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>
36 #ifdef HAVE_LIBSELINUX
37 #include <selinux/selinux.h>
38 #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) isalpha ((unsigned char) (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) (tolower ((unsigned char) (x)))
86 #ifndef FILE_SYSTEM_CASE
87 #define FILE_SYSTEM_CASE(filename) (filename)
90 /* Nonzero during writing of auto-save files. */
91 static int auto_saving
;
93 /* Nonzero umask during creation of auto-save directories. */
94 static int auto_saving_dir_umask
;
96 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
97 a new file with the same mode as the original. */
98 static int auto_save_mode_bits
;
100 /* Set by auto_save_1 if an error occurred during the last auto-save. */
101 static int auto_save_error_occurred
;
103 /* The symbol bound to coding-system-for-read when
104 insert-file-contents is called for recovering a file. This is not
105 an actual coding system name, but just an indicator to tell
106 insert-file-contents to use `emacs-mule' with a special flag for
107 auto saving and recovering a file. */
108 static Lisp_Object Qauto_save_coding
;
110 /* Property name of a file name handler,
111 which gives a list of operations it handles.. */
112 static Lisp_Object Qoperations
;
114 /* Lisp functions for translating file formats. */
115 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
117 /* Lisp function for setting buffer-file-coding-system and the
118 multibyteness of the current buffer after inserting a file. */
119 static Lisp_Object Qafter_insert_file_set_coding
;
121 static Lisp_Object Qwrite_region_annotate_functions
;
122 /* Each time an annotation function changes the buffer, the new buffer
124 static Lisp_Object Vwrite_region_annotation_buffers
;
129 static Lisp_Object Qdelete_by_moving_to_trash
;
131 /* Lisp function for moving files to trash. */
132 static Lisp_Object Qmove_file_to_trash
;
134 /* Lisp function for recursively copying directories. */
135 static Lisp_Object Qcopy_directory
;
137 /* Lisp function for recursively deleting directories. */
138 static Lisp_Object Qdelete_directory
;
143 Lisp_Object Qfile_error
;
144 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
145 static Lisp_Object Qexcl
;
146 Lisp_Object Qfile_name_history
;
148 static Lisp_Object Qcar_less_than_car
;
150 static Lisp_Object
Fmake_symbolic_link (Lisp_Object
, Lisp_Object
, Lisp_Object
);
151 static int a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
152 Lisp_Object
*, struct coding_system
*);
153 static int e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
154 struct coding_system
*);
158 report_file_error (const char *string
, Lisp_Object data
)
160 Lisp_Object errstring
;
164 synchronize_system_messages_locale ();
165 str
= strerror (errorno
);
166 errstring
= code_convert_string_norecord (make_unibyte_string (str
,
168 Vlocale_coding_system
, 0);
174 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
177 /* System error messages are capitalized. Downcase the initial
178 unless it is followed by a slash. (The slash case caters to
179 error messages that begin with "I/O" or, in German, "E/A".) */
180 if (STRING_MULTIBYTE (errstring
)
181 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
185 str
= SSDATA (errstring
);
186 c
= STRING_CHAR ((unsigned char *) str
);
187 Faset (errstring
, make_number (0), make_number (downcase (c
)));
190 xsignal (Qfile_error
,
191 Fcons (build_string (string
), Fcons (errstring
, data
)));
196 close_file_unwind (Lisp_Object fd
)
198 emacs_close (XFASTINT (fd
));
202 /* Restore point, having saved it as a marker. */
205 restore_point_unwind (Lisp_Object location
)
207 Fgoto_char (location
);
208 Fset_marker (location
, Qnil
, Qnil
);
213 static Lisp_Object Qexpand_file_name
;
214 static Lisp_Object Qsubstitute_in_file_name
;
215 static Lisp_Object Qdirectory_file_name
;
216 static Lisp_Object Qfile_name_directory
;
217 static Lisp_Object Qfile_name_nondirectory
;
218 static Lisp_Object Qunhandled_file_name_directory
;
219 static Lisp_Object Qfile_name_as_directory
;
220 static Lisp_Object Qcopy_file
;
221 static Lisp_Object Qmake_directory_internal
;
222 static Lisp_Object Qmake_directory
;
223 static Lisp_Object Qdelete_directory_internal
;
224 Lisp_Object Qdelete_file
;
225 static Lisp_Object Qrename_file
;
226 static Lisp_Object Qadd_name_to_file
;
227 static Lisp_Object Qmake_symbolic_link
;
228 Lisp_Object Qfile_exists_p
;
229 static Lisp_Object Qfile_executable_p
;
230 static Lisp_Object Qfile_readable_p
;
231 static Lisp_Object Qfile_writable_p
;
232 static Lisp_Object Qfile_symlink_p
;
233 static Lisp_Object Qaccess_file
;
234 Lisp_Object Qfile_directory_p
;
235 static Lisp_Object Qfile_regular_p
;
236 static Lisp_Object Qfile_accessible_directory_p
;
237 static Lisp_Object Qfile_modes
;
238 static Lisp_Object Qset_file_modes
;
239 static Lisp_Object Qset_file_times
;
240 static Lisp_Object Qfile_selinux_context
;
241 static Lisp_Object Qset_file_selinux_context
;
242 static Lisp_Object Qfile_newer_than_file_p
;
243 Lisp_Object Qinsert_file_contents
;
244 Lisp_Object Qwrite_region
;
245 static Lisp_Object Qverify_visited_file_modtime
;
246 static Lisp_Object Qset_visited_file_modtime
;
248 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
249 Sfind_file_name_handler
, 2, 2, 0,
250 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
251 Otherwise, return nil.
252 A file name is handled if one of the regular expressions in
253 `file-name-handler-alist' matches it.
255 If OPERATION equals `inhibit-file-name-operation', then we ignore
256 any handlers that are members of `inhibit-file-name-handlers',
257 but we still do run any other handlers. This lets handlers
258 use the standard functions without calling themselves recursively. */)
259 (Lisp_Object filename
, Lisp_Object operation
)
261 /* This function must not munge the match data. */
262 Lisp_Object chain
, inhibited_handlers
, result
;
266 CHECK_STRING (filename
);
268 if (EQ (operation
, Vinhibit_file_name_operation
))
269 inhibited_handlers
= Vinhibit_file_name_handlers
;
271 inhibited_handlers
= Qnil
;
273 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
274 chain
= XCDR (chain
))
280 Lisp_Object string
= XCAR (elt
);
282 Lisp_Object handler
= XCDR (elt
);
283 Lisp_Object operations
= Qnil
;
285 if (SYMBOLP (handler
))
286 operations
= Fget (handler
, Qoperations
);
289 && (match_pos
= fast_string_match (string
, filename
)) > pos
290 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
294 handler
= XCDR (elt
);
295 tem
= Fmemq (handler
, inhibited_handlers
);
309 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
311 doc
: /* Return the directory component in file name FILENAME.
312 Return nil if FILENAME does not include a directory.
313 Otherwise return a directory name.
314 Given a Unix syntax file name, returns a string ending in slash. */)
315 (Lisp_Object filename
)
318 register const char *beg
;
322 register const char *p
;
325 CHECK_STRING (filename
);
327 /* If the file name has special constructs in it,
328 call the corresponding file handler. */
329 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
332 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
334 return STRINGP (handled_name
) ? handled_name
: Qnil
;
337 filename
= FILE_SYSTEM_CASE (filename
);
339 beg
= (char *) alloca (SBYTES (filename
) + 1);
340 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
342 beg
= SSDATA (filename
);
344 p
= beg
+ SBYTES (filename
);
346 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
348 /* only recognize drive specifier at the beginning */
350 /* handle the "/:d:foo" and "/:foo" cases correctly */
351 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
352 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
359 /* Expansion of "c:" to drive and default directory. */
362 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
363 char *res
= alloca (MAXPATHLEN
+ 1);
366 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
368 strncpy (res
, beg
, 2);
373 if (getdefdir (toupper ((unsigned char) *beg
) - 'A' + 1, r
))
375 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
378 p
= beg
+ strlen (beg
);
381 dostounix_filename (beg
);
384 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
387 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
388 Sfile_name_nondirectory
, 1, 1, 0,
389 doc
: /* Return file name FILENAME sans its directory.
390 For example, in a Unix-syntax file name,
391 this is everything after the last slash,
392 or the entire name if it contains no slash. */)
393 (Lisp_Object filename
)
395 register const char *beg
, *p
, *end
;
398 CHECK_STRING (filename
);
400 /* If the file name has special constructs in it,
401 call the corresponding file handler. */
402 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
405 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
407 if (STRINGP (handled_name
))
409 error ("Invalid handler in `file-name-handler-alist'");
412 beg
= SSDATA (filename
);
413 end
= p
= beg
+ SBYTES (filename
);
415 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
417 /* only recognize drive specifier at beginning */
419 /* handle the "/:d:foo" case correctly */
420 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
425 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
428 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
429 Sunhandled_file_name_directory
, 1, 1, 0,
430 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
431 A `directly usable' directory name is one that may be used without the
432 intervention of any file handler.
433 If FILENAME is a directly usable file itself, return
434 \(file-name-directory FILENAME).
435 If FILENAME refers to a file which is not accessible from a local process,
436 then this should return nil.
437 The `call-process' and `start-process' functions use this function to
438 get a current directory to run processes in. */)
439 (Lisp_Object filename
)
443 /* If the file name has special constructs in it,
444 call the corresponding file handler. */
445 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
448 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
450 return STRINGP (handled_name
) ? handled_name
: Qnil
;
453 return Ffile_name_directory (filename
);
458 file_name_as_directory (char *out
, const char *in
)
460 ptrdiff_t len
= strlen (in
);
472 /* For Unix syntax, Append a slash if necessary */
473 if (!IS_DIRECTORY_SEP (out
[len
- 1]))
475 out
[len
] = DIRECTORY_SEP
;
479 dostounix_filename (out
);
484 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
485 Sfile_name_as_directory
, 1, 1, 0,
486 doc
: /* Return a string representing the file name FILE interpreted as a directory.
487 This operation exists because a directory is also a file, but its name as
488 a directory is different from its name as a file.
489 The result can be used as the value of `default-directory'
490 or passed as second argument to `expand-file-name'.
491 For a Unix-syntax file name, just appends a slash. */)
501 /* If the file name has special constructs in it,
502 call the corresponding file handler. */
503 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
506 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
508 if (STRINGP (handled_name
))
510 error ("Invalid handler in `file-name-handler-alist'");
513 buf
= (char *) alloca (SBYTES (file
) + 10);
514 file_name_as_directory (buf
, SSDATA (file
));
515 return make_specified_string (buf
, -1, strlen (buf
),
516 STRING_MULTIBYTE (file
));
520 * Convert from directory name to filename.
521 * On UNIX, it's simple: just make sure there isn't a terminating /
523 * Value is nonzero if the string output is different from the input.
527 directory_file_name (char *src
, char *dst
)
533 /* Process as Unix format: just remove any final slash.
534 But leave "/" unchanged; do not change it to "". */
537 && IS_DIRECTORY_SEP (dst
[slen
- 1])
539 && !IS_ANY_SEP (dst
[slen
- 2])
544 dostounix_filename (dst
);
549 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
551 doc
: /* Returns the file name of the directory named DIRECTORY.
552 This is the name of the file that holds the data for the directory DIRECTORY.
553 This operation exists because a directory is also a file, but its name as
554 a directory is different from its name as a file.
555 In Unix-syntax, this function just removes the final slash. */)
556 (Lisp_Object directory
)
561 CHECK_STRING (directory
);
563 if (NILP (directory
))
566 /* If the file name has special constructs in it,
567 call the corresponding file handler. */
568 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
571 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
573 if (STRINGP (handled_name
))
575 error ("Invalid handler in `file-name-handler-alist'");
578 buf
= (char *) alloca (SBYTES (directory
) + 20);
579 directory_file_name (SSDATA (directory
), buf
);
580 return make_specified_string (buf
, -1, strlen (buf
),
581 STRING_MULTIBYTE (directory
));
584 static const char make_temp_name_tbl
[64] =
586 'A','B','C','D','E','F','G','H',
587 'I','J','K','L','M','N','O','P',
588 'Q','R','S','T','U','V','W','X',
589 'Y','Z','a','b','c','d','e','f',
590 'g','h','i','j','k','l','m','n',
591 'o','p','q','r','s','t','u','v',
592 'w','x','y','z','0','1','2','3',
593 '4','5','6','7','8','9','-','_'
596 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
598 /* Value is a temporary file name starting with PREFIX, a string.
600 The Emacs process number forms part of the result, so there is
601 no danger of generating a name being used by another process.
602 In addition, this function makes an attempt to choose a name
603 which has no existing file. To make this work, PREFIX should be
604 an absolute file name.
606 BASE64_P non-zero means add the pid as 3 characters in base64
607 encoding. In this case, 6 characters will be added to PREFIX to
608 form the file name. Otherwise, if Emacs is running on a system
609 with long file names, add the pid as a decimal number.
611 This function signals an error if no unique file name could be
615 make_temp_name (Lisp_Object prefix
, int base64_p
)
621 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
624 CHECK_STRING (prefix
);
626 /* VAL is created by adding 6 characters to PREFIX. The first
627 three are the PID of this process, in base 64, and the second
628 three are incremented if the file already exists. This ensures
629 262144 unique file names per PID per PREFIX. */
635 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
636 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
637 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
642 #ifdef HAVE_LONG_FILE_NAMES
643 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
645 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
646 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
647 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
652 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
653 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
654 if (!STRING_MULTIBYTE (prefix
))
655 STRING_SET_UNIBYTE (val
);
657 memcpy (data
, SSDATA (prefix
), len
);
660 memcpy (p
, pidbuf
, pidlen
);
663 /* Here we try to minimize useless stat'ing when this function is
664 invoked many times successively with the same PREFIX. We achieve
665 this by initializing count to a random value, and incrementing it
668 We don't want make-temp-name to be called while dumping,
669 because then make_temp_name_count_initialized_p would get set
670 and then make_temp_name_count would not be set when Emacs starts. */
672 if (!make_temp_name_count_initialized_p
)
674 make_temp_name_count
= time (NULL
);
675 make_temp_name_count_initialized_p
= 1;
681 unsigned num
= make_temp_name_count
;
683 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
684 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
685 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
687 /* Poor man's congruential RN generator. Replace with
688 ++make_temp_name_count for debugging. */
689 make_temp_name_count
+= 25229;
690 make_temp_name_count
%= 225307;
692 if (stat (data
, &ignored
) < 0)
694 /* We want to return only if errno is ENOENT. */
698 /* The error here is dubious, but there is little else we
699 can do. The alternatives are to return nil, which is
700 as bad as (and in many cases worse than) throwing the
701 error, or to ignore the error, which will likely result
702 in looping through 225307 stat's, which is not only
703 dog-slow, but also useless since eventually nil would
704 have to be returned anyway. */
705 report_file_error ("Cannot create temporary name for prefix",
706 Fcons (prefix
, Qnil
));
713 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
714 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
715 The Emacs process number forms part of the result,
716 so there is no danger of generating a name being used by another process.
718 In addition, this function makes an attempt to choose a name
719 which has no existing file. To make this work,
720 PREFIX should be an absolute file name.
722 There is a race condition between calling `make-temp-name' and creating the
723 file which opens all kinds of security holes. For that reason, you should
724 probably use `make-temp-file' instead, except in three circumstances:
726 * If you are creating the file in the user's home directory.
727 * If you are creating a directory rather than an ordinary file.
728 * If you are taking special precautions as `make-temp-file' does. */)
731 return make_temp_name (prefix
, 0);
736 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
737 doc
: /* Convert filename NAME to absolute, and canonicalize it.
738 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
739 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
740 the current buffer's value of `default-directory' is used.
741 NAME should be a string that is a valid file name for the underlying
743 File name components that are `.' are removed, and
744 so are file name components followed by `..', along with the `..' itself;
745 note that these simplifications are done without checking the resulting
746 file names in the file system.
747 Multiple consecutive slashes are collapsed into a single slash,
748 except at the beginning of the file name when they are significant (e.g.,
749 UNC file names on MS-Windows.)
750 An initial `~/' expands to your home directory.
751 An initial `~USER/' expands to USER's home directory.
752 See also the function `substitute-in-file-name'.
754 For technical reasons, this function can return correct but
755 non-intuitive results for the root directory; for instance,
756 \(expand-file-name ".." "/") returns "/..". For this reason, use
757 \(directory-file-name (file-name-directory dirname)) to traverse a
758 filesystem tree, not (expand-file-name ".." dirname). */)
759 (Lisp_Object name
, Lisp_Object default_directory
)
761 /* These point to SDATA and need to be careful with string-relocation
762 during GC (via DECODE_FILE). */
765 /* This should only point to alloca'd data. */
772 int collapse_newdir
= 1;
776 Lisp_Object handler
, result
, handled_name
;
782 /* If the file name has special constructs in it,
783 call the corresponding file handler. */
784 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
787 handled_name
= call3 (handler
, Qexpand_file_name
,
788 name
, default_directory
);
789 if (STRINGP (handled_name
))
791 error ("Invalid handler in `file-name-handler-alist'");
795 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
796 if (NILP (default_directory
))
797 default_directory
= BVAR (current_buffer
, directory
);
798 if (! STRINGP (default_directory
))
801 /* "/" is not considered a root directory on DOS_NT, so using "/"
802 here causes an infinite recursion in, e.g., the following:
804 (let (default-directory)
805 (expand-file-name "a"))
807 To avoid this, we set default_directory to the root of the
809 default_directory
= build_string (emacs_root_dir ());
811 default_directory
= build_string ("/");
815 if (!NILP (default_directory
))
817 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
820 handled_name
= call3 (handler
, Qexpand_file_name
,
821 name
, default_directory
);
822 if (STRINGP (handled_name
))
824 error ("Invalid handler in `file-name-handler-alist'");
829 char *o
= SSDATA (default_directory
);
831 /* Make sure DEFAULT_DIRECTORY is properly expanded.
832 It would be better to do this down below where we actually use
833 default_directory. Unfortunately, calling Fexpand_file_name recursively
834 could invoke GC, and the strings might be relocated. This would
835 be annoying because we have pointers into strings lying around
836 that would need adjusting, and people would add new pointers to
837 the code and forget to adjust them, resulting in intermittent bugs.
838 Putting this call here avoids all that crud.
840 The EQ test avoids infinite recursion. */
841 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
842 /* Save time in some common cases - as long as default_directory
843 is not relative, it can be canonicalized with name below (if it
844 is needed at all) without requiring it to be expanded now. */
846 /* Detect MSDOS file names with drive specifiers. */
847 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
848 && IS_DIRECTORY_SEP (o
[2]))
850 /* Detect Windows file names in UNC format. */
851 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
853 #else /* not DOS_NT */
854 /* Detect Unix absolute file names (/... alone is not absolute on
856 && ! (IS_DIRECTORY_SEP (o
[0]))
857 #endif /* not DOS_NT */
863 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
867 name
= FILE_SYSTEM_CASE (name
);
868 multibyte
= STRING_MULTIBYTE (name
);
869 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
872 default_directory
= string_to_multibyte (default_directory
);
875 name
= string_to_multibyte (name
);
880 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
881 nm
= (char *) alloca (SBYTES (name
) + 1);
882 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
885 /* Note if special escape prefix is present, but remove for now. */
886 if (nm
[0] == '/' && nm
[1] == ':')
892 /* Find and remove drive specifier if present; this makes nm absolute
893 even if the rest of the name appears to be relative. Only look for
894 drive specifier at the beginning. */
895 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
897 drive
= (unsigned char) nm
[0];
902 /* If we see "c://somedir", we want to strip the first slash after the
903 colon when stripping the drive letter. Otherwise, this expands to
905 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
908 /* Discard any previous drive specifier if nm is now in UNC format. */
909 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
913 #endif /* WINDOWSNT */
916 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
917 none are found, we can probably return right away. We will avoid
918 allocating a new string if name is already fully expanded. */
920 IS_DIRECTORY_SEP (nm
[0])
922 && drive
&& !is_escaped
925 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
929 /* If it turns out that the filename we want to return is just a
930 suffix of FILENAME, we don't need to go through and edit
931 things; we just need to construct a new string using data
932 starting at the middle of FILENAME. If we set lose to a
933 non-zero value, that means we've discovered that we can't do
940 /* Since we know the name is absolute, we can assume that each
941 element starts with a "/". */
943 /* "." and ".." are hairy. */
944 if (IS_DIRECTORY_SEP (p
[0])
946 && (IS_DIRECTORY_SEP (p
[2])
948 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
951 /* We want to replace multiple `/' in a row with a single
954 && IS_DIRECTORY_SEP (p
[0])
955 && IS_DIRECTORY_SEP (p
[1]))
962 /* Make sure directories are all separated with /, but
963 avoid allocation of a new string when not required. */
964 dostounix_filename (nm
);
966 if (IS_DIRECTORY_SEP (nm
[1]))
968 if (strcmp (nm
, SSDATA (name
)) != 0)
969 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
973 /* Drive must be set, so this is okay. */
974 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
978 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
979 temp
[0] = DRIVE_LETTER (drive
);
980 name
= concat2 (build_string (temp
), name
);
983 #else /* not DOS_NT */
984 if (strcmp (nm
, SSDATA (name
)) == 0)
986 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
987 #endif /* not DOS_NT */
991 /* At this point, nm might or might not be an absolute file name. We
992 need to expand ~ or ~user if present, otherwise prefix nm with
993 default_directory if nm is not absolute, and finally collapse /./
994 and /foo/../ sequences.
996 We set newdir to be the appropriate prefix if one is needed:
997 - the relevant user directory if nm starts with ~ or ~user
998 - the specified drive's working dir (DOS/NT only) if nm does not
1000 - the value of default_directory.
1002 Note that these prefixes are not guaranteed to be absolute (except
1003 for the working dir of a drive). Therefore, to ensure we always
1004 return an absolute name, if the final prefix is not absolute we
1005 append it to the current working directory. */
1009 if (nm
[0] == '~') /* prefix ~ */
1011 if (IS_DIRECTORY_SEP (nm
[1])
1012 || nm
[1] == 0) /* ~ by itself */
1016 if (!(newdir
= egetenv ("HOME")))
1019 /* `egetenv' may return a unibyte string, which will bite us since
1020 we expect the directory to be multibyte. */
1021 tem
= build_string (newdir
);
1022 if (!STRING_MULTIBYTE (tem
))
1024 hdir
= DECODE_FILE (tem
);
1025 newdir
= SSDATA (hdir
);
1028 collapse_newdir
= 0;
1031 else /* ~user/filename */
1034 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1035 o
= alloca (p
- nm
+ 1);
1036 memcpy (o
, nm
, p
- nm
);
1040 pw
= (struct passwd
*) getpwnam (o
+ 1);
1044 newdir
= pw
->pw_dir
;
1047 collapse_newdir
= 0;
1051 /* If we don't find a user of that name, leave the name
1052 unchanged; don't move nm forward to p. */
1057 /* On DOS and Windows, nm is absolute if a drive name was specified;
1058 use the drive's current directory as the prefix if needed. */
1059 if (!newdir
&& drive
)
1061 /* Get default directory if needed to make nm absolute. */
1063 if (!IS_DIRECTORY_SEP (nm
[0]))
1065 adir
= alloca (MAXPATHLEN
+ 1);
1066 if (!getdefdir (toupper (drive
) - 'A' + 1, adir
))
1071 /* Either nm starts with /, or drive isn't mounted. */
1073 adir
[0] = DRIVE_LETTER (drive
);
1082 /* Finally, if no prefix has been specified and nm is not absolute,
1083 then it must be expanded relative to default_directory. */
1087 /* /... alone is not absolute on DOS and Windows. */
1088 && !IS_DIRECTORY_SEP (nm
[0])
1091 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1095 newdir
= SSDATA (default_directory
);
1097 /* Note if special escape prefix is present, but remove for now. */
1098 if (newdir
[0] == '/' && newdir
[1] == ':')
1109 /* First ensure newdir is an absolute name. */
1111 /* Detect MSDOS file names with drive specifiers. */
1112 ! (IS_DRIVE (newdir
[0])
1113 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1115 /* Detect Windows file names in UNC format. */
1116 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1120 /* Effectively, let newdir be (expand-file-name newdir cwd).
1121 Because of the admonition against calling expand-file-name
1122 when we have pointers into lisp strings, we accomplish this
1123 indirectly by prepending newdir to nm if necessary, and using
1124 cwd (or the wd of newdir's drive) as the new newdir. */
1126 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1128 drive
= (unsigned char) newdir
[0];
1131 if (!IS_DIRECTORY_SEP (nm
[0]))
1133 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1134 file_name_as_directory (tmp
, newdir
);
1138 adir
= alloca (MAXPATHLEN
+ 1);
1141 if (!getdefdir (toupper (drive
) - 'A' + 1, adir
))
1149 /* Strip off drive name from prefix, if present. */
1150 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1156 /* Keep only a prefix from newdir if nm starts with slash
1157 (//server/share for UNC, nothing otherwise). */
1158 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1161 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1163 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1165 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1167 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1180 /* Get rid of any slash at the end of newdir, unless newdir is
1181 just / or // (an incomplete UNC name). */
1182 length
= strlen (newdir
);
1183 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1185 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1189 char *temp
= (char *) alloca (length
);
1190 memcpy (temp
, newdir
, length
- 1);
1191 temp
[length
- 1] = 0;
1199 /* Now concatenate the directory and name to new space in the stack frame. */
1200 tlen
+= strlen (nm
) + 1;
1202 /* Reserve space for drive specifier and escape prefix, since either
1203 or both may need to be inserted. (The Microsoft x86 compiler
1204 produces incorrect code if the following two lines are combined.) */
1205 target
= (char *) alloca (tlen
+ 4);
1207 #else /* not DOS_NT */
1208 target
= (char *) alloca (tlen
);
1209 #endif /* not DOS_NT */
1214 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1217 /* If newdir is effectively "C:/", then the drive letter will have
1218 been stripped and newdir will be "/". Concatenating with an
1219 absolute directory in nm produces "//", which will then be
1220 incorrectly treated as a network share. Ignore newdir in
1221 this case (keeping the drive letter). */
1222 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1223 && newdir
[1] == '\0'))
1225 strcpy (target
, newdir
);
1228 file_name_as_directory (target
, newdir
);
1231 strcat (target
, nm
);
1233 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1241 if (!IS_DIRECTORY_SEP (*p
))
1245 else if (p
[1] == '.'
1246 && (IS_DIRECTORY_SEP (p
[2])
1249 /* If "/." is the entire filename, keep the "/". Otherwise,
1250 just delete the whole "/.". */
1251 if (o
== target
&& p
[2] == '\0')
1255 else if (p
[1] == '.' && p
[2] == '.'
1256 /* `/../' is the "superroot" on certain file systems.
1257 Turned off on DOS_NT systems because they have no
1258 "superroot" and because this causes us to produce
1259 file names like "d:/../foo" which fail file-related
1260 functions of the underlying OS. (To reproduce, try a
1261 long series of "../../" in default_directory, longer
1262 than the number of levels from the root.) */
1266 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1271 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1274 /* Don't go below server level in UNC filenames. */
1275 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1276 && IS_DIRECTORY_SEP (*target
))
1280 /* Keep initial / only if this is the whole name. */
1281 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1285 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1286 /* Collapse multiple `/' in a row. */
1295 /* At last, set drive name. */
1297 /* Except for network file name. */
1298 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1299 #endif /* WINDOWSNT */
1301 if (!drive
) abort ();
1303 target
[0] = DRIVE_LETTER (drive
);
1306 /* Reinsert the escape prefix if required. */
1313 dostounix_filename (target
);
1316 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1319 /* Again look to see if the file name has special constructs in it
1320 and perhaps call the corresponding file handler. This is needed
1321 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1322 the ".." component gives us "/user@host:/bar/../baz" which needs
1323 to be expanded again. */
1324 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1325 if (!NILP (handler
))
1327 handled_name
= call3 (handler
, Qexpand_file_name
,
1328 result
, default_directory
);
1329 if (STRINGP (handled_name
))
1330 return handled_name
;
1331 error ("Invalid handler in `file-name-handler-alist'");
1338 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1339 This is the old version of expand-file-name, before it was thoroughly
1340 rewritten for Emacs 10.31. We leave this version here commented-out,
1341 because the code is very complex and likely to have subtle bugs. If
1342 bugs _are_ found, it might be of interest to look at the old code and
1343 see what did it do in the relevant situation.
1345 Don't remove this code: it's true that it will be accessible
1346 from the repository, but a few years from deletion, people will
1347 forget it is there. */
1349 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1350 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1351 "Convert FILENAME to absolute, and canonicalize it.\n\
1352 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1353 \(does not start with slash); if DEFAULT is nil or missing,\n\
1354 the current buffer's value of default-directory is used.\n\
1355 Filenames containing `.' or `..' as components are simplified;\n\
1356 initial `~/' expands to your home directory.\n\
1357 See also the function `substitute-in-file-name'.")
1359 Lisp_Object name
, defalt
;
1363 register unsigned char *newdir
, *p
, *o
;
1365 unsigned char *target
;
1369 CHECK_STRING (name
);
1372 /* If nm is absolute, flush ...// and detect /./ and /../.
1373 If no /./ or /../ we can return right away. */
1380 if (p
[0] == '/' && p
[1] == '/'
1383 if (p
[0] == '/' && p
[1] == '~')
1384 nm
= p
+ 1, lose
= 1;
1385 if (p
[0] == '/' && p
[1] == '.'
1386 && (p
[2] == '/' || p
[2] == 0
1387 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1393 if (nm
== SDATA (name
))
1395 return build_string (nm
);
1399 /* Now determine directory to start with and put it in NEWDIR. */
1403 if (nm
[0] == '~') /* prefix ~ */
1404 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1406 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1407 newdir
= (unsigned char *) "";
1410 else /* ~user/filename */
1412 /* Get past ~ to user. */
1413 unsigned char *user
= nm
+ 1;
1414 /* Find end of name. */
1415 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1416 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1417 /* Copy the user name into temp storage. */
1418 o
= (unsigned char *) alloca (len
+ 1);
1419 memcpy (o
, user
, len
);
1422 /* Look up the user name. */
1424 pw
= (struct passwd
*) getpwnam (o
+ 1);
1427 error ("\"%s\" isn't a registered user", o
+ 1);
1429 newdir
= (unsigned char *) pw
->pw_dir
;
1431 /* Discard the user name from NM. */
1435 if (nm
[0] != '/' && !newdir
)
1438 defalt
= current_buffer
->directory
;
1439 CHECK_STRING (defalt
);
1440 newdir
= SDATA (defalt
);
1443 /* Now concatenate the directory and name to new space in the stack frame. */
1445 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1446 target
= (unsigned char *) alloca (tlen
);
1451 if (nm
[0] == 0 || nm
[0] == '/')
1452 strcpy (target
, newdir
);
1454 file_name_as_directory (target
, newdir
);
1457 strcat (target
, nm
);
1459 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1470 else if (!strncmp (p
, "//", 2)
1476 else if (p
[0] == '/' && p
[1] == '.'
1477 && (p
[2] == '/' || p
[2] == 0))
1479 else if (!strncmp (p
, "/..", 3)
1480 /* `/../' is the "superroot" on certain file systems. */
1482 && (p
[3] == '/' || p
[3] == 0))
1484 while (o
!= target
&& *--o
!= '/')
1486 if (o
== target
&& *o
== '/')
1496 return make_string (target
, o
- target
);
1500 /* If /~ or // appears, discard everything through first slash. */
1502 file_name_absolute_p (const char *filename
)
1505 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1507 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1508 && IS_DIRECTORY_SEP (filename
[2]))
1514 search_embedded_absfilename (char *nm
, char *endp
)
1518 for (p
= nm
+ 1; p
< endp
; p
++)
1521 || IS_DIRECTORY_SEP (p
[-1]))
1522 && file_name_absolute_p (p
)
1523 #if defined (WINDOWSNT) || defined (CYGWIN)
1524 /* // at start of file name is meaningful in Apollo,
1525 WindowsNT and Cygwin systems. */
1526 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1527 #endif /* not (WINDOWSNT || CYGWIN) */
1530 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1531 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1533 char *o
= alloca (s
- p
+ 1);
1535 memcpy (o
, p
, s
- p
);
1538 /* If we have ~user and `user' exists, discard
1539 everything up to ~. But if `user' does not exist, leave
1540 ~user alone, it might be a literal file name. */
1542 pw
= getpwnam (o
+ 1);
1554 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1555 Ssubstitute_in_file_name
, 1, 1, 0,
1556 doc
: /* Substitute environment variables referred to in FILENAME.
1557 `$FOO' where FOO is an environment variable name means to substitute
1558 the value of that variable. The variable name should be terminated
1559 with a character not a letter, digit or underscore; otherwise, enclose
1560 the entire variable name in braces.
1562 If `/~' appears, all of FILENAME through that `/' is discarded.
1563 If `//' appears, everything up to and including the first of
1564 those `/' is discarded. */)
1565 (Lisp_Object filename
)
1569 register char *s
, *p
, *o
, *x
, *endp
;
1570 char *target
= NULL
;
1572 int substituted
= 0;
1575 Lisp_Object handler
;
1577 CHECK_STRING (filename
);
1579 multibyte
= STRING_MULTIBYTE (filename
);
1581 /* If the file name has special constructs in it,
1582 call the corresponding file handler. */
1583 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1584 if (!NILP (handler
))
1586 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1588 if (STRINGP (handled_name
))
1589 return handled_name
;
1590 error ("Invalid handler in `file-name-handler-alist'");
1593 /* Always work on a copy of the string, in case GC happens during
1594 decode of environment variables, causing the original Lisp_String
1595 data to be relocated. */
1596 nm
= (char *) alloca (SBYTES (filename
) + 1);
1597 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1600 dostounix_filename (nm
);
1601 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1603 endp
= nm
+ SBYTES (filename
);
1605 /* If /~ or // appears, discard everything through first slash. */
1606 p
= search_embedded_absfilename (nm
, endp
);
1608 /* Start over with the new string, so we check the file-name-handler
1609 again. Important with filenames like "/home/foo//:/hello///there"
1610 which would substitute to "/:/hello///there" rather than "/there". */
1611 return Fsubstitute_in_file_name
1612 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1614 /* See if any variables are substituted into the string
1615 and find the total length of their values in `total'. */
1617 for (p
= nm
; p
!= endp
;)
1627 /* "$$" means a single "$". */
1636 while (p
!= endp
&& *p
!= '}') p
++;
1637 if (*p
!= '}') goto missingclose
;
1643 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1647 /* Copy out the variable name. */
1648 target
= (char *) alloca (s
- o
+ 1);
1649 strncpy (target
, o
, s
- o
);
1652 strupr (target
); /* $home == $HOME etc. */
1655 /* Get variable value. */
1656 o
= egetenv (target
);
1659 /* Don't try to guess a maximum length - UTF8 can use up to
1660 four bytes per character. This code is unlikely to run
1661 in a situation that requires performance, so decoding the
1662 env variables twice should be acceptable. Note that
1663 decoding may cause a garbage collect. */
1664 Lisp_Object orig
, decoded
;
1665 orig
= make_unibyte_string (o
, strlen (o
));
1666 decoded
= DECODE_FILE (orig
);
1667 total
+= SBYTES (decoded
);
1677 /* If substitution required, recopy the string and do it. */
1678 /* Make space in stack frame for the new copy. */
1679 xnm
= (char *) alloca (SBYTES (filename
) + total
+ 1);
1682 /* Copy the rest of the name through, replacing $ constructs with values. */
1699 while (p
!= endp
&& *p
!= '}') p
++;
1700 if (*p
!= '}') goto missingclose
;
1706 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1710 /* Copy out the variable name. */
1711 target
= (char *) alloca (s
- o
+ 1);
1712 strncpy (target
, o
, s
- o
);
1715 strupr (target
); /* $home == $HOME etc. */
1718 /* Get variable value. */
1719 o
= egetenv (target
);
1723 strcpy (x
, target
); x
+= strlen (target
);
1727 Lisp_Object orig
, decoded
;
1728 ptrdiff_t orig_length
, decoded_length
;
1729 orig_length
= strlen (o
);
1730 orig
= make_unibyte_string (o
, orig_length
);
1731 decoded
= DECODE_FILE (orig
);
1732 decoded_length
= SBYTES (decoded
);
1733 strncpy (x
, SSDATA (decoded
), decoded_length
);
1734 x
+= decoded_length
;
1736 /* If environment variable needed decoding, return value
1737 needs to be multibyte. */
1738 if (decoded_length
!= orig_length
1739 || strncmp (SSDATA (decoded
), o
, orig_length
))
1746 /* If /~ or // appears, discard everything through first slash. */
1747 while ((p
= search_embedded_absfilename (xnm
, x
)))
1748 /* This time we do not start over because we've already expanded envvars
1749 and replaced $$ with $. Maybe we should start over as well, but we'd
1750 need to quote some $ to $$ first. */
1753 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1756 error ("Bad format environment-variable substitution");
1758 error ("Missing \"}\" in environment-variable substitution");
1760 error ("Substituting nonexistent environment variable \"%s\"", target
);
1766 /* A slightly faster and more convenient way to get
1767 (directory-file-name (expand-file-name FOO)). */
1770 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1772 register Lisp_Object absname
;
1774 absname
= Fexpand_file_name (filename
, defdir
);
1776 /* Remove final slash, if any (unless this is the root dir).
1777 stat behaves differently depending! */
1778 if (SCHARS (absname
) > 1
1779 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1780 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1781 /* We cannot take shortcuts; they might be wrong for magic file names. */
1782 absname
= Fdirectory_file_name (absname
);
1786 /* Signal an error if the file ABSNAME already exists.
1787 If INTERACTIVE is nonzero, ask the user whether to proceed,
1788 and bypass the error if the user says to go ahead.
1789 QUERYSTRING is a name for the action that is being considered
1792 *STATPTR is used to store the stat information if the file exists.
1793 If the file does not exist, STATPTR->st_mode is set to 0.
1794 If STATPTR is null, we don't store into it.
1796 If QUICK is nonzero, we ask for y or n, not yes or no. */
1799 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1800 int interactive
, struct stat
*statptr
, int quick
)
1802 register Lisp_Object tem
, encoded_filename
;
1803 struct stat statbuf
;
1804 struct gcpro gcpro1
;
1806 encoded_filename
= ENCODE_FILE (absname
);
1808 /* `stat' is a good way to tell whether the file exists,
1809 regardless of what access permissions it has. */
1810 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1812 if (S_ISDIR (statbuf
.st_mode
))
1813 xsignal2 (Qfile_error
,
1814 build_string ("File is a directory"), absname
);
1817 xsignal2 (Qfile_already_exists
,
1818 build_string ("File already exists"), absname
);
1820 tem
= format2 ("File %s already exists; %s anyway? ",
1821 absname
, build_string (querystring
));
1823 tem
= call1 (intern ("y-or-n-p"), tem
);
1825 tem
= do_yes_or_no_p (tem
);
1828 xsignal2 (Qfile_already_exists
,
1829 build_string ("File already exists"), absname
);
1836 statptr
->st_mode
= 0;
1841 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1842 "fCopy file: \nGCopy %s to file: \np\nP",
1843 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1844 If NEWNAME names a directory, copy FILE there.
1846 This function always sets the file modes of the output file to match
1849 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1850 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1851 signal a `file-already-exists' error without overwriting. If
1852 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1853 about overwriting; this is what happens in interactive use with M-x.
1854 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1857 Fourth arg KEEP-TIME non-nil means give the output file the same
1858 last-modified time as the old one. (This works on only some systems.)
1860 A prefix arg makes KEEP-TIME non-nil.
1862 If PRESERVE-UID-GID is non-nil, we try to transfer the
1863 uid and gid of FILE to NEWNAME.
1865 If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
1866 on the system, we copy the SELinux context of FILE to NEWNAME. */)
1867 (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
)
1871 char buf
[16 * 1024];
1872 struct stat st
, out_st
;
1873 Lisp_Object handler
;
1874 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1875 ptrdiff_t count
= SPECPDL_INDEX ();
1876 int input_file_statable_p
;
1877 Lisp_Object encoded_file
, encoded_newname
;
1879 security_context_t con
;
1880 int fail
, conlength
= 0;
1883 encoded_file
= encoded_newname
= Qnil
;
1884 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1885 CHECK_STRING (file
);
1886 CHECK_STRING (newname
);
1888 if (!NILP (Ffile_directory_p (newname
)))
1889 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1891 newname
= Fexpand_file_name (newname
, Qnil
);
1893 file
= Fexpand_file_name (file
, Qnil
);
1895 /* If the input file name has special constructs in it,
1896 call the corresponding file handler. */
1897 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1898 /* Likewise for output file name. */
1900 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1901 if (!NILP (handler
))
1902 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1903 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1904 preserve_selinux_context
));
1906 encoded_file
= ENCODE_FILE (file
);
1907 encoded_newname
= ENCODE_FILE (newname
);
1909 if (NILP (ok_if_already_exists
)
1910 || INTEGERP (ok_if_already_exists
))
1911 barf_or_query_if_file_exists (newname
, "copy to it",
1912 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1913 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1917 if (!CopyFile (SDATA (encoded_file
),
1918 SDATA (encoded_newname
),
1920 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1921 /* CopyFile retains the timestamp by default. */
1922 else if (NILP (keep_time
))
1928 EMACS_GET_TIME (now
);
1929 filename
= SDATA (encoded_newname
);
1931 /* Ensure file is writable while its modified time is set. */
1932 attributes
= GetFileAttributes (filename
);
1933 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1934 if (set_file_times (filename
, now
, now
))
1936 /* Restore original attributes. */
1937 SetFileAttributes (filename
, attributes
);
1938 xsignal2 (Qfile_date_error
,
1939 build_string ("Cannot set file date"), newname
);
1941 /* Restore original attributes. */
1942 SetFileAttributes (filename
, attributes
);
1944 #else /* not WINDOWSNT */
1946 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
1950 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1952 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1954 /* We can only copy regular files and symbolic links. Other files are not
1956 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
1959 if (!NILP (preserve_selinux_context
) && is_selinux_enabled ())
1961 conlength
= fgetfilecon (ifd
, &con
);
1962 if (conlength
== -1)
1963 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
1967 if (out_st
.st_mode
!= 0
1968 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
1971 report_file_error ("Input and output files are the same",
1972 Fcons (file
, Fcons (newname
, Qnil
)));
1975 if (input_file_statable_p
)
1977 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
1979 #if defined (EISDIR)
1980 /* Get a better looking error message. */
1983 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
1988 /* System's default file type was set to binary by _fmode in emacs.c. */
1989 ofd
= emacs_open (SDATA (encoded_newname
),
1990 O_WRONLY
| O_TRUNC
| O_CREAT
1991 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
1992 S_IREAD
| S_IWRITE
);
1993 #else /* not MSDOS */
1995 int new_mask
= 0666;
1996 if (input_file_statable_p
)
1998 if (!NILP (preserve_uid_gid
))
2000 new_mask
&= st
.st_mode
;
2002 ofd
= emacs_open (SSDATA (encoded_newname
),
2003 (O_WRONLY
| O_TRUNC
| O_CREAT
2004 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2007 #endif /* not MSDOS */
2009 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2011 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2015 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2016 if (emacs_write (ofd
, buf
, n
) != n
)
2017 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2021 /* Preserve the original file modes, and if requested, also its
2023 if (input_file_statable_p
)
2025 int mode_mask
= 07777;
2026 if (!NILP (preserve_uid_gid
))
2028 /* Attempt to change owner and group. If that doesn't work
2029 attempt to change just the group, as that is sometimes allowed.
2030 Adjust the mode mask to eliminate setuid or setgid bits
2031 that are inappropriate if the owner and group are wrong. */
2032 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2034 mode_mask
&= ~06000;
2035 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2039 if (fchmod (ofd
, st
.st_mode
& mode_mask
) != 0)
2040 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
2042 #endif /* not MSDOS */
2047 /* Set the modified context back to the file. */
2048 fail
= fsetfilecon (ofd
, con
);
2049 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2050 if (fail
&& errno
!= ENOTSUP
)
2051 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2057 /* Closing the output clobbers the file times on some systems. */
2058 if (emacs_close (ofd
) < 0)
2059 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2061 if (input_file_statable_p
)
2063 if (!NILP (keep_time
))
2065 EMACS_TIME atime
, mtime
;
2066 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
2067 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
2068 if (set_file_times (SSDATA (encoded_newname
),
2070 xsignal2 (Qfile_date_error
,
2071 build_string ("Cannot set file date"), newname
);
2078 if (input_file_statable_p
)
2080 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2081 and if it can't, it tells so. Otherwise, under MSDOS we usually
2082 get only the READ bit, which will make the copied file read-only,
2083 so it's better not to chmod at all. */
2084 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2085 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2088 #endif /* not WINDOWSNT */
2090 /* Discard the unwind protects. */
2091 specpdl_ptr
= specpdl
+ count
;
2097 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2098 Smake_directory_internal
, 1, 1, 0,
2099 doc
: /* Create a new directory named DIRECTORY. */)
2100 (Lisp_Object directory
)
2103 Lisp_Object handler
;
2104 Lisp_Object encoded_dir
;
2106 CHECK_STRING (directory
);
2107 directory
= Fexpand_file_name (directory
, Qnil
);
2109 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2110 if (!NILP (handler
))
2111 return call2 (handler
, Qmake_directory_internal
, directory
);
2113 encoded_dir
= ENCODE_FILE (directory
);
2115 dir
= SSDATA (encoded_dir
);
2118 if (mkdir (dir
) != 0)
2120 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2122 report_file_error ("Creating directory", list1 (directory
));
2127 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2128 Sdelete_directory_internal
, 1, 1, 0,
2129 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2130 (Lisp_Object directory
)
2133 Lisp_Object encoded_dir
;
2135 CHECK_STRING (directory
);
2136 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2137 encoded_dir
= ENCODE_FILE (directory
);
2138 dir
= SSDATA (encoded_dir
);
2140 if (rmdir (dir
) != 0)
2141 report_file_error ("Removing directory", list1 (directory
));
2146 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2147 "(list (read-file-name \
2148 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2149 \"Move file to trash: \" \"Delete file: \") \
2150 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2151 (null current-prefix-arg))",
2152 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2153 If file has multiple names, it continues to exist with the other names.
2154 TRASH non-nil means to trash the file instead of deleting, provided
2155 `delete-by-moving-to-trash' is non-nil.
2157 When called interactively, TRASH is t if no prefix argument is given.
2158 With a prefix argument, TRASH is nil. */)
2159 (Lisp_Object filename
, Lisp_Object trash
)
2161 Lisp_Object handler
;
2162 Lisp_Object encoded_file
;
2163 struct gcpro gcpro1
;
2166 if (!NILP (Ffile_directory_p (filename
))
2167 && NILP (Ffile_symlink_p (filename
)))
2168 xsignal2 (Qfile_error
,
2169 build_string ("Removing old name: is a directory"),
2172 filename
= Fexpand_file_name (filename
, Qnil
);
2174 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2175 if (!NILP (handler
))
2176 return call3 (handler
, Qdelete_file
, filename
, trash
);
2178 if (delete_by_moving_to_trash
&& !NILP (trash
))
2179 return call1 (Qmove_file_to_trash
, filename
);
2181 encoded_file
= ENCODE_FILE (filename
);
2183 if (0 > unlink (SSDATA (encoded_file
)))
2184 report_file_error ("Removing old name", list1 (filename
));
2189 internal_delete_file_1 (Lisp_Object ignore
)
2194 /* Delete file FILENAME, returning 1 if successful and 0 if failed.
2195 This ignores `delete-by-moving-to-trash'. */
2198 internal_delete_file (Lisp_Object filename
)
2202 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2203 Qt
, internal_delete_file_1
);
2207 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2208 "fRename file: \nGRename %s to file: \np",
2209 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2210 If file has names other than FILE, it continues to have those names.
2211 Signals a `file-already-exists' error if a file NEWNAME already exists
2212 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2213 A number as third arg means request confirmation if NEWNAME already exists.
2214 This is what happens in interactive use with M-x. */)
2215 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2217 Lisp_Object handler
;
2218 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2219 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2221 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2222 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2223 CHECK_STRING (file
);
2224 CHECK_STRING (newname
);
2225 file
= Fexpand_file_name (file
, Qnil
);
2227 if ((!NILP (Ffile_directory_p (newname
)))
2229 /* If the file names are identical but for the case,
2230 don't attempt to move directory to itself. */
2231 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2235 Lisp_Object fname
= NILP (Ffile_directory_p (file
))
2236 ? file
: Fdirectory_file_name (file
);
2237 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2240 newname
= Fexpand_file_name (newname
, Qnil
);
2242 /* If the file name has special constructs in it,
2243 call the corresponding file handler. */
2244 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2246 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2247 if (!NILP (handler
))
2248 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2249 file
, newname
, ok_if_already_exists
));
2251 encoded_file
= ENCODE_FILE (file
);
2252 encoded_newname
= ENCODE_FILE (newname
);
2255 /* If the file names are identical but for the case, don't ask for
2256 confirmation: they simply want to change the letter-case of the
2258 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2260 if (NILP (ok_if_already_exists
)
2261 || INTEGERP (ok_if_already_exists
))
2262 barf_or_query_if_file_exists (newname
, "rename to it",
2263 INTEGERP (ok_if_already_exists
), 0, 0);
2264 if (0 > rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2269 symlink_target
= Ffile_symlink_p (file
);
2270 if (! NILP (symlink_target
))
2271 Fmake_symbolic_link (symlink_target
, newname
,
2272 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2273 else if (!NILP (Ffile_directory_p (file
)))
2274 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2276 /* We have already prompted if it was an integer, so don't
2277 have copy-file prompt again. */
2278 Fcopy_file (file
, newname
,
2279 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2282 count
= SPECPDL_INDEX ();
2283 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2285 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2286 call2 (Qdelete_directory
, file
, Qt
);
2288 Fdelete_file (file
, Qnil
);
2289 unbind_to (count
, Qnil
);
2292 report_file_error ("Renaming", list2 (file
, newname
));
2298 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2299 "fAdd name to file: \nGName to add to %s: \np",
2300 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2301 Signals a `file-already-exists' error if a file NEWNAME already exists
2302 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2303 A number as third arg means request confirmation if NEWNAME already exists.
2304 This is what happens in interactive use with M-x. */)
2305 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2307 Lisp_Object handler
;
2308 Lisp_Object encoded_file
, encoded_newname
;
2309 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2311 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2312 encoded_file
= encoded_newname
= Qnil
;
2313 CHECK_STRING (file
);
2314 CHECK_STRING (newname
);
2315 file
= Fexpand_file_name (file
, Qnil
);
2317 if (!NILP (Ffile_directory_p (newname
)))
2318 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2320 newname
= Fexpand_file_name (newname
, Qnil
);
2322 /* If the file name has special constructs in it,
2323 call the corresponding file handler. */
2324 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2325 if (!NILP (handler
))
2326 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2327 newname
, ok_if_already_exists
));
2329 /* If the new name has special constructs in it,
2330 call the corresponding file handler. */
2331 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2332 if (!NILP (handler
))
2333 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2334 newname
, ok_if_already_exists
));
2336 encoded_file
= ENCODE_FILE (file
);
2337 encoded_newname
= ENCODE_FILE (newname
);
2339 if (NILP (ok_if_already_exists
)
2340 || INTEGERP (ok_if_already_exists
))
2341 barf_or_query_if_file_exists (newname
, "make it a new name",
2342 INTEGERP (ok_if_already_exists
), 0, 0);
2344 unlink (SSDATA (newname
));
2345 if (0 > link (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2346 report_file_error ("Adding new name", list2 (file
, newname
));
2352 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2353 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2354 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2355 Both args must be strings.
2356 Signals a `file-already-exists' error if a file LINKNAME already exists
2357 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2358 A number as third arg means request confirmation if LINKNAME already exists.
2359 This happens for interactive use with M-x. */)
2360 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2362 Lisp_Object handler
;
2363 Lisp_Object encoded_filename
, encoded_linkname
;
2364 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2366 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2367 encoded_filename
= encoded_linkname
= Qnil
;
2368 CHECK_STRING (filename
);
2369 CHECK_STRING (linkname
);
2370 /* If the link target has a ~, we must expand it to get
2371 a truly valid file name. Otherwise, do not expand;
2372 we want to permit links to relative file names. */
2373 if (SREF (filename
, 0) == '~')
2374 filename
= Fexpand_file_name (filename
, Qnil
);
2376 if (!NILP (Ffile_directory_p (linkname
)))
2377 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2379 linkname
= Fexpand_file_name (linkname
, Qnil
);
2381 /* If the file name has special constructs in it,
2382 call the corresponding file handler. */
2383 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2384 if (!NILP (handler
))
2385 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2386 linkname
, ok_if_already_exists
));
2388 /* If the new link name has special constructs in it,
2389 call the corresponding file handler. */
2390 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2391 if (!NILP (handler
))
2392 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2393 linkname
, ok_if_already_exists
));
2395 encoded_filename
= ENCODE_FILE (filename
);
2396 encoded_linkname
= ENCODE_FILE (linkname
);
2398 if (NILP (ok_if_already_exists
)
2399 || INTEGERP (ok_if_already_exists
))
2400 barf_or_query_if_file_exists (linkname
, "make it a link",
2401 INTEGERP (ok_if_already_exists
), 0, 0);
2402 if (0 > symlink (SSDATA (encoded_filename
),
2403 SSDATA (encoded_linkname
)))
2405 /* If we didn't complain already, silently delete existing file. */
2406 if (errno
== EEXIST
)
2408 unlink (SSDATA (encoded_linkname
));
2409 if (0 <= symlink (SSDATA (encoded_filename
),
2410 SSDATA (encoded_linkname
)))
2416 if (errno
== ENOSYS
)
2419 xsignal1 (Qfile_error
,
2420 build_string ("Symbolic links are not supported"));
2423 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2430 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2432 doc
: /* Return t if file FILENAME specifies an absolute file name.
2433 On Unix, this is a name starting with a `/' or a `~'. */)
2434 (Lisp_Object filename
)
2436 CHECK_STRING (filename
);
2437 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2440 /* Return nonzero if file FILENAME exists and can be executed. */
2443 check_executable (char *filename
)
2447 if (stat (filename
, &st
) < 0)
2449 return ((st
.st_mode
& S_IEXEC
) != 0);
2450 #else /* not DOS_NT */
2451 #ifdef HAVE_EUIDACCESS
2452 return (euidaccess (filename
, 1) >= 0);
2454 /* Access isn't quite right because it uses the real uid
2455 and we really want to test with the effective uid.
2456 But Unix doesn't give us a right way to do it. */
2457 return (access (filename
, 1) >= 0);
2459 #endif /* not DOS_NT */
2462 /* Return nonzero if file FILENAME exists and can be written. */
2465 check_writable (const char *filename
)
2469 if (stat (filename
, &st
) < 0)
2471 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2472 #else /* not MSDOS */
2473 #ifdef HAVE_EUIDACCESS
2474 int res
= (euidaccess (filename
, 2) >= 0);
2476 /* euidaccess may have returned failure because Cygwin couldn't
2477 determine the file's UID or GID; if so, we return success. */
2481 if (stat (filename
, &st
) < 0)
2483 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2487 #else /* not HAVE_EUIDACCESS */
2488 /* Access isn't quite right because it uses the real uid
2489 and we really want to test with the effective uid.
2490 But Unix doesn't give us a right way to do it.
2491 Opening with O_WRONLY could work for an ordinary file,
2492 but would lose for directories. */
2493 return (access (filename
, 2) >= 0);
2494 #endif /* not HAVE_EUIDACCESS */
2495 #endif /* not MSDOS */
2498 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2499 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2500 See also `file-readable-p' and `file-attributes'.
2501 This returns nil for a symlink to a nonexistent file.
2502 Use `file-symlink-p' to test for such links. */)
2503 (Lisp_Object filename
)
2505 Lisp_Object absname
;
2506 Lisp_Object handler
;
2507 struct stat statbuf
;
2509 CHECK_STRING (filename
);
2510 absname
= Fexpand_file_name (filename
, Qnil
);
2512 /* If the file name has special constructs in it,
2513 call the corresponding file handler. */
2514 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2515 if (!NILP (handler
))
2516 return call2 (handler
, Qfile_exists_p
, absname
);
2518 absname
= ENCODE_FILE (absname
);
2520 return (stat (SSDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2523 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2524 doc
: /* Return t if FILENAME can be executed by you.
2525 For a directory, this means you can access files in that directory. */)
2526 (Lisp_Object filename
)
2528 Lisp_Object absname
;
2529 Lisp_Object handler
;
2531 CHECK_STRING (filename
);
2532 absname
= Fexpand_file_name (filename
, Qnil
);
2534 /* If the file name has special constructs in it,
2535 call the corresponding file handler. */
2536 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2537 if (!NILP (handler
))
2538 return call2 (handler
, Qfile_executable_p
, absname
);
2540 absname
= ENCODE_FILE (absname
);
2542 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2545 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2546 doc
: /* Return t if file FILENAME exists and you can read it.
2547 See also `file-exists-p' and `file-attributes'. */)
2548 (Lisp_Object filename
)
2550 Lisp_Object absname
;
2551 Lisp_Object handler
;
2554 struct stat statbuf
;
2556 CHECK_STRING (filename
);
2557 absname
= Fexpand_file_name (filename
, Qnil
);
2559 /* If the file name has special constructs in it,
2560 call the corresponding file handler. */
2561 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2562 if (!NILP (handler
))
2563 return call2 (handler
, Qfile_readable_p
, absname
);
2565 absname
= ENCODE_FILE (absname
);
2567 #if defined (DOS_NT) || defined (macintosh)
2568 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2570 if (access (SDATA (absname
), 0) == 0)
2573 #else /* not DOS_NT and not macintosh */
2576 /* Opening a fifo without O_NONBLOCK can wait.
2577 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2578 except in the case of a fifo, on a system which handles it. */
2579 desc
= stat (SSDATA (absname
), &statbuf
);
2582 if (S_ISFIFO (statbuf
.st_mode
))
2583 flags
|= O_NONBLOCK
;
2585 desc
= emacs_open (SSDATA (absname
), flags
, 0);
2590 #endif /* not DOS_NT and not macintosh */
2593 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2595 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2596 doc
: /* Return t if file FILENAME can be written or created by you. */)
2597 (Lisp_Object filename
)
2599 Lisp_Object absname
, dir
, encoded
;
2600 Lisp_Object handler
;
2601 struct stat statbuf
;
2603 CHECK_STRING (filename
);
2604 absname
= Fexpand_file_name (filename
, Qnil
);
2606 /* If the file name has special constructs in it,
2607 call the corresponding file handler. */
2608 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2609 if (!NILP (handler
))
2610 return call2 (handler
, Qfile_writable_p
, absname
);
2612 encoded
= ENCODE_FILE (absname
);
2613 if (stat (SSDATA (encoded
), &statbuf
) >= 0)
2614 return (check_writable (SSDATA (encoded
))
2617 dir
= Ffile_name_directory (absname
);
2620 dir
= Fdirectory_file_name (dir
);
2623 dir
= ENCODE_FILE (dir
);
2625 /* The read-only attribute of the parent directory doesn't affect
2626 whether a file or directory can be created within it. Some day we
2627 should check ACLs though, which do affect this. */
2628 if (stat (SDATA (dir
), &statbuf
) < 0)
2630 return S_ISDIR (statbuf
.st_mode
) ? Qt
: Qnil
;
2632 return (check_writable (!NILP (dir
) ? SSDATA (dir
) : "")
2637 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2638 doc
: /* Access file FILENAME, and get an error if that does not work.
2639 The second argument STRING is used in the error message.
2640 If there is no error, returns nil. */)
2641 (Lisp_Object filename
, Lisp_Object string
)
2643 Lisp_Object handler
, encoded_filename
, absname
;
2646 CHECK_STRING (filename
);
2647 absname
= Fexpand_file_name (filename
, Qnil
);
2649 CHECK_STRING (string
);
2651 /* If the file name has special constructs in it,
2652 call the corresponding file handler. */
2653 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2654 if (!NILP (handler
))
2655 return call3 (handler
, Qaccess_file
, absname
, string
);
2657 encoded_filename
= ENCODE_FILE (absname
);
2659 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2661 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2667 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2668 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2669 The value is the link target, as a string.
2670 Otherwise it returns nil.
2672 This function returns t when given the name of a symlink that
2673 points to a nonexistent file. */)
2674 (Lisp_Object filename
)
2676 Lisp_Object handler
;
2679 char readlink_buf
[READLINK_BUFSIZE
];
2681 CHECK_STRING (filename
);
2682 filename
= Fexpand_file_name (filename
, Qnil
);
2684 /* If the file name has special constructs in it,
2685 call the corresponding file handler. */
2686 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2687 if (!NILP (handler
))
2688 return call2 (handler
, Qfile_symlink_p
, filename
);
2690 filename
= ENCODE_FILE (filename
);
2692 buf
= emacs_readlink (SSDATA (filename
), readlink_buf
);
2696 val
= build_string (buf
);
2697 if (buf
[0] == '/' && strchr (buf
, ':'))
2698 val
= concat2 (build_string ("/:"), val
);
2699 if (buf
!= readlink_buf
)
2701 val
= DECODE_FILE (val
);
2705 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2706 doc
: /* Return t if FILENAME names an existing directory.
2707 Symbolic links to directories count as directories.
2708 See `file-symlink-p' to distinguish symlinks. */)
2709 (Lisp_Object filename
)
2711 register Lisp_Object absname
;
2713 Lisp_Object handler
;
2715 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2717 /* If the file name has special constructs in it,
2718 call the corresponding file handler. */
2719 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2720 if (!NILP (handler
))
2721 return call2 (handler
, Qfile_directory_p
, absname
);
2723 absname
= ENCODE_FILE (absname
);
2725 if (stat (SSDATA (absname
), &st
) < 0)
2727 return S_ISDIR (st
.st_mode
) ? Qt
: Qnil
;
2730 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2731 Sfile_accessible_directory_p
, 1, 1, 0,
2732 doc
: /* Return t if file FILENAME names a directory you can open.
2733 For the value to be t, FILENAME must specify the name of a directory as a file,
2734 and the directory must allow you to open files in it. In order to use a
2735 directory as a buffer's current directory, this predicate must return true.
2736 A directory name spec may be given instead; then the value is t
2737 if the directory so specified exists and really is a readable and
2738 searchable directory. */)
2739 (Lisp_Object filename
)
2741 Lisp_Object handler
;
2743 struct gcpro gcpro1
;
2745 /* If the file name has special constructs in it,
2746 call the corresponding file handler. */
2747 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2748 if (!NILP (handler
))
2749 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2752 tem
= (NILP (Ffile_directory_p (filename
))
2753 || NILP (Ffile_executable_p (filename
)));
2755 return tem
? Qnil
: Qt
;
2758 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2759 doc
: /* Return t if FILENAME names a regular file.
2760 This is the sort of file that holds an ordinary stream of data bytes.
2761 Symbolic links to regular files count as regular files.
2762 See `file-symlink-p' to distinguish symlinks. */)
2763 (Lisp_Object filename
)
2765 register Lisp_Object absname
;
2767 Lisp_Object handler
;
2769 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2771 /* If the file name has special constructs in it,
2772 call the corresponding file handler. */
2773 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2774 if (!NILP (handler
))
2775 return call2 (handler
, Qfile_regular_p
, absname
);
2777 absname
= ENCODE_FILE (absname
);
2782 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2784 /* Tell stat to use expensive method to get accurate info. */
2785 Vw32_get_true_file_attributes
= Qt
;
2786 result
= stat (SDATA (absname
), &st
);
2787 Vw32_get_true_file_attributes
= tem
;
2791 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2794 if (stat (SSDATA (absname
), &st
) < 0)
2796 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2800 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2801 Sfile_selinux_context
, 1, 1, 0,
2802 doc
: /* Return SELinux context of file named FILENAME.
2803 The return value is a list (USER ROLE TYPE RANGE), where the list
2804 elements are strings naming the user, role, type, and range of the
2805 file's SELinux security context.
2807 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2808 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2809 (Lisp_Object filename
)
2811 Lisp_Object absname
;
2812 Lisp_Object values
[4];
2813 Lisp_Object handler
;
2815 security_context_t con
;
2820 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2822 /* If the file name has special constructs in it,
2823 call the corresponding file handler. */
2824 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2825 if (!NILP (handler
))
2826 return call2 (handler
, Qfile_selinux_context
, absname
);
2828 absname
= ENCODE_FILE (absname
);
2835 if (is_selinux_enabled ())
2837 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2840 context
= context_new (con
);
2841 if (context_user_get (context
))
2842 values
[0] = build_string (context_user_get (context
));
2843 if (context_role_get (context
))
2844 values
[1] = build_string (context_role_get (context
));
2845 if (context_type_get (context
))
2846 values
[2] = build_string (context_type_get (context
));
2847 if (context_range_get (context
))
2848 values
[3] = build_string (context_range_get (context
));
2849 context_free (context
);
2856 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2859 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2860 Sset_file_selinux_context
, 2, 2, 0,
2861 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2862 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2863 elements are strings naming the components of a SELinux context.
2865 This function does nothing if SELinux is disabled, or if Emacs was not
2866 compiled with SELinux support. */)
2867 (Lisp_Object filename
, Lisp_Object context
)
2869 Lisp_Object absname
;
2870 Lisp_Object handler
;
2872 Lisp_Object encoded_absname
;
2873 Lisp_Object user
= CAR_SAFE (context
);
2874 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2875 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2876 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2877 security_context_t con
;
2878 int fail
, conlength
;
2879 context_t parsed_con
;
2882 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2884 /* If the file name has special constructs in it,
2885 call the corresponding file handler. */
2886 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2887 if (!NILP (handler
))
2888 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2891 if (is_selinux_enabled ())
2893 /* Get current file context. */
2894 encoded_absname
= ENCODE_FILE (absname
);
2895 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2898 parsed_con
= context_new (con
);
2899 /* Change the parts defined in the parameter.*/
2902 if (context_user_set (parsed_con
, SSDATA (user
)))
2903 error ("Doing context_user_set");
2907 if (context_role_set (parsed_con
, SSDATA (role
)))
2908 error ("Doing context_role_set");
2912 if (context_type_set (parsed_con
, SSDATA (type
)))
2913 error ("Doing context_type_set");
2915 if (STRINGP (range
))
2917 if (context_range_set (parsed_con
, SSDATA (range
)))
2918 error ("Doing context_range_set");
2921 /* Set the modified context back to the file. */
2922 fail
= lsetfilecon (SSDATA (encoded_absname
),
2923 context_str (parsed_con
));
2924 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2925 if (fail
&& errno
!= ENOTSUP
)
2926 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
2928 context_free (parsed_con
);
2931 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
2941 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2942 doc
: /* Return mode bits of file named FILENAME, as an integer.
2943 Return nil, if file does not exist or is not accessible. */)
2944 (Lisp_Object filename
)
2946 Lisp_Object absname
;
2948 Lisp_Object handler
;
2950 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2952 /* If the file name has special constructs in it,
2953 call the corresponding file handler. */
2954 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2955 if (!NILP (handler
))
2956 return call2 (handler
, Qfile_modes
, absname
);
2958 absname
= ENCODE_FILE (absname
);
2960 if (stat (SSDATA (absname
), &st
) < 0)
2963 return make_number (st
.st_mode
& 07777);
2966 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2967 "(let ((file (read-file-name \"File: \"))) \
2968 (list file (read-file-modes nil file)))",
2969 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2970 Only the 12 low bits of MODE are used.
2972 Interactively, mode bits are read by `read-file-modes', which accepts
2973 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2974 (Lisp_Object filename
, Lisp_Object mode
)
2976 Lisp_Object absname
, encoded_absname
;
2977 Lisp_Object handler
;
2979 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2980 CHECK_NUMBER (mode
);
2982 /* If the file name has special constructs in it,
2983 call the corresponding file handler. */
2984 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2985 if (!NILP (handler
))
2986 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2988 encoded_absname
= ENCODE_FILE (absname
);
2990 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
2991 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2996 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2997 doc
: /* Set the file permission bits for newly created files.
2998 The argument MODE should be an integer; only the low 9 bits are used.
2999 This setting is inherited by subprocesses. */)
3002 CHECK_NUMBER (mode
);
3004 umask ((~ XINT (mode
)) & 0777);
3009 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3010 doc
: /* Return the default file protection for created files.
3011 The value is an integer. */)
3018 realmask
= umask (0);
3022 XSETINT (value
, (~ realmask
) & 0777);
3027 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3028 doc
: /* Set times of file FILENAME to TIMESTAMP.
3029 Set both access and modification times.
3030 Return t on success, else nil.
3031 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3033 (Lisp_Object filename
, Lisp_Object timestamp
)
3035 Lisp_Object absname
, encoded_absname
;
3036 Lisp_Object handler
;
3040 if (! lisp_time_argument (timestamp
, &sec
, &usec
))
3041 error ("Invalid time specification");
3043 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3045 /* If the file name has special constructs in it,
3046 call the corresponding file handler. */
3047 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3048 if (!NILP (handler
))
3049 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3051 encoded_absname
= ENCODE_FILE (absname
);
3056 EMACS_SET_SECS (t
, sec
);
3057 EMACS_SET_USECS (t
, usec
);
3059 if (set_file_times (SSDATA (encoded_absname
), t
, t
))
3064 /* Setting times on a directory always fails. */
3065 if (stat (SSDATA (encoded_absname
), &st
) == 0 && S_ISDIR (st
.st_mode
))
3068 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3077 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3078 doc
: /* Tell Unix to finish all pending disk updates. */)
3085 #endif /* HAVE_SYNC */
3087 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3088 doc
: /* Return t if file FILE1 is newer than file FILE2.
3089 If FILE1 does not exist, the answer is nil;
3090 otherwise, if FILE2 does not exist, the answer is t. */)
3091 (Lisp_Object file1
, Lisp_Object file2
)
3093 Lisp_Object absname1
, absname2
;
3096 Lisp_Object handler
;
3097 struct gcpro gcpro1
, gcpro2
;
3099 CHECK_STRING (file1
);
3100 CHECK_STRING (file2
);
3103 GCPRO2 (absname1
, file2
);
3104 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3105 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3108 /* If the file name has special constructs in it,
3109 call the corresponding file handler. */
3110 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3112 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3113 if (!NILP (handler
))
3114 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3116 GCPRO2 (absname1
, absname2
);
3117 absname1
= ENCODE_FILE (absname1
);
3118 absname2
= ENCODE_FILE (absname2
);
3121 if (stat (SSDATA (absname1
), &st
) < 0)
3124 mtime1
= st
.st_mtime
;
3126 if (stat (SSDATA (absname2
), &st
) < 0)
3129 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3132 #ifndef READ_BUF_SIZE
3133 #define READ_BUF_SIZE (64 << 10)
3135 /* Some buffer offsets are stored in 'int' variables. */
3136 verify (READ_BUF_SIZE
<= INT_MAX
);
3138 /* This function is called after Lisp functions to decide a coding
3139 system are called, or when they cause an error. Before they are
3140 called, the current buffer is set unibyte and it contains only a
3141 newly inserted text (thus the buffer was empty before the
3144 The functions may set markers, overlays, text properties, or even
3145 alter the buffer contents, change the current buffer.
3147 Here, we reset all those changes by:
3148 o set back the current buffer.
3149 o move all markers and overlays to BEG.
3150 o remove all text properties.
3151 o set back the buffer multibyteness. */
3154 decide_coding_unwind (Lisp_Object unwind_data
)
3156 Lisp_Object multibyte
, undo_list
, buffer
;
3158 multibyte
= XCAR (unwind_data
);
3159 unwind_data
= XCDR (unwind_data
);
3160 undo_list
= XCAR (unwind_data
);
3161 buffer
= XCDR (unwind_data
);
3163 if (current_buffer
!= XBUFFER (buffer
))
3164 set_buffer_internal (XBUFFER (buffer
));
3165 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3166 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3167 BUF_INTERVALS (current_buffer
) = 0;
3168 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3170 /* Now we are safe to change the buffer's multibyteness directly. */
3171 BVAR (current_buffer
, enable_multibyte_characters
) = multibyte
;
3172 BVAR (current_buffer
, undo_list
) = undo_list
;
3178 /* Used to pass values from insert-file-contents to read_non_regular. */
3180 static int non_regular_fd
;
3181 static ptrdiff_t non_regular_inserted
;
3182 static int non_regular_nbytes
;
3185 /* Read from a non-regular file.
3186 Read non_regular_nbytes bytes max from non_regular_fd.
3187 Non_regular_inserted specifies where to put the read bytes.
3188 Value is the number of bytes read. */
3191 read_non_regular (Lisp_Object ignore
)
3197 nbytes
= emacs_read (non_regular_fd
,
3198 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3199 + non_regular_inserted
),
3200 non_regular_nbytes
);
3202 return make_number (nbytes
);
3206 /* Condition-case handler used when reading from non-regular files
3207 in insert-file-contents. */
3210 read_non_regular_quit (Lisp_Object ignore
)
3215 /* Reposition FD to OFFSET, based on WHENCE. This acts like lseek
3216 except that it also tests for OFFSET being out of lseek's range. */
3218 emacs_lseek (int fd
, EMACS_INT offset
, int whence
)
3220 /* Use "&" rather than "&&" to suppress a bogus GCC warning; see
3221 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43772>. */
3222 if (! ((TYPE_MINIMUM (off_t
) <= offset
) & (offset
<= TYPE_MAXIMUM (off_t
))))
3227 return lseek (fd
, offset
, whence
);
3231 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3233 doc
: /* Insert contents of file FILENAME after point.
3234 Returns list of absolute file name and number of characters inserted.
3235 If second argument VISIT is non-nil, the buffer's visited filename and
3236 last save file modtime are set, and it is marked unmodified. If
3237 visiting and the file does not exist, visiting is completed before the
3240 The optional third and fourth arguments BEG and END specify what portion
3241 of the file to insert. These arguments count bytes in the file, not
3242 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3244 If optional fifth argument REPLACE is non-nil, replace the current
3245 buffer contents (in the accessible portion) with the file contents.
3246 This is better than simply deleting and inserting the whole thing
3247 because (1) it preserves some marker positions and (2) it puts less data
3248 in the undo list. When REPLACE is non-nil, the second return value is
3249 the number of characters that replace previous buffer contents.
3251 This function does code conversion according to the value of
3252 `coding-system-for-read' or `file-coding-system-alist', and sets the
3253 variable `last-coding-system-used' to the coding system actually used. */)
3254 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3258 ptrdiff_t inserted
= 0;
3260 register ptrdiff_t how_much
;
3261 off_t beg_offset
, end_offset
;
3262 register int unprocessed
;
3263 ptrdiff_t count
= SPECPDL_INDEX ();
3264 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3265 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3267 ptrdiff_t total
= 0;
3268 int not_regular
= 0;
3270 char read_buf
[READ_BUF_SIZE
];
3271 struct coding_system coding
;
3272 char buffer
[1 << 14];
3273 int replace_handled
= 0;
3274 int set_coding_system
= 0;
3275 Lisp_Object coding_system
;
3277 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3278 int we_locked_file
= 0;
3279 int deferred_remove_unwind_protect
= 0;
3281 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3282 error ("Cannot do file visiting in an indirect buffer");
3284 if (!NILP (BVAR (current_buffer
, read_only
)))
3285 Fbarf_if_buffer_read_only ();
3289 orig_filename
= Qnil
;
3292 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3294 CHECK_STRING (filename
);
3295 filename
= Fexpand_file_name (filename
, Qnil
);
3297 /* The value Qnil means that the coding system is not yet
3299 coding_system
= Qnil
;
3301 /* If the file name has special constructs in it,
3302 call the corresponding file handler. */
3303 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3304 if (!NILP (handler
))
3306 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3307 visit
, beg
, end
, replace
);
3308 if (CONSP (val
) && CONSP (XCDR (val
))
3309 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3310 inserted
= XINT (XCAR (XCDR (val
)));
3314 orig_filename
= filename
;
3315 filename
= ENCODE_FILE (filename
);
3321 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3323 /* Tell stat to use expensive method to get accurate info. */
3324 Vw32_get_true_file_attributes
= Qt
;
3325 total
= stat (SSDATA (filename
), &st
);
3326 Vw32_get_true_file_attributes
= tem
;
3330 if (stat (SSDATA (filename
), &st
) < 0)
3331 #endif /* WINDOWSNT */
3336 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3340 if (!NILP (Vcoding_system_for_read
))
3341 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3345 /* This code will need to be changed in order to work on named
3346 pipes, and it's probably just not worth it. So we should at
3347 least signal an error. */
3348 if (!S_ISREG (st
.st_mode
))
3355 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3356 xsignal2 (Qfile_error
,
3357 build_string ("not a regular file"), orig_filename
);
3361 if ((fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0)) < 0)
3364 /* Replacement should preserve point as it preserves markers. */
3365 if (!NILP (replace
))
3366 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3368 record_unwind_protect (close_file_unwind
, make_number (fd
));
3373 if (!NILP (beg
) || !NILP (end
))
3374 error ("Attempt to visit less than an entire file");
3375 if (BEG
< Z
&& NILP (replace
))
3376 error ("Cannot do file visiting in a non-empty buffer");
3381 if (! (RANGED_INTEGERP (0, beg
, TYPE_MAXIMUM (off_t
))))
3382 wrong_type_argument (intern ("file-offset"), beg
);
3383 beg_offset
= XFASTINT (beg
);
3390 if (! (RANGED_INTEGERP (0, end
, TYPE_MAXIMUM (off_t
))))
3391 wrong_type_argument (intern ("file-offset"), end
);
3392 end_offset
= XFASTINT (end
);
3397 end_offset
= TYPE_MAXIMUM (off_t
);
3400 end_offset
= st
.st_size
;
3402 /* A negative size can happen on a platform that allows file
3403 sizes greater than the maximum off_t value. */
3407 /* The file size returned from stat may be zero, but data
3408 may be readable nonetheless, for example when this is a
3409 file in the /proc filesystem. */
3410 if (end_offset
== 0)
3411 end_offset
= READ_BUF_SIZE
;
3415 /* Check now whether the buffer will become too large,
3416 in the likely case where the file's length is not changing.
3417 This saves a lot of needless work before a buffer overflow. */
3420 /* The likely offset where we will stop reading. We could read
3421 more (or less), if the file grows (or shrinks) as we read it. */
3422 off_t likely_end
= min (end_offset
, st
.st_size
);
3424 if (beg_offset
< likely_end
)
3426 ptrdiff_t buf_bytes
=
3427 Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3428 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3429 off_t likely_growth
= likely_end
- beg_offset
;
3430 if (buf_growth_max
< likely_growth
)
3435 /* Prevent redisplay optimizations. */
3436 current_buffer
->clip_changed
= 1;
3438 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3440 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3441 setup_coding_system (coding_system
, &coding
);
3442 /* Ensure we set Vlast_coding_system_used. */
3443 set_coding_system
= 1;
3447 /* Decide the coding system to use for reading the file now
3448 because we can't use an optimized method for handling
3449 `coding:' tag if the current buffer is not empty. */
3450 if (!NILP (Vcoding_system_for_read
))
3451 coding_system
= Vcoding_system_for_read
;
3454 /* Don't try looking inside a file for a coding system
3455 specification if it is not seekable. */
3456 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3458 /* Find a coding system specified in the heading two
3459 lines or in the tailing several lines of the file.
3460 We assume that the 1K-byte and 3K-byte for heading
3461 and tailing respectively are sufficient for this
3465 if (st
.st_size
<= (1024 * 4))
3466 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3469 nread
= emacs_read (fd
, read_buf
, 1024);
3472 if (lseek (fd
, st
.st_size
- (1024 * 3), SEEK_SET
) < 0)
3473 report_file_error ("Setting file position",
3474 Fcons (orig_filename
, Qnil
));
3475 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3480 error ("IO error reading %s: %s",
3481 SDATA (orig_filename
), emacs_strerror (errno
));
3484 struct buffer
*prev
= current_buffer
;
3485 Lisp_Object workbuf
;
3488 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3490 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3491 buf
= XBUFFER (workbuf
);
3493 delete_all_overlays (buf
);
3494 BVAR (buf
, directory
) = BVAR (current_buffer
, directory
);
3495 BVAR (buf
, read_only
) = Qnil
;
3496 BVAR (buf
, filename
) = Qnil
;
3497 BVAR (buf
, undo_list
) = Qt
;
3498 eassert (buf
->overlays_before
== NULL
);
3499 eassert (buf
->overlays_after
== NULL
);
3501 set_buffer_internal (buf
);
3503 BVAR (buf
, enable_multibyte_characters
) = Qnil
;
3505 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3506 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3507 coding_system
= call2 (Vset_auto_coding_function
,
3508 filename
, make_number (nread
));
3509 set_buffer_internal (prev
);
3511 /* Discard the unwind protect for recovering the
3515 /* Rewind the file for the actual read done later. */
3516 if (lseek (fd
, 0, SEEK_SET
) < 0)
3517 report_file_error ("Setting file position",
3518 Fcons (orig_filename
, Qnil
));
3522 if (NILP (coding_system
))
3524 /* If we have not yet decided a coding system, check
3525 file-coding-system-alist. */
3526 Lisp_Object args
[6];
3528 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3529 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3530 coding_system
= Ffind_operation_coding_system (6, args
);
3531 if (CONSP (coding_system
))
3532 coding_system
= XCAR (coding_system
);
3536 if (NILP (coding_system
))
3537 coding_system
= Qundecided
;
3539 CHECK_CODING_SYSTEM (coding_system
);
3541 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3542 /* We must suppress all character code conversion except for
3543 end-of-line conversion. */
3544 coding_system
= raw_text_coding_system (coding_system
);
3546 setup_coding_system (coding_system
, &coding
);
3547 /* Ensure we set Vlast_coding_system_used. */
3548 set_coding_system
= 1;
3551 /* If requested, replace the accessible part of the buffer
3552 with the file contents. Avoid replacing text at the
3553 beginning or end of the buffer that matches the file contents;
3554 that preserves markers pointing to the unchanged parts.
3556 Here we implement this feature in an optimized way
3557 for the case where code conversion is NOT needed.
3558 The following if-statement handles the case of conversion
3559 in a less optimal way.
3561 If the code conversion is "automatic" then we try using this
3562 method and hope for the best.
3563 But if we discover the need for conversion, we give up on this method
3564 and let the following if-statement handle the replace job. */
3567 && (NILP (coding_system
)
3568 || ! CODING_REQUIRE_DECODING (&coding
)))
3570 /* same_at_start and same_at_end count bytes,
3571 because file access counts bytes
3572 and BEG and END count bytes. */
3573 ptrdiff_t same_at_start
= BEGV_BYTE
;
3574 ptrdiff_t same_at_end
= ZV_BYTE
;
3576 /* There is still a possibility we will find the need to do code
3577 conversion. If that happens, we set this variable to 1 to
3578 give up on handling REPLACE in the optimized way. */
3579 int giveup_match_end
= 0;
3581 if (beg_offset
!= 0)
3583 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3584 report_file_error ("Setting file position",
3585 Fcons (orig_filename
, Qnil
));
3590 /* Count how many chars at the start of the file
3591 match the text at the beginning of the buffer. */
3596 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3598 error ("IO error reading %s: %s",
3599 SSDATA (orig_filename
), emacs_strerror (errno
));
3600 else if (nread
== 0)
3603 if (CODING_REQUIRE_DETECTION (&coding
))
3605 coding_system
= detect_coding_system ((unsigned char *) buffer
,
3608 setup_coding_system (coding_system
, &coding
);
3611 if (CODING_REQUIRE_DECODING (&coding
))
3612 /* We found that the file should be decoded somehow.
3613 Let's give up here. */
3615 giveup_match_end
= 1;
3620 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3621 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3622 same_at_start
++, bufpos
++;
3623 /* If we found a discrepancy, stop the scan.
3624 Otherwise loop around and scan the next bufferful. */
3625 if (bufpos
!= nread
)
3629 /* If the file matches the buffer completely,
3630 there's no need to replace anything. */
3631 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3635 /* Truncate the buffer to the size of the file. */
3636 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3641 /* Count how many chars at the end of the file
3642 match the text at the end of the buffer. But, if we have
3643 already found that decoding is necessary, don't waste time. */
3644 while (!giveup_match_end
)
3646 int total_read
, nread
, bufpos
, trial
;
3649 /* At what file position are we now scanning? */
3650 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3651 /* If the entire file matches the buffer tail, stop the scan. */
3654 /* How much can we scan in the next step? */
3655 trial
= min (curpos
, sizeof buffer
);
3656 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3657 report_file_error ("Setting file position",
3658 Fcons (orig_filename
, Qnil
));
3660 total_read
= nread
= 0;
3661 while (total_read
< trial
)
3663 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3665 error ("IO error reading %s: %s",
3666 SDATA (orig_filename
), emacs_strerror (errno
));
3667 else if (nread
== 0)
3669 total_read
+= nread
;
3672 /* Scan this bufferful from the end, comparing with
3673 the Emacs buffer. */
3674 bufpos
= total_read
;
3676 /* Compare with same_at_start to avoid counting some buffer text
3677 as matching both at the file's beginning and at the end. */
3678 while (bufpos
> 0 && same_at_end
> same_at_start
3679 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3680 same_at_end
--, bufpos
--;
3682 /* If we found a discrepancy, stop the scan.
3683 Otherwise loop around and scan the preceding bufferful. */
3686 /* If this discrepancy is because of code conversion,
3687 we cannot use this method; giveup and try the other. */
3688 if (same_at_end
> same_at_start
3689 && FETCH_BYTE (same_at_end
- 1) >= 0200
3690 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3691 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3692 giveup_match_end
= 1;
3701 if (! giveup_match_end
)
3705 /* We win! We can handle REPLACE the optimized way. */
3707 /* Extend the start of non-matching text area to multibyte
3708 character boundary. */
3709 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3710 while (same_at_start
> BEGV_BYTE
3711 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3714 /* Extend the end of non-matching text area to multibyte
3715 character boundary. */
3716 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3717 while (same_at_end
< ZV_BYTE
3718 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3721 /* Don't try to reuse the same piece of text twice. */
3722 overlap
= (same_at_start
- BEGV_BYTE
3724 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3726 same_at_end
+= overlap
;
3728 /* Arrange to read only the nonmatching middle part of the file. */
3729 beg_offset
+= same_at_start
- BEGV_BYTE
;
3730 end_offset
-= ZV_BYTE
- same_at_end
;
3732 del_range_byte (same_at_start
, same_at_end
, 0);
3733 /* Insert from the file at the proper position. */
3734 temp
= BYTE_TO_CHAR (same_at_start
);
3735 SET_PT_BOTH (temp
, same_at_start
);
3737 /* If display currently starts at beginning of line,
3738 keep it that way. */
3739 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3740 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3742 replace_handled
= 1;
3746 /* If requested, replace the accessible part of the buffer
3747 with the file contents. Avoid replacing text at the
3748 beginning or end of the buffer that matches the file contents;
3749 that preserves markers pointing to the unchanged parts.
3751 Here we implement this feature for the case where code conversion
3752 is needed, in a simple way that needs a lot of memory.
3753 The preceding if-statement handles the case of no conversion
3754 in a more optimized way. */
3755 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3757 ptrdiff_t same_at_start
= BEGV_BYTE
;
3758 ptrdiff_t same_at_end
= ZV_BYTE
;
3759 ptrdiff_t same_at_start_charpos
;
3760 ptrdiff_t inserted_chars
;
3763 unsigned char *decoded
;
3766 ptrdiff_t this_count
= SPECPDL_INDEX ();
3767 int multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3768 Lisp_Object conversion_buffer
;
3769 struct gcpro gcpro1
;
3771 conversion_buffer
= code_conversion_save (1, multibyte
);
3773 /* First read the whole file, performing code conversion into
3774 CONVERSION_BUFFER. */
3776 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3777 report_file_error ("Setting file position",
3778 Fcons (orig_filename
, Qnil
));
3780 total
= st
.st_size
; /* Total bytes in the file. */
3781 how_much
= 0; /* Bytes read from file so far. */
3782 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3783 unprocessed
= 0; /* Bytes not processed in previous loop. */
3785 GCPRO1 (conversion_buffer
);
3786 while (how_much
< total
)
3788 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3789 quitting while reading a huge while. */
3790 /* `try'' is reserved in some compilers (Microsoft C). */
3791 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
3793 /* Allow quitting out of the actual I/O. */
3796 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3804 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3805 BUF_Z (XBUFFER (conversion_buffer
)));
3806 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3807 unprocessed
+ this, conversion_buffer
);
3808 unprocessed
= coding
.carryover_bytes
;
3809 if (coding
.carryover_bytes
> 0)
3810 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3815 /* We should remove the unwind_protect calling
3816 close_file_unwind, but other stuff has been added the stack,
3817 so defer the removal till we reach the `handled' label. */
3818 deferred_remove_unwind_protect
= 1;
3820 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3821 if we couldn't read the file. */
3824 error ("IO error reading %s: %s",
3825 SDATA (orig_filename
), emacs_strerror (errno
));
3827 if (unprocessed
> 0)
3829 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3830 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3831 unprocessed
, conversion_buffer
);
3832 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3835 coding_system
= CODING_ID_NAME (coding
.id
);
3836 set_coding_system
= 1;
3837 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3838 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3839 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3841 /* Compare the beginning of the converted string with the buffer
3845 while (bufpos
< inserted
&& same_at_start
< same_at_end
3846 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3847 same_at_start
++, bufpos
++;
3849 /* If the file matches the head of buffer completely,
3850 there's no need to replace anything. */
3852 if (bufpos
== inserted
)
3854 /* Truncate the buffer to the size of the file. */
3855 if (same_at_start
== same_at_end
)
3858 del_range_byte (same_at_start
, same_at_end
, 0);
3861 unbind_to (this_count
, Qnil
);
3865 /* Extend the start of non-matching text area to the previous
3866 multibyte character boundary. */
3867 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3868 while (same_at_start
> BEGV_BYTE
3869 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3872 /* Scan this bufferful from the end, comparing with
3873 the Emacs buffer. */
3876 /* Compare with same_at_start to avoid counting some buffer text
3877 as matching both at the file's beginning and at the end. */
3878 while (bufpos
> 0 && same_at_end
> same_at_start
3879 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3880 same_at_end
--, bufpos
--;
3882 /* Extend the end of non-matching text area to the next
3883 multibyte character boundary. */
3884 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3885 while (same_at_end
< ZV_BYTE
3886 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3889 /* Don't try to reuse the same piece of text twice. */
3890 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3892 same_at_end
+= overlap
;
3894 /* If display currently starts at beginning of line,
3895 keep it that way. */
3896 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3897 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3899 /* Replace the chars that we need to replace,
3900 and update INSERTED to equal the number of bytes
3901 we are taking from the decoded string. */
3902 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3904 if (same_at_end
!= same_at_start
)
3906 del_range_byte (same_at_start
, same_at_end
, 0);
3908 same_at_start
= GPT_BYTE
;
3912 temp
= BYTE_TO_CHAR (same_at_start
);
3914 /* Insert from the file at the proper position. */
3915 SET_PT_BOTH (temp
, same_at_start
);
3916 same_at_start_charpos
3917 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3918 same_at_start
- BEGV_BYTE
3919 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3921 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3922 same_at_start
+ inserted
- BEGV_BYTE
3923 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3924 - same_at_start_charpos
);
3925 /* This binding is to avoid ask-user-about-supersession-threat
3926 being called in insert_from_buffer (via in
3927 prepare_to_modify_buffer). */
3928 specbind (intern ("buffer-file-name"), Qnil
);
3929 insert_from_buffer (XBUFFER (conversion_buffer
),
3930 same_at_start_charpos
, inserted_chars
, 0);
3931 /* Set `inserted' to the number of inserted characters. */
3932 inserted
= PT
- temp
;
3933 /* Set point before the inserted characters. */
3934 SET_PT_BOTH (temp
, same_at_start
);
3936 unbind_to (this_count
, Qnil
);
3942 total
= end_offset
- beg_offset
;
3944 /* For a special file, all we can do is guess. */
3945 total
= READ_BUF_SIZE
;
3947 if (NILP (visit
) && total
> 0)
3949 #ifdef CLASH_DETECTION
3950 if (!NILP (BVAR (current_buffer
, file_truename
))
3951 /* Make binding buffer-file-name to nil effective. */
3952 && !NILP (BVAR (current_buffer
, filename
))
3953 && SAVE_MODIFF
>= MODIFF
)
3955 #endif /* CLASH_DETECTION */
3956 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3960 if (GAP_SIZE
< total
)
3961 make_gap (total
- GAP_SIZE
);
3963 if (beg_offset
!= 0 || !NILP (replace
))
3965 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3966 report_file_error ("Setting file position",
3967 Fcons (orig_filename
, Qnil
));
3970 /* In the following loop, HOW_MUCH contains the total bytes read so
3971 far for a regular file, and not changed for a special file. But,
3972 before exiting the loop, it is set to a negative value if I/O
3976 /* Total bytes inserted. */
3979 /* Here, we don't do code conversion in the loop. It is done by
3980 decode_coding_gap after all data are read into the buffer. */
3982 ptrdiff_t gap_size
= GAP_SIZE
;
3984 while (how_much
< total
)
3986 /* try is reserved in some compilers (Microsoft C) */
3987 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3994 /* Maybe make more room. */
3995 if (gap_size
< trytry
)
3997 make_gap (total
- gap_size
);
3998 gap_size
= GAP_SIZE
;
4001 /* Read from the file, capturing `quit'. When an
4002 error occurs, end the loop, and arrange for a quit
4003 to be signaled after decoding the text we read. */
4004 non_regular_fd
= fd
;
4005 non_regular_inserted
= inserted
;
4006 non_regular_nbytes
= trytry
;
4007 nbytes
= internal_condition_case_1 (read_non_regular
,
4009 read_non_regular_quit
);
4016 this = XINT (nbytes
);
4020 /* Allow quitting out of the actual I/O. We don't make text
4021 part of the buffer until all the reading is done, so a C-g
4022 here doesn't do any harm. */
4025 this = emacs_read (fd
,
4026 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4040 /* For a regular file, where TOTAL is the real size,
4041 count HOW_MUCH to compare with it.
4042 For a special file, where TOTAL is just a buffer size,
4043 so don't bother counting in HOW_MUCH.
4044 (INSERTED is where we count the number of characters inserted.) */
4051 /* Now we have read all the file data into the gap.
4052 If it was empty, undo marking the buffer modified. */
4056 #ifdef CLASH_DETECTION
4058 unlock_file (BVAR (current_buffer
, file_truename
));
4060 Vdeactivate_mark
= old_Vdeactivate_mark
;
4063 Vdeactivate_mark
= Qt
;
4065 /* Make the text read part of the buffer. */
4066 GAP_SIZE
-= inserted
;
4068 GPT_BYTE
+= inserted
;
4070 ZV_BYTE
+= inserted
;
4075 /* Put an anchor to ensure multi-byte form ends at gap. */
4080 /* Discard the unwind protect for closing the file. */
4084 error ("IO error reading %s: %s",
4085 SDATA (orig_filename
), emacs_strerror (errno
));
4089 if (NILP (coding_system
))
4091 /* The coding system is not yet decided. Decide it by an
4092 optimized method for handling `coding:' tag.
4094 Note that we can get here only if the buffer was empty
4095 before the insertion. */
4097 if (!NILP (Vcoding_system_for_read
))
4098 coding_system
= Vcoding_system_for_read
;
4101 /* Since we are sure that the current buffer was empty
4102 before the insertion, we can toggle
4103 enable-multibyte-characters directly here without taking
4104 care of marker adjustment. By this way, we can run Lisp
4105 program safely before decoding the inserted text. */
4106 Lisp_Object unwind_data
;
4107 ptrdiff_t count1
= SPECPDL_INDEX ();
4109 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4110 Fcons (BVAR (current_buffer
, undo_list
),
4111 Fcurrent_buffer ()));
4112 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
4113 BVAR (current_buffer
, undo_list
) = Qt
;
4114 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4116 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4118 coding_system
= call2 (Vset_auto_coding_function
,
4119 filename
, make_number (inserted
));
4122 if (NILP (coding_system
))
4124 /* If the coding system is not yet decided, check
4125 file-coding-system-alist. */
4126 Lisp_Object args
[6];
4128 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4129 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4130 coding_system
= Ffind_operation_coding_system (6, args
);
4131 if (CONSP (coding_system
))
4132 coding_system
= XCAR (coding_system
);
4134 unbind_to (count1
, Qnil
);
4135 inserted
= Z_BYTE
- BEG_BYTE
;
4138 if (NILP (coding_system
))
4139 coding_system
= Qundecided
;
4141 CHECK_CODING_SYSTEM (coding_system
);
4143 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4144 /* We must suppress all character code conversion except for
4145 end-of-line conversion. */
4146 coding_system
= raw_text_coding_system (coding_system
);
4147 setup_coding_system (coding_system
, &coding
);
4148 /* Ensure we set Vlast_coding_system_used. */
4149 set_coding_system
= 1;
4154 /* When we visit a file by raw-text, we change the buffer to
4156 if (CODING_FOR_UNIBYTE (&coding
)
4157 /* Can't do this if part of the buffer might be preserved. */
4159 /* Visiting a file with these coding system makes the buffer
4161 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
4164 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4165 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4166 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4168 move_gap_both (PT
, PT_BYTE
);
4169 GAP_SIZE
+= inserted
;
4170 ZV_BYTE
-= inserted
;
4174 decode_coding_gap (&coding
, inserted
, inserted
);
4175 inserted
= coding
.produced_char
;
4176 coding_system
= CODING_ID_NAME (coding
.id
);
4178 else if (inserted
> 0)
4179 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4182 /* Call after-change hooks for the inserted text, aside from the case
4183 of normal visiting (not with REPLACE), which is done in a new buffer
4184 "before" the buffer is changed. */
4185 if (inserted
> 0 && total
> 0
4186 && (NILP (visit
) || !NILP (replace
)))
4188 signal_after_change (PT
, 0, inserted
);
4189 update_compositions (PT
, PT
, CHECK_BORDER
);
4192 /* Now INSERTED is measured in characters. */
4196 if (deferred_remove_unwind_protect
)
4197 /* If requested above, discard the unwind protect for closing the
4203 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4204 BVAR (current_buffer
, undo_list
) = Qnil
;
4208 current_buffer
->modtime
= st
.st_mtime
;
4209 current_buffer
->modtime_size
= st
.st_size
;
4210 BVAR (current_buffer
, filename
) = orig_filename
;
4213 SAVE_MODIFF
= MODIFF
;
4214 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4215 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4216 #ifdef CLASH_DETECTION
4219 if (!NILP (BVAR (current_buffer
, file_truename
)))
4220 unlock_file (BVAR (current_buffer
, file_truename
));
4221 unlock_file (filename
);
4223 #endif /* CLASH_DETECTION */
4225 xsignal2 (Qfile_error
,
4226 build_string ("not a regular file"), orig_filename
);
4229 if (set_coding_system
)
4230 Vlast_coding_system_used
= coding_system
;
4232 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4234 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4236 if (! NILP (insval
))
4238 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4239 wrong_type_argument (intern ("inserted-chars"), insval
);
4240 inserted
= XFASTINT (insval
);
4244 /* Decode file format. */
4247 /* Don't run point motion or modification hooks when decoding. */
4248 ptrdiff_t count1
= SPECPDL_INDEX ();
4249 ptrdiff_t old_inserted
= inserted
;
4250 specbind (Qinhibit_point_motion_hooks
, Qt
);
4251 specbind (Qinhibit_modification_hooks
, Qt
);
4253 /* Save old undo list and don't record undo for decoding. */
4254 old_undo
= BVAR (current_buffer
, undo_list
);
4255 BVAR (current_buffer
, undo_list
) = Qt
;
4259 insval
= call3 (Qformat_decode
,
4260 Qnil
, make_number (inserted
), visit
);
4261 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4262 wrong_type_argument (intern ("inserted-chars"), insval
);
4263 inserted
= XFASTINT (insval
);
4267 /* If REPLACE is non-nil and we succeeded in not replacing the
4268 beginning or end of the buffer text with the file's contents,
4269 call format-decode with `point' positioned at the beginning
4270 of the buffer and `inserted' equaling the number of
4271 characters in the buffer. Otherwise, format-decode might
4272 fail to correctly analyze the beginning or end of the buffer.
4273 Hence we temporarily save `point' and `inserted' here and
4274 restore `point' iff format-decode did not insert or delete
4275 any text. Otherwise we leave `point' at point-min. */
4276 ptrdiff_t opoint
= PT
;
4277 ptrdiff_t opoint_byte
= PT_BYTE
;
4278 ptrdiff_t oinserted
= ZV
- BEGV
;
4279 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4281 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4282 insval
= call3 (Qformat_decode
,
4283 Qnil
, make_number (oinserted
), visit
);
4284 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4285 wrong_type_argument (intern ("inserted-chars"), insval
);
4286 if (ochars_modiff
== CHARS_MODIFF
)
4287 /* format_decode didn't modify buffer's characters => move
4288 point back to position before inserted text and leave
4289 value of inserted alone. */
4290 SET_PT_BOTH (opoint
, opoint_byte
);
4292 /* format_decode modified buffer's characters => consider
4293 entire buffer changed and leave point at point-min. */
4294 inserted
= XFASTINT (insval
);
4297 /* For consistency with format-decode call these now iff inserted > 0
4298 (martin 2007-06-28). */
4299 p
= Vafter_insert_file_functions
;
4304 insval
= call1 (XCAR (p
), make_number (inserted
));
4307 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4308 wrong_type_argument (intern ("inserted-chars"), insval
);
4309 inserted
= XFASTINT (insval
);
4314 /* For the rationale of this see the comment on
4315 format-decode above. */
4316 ptrdiff_t opoint
= PT
;
4317 ptrdiff_t opoint_byte
= PT_BYTE
;
4318 ptrdiff_t oinserted
= ZV
- BEGV
;
4319 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4321 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4322 insval
= call1 (XCAR (p
), make_number (oinserted
));
4325 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4326 wrong_type_argument (intern ("inserted-chars"), insval
);
4327 if (ochars_modiff
== CHARS_MODIFF
)
4328 /* after_insert_file_functions didn't modify
4329 buffer's characters => move point back to
4330 position before inserted text and leave value of
4332 SET_PT_BOTH (opoint
, opoint_byte
);
4334 /* after_insert_file_functions did modify buffer's
4335 characters => consider entire buffer changed and
4336 leave point at point-min. */
4337 inserted
= XFASTINT (insval
);
4347 BVAR (current_buffer
, undo_list
) = old_undo
;
4348 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4350 /* Adjust the last undo record for the size change during
4351 the format conversion. */
4352 Lisp_Object tem
= XCAR (old_undo
);
4353 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4354 && INTEGERP (XCDR (tem
))
4355 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4356 XSETCDR (tem
, make_number (PT
+ inserted
));
4360 /* If undo_list was Qt before, keep it that way.
4361 Otherwise start with an empty undo_list. */
4362 BVAR (current_buffer
, undo_list
) = EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4364 unbind_to (count1
, Qnil
);
4368 && current_buffer
->modtime
== -1)
4370 /* If visiting nonexistent file, return nil. */
4372 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4376 Fsignal (Qquit
, Qnil
);
4378 /* ??? Retval needs to be dealt with in all cases consistently. */
4380 val
= Fcons (orig_filename
,
4381 Fcons (make_number (inserted
),
4384 RETURN_UNGCPRO (unbind_to (count
, val
));
4387 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4390 build_annotations_unwind (Lisp_Object arg
)
4392 Vwrite_region_annotation_buffers
= arg
;
4396 /* Decide the coding-system to encode the data with. */
4399 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4400 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4401 struct coding_system
*coding
)
4404 Lisp_Object eol_parent
= Qnil
;
4407 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4408 BVAR (current_buffer
, auto_save_file_name
))))
4413 else if (!NILP (Vcoding_system_for_write
))
4415 val
= Vcoding_system_for_write
;
4416 if (coding_system_require_warning
4417 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4418 /* Confirm that VAL can surely encode the current region. */
4419 val
= call5 (Vselect_safe_coding_system_function
,
4420 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4425 /* If the variable `buffer-file-coding-system' is set locally,
4426 it means that the file was read with some kind of code
4427 conversion or the variable is explicitly set by users. We
4428 had better write it out with the same coding system even if
4429 `enable-multibyte-characters' is nil.
4431 If it is not set locally, we anyway have to convert EOL
4432 format if the default value of `buffer-file-coding-system'
4433 tells that it is not Unix-like (LF only) format. */
4434 int using_default_coding
= 0;
4435 int force_raw_text
= 0;
4437 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4439 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4442 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4448 /* Check file-coding-system-alist. */
4449 Lisp_Object args
[7], coding_systems
;
4451 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4452 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4454 coding_systems
= Ffind_operation_coding_system (7, args
);
4455 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4456 val
= XCDR (coding_systems
);
4461 /* If we still have not decided a coding system, use the
4462 default value of buffer-file-coding-system. */
4463 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4464 using_default_coding
= 1;
4467 if (! NILP (val
) && ! force_raw_text
)
4469 Lisp_Object spec
, attrs
;
4471 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4472 attrs
= AREF (spec
, 0);
4473 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4478 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4479 /* Confirm that VAL can surely encode the current region. */
4480 val
= call5 (Vselect_safe_coding_system_function
,
4481 start
, end
, val
, Qnil
, filename
);
4483 /* If the decided coding-system doesn't specify end-of-line
4484 format, we use that of
4485 `default-buffer-file-coding-system'. */
4486 if (! using_default_coding
4487 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4488 val
= (coding_inherit_eol_type
4489 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4491 /* If we decide not to encode text, use `raw-text' or one of its
4494 val
= raw_text_coding_system (val
);
4497 val
= coding_inherit_eol_type (val
, eol_parent
);
4498 setup_coding_system (val
, coding
);
4500 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4501 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4505 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4506 "r\nFWrite region to file: \ni\ni\ni\np",
4507 doc
: /* Write current region into specified file.
4508 When called from a program, requires three arguments:
4509 START, END and FILENAME. START and END are normally buffer positions
4510 specifying the part of the buffer to write.
4511 If START is nil, that means to use the entire buffer contents.
4512 If START is a string, then output that string to the file
4513 instead of any buffer contents; END is ignored.
4515 Optional fourth argument APPEND if non-nil means
4516 append to existing file contents (if any). If it is an integer,
4517 seek to that offset in the file before writing.
4518 Optional fifth argument VISIT, if t or a string, means
4519 set the last-save-file-modtime of buffer to this file's modtime
4520 and mark buffer not modified.
4521 If VISIT is a string, it is a second file name;
4522 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4523 VISIT is also the file name to lock and unlock for clash detection.
4524 If VISIT is neither t nor nil nor a string,
4525 that means do not display the \"Wrote file\" message.
4526 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4527 use for locking and unlocking, overriding FILENAME and VISIT.
4528 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4529 for an existing file with the same name. If MUSTBENEW is `excl',
4530 that means to get an error if the file already exists; never overwrite.
4531 If MUSTBENEW is neither nil nor `excl', that means ask for
4532 confirmation before overwriting, but do go ahead and overwrite the file
4533 if the user confirms.
4535 This does code conversion according to the value of
4536 `coding-system-for-write', `buffer-file-coding-system', or
4537 `file-coding-system-alist', and sets the variable
4538 `last-coding-system-used' to the coding system actually used.
4540 This calls `write-region-annotate-functions' at the start, and
4541 `write-region-post-annotation-function' at the end. */)
4542 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4549 ptrdiff_t count
= SPECPDL_INDEX ();
4551 Lisp_Object handler
;
4552 Lisp_Object visit_file
;
4553 Lisp_Object annotations
;
4554 Lisp_Object encoded_filename
;
4555 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4556 int quietly
= !NILP (visit
);
4557 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4558 struct buffer
*given_buffer
;
4559 struct coding_system coding
;
4561 if (current_buffer
->base_buffer
&& visiting
)
4562 error ("Cannot do file visiting in an indirect buffer");
4564 if (!NILP (start
) && !STRINGP (start
))
4565 validate_region (&start
, &end
);
4568 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4570 filename
= Fexpand_file_name (filename
, Qnil
);
4572 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4573 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4575 if (STRINGP (visit
))
4576 visit_file
= Fexpand_file_name (visit
, Qnil
);
4578 visit_file
= filename
;
4580 if (NILP (lockname
))
4581 lockname
= visit_file
;
4585 /* If the file name has special constructs in it,
4586 call the corresponding file handler. */
4587 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4588 /* If FILENAME has no handler, see if VISIT has one. */
4589 if (NILP (handler
) && STRINGP (visit
))
4590 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4592 if (!NILP (handler
))
4595 val
= call6 (handler
, Qwrite_region
, start
, end
,
4596 filename
, append
, visit
);
4600 SAVE_MODIFF
= MODIFF
;
4601 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4602 BVAR (current_buffer
, filename
) = visit_file
;
4608 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4610 /* Special kludge to simplify auto-saving. */
4613 /* Do it later, so write-region-annotate-function can work differently
4614 if we save "the buffer" vs "a region".
4615 This is useful in tar-mode. --Stef
4616 XSETFASTINT (start, BEG);
4617 XSETFASTINT (end, Z); */
4621 record_unwind_protect (build_annotations_unwind
,
4622 Vwrite_region_annotation_buffers
);
4623 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4624 count1
= SPECPDL_INDEX ();
4626 given_buffer
= current_buffer
;
4628 if (!STRINGP (start
))
4630 annotations
= build_annotations (start
, end
);
4632 if (current_buffer
!= given_buffer
)
4634 XSETFASTINT (start
, BEGV
);
4635 XSETFASTINT (end
, ZV
);
4641 XSETFASTINT (start
, BEGV
);
4642 XSETFASTINT (end
, ZV
);
4647 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4649 /* Decide the coding-system to encode the data with.
4650 We used to make this choice before calling build_annotations, but that
4651 leads to problems when a write-annotate-function takes care of
4652 unsavable chars (as was the case with X-Symbol). */
4653 Vlast_coding_system_used
4654 = choose_write_coding_system (start
, end
, filename
,
4655 append
, visit
, lockname
, &coding
);
4657 #ifdef CLASH_DETECTION
4659 lock_file (lockname
);
4660 #endif /* CLASH_DETECTION */
4662 encoded_filename
= ENCODE_FILE (filename
);
4664 fn
= SSDATA (encoded_filename
);
4668 desc
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4669 #else /* not DOS_NT */
4670 desc
= emacs_open (fn
, O_WRONLY
, 0);
4671 #endif /* not DOS_NT */
4673 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4675 desc
= emacs_open (fn
,
4676 O_WRONLY
| O_CREAT
| O_BINARY
4677 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4678 S_IREAD
| S_IWRITE
);
4679 #else /* not DOS_NT */
4680 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4681 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4682 auto_saving
? auto_save_mode_bits
: 0666);
4683 #endif /* not DOS_NT */
4687 #ifdef CLASH_DETECTION
4689 if (!auto_saving
) unlock_file (lockname
);
4691 #endif /* CLASH_DETECTION */
4693 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4696 record_unwind_protect (close_file_unwind
, make_number (desc
));
4698 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4702 if (NUMBERP (append
))
4703 ret
= emacs_lseek (desc
, XINT (append
), SEEK_CUR
);
4705 ret
= lseek (desc
, 0, SEEK_END
);
4708 #ifdef CLASH_DETECTION
4710 if (!auto_saving
) unlock_file (lockname
);
4712 #endif /* CLASH_DETECTION */
4714 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4723 if (STRINGP (start
))
4725 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4726 &annotations
, &coding
);
4729 else if (XINT (start
) != XINT (end
))
4731 failure
= 0 > a_write (desc
, Qnil
,
4732 XINT (start
), XINT (end
) - XINT (start
),
4733 &annotations
, &coding
);
4738 /* If file was empty, still need to write the annotations */
4739 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4740 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4744 if (CODING_REQUIRE_FLUSHING (&coding
)
4745 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4748 /* We have to flush out a data. */
4749 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4750 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4757 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4758 Disk full in NFS may be reported here. */
4759 /* mib says that closing the file will try to write as fast as NFS can do
4760 it, and that means the fsync here is not crucial for autosave files. */
4761 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4763 /* If fsync fails with EINTR, don't treat that as serious. Also
4764 ignore EINVAL which happens when fsync is not supported on this
4766 if (errno
!= EINTR
&& errno
!= EINVAL
)
4767 failure
= 1, save_errno
= errno
;
4771 /* NFS can report a write failure now. */
4772 if (emacs_close (desc
) < 0)
4773 failure
= 1, save_errno
= errno
;
4777 /* Discard the unwind protect for close_file_unwind. */
4778 specpdl_ptr
= specpdl
+ count1
;
4780 /* Call write-region-post-annotation-function. */
4781 while (CONSP (Vwrite_region_annotation_buffers
))
4783 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4784 if (!NILP (Fbuffer_live_p (buf
)))
4787 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4788 call0 (Vwrite_region_post_annotation_function
);
4790 Vwrite_region_annotation_buffers
4791 = XCDR (Vwrite_region_annotation_buffers
);
4794 unbind_to (count
, Qnil
);
4796 #ifdef CLASH_DETECTION
4798 unlock_file (lockname
);
4799 #endif /* CLASH_DETECTION */
4801 /* Do this before reporting IO error
4802 to avoid a "file has changed on disk" warning on
4803 next attempt to save. */
4806 current_buffer
->modtime
= st
.st_mtime
;
4807 current_buffer
->modtime_size
= st
.st_size
;
4811 error ("IO error writing %s: %s", SDATA (filename
),
4812 emacs_strerror (save_errno
));
4816 SAVE_MODIFF
= MODIFF
;
4817 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4818 BVAR (current_buffer
, filename
) = visit_file
;
4819 update_mode_lines
++;
4824 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4825 BVAR (current_buffer
, auto_save_file_name
))))
4826 SAVE_MODIFF
= MODIFF
;
4832 message_with_string ((INTEGERP (append
)
4842 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4844 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4845 doc
: /* Return t if (car A) is numerically less than (car B). */)
4846 (Lisp_Object a
, Lisp_Object b
)
4848 return Flss (Fcar (a
), Fcar (b
));
4851 /* Build the complete list of annotations appropriate for writing out
4852 the text between START and END, by calling all the functions in
4853 write-region-annotate-functions and merging the lists they return.
4854 If one of these functions switches to a different buffer, we assume
4855 that buffer contains altered text. Therefore, the caller must
4856 make sure to restore the current buffer in all cases,
4857 as save-excursion would do. */
4860 build_annotations (Lisp_Object start
, Lisp_Object end
)
4862 Lisp_Object annotations
;
4864 struct gcpro gcpro1
, gcpro2
;
4865 Lisp_Object original_buffer
;
4866 int i
, used_global
= 0;
4868 XSETBUFFER (original_buffer
, current_buffer
);
4871 p
= Vwrite_region_annotate_functions
;
4872 GCPRO2 (annotations
, p
);
4875 struct buffer
*given_buffer
= current_buffer
;
4876 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4877 { /* Use the global value of the hook. */
4880 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4882 p
= Fappend (2, arg
);
4885 Vwrite_region_annotations_so_far
= annotations
;
4886 res
= call2 (XCAR (p
), start
, end
);
4887 /* If the function makes a different buffer current,
4888 assume that means this buffer contains altered text to be output.
4889 Reset START and END from the buffer bounds
4890 and discard all previous annotations because they should have
4891 been dealt with by this function. */
4892 if (current_buffer
!= given_buffer
)
4894 Vwrite_region_annotation_buffers
4895 = Fcons (Fcurrent_buffer (),
4896 Vwrite_region_annotation_buffers
);
4897 XSETFASTINT (start
, BEGV
);
4898 XSETFASTINT (end
, ZV
);
4901 Flength (res
); /* Check basic validity of return value */
4902 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4906 /* Now do the same for annotation functions implied by the file-format */
4907 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
4908 p
= BVAR (current_buffer
, auto_save_file_format
);
4910 p
= BVAR (current_buffer
, file_format
);
4911 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4913 struct buffer
*given_buffer
= current_buffer
;
4915 Vwrite_region_annotations_so_far
= annotations
;
4917 /* Value is either a list of annotations or nil if the function
4918 has written annotations to a temporary buffer, which is now
4920 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4921 original_buffer
, make_number (i
));
4922 if (current_buffer
!= given_buffer
)
4924 XSETFASTINT (start
, BEGV
);
4925 XSETFASTINT (end
, ZV
);
4930 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4938 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4939 If STRING is nil, POS is the character position in the current buffer.
4940 Intersperse with them the annotations from *ANNOT
4941 which fall within the range of POS to POS + NCHARS,
4942 each at its appropriate position.
4944 We modify *ANNOT by discarding elements as we use them up.
4946 The return value is negative in case of system call failure. */
4949 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
4950 register ptrdiff_t nchars
, Lisp_Object
*annot
,
4951 struct coding_system
*coding
)
4955 ptrdiff_t lastpos
= pos
+ nchars
;
4957 while (NILP (*annot
) || CONSP (*annot
))
4959 tem
= Fcar_safe (Fcar (*annot
));
4962 nextpos
= XFASTINT (tem
);
4964 /* If there are no more annotations in this range,
4965 output the rest of the range all at once. */
4966 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4967 return e_write (desc
, string
, pos
, lastpos
, coding
);
4969 /* Output buffer text up to the next annotation's position. */
4972 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4976 /* Output the annotation. */
4977 tem
= Fcdr (Fcar (*annot
));
4980 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4983 *annot
= Fcdr (*annot
);
4989 /* Write text in the range START and END into descriptor DESC,
4990 encoding them with coding system CODING. If STRING is nil, START
4991 and END are character positions of the current buffer, else they
4992 are indexes to the string STRING. */
4995 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
4996 struct coding_system
*coding
)
4998 if (STRINGP (string
))
5001 end
= SCHARS (string
);
5004 /* We used to have a code for handling selective display here. But,
5005 now it is handled within encode_coding. */
5009 if (STRINGP (string
))
5011 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5012 if (CODING_REQUIRE_ENCODING (coding
))
5014 encode_coding_object (coding
, string
,
5015 start
, string_char_to_byte (string
, start
),
5016 end
, string_char_to_byte (string
, end
), Qt
);
5020 coding
->dst_object
= string
;
5021 coding
->consumed_char
= SCHARS (string
);
5022 coding
->produced
= SBYTES (string
);
5027 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5028 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5030 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5031 if (CODING_REQUIRE_ENCODING (coding
))
5033 encode_coding_object (coding
, Fcurrent_buffer (),
5034 start
, start_byte
, end
, end_byte
, Qt
);
5038 coding
->dst_object
= Qnil
;
5039 coding
->dst_pos_byte
= start_byte
;
5040 if (start
>= GPT
|| end
<= GPT
)
5042 coding
->consumed_char
= end
- start
;
5043 coding
->produced
= end_byte
- start_byte
;
5047 coding
->consumed_char
= GPT
- start
;
5048 coding
->produced
= GPT_BYTE
- start_byte
;
5053 if (coding
->produced
> 0)
5057 STRINGP (coding
->dst_object
)
5058 ? SSDATA (coding
->dst_object
)
5059 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
5062 if (coding
->produced
)
5065 start
+= coding
->consumed_char
;
5071 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5072 Sverify_visited_file_modtime
, 0, 1, 0,
5073 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5074 This means that the file has not been changed since it was visited or saved.
5075 If BUF is omitted or nil, it defaults to the current buffer.
5076 See Info node `(elisp)Modification Time' for more details. */)
5081 Lisp_Object handler
;
5082 Lisp_Object filename
;
5092 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5093 if (b
->modtime
== 0) return Qt
;
5095 /* If the file name has special constructs in it,
5096 call the corresponding file handler. */
5097 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5098 Qverify_visited_file_modtime
);
5099 if (!NILP (handler
))
5100 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5102 filename
= ENCODE_FILE (BVAR (b
, filename
));
5104 if (stat (SSDATA (filename
), &st
) < 0)
5106 /* If the file doesn't exist now and didn't exist before,
5107 we say that it isn't modified, provided the error is a tame one. */
5108 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
5113 if ((st
.st_mtime
== b
->modtime
5114 /* If both are positive, accept them if they are off by one second. */
5115 || (st
.st_mtime
> 0 && b
->modtime
> 0
5116 && (st
.st_mtime
- 1 == b
->modtime
5117 || st
.st_mtime
== b
->modtime
- 1)))
5118 && (st
.st_size
== b
->modtime_size
5119 || b
->modtime_size
< 0))
5124 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5125 Sclear_visited_file_modtime
, 0, 0, 0,
5126 doc
: /* Clear out records of last mod time of visited file.
5127 Next attempt to save will certainly not complain of a discrepancy. */)
5130 current_buffer
->modtime
= 0;
5131 current_buffer
->modtime_size
= -1;
5135 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5136 Svisited_file_modtime
, 0, 0, 0,
5137 doc
: /* Return the current buffer's recorded visited file modification time.
5138 The value is a list of the form (HIGH LOW), like the time values that
5139 `file-attributes' returns. If the current buffer has no recorded file
5140 modification time, this function returns 0. If the visited file
5141 doesn't exist, HIGH will be -1.
5142 See Info node `(elisp)Modification Time' for more details. */)
5145 if (! current_buffer
->modtime
)
5146 return make_number (0);
5147 return make_time (current_buffer
->modtime
);
5150 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5151 Sset_visited_file_modtime
, 0, 1, 0,
5152 doc
: /* Update buffer's recorded modification time from the visited file's time.
5153 Useful if the buffer was not read from the file normally
5154 or if the file itself has been changed for some known benign reason.
5155 An argument specifies the modification time value to use
5156 \(instead of that of the visited file), in the form of a list
5157 \(HIGH . LOW) or (HIGH LOW). */)
5158 (Lisp_Object time_list
)
5160 if (!NILP (time_list
))
5162 CONS_TO_INTEGER (time_list
, time_t, current_buffer
->modtime
);
5163 current_buffer
->modtime_size
= -1;
5167 register Lisp_Object filename
;
5169 Lisp_Object handler
;
5171 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5173 /* If the file name has special constructs in it,
5174 call the corresponding file handler. */
5175 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5176 if (!NILP (handler
))
5177 /* The handler can find the file name the same way we did. */
5178 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5180 filename
= ENCODE_FILE (filename
);
5182 if (stat (SSDATA (filename
), &st
) >= 0)
5184 current_buffer
->modtime
= st
.st_mtime
;
5185 current_buffer
->modtime_size
= st
.st_size
;
5193 auto_save_error (Lisp_Object error_val
)
5195 Lisp_Object args
[3], msg
;
5197 struct gcpro gcpro1
;
5201 auto_save_error_occurred
= 1;
5203 ring_bell (XFRAME (selected_frame
));
5205 args
[0] = build_string ("Auto-saving %s: %s");
5206 args
[1] = BVAR (current_buffer
, name
);
5207 args
[2] = Ferror_message_string (error_val
);
5208 msg
= Fformat (3, args
);
5210 nbytes
= SBYTES (msg
);
5211 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5212 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5214 for (i
= 0; i
< 3; ++i
)
5217 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5219 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5220 Fsleep_for (make_number (1), Qnil
);
5234 auto_save_mode_bits
= 0666;
5236 /* Get visited file's mode to become the auto save file's mode. */
5237 if (! NILP (BVAR (current_buffer
, filename
)))
5239 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5240 /* But make sure we can overwrite it later! */
5241 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5242 else if ((modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5244 /* Remote files don't cooperate with stat. */
5245 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5249 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5250 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5255 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5258 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5270 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5273 minibuffer_auto_raise
= XINT (value
);
5278 do_auto_save_make_dir (Lisp_Object dir
)
5282 auto_saving_dir_umask
= 077;
5283 result
= call2 (Qmake_directory
, dir
, Qt
);
5284 auto_saving_dir_umask
= 0;
5289 do_auto_save_eh (Lisp_Object ignore
)
5291 auto_saving_dir_umask
= 0;
5295 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5296 doc
: /* Auto-save all buffers that need it.
5297 This is all buffers that have auto-saving enabled
5298 and are changed since last auto-saved.
5299 Auto-saving writes the buffer into a file
5300 so that your editing is not lost if the system crashes.
5301 This file is not the file you visited; that changes only when you save.
5302 Normally we run the normal hook `auto-save-hook' before saving.
5304 A non-nil NO-MESSAGE argument means do not print any message if successful.
5305 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5306 (Lisp_Object no_message
, Lisp_Object current_only
)
5308 struct buffer
*old
= current_buffer
, *b
;
5309 Lisp_Object tail
, buf
, hook
;
5311 int do_handled_files
;
5313 FILE *stream
= NULL
;
5314 ptrdiff_t count
= SPECPDL_INDEX ();
5315 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5316 int old_message_p
= 0;
5317 struct gcpro gcpro1
, gcpro2
;
5319 if (max_specpdl_size
< specpdl_size
+ 40)
5320 max_specpdl_size
= specpdl_size
+ 40;
5325 if (NILP (no_message
))
5327 old_message_p
= push_message ();
5328 record_unwind_protect (pop_message_unwind
, Qnil
);
5331 /* Ordinarily don't quit within this function,
5332 but don't make it impossible to quit (in case we get hung in I/O). */
5336 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5337 point to non-strings reached from Vbuffer_alist. */
5339 hook
= intern ("auto-save-hook");
5340 Frun_hooks (1, &hook
);
5342 if (STRINGP (Vauto_save_list_file_name
))
5344 Lisp_Object listfile
;
5346 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5348 /* Don't try to create the directory when shutting down Emacs,
5349 because creating the directory might signal an error, and
5350 that would leave Emacs in a strange state. */
5351 if (!NILP (Vrun_hooks
))
5355 GCPRO2 (dir
, listfile
);
5356 dir
= Ffile_name_directory (listfile
);
5357 if (NILP (Ffile_directory_p (dir
)))
5358 internal_condition_case_1 (do_auto_save_make_dir
,
5364 stream
= fopen (SSDATA (listfile
), "w");
5367 record_unwind_protect (do_auto_save_unwind
,
5368 make_save_value (stream
, 0));
5369 record_unwind_protect (do_auto_save_unwind_1
,
5370 make_number (minibuffer_auto_raise
));
5371 minibuffer_auto_raise
= 0;
5373 auto_save_error_occurred
= 0;
5375 /* On first pass, save all files that don't have handlers.
5376 On second pass, save all files that do have handlers.
5378 If Emacs is crashing, the handlers may tweak what is causing
5379 Emacs to crash in the first place, and it would be a shame if
5380 Emacs failed to autosave perfectly ordinary files because it
5381 couldn't handle some ange-ftp'd file. */
5383 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5384 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5386 buf
= XCDR (XCAR (tail
));
5389 /* Record all the buffers that have auto save mode
5390 in the special file that lists them. For each of these buffers,
5391 Record visited name (if any) and auto save name. */
5392 if (STRINGP (BVAR (b
, auto_save_file_name
))
5393 && stream
!= NULL
&& do_handled_files
== 0)
5396 if (!NILP (BVAR (b
, filename
)))
5398 fwrite (SDATA (BVAR (b
, filename
)), 1,
5399 SBYTES (BVAR (b
, filename
)), stream
);
5401 putc ('\n', stream
);
5402 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5403 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5404 putc ('\n', stream
);
5408 if (!NILP (current_only
)
5409 && b
!= current_buffer
)
5412 /* Don't auto-save indirect buffers.
5413 The base buffer takes care of it. */
5417 /* Check for auto save enabled
5418 and file changed since last auto save
5419 and file changed since last real save. */
5420 if (STRINGP (BVAR (b
, auto_save_file_name
))
5421 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5422 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5423 /* -1 means we've turned off autosaving for a while--see below. */
5424 && XINT (BVAR (b
, save_length
)) >= 0
5425 && (do_handled_files
5426 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5429 EMACS_TIME before_time
, after_time
;
5431 EMACS_GET_TIME (before_time
);
5433 /* If we had a failure, don't try again for 20 minutes. */
5434 if (b
->auto_save_failure_time
> 0
5435 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5438 set_buffer_internal (b
);
5439 if (NILP (Vauto_save_include_big_deletions
)
5440 && (XFASTINT (BVAR (b
, save_length
)) * 10
5441 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5442 /* A short file is likely to change a large fraction;
5443 spare the user annoying messages. */
5444 && XFASTINT (BVAR (b
, save_length
)) > 5000
5445 /* These messages are frequent and annoying for `*mail*'. */
5446 && !EQ (BVAR (b
, filename
), Qnil
)
5447 && NILP (no_message
))
5449 /* It has shrunk too much; turn off auto-saving here. */
5450 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5451 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5453 minibuffer_auto_raise
= 0;
5454 /* Turn off auto-saving until there's a real save,
5455 and prevent any more warnings. */
5456 XSETINT (BVAR (b
, save_length
), -1);
5457 Fsleep_for (make_number (1), Qnil
);
5460 if (!auto_saved
&& NILP (no_message
))
5461 message1 ("Auto-saving...");
5462 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5464 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5465 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5466 set_buffer_internal (old
);
5468 EMACS_GET_TIME (after_time
);
5470 /* If auto-save took more than 60 seconds,
5471 assume it was an NFS failure that got a timeout. */
5472 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5473 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5477 /* Prevent another auto save till enough input events come in. */
5478 record_auto_save ();
5480 if (auto_saved
&& NILP (no_message
))
5484 /* If we are going to restore an old message,
5485 give time to read ours. */
5486 sit_for (make_number (1), 0, 0);
5489 else if (!auto_save_error_occurred
)
5490 /* Don't overwrite the error message if an error occurred.
5491 If we displayed a message and then restored a state
5492 with no message, leave a "done" message on the screen. */
5493 message1 ("Auto-saving...done");
5498 /* This restores the message-stack status. */
5499 unbind_to (count
, Qnil
);
5503 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5504 Sset_buffer_auto_saved
, 0, 0, 0,
5505 doc
: /* Mark current buffer as auto-saved with its current text.
5506 No auto-save file will be written until the buffer changes again. */)
5509 /* FIXME: This should not be called in indirect buffers, since
5510 they're not autosaved. */
5511 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5512 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5513 current_buffer
->auto_save_failure_time
= 0;
5517 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5518 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5519 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5522 current_buffer
->auto_save_failure_time
= 0;
5526 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5528 doc
: /* Return t if current buffer has been auto-saved recently.
5529 More precisely, if it has been auto-saved since last read from or saved
5530 in the visited file. If the buffer has no visited file,
5531 then any auto-save counts as "recent". */)
5534 /* FIXME: maybe we should return nil for indirect buffers since
5535 they're never autosaved. */
5536 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5539 /* Reading and completing file names */
5541 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5542 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5543 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5544 The return value is only relevant for a call to `read-file-name' that happens
5545 before any other event (mouse or keypress) is handled. */)
5548 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5549 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5559 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5561 struct gcpro gcpro1
;
5562 Lisp_Object args
[7];
5564 GCPRO1 (default_filename
);
5565 args
[0] = intern ("read-file-name");
5568 args
[3] = default_filename
;
5569 args
[4] = mustmatch
;
5571 args
[6] = predicate
;
5572 RETURN_UNGCPRO (Ffuncall (7, args
));
5577 syms_of_fileio (void)
5579 DEFSYM (Qoperations
, "operations");
5580 DEFSYM (Qexpand_file_name
, "expand-file-name");
5581 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5582 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5583 DEFSYM (Qfile_name_directory
, "file-name-directory");
5584 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5585 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5586 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5587 DEFSYM (Qcopy_file
, "copy-file");
5588 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5589 DEFSYM (Qmake_directory
, "make-directory");
5590 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5591 DEFSYM (Qdelete_file
, "delete-file");
5592 DEFSYM (Qrename_file
, "rename-file");
5593 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5594 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5595 DEFSYM (Qfile_exists_p
, "file-exists-p");
5596 DEFSYM (Qfile_executable_p
, "file-executable-p");
5597 DEFSYM (Qfile_readable_p
, "file-readable-p");
5598 DEFSYM (Qfile_writable_p
, "file-writable-p");
5599 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5600 DEFSYM (Qaccess_file
, "access-file");
5601 DEFSYM (Qfile_directory_p
, "file-directory-p");
5602 DEFSYM (Qfile_regular_p
, "file-regular-p");
5603 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5604 DEFSYM (Qfile_modes
, "file-modes");
5605 DEFSYM (Qset_file_modes
, "set-file-modes");
5606 DEFSYM (Qset_file_times
, "set-file-times");
5607 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5608 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5609 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5610 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5611 DEFSYM (Qwrite_region
, "write-region");
5612 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5613 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5614 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5616 DEFSYM (Qfile_name_history
, "file-name-history");
5617 Fset (Qfile_name_history
, Qnil
);
5619 DEFSYM (Qfile_error
, "file-error");
5620 DEFSYM (Qfile_already_exists
, "file-already-exists");
5621 DEFSYM (Qfile_date_error
, "file-date-error");
5622 DEFSYM (Qexcl
, "excl");
5624 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5625 doc
: /* Coding system for encoding file names.
5626 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5627 Vfile_name_coding_system
= Qnil
;
5629 DEFVAR_LISP ("default-file-name-coding-system",
5630 Vdefault_file_name_coding_system
,
5631 doc
: /* Default coding system for encoding file names.
5632 This variable is used only when `file-name-coding-system' is nil.
5634 This variable is set/changed by the command `set-language-environment'.
5635 User should not set this variable manually,
5636 instead use `file-name-coding-system' to get a constant encoding
5637 of file names regardless of the current language environment. */);
5638 Vdefault_file_name_coding_system
= Qnil
;
5640 DEFSYM (Qformat_decode
, "format-decode");
5641 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5642 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5643 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5645 Fput (Qfile_error
, Qerror_conditions
,
5646 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5647 Fput (Qfile_error
, Qerror_message
,
5648 make_pure_c_string ("File error"));
5650 Fput (Qfile_already_exists
, Qerror_conditions
,
5651 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5652 Fput (Qfile_already_exists
, Qerror_message
,
5653 make_pure_c_string ("File already exists"));
5655 Fput (Qfile_date_error
, Qerror_conditions
,
5656 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5657 Fput (Qfile_date_error
, Qerror_message
,
5658 make_pure_c_string ("Cannot set file date"));
5660 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5661 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5662 If a file name matches REGEXP, all I/O on that file is done by calling
5663 HANDLER. If a file name matches more than one handler, the handler
5664 whose match starts last in the file name gets precedence. The
5665 function `find-file-name-handler' checks this list for a handler for
5668 HANDLER should be a function. The first argument given to it is the
5669 name of the I/O primitive to be handled; the remaining arguments are
5670 the arguments that were passed to that primitive. For example, if you
5671 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5672 HANDLER is called like this:
5674 (funcall HANDLER 'file-exists-p FILENAME)
5676 Note that HANDLER must be able to handle all I/O primitives; if it has
5677 nothing special to do for a primitive, it should reinvoke the
5678 primitive to handle the operation \"the usual way\".
5679 See Info node `(elisp)Magic File Names' for more details. */);
5680 Vfile_name_handler_alist
= Qnil
;
5682 DEFVAR_LISP ("set-auto-coding-function",
5683 Vset_auto_coding_function
,
5684 doc
: /* If non-nil, a function to call to decide a coding system of file.
5685 Two arguments are passed to this function: the file name
5686 and the length of a file contents following the point.
5687 This function should return a coding system to decode the file contents.
5688 It should check the file name against `auto-coding-alist'.
5689 If no coding system is decided, it should check a coding system
5690 specified in the heading lines with the format:
5691 -*- ... coding: CODING-SYSTEM; ... -*-
5692 or local variable spec of the tailing lines with `coding:' tag. */);
5693 Vset_auto_coding_function
= Qnil
;
5695 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5696 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5697 Each is passed one argument, the number of characters inserted,
5698 with point at the start of the inserted text. Each function
5699 should leave point the same, and return the new character count.
5700 If `insert-file-contents' is intercepted by a handler from
5701 `file-name-handler-alist', that handler is responsible for calling the
5702 functions in `after-insert-file-functions' if appropriate. */);
5703 Vafter_insert_file_functions
= Qnil
;
5705 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5706 doc
: /* A list of functions to be called at the start of `write-region'.
5707 Each is passed two arguments, START and END as for `write-region'.
5708 These are usually two numbers but not always; see the documentation
5709 for `write-region'. The function should return a list of pairs
5710 of the form (POSITION . STRING), consisting of strings to be effectively
5711 inserted at the specified positions of the file being written (1 means to
5712 insert before the first byte written). The POSITIONs must be sorted into
5715 If there are several annotation functions, the lists returned by these
5716 functions are merged destructively. As each annotation function runs,
5717 the variable `write-region-annotations-so-far' contains a list of all
5718 annotations returned by previous annotation functions.
5720 An annotation function can return with a different buffer current.
5721 Doing so removes the annotations returned by previous functions, and
5722 resets START and END to `point-min' and `point-max' of the new buffer.
5724 After `write-region' completes, Emacs calls the function stored in
5725 `write-region-post-annotation-function', once for each buffer that was
5726 current when building the annotations (i.e., at least once), with that
5727 buffer current. */);
5728 Vwrite_region_annotate_functions
= Qnil
;
5729 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5731 DEFVAR_LISP ("write-region-post-annotation-function",
5732 Vwrite_region_post_annotation_function
,
5733 doc
: /* Function to call after `write-region' completes.
5734 The function is called with no arguments. If one or more of the
5735 annotation functions in `write-region-annotate-functions' changed the
5736 current buffer, the function stored in this variable is called for
5737 each of those additional buffers as well, in addition to the original
5738 buffer. The relevant buffer is current during each function call. */);
5739 Vwrite_region_post_annotation_function
= Qnil
;
5740 staticpro (&Vwrite_region_annotation_buffers
);
5742 DEFVAR_LISP ("write-region-annotations-so-far",
5743 Vwrite_region_annotations_so_far
,
5744 doc
: /* When an annotation function is called, this holds the previous annotations.
5745 These are the annotations made by other annotation functions
5746 that were already called. See also `write-region-annotate-functions'. */);
5747 Vwrite_region_annotations_so_far
= Qnil
;
5749 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5750 doc
: /* A list of file name handlers that temporarily should not be used.
5751 This applies only to the operation `inhibit-file-name-operation'. */);
5752 Vinhibit_file_name_handlers
= Qnil
;
5754 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5755 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5756 Vinhibit_file_name_operation
= Qnil
;
5758 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
5759 doc
: /* File name in which we write a list of all auto save file names.
5760 This variable is initialized automatically from `auto-save-list-file-prefix'
5761 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5762 a non-nil value. */);
5763 Vauto_save_list_file_name
= Qnil
;
5765 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
5766 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5767 Normally auto-save files are written under other names. */);
5768 Vauto_save_visited_file_name
= Qnil
;
5770 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
5771 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5772 If nil, deleting a substantial portion of the text disables auto-save
5773 in the buffer; this is the default behavior, because the auto-save
5774 file is usually more useful if it contains the deleted text. */);
5775 Vauto_save_include_big_deletions
= Qnil
;
5778 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
5779 doc
: /* Non-nil means don't call fsync in `write-region'.
5780 This variable affects calls to `write-region' as well as save commands.
5781 A non-nil value may result in data loss! */);
5782 write_region_inhibit_fsync
= 0;
5785 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
5786 doc
: /* Specifies whether to use the system's trash can.
5787 When non-nil, certain file deletion commands use the function
5788 `move-file-to-trash' instead of deleting files outright.
5789 This includes interactive calls to `delete-file' and
5790 `delete-directory' and the Dired deletion commands. */);
5791 delete_by_moving_to_trash
= 0;
5792 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5794 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
5795 DEFSYM (Qcopy_directory
, "copy-directory");
5796 DEFSYM (Qdelete_directory
, "delete-directory");
5798 defsubr (&Sfind_file_name_handler
);
5799 defsubr (&Sfile_name_directory
);
5800 defsubr (&Sfile_name_nondirectory
);
5801 defsubr (&Sunhandled_file_name_directory
);
5802 defsubr (&Sfile_name_as_directory
);
5803 defsubr (&Sdirectory_file_name
);
5804 defsubr (&Smake_temp_name
);
5805 defsubr (&Sexpand_file_name
);
5806 defsubr (&Ssubstitute_in_file_name
);
5807 defsubr (&Scopy_file
);
5808 defsubr (&Smake_directory_internal
);
5809 defsubr (&Sdelete_directory_internal
);
5810 defsubr (&Sdelete_file
);
5811 defsubr (&Srename_file
);
5812 defsubr (&Sadd_name_to_file
);
5813 defsubr (&Smake_symbolic_link
);
5814 defsubr (&Sfile_name_absolute_p
);
5815 defsubr (&Sfile_exists_p
);
5816 defsubr (&Sfile_executable_p
);
5817 defsubr (&Sfile_readable_p
);
5818 defsubr (&Sfile_writable_p
);
5819 defsubr (&Saccess_file
);
5820 defsubr (&Sfile_symlink_p
);
5821 defsubr (&Sfile_directory_p
);
5822 defsubr (&Sfile_accessible_directory_p
);
5823 defsubr (&Sfile_regular_p
);
5824 defsubr (&Sfile_modes
);
5825 defsubr (&Sset_file_modes
);
5826 defsubr (&Sset_file_times
);
5827 defsubr (&Sfile_selinux_context
);
5828 defsubr (&Sset_file_selinux_context
);
5829 defsubr (&Sset_default_file_modes
);
5830 defsubr (&Sdefault_file_modes
);
5831 defsubr (&Sfile_newer_than_file_p
);
5832 defsubr (&Sinsert_file_contents
);
5833 defsubr (&Swrite_region
);
5834 defsubr (&Scar_less_than_car
);
5835 defsubr (&Sverify_visited_file_modtime
);
5836 defsubr (&Sclear_visited_file_modtime
);
5837 defsubr (&Svisited_file_modtime
);
5838 defsubr (&Sset_visited_file_modtime
);
5839 defsubr (&Sdo_auto_save
);
5840 defsubr (&Sset_buffer_auto_saved
);
5841 defsubr (&Sclear_buffer_auto_save_failure
);
5842 defsubr (&Srecent_auto_save_p
);
5844 defsubr (&Snext_read_file_uses_dialog_p
);
5847 defsubr (&Sunix_sync
);