1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2011 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"
44 #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 inequal, 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 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
94 a new file with the same mode as the original */
95 static int auto_save_mode_bits
;
97 /* Set by auto_save_1 if an error occurred during the last auto-save. */
98 static int auto_save_error_occurred
;
100 /* The symbol bound to coding-system-for-read when
101 insert-file-contents is called for recovering a file. This is not
102 an actual coding system name, but just an indicator to tell
103 insert-file-contents to use `emacs-mule' with a special flag for
104 auto saving and recovering a file. */
105 static Lisp_Object Qauto_save_coding
;
107 /* Property name of a file name handler,
108 which gives a list of operations it handles.. */
109 static Lisp_Object Qoperations
;
111 /* Lisp functions for translating file formats */
112 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
114 /* Lisp function for setting buffer-file-coding-system and the
115 multibyteness of the current buffer after inserting a file. */
116 static Lisp_Object Qafter_insert_file_set_coding
;
118 static Lisp_Object Qwrite_region_annotate_functions
;
119 /* Each time an annotation function changes the buffer, the new buffer
121 static Lisp_Object Vwrite_region_annotation_buffers
;
126 static Lisp_Object Qdelete_by_moving_to_trash
;
128 /* Lisp function for moving files to trash. */
129 static Lisp_Object Qmove_file_to_trash
;
131 /* Lisp function for recursively copying directories. */
132 static Lisp_Object Qcopy_directory
;
134 /* Lisp function for recursively deleting directories. */
135 static Lisp_Object Qdelete_directory
;
140 Lisp_Object Qfile_error
;
141 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
142 static Lisp_Object Qexcl
;
143 Lisp_Object Qfile_name_history
;
145 static Lisp_Object Qcar_less_than_car
;
147 static Lisp_Object
Fmake_symbolic_link (Lisp_Object
, Lisp_Object
, Lisp_Object
);
148 static int a_write (int, Lisp_Object
, EMACS_INT
, EMACS_INT
,
149 Lisp_Object
*, struct coding_system
*);
150 static int e_write (int, Lisp_Object
, EMACS_INT
, EMACS_INT
,
151 struct coding_system
*);
155 report_file_error (const char *string
, Lisp_Object data
)
157 Lisp_Object errstring
;
161 synchronize_system_messages_locale ();
162 str
= strerror (errorno
);
163 errstring
= code_convert_string_norecord (make_unibyte_string (str
,
165 Vlocale_coding_system
, 0);
171 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
174 /* System error messages are capitalized. Downcase the initial
175 unless it is followed by a slash. (The slash case caters to
176 error messages that begin with "I/O" or, in German, "E/A".) */
177 if (STRING_MULTIBYTE (errstring
)
178 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
182 str
= SSDATA (errstring
);
183 c
= STRING_CHAR ((unsigned char *) str
);
184 Faset (errstring
, make_number (0), make_number (downcase (c
)));
187 xsignal (Qfile_error
,
188 Fcons (build_string (string
), Fcons (errstring
, data
)));
193 close_file_unwind (Lisp_Object fd
)
195 emacs_close (XFASTINT (fd
));
199 /* Restore point, having saved it as a marker. */
202 restore_point_unwind (Lisp_Object location
)
204 Fgoto_char (location
);
205 Fset_marker (location
, Qnil
, Qnil
);
210 static Lisp_Object Qexpand_file_name
;
211 static Lisp_Object Qsubstitute_in_file_name
;
212 static Lisp_Object Qdirectory_file_name
;
213 static Lisp_Object Qfile_name_directory
;
214 static Lisp_Object Qfile_name_nondirectory
;
215 static Lisp_Object Qunhandled_file_name_directory
;
216 static Lisp_Object Qfile_name_as_directory
;
217 static Lisp_Object Qcopy_file
;
218 static Lisp_Object Qmake_directory_internal
;
219 static Lisp_Object Qmake_directory
;
220 static Lisp_Object Qdelete_directory_internal
;
221 Lisp_Object Qdelete_file
;
222 static Lisp_Object Qrename_file
;
223 static Lisp_Object Qadd_name_to_file
;
224 static Lisp_Object Qmake_symbolic_link
;
225 Lisp_Object Qfile_exists_p
;
226 static Lisp_Object Qfile_executable_p
;
227 static Lisp_Object Qfile_readable_p
;
228 static Lisp_Object Qfile_writable_p
;
229 static Lisp_Object Qfile_symlink_p
;
230 static Lisp_Object Qaccess_file
;
231 Lisp_Object Qfile_directory_p
;
232 static Lisp_Object Qfile_regular_p
;
233 static Lisp_Object Qfile_accessible_directory_p
;
234 static Lisp_Object Qfile_modes
;
235 static Lisp_Object Qset_file_modes
;
236 static Lisp_Object Qset_file_times
;
237 static Lisp_Object Qfile_selinux_context
;
238 static Lisp_Object Qset_file_selinux_context
;
239 static Lisp_Object Qfile_newer_than_file_p
;
240 Lisp_Object Qinsert_file_contents
;
241 Lisp_Object Qwrite_region
;
242 static Lisp_Object Qverify_visited_file_modtime
;
243 static Lisp_Object Qset_visited_file_modtime
;
245 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
246 Sfind_file_name_handler
, 2, 2, 0,
247 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
248 Otherwise, return nil.
249 A file name is handled if one of the regular expressions in
250 `file-name-handler-alist' matches it.
252 If OPERATION equals `inhibit-file-name-operation', then we ignore
253 any handlers that are members of `inhibit-file-name-handlers',
254 but we still do run any other handlers. This lets handlers
255 use the standard functions without calling themselves recursively. */)
256 (Lisp_Object filename
, Lisp_Object operation
)
258 /* This function must not munge the match data. */
259 Lisp_Object chain
, inhibited_handlers
, result
;
263 CHECK_STRING (filename
);
265 if (EQ (operation
, Vinhibit_file_name_operation
))
266 inhibited_handlers
= Vinhibit_file_name_handlers
;
268 inhibited_handlers
= Qnil
;
270 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
271 chain
= XCDR (chain
))
277 Lisp_Object string
= XCAR (elt
);
279 Lisp_Object handler
= XCDR (elt
);
280 Lisp_Object operations
= Qnil
;
282 if (SYMBOLP (handler
))
283 operations
= Fget (handler
, Qoperations
);
286 && (match_pos
= fast_string_match (string
, filename
)) > pos
287 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
291 handler
= XCDR (elt
);
292 tem
= Fmemq (handler
, inhibited_handlers
);
306 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
308 doc
: /* Return the directory component in file name FILENAME.
309 Return nil if FILENAME does not include a directory.
310 Otherwise return a directory name.
311 Given a Unix syntax file name, returns a string ending in slash. */)
312 (Lisp_Object filename
)
315 register const char *beg
;
319 register const char *p
;
322 CHECK_STRING (filename
);
324 /* If the file name has special constructs in it,
325 call the corresponding file handler. */
326 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
328 return call2 (handler
, Qfile_name_directory
, filename
);
330 filename
= FILE_SYSTEM_CASE (filename
);
332 beg
= (char *) alloca (SBYTES (filename
) + 1);
333 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
335 beg
= SSDATA (filename
);
337 p
= beg
+ SBYTES (filename
);
339 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
341 /* only recognise drive specifier at the beginning */
343 /* handle the "/:d:foo" and "/:foo" cases correctly */
344 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
345 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
352 /* Expansion of "c:" to drive and default directory. */
355 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
356 char *res
= alloca (MAXPATHLEN
+ 1);
359 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
361 strncpy (res
, beg
, 2);
366 if (getdefdir (toupper ((unsigned char) *beg
) - 'A' + 1, r
))
368 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
371 p
= beg
+ strlen (beg
);
374 dostounix_filename (beg
);
377 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
380 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
381 Sfile_name_nondirectory
, 1, 1, 0,
382 doc
: /* Return file name FILENAME sans its directory.
383 For example, in a Unix-syntax file name,
384 this is everything after the last slash,
385 or the entire name if it contains no slash. */)
386 (Lisp_Object filename
)
388 register const char *beg
, *p
, *end
;
391 CHECK_STRING (filename
);
393 /* If the file name has special constructs in it,
394 call the corresponding file handler. */
395 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
397 return call2 (handler
, Qfile_name_nondirectory
, filename
);
399 beg
= SSDATA (filename
);
400 end
= p
= beg
+ SBYTES (filename
);
402 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
404 /* only recognise drive specifier at beginning */
406 /* handle the "/:d:foo" case correctly */
407 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
412 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
415 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
416 Sunhandled_file_name_directory
, 1, 1, 0,
417 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
418 A `directly usable' directory name is one that may be used without the
419 intervention of any file handler.
420 If FILENAME is a directly usable file itself, return
421 \(file-name-directory FILENAME).
422 If FILENAME refers to a file which is not accessible from a local process,
423 then this should return nil.
424 The `call-process' and `start-process' functions use this function to
425 get a current directory to run processes in. */)
426 (Lisp_Object filename
)
430 /* If the file name has special constructs in it,
431 call the corresponding file handler. */
432 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
434 return call2 (handler
, Qunhandled_file_name_directory
, filename
);
436 return Ffile_name_directory (filename
);
441 file_name_as_directory (char *out
, const char *in
)
443 ptrdiff_t len
= strlen (in
);
455 /* For Unix syntax, Append a slash if necessary */
456 if (!IS_DIRECTORY_SEP (out
[len
- 1]))
458 out
[len
] = DIRECTORY_SEP
;
462 dostounix_filename (out
);
467 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
468 Sfile_name_as_directory
, 1, 1, 0,
469 doc
: /* Return a string representing the file name FILE interpreted as a directory.
470 This operation exists because a directory is also a file, but its name as
471 a directory is different from its name as a file.
472 The result can be used as the value of `default-directory'
473 or passed as second argument to `expand-file-name'.
474 For a Unix-syntax file name, just appends a slash. */)
484 /* If the file name has special constructs in it,
485 call the corresponding file handler. */
486 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
488 return call2 (handler
, Qfile_name_as_directory
, file
);
490 buf
= (char *) alloca (SBYTES (file
) + 10);
491 file_name_as_directory (buf
, SSDATA (file
));
492 return make_specified_string (buf
, -1, strlen (buf
),
493 STRING_MULTIBYTE (file
));
497 * Convert from directory name to filename.
498 * On UNIX, it's simple: just make sure there isn't a terminating /
500 * Value is nonzero if the string output is different from the input.
504 directory_file_name (char *src
, char *dst
)
510 /* Process as Unix format: just remove any final slash.
511 But leave "/" unchanged; do not change it to "". */
514 && IS_DIRECTORY_SEP (dst
[slen
- 1])
516 && !IS_ANY_SEP (dst
[slen
- 2])
521 dostounix_filename (dst
);
526 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
528 doc
: /* Returns the file name of the directory named DIRECTORY.
529 This is the name of the file that holds the data for the directory DIRECTORY.
530 This operation exists because a directory is also a file, but its name as
531 a directory is different from its name as a file.
532 In Unix-syntax, this function just removes the final slash. */)
533 (Lisp_Object directory
)
538 CHECK_STRING (directory
);
540 if (NILP (directory
))
543 /* If the file name has special constructs in it,
544 call the corresponding file handler. */
545 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
547 return call2 (handler
, Qdirectory_file_name
, directory
);
549 buf
= (char *) alloca (SBYTES (directory
) + 20);
550 directory_file_name (SSDATA (directory
), buf
);
551 return make_specified_string (buf
, -1, strlen (buf
),
552 STRING_MULTIBYTE (directory
));
555 static const char make_temp_name_tbl
[64] =
557 'A','B','C','D','E','F','G','H',
558 'I','J','K','L','M','N','O','P',
559 'Q','R','S','T','U','V','W','X',
560 'Y','Z','a','b','c','d','e','f',
561 'g','h','i','j','k','l','m','n',
562 'o','p','q','r','s','t','u','v',
563 'w','x','y','z','0','1','2','3',
564 '4','5','6','7','8','9','-','_'
567 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
569 /* Value is a temporary file name starting with PREFIX, a string.
571 The Emacs process number forms part of the result, so there is
572 no danger of generating a name being used by another process.
573 In addition, this function makes an attempt to choose a name
574 which has no existing file. To make this work, PREFIX should be
575 an absolute file name.
577 BASE64_P non-zero means add the pid as 3 characters in base64
578 encoding. In this case, 6 characters will be added to PREFIX to
579 form the file name. Otherwise, if Emacs is running on a system
580 with long file names, add the pid as a decimal number.
582 This function signals an error if no unique file name could be
586 make_temp_name (Lisp_Object prefix
, int base64_p
)
592 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
595 CHECK_STRING (prefix
);
597 /* VAL is created by adding 6 characters to PREFIX. The first
598 three are the PID of this process, in base 64, and the second
599 three are incremented if the file already exists. This ensures
600 262144 unique file names per PID per PREFIX. */
606 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
607 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
608 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
613 #ifdef HAVE_LONG_FILE_NAMES
614 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
616 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
617 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
618 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
623 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
624 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
625 if (!STRING_MULTIBYTE (prefix
))
626 STRING_SET_UNIBYTE (val
);
628 memcpy (data
, SSDATA (prefix
), len
);
631 memcpy (p
, pidbuf
, pidlen
);
634 /* Here we try to minimize useless stat'ing when this function is
635 invoked many times successively with the same PREFIX. We achieve
636 this by initializing count to a random value, and incrementing it
639 We don't want make-temp-name to be called while dumping,
640 because then make_temp_name_count_initialized_p would get set
641 and then make_temp_name_count would not be set when Emacs starts. */
643 if (!make_temp_name_count_initialized_p
)
645 make_temp_name_count
= time (NULL
);
646 make_temp_name_count_initialized_p
= 1;
652 unsigned num
= make_temp_name_count
;
654 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
655 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
656 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
658 /* Poor man's congruential RN generator. Replace with
659 ++make_temp_name_count for debugging. */
660 make_temp_name_count
+= 25229;
661 make_temp_name_count
%= 225307;
663 if (stat (data
, &ignored
) < 0)
665 /* We want to return only if errno is ENOENT. */
669 /* The error here is dubious, but there is little else we
670 can do. The alternatives are to return nil, which is
671 as bad as (and in many cases worse than) throwing the
672 error, or to ignore the error, which will likely result
673 in looping through 225307 stat's, which is not only
674 dog-slow, but also useless since eventually nil would
675 have to be returned anyway. */
676 report_file_error ("Cannot create temporary name for prefix",
677 Fcons (prefix
, Qnil
));
684 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
685 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
686 The Emacs process number forms part of the result,
687 so there is no danger of generating a name being used by another process.
689 In addition, this function makes an attempt to choose a name
690 which has no existing file. To make this work,
691 PREFIX should be an absolute file name.
693 There is a race condition between calling `make-temp-name' and creating the
694 file which opens all kinds of security holes. For that reason, you should
695 probably use `make-temp-file' instead, except in three circumstances:
697 * If you are creating the file in the user's home directory.
698 * If you are creating a directory rather than an ordinary file.
699 * If you are taking special precautions as `make-temp-file' does. */)
702 return make_temp_name (prefix
, 0);
707 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
708 doc
: /* Convert filename NAME to absolute, and canonicalize it.
709 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
710 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
711 the current buffer's value of `default-directory' is used.
712 NAME should be a string that is a valid file name for the underlying
714 File name components that are `.' are removed, and
715 so are file name components followed by `..', along with the `..' itself;
716 note that these simplifications are done without checking the resulting
717 file names in the file system.
718 Multiple consecutive slashes are collapsed into a single slash,
719 except at the beginning of the file name when they are significant (e.g.,
720 UNC file names on MS-Windows.)
721 An initial `~/' expands to your home directory.
722 An initial `~USER/' expands to USER's home directory.
723 See also the function `substitute-in-file-name'.
725 For technical reasons, this function can return correct but
726 non-intuitive results for the root directory; for instance,
727 \(expand-file-name ".." "/") returns "/..". For this reason, use
728 \(directory-file-name (file-name-directory dirname)) to traverse a
729 filesystem tree, not (expand-file-name ".." dirname). */)
730 (Lisp_Object name
, Lisp_Object default_directory
)
732 /* These point to SDATA and need to be careful with string-relocation
733 during GC (via DECODE_FILE). */
736 /* This should only point to alloca'd data. */
743 int collapse_newdir
= 1;
747 Lisp_Object handler
, result
;
753 /* If the file name has special constructs in it,
754 call the corresponding file handler. */
755 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
757 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
759 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
760 if (NILP (default_directory
))
761 default_directory
= BVAR (current_buffer
, directory
);
762 if (! STRINGP (default_directory
))
765 /* "/" is not considered a root directory on DOS_NT, so using "/"
766 here causes an infinite recursion in, e.g., the following:
768 (let (default-directory)
769 (expand-file-name "a"))
771 To avoid this, we set default_directory to the root of the
773 default_directory
= build_string (emacs_root_dir ());
775 default_directory
= build_string ("/");
779 if (!NILP (default_directory
))
781 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
783 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
787 char *o
= SSDATA (default_directory
);
789 /* Make sure DEFAULT_DIRECTORY is properly expanded.
790 It would be better to do this down below where we actually use
791 default_directory. Unfortunately, calling Fexpand_file_name recursively
792 could invoke GC, and the strings might be relocated. This would
793 be annoying because we have pointers into strings lying around
794 that would need adjusting, and people would add new pointers to
795 the code and forget to adjust them, resulting in intermittent bugs.
796 Putting this call here avoids all that crud.
798 The EQ test avoids infinite recursion. */
799 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
800 /* Save time in some common cases - as long as default_directory
801 is not relative, it can be canonicalized with name below (if it
802 is needed at all) without requiring it to be expanded now. */
804 /* Detect MSDOS file names with drive specifiers. */
805 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
806 && IS_DIRECTORY_SEP (o
[2]))
808 /* Detect Windows file names in UNC format. */
809 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
811 #else /* not DOS_NT */
812 /* Detect Unix absolute file names (/... alone is not absolute on
814 && ! (IS_DIRECTORY_SEP (o
[0]))
815 #endif /* not DOS_NT */
821 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
825 name
= FILE_SYSTEM_CASE (name
);
826 multibyte
= STRING_MULTIBYTE (name
);
827 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
830 default_directory
= string_to_multibyte (default_directory
);
833 name
= string_to_multibyte (name
);
838 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
839 nm
= (char *) alloca (SBYTES (name
) + 1);
840 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
843 /* Note if special escape prefix is present, but remove for now. */
844 if (nm
[0] == '/' && nm
[1] == ':')
850 /* Find and remove drive specifier if present; this makes nm absolute
851 even if the rest of the name appears to be relative. Only look for
852 drive specifier at the beginning. */
853 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
855 drive
= (unsigned char) nm
[0];
860 /* If we see "c://somedir", we want to strip the first slash after the
861 colon when stripping the drive letter. Otherwise, this expands to
863 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
866 /* Discard any previous drive specifier if nm is now in UNC format. */
867 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
871 #endif /* WINDOWSNT */
874 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
875 none are found, we can probably return right away. We will avoid
876 allocating a new string if name is already fully expanded. */
878 IS_DIRECTORY_SEP (nm
[0])
880 && drive
&& !is_escaped
883 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
887 /* If it turns out that the filename we want to return is just a
888 suffix of FILENAME, we don't need to go through and edit
889 things; we just need to construct a new string using data
890 starting at the middle of FILENAME. If we set lose to a
891 non-zero value, that means we've discovered that we can't do
898 /* Since we know the name is absolute, we can assume that each
899 element starts with a "/". */
901 /* "." and ".." are hairy. */
902 if (IS_DIRECTORY_SEP (p
[0])
904 && (IS_DIRECTORY_SEP (p
[2])
906 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
909 /* We want to replace multiple `/' in a row with a single
912 && IS_DIRECTORY_SEP (p
[0])
913 && IS_DIRECTORY_SEP (p
[1]))
920 /* Make sure directories are all separated with /, but
921 avoid allocation of a new string when not required. */
922 dostounix_filename (nm
);
924 if (IS_DIRECTORY_SEP (nm
[1]))
926 if (strcmp (nm
, SSDATA (name
)) != 0)
927 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
931 /* drive must be set, so this is okay */
932 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
936 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
937 temp
[0] = DRIVE_LETTER (drive
);
938 name
= concat2 (build_string (temp
), name
);
941 #else /* not DOS_NT */
942 if (strcmp (nm
, SSDATA (name
)) == 0)
944 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
945 #endif /* not DOS_NT */
949 /* At this point, nm might or might not be an absolute file name. We
950 need to expand ~ or ~user if present, otherwise prefix nm with
951 default_directory if nm is not absolute, and finally collapse /./
952 and /foo/../ sequences.
954 We set newdir to be the appropriate prefix if one is needed:
955 - the relevant user directory if nm starts with ~ or ~user
956 - the specified drive's working dir (DOS/NT only) if nm does not
958 - the value of default_directory.
960 Note that these prefixes are not guaranteed to be absolute (except
961 for the working dir of a drive). Therefore, to ensure we always
962 return an absolute name, if the final prefix is not absolute we
963 append it to the current working directory. */
967 if (nm
[0] == '~') /* prefix ~ */
969 if (IS_DIRECTORY_SEP (nm
[1])
970 || nm
[1] == 0) /* ~ by itself */
974 if (!(newdir
= egetenv ("HOME")))
977 /* egetenv may return a unibyte string, which will bite us since
978 we expect the directory to be multibyte. */
979 tem
= build_string (newdir
);
980 if (!STRING_MULTIBYTE (tem
))
982 hdir
= DECODE_FILE (tem
);
983 newdir
= SSDATA (hdir
);
989 else /* ~user/filename */
992 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
993 o
= alloca (p
- nm
+ 1);
994 memcpy (o
, nm
, p
- nm
);
998 pw
= (struct passwd
*) getpwnam (o
+ 1);
1002 newdir
= pw
->pw_dir
;
1005 collapse_newdir
= 0;
1009 /* If we don't find a user of that name, leave the name
1010 unchanged; don't move nm forward to p. */
1015 /* On DOS and Windows, nm is absolute if a drive name was specified;
1016 use the drive's current directory as the prefix if needed. */
1017 if (!newdir
&& drive
)
1019 /* Get default directory if needed to make nm absolute. */
1021 if (!IS_DIRECTORY_SEP (nm
[0]))
1023 adir
= alloca (MAXPATHLEN
+ 1);
1024 if (!getdefdir (toupper (drive
) - 'A' + 1, adir
))
1029 /* Either nm starts with /, or drive isn't mounted. */
1031 adir
[0] = DRIVE_LETTER (drive
);
1040 /* Finally, if no prefix has been specified and nm is not absolute,
1041 then it must be expanded relative to default_directory. */
1045 /* /... alone is not absolute on DOS and Windows. */
1046 && !IS_DIRECTORY_SEP (nm
[0])
1049 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1053 newdir
= SSDATA (default_directory
);
1055 /* Note if special escape prefix is present, but remove for now. */
1056 if (newdir
[0] == '/' && newdir
[1] == ':')
1067 /* First ensure newdir is an absolute name. */
1069 /* Detect MSDOS file names with drive specifiers. */
1070 ! (IS_DRIVE (newdir
[0])
1071 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1073 /* Detect Windows file names in UNC format. */
1074 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1078 /* Effectively, let newdir be (expand-file-name newdir cwd).
1079 Because of the admonition against calling expand-file-name
1080 when we have pointers into lisp strings, we accomplish this
1081 indirectly by prepending newdir to nm if necessary, and using
1082 cwd (or the wd of newdir's drive) as the new newdir. */
1084 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1086 drive
= (unsigned char) newdir
[0];
1089 if (!IS_DIRECTORY_SEP (nm
[0]))
1091 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1092 file_name_as_directory (tmp
, newdir
);
1096 adir
= alloca (MAXPATHLEN
+ 1);
1099 if (!getdefdir (toupper (drive
) - 'A' + 1, adir
))
1107 /* Strip off drive name from prefix, if present. */
1108 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1114 /* Keep only a prefix from newdir if nm starts with slash
1115 (//server/share for UNC, nothing otherwise). */
1116 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1119 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1121 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1123 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1125 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1138 /* Get rid of any slash at the end of newdir, unless newdir is
1139 just / or // (an incomplete UNC name). */
1140 length
= strlen (newdir
);
1141 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1143 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1147 char *temp
= (char *) alloca (length
);
1148 memcpy (temp
, newdir
, length
- 1);
1149 temp
[length
- 1] = 0;
1157 /* Now concatenate the directory and name to new space in the stack frame */
1158 tlen
+= strlen (nm
) + 1;
1160 /* Reserve space for drive specifier and escape prefix, since either
1161 or both may need to be inserted. (The Microsoft x86 compiler
1162 produces incorrect code if the following two lines are combined.) */
1163 target
= (char *) alloca (tlen
+ 4);
1165 #else /* not DOS_NT */
1166 target
= (char *) alloca (tlen
);
1167 #endif /* not DOS_NT */
1172 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1175 /* If newdir is effectively "C:/", then the drive letter will have
1176 been stripped and newdir will be "/". Concatenating with an
1177 absolute directory in nm produces "//", which will then be
1178 incorrectly treated as a network share. Ignore newdir in
1179 this case (keeping the drive letter). */
1180 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1181 && newdir
[1] == '\0'))
1183 strcpy (target
, newdir
);
1186 file_name_as_directory (target
, newdir
);
1189 strcat (target
, nm
);
1191 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1199 if (!IS_DIRECTORY_SEP (*p
))
1203 else if (p
[1] == '.'
1204 && (IS_DIRECTORY_SEP (p
[2])
1207 /* If "/." is the entire filename, keep the "/". Otherwise,
1208 just delete the whole "/.". */
1209 if (o
== target
&& p
[2] == '\0')
1213 else if (p
[1] == '.' && p
[2] == '.'
1214 /* `/../' is the "superroot" on certain file systems.
1215 Turned off on DOS_NT systems because they have no
1216 "superroot" and because this causes us to produce
1217 file names like "d:/../foo" which fail file-related
1218 functions of the underlying OS. (To reproduce, try a
1219 long series of "../../" in default_directory, longer
1220 than the number of levels from the root.) */
1224 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1229 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1232 /* Don't go below server level in UNC filenames. */
1233 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1234 && IS_DIRECTORY_SEP (*target
))
1238 /* Keep initial / only if this is the whole name. */
1239 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1243 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1244 /* Collapse multiple `/' in a row. */
1253 /* At last, set drive name. */
1255 /* Except for network file name. */
1256 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1257 #endif /* WINDOWSNT */
1259 if (!drive
) abort ();
1261 target
[0] = DRIVE_LETTER (drive
);
1264 /* Reinsert the escape prefix if required. */
1271 dostounix_filename (target
);
1274 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1277 /* Again look to see if the file name has special constructs in it
1278 and perhaps call the corresponding file handler. This is needed
1279 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1280 the ".." component gives us "/user@host:/bar/../baz" which needs
1281 to be expanded again. */
1282 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1283 if (!NILP (handler
))
1284 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1290 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1291 This is the old version of expand-file-name, before it was thoroughly
1292 rewritten for Emacs 10.31. We leave this version here commented-out,
1293 because the code is very complex and likely to have subtle bugs. If
1294 bugs _are_ found, it might be of interest to look at the old code and
1295 see what did it do in the relevant situation.
1297 Don't remove this code: it's true that it will be accessible
1298 from the repository, but a few years from deletion, people will
1299 forget it is there. */
1301 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1302 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1303 "Convert FILENAME to absolute, and canonicalize it.\n\
1304 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1305 \(does not start with slash); if DEFAULT is nil or missing,\n\
1306 the current buffer's value of default-directory is used.\n\
1307 Filenames containing `.' or `..' as components are simplified;\n\
1308 initial `~/' expands to your home directory.\n\
1309 See also the function `substitute-in-file-name'.")
1311 Lisp_Object name
, defalt
;
1315 register unsigned char *newdir
, *p
, *o
;
1317 unsigned char *target
;
1321 CHECK_STRING (name
);
1324 /* If nm is absolute, flush ...// and detect /./ and /../.
1325 If no /./ or /../ we can return right away. */
1332 if (p
[0] == '/' && p
[1] == '/'
1335 if (p
[0] == '/' && p
[1] == '~')
1336 nm
= p
+ 1, lose
= 1;
1337 if (p
[0] == '/' && p
[1] == '.'
1338 && (p
[2] == '/' || p
[2] == 0
1339 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1345 if (nm
== SDATA (name
))
1347 return build_string (nm
);
1351 /* Now determine directory to start with and put it in NEWDIR */
1355 if (nm
[0] == '~') /* prefix ~ */
1356 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1358 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1359 newdir
= (unsigned char *) "";
1362 else /* ~user/filename */
1364 /* Get past ~ to user */
1365 unsigned char *user
= nm
+ 1;
1366 /* Find end of name. */
1367 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1368 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1369 /* Copy the user name into temp storage. */
1370 o
= (unsigned char *) alloca (len
+ 1);
1371 memcpy (o
, user
, len
);
1374 /* Look up the user name. */
1376 pw
= (struct passwd
*) getpwnam (o
+ 1);
1379 error ("\"%s\" isn't a registered user", o
+ 1);
1381 newdir
= (unsigned char *) pw
->pw_dir
;
1383 /* Discard the user name from NM. */
1387 if (nm
[0] != '/' && !newdir
)
1390 defalt
= current_buffer
->directory
;
1391 CHECK_STRING (defalt
);
1392 newdir
= SDATA (defalt
);
1395 /* Now concatenate the directory and name to new space in the stack frame */
1397 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1398 target
= (unsigned char *) alloca (tlen
);
1403 if (nm
[0] == 0 || nm
[0] == '/')
1404 strcpy (target
, newdir
);
1406 file_name_as_directory (target
, newdir
);
1409 strcat (target
, nm
);
1411 /* Now canonicalize by removing /. and /foo/.. if they appear */
1422 else if (!strncmp (p
, "//", 2)
1428 else if (p
[0] == '/' && p
[1] == '.'
1429 && (p
[2] == '/' || p
[2] == 0))
1431 else if (!strncmp (p
, "/..", 3)
1432 /* `/../' is the "superroot" on certain file systems. */
1434 && (p
[3] == '/' || p
[3] == 0))
1436 while (o
!= target
&& *--o
!= '/')
1438 if (o
== target
&& *o
== '/')
1448 return make_string (target
, o
- target
);
1452 /* If /~ or // appears, discard everything through first slash. */
1454 file_name_absolute_p (const char *filename
)
1457 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1459 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1460 && IS_DIRECTORY_SEP (filename
[2]))
1466 search_embedded_absfilename (char *nm
, char *endp
)
1470 for (p
= nm
+ 1; p
< endp
; p
++)
1473 || IS_DIRECTORY_SEP (p
[-1]))
1474 && file_name_absolute_p (p
)
1475 #if defined (WINDOWSNT) || defined (CYGWIN)
1476 /* // at start of file name is meaningful in Apollo,
1477 WindowsNT and Cygwin systems. */
1478 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1479 #endif /* not (WINDOWSNT || CYGWIN) */
1482 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1483 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
1485 char *o
= alloca (s
- p
+ 1);
1487 memcpy (o
, p
, s
- p
);
1490 /* If we have ~user and `user' exists, discard
1491 everything up to ~. But if `user' does not exist, leave
1492 ~user alone, it might be a literal file name. */
1494 pw
= getpwnam (o
+ 1);
1506 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1507 Ssubstitute_in_file_name
, 1, 1, 0,
1508 doc
: /* Substitute environment variables referred to in FILENAME.
1509 `$FOO' where FOO is an environment variable name means to substitute
1510 the value of that variable. The variable name should be terminated
1511 with a character not a letter, digit or underscore; otherwise, enclose
1512 the entire variable name in braces.
1514 If `/~' appears, all of FILENAME through that `/' is discarded.
1515 If `//' appears, everything up to and including the first of
1516 those `/' is discarded. */)
1517 (Lisp_Object filename
)
1521 register char *s
, *p
, *o
, *x
, *endp
;
1522 char *target
= NULL
;
1524 int substituted
= 0;
1527 Lisp_Object handler
;
1529 CHECK_STRING (filename
);
1531 multibyte
= STRING_MULTIBYTE (filename
);
1533 /* If the file name has special constructs in it,
1534 call the corresponding file handler. */
1535 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1536 if (!NILP (handler
))
1537 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
1539 /* Always work on a copy of the string, in case GC happens during
1540 decode of environment variables, causing the original Lisp_String
1541 data to be relocated. */
1542 nm
= (char *) alloca (SBYTES (filename
) + 1);
1543 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1546 dostounix_filename (nm
);
1547 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1549 endp
= nm
+ SBYTES (filename
);
1551 /* If /~ or // appears, discard everything through first slash. */
1552 p
= search_embedded_absfilename (nm
, endp
);
1554 /* Start over with the new string, so we check the file-name-handler
1555 again. Important with filenames like "/home/foo//:/hello///there"
1556 which whould substitute to "/:/hello///there" rather than "/there". */
1557 return Fsubstitute_in_file_name
1558 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1560 /* See if any variables are substituted into the string
1561 and find the total length of their values in `total' */
1563 for (p
= nm
; p
!= endp
;)
1573 /* "$$" means a single "$" */
1582 while (p
!= endp
&& *p
!= '}') p
++;
1583 if (*p
!= '}') goto missingclose
;
1589 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1593 /* Copy out the variable name */
1594 target
= (char *) alloca (s
- o
+ 1);
1595 strncpy (target
, o
, s
- o
);
1598 strupr (target
); /* $home == $HOME etc. */
1601 /* Get variable value */
1602 o
= egetenv (target
);
1605 /* Don't try to guess a maximum length - UTF8 can use up to
1606 four bytes per character. This code is unlikely to run
1607 in a situation that requires performance, so decoding the
1608 env variables twice should be acceptable. Note that
1609 decoding may cause a garbage collect. */
1610 Lisp_Object orig
, decoded
;
1611 orig
= make_unibyte_string (o
, strlen (o
));
1612 decoded
= DECODE_FILE (orig
);
1613 total
+= SBYTES (decoded
);
1623 /* If substitution required, recopy the string and do it */
1624 /* Make space in stack frame for the new copy */
1625 xnm
= (char *) alloca (SBYTES (filename
) + total
+ 1);
1628 /* Copy the rest of the name through, replacing $ constructs with values */
1645 while (p
!= endp
&& *p
!= '}') p
++;
1646 if (*p
!= '}') goto missingclose
;
1652 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1656 /* Copy out the variable name */
1657 target
= (char *) alloca (s
- o
+ 1);
1658 strncpy (target
, o
, s
- o
);
1661 strupr (target
); /* $home == $HOME etc. */
1664 /* Get variable value */
1665 o
= egetenv (target
);
1669 strcpy (x
, target
); x
+= strlen (target
);
1673 Lisp_Object orig
, decoded
;
1674 ptrdiff_t orig_length
, decoded_length
;
1675 orig_length
= strlen (o
);
1676 orig
= make_unibyte_string (o
, orig_length
);
1677 decoded
= DECODE_FILE (orig
);
1678 decoded_length
= SBYTES (decoded
);
1679 strncpy (x
, SSDATA (decoded
), decoded_length
);
1680 x
+= decoded_length
;
1682 /* If environment variable needed decoding, return value
1683 needs to be multibyte. */
1684 if (decoded_length
!= orig_length
1685 || strncmp (SSDATA (decoded
), o
, orig_length
))
1692 /* If /~ or // appears, discard everything through first slash. */
1693 while ((p
= search_embedded_absfilename (xnm
, x
)))
1694 /* This time we do not start over because we've already expanded envvars
1695 and replaced $$ with $. Maybe we should start over as well, but we'd
1696 need to quote some $ to $$ first. */
1699 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1702 error ("Bad format environment-variable substitution");
1704 error ("Missing \"}\" in environment-variable substitution");
1706 error ("Substituting nonexistent environment variable \"%s\"", target
);
1712 /* A slightly faster and more convenient way to get
1713 (directory-file-name (expand-file-name FOO)). */
1716 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1718 register Lisp_Object absname
;
1720 absname
= Fexpand_file_name (filename
, defdir
);
1722 /* Remove final slash, if any (unless this is the root dir).
1723 stat behaves differently depending! */
1724 if (SCHARS (absname
) > 1
1725 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1726 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
1727 /* We cannot take shortcuts; they might be wrong for magic file names. */
1728 absname
= Fdirectory_file_name (absname
);
1732 /* Signal an error if the file ABSNAME already exists.
1733 If INTERACTIVE is nonzero, ask the user whether to proceed,
1734 and bypass the error if the user says to go ahead.
1735 QUERYSTRING is a name for the action that is being considered
1738 *STATPTR is used to store the stat information if the file exists.
1739 If the file does not exist, STATPTR->st_mode is set to 0.
1740 If STATPTR is null, we don't store into it.
1742 If QUICK is nonzero, we ask for y or n, not yes or no. */
1745 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1746 int interactive
, struct stat
*statptr
, int quick
)
1748 register Lisp_Object tem
, encoded_filename
;
1749 struct stat statbuf
;
1750 struct gcpro gcpro1
;
1752 encoded_filename
= ENCODE_FILE (absname
);
1754 /* stat is a good way to tell whether the file exists,
1755 regardless of what access permissions it has. */
1756 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1758 if (S_ISDIR (statbuf
.st_mode
))
1759 xsignal2 (Qfile_error
,
1760 build_string ("File is a directory"), absname
);
1763 xsignal2 (Qfile_already_exists
,
1764 build_string ("File already exists"), absname
);
1766 tem
= format2 ("File %s already exists; %s anyway? ",
1767 absname
, build_string (querystring
));
1769 tem
= call1 (intern ("y-or-n-p"), tem
);
1771 tem
= do_yes_or_no_p (tem
);
1774 xsignal2 (Qfile_already_exists
,
1775 build_string ("File already exists"), absname
);
1782 statptr
->st_mode
= 0;
1787 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1788 "fCopy file: \nGCopy %s to file: \np\nP",
1789 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1790 If NEWNAME names a directory, copy FILE there.
1792 This function always sets the file modes of the output file to match
1795 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1796 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1797 signal a `file-already-exists' error without overwriting. If
1798 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1799 about overwriting; this is what happens in interactive use with M-x.
1800 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1803 Fourth arg KEEP-TIME non-nil means give the output file the same
1804 last-modified time as the old one. (This works on only some systems.)
1806 A prefix arg makes KEEP-TIME non-nil.
1808 If PRESERVE-UID-GID is non-nil, we try to transfer the
1809 uid and gid of FILE to NEWNAME.
1811 If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
1812 on the system, we copy the SELinux context of FILE to NEWNAME. */)
1813 (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
)
1817 char buf
[16 * 1024];
1818 struct stat st
, out_st
;
1819 Lisp_Object handler
;
1820 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1821 int count
= SPECPDL_INDEX ();
1822 int input_file_statable_p
;
1823 Lisp_Object encoded_file
, encoded_newname
;
1825 security_context_t con
;
1826 int fail
, conlength
= 0;
1829 encoded_file
= encoded_newname
= Qnil
;
1830 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1831 CHECK_STRING (file
);
1832 CHECK_STRING (newname
);
1834 if (!NILP (Ffile_directory_p (newname
)))
1835 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1837 newname
= Fexpand_file_name (newname
, Qnil
);
1839 file
= Fexpand_file_name (file
, Qnil
);
1841 /* If the input file name has special constructs in it,
1842 call the corresponding file handler. */
1843 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1844 /* Likewise for output file name. */
1846 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1847 if (!NILP (handler
))
1848 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1849 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1850 preserve_selinux_context
));
1852 encoded_file
= ENCODE_FILE (file
);
1853 encoded_newname
= ENCODE_FILE (newname
);
1855 if (NILP (ok_if_already_exists
)
1856 || INTEGERP (ok_if_already_exists
))
1857 barf_or_query_if_file_exists (newname
, "copy to it",
1858 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1859 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1863 if (!CopyFile (SDATA (encoded_file
),
1864 SDATA (encoded_newname
),
1866 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1867 /* CopyFile retains the timestamp by default. */
1868 else if (NILP (keep_time
))
1874 EMACS_GET_TIME (now
);
1875 filename
= SDATA (encoded_newname
);
1877 /* Ensure file is writable while its modified time is set. */
1878 attributes
= GetFileAttributes (filename
);
1879 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1880 if (set_file_times (filename
, now
, now
))
1882 /* Restore original attributes. */
1883 SetFileAttributes (filename
, attributes
);
1884 xsignal2 (Qfile_date_error
,
1885 build_string ("Cannot set file date"), newname
);
1887 /* Restore original attributes. */
1888 SetFileAttributes (filename
, attributes
);
1890 #else /* not WINDOWSNT */
1892 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
1896 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1898 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1900 /* We can only copy regular files and symbolic links. Other files are not
1902 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
1905 if (!NILP (preserve_selinux_context
) && is_selinux_enabled ())
1907 conlength
= fgetfilecon (ifd
, &con
);
1908 if (conlength
== -1)
1909 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
1913 if (out_st
.st_mode
!= 0
1914 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
1917 report_file_error ("Input and output files are the same",
1918 Fcons (file
, Fcons (newname
, Qnil
)));
1921 if (input_file_statable_p
)
1923 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
1925 #if defined (EISDIR)
1926 /* Get a better looking error message. */
1929 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
1934 /* System's default file type was set to binary by _fmode in emacs.c. */
1935 ofd
= emacs_open (SDATA (encoded_newname
),
1936 O_WRONLY
| O_TRUNC
| O_CREAT
1937 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
1938 S_IREAD
| S_IWRITE
);
1939 #else /* not MSDOS */
1941 int new_mask
= 0666;
1942 if (input_file_statable_p
)
1944 if (!NILP (preserve_uid_gid
))
1946 new_mask
&= st
.st_mode
;
1948 ofd
= emacs_open (SSDATA (encoded_newname
),
1949 (O_WRONLY
| O_TRUNC
| O_CREAT
1950 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
1953 #endif /* not MSDOS */
1955 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
1957 record_unwind_protect (close_file_unwind
, make_number (ofd
));
1961 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
1962 if (emacs_write (ofd
, buf
, n
) != n
)
1963 report_file_error ("I/O error", Fcons (newname
, Qnil
));
1967 /* Preserve the original file modes, and if requested, also its
1969 if (input_file_statable_p
)
1971 int mode_mask
= 07777;
1972 if (!NILP (preserve_uid_gid
))
1974 /* Attempt to change owner and group. If that doesn't work
1975 attempt to change just the group, as that is sometimes allowed.
1976 Adjust the mode mask to eliminate setuid or setgid bits
1977 that are inappropriate if the owner and group are wrong. */
1978 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
1980 mode_mask
&= ~06000;
1981 if (fchown (ofd
, -1, st
.st_gid
) == 0)
1985 if (fchmod (ofd
, st
.st_mode
& mode_mask
) != 0)
1986 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
1988 #endif /* not MSDOS */
1993 /* Set the modified context back to the file. */
1994 fail
= fsetfilecon (ofd
, con
);
1996 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2002 /* Closing the output clobbers the file times on some systems. */
2003 if (emacs_close (ofd
) < 0)
2004 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2006 if (input_file_statable_p
)
2008 if (!NILP (keep_time
))
2010 EMACS_TIME atime
, mtime
;
2011 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
2012 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
2013 if (set_file_times (SSDATA (encoded_newname
),
2015 xsignal2 (Qfile_date_error
,
2016 build_string ("Cannot set file date"), newname
);
2023 if (input_file_statable_p
)
2025 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2026 and if it can't, it tells so. Otherwise, under MSDOS we usually
2027 get only the READ bit, which will make the copied file read-only,
2028 so it's better not to chmod at all. */
2029 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2030 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2033 #endif /* not WINDOWSNT */
2035 /* Discard the unwind protects. */
2036 specpdl_ptr
= specpdl
+ count
;
2042 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2043 Smake_directory_internal
, 1, 1, 0,
2044 doc
: /* Create a new directory named DIRECTORY. */)
2045 (Lisp_Object directory
)
2048 Lisp_Object handler
;
2049 Lisp_Object encoded_dir
;
2051 CHECK_STRING (directory
);
2052 directory
= Fexpand_file_name (directory
, Qnil
);
2054 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2055 if (!NILP (handler
))
2056 return call2 (handler
, Qmake_directory_internal
, directory
);
2058 encoded_dir
= ENCODE_FILE (directory
);
2060 dir
= SSDATA (encoded_dir
);
2063 if (mkdir (dir
) != 0)
2065 if (mkdir (dir
, 0777) != 0)
2067 report_file_error ("Creating directory", list1 (directory
));
2072 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2073 Sdelete_directory_internal
, 1, 1, 0,
2074 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2075 (Lisp_Object directory
)
2078 Lisp_Object encoded_dir
;
2080 CHECK_STRING (directory
);
2081 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2082 encoded_dir
= ENCODE_FILE (directory
);
2083 dir
= SSDATA (encoded_dir
);
2085 if (rmdir (dir
) != 0)
2086 report_file_error ("Removing directory", list1 (directory
));
2091 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2092 "(list (read-file-name \
2093 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2094 \"Move file to trash: \" \"Delete file: \") \
2095 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2096 (null current-prefix-arg))",
2097 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2098 If file has multiple names, it continues to exist with the other names.
2099 TRASH non-nil means to trash the file instead of deleting, provided
2100 `delete-by-moving-to-trash' is non-nil.
2102 When called interactively, TRASH is t if no prefix argument is given.
2103 With a prefix argument, TRASH is nil. */)
2104 (Lisp_Object filename
, Lisp_Object trash
)
2106 Lisp_Object handler
;
2107 Lisp_Object encoded_file
;
2108 struct gcpro gcpro1
;
2111 if (!NILP (Ffile_directory_p (filename
))
2112 && NILP (Ffile_symlink_p (filename
)))
2113 xsignal2 (Qfile_error
,
2114 build_string ("Removing old name: is a directory"),
2117 filename
= Fexpand_file_name (filename
, Qnil
);
2119 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2120 if (!NILP (handler
))
2121 return call3 (handler
, Qdelete_file
, filename
, trash
);
2123 if (delete_by_moving_to_trash
&& !NILP (trash
))
2124 return call1 (Qmove_file_to_trash
, filename
);
2126 encoded_file
= ENCODE_FILE (filename
);
2128 if (0 > unlink (SSDATA (encoded_file
)))
2129 report_file_error ("Removing old name", list1 (filename
));
2134 internal_delete_file_1 (Lisp_Object ignore
)
2139 /* Delete file FILENAME, returning 1 if successful and 0 if failed.
2140 This ignores `delete-by-moving-to-trash'. */
2143 internal_delete_file (Lisp_Object filename
)
2147 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2148 Qt
, internal_delete_file_1
);
2152 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2153 "fRename file: \nGRename %s to file: \np",
2154 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2155 If file has names other than FILE, it continues to have those names.
2156 Signals a `file-already-exists' error if a file NEWNAME already exists
2157 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2158 A number as third arg means request confirmation if NEWNAME already exists.
2159 This is what happens in interactive use with M-x. */)
2160 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2162 Lisp_Object handler
;
2163 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2164 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2166 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2167 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2168 CHECK_STRING (file
);
2169 CHECK_STRING (newname
);
2170 file
= Fexpand_file_name (file
, Qnil
);
2172 if ((!NILP (Ffile_directory_p (newname
)))
2174 /* If the file names are identical but for the case,
2175 don't attempt to move directory to itself. */
2176 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2180 Lisp_Object fname
= NILP (Ffile_directory_p (file
))
2181 ? file
: Fdirectory_file_name (file
);
2182 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2185 newname
= Fexpand_file_name (newname
, Qnil
);
2187 /* If the file name has special constructs in it,
2188 call the corresponding file handler. */
2189 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2191 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2192 if (!NILP (handler
))
2193 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2194 file
, newname
, ok_if_already_exists
));
2196 encoded_file
= ENCODE_FILE (file
);
2197 encoded_newname
= ENCODE_FILE (newname
);
2200 /* If the file names are identical but for the case, don't ask for
2201 confirmation: they simply want to change the letter-case of the
2203 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2205 if (NILP (ok_if_already_exists
)
2206 || INTEGERP (ok_if_already_exists
))
2207 barf_or_query_if_file_exists (newname
, "rename to it",
2208 INTEGERP (ok_if_already_exists
), 0, 0);
2209 if (0 > rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2214 symlink_target
= Ffile_symlink_p (file
);
2215 if (! NILP (symlink_target
))
2216 Fmake_symbolic_link (symlink_target
, newname
,
2217 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2218 else if (!NILP (Ffile_directory_p (file
)))
2219 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2221 /* We have already prompted if it was an integer, so don't
2222 have copy-file prompt again. */
2223 Fcopy_file (file
, newname
,
2224 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2227 count
= SPECPDL_INDEX ();
2228 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2230 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2231 call2 (Qdelete_directory
, file
, Qt
);
2233 Fdelete_file (file
, Qnil
);
2234 unbind_to (count
, Qnil
);
2237 report_file_error ("Renaming", list2 (file
, newname
));
2243 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2244 "fAdd name to file: \nGName to add to %s: \np",
2245 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2246 Signals a `file-already-exists' error if a file NEWNAME already exists
2247 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2248 A number as third arg means request confirmation if NEWNAME already exists.
2249 This is what happens in interactive use with M-x. */)
2250 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2252 Lisp_Object handler
;
2253 Lisp_Object encoded_file
, encoded_newname
;
2254 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2256 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2257 encoded_file
= encoded_newname
= Qnil
;
2258 CHECK_STRING (file
);
2259 CHECK_STRING (newname
);
2260 file
= Fexpand_file_name (file
, Qnil
);
2262 if (!NILP (Ffile_directory_p (newname
)))
2263 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2265 newname
= Fexpand_file_name (newname
, Qnil
);
2267 /* If the file name has special constructs in it,
2268 call the corresponding file handler. */
2269 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2270 if (!NILP (handler
))
2271 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2272 newname
, ok_if_already_exists
));
2274 /* If the new name has special constructs in it,
2275 call the corresponding file handler. */
2276 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2277 if (!NILP (handler
))
2278 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2279 newname
, ok_if_already_exists
));
2281 encoded_file
= ENCODE_FILE (file
);
2282 encoded_newname
= ENCODE_FILE (newname
);
2284 if (NILP (ok_if_already_exists
)
2285 || INTEGERP (ok_if_already_exists
))
2286 barf_or_query_if_file_exists (newname
, "make it a new name",
2287 INTEGERP (ok_if_already_exists
), 0, 0);
2289 unlink (SSDATA (newname
));
2290 if (0 > link (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2291 report_file_error ("Adding new name", list2 (file
, newname
));
2297 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2298 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2299 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2300 Both args must be strings.
2301 Signals a `file-already-exists' error if a file LINKNAME already exists
2302 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2303 A number as third arg means request confirmation if LINKNAME already exists.
2304 This happens for interactive use with M-x. */)
2305 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2307 Lisp_Object handler
;
2308 Lisp_Object encoded_filename
, encoded_linkname
;
2309 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2311 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2312 encoded_filename
= encoded_linkname
= Qnil
;
2313 CHECK_STRING (filename
);
2314 CHECK_STRING (linkname
);
2315 /* If the link target has a ~, we must expand it to get
2316 a truly valid file name. Otherwise, do not expand;
2317 we want to permit links to relative file names. */
2318 if (SREF (filename
, 0) == '~')
2319 filename
= Fexpand_file_name (filename
, Qnil
);
2321 if (!NILP (Ffile_directory_p (linkname
)))
2322 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2324 linkname
= Fexpand_file_name (linkname
, Qnil
);
2326 /* If the file name has special constructs in it,
2327 call the corresponding file handler. */
2328 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2329 if (!NILP (handler
))
2330 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2331 linkname
, ok_if_already_exists
));
2333 /* If the new link name has special constructs in it,
2334 call the corresponding file handler. */
2335 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2336 if (!NILP (handler
))
2337 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2338 linkname
, ok_if_already_exists
));
2340 encoded_filename
= ENCODE_FILE (filename
);
2341 encoded_linkname
= ENCODE_FILE (linkname
);
2343 if (NILP (ok_if_already_exists
)
2344 || INTEGERP (ok_if_already_exists
))
2345 barf_or_query_if_file_exists (linkname
, "make it a link",
2346 INTEGERP (ok_if_already_exists
), 0, 0);
2347 if (0 > symlink (SSDATA (encoded_filename
),
2348 SSDATA (encoded_linkname
)))
2350 /* If we didn't complain already, silently delete existing file. */
2351 if (errno
== EEXIST
)
2353 unlink (SSDATA (encoded_linkname
));
2354 if (0 <= symlink (SSDATA (encoded_filename
),
2355 SSDATA (encoded_linkname
)))
2361 if (errno
== ENOSYS
)
2364 xsignal1 (Qfile_error
,
2365 build_string ("Symbolic links are not supported"));
2368 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2375 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2377 doc
: /* Return t if file FILENAME specifies an absolute file name.
2378 On Unix, this is a name starting with a `/' or a `~'. */)
2379 (Lisp_Object filename
)
2381 CHECK_STRING (filename
);
2382 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2385 /* Return nonzero if file FILENAME exists and can be executed. */
2388 check_executable (char *filename
)
2392 if (stat (filename
, &st
) < 0)
2394 return ((st
.st_mode
& S_IEXEC
) != 0);
2395 #else /* not DOS_NT */
2396 #ifdef HAVE_EUIDACCESS
2397 return (euidaccess (filename
, 1) >= 0);
2399 /* Access isn't quite right because it uses the real uid
2400 and we really want to test with the effective uid.
2401 But Unix doesn't give us a right way to do it. */
2402 return (access (filename
, 1) >= 0);
2404 #endif /* not DOS_NT */
2407 /* Return nonzero if file FILENAME exists and can be written. */
2410 check_writable (const char *filename
)
2414 if (stat (filename
, &st
) < 0)
2416 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2417 #else /* not MSDOS */
2418 #ifdef HAVE_EUIDACCESS
2419 return (euidaccess (filename
, 2) >= 0);
2421 /* Access isn't quite right because it uses the real uid
2422 and we really want to test with the effective uid.
2423 But Unix doesn't give us a right way to do it.
2424 Opening with O_WRONLY could work for an ordinary file,
2425 but would lose for directories. */
2426 return (access (filename
, 2) >= 0);
2428 #endif /* not MSDOS */
2431 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2432 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2433 See also `file-readable-p' and `file-attributes'.
2434 This returns nil for a symlink to a nonexistent file.
2435 Use `file-symlink-p' to test for such links. */)
2436 (Lisp_Object filename
)
2438 Lisp_Object absname
;
2439 Lisp_Object handler
;
2440 struct stat statbuf
;
2442 CHECK_STRING (filename
);
2443 absname
= Fexpand_file_name (filename
, Qnil
);
2445 /* If the file name has special constructs in it,
2446 call the corresponding file handler. */
2447 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2448 if (!NILP (handler
))
2449 return call2 (handler
, Qfile_exists_p
, absname
);
2451 absname
= ENCODE_FILE (absname
);
2453 return (stat (SSDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2456 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2457 doc
: /* Return t if FILENAME can be executed by you.
2458 For a directory, this means you can access files in that directory. */)
2459 (Lisp_Object filename
)
2461 Lisp_Object absname
;
2462 Lisp_Object handler
;
2464 CHECK_STRING (filename
);
2465 absname
= Fexpand_file_name (filename
, Qnil
);
2467 /* If the file name has special constructs in it,
2468 call the corresponding file handler. */
2469 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2470 if (!NILP (handler
))
2471 return call2 (handler
, Qfile_executable_p
, absname
);
2473 absname
= ENCODE_FILE (absname
);
2475 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2478 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2479 doc
: /* Return t if file FILENAME exists and you can read it.
2480 See also `file-exists-p' and `file-attributes'. */)
2481 (Lisp_Object filename
)
2483 Lisp_Object absname
;
2484 Lisp_Object handler
;
2487 struct stat statbuf
;
2489 CHECK_STRING (filename
);
2490 absname
= Fexpand_file_name (filename
, Qnil
);
2492 /* If the file name has special constructs in it,
2493 call the corresponding file handler. */
2494 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2495 if (!NILP (handler
))
2496 return call2 (handler
, Qfile_readable_p
, absname
);
2498 absname
= ENCODE_FILE (absname
);
2500 #if defined (DOS_NT) || defined (macintosh)
2501 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2503 if (access (SDATA (absname
), 0) == 0)
2506 #else /* not DOS_NT and not macintosh */
2509 /* Opening a fifo without O_NONBLOCK can wait.
2510 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2511 except in the case of a fifo, on a system which handles it. */
2512 desc
= stat (SSDATA (absname
), &statbuf
);
2515 if (S_ISFIFO (statbuf
.st_mode
))
2516 flags
|= O_NONBLOCK
;
2518 desc
= emacs_open (SSDATA (absname
), flags
, 0);
2523 #endif /* not DOS_NT and not macintosh */
2526 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2528 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2529 doc
: /* Return t if file FILENAME can be written or created by you. */)
2530 (Lisp_Object filename
)
2532 Lisp_Object absname
, dir
, encoded
;
2533 Lisp_Object handler
;
2534 struct stat statbuf
;
2536 CHECK_STRING (filename
);
2537 absname
= Fexpand_file_name (filename
, Qnil
);
2539 /* If the file name has special constructs in it,
2540 call the corresponding file handler. */
2541 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2542 if (!NILP (handler
))
2543 return call2 (handler
, Qfile_writable_p
, absname
);
2545 encoded
= ENCODE_FILE (absname
);
2546 if (stat (SSDATA (encoded
), &statbuf
) >= 0)
2547 return (check_writable (SSDATA (encoded
))
2550 dir
= Ffile_name_directory (absname
);
2553 dir
= Fdirectory_file_name (dir
);
2556 dir
= ENCODE_FILE (dir
);
2558 /* The read-only attribute of the parent directory doesn't affect
2559 whether a file or directory can be created within it. Some day we
2560 should check ACLs though, which do affect this. */
2561 if (stat (SDATA (dir
), &statbuf
) < 0)
2563 return S_ISDIR (statbuf
.st_mode
) ? Qt
: Qnil
;
2565 return (check_writable (!NILP (dir
) ? SSDATA (dir
) : "")
2570 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2571 doc
: /* Access file FILENAME, and get an error if that does not work.
2572 The second argument STRING is used in the error message.
2573 If there is no error, returns nil. */)
2574 (Lisp_Object filename
, Lisp_Object string
)
2576 Lisp_Object handler
, encoded_filename
, absname
;
2579 CHECK_STRING (filename
);
2580 absname
= Fexpand_file_name (filename
, Qnil
);
2582 CHECK_STRING (string
);
2584 /* If the file name has special constructs in it,
2585 call the corresponding file handler. */
2586 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2587 if (!NILP (handler
))
2588 return call3 (handler
, Qaccess_file
, absname
, string
);
2590 encoded_filename
= ENCODE_FILE (absname
);
2592 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2594 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2600 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2601 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2602 The value is the link target, as a string.
2603 Otherwise it returns nil.
2605 This function returns t when given the name of a symlink that
2606 points to a nonexistent file. */)
2607 (Lisp_Object filename
)
2609 Lisp_Object handler
;
2612 char readlink_buf
[READLINK_BUFSIZE
];
2614 CHECK_STRING (filename
);
2615 filename
= Fexpand_file_name (filename
, Qnil
);
2617 /* If the file name has special constructs in it,
2618 call the corresponding file handler. */
2619 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2620 if (!NILP (handler
))
2621 return call2 (handler
, Qfile_symlink_p
, filename
);
2623 filename
= ENCODE_FILE (filename
);
2625 buf
= emacs_readlink (SSDATA (filename
), readlink_buf
);
2629 val
= build_string (buf
);
2630 if (buf
[0] == '/' && strchr (buf
, ':'))
2631 val
= concat2 (build_string ("/:"), val
);
2632 if (buf
!= readlink_buf
)
2634 val
= DECODE_FILE (val
);
2638 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2639 doc
: /* Return t if FILENAME names an existing directory.
2640 Symbolic links to directories count as directories.
2641 See `file-symlink-p' to distinguish symlinks. */)
2642 (Lisp_Object filename
)
2644 register Lisp_Object absname
;
2646 Lisp_Object handler
;
2648 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2650 /* If the file name has special constructs in it,
2651 call the corresponding file handler. */
2652 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2653 if (!NILP (handler
))
2654 return call2 (handler
, Qfile_directory_p
, absname
);
2656 absname
= ENCODE_FILE (absname
);
2658 if (stat (SSDATA (absname
), &st
) < 0)
2660 return S_ISDIR (st
.st_mode
) ? Qt
: Qnil
;
2663 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2664 Sfile_accessible_directory_p
, 1, 1, 0,
2665 doc
: /* Return t if file FILENAME names a directory you can open.
2666 For the value to be t, FILENAME must specify the name of a directory as a file,
2667 and the directory must allow you to open files in it. In order to use a
2668 directory as a buffer's current directory, this predicate must return true.
2669 A directory name spec may be given instead; then the value is t
2670 if the directory so specified exists and really is a readable and
2671 searchable directory. */)
2672 (Lisp_Object filename
)
2674 Lisp_Object handler
;
2676 struct gcpro gcpro1
;
2678 /* If the file name has special constructs in it,
2679 call the corresponding file handler. */
2680 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2681 if (!NILP (handler
))
2682 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2685 tem
= (NILP (Ffile_directory_p (filename
))
2686 || NILP (Ffile_executable_p (filename
)));
2688 return tem
? Qnil
: Qt
;
2691 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2692 doc
: /* Return t if FILENAME names a regular file.
2693 This is the sort of file that holds an ordinary stream of data bytes.
2694 Symbolic links to regular files count as regular files.
2695 See `file-symlink-p' to distinguish symlinks. */)
2696 (Lisp_Object filename
)
2698 register Lisp_Object absname
;
2700 Lisp_Object handler
;
2702 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2704 /* If the file name has special constructs in it,
2705 call the corresponding file handler. */
2706 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2707 if (!NILP (handler
))
2708 return call2 (handler
, Qfile_regular_p
, absname
);
2710 absname
= ENCODE_FILE (absname
);
2715 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2717 /* Tell stat to use expensive method to get accurate info. */
2718 Vw32_get_true_file_attributes
= Qt
;
2719 result
= stat (SDATA (absname
), &st
);
2720 Vw32_get_true_file_attributes
= tem
;
2724 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2727 if (stat (SSDATA (absname
), &st
) < 0)
2729 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2733 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2734 Sfile_selinux_context
, 1, 1, 0,
2735 doc
: /* Return SELinux context of file named FILENAME,
2736 as a list ("user", "role", "type", "range"). Return (nil, nil, nil, nil)
2737 if file does not exist, is not accessible, or SELinux is disabled */)
2738 (Lisp_Object filename
)
2740 Lisp_Object absname
;
2741 Lisp_Object values
[4];
2742 Lisp_Object handler
;
2744 security_context_t con
;
2749 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2751 /* If the file name has special constructs in it,
2752 call the corresponding file handler. */
2753 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2754 if (!NILP (handler
))
2755 return call2 (handler
, Qfile_selinux_context
, absname
);
2757 absname
= ENCODE_FILE (absname
);
2764 if (is_selinux_enabled ())
2766 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2769 context
= context_new (con
);
2770 if (context_user_get (context
))
2771 values
[0] = build_string (context_user_get (context
));
2772 if (context_role_get (context
))
2773 values
[1] = build_string (context_role_get (context
));
2774 if (context_type_get (context
))
2775 values
[2] = build_string (context_type_get (context
));
2776 if (context_range_get (context
))
2777 values
[3] = build_string (context_range_get (context
));
2778 context_free (context
);
2785 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2788 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2789 Sset_file_selinux_context
, 2, 2, 0,
2790 doc
: /* Set SELinux context of file named FILENAME to CONTEXT
2791 as a list ("user", "role", "type", "range"). Has no effect if SELinux
2793 (Lisp_Object filename
, Lisp_Object context
)
2795 Lisp_Object absname
;
2796 Lisp_Object handler
;
2798 Lisp_Object encoded_absname
;
2799 Lisp_Object user
= CAR_SAFE (context
);
2800 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2801 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2802 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2803 security_context_t con
;
2804 int fail
, conlength
;
2805 context_t parsed_con
;
2808 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2810 /* If the file name has special constructs in it,
2811 call the corresponding file handler. */
2812 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2813 if (!NILP (handler
))
2814 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2817 if (is_selinux_enabled ())
2819 /* Get current file context. */
2820 encoded_absname
= ENCODE_FILE (absname
);
2821 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2824 parsed_con
= context_new (con
);
2825 /* Change the parts defined in the parameter.*/
2828 if (context_user_set (parsed_con
, SSDATA (user
)))
2829 error ("Doing context_user_set");
2833 if (context_role_set (parsed_con
, SSDATA (role
)))
2834 error ("Doing context_role_set");
2838 if (context_type_set (parsed_con
, SSDATA (type
)))
2839 error ("Doing context_type_set");
2841 if (STRINGP (range
))
2843 if (context_range_set (parsed_con
, SSDATA (range
)))
2844 error ("Doing context_range_set");
2847 /* Set the modified context back to the file. */
2848 fail
= lsetfilecon (SSDATA (encoded_absname
),
2849 context_str (parsed_con
));
2851 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
2853 context_free (parsed_con
);
2856 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
2866 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2867 doc
: /* Return mode bits of file named FILENAME, as an integer.
2868 Return nil, if file does not exist or is not accessible. */)
2869 (Lisp_Object filename
)
2871 Lisp_Object absname
;
2873 Lisp_Object handler
;
2875 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2877 /* If the file name has special constructs in it,
2878 call the corresponding file handler. */
2879 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2880 if (!NILP (handler
))
2881 return call2 (handler
, Qfile_modes
, absname
);
2883 absname
= ENCODE_FILE (absname
);
2885 if (stat (SSDATA (absname
), &st
) < 0)
2888 return make_number (st
.st_mode
& 07777);
2891 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2892 "(let ((file (read-file-name \"File: \"))) \
2893 (list file (read-file-modes nil file)))",
2894 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2895 Only the 12 low bits of MODE are used.
2897 Interactively, mode bits are read by `read-file-modes', which accepts
2898 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2899 (Lisp_Object filename
, Lisp_Object mode
)
2901 Lisp_Object absname
, encoded_absname
;
2902 Lisp_Object handler
;
2904 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2905 CHECK_NUMBER (mode
);
2907 /* If the file name has special constructs in it,
2908 call the corresponding file handler. */
2909 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2910 if (!NILP (handler
))
2911 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2913 encoded_absname
= ENCODE_FILE (absname
);
2915 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
2916 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2921 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2922 doc
: /* Set the file permission bits for newly created files.
2923 The argument MODE should be an integer; only the low 9 bits are used.
2924 This setting is inherited by subprocesses. */)
2927 CHECK_NUMBER (mode
);
2929 umask ((~ XINT (mode
)) & 0777);
2934 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
2935 doc
: /* Return the default file protection for created files.
2936 The value is an integer. */)
2942 realmask
= umask (0);
2945 XSETINT (value
, (~ realmask
) & 0777);
2950 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
2951 doc
: /* Set times of file FILENAME to TIMESTAMP.
2952 Set both access and modification times.
2953 Return t on success, else nil.
2954 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
2956 (Lisp_Object filename
, Lisp_Object timestamp
)
2958 Lisp_Object absname
, encoded_absname
;
2959 Lisp_Object handler
;
2963 if (! lisp_time_argument (timestamp
, &sec
, &usec
))
2964 error ("Invalid time specification");
2966 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2968 /* If the file name has special constructs in it,
2969 call the corresponding file handler. */
2970 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
2971 if (!NILP (handler
))
2972 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
2974 encoded_absname
= ENCODE_FILE (absname
);
2979 EMACS_SET_SECS (t
, sec
);
2980 EMACS_SET_USECS (t
, usec
);
2982 if (set_file_times (SSDATA (encoded_absname
), t
, t
))
2987 /* Setting times on a directory always fails. */
2988 if (stat (SSDATA (encoded_absname
), &st
) == 0 && S_ISDIR (st
.st_mode
))
2991 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3000 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3001 doc
: /* Tell Unix to finish all pending disk updates. */)
3008 #endif /* HAVE_SYNC */
3010 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3011 doc
: /* Return t if file FILE1 is newer than file FILE2.
3012 If FILE1 does not exist, the answer is nil;
3013 otherwise, if FILE2 does not exist, the answer is t. */)
3014 (Lisp_Object file1
, Lisp_Object file2
)
3016 Lisp_Object absname1
, absname2
;
3019 Lisp_Object handler
;
3020 struct gcpro gcpro1
, gcpro2
;
3022 CHECK_STRING (file1
);
3023 CHECK_STRING (file2
);
3026 GCPRO2 (absname1
, file2
);
3027 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3028 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3031 /* If the file name has special constructs in it,
3032 call the corresponding file handler. */
3033 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3035 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3036 if (!NILP (handler
))
3037 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3039 GCPRO2 (absname1
, absname2
);
3040 absname1
= ENCODE_FILE (absname1
);
3041 absname2
= ENCODE_FILE (absname2
);
3044 if (stat (SSDATA (absname1
), &st
) < 0)
3047 mtime1
= st
.st_mtime
;
3049 if (stat (SSDATA (absname2
), &st
) < 0)
3052 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3055 #ifndef READ_BUF_SIZE
3056 #define READ_BUF_SIZE (64 << 10)
3059 /* This function is called after Lisp functions to decide a coding
3060 system are called, or when they cause an error. Before they are
3061 called, the current buffer is set unibyte and it contains only a
3062 newly inserted text (thus the buffer was empty before the
3065 The functions may set markers, overlays, text properties, or even
3066 alter the buffer contents, change the current buffer.
3068 Here, we reset all those changes by:
3069 o set back the current buffer.
3070 o move all markers and overlays to BEG.
3071 o remove all text properties.
3072 o set back the buffer multibyteness. */
3075 decide_coding_unwind (Lisp_Object unwind_data
)
3077 Lisp_Object multibyte
, undo_list
, buffer
;
3079 multibyte
= XCAR (unwind_data
);
3080 unwind_data
= XCDR (unwind_data
);
3081 undo_list
= XCAR (unwind_data
);
3082 buffer
= XCDR (unwind_data
);
3084 if (current_buffer
!= XBUFFER (buffer
))
3085 set_buffer_internal (XBUFFER (buffer
));
3086 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3087 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3088 BUF_INTERVALS (current_buffer
) = 0;
3089 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3091 /* Now we are safe to change the buffer's multibyteness directly. */
3092 BVAR (current_buffer
, enable_multibyte_characters
) = multibyte
;
3093 BVAR (current_buffer
, undo_list
) = undo_list
;
3099 /* Used to pass values from insert-file-contents to read_non_regular. */
3101 static int non_regular_fd
;
3102 static EMACS_INT non_regular_inserted
;
3103 static EMACS_INT non_regular_nbytes
;
3106 /* Read from a non-regular file.
3107 Read non_regular_nbytes bytes max from non_regular_fd.
3108 Non_regular_inserted specifies where to put the read bytes.
3109 Value is the number of bytes read. */
3112 read_non_regular (Lisp_Object ignore
)
3118 nbytes
= emacs_read (non_regular_fd
,
3119 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3120 + non_regular_inserted
),
3121 non_regular_nbytes
);
3123 return make_number (nbytes
);
3127 /* Condition-case handler used when reading from non-regular files
3128 in insert-file-contents. */
3131 read_non_regular_quit (Lisp_Object ignore
)
3136 /* Reposition FD to OFFSET, based on WHENCE. This acts like lseek
3137 except that it also tests for OFFSET being out of lseek's range. */
3139 emacs_lseek (int fd
, EMACS_INT offset
, int whence
)
3141 /* Use "&" rather than "&&" to suppress a bogus GCC warning; see
3142 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43772>. */
3143 if (! ((TYPE_MINIMUM (off_t
) <= offset
) & (offset
<= TYPE_MAXIMUM (off_t
))))
3148 return lseek (fd
, offset
, whence
);
3152 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3154 doc
: /* Insert contents of file FILENAME after point.
3155 Returns list of absolute file name and number of characters inserted.
3156 If second argument VISIT is non-nil, the buffer's visited filename and
3157 last save file modtime are set, and it is marked unmodified. If
3158 visiting and the file does not exist, visiting is completed before the
3161 The optional third and fourth arguments BEG and END specify what portion
3162 of the file to insert. These arguments count bytes in the file, not
3163 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3165 If optional fifth argument REPLACE is non-nil, replace the current
3166 buffer contents (in the accessible portion) with the file contents.
3167 This is better than simply deleting and inserting the whole thing
3168 because (1) it preserves some marker positions and (2) it puts less data
3169 in the undo list. When REPLACE is non-nil, the second return value is
3170 the number of characters that replace previous buffer contents.
3172 This function does code conversion according to the value of
3173 `coding-system-for-read' or `file-coding-system-alist', and sets the
3174 variable `last-coding-system-used' to the coding system actually used. */)
3175 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3179 EMACS_INT inserted
= 0;
3181 register EMACS_INT how_much
;
3182 off_t beg_offset
, end_offset
;
3183 register EMACS_INT unprocessed
;
3184 int count
= SPECPDL_INDEX ();
3185 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3186 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3188 EMACS_INT total
= 0;
3189 int not_regular
= 0;
3190 char read_buf
[READ_BUF_SIZE
];
3191 struct coding_system coding
;
3192 char buffer
[1 << 14];
3193 int replace_handled
= 0;
3194 int set_coding_system
= 0;
3195 Lisp_Object coding_system
;
3197 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3198 int we_locked_file
= 0;
3199 int deferred_remove_unwind_protect
= 0;
3201 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3202 error ("Cannot do file visiting in an indirect buffer");
3204 if (!NILP (BVAR (current_buffer
, read_only
)))
3205 Fbarf_if_buffer_read_only ();
3209 orig_filename
= Qnil
;
3212 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3214 CHECK_STRING (filename
);
3215 filename
= Fexpand_file_name (filename
, Qnil
);
3217 /* The value Qnil means that the coding system is not yet
3219 coding_system
= Qnil
;
3221 /* If the file name has special constructs in it,
3222 call the corresponding file handler. */
3223 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3224 if (!NILP (handler
))
3226 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3227 visit
, beg
, end
, replace
);
3228 if (CONSP (val
) && CONSP (XCDR (val
)))
3229 inserted
= XINT (XCAR (XCDR (val
)));
3233 orig_filename
= filename
;
3234 filename
= ENCODE_FILE (filename
);
3240 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3242 /* Tell stat to use expensive method to get accurate info. */
3243 Vw32_get_true_file_attributes
= Qt
;
3244 total
= stat (SSDATA (filename
), &st
);
3245 Vw32_get_true_file_attributes
= tem
;
3249 if (stat (SSDATA (filename
), &st
) < 0)
3250 #endif /* WINDOWSNT */
3254 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3258 if (!NILP (Vcoding_system_for_read
))
3259 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3263 /* This code will need to be changed in order to work on named
3264 pipes, and it's probably just not worth it. So we should at
3265 least signal an error. */
3266 if (!S_ISREG (st
.st_mode
))
3273 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3274 xsignal2 (Qfile_error
,
3275 build_string ("not a regular file"), orig_filename
);
3279 if ((fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0)) < 0)
3282 /* Replacement should preserve point as it preserves markers. */
3283 if (!NILP (replace
))
3284 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3286 record_unwind_protect (close_file_unwind
, make_number (fd
));
3291 if (!NILP (beg
) || !NILP (end
))
3292 error ("Attempt to visit less than an entire file");
3293 if (BEG
< Z
&& NILP (replace
))
3294 error ("Cannot do file visiting in a non-empty buffer");
3299 if (! (RANGED_INTEGERP (0, beg
, TYPE_MAXIMUM (off_t
))))
3300 wrong_type_argument (intern ("file-offset"), beg
);
3301 beg_offset
= XFASTINT (beg
);
3308 if (! (RANGED_INTEGERP (0, end
, TYPE_MAXIMUM (off_t
))))
3309 wrong_type_argument (intern ("file-offset"), end
);
3310 end_offset
= XFASTINT (end
);
3315 end_offset
= TYPE_MAXIMUM (off_t
);
3318 end_offset
= st
.st_size
;
3320 /* A negative size can happen on a platform that allows file
3321 sizes greater than the maximum off_t value. */
3325 /* The file size returned from stat may be zero, but data
3326 may be readable nonetheless, for example when this is a
3327 file in the /proc filesystem. */
3328 if (end_offset
== 0)
3329 end_offset
= READ_BUF_SIZE
;
3333 /* Check now whether the buffer will become too large,
3334 in the likely case where the file's length is not changing.
3335 This saves a lot of needless work before a buffer overflow. */
3338 /* The likely offset where we will stop reading. We could read
3339 more (or less), if the file grows (or shrinks) as we read it. */
3340 off_t likely_end
= min (end_offset
, st
.st_size
);
3342 if (beg_offset
< likely_end
)
3344 ptrdiff_t buf_bytes
=
3345 Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3346 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3347 off_t likely_growth
= likely_end
- beg_offset
;
3348 if (buf_growth_max
< likely_growth
)
3353 /* Prevent redisplay optimizations. */
3354 current_buffer
->clip_changed
= 1;
3356 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3358 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3359 setup_coding_system (coding_system
, &coding
);
3360 /* Ensure we set Vlast_coding_system_used. */
3361 set_coding_system
= 1;
3365 /* Decide the coding system to use for reading the file now
3366 because we can't use an optimized method for handling
3367 `coding:' tag if the current buffer is not empty. */
3368 if (!NILP (Vcoding_system_for_read
))
3369 coding_system
= Vcoding_system_for_read
;
3372 /* Don't try looking inside a file for a coding system
3373 specification if it is not seekable. */
3374 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3376 /* Find a coding system specified in the heading two
3377 lines or in the tailing several lines of the file.
3378 We assume that the 1K-byte and 3K-byte for heading
3379 and tailing respectively are sufficient for this
3383 if (st
.st_size
<= (1024 * 4))
3384 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3387 nread
= emacs_read (fd
, read_buf
, 1024);
3390 if (lseek (fd
, st
.st_size
- (1024 * 3), SEEK_SET
) < 0)
3391 report_file_error ("Setting file position",
3392 Fcons (orig_filename
, Qnil
));
3393 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3398 error ("IO error reading %s: %s",
3399 SDATA (orig_filename
), emacs_strerror (errno
));
3402 struct buffer
*prev
= current_buffer
;
3403 Lisp_Object workbuf
;
3406 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3408 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3409 buf
= XBUFFER (workbuf
);
3411 delete_all_overlays (buf
);
3412 BVAR (buf
, directory
) = BVAR (current_buffer
, directory
);
3413 BVAR (buf
, read_only
) = Qnil
;
3414 BVAR (buf
, filename
) = Qnil
;
3415 BVAR (buf
, undo_list
) = Qt
;
3416 eassert (buf
->overlays_before
== NULL
);
3417 eassert (buf
->overlays_after
== NULL
);
3419 set_buffer_internal (buf
);
3421 BVAR (buf
, enable_multibyte_characters
) = Qnil
;
3423 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3424 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3425 coding_system
= call2 (Vset_auto_coding_function
,
3426 filename
, make_number (nread
));
3427 set_buffer_internal (prev
);
3429 /* Discard the unwind protect for recovering the
3433 /* Rewind the file for the actual read done later. */
3434 if (lseek (fd
, 0, SEEK_SET
) < 0)
3435 report_file_error ("Setting file position",
3436 Fcons (orig_filename
, Qnil
));
3440 if (NILP (coding_system
))
3442 /* If we have not yet decided a coding system, check
3443 file-coding-system-alist. */
3444 Lisp_Object args
[6];
3446 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3447 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3448 coding_system
= Ffind_operation_coding_system (6, args
);
3449 if (CONSP (coding_system
))
3450 coding_system
= XCAR (coding_system
);
3454 if (NILP (coding_system
))
3455 coding_system
= Qundecided
;
3457 CHECK_CODING_SYSTEM (coding_system
);
3459 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3460 /* We must suppress all character code conversion except for
3461 end-of-line conversion. */
3462 coding_system
= raw_text_coding_system (coding_system
);
3464 setup_coding_system (coding_system
, &coding
);
3465 /* Ensure we set Vlast_coding_system_used. */
3466 set_coding_system
= 1;
3469 /* If requested, replace the accessible part of the buffer
3470 with the file contents. Avoid replacing text at the
3471 beginning or end of the buffer that matches the file contents;
3472 that preserves markers pointing to the unchanged parts.
3474 Here we implement this feature in an optimized way
3475 for the case where code conversion is NOT needed.
3476 The following if-statement handles the case of conversion
3477 in a less optimal way.
3479 If the code conversion is "automatic" then we try using this
3480 method and hope for the best.
3481 But if we discover the need for conversion, we give up on this method
3482 and let the following if-statement handle the replace job. */
3485 && (NILP (coding_system
)
3486 || ! CODING_REQUIRE_DECODING (&coding
)))
3488 /* same_at_start and same_at_end count bytes,
3489 because file access counts bytes
3490 and BEG and END count bytes. */
3491 EMACS_INT same_at_start
= BEGV_BYTE
;
3492 EMACS_INT same_at_end
= ZV_BYTE
;
3494 /* There is still a possibility we will find the need to do code
3495 conversion. If that happens, we set this variable to 1 to
3496 give up on handling REPLACE in the optimized way. */
3497 int giveup_match_end
= 0;
3499 if (beg_offset
!= 0)
3501 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3502 report_file_error ("Setting file position",
3503 Fcons (orig_filename
, Qnil
));
3508 /* Count how many chars at the start of the file
3509 match the text at the beginning of the buffer. */
3512 EMACS_INT nread
, bufpos
;
3514 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3516 error ("IO error reading %s: %s",
3517 SSDATA (orig_filename
), emacs_strerror (errno
));
3518 else if (nread
== 0)
3521 if (CODING_REQUIRE_DETECTION (&coding
))
3523 coding_system
= detect_coding_system ((unsigned char *) buffer
,
3526 setup_coding_system (coding_system
, &coding
);
3529 if (CODING_REQUIRE_DECODING (&coding
))
3530 /* We found that the file should be decoded somehow.
3531 Let's give up here. */
3533 giveup_match_end
= 1;
3538 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3539 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3540 same_at_start
++, bufpos
++;
3541 /* If we found a discrepancy, stop the scan.
3542 Otherwise loop around and scan the next bufferful. */
3543 if (bufpos
!= nread
)
3547 /* If the file matches the buffer completely,
3548 there's no need to replace anything. */
3549 if (same_at_start
- BEGV_BYTE
== end_offset
)
3553 /* Truncate the buffer to the size of the file. */
3554 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3559 /* Count how many chars at the end of the file
3560 match the text at the end of the buffer. But, if we have
3561 already found that decoding is necessary, don't waste time. */
3562 while (!giveup_match_end
)
3564 int total_read
, nread
, bufpos
, trial
;
3567 /* At what file position are we now scanning? */
3568 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3569 /* If the entire file matches the buffer tail, stop the scan. */
3572 /* How much can we scan in the next step? */
3573 trial
= min (curpos
, sizeof buffer
);
3574 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3575 report_file_error ("Setting file position",
3576 Fcons (orig_filename
, Qnil
));
3578 total_read
= nread
= 0;
3579 while (total_read
< trial
)
3581 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3583 error ("IO error reading %s: %s",
3584 SDATA (orig_filename
), emacs_strerror (errno
));
3585 else if (nread
== 0)
3587 total_read
+= nread
;
3590 /* Scan this bufferful from the end, comparing with
3591 the Emacs buffer. */
3592 bufpos
= total_read
;
3594 /* Compare with same_at_start to avoid counting some buffer text
3595 as matching both at the file's beginning and at the end. */
3596 while (bufpos
> 0 && same_at_end
> same_at_start
3597 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3598 same_at_end
--, bufpos
--;
3600 /* If we found a discrepancy, stop the scan.
3601 Otherwise loop around and scan the preceding bufferful. */
3604 /* If this discrepancy is because of code conversion,
3605 we cannot use this method; giveup and try the other. */
3606 if (same_at_end
> same_at_start
3607 && FETCH_BYTE (same_at_end
- 1) >= 0200
3608 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3609 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3610 giveup_match_end
= 1;
3619 if (! giveup_match_end
)
3623 /* We win! We can handle REPLACE the optimized way. */
3625 /* Extend the start of non-matching text area to multibyte
3626 character boundary. */
3627 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3628 while (same_at_start
> BEGV_BYTE
3629 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3632 /* Extend the end of non-matching text area to multibyte
3633 character boundary. */
3634 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3635 while (same_at_end
< ZV_BYTE
3636 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3639 /* Don't try to reuse the same piece of text twice. */
3640 overlap
= (same_at_start
- BEGV_BYTE
3642 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3644 same_at_end
+= overlap
;
3646 /* Arrange to read only the nonmatching middle part of the file. */
3647 beg_offset
+= same_at_start
- BEGV_BYTE
;
3648 end_offset
-= ZV_BYTE
- same_at_end
;
3650 del_range_byte (same_at_start
, same_at_end
, 0);
3651 /* Insert from the file at the proper position. */
3652 temp
= BYTE_TO_CHAR (same_at_start
);
3653 SET_PT_BOTH (temp
, same_at_start
);
3655 /* If display currently starts at beginning of line,
3656 keep it that way. */
3657 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3658 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3660 replace_handled
= 1;
3664 /* If requested, replace the accessible part of the buffer
3665 with the file contents. Avoid replacing text at the
3666 beginning or end of the buffer that matches the file contents;
3667 that preserves markers pointing to the unchanged parts.
3669 Here we implement this feature for the case where code conversion
3670 is needed, in a simple way that needs a lot of memory.
3671 The preceding if-statement handles the case of no conversion
3672 in a more optimized way. */
3673 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3675 EMACS_INT same_at_start
= BEGV_BYTE
;
3676 EMACS_INT same_at_end
= ZV_BYTE
;
3677 EMACS_INT same_at_start_charpos
;
3678 EMACS_INT inserted_chars
;
3681 unsigned char *decoded
;
3684 int this_count
= SPECPDL_INDEX ();
3685 int multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3686 Lisp_Object conversion_buffer
;
3688 conversion_buffer
= code_conversion_save (1, multibyte
);
3690 /* First read the whole file, performing code conversion into
3691 CONVERSION_BUFFER. */
3693 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3694 report_file_error ("Setting file position",
3695 Fcons (orig_filename
, Qnil
));
3697 total
= st
.st_size
; /* Total bytes in the file. */
3698 how_much
= 0; /* Bytes read from file so far. */
3699 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3700 unprocessed
= 0; /* Bytes not processed in previous loop. */
3702 GCPRO1 (conversion_buffer
);
3703 while (how_much
< total
)
3705 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3706 quitting while reading a huge while. */
3707 /* try is reserved in some compilers (Microsoft C) */
3708 EMACS_INT trytry
= min (total
- how_much
,
3709 READ_BUF_SIZE
- unprocessed
);
3711 /* Allow quitting out of the actual I/O. */
3714 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3722 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3723 BUF_Z (XBUFFER (conversion_buffer
)));
3724 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3725 unprocessed
+ this, conversion_buffer
);
3726 unprocessed
= coding
.carryover_bytes
;
3727 if (coding
.carryover_bytes
> 0)
3728 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3733 /* We should remove the unwind_protect calling
3734 close_file_unwind, but other stuff has been added the stack,
3735 so defer the removal till we reach the `handled' label. */
3736 deferred_remove_unwind_protect
= 1;
3738 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3739 if we couldn't read the file. */
3742 error ("IO error reading %s: %s",
3743 SDATA (orig_filename
), emacs_strerror (errno
));
3745 if (unprocessed
> 0)
3747 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3748 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3749 unprocessed
, conversion_buffer
);
3750 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3753 coding_system
= CODING_ID_NAME (coding
.id
);
3754 set_coding_system
= 1;
3755 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3756 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3757 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3759 /* Compare the beginning of the converted string with the buffer
3763 while (bufpos
< inserted
&& same_at_start
< same_at_end
3764 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3765 same_at_start
++, bufpos
++;
3767 /* If the file matches the head of buffer completely,
3768 there's no need to replace anything. */
3770 if (bufpos
== inserted
)
3772 /* Truncate the buffer to the size of the file. */
3773 if (same_at_start
== same_at_end
)
3776 del_range_byte (same_at_start
, same_at_end
, 0);
3779 unbind_to (this_count
, Qnil
);
3783 /* Extend the start of non-matching text area to the previous
3784 multibyte character boundary. */
3785 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3786 while (same_at_start
> BEGV_BYTE
3787 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3790 /* Scan this bufferful from the end, comparing with
3791 the Emacs buffer. */
3794 /* Compare with same_at_start to avoid counting some buffer text
3795 as matching both at the file's beginning and at the end. */
3796 while (bufpos
> 0 && same_at_end
> same_at_start
3797 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3798 same_at_end
--, bufpos
--;
3800 /* Extend the end of non-matching text area to the next
3801 multibyte character boundary. */
3802 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3803 while (same_at_end
< ZV_BYTE
3804 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3807 /* Don't try to reuse the same piece of text twice. */
3808 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3810 same_at_end
+= overlap
;
3812 /* If display currently starts at beginning of line,
3813 keep it that way. */
3814 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3815 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3817 /* Replace the chars that we need to replace,
3818 and update INSERTED to equal the number of bytes
3819 we are taking from the decoded string. */
3820 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3822 if (same_at_end
!= same_at_start
)
3824 del_range_byte (same_at_start
, same_at_end
, 0);
3826 same_at_start
= GPT_BYTE
;
3830 temp
= BYTE_TO_CHAR (same_at_start
);
3832 /* Insert from the file at the proper position. */
3833 SET_PT_BOTH (temp
, same_at_start
);
3834 same_at_start_charpos
3835 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3836 same_at_start
- BEGV_BYTE
3837 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3839 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3840 same_at_start
+ inserted
- BEGV_BYTE
3841 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3842 - same_at_start_charpos
);
3843 /* This binding is to avoid ask-user-about-supersession-threat
3844 being called in insert_from_buffer (via in
3845 prepare_to_modify_buffer). */
3846 specbind (intern ("buffer-file-name"), Qnil
);
3847 insert_from_buffer (XBUFFER (conversion_buffer
),
3848 same_at_start_charpos
, inserted_chars
, 0);
3849 /* Set `inserted' to the number of inserted characters. */
3850 inserted
= PT
- temp
;
3851 /* Set point before the inserted characters. */
3852 SET_PT_BOTH (temp
, same_at_start
);
3854 unbind_to (this_count
, Qnil
);
3860 total
= end_offset
- beg_offset
;
3862 /* For a special file, all we can do is guess. */
3863 total
= READ_BUF_SIZE
;
3865 if (NILP (visit
) && total
> 0)
3867 #ifdef CLASH_DETECTION
3868 if (!NILP (BVAR (current_buffer
, file_truename
))
3869 /* Make binding buffer-file-name to nil effective. */
3870 && !NILP (BVAR (current_buffer
, filename
))
3871 && SAVE_MODIFF
>= MODIFF
)
3873 #endif /* CLASH_DETECTION */
3874 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3878 if (GAP_SIZE
< total
)
3879 make_gap (total
- GAP_SIZE
);
3881 if (beg_offset
!= 0 || !NILP (replace
))
3883 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3884 report_file_error ("Setting file position",
3885 Fcons (orig_filename
, Qnil
));
3888 /* In the following loop, HOW_MUCH contains the total bytes read so
3889 far for a regular file, and not changed for a special file. But,
3890 before exiting the loop, it is set to a negative value if I/O
3894 /* Total bytes inserted. */
3897 /* Here, we don't do code conversion in the loop. It is done by
3898 decode_coding_gap after all data are read into the buffer. */
3900 EMACS_INT gap_size
= GAP_SIZE
;
3902 while (how_much
< total
)
3904 /* try is reserved in some compilers (Microsoft C) */
3905 EMACS_INT trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3912 /* Maybe make more room. */
3913 if (gap_size
< trytry
)
3915 make_gap (total
- gap_size
);
3916 gap_size
= GAP_SIZE
;
3919 /* Read from the file, capturing `quit'. When an
3920 error occurs, end the loop, and arrange for a quit
3921 to be signaled after decoding the text we read. */
3922 non_regular_fd
= fd
;
3923 non_regular_inserted
= inserted
;
3924 non_regular_nbytes
= trytry
;
3925 nbytes
= internal_condition_case_1 (read_non_regular
,
3927 read_non_regular_quit
);
3934 this = XINT (nbytes
);
3938 /* Allow quitting out of the actual I/O. We don't make text
3939 part of the buffer until all the reading is done, so a C-g
3940 here doesn't do any harm. */
3943 this = emacs_read (fd
,
3944 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3958 /* For a regular file, where TOTAL is the real size,
3959 count HOW_MUCH to compare with it.
3960 For a special file, where TOTAL is just a buffer size,
3961 so don't bother counting in HOW_MUCH.
3962 (INSERTED is where we count the number of characters inserted.) */
3969 /* Now we have read all the file data into the gap.
3970 If it was empty, undo marking the buffer modified. */
3974 #ifdef CLASH_DETECTION
3976 unlock_file (BVAR (current_buffer
, file_truename
));
3978 Vdeactivate_mark
= old_Vdeactivate_mark
;
3981 Vdeactivate_mark
= Qt
;
3983 /* Make the text read part of the buffer. */
3984 GAP_SIZE
-= inserted
;
3986 GPT_BYTE
+= inserted
;
3988 ZV_BYTE
+= inserted
;
3993 /* Put an anchor to ensure multi-byte form ends at gap. */
3998 /* Discard the unwind protect for closing the file. */
4002 error ("IO error reading %s: %s",
4003 SDATA (orig_filename
), emacs_strerror (errno
));
4007 if (NILP (coding_system
))
4009 /* The coding system is not yet decided. Decide it by an
4010 optimized method for handling `coding:' tag.
4012 Note that we can get here only if the buffer was empty
4013 before the insertion. */
4015 if (!NILP (Vcoding_system_for_read
))
4016 coding_system
= Vcoding_system_for_read
;
4019 /* Since we are sure that the current buffer was empty
4020 before the insertion, we can toggle
4021 enable-multibyte-characters directly here without taking
4022 care of marker adjustment. By this way, we can run Lisp
4023 program safely before decoding the inserted text. */
4024 Lisp_Object unwind_data
;
4025 int count1
= SPECPDL_INDEX ();
4027 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4028 Fcons (BVAR (current_buffer
, undo_list
),
4029 Fcurrent_buffer ()));
4030 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
4031 BVAR (current_buffer
, undo_list
) = Qt
;
4032 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4034 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4036 coding_system
= call2 (Vset_auto_coding_function
,
4037 filename
, make_number (inserted
));
4040 if (NILP (coding_system
))
4042 /* If the coding system is not yet decided, check
4043 file-coding-system-alist. */
4044 Lisp_Object args
[6];
4046 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4047 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4048 coding_system
= Ffind_operation_coding_system (6, args
);
4049 if (CONSP (coding_system
))
4050 coding_system
= XCAR (coding_system
);
4052 unbind_to (count1
, Qnil
);
4053 inserted
= Z_BYTE
- BEG_BYTE
;
4056 if (NILP (coding_system
))
4057 coding_system
= Qundecided
;
4059 CHECK_CODING_SYSTEM (coding_system
);
4061 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4062 /* We must suppress all character code conversion except for
4063 end-of-line conversion. */
4064 coding_system
= raw_text_coding_system (coding_system
);
4065 setup_coding_system (coding_system
, &coding
);
4066 /* Ensure we set Vlast_coding_system_used. */
4067 set_coding_system
= 1;
4072 /* When we visit a file by raw-text, we change the buffer to
4074 if (CODING_FOR_UNIBYTE (&coding
)
4075 /* Can't do this if part of the buffer might be preserved. */
4077 /* Visiting a file with these coding system makes the buffer
4079 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
4082 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4083 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4084 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4086 move_gap_both (PT
, PT_BYTE
);
4087 GAP_SIZE
+= inserted
;
4088 ZV_BYTE
-= inserted
;
4092 decode_coding_gap (&coding
, inserted
, inserted
);
4093 inserted
= coding
.produced_char
;
4094 coding_system
= CODING_ID_NAME (coding
.id
);
4096 else if (inserted
> 0)
4097 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4100 /* Now INSERTED is measured in characters. */
4104 if (deferred_remove_unwind_protect
)
4105 /* If requested above, discard the unwind protect for closing the
4111 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4112 BVAR (current_buffer
, undo_list
) = Qnil
;
4116 current_buffer
->modtime
= st
.st_mtime
;
4117 current_buffer
->modtime_size
= st
.st_size
;
4118 BVAR (current_buffer
, filename
) = orig_filename
;
4121 SAVE_MODIFF
= MODIFF
;
4122 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4123 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4124 #ifdef CLASH_DETECTION
4127 if (!NILP (BVAR (current_buffer
, file_truename
)))
4128 unlock_file (BVAR (current_buffer
, file_truename
));
4129 unlock_file (filename
);
4131 #endif /* CLASH_DETECTION */
4133 xsignal2 (Qfile_error
,
4134 build_string ("not a regular file"), orig_filename
);
4137 if (set_coding_system
)
4138 Vlast_coding_system_used
= coding_system
;
4140 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4142 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4144 if (! NILP (insval
))
4146 CHECK_NUMBER (insval
);
4147 inserted
= XFASTINT (insval
);
4151 /* Decode file format. */
4154 /* Don't run point motion or modification hooks when decoding. */
4155 int count1
= SPECPDL_INDEX ();
4156 EMACS_INT old_inserted
= inserted
;
4157 specbind (Qinhibit_point_motion_hooks
, Qt
);
4158 specbind (Qinhibit_modification_hooks
, Qt
);
4160 /* Save old undo list and don't record undo for decoding. */
4161 old_undo
= BVAR (current_buffer
, undo_list
);
4162 BVAR (current_buffer
, undo_list
) = Qt
;
4166 insval
= call3 (Qformat_decode
,
4167 Qnil
, make_number (inserted
), visit
);
4168 CHECK_NUMBER (insval
);
4169 inserted
= XFASTINT (insval
);
4173 /* If REPLACE is non-nil and we succeeded in not replacing the
4174 beginning or end of the buffer text with the file's contents,
4175 call format-decode with `point' positioned at the beginning
4176 of the buffer and `inserted' equalling the number of
4177 characters in the buffer. Otherwise, format-decode might
4178 fail to correctly analyze the beginning or end of the buffer.
4179 Hence we temporarily save `point' and `inserted' here and
4180 restore `point' iff format-decode did not insert or delete
4181 any text. Otherwise we leave `point' at point-min. */
4182 EMACS_INT opoint
= PT
;
4183 EMACS_INT opoint_byte
= PT_BYTE
;
4184 EMACS_INT oinserted
= ZV
- BEGV
;
4185 int ochars_modiff
= CHARS_MODIFF
;
4187 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4188 insval
= call3 (Qformat_decode
,
4189 Qnil
, make_number (oinserted
), visit
);
4190 CHECK_NUMBER (insval
);
4191 if (ochars_modiff
== CHARS_MODIFF
)
4192 /* format_decode didn't modify buffer's characters => move
4193 point back to position before inserted text and leave
4194 value of inserted alone. */
4195 SET_PT_BOTH (opoint
, opoint_byte
);
4197 /* format_decode modified buffer's characters => consider
4198 entire buffer changed and leave point at point-min. */
4199 inserted
= XFASTINT (insval
);
4202 /* For consistency with format-decode call these now iff inserted > 0
4203 (martin 2007-06-28). */
4204 p
= Vafter_insert_file_functions
;
4209 insval
= call1 (XCAR (p
), make_number (inserted
));
4212 CHECK_NUMBER (insval
);
4213 inserted
= XFASTINT (insval
);
4218 /* For the rationale of this see the comment on
4219 format-decode above. */
4220 EMACS_INT opoint
= PT
;
4221 EMACS_INT opoint_byte
= PT_BYTE
;
4222 EMACS_INT oinserted
= ZV
- BEGV
;
4223 int ochars_modiff
= CHARS_MODIFF
;
4225 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4226 insval
= call1 (XCAR (p
), make_number (oinserted
));
4229 CHECK_NUMBER (insval
);
4230 if (ochars_modiff
== CHARS_MODIFF
)
4231 /* after_insert_file_functions didn't modify
4232 buffer's characters => move point back to
4233 position before inserted text and leave value of
4235 SET_PT_BOTH (opoint
, opoint_byte
);
4237 /* after_insert_file_functions did modify buffer's
4238 characters => consider entire buffer changed and
4239 leave point at point-min. */
4240 inserted
= XFASTINT (insval
);
4250 BVAR (current_buffer
, undo_list
) = old_undo
;
4251 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4253 /* Adjust the last undo record for the size change during
4254 the format conversion. */
4255 Lisp_Object tem
= XCAR (old_undo
);
4256 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4257 && INTEGERP (XCDR (tem
))
4258 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4259 XSETCDR (tem
, make_number (PT
+ inserted
));
4263 /* If undo_list was Qt before, keep it that way.
4264 Otherwise start with an empty undo_list. */
4265 BVAR (current_buffer
, undo_list
) = EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4267 unbind_to (count1
, Qnil
);
4270 /* Call after-change hooks for the inserted text, aside from the case
4271 of normal visiting (not with REPLACE), which is done in a new buffer
4272 "before" the buffer is changed. */
4273 if (inserted
> 0 && total
> 0
4274 && (NILP (visit
) || !NILP (replace
)))
4276 signal_after_change (PT
, 0, inserted
);
4277 update_compositions (PT
, PT
, CHECK_BORDER
);
4281 && current_buffer
->modtime
== -1)
4283 /* If visiting nonexistent file, return nil. */
4284 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4288 Fsignal (Qquit
, Qnil
);
4290 /* ??? Retval needs to be dealt with in all cases consistently. */
4292 val
= Fcons (orig_filename
,
4293 Fcons (make_number (inserted
),
4296 RETURN_UNGCPRO (unbind_to (count
, val
));
4299 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4302 build_annotations_unwind (Lisp_Object arg
)
4304 Vwrite_region_annotation_buffers
= arg
;
4308 /* Decide the coding-system to encode the data with. */
4311 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4312 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4313 struct coding_system
*coding
)
4316 Lisp_Object eol_parent
= Qnil
;
4319 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4320 BVAR (current_buffer
, auto_save_file_name
))))
4325 else if (!NILP (Vcoding_system_for_write
))
4327 val
= Vcoding_system_for_write
;
4328 if (coding_system_require_warning
4329 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4330 /* Confirm that VAL can surely encode the current region. */
4331 val
= call5 (Vselect_safe_coding_system_function
,
4332 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4337 /* If the variable `buffer-file-coding-system' is set locally,
4338 it means that the file was read with some kind of code
4339 conversion or the variable is explicitly set by users. We
4340 had better write it out with the same coding system even if
4341 `enable-multibyte-characters' is nil.
4343 If it is not set locally, we anyway have to convert EOL
4344 format if the default value of `buffer-file-coding-system'
4345 tells that it is not Unix-like (LF only) format. */
4346 int using_default_coding
= 0;
4347 int force_raw_text
= 0;
4349 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4351 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4354 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4360 /* Check file-coding-system-alist. */
4361 Lisp_Object args
[7], coding_systems
;
4363 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4364 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4366 coding_systems
= Ffind_operation_coding_system (7, args
);
4367 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4368 val
= XCDR (coding_systems
);
4373 /* If we still have not decided a coding system, use the
4374 default value of buffer-file-coding-system. */
4375 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4376 using_default_coding
= 1;
4379 if (! NILP (val
) && ! force_raw_text
)
4381 Lisp_Object spec
, attrs
;
4383 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4384 attrs
= AREF (spec
, 0);
4385 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4390 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4391 /* Confirm that VAL can surely encode the current region. */
4392 val
= call5 (Vselect_safe_coding_system_function
,
4393 start
, end
, val
, Qnil
, filename
);
4395 /* If the decided coding-system doesn't specify end-of-line
4396 format, we use that of
4397 `default-buffer-file-coding-system'. */
4398 if (! using_default_coding
4399 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4400 val
= (coding_inherit_eol_type
4401 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4403 /* If we decide not to encode text, use `raw-text' or one of its
4406 val
= raw_text_coding_system (val
);
4409 val
= coding_inherit_eol_type (val
, eol_parent
);
4410 setup_coding_system (val
, coding
);
4412 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4413 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4417 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4418 "r\nFWrite region to file: \ni\ni\ni\np",
4419 doc
: /* Write current region into specified file.
4420 When called from a program, requires three arguments:
4421 START, END and FILENAME. START and END are normally buffer positions
4422 specifying the part of the buffer to write.
4423 If START is nil, that means to use the entire buffer contents.
4424 If START is a string, then output that string to the file
4425 instead of any buffer contents; END is ignored.
4427 Optional fourth argument APPEND if non-nil means
4428 append to existing file contents (if any). If it is an integer,
4429 seek to that offset in the file before writing.
4430 Optional fifth argument VISIT, if t or a string, means
4431 set the last-save-file-modtime of buffer to this file's modtime
4432 and mark buffer not modified.
4433 If VISIT is a string, it is a second file name;
4434 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4435 VISIT is also the file name to lock and unlock for clash detection.
4436 If VISIT is neither t nor nil nor a string,
4437 that means do not display the \"Wrote file\" message.
4438 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4439 use for locking and unlocking, overriding FILENAME and VISIT.
4440 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4441 for an existing file with the same name. If MUSTBENEW is `excl',
4442 that means to get an error if the file already exists; never overwrite.
4443 If MUSTBENEW is neither nil nor `excl', that means ask for
4444 confirmation before overwriting, but do go ahead and overwrite the file
4445 if the user confirms.
4447 This does code conversion according to the value of
4448 `coding-system-for-write', `buffer-file-coding-system', or
4449 `file-coding-system-alist', and sets the variable
4450 `last-coding-system-used' to the coding system actually used.
4452 This calls `write-region-annotate-functions' at the start, and
4453 `write-region-post-annotation-function' at the end. */)
4454 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4461 int count
= SPECPDL_INDEX ();
4463 Lisp_Object handler
;
4464 Lisp_Object visit_file
;
4465 Lisp_Object annotations
;
4466 Lisp_Object encoded_filename
;
4467 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4468 int quietly
= !NILP (visit
);
4469 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4470 struct buffer
*given_buffer
;
4471 struct coding_system coding
;
4473 if (current_buffer
->base_buffer
&& visiting
)
4474 error ("Cannot do file visiting in an indirect buffer");
4476 if (!NILP (start
) && !STRINGP (start
))
4477 validate_region (&start
, &end
);
4480 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4482 filename
= Fexpand_file_name (filename
, Qnil
);
4484 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4485 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4487 if (STRINGP (visit
))
4488 visit_file
= Fexpand_file_name (visit
, Qnil
);
4490 visit_file
= filename
;
4492 if (NILP (lockname
))
4493 lockname
= visit_file
;
4497 /* If the file name has special constructs in it,
4498 call the corresponding file handler. */
4499 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4500 /* If FILENAME has no handler, see if VISIT has one. */
4501 if (NILP (handler
) && STRINGP (visit
))
4502 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4504 if (!NILP (handler
))
4507 val
= call6 (handler
, Qwrite_region
, start
, end
,
4508 filename
, append
, visit
);
4512 SAVE_MODIFF
= MODIFF
;
4513 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4514 BVAR (current_buffer
, filename
) = visit_file
;
4520 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4522 /* Special kludge to simplify auto-saving. */
4525 /* Do it later, so write-region-annotate-function can work differently
4526 if we save "the buffer" vs "a region".
4527 This is useful in tar-mode. --Stef
4528 XSETFASTINT (start, BEG);
4529 XSETFASTINT (end, Z); */
4533 record_unwind_protect (build_annotations_unwind
,
4534 Vwrite_region_annotation_buffers
);
4535 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4536 count1
= SPECPDL_INDEX ();
4538 given_buffer
= current_buffer
;
4540 if (!STRINGP (start
))
4542 annotations
= build_annotations (start
, end
);
4544 if (current_buffer
!= given_buffer
)
4546 XSETFASTINT (start
, BEGV
);
4547 XSETFASTINT (end
, ZV
);
4553 XSETFASTINT (start
, BEGV
);
4554 XSETFASTINT (end
, ZV
);
4559 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4561 /* Decide the coding-system to encode the data with.
4562 We used to make this choice before calling build_annotations, but that
4563 leads to problems when a write-annotate-function takes care of
4564 unsavable chars (as was the case with X-Symbol). */
4565 Vlast_coding_system_used
4566 = choose_write_coding_system (start
, end
, filename
,
4567 append
, visit
, lockname
, &coding
);
4569 #ifdef CLASH_DETECTION
4571 lock_file (lockname
);
4572 #endif /* CLASH_DETECTION */
4574 encoded_filename
= ENCODE_FILE (filename
);
4576 fn
= SSDATA (encoded_filename
);
4580 desc
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4581 #else /* not DOS_NT */
4582 desc
= emacs_open (fn
, O_WRONLY
, 0);
4583 #endif /* not DOS_NT */
4585 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4587 desc
= emacs_open (fn
,
4588 O_WRONLY
| O_CREAT
| O_BINARY
4589 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4590 S_IREAD
| S_IWRITE
);
4591 #else /* not DOS_NT */
4592 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4593 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4594 auto_saving
? auto_save_mode_bits
: 0666);
4595 #endif /* not DOS_NT */
4599 #ifdef CLASH_DETECTION
4601 if (!auto_saving
) unlock_file (lockname
);
4603 #endif /* CLASH_DETECTION */
4605 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4608 record_unwind_protect (close_file_unwind
, make_number (desc
));
4610 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4614 if (NUMBERP (append
))
4615 ret
= emacs_lseek (desc
, XINT (append
), SEEK_CUR
);
4617 ret
= lseek (desc
, 0, SEEK_END
);
4620 #ifdef CLASH_DETECTION
4621 if (!auto_saving
) unlock_file (lockname
);
4622 #endif /* CLASH_DETECTION */
4624 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4633 if (STRINGP (start
))
4635 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4636 &annotations
, &coding
);
4639 else if (XINT (start
) != XINT (end
))
4641 failure
= 0 > a_write (desc
, Qnil
,
4642 XINT (start
), XINT (end
) - XINT (start
),
4643 &annotations
, &coding
);
4648 /* If file was empty, still need to write the annotations */
4649 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4650 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4654 if (CODING_REQUIRE_FLUSHING (&coding
)
4655 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4658 /* We have to flush out a data. */
4659 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4660 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4667 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4668 Disk full in NFS may be reported here. */
4669 /* mib says that closing the file will try to write as fast as NFS can do
4670 it, and that means the fsync here is not crucial for autosave files. */
4671 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4673 /* If fsync fails with EINTR, don't treat that as serious. Also
4674 ignore EINVAL which happens when fsync is not supported on this
4676 if (errno
!= EINTR
&& errno
!= EINVAL
)
4677 failure
= 1, save_errno
= errno
;
4681 /* NFS can report a write failure now. */
4682 if (emacs_close (desc
) < 0)
4683 failure
= 1, save_errno
= errno
;
4687 /* Discard the unwind protect for close_file_unwind. */
4688 specpdl_ptr
= specpdl
+ count1
;
4690 /* Call write-region-post-annotation-function. */
4691 while (CONSP (Vwrite_region_annotation_buffers
))
4693 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4694 if (!NILP (Fbuffer_live_p (buf
)))
4697 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4698 call0 (Vwrite_region_post_annotation_function
);
4700 Vwrite_region_annotation_buffers
4701 = XCDR (Vwrite_region_annotation_buffers
);
4704 unbind_to (count
, Qnil
);
4706 #ifdef CLASH_DETECTION
4708 unlock_file (lockname
);
4709 #endif /* CLASH_DETECTION */
4711 /* Do this before reporting IO error
4712 to avoid a "file has changed on disk" warning on
4713 next attempt to save. */
4716 current_buffer
->modtime
= st
.st_mtime
;
4717 current_buffer
->modtime_size
= st
.st_size
;
4721 error ("IO error writing %s: %s", SDATA (filename
),
4722 emacs_strerror (save_errno
));
4726 SAVE_MODIFF
= MODIFF
;
4727 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4728 BVAR (current_buffer
, filename
) = visit_file
;
4729 update_mode_lines
++;
4734 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4735 BVAR (current_buffer
, auto_save_file_name
))))
4736 SAVE_MODIFF
= MODIFF
;
4742 message_with_string ((INTEGERP (append
)
4752 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4754 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4755 doc
: /* Return t if (car A) is numerically less than (car B). */)
4756 (Lisp_Object a
, Lisp_Object b
)
4758 return Flss (Fcar (a
), Fcar (b
));
4761 /* Build the complete list of annotations appropriate for writing out
4762 the text between START and END, by calling all the functions in
4763 write-region-annotate-functions and merging the lists they return.
4764 If one of these functions switches to a different buffer, we assume
4765 that buffer contains altered text. Therefore, the caller must
4766 make sure to restore the current buffer in all cases,
4767 as save-excursion would do. */
4770 build_annotations (Lisp_Object start
, Lisp_Object end
)
4772 Lisp_Object annotations
;
4774 struct gcpro gcpro1
, gcpro2
;
4775 Lisp_Object original_buffer
;
4776 int i
, used_global
= 0;
4778 XSETBUFFER (original_buffer
, current_buffer
);
4781 p
= Vwrite_region_annotate_functions
;
4782 GCPRO2 (annotations
, p
);
4785 struct buffer
*given_buffer
= current_buffer
;
4786 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4787 { /* Use the global value of the hook. */
4790 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4792 p
= Fappend (2, arg
);
4795 Vwrite_region_annotations_so_far
= annotations
;
4796 res
= call2 (XCAR (p
), start
, end
);
4797 /* If the function makes a different buffer current,
4798 assume that means this buffer contains altered text to be output.
4799 Reset START and END from the buffer bounds
4800 and discard all previous annotations because they should have
4801 been dealt with by this function. */
4802 if (current_buffer
!= given_buffer
)
4804 Vwrite_region_annotation_buffers
4805 = Fcons (Fcurrent_buffer (),
4806 Vwrite_region_annotation_buffers
);
4807 XSETFASTINT (start
, BEGV
);
4808 XSETFASTINT (end
, ZV
);
4811 Flength (res
); /* Check basic validity of return value */
4812 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4816 /* Now do the same for annotation functions implied by the file-format */
4817 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
4818 p
= BVAR (current_buffer
, auto_save_file_format
);
4820 p
= BVAR (current_buffer
, file_format
);
4821 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4823 struct buffer
*given_buffer
= current_buffer
;
4825 Vwrite_region_annotations_so_far
= annotations
;
4827 /* Value is either a list of annotations or nil if the function
4828 has written annotations to a temporary buffer, which is now
4830 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4831 original_buffer
, make_number (i
));
4832 if (current_buffer
!= given_buffer
)
4834 XSETFASTINT (start
, BEGV
);
4835 XSETFASTINT (end
, ZV
);
4840 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4848 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4849 If STRING is nil, POS is the character position in the current buffer.
4850 Intersperse with them the annotations from *ANNOT
4851 which fall within the range of POS to POS + NCHARS,
4852 each at its appropriate position.
4854 We modify *ANNOT by discarding elements as we use them up.
4856 The return value is negative in case of system call failure. */
4859 a_write (int desc
, Lisp_Object string
, EMACS_INT pos
,
4860 register EMACS_INT nchars
, Lisp_Object
*annot
,
4861 struct coding_system
*coding
)
4865 EMACS_INT lastpos
= pos
+ nchars
;
4867 while (NILP (*annot
) || CONSP (*annot
))
4869 tem
= Fcar_safe (Fcar (*annot
));
4872 nextpos
= XFASTINT (tem
);
4874 /* If there are no more annotations in this range,
4875 output the rest of the range all at once. */
4876 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4877 return e_write (desc
, string
, pos
, lastpos
, coding
);
4879 /* Output buffer text up to the next annotation's position. */
4882 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4886 /* Output the annotation. */
4887 tem
= Fcdr (Fcar (*annot
));
4890 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4893 *annot
= Fcdr (*annot
);
4899 /* Write text in the range START and END into descriptor DESC,
4900 encoding them with coding system CODING. If STRING is nil, START
4901 and END are character positions of the current buffer, else they
4902 are indexes to the string STRING. */
4905 e_write (int desc
, Lisp_Object string
, EMACS_INT start
, EMACS_INT end
,
4906 struct coding_system
*coding
)
4908 if (STRINGP (string
))
4911 end
= SCHARS (string
);
4914 /* We used to have a code for handling selective display here. But,
4915 now it is handled within encode_coding. */
4919 if (STRINGP (string
))
4921 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
4922 if (CODING_REQUIRE_ENCODING (coding
))
4924 encode_coding_object (coding
, string
,
4925 start
, string_char_to_byte (string
, start
),
4926 end
, string_char_to_byte (string
, end
), Qt
);
4930 coding
->dst_object
= string
;
4931 coding
->consumed_char
= SCHARS (string
);
4932 coding
->produced
= SBYTES (string
);
4937 EMACS_INT start_byte
= CHAR_TO_BYTE (start
);
4938 EMACS_INT end_byte
= CHAR_TO_BYTE (end
);
4940 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
4941 if (CODING_REQUIRE_ENCODING (coding
))
4943 encode_coding_object (coding
, Fcurrent_buffer (),
4944 start
, start_byte
, end
, end_byte
, Qt
);
4948 coding
->dst_object
= Qnil
;
4949 coding
->dst_pos_byte
= start_byte
;
4950 if (start
>= GPT
|| end
<= GPT
)
4952 coding
->consumed_char
= end
- start
;
4953 coding
->produced
= end_byte
- start_byte
;
4957 coding
->consumed_char
= GPT
- start
;
4958 coding
->produced
= GPT_BYTE
- start_byte
;
4963 if (coding
->produced
> 0)
4967 STRINGP (coding
->dst_object
)
4968 ? SSDATA (coding
->dst_object
)
4969 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
4972 if (coding
->produced
)
4975 start
+= coding
->consumed_char
;
4981 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
4982 Sverify_visited_file_modtime
, 0, 1, 0,
4983 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
4984 This means that the file has not been changed since it was visited or saved.
4985 If BUF is omitted or nil, it defaults to the current buffer.
4986 See Info node `(elisp)Modification Time' for more details. */)
4991 Lisp_Object handler
;
4992 Lisp_Object filename
;
5002 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5003 if (b
->modtime
== 0) return Qt
;
5005 /* If the file name has special constructs in it,
5006 call the corresponding file handler. */
5007 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5008 Qverify_visited_file_modtime
);
5009 if (!NILP (handler
))
5010 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5012 filename
= ENCODE_FILE (BVAR (b
, filename
));
5014 if (stat (SSDATA (filename
), &st
) < 0)
5016 /* If the file doesn't exist now and didn't exist before,
5017 we say that it isn't modified, provided the error is a tame one. */
5018 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
5023 if ((st
.st_mtime
== b
->modtime
5024 /* If both are positive, accept them if they are off by one second. */
5025 || (st
.st_mtime
> 0 && b
->modtime
> 0
5026 && (st
.st_mtime
- 1 == b
->modtime
5027 || st
.st_mtime
== b
->modtime
- 1)))
5028 && (st
.st_size
== b
->modtime_size
5029 || b
->modtime_size
< 0))
5034 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5035 Sclear_visited_file_modtime
, 0, 0, 0,
5036 doc
: /* Clear out records of last mod time of visited file.
5037 Next attempt to save will certainly not complain of a discrepancy. */)
5040 current_buffer
->modtime
= 0;
5041 current_buffer
->modtime_size
= -1;
5045 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5046 Svisited_file_modtime
, 0, 0, 0,
5047 doc
: /* Return the current buffer's recorded visited file modification time.
5048 The value is a list of the form (HIGH LOW), like the time values
5049 that `file-attributes' returns. If the current buffer has no recorded
5050 file modification time, this function returns 0.
5051 See Info node `(elisp)Modification Time' for more details. */)
5054 if (! current_buffer
->modtime
)
5055 return make_number (0);
5056 return make_time (current_buffer
->modtime
);
5059 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5060 Sset_visited_file_modtime
, 0, 1, 0,
5061 doc
: /* Update buffer's recorded modification time from the visited file's time.
5062 Useful if the buffer was not read from the file normally
5063 or if the file itself has been changed for some known benign reason.
5064 An argument specifies the modification time value to use
5065 \(instead of that of the visited file), in the form of a list
5066 \(HIGH . LOW) or (HIGH LOW). */)
5067 (Lisp_Object time_list
)
5069 if (!NILP (time_list
))
5071 CONS_TO_INTEGER (time_list
, time_t, current_buffer
->modtime
);
5072 current_buffer
->modtime_size
= -1;
5076 register Lisp_Object filename
;
5078 Lisp_Object handler
;
5080 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5082 /* If the file name has special constructs in it,
5083 call the corresponding file handler. */
5084 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5085 if (!NILP (handler
))
5086 /* The handler can find the file name the same way we did. */
5087 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5089 filename
= ENCODE_FILE (filename
);
5091 if (stat (SSDATA (filename
), &st
) >= 0)
5093 current_buffer
->modtime
= st
.st_mtime
;
5094 current_buffer
->modtime_size
= st
.st_size
;
5102 auto_save_error (Lisp_Object error_val
)
5104 Lisp_Object args
[3], msg
;
5106 struct gcpro gcpro1
;
5110 auto_save_error_occurred
= 1;
5112 ring_bell (XFRAME (selected_frame
));
5114 args
[0] = build_string ("Auto-saving %s: %s");
5115 args
[1] = BVAR (current_buffer
, name
);
5116 args
[2] = Ferror_message_string (error_val
);
5117 msg
= Fformat (3, args
);
5119 nbytes
= SBYTES (msg
);
5120 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5121 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5123 for (i
= 0; i
< 3; ++i
)
5126 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5128 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5129 Fsleep_for (make_number (1), Qnil
);
5143 auto_save_mode_bits
= 0666;
5145 /* Get visited file's mode to become the auto save file's mode. */
5146 if (! NILP (BVAR (current_buffer
, filename
)))
5148 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5149 /* But make sure we can overwrite it later! */
5150 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5151 else if ((modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5153 /* Remote files don't cooperate with stat. */
5154 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5158 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5159 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5164 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5167 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5179 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5182 minibuffer_auto_raise
= XINT (value
);
5187 do_auto_save_make_dir (Lisp_Object dir
)
5191 call2 (Qmake_directory
, dir
, Qt
);
5192 XSETFASTINT (mode
, 0700);
5193 return Fset_file_modes (dir
, mode
);
5197 do_auto_save_eh (Lisp_Object ignore
)
5202 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5203 doc
: /* Auto-save all buffers that need it.
5204 This is all buffers that have auto-saving enabled
5205 and are changed since last auto-saved.
5206 Auto-saving writes the buffer into a file
5207 so that your editing is not lost if the system crashes.
5208 This file is not the file you visited; that changes only when you save.
5209 Normally we run the normal hook `auto-save-hook' before saving.
5211 A non-nil NO-MESSAGE argument means do not print any message if successful.
5212 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5213 (Lisp_Object no_message
, Lisp_Object current_only
)
5215 struct buffer
*old
= current_buffer
, *b
;
5216 Lisp_Object tail
, buf
, hook
;
5218 int do_handled_files
;
5220 FILE *stream
= NULL
;
5221 int count
= SPECPDL_INDEX ();
5222 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5223 int old_message_p
= 0;
5224 struct gcpro gcpro1
, gcpro2
;
5226 if (max_specpdl_size
< specpdl_size
+ 40)
5227 max_specpdl_size
= specpdl_size
+ 40;
5232 if (NILP (no_message
))
5234 old_message_p
= push_message ();
5235 record_unwind_protect (pop_message_unwind
, Qnil
);
5238 /* Ordinarily don't quit within this function,
5239 but don't make it impossible to quit (in case we get hung in I/O). */
5243 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5244 point to non-strings reached from Vbuffer_alist. */
5246 hook
= intern ("auto-save-hook");
5247 Frun_hooks (1, &hook
);
5249 if (STRINGP (Vauto_save_list_file_name
))
5251 Lisp_Object listfile
;
5253 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5255 /* Don't try to create the directory when shutting down Emacs,
5256 because creating the directory might signal an error, and
5257 that would leave Emacs in a strange state. */
5258 if (!NILP (Vrun_hooks
))
5262 GCPRO2 (dir
, listfile
);
5263 dir
= Ffile_name_directory (listfile
);
5264 if (NILP (Ffile_directory_p (dir
)))
5265 internal_condition_case_1 (do_auto_save_make_dir
,
5266 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5271 stream
= fopen (SSDATA (listfile
), "w");
5274 record_unwind_protect (do_auto_save_unwind
,
5275 make_save_value (stream
, 0));
5276 record_unwind_protect (do_auto_save_unwind_1
,
5277 make_number (minibuffer_auto_raise
));
5278 minibuffer_auto_raise
= 0;
5280 auto_save_error_occurred
= 0;
5282 /* On first pass, save all files that don't have handlers.
5283 On second pass, save all files that do have handlers.
5285 If Emacs is crashing, the handlers may tweak what is causing
5286 Emacs to crash in the first place, and it would be a shame if
5287 Emacs failed to autosave perfectly ordinary files because it
5288 couldn't handle some ange-ftp'd file. */
5290 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5291 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5293 buf
= XCDR (XCAR (tail
));
5296 /* Record all the buffers that have auto save mode
5297 in the special file that lists them. For each of these buffers,
5298 Record visited name (if any) and auto save name. */
5299 if (STRINGP (BVAR (b
, auto_save_file_name
))
5300 && stream
!= NULL
&& do_handled_files
== 0)
5303 if (!NILP (BVAR (b
, filename
)))
5305 fwrite (SDATA (BVAR (b
, filename
)), 1,
5306 SBYTES (BVAR (b
, filename
)), stream
);
5308 putc ('\n', stream
);
5309 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5310 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5311 putc ('\n', stream
);
5315 if (!NILP (current_only
)
5316 && b
!= current_buffer
)
5319 /* Don't auto-save indirect buffers.
5320 The base buffer takes care of it. */
5324 /* Check for auto save enabled
5325 and file changed since last auto save
5326 and file changed since last real save. */
5327 if (STRINGP (BVAR (b
, auto_save_file_name
))
5328 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5329 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5330 /* -1 means we've turned off autosaving for a while--see below. */
5331 && XINT (BVAR (b
, save_length
)) >= 0
5332 && (do_handled_files
5333 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5336 EMACS_TIME before_time
, after_time
;
5338 EMACS_GET_TIME (before_time
);
5340 /* If we had a failure, don't try again for 20 minutes. */
5341 if (b
->auto_save_failure_time
>= 0
5342 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5345 set_buffer_internal (b
);
5346 if (NILP (Vauto_save_include_big_deletions
)
5347 && (XFASTINT (BVAR (b
, save_length
)) * 10
5348 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5349 /* A short file is likely to change a large fraction;
5350 spare the user annoying messages. */
5351 && XFASTINT (BVAR (b
, save_length
)) > 5000
5352 /* These messages are frequent and annoying for `*mail*'. */
5353 && !EQ (BVAR (b
, filename
), Qnil
)
5354 && NILP (no_message
))
5356 /* It has shrunk too much; turn off auto-saving here. */
5357 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5358 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5360 minibuffer_auto_raise
= 0;
5361 /* Turn off auto-saving until there's a real save,
5362 and prevent any more warnings. */
5363 XSETINT (BVAR (b
, save_length
), -1);
5364 Fsleep_for (make_number (1), Qnil
);
5367 if (!auto_saved
&& NILP (no_message
))
5368 message1 ("Auto-saving...");
5369 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5371 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5372 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5373 set_buffer_internal (old
);
5375 EMACS_GET_TIME (after_time
);
5377 /* If auto-save took more than 60 seconds,
5378 assume it was an NFS failure that got a timeout. */
5379 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5380 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5384 /* Prevent another auto save till enough input events come in. */
5385 record_auto_save ();
5387 if (auto_saved
&& NILP (no_message
))
5391 /* If we are going to restore an old message,
5392 give time to read ours. */
5393 sit_for (make_number (1), 0, 0);
5396 else if (!auto_save_error_occurred
)
5397 /* Don't overwrite the error message if an error occurred.
5398 If we displayed a message and then restored a state
5399 with no message, leave a "done" message on the screen. */
5400 message1 ("Auto-saving...done");
5405 /* This restores the message-stack status. */
5406 unbind_to (count
, Qnil
);
5410 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5411 Sset_buffer_auto_saved
, 0, 0, 0,
5412 doc
: /* Mark current buffer as auto-saved with its current text.
5413 No auto-save file will be written until the buffer changes again. */)
5416 /* FIXME: This should not be called in indirect buffers, since
5417 they're not autosaved. */
5418 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5419 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5420 current_buffer
->auto_save_failure_time
= -1;
5424 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5425 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5426 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5429 current_buffer
->auto_save_failure_time
= -1;
5433 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5435 doc
: /* Return t if current buffer has been auto-saved recently.
5436 More precisely, if it has been auto-saved since last read from or saved
5437 in the visited file. If the buffer has no visited file,
5438 then any auto-save counts as "recent". */)
5441 /* FIXME: maybe we should return nil for indirect buffers since
5442 they're never autosaved. */
5443 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5446 /* Reading and completing file names */
5448 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5449 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5450 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5451 The return value is only relevant for a call to `read-file-name' that happens
5452 before any other event (mouse or keypress) is handled. */)
5455 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5456 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5466 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5468 struct gcpro gcpro1
;
5469 Lisp_Object args
[7];
5471 GCPRO1 (default_filename
);
5472 args
[0] = intern ("read-file-name");
5475 args
[3] = default_filename
;
5476 args
[4] = mustmatch
;
5478 args
[6] = predicate
;
5479 RETURN_UNGCPRO (Ffuncall (7, args
));
5484 syms_of_fileio (void)
5486 DEFSYM (Qoperations
, "operations");
5487 DEFSYM (Qexpand_file_name
, "expand-file-name");
5488 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5489 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5490 DEFSYM (Qfile_name_directory
, "file-name-directory");
5491 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5492 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5493 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5494 DEFSYM (Qcopy_file
, "copy-file");
5495 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5496 DEFSYM (Qmake_directory
, "make-directory");
5497 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5498 DEFSYM (Qdelete_file
, "delete-file");
5499 DEFSYM (Qrename_file
, "rename-file");
5500 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5501 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5502 DEFSYM (Qfile_exists_p
, "file-exists-p");
5503 DEFSYM (Qfile_executable_p
, "file-executable-p");
5504 DEFSYM (Qfile_readable_p
, "file-readable-p");
5505 DEFSYM (Qfile_writable_p
, "file-writable-p");
5506 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5507 DEFSYM (Qaccess_file
, "access-file");
5508 DEFSYM (Qfile_directory_p
, "file-directory-p");
5509 DEFSYM (Qfile_regular_p
, "file-regular-p");
5510 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5511 DEFSYM (Qfile_modes
, "file-modes");
5512 DEFSYM (Qset_file_modes
, "set-file-modes");
5513 DEFSYM (Qset_file_times
, "set-file-times");
5514 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5515 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5516 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5517 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5518 DEFSYM (Qwrite_region
, "write-region");
5519 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5520 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5521 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5523 DEFSYM (Qfile_name_history
, "file-name-history");
5524 Fset (Qfile_name_history
, Qnil
);
5526 DEFSYM (Qfile_error
, "file-error");
5527 DEFSYM (Qfile_already_exists
, "file-already-exists");
5528 DEFSYM (Qfile_date_error
, "file-date-error");
5529 DEFSYM (Qexcl
, "excl");
5531 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5532 doc
: /* *Coding system for encoding file names.
5533 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5534 Vfile_name_coding_system
= Qnil
;
5536 DEFVAR_LISP ("default-file-name-coding-system",
5537 Vdefault_file_name_coding_system
,
5538 doc
: /* Default coding system for encoding file names.
5539 This variable is used only when `file-name-coding-system' is nil.
5541 This variable is set/changed by the command `set-language-environment'.
5542 User should not set this variable manually,
5543 instead use `file-name-coding-system' to get a constant encoding
5544 of file names regardless of the current language environment. */);
5545 Vdefault_file_name_coding_system
= Qnil
;
5547 DEFSYM (Qformat_decode
, "format-decode");
5548 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5549 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5550 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5552 Fput (Qfile_error
, Qerror_conditions
,
5553 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5554 Fput (Qfile_error
, Qerror_message
,
5555 make_pure_c_string ("File error"));
5557 Fput (Qfile_already_exists
, Qerror_conditions
,
5558 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5559 Fput (Qfile_already_exists
, Qerror_message
,
5560 make_pure_c_string ("File already exists"));
5562 Fput (Qfile_date_error
, Qerror_conditions
,
5563 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5564 Fput (Qfile_date_error
, Qerror_message
,
5565 make_pure_c_string ("Cannot set file date"));
5567 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5568 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
5569 If a file name matches REGEXP, then all I/O on that file is done by calling
5572 The first argument given to HANDLER is the name of the I/O primitive
5573 to be handled; the remaining arguments are the arguments that were
5574 passed to that primitive. For example, if you do
5575 (file-exists-p FILENAME)
5576 and FILENAME is handled by HANDLER, then HANDLER is called like this:
5577 (funcall HANDLER 'file-exists-p FILENAME)
5578 The function `find-file-name-handler' checks this list for a handler
5579 for its argument. */);
5580 Vfile_name_handler_alist
= Qnil
;
5582 DEFVAR_LISP ("set-auto-coding-function",
5583 Vset_auto_coding_function
,
5584 doc
: /* If non-nil, a function to call to decide a coding system of file.
5585 Two arguments are passed to this function: the file name
5586 and the length of a file contents following the point.
5587 This function should return a coding system to decode the file contents.
5588 It should check the file name against `auto-coding-alist'.
5589 If no coding system is decided, it should check a coding system
5590 specified in the heading lines with the format:
5591 -*- ... coding: CODING-SYSTEM; ... -*-
5592 or local variable spec of the tailing lines with `coding:' tag. */);
5593 Vset_auto_coding_function
= Qnil
;
5595 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5596 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5597 Each is passed one argument, the number of characters inserted,
5598 with point at the start of the inserted text. Each function
5599 should leave point the same, and return the new character count.
5600 If `insert-file-contents' is intercepted by a handler from
5601 `file-name-handler-alist', that handler is responsible for calling the
5602 functions in `after-insert-file-functions' if appropriate. */);
5603 Vafter_insert_file_functions
= Qnil
;
5605 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5606 doc
: /* A list of functions to be called at the start of `write-region'.
5607 Each is passed two arguments, START and END as for `write-region'.
5608 These are usually two numbers but not always; see the documentation
5609 for `write-region'. The function should return a list of pairs
5610 of the form (POSITION . STRING), consisting of strings to be effectively
5611 inserted at the specified positions of the file being written (1 means to
5612 insert before the first byte written). The POSITIONs must be sorted into
5615 If there are several annotation functions, the lists returned by these
5616 functions are merged destructively. As each annotation function runs,
5617 the variable `write-region-annotations-so-far' contains a list of all
5618 annotations returned by previous annotation functions.
5620 An annotation function can return with a different buffer current.
5621 Doing so removes the annotations returned by previous functions, and
5622 resets START and END to `point-min' and `point-max' of the new buffer.
5624 After `write-region' completes, Emacs calls the function stored in
5625 `write-region-post-annotation-function', once for each buffer that was
5626 current when building the annotations (i.e., at least once), with that
5627 buffer current. */);
5628 Vwrite_region_annotate_functions
= Qnil
;
5629 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5631 DEFVAR_LISP ("write-region-post-annotation-function",
5632 Vwrite_region_post_annotation_function
,
5633 doc
: /* Function to call after `write-region' completes.
5634 The function is called with no arguments. If one or more of the
5635 annotation functions in `write-region-annotate-functions' changed the
5636 current buffer, the function stored in this variable is called for
5637 each of those additional buffers as well, in addition to the original
5638 buffer. The relevant buffer is current during each function call. */);
5639 Vwrite_region_post_annotation_function
= Qnil
;
5640 staticpro (&Vwrite_region_annotation_buffers
);
5642 DEFVAR_LISP ("write-region-annotations-so-far",
5643 Vwrite_region_annotations_so_far
,
5644 doc
: /* When an annotation function is called, this holds the previous annotations.
5645 These are the annotations made by other annotation functions
5646 that were already called. See also `write-region-annotate-functions'. */);
5647 Vwrite_region_annotations_so_far
= Qnil
;
5649 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5650 doc
: /* A list of file name handlers that temporarily should not be used.
5651 This applies only to the operation `inhibit-file-name-operation'. */);
5652 Vinhibit_file_name_handlers
= Qnil
;
5654 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5655 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5656 Vinhibit_file_name_operation
= Qnil
;
5658 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
5659 doc
: /* File name in which we write a list of all auto save file names.
5660 This variable is initialized automatically from `auto-save-list-file-prefix'
5661 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5662 a non-nil value. */);
5663 Vauto_save_list_file_name
= Qnil
;
5665 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
5666 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5667 Normally auto-save files are written under other names. */);
5668 Vauto_save_visited_file_name
= Qnil
;
5670 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
5671 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5672 If nil, deleting a substantial portion of the text disables auto-save
5673 in the buffer; this is the default behavior, because the auto-save
5674 file is usually more useful if it contains the deleted text. */);
5675 Vauto_save_include_big_deletions
= Qnil
;
5678 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
5679 doc
: /* *Non-nil means don't call fsync in `write-region'.
5680 This variable affects calls to `write-region' as well as save commands.
5681 A non-nil value may result in data loss! */);
5682 write_region_inhibit_fsync
= 0;
5685 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
5686 doc
: /* Specifies whether to use the system's trash can.
5687 When non-nil, certain file deletion commands use the function
5688 `move-file-to-trash' instead of deleting files outright.
5689 This includes interactive calls to `delete-file' and
5690 `delete-directory' and the Dired deletion commands. */);
5691 delete_by_moving_to_trash
= 0;
5692 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5694 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
5695 DEFSYM (Qcopy_directory
, "copy-directory");
5696 DEFSYM (Qdelete_directory
, "delete-directory");
5698 defsubr (&Sfind_file_name_handler
);
5699 defsubr (&Sfile_name_directory
);
5700 defsubr (&Sfile_name_nondirectory
);
5701 defsubr (&Sunhandled_file_name_directory
);
5702 defsubr (&Sfile_name_as_directory
);
5703 defsubr (&Sdirectory_file_name
);
5704 defsubr (&Smake_temp_name
);
5705 defsubr (&Sexpand_file_name
);
5706 defsubr (&Ssubstitute_in_file_name
);
5707 defsubr (&Scopy_file
);
5708 defsubr (&Smake_directory_internal
);
5709 defsubr (&Sdelete_directory_internal
);
5710 defsubr (&Sdelete_file
);
5711 defsubr (&Srename_file
);
5712 defsubr (&Sadd_name_to_file
);
5713 defsubr (&Smake_symbolic_link
);
5714 defsubr (&Sfile_name_absolute_p
);
5715 defsubr (&Sfile_exists_p
);
5716 defsubr (&Sfile_executable_p
);
5717 defsubr (&Sfile_readable_p
);
5718 defsubr (&Sfile_writable_p
);
5719 defsubr (&Saccess_file
);
5720 defsubr (&Sfile_symlink_p
);
5721 defsubr (&Sfile_directory_p
);
5722 defsubr (&Sfile_accessible_directory_p
);
5723 defsubr (&Sfile_regular_p
);
5724 defsubr (&Sfile_modes
);
5725 defsubr (&Sset_file_modes
);
5726 defsubr (&Sset_file_times
);
5727 defsubr (&Sfile_selinux_context
);
5728 defsubr (&Sset_file_selinux_context
);
5729 defsubr (&Sset_default_file_modes
);
5730 defsubr (&Sdefault_file_modes
);
5731 defsubr (&Sfile_newer_than_file_p
);
5732 defsubr (&Sinsert_file_contents
);
5733 defsubr (&Swrite_region
);
5734 defsubr (&Scar_less_than_car
);
5735 defsubr (&Sverify_visited_file_modtime
);
5736 defsubr (&Sclear_visited_file_modtime
);
5737 defsubr (&Svisited_file_modtime
);
5738 defsubr (&Sset_visited_file_modtime
);
5739 defsubr (&Sdo_auto_save
);
5740 defsubr (&Sset_buffer_auto_saved
);
5741 defsubr (&Sclear_buffer_auto_save_failure
);
5742 defsubr (&Srecent_auto_save_p
);
5744 defsubr (&Snext_read_file_uses_dialog_p
);
5747 defsubr (&Sunix_sync
);