1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
36 #ifdef HAVE_LIBSELINUX
37 #include <selinux/selinux.h>
38 #include <selinux/context.h>
42 #include "intervals.h"
43 #include "character.h"
47 #include "blockinput.h"
49 #include "dispextern.h"
55 #endif /* not WINDOWSNT */
59 #include <sys/param.h>
64 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
65 redirector allows the six letters between 'Z' and 'a' as well. */
67 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
70 #define IS_DRIVE(x) isalpha ((unsigned char) (x))
72 /* Need to lower-case the drive letter, or else expanded
73 filenames will sometimes compare unequal, because
74 `expand-file-name' doesn't always down-case the drive letter. */
75 #define DRIVE_LETTER(x) (tolower ((unsigned char) (x)))
79 #include <stat-time.h>
87 #ifndef FILE_SYSTEM_CASE
88 #define FILE_SYSTEM_CASE(filename) (filename)
91 /* Nonzero during writing of auto-save files. */
92 static int auto_saving
;
94 /* Nonzero umask during creation of auto-save directories. */
95 static int auto_saving_dir_umask
;
97 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
98 a new file with the same mode as the original. */
99 static int auto_save_mode_bits
;
101 /* Set by auto_save_1 if an error occurred during the last auto-save. */
102 static int auto_save_error_occurred
;
104 /* The symbol bound to coding-system-for-read when
105 insert-file-contents is called for recovering a file. This is not
106 an actual coding system name, but just an indicator to tell
107 insert-file-contents to use `emacs-mule' with a special flag for
108 auto saving and recovering a file. */
109 static Lisp_Object Qauto_save_coding
;
111 /* Property name of a file name handler,
112 which gives a list of operations it handles.. */
113 static Lisp_Object Qoperations
;
115 /* Lisp functions for translating file formats. */
116 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
118 /* Lisp function for setting buffer-file-coding-system and the
119 multibyteness of the current buffer after inserting a file. */
120 static Lisp_Object Qafter_insert_file_set_coding
;
122 static Lisp_Object Qwrite_region_annotate_functions
;
123 /* Each time an annotation function changes the buffer, the new buffer
125 static Lisp_Object Vwrite_region_annotation_buffers
;
130 static Lisp_Object Qdelete_by_moving_to_trash
;
132 /* Lisp function for moving files to trash. */
133 static Lisp_Object Qmove_file_to_trash
;
135 /* Lisp function for recursively copying directories. */
136 static Lisp_Object Qcopy_directory
;
138 /* Lisp function for recursively deleting directories. */
139 static Lisp_Object Qdelete_directory
;
144 Lisp_Object Qfile_error
;
145 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
146 static Lisp_Object Qexcl
;
147 Lisp_Object Qfile_name_history
;
149 static Lisp_Object Qcar_less_than_car
;
151 static int a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
152 Lisp_Object
*, struct coding_system
*);
153 static int e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
154 struct coding_system
*);
158 report_file_error (const char *string
, Lisp_Object data
)
160 Lisp_Object errstring
;
164 synchronize_system_messages_locale ();
165 str
= strerror (errorno
);
166 errstring
= code_convert_string_norecord (make_unibyte_string (str
,
168 Vlocale_coding_system
, 0);
174 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
177 /* System error messages are capitalized. Downcase the initial
178 unless it is followed by a slash. (The slash case caters to
179 error messages that begin with "I/O" or, in German, "E/A".) */
180 if (STRING_MULTIBYTE (errstring
)
181 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
185 str
= SSDATA (errstring
);
186 c
= STRING_CHAR ((unsigned char *) str
);
187 Faset (errstring
, make_number (0), make_number (downcase (c
)));
190 xsignal (Qfile_error
,
191 Fcons (build_string (string
), Fcons (errstring
, data
)));
196 close_file_unwind (Lisp_Object fd
)
198 emacs_close (XFASTINT (fd
));
202 /* Restore point, having saved it as a marker. */
205 restore_point_unwind (Lisp_Object location
)
207 Fgoto_char (location
);
208 Fset_marker (location
, Qnil
, Qnil
);
213 static Lisp_Object Qexpand_file_name
;
214 static Lisp_Object Qsubstitute_in_file_name
;
215 static Lisp_Object Qdirectory_file_name
;
216 static Lisp_Object Qfile_name_directory
;
217 static Lisp_Object Qfile_name_nondirectory
;
218 static Lisp_Object Qunhandled_file_name_directory
;
219 static Lisp_Object Qfile_name_as_directory
;
220 static Lisp_Object Qcopy_file
;
221 static Lisp_Object Qmake_directory_internal
;
222 static Lisp_Object Qmake_directory
;
223 static Lisp_Object Qdelete_directory_internal
;
224 Lisp_Object Qdelete_file
;
225 static Lisp_Object Qrename_file
;
226 static Lisp_Object Qadd_name_to_file
;
227 static Lisp_Object Qmake_symbolic_link
;
228 Lisp_Object Qfile_exists_p
;
229 static Lisp_Object Qfile_executable_p
;
230 static Lisp_Object Qfile_readable_p
;
231 static Lisp_Object Qfile_writable_p
;
232 static Lisp_Object Qfile_symlink_p
;
233 static Lisp_Object Qaccess_file
;
234 Lisp_Object Qfile_directory_p
;
235 static Lisp_Object Qfile_regular_p
;
236 static Lisp_Object Qfile_accessible_directory_p
;
237 static Lisp_Object Qfile_modes
;
238 static Lisp_Object Qset_file_modes
;
239 static Lisp_Object Qset_file_times
;
240 static Lisp_Object Qfile_selinux_context
;
241 static Lisp_Object Qset_file_selinux_context
;
242 static Lisp_Object Qfile_newer_than_file_p
;
243 Lisp_Object Qinsert_file_contents
;
244 Lisp_Object Qwrite_region
;
245 static Lisp_Object Qverify_visited_file_modtime
;
246 static Lisp_Object Qset_visited_file_modtime
;
248 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
249 Sfind_file_name_handler
, 2, 2, 0,
250 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
251 Otherwise, return nil.
252 A file name is handled if one of the regular expressions in
253 `file-name-handler-alist' matches it.
255 If OPERATION equals `inhibit-file-name-operation', then we ignore
256 any handlers that are members of `inhibit-file-name-handlers',
257 but we still do run any other handlers. This lets handlers
258 use the standard functions without calling themselves recursively. */)
259 (Lisp_Object filename
, Lisp_Object operation
)
261 /* This function must not munge the match data. */
262 Lisp_Object chain
, inhibited_handlers
, result
;
266 CHECK_STRING (filename
);
268 if (EQ (operation
, Vinhibit_file_name_operation
))
269 inhibited_handlers
= Vinhibit_file_name_handlers
;
271 inhibited_handlers
= Qnil
;
273 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
274 chain
= XCDR (chain
))
280 Lisp_Object string
= XCAR (elt
);
282 Lisp_Object handler
= XCDR (elt
);
283 Lisp_Object operations
= Qnil
;
285 if (SYMBOLP (handler
))
286 operations
= Fget (handler
, Qoperations
);
289 && (match_pos
= fast_string_match (string
, filename
)) > pos
290 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
294 handler
= XCDR (elt
);
295 tem
= Fmemq (handler
, inhibited_handlers
);
309 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
311 doc
: /* Return the directory component in file name FILENAME.
312 Return nil if FILENAME does not include a directory.
313 Otherwise return a directory name.
314 Given a Unix syntax file name, returns a string ending in slash. */)
315 (Lisp_Object filename
)
318 register const char *beg
;
322 register const char *p
;
325 CHECK_STRING (filename
);
327 /* If the file name has special constructs in it,
328 call the corresponding file handler. */
329 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
332 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
334 return STRINGP (handled_name
) ? handled_name
: Qnil
;
337 filename
= FILE_SYSTEM_CASE (filename
);
339 beg
= (char *) alloca (SBYTES (filename
) + 1);
340 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
342 beg
= SSDATA (filename
);
344 p
= beg
+ SBYTES (filename
);
346 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
348 /* only recognize drive specifier at the beginning */
350 /* handle the "/:d:foo" and "/:foo" cases correctly */
351 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
352 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
359 /* Expansion of "c:" to drive and default directory. */
362 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
363 char *res
= alloca (MAXPATHLEN
+ 1);
366 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
368 strncpy (res
, beg
, 2);
373 if (getdefdir (toupper ((unsigned char) *beg
) - 'A' + 1, r
))
375 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
378 p
= beg
+ strlen (beg
);
381 dostounix_filename (beg
);
384 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
387 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
388 Sfile_name_nondirectory
, 1, 1, 0,
389 doc
: /* Return file name FILENAME sans its directory.
390 For example, in a Unix-syntax file name,
391 this is everything after the last slash,
392 or the entire name if it contains no slash. */)
393 (Lisp_Object filename
)
395 register const char *beg
, *p
, *end
;
398 CHECK_STRING (filename
);
400 /* If the file name has special constructs in it,
401 call the corresponding file handler. */
402 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
405 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
407 if (STRINGP (handled_name
))
409 error ("Invalid handler in `file-name-handler-alist'");
412 beg
= SSDATA (filename
);
413 end
= p
= beg
+ SBYTES (filename
);
415 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
417 /* only recognize drive specifier at beginning */
419 /* handle the "/:d:foo" case correctly */
420 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
425 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
428 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
429 Sunhandled_file_name_directory
, 1, 1, 0,
430 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
431 A `directly usable' directory name is one that may be used without the
432 intervention of any file handler.
433 If FILENAME is a directly usable file itself, return
434 \(file-name-directory FILENAME).
435 If FILENAME refers to a file which is not accessible from a local process,
436 then this should return nil.
437 The `call-process' and `start-process' functions use this function to
438 get a current directory to run processes in. */)
439 (Lisp_Object filename
)
443 /* If the file name has special constructs in it,
444 call the corresponding file handler. */
445 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
448 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
450 return STRINGP (handled_name
) ? handled_name
: Qnil
;
453 return Ffile_name_directory (filename
);
458 file_name_as_directory (char *out
, const char *in
)
460 ptrdiff_t len
= strlen (in
);
472 /* For Unix syntax, Append a slash if necessary */
473 if (!IS_DIRECTORY_SEP (out
[len
- 1]))
475 out
[len
] = DIRECTORY_SEP
;
479 dostounix_filename (out
);
484 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
485 Sfile_name_as_directory
, 1, 1, 0,
486 doc
: /* Return a string representing the file name FILE interpreted as a directory.
487 This operation exists because a directory is also a file, but its name as
488 a directory is different from its name as a file.
489 The result can be used as the value of `default-directory'
490 or passed as second argument to `expand-file-name'.
491 For a Unix-syntax file name, just appends a slash. */)
501 /* If the file name has special constructs in it,
502 call the corresponding file handler. */
503 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
506 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
508 if (STRINGP (handled_name
))
510 error ("Invalid handler in `file-name-handler-alist'");
513 buf
= (char *) alloca (SBYTES (file
) + 10);
514 file_name_as_directory (buf
, SSDATA (file
));
515 return make_specified_string (buf
, -1, strlen (buf
),
516 STRING_MULTIBYTE (file
));
520 * Convert from directory name to filename.
521 * On UNIX, it's simple: just make sure there isn't a terminating /
523 * Value is nonzero if the string output is different from the input.
527 directory_file_name (char *src
, char *dst
)
533 /* Process as Unix format: just remove any final slash.
534 But leave "/" unchanged; do not change it to "". */
537 && IS_DIRECTORY_SEP (dst
[slen
- 1])
539 && !IS_ANY_SEP (dst
[slen
- 2])
544 dostounix_filename (dst
);
549 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
551 doc
: /* Returns the file name of the directory named DIRECTORY.
552 This is the name of the file that holds the data for the directory DIRECTORY.
553 This operation exists because a directory is also a file, but its name as
554 a directory is different from its name as a file.
555 In Unix-syntax, this function just removes the final slash. */)
556 (Lisp_Object directory
)
561 CHECK_STRING (directory
);
563 if (NILP (directory
))
566 /* If the file name has special constructs in it,
567 call the corresponding file handler. */
568 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
571 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
573 if (STRINGP (handled_name
))
575 error ("Invalid handler in `file-name-handler-alist'");
578 buf
= (char *) alloca (SBYTES (directory
) + 20);
579 directory_file_name (SSDATA (directory
), buf
);
580 return make_specified_string (buf
, -1, strlen (buf
),
581 STRING_MULTIBYTE (directory
));
584 static const char make_temp_name_tbl
[64] =
586 'A','B','C','D','E','F','G','H',
587 'I','J','K','L','M','N','O','P',
588 'Q','R','S','T','U','V','W','X',
589 'Y','Z','a','b','c','d','e','f',
590 'g','h','i','j','k','l','m','n',
591 'o','p','q','r','s','t','u','v',
592 'w','x','y','z','0','1','2','3',
593 '4','5','6','7','8','9','-','_'
596 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
598 /* Value is a temporary file name starting with PREFIX, a string.
600 The Emacs process number forms part of the result, so there is
601 no danger of generating a name being used by another process.
602 In addition, this function makes an attempt to choose a name
603 which has no existing file. To make this work, PREFIX should be
604 an absolute file name.
606 BASE64_P non-zero means add the pid as 3 characters in base64
607 encoding. In this case, 6 characters will be added to PREFIX to
608 form the file name. Otherwise, if Emacs is running on a system
609 with long file names, add the pid as a decimal number.
611 This function signals an error if no unique file name could be
615 make_temp_name (Lisp_Object prefix
, int base64_p
)
621 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
624 CHECK_STRING (prefix
);
626 /* VAL is created by adding 6 characters to PREFIX. The first
627 three are the PID of this process, in base 64, and the second
628 three are incremented if the file already exists. This ensures
629 262144 unique file names per PID per PREFIX. */
635 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
636 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
637 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
642 #ifdef HAVE_LONG_FILE_NAMES
643 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
645 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
646 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
647 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
652 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
653 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
654 if (!STRING_MULTIBYTE (prefix
))
655 STRING_SET_UNIBYTE (val
);
657 memcpy (data
, SSDATA (prefix
), len
);
660 memcpy (p
, pidbuf
, pidlen
);
663 /* Here we try to minimize useless stat'ing when this function is
664 invoked many times successively with the same PREFIX. We achieve
665 this by initializing count to a random value, and incrementing it
668 We don't want make-temp-name to be called while dumping,
669 because then make_temp_name_count_initialized_p would get set
670 and then make_temp_name_count would not be set when Emacs starts. */
672 if (!make_temp_name_count_initialized_p
)
674 make_temp_name_count
= time (NULL
);
675 make_temp_name_count_initialized_p
= 1;
681 unsigned num
= make_temp_name_count
;
683 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
684 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
685 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
687 /* Poor man's congruential RN generator. Replace with
688 ++make_temp_name_count for debugging. */
689 make_temp_name_count
+= 25229;
690 make_temp_name_count
%= 225307;
692 if (stat (data
, &ignored
) < 0)
694 /* We want to return only if errno is ENOENT. */
698 /* The error here is dubious, but there is little else we
699 can do. The alternatives are to return nil, which is
700 as bad as (and in many cases worse than) throwing the
701 error, or to ignore the error, which will likely result
702 in looping through 225307 stat's, which is not only
703 dog-slow, but also useless since eventually nil would
704 have to be returned anyway. */
705 report_file_error ("Cannot create temporary name for prefix",
706 Fcons (prefix
, Qnil
));
713 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
714 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
715 The Emacs process number forms part of the result,
716 so there is no danger of generating a name being used by another process.
718 In addition, this function makes an attempt to choose a name
719 which has no existing file. To make this work,
720 PREFIX should be an absolute file name.
722 There is a race condition between calling `make-temp-name' and creating the
723 file which opens all kinds of security holes. For that reason, you should
724 probably use `make-temp-file' instead, except in three circumstances:
726 * If you are creating the file in the user's home directory.
727 * If you are creating a directory rather than an ordinary file.
728 * If you are taking special precautions as `make-temp-file' does. */)
731 return make_temp_name (prefix
, 0);
736 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
737 doc
: /* Convert filename NAME to absolute, and canonicalize it.
738 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
739 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
740 the current buffer's value of `default-directory' is used.
741 NAME should be a string that is a valid file name for the underlying
743 File name components that are `.' are removed, and
744 so are file name components followed by `..', along with the `..' itself;
745 note that these simplifications are done without checking the resulting
746 file names in the file system.
747 Multiple consecutive slashes are collapsed into a single slash,
748 except at the beginning of the file name when they are significant (e.g.,
749 UNC file names on MS-Windows.)
750 An initial `~/' expands to your home directory.
751 An initial `~USER/' expands to USER's home directory.
752 See also the function `substitute-in-file-name'.
754 For technical reasons, this function can return correct but
755 non-intuitive results for the root directory; for instance,
756 \(expand-file-name ".." "/") returns "/..". For this reason, use
757 \(directory-file-name (file-name-directory dirname)) to traverse a
758 filesystem tree, not (expand-file-name ".." dirname). */)
759 (Lisp_Object name
, Lisp_Object default_directory
)
761 /* These point to SDATA and need to be careful with string-relocation
762 during GC (via DECODE_FILE). */
765 /* This should only point to alloca'd data. */
772 int collapse_newdir
= 1;
776 Lisp_Object handler
, result
, handled_name
;
782 /* If the file name has special constructs in it,
783 call the corresponding file handler. */
784 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
787 handled_name
= call3 (handler
, Qexpand_file_name
,
788 name
, default_directory
);
789 if (STRINGP (handled_name
))
791 error ("Invalid handler in `file-name-handler-alist'");
795 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
796 if (NILP (default_directory
))
797 default_directory
= BVAR (current_buffer
, directory
);
798 if (! STRINGP (default_directory
))
801 /* "/" is not considered a root directory on DOS_NT, so using "/"
802 here causes an infinite recursion in, e.g., the following:
804 (let (default-directory)
805 (expand-file-name "a"))
807 To avoid this, we set default_directory to the root of the
809 default_directory
= build_string (emacs_root_dir ());
811 default_directory
= build_string ("/");
815 if (!NILP (default_directory
))
817 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
820 handled_name
= call3 (handler
, Qexpand_file_name
,
821 name
, default_directory
);
822 if (STRINGP (handled_name
))
824 error ("Invalid handler in `file-name-handler-alist'");
829 char *o
= SSDATA (default_directory
);
831 /* Make sure DEFAULT_DIRECTORY is properly expanded.
832 It would be better to do this down below where we actually use
833 default_directory. Unfortunately, calling Fexpand_file_name recursively
834 could invoke GC, and the strings might be relocated. This would
835 be annoying because we have pointers into strings lying around
836 that would need adjusting, and people would add new pointers to
837 the code and forget to adjust them, resulting in intermittent bugs.
838 Putting this call here avoids all that crud.
840 The EQ test avoids infinite recursion. */
841 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
842 /* Save time in some common cases - as long as default_directory
843 is not relative, it can be canonicalized with name below (if it
844 is needed at all) without requiring it to be expanded now. */
846 /* Detect MSDOS file names with drive specifiers. */
847 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
848 && IS_DIRECTORY_SEP (o
[2]))
850 /* Detect Windows file names in UNC format. */
851 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
853 #else /* not DOS_NT */
854 /* Detect Unix absolute file names (/... alone is not absolute on
856 && ! (IS_DIRECTORY_SEP (o
[0]))
857 #endif /* not DOS_NT */
863 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
867 name
= FILE_SYSTEM_CASE (name
);
868 multibyte
= STRING_MULTIBYTE (name
);
869 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
872 default_directory
= string_to_multibyte (default_directory
);
875 name
= string_to_multibyte (name
);
880 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
881 nm
= (char *) alloca (SBYTES (name
) + 1);
882 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
885 /* Note if special escape prefix is present, but remove for now. */
886 if (nm
[0] == '/' && nm
[1] == ':')
892 /* Find and remove drive specifier if present; this makes nm absolute
893 even if the rest of the name appears to be relative. Only look for
894 drive specifier at the beginning. */
895 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
897 drive
= (unsigned char) nm
[0];
902 /* If we see "c://somedir", we want to strip the first slash after the
903 colon when stripping the drive letter. Otherwise, this expands to
905 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
908 /* Discard any previous drive specifier if nm is now in UNC format. */
909 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
913 #endif /* WINDOWSNT */
916 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
917 none are found, we can probably return right away. We will avoid
918 allocating a new string if name is already fully expanded. */
920 IS_DIRECTORY_SEP (nm
[0])
922 && drive
&& !is_escaped
925 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
929 /* If it turns out that the filename we want to return is just a
930 suffix of FILENAME, we don't need to go through and edit
931 things; we just need to construct a new string using data
932 starting at the middle of FILENAME. If we set lose to a
933 non-zero value, that means we've discovered that we can't do
940 /* Since we know the name is absolute, we can assume that each
941 element starts with a "/". */
943 /* "." and ".." are hairy. */
944 if (IS_DIRECTORY_SEP (p
[0])
946 && (IS_DIRECTORY_SEP (p
[2])
948 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
951 /* We want to replace multiple `/' in a row with a single
954 && IS_DIRECTORY_SEP (p
[0])
955 && IS_DIRECTORY_SEP (p
[1]))
962 /* Make sure directories are all separated with /, but
963 avoid allocation of a new string when not required. */
964 dostounix_filename (nm
);
966 if (IS_DIRECTORY_SEP (nm
[1]))
968 if (strcmp (nm
, SSDATA (name
)) != 0)
969 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
973 /* Drive must be set, so this is okay. */
974 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
978 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
979 temp
[0] = DRIVE_LETTER (drive
);
980 name
= concat2 (build_string (temp
), name
);
983 #else /* not DOS_NT */
984 if (strcmp (nm
, SSDATA (name
)) == 0)
986 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
987 #endif /* not DOS_NT */
991 /* At this point, nm might or might not be an absolute file name. We
992 need to expand ~ or ~user if present, otherwise prefix nm with
993 default_directory if nm is not absolute, and finally collapse /./
994 and /foo/../ sequences.
996 We set newdir to be the appropriate prefix if one is needed:
997 - the relevant user directory if nm starts with ~ or ~user
998 - the specified drive's working dir (DOS/NT only) if nm does not
1000 - the value of default_directory.
1002 Note that these prefixes are not guaranteed to be absolute (except
1003 for the working dir of a drive). Therefore, to ensure we always
1004 return an absolute name, if the final prefix is not absolute we
1005 append it to the current working directory. */
1009 if (nm
[0] == '~') /* prefix ~ */
1011 if (IS_DIRECTORY_SEP (nm
[1])
1012 || nm
[1] == 0) /* ~ by itself */
1016 if (!(newdir
= egetenv ("HOME")))
1019 /* `egetenv' may return a unibyte string, which will bite us since
1020 we expect the directory to be multibyte. */
1021 tem
= build_string (newdir
);
1022 if (!STRING_MULTIBYTE (tem
))
1024 hdir
= DECODE_FILE (tem
);
1025 newdir
= SSDATA (hdir
);
1028 collapse_newdir
= 0;
1031 else /* ~user/filename */
1034 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1035 o
= alloca (p
- nm
+ 1);
1036 memcpy (o
, nm
, p
- nm
);
1040 pw
= (struct passwd
*) getpwnam (o
+ 1);
1044 newdir
= pw
->pw_dir
;
1047 collapse_newdir
= 0;
1051 /* If we don't find a user of that name, leave the name
1052 unchanged; don't move nm forward to p. */
1057 /* On DOS and Windows, nm is absolute if a drive name was specified;
1058 use the drive's current directory as the prefix if needed. */
1059 if (!newdir
&& drive
)
1061 /* Get default directory if needed to make nm absolute. */
1063 if (!IS_DIRECTORY_SEP (nm
[0]))
1065 adir
= alloca (MAXPATHLEN
+ 1);
1066 if (!getdefdir (toupper (drive
) - 'A' + 1, adir
))
1071 /* Either nm starts with /, or drive isn't mounted. */
1073 adir
[0] = DRIVE_LETTER (drive
);
1082 /* Finally, if no prefix has been specified and nm is not absolute,
1083 then it must be expanded relative to default_directory. */
1087 /* /... alone is not absolute on DOS and Windows. */
1088 && !IS_DIRECTORY_SEP (nm
[0])
1091 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1095 newdir
= SSDATA (default_directory
);
1097 /* Note if special escape prefix is present, but remove for now. */
1098 if (newdir
[0] == '/' && newdir
[1] == ':')
1109 /* First ensure newdir is an absolute name. */
1111 /* Detect MSDOS file names with drive specifiers. */
1112 ! (IS_DRIVE (newdir
[0])
1113 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1115 /* Detect Windows file names in UNC format. */
1116 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1120 /* Effectively, let newdir be (expand-file-name newdir cwd).
1121 Because of the admonition against calling expand-file-name
1122 when we have pointers into lisp strings, we accomplish this
1123 indirectly by prepending newdir to nm if necessary, and using
1124 cwd (or the wd of newdir's drive) as the new newdir. */
1126 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1128 drive
= (unsigned char) newdir
[0];
1131 if (!IS_DIRECTORY_SEP (nm
[0]))
1133 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1134 file_name_as_directory (tmp
, newdir
);
1138 adir
= alloca (MAXPATHLEN
+ 1);
1141 if (!getdefdir (toupper (drive
) - 'A' + 1, adir
))
1149 /* Strip off drive name from prefix, if present. */
1150 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1156 /* Keep only a prefix from newdir if nm starts with slash
1157 (//server/share for UNC, nothing otherwise). */
1158 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1161 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1163 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1165 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1167 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1180 /* Get rid of any slash at the end of newdir, unless newdir is
1181 just / or // (an incomplete UNC name). */
1182 length
= strlen (newdir
);
1183 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1185 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1189 char *temp
= (char *) alloca (length
);
1190 memcpy (temp
, newdir
, length
- 1);
1191 temp
[length
- 1] = 0;
1199 /* Now concatenate the directory and name to new space in the stack frame. */
1200 tlen
+= strlen (nm
) + 1;
1202 /* Reserve space for drive specifier and escape prefix, since either
1203 or both may need to be inserted. (The Microsoft x86 compiler
1204 produces incorrect code if the following two lines are combined.) */
1205 target
= (char *) alloca (tlen
+ 4);
1207 #else /* not DOS_NT */
1208 target
= (char *) alloca (tlen
);
1209 #endif /* not DOS_NT */
1214 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1217 /* If newdir is effectively "C:/", then the drive letter will have
1218 been stripped and newdir will be "/". Concatenating with an
1219 absolute directory in nm produces "//", which will then be
1220 incorrectly treated as a network share. Ignore newdir in
1221 this case (keeping the drive letter). */
1222 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1223 && newdir
[1] == '\0'))
1225 strcpy (target
, newdir
);
1228 file_name_as_directory (target
, newdir
);
1231 strcat (target
, nm
);
1233 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1241 if (!IS_DIRECTORY_SEP (*p
))
1245 else if (p
[1] == '.'
1246 && (IS_DIRECTORY_SEP (p
[2])
1249 /* If "/." is the entire filename, keep the "/". Otherwise,
1250 just delete the whole "/.". */
1251 if (o
== target
&& p
[2] == '\0')
1255 else if (p
[1] == '.' && p
[2] == '.'
1256 /* `/../' is the "superroot" on certain file systems.
1257 Turned off on DOS_NT systems because they have no
1258 "superroot" and because this causes us to produce
1259 file names like "d:/../foo" which fail file-related
1260 functions of the underlying OS. (To reproduce, try a
1261 long series of "../../" in default_directory, longer
1262 than the number of levels from the root.) */
1266 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1271 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1274 /* Don't go below server level in UNC filenames. */
1275 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1276 && IS_DIRECTORY_SEP (*target
))
1280 /* Keep initial / only if this is the whole name. */
1281 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1285 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1286 /* Collapse multiple `/' in a row. */
1295 /* At last, set drive name. */
1297 /* Except for network file name. */
1298 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1299 #endif /* WINDOWSNT */
1301 if (!drive
) abort ();
1303 target
[0] = DRIVE_LETTER (drive
);
1306 /* Reinsert the escape prefix if required. */
1313 dostounix_filename (target
);
1316 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1319 /* Again look to see if the file name has special constructs in it
1320 and perhaps call the corresponding file handler. This is needed
1321 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1322 the ".." component gives us "/user@host:/bar/../baz" which needs
1323 to be expanded again. */
1324 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1325 if (!NILP (handler
))
1327 handled_name
= call3 (handler
, Qexpand_file_name
,
1328 result
, default_directory
);
1329 if (STRINGP (handled_name
))
1330 return handled_name
;
1331 error ("Invalid handler in `file-name-handler-alist'");
1338 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1339 This is the old version of expand-file-name, before it was thoroughly
1340 rewritten for Emacs 10.31. We leave this version here commented-out,
1341 because the code is very complex and likely to have subtle bugs. If
1342 bugs _are_ found, it might be of interest to look at the old code and
1343 see what did it do in the relevant situation.
1345 Don't remove this code: it's true that it will be accessible
1346 from the repository, but a few years from deletion, people will
1347 forget it is there. */
1349 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1350 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1351 "Convert FILENAME to absolute, and canonicalize it.\n\
1352 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1353 \(does not start with slash); if DEFAULT is nil or missing,\n\
1354 the current buffer's value of default-directory is used.\n\
1355 Filenames containing `.' or `..' as components are simplified;\n\
1356 initial `~/' expands to your home directory.\n\
1357 See also the function `substitute-in-file-name'.")
1359 Lisp_Object name
, defalt
;
1363 register unsigned char *newdir
, *p
, *o
;
1365 unsigned char *target
;
1369 CHECK_STRING (name
);
1372 /* If nm is absolute, flush ...// and detect /./ and /../.
1373 If no /./ or /../ we can return right away. */
1380 if (p
[0] == '/' && p
[1] == '/'
1383 if (p
[0] == '/' && p
[1] == '~')
1384 nm
= p
+ 1, lose
= 1;
1385 if (p
[0] == '/' && p
[1] == '.'
1386 && (p
[2] == '/' || p
[2] == 0
1387 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1393 if (nm
== SDATA (name
))
1395 return build_string (nm
);
1399 /* Now determine directory to start with and put it in NEWDIR. */
1403 if (nm
[0] == '~') /* prefix ~ */
1404 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1406 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1407 newdir
= (unsigned char *) "";
1410 else /* ~user/filename */
1412 /* Get past ~ to user. */
1413 unsigned char *user
= nm
+ 1;
1414 /* Find end of name. */
1415 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1416 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1417 /* Copy the user name into temp storage. */
1418 o
= (unsigned char *) alloca (len
+ 1);
1419 memcpy (o
, user
, len
);
1422 /* Look up the user name. */
1424 pw
= (struct passwd
*) getpwnam (o
+ 1);
1427 error ("\"%s\" isn't a registered user", o
+ 1);
1429 newdir
= (unsigned char *) pw
->pw_dir
;
1431 /* Discard the user name from NM. */
1435 if (nm
[0] != '/' && !newdir
)
1438 defalt
= current_buffer
->directory
;
1439 CHECK_STRING (defalt
);
1440 newdir
= SDATA (defalt
);
1443 /* Now concatenate the directory and name to new space in the stack frame. */
1445 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1446 target
= (unsigned char *) alloca (tlen
);
1451 if (nm
[0] == 0 || nm
[0] == '/')
1452 strcpy (target
, newdir
);
1454 file_name_as_directory (target
, newdir
);
1457 strcat (target
, nm
);
1459 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1470 else if (!strncmp (p
, "//", 2)
1476 else if (p
[0] == '/' && p
[1] == '.'
1477 && (p
[2] == '/' || p
[2] == 0))
1479 else if (!strncmp (p
, "/..", 3)
1480 /* `/../' is the "superroot" on certain file systems. */
1482 && (p
[3] == '/' || p
[3] == 0))
1484 while (o
!= target
&& *--o
!= '/')
1486 if (o
== target
&& *o
== '/')
1496 return make_string (target
, o
- target
);
1500 /* If /~ or // appears, discard everything through first slash. */
1502 file_name_absolute_p (const char *filename
)
1505 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1507 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1508 && IS_DIRECTORY_SEP (filename
[2]))
1514 search_embedded_absfilename (char *nm
, char *endp
)
1518 for (p
= nm
+ 1; p
< endp
; p
++)
1521 || IS_DIRECTORY_SEP (p
[-1]))
1522 && file_name_absolute_p (p
)
1523 #if defined (WINDOWSNT) || defined (CYGWIN)
1524 /* // at start of file name is meaningful in Apollo,
1525 WindowsNT and Cygwin systems. */
1526 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1527 #endif /* not (WINDOWSNT || CYGWIN) */
1530 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1531 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1533 char *o
= alloca (s
- p
+ 1);
1535 memcpy (o
, p
, s
- p
);
1538 /* If we have ~user and `user' exists, discard
1539 everything up to ~. But if `user' does not exist, leave
1540 ~user alone, it might be a literal file name. */
1542 pw
= getpwnam (o
+ 1);
1554 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1555 Ssubstitute_in_file_name
, 1, 1, 0,
1556 doc
: /* Substitute environment variables referred to in FILENAME.
1557 `$FOO' where FOO is an environment variable name means to substitute
1558 the value of that variable. The variable name should be terminated
1559 with a character not a letter, digit or underscore; otherwise, enclose
1560 the entire variable name in braces.
1562 If `/~' appears, all of FILENAME through that `/' is discarded.
1563 If `//' appears, everything up to and including the first of
1564 those `/' is discarded. */)
1565 (Lisp_Object filename
)
1569 register char *s
, *p
, *o
, *x
, *endp
;
1570 char *target
= NULL
;
1572 int substituted
= 0;
1575 Lisp_Object handler
;
1577 CHECK_STRING (filename
);
1579 multibyte
= STRING_MULTIBYTE (filename
);
1581 /* If the file name has special constructs in it,
1582 call the corresponding file handler. */
1583 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1584 if (!NILP (handler
))
1586 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1588 if (STRINGP (handled_name
))
1589 return handled_name
;
1590 error ("Invalid handler in `file-name-handler-alist'");
1593 /* Always work on a copy of the string, in case GC happens during
1594 decode of environment variables, causing the original Lisp_String
1595 data to be relocated. */
1596 nm
= (char *) alloca (SBYTES (filename
) + 1);
1597 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1600 dostounix_filename (nm
);
1601 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1603 endp
= nm
+ SBYTES (filename
);
1605 /* If /~ or // appears, discard everything through first slash. */
1606 p
= search_embedded_absfilename (nm
, endp
);
1608 /* Start over with the new string, so we check the file-name-handler
1609 again. Important with filenames like "/home/foo//:/hello///there"
1610 which would substitute to "/:/hello///there" rather than "/there". */
1611 return Fsubstitute_in_file_name
1612 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1614 /* See if any variables are substituted into the string
1615 and find the total length of their values in `total'. */
1617 for (p
= nm
; p
!= endp
;)
1627 /* "$$" means a single "$". */
1636 while (p
!= endp
&& *p
!= '}') p
++;
1637 if (*p
!= '}') goto missingclose
;
1643 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1647 /* Copy out the variable name. */
1648 target
= (char *) alloca (s
- o
+ 1);
1649 strncpy (target
, o
, s
- o
);
1652 strupr (target
); /* $home == $HOME etc. */
1655 /* Get variable value. */
1656 o
= egetenv (target
);
1659 /* Don't try to guess a maximum length - UTF8 can use up to
1660 four bytes per character. This code is unlikely to run
1661 in a situation that requires performance, so decoding the
1662 env variables twice should be acceptable. Note that
1663 decoding may cause a garbage collect. */
1664 Lisp_Object orig
, decoded
;
1665 orig
= make_unibyte_string (o
, strlen (o
));
1666 decoded
= DECODE_FILE (orig
);
1667 total
+= SBYTES (decoded
);
1677 /* If substitution required, recopy the string and do it. */
1678 /* Make space in stack frame for the new copy. */
1679 xnm
= (char *) alloca (SBYTES (filename
) + total
+ 1);
1682 /* Copy the rest of the name through, replacing $ constructs with values. */
1699 while (p
!= endp
&& *p
!= '}') p
++;
1700 if (*p
!= '}') goto missingclose
;
1706 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1710 /* Copy out the variable name. */
1711 target
= (char *) alloca (s
- o
+ 1);
1712 strncpy (target
, o
, s
- o
);
1715 strupr (target
); /* $home == $HOME etc. */
1718 /* Get variable value. */
1719 o
= egetenv (target
);
1723 strcpy (x
, target
); x
+= strlen (target
);
1727 Lisp_Object orig
, decoded
;
1728 ptrdiff_t orig_length
, decoded_length
;
1729 orig_length
= strlen (o
);
1730 orig
= make_unibyte_string (o
, orig_length
);
1731 decoded
= DECODE_FILE (orig
);
1732 decoded_length
= SBYTES (decoded
);
1733 strncpy (x
, SSDATA (decoded
), decoded_length
);
1734 x
+= decoded_length
;
1736 /* If environment variable needed decoding, return value
1737 needs to be multibyte. */
1738 if (decoded_length
!= orig_length
1739 || strncmp (SSDATA (decoded
), o
, orig_length
))
1746 /* If /~ or // appears, discard everything through first slash. */
1747 while ((p
= search_embedded_absfilename (xnm
, x
)))
1748 /* This time we do not start over because we've already expanded envvars
1749 and replaced $$ with $. Maybe we should start over as well, but we'd
1750 need to quote some $ to $$ first. */
1753 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1756 error ("Bad format environment-variable substitution");
1758 error ("Missing \"}\" in environment-variable substitution");
1760 error ("Substituting nonexistent environment variable \"%s\"", target
);
1766 /* A slightly faster and more convenient way to get
1767 (directory-file-name (expand-file-name FOO)). */
1770 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1772 register Lisp_Object absname
;
1774 absname
= Fexpand_file_name (filename
, defdir
);
1776 /* Remove final slash, if any (unless this is the root dir).
1777 stat behaves differently depending! */
1778 if (SCHARS (absname
) > 1
1779 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1780 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1781 /* We cannot take shortcuts; they might be wrong for magic file names. */
1782 absname
= Fdirectory_file_name (absname
);
1786 /* Signal an error if the file ABSNAME already exists.
1787 If INTERACTIVE is nonzero, ask the user whether to proceed,
1788 and bypass the error if the user says to go ahead.
1789 QUERYSTRING is a name for the action that is being considered
1792 *STATPTR is used to store the stat information if the file exists.
1793 If the file does not exist, STATPTR->st_mode is set to 0.
1794 If STATPTR is null, we don't store into it.
1796 If QUICK is nonzero, we ask for y or n, not yes or no. */
1799 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1800 int interactive
, struct stat
*statptr
, int quick
)
1802 register Lisp_Object tem
, encoded_filename
;
1803 struct stat statbuf
;
1804 struct gcpro gcpro1
;
1806 encoded_filename
= ENCODE_FILE (absname
);
1808 /* `stat' is a good way to tell whether the file exists,
1809 regardless of what access permissions it has. */
1810 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1812 if (S_ISDIR (statbuf
.st_mode
))
1813 xsignal2 (Qfile_error
,
1814 build_string ("File is a directory"), absname
);
1817 xsignal2 (Qfile_already_exists
,
1818 build_string ("File already exists"), absname
);
1820 tem
= format2 ("File %s already exists; %s anyway? ",
1821 absname
, build_string (querystring
));
1823 tem
= call1 (intern ("y-or-n-p"), tem
);
1825 tem
= do_yes_or_no_p (tem
);
1828 xsignal2 (Qfile_already_exists
,
1829 build_string ("File already exists"), absname
);
1836 statptr
->st_mode
= 0;
1841 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1842 "fCopy file: \nGCopy %s to file: \np\nP",
1843 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1844 If NEWNAME names a directory, copy FILE there.
1846 This function always sets the file modes of the output file to match
1849 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1850 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1851 signal a `file-already-exists' error without overwriting. If
1852 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1853 about overwriting; this is what happens in interactive use with M-x.
1854 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1857 Fourth arg KEEP-TIME non-nil means give the output file the same
1858 last-modified time as the old one. (This works on only some systems.)
1860 A prefix arg makes KEEP-TIME non-nil.
1862 If PRESERVE-UID-GID is non-nil, we try to transfer the
1863 uid and gid of FILE to NEWNAME.
1865 If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
1866 on the system, we copy the SELinux context of FILE to NEWNAME. */)
1867 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
, Lisp_Object keep_time
, Lisp_Object preserve_uid_gid
, Lisp_Object preserve_selinux_context
)
1871 char buf
[16 * 1024];
1872 struct stat st
, out_st
;
1873 Lisp_Object handler
;
1874 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1875 ptrdiff_t count
= SPECPDL_INDEX ();
1876 int input_file_statable_p
;
1877 Lisp_Object encoded_file
, encoded_newname
;
1879 security_context_t con
;
1880 int fail
, conlength
= 0;
1883 encoded_file
= encoded_newname
= Qnil
;
1884 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1885 CHECK_STRING (file
);
1886 CHECK_STRING (newname
);
1888 if (!NILP (Ffile_directory_p (newname
)))
1889 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1891 newname
= Fexpand_file_name (newname
, Qnil
);
1893 file
= Fexpand_file_name (file
, Qnil
);
1895 /* If the input file name has special constructs in it,
1896 call the corresponding file handler. */
1897 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1898 /* Likewise for output file name. */
1900 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1901 if (!NILP (handler
))
1902 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1903 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1904 preserve_selinux_context
));
1906 encoded_file
= ENCODE_FILE (file
);
1907 encoded_newname
= ENCODE_FILE (newname
);
1909 if (NILP (ok_if_already_exists
)
1910 || INTEGERP (ok_if_already_exists
))
1911 barf_or_query_if_file_exists (newname
, "copy to it",
1912 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1913 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1917 if (!CopyFile (SDATA (encoded_file
),
1918 SDATA (encoded_newname
),
1920 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1921 /* CopyFile retains the timestamp by default. */
1922 else if (NILP (keep_time
))
1928 EMACS_GET_TIME (now
);
1929 filename
= SDATA (encoded_newname
);
1931 /* Ensure file is writable while its modified time is set. */
1932 attributes
= GetFileAttributes (filename
);
1933 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1934 if (set_file_times (-1, filename
, now
, now
))
1936 /* Restore original attributes. */
1937 SetFileAttributes (filename
, attributes
);
1938 xsignal2 (Qfile_date_error
,
1939 build_string ("Cannot set file date"), newname
);
1941 /* Restore original attributes. */
1942 SetFileAttributes (filename
, attributes
);
1944 #else /* not WINDOWSNT */
1946 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
1950 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1952 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1954 /* We can only copy regular files and symbolic links. Other files are not
1956 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
1959 if (!NILP (preserve_selinux_context
) && is_selinux_enabled ())
1961 conlength
= fgetfilecon (ifd
, &con
);
1962 if (conlength
== -1)
1963 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
1967 if (out_st
.st_mode
!= 0
1968 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
1971 report_file_error ("Input and output files are the same",
1972 Fcons (file
, Fcons (newname
, Qnil
)));
1975 if (input_file_statable_p
)
1977 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
1979 #if defined (EISDIR)
1980 /* Get a better looking error message. */
1983 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
1988 /* System's default file type was set to binary by _fmode in emacs.c. */
1989 ofd
= emacs_open (SDATA (encoded_newname
),
1990 O_WRONLY
| O_TRUNC
| O_CREAT
1991 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
1992 S_IREAD
| S_IWRITE
);
1993 #else /* not MSDOS */
1995 int new_mask
= 0666;
1996 if (input_file_statable_p
)
1998 if (!NILP (preserve_uid_gid
))
2000 new_mask
&= st
.st_mode
;
2002 ofd
= emacs_open (SSDATA (encoded_newname
),
2003 (O_WRONLY
| O_TRUNC
| O_CREAT
2004 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2007 #endif /* not MSDOS */
2009 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2011 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2015 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2016 if (emacs_write (ofd
, buf
, n
) != n
)
2017 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2021 /* Preserve the original file modes, and if requested, also its
2023 if (input_file_statable_p
)
2025 int mode_mask
= 07777;
2026 if (!NILP (preserve_uid_gid
))
2028 /* Attempt to change owner and group. If that doesn't work
2029 attempt to change just the group, as that is sometimes allowed.
2030 Adjust the mode mask to eliminate setuid or setgid bits
2031 that are inappropriate if the owner and group are wrong. */
2032 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2034 mode_mask
&= ~06000;
2035 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2039 if (fchmod (ofd
, st
.st_mode
& mode_mask
) != 0)
2040 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
2042 #endif /* not MSDOS */
2047 /* Set the modified context back to the file. */
2048 fail
= fsetfilecon (ofd
, con
);
2049 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2050 if (fail
&& errno
!= ENOTSUP
)
2051 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2057 if (input_file_statable_p
)
2059 if (!NILP (keep_time
))
2061 EMACS_TIME atime
= get_stat_atime (&st
);
2062 EMACS_TIME mtime
= get_stat_mtime (&st
);
2063 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2064 xsignal2 (Qfile_date_error
,
2065 build_string ("Cannot set file date"), newname
);
2069 if (emacs_close (ofd
) < 0)
2070 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2075 if (input_file_statable_p
)
2077 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2078 and if it can't, it tells so. Otherwise, under MSDOS we usually
2079 get only the READ bit, which will make the copied file read-only,
2080 so it's better not to chmod at all. */
2081 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2082 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2085 #endif /* not WINDOWSNT */
2087 /* Discard the unwind protects. */
2088 specpdl_ptr
= specpdl
+ count
;
2094 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2095 Smake_directory_internal
, 1, 1, 0,
2096 doc
: /* Create a new directory named DIRECTORY. */)
2097 (Lisp_Object directory
)
2100 Lisp_Object handler
;
2101 Lisp_Object encoded_dir
;
2103 CHECK_STRING (directory
);
2104 directory
= Fexpand_file_name (directory
, Qnil
);
2106 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2107 if (!NILP (handler
))
2108 return call2 (handler
, Qmake_directory_internal
, directory
);
2110 encoded_dir
= ENCODE_FILE (directory
);
2112 dir
= SSDATA (encoded_dir
);
2115 if (mkdir (dir
) != 0)
2117 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2119 report_file_error ("Creating directory", list1 (directory
));
2124 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2125 Sdelete_directory_internal
, 1, 1, 0,
2126 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2127 (Lisp_Object directory
)
2130 Lisp_Object encoded_dir
;
2132 CHECK_STRING (directory
);
2133 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2134 encoded_dir
= ENCODE_FILE (directory
);
2135 dir
= SSDATA (encoded_dir
);
2137 if (rmdir (dir
) != 0)
2138 report_file_error ("Removing directory", list1 (directory
));
2143 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2144 "(list (read-file-name \
2145 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2146 \"Move file to trash: \" \"Delete file: \") \
2147 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2148 (null current-prefix-arg))",
2149 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2150 If file has multiple names, it continues to exist with the other names.
2151 TRASH non-nil means to trash the file instead of deleting, provided
2152 `delete-by-moving-to-trash' is non-nil.
2154 When called interactively, TRASH is t if no prefix argument is given.
2155 With a prefix argument, TRASH is nil. */)
2156 (Lisp_Object filename
, Lisp_Object trash
)
2158 Lisp_Object handler
;
2159 Lisp_Object encoded_file
;
2160 struct gcpro gcpro1
;
2163 if (!NILP (Ffile_directory_p (filename
))
2164 && NILP (Ffile_symlink_p (filename
)))
2165 xsignal2 (Qfile_error
,
2166 build_string ("Removing old name: is a directory"),
2169 filename
= Fexpand_file_name (filename
, Qnil
);
2171 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2172 if (!NILP (handler
))
2173 return call3 (handler
, Qdelete_file
, filename
, trash
);
2175 if (delete_by_moving_to_trash
&& !NILP (trash
))
2176 return call1 (Qmove_file_to_trash
, filename
);
2178 encoded_file
= ENCODE_FILE (filename
);
2180 if (0 > unlink (SSDATA (encoded_file
)))
2181 report_file_error ("Removing old name", list1 (filename
));
2186 internal_delete_file_1 (Lisp_Object ignore
)
2191 /* Delete file FILENAME, returning 1 if successful and 0 if failed.
2192 This ignores `delete-by-moving-to-trash'. */
2195 internal_delete_file (Lisp_Object filename
)
2199 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2200 Qt
, internal_delete_file_1
);
2204 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2205 "fRename file: \nGRename %s to file: \np",
2206 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2207 If file has names other than FILE, it continues to have those names.
2208 Signals a `file-already-exists' error if a file NEWNAME already exists
2209 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2210 A number as third arg means request confirmation if NEWNAME already exists.
2211 This is what happens in interactive use with M-x. */)
2212 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2214 Lisp_Object handler
;
2215 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2216 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2218 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2219 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2220 CHECK_STRING (file
);
2221 CHECK_STRING (newname
);
2222 file
= Fexpand_file_name (file
, Qnil
);
2224 if ((!NILP (Ffile_directory_p (newname
)))
2226 /* If the file names are identical but for the case,
2227 don't attempt to move directory to itself. */
2228 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2232 Lisp_Object fname
= NILP (Ffile_directory_p (file
))
2233 ? file
: Fdirectory_file_name (file
);
2234 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2237 newname
= Fexpand_file_name (newname
, Qnil
);
2239 /* If the file name has special constructs in it,
2240 call the corresponding file handler. */
2241 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2243 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2244 if (!NILP (handler
))
2245 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2246 file
, newname
, ok_if_already_exists
));
2248 encoded_file
= ENCODE_FILE (file
);
2249 encoded_newname
= ENCODE_FILE (newname
);
2252 /* If the file names are identical but for the case, don't ask for
2253 confirmation: they simply want to change the letter-case of the
2255 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2257 if (NILP (ok_if_already_exists
)
2258 || INTEGERP (ok_if_already_exists
))
2259 barf_or_query_if_file_exists (newname
, "rename to it",
2260 INTEGERP (ok_if_already_exists
), 0, 0);
2261 if (0 > rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2266 symlink_target
= Ffile_symlink_p (file
);
2267 if (! NILP (symlink_target
))
2268 Fmake_symbolic_link (symlink_target
, newname
,
2269 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2270 else if (!NILP (Ffile_directory_p (file
)))
2271 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2273 /* We have already prompted if it was an integer, so don't
2274 have copy-file prompt again. */
2275 Fcopy_file (file
, newname
,
2276 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2279 count
= SPECPDL_INDEX ();
2280 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2282 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2283 call2 (Qdelete_directory
, file
, Qt
);
2285 Fdelete_file (file
, Qnil
);
2286 unbind_to (count
, Qnil
);
2289 report_file_error ("Renaming", list2 (file
, newname
));
2295 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2296 "fAdd name to file: \nGName to add to %s: \np",
2297 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2298 Signals a `file-already-exists' error if a file NEWNAME already exists
2299 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2300 A number as third arg means request confirmation if NEWNAME already exists.
2301 This is what happens in interactive use with M-x. */)
2302 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2304 Lisp_Object handler
;
2305 Lisp_Object encoded_file
, encoded_newname
;
2306 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2308 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2309 encoded_file
= encoded_newname
= Qnil
;
2310 CHECK_STRING (file
);
2311 CHECK_STRING (newname
);
2312 file
= Fexpand_file_name (file
, Qnil
);
2314 if (!NILP (Ffile_directory_p (newname
)))
2315 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2317 newname
= Fexpand_file_name (newname
, Qnil
);
2319 /* If the file name has special constructs in it,
2320 call the corresponding file handler. */
2321 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2322 if (!NILP (handler
))
2323 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2324 newname
, ok_if_already_exists
));
2326 /* If the new name has special constructs in it,
2327 call the corresponding file handler. */
2328 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2329 if (!NILP (handler
))
2330 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2331 newname
, ok_if_already_exists
));
2333 encoded_file
= ENCODE_FILE (file
);
2334 encoded_newname
= ENCODE_FILE (newname
);
2336 if (NILP (ok_if_already_exists
)
2337 || INTEGERP (ok_if_already_exists
))
2338 barf_or_query_if_file_exists (newname
, "make it a new name",
2339 INTEGERP (ok_if_already_exists
), 0, 0);
2341 unlink (SSDATA (newname
));
2342 if (0 > link (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2343 report_file_error ("Adding new name", list2 (file
, newname
));
2349 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2350 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2351 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2352 Both args must be strings.
2353 Signals a `file-already-exists' error if a file LINKNAME already exists
2354 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2355 A number as third arg means request confirmation if LINKNAME already exists.
2356 This happens for interactive use with M-x. */)
2357 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2359 Lisp_Object handler
;
2360 Lisp_Object encoded_filename
, encoded_linkname
;
2361 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2363 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2364 encoded_filename
= encoded_linkname
= Qnil
;
2365 CHECK_STRING (filename
);
2366 CHECK_STRING (linkname
);
2367 /* If the link target has a ~, we must expand it to get
2368 a truly valid file name. Otherwise, do not expand;
2369 we want to permit links to relative file names. */
2370 if (SREF (filename
, 0) == '~')
2371 filename
= Fexpand_file_name (filename
, Qnil
);
2373 if (!NILP (Ffile_directory_p (linkname
)))
2374 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2376 linkname
= Fexpand_file_name (linkname
, Qnil
);
2378 /* If the file name has special constructs in it,
2379 call the corresponding file handler. */
2380 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2381 if (!NILP (handler
))
2382 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2383 linkname
, ok_if_already_exists
));
2385 /* If the new link name has special constructs in it,
2386 call the corresponding file handler. */
2387 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2388 if (!NILP (handler
))
2389 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2390 linkname
, ok_if_already_exists
));
2392 encoded_filename
= ENCODE_FILE (filename
);
2393 encoded_linkname
= ENCODE_FILE (linkname
);
2395 if (NILP (ok_if_already_exists
)
2396 || INTEGERP (ok_if_already_exists
))
2397 barf_or_query_if_file_exists (linkname
, "make it a link",
2398 INTEGERP (ok_if_already_exists
), 0, 0);
2399 if (0 > symlink (SSDATA (encoded_filename
),
2400 SSDATA (encoded_linkname
)))
2402 /* If we didn't complain already, silently delete existing file. */
2403 if (errno
== EEXIST
)
2405 unlink (SSDATA (encoded_linkname
));
2406 if (0 <= symlink (SSDATA (encoded_filename
),
2407 SSDATA (encoded_linkname
)))
2413 if (errno
== ENOSYS
)
2416 xsignal1 (Qfile_error
,
2417 build_string ("Symbolic links are not supported"));
2420 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2427 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2429 doc
: /* Return t if file FILENAME specifies an absolute file name.
2430 On Unix, this is a name starting with a `/' or a `~'. */)
2431 (Lisp_Object filename
)
2433 CHECK_STRING (filename
);
2434 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2437 /* Return nonzero if file FILENAME exists and can be executed. */
2440 check_executable (char *filename
)
2444 if (stat (filename
, &st
) < 0)
2446 return ((st
.st_mode
& S_IEXEC
) != 0);
2447 #else /* not DOS_NT */
2448 #ifdef HAVE_EUIDACCESS
2449 return (euidaccess (filename
, 1) >= 0);
2451 /* Access isn't quite right because it uses the real uid
2452 and we really want to test with the effective uid.
2453 But Unix doesn't give us a right way to do it. */
2454 return (access (filename
, 1) >= 0);
2456 #endif /* not DOS_NT */
2459 /* Return nonzero if file FILENAME exists and can be written. */
2462 check_writable (const char *filename
)
2466 if (stat (filename
, &st
) < 0)
2468 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2469 #else /* not MSDOS */
2470 #ifdef HAVE_EUIDACCESS
2471 int res
= (euidaccess (filename
, 2) >= 0);
2473 /* euidaccess may have returned failure because Cygwin couldn't
2474 determine the file's UID or GID; if so, we return success. */
2478 if (stat (filename
, &st
) < 0)
2480 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2484 #else /* not HAVE_EUIDACCESS */
2485 /* Access isn't quite right because it uses the real uid
2486 and we really want to test with the effective uid.
2487 But Unix doesn't give us a right way to do it.
2488 Opening with O_WRONLY could work for an ordinary file,
2489 but would lose for directories. */
2490 return (access (filename
, 2) >= 0);
2491 #endif /* not HAVE_EUIDACCESS */
2492 #endif /* not MSDOS */
2495 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2496 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2497 See also `file-readable-p' and `file-attributes'.
2498 This returns nil for a symlink to a nonexistent file.
2499 Use `file-symlink-p' to test for such links. */)
2500 (Lisp_Object filename
)
2502 Lisp_Object absname
;
2503 Lisp_Object handler
;
2504 struct stat statbuf
;
2506 CHECK_STRING (filename
);
2507 absname
= Fexpand_file_name (filename
, Qnil
);
2509 /* If the file name has special constructs in it,
2510 call the corresponding file handler. */
2511 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2512 if (!NILP (handler
))
2513 return call2 (handler
, Qfile_exists_p
, absname
);
2515 absname
= ENCODE_FILE (absname
);
2517 return (stat (SSDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2520 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2521 doc
: /* Return t if FILENAME can be executed by you.
2522 For a directory, this means you can access files in that directory. */)
2523 (Lisp_Object filename
)
2525 Lisp_Object absname
;
2526 Lisp_Object handler
;
2528 CHECK_STRING (filename
);
2529 absname
= Fexpand_file_name (filename
, Qnil
);
2531 /* If the file name has special constructs in it,
2532 call the corresponding file handler. */
2533 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2534 if (!NILP (handler
))
2535 return call2 (handler
, Qfile_executable_p
, absname
);
2537 absname
= ENCODE_FILE (absname
);
2539 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2542 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2543 doc
: /* Return t if file FILENAME exists and you can read it.
2544 See also `file-exists-p' and `file-attributes'. */)
2545 (Lisp_Object filename
)
2547 Lisp_Object absname
;
2548 Lisp_Object handler
;
2551 struct stat statbuf
;
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
);
2564 #if defined (DOS_NT) || defined (macintosh)
2565 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2567 if (access (SDATA (absname
), 0) == 0)
2570 #else /* not DOS_NT and not macintosh */
2573 /* Opening a fifo without O_NONBLOCK can wait.
2574 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2575 except in the case of a fifo, on a system which handles it. */
2576 desc
= stat (SSDATA (absname
), &statbuf
);
2579 if (S_ISFIFO (statbuf
.st_mode
))
2580 flags
|= O_NONBLOCK
;
2582 desc
= emacs_open (SSDATA (absname
), flags
, 0);
2587 #endif /* not DOS_NT and not macintosh */
2590 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2592 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2593 doc
: /* Return t if file FILENAME can be written or created by you. */)
2594 (Lisp_Object filename
)
2596 Lisp_Object absname
, dir
, encoded
;
2597 Lisp_Object handler
;
2598 struct stat statbuf
;
2600 CHECK_STRING (filename
);
2601 absname
= Fexpand_file_name (filename
, Qnil
);
2603 /* If the file name has special constructs in it,
2604 call the corresponding file handler. */
2605 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2606 if (!NILP (handler
))
2607 return call2 (handler
, Qfile_writable_p
, absname
);
2609 encoded
= ENCODE_FILE (absname
);
2610 if (stat (SSDATA (encoded
), &statbuf
) >= 0)
2611 return (check_writable (SSDATA (encoded
))
2614 dir
= Ffile_name_directory (absname
);
2617 dir
= Fdirectory_file_name (dir
);
2620 dir
= ENCODE_FILE (dir
);
2622 /* The read-only attribute of the parent directory doesn't affect
2623 whether a file or directory can be created within it. Some day we
2624 should check ACLs though, which do affect this. */
2625 if (stat (SDATA (dir
), &statbuf
) < 0)
2627 return S_ISDIR (statbuf
.st_mode
) ? Qt
: Qnil
;
2629 return (check_writable (!NILP (dir
) ? SSDATA (dir
) : "")
2634 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2635 doc
: /* Access file FILENAME, and get an error if that does not work.
2636 The second argument STRING is used in the error message.
2637 If there is no error, returns nil. */)
2638 (Lisp_Object filename
, Lisp_Object string
)
2640 Lisp_Object handler
, encoded_filename
, absname
;
2643 CHECK_STRING (filename
);
2644 absname
= Fexpand_file_name (filename
, Qnil
);
2646 CHECK_STRING (string
);
2648 /* If the file name has special constructs in it,
2649 call the corresponding file handler. */
2650 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2651 if (!NILP (handler
))
2652 return call3 (handler
, Qaccess_file
, absname
, string
);
2654 encoded_filename
= ENCODE_FILE (absname
);
2656 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2658 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2664 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2665 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2666 The value is the link target, as a string.
2667 Otherwise it returns nil.
2669 This function returns t when given the name of a symlink that
2670 points to a nonexistent file. */)
2671 (Lisp_Object filename
)
2673 Lisp_Object handler
;
2676 char readlink_buf
[READLINK_BUFSIZE
];
2678 CHECK_STRING (filename
);
2679 filename
= Fexpand_file_name (filename
, Qnil
);
2681 /* If the file name has special constructs in it,
2682 call the corresponding file handler. */
2683 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2684 if (!NILP (handler
))
2685 return call2 (handler
, Qfile_symlink_p
, filename
);
2687 filename
= ENCODE_FILE (filename
);
2689 buf
= emacs_readlink (SSDATA (filename
), readlink_buf
);
2693 val
= build_string (buf
);
2694 if (buf
[0] == '/' && strchr (buf
, ':'))
2695 val
= concat2 (build_string ("/:"), val
);
2696 if (buf
!= readlink_buf
)
2698 val
= DECODE_FILE (val
);
2702 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2703 doc
: /* Return t if FILENAME names an existing directory.
2704 Symbolic links to directories count as directories.
2705 See `file-symlink-p' to distinguish symlinks. */)
2706 (Lisp_Object filename
)
2708 register Lisp_Object absname
;
2710 Lisp_Object handler
;
2712 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2714 /* If the file name has special constructs in it,
2715 call the corresponding file handler. */
2716 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2717 if (!NILP (handler
))
2718 return call2 (handler
, Qfile_directory_p
, absname
);
2720 absname
= ENCODE_FILE (absname
);
2722 if (stat (SSDATA (absname
), &st
) < 0)
2724 return S_ISDIR (st
.st_mode
) ? Qt
: Qnil
;
2727 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2728 Sfile_accessible_directory_p
, 1, 1, 0,
2729 doc
: /* Return t if file FILENAME names a directory you can open.
2730 For the value to be t, FILENAME must specify the name of a directory as a file,
2731 and the directory must allow you to open files in it. In order to use a
2732 directory as a buffer's current directory, this predicate must return true.
2733 A directory name spec may be given instead; then the value is t
2734 if the directory so specified exists and really is a readable and
2735 searchable directory. */)
2736 (Lisp_Object filename
)
2738 Lisp_Object handler
;
2740 struct gcpro gcpro1
;
2742 /* If the file name has special constructs in it,
2743 call the corresponding file handler. */
2744 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2745 if (!NILP (handler
))
2746 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2749 tem
= (NILP (Ffile_directory_p (filename
))
2750 || NILP (Ffile_executable_p (filename
)));
2752 return tem
? Qnil
: Qt
;
2755 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2756 doc
: /* Return t if FILENAME names a regular file.
2757 This is the sort of file that holds an ordinary stream of data bytes.
2758 Symbolic links to regular files count as regular files.
2759 See `file-symlink-p' to distinguish symlinks. */)
2760 (Lisp_Object filename
)
2762 register Lisp_Object absname
;
2764 Lisp_Object handler
;
2766 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2768 /* If the file name has special constructs in it,
2769 call the corresponding file handler. */
2770 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2771 if (!NILP (handler
))
2772 return call2 (handler
, Qfile_regular_p
, absname
);
2774 absname
= ENCODE_FILE (absname
);
2779 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2781 /* Tell stat to use expensive method to get accurate info. */
2782 Vw32_get_true_file_attributes
= Qt
;
2783 result
= stat (SDATA (absname
), &st
);
2784 Vw32_get_true_file_attributes
= tem
;
2788 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2791 if (stat (SSDATA (absname
), &st
) < 0)
2793 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2797 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2798 Sfile_selinux_context
, 1, 1, 0,
2799 doc
: /* Return SELinux context of file named FILENAME.
2800 The return value is a list (USER ROLE TYPE RANGE), where the list
2801 elements are strings naming the user, role, type, and range of the
2802 file's SELinux security context.
2804 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2805 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2806 (Lisp_Object filename
)
2808 Lisp_Object absname
;
2809 Lisp_Object values
[4];
2810 Lisp_Object handler
;
2812 security_context_t con
;
2817 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2819 /* If the file name has special constructs in it,
2820 call the corresponding file handler. */
2821 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2822 if (!NILP (handler
))
2823 return call2 (handler
, Qfile_selinux_context
, absname
);
2825 absname
= ENCODE_FILE (absname
);
2832 if (is_selinux_enabled ())
2834 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2837 context
= context_new (con
);
2838 if (context_user_get (context
))
2839 values
[0] = build_string (context_user_get (context
));
2840 if (context_role_get (context
))
2841 values
[1] = build_string (context_role_get (context
));
2842 if (context_type_get (context
))
2843 values
[2] = build_string (context_type_get (context
));
2844 if (context_range_get (context
))
2845 values
[3] = build_string (context_range_get (context
));
2846 context_free (context
);
2853 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2856 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2857 Sset_file_selinux_context
, 2, 2, 0,
2858 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2859 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2860 elements are strings naming the components of a SELinux context.
2862 This function does nothing if SELinux is disabled, or if Emacs was not
2863 compiled with SELinux support. */)
2864 (Lisp_Object filename
, Lisp_Object context
)
2866 Lisp_Object absname
;
2867 Lisp_Object handler
;
2869 Lisp_Object encoded_absname
;
2870 Lisp_Object user
= CAR_SAFE (context
);
2871 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2872 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2873 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2874 security_context_t con
;
2875 int fail
, conlength
;
2876 context_t parsed_con
;
2879 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2881 /* If the file name has special constructs in it,
2882 call the corresponding file handler. */
2883 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2884 if (!NILP (handler
))
2885 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2888 if (is_selinux_enabled ())
2890 /* Get current file context. */
2891 encoded_absname
= ENCODE_FILE (absname
);
2892 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2895 parsed_con
= context_new (con
);
2896 /* Change the parts defined in the parameter.*/
2899 if (context_user_set (parsed_con
, SSDATA (user
)))
2900 error ("Doing context_user_set");
2904 if (context_role_set (parsed_con
, SSDATA (role
)))
2905 error ("Doing context_role_set");
2909 if (context_type_set (parsed_con
, SSDATA (type
)))
2910 error ("Doing context_type_set");
2912 if (STRINGP (range
))
2914 if (context_range_set (parsed_con
, SSDATA (range
)))
2915 error ("Doing context_range_set");
2918 /* Set the modified context back to the file. */
2919 fail
= lsetfilecon (SSDATA (encoded_absname
),
2920 context_str (parsed_con
));
2921 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2922 if (fail
&& errno
!= ENOTSUP
)
2923 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
2925 context_free (parsed_con
);
2928 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
2938 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2939 doc
: /* Return mode bits of file named FILENAME, as an integer.
2940 Return nil, if file does not exist or is not accessible. */)
2941 (Lisp_Object filename
)
2943 Lisp_Object absname
;
2945 Lisp_Object handler
;
2947 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2949 /* If the file name has special constructs in it,
2950 call the corresponding file handler. */
2951 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2952 if (!NILP (handler
))
2953 return call2 (handler
, Qfile_modes
, absname
);
2955 absname
= ENCODE_FILE (absname
);
2957 if (stat (SSDATA (absname
), &st
) < 0)
2960 return make_number (st
.st_mode
& 07777);
2963 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2964 "(let ((file (read-file-name \"File: \"))) \
2965 (list file (read-file-modes nil file)))",
2966 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2967 Only the 12 low bits of MODE are used.
2969 Interactively, mode bits are read by `read-file-modes', which accepts
2970 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2971 (Lisp_Object filename
, Lisp_Object mode
)
2973 Lisp_Object absname
, encoded_absname
;
2974 Lisp_Object handler
;
2976 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2977 CHECK_NUMBER (mode
);
2979 /* If the file name has special constructs in it,
2980 call the corresponding file handler. */
2981 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2982 if (!NILP (handler
))
2983 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2985 encoded_absname
= ENCODE_FILE (absname
);
2987 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
2988 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2993 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2994 doc
: /* Set the file permission bits for newly created files.
2995 The argument MODE should be an integer; only the low 9 bits are used.
2996 This setting is inherited by subprocesses. */)
2999 CHECK_NUMBER (mode
);
3001 umask ((~ XINT (mode
)) & 0777);
3006 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3007 doc
: /* Return the default file protection for created files.
3008 The value is an integer. */)
3015 realmask
= umask (0);
3019 XSETINT (value
, (~ realmask
) & 0777);
3024 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3025 doc
: /* Set times of file FILENAME to TIMESTAMP.
3026 Set both access and modification times.
3027 Return t on success, else nil.
3028 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3030 (Lisp_Object filename
, Lisp_Object timestamp
)
3032 Lisp_Object absname
, encoded_absname
;
3033 Lisp_Object handler
;
3034 EMACS_TIME t
= lisp_time_argument (timestamp
, 0);
3036 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3038 /* If the file name has special constructs in it,
3039 call the corresponding file handler. */
3040 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3041 if (!NILP (handler
))
3042 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3044 encoded_absname
= ENCODE_FILE (absname
);
3047 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3052 /* Setting times on a directory always fails. */
3053 if (stat (SSDATA (encoded_absname
), &st
) == 0 && S_ISDIR (st
.st_mode
))
3056 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3065 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3066 doc
: /* Tell Unix to finish all pending disk updates. */)
3073 #endif /* HAVE_SYNC */
3075 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3076 doc
: /* Return t if file FILE1 is newer than file FILE2.
3077 If FILE1 does not exist, the answer is nil;
3078 otherwise, if FILE2 does not exist, the answer is t. */)
3079 (Lisp_Object file1
, Lisp_Object file2
)
3081 Lisp_Object absname1
, absname2
;
3084 Lisp_Object handler
;
3085 struct gcpro gcpro1
, gcpro2
;
3087 CHECK_STRING (file1
);
3088 CHECK_STRING (file2
);
3091 GCPRO2 (absname1
, file2
);
3092 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3093 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3096 /* If the file name has special constructs in it,
3097 call the corresponding file handler. */
3098 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3100 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3101 if (!NILP (handler
))
3102 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3104 GCPRO2 (absname1
, absname2
);
3105 absname1
= ENCODE_FILE (absname1
);
3106 absname2
= ENCODE_FILE (absname2
);
3109 if (stat (SSDATA (absname1
), &st
) < 0)
3112 mtime1
= st
.st_mtime
;
3114 if (stat (SSDATA (absname2
), &st
) < 0)
3117 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3120 #ifndef READ_BUF_SIZE
3121 #define READ_BUF_SIZE (64 << 10)
3123 /* Some buffer offsets are stored in 'int' variables. */
3124 verify (READ_BUF_SIZE
<= INT_MAX
);
3126 /* This function is called after Lisp functions to decide a coding
3127 system are called, or when they cause an error. Before they are
3128 called, the current buffer is set unibyte and it contains only a
3129 newly inserted text (thus the buffer was empty before the
3132 The functions may set markers, overlays, text properties, or even
3133 alter the buffer contents, change the current buffer.
3135 Here, we reset all those changes by:
3136 o set back the current buffer.
3137 o move all markers and overlays to BEG.
3138 o remove all text properties.
3139 o set back the buffer multibyteness. */
3142 decide_coding_unwind (Lisp_Object unwind_data
)
3144 Lisp_Object multibyte
, undo_list
, buffer
;
3146 multibyte
= XCAR (unwind_data
);
3147 unwind_data
= XCDR (unwind_data
);
3148 undo_list
= XCAR (unwind_data
);
3149 buffer
= XCDR (unwind_data
);
3151 if (current_buffer
!= XBUFFER (buffer
))
3152 set_buffer_internal (XBUFFER (buffer
));
3153 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3154 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3155 BUF_INTERVALS (current_buffer
) = 0;
3156 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3158 /* Now we are safe to change the buffer's multibyteness directly. */
3159 BVAR (current_buffer
, enable_multibyte_characters
) = multibyte
;
3160 BVAR (current_buffer
, undo_list
) = undo_list
;
3166 /* Used to pass values from insert-file-contents to read_non_regular. */
3168 static int non_regular_fd
;
3169 static ptrdiff_t non_regular_inserted
;
3170 static int non_regular_nbytes
;
3173 /* Read from a non-regular file.
3174 Read non_regular_nbytes bytes max from non_regular_fd.
3175 Non_regular_inserted specifies where to put the read bytes.
3176 Value is the number of bytes read. */
3179 read_non_regular (Lisp_Object ignore
)
3185 nbytes
= emacs_read (non_regular_fd
,
3186 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3187 + non_regular_inserted
),
3188 non_regular_nbytes
);
3190 return make_number (nbytes
);
3194 /* Condition-case handler used when reading from non-regular files
3195 in insert-file-contents. */
3198 read_non_regular_quit (Lisp_Object ignore
)
3203 /* Reposition FD to OFFSET, based on WHENCE. This acts like lseek
3204 except that it also tests for OFFSET being out of lseek's range. */
3206 emacs_lseek (int fd
, EMACS_INT offset
, int whence
)
3208 /* Use "&" rather than "&&" to suppress a bogus GCC warning; see
3209 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43772>. */
3210 if (! ((TYPE_MINIMUM (off_t
) <= offset
) & (offset
<= TYPE_MAXIMUM (off_t
))))
3215 return lseek (fd
, offset
, whence
);
3219 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3221 doc
: /* Insert contents of file FILENAME after point.
3222 Returns list of absolute file name and number of characters inserted.
3223 If second argument VISIT is non-nil, the buffer's visited filename and
3224 last save file modtime are set, and it is marked unmodified. If
3225 visiting and the file does not exist, visiting is completed before the
3228 The optional third and fourth arguments BEG and END specify what portion
3229 of the file to insert. These arguments count bytes in the file, not
3230 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3232 If optional fifth argument REPLACE is non-nil, replace the current
3233 buffer contents (in the accessible portion) with the file contents.
3234 This is better than simply deleting and inserting the whole thing
3235 because (1) it preserves some marker positions and (2) it puts less data
3236 in the undo list. When REPLACE is non-nil, the second return value is
3237 the number of characters that replace previous buffer contents.
3239 This function does code conversion according to the value of
3240 `coding-system-for-read' or `file-coding-system-alist', and sets the
3241 variable `last-coding-system-used' to the coding system actually used. */)
3242 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3246 ptrdiff_t inserted
= 0;
3248 register ptrdiff_t how_much
;
3249 off_t beg_offset
, end_offset
;
3250 register int unprocessed
;
3251 ptrdiff_t count
= SPECPDL_INDEX ();
3252 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3253 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3255 ptrdiff_t total
= 0;
3256 int not_regular
= 0;
3258 char read_buf
[READ_BUF_SIZE
];
3259 struct coding_system coding
;
3260 char buffer
[1 << 14];
3261 int replace_handled
= 0;
3262 int set_coding_system
= 0;
3263 Lisp_Object coding_system
;
3265 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3266 int we_locked_file
= 0;
3267 int deferred_remove_unwind_protect
= 0;
3269 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3270 error ("Cannot do file visiting in an indirect buffer");
3272 if (!NILP (BVAR (current_buffer
, read_only
)))
3273 Fbarf_if_buffer_read_only ();
3277 orig_filename
= Qnil
;
3280 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3282 CHECK_STRING (filename
);
3283 filename
= Fexpand_file_name (filename
, Qnil
);
3285 /* The value Qnil means that the coding system is not yet
3287 coding_system
= Qnil
;
3289 /* If the file name has special constructs in it,
3290 call the corresponding file handler. */
3291 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3292 if (!NILP (handler
))
3294 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3295 visit
, beg
, end
, replace
);
3296 if (CONSP (val
) && CONSP (XCDR (val
))
3297 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3298 inserted
= XINT (XCAR (XCDR (val
)));
3302 orig_filename
= filename
;
3303 filename
= ENCODE_FILE (filename
);
3309 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3311 /* Tell stat to use expensive method to get accurate info. */
3312 Vw32_get_true_file_attributes
= Qt
;
3313 total
= stat (SSDATA (filename
), &st
);
3314 Vw32_get_true_file_attributes
= tem
;
3318 if (stat (SSDATA (filename
), &st
) < 0)
3319 #endif /* WINDOWSNT */
3324 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3328 if (!NILP (Vcoding_system_for_read
))
3329 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3333 /* This code will need to be changed in order to work on named
3334 pipes, and it's probably just not worth it. So we should at
3335 least signal an error. */
3336 if (!S_ISREG (st
.st_mode
))
3343 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3344 xsignal2 (Qfile_error
,
3345 build_string ("not a regular file"), orig_filename
);
3349 if ((fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0)) < 0)
3352 /* Replacement should preserve point as it preserves markers. */
3353 if (!NILP (replace
))
3354 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3356 record_unwind_protect (close_file_unwind
, make_number (fd
));
3361 if (!NILP (beg
) || !NILP (end
))
3362 error ("Attempt to visit less than an entire file");
3363 if (BEG
< Z
&& NILP (replace
))
3364 error ("Cannot do file visiting in a non-empty buffer");
3369 if (! (RANGED_INTEGERP (0, beg
, TYPE_MAXIMUM (off_t
))))
3370 wrong_type_argument (intern ("file-offset"), beg
);
3371 beg_offset
= XFASTINT (beg
);
3378 if (! (RANGED_INTEGERP (0, end
, TYPE_MAXIMUM (off_t
))))
3379 wrong_type_argument (intern ("file-offset"), end
);
3380 end_offset
= XFASTINT (end
);
3385 end_offset
= TYPE_MAXIMUM (off_t
);
3388 end_offset
= st
.st_size
;
3390 /* A negative size can happen on a platform that allows file
3391 sizes greater than the maximum off_t value. */
3395 /* The file size returned from stat may be zero, but data
3396 may be readable nonetheless, for example when this is a
3397 file in the /proc filesystem. */
3398 if (end_offset
== 0)
3399 end_offset
= READ_BUF_SIZE
;
3403 /* Check now whether the buffer will become too large,
3404 in the likely case where the file's length is not changing.
3405 This saves a lot of needless work before a buffer overflow. */
3408 /* The likely offset where we will stop reading. We could read
3409 more (or less), if the file grows (or shrinks) as we read it. */
3410 off_t likely_end
= min (end_offset
, st
.st_size
);
3412 if (beg_offset
< likely_end
)
3414 ptrdiff_t buf_bytes
=
3415 Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3416 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3417 off_t likely_growth
= likely_end
- beg_offset
;
3418 if (buf_growth_max
< likely_growth
)
3423 /* Prevent redisplay optimizations. */
3424 current_buffer
->clip_changed
= 1;
3426 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3428 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3429 setup_coding_system (coding_system
, &coding
);
3430 /* Ensure we set Vlast_coding_system_used. */
3431 set_coding_system
= 1;
3435 /* Decide the coding system to use for reading the file now
3436 because we can't use an optimized method for handling
3437 `coding:' tag if the current buffer is not empty. */
3438 if (!NILP (Vcoding_system_for_read
))
3439 coding_system
= Vcoding_system_for_read
;
3442 /* Don't try looking inside a file for a coding system
3443 specification if it is not seekable. */
3444 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3446 /* Find a coding system specified in the heading two
3447 lines or in the tailing several lines of the file.
3448 We assume that the 1K-byte and 3K-byte for heading
3449 and tailing respectively are sufficient for this
3453 if (st
.st_size
<= (1024 * 4))
3454 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3457 nread
= emacs_read (fd
, read_buf
, 1024);
3460 if (lseek (fd
, st
.st_size
- (1024 * 3), SEEK_SET
) < 0)
3461 report_file_error ("Setting file position",
3462 Fcons (orig_filename
, Qnil
));
3463 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3468 error ("IO error reading %s: %s",
3469 SDATA (orig_filename
), emacs_strerror (errno
));
3472 struct buffer
*prev
= current_buffer
;
3473 Lisp_Object workbuf
;
3476 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3478 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3479 buf
= XBUFFER (workbuf
);
3481 delete_all_overlays (buf
);
3482 BVAR (buf
, directory
) = BVAR (current_buffer
, directory
);
3483 BVAR (buf
, read_only
) = Qnil
;
3484 BVAR (buf
, filename
) = Qnil
;
3485 BVAR (buf
, undo_list
) = Qt
;
3486 eassert (buf
->overlays_before
== NULL
);
3487 eassert (buf
->overlays_after
== NULL
);
3489 set_buffer_internal (buf
);
3491 BVAR (buf
, enable_multibyte_characters
) = Qnil
;
3493 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3494 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3495 coding_system
= call2 (Vset_auto_coding_function
,
3496 filename
, make_number (nread
));
3497 set_buffer_internal (prev
);
3499 /* Discard the unwind protect for recovering the
3503 /* Rewind the file for the actual read done later. */
3504 if (lseek (fd
, 0, SEEK_SET
) < 0)
3505 report_file_error ("Setting file position",
3506 Fcons (orig_filename
, Qnil
));
3510 if (NILP (coding_system
))
3512 /* If we have not yet decided a coding system, check
3513 file-coding-system-alist. */
3514 Lisp_Object args
[6];
3516 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3517 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3518 coding_system
= Ffind_operation_coding_system (6, args
);
3519 if (CONSP (coding_system
))
3520 coding_system
= XCAR (coding_system
);
3524 if (NILP (coding_system
))
3525 coding_system
= Qundecided
;
3527 CHECK_CODING_SYSTEM (coding_system
);
3529 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3530 /* We must suppress all character code conversion except for
3531 end-of-line conversion. */
3532 coding_system
= raw_text_coding_system (coding_system
);
3534 setup_coding_system (coding_system
, &coding
);
3535 /* Ensure we set Vlast_coding_system_used. */
3536 set_coding_system
= 1;
3539 /* If requested, replace the accessible part of the buffer
3540 with the file contents. Avoid replacing text at the
3541 beginning or end of the buffer that matches the file contents;
3542 that preserves markers pointing to the unchanged parts.
3544 Here we implement this feature in an optimized way
3545 for the case where code conversion is NOT needed.
3546 The following if-statement handles the case of conversion
3547 in a less optimal way.
3549 If the code conversion is "automatic" then we try using this
3550 method and hope for the best.
3551 But if we discover the need for conversion, we give up on this method
3552 and let the following if-statement handle the replace job. */
3555 && (NILP (coding_system
)
3556 || ! CODING_REQUIRE_DECODING (&coding
)))
3558 /* same_at_start and same_at_end count bytes,
3559 because file access counts bytes
3560 and BEG and END count bytes. */
3561 ptrdiff_t same_at_start
= BEGV_BYTE
;
3562 ptrdiff_t same_at_end
= ZV_BYTE
;
3564 /* There is still a possibility we will find the need to do code
3565 conversion. If that happens, we set this variable to 1 to
3566 give up on handling REPLACE in the optimized way. */
3567 int giveup_match_end
= 0;
3569 if (beg_offset
!= 0)
3571 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3572 report_file_error ("Setting file position",
3573 Fcons (orig_filename
, Qnil
));
3578 /* Count how many chars at the start of the file
3579 match the text at the beginning of the buffer. */
3584 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3586 error ("IO error reading %s: %s",
3587 SSDATA (orig_filename
), emacs_strerror (errno
));
3588 else if (nread
== 0)
3591 if (CODING_REQUIRE_DETECTION (&coding
))
3593 coding_system
= detect_coding_system ((unsigned char *) buffer
,
3596 setup_coding_system (coding_system
, &coding
);
3599 if (CODING_REQUIRE_DECODING (&coding
))
3600 /* We found that the file should be decoded somehow.
3601 Let's give up here. */
3603 giveup_match_end
= 1;
3608 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3609 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3610 same_at_start
++, bufpos
++;
3611 /* If we found a discrepancy, stop the scan.
3612 Otherwise loop around and scan the next bufferful. */
3613 if (bufpos
!= nread
)
3617 /* If the file matches the buffer completely,
3618 there's no need to replace anything. */
3619 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3623 /* Truncate the buffer to the size of the file. */
3624 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3629 /* Count how many chars at the end of the file
3630 match the text at the end of the buffer. But, if we have
3631 already found that decoding is necessary, don't waste time. */
3632 while (!giveup_match_end
)
3634 int total_read
, nread
, bufpos
, trial
;
3637 /* At what file position are we now scanning? */
3638 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3639 /* If the entire file matches the buffer tail, stop the scan. */
3642 /* How much can we scan in the next step? */
3643 trial
= min (curpos
, sizeof buffer
);
3644 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3645 report_file_error ("Setting file position",
3646 Fcons (orig_filename
, Qnil
));
3648 total_read
= nread
= 0;
3649 while (total_read
< trial
)
3651 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3653 error ("IO error reading %s: %s",
3654 SDATA (orig_filename
), emacs_strerror (errno
));
3655 else if (nread
== 0)
3657 total_read
+= nread
;
3660 /* Scan this bufferful from the end, comparing with
3661 the Emacs buffer. */
3662 bufpos
= total_read
;
3664 /* Compare with same_at_start to avoid counting some buffer text
3665 as matching both at the file's beginning and at the end. */
3666 while (bufpos
> 0 && same_at_end
> same_at_start
3667 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3668 same_at_end
--, bufpos
--;
3670 /* If we found a discrepancy, stop the scan.
3671 Otherwise loop around and scan the preceding bufferful. */
3674 /* If this discrepancy is because of code conversion,
3675 we cannot use this method; giveup and try the other. */
3676 if (same_at_end
> same_at_start
3677 && FETCH_BYTE (same_at_end
- 1) >= 0200
3678 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3679 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3680 giveup_match_end
= 1;
3689 if (! giveup_match_end
)
3693 /* We win! We can handle REPLACE the optimized way. */
3695 /* Extend the start of non-matching text area to multibyte
3696 character boundary. */
3697 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3698 while (same_at_start
> BEGV_BYTE
3699 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3702 /* Extend the end of non-matching text area to multibyte
3703 character boundary. */
3704 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3705 while (same_at_end
< ZV_BYTE
3706 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3709 /* Don't try to reuse the same piece of text twice. */
3710 overlap
= (same_at_start
- BEGV_BYTE
3712 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3714 same_at_end
+= overlap
;
3716 /* Arrange to read only the nonmatching middle part of the file. */
3717 beg_offset
+= same_at_start
- BEGV_BYTE
;
3718 end_offset
-= ZV_BYTE
- same_at_end
;
3720 del_range_byte (same_at_start
, same_at_end
, 0);
3721 /* Insert from the file at the proper position. */
3722 temp
= BYTE_TO_CHAR (same_at_start
);
3723 SET_PT_BOTH (temp
, same_at_start
);
3725 /* If display currently starts at beginning of line,
3726 keep it that way. */
3727 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3728 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3730 replace_handled
= 1;
3734 /* If requested, replace the accessible part of the buffer
3735 with the file contents. Avoid replacing text at the
3736 beginning or end of the buffer that matches the file contents;
3737 that preserves markers pointing to the unchanged parts.
3739 Here we implement this feature for the case where code conversion
3740 is needed, in a simple way that needs a lot of memory.
3741 The preceding if-statement handles the case of no conversion
3742 in a more optimized way. */
3743 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3745 ptrdiff_t same_at_start
= BEGV_BYTE
;
3746 ptrdiff_t same_at_end
= ZV_BYTE
;
3747 ptrdiff_t same_at_start_charpos
;
3748 ptrdiff_t inserted_chars
;
3751 unsigned char *decoded
;
3754 ptrdiff_t this_count
= SPECPDL_INDEX ();
3755 int multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3756 Lisp_Object conversion_buffer
;
3757 struct gcpro gcpro1
;
3759 conversion_buffer
= code_conversion_save (1, multibyte
);
3761 /* First read the whole file, performing code conversion into
3762 CONVERSION_BUFFER. */
3764 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3765 report_file_error ("Setting file position",
3766 Fcons (orig_filename
, Qnil
));
3768 total
= st
.st_size
; /* Total bytes in the file. */
3769 how_much
= 0; /* Bytes read from file so far. */
3770 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3771 unprocessed
= 0; /* Bytes not processed in previous loop. */
3773 GCPRO1 (conversion_buffer
);
3774 while (how_much
< total
)
3776 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3777 quitting while reading a huge while. */
3778 /* `try'' is reserved in some compilers (Microsoft C). */
3779 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
3781 /* Allow quitting out of the actual I/O. */
3784 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3792 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3793 BUF_Z (XBUFFER (conversion_buffer
)));
3794 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3795 unprocessed
+ this, conversion_buffer
);
3796 unprocessed
= coding
.carryover_bytes
;
3797 if (coding
.carryover_bytes
> 0)
3798 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3803 /* We should remove the unwind_protect calling
3804 close_file_unwind, but other stuff has been added the stack,
3805 so defer the removal till we reach the `handled' label. */
3806 deferred_remove_unwind_protect
= 1;
3808 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3809 if we couldn't read the file. */
3812 error ("IO error reading %s: %s",
3813 SDATA (orig_filename
), emacs_strerror (errno
));
3815 if (unprocessed
> 0)
3817 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3818 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3819 unprocessed
, conversion_buffer
);
3820 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3823 coding_system
= CODING_ID_NAME (coding
.id
);
3824 set_coding_system
= 1;
3825 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3826 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3827 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3829 /* Compare the beginning of the converted string with the buffer
3833 while (bufpos
< inserted
&& same_at_start
< same_at_end
3834 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3835 same_at_start
++, bufpos
++;
3837 /* If the file matches the head of buffer completely,
3838 there's no need to replace anything. */
3840 if (bufpos
== inserted
)
3842 /* Truncate the buffer to the size of the file. */
3843 if (same_at_start
== same_at_end
)
3846 del_range_byte (same_at_start
, same_at_end
, 0);
3849 unbind_to (this_count
, Qnil
);
3853 /* Extend the start of non-matching text area to the previous
3854 multibyte character boundary. */
3855 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3856 while (same_at_start
> BEGV_BYTE
3857 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3860 /* Scan this bufferful from the end, comparing with
3861 the Emacs buffer. */
3864 /* Compare with same_at_start to avoid counting some buffer text
3865 as matching both at the file's beginning and at the end. */
3866 while (bufpos
> 0 && same_at_end
> same_at_start
3867 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3868 same_at_end
--, bufpos
--;
3870 /* Extend the end of non-matching text area to the next
3871 multibyte character boundary. */
3872 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3873 while (same_at_end
< ZV_BYTE
3874 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3877 /* Don't try to reuse the same piece of text twice. */
3878 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3880 same_at_end
+= overlap
;
3882 /* If display currently starts at beginning of line,
3883 keep it that way. */
3884 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3885 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3887 /* Replace the chars that we need to replace,
3888 and update INSERTED to equal the number of bytes
3889 we are taking from the decoded string. */
3890 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3892 if (same_at_end
!= same_at_start
)
3894 del_range_byte (same_at_start
, same_at_end
, 0);
3896 same_at_start
= GPT_BYTE
;
3900 temp
= BYTE_TO_CHAR (same_at_start
);
3902 /* Insert from the file at the proper position. */
3903 SET_PT_BOTH (temp
, same_at_start
);
3904 same_at_start_charpos
3905 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3906 same_at_start
- BEGV_BYTE
3907 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3909 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3910 same_at_start
+ inserted
- BEGV_BYTE
3911 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3912 - same_at_start_charpos
);
3913 /* This binding is to avoid ask-user-about-supersession-threat
3914 being called in insert_from_buffer (via in
3915 prepare_to_modify_buffer). */
3916 specbind (intern ("buffer-file-name"), Qnil
);
3917 insert_from_buffer (XBUFFER (conversion_buffer
),
3918 same_at_start_charpos
, inserted_chars
, 0);
3919 /* Set `inserted' to the number of inserted characters. */
3920 inserted
= PT
- temp
;
3921 /* Set point before the inserted characters. */
3922 SET_PT_BOTH (temp
, same_at_start
);
3924 unbind_to (this_count
, Qnil
);
3930 total
= end_offset
- beg_offset
;
3932 /* For a special file, all we can do is guess. */
3933 total
= READ_BUF_SIZE
;
3935 if (NILP (visit
) && total
> 0)
3937 #ifdef CLASH_DETECTION
3938 if (!NILP (BVAR (current_buffer
, file_truename
))
3939 /* Make binding buffer-file-name to nil effective. */
3940 && !NILP (BVAR (current_buffer
, filename
))
3941 && SAVE_MODIFF
>= MODIFF
)
3943 #endif /* CLASH_DETECTION */
3944 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3948 if (GAP_SIZE
< total
)
3949 make_gap (total
- GAP_SIZE
);
3951 if (beg_offset
!= 0 || !NILP (replace
))
3953 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3954 report_file_error ("Setting file position",
3955 Fcons (orig_filename
, Qnil
));
3958 /* In the following loop, HOW_MUCH contains the total bytes read so
3959 far for a regular file, and not changed for a special file. But,
3960 before exiting the loop, it is set to a negative value if I/O
3964 /* Total bytes inserted. */
3967 /* Here, we don't do code conversion in the loop. It is done by
3968 decode_coding_gap after all data are read into the buffer. */
3970 ptrdiff_t gap_size
= GAP_SIZE
;
3972 while (how_much
< total
)
3974 /* try is reserved in some compilers (Microsoft C) */
3975 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3982 /* Maybe make more room. */
3983 if (gap_size
< trytry
)
3985 make_gap (total
- gap_size
);
3986 gap_size
= GAP_SIZE
;
3989 /* Read from the file, capturing `quit'. When an
3990 error occurs, end the loop, and arrange for a quit
3991 to be signaled after decoding the text we read. */
3992 non_regular_fd
= fd
;
3993 non_regular_inserted
= inserted
;
3994 non_regular_nbytes
= trytry
;
3995 nbytes
= internal_condition_case_1 (read_non_regular
,
3997 read_non_regular_quit
);
4004 this = XINT (nbytes
);
4008 /* Allow quitting out of the actual I/O. We don't make text
4009 part of the buffer until all the reading is done, so a C-g
4010 here doesn't do any harm. */
4013 this = emacs_read (fd
,
4014 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4028 /* For a regular file, where TOTAL is the real size,
4029 count HOW_MUCH to compare with it.
4030 For a special file, where TOTAL is just a buffer size,
4031 so don't bother counting in HOW_MUCH.
4032 (INSERTED is where we count the number of characters inserted.) */
4039 /* Now we have read all the file data into the gap.
4040 If it was empty, undo marking the buffer modified. */
4044 #ifdef CLASH_DETECTION
4046 unlock_file (BVAR (current_buffer
, file_truename
));
4048 Vdeactivate_mark
= old_Vdeactivate_mark
;
4051 Vdeactivate_mark
= Qt
;
4053 /* Make the text read part of the buffer. */
4054 GAP_SIZE
-= inserted
;
4056 GPT_BYTE
+= inserted
;
4058 ZV_BYTE
+= inserted
;
4063 /* Put an anchor to ensure multi-byte form ends at gap. */
4068 /* Discard the unwind protect for closing the file. */
4072 error ("IO error reading %s: %s",
4073 SDATA (orig_filename
), emacs_strerror (errno
));
4077 if (NILP (coding_system
))
4079 /* The coding system is not yet decided. Decide it by an
4080 optimized method for handling `coding:' tag.
4082 Note that we can get here only if the buffer was empty
4083 before the insertion. */
4085 if (!NILP (Vcoding_system_for_read
))
4086 coding_system
= Vcoding_system_for_read
;
4089 /* Since we are sure that the current buffer was empty
4090 before the insertion, we can toggle
4091 enable-multibyte-characters directly here without taking
4092 care of marker adjustment. By this way, we can run Lisp
4093 program safely before decoding the inserted text. */
4094 Lisp_Object unwind_data
;
4095 ptrdiff_t count1
= SPECPDL_INDEX ();
4097 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4098 Fcons (BVAR (current_buffer
, undo_list
),
4099 Fcurrent_buffer ()));
4100 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
4101 BVAR (current_buffer
, undo_list
) = Qt
;
4102 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4104 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4106 coding_system
= call2 (Vset_auto_coding_function
,
4107 filename
, make_number (inserted
));
4110 if (NILP (coding_system
))
4112 /* If the coding system is not yet decided, check
4113 file-coding-system-alist. */
4114 Lisp_Object args
[6];
4116 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4117 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4118 coding_system
= Ffind_operation_coding_system (6, args
);
4119 if (CONSP (coding_system
))
4120 coding_system
= XCAR (coding_system
);
4122 unbind_to (count1
, Qnil
);
4123 inserted
= Z_BYTE
- BEG_BYTE
;
4126 if (NILP (coding_system
))
4127 coding_system
= Qundecided
;
4129 CHECK_CODING_SYSTEM (coding_system
);
4131 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4132 /* We must suppress all character code conversion except for
4133 end-of-line conversion. */
4134 coding_system
= raw_text_coding_system (coding_system
);
4135 setup_coding_system (coding_system
, &coding
);
4136 /* Ensure we set Vlast_coding_system_used. */
4137 set_coding_system
= 1;
4142 /* When we visit a file by raw-text, we change the buffer to
4144 if (CODING_FOR_UNIBYTE (&coding
)
4145 /* Can't do this if part of the buffer might be preserved. */
4147 /* Visiting a file with these coding system makes the buffer
4149 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
4152 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4153 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4154 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4156 move_gap_both (PT
, PT_BYTE
);
4157 GAP_SIZE
+= inserted
;
4158 ZV_BYTE
-= inserted
;
4162 decode_coding_gap (&coding
, inserted
, inserted
);
4163 inserted
= coding
.produced_char
;
4164 coding_system
= CODING_ID_NAME (coding
.id
);
4166 else if (inserted
> 0)
4167 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4170 /* Call after-change hooks for the inserted text, aside from the case
4171 of normal visiting (not with REPLACE), which is done in a new buffer
4172 "before" the buffer is changed. */
4173 if (inserted
> 0 && total
> 0
4174 && (NILP (visit
) || !NILP (replace
)))
4176 signal_after_change (PT
, 0, inserted
);
4177 update_compositions (PT
, PT
, CHECK_BORDER
);
4180 /* Now INSERTED is measured in characters. */
4184 if (deferred_remove_unwind_protect
)
4185 /* If requested above, discard the unwind protect for closing the
4191 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4192 BVAR (current_buffer
, undo_list
) = Qnil
;
4196 if (st
.st_mtime
== -1)
4197 EMACS_SET_INVALID_TIME (current_buffer
->modtime
);
4199 current_buffer
->modtime
= get_stat_mtime (&st
);
4200 current_buffer
->modtime_size
= st
.st_size
;
4201 BVAR (current_buffer
, filename
) = orig_filename
;
4204 SAVE_MODIFF
= MODIFF
;
4205 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4206 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4207 #ifdef CLASH_DETECTION
4210 if (!NILP (BVAR (current_buffer
, file_truename
)))
4211 unlock_file (BVAR (current_buffer
, file_truename
));
4212 unlock_file (filename
);
4214 #endif /* CLASH_DETECTION */
4216 xsignal2 (Qfile_error
,
4217 build_string ("not a regular file"), orig_filename
);
4220 if (set_coding_system
)
4221 Vlast_coding_system_used
= coding_system
;
4223 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4225 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4227 if (! NILP (insval
))
4229 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4230 wrong_type_argument (intern ("inserted-chars"), insval
);
4231 inserted
= XFASTINT (insval
);
4235 /* Decode file format. */
4238 /* Don't run point motion or modification hooks when decoding. */
4239 ptrdiff_t count1
= SPECPDL_INDEX ();
4240 ptrdiff_t old_inserted
= inserted
;
4241 specbind (Qinhibit_point_motion_hooks
, Qt
);
4242 specbind (Qinhibit_modification_hooks
, Qt
);
4244 /* Save old undo list and don't record undo for decoding. */
4245 old_undo
= BVAR (current_buffer
, undo_list
);
4246 BVAR (current_buffer
, undo_list
) = Qt
;
4250 insval
= call3 (Qformat_decode
,
4251 Qnil
, make_number (inserted
), visit
);
4252 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4253 wrong_type_argument (intern ("inserted-chars"), insval
);
4254 inserted
= XFASTINT (insval
);
4258 /* If REPLACE is non-nil and we succeeded in not replacing the
4259 beginning or end of the buffer text with the file's contents,
4260 call format-decode with `point' positioned at the beginning
4261 of the buffer and `inserted' equaling the number of
4262 characters in the buffer. Otherwise, format-decode might
4263 fail to correctly analyze the beginning or end of the buffer.
4264 Hence we temporarily save `point' and `inserted' here and
4265 restore `point' iff format-decode did not insert or delete
4266 any text. Otherwise we leave `point' at point-min. */
4267 ptrdiff_t opoint
= PT
;
4268 ptrdiff_t opoint_byte
= PT_BYTE
;
4269 ptrdiff_t oinserted
= ZV
- BEGV
;
4270 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4272 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4273 insval
= call3 (Qformat_decode
,
4274 Qnil
, make_number (oinserted
), visit
);
4275 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4276 wrong_type_argument (intern ("inserted-chars"), insval
);
4277 if (ochars_modiff
== CHARS_MODIFF
)
4278 /* format_decode didn't modify buffer's characters => move
4279 point back to position before inserted text and leave
4280 value of inserted alone. */
4281 SET_PT_BOTH (opoint
, opoint_byte
);
4283 /* format_decode modified buffer's characters => consider
4284 entire buffer changed and leave point at point-min. */
4285 inserted
= XFASTINT (insval
);
4288 /* For consistency with format-decode call these now iff inserted > 0
4289 (martin 2007-06-28). */
4290 p
= Vafter_insert_file_functions
;
4295 insval
= call1 (XCAR (p
), make_number (inserted
));
4298 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4299 wrong_type_argument (intern ("inserted-chars"), insval
);
4300 inserted
= XFASTINT (insval
);
4305 /* For the rationale of this see the comment on
4306 format-decode above. */
4307 ptrdiff_t opoint
= PT
;
4308 ptrdiff_t opoint_byte
= PT_BYTE
;
4309 ptrdiff_t oinserted
= ZV
- BEGV
;
4310 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4312 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4313 insval
= call1 (XCAR (p
), make_number (oinserted
));
4316 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4317 wrong_type_argument (intern ("inserted-chars"), insval
);
4318 if (ochars_modiff
== CHARS_MODIFF
)
4319 /* after_insert_file_functions didn't modify
4320 buffer's characters => move point back to
4321 position before inserted text and leave value of
4323 SET_PT_BOTH (opoint
, opoint_byte
);
4325 /* after_insert_file_functions did modify buffer's
4326 characters => consider entire buffer changed and
4327 leave point at point-min. */
4328 inserted
= XFASTINT (insval
);
4338 BVAR (current_buffer
, undo_list
) = old_undo
;
4339 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4341 /* Adjust the last undo record for the size change during
4342 the format conversion. */
4343 Lisp_Object tem
= XCAR (old_undo
);
4344 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4345 && INTEGERP (XCDR (tem
))
4346 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4347 XSETCDR (tem
, make_number (PT
+ inserted
));
4351 /* If undo_list was Qt before, keep it that way.
4352 Otherwise start with an empty undo_list. */
4353 BVAR (current_buffer
, undo_list
) = EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4355 unbind_to (count1
, Qnil
);
4359 && EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
4361 /* If visiting nonexistent file, return nil. */
4363 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4367 Fsignal (Qquit
, Qnil
);
4369 /* ??? Retval needs to be dealt with in all cases consistently. */
4371 val
= Fcons (orig_filename
,
4372 Fcons (make_number (inserted
),
4375 RETURN_UNGCPRO (unbind_to (count
, val
));
4378 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4381 build_annotations_unwind (Lisp_Object arg
)
4383 Vwrite_region_annotation_buffers
= arg
;
4387 /* Decide the coding-system to encode the data with. */
4390 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4391 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4392 struct coding_system
*coding
)
4395 Lisp_Object eol_parent
= Qnil
;
4398 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4399 BVAR (current_buffer
, auto_save_file_name
))))
4404 else if (!NILP (Vcoding_system_for_write
))
4406 val
= Vcoding_system_for_write
;
4407 if (coding_system_require_warning
4408 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4409 /* Confirm that VAL can surely encode the current region. */
4410 val
= call5 (Vselect_safe_coding_system_function
,
4411 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4416 /* If the variable `buffer-file-coding-system' is set locally,
4417 it means that the file was read with some kind of code
4418 conversion or the variable is explicitly set by users. We
4419 had better write it out with the same coding system even if
4420 `enable-multibyte-characters' is nil.
4422 If it is not set locally, we anyway have to convert EOL
4423 format if the default value of `buffer-file-coding-system'
4424 tells that it is not Unix-like (LF only) format. */
4425 int using_default_coding
= 0;
4426 int force_raw_text
= 0;
4428 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4430 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4433 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4439 /* Check file-coding-system-alist. */
4440 Lisp_Object args
[7], coding_systems
;
4442 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4443 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4445 coding_systems
= Ffind_operation_coding_system (7, args
);
4446 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4447 val
= XCDR (coding_systems
);
4452 /* If we still have not decided a coding system, use the
4453 default value of buffer-file-coding-system. */
4454 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4455 using_default_coding
= 1;
4458 if (! NILP (val
) && ! force_raw_text
)
4460 Lisp_Object spec
, attrs
;
4462 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4463 attrs
= AREF (spec
, 0);
4464 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4469 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4470 /* Confirm that VAL can surely encode the current region. */
4471 val
= call5 (Vselect_safe_coding_system_function
,
4472 start
, end
, val
, Qnil
, filename
);
4474 /* If the decided coding-system doesn't specify end-of-line
4475 format, we use that of
4476 `default-buffer-file-coding-system'. */
4477 if (! using_default_coding
4478 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4479 val
= (coding_inherit_eol_type
4480 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4482 /* If we decide not to encode text, use `raw-text' or one of its
4485 val
= raw_text_coding_system (val
);
4488 val
= coding_inherit_eol_type (val
, eol_parent
);
4489 setup_coding_system (val
, coding
);
4491 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4492 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4496 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4497 "r\nFWrite region to file: \ni\ni\ni\np",
4498 doc
: /* Write current region into specified file.
4499 When called from a program, requires three arguments:
4500 START, END and FILENAME. START and END are normally buffer positions
4501 specifying the part of the buffer to write.
4502 If START is nil, that means to use the entire buffer contents.
4503 If START is a string, then output that string to the file
4504 instead of any buffer contents; END is ignored.
4506 Optional fourth argument APPEND if non-nil means
4507 append to existing file contents (if any). If it is an integer,
4508 seek to that offset in the file before writing.
4509 Optional fifth argument VISIT, if t or a string, means
4510 set the last-save-file-modtime of buffer to this file's modtime
4511 and mark buffer not modified.
4512 If VISIT is a string, it is a second file name;
4513 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4514 VISIT is also the file name to lock and unlock for clash detection.
4515 If VISIT is neither t nor nil nor a string,
4516 that means do not display the \"Wrote file\" message.
4517 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4518 use for locking and unlocking, overriding FILENAME and VISIT.
4519 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4520 for an existing file with the same name. If MUSTBENEW is `excl',
4521 that means to get an error if the file already exists; never overwrite.
4522 If MUSTBENEW is neither nil nor `excl', that means ask for
4523 confirmation before overwriting, but do go ahead and overwrite the file
4524 if the user confirms.
4526 This does code conversion according to the value of
4527 `coding-system-for-write', `buffer-file-coding-system', or
4528 `file-coding-system-alist', and sets the variable
4529 `last-coding-system-used' to the coding system actually used.
4531 This calls `write-region-annotate-functions' at the start, and
4532 `write-region-post-annotation-function' at the end. */)
4533 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4540 ptrdiff_t count
= SPECPDL_INDEX ();
4542 Lisp_Object handler
;
4543 Lisp_Object visit_file
;
4544 Lisp_Object annotations
;
4545 Lisp_Object encoded_filename
;
4546 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4547 int quietly
= !NILP (visit
);
4548 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4549 struct buffer
*given_buffer
;
4550 struct coding_system coding
;
4552 if (current_buffer
->base_buffer
&& visiting
)
4553 error ("Cannot do file visiting in an indirect buffer");
4555 if (!NILP (start
) && !STRINGP (start
))
4556 validate_region (&start
, &end
);
4559 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4561 filename
= Fexpand_file_name (filename
, Qnil
);
4563 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4564 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4566 if (STRINGP (visit
))
4567 visit_file
= Fexpand_file_name (visit
, Qnil
);
4569 visit_file
= filename
;
4571 if (NILP (lockname
))
4572 lockname
= visit_file
;
4576 /* If the file name has special constructs in it,
4577 call the corresponding file handler. */
4578 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4579 /* If FILENAME has no handler, see if VISIT has one. */
4580 if (NILP (handler
) && STRINGP (visit
))
4581 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4583 if (!NILP (handler
))
4586 val
= call6 (handler
, Qwrite_region
, start
, end
,
4587 filename
, append
, visit
);
4591 SAVE_MODIFF
= MODIFF
;
4592 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4593 BVAR (current_buffer
, filename
) = visit_file
;
4599 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4601 /* Special kludge to simplify auto-saving. */
4604 /* Do it later, so write-region-annotate-function can work differently
4605 if we save "the buffer" vs "a region".
4606 This is useful in tar-mode. --Stef
4607 XSETFASTINT (start, BEG);
4608 XSETFASTINT (end, Z); */
4612 record_unwind_protect (build_annotations_unwind
,
4613 Vwrite_region_annotation_buffers
);
4614 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4615 count1
= SPECPDL_INDEX ();
4617 given_buffer
= current_buffer
;
4619 if (!STRINGP (start
))
4621 annotations
= build_annotations (start
, end
);
4623 if (current_buffer
!= given_buffer
)
4625 XSETFASTINT (start
, BEGV
);
4626 XSETFASTINT (end
, ZV
);
4632 XSETFASTINT (start
, BEGV
);
4633 XSETFASTINT (end
, ZV
);
4638 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4640 /* Decide the coding-system to encode the data with.
4641 We used to make this choice before calling build_annotations, but that
4642 leads to problems when a write-annotate-function takes care of
4643 unsavable chars (as was the case with X-Symbol). */
4644 Vlast_coding_system_used
4645 = choose_write_coding_system (start
, end
, filename
,
4646 append
, visit
, lockname
, &coding
);
4648 #ifdef CLASH_DETECTION
4650 lock_file (lockname
);
4651 #endif /* CLASH_DETECTION */
4653 encoded_filename
= ENCODE_FILE (filename
);
4655 fn
= SSDATA (encoded_filename
);
4659 desc
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4660 #else /* not DOS_NT */
4661 desc
= emacs_open (fn
, O_WRONLY
, 0);
4662 #endif /* not DOS_NT */
4664 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4666 desc
= emacs_open (fn
,
4667 O_WRONLY
| O_CREAT
| O_BINARY
4668 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4669 S_IREAD
| S_IWRITE
);
4670 #else /* not DOS_NT */
4671 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4672 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4673 auto_saving
? auto_save_mode_bits
: 0666);
4674 #endif /* not DOS_NT */
4678 #ifdef CLASH_DETECTION
4680 if (!auto_saving
) unlock_file (lockname
);
4682 #endif /* CLASH_DETECTION */
4684 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4687 record_unwind_protect (close_file_unwind
, make_number (desc
));
4689 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4693 if (NUMBERP (append
))
4694 ret
= emacs_lseek (desc
, XINT (append
), SEEK_CUR
);
4696 ret
= lseek (desc
, 0, SEEK_END
);
4699 #ifdef CLASH_DETECTION
4701 if (!auto_saving
) unlock_file (lockname
);
4703 #endif /* CLASH_DETECTION */
4705 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4714 if (STRINGP (start
))
4716 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4717 &annotations
, &coding
);
4720 else if (XINT (start
) != XINT (end
))
4722 failure
= 0 > a_write (desc
, Qnil
,
4723 XINT (start
), XINT (end
) - XINT (start
),
4724 &annotations
, &coding
);
4729 /* If file was empty, still need to write the annotations */
4730 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4731 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4735 if (CODING_REQUIRE_FLUSHING (&coding
)
4736 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4739 /* We have to flush out a data. */
4740 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4741 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4748 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4749 Disk full in NFS may be reported here. */
4750 /* mib says that closing the file will try to write as fast as NFS can do
4751 it, and that means the fsync here is not crucial for autosave files. */
4752 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4754 /* If fsync fails with EINTR, don't treat that as serious. Also
4755 ignore EINVAL which happens when fsync is not supported on this
4757 if (errno
!= EINTR
&& errno
!= EINVAL
)
4758 failure
= 1, save_errno
= errno
;
4762 /* NFS can report a write failure now. */
4763 if (emacs_close (desc
) < 0)
4764 failure
= 1, save_errno
= errno
;
4768 /* Discard the unwind protect for close_file_unwind. */
4769 specpdl_ptr
= specpdl
+ count1
;
4771 /* Call write-region-post-annotation-function. */
4772 while (CONSP (Vwrite_region_annotation_buffers
))
4774 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4775 if (!NILP (Fbuffer_live_p (buf
)))
4778 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4779 call0 (Vwrite_region_post_annotation_function
);
4781 Vwrite_region_annotation_buffers
4782 = XCDR (Vwrite_region_annotation_buffers
);
4785 unbind_to (count
, Qnil
);
4787 #ifdef CLASH_DETECTION
4789 unlock_file (lockname
);
4790 #endif /* CLASH_DETECTION */
4792 /* Do this before reporting IO error
4793 to avoid a "file has changed on disk" warning on
4794 next attempt to save. */
4797 current_buffer
->modtime
= get_stat_mtime (&st
);
4798 current_buffer
->modtime_size
= st
.st_size
;
4802 error ("IO error writing %s: %s", SDATA (filename
),
4803 emacs_strerror (save_errno
));
4807 SAVE_MODIFF
= MODIFF
;
4808 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4809 BVAR (current_buffer
, filename
) = visit_file
;
4810 update_mode_lines
++;
4815 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4816 BVAR (current_buffer
, auto_save_file_name
))))
4817 SAVE_MODIFF
= MODIFF
;
4823 message_with_string ((INTEGERP (append
)
4833 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4835 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4836 doc
: /* Return t if (car A) is numerically less than (car B). */)
4837 (Lisp_Object a
, Lisp_Object b
)
4839 return Flss (Fcar (a
), Fcar (b
));
4842 /* Build the complete list of annotations appropriate for writing out
4843 the text between START and END, by calling all the functions in
4844 write-region-annotate-functions and merging the lists they return.
4845 If one of these functions switches to a different buffer, we assume
4846 that buffer contains altered text. Therefore, the caller must
4847 make sure to restore the current buffer in all cases,
4848 as save-excursion would do. */
4851 build_annotations (Lisp_Object start
, Lisp_Object end
)
4853 Lisp_Object annotations
;
4855 struct gcpro gcpro1
, gcpro2
;
4856 Lisp_Object original_buffer
;
4857 int i
, used_global
= 0;
4859 XSETBUFFER (original_buffer
, current_buffer
);
4862 p
= Vwrite_region_annotate_functions
;
4863 GCPRO2 (annotations
, p
);
4866 struct buffer
*given_buffer
= current_buffer
;
4867 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4868 { /* Use the global value of the hook. */
4871 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4873 p
= Fappend (2, arg
);
4876 Vwrite_region_annotations_so_far
= annotations
;
4877 res
= call2 (XCAR (p
), start
, end
);
4878 /* If the function makes a different buffer current,
4879 assume that means this buffer contains altered text to be output.
4880 Reset START and END from the buffer bounds
4881 and discard all previous annotations because they should have
4882 been dealt with by this function. */
4883 if (current_buffer
!= given_buffer
)
4885 Vwrite_region_annotation_buffers
4886 = Fcons (Fcurrent_buffer (),
4887 Vwrite_region_annotation_buffers
);
4888 XSETFASTINT (start
, BEGV
);
4889 XSETFASTINT (end
, ZV
);
4892 Flength (res
); /* Check basic validity of return value */
4893 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4897 /* Now do the same for annotation functions implied by the file-format */
4898 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
4899 p
= BVAR (current_buffer
, auto_save_file_format
);
4901 p
= BVAR (current_buffer
, file_format
);
4902 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4904 struct buffer
*given_buffer
= current_buffer
;
4906 Vwrite_region_annotations_so_far
= annotations
;
4908 /* Value is either a list of annotations or nil if the function
4909 has written annotations to a temporary buffer, which is now
4911 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4912 original_buffer
, make_number (i
));
4913 if (current_buffer
!= given_buffer
)
4915 XSETFASTINT (start
, BEGV
);
4916 XSETFASTINT (end
, ZV
);
4921 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4929 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4930 If STRING is nil, POS is the character position in the current buffer.
4931 Intersperse with them the annotations from *ANNOT
4932 which fall within the range of POS to POS + NCHARS,
4933 each at its appropriate position.
4935 We modify *ANNOT by discarding elements as we use them up.
4937 The return value is negative in case of system call failure. */
4940 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
4941 register ptrdiff_t nchars
, Lisp_Object
*annot
,
4942 struct coding_system
*coding
)
4946 ptrdiff_t lastpos
= pos
+ nchars
;
4948 while (NILP (*annot
) || CONSP (*annot
))
4950 tem
= Fcar_safe (Fcar (*annot
));
4953 nextpos
= XFASTINT (tem
);
4955 /* If there are no more annotations in this range,
4956 output the rest of the range all at once. */
4957 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4958 return e_write (desc
, string
, pos
, lastpos
, coding
);
4960 /* Output buffer text up to the next annotation's position. */
4963 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4967 /* Output the annotation. */
4968 tem
= Fcdr (Fcar (*annot
));
4971 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4974 *annot
= Fcdr (*annot
);
4980 /* Write text in the range START and END into descriptor DESC,
4981 encoding them with coding system CODING. If STRING is nil, START
4982 and END are character positions of the current buffer, else they
4983 are indexes to the string STRING. */
4986 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
4987 struct coding_system
*coding
)
4989 if (STRINGP (string
))
4992 end
= SCHARS (string
);
4995 /* We used to have a code for handling selective display here. But,
4996 now it is handled within encode_coding. */
5000 if (STRINGP (string
))
5002 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5003 if (CODING_REQUIRE_ENCODING (coding
))
5005 encode_coding_object (coding
, string
,
5006 start
, string_char_to_byte (string
, start
),
5007 end
, string_char_to_byte (string
, end
), Qt
);
5011 coding
->dst_object
= string
;
5012 coding
->consumed_char
= SCHARS (string
);
5013 coding
->produced
= SBYTES (string
);
5018 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5019 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5021 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5022 if (CODING_REQUIRE_ENCODING (coding
))
5024 encode_coding_object (coding
, Fcurrent_buffer (),
5025 start
, start_byte
, end
, end_byte
, Qt
);
5029 coding
->dst_object
= Qnil
;
5030 coding
->dst_pos_byte
= start_byte
;
5031 if (start
>= GPT
|| end
<= GPT
)
5033 coding
->consumed_char
= end
- start
;
5034 coding
->produced
= end_byte
- start_byte
;
5038 coding
->consumed_char
= GPT
- start
;
5039 coding
->produced
= GPT_BYTE
- start_byte
;
5044 if (coding
->produced
> 0)
5048 STRINGP (coding
->dst_object
)
5049 ? SSDATA (coding
->dst_object
)
5050 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
5053 if (coding
->produced
)
5056 start
+= coding
->consumed_char
;
5062 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5063 Sverify_visited_file_modtime
, 0, 1, 0,
5064 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5065 This means that the file has not been changed since it was visited or saved.
5066 If BUF is omitted or nil, it defaults to the current buffer.
5067 See Info node `(elisp)Modification Time' for more details. */)
5072 Lisp_Object handler
;
5073 Lisp_Object filename
;
5074 EMACS_TIME mtime
, diff
, one_second
;
5084 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5085 if (EMACS_NSECS (b
->modtime
) == UNKNOWN_MODTIME_NSECS
) return Qt
;
5087 /* If the file name has special constructs in it,
5088 call the corresponding file handler. */
5089 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5090 Qverify_visited_file_modtime
);
5091 if (!NILP (handler
))
5092 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5094 filename
= ENCODE_FILE (BVAR (b
, filename
));
5096 if (stat (SSDATA (filename
), &st
) == 0)
5097 mtime
= get_stat_mtime (&st
);
5100 /* If the file doesn't exist now and didn't exist before,
5101 we say that it isn't modified, provided the error is a tame one. */
5102 int ns
= (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
5103 ? NONEXISTENT_MODTIME_NSECS
5104 : UNKNOWN_MODTIME_NSECS
);
5105 EMACS_SET_SECS_NSECS (mtime
, 0, ns
);
5107 if ((EMACS_TIME_EQ (mtime
, b
->modtime
)
5108 /* If both exist, accept them if they are off by one second. */
5109 || (EMACS_TIME_VALID_P (mtime
) && EMACS_TIME_VALID_P (b
->modtime
)
5110 && ((EMACS_TIME_LT (mtime
, b
->modtime
)
5111 ? EMACS_SUB_TIME (diff
, b
->modtime
, mtime
)
5112 : EMACS_SUB_TIME (diff
, mtime
, b
->modtime
)),
5113 EMACS_SET_SECS_NSECS (one_second
, 1, 0),
5114 EMACS_TIME_LE (diff
, one_second
))))
5115 && (st
.st_size
== b
->modtime_size
5116 || b
->modtime_size
< 0))
5121 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5122 Sclear_visited_file_modtime
, 0, 0, 0,
5123 doc
: /* Clear out records of last mod time of visited file.
5124 Next attempt to save will certainly not complain of a discrepancy. */)
5127 EMACS_SET_SECS_NSECS (current_buffer
->modtime
, 0, UNKNOWN_MODTIME_NSECS
);
5128 current_buffer
->modtime_size
= -1;
5132 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5133 Svisited_file_modtime
, 0, 0, 0,
5134 doc
: /* Return the current buffer's recorded visited file modification time.
5135 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5136 `file-attributes' returns. If the current buffer has no recorded file
5137 modification time, this function returns 0. If the visited file
5138 doesn't exist, HIGH will be -1.
5139 See Info node `(elisp)Modification Time' for more details. */)
5142 if (EMACS_NSECS (current_buffer
->modtime
) < 0)
5143 return make_number (0);
5144 return make_lisp_time (current_buffer
->modtime
);
5147 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5148 Sset_visited_file_modtime
, 0, 1, 0,
5149 doc
: /* Update buffer's recorded modification time from the visited file's time.
5150 Useful if the buffer was not read from the file normally
5151 or if the file itself has been changed for some known benign reason.
5152 An argument specifies the modification time value to use
5153 \(instead of that of the visited file), in the form of a list
5154 \(HIGH LOW USEC PSEC) as returned by `current-time'. */)
5155 (Lisp_Object time_list
)
5157 if (!NILP (time_list
))
5159 current_buffer
->modtime
= lisp_time_argument (time_list
, 0);
5160 current_buffer
->modtime_size
= -1;
5164 register Lisp_Object filename
;
5166 Lisp_Object handler
;
5168 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5170 /* If the file name has special constructs in it,
5171 call the corresponding file handler. */
5172 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5173 if (!NILP (handler
))
5174 /* The handler can find the file name the same way we did. */
5175 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5177 filename
= ENCODE_FILE (filename
);
5179 if (stat (SSDATA (filename
), &st
) >= 0)
5181 current_buffer
->modtime
= get_stat_mtime (&st
);
5182 current_buffer
->modtime_size
= st
.st_size
;
5190 auto_save_error (Lisp_Object error_val
)
5192 Lisp_Object args
[3], msg
;
5194 struct gcpro gcpro1
;
5198 auto_save_error_occurred
= 1;
5200 ring_bell (XFRAME (selected_frame
));
5202 args
[0] = build_string ("Auto-saving %s: %s");
5203 args
[1] = BVAR (current_buffer
, name
);
5204 args
[2] = Ferror_message_string (error_val
);
5205 msg
= Fformat (3, args
);
5207 nbytes
= SBYTES (msg
);
5208 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5209 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5211 for (i
= 0; i
< 3; ++i
)
5214 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5216 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5217 Fsleep_for (make_number (1), Qnil
);
5231 auto_save_mode_bits
= 0666;
5233 /* Get visited file's mode to become the auto save file's mode. */
5234 if (! NILP (BVAR (current_buffer
, filename
)))
5236 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5237 /* But make sure we can overwrite it later! */
5238 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5239 else if ((modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5241 /* Remote files don't cooperate with stat. */
5242 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5246 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5247 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5252 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5255 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5267 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5270 minibuffer_auto_raise
= XINT (value
);
5275 do_auto_save_make_dir (Lisp_Object dir
)
5279 auto_saving_dir_umask
= 077;
5280 result
= call2 (Qmake_directory
, dir
, Qt
);
5281 auto_saving_dir_umask
= 0;
5286 do_auto_save_eh (Lisp_Object ignore
)
5288 auto_saving_dir_umask
= 0;
5292 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5293 doc
: /* Auto-save all buffers that need it.
5294 This is all buffers that have auto-saving enabled
5295 and are changed since last auto-saved.
5296 Auto-saving writes the buffer into a file
5297 so that your editing is not lost if the system crashes.
5298 This file is not the file you visited; that changes only when you save.
5299 Normally we run the normal hook `auto-save-hook' before saving.
5301 A non-nil NO-MESSAGE argument means do not print any message if successful.
5302 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5303 (Lisp_Object no_message
, Lisp_Object current_only
)
5305 struct buffer
*old
= current_buffer
, *b
;
5306 Lisp_Object tail
, buf
, hook
;
5308 int do_handled_files
;
5310 FILE *stream
= NULL
;
5311 ptrdiff_t count
= SPECPDL_INDEX ();
5312 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5313 int old_message_p
= 0;
5314 struct gcpro gcpro1
, gcpro2
;
5316 if (max_specpdl_size
< specpdl_size
+ 40)
5317 max_specpdl_size
= specpdl_size
+ 40;
5322 if (NILP (no_message
))
5324 old_message_p
= push_message ();
5325 record_unwind_protect (pop_message_unwind
, Qnil
);
5328 /* Ordinarily don't quit within this function,
5329 but don't make it impossible to quit (in case we get hung in I/O). */
5333 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5334 point to non-strings reached from Vbuffer_alist. */
5336 hook
= intern ("auto-save-hook");
5337 Frun_hooks (1, &hook
);
5339 if (STRINGP (Vauto_save_list_file_name
))
5341 Lisp_Object listfile
;
5343 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5345 /* Don't try to create the directory when shutting down Emacs,
5346 because creating the directory might signal an error, and
5347 that would leave Emacs in a strange state. */
5348 if (!NILP (Vrun_hooks
))
5352 GCPRO2 (dir
, listfile
);
5353 dir
= Ffile_name_directory (listfile
);
5354 if (NILP (Ffile_directory_p (dir
)))
5355 internal_condition_case_1 (do_auto_save_make_dir
,
5361 stream
= fopen (SSDATA (listfile
), "w");
5364 record_unwind_protect (do_auto_save_unwind
,
5365 make_save_value (stream
, 0));
5366 record_unwind_protect (do_auto_save_unwind_1
,
5367 make_number (minibuffer_auto_raise
));
5368 minibuffer_auto_raise
= 0;
5370 auto_save_error_occurred
= 0;
5372 /* On first pass, save all files that don't have handlers.
5373 On second pass, save all files that do have handlers.
5375 If Emacs is crashing, the handlers may tweak what is causing
5376 Emacs to crash in the first place, and it would be a shame if
5377 Emacs failed to autosave perfectly ordinary files because it
5378 couldn't handle some ange-ftp'd file. */
5380 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5381 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5383 buf
= XCDR (XCAR (tail
));
5386 /* Record all the buffers that have auto save mode
5387 in the special file that lists them. For each of these buffers,
5388 Record visited name (if any) and auto save name. */
5389 if (STRINGP (BVAR (b
, auto_save_file_name
))
5390 && stream
!= NULL
&& do_handled_files
== 0)
5393 if (!NILP (BVAR (b
, filename
)))
5395 fwrite (SDATA (BVAR (b
, filename
)), 1,
5396 SBYTES (BVAR (b
, filename
)), stream
);
5398 putc ('\n', stream
);
5399 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5400 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5401 putc ('\n', stream
);
5405 if (!NILP (current_only
)
5406 && b
!= current_buffer
)
5409 /* Don't auto-save indirect buffers.
5410 The base buffer takes care of it. */
5414 /* Check for auto save enabled
5415 and file changed since last auto save
5416 and file changed since last real save. */
5417 if (STRINGP (BVAR (b
, auto_save_file_name
))
5418 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5419 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5420 /* -1 means we've turned off autosaving for a while--see below. */
5421 && XINT (BVAR (b
, save_length
)) >= 0
5422 && (do_handled_files
5423 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5426 EMACS_TIME before_time
, after_time
;
5428 EMACS_GET_TIME (before_time
);
5430 /* If we had a failure, don't try again for 20 minutes. */
5431 if (b
->auto_save_failure_time
> 0
5432 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5435 set_buffer_internal (b
);
5436 if (NILP (Vauto_save_include_big_deletions
)
5437 && (XFASTINT (BVAR (b
, save_length
)) * 10
5438 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5439 /* A short file is likely to change a large fraction;
5440 spare the user annoying messages. */
5441 && XFASTINT (BVAR (b
, save_length
)) > 5000
5442 /* These messages are frequent and annoying for `*mail*'. */
5443 && !EQ (BVAR (b
, filename
), Qnil
)
5444 && NILP (no_message
))
5446 /* It has shrunk too much; turn off auto-saving here. */
5447 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5448 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5450 minibuffer_auto_raise
= 0;
5451 /* Turn off auto-saving until there's a real save,
5452 and prevent any more warnings. */
5453 XSETINT (BVAR (b
, save_length
), -1);
5454 Fsleep_for (make_number (1), Qnil
);
5457 if (!auto_saved
&& NILP (no_message
))
5458 message1 ("Auto-saving...");
5459 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5461 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5462 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5463 set_buffer_internal (old
);
5465 EMACS_GET_TIME (after_time
);
5467 /* If auto-save took more than 60 seconds,
5468 assume it was an NFS failure that got a timeout. */
5469 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5470 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5474 /* Prevent another auto save till enough input events come in. */
5475 record_auto_save ();
5477 if (auto_saved
&& NILP (no_message
))
5481 /* If we are going to restore an old message,
5482 give time to read ours. */
5483 sit_for (make_number (1), 0, 0);
5486 else if (!auto_save_error_occurred
)
5487 /* Don't overwrite the error message if an error occurred.
5488 If we displayed a message and then restored a state
5489 with no message, leave a "done" message on the screen. */
5490 message1 ("Auto-saving...done");
5495 /* This restores the message-stack status. */
5496 unbind_to (count
, Qnil
);
5500 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5501 Sset_buffer_auto_saved
, 0, 0, 0,
5502 doc
: /* Mark current buffer as auto-saved with its current text.
5503 No auto-save file will be written until the buffer changes again. */)
5506 /* FIXME: This should not be called in indirect buffers, since
5507 they're not autosaved. */
5508 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5509 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5510 current_buffer
->auto_save_failure_time
= 0;
5514 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5515 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5516 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5519 current_buffer
->auto_save_failure_time
= 0;
5523 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5525 doc
: /* Return t if current buffer has been auto-saved recently.
5526 More precisely, if it has been auto-saved since last read from or saved
5527 in the visited file. If the buffer has no visited file,
5528 then any auto-save counts as "recent". */)
5531 /* FIXME: maybe we should return nil for indirect buffers since
5532 they're never autosaved. */
5533 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5536 /* Reading and completing file names */
5538 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5539 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5540 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5541 The return value is only relevant for a call to `read-file-name' that happens
5542 before any other event (mouse or keypress) is handled. */)
5545 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5546 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5556 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5558 struct gcpro gcpro1
;
5559 Lisp_Object args
[7];
5561 GCPRO1 (default_filename
);
5562 args
[0] = intern ("read-file-name");
5565 args
[3] = default_filename
;
5566 args
[4] = mustmatch
;
5568 args
[6] = predicate
;
5569 RETURN_UNGCPRO (Ffuncall (7, args
));
5574 syms_of_fileio (void)
5576 DEFSYM (Qoperations
, "operations");
5577 DEFSYM (Qexpand_file_name
, "expand-file-name");
5578 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5579 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5580 DEFSYM (Qfile_name_directory
, "file-name-directory");
5581 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5582 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5583 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5584 DEFSYM (Qcopy_file
, "copy-file");
5585 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5586 DEFSYM (Qmake_directory
, "make-directory");
5587 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5588 DEFSYM (Qdelete_file
, "delete-file");
5589 DEFSYM (Qrename_file
, "rename-file");
5590 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5591 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5592 DEFSYM (Qfile_exists_p
, "file-exists-p");
5593 DEFSYM (Qfile_executable_p
, "file-executable-p");
5594 DEFSYM (Qfile_readable_p
, "file-readable-p");
5595 DEFSYM (Qfile_writable_p
, "file-writable-p");
5596 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5597 DEFSYM (Qaccess_file
, "access-file");
5598 DEFSYM (Qfile_directory_p
, "file-directory-p");
5599 DEFSYM (Qfile_regular_p
, "file-regular-p");
5600 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5601 DEFSYM (Qfile_modes
, "file-modes");
5602 DEFSYM (Qset_file_modes
, "set-file-modes");
5603 DEFSYM (Qset_file_times
, "set-file-times");
5604 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5605 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5606 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5607 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5608 DEFSYM (Qwrite_region
, "write-region");
5609 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5610 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5611 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5613 DEFSYM (Qfile_name_history
, "file-name-history");
5614 Fset (Qfile_name_history
, Qnil
);
5616 DEFSYM (Qfile_error
, "file-error");
5617 DEFSYM (Qfile_already_exists
, "file-already-exists");
5618 DEFSYM (Qfile_date_error
, "file-date-error");
5619 DEFSYM (Qexcl
, "excl");
5621 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5622 doc
: /* Coding system for encoding file names.
5623 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5624 Vfile_name_coding_system
= Qnil
;
5626 DEFVAR_LISP ("default-file-name-coding-system",
5627 Vdefault_file_name_coding_system
,
5628 doc
: /* Default coding system for encoding file names.
5629 This variable is used only when `file-name-coding-system' is nil.
5631 This variable is set/changed by the command `set-language-environment'.
5632 User should not set this variable manually,
5633 instead use `file-name-coding-system' to get a constant encoding
5634 of file names regardless of the current language environment. */);
5635 Vdefault_file_name_coding_system
= Qnil
;
5637 DEFSYM (Qformat_decode
, "format-decode");
5638 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5639 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5640 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5642 Fput (Qfile_error
, Qerror_conditions
,
5643 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5644 Fput (Qfile_error
, Qerror_message
,
5645 make_pure_c_string ("File error"));
5647 Fput (Qfile_already_exists
, Qerror_conditions
,
5648 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5649 Fput (Qfile_already_exists
, Qerror_message
,
5650 make_pure_c_string ("File already exists"));
5652 Fput (Qfile_date_error
, Qerror_conditions
,
5653 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5654 Fput (Qfile_date_error
, Qerror_message
,
5655 make_pure_c_string ("Cannot set file date"));
5657 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5658 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5659 If a file name matches REGEXP, all I/O on that file is done by calling
5660 HANDLER. If a file name matches more than one handler, the handler
5661 whose match starts last in the file name gets precedence. The
5662 function `find-file-name-handler' checks this list for a handler for
5665 HANDLER should be a function. The first argument given to it is the
5666 name of the I/O primitive to be handled; the remaining arguments are
5667 the arguments that were passed to that primitive. For example, if you
5668 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5669 HANDLER is called like this:
5671 (funcall HANDLER 'file-exists-p FILENAME)
5673 Note that HANDLER must be able to handle all I/O primitives; if it has
5674 nothing special to do for a primitive, it should reinvoke the
5675 primitive to handle the operation \"the usual way\".
5676 See Info node `(elisp)Magic File Names' for more details. */);
5677 Vfile_name_handler_alist
= Qnil
;
5679 DEFVAR_LISP ("set-auto-coding-function",
5680 Vset_auto_coding_function
,
5681 doc
: /* If non-nil, a function to call to decide a coding system of file.
5682 Two arguments are passed to this function: the file name
5683 and the length of a file contents following the point.
5684 This function should return a coding system to decode the file contents.
5685 It should check the file name against `auto-coding-alist'.
5686 If no coding system is decided, it should check a coding system
5687 specified in the heading lines with the format:
5688 -*- ... coding: CODING-SYSTEM; ... -*-
5689 or local variable spec of the tailing lines with `coding:' tag. */);
5690 Vset_auto_coding_function
= Qnil
;
5692 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5693 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5694 Each is passed one argument, the number of characters inserted,
5695 with point at the start of the inserted text. Each function
5696 should leave point the same, and return the new character count.
5697 If `insert-file-contents' is intercepted by a handler from
5698 `file-name-handler-alist', that handler is responsible for calling the
5699 functions in `after-insert-file-functions' if appropriate. */);
5700 Vafter_insert_file_functions
= Qnil
;
5702 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5703 doc
: /* A list of functions to be called at the start of `write-region'.
5704 Each is passed two arguments, START and END as for `write-region'.
5705 These are usually two numbers but not always; see the documentation
5706 for `write-region'. The function should return a list of pairs
5707 of the form (POSITION . STRING), consisting of strings to be effectively
5708 inserted at the specified positions of the file being written (1 means to
5709 insert before the first byte written). The POSITIONs must be sorted into
5712 If there are several annotation functions, the lists returned by these
5713 functions are merged destructively. As each annotation function runs,
5714 the variable `write-region-annotations-so-far' contains a list of all
5715 annotations returned by previous annotation functions.
5717 An annotation function can return with a different buffer current.
5718 Doing so removes the annotations returned by previous functions, and
5719 resets START and END to `point-min' and `point-max' of the new buffer.
5721 After `write-region' completes, Emacs calls the function stored in
5722 `write-region-post-annotation-function', once for each buffer that was
5723 current when building the annotations (i.e., at least once), with that
5724 buffer current. */);
5725 Vwrite_region_annotate_functions
= Qnil
;
5726 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5728 DEFVAR_LISP ("write-region-post-annotation-function",
5729 Vwrite_region_post_annotation_function
,
5730 doc
: /* Function to call after `write-region' completes.
5731 The function is called with no arguments. If one or more of the
5732 annotation functions in `write-region-annotate-functions' changed the
5733 current buffer, the function stored in this variable is called for
5734 each of those additional buffers as well, in addition to the original
5735 buffer. The relevant buffer is current during each function call. */);
5736 Vwrite_region_post_annotation_function
= Qnil
;
5737 staticpro (&Vwrite_region_annotation_buffers
);
5739 DEFVAR_LISP ("write-region-annotations-so-far",
5740 Vwrite_region_annotations_so_far
,
5741 doc
: /* When an annotation function is called, this holds the previous annotations.
5742 These are the annotations made by other annotation functions
5743 that were already called. See also `write-region-annotate-functions'. */);
5744 Vwrite_region_annotations_so_far
= Qnil
;
5746 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5747 doc
: /* A list of file name handlers that temporarily should not be used.
5748 This applies only to the operation `inhibit-file-name-operation'. */);
5749 Vinhibit_file_name_handlers
= Qnil
;
5751 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5752 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5753 Vinhibit_file_name_operation
= Qnil
;
5755 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
5756 doc
: /* File name in which we write a list of all auto save file names.
5757 This variable is initialized automatically from `auto-save-list-file-prefix'
5758 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5759 a non-nil value. */);
5760 Vauto_save_list_file_name
= Qnil
;
5762 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
5763 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5764 Normally auto-save files are written under other names. */);
5765 Vauto_save_visited_file_name
= Qnil
;
5767 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
5768 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5769 If nil, deleting a substantial portion of the text disables auto-save
5770 in the buffer; this is the default behavior, because the auto-save
5771 file is usually more useful if it contains the deleted text. */);
5772 Vauto_save_include_big_deletions
= Qnil
;
5775 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
5776 doc
: /* Non-nil means don't call fsync in `write-region'.
5777 This variable affects calls to `write-region' as well as save commands.
5778 A non-nil value may result in data loss! */);
5779 write_region_inhibit_fsync
= 0;
5782 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
5783 doc
: /* Specifies whether to use the system's trash can.
5784 When non-nil, certain file deletion commands use the function
5785 `move-file-to-trash' instead of deleting files outright.
5786 This includes interactive calls to `delete-file' and
5787 `delete-directory' and the Dired deletion commands. */);
5788 delete_by_moving_to_trash
= 0;
5789 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5791 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
5792 DEFSYM (Qcopy_directory
, "copy-directory");
5793 DEFSYM (Qdelete_directory
, "delete-directory");
5795 defsubr (&Sfind_file_name_handler
);
5796 defsubr (&Sfile_name_directory
);
5797 defsubr (&Sfile_name_nondirectory
);
5798 defsubr (&Sunhandled_file_name_directory
);
5799 defsubr (&Sfile_name_as_directory
);
5800 defsubr (&Sdirectory_file_name
);
5801 defsubr (&Smake_temp_name
);
5802 defsubr (&Sexpand_file_name
);
5803 defsubr (&Ssubstitute_in_file_name
);
5804 defsubr (&Scopy_file
);
5805 defsubr (&Smake_directory_internal
);
5806 defsubr (&Sdelete_directory_internal
);
5807 defsubr (&Sdelete_file
);
5808 defsubr (&Srename_file
);
5809 defsubr (&Sadd_name_to_file
);
5810 defsubr (&Smake_symbolic_link
);
5811 defsubr (&Sfile_name_absolute_p
);
5812 defsubr (&Sfile_exists_p
);
5813 defsubr (&Sfile_executable_p
);
5814 defsubr (&Sfile_readable_p
);
5815 defsubr (&Sfile_writable_p
);
5816 defsubr (&Saccess_file
);
5817 defsubr (&Sfile_symlink_p
);
5818 defsubr (&Sfile_directory_p
);
5819 defsubr (&Sfile_accessible_directory_p
);
5820 defsubr (&Sfile_regular_p
);
5821 defsubr (&Sfile_modes
);
5822 defsubr (&Sset_file_modes
);
5823 defsubr (&Sset_file_times
);
5824 defsubr (&Sfile_selinux_context
);
5825 defsubr (&Sset_file_selinux_context
);
5826 defsubr (&Sset_default_file_modes
);
5827 defsubr (&Sdefault_file_modes
);
5828 defsubr (&Sfile_newer_than_file_p
);
5829 defsubr (&Sinsert_file_contents
);
5830 defsubr (&Swrite_region
);
5831 defsubr (&Scar_less_than_car
);
5832 defsubr (&Sverify_visited_file_modtime
);
5833 defsubr (&Sclear_visited_file_modtime
);
5834 defsubr (&Svisited_file_modtime
);
5835 defsubr (&Sset_visited_file_modtime
);
5836 defsubr (&Sdo_auto_save
);
5837 defsubr (&Sset_buffer_auto_saved
);
5838 defsubr (&Sclear_buffer_auto_save_failure
);
5839 defsubr (&Srecent_auto_save_p
);
5841 defsubr (&Snext_read_file_uses_dialog_p
);
5844 defsubr (&Sunix_sync
);