1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
34 #ifdef HAVE_LIBSELINUX
35 #include <selinux/selinux.h>
36 #include <selinux/context.h>
42 #include "intervals.h"
43 #include "character.h"
47 #include "blockinput.h"
49 #include "dispextern.h"
57 #endif /* not WINDOWSNT */
61 #include <sys/param.h>
66 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
67 redirector allows the six letters between 'Z' and 'a' as well. */
69 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
72 #define IS_DRIVE(x) c_isalpha (x)
74 /* Need to lower-case the drive letter, or else expanded
75 filenames will sometimes compare unequal, because
76 `expand-file-name' doesn't always down-case the drive letter. */
77 #define DRIVE_LETTER(x) c_tolower (x)
81 #include <stat-time.h>
89 /* True during writing of auto-save files. */
90 static bool auto_saving
;
92 /* Nonzero umask during creation of auto-save directories. */
93 static mode_t auto_saving_dir_umask
;
95 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
96 a new file with the same mode as the original. */
97 static mode_t auto_save_mode_bits
;
99 /* Set by auto_save_1 if an error occurred during the last auto-save. */
100 static bool auto_save_error_occurred
;
102 /* The symbol bound to coding-system-for-read when
103 insert-file-contents is called for recovering a file. This is not
104 an actual coding system name, but just an indicator to tell
105 insert-file-contents to use `emacs-mule' with a special flag for
106 auto saving and recovering a file. */
107 static Lisp_Object Qauto_save_coding
;
109 /* Property name of a file name handler,
110 which gives a list of operations it handles.. */
111 static Lisp_Object Qoperations
;
113 /* Lisp functions for translating file formats. */
114 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
116 /* Lisp function for setting buffer-file-coding-system and the
117 multibyteness of the current buffer after inserting a file. */
118 static Lisp_Object Qafter_insert_file_set_coding
;
120 static Lisp_Object Qwrite_region_annotate_functions
;
121 /* Each time an annotation function changes the buffer, the new buffer
123 static Lisp_Object Vwrite_region_annotation_buffers
;
128 static Lisp_Object Qdelete_by_moving_to_trash
;
130 /* Lisp function for moving files to trash. */
131 static Lisp_Object Qmove_file_to_trash
;
133 /* Lisp function for recursively copying directories. */
134 static Lisp_Object Qcopy_directory
;
136 /* Lisp function for recursively deleting directories. */
137 static Lisp_Object Qdelete_directory
;
142 Lisp_Object Qfile_error
;
143 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
144 static Lisp_Object Qexcl
;
145 Lisp_Object Qfile_name_history
;
147 static Lisp_Object Qcar_less_than_car
;
149 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
150 Lisp_Object
*, struct coding_system
*);
151 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
152 struct coding_system
*);
156 report_file_error (const char *string
, Lisp_Object data
)
158 Lisp_Object errstring
;
162 synchronize_system_messages_locale ();
163 str
= strerror (errorno
);
164 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
165 Vlocale_coding_system
, 0);
171 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
174 /* System error messages are capitalized. Downcase the initial
175 unless it is followed by a slash. (The slash case caters to
176 error messages that begin with "I/O" or, in German, "E/A".) */
177 if (STRING_MULTIBYTE (errstring
)
178 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
182 str
= SSDATA (errstring
);
183 c
= STRING_CHAR ((unsigned char *) str
);
184 Faset (errstring
, make_number (0), make_number (downcase (c
)));
187 xsignal (Qfile_error
,
188 Fcons (build_string (string
), Fcons (errstring
, data
)));
193 close_file_unwind (Lisp_Object fd
)
195 emacs_close (XFASTINT (fd
));
199 /* Restore point, having saved it as a marker. */
202 restore_point_unwind (Lisp_Object location
)
204 Fgoto_char (location
);
205 Fset_marker (location
, Qnil
, Qnil
);
210 static Lisp_Object Qexpand_file_name
;
211 static Lisp_Object Qsubstitute_in_file_name
;
212 static Lisp_Object Qdirectory_file_name
;
213 static Lisp_Object Qfile_name_directory
;
214 static Lisp_Object Qfile_name_nondirectory
;
215 static Lisp_Object Qunhandled_file_name_directory
;
216 static Lisp_Object Qfile_name_as_directory
;
217 static Lisp_Object Qcopy_file
;
218 static Lisp_Object Qmake_directory_internal
;
219 static Lisp_Object Qmake_directory
;
220 static Lisp_Object Qdelete_directory_internal
;
221 Lisp_Object Qdelete_file
;
222 static Lisp_Object Qrename_file
;
223 static Lisp_Object Qadd_name_to_file
;
224 static Lisp_Object Qmake_symbolic_link
;
225 Lisp_Object Qfile_exists_p
;
226 static Lisp_Object Qfile_executable_p
;
227 static Lisp_Object Qfile_readable_p
;
228 static Lisp_Object Qfile_writable_p
;
229 static Lisp_Object Qfile_symlink_p
;
230 static Lisp_Object Qaccess_file
;
231 Lisp_Object Qfile_directory_p
;
232 static Lisp_Object Qfile_regular_p
;
233 static Lisp_Object Qfile_accessible_directory_p
;
234 static Lisp_Object Qfile_modes
;
235 static Lisp_Object Qset_file_modes
;
236 static Lisp_Object Qset_file_times
;
237 static Lisp_Object Qfile_selinux_context
;
238 static Lisp_Object Qset_file_selinux_context
;
239 static Lisp_Object Qfile_newer_than_file_p
;
240 Lisp_Object Qinsert_file_contents
;
241 Lisp_Object Qwrite_region
;
242 static Lisp_Object Qverify_visited_file_modtime
;
243 static Lisp_Object Qset_visited_file_modtime
;
245 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
246 Sfind_file_name_handler
, 2, 2, 0,
247 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
248 Otherwise, return nil.
249 A file name is handled if one of the regular expressions in
250 `file-name-handler-alist' matches it.
252 If OPERATION equals `inhibit-file-name-operation', then we ignore
253 any handlers that are members of `inhibit-file-name-handlers',
254 but we still do run any other handlers. This lets handlers
255 use the standard functions without calling themselves recursively. */)
256 (Lisp_Object filename
, Lisp_Object operation
)
258 /* This function must not munge the match data. */
259 Lisp_Object chain
, inhibited_handlers
, result
;
263 CHECK_STRING (filename
);
265 if (EQ (operation
, Vinhibit_file_name_operation
))
266 inhibited_handlers
= Vinhibit_file_name_handlers
;
268 inhibited_handlers
= Qnil
;
270 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
271 chain
= XCDR (chain
))
277 Lisp_Object string
= XCAR (elt
);
279 Lisp_Object handler
= XCDR (elt
);
280 Lisp_Object operations
= Qnil
;
282 if (SYMBOLP (handler
))
283 operations
= Fget (handler
, Qoperations
);
286 && (match_pos
= fast_string_match (string
, filename
)) > pos
287 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
291 handler
= XCDR (elt
);
292 tem
= Fmemq (handler
, inhibited_handlers
);
306 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
308 doc
: /* Return the directory component in file name FILENAME.
309 Return nil if FILENAME does not include a directory.
310 Otherwise return a directory name.
311 Given a Unix syntax file name, returns a string ending in slash. */)
312 (Lisp_Object filename
)
315 register const char *beg
;
320 register const char *p
;
323 CHECK_STRING (filename
);
325 /* If the file name has special constructs in it,
326 call the corresponding file handler. */
327 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
330 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
332 return STRINGP (handled_name
) ? handled_name
: Qnil
;
336 beg
= alloca (SBYTES (filename
) + 1);
337 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
339 beg
= SSDATA (filename
);
341 p
= beg
+ SBYTES (filename
);
343 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
345 /* only recognize drive specifier at the beginning */
347 /* handle the "/:d:foo" and "/:foo" cases correctly */
348 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
349 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
356 /* Expansion of "c:" to drive and default directory. */
359 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
360 char *res
= alloca (MAXPATHLEN
+ 1);
363 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
365 memcpy (res
, beg
, 2);
370 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
372 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
375 p
= beg
+ strlen (beg
);
378 tem_fn
= ENCODE_FILE (make_specified_string (beg
, -1, p
- beg
,
379 STRING_MULTIBYTE (filename
)));
380 dostounix_filename (SSDATA (tem_fn
));
381 return DECODE_FILE (tem_fn
);
383 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
387 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
388 Sfile_name_nondirectory
, 1, 1, 0,
389 doc
: /* Return file name FILENAME sans its directory.
390 For example, in a Unix-syntax file name,
391 this is everything after the last slash,
392 or the entire name if it contains no slash. */)
393 (Lisp_Object filename
)
395 register const char *beg
, *p
, *end
;
398 CHECK_STRING (filename
);
400 /* If the file name has special constructs in it,
401 call the corresponding file handler. */
402 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
405 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
407 if (STRINGP (handled_name
))
409 error ("Invalid handler in `file-name-handler-alist'");
412 beg
= SSDATA (filename
);
413 end
= p
= beg
+ SBYTES (filename
);
415 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
417 /* only recognize drive specifier at beginning */
419 /* handle the "/:d:foo" case correctly */
420 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
425 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
428 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
429 Sunhandled_file_name_directory
, 1, 1, 0,
430 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
431 A `directly usable' directory name is one that may be used without the
432 intervention of any file handler.
433 If FILENAME is a directly usable file itself, return
434 \(file-name-directory FILENAME).
435 If FILENAME refers to a file which is not accessible from a local process,
436 then this should return nil.
437 The `call-process' and `start-process' functions use this function to
438 get a current directory to run processes in. */)
439 (Lisp_Object filename
)
443 /* If the file name has special constructs in it,
444 call the corresponding file handler. */
445 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
448 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
450 return STRINGP (handled_name
) ? handled_name
: Qnil
;
453 return Ffile_name_directory (filename
);
456 /* Convert from file name SRC of length SRCLEN to directory name
457 in DST. On UNIX, just make sure there is a terminating /.
458 Return the length of DST. */
461 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
)
473 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
475 dst
[srclen
] = DIRECTORY_SEP
;
476 dst
[srclen
+ 1] = '\0';
480 dostounix_filename (dst
);
485 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
486 Sfile_name_as_directory
, 1, 1, 0,
487 doc
: /* Return a string representing the file name FILE interpreted as a directory.
488 This operation exists because a directory is also a file, but its name as
489 a directory is different from its name as a file.
490 The result can be used as the value of `default-directory'
491 or passed as second argument to `expand-file-name'.
492 For a Unix-syntax file name, just appends a slash. */)
503 /* If the file name has special constructs in it,
504 call the corresponding file handler. */
505 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
508 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
510 if (STRINGP (handled_name
))
512 error ("Invalid handler in `file-name-handler-alist'");
515 buf
= alloca (SBYTES (file
) + 10);
516 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
));
517 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
520 /* Convert from directory name SRC of length SRCLEN to
521 file name in DST. On UNIX, just make sure there isn't
522 a terminating /. Return the length of DST. */
525 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
)
527 /* Process as Unix format: just remove any final slash.
528 But leave "/" unchanged; do not change it to "". */
531 && IS_DIRECTORY_SEP (dst
[srclen
- 1])
533 && !IS_ANY_SEP (dst
[srclen
- 2])
541 dostounix_filename (dst
);
546 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
548 doc
: /* Returns the file name of the directory named DIRECTORY.
549 This is the name of the file that holds the data for the directory DIRECTORY.
550 This operation exists because a directory is also a file, but its name as
551 a directory is different from its name as a file.
552 In Unix-syntax, this function just removes the final slash. */)
553 (Lisp_Object directory
)
559 CHECK_STRING (directory
);
561 if (NILP (directory
))
564 /* If the file name has special constructs in it,
565 call the corresponding file handler. */
566 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
569 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
571 if (STRINGP (handled_name
))
573 error ("Invalid handler in `file-name-handler-alist'");
576 buf
= alloca (SBYTES (directory
) + 20);
577 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
));
578 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
581 static const char make_temp_name_tbl
[64] =
583 'A','B','C','D','E','F','G','H',
584 'I','J','K','L','M','N','O','P',
585 'Q','R','S','T','U','V','W','X',
586 'Y','Z','a','b','c','d','e','f',
587 'g','h','i','j','k','l','m','n',
588 'o','p','q','r','s','t','u','v',
589 'w','x','y','z','0','1','2','3',
590 '4','5','6','7','8','9','-','_'
593 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
595 /* Value is a temporary file name starting with PREFIX, a string.
597 The Emacs process number forms part of the result, so there is
598 no danger of generating a name being used by another process.
599 In addition, this function makes an attempt to choose a name
600 which has no existing file. To make this work, PREFIX should be
601 an absolute file name.
603 BASE64_P means add the pid as 3 characters in base64
604 encoding. In this case, 6 characters will be added to PREFIX to
605 form the file name. Otherwise, if Emacs is running on a system
606 with long file names, add the pid as a decimal number.
608 This function signals an error if no unique file name could be
612 make_temp_name (Lisp_Object prefix
, bool base64_p
)
618 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
621 CHECK_STRING (prefix
);
623 /* VAL is created by adding 6 characters to PREFIX. The first
624 three are the PID of this process, in base 64, and the second
625 three are incremented if the file already exists. This ensures
626 262144 unique file names per PID per PREFIX. */
632 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
633 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
634 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
639 #ifdef HAVE_LONG_FILE_NAMES
640 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
642 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
643 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
644 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
649 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
650 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
651 if (!STRING_MULTIBYTE (prefix
))
652 STRING_SET_UNIBYTE (val
);
654 memcpy (data
, SSDATA (prefix
), len
);
657 memcpy (p
, pidbuf
, pidlen
);
660 /* Here we try to minimize useless stat'ing when this function is
661 invoked many times successively with the same PREFIX. We achieve
662 this by initializing count to a random value, and incrementing it
665 We don't want make-temp-name to be called while dumping,
666 because then make_temp_name_count_initialized_p would get set
667 and then make_temp_name_count would not be set when Emacs starts. */
669 if (!make_temp_name_count_initialized_p
)
671 make_temp_name_count
= time (NULL
);
672 make_temp_name_count_initialized_p
= 1;
677 unsigned num
= make_temp_name_count
;
679 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
680 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
681 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
683 /* Poor man's congruential RN generator. Replace with
684 ++make_temp_name_count for debugging. */
685 make_temp_name_count
+= 25229;
686 make_temp_name_count
%= 225307;
688 if (!check_existing (data
))
690 /* We want to return only if errno is ENOENT. */
694 /* The error here is dubious, but there is little else we
695 can do. The alternatives are to return nil, which is
696 as bad as (and in many cases worse than) throwing the
697 error, or to ignore the error, which will likely result
698 in looping through 225307 stat's, which is not only
699 dog-slow, but also useless since eventually nil would
700 have to be returned anyway. */
701 report_file_error ("Cannot create temporary name for prefix",
702 Fcons (prefix
, Qnil
));
709 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
710 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
711 The Emacs process number forms part of the result,
712 so there is no danger of generating a name being used by another process.
714 In addition, this function makes an attempt to choose a name
715 which has no existing file. To make this work,
716 PREFIX should be an absolute file name.
718 There is a race condition between calling `make-temp-name' and creating the
719 file which opens all kinds of security holes. For that reason, you should
720 probably use `make-temp-file' instead, except in three circumstances:
722 * If you are creating the file in the user's home directory.
723 * If you are creating a directory rather than an ordinary file.
724 * If you are taking special precautions as `make-temp-file' does. */)
727 return make_temp_name (prefix
, 0);
732 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
733 doc
: /* Convert filename NAME to absolute, and canonicalize it.
734 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
735 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
736 the current buffer's value of `default-directory' is used.
737 NAME should be a string that is a valid file name for the underlying
739 File name components that are `.' are removed, and
740 so are file name components followed by `..', along with the `..' itself;
741 note that these simplifications are done without checking the resulting
742 file names in the file system.
743 Multiple consecutive slashes are collapsed into a single slash,
744 except at the beginning of the file name when they are significant (e.g.,
745 UNC file names on MS-Windows.)
746 An initial `~/' expands to your home directory.
747 An initial `~USER/' expands to USER's home directory.
748 See also the function `substitute-in-file-name'.
750 For technical reasons, this function can return correct but
751 non-intuitive results for the root directory; for instance,
752 \(expand-file-name ".." "/") returns "/..". For this reason, use
753 \(directory-file-name (file-name-directory dirname)) to traverse a
754 filesystem tree, not (expand-file-name ".." dirname). */)
755 (Lisp_Object name
, Lisp_Object default_directory
)
757 /* These point to SDATA and need to be careful with string-relocation
758 during GC (via DECODE_FILE). */
761 /* This should only point to alloca'd data. */
768 bool collapse_newdir
= 1;
772 Lisp_Object handler
, result
, handled_name
;
778 /* If the file name has special constructs in it,
779 call the corresponding file handler. */
780 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
783 handled_name
= call3 (handler
, Qexpand_file_name
,
784 name
, default_directory
);
785 if (STRINGP (handled_name
))
787 error ("Invalid handler in `file-name-handler-alist'");
791 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
792 if (NILP (default_directory
))
793 default_directory
= BVAR (current_buffer
, directory
);
794 if (! STRINGP (default_directory
))
797 /* "/" is not considered a root directory on DOS_NT, so using "/"
798 here causes an infinite recursion in, e.g., the following:
800 (let (default-directory)
801 (expand-file-name "a"))
803 To avoid this, we set default_directory to the root of the
805 default_directory
= build_string (emacs_root_dir ());
807 default_directory
= build_string ("/");
811 if (!NILP (default_directory
))
813 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
816 handled_name
= call3 (handler
, Qexpand_file_name
,
817 name
, default_directory
);
818 if (STRINGP (handled_name
))
820 error ("Invalid handler in `file-name-handler-alist'");
825 char *o
= SSDATA (default_directory
);
827 /* Make sure DEFAULT_DIRECTORY is properly expanded.
828 It would be better to do this down below where we actually use
829 default_directory. Unfortunately, calling Fexpand_file_name recursively
830 could invoke GC, and the strings might be relocated. This would
831 be annoying because we have pointers into strings lying around
832 that would need adjusting, and people would add new pointers to
833 the code and forget to adjust them, resulting in intermittent bugs.
834 Putting this call here avoids all that crud.
836 The EQ test avoids infinite recursion. */
837 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
838 /* Save time in some common cases - as long as default_directory
839 is not relative, it can be canonicalized with name below (if it
840 is needed at all) without requiring it to be expanded now. */
842 /* Detect MSDOS file names with drive specifiers. */
843 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
844 && IS_DIRECTORY_SEP (o
[2]))
846 /* Detect Windows file names in UNC format. */
847 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
849 #else /* not DOS_NT */
850 /* Detect Unix absolute file names (/... alone is not absolute on
852 && ! (IS_DIRECTORY_SEP (o
[0]))
853 #endif /* not DOS_NT */
859 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
863 multibyte
= STRING_MULTIBYTE (name
);
864 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
867 default_directory
= string_to_multibyte (default_directory
);
870 name
= string_to_multibyte (name
);
875 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
876 nm
= alloca (SBYTES (name
) + 1);
877 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
880 /* Note if special escape prefix is present, but remove for now. */
881 if (nm
[0] == '/' && nm
[1] == ':')
887 /* Find and remove drive specifier if present; this makes nm absolute
888 even if the rest of the name appears to be relative. Only look for
889 drive specifier at the beginning. */
890 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
892 drive
= (unsigned char) nm
[0];
897 /* If we see "c://somedir", we want to strip the first slash after the
898 colon when stripping the drive letter. Otherwise, this expands to
900 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
903 /* Discard any previous drive specifier if nm is now in UNC format. */
904 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
908 #endif /* WINDOWSNT */
911 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
912 none are found, we can probably return right away. We will avoid
913 allocating a new string if name is already fully expanded. */
915 IS_DIRECTORY_SEP (nm
[0])
917 && drive
&& !is_escaped
920 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
924 /* If it turns out that the filename we want to return is just a
925 suffix of FILENAME, we don't need to go through and edit
926 things; we just need to construct a new string using data
927 starting at the middle of FILENAME. If we set LOSE, that
928 means we've discovered that we can't do that cool trick. */
934 /* Since we know the name is absolute, we can assume that each
935 element starts with a "/". */
937 /* "." and ".." are hairy. */
938 if (IS_DIRECTORY_SEP (p
[0])
940 && (IS_DIRECTORY_SEP (p
[2])
942 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
945 /* We want to replace multiple `/' in a row with a single
948 && IS_DIRECTORY_SEP (p
[0])
949 && IS_DIRECTORY_SEP (p
[1]))
956 /* Make sure directories are all separated with /, but
957 avoid allocation of a new string when not required. */
960 Lisp_Object tem_name
= make_specified_string (nm
, -1, strlen (nm
),
963 tem_name
= ENCODE_FILE (tem_name
);
964 dostounix_filename (SSDATA (tem_name
));
965 tem_name
= DECODE_FILE (tem_name
);
966 memcpy (nm
, SSDATA (tem_name
), SBYTES (tem_name
) + 1);
969 dostounix_filename (nm
);
971 if (IS_DIRECTORY_SEP (nm
[1]))
973 if (strcmp (nm
, SSDATA (name
)) != 0)
974 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
978 /* Drive must be set, so this is okay. */
979 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
983 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
984 temp
[0] = DRIVE_LETTER (drive
);
985 name
= concat2 (build_string (temp
), name
);
988 #else /* not DOS_NT */
989 if (strcmp (nm
, SSDATA (name
)) == 0)
991 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
992 #endif /* not DOS_NT */
996 /* At this point, nm might or might not be an absolute file name. We
997 need to expand ~ or ~user if present, otherwise prefix nm with
998 default_directory if nm is not absolute, and finally collapse /./
999 and /foo/../ sequences.
1001 We set newdir to be the appropriate prefix if one is needed:
1002 - the relevant user directory if nm starts with ~ or ~user
1003 - the specified drive's working dir (DOS/NT only) if nm does not
1005 - the value of default_directory.
1007 Note that these prefixes are not guaranteed to be absolute (except
1008 for the working dir of a drive). Therefore, to ensure we always
1009 return an absolute name, if the final prefix is not absolute we
1010 append it to the current working directory. */
1014 if (nm
[0] == '~') /* prefix ~ */
1016 if (IS_DIRECTORY_SEP (nm
[1])
1017 || nm
[1] == 0) /* ~ by itself */
1021 if (!(newdir
= egetenv ("HOME")))
1024 /* `egetenv' may return a unibyte string, which will bite us since
1025 we expect the directory to be multibyte. */
1026 tem
= build_string (newdir
);
1027 if (!STRING_MULTIBYTE (tem
))
1029 hdir
= DECODE_FILE (tem
);
1030 newdir
= SSDATA (hdir
);
1033 collapse_newdir
= 0;
1036 else /* ~user/filename */
1039 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1040 o
= alloca (p
- nm
+ 1);
1041 memcpy (o
, nm
, p
- nm
);
1045 pw
= getpwnam (o
+ 1);
1049 newdir
= pw
->pw_dir
;
1052 collapse_newdir
= 0;
1056 /* If we don't find a user of that name, leave the name
1057 unchanged; don't move nm forward to p. */
1062 /* On DOS and Windows, nm is absolute if a drive name was specified;
1063 use the drive's current directory as the prefix if needed. */
1064 if (!newdir
&& drive
)
1066 /* Get default directory if needed to make nm absolute. */
1068 if (!IS_DIRECTORY_SEP (nm
[0]))
1070 adir
= alloca (MAXPATHLEN
+ 1);
1071 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1076 /* Either nm starts with /, or drive isn't mounted. */
1078 adir
[0] = DRIVE_LETTER (drive
);
1087 /* Finally, if no prefix has been specified and nm is not absolute,
1088 then it must be expanded relative to default_directory. */
1092 /* /... alone is not absolute on DOS and Windows. */
1093 && !IS_DIRECTORY_SEP (nm
[0])
1096 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1100 newdir
= SSDATA (default_directory
);
1102 /* Note if special escape prefix is present, but remove for now. */
1103 if (newdir
[0] == '/' && newdir
[1] == ':')
1114 /* First ensure newdir is an absolute name. */
1116 /* Detect MSDOS file names with drive specifiers. */
1117 ! (IS_DRIVE (newdir
[0])
1118 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1120 /* Detect Windows file names in UNC format. */
1121 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1125 /* Effectively, let newdir be (expand-file-name newdir cwd).
1126 Because of the admonition against calling expand-file-name
1127 when we have pointers into lisp strings, we accomplish this
1128 indirectly by prepending newdir to nm if necessary, and using
1129 cwd (or the wd of newdir's drive) as the new newdir. */
1131 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1133 drive
= (unsigned char) newdir
[0];
1136 if (!IS_DIRECTORY_SEP (nm
[0]))
1138 ptrdiff_t newlen
= strlen (newdir
);
1139 char *tmp
= alloca (newlen
+ strlen (nm
) + 2);
1140 file_name_as_directory (tmp
, newdir
, newlen
);
1144 adir
= alloca (MAXPATHLEN
+ 1);
1147 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1151 getcwd (adir
, MAXPATHLEN
+ 1);
1155 /* Strip off drive name from prefix, if present. */
1156 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1162 /* Keep only a prefix from newdir if nm starts with slash
1163 (//server/share for UNC, nothing otherwise). */
1164 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1167 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1169 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1171 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1173 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1186 /* Get rid of any slash at the end of newdir, unless newdir is
1187 just / or // (an incomplete UNC name). */
1188 length
= strlen (newdir
);
1190 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1192 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1196 char *temp
= alloca (length
);
1197 memcpy (temp
, newdir
, length
- 1);
1198 temp
[length
- 1] = 0;
1209 /* Now concatenate the directory and name to new space in the stack frame. */
1210 tlen
+= strlen (nm
) + 1;
1212 /* Reserve space for drive specifier and escape prefix, since either
1213 or both may need to be inserted. (The Microsoft x86 compiler
1214 produces incorrect code if the following two lines are combined.) */
1215 target
= alloca (tlen
+ 4);
1217 #else /* not DOS_NT */
1218 target
= alloca (tlen
);
1219 #endif /* not DOS_NT */
1224 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1227 /* If newdir is effectively "C:/", then the drive letter will have
1228 been stripped and newdir will be "/". Concatenating with an
1229 absolute directory in nm produces "//", which will then be
1230 incorrectly treated as a network share. Ignore newdir in
1231 this case (keeping the drive letter). */
1232 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1233 && newdir
[1] == '\0'))
1235 strcpy (target
, newdir
);
1238 file_name_as_directory (target
, newdir
, length
);
1241 strcat (target
, nm
);
1243 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1251 if (!IS_DIRECTORY_SEP (*p
))
1255 else if (p
[1] == '.'
1256 && (IS_DIRECTORY_SEP (p
[2])
1259 /* If "/." is the entire filename, keep the "/". Otherwise,
1260 just delete the whole "/.". */
1261 if (o
== target
&& p
[2] == '\0')
1265 else if (p
[1] == '.' && p
[2] == '.'
1266 /* `/../' is the "superroot" on certain file systems.
1267 Turned off on DOS_NT systems because they have no
1268 "superroot" and because this causes us to produce
1269 file names like "d:/../foo" which fail file-related
1270 functions of the underlying OS. (To reproduce, try a
1271 long series of "../../" in default_directory, longer
1272 than the number of levels from the root.) */
1276 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1281 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1284 /* Don't go below server level in UNC filenames. */
1285 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1286 && IS_DIRECTORY_SEP (*target
))
1290 /* Keep initial / only if this is the whole name. */
1291 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1295 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1296 /* Collapse multiple `/' in a row. */
1305 /* At last, set drive name. */
1307 /* Except for network file name. */
1308 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1309 #endif /* WINDOWSNT */
1311 if (!drive
) emacs_abort ();
1313 target
[0] = DRIVE_LETTER (drive
);
1316 /* Reinsert the escape prefix if required. */
1323 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1324 result
= ENCODE_FILE (result
);
1325 dostounix_filename (SSDATA (result
));
1326 result
= DECODE_FILE (result
);
1328 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1329 #endif /* !DOS_NT */
1332 /* Again look to see if the file name has special constructs in it
1333 and perhaps call the corresponding file handler. This is needed
1334 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1335 the ".." component gives us "/user@host:/bar/../baz" which needs
1336 to be expanded again. */
1337 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1338 if (!NILP (handler
))
1340 handled_name
= call3 (handler
, Qexpand_file_name
,
1341 result
, default_directory
);
1342 if (STRINGP (handled_name
))
1343 return handled_name
;
1344 error ("Invalid handler in `file-name-handler-alist'");
1351 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1352 This is the old version of expand-file-name, before it was thoroughly
1353 rewritten for Emacs 10.31. We leave this version here commented-out,
1354 because the code is very complex and likely to have subtle bugs. If
1355 bugs _are_ found, it might be of interest to look at the old code and
1356 see what did it do in the relevant situation.
1358 Don't remove this code: it's true that it will be accessible
1359 from the repository, but a few years from deletion, people will
1360 forget it is there. */
1362 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1363 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1364 "Convert FILENAME to absolute, and canonicalize it.\n\
1365 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1366 \(does not start with slash); if DEFAULT is nil or missing,\n\
1367 the current buffer's value of default-directory is used.\n\
1368 Filenames containing `.' or `..' as components are simplified;\n\
1369 initial `~/' expands to your home directory.\n\
1370 See also the function `substitute-in-file-name'.")
1372 Lisp_Object name
, defalt
;
1376 register unsigned char *newdir
, *p
, *o
;
1378 unsigned char *target
;
1381 CHECK_STRING (name
);
1384 /* If nm is absolute, flush ...// and detect /./ and /../.
1385 If no /./ or /../ we can return right away. */
1392 if (p
[0] == '/' && p
[1] == '/')
1394 if (p
[0] == '/' && p
[1] == '~')
1395 nm
= p
+ 1, lose
= 1;
1396 if (p
[0] == '/' && p
[1] == '.'
1397 && (p
[2] == '/' || p
[2] == 0
1398 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1404 if (nm
== SDATA (name
))
1406 return build_string (nm
);
1410 /* Now determine directory to start with and put it in NEWDIR. */
1414 if (nm
[0] == '~') /* prefix ~ */
1415 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1417 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1418 newdir
= (unsigned char *) "";
1421 else /* ~user/filename */
1423 /* Get past ~ to user. */
1424 unsigned char *user
= nm
+ 1;
1425 /* Find end of name. */
1426 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1427 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1428 /* Copy the user name into temp storage. */
1429 o
= alloca (len
+ 1);
1430 memcpy (o
, user
, len
);
1433 /* Look up the user name. */
1435 pw
= (struct passwd
*) getpwnam (o
+ 1);
1438 error ("\"%s\" isn't a registered user", o
+ 1);
1440 newdir
= (unsigned char *) pw
->pw_dir
;
1442 /* Discard the user name from NM. */
1446 if (nm
[0] != '/' && !newdir
)
1449 defalt
= current_buffer
->directory
;
1450 CHECK_STRING (defalt
);
1451 newdir
= SDATA (defalt
);
1454 /* Now concatenate the directory and name to new space in the stack frame. */
1456 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1457 target
= alloca (tlen
);
1462 if (nm
[0] == 0 || nm
[0] == '/')
1463 strcpy (target
, newdir
);
1465 file_name_as_directory (target
, newdir
);
1468 strcat (target
, nm
);
1470 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1481 else if (!strncmp (p
, "//", 2)
1487 else if (p
[0] == '/' && p
[1] == '.'
1488 && (p
[2] == '/' || p
[2] == 0))
1490 else if (!strncmp (p
, "/..", 3)
1491 /* `/../' is the "superroot" on certain file systems. */
1493 && (p
[3] == '/' || p
[3] == 0))
1495 while (o
!= target
&& *--o
!= '/')
1497 if (o
== target
&& *o
== '/')
1507 return make_string (target
, o
- target
);
1511 /* If /~ or // appears, discard everything through first slash. */
1513 file_name_absolute_p (const char *filename
)
1516 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1518 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1519 && IS_DIRECTORY_SEP (filename
[2]))
1525 search_embedded_absfilename (char *nm
, char *endp
)
1529 for (p
= nm
+ 1; p
< endp
; p
++)
1531 if (IS_DIRECTORY_SEP (p
[-1])
1532 && file_name_absolute_p (p
)
1533 #if defined (WINDOWSNT) || defined (CYGWIN)
1534 /* // at start of file name is meaningful in Apollo,
1535 WindowsNT and Cygwin systems. */
1536 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1537 #endif /* not (WINDOWSNT || CYGWIN) */
1540 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1541 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1543 char *o
= alloca (s
- p
+ 1);
1545 memcpy (o
, p
, s
- p
);
1548 /* If we have ~user and `user' exists, discard
1549 everything up to ~. But if `user' does not exist, leave
1550 ~user alone, it might be a literal file name. */
1552 pw
= getpwnam (o
+ 1);
1564 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1565 Ssubstitute_in_file_name
, 1, 1, 0,
1566 doc
: /* Substitute environment variables referred to in FILENAME.
1567 `$FOO' where FOO is an environment variable name means to substitute
1568 the value of that variable. The variable name should be terminated
1569 with a character not a letter, digit or underscore; otherwise, enclose
1570 the entire variable name in braces.
1572 If `/~' appears, all of FILENAME through that `/' is discarded.
1573 If `//' appears, everything up to and including the first of
1574 those `/' is discarded. */)
1575 (Lisp_Object filename
)
1577 char *nm
, *s
, *p
, *o
, *x
, *endp
;
1578 char *target
= NULL
;
1580 bool substituted
= 0;
1583 Lisp_Object handler
;
1585 CHECK_STRING (filename
);
1587 multibyte
= STRING_MULTIBYTE (filename
);
1589 /* If the file name has special constructs in it,
1590 call the corresponding file handler. */
1591 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1592 if (!NILP (handler
))
1594 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1596 if (STRINGP (handled_name
))
1597 return handled_name
;
1598 error ("Invalid handler in `file-name-handler-alist'");
1601 /* Always work on a copy of the string, in case GC happens during
1602 decode of environment variables, causing the original Lisp_String
1603 data to be relocated. */
1604 nm
= alloca (SBYTES (filename
) + 1);
1605 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1609 Lisp_Object encoded_filename
= ENCODE_FILE (filename
);
1612 dostounix_filename (SDATA (encoded_filename
));
1613 tem_fn
= DECODE_FILE (encoded_filename
);
1614 nm
= alloca (SBYTES (tem_fn
) + 1);
1615 memcpy (nm
, SDATA (tem_fn
), SBYTES (tem_fn
) + 1);
1616 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1621 endp
= nm
+ SBYTES (filename
);
1623 /* If /~ or // appears, discard everything through first slash. */
1624 p
= search_embedded_absfilename (nm
, endp
);
1626 /* Start over with the new string, so we check the file-name-handler
1627 again. Important with filenames like "/home/foo//:/hello///there"
1628 which would substitute to "/:/hello///there" rather than "/there". */
1629 return Fsubstitute_in_file_name
1630 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1632 /* See if any variables are substituted into the string
1633 and find the total length of their values in `total'. */
1635 for (p
= nm
; p
!= endp
;)
1645 /* "$$" means a single "$". */
1654 while (p
!= endp
&& *p
!= '}') p
++;
1655 if (*p
!= '}') goto missingclose
;
1661 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1665 /* Copy out the variable name. */
1666 target
= alloca (s
- o
+ 1);
1667 memcpy (target
, o
, s
- o
);
1670 strupr (target
); /* $home == $HOME etc. */
1673 /* Get variable value. */
1674 o
= egetenv (target
);
1677 /* Don't try to guess a maximum length - UTF8 can use up to
1678 four bytes per character. This code is unlikely to run
1679 in a situation that requires performance, so decoding the
1680 env variables twice should be acceptable. Note that
1681 decoding may cause a garbage collect. */
1682 Lisp_Object orig
, decoded
;
1683 orig
= build_unibyte_string (o
);
1684 decoded
= DECODE_FILE (orig
);
1685 total
+= SBYTES (decoded
);
1695 /* If substitution required, recopy the string and do it. */
1696 /* Make space in stack frame for the new copy. */
1697 xnm
= alloca (SBYTES (filename
) + total
+ 1);
1700 /* Copy the rest of the name through, replacing $ constructs with values. */
1717 while (p
!= endp
&& *p
!= '}') p
++;
1718 if (*p
!= '}') goto missingclose
;
1724 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1728 /* Copy out the variable name. */
1729 target
= alloca (s
- o
+ 1);
1730 memcpy (target
, o
, s
- o
);
1733 strupr (target
); /* $home == $HOME etc. */
1736 /* Get variable value. */
1737 o
= egetenv (target
);
1741 strcpy (x
, target
); x
+= strlen (target
);
1745 Lisp_Object orig
, decoded
;
1746 ptrdiff_t orig_length
, decoded_length
;
1747 orig_length
= strlen (o
);
1748 orig
= make_unibyte_string (o
, orig_length
);
1749 decoded
= DECODE_FILE (orig
);
1750 decoded_length
= SBYTES (decoded
);
1751 memcpy (x
, SDATA (decoded
), decoded_length
);
1752 x
+= decoded_length
;
1754 /* If environment variable needed decoding, return value
1755 needs to be multibyte. */
1756 if (decoded_length
!= orig_length
1757 || memcmp (SDATA (decoded
), o
, orig_length
))
1764 /* If /~ or // appears, discard everything through first slash. */
1765 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1766 /* This time we do not start over because we've already expanded envvars
1767 and replaced $$ with $. Maybe we should start over as well, but we'd
1768 need to quote some $ to $$ first. */
1771 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1774 error ("Bad format environment-variable substitution");
1776 error ("Missing \"}\" in environment-variable substitution");
1778 error ("Substituting nonexistent environment variable \"%s\"", target
);
1784 /* A slightly faster and more convenient way to get
1785 (directory-file-name (expand-file-name FOO)). */
1788 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1790 register Lisp_Object absname
;
1792 absname
= Fexpand_file_name (filename
, defdir
);
1794 /* Remove final slash, if any (unless this is the root dir).
1795 stat behaves differently depending! */
1796 if (SCHARS (absname
) > 1
1797 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1798 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1799 /* We cannot take shortcuts; they might be wrong for magic file names. */
1800 absname
= Fdirectory_file_name (absname
);
1804 /* Signal an error if the file ABSNAME already exists.
1805 If INTERACTIVE, ask the user whether to proceed,
1806 and bypass the error if the user says to go ahead.
1807 QUERYSTRING is a name for the action that is being considered
1810 *STATPTR is used to store the stat information if the file exists.
1811 If the file does not exist, STATPTR->st_mode is set to 0.
1812 If STATPTR is null, we don't store into it.
1814 If QUICK, ask for y or n, not yes or no. */
1817 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1818 bool interactive
, struct stat
*statptr
,
1821 Lisp_Object tem
, encoded_filename
;
1822 struct stat statbuf
;
1823 struct gcpro gcpro1
;
1825 encoded_filename
= ENCODE_FILE (absname
);
1827 /* `stat' is a good way to tell whether the file exists,
1828 regardless of what access permissions it has. */
1829 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1831 if (S_ISDIR (statbuf
.st_mode
))
1832 xsignal2 (Qfile_error
,
1833 build_string ("File is a directory"), absname
);
1836 xsignal2 (Qfile_already_exists
,
1837 build_string ("File already exists"), absname
);
1839 tem
= format2 ("File %s already exists; %s anyway? ",
1840 absname
, build_string (querystring
));
1842 tem
= call1 (intern ("y-or-n-p"), tem
);
1844 tem
= do_yes_or_no_p (tem
);
1847 xsignal2 (Qfile_already_exists
,
1848 build_string ("File already exists"), absname
);
1855 statptr
->st_mode
= 0;
1860 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1861 "fCopy file: \nGCopy %s to file: \np\nP",
1862 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1863 If NEWNAME names a directory, copy FILE there.
1865 This function always sets the file modes of the output file to match
1868 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1869 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1870 signal a `file-already-exists' error without overwriting. If
1871 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1872 about overwriting; this is what happens in interactive use with M-x.
1873 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1876 Fourth arg KEEP-TIME non-nil means give the output file the same
1877 last-modified time as the old one. (This works on only some systems.)
1879 A prefix arg makes KEEP-TIME non-nil.
1881 If PRESERVE-UID-GID is non-nil, we try to transfer the
1882 uid and gid of FILE to NEWNAME.
1884 If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
1885 on the system, we copy the SELinux context of FILE to NEWNAME. */)
1886 (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
)
1890 char buf
[16 * 1024];
1891 struct stat st
, out_st
;
1892 Lisp_Object handler
;
1893 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1894 ptrdiff_t count
= SPECPDL_INDEX ();
1895 bool input_file_statable_p
;
1896 Lisp_Object encoded_file
, encoded_newname
;
1898 security_context_t con
;
1902 encoded_file
= encoded_newname
= Qnil
;
1903 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1904 CHECK_STRING (file
);
1905 CHECK_STRING (newname
);
1907 if (!NILP (Ffile_directory_p (newname
)))
1908 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1910 newname
= Fexpand_file_name (newname
, Qnil
);
1912 file
= Fexpand_file_name (file
, Qnil
);
1914 /* If the input file name has special constructs in it,
1915 call the corresponding file handler. */
1916 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1917 /* Likewise for output file name. */
1919 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1920 if (!NILP (handler
))
1921 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1922 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1923 preserve_selinux_context
));
1925 encoded_file
= ENCODE_FILE (file
);
1926 encoded_newname
= ENCODE_FILE (newname
);
1928 if (NILP (ok_if_already_exists
)
1929 || INTEGERP (ok_if_already_exists
))
1930 barf_or_query_if_file_exists (newname
, "copy to it",
1931 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1932 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1936 if (!CopyFile (SDATA (encoded_file
),
1937 SDATA (encoded_newname
),
1939 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1940 /* CopyFile retains the timestamp by default. */
1941 else if (NILP (keep_time
))
1947 filename
= SDATA (encoded_newname
);
1949 /* Ensure file is writable while its modified time is set. */
1950 attributes
= GetFileAttributes (filename
);
1951 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1952 now
= current_emacs_time ();
1953 if (set_file_times (-1, filename
, now
, now
))
1955 /* Restore original attributes. */
1956 SetFileAttributes (filename
, attributes
);
1957 xsignal2 (Qfile_date_error
,
1958 build_string ("Cannot set file date"), newname
);
1960 /* Restore original attributes. */
1961 SetFileAttributes (filename
, attributes
);
1963 #else /* not WINDOWSNT */
1965 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
1969 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1971 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1973 /* We can only copy regular files and symbolic links. Other files are not
1975 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
1978 if (!NILP (preserve_selinux_context
) && is_selinux_enabled ())
1980 conlength
= fgetfilecon (ifd
, &con
);
1981 if (conlength
== -1)
1982 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
1986 if (out_st
.st_mode
!= 0
1987 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
1990 report_file_error ("Input and output files are the same",
1991 Fcons (file
, Fcons (newname
, Qnil
)));
1994 if (input_file_statable_p
)
1996 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
1998 /* Get a better looking error message. */
2000 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2005 /* System's default file type was set to binary by _fmode in emacs.c. */
2006 ofd
= emacs_open (SDATA (encoded_newname
),
2007 O_WRONLY
| O_TRUNC
| O_CREAT
2008 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2009 S_IREAD
| S_IWRITE
);
2010 #else /* not MSDOS */
2012 mode_t new_mask
= 0666;
2013 if (input_file_statable_p
)
2015 if (!NILP (preserve_uid_gid
))
2017 new_mask
&= st
.st_mode
;
2019 ofd
= emacs_open (SSDATA (encoded_newname
),
2020 (O_WRONLY
| O_TRUNC
| O_CREAT
2021 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2024 #endif /* not MSDOS */
2026 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2028 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2032 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2033 if (emacs_write (ofd
, buf
, n
) != n
)
2034 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2038 /* Preserve the original file modes, and if requested, also its
2040 if (input_file_statable_p
)
2042 mode_t mode_mask
= 07777;
2043 if (!NILP (preserve_uid_gid
))
2045 /* Attempt to change owner and group. If that doesn't work
2046 attempt to change just the group, as that is sometimes allowed.
2047 Adjust the mode mask to eliminate setuid or setgid bits
2048 that are inappropriate if the owner and group are wrong. */
2049 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2051 mode_mask
&= ~06000;
2052 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2056 if (fchmod (ofd
, st
.st_mode
& mode_mask
) != 0)
2057 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
2059 #endif /* not MSDOS */
2064 /* Set the modified context back to the file. */
2065 bool fail
= fsetfilecon (ofd
, con
) != 0;
2066 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2067 if (fail
&& errno
!= ENOTSUP
)
2068 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2074 if (input_file_statable_p
)
2076 if (!NILP (keep_time
))
2078 EMACS_TIME atime
= get_stat_atime (&st
);
2079 EMACS_TIME mtime
= get_stat_mtime (&st
);
2080 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2081 xsignal2 (Qfile_date_error
,
2082 build_string ("Cannot set file date"), newname
);
2086 if (emacs_close (ofd
) < 0)
2087 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2092 if (input_file_statable_p
)
2094 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2095 and if it can't, it tells so. Otherwise, under MSDOS we usually
2096 get only the READ bit, which will make the copied file read-only,
2097 so it's better not to chmod at all. */
2098 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2099 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2102 #endif /* not WINDOWSNT */
2104 /* Discard the unwind protects. */
2105 specpdl_ptr
= specpdl
+ count
;
2111 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2112 Smake_directory_internal
, 1, 1, 0,
2113 doc
: /* Create a new directory named DIRECTORY. */)
2114 (Lisp_Object directory
)
2117 Lisp_Object handler
;
2118 Lisp_Object encoded_dir
;
2120 CHECK_STRING (directory
);
2121 directory
= Fexpand_file_name (directory
, Qnil
);
2123 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2124 if (!NILP (handler
))
2125 return call2 (handler
, Qmake_directory_internal
, directory
);
2127 encoded_dir
= ENCODE_FILE (directory
);
2129 dir
= SSDATA (encoded_dir
);
2132 if (mkdir (dir
) != 0)
2134 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2136 report_file_error ("Creating directory", list1 (directory
));
2141 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2142 Sdelete_directory_internal
, 1, 1, 0,
2143 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2144 (Lisp_Object directory
)
2147 Lisp_Object encoded_dir
;
2149 CHECK_STRING (directory
);
2150 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2151 encoded_dir
= ENCODE_FILE (directory
);
2152 dir
= SSDATA (encoded_dir
);
2154 if (rmdir (dir
) != 0)
2155 report_file_error ("Removing directory", list1 (directory
));
2160 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2161 "(list (read-file-name \
2162 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2163 \"Move file to trash: \" \"Delete file: \") \
2164 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2165 (null current-prefix-arg))",
2166 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2167 If file has multiple names, it continues to exist with the other names.
2168 TRASH non-nil means to trash the file instead of deleting, provided
2169 `delete-by-moving-to-trash' is non-nil.
2171 When called interactively, TRASH is t if no prefix argument is given.
2172 With a prefix argument, TRASH is nil. */)
2173 (Lisp_Object filename
, Lisp_Object trash
)
2175 Lisp_Object handler
;
2176 Lisp_Object encoded_file
;
2177 struct gcpro gcpro1
;
2180 if (!NILP (Ffile_directory_p (filename
))
2181 && NILP (Ffile_symlink_p (filename
)))
2182 xsignal2 (Qfile_error
,
2183 build_string ("Removing old name: is a directory"),
2186 filename
= Fexpand_file_name (filename
, Qnil
);
2188 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2189 if (!NILP (handler
))
2190 return call3 (handler
, Qdelete_file
, filename
, trash
);
2192 if (delete_by_moving_to_trash
&& !NILP (trash
))
2193 return call1 (Qmove_file_to_trash
, filename
);
2195 encoded_file
= ENCODE_FILE (filename
);
2197 if (unlink (SSDATA (encoded_file
)) < 0)
2198 report_file_error ("Removing old name", list1 (filename
));
2203 internal_delete_file_1 (Lisp_Object ignore
)
2208 /* Delete file FILENAME.
2209 This ignores `delete-by-moving-to-trash'. */
2212 internal_delete_file (Lisp_Object filename
)
2214 internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2215 Qt
, internal_delete_file_1
);
2218 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2219 "fRename file: \nGRename %s to file: \np",
2220 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2221 If file has names other than FILE, it continues to have those names.
2222 Signals a `file-already-exists' error if a file NEWNAME already exists
2223 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2224 A number as third arg means request confirmation if NEWNAME already exists.
2225 This is what happens in interactive use with M-x. */)
2226 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2228 Lisp_Object handler
;
2229 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2230 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2232 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2233 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2234 CHECK_STRING (file
);
2235 CHECK_STRING (newname
);
2236 file
= Fexpand_file_name (file
, Qnil
);
2238 if ((!NILP (Ffile_directory_p (newname
)))
2240 /* If the file names are identical but for the case,
2241 don't attempt to move directory to itself. */
2242 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2246 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2247 ? file
: Fdirectory_file_name (file
));
2248 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2251 newname
= Fexpand_file_name (newname
, Qnil
);
2253 /* If the file name has special constructs in it,
2254 call the corresponding file handler. */
2255 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2257 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2258 if (!NILP (handler
))
2259 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2260 file
, newname
, ok_if_already_exists
));
2262 encoded_file
= ENCODE_FILE (file
);
2263 encoded_newname
= ENCODE_FILE (newname
);
2266 /* If the file names are identical but for the case, don't ask for
2267 confirmation: they simply want to change the letter-case of the
2269 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2271 if (NILP (ok_if_already_exists
)
2272 || INTEGERP (ok_if_already_exists
))
2273 barf_or_query_if_file_exists (newname
, "rename to it",
2274 INTEGERP (ok_if_already_exists
), 0, 0);
2275 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2280 symlink_target
= Ffile_symlink_p (file
);
2281 if (! NILP (symlink_target
))
2282 Fmake_symbolic_link (symlink_target
, newname
,
2283 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2284 else if (!NILP (Ffile_directory_p (file
)))
2285 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2287 /* We have already prompted if it was an integer, so don't
2288 have copy-file prompt again. */
2289 Fcopy_file (file
, newname
,
2290 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2293 count
= SPECPDL_INDEX ();
2294 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2296 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2297 call2 (Qdelete_directory
, file
, Qt
);
2299 Fdelete_file (file
, Qnil
);
2300 unbind_to (count
, Qnil
);
2303 report_file_error ("Renaming", list2 (file
, newname
));
2309 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2310 "fAdd name to file: \nGName to add to %s: \np",
2311 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2312 Signals a `file-already-exists' error if a file NEWNAME already exists
2313 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2314 A number as third arg means request confirmation if NEWNAME already exists.
2315 This is what happens in interactive use with M-x. */)
2316 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2318 Lisp_Object handler
;
2319 Lisp_Object encoded_file
, encoded_newname
;
2320 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2322 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2323 encoded_file
= encoded_newname
= Qnil
;
2324 CHECK_STRING (file
);
2325 CHECK_STRING (newname
);
2326 file
= Fexpand_file_name (file
, Qnil
);
2328 if (!NILP (Ffile_directory_p (newname
)))
2329 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2331 newname
= Fexpand_file_name (newname
, Qnil
);
2333 /* If the file name has special constructs in it,
2334 call the corresponding file handler. */
2335 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2336 if (!NILP (handler
))
2337 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2338 newname
, ok_if_already_exists
));
2340 /* If the new name has special constructs in it,
2341 call the corresponding file handler. */
2342 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2343 if (!NILP (handler
))
2344 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2345 newname
, ok_if_already_exists
));
2347 encoded_file
= ENCODE_FILE (file
);
2348 encoded_newname
= ENCODE_FILE (newname
);
2350 if (NILP (ok_if_already_exists
)
2351 || INTEGERP (ok_if_already_exists
))
2352 barf_or_query_if_file_exists (newname
, "make it a new name",
2353 INTEGERP (ok_if_already_exists
), 0, 0);
2355 unlink (SSDATA (newname
));
2356 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2357 report_file_error ("Adding new name", list2 (file
, newname
));
2363 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2364 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2365 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2366 Both args must be strings.
2367 Signals a `file-already-exists' error if a file LINKNAME already exists
2368 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2369 A number as third arg means request confirmation if LINKNAME already exists.
2370 This happens for interactive use with M-x. */)
2371 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2373 Lisp_Object handler
;
2374 Lisp_Object encoded_filename
, encoded_linkname
;
2375 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2377 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2378 encoded_filename
= encoded_linkname
= Qnil
;
2379 CHECK_STRING (filename
);
2380 CHECK_STRING (linkname
);
2381 /* If the link target has a ~, we must expand it to get
2382 a truly valid file name. Otherwise, do not expand;
2383 we want to permit links to relative file names. */
2384 if (SREF (filename
, 0) == '~')
2385 filename
= Fexpand_file_name (filename
, Qnil
);
2387 if (!NILP (Ffile_directory_p (linkname
)))
2388 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2390 linkname
= Fexpand_file_name (linkname
, Qnil
);
2392 /* If the file name has special constructs in it,
2393 call the corresponding file handler. */
2394 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2395 if (!NILP (handler
))
2396 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2397 linkname
, ok_if_already_exists
));
2399 /* If the new link name has special constructs in it,
2400 call the corresponding file handler. */
2401 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2402 if (!NILP (handler
))
2403 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2404 linkname
, ok_if_already_exists
));
2406 encoded_filename
= ENCODE_FILE (filename
);
2407 encoded_linkname
= ENCODE_FILE (linkname
);
2409 if (NILP (ok_if_already_exists
)
2410 || INTEGERP (ok_if_already_exists
))
2411 barf_or_query_if_file_exists (linkname
, "make it a link",
2412 INTEGERP (ok_if_already_exists
), 0, 0);
2413 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2415 /* If we didn't complain already, silently delete existing file. */
2416 if (errno
== EEXIST
)
2418 unlink (SSDATA (encoded_linkname
));
2419 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2426 if (errno
== ENOSYS
)
2429 xsignal1 (Qfile_error
,
2430 build_string ("Symbolic links are not supported"));
2433 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2440 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2442 doc
: /* Return t if file FILENAME specifies an absolute file name.
2443 On Unix, this is a name starting with a `/' or a `~'. */)
2444 (Lisp_Object filename
)
2446 CHECK_STRING (filename
);
2447 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2450 /* Return true if FILENAME exists. */
2452 check_existing (const char *filename
)
2454 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
2457 /* Return true if file FILENAME exists and can be executed. */
2460 check_executable (char *filename
)
2462 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
2465 /* Return true if file FILENAME exists and can be accessed
2466 according to AMODE, which should include W_OK.
2467 On failure, return false and set errno. */
2470 check_writable (const char *filename
, int amode
)
2473 /* FIXME: an faccessat implementation should be added to the
2474 DOS/Windows ports and this #ifdef branch should be removed. */
2476 if (stat (filename
, &st
) < 0)
2479 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2480 #else /* not MSDOS */
2481 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
2483 /* faccessat may have returned failure because Cygwin couldn't
2484 determine the file's UID or GID; if so, we return success. */
2487 int faccessat_errno
= errno
;
2489 if (stat (filename
, &st
) < 0)
2491 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2492 errno
= faccessat_errno
;
2496 #endif /* not MSDOS */
2499 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2500 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2501 See also `file-readable-p' and `file-attributes'.
2502 This returns nil for a symlink to a nonexistent file.
2503 Use `file-symlink-p' to test for such links. */)
2504 (Lisp_Object filename
)
2506 Lisp_Object absname
;
2507 Lisp_Object handler
;
2509 CHECK_STRING (filename
);
2510 absname
= Fexpand_file_name (filename
, Qnil
);
2512 /* If the file name has special constructs in it,
2513 call the corresponding file handler. */
2514 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2515 if (!NILP (handler
))
2516 return call2 (handler
, Qfile_exists_p
, absname
);
2518 absname
= ENCODE_FILE (absname
);
2520 return (check_existing (SSDATA (absname
))) ? Qt
: Qnil
;
2523 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2524 doc
: /* Return t if FILENAME can be executed by you.
2525 For a directory, this means you can access files in that directory. */)
2526 (Lisp_Object filename
)
2528 Lisp_Object absname
;
2529 Lisp_Object handler
;
2531 CHECK_STRING (filename
);
2532 absname
= Fexpand_file_name (filename
, Qnil
);
2534 /* If the file name has special constructs in it,
2535 call the corresponding file handler. */
2536 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2537 if (!NILP (handler
))
2538 return call2 (handler
, Qfile_executable_p
, absname
);
2540 absname
= ENCODE_FILE (absname
);
2542 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2545 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2546 doc
: /* Return t if file FILENAME exists and you can read it.
2547 See also `file-exists-p' and `file-attributes'. */)
2548 (Lisp_Object filename
)
2550 Lisp_Object absname
;
2551 Lisp_Object handler
;
2553 CHECK_STRING (filename
);
2554 absname
= Fexpand_file_name (filename
, Qnil
);
2556 /* If the file name has special constructs in it,
2557 call the corresponding file handler. */
2558 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2559 if (!NILP (handler
))
2560 return call2 (handler
, Qfile_readable_p
, absname
);
2562 absname
= ENCODE_FILE (absname
);
2563 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2567 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2568 doc
: /* Return t if file FILENAME can be written or created by you. */)
2569 (Lisp_Object filename
)
2571 Lisp_Object absname
, dir
, encoded
;
2572 Lisp_Object handler
;
2574 CHECK_STRING (filename
);
2575 absname
= Fexpand_file_name (filename
, Qnil
);
2577 /* If the file name has special constructs in it,
2578 call the corresponding file handler. */
2579 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2580 if (!NILP (handler
))
2581 return call2 (handler
, Qfile_writable_p
, absname
);
2583 encoded
= ENCODE_FILE (absname
);
2584 if (check_writable (SSDATA (encoded
), W_OK
))
2586 if (errno
!= ENOENT
)
2589 dir
= Ffile_name_directory (absname
);
2590 eassert (!NILP (dir
));
2592 dir
= Fdirectory_file_name (dir
);
2595 dir
= ENCODE_FILE (dir
);
2597 /* The read-only attribute of the parent directory doesn't affect
2598 whether a file or directory can be created within it. Some day we
2599 should check ACLs though, which do affect this. */
2600 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2602 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2606 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2607 doc
: /* Access file FILENAME, and get an error if that does not work.
2608 The second argument STRING is used in the error message.
2609 If there is no error, returns nil. */)
2610 (Lisp_Object filename
, Lisp_Object string
)
2612 Lisp_Object handler
, encoded_filename
, absname
;
2615 CHECK_STRING (filename
);
2616 absname
= Fexpand_file_name (filename
, Qnil
);
2618 CHECK_STRING (string
);
2620 /* If the file name has special constructs in it,
2621 call the corresponding file handler. */
2622 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2623 if (!NILP (handler
))
2624 return call3 (handler
, Qaccess_file
, absname
, string
);
2626 encoded_filename
= ENCODE_FILE (absname
);
2628 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2630 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2636 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2637 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2638 The value is the link target, as a string.
2639 Otherwise it returns nil.
2641 This function returns t when given the name of a symlink that
2642 points to a nonexistent file. */)
2643 (Lisp_Object filename
)
2645 Lisp_Object handler
;
2648 char readlink_buf
[READLINK_BUFSIZE
];
2650 CHECK_STRING (filename
);
2651 filename
= Fexpand_file_name (filename
, Qnil
);
2653 /* If the file name has special constructs in it,
2654 call the corresponding file handler. */
2655 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2656 if (!NILP (handler
))
2657 return call2 (handler
, Qfile_symlink_p
, filename
);
2659 filename
= ENCODE_FILE (filename
);
2661 buf
= emacs_readlink (SSDATA (filename
), readlink_buf
);
2665 val
= build_string (buf
);
2666 if (buf
[0] == '/' && strchr (buf
, ':'))
2667 val
= concat2 (build_string ("/:"), val
);
2668 if (buf
!= readlink_buf
)
2670 val
= DECODE_FILE (val
);
2674 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2675 doc
: /* Return t if FILENAME names an existing directory.
2676 Symbolic links to directories count as directories.
2677 See `file-symlink-p' to distinguish symlinks. */)
2678 (Lisp_Object filename
)
2680 Lisp_Object absname
;
2681 Lisp_Object handler
;
2683 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2685 /* If the file name has special constructs in it,
2686 call the corresponding file handler. */
2687 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2688 if (!NILP (handler
))
2689 return call2 (handler
, Qfile_directory_p
, absname
);
2691 absname
= ENCODE_FILE (absname
);
2693 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2696 /* Return true if FILE is a directory or a symlink to a directory. */
2698 file_directory_p (char const *file
)
2701 /* This is cheaper than 'stat'. */
2702 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2705 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2709 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2710 Sfile_accessible_directory_p
, 1, 1, 0,
2711 doc
: /* Return t if file FILENAME names a directory you can open.
2712 For the value to be t, FILENAME must specify the name of a directory as a file,
2713 and the directory must allow you to open files in it. In order to use a
2714 directory as a buffer's current directory, this predicate must return true.
2715 A directory name spec may be given instead; then the value is t
2716 if the directory so specified exists and really is a readable and
2717 searchable directory. */)
2718 (Lisp_Object filename
)
2720 Lisp_Object absname
;
2721 Lisp_Object handler
;
2723 CHECK_STRING (filename
);
2724 absname
= Fexpand_file_name (filename
, Qnil
);
2726 /* If the file name has special constructs in it,
2727 call the corresponding file handler. */
2728 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2729 if (!NILP (handler
))
2730 return call2 (handler
, Qfile_accessible_directory_p
, absname
);
2732 absname
= ENCODE_FILE (absname
);
2733 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2736 /* If FILE is a searchable directory or a symlink to a
2737 searchable directory, return true. Otherwise return
2738 false and set errno to an error number. */
2740 file_accessible_directory_p (char const *file
)
2743 /* There's no need to test whether FILE is searchable, as the
2744 searchable/executable bit is invented on DOS_NT platforms. */
2745 return file_directory_p (file
);
2747 /* On POSIXish platforms, use just one system call; this avoids a
2748 race and is typically faster. */
2749 ptrdiff_t len
= strlen (file
);
2755 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2756 There are three exceptions: "", "/", and "//". Leave "" alone,
2757 as it's invalid. Append only "." to the other two exceptions as
2758 "/" and "//" are distinct on some platforms, whereas "/", "///",
2759 "////", etc. are all equivalent. */
2764 /* Just check for trailing '/' when deciding whether to append '/'.
2765 That's simpler than testing the two special cases "/" and "//",
2766 and it's a safe optimization here. */
2767 char *buf
= SAFE_ALLOCA (len
+ 3);
2768 memcpy (buf
, file
, len
);
2769 strcpy (buf
+ len
, "/." + (file
[len
- 1] == '/'));
2773 ok
= check_existing (dir
);
2774 saved_errno
= errno
;
2776 errno
= saved_errno
;
2781 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2782 doc
: /* Return t if FILENAME names a regular file.
2783 This is the sort of file that holds an ordinary stream of data bytes.
2784 Symbolic links to regular files count as regular files.
2785 See `file-symlink-p' to distinguish symlinks. */)
2786 (Lisp_Object filename
)
2788 register Lisp_Object absname
;
2790 Lisp_Object handler
;
2792 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2794 /* If the file name has special constructs in it,
2795 call the corresponding file handler. */
2796 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2797 if (!NILP (handler
))
2798 return call2 (handler
, Qfile_regular_p
, absname
);
2800 absname
= ENCODE_FILE (absname
);
2805 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2807 /* Tell stat to use expensive method to get accurate info. */
2808 Vw32_get_true_file_attributes
= Qt
;
2809 result
= stat (SDATA (absname
), &st
);
2810 Vw32_get_true_file_attributes
= tem
;
2814 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2817 if (stat (SSDATA (absname
), &st
) < 0)
2819 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2823 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2824 Sfile_selinux_context
, 1, 1, 0,
2825 doc
: /* Return SELinux context of file named FILENAME.
2826 The return value is a list (USER ROLE TYPE RANGE), where the list
2827 elements are strings naming the user, role, type, and range of the
2828 file's SELinux security context.
2830 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2831 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2832 (Lisp_Object filename
)
2834 Lisp_Object absname
;
2835 Lisp_Object values
[4];
2836 Lisp_Object handler
;
2838 security_context_t con
;
2843 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2845 /* If the file name has special constructs in it,
2846 call the corresponding file handler. */
2847 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2848 if (!NILP (handler
))
2849 return call2 (handler
, Qfile_selinux_context
, absname
);
2851 absname
= ENCODE_FILE (absname
);
2858 if (is_selinux_enabled ())
2860 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2863 context
= context_new (con
);
2864 if (context_user_get (context
))
2865 values
[0] = build_string (context_user_get (context
));
2866 if (context_role_get (context
))
2867 values
[1] = build_string (context_role_get (context
));
2868 if (context_type_get (context
))
2869 values
[2] = build_string (context_type_get (context
));
2870 if (context_range_get (context
))
2871 values
[3] = build_string (context_range_get (context
));
2872 context_free (context
);
2878 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2881 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2882 Sset_file_selinux_context
, 2, 2, 0,
2883 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2884 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2885 elements are strings naming the components of a SELinux context.
2887 This function does nothing if SELinux is disabled, or if Emacs was not
2888 compiled with SELinux support. */)
2889 (Lisp_Object filename
, Lisp_Object context
)
2891 Lisp_Object absname
;
2892 Lisp_Object handler
;
2894 Lisp_Object encoded_absname
;
2895 Lisp_Object user
= CAR_SAFE (context
);
2896 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2897 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2898 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2899 security_context_t con
;
2902 context_t parsed_con
;
2905 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
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_selinux_context
);
2910 if (!NILP (handler
))
2911 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2914 if (is_selinux_enabled ())
2916 /* Get current file context. */
2917 encoded_absname
= ENCODE_FILE (absname
);
2918 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2921 parsed_con
= context_new (con
);
2922 /* Change the parts defined in the parameter.*/
2925 if (context_user_set (parsed_con
, SSDATA (user
)))
2926 error ("Doing context_user_set");
2930 if (context_role_set (parsed_con
, SSDATA (role
)))
2931 error ("Doing context_role_set");
2935 if (context_type_set (parsed_con
, SSDATA (type
)))
2936 error ("Doing context_type_set");
2938 if (STRINGP (range
))
2940 if (context_range_set (parsed_con
, SSDATA (range
)))
2941 error ("Doing context_range_set");
2944 /* Set the modified context back to the file. */
2945 fail
= (lsetfilecon (SSDATA (encoded_absname
),
2946 context_str (parsed_con
))
2948 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2949 if (fail
&& errno
!= ENOTSUP
)
2950 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
2952 context_free (parsed_con
);
2956 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
2963 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2964 doc
: /* Return mode bits of file named FILENAME, as an integer.
2965 Return nil, if file does not exist or is not accessible. */)
2966 (Lisp_Object filename
)
2968 Lisp_Object absname
;
2970 Lisp_Object handler
;
2972 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2974 /* If the file name has special constructs in it,
2975 call the corresponding file handler. */
2976 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2977 if (!NILP (handler
))
2978 return call2 (handler
, Qfile_modes
, absname
);
2980 absname
= ENCODE_FILE (absname
);
2982 if (stat (SSDATA (absname
), &st
) < 0)
2985 return make_number (st
.st_mode
& 07777);
2988 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2989 "(let ((file (read-file-name \"File: \"))) \
2990 (list file (read-file-modes nil file)))",
2991 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2992 Only the 12 low bits of MODE are used.
2994 Interactively, mode bits are read by `read-file-modes', which accepts
2995 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2996 (Lisp_Object filename
, Lisp_Object mode
)
2998 Lisp_Object absname
, encoded_absname
;
2999 Lisp_Object handler
;
3001 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3002 CHECK_NUMBER (mode
);
3004 /* If the file name has special constructs in it,
3005 call the corresponding file handler. */
3006 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3007 if (!NILP (handler
))
3008 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3010 encoded_absname
= ENCODE_FILE (absname
);
3012 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3013 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3018 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3019 doc
: /* Set the file permission bits for newly created files.
3020 The argument MODE should be an integer; only the low 9 bits are used.
3021 This setting is inherited by subprocesses. */)
3024 CHECK_NUMBER (mode
);
3026 umask ((~ XINT (mode
)) & 0777);
3031 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3032 doc
: /* Return the default file protection for created files.
3033 The value is an integer. */)
3040 realmask
= umask (0);
3044 XSETINT (value
, (~ realmask
) & 0777);
3049 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3050 doc
: /* Set times of file FILENAME to TIMESTAMP.
3051 Set both access and modification times.
3052 Return t on success, else nil.
3053 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3055 (Lisp_Object filename
, Lisp_Object timestamp
)
3057 Lisp_Object absname
, encoded_absname
;
3058 Lisp_Object handler
;
3059 EMACS_TIME t
= lisp_time_argument (timestamp
);
3061 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3063 /* If the file name has special constructs in it,
3064 call the corresponding file handler. */
3065 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3066 if (!NILP (handler
))
3067 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3069 encoded_absname
= ENCODE_FILE (absname
);
3072 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3075 /* Setting times on a directory always fails. */
3076 if (file_directory_p (SSDATA (encoded_absname
)))
3079 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3088 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3089 doc
: /* Tell Unix to finish all pending disk updates. */)
3096 #endif /* HAVE_SYNC */
3098 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3099 doc
: /* Return t if file FILE1 is newer than file FILE2.
3100 If FILE1 does not exist, the answer is nil;
3101 otherwise, if FILE2 does not exist, the answer is t. */)
3102 (Lisp_Object file1
, Lisp_Object file2
)
3104 Lisp_Object absname1
, absname2
;
3105 struct stat st1
, st2
;
3106 Lisp_Object handler
;
3107 struct gcpro gcpro1
, gcpro2
;
3109 CHECK_STRING (file1
);
3110 CHECK_STRING (file2
);
3113 GCPRO2 (absname1
, file2
);
3114 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3115 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3118 /* If the file name has special constructs in it,
3119 call the corresponding file handler. */
3120 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3122 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3123 if (!NILP (handler
))
3124 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3126 GCPRO2 (absname1
, absname2
);
3127 absname1
= ENCODE_FILE (absname1
);
3128 absname2
= ENCODE_FILE (absname2
);
3131 if (stat (SSDATA (absname1
), &st1
) < 0)
3134 if (stat (SSDATA (absname2
), &st2
) < 0)
3137 return (EMACS_TIME_GT (get_stat_mtime (&st1
), get_stat_mtime (&st2
))
3141 #ifndef READ_BUF_SIZE
3142 #define READ_BUF_SIZE (64 << 10)
3144 /* Some buffer offsets are stored in 'int' variables. */
3145 verify (READ_BUF_SIZE
<= INT_MAX
);
3147 /* This function is called after Lisp functions to decide a coding
3148 system are called, or when they cause an error. Before they are
3149 called, the current buffer is set unibyte and it contains only a
3150 newly inserted text (thus the buffer was empty before the
3153 The functions may set markers, overlays, text properties, or even
3154 alter the buffer contents, change the current buffer.
3156 Here, we reset all those changes by:
3157 o set back the current buffer.
3158 o move all markers and overlays to BEG.
3159 o remove all text properties.
3160 o set back the buffer multibyteness. */
3163 decide_coding_unwind (Lisp_Object unwind_data
)
3165 Lisp_Object multibyte
, undo_list
, buffer
;
3167 multibyte
= XCAR (unwind_data
);
3168 unwind_data
= XCDR (unwind_data
);
3169 undo_list
= XCAR (unwind_data
);
3170 buffer
= XCDR (unwind_data
);
3172 set_buffer_internal (XBUFFER (buffer
));
3173 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3174 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3175 set_buffer_intervals (current_buffer
, NULL
);
3176 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3178 /* Now we are safe to change the buffer's multibyteness directly. */
3179 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3180 bset_undo_list (current_buffer
, undo_list
);
3186 /* Used to pass values from insert-file-contents to read_non_regular. */
3188 static int non_regular_fd
;
3189 static ptrdiff_t non_regular_inserted
;
3190 static int non_regular_nbytes
;
3193 /* Read from a non-regular file.
3194 Read non_regular_nbytes bytes max from non_regular_fd.
3195 Non_regular_inserted specifies where to put the read bytes.
3196 Value is the number of bytes read. */
3199 read_non_regular (Lisp_Object ignore
)
3205 nbytes
= emacs_read (non_regular_fd
,
3206 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3207 + non_regular_inserted
),
3208 non_regular_nbytes
);
3210 return make_number (nbytes
);
3214 /* Condition-case handler used when reading from non-regular files
3215 in insert-file-contents. */
3218 read_non_regular_quit (Lisp_Object ignore
)
3223 /* Reposition FD to OFFSET, based on WHENCE. This acts like lseek
3224 except that it also tests for OFFSET being out of lseek's range. */
3226 emacs_lseek (int fd
, EMACS_INT offset
, int whence
)
3228 /* Use "&" rather than "&&" to suppress a bogus GCC warning; see
3229 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43772>. */
3230 if (! ((offset
>= TYPE_MINIMUM (off_t
)) & (offset
<= TYPE_MAXIMUM (off_t
))))
3235 return lseek (fd
, offset
, whence
);
3238 /* Return a special time value indicating the error number ERRNUM. */
3240 time_error_value (int errnum
)
3242 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3243 ? NONEXISTENT_MODTIME_NSECS
3244 : UNKNOWN_MODTIME_NSECS
);
3245 return make_emacs_time (0, ns
);
3248 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3250 doc
: /* Insert contents of file FILENAME after point.
3251 Returns list of absolute file name and number of characters inserted.
3252 If second argument VISIT is non-nil, the buffer's visited filename and
3253 last save file modtime are set, and it is marked unmodified. If
3254 visiting and the file does not exist, visiting is completed before the
3257 The optional third and fourth arguments BEG and END specify what portion
3258 of the file to insert. These arguments count bytes in the file, not
3259 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3261 If optional fifth argument REPLACE is non-nil, replace the current
3262 buffer contents (in the accessible portion) with the file contents.
3263 This is better than simply deleting and inserting the whole thing
3264 because (1) it preserves some marker positions and (2) it puts less data
3265 in the undo list. When REPLACE is non-nil, the second return value is
3266 the number of characters that replace previous buffer contents.
3268 This function does code conversion according to the value of
3269 `coding-system-for-read' or `file-coding-system-alist', and sets the
3270 variable `last-coding-system-used' to the coding system actually used. */)
3271 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3277 ptrdiff_t inserted
= 0;
3280 off_t beg_offset
, end_offset
;
3282 ptrdiff_t count
= SPECPDL_INDEX ();
3283 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3284 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3286 ptrdiff_t total
= 0;
3287 bool not_regular
= 0;
3289 char read_buf
[READ_BUF_SIZE
];
3290 struct coding_system coding
;
3291 char buffer
[1 << 14];
3292 bool replace_handled
= 0;
3293 bool set_coding_system
= 0;
3294 Lisp_Object coding_system
;
3296 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3297 bool we_locked_file
= 0;
3298 bool deferred_remove_unwind_protect
= 0;
3300 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3301 error ("Cannot do file visiting in an indirect buffer");
3303 if (!NILP (BVAR (current_buffer
, read_only
)))
3304 Fbarf_if_buffer_read_only ();
3308 orig_filename
= Qnil
;
3311 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3313 CHECK_STRING (filename
);
3314 filename
= Fexpand_file_name (filename
, Qnil
);
3316 /* The value Qnil means that the coding system is not yet
3318 coding_system
= Qnil
;
3320 /* If the file name has special constructs in it,
3321 call the corresponding file handler. */
3322 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3323 if (!NILP (handler
))
3325 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3326 visit
, beg
, end
, replace
);
3327 if (CONSP (val
) && CONSP (XCDR (val
))
3328 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3329 inserted
= XINT (XCAR (XCDR (val
)));
3333 orig_filename
= filename
;
3334 filename
= ENCODE_FILE (filename
);
3340 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3342 /* Tell stat to use expensive method to get accurate info. */
3343 Vw32_get_true_file_attributes
= Qt
;
3344 file_status
= stat (SSDATA (filename
), &st
);
3345 Vw32_get_true_file_attributes
= tem
;
3348 file_status
= stat (SSDATA (filename
), &st
);
3349 #endif /* WINDOWSNT */
3351 if (file_status
== 0)
3352 mtime
= get_stat_mtime (&st
);
3358 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3359 mtime
= time_error_value (save_errno
);
3362 if (!NILP (Vcoding_system_for_read
))
3363 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3367 /* This code will need to be changed in order to work on named
3368 pipes, and it's probably just not worth it. So we should at
3369 least signal an error. */
3370 if (!S_ISREG (st
.st_mode
))
3377 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3378 xsignal2 (Qfile_error
,
3379 build_string ("not a regular file"), orig_filename
);
3383 if ((fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0)) < 0)
3386 /* Replacement should preserve point as it preserves markers. */
3387 if (!NILP (replace
))
3388 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3390 record_unwind_protect (close_file_unwind
, make_number (fd
));
3395 if (!NILP (beg
) || !NILP (end
))
3396 error ("Attempt to visit less than an entire file");
3397 if (BEG
< Z
&& NILP (replace
))
3398 error ("Cannot do file visiting in a non-empty buffer");
3403 if (! RANGED_INTEGERP (0, beg
, TYPE_MAXIMUM (off_t
)))
3404 wrong_type_argument (intern ("file-offset"), beg
);
3405 beg_offset
= XFASTINT (beg
);
3412 if (! RANGED_INTEGERP (0, end
, TYPE_MAXIMUM (off_t
)))
3413 wrong_type_argument (intern ("file-offset"), end
);
3414 end_offset
= XFASTINT (end
);
3419 end_offset
= TYPE_MAXIMUM (off_t
);
3422 end_offset
= st
.st_size
;
3424 /* A negative size can happen on a platform that allows file
3425 sizes greater than the maximum off_t value. */
3429 /* The file size returned from stat may be zero, but data
3430 may be readable nonetheless, for example when this is a
3431 file in the /proc filesystem. */
3432 if (end_offset
== 0)
3433 end_offset
= READ_BUF_SIZE
;
3437 /* Check now whether the buffer will become too large,
3438 in the likely case where the file's length is not changing.
3439 This saves a lot of needless work before a buffer overflow. */
3442 /* The likely offset where we will stop reading. We could read
3443 more (or less), if the file grows (or shrinks) as we read it. */
3444 off_t likely_end
= min (end_offset
, st
.st_size
);
3446 if (beg_offset
< likely_end
)
3449 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3450 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3451 off_t likely_growth
= likely_end
- beg_offset
;
3452 if (buf_growth_max
< likely_growth
)
3457 /* Prevent redisplay optimizations. */
3458 current_buffer
->clip_changed
= 1;
3460 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3462 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3463 setup_coding_system (coding_system
, &coding
);
3464 /* Ensure we set Vlast_coding_system_used. */
3465 set_coding_system
= 1;
3469 /* Decide the coding system to use for reading the file now
3470 because we can't use an optimized method for handling
3471 `coding:' tag if the current buffer is not empty. */
3472 if (!NILP (Vcoding_system_for_read
))
3473 coding_system
= Vcoding_system_for_read
;
3476 /* Don't try looking inside a file for a coding system
3477 specification if it is not seekable. */
3478 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3480 /* Find a coding system specified in the heading two
3481 lines or in the tailing several lines of the file.
3482 We assume that the 1K-byte and 3K-byte for heading
3483 and tailing respectively are sufficient for this
3487 if (st
.st_size
<= (1024 * 4))
3488 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3491 nread
= emacs_read (fd
, read_buf
, 1024);
3494 if (lseek (fd
, st
.st_size
- (1024 * 3), SEEK_SET
) < 0)
3495 report_file_error ("Setting file position",
3496 Fcons (orig_filename
, Qnil
));
3497 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3502 error ("IO error reading %s: %s",
3503 SDATA (orig_filename
), emacs_strerror (errno
));
3506 struct buffer
*prev
= current_buffer
;
3507 Lisp_Object workbuf
;
3510 record_unwind_current_buffer ();
3512 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3513 buf
= XBUFFER (workbuf
);
3515 delete_all_overlays (buf
);
3516 bset_directory (buf
, BVAR (current_buffer
, directory
));
3517 bset_read_only (buf
, Qnil
);
3518 bset_filename (buf
, Qnil
);
3519 bset_undo_list (buf
, Qt
);
3520 eassert (buf
->overlays_before
== NULL
);
3521 eassert (buf
->overlays_after
== NULL
);
3523 set_buffer_internal (buf
);
3525 bset_enable_multibyte_characters (buf
, Qnil
);
3527 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3528 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3529 coding_system
= call2 (Vset_auto_coding_function
,
3530 filename
, make_number (nread
));
3531 set_buffer_internal (prev
);
3533 /* Discard the unwind protect for recovering the
3537 /* Rewind the file for the actual read done later. */
3538 if (lseek (fd
, 0, SEEK_SET
) < 0)
3539 report_file_error ("Setting file position",
3540 Fcons (orig_filename
, Qnil
));
3544 if (NILP (coding_system
))
3546 /* If we have not yet decided a coding system, check
3547 file-coding-system-alist. */
3548 Lisp_Object args
[6];
3550 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3551 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3552 coding_system
= Ffind_operation_coding_system (6, args
);
3553 if (CONSP (coding_system
))
3554 coding_system
= XCAR (coding_system
);
3558 if (NILP (coding_system
))
3559 coding_system
= Qundecided
;
3561 CHECK_CODING_SYSTEM (coding_system
);
3563 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3564 /* We must suppress all character code conversion except for
3565 end-of-line conversion. */
3566 coding_system
= raw_text_coding_system (coding_system
);
3568 setup_coding_system (coding_system
, &coding
);
3569 /* Ensure we set Vlast_coding_system_used. */
3570 set_coding_system
= 1;
3573 /* If requested, replace the accessible part of the buffer
3574 with the file contents. Avoid replacing text at the
3575 beginning or end of the buffer that matches the file contents;
3576 that preserves markers pointing to the unchanged parts.
3578 Here we implement this feature in an optimized way
3579 for the case where code conversion is NOT needed.
3580 The following if-statement handles the case of conversion
3581 in a less optimal way.
3583 If the code conversion is "automatic" then we try using this
3584 method and hope for the best.
3585 But if we discover the need for conversion, we give up on this method
3586 and let the following if-statement handle the replace job. */
3589 && (NILP (coding_system
)
3590 || ! CODING_REQUIRE_DECODING (&coding
)))
3592 /* same_at_start and same_at_end count bytes,
3593 because file access counts bytes
3594 and BEG and END count bytes. */
3595 ptrdiff_t same_at_start
= BEGV_BYTE
;
3596 ptrdiff_t same_at_end
= ZV_BYTE
;
3598 /* There is still a possibility we will find the need to do code
3599 conversion. If that happens, set this variable to
3600 give up on handling REPLACE in the optimized way. */
3601 bool giveup_match_end
= 0;
3603 if (beg_offset
!= 0)
3605 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3606 report_file_error ("Setting file position",
3607 Fcons (orig_filename
, Qnil
));
3612 /* Count how many chars at the start of the file
3613 match the text at the beginning of the buffer. */
3618 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3620 error ("IO error reading %s: %s",
3621 SSDATA (orig_filename
), emacs_strerror (errno
));
3622 else if (nread
== 0)
3625 if (CODING_REQUIRE_DETECTION (&coding
))
3627 coding_system
= detect_coding_system ((unsigned char *) buffer
,
3630 setup_coding_system (coding_system
, &coding
);
3633 if (CODING_REQUIRE_DECODING (&coding
))
3634 /* We found that the file should be decoded somehow.
3635 Let's give up here. */
3637 giveup_match_end
= 1;
3642 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3643 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3644 same_at_start
++, bufpos
++;
3645 /* If we found a discrepancy, stop the scan.
3646 Otherwise loop around and scan the next bufferful. */
3647 if (bufpos
!= nread
)
3651 /* If the file matches the buffer completely,
3652 there's no need to replace anything. */
3653 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3657 /* Truncate the buffer to the size of the file. */
3658 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3663 /* Count how many chars at the end of the file
3664 match the text at the end of the buffer. But, if we have
3665 already found that decoding is necessary, don't waste time. */
3666 while (!giveup_match_end
)
3668 int total_read
, nread
, bufpos
, trial
;
3671 /* At what file position are we now scanning? */
3672 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3673 /* If the entire file matches the buffer tail, stop the scan. */
3676 /* How much can we scan in the next step? */
3677 trial
= min (curpos
, sizeof buffer
);
3678 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3679 report_file_error ("Setting file position",
3680 Fcons (orig_filename
, Qnil
));
3682 total_read
= nread
= 0;
3683 while (total_read
< trial
)
3685 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3687 error ("IO error reading %s: %s",
3688 SDATA (orig_filename
), emacs_strerror (errno
));
3689 else if (nread
== 0)
3691 total_read
+= nread
;
3694 /* Scan this bufferful from the end, comparing with
3695 the Emacs buffer. */
3696 bufpos
= total_read
;
3698 /* Compare with same_at_start to avoid counting some buffer text
3699 as matching both at the file's beginning and at the end. */
3700 while (bufpos
> 0 && same_at_end
> same_at_start
3701 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3702 same_at_end
--, bufpos
--;
3704 /* If we found a discrepancy, stop the scan.
3705 Otherwise loop around and scan the preceding bufferful. */
3708 /* If this discrepancy is because of code conversion,
3709 we cannot use this method; giveup and try the other. */
3710 if (same_at_end
> same_at_start
3711 && FETCH_BYTE (same_at_end
- 1) >= 0200
3712 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3713 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3714 giveup_match_end
= 1;
3723 if (! giveup_match_end
)
3727 /* We win! We can handle REPLACE the optimized way. */
3729 /* Extend the start of non-matching text area to multibyte
3730 character boundary. */
3731 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3732 while (same_at_start
> BEGV_BYTE
3733 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3736 /* Extend the end of non-matching text area to multibyte
3737 character boundary. */
3738 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3739 while (same_at_end
< ZV_BYTE
3740 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3743 /* Don't try to reuse the same piece of text twice. */
3744 overlap
= (same_at_start
- BEGV_BYTE
3746 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3748 same_at_end
+= overlap
;
3750 /* Arrange to read only the nonmatching middle part of the file. */
3751 beg_offset
+= same_at_start
- BEGV_BYTE
;
3752 end_offset
-= ZV_BYTE
- same_at_end
;
3754 del_range_byte (same_at_start
, same_at_end
, 0);
3755 /* Insert from the file at the proper position. */
3756 temp
= BYTE_TO_CHAR (same_at_start
);
3757 SET_PT_BOTH (temp
, same_at_start
);
3759 /* If display currently starts at beginning of line,
3760 keep it that way. */
3761 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3762 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3764 replace_handled
= 1;
3768 /* If requested, replace the accessible part of the buffer
3769 with the file contents. Avoid replacing text at the
3770 beginning or end of the buffer that matches the file contents;
3771 that preserves markers pointing to the unchanged parts.
3773 Here we implement this feature for the case where code conversion
3774 is needed, in a simple way that needs a lot of memory.
3775 The preceding if-statement handles the case of no conversion
3776 in a more optimized way. */
3777 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3779 ptrdiff_t same_at_start
= BEGV_BYTE
;
3780 ptrdiff_t same_at_end
= ZV_BYTE
;
3781 ptrdiff_t same_at_start_charpos
;
3782 ptrdiff_t inserted_chars
;
3785 unsigned char *decoded
;
3788 ptrdiff_t this_count
= SPECPDL_INDEX ();
3790 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3791 Lisp_Object conversion_buffer
;
3792 struct gcpro gcpro1
;
3794 conversion_buffer
= code_conversion_save (1, multibyte
);
3796 /* First read the whole file, performing code conversion into
3797 CONVERSION_BUFFER. */
3799 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3800 report_file_error ("Setting file position",
3801 Fcons (orig_filename
, Qnil
));
3803 total
= st
.st_size
; /* Total bytes in the file. */
3804 how_much
= 0; /* Bytes read from file so far. */
3805 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3806 unprocessed
= 0; /* Bytes not processed in previous loop. */
3808 GCPRO1 (conversion_buffer
);
3809 while (how_much
< total
)
3811 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3812 quitting while reading a huge while. */
3813 /* `try'' is reserved in some compilers (Microsoft C). */
3814 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
3816 /* Allow quitting out of the actual I/O. */
3819 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3827 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3828 BUF_Z (XBUFFER (conversion_buffer
)));
3829 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3830 unprocessed
+ this, conversion_buffer
);
3831 unprocessed
= coding
.carryover_bytes
;
3832 if (coding
.carryover_bytes
> 0)
3833 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3838 /* We should remove the unwind_protect calling
3839 close_file_unwind, but other stuff has been added the stack,
3840 so defer the removal till we reach the `handled' label. */
3841 deferred_remove_unwind_protect
= 1;
3843 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3844 if we couldn't read the file. */
3847 error ("IO error reading %s: %s",
3848 SDATA (orig_filename
), emacs_strerror (errno
));
3850 if (unprocessed
> 0)
3852 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3853 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3854 unprocessed
, conversion_buffer
);
3855 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3858 coding_system
= CODING_ID_NAME (coding
.id
);
3859 set_coding_system
= 1;
3860 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3861 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3862 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3864 /* Compare the beginning of the converted string with the buffer
3868 while (bufpos
< inserted
&& same_at_start
< same_at_end
3869 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3870 same_at_start
++, bufpos
++;
3872 /* If the file matches the head of buffer completely,
3873 there's no need to replace anything. */
3875 if (bufpos
== inserted
)
3877 /* Truncate the buffer to the size of the file. */
3878 if (same_at_start
== same_at_end
)
3881 del_range_byte (same_at_start
, same_at_end
, 0);
3884 unbind_to (this_count
, Qnil
);
3888 /* Extend the start of non-matching text area to the previous
3889 multibyte character boundary. */
3890 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3891 while (same_at_start
> BEGV_BYTE
3892 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3895 /* Scan this bufferful from the end, comparing with
3896 the Emacs buffer. */
3899 /* Compare with same_at_start to avoid counting some buffer text
3900 as matching both at the file's beginning and at the end. */
3901 while (bufpos
> 0 && same_at_end
> same_at_start
3902 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3903 same_at_end
--, bufpos
--;
3905 /* Extend the end of non-matching text area to the next
3906 multibyte character boundary. */
3907 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3908 while (same_at_end
< ZV_BYTE
3909 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3912 /* Don't try to reuse the same piece of text twice. */
3913 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3915 same_at_end
+= overlap
;
3917 /* If display currently starts at beginning of line,
3918 keep it that way. */
3919 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3920 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3922 /* Replace the chars that we need to replace,
3923 and update INSERTED to equal the number of bytes
3924 we are taking from the decoded string. */
3925 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3927 if (same_at_end
!= same_at_start
)
3929 del_range_byte (same_at_start
, same_at_end
, 0);
3931 same_at_start
= GPT_BYTE
;
3935 temp
= BYTE_TO_CHAR (same_at_start
);
3937 /* Insert from the file at the proper position. */
3938 SET_PT_BOTH (temp
, same_at_start
);
3939 same_at_start_charpos
3940 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3941 same_at_start
- BEGV_BYTE
3942 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3944 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3945 same_at_start
+ inserted
- BEGV_BYTE
3946 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3947 - same_at_start_charpos
);
3948 /* This binding is to avoid ask-user-about-supersession-threat
3949 being called in insert_from_buffer (via in
3950 prepare_to_modify_buffer). */
3951 specbind (intern ("buffer-file-name"), Qnil
);
3952 insert_from_buffer (XBUFFER (conversion_buffer
),
3953 same_at_start_charpos
, inserted_chars
, 0);
3954 /* Set `inserted' to the number of inserted characters. */
3955 inserted
= PT
- temp
;
3956 /* Set point before the inserted characters. */
3957 SET_PT_BOTH (temp
, same_at_start
);
3959 unbind_to (this_count
, Qnil
);
3965 total
= end_offset
- beg_offset
;
3967 /* For a special file, all we can do is guess. */
3968 total
= READ_BUF_SIZE
;
3970 if (NILP (visit
) && total
> 0)
3972 #ifdef CLASH_DETECTION
3973 if (!NILP (BVAR (current_buffer
, file_truename
))
3974 /* Make binding buffer-file-name to nil effective. */
3975 && !NILP (BVAR (current_buffer
, filename
))
3976 && SAVE_MODIFF
>= MODIFF
)
3978 #endif /* CLASH_DETECTION */
3979 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3983 if (GAP_SIZE
< total
)
3984 make_gap (total
- GAP_SIZE
);
3986 if (beg_offset
!= 0 || !NILP (replace
))
3988 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3989 report_file_error ("Setting file position",
3990 Fcons (orig_filename
, Qnil
));
3993 /* In the following loop, HOW_MUCH contains the total bytes read so
3994 far for a regular file, and not changed for a special file. But,
3995 before exiting the loop, it is set to a negative value if I/O
3999 /* Total bytes inserted. */
4002 /* Here, we don't do code conversion in the loop. It is done by
4003 decode_coding_gap after all data are read into the buffer. */
4005 ptrdiff_t gap_size
= GAP_SIZE
;
4007 while (how_much
< total
)
4009 /* try is reserved in some compilers (Microsoft C) */
4010 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4017 /* Maybe make more room. */
4018 if (gap_size
< trytry
)
4020 make_gap (total
- gap_size
);
4021 gap_size
= GAP_SIZE
;
4024 /* Read from the file, capturing `quit'. When an
4025 error occurs, end the loop, and arrange for a quit
4026 to be signaled after decoding the text we read. */
4027 non_regular_fd
= fd
;
4028 non_regular_inserted
= inserted
;
4029 non_regular_nbytes
= trytry
;
4030 nbytes
= internal_condition_case_1 (read_non_regular
,
4032 read_non_regular_quit
);
4039 this = XINT (nbytes
);
4043 /* Allow quitting out of the actual I/O. We don't make text
4044 part of the buffer until all the reading is done, so a C-g
4045 here doesn't do any harm. */
4048 this = emacs_read (fd
,
4049 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4063 /* For a regular file, where TOTAL is the real size,
4064 count HOW_MUCH to compare with it.
4065 For a special file, where TOTAL is just a buffer size,
4066 so don't bother counting in HOW_MUCH.
4067 (INSERTED is where we count the number of characters inserted.) */
4074 /* Now we have read all the file data into the gap.
4075 If it was empty, undo marking the buffer modified. */
4079 #ifdef CLASH_DETECTION
4081 unlock_file (BVAR (current_buffer
, file_truename
));
4083 Vdeactivate_mark
= old_Vdeactivate_mark
;
4086 Vdeactivate_mark
= Qt
;
4088 /* Make the text read part of the buffer. */
4089 GAP_SIZE
-= inserted
;
4091 GPT_BYTE
+= inserted
;
4093 ZV_BYTE
+= inserted
;
4098 /* Put an anchor to ensure multi-byte form ends at gap. */
4103 /* Discard the unwind protect for closing the file. */
4107 error ("IO error reading %s: %s",
4108 SDATA (orig_filename
), emacs_strerror (errno
));
4112 if (NILP (coding_system
))
4114 /* The coding system is not yet decided. Decide it by an
4115 optimized method for handling `coding:' tag.
4117 Note that we can get here only if the buffer was empty
4118 before the insertion. */
4120 if (!NILP (Vcoding_system_for_read
))
4121 coding_system
= Vcoding_system_for_read
;
4124 /* Since we are sure that the current buffer was empty
4125 before the insertion, we can toggle
4126 enable-multibyte-characters directly here without taking
4127 care of marker adjustment. By this way, we can run Lisp
4128 program safely before decoding the inserted text. */
4129 Lisp_Object unwind_data
;
4130 ptrdiff_t count1
= SPECPDL_INDEX ();
4132 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4133 Fcons (BVAR (current_buffer
, undo_list
),
4134 Fcurrent_buffer ()));
4135 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4136 bset_undo_list (current_buffer
, Qt
);
4137 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4139 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4141 coding_system
= call2 (Vset_auto_coding_function
,
4142 filename
, make_number (inserted
));
4145 if (NILP (coding_system
))
4147 /* If the coding system is not yet decided, check
4148 file-coding-system-alist. */
4149 Lisp_Object args
[6];
4151 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4152 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4153 coding_system
= Ffind_operation_coding_system (6, args
);
4154 if (CONSP (coding_system
))
4155 coding_system
= XCAR (coding_system
);
4157 unbind_to (count1
, Qnil
);
4158 inserted
= Z_BYTE
- BEG_BYTE
;
4161 if (NILP (coding_system
))
4162 coding_system
= Qundecided
;
4164 CHECK_CODING_SYSTEM (coding_system
);
4166 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4167 /* We must suppress all character code conversion except for
4168 end-of-line conversion. */
4169 coding_system
= raw_text_coding_system (coding_system
);
4170 setup_coding_system (coding_system
, &coding
);
4171 /* Ensure we set Vlast_coding_system_used. */
4172 set_coding_system
= 1;
4177 /* When we visit a file by raw-text, we change the buffer to
4179 if (CODING_FOR_UNIBYTE (&coding
)
4180 /* Can't do this if part of the buffer might be preserved. */
4182 /* Visiting a file with these coding system makes the buffer
4184 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4187 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4188 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4189 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4191 move_gap_both (PT
, PT_BYTE
);
4192 GAP_SIZE
+= inserted
;
4193 ZV_BYTE
-= inserted
;
4197 decode_coding_gap (&coding
, inserted
, inserted
);
4198 inserted
= coding
.produced_char
;
4199 coding_system
= CODING_ID_NAME (coding
.id
);
4201 else if (inserted
> 0)
4202 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4205 /* Call after-change hooks for the inserted text, aside from the case
4206 of normal visiting (not with REPLACE), which is done in a new buffer
4207 "before" the buffer is changed. */
4208 if (inserted
> 0 && total
> 0
4209 && (NILP (visit
) || !NILP (replace
)))
4211 signal_after_change (PT
, 0, inserted
);
4212 update_compositions (PT
, PT
, CHECK_BORDER
);
4215 /* Now INSERTED is measured in characters. */
4219 if (deferred_remove_unwind_protect
)
4220 /* If requested above, discard the unwind protect for closing the
4226 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4227 bset_undo_list (current_buffer
, Qnil
);
4231 current_buffer
->modtime
= mtime
;
4232 current_buffer
->modtime_size
= st
.st_size
;
4233 bset_filename (current_buffer
, orig_filename
);
4236 SAVE_MODIFF
= MODIFF
;
4237 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4238 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4239 #ifdef CLASH_DETECTION
4242 if (!NILP (BVAR (current_buffer
, file_truename
)))
4243 unlock_file (BVAR (current_buffer
, file_truename
));
4244 unlock_file (filename
);
4246 #endif /* CLASH_DETECTION */
4248 xsignal2 (Qfile_error
,
4249 build_string ("not a regular file"), orig_filename
);
4252 if (set_coding_system
)
4253 Vlast_coding_system_used
= coding_system
;
4255 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4257 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4259 if (! NILP (insval
))
4261 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4262 wrong_type_argument (intern ("inserted-chars"), insval
);
4263 inserted
= XFASTINT (insval
);
4267 /* Decode file format. */
4270 /* Don't run point motion or modification hooks when decoding. */
4271 ptrdiff_t count1
= SPECPDL_INDEX ();
4272 ptrdiff_t old_inserted
= inserted
;
4273 specbind (Qinhibit_point_motion_hooks
, Qt
);
4274 specbind (Qinhibit_modification_hooks
, Qt
);
4276 /* Save old undo list and don't record undo for decoding. */
4277 old_undo
= BVAR (current_buffer
, undo_list
);
4278 bset_undo_list (current_buffer
, Qt
);
4282 insval
= call3 (Qformat_decode
,
4283 Qnil
, make_number (inserted
), visit
);
4284 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4285 wrong_type_argument (intern ("inserted-chars"), insval
);
4286 inserted
= XFASTINT (insval
);
4290 /* If REPLACE is non-nil and we succeeded in not replacing the
4291 beginning or end of the buffer text with the file's contents,
4292 call format-decode with `point' positioned at the beginning
4293 of the buffer and `inserted' equaling the number of
4294 characters in the buffer. Otherwise, format-decode might
4295 fail to correctly analyze the beginning or end of the buffer.
4296 Hence we temporarily save `point' and `inserted' here and
4297 restore `point' iff format-decode did not insert or delete
4298 any text. Otherwise we leave `point' at point-min. */
4299 ptrdiff_t opoint
= PT
;
4300 ptrdiff_t opoint_byte
= PT_BYTE
;
4301 ptrdiff_t oinserted
= ZV
- BEGV
;
4302 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4304 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4305 insval
= call3 (Qformat_decode
,
4306 Qnil
, make_number (oinserted
), visit
);
4307 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4308 wrong_type_argument (intern ("inserted-chars"), insval
);
4309 if (ochars_modiff
== CHARS_MODIFF
)
4310 /* format_decode didn't modify buffer's characters => move
4311 point back to position before inserted text and leave
4312 value of inserted alone. */
4313 SET_PT_BOTH (opoint
, opoint_byte
);
4315 /* format_decode modified buffer's characters => consider
4316 entire buffer changed and leave point at point-min. */
4317 inserted
= XFASTINT (insval
);
4320 /* For consistency with format-decode call these now iff inserted > 0
4321 (martin 2007-06-28). */
4322 p
= Vafter_insert_file_functions
;
4327 insval
= call1 (XCAR (p
), make_number (inserted
));
4330 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4331 wrong_type_argument (intern ("inserted-chars"), insval
);
4332 inserted
= XFASTINT (insval
);
4337 /* For the rationale of this see the comment on
4338 format-decode above. */
4339 ptrdiff_t opoint
= PT
;
4340 ptrdiff_t opoint_byte
= PT_BYTE
;
4341 ptrdiff_t oinserted
= ZV
- BEGV
;
4342 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4344 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4345 insval
= call1 (XCAR (p
), make_number (oinserted
));
4348 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4349 wrong_type_argument (intern ("inserted-chars"), insval
);
4350 if (ochars_modiff
== CHARS_MODIFF
)
4351 /* after_insert_file_functions didn't modify
4352 buffer's characters => move point back to
4353 position before inserted text and leave value of
4355 SET_PT_BOTH (opoint
, opoint_byte
);
4357 /* after_insert_file_functions did modify buffer's
4358 characters => consider entire buffer changed and
4359 leave point at point-min. */
4360 inserted
= XFASTINT (insval
);
4370 bset_undo_list (current_buffer
, old_undo
);
4371 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4373 /* Adjust the last undo record for the size change during
4374 the format conversion. */
4375 Lisp_Object tem
= XCAR (old_undo
);
4376 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4377 && INTEGERP (XCDR (tem
))
4378 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4379 XSETCDR (tem
, make_number (PT
+ inserted
));
4383 /* If undo_list was Qt before, keep it that way.
4384 Otherwise start with an empty undo_list. */
4385 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4387 unbind_to (count1
, Qnil
);
4391 && EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
4393 /* If visiting nonexistent file, return nil. */
4395 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4399 Fsignal (Qquit
, Qnil
);
4401 /* ??? Retval needs to be dealt with in all cases consistently. */
4403 val
= Fcons (orig_filename
,
4404 Fcons (make_number (inserted
),
4407 RETURN_UNGCPRO (unbind_to (count
, val
));
4410 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4413 build_annotations_unwind (Lisp_Object arg
)
4415 Vwrite_region_annotation_buffers
= arg
;
4419 /* Decide the coding-system to encode the data with. */
4422 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4423 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4424 struct coding_system
*coding
)
4427 Lisp_Object eol_parent
= Qnil
;
4430 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4431 BVAR (current_buffer
, auto_save_file_name
))))
4436 else if (!NILP (Vcoding_system_for_write
))
4438 val
= Vcoding_system_for_write
;
4439 if (coding_system_require_warning
4440 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4441 /* Confirm that VAL can surely encode the current region. */
4442 val
= call5 (Vselect_safe_coding_system_function
,
4443 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4448 /* If the variable `buffer-file-coding-system' is set locally,
4449 it means that the file was read with some kind of code
4450 conversion or the variable is explicitly set by users. We
4451 had better write it out with the same coding system even if
4452 `enable-multibyte-characters' is nil.
4454 If it is not set locally, we anyway have to convert EOL
4455 format if the default value of `buffer-file-coding-system'
4456 tells that it is not Unix-like (LF only) format. */
4457 bool using_default_coding
= 0;
4458 bool force_raw_text
= 0;
4460 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4462 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4465 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4471 /* Check file-coding-system-alist. */
4472 Lisp_Object args
[7], coding_systems
;
4474 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4475 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4477 coding_systems
= Ffind_operation_coding_system (7, args
);
4478 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4479 val
= XCDR (coding_systems
);
4484 /* If we still have not decided a coding system, use the
4485 default value of buffer-file-coding-system. */
4486 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4487 using_default_coding
= 1;
4490 if (! NILP (val
) && ! force_raw_text
)
4492 Lisp_Object spec
, attrs
;
4494 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4495 attrs
= AREF (spec
, 0);
4496 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4501 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4502 /* Confirm that VAL can surely encode the current region. */
4503 val
= call5 (Vselect_safe_coding_system_function
,
4504 start
, end
, val
, Qnil
, filename
);
4506 /* If the decided coding-system doesn't specify end-of-line
4507 format, we use that of
4508 `default-buffer-file-coding-system'. */
4509 if (! using_default_coding
4510 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4511 val
= (coding_inherit_eol_type
4512 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4514 /* If we decide not to encode text, use `raw-text' or one of its
4517 val
= raw_text_coding_system (val
);
4520 val
= coding_inherit_eol_type (val
, eol_parent
);
4521 setup_coding_system (val
, coding
);
4523 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4524 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4528 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4529 "r\nFWrite region to file: \ni\ni\ni\np",
4530 doc
: /* Write current region into specified file.
4531 When called from a program, requires three arguments:
4532 START, END and FILENAME. START and END are normally buffer positions
4533 specifying the part of the buffer to write.
4534 If START is nil, that means to use the entire buffer contents.
4535 If START is a string, then output that string to the file
4536 instead of any buffer contents; END is ignored.
4538 Optional fourth argument APPEND if non-nil means
4539 append to existing file contents (if any). If it is an integer,
4540 seek to that offset in the file before writing.
4541 Optional fifth argument VISIT, if t or a string, means
4542 set the last-save-file-modtime of buffer to this file's modtime
4543 and mark buffer not modified.
4544 If VISIT is a string, it is a second file name;
4545 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4546 VISIT is also the file name to lock and unlock for clash detection.
4547 If VISIT is neither t nor nil nor a string,
4548 that means do not display the \"Wrote file\" message.
4549 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4550 use for locking and unlocking, overriding FILENAME and VISIT.
4551 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4552 for an existing file with the same name. If MUSTBENEW is `excl',
4553 that means to get an error if the file already exists; never overwrite.
4554 If MUSTBENEW is neither nil nor `excl', that means ask for
4555 confirmation before overwriting, but do go ahead and overwrite the file
4556 if the user confirms.
4558 This does code conversion according to the value of
4559 `coding-system-for-write', `buffer-file-coding-system', or
4560 `file-coding-system-alist', and sets the variable
4561 `last-coding-system-used' to the coding system actually used.
4563 This calls `write-region-annotate-functions' at the start, and
4564 `write-region-post-annotation-function' at the end. */)
4565 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4573 ptrdiff_t count
= SPECPDL_INDEX ();
4575 Lisp_Object handler
;
4576 Lisp_Object visit_file
;
4577 Lisp_Object annotations
;
4578 Lisp_Object encoded_filename
;
4579 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4580 bool quietly
= !NILP (visit
);
4581 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4582 struct buffer
*given_buffer
;
4583 struct coding_system coding
;
4585 if (current_buffer
->base_buffer
&& visiting
)
4586 error ("Cannot do file visiting in an indirect buffer");
4588 if (!NILP (start
) && !STRINGP (start
))
4589 validate_region (&start
, &end
);
4592 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4594 filename
= Fexpand_file_name (filename
, Qnil
);
4596 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4597 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4599 if (STRINGP (visit
))
4600 visit_file
= Fexpand_file_name (visit
, Qnil
);
4602 visit_file
= filename
;
4604 if (NILP (lockname
))
4605 lockname
= visit_file
;
4609 /* If the file name has special constructs in it,
4610 call the corresponding file handler. */
4611 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4612 /* If FILENAME has no handler, see if VISIT has one. */
4613 if (NILP (handler
) && STRINGP (visit
))
4614 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4616 if (!NILP (handler
))
4619 val
= call6 (handler
, Qwrite_region
, start
, end
,
4620 filename
, append
, visit
);
4624 SAVE_MODIFF
= MODIFF
;
4625 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4626 bset_filename (current_buffer
, visit_file
);
4632 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4634 /* Special kludge to simplify auto-saving. */
4637 /* Do it later, so write-region-annotate-function can work differently
4638 if we save "the buffer" vs "a region".
4639 This is useful in tar-mode. --Stef
4640 XSETFASTINT (start, BEG);
4641 XSETFASTINT (end, Z); */
4645 record_unwind_protect (build_annotations_unwind
,
4646 Vwrite_region_annotation_buffers
);
4647 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4648 count1
= SPECPDL_INDEX ();
4650 given_buffer
= current_buffer
;
4652 if (!STRINGP (start
))
4654 annotations
= build_annotations (start
, end
);
4656 if (current_buffer
!= given_buffer
)
4658 XSETFASTINT (start
, BEGV
);
4659 XSETFASTINT (end
, ZV
);
4665 XSETFASTINT (start
, BEGV
);
4666 XSETFASTINT (end
, ZV
);
4671 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4673 /* Decide the coding-system to encode the data with.
4674 We used to make this choice before calling build_annotations, but that
4675 leads to problems when a write-annotate-function takes care of
4676 unsavable chars (as was the case with X-Symbol). */
4677 Vlast_coding_system_used
4678 = choose_write_coding_system (start
, end
, filename
,
4679 append
, visit
, lockname
, &coding
);
4681 #ifdef CLASH_DETECTION
4683 lock_file (lockname
);
4684 #endif /* CLASH_DETECTION */
4686 encoded_filename
= ENCODE_FILE (filename
);
4688 fn
= SSDATA (encoded_filename
);
4692 desc
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4693 #else /* not DOS_NT */
4694 desc
= emacs_open (fn
, O_WRONLY
, 0);
4695 #endif /* not DOS_NT */
4697 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4699 desc
= emacs_open (fn
,
4700 O_WRONLY
| O_CREAT
| O_BINARY
4701 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4702 S_IREAD
| S_IWRITE
);
4703 #else /* not DOS_NT */
4704 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4705 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4706 auto_saving
? auto_save_mode_bits
: 0666);
4707 #endif /* not DOS_NT */
4711 #ifdef CLASH_DETECTION
4713 if (!auto_saving
) unlock_file (lockname
);
4715 #endif /* CLASH_DETECTION */
4717 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4720 record_unwind_protect (close_file_unwind
, make_number (desc
));
4722 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4726 if (NUMBERP (append
))
4727 ret
= emacs_lseek (desc
, XINT (append
), SEEK_CUR
);
4729 ret
= lseek (desc
, 0, SEEK_END
);
4732 #ifdef CLASH_DETECTION
4734 if (!auto_saving
) unlock_file (lockname
);
4736 #endif /* CLASH_DETECTION */
4738 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4746 if (STRINGP (start
))
4747 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4748 else if (XINT (start
) != XINT (end
))
4749 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4750 &annotations
, &coding
);
4753 /* If file was empty, still need to write the annotations. */
4754 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4755 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4759 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4760 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4762 /* We have to flush out a data. */
4763 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4764 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4771 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4772 Disk full in NFS may be reported here. */
4773 /* mib says that closing the file will try to write as fast as NFS can do
4774 it, and that means the fsync here is not crucial for autosave files. */
4775 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4777 /* If fsync fails with EINTR, don't treat that as serious. Also
4778 ignore EINVAL which happens when fsync is not supported on this
4780 if (errno
!= EINTR
&& errno
!= EINVAL
)
4781 ok
= 0, save_errno
= errno
;
4785 modtime
= invalid_emacs_time ();
4788 if (fstat (desc
, &st
) == 0)
4789 modtime
= get_stat_mtime (&st
);
4791 ok
= 0, save_errno
= errno
;
4794 /* NFS can report a write failure now. */
4795 if (emacs_close (desc
) < 0)
4796 ok
= 0, save_errno
= errno
;
4798 /* Discard the unwind protect for close_file_unwind. */
4799 specpdl_ptr
= specpdl
+ count1
;
4801 /* Call write-region-post-annotation-function. */
4802 while (CONSP (Vwrite_region_annotation_buffers
))
4804 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4805 if (!NILP (Fbuffer_live_p (buf
)))
4808 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4809 call0 (Vwrite_region_post_annotation_function
);
4811 Vwrite_region_annotation_buffers
4812 = XCDR (Vwrite_region_annotation_buffers
);
4815 unbind_to (count
, Qnil
);
4817 #ifdef CLASH_DETECTION
4819 unlock_file (lockname
);
4820 #endif /* CLASH_DETECTION */
4822 /* Do this before reporting IO error
4823 to avoid a "file has changed on disk" warning on
4824 next attempt to save. */
4825 if (EMACS_TIME_VALID_P (modtime
))
4827 current_buffer
->modtime
= modtime
;
4828 current_buffer
->modtime_size
= st
.st_size
;
4832 error ("IO error writing %s: %s", SDATA (filename
),
4833 emacs_strerror (save_errno
));
4837 SAVE_MODIFF
= MODIFF
;
4838 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4839 bset_filename (current_buffer
, visit_file
);
4840 update_mode_lines
++;
4845 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4846 BVAR (current_buffer
, auto_save_file_name
))))
4847 SAVE_MODIFF
= MODIFF
;
4853 message_with_string ((INTEGERP (append
)
4863 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4865 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4866 doc
: /* Return t if (car A) is numerically less than (car B). */)
4867 (Lisp_Object a
, Lisp_Object b
)
4869 return Flss (Fcar (a
), Fcar (b
));
4872 /* Build the complete list of annotations appropriate for writing out
4873 the text between START and END, by calling all the functions in
4874 write-region-annotate-functions and merging the lists they return.
4875 If one of these functions switches to a different buffer, we assume
4876 that buffer contains altered text. Therefore, the caller must
4877 make sure to restore the current buffer in all cases,
4878 as save-excursion would do. */
4881 build_annotations (Lisp_Object start
, Lisp_Object end
)
4883 Lisp_Object annotations
;
4885 struct gcpro gcpro1
, gcpro2
;
4886 Lisp_Object original_buffer
;
4888 bool used_global
= 0;
4890 XSETBUFFER (original_buffer
, current_buffer
);
4893 p
= Vwrite_region_annotate_functions
;
4894 GCPRO2 (annotations
, p
);
4897 struct buffer
*given_buffer
= current_buffer
;
4898 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4899 { /* Use the global value of the hook. */
4902 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4904 p
= Fappend (2, arg
);
4907 Vwrite_region_annotations_so_far
= annotations
;
4908 res
= call2 (XCAR (p
), start
, end
);
4909 /* If the function makes a different buffer current,
4910 assume that means this buffer contains altered text to be output.
4911 Reset START and END from the buffer bounds
4912 and discard all previous annotations because they should have
4913 been dealt with by this function. */
4914 if (current_buffer
!= given_buffer
)
4916 Vwrite_region_annotation_buffers
4917 = Fcons (Fcurrent_buffer (),
4918 Vwrite_region_annotation_buffers
);
4919 XSETFASTINT (start
, BEGV
);
4920 XSETFASTINT (end
, ZV
);
4923 Flength (res
); /* Check basic validity of return value */
4924 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4928 /* Now do the same for annotation functions implied by the file-format */
4929 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
4930 p
= BVAR (current_buffer
, auto_save_file_format
);
4932 p
= BVAR (current_buffer
, file_format
);
4933 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4935 struct buffer
*given_buffer
= current_buffer
;
4937 Vwrite_region_annotations_so_far
= annotations
;
4939 /* Value is either a list of annotations or nil if the function
4940 has written annotations to a temporary buffer, which is now
4942 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4943 original_buffer
, make_number (i
));
4944 if (current_buffer
!= given_buffer
)
4946 XSETFASTINT (start
, BEGV
);
4947 XSETFASTINT (end
, ZV
);
4952 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4960 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4961 If STRING is nil, POS is the character position in the current buffer.
4962 Intersperse with them the annotations from *ANNOT
4963 which fall within the range of POS to POS + NCHARS,
4964 each at its appropriate position.
4966 We modify *ANNOT by discarding elements as we use them up.
4968 Return true if successful. */
4971 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
4972 ptrdiff_t nchars
, Lisp_Object
*annot
,
4973 struct coding_system
*coding
)
4977 ptrdiff_t lastpos
= pos
+ nchars
;
4979 while (NILP (*annot
) || CONSP (*annot
))
4981 tem
= Fcar_safe (Fcar (*annot
));
4984 nextpos
= XFASTINT (tem
);
4986 /* If there are no more annotations in this range,
4987 output the rest of the range all at once. */
4988 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4989 return e_write (desc
, string
, pos
, lastpos
, coding
);
4991 /* Output buffer text up to the next annotation's position. */
4994 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
4998 /* Output the annotation. */
4999 tem
= Fcdr (Fcar (*annot
));
5002 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5005 *annot
= Fcdr (*annot
);
5011 /* Write text in the range START and END into descriptor DESC,
5012 encoding them with coding system CODING. If STRING is nil, START
5013 and END are character positions of the current buffer, else they
5014 are indexes to the string STRING. Return true if successful. */
5017 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5018 struct coding_system
*coding
)
5020 if (STRINGP (string
))
5023 end
= SCHARS (string
);
5026 /* We used to have a code for handling selective display here. But,
5027 now it is handled within encode_coding. */
5031 if (STRINGP (string
))
5033 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5034 if (CODING_REQUIRE_ENCODING (coding
))
5036 encode_coding_object (coding
, string
,
5037 start
, string_char_to_byte (string
, start
),
5038 end
, string_char_to_byte (string
, end
), Qt
);
5042 coding
->dst_object
= string
;
5043 coding
->consumed_char
= SCHARS (string
);
5044 coding
->produced
= SBYTES (string
);
5049 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5050 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5052 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5053 if (CODING_REQUIRE_ENCODING (coding
))
5055 encode_coding_object (coding
, Fcurrent_buffer (),
5056 start
, start_byte
, end
, end_byte
, Qt
);
5060 coding
->dst_object
= Qnil
;
5061 coding
->dst_pos_byte
= start_byte
;
5062 if (start
>= GPT
|| end
<= GPT
)
5064 coding
->consumed_char
= end
- start
;
5065 coding
->produced
= end_byte
- start_byte
;
5069 coding
->consumed_char
= GPT
- start
;
5070 coding
->produced
= GPT_BYTE
- start_byte
;
5075 if (coding
->produced
> 0)
5078 -= emacs_write (desc
,
5079 STRINGP (coding
->dst_object
)
5080 ? SSDATA (coding
->dst_object
)
5081 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
5084 if (coding
->produced
)
5087 start
+= coding
->consumed_char
;
5093 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5094 Sverify_visited_file_modtime
, 0, 1, 0,
5095 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5096 This means that the file has not been changed since it was visited or saved.
5097 If BUF is omitted or nil, it defaults to the current buffer.
5098 See Info node `(elisp)Modification Time' for more details. */)
5103 Lisp_Object handler
;
5104 Lisp_Object filename
;
5115 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5116 if (EMACS_NSECS (b
->modtime
) == UNKNOWN_MODTIME_NSECS
) return Qt
;
5118 /* If the file name has special constructs in it,
5119 call the corresponding file handler. */
5120 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5121 Qverify_visited_file_modtime
);
5122 if (!NILP (handler
))
5123 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5125 filename
= ENCODE_FILE (BVAR (b
, filename
));
5127 mtime
= (stat (SSDATA (filename
), &st
) == 0
5128 ? get_stat_mtime (&st
)
5129 : time_error_value (errno
));
5130 if (EMACS_TIME_EQ (mtime
, b
->modtime
)
5131 && (st
.st_size
== b
->modtime_size
5132 || b
->modtime_size
< 0))
5137 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5138 Sclear_visited_file_modtime
, 0, 0, 0,
5139 doc
: /* Clear out records of last mod time of visited file.
5140 Next attempt to save will certainly not complain of a discrepancy. */)
5143 current_buffer
->modtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
);
5144 current_buffer
->modtime_size
= -1;
5148 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5149 Svisited_file_modtime
, 0, 0, 0,
5150 doc
: /* Return the current buffer's recorded visited file modification time.
5151 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5152 `file-attributes' returns. If the current buffer has no recorded file
5153 modification time, this function returns 0. If the visited file
5154 doesn't exist, HIGH will be -1.
5155 See Info node `(elisp)Modification Time' for more details. */)
5158 if (EMACS_NSECS (current_buffer
->modtime
) < 0)
5159 return make_number (0);
5160 return make_lisp_time (current_buffer
->modtime
);
5163 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5164 Sset_visited_file_modtime
, 0, 1, 0,
5165 doc
: /* Update buffer's recorded modification time from the visited file's time.
5166 Useful if the buffer was not read from the file normally
5167 or if the file itself has been changed for some known benign reason.
5168 An argument specifies the modification time value to use
5169 \(instead of that of the visited file), in the form of a list
5170 \(HIGH LOW USEC PSEC) as returned by `current-time'. */)
5171 (Lisp_Object time_list
)
5173 if (!NILP (time_list
))
5175 current_buffer
->modtime
= lisp_time_argument (time_list
);
5176 current_buffer
->modtime_size
= -1;
5180 register Lisp_Object filename
;
5182 Lisp_Object handler
;
5184 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5186 /* If the file name has special constructs in it,
5187 call the corresponding file handler. */
5188 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5189 if (!NILP (handler
))
5190 /* The handler can find the file name the same way we did. */
5191 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5193 filename
= ENCODE_FILE (filename
);
5195 if (stat (SSDATA (filename
), &st
) >= 0)
5197 current_buffer
->modtime
= get_stat_mtime (&st
);
5198 current_buffer
->modtime_size
= st
.st_size
;
5206 auto_save_error (Lisp_Object error_val
)
5208 Lisp_Object args
[3], msg
;
5210 struct gcpro gcpro1
;
5214 auto_save_error_occurred
= 1;
5216 ring_bell (XFRAME (selected_frame
));
5218 args
[0] = build_string ("Auto-saving %s: %s");
5219 args
[1] = BVAR (current_buffer
, name
);
5220 args
[2] = Ferror_message_string (error_val
);
5221 msg
= Fformat (3, args
);
5223 nbytes
= SBYTES (msg
);
5224 msgbuf
= SAFE_ALLOCA (nbytes
);
5225 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5227 for (i
= 0; i
< 3; ++i
)
5230 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5232 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5233 Fsleep_for (make_number (1), Qnil
);
5247 auto_save_mode_bits
= 0666;
5249 /* Get visited file's mode to become the auto save file's mode. */
5250 if (! NILP (BVAR (current_buffer
, filename
)))
5252 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5253 /* But make sure we can overwrite it later! */
5254 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5255 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5257 /* Remote files don't cooperate with stat. */
5258 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5262 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5263 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5268 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5271 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5283 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5286 minibuffer_auto_raise
= XINT (value
);
5291 do_auto_save_make_dir (Lisp_Object dir
)
5295 auto_saving_dir_umask
= 077;
5296 result
= call2 (Qmake_directory
, dir
, Qt
);
5297 auto_saving_dir_umask
= 0;
5302 do_auto_save_eh (Lisp_Object ignore
)
5304 auto_saving_dir_umask
= 0;
5308 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5309 doc
: /* Auto-save all buffers that need it.
5310 This is all buffers that have auto-saving enabled
5311 and are changed since last auto-saved.
5312 Auto-saving writes the buffer into a file
5313 so that your editing is not lost if the system crashes.
5314 This file is not the file you visited; that changes only when you save.
5315 Normally we run the normal hook `auto-save-hook' before saving.
5317 A non-nil NO-MESSAGE argument means do not print any message if successful.
5318 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5319 (Lisp_Object no_message
, Lisp_Object current_only
)
5321 struct buffer
*old
= current_buffer
, *b
;
5322 Lisp_Object tail
, buf
, hook
;
5323 bool auto_saved
= 0;
5324 int do_handled_files
;
5326 FILE *stream
= NULL
;
5327 ptrdiff_t count
= SPECPDL_INDEX ();
5328 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5329 bool old_message_p
= 0;
5330 struct gcpro gcpro1
, gcpro2
;
5332 if (max_specpdl_size
< specpdl_size
+ 40)
5333 max_specpdl_size
= specpdl_size
+ 40;
5338 if (NILP (no_message
))
5340 old_message_p
= push_message ();
5341 record_unwind_protect (pop_message_unwind
, Qnil
);
5344 /* Ordinarily don't quit within this function,
5345 but don't make it impossible to quit (in case we get hung in I/O). */
5349 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5350 point to non-strings reached from Vbuffer_alist. */
5352 hook
= intern ("auto-save-hook");
5353 Frun_hooks (1, &hook
);
5355 if (STRINGP (Vauto_save_list_file_name
))
5357 Lisp_Object listfile
;
5359 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5361 /* Don't try to create the directory when shutting down Emacs,
5362 because creating the directory might signal an error, and
5363 that would leave Emacs in a strange state. */
5364 if (!NILP (Vrun_hooks
))
5368 GCPRO2 (dir
, listfile
);
5369 dir
= Ffile_name_directory (listfile
);
5370 if (NILP (Ffile_directory_p (dir
)))
5371 internal_condition_case_1 (do_auto_save_make_dir
,
5377 stream
= fopen (SSDATA (listfile
), "w");
5380 record_unwind_protect (do_auto_save_unwind
,
5381 make_save_value (stream
, 0));
5382 record_unwind_protect (do_auto_save_unwind_1
,
5383 make_number (minibuffer_auto_raise
));
5384 minibuffer_auto_raise
= 0;
5386 auto_save_error_occurred
= 0;
5388 /* On first pass, save all files that don't have handlers.
5389 On second pass, save all files that do have handlers.
5391 If Emacs is crashing, the handlers may tweak what is causing
5392 Emacs to crash in the first place, and it would be a shame if
5393 Emacs failed to autosave perfectly ordinary files because it
5394 couldn't handle some ange-ftp'd file. */
5396 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5397 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5399 buf
= XCDR (XCAR (tail
));
5402 /* Record all the buffers that have auto save mode
5403 in the special file that lists them. For each of these buffers,
5404 Record visited name (if any) and auto save name. */
5405 if (STRINGP (BVAR (b
, auto_save_file_name
))
5406 && stream
!= NULL
&& do_handled_files
== 0)
5409 if (!NILP (BVAR (b
, filename
)))
5411 fwrite (SDATA (BVAR (b
, filename
)), 1,
5412 SBYTES (BVAR (b
, filename
)), stream
);
5414 putc ('\n', stream
);
5415 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5416 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5417 putc ('\n', stream
);
5421 if (!NILP (current_only
)
5422 && b
!= current_buffer
)
5425 /* Don't auto-save indirect buffers.
5426 The base buffer takes care of it. */
5430 /* Check for auto save enabled
5431 and file changed since last auto save
5432 and file changed since last real save. */
5433 if (STRINGP (BVAR (b
, auto_save_file_name
))
5434 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5435 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5436 /* -1 means we've turned off autosaving for a while--see below. */
5437 && XINT (BVAR (b
, save_length
)) >= 0
5438 && (do_handled_files
5439 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5442 EMACS_TIME before_time
= current_emacs_time ();
5443 EMACS_TIME after_time
;
5445 /* If we had a failure, don't try again for 20 minutes. */
5446 if (b
->auto_save_failure_time
> 0
5447 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5450 set_buffer_internal (b
);
5451 if (NILP (Vauto_save_include_big_deletions
)
5452 && (XFASTINT (BVAR (b
, save_length
)) * 10
5453 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5454 /* A short file is likely to change a large fraction;
5455 spare the user annoying messages. */
5456 && XFASTINT (BVAR (b
, save_length
)) > 5000
5457 /* These messages are frequent and annoying for `*mail*'. */
5458 && !EQ (BVAR (b
, filename
), Qnil
)
5459 && NILP (no_message
))
5461 /* It has shrunk too much; turn off auto-saving here. */
5462 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5463 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5465 minibuffer_auto_raise
= 0;
5466 /* Turn off auto-saving until there's a real save,
5467 and prevent any more warnings. */
5468 XSETINT (BVAR (b
, save_length
), -1);
5469 Fsleep_for (make_number (1), Qnil
);
5472 if (!auto_saved
&& NILP (no_message
))
5473 message1 ("Auto-saving...");
5474 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5476 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5477 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5478 set_buffer_internal (old
);
5480 after_time
= current_emacs_time ();
5482 /* If auto-save took more than 60 seconds,
5483 assume it was an NFS failure that got a timeout. */
5484 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5485 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5489 /* Prevent another auto save till enough input events come in. */
5490 record_auto_save ();
5492 if (auto_saved
&& NILP (no_message
))
5496 /* If we are going to restore an old message,
5497 give time to read ours. */
5498 sit_for (make_number (1), 0, 0);
5501 else if (!auto_save_error_occurred
)
5502 /* Don't overwrite the error message if an error occurred.
5503 If we displayed a message and then restored a state
5504 with no message, leave a "done" message on the screen. */
5505 message1 ("Auto-saving...done");
5510 /* This restores the message-stack status. */
5511 unbind_to (count
, Qnil
);
5515 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5516 Sset_buffer_auto_saved
, 0, 0, 0,
5517 doc
: /* Mark current buffer as auto-saved with its current text.
5518 No auto-save file will be written until the buffer changes again. */)
5521 /* FIXME: This should not be called in indirect buffers, since
5522 they're not autosaved. */
5523 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5524 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5525 current_buffer
->auto_save_failure_time
= 0;
5529 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5530 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5531 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5534 current_buffer
->auto_save_failure_time
= 0;
5538 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5540 doc
: /* Return t if current buffer has been auto-saved recently.
5541 More precisely, if it has been auto-saved since last read from or saved
5542 in the visited file. If the buffer has no visited file,
5543 then any auto-save counts as "recent". */)
5546 /* FIXME: maybe we should return nil for indirect buffers since
5547 they're never autosaved. */
5548 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5551 /* Reading and completing file names */
5553 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5554 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5555 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5556 The return value is only relevant for a call to `read-file-name' that happens
5557 before any other event (mouse or keypress) is handled. */)
5560 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5561 || defined (HAVE_NS)
5562 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5572 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5574 struct gcpro gcpro1
;
5575 Lisp_Object args
[7];
5577 GCPRO1 (default_filename
);
5578 args
[0] = intern ("read-file-name");
5581 args
[3] = default_filename
;
5582 args
[4] = mustmatch
;
5584 args
[6] = predicate
;
5585 RETURN_UNGCPRO (Ffuncall (7, args
));
5590 syms_of_fileio (void)
5592 DEFSYM (Qoperations
, "operations");
5593 DEFSYM (Qexpand_file_name
, "expand-file-name");
5594 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5595 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5596 DEFSYM (Qfile_name_directory
, "file-name-directory");
5597 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5598 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5599 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5600 DEFSYM (Qcopy_file
, "copy-file");
5601 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5602 DEFSYM (Qmake_directory
, "make-directory");
5603 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5604 DEFSYM (Qdelete_file
, "delete-file");
5605 DEFSYM (Qrename_file
, "rename-file");
5606 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5607 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5608 DEFSYM (Qfile_exists_p
, "file-exists-p");
5609 DEFSYM (Qfile_executable_p
, "file-executable-p");
5610 DEFSYM (Qfile_readable_p
, "file-readable-p");
5611 DEFSYM (Qfile_writable_p
, "file-writable-p");
5612 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5613 DEFSYM (Qaccess_file
, "access-file");
5614 DEFSYM (Qfile_directory_p
, "file-directory-p");
5615 DEFSYM (Qfile_regular_p
, "file-regular-p");
5616 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5617 DEFSYM (Qfile_modes
, "file-modes");
5618 DEFSYM (Qset_file_modes
, "set-file-modes");
5619 DEFSYM (Qset_file_times
, "set-file-times");
5620 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5621 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5622 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5623 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5624 DEFSYM (Qwrite_region
, "write-region");
5625 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5626 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5627 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5629 DEFSYM (Qfile_name_history
, "file-name-history");
5630 Fset (Qfile_name_history
, Qnil
);
5632 DEFSYM (Qfile_error
, "file-error");
5633 DEFSYM (Qfile_already_exists
, "file-already-exists");
5634 DEFSYM (Qfile_date_error
, "file-date-error");
5635 DEFSYM (Qexcl
, "excl");
5637 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5638 doc
: /* Coding system for encoding file names.
5639 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5640 Vfile_name_coding_system
= Qnil
;
5642 DEFVAR_LISP ("default-file-name-coding-system",
5643 Vdefault_file_name_coding_system
,
5644 doc
: /* Default coding system for encoding file names.
5645 This variable is used only when `file-name-coding-system' is nil.
5647 This variable is set/changed by the command `set-language-environment'.
5648 User should not set this variable manually,
5649 instead use `file-name-coding-system' to get a constant encoding
5650 of file names regardless of the current language environment. */);
5651 Vdefault_file_name_coding_system
= Qnil
;
5653 DEFSYM (Qformat_decode
, "format-decode");
5654 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5655 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5656 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5658 Fput (Qfile_error
, Qerror_conditions
,
5659 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5660 Fput (Qfile_error
, Qerror_message
,
5661 build_pure_c_string ("File error"));
5663 Fput (Qfile_already_exists
, Qerror_conditions
,
5664 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5665 Fput (Qfile_already_exists
, Qerror_message
,
5666 build_pure_c_string ("File already exists"));
5668 Fput (Qfile_date_error
, Qerror_conditions
,
5669 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5670 Fput (Qfile_date_error
, Qerror_message
,
5671 build_pure_c_string ("Cannot set file date"));
5673 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5674 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5675 If a file name matches REGEXP, all I/O on that file is done by calling
5676 HANDLER. If a file name matches more than one handler, the handler
5677 whose match starts last in the file name gets precedence. The
5678 function `find-file-name-handler' checks this list for a handler for
5681 HANDLER should be a function. The first argument given to it is the
5682 name of the I/O primitive to be handled; the remaining arguments are
5683 the arguments that were passed to that primitive. For example, if you
5684 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5685 HANDLER is called like this:
5687 (funcall HANDLER 'file-exists-p FILENAME)
5689 Note that HANDLER must be able to handle all I/O primitives; if it has
5690 nothing special to do for a primitive, it should reinvoke the
5691 primitive to handle the operation \"the usual way\".
5692 See Info node `(elisp)Magic File Names' for more details. */);
5693 Vfile_name_handler_alist
= Qnil
;
5695 DEFVAR_LISP ("set-auto-coding-function",
5696 Vset_auto_coding_function
,
5697 doc
: /* If non-nil, a function to call to decide a coding system of file.
5698 Two arguments are passed to this function: the file name
5699 and the length of a file contents following the point.
5700 This function should return a coding system to decode the file contents.
5701 It should check the file name against `auto-coding-alist'.
5702 If no coding system is decided, it should check a coding system
5703 specified in the heading lines with the format:
5704 -*- ... coding: CODING-SYSTEM; ... -*-
5705 or local variable spec of the tailing lines with `coding:' tag. */);
5706 Vset_auto_coding_function
= Qnil
;
5708 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5709 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5710 Each is passed one argument, the number of characters inserted,
5711 with point at the start of the inserted text. Each function
5712 should leave point the same, and return the new character count.
5713 If `insert-file-contents' is intercepted by a handler from
5714 `file-name-handler-alist', that handler is responsible for calling the
5715 functions in `after-insert-file-functions' if appropriate. */);
5716 Vafter_insert_file_functions
= Qnil
;
5718 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5719 doc
: /* A list of functions to be called at the start of `write-region'.
5720 Each is passed two arguments, START and END as for `write-region'.
5721 These are usually two numbers but not always; see the documentation
5722 for `write-region'. The function should return a list of pairs
5723 of the form (POSITION . STRING), consisting of strings to be effectively
5724 inserted at the specified positions of the file being written (1 means to
5725 insert before the first byte written). The POSITIONs must be sorted into
5728 If there are several annotation functions, the lists returned by these
5729 functions are merged destructively. As each annotation function runs,
5730 the variable `write-region-annotations-so-far' contains a list of all
5731 annotations returned by previous annotation functions.
5733 An annotation function can return with a different buffer current.
5734 Doing so removes the annotations returned by previous functions, and
5735 resets START and END to `point-min' and `point-max' of the new buffer.
5737 After `write-region' completes, Emacs calls the function stored in
5738 `write-region-post-annotation-function', once for each buffer that was
5739 current when building the annotations (i.e., at least once), with that
5740 buffer current. */);
5741 Vwrite_region_annotate_functions
= Qnil
;
5742 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5744 DEFVAR_LISP ("write-region-post-annotation-function",
5745 Vwrite_region_post_annotation_function
,
5746 doc
: /* Function to call after `write-region' completes.
5747 The function is called with no arguments. If one or more of the
5748 annotation functions in `write-region-annotate-functions' changed the
5749 current buffer, the function stored in this variable is called for
5750 each of those additional buffers as well, in addition to the original
5751 buffer. The relevant buffer is current during each function call. */);
5752 Vwrite_region_post_annotation_function
= Qnil
;
5753 staticpro (&Vwrite_region_annotation_buffers
);
5755 DEFVAR_LISP ("write-region-annotations-so-far",
5756 Vwrite_region_annotations_so_far
,
5757 doc
: /* When an annotation function is called, this holds the previous annotations.
5758 These are the annotations made by other annotation functions
5759 that were already called. See also `write-region-annotate-functions'. */);
5760 Vwrite_region_annotations_so_far
= Qnil
;
5762 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5763 doc
: /* A list of file name handlers that temporarily should not be used.
5764 This applies only to the operation `inhibit-file-name-operation'. */);
5765 Vinhibit_file_name_handlers
= Qnil
;
5767 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5768 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5769 Vinhibit_file_name_operation
= Qnil
;
5771 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
5772 doc
: /* File name in which we write a list of all auto save file names.
5773 This variable is initialized automatically from `auto-save-list-file-prefix'
5774 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5775 a non-nil value. */);
5776 Vauto_save_list_file_name
= Qnil
;
5778 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
5779 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5780 Normally auto-save files are written under other names. */);
5781 Vauto_save_visited_file_name
= Qnil
;
5783 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
5784 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5785 If nil, deleting a substantial portion of the text disables auto-save
5786 in the buffer; this is the default behavior, because the auto-save
5787 file is usually more useful if it contains the deleted text. */);
5788 Vauto_save_include_big_deletions
= Qnil
;
5791 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
5792 doc
: /* Non-nil means don't call fsync in `write-region'.
5793 This variable affects calls to `write-region' as well as save commands.
5794 A non-nil value may result in data loss! */);
5795 write_region_inhibit_fsync
= 0;
5798 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
5799 doc
: /* Specifies whether to use the system's trash can.
5800 When non-nil, certain file deletion commands use the function
5801 `move-file-to-trash' instead of deleting files outright.
5802 This includes interactive calls to `delete-file' and
5803 `delete-directory' and the Dired deletion commands. */);
5804 delete_by_moving_to_trash
= 0;
5805 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5807 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
5808 DEFSYM (Qcopy_directory
, "copy-directory");
5809 DEFSYM (Qdelete_directory
, "delete-directory");
5811 defsubr (&Sfind_file_name_handler
);
5812 defsubr (&Sfile_name_directory
);
5813 defsubr (&Sfile_name_nondirectory
);
5814 defsubr (&Sunhandled_file_name_directory
);
5815 defsubr (&Sfile_name_as_directory
);
5816 defsubr (&Sdirectory_file_name
);
5817 defsubr (&Smake_temp_name
);
5818 defsubr (&Sexpand_file_name
);
5819 defsubr (&Ssubstitute_in_file_name
);
5820 defsubr (&Scopy_file
);
5821 defsubr (&Smake_directory_internal
);
5822 defsubr (&Sdelete_directory_internal
);
5823 defsubr (&Sdelete_file
);
5824 defsubr (&Srename_file
);
5825 defsubr (&Sadd_name_to_file
);
5826 defsubr (&Smake_symbolic_link
);
5827 defsubr (&Sfile_name_absolute_p
);
5828 defsubr (&Sfile_exists_p
);
5829 defsubr (&Sfile_executable_p
);
5830 defsubr (&Sfile_readable_p
);
5831 defsubr (&Sfile_writable_p
);
5832 defsubr (&Saccess_file
);
5833 defsubr (&Sfile_symlink_p
);
5834 defsubr (&Sfile_directory_p
);
5835 defsubr (&Sfile_accessible_directory_p
);
5836 defsubr (&Sfile_regular_p
);
5837 defsubr (&Sfile_modes
);
5838 defsubr (&Sset_file_modes
);
5839 defsubr (&Sset_file_times
);
5840 defsubr (&Sfile_selinux_context
);
5841 defsubr (&Sset_file_selinux_context
);
5842 defsubr (&Sset_default_file_modes
);
5843 defsubr (&Sdefault_file_modes
);
5844 defsubr (&Sfile_newer_than_file_p
);
5845 defsubr (&Sinsert_file_contents
);
5846 defsubr (&Swrite_region
);
5847 defsubr (&Scar_less_than_car
);
5848 defsubr (&Sverify_visited_file_modtime
);
5849 defsubr (&Sclear_visited_file_modtime
);
5850 defsubr (&Svisited_file_modtime
);
5851 defsubr (&Sset_visited_file_modtime
);
5852 defsubr (&Sdo_auto_save
);
5853 defsubr (&Sset_buffer_auto_saved
);
5854 defsubr (&Sclear_buffer_auto_save_failure
);
5855 defsubr (&Srecent_auto_save_p
);
5857 defsubr (&Snext_read_file_uses_dialog_p
);
5860 defsubr (&Sunix_sync
);