1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
34 #ifdef HAVE_LIBSELINUX
35 #include <selinux/selinux.h>
36 #include <selinux/context.h>
42 #include "intervals.h"
43 #include "character.h"
47 #include "blockinput.h"
49 #include "dispextern.h"
55 #endif /* not WINDOWSNT */
59 #include <sys/param.h>
64 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
65 redirector allows the six letters between 'Z' and 'a' as well. */
67 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
70 #define IS_DRIVE(x) c_isalpha (x)
72 /* Need to lower-case the drive letter, or else expanded
73 filenames will sometimes compare unequal, because
74 `expand-file-name' doesn't always down-case the drive letter. */
75 #define DRIVE_LETTER(x) c_tolower (x)
79 #include <stat-time.h>
87 /* True during writing of auto-save files. */
88 static bool auto_saving
;
90 /* Nonzero umask during creation of auto-save directories. */
91 static mode_t auto_saving_dir_umask
;
93 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
94 a new file with the same mode as the original. */
95 static mode_t auto_save_mode_bits
;
97 /* Set by auto_save_1 if an error occurred during the last auto-save. */
98 static bool auto_save_error_occurred
;
100 /* The symbol bound to coding-system-for-read when
101 insert-file-contents is called for recovering a file. This is not
102 an actual coding system name, but just an indicator to tell
103 insert-file-contents to use `emacs-mule' with a special flag for
104 auto saving and recovering a file. */
105 static Lisp_Object Qauto_save_coding
;
107 /* Property name of a file name handler,
108 which gives a list of operations it handles.. */
109 static Lisp_Object Qoperations
;
111 /* Lisp functions for translating file formats. */
112 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
114 /* Lisp function for setting buffer-file-coding-system and the
115 multibyteness of the current buffer after inserting a file. */
116 static Lisp_Object Qafter_insert_file_set_coding
;
118 static Lisp_Object Qwrite_region_annotate_functions
;
119 /* Each time an annotation function changes the buffer, the new buffer
121 static Lisp_Object Vwrite_region_annotation_buffers
;
126 static Lisp_Object Qdelete_by_moving_to_trash
;
128 /* Lisp function for moving files to trash. */
129 static Lisp_Object Qmove_file_to_trash
;
131 /* Lisp function for recursively copying directories. */
132 static Lisp_Object Qcopy_directory
;
134 /* Lisp function for recursively deleting directories. */
135 static Lisp_Object Qdelete_directory
;
140 Lisp_Object Qfile_error
;
141 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
142 static Lisp_Object Qexcl
;
143 Lisp_Object Qfile_name_history
;
145 static Lisp_Object Qcar_less_than_car
;
147 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
148 Lisp_Object
*, struct coding_system
*);
149 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
150 struct coding_system
*);
154 report_file_error (const char *string
, Lisp_Object data
)
156 Lisp_Object errstring
;
160 synchronize_system_messages_locale ();
161 str
= strerror (errorno
);
162 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
163 Vlocale_coding_system
, 0);
169 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
172 /* System error messages are capitalized. Downcase the initial
173 unless it is followed by a slash. (The slash case caters to
174 error messages that begin with "I/O" or, in German, "E/A".) */
175 if (STRING_MULTIBYTE (errstring
)
176 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
180 str
= SSDATA (errstring
);
181 c
= STRING_CHAR ((unsigned char *) str
);
182 Faset (errstring
, make_number (0), make_number (downcase (c
)));
185 xsignal (Qfile_error
,
186 Fcons (build_string (string
), Fcons (errstring
, data
)));
191 close_file_unwind (Lisp_Object fd
)
193 emacs_close (XFASTINT (fd
));
197 /* Restore point, having saved it as a marker. */
200 restore_point_unwind (Lisp_Object location
)
202 Fgoto_char (location
);
203 Fset_marker (location
, Qnil
, Qnil
);
208 static Lisp_Object Qexpand_file_name
;
209 static Lisp_Object Qsubstitute_in_file_name
;
210 static Lisp_Object Qdirectory_file_name
;
211 static Lisp_Object Qfile_name_directory
;
212 static Lisp_Object Qfile_name_nondirectory
;
213 static Lisp_Object Qunhandled_file_name_directory
;
214 static Lisp_Object Qfile_name_as_directory
;
215 static Lisp_Object Qcopy_file
;
216 static Lisp_Object Qmake_directory_internal
;
217 static Lisp_Object Qmake_directory
;
218 static Lisp_Object Qdelete_directory_internal
;
219 Lisp_Object Qdelete_file
;
220 static Lisp_Object Qrename_file
;
221 static Lisp_Object Qadd_name_to_file
;
222 static Lisp_Object Qmake_symbolic_link
;
223 Lisp_Object Qfile_exists_p
;
224 static Lisp_Object Qfile_executable_p
;
225 static Lisp_Object Qfile_readable_p
;
226 static Lisp_Object Qfile_writable_p
;
227 static Lisp_Object Qfile_symlink_p
;
228 static Lisp_Object Qaccess_file
;
229 Lisp_Object Qfile_directory_p
;
230 static Lisp_Object Qfile_regular_p
;
231 static Lisp_Object Qfile_accessible_directory_p
;
232 static Lisp_Object Qfile_modes
;
233 static Lisp_Object Qset_file_modes
;
234 static Lisp_Object Qset_file_times
;
235 static Lisp_Object Qfile_selinux_context
;
236 static Lisp_Object Qset_file_selinux_context
;
237 static Lisp_Object Qfile_newer_than_file_p
;
238 Lisp_Object Qinsert_file_contents
;
239 Lisp_Object Qwrite_region
;
240 static Lisp_Object Qverify_visited_file_modtime
;
241 static Lisp_Object Qset_visited_file_modtime
;
243 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
244 Sfind_file_name_handler
, 2, 2, 0,
245 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
246 Otherwise, return nil.
247 A file name is handled if one of the regular expressions in
248 `file-name-handler-alist' matches it.
250 If OPERATION equals `inhibit-file-name-operation', then we ignore
251 any handlers that are members of `inhibit-file-name-handlers',
252 but we still do run any other handlers. This lets handlers
253 use the standard functions without calling themselves recursively. */)
254 (Lisp_Object filename
, Lisp_Object operation
)
256 /* This function must not munge the match data. */
257 Lisp_Object chain
, inhibited_handlers
, result
;
261 CHECK_STRING (filename
);
263 if (EQ (operation
, Vinhibit_file_name_operation
))
264 inhibited_handlers
= Vinhibit_file_name_handlers
;
266 inhibited_handlers
= Qnil
;
268 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
269 chain
= XCDR (chain
))
275 Lisp_Object string
= XCAR (elt
);
277 Lisp_Object handler
= XCDR (elt
);
278 Lisp_Object operations
= Qnil
;
280 if (SYMBOLP (handler
))
281 operations
= Fget (handler
, Qoperations
);
284 && (match_pos
= fast_string_match (string
, filename
)) > pos
285 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
289 handler
= XCDR (elt
);
290 tem
= Fmemq (handler
, inhibited_handlers
);
304 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
306 doc
: /* Return the directory component in file name FILENAME.
307 Return nil if FILENAME does not include a directory.
308 Otherwise return a directory name.
309 Given a Unix syntax file name, returns a string ending in slash. */)
310 (Lisp_Object filename
)
313 register const char *beg
;
317 register const char *p
;
320 CHECK_STRING (filename
);
322 /* If the file name has special constructs in it,
323 call the corresponding file handler. */
324 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
327 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
329 return STRINGP (handled_name
) ? handled_name
: Qnil
;
333 beg
= alloca (SBYTES (filename
) + 1);
334 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
336 beg
= SSDATA (filename
);
338 p
= beg
+ SBYTES (filename
);
340 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
342 /* only recognize drive specifier at the beginning */
344 /* handle the "/:d:foo" and "/:foo" cases correctly */
345 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
346 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
353 /* Expansion of "c:" to drive and default directory. */
356 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
357 char *res
= alloca (MAXPATHLEN
+ 1);
360 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
362 memcpy (res
, beg
, 2);
367 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
369 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
372 p
= beg
+ strlen (beg
);
375 dostounix_filename (beg
);
378 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
381 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
382 Sfile_name_nondirectory
, 1, 1, 0,
383 doc
: /* Return file name FILENAME sans its directory.
384 For example, in a Unix-syntax file name,
385 this is everything after the last slash,
386 or the entire name if it contains no slash. */)
387 (Lisp_Object filename
)
389 register const char *beg
, *p
, *end
;
392 CHECK_STRING (filename
);
394 /* If the file name has special constructs in it,
395 call the corresponding file handler. */
396 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
399 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
401 if (STRINGP (handled_name
))
403 error ("Invalid handler in `file-name-handler-alist'");
406 beg
= SSDATA (filename
);
407 end
= p
= beg
+ SBYTES (filename
);
409 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
411 /* only recognize drive specifier at beginning */
413 /* handle the "/:d:foo" case correctly */
414 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
419 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
422 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
423 Sunhandled_file_name_directory
, 1, 1, 0,
424 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
425 A `directly usable' directory name is one that may be used without the
426 intervention of any file handler.
427 If FILENAME is a directly usable file itself, return
428 \(file-name-directory FILENAME).
429 If FILENAME refers to a file which is not accessible from a local process,
430 then this should return nil.
431 The `call-process' and `start-process' functions use this function to
432 get a current directory to run processes in. */)
433 (Lisp_Object filename
)
437 /* If the file name has special constructs in it,
438 call the corresponding file handler. */
439 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
442 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
444 return STRINGP (handled_name
) ? handled_name
: Qnil
;
447 return Ffile_name_directory (filename
);
450 /* Convert from file name SRC of length SRCLEN to directory name
451 in DST. On UNIX, just make sure there is a terminating /.
452 Return the length of DST. */
455 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
)
467 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
469 dst
[srclen
] = DIRECTORY_SEP
;
470 dst
[srclen
+ 1] = '\0';
474 dostounix_filename (dst
);
479 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
480 Sfile_name_as_directory
, 1, 1, 0,
481 doc
: /* Return a string representing the file name FILE interpreted as a directory.
482 This operation exists because a directory is also a file, but its name as
483 a directory is different from its name as a file.
484 The result can be used as the value of `default-directory'
485 or passed as second argument to `expand-file-name'.
486 For a Unix-syntax file name, just appends a slash. */)
497 /* If the file name has special constructs in it,
498 call the corresponding file handler. */
499 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
502 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
504 if (STRINGP (handled_name
))
506 error ("Invalid handler in `file-name-handler-alist'");
509 buf
= alloca (SBYTES (file
) + 10);
510 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
));
511 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
514 /* Convert from directory name SRC of length SRCLEN to
515 file name in DST. On UNIX, just make sure there isn't
516 a terminating /. Return the length of DST. */
519 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
)
521 /* Process as Unix format: just remove any final slash.
522 But leave "/" unchanged; do not change it to "". */
525 && IS_DIRECTORY_SEP (dst
[srclen
- 1])
527 && !IS_ANY_SEP (dst
[srclen
- 2])
535 dostounix_filename (dst
);
540 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
542 doc
: /* Returns the file name of the directory named DIRECTORY.
543 This is the name of the file that holds the data for the directory DIRECTORY.
544 This operation exists because a directory is also a file, but its name as
545 a directory is different from its name as a file.
546 In Unix-syntax, this function just removes the final slash. */)
547 (Lisp_Object directory
)
553 CHECK_STRING (directory
);
555 if (NILP (directory
))
558 /* If the file name has special constructs in it,
559 call the corresponding file handler. */
560 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
563 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
565 if (STRINGP (handled_name
))
567 error ("Invalid handler in `file-name-handler-alist'");
570 buf
= alloca (SBYTES (directory
) + 20);
571 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
));
572 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
575 static const char make_temp_name_tbl
[64] =
577 'A','B','C','D','E','F','G','H',
578 'I','J','K','L','M','N','O','P',
579 'Q','R','S','T','U','V','W','X',
580 'Y','Z','a','b','c','d','e','f',
581 'g','h','i','j','k','l','m','n',
582 'o','p','q','r','s','t','u','v',
583 'w','x','y','z','0','1','2','3',
584 '4','5','6','7','8','9','-','_'
587 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
589 /* Value is a temporary file name starting with PREFIX, a string.
591 The Emacs process number forms part of the result, so there is
592 no danger of generating a name being used by another process.
593 In addition, this function makes an attempt to choose a name
594 which has no existing file. To make this work, PREFIX should be
595 an absolute file name.
597 BASE64_P means add the pid as 3 characters in base64
598 encoding. In this case, 6 characters will be added to PREFIX to
599 form the file name. Otherwise, if Emacs is running on a system
600 with long file names, add the pid as a decimal number.
602 This function signals an error if no unique file name could be
606 make_temp_name (Lisp_Object prefix
, bool base64_p
)
612 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
615 CHECK_STRING (prefix
);
617 /* VAL is created by adding 6 characters to PREFIX. The first
618 three are the PID of this process, in base 64, and the second
619 three are incremented if the file already exists. This ensures
620 262144 unique file names per PID per PREFIX. */
626 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
627 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
628 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
633 #ifdef HAVE_LONG_FILE_NAMES
634 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
636 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
637 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
638 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
643 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
644 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
645 if (!STRING_MULTIBYTE (prefix
))
646 STRING_SET_UNIBYTE (val
);
648 memcpy (data
, SSDATA (prefix
), len
);
651 memcpy (p
, pidbuf
, pidlen
);
654 /* Here we try to minimize useless stat'ing when this function is
655 invoked many times successively with the same PREFIX. We achieve
656 this by initializing count to a random value, and incrementing it
659 We don't want make-temp-name to be called while dumping,
660 because then make_temp_name_count_initialized_p would get set
661 and then make_temp_name_count would not be set when Emacs starts. */
663 if (!make_temp_name_count_initialized_p
)
665 make_temp_name_count
= time (NULL
);
666 make_temp_name_count_initialized_p
= 1;
672 unsigned num
= make_temp_name_count
;
674 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
675 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
676 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
678 /* Poor man's congruential RN generator. Replace with
679 ++make_temp_name_count for debugging. */
680 make_temp_name_count
+= 25229;
681 make_temp_name_count
%= 225307;
683 if (stat (data
, &ignored
) < 0)
685 /* We want to return only if errno is ENOENT. */
689 /* The error here is dubious, but there is little else we
690 can do. The alternatives are to return nil, which is
691 as bad as (and in many cases worse than) throwing the
692 error, or to ignore the error, which will likely result
693 in looping through 225307 stat's, which is not only
694 dog-slow, but also useless since eventually nil would
695 have to be returned anyway. */
696 report_file_error ("Cannot create temporary name for prefix",
697 Fcons (prefix
, Qnil
));
704 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
705 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
706 The Emacs process number forms part of the result,
707 so there is no danger of generating a name being used by another process.
709 In addition, this function makes an attempt to choose a name
710 which has no existing file. To make this work,
711 PREFIX should be an absolute file name.
713 There is a race condition between calling `make-temp-name' and creating the
714 file which opens all kinds of security holes. For that reason, you should
715 probably use `make-temp-file' instead, except in three circumstances:
717 * If you are creating the file in the user's home directory.
718 * If you are creating a directory rather than an ordinary file.
719 * If you are taking special precautions as `make-temp-file' does. */)
722 return make_temp_name (prefix
, 0);
727 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
728 doc
: /* Convert filename NAME to absolute, and canonicalize it.
729 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
730 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
731 the current buffer's value of `default-directory' is used.
732 NAME should be a string that is a valid file name for the underlying
734 File name components that are `.' are removed, and
735 so are file name components followed by `..', along with the `..' itself;
736 note that these simplifications are done without checking the resulting
737 file names in the file system.
738 Multiple consecutive slashes are collapsed into a single slash,
739 except at the beginning of the file name when they are significant (e.g.,
740 UNC file names on MS-Windows.)
741 An initial `~/' expands to your home directory.
742 An initial `~USER/' expands to USER's home directory.
743 See also the function `substitute-in-file-name'.
745 For technical reasons, this function can return correct but
746 non-intuitive results for the root directory; for instance,
747 \(expand-file-name ".." "/") returns "/..". For this reason, use
748 \(directory-file-name (file-name-directory dirname)) to traverse a
749 filesystem tree, not (expand-file-name ".." dirname). */)
750 (Lisp_Object name
, Lisp_Object default_directory
)
752 /* These point to SDATA and need to be careful with string-relocation
753 during GC (via DECODE_FILE). */
756 /* This should only point to alloca'd data. */
763 bool collapse_newdir
= 1;
767 Lisp_Object handler
, result
, handled_name
;
773 /* If the file name has special constructs in it,
774 call the corresponding file handler. */
775 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
778 handled_name
= call3 (handler
, Qexpand_file_name
,
779 name
, default_directory
);
780 if (STRINGP (handled_name
))
782 error ("Invalid handler in `file-name-handler-alist'");
786 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
787 if (NILP (default_directory
))
788 default_directory
= BVAR (current_buffer
, directory
);
789 if (! STRINGP (default_directory
))
792 /* "/" is not considered a root directory on DOS_NT, so using "/"
793 here causes an infinite recursion in, e.g., the following:
795 (let (default-directory)
796 (expand-file-name "a"))
798 To avoid this, we set default_directory to the root of the
800 default_directory
= build_string (emacs_root_dir ());
802 default_directory
= build_string ("/");
806 if (!NILP (default_directory
))
808 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
811 handled_name
= call3 (handler
, Qexpand_file_name
,
812 name
, default_directory
);
813 if (STRINGP (handled_name
))
815 error ("Invalid handler in `file-name-handler-alist'");
820 char *o
= SSDATA (default_directory
);
822 /* Make sure DEFAULT_DIRECTORY is properly expanded.
823 It would be better to do this down below where we actually use
824 default_directory. Unfortunately, calling Fexpand_file_name recursively
825 could invoke GC, and the strings might be relocated. This would
826 be annoying because we have pointers into strings lying around
827 that would need adjusting, and people would add new pointers to
828 the code and forget to adjust them, resulting in intermittent bugs.
829 Putting this call here avoids all that crud.
831 The EQ test avoids infinite recursion. */
832 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
833 /* Save time in some common cases - as long as default_directory
834 is not relative, it can be canonicalized with name below (if it
835 is needed at all) without requiring it to be expanded now. */
837 /* Detect MSDOS file names with drive specifiers. */
838 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
839 && IS_DIRECTORY_SEP (o
[2]))
841 /* Detect Windows file names in UNC format. */
842 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
844 #else /* not DOS_NT */
845 /* Detect Unix absolute file names (/... alone is not absolute on
847 && ! (IS_DIRECTORY_SEP (o
[0]))
848 #endif /* not DOS_NT */
854 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
858 multibyte
= STRING_MULTIBYTE (name
);
859 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
862 default_directory
= string_to_multibyte (default_directory
);
865 name
= string_to_multibyte (name
);
870 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
871 nm
= alloca (SBYTES (name
) + 1);
872 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
875 /* Note if special escape prefix is present, but remove for now. */
876 if (nm
[0] == '/' && nm
[1] == ':')
882 /* Find and remove drive specifier if present; this makes nm absolute
883 even if the rest of the name appears to be relative. Only look for
884 drive specifier at the beginning. */
885 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
887 drive
= (unsigned char) nm
[0];
892 /* If we see "c://somedir", we want to strip the first slash after the
893 colon when stripping the drive letter. Otherwise, this expands to
895 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
898 /* Discard any previous drive specifier if nm is now in UNC format. */
899 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
903 #endif /* WINDOWSNT */
906 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
907 none are found, we can probably return right away. We will avoid
908 allocating a new string if name is already fully expanded. */
910 IS_DIRECTORY_SEP (nm
[0])
912 && drive
&& !is_escaped
915 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
919 /* If it turns out that the filename we want to return is just a
920 suffix of FILENAME, we don't need to go through and edit
921 things; we just need to construct a new string using data
922 starting at the middle of FILENAME. If we set LOSE, that
923 means we've discovered that we can't do that cool trick. */
929 /* Since we know the name is absolute, we can assume that each
930 element starts with a "/". */
932 /* "." and ".." are hairy. */
933 if (IS_DIRECTORY_SEP (p
[0])
935 && (IS_DIRECTORY_SEP (p
[2])
937 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
940 /* We want to replace multiple `/' in a row with a single
943 && IS_DIRECTORY_SEP (p
[0])
944 && IS_DIRECTORY_SEP (p
[1]))
951 /* Make sure directories are all separated with /, but
952 avoid allocation of a new string when not required. */
953 dostounix_filename (nm
);
955 if (IS_DIRECTORY_SEP (nm
[1]))
957 if (strcmp (nm
, SSDATA (name
)) != 0)
958 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
962 /* Drive must be set, so this is okay. */
963 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
967 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
968 temp
[0] = DRIVE_LETTER (drive
);
969 name
= concat2 (build_string (temp
), name
);
972 #else /* not DOS_NT */
973 if (strcmp (nm
, SSDATA (name
)) == 0)
975 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
976 #endif /* not DOS_NT */
980 /* At this point, nm might or might not be an absolute file name. We
981 need to expand ~ or ~user if present, otherwise prefix nm with
982 default_directory if nm is not absolute, and finally collapse /./
983 and /foo/../ sequences.
985 We set newdir to be the appropriate prefix if one is needed:
986 - the relevant user directory if nm starts with ~ or ~user
987 - the specified drive's working dir (DOS/NT only) if nm does not
989 - the value of default_directory.
991 Note that these prefixes are not guaranteed to be absolute (except
992 for the working dir of a drive). Therefore, to ensure we always
993 return an absolute name, if the final prefix is not absolute we
994 append it to the current working directory. */
998 if (nm
[0] == '~') /* prefix ~ */
1000 if (IS_DIRECTORY_SEP (nm
[1])
1001 || nm
[1] == 0) /* ~ by itself */
1005 if (!(newdir
= egetenv ("HOME")))
1008 /* `egetenv' may return a unibyte string, which will bite us since
1009 we expect the directory to be multibyte. */
1010 tem
= build_string (newdir
);
1011 if (!STRING_MULTIBYTE (tem
))
1013 hdir
= DECODE_FILE (tem
);
1014 newdir
= SSDATA (hdir
);
1017 collapse_newdir
= 0;
1020 else /* ~user/filename */
1023 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1024 o
= alloca (p
- nm
+ 1);
1025 memcpy (o
, nm
, p
- nm
);
1029 pw
= (struct passwd
*) getpwnam (o
+ 1);
1033 newdir
= pw
->pw_dir
;
1036 collapse_newdir
= 0;
1040 /* If we don't find a user of that name, leave the name
1041 unchanged; don't move nm forward to p. */
1046 /* On DOS and Windows, nm is absolute if a drive name was specified;
1047 use the drive's current directory as the prefix if needed. */
1048 if (!newdir
&& drive
)
1050 /* Get default directory if needed to make nm absolute. */
1052 if (!IS_DIRECTORY_SEP (nm
[0]))
1054 adir
= alloca (MAXPATHLEN
+ 1);
1055 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1060 /* Either nm starts with /, or drive isn't mounted. */
1062 adir
[0] = DRIVE_LETTER (drive
);
1071 /* Finally, if no prefix has been specified and nm is not absolute,
1072 then it must be expanded relative to default_directory. */
1076 /* /... alone is not absolute on DOS and Windows. */
1077 && !IS_DIRECTORY_SEP (nm
[0])
1080 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1084 newdir
= SSDATA (default_directory
);
1086 /* Note if special escape prefix is present, but remove for now. */
1087 if (newdir
[0] == '/' && newdir
[1] == ':')
1098 /* First ensure newdir is an absolute name. */
1100 /* Detect MSDOS file names with drive specifiers. */
1101 ! (IS_DRIVE (newdir
[0])
1102 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1104 /* Detect Windows file names in UNC format. */
1105 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1109 /* Effectively, let newdir be (expand-file-name newdir cwd).
1110 Because of the admonition against calling expand-file-name
1111 when we have pointers into lisp strings, we accomplish this
1112 indirectly by prepending newdir to nm if necessary, and using
1113 cwd (or the wd of newdir's drive) as the new newdir. */
1115 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1117 drive
= (unsigned char) newdir
[0];
1120 if (!IS_DIRECTORY_SEP (nm
[0]))
1122 ptrdiff_t newlen
= strlen (newdir
);
1123 char *tmp
= alloca (newlen
+ strlen (nm
) + 2);
1124 file_name_as_directory (tmp
, newdir
, newlen
);
1128 adir
= alloca (MAXPATHLEN
+ 1);
1131 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1139 /* Strip off drive name from prefix, if present. */
1140 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1146 /* Keep only a prefix from newdir if nm starts with slash
1147 (//server/share for UNC, nothing otherwise). */
1148 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1151 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1153 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1155 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1157 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1170 /* Get rid of any slash at the end of newdir, unless newdir is
1171 just / or // (an incomplete UNC name). */
1172 length
= strlen (newdir
);
1174 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1176 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1180 char *temp
= alloca (length
);
1181 memcpy (temp
, newdir
, length
- 1);
1182 temp
[length
- 1] = 0;
1193 /* Now concatenate the directory and name to new space in the stack frame. */
1194 tlen
+= strlen (nm
) + 1;
1196 /* Reserve space for drive specifier and escape prefix, since either
1197 or both may need to be inserted. (The Microsoft x86 compiler
1198 produces incorrect code if the following two lines are combined.) */
1199 target
= alloca (tlen
+ 4);
1201 #else /* not DOS_NT */
1202 target
= alloca (tlen
);
1203 #endif /* not DOS_NT */
1208 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1211 /* If newdir is effectively "C:/", then the drive letter will have
1212 been stripped and newdir will be "/". Concatenating with an
1213 absolute directory in nm produces "//", which will then be
1214 incorrectly treated as a network share. Ignore newdir in
1215 this case (keeping the drive letter). */
1216 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1217 && newdir
[1] == '\0'))
1219 strcpy (target
, newdir
);
1222 file_name_as_directory (target
, newdir
, length
);
1225 strcat (target
, nm
);
1227 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1235 if (!IS_DIRECTORY_SEP (*p
))
1239 else if (p
[1] == '.'
1240 && (IS_DIRECTORY_SEP (p
[2])
1243 /* If "/." is the entire filename, keep the "/". Otherwise,
1244 just delete the whole "/.". */
1245 if (o
== target
&& p
[2] == '\0')
1249 else if (p
[1] == '.' && p
[2] == '.'
1250 /* `/../' is the "superroot" on certain file systems.
1251 Turned off on DOS_NT systems because they have no
1252 "superroot" and because this causes us to produce
1253 file names like "d:/../foo" which fail file-related
1254 functions of the underlying OS. (To reproduce, try a
1255 long series of "../../" in default_directory, longer
1256 than the number of levels from the root.) */
1260 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1265 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1268 /* Don't go below server level in UNC filenames. */
1269 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1270 && IS_DIRECTORY_SEP (*target
))
1274 /* Keep initial / only if this is the whole name. */
1275 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1279 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1280 /* Collapse multiple `/' in a row. */
1289 /* At last, set drive name. */
1291 /* Except for network file name. */
1292 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1293 #endif /* WINDOWSNT */
1295 if (!drive
) emacs_abort ();
1297 target
[0] = DRIVE_LETTER (drive
);
1300 /* Reinsert the escape prefix if required. */
1307 dostounix_filename (target
);
1310 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1313 /* Again look to see if the file name has special constructs in it
1314 and perhaps call the corresponding file handler. This is needed
1315 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1316 the ".." component gives us "/user@host:/bar/../baz" which needs
1317 to be expanded again. */
1318 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1319 if (!NILP (handler
))
1321 handled_name
= call3 (handler
, Qexpand_file_name
,
1322 result
, default_directory
);
1323 if (STRINGP (handled_name
))
1324 return handled_name
;
1325 error ("Invalid handler in `file-name-handler-alist'");
1332 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1333 This is the old version of expand-file-name, before it was thoroughly
1334 rewritten for Emacs 10.31. We leave this version here commented-out,
1335 because the code is very complex and likely to have subtle bugs. If
1336 bugs _are_ found, it might be of interest to look at the old code and
1337 see what did it do in the relevant situation.
1339 Don't remove this code: it's true that it will be accessible
1340 from the repository, but a few years from deletion, people will
1341 forget it is there. */
1343 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1344 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1345 "Convert FILENAME to absolute, and canonicalize it.\n\
1346 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1347 \(does not start with slash); if DEFAULT is nil or missing,\n\
1348 the current buffer's value of default-directory is used.\n\
1349 Filenames containing `.' or `..' as components are simplified;\n\
1350 initial `~/' expands to your home directory.\n\
1351 See also the function `substitute-in-file-name'.")
1353 Lisp_Object name
, defalt
;
1357 register unsigned char *newdir
, *p
, *o
;
1359 unsigned char *target
;
1362 CHECK_STRING (name
);
1365 /* If nm is absolute, flush ...// and detect /./ and /../.
1366 If no /./ or /../ we can return right away. */
1373 if (p
[0] == '/' && p
[1] == '/'
1376 if (p
[0] == '/' && p
[1] == '~')
1377 nm
= p
+ 1, lose
= 1;
1378 if (p
[0] == '/' && p
[1] == '.'
1379 && (p
[2] == '/' || p
[2] == 0
1380 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1386 if (nm
== SDATA (name
))
1388 return build_string (nm
);
1392 /* Now determine directory to start with and put it in NEWDIR. */
1396 if (nm
[0] == '~') /* prefix ~ */
1397 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1399 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1400 newdir
= (unsigned char *) "";
1403 else /* ~user/filename */
1405 /* Get past ~ to user. */
1406 unsigned char *user
= nm
+ 1;
1407 /* Find end of name. */
1408 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1409 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1410 /* Copy the user name into temp storage. */
1411 o
= alloca (len
+ 1);
1412 memcpy (o
, user
, len
);
1415 /* Look up the user name. */
1417 pw
= (struct passwd
*) getpwnam (o
+ 1);
1420 error ("\"%s\" isn't a registered user", o
+ 1);
1422 newdir
= (unsigned char *) pw
->pw_dir
;
1424 /* Discard the user name from NM. */
1428 if (nm
[0] != '/' && !newdir
)
1431 defalt
= current_buffer
->directory
;
1432 CHECK_STRING (defalt
);
1433 newdir
= SDATA (defalt
);
1436 /* Now concatenate the directory and name to new space in the stack frame. */
1438 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1439 target
= alloca (tlen
);
1444 if (nm
[0] == 0 || nm
[0] == '/')
1445 strcpy (target
, newdir
);
1447 file_name_as_directory (target
, newdir
);
1450 strcat (target
, nm
);
1452 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1463 else if (!strncmp (p
, "//", 2)
1469 else if (p
[0] == '/' && p
[1] == '.'
1470 && (p
[2] == '/' || p
[2] == 0))
1472 else if (!strncmp (p
, "/..", 3)
1473 /* `/../' is the "superroot" on certain file systems. */
1475 && (p
[3] == '/' || p
[3] == 0))
1477 while (o
!= target
&& *--o
!= '/')
1479 if (o
== target
&& *o
== '/')
1489 return make_string (target
, o
- target
);
1493 /* If /~ or // appears, discard everything through first slash. */
1495 file_name_absolute_p (const char *filename
)
1498 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1500 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1501 && IS_DIRECTORY_SEP (filename
[2]))
1507 search_embedded_absfilename (char *nm
, char *endp
)
1511 for (p
= nm
+ 1; p
< endp
; p
++)
1514 || IS_DIRECTORY_SEP (p
[-1]))
1515 && file_name_absolute_p (p
)
1516 #if defined (WINDOWSNT) || defined (CYGWIN)
1517 /* // at start of file name is meaningful in Apollo,
1518 WindowsNT and Cygwin systems. */
1519 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1520 #endif /* not (WINDOWSNT || CYGWIN) */
1523 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1524 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1526 char *o
= alloca (s
- p
+ 1);
1528 memcpy (o
, p
, s
- p
);
1531 /* If we have ~user and `user' exists, discard
1532 everything up to ~. But if `user' does not exist, leave
1533 ~user alone, it might be a literal file name. */
1535 pw
= getpwnam (o
+ 1);
1547 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1548 Ssubstitute_in_file_name
, 1, 1, 0,
1549 doc
: /* Substitute environment variables referred to in FILENAME.
1550 `$FOO' where FOO is an environment variable name means to substitute
1551 the value of that variable. The variable name should be terminated
1552 with a character not a letter, digit or underscore; otherwise, enclose
1553 the entire variable name in braces.
1555 If `/~' appears, all of FILENAME through that `/' is discarded.
1556 If `//' appears, everything up to and including the first of
1557 those `/' is discarded. */)
1558 (Lisp_Object filename
)
1560 char *nm
, *s
, *p
, *o
, *x
, *endp
;
1561 char *target
= NULL
;
1563 bool substituted
= 0;
1566 Lisp_Object handler
;
1568 CHECK_STRING (filename
);
1570 multibyte
= STRING_MULTIBYTE (filename
);
1572 /* If the file name has special constructs in it,
1573 call the corresponding file handler. */
1574 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1575 if (!NILP (handler
))
1577 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1579 if (STRINGP (handled_name
))
1580 return handled_name
;
1581 error ("Invalid handler in `file-name-handler-alist'");
1584 /* Always work on a copy of the string, in case GC happens during
1585 decode of environment variables, causing the original Lisp_String
1586 data to be relocated. */
1587 nm
= alloca (SBYTES (filename
) + 1);
1588 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1591 dostounix_filename (nm
);
1592 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1594 endp
= nm
+ SBYTES (filename
);
1596 /* If /~ or // appears, discard everything through first slash. */
1597 p
= search_embedded_absfilename (nm
, endp
);
1599 /* Start over with the new string, so we check the file-name-handler
1600 again. Important with filenames like "/home/foo//:/hello///there"
1601 which would substitute to "/:/hello///there" rather than "/there". */
1602 return Fsubstitute_in_file_name
1603 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1605 /* See if any variables are substituted into the string
1606 and find the total length of their values in `total'. */
1608 for (p
= nm
; p
!= endp
;)
1618 /* "$$" means a single "$". */
1627 while (p
!= endp
&& *p
!= '}') p
++;
1628 if (*p
!= '}') goto missingclose
;
1634 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1638 /* Copy out the variable name. */
1639 target
= alloca (s
- o
+ 1);
1640 memcpy (target
, o
, s
- o
);
1643 strupr (target
); /* $home == $HOME etc. */
1646 /* Get variable value. */
1647 o
= egetenv (target
);
1650 /* Don't try to guess a maximum length - UTF8 can use up to
1651 four bytes per character. This code is unlikely to run
1652 in a situation that requires performance, so decoding the
1653 env variables twice should be acceptable. Note that
1654 decoding may cause a garbage collect. */
1655 Lisp_Object orig
, decoded
;
1656 orig
= build_unibyte_string (o
);
1657 decoded
= DECODE_FILE (orig
);
1658 total
+= SBYTES (decoded
);
1668 /* If substitution required, recopy the string and do it. */
1669 /* Make space in stack frame for the new copy. */
1670 xnm
= alloca (SBYTES (filename
) + total
+ 1);
1673 /* Copy the rest of the name through, replacing $ constructs with values. */
1690 while (p
!= endp
&& *p
!= '}') p
++;
1691 if (*p
!= '}') goto missingclose
;
1697 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1701 /* Copy out the variable name. */
1702 target
= alloca (s
- o
+ 1);
1703 memcpy (target
, o
, s
- o
);
1706 strupr (target
); /* $home == $HOME etc. */
1709 /* Get variable value. */
1710 o
= egetenv (target
);
1714 strcpy (x
, target
); x
+= strlen (target
);
1718 Lisp_Object orig
, decoded
;
1719 ptrdiff_t orig_length
, decoded_length
;
1720 orig_length
= strlen (o
);
1721 orig
= make_unibyte_string (o
, orig_length
);
1722 decoded
= DECODE_FILE (orig
);
1723 decoded_length
= SBYTES (decoded
);
1724 memcpy (x
, SDATA (decoded
), decoded_length
);
1725 x
+= decoded_length
;
1727 /* If environment variable needed decoding, return value
1728 needs to be multibyte. */
1729 if (decoded_length
!= orig_length
1730 || memcmp (SDATA (decoded
), o
, orig_length
))
1737 /* If /~ or // appears, discard everything through first slash. */
1738 while ((p
= search_embedded_absfilename (xnm
, x
)))
1739 /* This time we do not start over because we've already expanded envvars
1740 and replaced $$ with $. Maybe we should start over as well, but we'd
1741 need to quote some $ to $$ first. */
1744 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1747 error ("Bad format environment-variable substitution");
1749 error ("Missing \"}\" in environment-variable substitution");
1751 error ("Substituting nonexistent environment variable \"%s\"", target
);
1757 /* A slightly faster and more convenient way to get
1758 (directory-file-name (expand-file-name FOO)). */
1761 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1763 register Lisp_Object absname
;
1765 absname
= Fexpand_file_name (filename
, defdir
);
1767 /* Remove final slash, if any (unless this is the root dir).
1768 stat behaves differently depending! */
1769 if (SCHARS (absname
) > 1
1770 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1771 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1772 /* We cannot take shortcuts; they might be wrong for magic file names. */
1773 absname
= Fdirectory_file_name (absname
);
1777 /* Signal an error if the file ABSNAME already exists.
1778 If INTERACTIVE, ask the user whether to proceed,
1779 and bypass the error if the user says to go ahead.
1780 QUERYSTRING is a name for the action that is being considered
1783 *STATPTR is used to store the stat information if the file exists.
1784 If the file does not exist, STATPTR->st_mode is set to 0.
1785 If STATPTR is null, we don't store into it.
1787 If QUICK, ask for y or n, not yes or no. */
1790 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1791 bool interactive
, struct stat
*statptr
,
1794 Lisp_Object tem
, encoded_filename
;
1795 struct stat statbuf
;
1796 struct gcpro gcpro1
;
1798 encoded_filename
= ENCODE_FILE (absname
);
1800 /* `stat' is a good way to tell whether the file exists,
1801 regardless of what access permissions it has. */
1802 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1804 if (S_ISDIR (statbuf
.st_mode
))
1805 xsignal2 (Qfile_error
,
1806 build_string ("File is a directory"), absname
);
1809 xsignal2 (Qfile_already_exists
,
1810 build_string ("File already exists"), absname
);
1812 tem
= format2 ("File %s already exists; %s anyway? ",
1813 absname
, build_string (querystring
));
1815 tem
= call1 (intern ("y-or-n-p"), tem
);
1817 tem
= do_yes_or_no_p (tem
);
1820 xsignal2 (Qfile_already_exists
,
1821 build_string ("File already exists"), absname
);
1828 statptr
->st_mode
= 0;
1833 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1834 "fCopy file: \nGCopy %s to file: \np\nP",
1835 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1836 If NEWNAME names a directory, copy FILE there.
1838 This function always sets the file modes of the output file to match
1841 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1842 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1843 signal a `file-already-exists' error without overwriting. If
1844 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1845 about overwriting; this is what happens in interactive use with M-x.
1846 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1849 Fourth arg KEEP-TIME non-nil means give the output file the same
1850 last-modified time as the old one. (This works on only some systems.)
1852 A prefix arg makes KEEP-TIME non-nil.
1854 If PRESERVE-UID-GID is non-nil, we try to transfer the
1855 uid and gid of FILE to NEWNAME.
1857 If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
1858 on the system, we copy the SELinux context of FILE to NEWNAME. */)
1859 (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
)
1863 char buf
[16 * 1024];
1864 struct stat st
, out_st
;
1865 Lisp_Object handler
;
1866 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1867 ptrdiff_t count
= SPECPDL_INDEX ();
1868 bool input_file_statable_p
;
1869 Lisp_Object encoded_file
, encoded_newname
;
1871 security_context_t con
;
1875 encoded_file
= encoded_newname
= Qnil
;
1876 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1877 CHECK_STRING (file
);
1878 CHECK_STRING (newname
);
1880 if (!NILP (Ffile_directory_p (newname
)))
1881 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1883 newname
= Fexpand_file_name (newname
, Qnil
);
1885 file
= Fexpand_file_name (file
, Qnil
);
1887 /* If the input file name has special constructs in it,
1888 call the corresponding file handler. */
1889 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1890 /* Likewise for output file name. */
1892 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1893 if (!NILP (handler
))
1894 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1895 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1896 preserve_selinux_context
));
1898 encoded_file
= ENCODE_FILE (file
);
1899 encoded_newname
= ENCODE_FILE (newname
);
1901 if (NILP (ok_if_already_exists
)
1902 || INTEGERP (ok_if_already_exists
))
1903 barf_or_query_if_file_exists (newname
, "copy to it",
1904 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1905 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1909 if (!CopyFile (SDATA (encoded_file
),
1910 SDATA (encoded_newname
),
1912 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1913 /* CopyFile retains the timestamp by default. */
1914 else if (NILP (keep_time
))
1920 filename
= SDATA (encoded_newname
);
1922 /* Ensure file is writable while its modified time is set. */
1923 attributes
= GetFileAttributes (filename
);
1924 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1925 now
= current_emacs_time ();
1926 if (set_file_times (-1, filename
, now
, now
))
1928 /* Restore original attributes. */
1929 SetFileAttributes (filename
, attributes
);
1930 xsignal2 (Qfile_date_error
,
1931 build_string ("Cannot set file date"), newname
);
1933 /* Restore original attributes. */
1934 SetFileAttributes (filename
, attributes
);
1936 #else /* not WINDOWSNT */
1938 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
1942 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1944 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1946 /* We can only copy regular files and symbolic links. Other files are not
1948 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
1951 if (!NILP (preserve_selinux_context
) && is_selinux_enabled ())
1953 conlength
= fgetfilecon (ifd
, &con
);
1954 if (conlength
== -1)
1955 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
1959 if (out_st
.st_mode
!= 0
1960 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
1963 report_file_error ("Input and output files are the same",
1964 Fcons (file
, Fcons (newname
, Qnil
)));
1967 if (input_file_statable_p
)
1969 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
1971 #if defined (EISDIR)
1972 /* Get a better looking error message. */
1975 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
1980 /* System's default file type was set to binary by _fmode in emacs.c. */
1981 ofd
= emacs_open (SDATA (encoded_newname
),
1982 O_WRONLY
| O_TRUNC
| O_CREAT
1983 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
1984 S_IREAD
| S_IWRITE
);
1985 #else /* not MSDOS */
1987 mode_t new_mask
= 0666;
1988 if (input_file_statable_p
)
1990 if (!NILP (preserve_uid_gid
))
1992 new_mask
&= st
.st_mode
;
1994 ofd
= emacs_open (SSDATA (encoded_newname
),
1995 (O_WRONLY
| O_TRUNC
| O_CREAT
1996 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
1999 #endif /* not MSDOS */
2001 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2003 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2007 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2008 if (emacs_write (ofd
, buf
, n
) != n
)
2009 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2013 /* Preserve the original file modes, and if requested, also its
2015 if (input_file_statable_p
)
2017 mode_t mode_mask
= 07777;
2018 if (!NILP (preserve_uid_gid
))
2020 /* Attempt to change owner and group. If that doesn't work
2021 attempt to change just the group, as that is sometimes allowed.
2022 Adjust the mode mask to eliminate setuid or setgid bits
2023 that are inappropriate if the owner and group are wrong. */
2024 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2026 mode_mask
&= ~06000;
2027 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2031 if (fchmod (ofd
, st
.st_mode
& mode_mask
) != 0)
2032 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
2034 #endif /* not MSDOS */
2039 /* Set the modified context back to the file. */
2040 bool fail
= fsetfilecon (ofd
, con
) != 0;
2041 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2042 if (fail
&& errno
!= ENOTSUP
)
2043 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2049 if (input_file_statable_p
)
2051 if (!NILP (keep_time
))
2053 EMACS_TIME atime
= get_stat_atime (&st
);
2054 EMACS_TIME mtime
= get_stat_mtime (&st
);
2055 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2056 xsignal2 (Qfile_date_error
,
2057 build_string ("Cannot set file date"), newname
);
2061 if (emacs_close (ofd
) < 0)
2062 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2067 if (input_file_statable_p
)
2069 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2070 and if it can't, it tells so. Otherwise, under MSDOS we usually
2071 get only the READ bit, which will make the copied file read-only,
2072 so it's better not to chmod at all. */
2073 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2074 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2077 #endif /* not WINDOWSNT */
2079 /* Discard the unwind protects. */
2080 specpdl_ptr
= specpdl
+ count
;
2086 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2087 Smake_directory_internal
, 1, 1, 0,
2088 doc
: /* Create a new directory named DIRECTORY. */)
2089 (Lisp_Object directory
)
2092 Lisp_Object handler
;
2093 Lisp_Object encoded_dir
;
2095 CHECK_STRING (directory
);
2096 directory
= Fexpand_file_name (directory
, Qnil
);
2098 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2099 if (!NILP (handler
))
2100 return call2 (handler
, Qmake_directory_internal
, directory
);
2102 encoded_dir
= ENCODE_FILE (directory
);
2104 dir
= SSDATA (encoded_dir
);
2107 if (mkdir (dir
) != 0)
2109 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2111 report_file_error ("Creating directory", list1 (directory
));
2116 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2117 Sdelete_directory_internal
, 1, 1, 0,
2118 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2119 (Lisp_Object directory
)
2122 Lisp_Object encoded_dir
;
2124 CHECK_STRING (directory
);
2125 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2126 encoded_dir
= ENCODE_FILE (directory
);
2127 dir
= SSDATA (encoded_dir
);
2129 if (rmdir (dir
) != 0)
2130 report_file_error ("Removing directory", list1 (directory
));
2135 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2136 "(list (read-file-name \
2137 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2138 \"Move file to trash: \" \"Delete file: \") \
2139 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2140 (null current-prefix-arg))",
2141 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2142 If file has multiple names, it continues to exist with the other names.
2143 TRASH non-nil means to trash the file instead of deleting, provided
2144 `delete-by-moving-to-trash' is non-nil.
2146 When called interactively, TRASH is t if no prefix argument is given.
2147 With a prefix argument, TRASH is nil. */)
2148 (Lisp_Object filename
, Lisp_Object trash
)
2150 Lisp_Object handler
;
2151 Lisp_Object encoded_file
;
2152 struct gcpro gcpro1
;
2155 if (!NILP (Ffile_directory_p (filename
))
2156 && NILP (Ffile_symlink_p (filename
)))
2157 xsignal2 (Qfile_error
,
2158 build_string ("Removing old name: is a directory"),
2161 filename
= Fexpand_file_name (filename
, Qnil
);
2163 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2164 if (!NILP (handler
))
2165 return call3 (handler
, Qdelete_file
, filename
, trash
);
2167 if (delete_by_moving_to_trash
&& !NILP (trash
))
2168 return call1 (Qmove_file_to_trash
, filename
);
2170 encoded_file
= ENCODE_FILE (filename
);
2172 if (0 > unlink (SSDATA (encoded_file
)))
2173 report_file_error ("Removing old name", list1 (filename
));
2178 internal_delete_file_1 (Lisp_Object ignore
)
2183 /* Delete file FILENAME.
2184 This ignores `delete-by-moving-to-trash'. */
2187 internal_delete_file (Lisp_Object filename
)
2189 internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2190 Qt
, internal_delete_file_1
);
2193 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2194 "fRename file: \nGRename %s to file: \np",
2195 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2196 If file has names other than FILE, it continues to have those names.
2197 Signals a `file-already-exists' error if a file NEWNAME already exists
2198 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2199 A number as third arg means request confirmation if NEWNAME already exists.
2200 This is what happens in interactive use with M-x. */)
2201 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2203 Lisp_Object handler
;
2204 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2205 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2207 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2208 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2209 CHECK_STRING (file
);
2210 CHECK_STRING (newname
);
2211 file
= Fexpand_file_name (file
, Qnil
);
2213 if ((!NILP (Ffile_directory_p (newname
)))
2215 /* If the file names are identical but for the case,
2216 don't attempt to move directory to itself. */
2217 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2221 Lisp_Object fname
= NILP (Ffile_directory_p (file
))
2222 ? file
: Fdirectory_file_name (file
);
2223 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2226 newname
= Fexpand_file_name (newname
, Qnil
);
2228 /* If the file name has special constructs in it,
2229 call the corresponding file handler. */
2230 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2232 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2233 if (!NILP (handler
))
2234 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2235 file
, newname
, ok_if_already_exists
));
2237 encoded_file
= ENCODE_FILE (file
);
2238 encoded_newname
= ENCODE_FILE (newname
);
2241 /* If the file names are identical but for the case, don't ask for
2242 confirmation: they simply want to change the letter-case of the
2244 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2246 if (NILP (ok_if_already_exists
)
2247 || INTEGERP (ok_if_already_exists
))
2248 barf_or_query_if_file_exists (newname
, "rename to it",
2249 INTEGERP (ok_if_already_exists
), 0, 0);
2250 if (0 > rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2255 symlink_target
= Ffile_symlink_p (file
);
2256 if (! NILP (symlink_target
))
2257 Fmake_symbolic_link (symlink_target
, newname
,
2258 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2259 else if (!NILP (Ffile_directory_p (file
)))
2260 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2262 /* We have already prompted if it was an integer, so don't
2263 have copy-file prompt again. */
2264 Fcopy_file (file
, newname
,
2265 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2268 count
= SPECPDL_INDEX ();
2269 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2271 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2272 call2 (Qdelete_directory
, file
, Qt
);
2274 Fdelete_file (file
, Qnil
);
2275 unbind_to (count
, Qnil
);
2278 report_file_error ("Renaming", list2 (file
, newname
));
2284 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2285 "fAdd name to file: \nGName to add to %s: \np",
2286 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2287 Signals a `file-already-exists' error if a file NEWNAME already exists
2288 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2289 A number as third arg means request confirmation if NEWNAME already exists.
2290 This is what happens in interactive use with M-x. */)
2291 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2293 Lisp_Object handler
;
2294 Lisp_Object encoded_file
, encoded_newname
;
2295 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2297 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2298 encoded_file
= encoded_newname
= Qnil
;
2299 CHECK_STRING (file
);
2300 CHECK_STRING (newname
);
2301 file
= Fexpand_file_name (file
, Qnil
);
2303 if (!NILP (Ffile_directory_p (newname
)))
2304 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2306 newname
= Fexpand_file_name (newname
, Qnil
);
2308 /* If the file name has special constructs in it,
2309 call the corresponding file handler. */
2310 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2311 if (!NILP (handler
))
2312 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2313 newname
, ok_if_already_exists
));
2315 /* If the new name has special constructs in it,
2316 call the corresponding file handler. */
2317 handler
= Ffind_file_name_handler (newname
, 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 encoded_file
= ENCODE_FILE (file
);
2323 encoded_newname
= ENCODE_FILE (newname
);
2325 if (NILP (ok_if_already_exists
)
2326 || INTEGERP (ok_if_already_exists
))
2327 barf_or_query_if_file_exists (newname
, "make it a new name",
2328 INTEGERP (ok_if_already_exists
), 0, 0);
2330 unlink (SSDATA (newname
));
2331 if (0 > link (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2332 report_file_error ("Adding new name", list2 (file
, newname
));
2338 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2339 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2340 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2341 Both args must be strings.
2342 Signals a `file-already-exists' error if a file LINKNAME already exists
2343 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2344 A number as third arg means request confirmation if LINKNAME already exists.
2345 This happens for interactive use with M-x. */)
2346 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2348 Lisp_Object handler
;
2349 Lisp_Object encoded_filename
, encoded_linkname
;
2350 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2352 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2353 encoded_filename
= encoded_linkname
= Qnil
;
2354 CHECK_STRING (filename
);
2355 CHECK_STRING (linkname
);
2356 /* If the link target has a ~, we must expand it to get
2357 a truly valid file name. Otherwise, do not expand;
2358 we want to permit links to relative file names. */
2359 if (SREF (filename
, 0) == '~')
2360 filename
= Fexpand_file_name (filename
, Qnil
);
2362 if (!NILP (Ffile_directory_p (linkname
)))
2363 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2365 linkname
= Fexpand_file_name (linkname
, Qnil
);
2367 /* If the file name has special constructs in it,
2368 call the corresponding file handler. */
2369 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2370 if (!NILP (handler
))
2371 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2372 linkname
, ok_if_already_exists
));
2374 /* If the new link name has special constructs in it,
2375 call the corresponding file handler. */
2376 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2377 if (!NILP (handler
))
2378 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2379 linkname
, ok_if_already_exists
));
2381 encoded_filename
= ENCODE_FILE (filename
);
2382 encoded_linkname
= ENCODE_FILE (linkname
);
2384 if (NILP (ok_if_already_exists
)
2385 || INTEGERP (ok_if_already_exists
))
2386 barf_or_query_if_file_exists (linkname
, "make it a link",
2387 INTEGERP (ok_if_already_exists
), 0, 0);
2388 if (0 > symlink (SSDATA (encoded_filename
),
2389 SSDATA (encoded_linkname
)))
2391 /* If we didn't complain already, silently delete existing file. */
2392 if (errno
== EEXIST
)
2394 unlink (SSDATA (encoded_linkname
));
2395 if (0 <= symlink (SSDATA (encoded_filename
),
2396 SSDATA (encoded_linkname
)))
2402 if (errno
== ENOSYS
)
2405 xsignal1 (Qfile_error
,
2406 build_string ("Symbolic links are not supported"));
2409 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2416 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2418 doc
: /* Return t if file FILENAME specifies an absolute file name.
2419 On Unix, this is a name starting with a `/' or a `~'. */)
2420 (Lisp_Object filename
)
2422 CHECK_STRING (filename
);
2423 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2426 /* Return true if file FILENAME exists and can be executed. */
2429 check_executable (char *filename
)
2433 if (stat (filename
, &st
) < 0)
2435 return ((st
.st_mode
& S_IEXEC
) != 0);
2436 #else /* not DOS_NT */
2437 #ifdef HAVE_EUIDACCESS
2438 return (euidaccess (filename
, 1) >= 0);
2440 /* Access isn't quite right because it uses the real uid
2441 and we really want to test with the effective uid.
2442 But Unix doesn't give us a right way to do it. */
2443 return (access (filename
, 1) >= 0);
2445 #endif /* not DOS_NT */
2448 /* Return true if file FILENAME exists and can be written. */
2451 check_writable (const char *filename
)
2455 if (stat (filename
, &st
) < 0)
2457 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2458 #else /* not MSDOS */
2459 #ifdef HAVE_EUIDACCESS
2460 bool res
= (euidaccess (filename
, 2) >= 0);
2462 /* euidaccess may have returned failure because Cygwin couldn't
2463 determine the file's UID or GID; if so, we return success. */
2467 if (stat (filename
, &st
) < 0)
2469 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2473 #else /* not HAVE_EUIDACCESS */
2474 /* Access isn't quite right because it uses the real uid
2475 and we really want to test with the effective uid.
2476 But Unix doesn't give us a right way to do it.
2477 Opening with O_WRONLY could work for an ordinary file,
2478 but would lose for directories. */
2479 return (access (filename
, 2) >= 0);
2480 #endif /* not HAVE_EUIDACCESS */
2481 #endif /* not MSDOS */
2484 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2485 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2486 See also `file-readable-p' and `file-attributes'.
2487 This returns nil for a symlink to a nonexistent file.
2488 Use `file-symlink-p' to test for such links. */)
2489 (Lisp_Object filename
)
2491 Lisp_Object absname
;
2492 Lisp_Object handler
;
2493 struct stat statbuf
;
2495 CHECK_STRING (filename
);
2496 absname
= Fexpand_file_name (filename
, Qnil
);
2498 /* If the file name has special constructs in it,
2499 call the corresponding file handler. */
2500 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2501 if (!NILP (handler
))
2502 return call2 (handler
, Qfile_exists_p
, absname
);
2504 absname
= ENCODE_FILE (absname
);
2506 return (stat (SSDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2509 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2510 doc
: /* Return t if FILENAME can be executed by you.
2511 For a directory, this means you can access files in that directory. */)
2512 (Lisp_Object filename
)
2514 Lisp_Object absname
;
2515 Lisp_Object handler
;
2517 CHECK_STRING (filename
);
2518 absname
= Fexpand_file_name (filename
, Qnil
);
2520 /* If the file name has special constructs in it,
2521 call the corresponding file handler. */
2522 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2523 if (!NILP (handler
))
2524 return call2 (handler
, Qfile_executable_p
, absname
);
2526 absname
= ENCODE_FILE (absname
);
2528 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2531 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2532 doc
: /* Return t if file FILENAME exists and you can read it.
2533 See also `file-exists-p' and `file-attributes'. */)
2534 (Lisp_Object filename
)
2536 Lisp_Object absname
;
2537 Lisp_Object handler
;
2540 struct stat statbuf
;
2542 CHECK_STRING (filename
);
2543 absname
= Fexpand_file_name (filename
, Qnil
);
2545 /* If the file name has special constructs in it,
2546 call the corresponding file handler. */
2547 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2548 if (!NILP (handler
))
2549 return call2 (handler
, Qfile_readable_p
, absname
);
2551 absname
= ENCODE_FILE (absname
);
2553 #if defined (DOS_NT) || defined (macintosh)
2554 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2556 if (access (SDATA (absname
), 0) == 0)
2559 #else /* not DOS_NT and not macintosh */
2562 /* Opening a fifo without O_NONBLOCK can wait.
2563 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2564 except in the case of a fifo, on a system which handles it. */
2565 desc
= stat (SSDATA (absname
), &statbuf
);
2568 if (S_ISFIFO (statbuf
.st_mode
))
2569 flags
|= O_NONBLOCK
;
2571 desc
= emacs_open (SSDATA (absname
), flags
, 0);
2576 #endif /* not DOS_NT and not macintosh */
2579 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2581 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2582 doc
: /* Return t if file FILENAME can be written or created by you. */)
2583 (Lisp_Object filename
)
2585 Lisp_Object absname
, dir
, encoded
;
2586 Lisp_Object handler
;
2587 struct stat statbuf
;
2589 CHECK_STRING (filename
);
2590 absname
= Fexpand_file_name (filename
, Qnil
);
2592 /* If the file name has special constructs in it,
2593 call the corresponding file handler. */
2594 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2595 if (!NILP (handler
))
2596 return call2 (handler
, Qfile_writable_p
, absname
);
2598 encoded
= ENCODE_FILE (absname
);
2599 if (stat (SSDATA (encoded
), &statbuf
) >= 0)
2600 return (check_writable (SSDATA (encoded
))
2603 dir
= Ffile_name_directory (absname
);
2606 dir
= Fdirectory_file_name (dir
);
2609 dir
= ENCODE_FILE (dir
);
2611 /* The read-only attribute of the parent directory doesn't affect
2612 whether a file or directory can be created within it. Some day we
2613 should check ACLs though, which do affect this. */
2614 if (stat (SDATA (dir
), &statbuf
) < 0)
2616 return S_ISDIR (statbuf
.st_mode
) ? Qt
: Qnil
;
2618 return (check_writable (!NILP (dir
) ? SSDATA (dir
) : "")
2623 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2624 doc
: /* Access file FILENAME, and get an error if that does not work.
2625 The second argument STRING is used in the error message.
2626 If there is no error, returns nil. */)
2627 (Lisp_Object filename
, Lisp_Object string
)
2629 Lisp_Object handler
, encoded_filename
, absname
;
2632 CHECK_STRING (filename
);
2633 absname
= Fexpand_file_name (filename
, Qnil
);
2635 CHECK_STRING (string
);
2637 /* If the file name has special constructs in it,
2638 call the corresponding file handler. */
2639 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2640 if (!NILP (handler
))
2641 return call3 (handler
, Qaccess_file
, absname
, string
);
2643 encoded_filename
= ENCODE_FILE (absname
);
2645 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2647 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2653 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2654 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2655 The value is the link target, as a string.
2656 Otherwise it returns nil.
2658 This function returns t when given the name of a symlink that
2659 points to a nonexistent file. */)
2660 (Lisp_Object filename
)
2662 Lisp_Object handler
;
2665 char readlink_buf
[READLINK_BUFSIZE
];
2667 CHECK_STRING (filename
);
2668 filename
= Fexpand_file_name (filename
, Qnil
);
2670 /* If the file name has special constructs in it,
2671 call the corresponding file handler. */
2672 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2673 if (!NILP (handler
))
2674 return call2 (handler
, Qfile_symlink_p
, filename
);
2676 filename
= ENCODE_FILE (filename
);
2678 buf
= emacs_readlink (SSDATA (filename
), readlink_buf
);
2682 val
= build_string (buf
);
2683 if (buf
[0] == '/' && strchr (buf
, ':'))
2684 val
= concat2 (build_string ("/:"), val
);
2685 if (buf
!= readlink_buf
)
2687 val
= DECODE_FILE (val
);
2691 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2692 doc
: /* Return t if FILENAME names an existing directory.
2693 Symbolic links to directories count as directories.
2694 See `file-symlink-p' to distinguish symlinks. */)
2695 (Lisp_Object filename
)
2697 register Lisp_Object absname
;
2699 Lisp_Object handler
;
2701 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2703 /* If the file name has special constructs in it,
2704 call the corresponding file handler. */
2705 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2706 if (!NILP (handler
))
2707 return call2 (handler
, Qfile_directory_p
, absname
);
2709 absname
= ENCODE_FILE (absname
);
2711 if (stat (SSDATA (absname
), &st
) < 0)
2713 return S_ISDIR (st
.st_mode
) ? Qt
: Qnil
;
2716 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2717 Sfile_accessible_directory_p
, 1, 1, 0,
2718 doc
: /* Return t if file FILENAME names a directory you can open.
2719 For the value to be t, FILENAME must specify the name of a directory as a file,
2720 and the directory must allow you to open files in it. In order to use a
2721 directory as a buffer's current directory, this predicate must return true.
2722 A directory name spec may be given instead; then the value is t
2723 if the directory so specified exists and really is a readable and
2724 searchable directory. */)
2725 (Lisp_Object filename
)
2727 Lisp_Object handler
;
2729 struct gcpro gcpro1
;
2731 /* If the file name has special constructs in it,
2732 call the corresponding file handler. */
2733 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2734 if (!NILP (handler
))
2735 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2738 tem
= (NILP (Ffile_directory_p (filename
))
2739 || NILP (Ffile_executable_p (filename
)));
2741 return tem
? Qnil
: Qt
;
2744 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2745 doc
: /* Return t if FILENAME names a regular file.
2746 This is the sort of file that holds an ordinary stream of data bytes.
2747 Symbolic links to regular files count as regular files.
2748 See `file-symlink-p' to distinguish symlinks. */)
2749 (Lisp_Object filename
)
2751 register Lisp_Object absname
;
2753 Lisp_Object handler
;
2755 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2757 /* If the file name has special constructs in it,
2758 call the corresponding file handler. */
2759 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2760 if (!NILP (handler
))
2761 return call2 (handler
, Qfile_regular_p
, absname
);
2763 absname
= ENCODE_FILE (absname
);
2768 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2770 /* Tell stat to use expensive method to get accurate info. */
2771 Vw32_get_true_file_attributes
= Qt
;
2772 result
= stat (SDATA (absname
), &st
);
2773 Vw32_get_true_file_attributes
= tem
;
2777 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2780 if (stat (SSDATA (absname
), &st
) < 0)
2782 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2786 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2787 Sfile_selinux_context
, 1, 1, 0,
2788 doc
: /* Return SELinux context of file named FILENAME.
2789 The return value is a list (USER ROLE TYPE RANGE), where the list
2790 elements are strings naming the user, role, type, and range of the
2791 file's SELinux security context.
2793 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2794 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2795 (Lisp_Object filename
)
2797 Lisp_Object absname
;
2798 Lisp_Object values
[4];
2799 Lisp_Object handler
;
2801 security_context_t con
;
2806 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2808 /* If the file name has special constructs in it,
2809 call the corresponding file handler. */
2810 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2811 if (!NILP (handler
))
2812 return call2 (handler
, Qfile_selinux_context
, absname
);
2814 absname
= ENCODE_FILE (absname
);
2821 if (is_selinux_enabled ())
2823 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2826 context
= context_new (con
);
2827 if (context_user_get (context
))
2828 values
[0] = build_string (context_user_get (context
));
2829 if (context_role_get (context
))
2830 values
[1] = build_string (context_role_get (context
));
2831 if (context_type_get (context
))
2832 values
[2] = build_string (context_type_get (context
));
2833 if (context_range_get (context
))
2834 values
[3] = build_string (context_range_get (context
));
2835 context_free (context
);
2842 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2845 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2846 Sset_file_selinux_context
, 2, 2, 0,
2847 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2848 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2849 elements are strings naming the components of a SELinux context.
2851 This function does nothing if SELinux is disabled, or if Emacs was not
2852 compiled with SELinux support. */)
2853 (Lisp_Object filename
, Lisp_Object context
)
2855 Lisp_Object absname
;
2856 Lisp_Object handler
;
2858 Lisp_Object encoded_absname
;
2859 Lisp_Object user
= CAR_SAFE (context
);
2860 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2861 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2862 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2863 security_context_t con
;
2866 context_t parsed_con
;
2869 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2871 /* If the file name has special constructs in it,
2872 call the corresponding file handler. */
2873 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2874 if (!NILP (handler
))
2875 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2878 if (is_selinux_enabled ())
2880 /* Get current file context. */
2881 encoded_absname
= ENCODE_FILE (absname
);
2882 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2885 parsed_con
= context_new (con
);
2886 /* Change the parts defined in the parameter.*/
2889 if (context_user_set (parsed_con
, SSDATA (user
)))
2890 error ("Doing context_user_set");
2894 if (context_role_set (parsed_con
, SSDATA (role
)))
2895 error ("Doing context_role_set");
2899 if (context_type_set (parsed_con
, SSDATA (type
)))
2900 error ("Doing context_type_set");
2902 if (STRINGP (range
))
2904 if (context_range_set (parsed_con
, SSDATA (range
)))
2905 error ("Doing context_range_set");
2908 /* Set the modified context back to the file. */
2909 fail
= (lsetfilecon (SSDATA (encoded_absname
),
2910 context_str (parsed_con
))
2912 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2913 if (fail
&& errno
!= ENOTSUP
)
2914 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
2916 context_free (parsed_con
);
2919 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
2929 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2930 doc
: /* Return mode bits of file named FILENAME, as an integer.
2931 Return nil, if file does not exist or is not accessible. */)
2932 (Lisp_Object filename
)
2934 Lisp_Object absname
;
2936 Lisp_Object handler
;
2938 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2940 /* If the file name has special constructs in it,
2941 call the corresponding file handler. */
2942 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2943 if (!NILP (handler
))
2944 return call2 (handler
, Qfile_modes
, absname
);
2946 absname
= ENCODE_FILE (absname
);
2948 if (stat (SSDATA (absname
), &st
) < 0)
2951 return make_number (st
.st_mode
& 07777);
2954 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2955 "(let ((file (read-file-name \"File: \"))) \
2956 (list file (read-file-modes nil file)))",
2957 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2958 Only the 12 low bits of MODE are used.
2960 Interactively, mode bits are read by `read-file-modes', which accepts
2961 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2962 (Lisp_Object filename
, Lisp_Object mode
)
2964 Lisp_Object absname
, encoded_absname
;
2965 Lisp_Object handler
;
2967 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2968 CHECK_NUMBER (mode
);
2970 /* If the file name has special constructs in it,
2971 call the corresponding file handler. */
2972 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2973 if (!NILP (handler
))
2974 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2976 encoded_absname
= ENCODE_FILE (absname
);
2978 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
2979 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2984 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2985 doc
: /* Set the file permission bits for newly created files.
2986 The argument MODE should be an integer; only the low 9 bits are used.
2987 This setting is inherited by subprocesses. */)
2990 CHECK_NUMBER (mode
);
2992 umask ((~ XINT (mode
)) & 0777);
2997 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
2998 doc
: /* Return the default file protection for created files.
2999 The value is an integer. */)
3006 realmask
= umask (0);
3010 XSETINT (value
, (~ realmask
) & 0777);
3015 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3016 doc
: /* Set times of file FILENAME to TIMESTAMP.
3017 Set both access and modification times.
3018 Return t on success, else nil.
3019 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3021 (Lisp_Object filename
, Lisp_Object timestamp
)
3023 Lisp_Object absname
, encoded_absname
;
3024 Lisp_Object handler
;
3025 EMACS_TIME t
= lisp_time_argument (timestamp
);
3027 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3029 /* If the file name has special constructs in it,
3030 call the corresponding file handler. */
3031 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3032 if (!NILP (handler
))
3033 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3035 encoded_absname
= ENCODE_FILE (absname
);
3038 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3043 /* Setting times on a directory always fails. */
3044 if (stat (SSDATA (encoded_absname
), &st
) == 0 && S_ISDIR (st
.st_mode
))
3047 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3056 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3057 doc
: /* Tell Unix to finish all pending disk updates. */)
3064 #endif /* HAVE_SYNC */
3066 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3067 doc
: /* Return t if file FILE1 is newer than file FILE2.
3068 If FILE1 does not exist, the answer is nil;
3069 otherwise, if FILE2 does not exist, the answer is t. */)
3070 (Lisp_Object file1
, Lisp_Object file2
)
3072 Lisp_Object absname1
, absname2
;
3073 struct stat st1
, st2
;
3074 Lisp_Object handler
;
3075 struct gcpro gcpro1
, gcpro2
;
3077 CHECK_STRING (file1
);
3078 CHECK_STRING (file2
);
3081 GCPRO2 (absname1
, file2
);
3082 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3083 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3086 /* If the file name has special constructs in it,
3087 call the corresponding file handler. */
3088 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3090 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3091 if (!NILP (handler
))
3092 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3094 GCPRO2 (absname1
, absname2
);
3095 absname1
= ENCODE_FILE (absname1
);
3096 absname2
= ENCODE_FILE (absname2
);
3099 if (stat (SSDATA (absname1
), &st1
) < 0)
3102 if (stat (SSDATA (absname2
), &st2
) < 0)
3105 return (EMACS_TIME_GT (get_stat_mtime (&st1
), get_stat_mtime (&st2
))
3109 #ifndef READ_BUF_SIZE
3110 #define READ_BUF_SIZE (64 << 10)
3112 /* Some buffer offsets are stored in 'int' variables. */
3113 verify (READ_BUF_SIZE
<= INT_MAX
);
3115 /* This function is called after Lisp functions to decide a coding
3116 system are called, or when they cause an error. Before they are
3117 called, the current buffer is set unibyte and it contains only a
3118 newly inserted text (thus the buffer was empty before the
3121 The functions may set markers, overlays, text properties, or even
3122 alter the buffer contents, change the current buffer.
3124 Here, we reset all those changes by:
3125 o set back the current buffer.
3126 o move all markers and overlays to BEG.
3127 o remove all text properties.
3128 o set back the buffer multibyteness. */
3131 decide_coding_unwind (Lisp_Object unwind_data
)
3133 Lisp_Object multibyte
, undo_list
, buffer
;
3135 multibyte
= XCAR (unwind_data
);
3136 unwind_data
= XCDR (unwind_data
);
3137 undo_list
= XCAR (unwind_data
);
3138 buffer
= XCDR (unwind_data
);
3140 set_buffer_internal (XBUFFER (buffer
));
3141 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3142 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3143 set_buffer_intervals (current_buffer
, NULL
);
3144 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3146 /* Now we are safe to change the buffer's multibyteness directly. */
3147 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3148 bset_undo_list (current_buffer
, undo_list
);
3154 /* Used to pass values from insert-file-contents to read_non_regular. */
3156 static int non_regular_fd
;
3157 static ptrdiff_t non_regular_inserted
;
3158 static int non_regular_nbytes
;
3161 /* Read from a non-regular file.
3162 Read non_regular_nbytes bytes max from non_regular_fd.
3163 Non_regular_inserted specifies where to put the read bytes.
3164 Value is the number of bytes read. */
3167 read_non_regular (Lisp_Object ignore
)
3173 nbytes
= emacs_read (non_regular_fd
,
3174 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3175 + non_regular_inserted
),
3176 non_regular_nbytes
);
3178 return make_number (nbytes
);
3182 /* Condition-case handler used when reading from non-regular files
3183 in insert-file-contents. */
3186 read_non_regular_quit (Lisp_Object ignore
)
3191 /* Reposition FD to OFFSET, based on WHENCE. This acts like lseek
3192 except that it also tests for OFFSET being out of lseek's range. */
3194 emacs_lseek (int fd
, EMACS_INT offset
, int whence
)
3196 /* Use "&" rather than "&&" to suppress a bogus GCC warning; see
3197 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43772>. */
3198 if (! ((TYPE_MINIMUM (off_t
) <= offset
) & (offset
<= TYPE_MAXIMUM (off_t
))))
3203 return lseek (fd
, offset
, whence
);
3206 /* Return a special time value indicating the error number ERRNUM. */
3208 time_error_value (int errnum
)
3210 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3211 ? NONEXISTENT_MODTIME_NSECS
3212 : UNKNOWN_MODTIME_NSECS
);
3213 return make_emacs_time (0, ns
);
3216 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3218 doc
: /* Insert contents of file FILENAME after point.
3219 Returns list of absolute file name and number of characters inserted.
3220 If second argument VISIT is non-nil, the buffer's visited filename and
3221 last save file modtime are set, and it is marked unmodified. If
3222 visiting and the file does not exist, visiting is completed before the
3225 The optional third and fourth arguments BEG and END specify what portion
3226 of the file to insert. These arguments count bytes in the file, not
3227 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3229 If optional fifth argument REPLACE is non-nil, replace the current
3230 buffer contents (in the accessible portion) with the file contents.
3231 This is better than simply deleting and inserting the whole thing
3232 because (1) it preserves some marker positions and (2) it puts less data
3233 in the undo list. When REPLACE is non-nil, the second return value is
3234 the number of characters that replace previous buffer contents.
3236 This function does code conversion according to the value of
3237 `coding-system-for-read' or `file-coding-system-alist', and sets the
3238 variable `last-coding-system-used' to the coding system actually used. */)
3239 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3245 ptrdiff_t inserted
= 0;
3248 off_t beg_offset
, end_offset
;
3250 ptrdiff_t count
= SPECPDL_INDEX ();
3251 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3252 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3254 ptrdiff_t total
= 0;
3255 bool not_regular
= 0;
3257 char read_buf
[READ_BUF_SIZE
];
3258 struct coding_system coding
;
3259 char buffer
[1 << 14];
3260 bool replace_handled
= 0;
3261 bool set_coding_system
= 0;
3262 Lisp_Object coding_system
;
3264 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3265 bool we_locked_file
= 0;
3266 bool deferred_remove_unwind_protect
= 0;
3268 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3269 error ("Cannot do file visiting in an indirect buffer");
3271 if (!NILP (BVAR (current_buffer
, read_only
)))
3272 Fbarf_if_buffer_read_only ();
3276 orig_filename
= Qnil
;
3279 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3281 CHECK_STRING (filename
);
3282 filename
= Fexpand_file_name (filename
, Qnil
);
3284 /* The value Qnil means that the coding system is not yet
3286 coding_system
= Qnil
;
3288 /* If the file name has special constructs in it,
3289 call the corresponding file handler. */
3290 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3291 if (!NILP (handler
))
3293 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3294 visit
, beg
, end
, replace
);
3295 if (CONSP (val
) && CONSP (XCDR (val
))
3296 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3297 inserted
= XINT (XCAR (XCDR (val
)));
3301 orig_filename
= filename
;
3302 filename
= ENCODE_FILE (filename
);
3308 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3310 /* Tell stat to use expensive method to get accurate info. */
3311 Vw32_get_true_file_attributes
= Qt
;
3312 file_status
= stat (SSDATA (filename
), &st
);
3313 Vw32_get_true_file_attributes
= tem
;
3316 file_status
= stat (SSDATA (filename
), &st
);
3317 #endif /* WINDOWSNT */
3319 if (file_status
== 0)
3320 mtime
= get_stat_mtime (&st
);
3326 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3327 mtime
= time_error_value (save_errno
);
3330 if (!NILP (Vcoding_system_for_read
))
3331 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3335 /* This code will need to be changed in order to work on named
3336 pipes, and it's probably just not worth it. So we should at
3337 least signal an error. */
3338 if (!S_ISREG (st
.st_mode
))
3345 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3346 xsignal2 (Qfile_error
,
3347 build_string ("not a regular file"), orig_filename
);
3351 if ((fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0)) < 0)
3354 /* Replacement should preserve point as it preserves markers. */
3355 if (!NILP (replace
))
3356 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3358 record_unwind_protect (close_file_unwind
, make_number (fd
));
3363 if (!NILP (beg
) || !NILP (end
))
3364 error ("Attempt to visit less than an entire file");
3365 if (BEG
< Z
&& NILP (replace
))
3366 error ("Cannot do file visiting in a non-empty buffer");
3371 if (! (RANGED_INTEGERP (0, beg
, TYPE_MAXIMUM (off_t
))))
3372 wrong_type_argument (intern ("file-offset"), beg
);
3373 beg_offset
= XFASTINT (beg
);
3380 if (! (RANGED_INTEGERP (0, end
, TYPE_MAXIMUM (off_t
))))
3381 wrong_type_argument (intern ("file-offset"), end
);
3382 end_offset
= XFASTINT (end
);
3387 end_offset
= TYPE_MAXIMUM (off_t
);
3390 end_offset
= st
.st_size
;
3392 /* A negative size can happen on a platform that allows file
3393 sizes greater than the maximum off_t value. */
3397 /* The file size returned from stat may be zero, but data
3398 may be readable nonetheless, for example when this is a
3399 file in the /proc filesystem. */
3400 if (end_offset
== 0)
3401 end_offset
= READ_BUF_SIZE
;
3405 /* Check now whether the buffer will become too large,
3406 in the likely case where the file's length is not changing.
3407 This saves a lot of needless work before a buffer overflow. */
3410 /* The likely offset where we will stop reading. We could read
3411 more (or less), if the file grows (or shrinks) as we read it. */
3412 off_t likely_end
= min (end_offset
, st
.st_size
);
3414 if (beg_offset
< likely_end
)
3416 ptrdiff_t buf_bytes
=
3417 Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3418 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3419 off_t likely_growth
= likely_end
- beg_offset
;
3420 if (buf_growth_max
< likely_growth
)
3425 /* Prevent redisplay optimizations. */
3426 current_buffer
->clip_changed
= 1;
3428 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3430 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3431 setup_coding_system (coding_system
, &coding
);
3432 /* Ensure we set Vlast_coding_system_used. */
3433 set_coding_system
= 1;
3437 /* Decide the coding system to use for reading the file now
3438 because we can't use an optimized method for handling
3439 `coding:' tag if the current buffer is not empty. */
3440 if (!NILP (Vcoding_system_for_read
))
3441 coding_system
= Vcoding_system_for_read
;
3444 /* Don't try looking inside a file for a coding system
3445 specification if it is not seekable. */
3446 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3448 /* Find a coding system specified in the heading two
3449 lines or in the tailing several lines of the file.
3450 We assume that the 1K-byte and 3K-byte for heading
3451 and tailing respectively are sufficient for this
3455 if (st
.st_size
<= (1024 * 4))
3456 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3459 nread
= emacs_read (fd
, read_buf
, 1024);
3462 if (lseek (fd
, st
.st_size
- (1024 * 3), SEEK_SET
) < 0)
3463 report_file_error ("Setting file position",
3464 Fcons (orig_filename
, Qnil
));
3465 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3470 error ("IO error reading %s: %s",
3471 SDATA (orig_filename
), emacs_strerror (errno
));
3474 struct buffer
*prev
= current_buffer
;
3475 Lisp_Object workbuf
;
3478 record_unwind_current_buffer ();
3480 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3481 buf
= XBUFFER (workbuf
);
3483 delete_all_overlays (buf
);
3484 bset_directory (buf
, BVAR (current_buffer
, directory
));
3485 bset_read_only (buf
, Qnil
);
3486 bset_filename (buf
, Qnil
);
3487 bset_undo_list (buf
, Qt
);
3488 eassert (buf
->overlays_before
== NULL
);
3489 eassert (buf
->overlays_after
== NULL
);
3491 set_buffer_internal (buf
);
3493 bset_enable_multibyte_characters (buf
, Qnil
);
3495 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3496 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3497 coding_system
= call2 (Vset_auto_coding_function
,
3498 filename
, make_number (nread
));
3499 set_buffer_internal (prev
);
3501 /* Discard the unwind protect for recovering the
3505 /* Rewind the file for the actual read done later. */
3506 if (lseek (fd
, 0, SEEK_SET
) < 0)
3507 report_file_error ("Setting file position",
3508 Fcons (orig_filename
, Qnil
));
3512 if (NILP (coding_system
))
3514 /* If we have not yet decided a coding system, check
3515 file-coding-system-alist. */
3516 Lisp_Object args
[6];
3518 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3519 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3520 coding_system
= Ffind_operation_coding_system (6, args
);
3521 if (CONSP (coding_system
))
3522 coding_system
= XCAR (coding_system
);
3526 if (NILP (coding_system
))
3527 coding_system
= Qundecided
;
3529 CHECK_CODING_SYSTEM (coding_system
);
3531 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3532 /* We must suppress all character code conversion except for
3533 end-of-line conversion. */
3534 coding_system
= raw_text_coding_system (coding_system
);
3536 setup_coding_system (coding_system
, &coding
);
3537 /* Ensure we set Vlast_coding_system_used. */
3538 set_coding_system
= 1;
3541 /* If requested, replace the accessible part of the buffer
3542 with the file contents. Avoid replacing text at the
3543 beginning or end of the buffer that matches the file contents;
3544 that preserves markers pointing to the unchanged parts.
3546 Here we implement this feature in an optimized way
3547 for the case where code conversion is NOT needed.
3548 The following if-statement handles the case of conversion
3549 in a less optimal way.
3551 If the code conversion is "automatic" then we try using this
3552 method and hope for the best.
3553 But if we discover the need for conversion, we give up on this method
3554 and let the following if-statement handle the replace job. */
3557 && (NILP (coding_system
)
3558 || ! CODING_REQUIRE_DECODING (&coding
)))
3560 /* same_at_start and same_at_end count bytes,
3561 because file access counts bytes
3562 and BEG and END count bytes. */
3563 ptrdiff_t same_at_start
= BEGV_BYTE
;
3564 ptrdiff_t same_at_end
= ZV_BYTE
;
3566 /* There is still a possibility we will find the need to do code
3567 conversion. If that happens, set this variable to
3568 give up on handling REPLACE in the optimized way. */
3569 bool giveup_match_end
= 0;
3571 if (beg_offset
!= 0)
3573 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3574 report_file_error ("Setting file position",
3575 Fcons (orig_filename
, Qnil
));
3580 /* Count how many chars at the start of the file
3581 match the text at the beginning of the buffer. */
3586 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3588 error ("IO error reading %s: %s",
3589 SSDATA (orig_filename
), emacs_strerror (errno
));
3590 else if (nread
== 0)
3593 if (CODING_REQUIRE_DETECTION (&coding
))
3595 coding_system
= detect_coding_system ((unsigned char *) buffer
,
3598 setup_coding_system (coding_system
, &coding
);
3601 if (CODING_REQUIRE_DECODING (&coding
))
3602 /* We found that the file should be decoded somehow.
3603 Let's give up here. */
3605 giveup_match_end
= 1;
3610 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3611 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3612 same_at_start
++, bufpos
++;
3613 /* If we found a discrepancy, stop the scan.
3614 Otherwise loop around and scan the next bufferful. */
3615 if (bufpos
!= nread
)
3619 /* If the file matches the buffer completely,
3620 there's no need to replace anything. */
3621 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3625 /* Truncate the buffer to the size of the file. */
3626 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3631 /* Count how many chars at the end of the file
3632 match the text at the end of the buffer. But, if we have
3633 already found that decoding is necessary, don't waste time. */
3634 while (!giveup_match_end
)
3636 int total_read
, nread
, bufpos
, trial
;
3639 /* At what file position are we now scanning? */
3640 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3641 /* If the entire file matches the buffer tail, stop the scan. */
3644 /* How much can we scan in the next step? */
3645 trial
= min (curpos
, sizeof buffer
);
3646 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3647 report_file_error ("Setting file position",
3648 Fcons (orig_filename
, Qnil
));
3650 total_read
= nread
= 0;
3651 while (total_read
< trial
)
3653 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3655 error ("IO error reading %s: %s",
3656 SDATA (orig_filename
), emacs_strerror (errno
));
3657 else if (nread
== 0)
3659 total_read
+= nread
;
3662 /* Scan this bufferful from the end, comparing with
3663 the Emacs buffer. */
3664 bufpos
= total_read
;
3666 /* Compare with same_at_start to avoid counting some buffer text
3667 as matching both at the file's beginning and at the end. */
3668 while (bufpos
> 0 && same_at_end
> same_at_start
3669 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3670 same_at_end
--, bufpos
--;
3672 /* If we found a discrepancy, stop the scan.
3673 Otherwise loop around and scan the preceding bufferful. */
3676 /* If this discrepancy is because of code conversion,
3677 we cannot use this method; giveup and try the other. */
3678 if (same_at_end
> same_at_start
3679 && FETCH_BYTE (same_at_end
- 1) >= 0200
3680 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3681 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3682 giveup_match_end
= 1;
3691 if (! giveup_match_end
)
3695 /* We win! We can handle REPLACE the optimized way. */
3697 /* Extend the start of non-matching text area to multibyte
3698 character boundary. */
3699 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3700 while (same_at_start
> BEGV_BYTE
3701 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3704 /* Extend the end of non-matching text area to multibyte
3705 character boundary. */
3706 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3707 while (same_at_end
< ZV_BYTE
3708 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3711 /* Don't try to reuse the same piece of text twice. */
3712 overlap
= (same_at_start
- BEGV_BYTE
3714 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3716 same_at_end
+= overlap
;
3718 /* Arrange to read only the nonmatching middle part of the file. */
3719 beg_offset
+= same_at_start
- BEGV_BYTE
;
3720 end_offset
-= ZV_BYTE
- same_at_end
;
3722 del_range_byte (same_at_start
, same_at_end
, 0);
3723 /* Insert from the file at the proper position. */
3724 temp
= BYTE_TO_CHAR (same_at_start
);
3725 SET_PT_BOTH (temp
, same_at_start
);
3727 /* If display currently starts at beginning of line,
3728 keep it that way. */
3729 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3730 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3732 replace_handled
= 1;
3736 /* If requested, replace the accessible part of the buffer
3737 with the file contents. Avoid replacing text at the
3738 beginning or end of the buffer that matches the file contents;
3739 that preserves markers pointing to the unchanged parts.
3741 Here we implement this feature for the case where code conversion
3742 is needed, in a simple way that needs a lot of memory.
3743 The preceding if-statement handles the case of no conversion
3744 in a more optimized way. */
3745 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3747 ptrdiff_t same_at_start
= BEGV_BYTE
;
3748 ptrdiff_t same_at_end
= ZV_BYTE
;
3749 ptrdiff_t same_at_start_charpos
;
3750 ptrdiff_t inserted_chars
;
3753 unsigned char *decoded
;
3756 ptrdiff_t this_count
= SPECPDL_INDEX ();
3758 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3759 Lisp_Object conversion_buffer
;
3760 struct gcpro gcpro1
;
3762 conversion_buffer
= code_conversion_save (1, multibyte
);
3764 /* First read the whole file, performing code conversion into
3765 CONVERSION_BUFFER. */
3767 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3768 report_file_error ("Setting file position",
3769 Fcons (orig_filename
, Qnil
));
3771 total
= st
.st_size
; /* Total bytes in the file. */
3772 how_much
= 0; /* Bytes read from file so far. */
3773 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3774 unprocessed
= 0; /* Bytes not processed in previous loop. */
3776 GCPRO1 (conversion_buffer
);
3777 while (how_much
< total
)
3779 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3780 quitting while reading a huge while. */
3781 /* `try'' is reserved in some compilers (Microsoft C). */
3782 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
3784 /* Allow quitting out of the actual I/O. */
3787 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3795 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3796 BUF_Z (XBUFFER (conversion_buffer
)));
3797 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3798 unprocessed
+ this, conversion_buffer
);
3799 unprocessed
= coding
.carryover_bytes
;
3800 if (coding
.carryover_bytes
> 0)
3801 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3806 /* We should remove the unwind_protect calling
3807 close_file_unwind, but other stuff has been added the stack,
3808 so defer the removal till we reach the `handled' label. */
3809 deferred_remove_unwind_protect
= 1;
3811 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3812 if we couldn't read the file. */
3815 error ("IO error reading %s: %s",
3816 SDATA (orig_filename
), emacs_strerror (errno
));
3818 if (unprocessed
> 0)
3820 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3821 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3822 unprocessed
, conversion_buffer
);
3823 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3826 coding_system
= CODING_ID_NAME (coding
.id
);
3827 set_coding_system
= 1;
3828 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3829 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3830 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3832 /* Compare the beginning of the converted string with the buffer
3836 while (bufpos
< inserted
&& same_at_start
< same_at_end
3837 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3838 same_at_start
++, bufpos
++;
3840 /* If the file matches the head of buffer completely,
3841 there's no need to replace anything. */
3843 if (bufpos
== inserted
)
3845 /* Truncate the buffer to the size of the file. */
3846 if (same_at_start
== same_at_end
)
3849 del_range_byte (same_at_start
, same_at_end
, 0);
3852 unbind_to (this_count
, Qnil
);
3856 /* Extend the start of non-matching text area to the previous
3857 multibyte character boundary. */
3858 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3859 while (same_at_start
> BEGV_BYTE
3860 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3863 /* Scan this bufferful from the end, comparing with
3864 the Emacs buffer. */
3867 /* Compare with same_at_start to avoid counting some buffer text
3868 as matching both at the file's beginning and at the end. */
3869 while (bufpos
> 0 && same_at_end
> same_at_start
3870 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3871 same_at_end
--, bufpos
--;
3873 /* Extend the end of non-matching text area to the next
3874 multibyte character boundary. */
3875 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3876 while (same_at_end
< ZV_BYTE
3877 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3880 /* Don't try to reuse the same piece of text twice. */
3881 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3883 same_at_end
+= overlap
;
3885 /* If display currently starts at beginning of line,
3886 keep it that way. */
3887 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3888 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3890 /* Replace the chars that we need to replace,
3891 and update INSERTED to equal the number of bytes
3892 we are taking from the decoded string. */
3893 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3895 if (same_at_end
!= same_at_start
)
3897 del_range_byte (same_at_start
, same_at_end
, 0);
3899 same_at_start
= GPT_BYTE
;
3903 temp
= BYTE_TO_CHAR (same_at_start
);
3905 /* Insert from the file at the proper position. */
3906 SET_PT_BOTH (temp
, same_at_start
);
3907 same_at_start_charpos
3908 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3909 same_at_start
- BEGV_BYTE
3910 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3912 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3913 same_at_start
+ inserted
- BEGV_BYTE
3914 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3915 - same_at_start_charpos
);
3916 /* This binding is to avoid ask-user-about-supersession-threat
3917 being called in insert_from_buffer (via in
3918 prepare_to_modify_buffer). */
3919 specbind (intern ("buffer-file-name"), Qnil
);
3920 insert_from_buffer (XBUFFER (conversion_buffer
),
3921 same_at_start_charpos
, inserted_chars
, 0);
3922 /* Set `inserted' to the number of inserted characters. */
3923 inserted
= PT
- temp
;
3924 /* Set point before the inserted characters. */
3925 SET_PT_BOTH (temp
, same_at_start
);
3927 unbind_to (this_count
, Qnil
);
3933 total
= end_offset
- beg_offset
;
3935 /* For a special file, all we can do is guess. */
3936 total
= READ_BUF_SIZE
;
3938 if (NILP (visit
) && total
> 0)
3940 #ifdef CLASH_DETECTION
3941 if (!NILP (BVAR (current_buffer
, file_truename
))
3942 /* Make binding buffer-file-name to nil effective. */
3943 && !NILP (BVAR (current_buffer
, filename
))
3944 && SAVE_MODIFF
>= MODIFF
)
3946 #endif /* CLASH_DETECTION */
3947 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3951 if (GAP_SIZE
< total
)
3952 make_gap (total
- GAP_SIZE
);
3954 if (beg_offset
!= 0 || !NILP (replace
))
3956 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3957 report_file_error ("Setting file position",
3958 Fcons (orig_filename
, Qnil
));
3961 /* In the following loop, HOW_MUCH contains the total bytes read so
3962 far for a regular file, and not changed for a special file. But,
3963 before exiting the loop, it is set to a negative value if I/O
3967 /* Total bytes inserted. */
3970 /* Here, we don't do code conversion in the loop. It is done by
3971 decode_coding_gap after all data are read into the buffer. */
3973 ptrdiff_t gap_size
= GAP_SIZE
;
3975 while (how_much
< total
)
3977 /* try is reserved in some compilers (Microsoft C) */
3978 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3985 /* Maybe make more room. */
3986 if (gap_size
< trytry
)
3988 make_gap (total
- gap_size
);
3989 gap_size
= GAP_SIZE
;
3992 /* Read from the file, capturing `quit'. When an
3993 error occurs, end the loop, and arrange for a quit
3994 to be signaled after decoding the text we read. */
3995 non_regular_fd
= fd
;
3996 non_regular_inserted
= inserted
;
3997 non_regular_nbytes
= trytry
;
3998 nbytes
= internal_condition_case_1 (read_non_regular
,
4000 read_non_regular_quit
);
4007 this = XINT (nbytes
);
4011 /* Allow quitting out of the actual I/O. We don't make text
4012 part of the buffer until all the reading is done, so a C-g
4013 here doesn't do any harm. */
4016 this = emacs_read (fd
,
4017 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4031 /* For a regular file, where TOTAL is the real size,
4032 count HOW_MUCH to compare with it.
4033 For a special file, where TOTAL is just a buffer size,
4034 so don't bother counting in HOW_MUCH.
4035 (INSERTED is where we count the number of characters inserted.) */
4042 /* Now we have read all the file data into the gap.
4043 If it was empty, undo marking the buffer modified. */
4047 #ifdef CLASH_DETECTION
4049 unlock_file (BVAR (current_buffer
, file_truename
));
4051 Vdeactivate_mark
= old_Vdeactivate_mark
;
4054 Vdeactivate_mark
= Qt
;
4056 /* Make the text read part of the buffer. */
4057 GAP_SIZE
-= inserted
;
4059 GPT_BYTE
+= inserted
;
4061 ZV_BYTE
+= inserted
;
4066 /* Put an anchor to ensure multi-byte form ends at gap. */
4071 /* Discard the unwind protect for closing the file. */
4075 error ("IO error reading %s: %s",
4076 SDATA (orig_filename
), emacs_strerror (errno
));
4080 if (NILP (coding_system
))
4082 /* The coding system is not yet decided. Decide it by an
4083 optimized method for handling `coding:' tag.
4085 Note that we can get here only if the buffer was empty
4086 before the insertion. */
4088 if (!NILP (Vcoding_system_for_read
))
4089 coding_system
= Vcoding_system_for_read
;
4092 /* Since we are sure that the current buffer was empty
4093 before the insertion, we can toggle
4094 enable-multibyte-characters directly here without taking
4095 care of marker adjustment. By this way, we can run Lisp
4096 program safely before decoding the inserted text. */
4097 Lisp_Object unwind_data
;
4098 ptrdiff_t count1
= SPECPDL_INDEX ();
4100 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4101 Fcons (BVAR (current_buffer
, undo_list
),
4102 Fcurrent_buffer ()));
4103 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4104 bset_undo_list (current_buffer
, Qt
);
4105 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4107 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4109 coding_system
= call2 (Vset_auto_coding_function
,
4110 filename
, make_number (inserted
));
4113 if (NILP (coding_system
))
4115 /* If the coding system is not yet decided, check
4116 file-coding-system-alist. */
4117 Lisp_Object args
[6];
4119 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4120 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4121 coding_system
= Ffind_operation_coding_system (6, args
);
4122 if (CONSP (coding_system
))
4123 coding_system
= XCAR (coding_system
);
4125 unbind_to (count1
, Qnil
);
4126 inserted
= Z_BYTE
- BEG_BYTE
;
4129 if (NILP (coding_system
))
4130 coding_system
= Qundecided
;
4132 CHECK_CODING_SYSTEM (coding_system
);
4134 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4135 /* We must suppress all character code conversion except for
4136 end-of-line conversion. */
4137 coding_system
= raw_text_coding_system (coding_system
);
4138 setup_coding_system (coding_system
, &coding
);
4139 /* Ensure we set Vlast_coding_system_used. */
4140 set_coding_system
= 1;
4145 /* When we visit a file by raw-text, we change the buffer to
4147 if (CODING_FOR_UNIBYTE (&coding
)
4148 /* Can't do this if part of the buffer might be preserved. */
4150 /* Visiting a file with these coding system makes the buffer
4152 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4155 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4156 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4157 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4159 move_gap_both (PT
, PT_BYTE
);
4160 GAP_SIZE
+= inserted
;
4161 ZV_BYTE
-= inserted
;
4165 decode_coding_gap (&coding
, inserted
, inserted
);
4166 inserted
= coding
.produced_char
;
4167 coding_system
= CODING_ID_NAME (coding
.id
);
4169 else if (inserted
> 0)
4170 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4173 /* Call after-change hooks for the inserted text, aside from the case
4174 of normal visiting (not with REPLACE), which is done in a new buffer
4175 "before" the buffer is changed. */
4176 if (inserted
> 0 && total
> 0
4177 && (NILP (visit
) || !NILP (replace
)))
4179 signal_after_change (PT
, 0, inserted
);
4180 update_compositions (PT
, PT
, CHECK_BORDER
);
4183 /* Now INSERTED is measured in characters. */
4187 if (deferred_remove_unwind_protect
)
4188 /* If requested above, discard the unwind protect for closing the
4194 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4195 bset_undo_list (current_buffer
, Qnil
);
4199 current_buffer
->modtime
= mtime
;
4200 current_buffer
->modtime_size
= st
.st_size
;
4201 bset_filename (current_buffer
, orig_filename
);
4204 SAVE_MODIFF
= MODIFF
;
4205 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4206 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4207 #ifdef CLASH_DETECTION
4210 if (!NILP (BVAR (current_buffer
, file_truename
)))
4211 unlock_file (BVAR (current_buffer
, file_truename
));
4212 unlock_file (filename
);
4214 #endif /* CLASH_DETECTION */
4216 xsignal2 (Qfile_error
,
4217 build_string ("not a regular file"), orig_filename
);
4220 if (set_coding_system
)
4221 Vlast_coding_system_used
= coding_system
;
4223 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4225 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4227 if (! NILP (insval
))
4229 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4230 wrong_type_argument (intern ("inserted-chars"), insval
);
4231 inserted
= XFASTINT (insval
);
4235 /* Decode file format. */
4238 /* Don't run point motion or modification hooks when decoding. */
4239 ptrdiff_t count1
= SPECPDL_INDEX ();
4240 ptrdiff_t old_inserted
= inserted
;
4241 specbind (Qinhibit_point_motion_hooks
, Qt
);
4242 specbind (Qinhibit_modification_hooks
, Qt
);
4244 /* Save old undo list and don't record undo for decoding. */
4245 old_undo
= BVAR (current_buffer
, undo_list
);
4246 bset_undo_list (current_buffer
, Qt
);
4250 insval
= call3 (Qformat_decode
,
4251 Qnil
, make_number (inserted
), visit
);
4252 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4253 wrong_type_argument (intern ("inserted-chars"), insval
);
4254 inserted
= XFASTINT (insval
);
4258 /* If REPLACE is non-nil and we succeeded in not replacing the
4259 beginning or end of the buffer text with the file's contents,
4260 call format-decode with `point' positioned at the beginning
4261 of the buffer and `inserted' equaling the number of
4262 characters in the buffer. Otherwise, format-decode might
4263 fail to correctly analyze the beginning or end of the buffer.
4264 Hence we temporarily save `point' and `inserted' here and
4265 restore `point' iff format-decode did not insert or delete
4266 any text. Otherwise we leave `point' at point-min. */
4267 ptrdiff_t opoint
= PT
;
4268 ptrdiff_t opoint_byte
= PT_BYTE
;
4269 ptrdiff_t oinserted
= ZV
- BEGV
;
4270 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4272 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4273 insval
= call3 (Qformat_decode
,
4274 Qnil
, make_number (oinserted
), visit
);
4275 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4276 wrong_type_argument (intern ("inserted-chars"), insval
);
4277 if (ochars_modiff
== CHARS_MODIFF
)
4278 /* format_decode didn't modify buffer's characters => move
4279 point back to position before inserted text and leave
4280 value of inserted alone. */
4281 SET_PT_BOTH (opoint
, opoint_byte
);
4283 /* format_decode modified buffer's characters => consider
4284 entire buffer changed and leave point at point-min. */
4285 inserted
= XFASTINT (insval
);
4288 /* For consistency with format-decode call these now iff inserted > 0
4289 (martin 2007-06-28). */
4290 p
= Vafter_insert_file_functions
;
4295 insval
= call1 (XCAR (p
), make_number (inserted
));
4298 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4299 wrong_type_argument (intern ("inserted-chars"), insval
);
4300 inserted
= XFASTINT (insval
);
4305 /* For the rationale of this see the comment on
4306 format-decode above. */
4307 ptrdiff_t opoint
= PT
;
4308 ptrdiff_t opoint_byte
= PT_BYTE
;
4309 ptrdiff_t oinserted
= ZV
- BEGV
;
4310 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4312 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4313 insval
= call1 (XCAR (p
), make_number (oinserted
));
4316 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4317 wrong_type_argument (intern ("inserted-chars"), insval
);
4318 if (ochars_modiff
== CHARS_MODIFF
)
4319 /* after_insert_file_functions didn't modify
4320 buffer's characters => move point back to
4321 position before inserted text and leave value of
4323 SET_PT_BOTH (opoint
, opoint_byte
);
4325 /* after_insert_file_functions did modify buffer's
4326 characters => consider entire buffer changed and
4327 leave point at point-min. */
4328 inserted
= XFASTINT (insval
);
4338 bset_undo_list (current_buffer
, old_undo
);
4339 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4341 /* Adjust the last undo record for the size change during
4342 the format conversion. */
4343 Lisp_Object tem
= XCAR (old_undo
);
4344 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4345 && INTEGERP (XCDR (tem
))
4346 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4347 XSETCDR (tem
, make_number (PT
+ inserted
));
4351 /* If undo_list was Qt before, keep it that way.
4352 Otherwise start with an empty undo_list. */
4353 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4355 unbind_to (count1
, Qnil
);
4359 && EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
4361 /* If visiting nonexistent file, return nil. */
4363 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4367 Fsignal (Qquit
, Qnil
);
4369 /* ??? Retval needs to be dealt with in all cases consistently. */
4371 val
= Fcons (orig_filename
,
4372 Fcons (make_number (inserted
),
4375 RETURN_UNGCPRO (unbind_to (count
, val
));
4378 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4381 build_annotations_unwind (Lisp_Object arg
)
4383 Vwrite_region_annotation_buffers
= arg
;
4387 /* Decide the coding-system to encode the data with. */
4390 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4391 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4392 struct coding_system
*coding
)
4395 Lisp_Object eol_parent
= Qnil
;
4398 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4399 BVAR (current_buffer
, auto_save_file_name
))))
4404 else if (!NILP (Vcoding_system_for_write
))
4406 val
= Vcoding_system_for_write
;
4407 if (coding_system_require_warning
4408 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4409 /* Confirm that VAL can surely encode the current region. */
4410 val
= call5 (Vselect_safe_coding_system_function
,
4411 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4416 /* If the variable `buffer-file-coding-system' is set locally,
4417 it means that the file was read with some kind of code
4418 conversion or the variable is explicitly set by users. We
4419 had better write it out with the same coding system even if
4420 `enable-multibyte-characters' is nil.
4422 If it is not set locally, we anyway have to convert EOL
4423 format if the default value of `buffer-file-coding-system'
4424 tells that it is not Unix-like (LF only) format. */
4425 bool using_default_coding
= 0;
4426 bool force_raw_text
= 0;
4428 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4430 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4433 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4439 /* Check file-coding-system-alist. */
4440 Lisp_Object args
[7], coding_systems
;
4442 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4443 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4445 coding_systems
= Ffind_operation_coding_system (7, args
);
4446 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4447 val
= XCDR (coding_systems
);
4452 /* If we still have not decided a coding system, use the
4453 default value of buffer-file-coding-system. */
4454 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4455 using_default_coding
= 1;
4458 if (! NILP (val
) && ! force_raw_text
)
4460 Lisp_Object spec
, attrs
;
4462 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4463 attrs
= AREF (spec
, 0);
4464 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4469 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4470 /* Confirm that VAL can surely encode the current region. */
4471 val
= call5 (Vselect_safe_coding_system_function
,
4472 start
, end
, val
, Qnil
, filename
);
4474 /* If the decided coding-system doesn't specify end-of-line
4475 format, we use that of
4476 `default-buffer-file-coding-system'. */
4477 if (! using_default_coding
4478 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4479 val
= (coding_inherit_eol_type
4480 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4482 /* If we decide not to encode text, use `raw-text' or one of its
4485 val
= raw_text_coding_system (val
);
4488 val
= coding_inherit_eol_type (val
, eol_parent
);
4489 setup_coding_system (val
, coding
);
4491 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4492 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4496 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4497 "r\nFWrite region to file: \ni\ni\ni\np",
4498 doc
: /* Write current region into specified file.
4499 When called from a program, requires three arguments:
4500 START, END and FILENAME. START and END are normally buffer positions
4501 specifying the part of the buffer to write.
4502 If START is nil, that means to use the entire buffer contents.
4503 If START is a string, then output that string to the file
4504 instead of any buffer contents; END is ignored.
4506 Optional fourth argument APPEND if non-nil means
4507 append to existing file contents (if any). If it is an integer,
4508 seek to that offset in the file before writing.
4509 Optional fifth argument VISIT, if t or a string, means
4510 set the last-save-file-modtime of buffer to this file's modtime
4511 and mark buffer not modified.
4512 If VISIT is a string, it is a second file name;
4513 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4514 VISIT is also the file name to lock and unlock for clash detection.
4515 If VISIT is neither t nor nil nor a string,
4516 that means do not display the \"Wrote file\" message.
4517 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4518 use for locking and unlocking, overriding FILENAME and VISIT.
4519 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4520 for an existing file with the same name. If MUSTBENEW is `excl',
4521 that means to get an error if the file already exists; never overwrite.
4522 If MUSTBENEW is neither nil nor `excl', that means ask for
4523 confirmation before overwriting, but do go ahead and overwrite the file
4524 if the user confirms.
4526 This does code conversion according to the value of
4527 `coding-system-for-write', `buffer-file-coding-system', or
4528 `file-coding-system-alist', and sets the variable
4529 `last-coding-system-used' to the coding system actually used.
4531 This calls `write-region-annotate-functions' at the start, and
4532 `write-region-post-annotation-function' at the end. */)
4533 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4540 ptrdiff_t count
= SPECPDL_INDEX ();
4542 Lisp_Object handler
;
4543 Lisp_Object visit_file
;
4544 Lisp_Object annotations
;
4545 Lisp_Object encoded_filename
;
4546 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4547 bool quietly
= !NILP (visit
);
4548 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4549 struct buffer
*given_buffer
;
4550 struct coding_system coding
;
4552 if (current_buffer
->base_buffer
&& visiting
)
4553 error ("Cannot do file visiting in an indirect buffer");
4555 if (!NILP (start
) && !STRINGP (start
))
4556 validate_region (&start
, &end
);
4559 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4561 filename
= Fexpand_file_name (filename
, Qnil
);
4563 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4564 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4566 if (STRINGP (visit
))
4567 visit_file
= Fexpand_file_name (visit
, Qnil
);
4569 visit_file
= filename
;
4571 if (NILP (lockname
))
4572 lockname
= visit_file
;
4576 /* If the file name has special constructs in it,
4577 call the corresponding file handler. */
4578 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4579 /* If FILENAME has no handler, see if VISIT has one. */
4580 if (NILP (handler
) && STRINGP (visit
))
4581 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4583 if (!NILP (handler
))
4586 val
= call6 (handler
, Qwrite_region
, start
, end
,
4587 filename
, append
, visit
);
4591 SAVE_MODIFF
= MODIFF
;
4592 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4593 bset_filename (current_buffer
, visit_file
);
4599 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4601 /* Special kludge to simplify auto-saving. */
4604 /* Do it later, so write-region-annotate-function can work differently
4605 if we save "the buffer" vs "a region".
4606 This is useful in tar-mode. --Stef
4607 XSETFASTINT (start, BEG);
4608 XSETFASTINT (end, Z); */
4612 record_unwind_protect (build_annotations_unwind
,
4613 Vwrite_region_annotation_buffers
);
4614 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4615 count1
= SPECPDL_INDEX ();
4617 given_buffer
= current_buffer
;
4619 if (!STRINGP (start
))
4621 annotations
= build_annotations (start
, end
);
4623 if (current_buffer
!= given_buffer
)
4625 XSETFASTINT (start
, BEGV
);
4626 XSETFASTINT (end
, ZV
);
4632 XSETFASTINT (start
, BEGV
);
4633 XSETFASTINT (end
, ZV
);
4638 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4640 /* Decide the coding-system to encode the data with.
4641 We used to make this choice before calling build_annotations, but that
4642 leads to problems when a write-annotate-function takes care of
4643 unsavable chars (as was the case with X-Symbol). */
4644 Vlast_coding_system_used
4645 = choose_write_coding_system (start
, end
, filename
,
4646 append
, visit
, lockname
, &coding
);
4648 #ifdef CLASH_DETECTION
4650 lock_file (lockname
);
4651 #endif /* CLASH_DETECTION */
4653 encoded_filename
= ENCODE_FILE (filename
);
4655 fn
= SSDATA (encoded_filename
);
4659 desc
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4660 #else /* not DOS_NT */
4661 desc
= emacs_open (fn
, O_WRONLY
, 0);
4662 #endif /* not DOS_NT */
4664 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4666 desc
= emacs_open (fn
,
4667 O_WRONLY
| O_CREAT
| O_BINARY
4668 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4669 S_IREAD
| S_IWRITE
);
4670 #else /* not DOS_NT */
4671 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4672 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4673 auto_saving
? auto_save_mode_bits
: 0666);
4674 #endif /* not DOS_NT */
4678 #ifdef CLASH_DETECTION
4680 if (!auto_saving
) unlock_file (lockname
);
4682 #endif /* CLASH_DETECTION */
4684 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4687 record_unwind_protect (close_file_unwind
, make_number (desc
));
4689 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4693 if (NUMBERP (append
))
4694 ret
= emacs_lseek (desc
, XINT (append
), SEEK_CUR
);
4696 ret
= lseek (desc
, 0, SEEK_END
);
4699 #ifdef CLASH_DETECTION
4701 if (!auto_saving
) unlock_file (lockname
);
4703 #endif /* CLASH_DETECTION */
4705 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4713 if (STRINGP (start
))
4714 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4715 else if (XINT (start
) != XINT (end
))
4716 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4717 &annotations
, &coding
);
4720 /* If file was empty, still need to write the annotations. */
4721 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4722 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4726 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4727 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4729 /* We have to flush out a data. */
4730 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4731 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4738 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4739 Disk full in NFS may be reported here. */
4740 /* mib says that closing the file will try to write as fast as NFS can do
4741 it, and that means the fsync here is not crucial for autosave files. */
4742 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4744 /* If fsync fails with EINTR, don't treat that as serious. Also
4745 ignore EINVAL which happens when fsync is not supported on this
4747 if (errno
!= EINTR
&& errno
!= EINVAL
)
4748 ok
= 0, save_errno
= errno
;
4752 /* NFS can report a write failure now. */
4753 if (emacs_close (desc
) < 0)
4754 ok
= 0, save_errno
= errno
;
4758 /* Discard the unwind protect for close_file_unwind. */
4759 specpdl_ptr
= specpdl
+ count1
;
4761 /* Call write-region-post-annotation-function. */
4762 while (CONSP (Vwrite_region_annotation_buffers
))
4764 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4765 if (!NILP (Fbuffer_live_p (buf
)))
4768 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4769 call0 (Vwrite_region_post_annotation_function
);
4771 Vwrite_region_annotation_buffers
4772 = XCDR (Vwrite_region_annotation_buffers
);
4775 unbind_to (count
, Qnil
);
4777 #ifdef CLASH_DETECTION
4779 unlock_file (lockname
);
4780 #endif /* CLASH_DETECTION */
4782 /* Do this before reporting IO error
4783 to avoid a "file has changed on disk" warning on
4784 next attempt to save. */
4787 current_buffer
->modtime
= get_stat_mtime (&st
);
4788 current_buffer
->modtime_size
= st
.st_size
;
4792 error ("IO error writing %s: %s", SDATA (filename
),
4793 emacs_strerror (save_errno
));
4797 SAVE_MODIFF
= MODIFF
;
4798 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4799 bset_filename (current_buffer
, visit_file
);
4800 update_mode_lines
++;
4805 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4806 BVAR (current_buffer
, auto_save_file_name
))))
4807 SAVE_MODIFF
= MODIFF
;
4813 message_with_string ((INTEGERP (append
)
4823 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4825 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4826 doc
: /* Return t if (car A) is numerically less than (car B). */)
4827 (Lisp_Object a
, Lisp_Object b
)
4829 return Flss (Fcar (a
), Fcar (b
));
4832 /* Build the complete list of annotations appropriate for writing out
4833 the text between START and END, by calling all the functions in
4834 write-region-annotate-functions and merging the lists they return.
4835 If one of these functions switches to a different buffer, we assume
4836 that buffer contains altered text. Therefore, the caller must
4837 make sure to restore the current buffer in all cases,
4838 as save-excursion would do. */
4841 build_annotations (Lisp_Object start
, Lisp_Object end
)
4843 Lisp_Object annotations
;
4845 struct gcpro gcpro1
, gcpro2
;
4846 Lisp_Object original_buffer
;
4848 bool used_global
= 0;
4850 XSETBUFFER (original_buffer
, current_buffer
);
4853 p
= Vwrite_region_annotate_functions
;
4854 GCPRO2 (annotations
, p
);
4857 struct buffer
*given_buffer
= current_buffer
;
4858 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4859 { /* Use the global value of the hook. */
4862 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4864 p
= Fappend (2, arg
);
4867 Vwrite_region_annotations_so_far
= annotations
;
4868 res
= call2 (XCAR (p
), start
, end
);
4869 /* If the function makes a different buffer current,
4870 assume that means this buffer contains altered text to be output.
4871 Reset START and END from the buffer bounds
4872 and discard all previous annotations because they should have
4873 been dealt with by this function. */
4874 if (current_buffer
!= given_buffer
)
4876 Vwrite_region_annotation_buffers
4877 = Fcons (Fcurrent_buffer (),
4878 Vwrite_region_annotation_buffers
);
4879 XSETFASTINT (start
, BEGV
);
4880 XSETFASTINT (end
, ZV
);
4883 Flength (res
); /* Check basic validity of return value */
4884 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4888 /* Now do the same for annotation functions implied by the file-format */
4889 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
4890 p
= BVAR (current_buffer
, auto_save_file_format
);
4892 p
= BVAR (current_buffer
, file_format
);
4893 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4895 struct buffer
*given_buffer
= current_buffer
;
4897 Vwrite_region_annotations_so_far
= annotations
;
4899 /* Value is either a list of annotations or nil if the function
4900 has written annotations to a temporary buffer, which is now
4902 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4903 original_buffer
, make_number (i
));
4904 if (current_buffer
!= given_buffer
)
4906 XSETFASTINT (start
, BEGV
);
4907 XSETFASTINT (end
, ZV
);
4912 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4920 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4921 If STRING is nil, POS is the character position in the current buffer.
4922 Intersperse with them the annotations from *ANNOT
4923 which fall within the range of POS to POS + NCHARS,
4924 each at its appropriate position.
4926 We modify *ANNOT by discarding elements as we use them up.
4928 Return true if successful. */
4931 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
4932 ptrdiff_t nchars
, Lisp_Object
*annot
,
4933 struct coding_system
*coding
)
4937 ptrdiff_t lastpos
= pos
+ nchars
;
4939 while (NILP (*annot
) || CONSP (*annot
))
4941 tem
= Fcar_safe (Fcar (*annot
));
4944 nextpos
= XFASTINT (tem
);
4946 /* If there are no more annotations in this range,
4947 output the rest of the range all at once. */
4948 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4949 return e_write (desc
, string
, pos
, lastpos
, coding
);
4951 /* Output buffer text up to the next annotation's position. */
4954 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
4958 /* Output the annotation. */
4959 tem
= Fcdr (Fcar (*annot
));
4962 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4965 *annot
= Fcdr (*annot
);
4971 /* Write text in the range START and END into descriptor DESC,
4972 encoding them with coding system CODING. If STRING is nil, START
4973 and END are character positions of the current buffer, else they
4974 are indexes to the string STRING. Return true if successful. */
4977 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
4978 struct coding_system
*coding
)
4980 if (STRINGP (string
))
4983 end
= SCHARS (string
);
4986 /* We used to have a code for handling selective display here. But,
4987 now it is handled within encode_coding. */
4991 if (STRINGP (string
))
4993 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
4994 if (CODING_REQUIRE_ENCODING (coding
))
4996 encode_coding_object (coding
, string
,
4997 start
, string_char_to_byte (string
, start
),
4998 end
, string_char_to_byte (string
, end
), Qt
);
5002 coding
->dst_object
= string
;
5003 coding
->consumed_char
= SCHARS (string
);
5004 coding
->produced
= SBYTES (string
);
5009 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5010 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5012 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5013 if (CODING_REQUIRE_ENCODING (coding
))
5015 encode_coding_object (coding
, Fcurrent_buffer (),
5016 start
, start_byte
, end
, end_byte
, Qt
);
5020 coding
->dst_object
= Qnil
;
5021 coding
->dst_pos_byte
= start_byte
;
5022 if (start
>= GPT
|| end
<= GPT
)
5024 coding
->consumed_char
= end
- start
;
5025 coding
->produced
= end_byte
- start_byte
;
5029 coding
->consumed_char
= GPT
- start
;
5030 coding
->produced
= GPT_BYTE
- start_byte
;
5035 if (coding
->produced
> 0)
5039 STRINGP (coding
->dst_object
)
5040 ? SSDATA (coding
->dst_object
)
5041 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
5044 if (coding
->produced
)
5047 start
+= coding
->consumed_char
;
5053 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5054 Sverify_visited_file_modtime
, 0, 1, 0,
5055 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5056 This means that the file has not been changed since it was visited or saved.
5057 If BUF is omitted or nil, it defaults to the current buffer.
5058 See Info node `(elisp)Modification Time' for more details. */)
5063 Lisp_Object handler
;
5064 Lisp_Object filename
;
5065 EMACS_TIME mtime
, diff
;
5075 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5076 if (EMACS_NSECS (b
->modtime
) == UNKNOWN_MODTIME_NSECS
) return Qt
;
5078 /* If the file name has special constructs in it,
5079 call the corresponding file handler. */
5080 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5081 Qverify_visited_file_modtime
);
5082 if (!NILP (handler
))
5083 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5085 filename
= ENCODE_FILE (BVAR (b
, filename
));
5087 mtime
= (stat (SSDATA (filename
), &st
) == 0
5088 ? get_stat_mtime (&st
)
5089 : time_error_value (errno
));
5090 if ((EMACS_TIME_EQ (mtime
, b
->modtime
)
5091 /* If both exist, accept them if they are off by one second. */
5092 || (EMACS_TIME_VALID_P (mtime
) && EMACS_TIME_VALID_P (b
->modtime
)
5093 && ((diff
= (EMACS_TIME_LT (mtime
, b
->modtime
)
5094 ? sub_emacs_time (b
->modtime
, mtime
)
5095 : sub_emacs_time (mtime
, b
->modtime
))),
5096 EMACS_TIME_LE (diff
, make_emacs_time (1, 0)))))
5097 && (st
.st_size
== b
->modtime_size
5098 || b
->modtime_size
< 0))
5103 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5104 Sclear_visited_file_modtime
, 0, 0, 0,
5105 doc
: /* Clear out records of last mod time of visited file.
5106 Next attempt to save will certainly not complain of a discrepancy. */)
5109 current_buffer
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
5110 current_buffer
->modtime_size
= -1;
5114 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5115 Svisited_file_modtime
, 0, 0, 0,
5116 doc
: /* Return the current buffer's recorded visited file modification time.
5117 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5118 `file-attributes' returns. If the current buffer has no recorded file
5119 modification time, this function returns 0. If the visited file
5120 doesn't exist, HIGH will be -1.
5121 See Info node `(elisp)Modification Time' for more details. */)
5124 if (EMACS_NSECS (current_buffer
->modtime
) < 0)
5125 return make_number (0);
5126 return make_lisp_time (current_buffer
->modtime
);
5129 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5130 Sset_visited_file_modtime
, 0, 1, 0,
5131 doc
: /* Update buffer's recorded modification time from the visited file's time.
5132 Useful if the buffer was not read from the file normally
5133 or if the file itself has been changed for some known benign reason.
5134 An argument specifies the modification time value to use
5135 \(instead of that of the visited file), in the form of a list
5136 \(HIGH LOW USEC PSEC) as returned by `current-time'. */)
5137 (Lisp_Object time_list
)
5139 if (!NILP (time_list
))
5141 current_buffer
->modtime
= lisp_time_argument (time_list
);
5142 current_buffer
->modtime_size
= -1;
5146 register Lisp_Object filename
;
5148 Lisp_Object handler
;
5150 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5152 /* If the file name has special constructs in it,
5153 call the corresponding file handler. */
5154 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5155 if (!NILP (handler
))
5156 /* The handler can find the file name the same way we did. */
5157 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5159 filename
= ENCODE_FILE (filename
);
5161 if (stat (SSDATA (filename
), &st
) >= 0)
5163 current_buffer
->modtime
= get_stat_mtime (&st
);
5164 current_buffer
->modtime_size
= st
.st_size
;
5172 auto_save_error (Lisp_Object error_val
)
5174 Lisp_Object args
[3], msg
;
5176 struct gcpro gcpro1
;
5180 auto_save_error_occurred
= 1;
5182 ring_bell (XFRAME (selected_frame
));
5184 args
[0] = build_string ("Auto-saving %s: %s");
5185 args
[1] = BVAR (current_buffer
, name
);
5186 args
[2] = Ferror_message_string (error_val
);
5187 msg
= Fformat (3, args
);
5189 nbytes
= SBYTES (msg
);
5190 msgbuf
= SAFE_ALLOCA (nbytes
);
5191 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5193 for (i
= 0; i
< 3; ++i
)
5196 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5198 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5199 Fsleep_for (make_number (1), Qnil
);
5213 auto_save_mode_bits
= 0666;
5215 /* Get visited file's mode to become the auto save file's mode. */
5216 if (! NILP (BVAR (current_buffer
, filename
)))
5218 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5219 /* But make sure we can overwrite it later! */
5220 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5221 else if ((modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5223 /* Remote files don't cooperate with stat. */
5224 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5228 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5229 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5234 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5237 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5249 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5252 minibuffer_auto_raise
= XINT (value
);
5257 do_auto_save_make_dir (Lisp_Object dir
)
5261 auto_saving_dir_umask
= 077;
5262 result
= call2 (Qmake_directory
, dir
, Qt
);
5263 auto_saving_dir_umask
= 0;
5268 do_auto_save_eh (Lisp_Object ignore
)
5270 auto_saving_dir_umask
= 0;
5274 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5275 doc
: /* Auto-save all buffers that need it.
5276 This is all buffers that have auto-saving enabled
5277 and are changed since last auto-saved.
5278 Auto-saving writes the buffer into a file
5279 so that your editing is not lost if the system crashes.
5280 This file is not the file you visited; that changes only when you save.
5281 Normally we run the normal hook `auto-save-hook' before saving.
5283 A non-nil NO-MESSAGE argument means do not print any message if successful.
5284 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5285 (Lisp_Object no_message
, Lisp_Object current_only
)
5287 struct buffer
*old
= current_buffer
, *b
;
5288 Lisp_Object tail
, buf
, hook
;
5289 bool auto_saved
= 0;
5290 int do_handled_files
;
5292 FILE *stream
= NULL
;
5293 ptrdiff_t count
= SPECPDL_INDEX ();
5294 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5295 bool old_message_p
= 0;
5296 struct gcpro gcpro1
, gcpro2
;
5298 if (max_specpdl_size
< specpdl_size
+ 40)
5299 max_specpdl_size
= specpdl_size
+ 40;
5304 if (NILP (no_message
))
5306 old_message_p
= push_message ();
5307 record_unwind_protect (pop_message_unwind
, Qnil
);
5310 /* Ordinarily don't quit within this function,
5311 but don't make it impossible to quit (in case we get hung in I/O). */
5315 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5316 point to non-strings reached from Vbuffer_alist. */
5318 hook
= intern ("auto-save-hook");
5319 Frun_hooks (1, &hook
);
5321 if (STRINGP (Vauto_save_list_file_name
))
5323 Lisp_Object listfile
;
5325 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5327 /* Don't try to create the directory when shutting down Emacs,
5328 because creating the directory might signal an error, and
5329 that would leave Emacs in a strange state. */
5330 if (!NILP (Vrun_hooks
))
5334 GCPRO2 (dir
, listfile
);
5335 dir
= Ffile_name_directory (listfile
);
5336 if (NILP (Ffile_directory_p (dir
)))
5337 internal_condition_case_1 (do_auto_save_make_dir
,
5343 stream
= fopen (SSDATA (listfile
), "w");
5346 record_unwind_protect (do_auto_save_unwind
,
5347 make_save_value (stream
, 0));
5348 record_unwind_protect (do_auto_save_unwind_1
,
5349 make_number (minibuffer_auto_raise
));
5350 minibuffer_auto_raise
= 0;
5352 auto_save_error_occurred
= 0;
5354 /* On first pass, save all files that don't have handlers.
5355 On second pass, save all files that do have handlers.
5357 If Emacs is crashing, the handlers may tweak what is causing
5358 Emacs to crash in the first place, and it would be a shame if
5359 Emacs failed to autosave perfectly ordinary files because it
5360 couldn't handle some ange-ftp'd file. */
5362 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5363 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5365 buf
= XCDR (XCAR (tail
));
5368 /* Record all the buffers that have auto save mode
5369 in the special file that lists them. For each of these buffers,
5370 Record visited name (if any) and auto save name. */
5371 if (STRINGP (BVAR (b
, auto_save_file_name
))
5372 && stream
!= NULL
&& do_handled_files
== 0)
5375 if (!NILP (BVAR (b
, filename
)))
5377 fwrite (SDATA (BVAR (b
, filename
)), 1,
5378 SBYTES (BVAR (b
, filename
)), stream
);
5380 putc ('\n', stream
);
5381 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5382 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5383 putc ('\n', stream
);
5387 if (!NILP (current_only
)
5388 && b
!= current_buffer
)
5391 /* Don't auto-save indirect buffers.
5392 The base buffer takes care of it. */
5396 /* Check for auto save enabled
5397 and file changed since last auto save
5398 and file changed since last real save. */
5399 if (STRINGP (BVAR (b
, auto_save_file_name
))
5400 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5401 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5402 /* -1 means we've turned off autosaving for a while--see below. */
5403 && XINT (BVAR (b
, save_length
)) >= 0
5404 && (do_handled_files
5405 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5408 EMACS_TIME before_time
= current_emacs_time ();
5409 EMACS_TIME after_time
;
5411 /* If we had a failure, don't try again for 20 minutes. */
5412 if (b
->auto_save_failure_time
> 0
5413 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5416 set_buffer_internal (b
);
5417 if (NILP (Vauto_save_include_big_deletions
)
5418 && (XFASTINT (BVAR (b
, save_length
)) * 10
5419 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5420 /* A short file is likely to change a large fraction;
5421 spare the user annoying messages. */
5422 && XFASTINT (BVAR (b
, save_length
)) > 5000
5423 /* These messages are frequent and annoying for `*mail*'. */
5424 && !EQ (BVAR (b
, filename
), Qnil
)
5425 && NILP (no_message
))
5427 /* It has shrunk too much; turn off auto-saving here. */
5428 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5429 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5431 minibuffer_auto_raise
= 0;
5432 /* Turn off auto-saving until there's a real save,
5433 and prevent any more warnings. */
5434 XSETINT (BVAR (b
, save_length
), -1);
5435 Fsleep_for (make_number (1), Qnil
);
5438 if (!auto_saved
&& NILP (no_message
))
5439 message1 ("Auto-saving...");
5440 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5442 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5443 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5444 set_buffer_internal (old
);
5446 after_time
= current_emacs_time ();
5448 /* If auto-save took more than 60 seconds,
5449 assume it was an NFS failure that got a timeout. */
5450 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5451 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5455 /* Prevent another auto save till enough input events come in. */
5456 record_auto_save ();
5458 if (auto_saved
&& NILP (no_message
))
5462 /* If we are going to restore an old message,
5463 give time to read ours. */
5464 sit_for (make_number (1), 0, 0);
5467 else if (!auto_save_error_occurred
)
5468 /* Don't overwrite the error message if an error occurred.
5469 If we displayed a message and then restored a state
5470 with no message, leave a "done" message on the screen. */
5471 message1 ("Auto-saving...done");
5476 /* This restores the message-stack status. */
5477 unbind_to (count
, Qnil
);
5481 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5482 Sset_buffer_auto_saved
, 0, 0, 0,
5483 doc
: /* Mark current buffer as auto-saved with its current text.
5484 No auto-save file will be written until the buffer changes again. */)
5487 /* FIXME: This should not be called in indirect buffers, since
5488 they're not autosaved. */
5489 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5490 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5491 current_buffer
->auto_save_failure_time
= 0;
5495 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5496 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5497 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5500 current_buffer
->auto_save_failure_time
= 0;
5504 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5506 doc
: /* Return t if current buffer has been auto-saved recently.
5507 More precisely, if it has been auto-saved since last read from or saved
5508 in the visited file. If the buffer has no visited file,
5509 then any auto-save counts as "recent". */)
5512 /* FIXME: maybe we should return nil for indirect buffers since
5513 they're never autosaved. */
5514 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5517 /* Reading and completing file names */
5519 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5520 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5521 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5522 The return value is only relevant for a call to `read-file-name' that happens
5523 before any other event (mouse or keypress) is handled. */)
5526 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5527 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5537 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5539 struct gcpro gcpro1
;
5540 Lisp_Object args
[7];
5542 GCPRO1 (default_filename
);
5543 args
[0] = intern ("read-file-name");
5546 args
[3] = default_filename
;
5547 args
[4] = mustmatch
;
5549 args
[6] = predicate
;
5550 RETURN_UNGCPRO (Ffuncall (7, args
));
5555 syms_of_fileio (void)
5557 DEFSYM (Qoperations
, "operations");
5558 DEFSYM (Qexpand_file_name
, "expand-file-name");
5559 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5560 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5561 DEFSYM (Qfile_name_directory
, "file-name-directory");
5562 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5563 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5564 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5565 DEFSYM (Qcopy_file
, "copy-file");
5566 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5567 DEFSYM (Qmake_directory
, "make-directory");
5568 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5569 DEFSYM (Qdelete_file
, "delete-file");
5570 DEFSYM (Qrename_file
, "rename-file");
5571 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5572 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5573 DEFSYM (Qfile_exists_p
, "file-exists-p");
5574 DEFSYM (Qfile_executable_p
, "file-executable-p");
5575 DEFSYM (Qfile_readable_p
, "file-readable-p");
5576 DEFSYM (Qfile_writable_p
, "file-writable-p");
5577 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5578 DEFSYM (Qaccess_file
, "access-file");
5579 DEFSYM (Qfile_directory_p
, "file-directory-p");
5580 DEFSYM (Qfile_regular_p
, "file-regular-p");
5581 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5582 DEFSYM (Qfile_modes
, "file-modes");
5583 DEFSYM (Qset_file_modes
, "set-file-modes");
5584 DEFSYM (Qset_file_times
, "set-file-times");
5585 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5586 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5587 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5588 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5589 DEFSYM (Qwrite_region
, "write-region");
5590 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5591 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5592 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5594 DEFSYM (Qfile_name_history
, "file-name-history");
5595 Fset (Qfile_name_history
, Qnil
);
5597 DEFSYM (Qfile_error
, "file-error");
5598 DEFSYM (Qfile_already_exists
, "file-already-exists");
5599 DEFSYM (Qfile_date_error
, "file-date-error");
5600 DEFSYM (Qexcl
, "excl");
5602 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5603 doc
: /* Coding system for encoding file names.
5604 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5605 Vfile_name_coding_system
= Qnil
;
5607 DEFVAR_LISP ("default-file-name-coding-system",
5608 Vdefault_file_name_coding_system
,
5609 doc
: /* Default coding system for encoding file names.
5610 This variable is used only when `file-name-coding-system' is nil.
5612 This variable is set/changed by the command `set-language-environment'.
5613 User should not set this variable manually,
5614 instead use `file-name-coding-system' to get a constant encoding
5615 of file names regardless of the current language environment. */);
5616 Vdefault_file_name_coding_system
= Qnil
;
5618 DEFSYM (Qformat_decode
, "format-decode");
5619 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5620 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5621 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5623 Fput (Qfile_error
, Qerror_conditions
,
5624 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5625 Fput (Qfile_error
, Qerror_message
,
5626 build_pure_c_string ("File error"));
5628 Fput (Qfile_already_exists
, Qerror_conditions
,
5629 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5630 Fput (Qfile_already_exists
, Qerror_message
,
5631 build_pure_c_string ("File already exists"));
5633 Fput (Qfile_date_error
, Qerror_conditions
,
5634 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5635 Fput (Qfile_date_error
, Qerror_message
,
5636 build_pure_c_string ("Cannot set file date"));
5638 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5639 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5640 If a file name matches REGEXP, all I/O on that file is done by calling
5641 HANDLER. If a file name matches more than one handler, the handler
5642 whose match starts last in the file name gets precedence. The
5643 function `find-file-name-handler' checks this list for a handler for
5646 HANDLER should be a function. The first argument given to it is the
5647 name of the I/O primitive to be handled; the remaining arguments are
5648 the arguments that were passed to that primitive. For example, if you
5649 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5650 HANDLER is called like this:
5652 (funcall HANDLER 'file-exists-p FILENAME)
5654 Note that HANDLER must be able to handle all I/O primitives; if it has
5655 nothing special to do for a primitive, it should reinvoke the
5656 primitive to handle the operation \"the usual way\".
5657 See Info node `(elisp)Magic File Names' for more details. */);
5658 Vfile_name_handler_alist
= Qnil
;
5660 DEFVAR_LISP ("set-auto-coding-function",
5661 Vset_auto_coding_function
,
5662 doc
: /* If non-nil, a function to call to decide a coding system of file.
5663 Two arguments are passed to this function: the file name
5664 and the length of a file contents following the point.
5665 This function should return a coding system to decode the file contents.
5666 It should check the file name against `auto-coding-alist'.
5667 If no coding system is decided, it should check a coding system
5668 specified in the heading lines with the format:
5669 -*- ... coding: CODING-SYSTEM; ... -*-
5670 or local variable spec of the tailing lines with `coding:' tag. */);
5671 Vset_auto_coding_function
= Qnil
;
5673 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5674 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5675 Each is passed one argument, the number of characters inserted,
5676 with point at the start of the inserted text. Each function
5677 should leave point the same, and return the new character count.
5678 If `insert-file-contents' is intercepted by a handler from
5679 `file-name-handler-alist', that handler is responsible for calling the
5680 functions in `after-insert-file-functions' if appropriate. */);
5681 Vafter_insert_file_functions
= Qnil
;
5683 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5684 doc
: /* A list of functions to be called at the start of `write-region'.
5685 Each is passed two arguments, START and END as for `write-region'.
5686 These are usually two numbers but not always; see the documentation
5687 for `write-region'. The function should return a list of pairs
5688 of the form (POSITION . STRING), consisting of strings to be effectively
5689 inserted at the specified positions of the file being written (1 means to
5690 insert before the first byte written). The POSITIONs must be sorted into
5693 If there are several annotation functions, the lists returned by these
5694 functions are merged destructively. As each annotation function runs,
5695 the variable `write-region-annotations-so-far' contains a list of all
5696 annotations returned by previous annotation functions.
5698 An annotation function can return with a different buffer current.
5699 Doing so removes the annotations returned by previous functions, and
5700 resets START and END to `point-min' and `point-max' of the new buffer.
5702 After `write-region' completes, Emacs calls the function stored in
5703 `write-region-post-annotation-function', once for each buffer that was
5704 current when building the annotations (i.e., at least once), with that
5705 buffer current. */);
5706 Vwrite_region_annotate_functions
= Qnil
;
5707 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5709 DEFVAR_LISP ("write-region-post-annotation-function",
5710 Vwrite_region_post_annotation_function
,
5711 doc
: /* Function to call after `write-region' completes.
5712 The function is called with no arguments. If one or more of the
5713 annotation functions in `write-region-annotate-functions' changed the
5714 current buffer, the function stored in this variable is called for
5715 each of those additional buffers as well, in addition to the original
5716 buffer. The relevant buffer is current during each function call. */);
5717 Vwrite_region_post_annotation_function
= Qnil
;
5718 staticpro (&Vwrite_region_annotation_buffers
);
5720 DEFVAR_LISP ("write-region-annotations-so-far",
5721 Vwrite_region_annotations_so_far
,
5722 doc
: /* When an annotation function is called, this holds the previous annotations.
5723 These are the annotations made by other annotation functions
5724 that were already called. See also `write-region-annotate-functions'. */);
5725 Vwrite_region_annotations_so_far
= Qnil
;
5727 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5728 doc
: /* A list of file name handlers that temporarily should not be used.
5729 This applies only to the operation `inhibit-file-name-operation'. */);
5730 Vinhibit_file_name_handlers
= Qnil
;
5732 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5733 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5734 Vinhibit_file_name_operation
= Qnil
;
5736 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
5737 doc
: /* File name in which we write a list of all auto save file names.
5738 This variable is initialized automatically from `auto-save-list-file-prefix'
5739 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5740 a non-nil value. */);
5741 Vauto_save_list_file_name
= Qnil
;
5743 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
5744 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5745 Normally auto-save files are written under other names. */);
5746 Vauto_save_visited_file_name
= Qnil
;
5748 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
5749 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5750 If nil, deleting a substantial portion of the text disables auto-save
5751 in the buffer; this is the default behavior, because the auto-save
5752 file is usually more useful if it contains the deleted text. */);
5753 Vauto_save_include_big_deletions
= Qnil
;
5756 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
5757 doc
: /* Non-nil means don't call fsync in `write-region'.
5758 This variable affects calls to `write-region' as well as save commands.
5759 A non-nil value may result in data loss! */);
5760 write_region_inhibit_fsync
= 0;
5763 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
5764 doc
: /* Specifies whether to use the system's trash can.
5765 When non-nil, certain file deletion commands use the function
5766 `move-file-to-trash' instead of deleting files outright.
5767 This includes interactive calls to `delete-file' and
5768 `delete-directory' and the Dired deletion commands. */);
5769 delete_by_moving_to_trash
= 0;
5770 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5772 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
5773 DEFSYM (Qcopy_directory
, "copy-directory");
5774 DEFSYM (Qdelete_directory
, "delete-directory");
5776 defsubr (&Sfind_file_name_handler
);
5777 defsubr (&Sfile_name_directory
);
5778 defsubr (&Sfile_name_nondirectory
);
5779 defsubr (&Sunhandled_file_name_directory
);
5780 defsubr (&Sfile_name_as_directory
);
5781 defsubr (&Sdirectory_file_name
);
5782 defsubr (&Smake_temp_name
);
5783 defsubr (&Sexpand_file_name
);
5784 defsubr (&Ssubstitute_in_file_name
);
5785 defsubr (&Scopy_file
);
5786 defsubr (&Smake_directory_internal
);
5787 defsubr (&Sdelete_directory_internal
);
5788 defsubr (&Sdelete_file
);
5789 defsubr (&Srename_file
);
5790 defsubr (&Sadd_name_to_file
);
5791 defsubr (&Smake_symbolic_link
);
5792 defsubr (&Sfile_name_absolute_p
);
5793 defsubr (&Sfile_exists_p
);
5794 defsubr (&Sfile_executable_p
);
5795 defsubr (&Sfile_readable_p
);
5796 defsubr (&Sfile_writable_p
);
5797 defsubr (&Saccess_file
);
5798 defsubr (&Sfile_symlink_p
);
5799 defsubr (&Sfile_directory_p
);
5800 defsubr (&Sfile_accessible_directory_p
);
5801 defsubr (&Sfile_regular_p
);
5802 defsubr (&Sfile_modes
);
5803 defsubr (&Sset_file_modes
);
5804 defsubr (&Sset_file_times
);
5805 defsubr (&Sfile_selinux_context
);
5806 defsubr (&Sset_file_selinux_context
);
5807 defsubr (&Sset_default_file_modes
);
5808 defsubr (&Sdefault_file_modes
);
5809 defsubr (&Sfile_newer_than_file_p
);
5810 defsubr (&Sinsert_file_contents
);
5811 defsubr (&Swrite_region
);
5812 defsubr (&Scar_less_than_car
);
5813 defsubr (&Sverify_visited_file_modtime
);
5814 defsubr (&Sclear_visited_file_modtime
);
5815 defsubr (&Svisited_file_modtime
);
5816 defsubr (&Sset_visited_file_modtime
);
5817 defsubr (&Sdo_auto_save
);
5818 defsubr (&Sset_buffer_auto_saved
);
5819 defsubr (&Sclear_buffer_auto_save_failure
);
5820 defsubr (&Srecent_auto_save_p
);
5822 defsubr (&Snext_read_file_uses_dialog_p
);
5825 defsubr (&Sunix_sync
);