1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
36 #ifdef HAVE_LIBSELINUX
37 #include <selinux/selinux.h>
38 #include <selinux/context.h>
42 #include "intervals.h"
44 #include "character.h"
47 #include "blockinput.h"
49 #include "dispextern.h"
55 #endif /* not WINDOWSNT */
59 #include <sys/param.h>
64 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
65 redirector allows the six letters between 'Z' and 'a' as well. */
67 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
70 #define IS_DRIVE(x) isalpha ((unsigned char) (x))
72 /* Need to lower-case the drive letter, or else expanded
73 filenames will sometimes compare inequal, because
74 `expand-file-name' doesn't always down-case the drive letter. */
75 #define DRIVE_LETTER(x) (tolower ((unsigned char) (x)))
86 #ifndef FILE_SYSTEM_CASE
87 #define FILE_SYSTEM_CASE(filename) (filename)
90 /* Nonzero during writing of auto-save files */
93 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
94 a new file with the same mode as the original */
95 int auto_save_mode_bits
;
97 /* Set by auto_save_1 if an error occurred during the last auto-save. */
98 int auto_save_error_occurred
;
100 /* The symbol bound to coding-system-for-read when
101 insert-file-contents is called for recovering a file. This is not
102 an actual coding system name, but just an indicator to tell
103 insert-file-contents to use `emacs-mule' with a special flag for
104 auto saving and recovering a file. */
105 static Lisp_Object Qauto_save_coding
;
107 /* Property name of a file name handler,
108 which gives a list of operations it handles.. */
109 static Lisp_Object Qoperations
;
111 /* Lisp functions for translating file formats */
112 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
114 /* Lisp function for setting buffer-file-coding-system and the
115 multibyteness of the current buffer after inserting a file. */
116 static Lisp_Object Qafter_insert_file_set_coding
;
118 static Lisp_Object Qwrite_region_annotate_functions
;
119 /* Each time an annotation function changes the buffer, the new buffer
121 Lisp_Object Vwrite_region_annotation_buffers
;
126 static Lisp_Object Qdelete_by_moving_to_trash
;
128 /* Lisp function for moving files to trash. */
129 static Lisp_Object Qmove_file_to_trash
;
131 /* Lisp function for recursively copying directories. */
132 static Lisp_Object Qcopy_directory
;
134 /* Lisp function for recursively deleting directories. */
135 static Lisp_Object Qdelete_directory
;
140 Lisp_Object Qfile_error
;
141 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
142 static Lisp_Object Qexcl
;
143 Lisp_Object Qfile_name_history
;
145 static Lisp_Object Qcar_less_than_car
;
147 INFUN (Fmake_symbolic_link
, 3);
148 static int a_write (int, Lisp_Object
, int, int,
149 Lisp_Object
*, struct coding_system
*);
150 static int e_write (int, Lisp_Object
, int, int, struct coding_system
*);
154 report_file_error (const char *string
, Lisp_Object data
)
156 Lisp_Object errstring
;
160 synchronize_system_messages_locale ();
161 str
= strerror (errorno
);
162 errstring
= code_convert_string_norecord (make_unibyte_string (str
,
164 Vlocale_coding_system
, 0);
170 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
173 /* System error messages are capitalized. Downcase the initial
174 unless it is followed by a slash. (The slash case caters to
175 error messages that begin with "I/O" or, in German, "E/A".) */
176 if (STRING_MULTIBYTE (errstring
)
177 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
181 str
= SSDATA (errstring
);
182 c
= STRING_CHAR ((unsigned char *) str
);
183 Faset (errstring
, make_number (0), make_number (downcase (c
)));
186 xsignal (Qfile_error
,
187 Fcons (build_string (string
), Fcons (errstring
, data
)));
192 close_file_unwind (Lisp_Object fd
)
194 emacs_close (XFASTINT (fd
));
198 /* Restore point, having saved it as a marker. */
201 restore_point_unwind (Lisp_Object location
)
203 Fgoto_char (location
);
204 Fset_marker (location
, Qnil
, Qnil
);
209 static Lisp_Object Qexpand_file_name
;
210 static Lisp_Object Qsubstitute_in_file_name
;
211 static Lisp_Object Qdirectory_file_name
;
212 static Lisp_Object Qfile_name_directory
;
213 static Lisp_Object Qfile_name_nondirectory
;
214 static Lisp_Object Qunhandled_file_name_directory
;
215 static Lisp_Object Qfile_name_as_directory
;
216 static Lisp_Object Qcopy_file
;
217 static Lisp_Object Qmake_directory_internal
;
218 static Lisp_Object Qmake_directory
;
219 static Lisp_Object Qdelete_directory_internal
;
220 Lisp_Object Qdelete_file
;
221 static Lisp_Object Qrename_file
;
222 static Lisp_Object Qadd_name_to_file
;
223 static Lisp_Object Qmake_symbolic_link
;
224 Lisp_Object Qfile_exists_p
;
225 static Lisp_Object Qfile_executable_p
;
226 static Lisp_Object Qfile_readable_p
;
227 static Lisp_Object Qfile_writable_p
;
228 static Lisp_Object Qfile_symlink_p
;
229 static Lisp_Object Qaccess_file
;
230 Lisp_Object Qfile_directory_p
;
231 static Lisp_Object Qfile_regular_p
;
232 static Lisp_Object Qfile_accessible_directory_p
;
233 static Lisp_Object Qfile_modes
;
234 static Lisp_Object Qset_file_modes
;
235 static Lisp_Object Qset_file_times
;
236 static Lisp_Object Qfile_selinux_context
;
237 static Lisp_Object Qset_file_selinux_context
;
238 static Lisp_Object Qfile_newer_than_file_p
;
239 Lisp_Object Qinsert_file_contents
;
240 Lisp_Object Qwrite_region
;
241 static Lisp_Object Qverify_visited_file_modtime
;
242 static Lisp_Object Qset_visited_file_modtime
;
244 DEFUE ("find-file-name-handler", Ffind_file_name_handler
,
245 Sfind_file_name_handler
, 2, 2, 0,
246 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
247 Otherwise, return nil.
248 A file name is handled if one of the regular expressions in
249 `file-name-handler-alist' matches it.
251 If OPERATION equals `inhibit-file-name-operation', then we ignore
252 any handlers that are members of `inhibit-file-name-handlers',
253 but we still do run any other handlers. This lets handlers
254 use the standard functions without calling themselves recursively. */)
255 (Lisp_Object filename
, Lisp_Object operation
)
257 /* This function must not munge the match data. */
258 Lisp_Object chain
, inhibited_handlers
, result
;
262 CHECK_STRING (filename
);
264 if (EQ (operation
, Vinhibit_file_name_operation
))
265 inhibited_handlers
= Vinhibit_file_name_handlers
;
267 inhibited_handlers
= Qnil
;
269 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
270 chain
= XCDR (chain
))
276 Lisp_Object string
= XCAR (elt
);
278 Lisp_Object handler
= XCDR (elt
);
279 Lisp_Object operations
= Qnil
;
281 if (SYMBOLP (handler
))
282 operations
= Fget (handler
, Qoperations
);
285 && (match_pos
= fast_string_match (string
, filename
)) > pos
286 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
290 handler
= XCDR (elt
);
291 tem
= Fmemq (handler
, inhibited_handlers
);
305 DEFUE ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
307 doc
: /* Return the directory component in file name FILENAME.
308 Return nil if FILENAME does not include a directory.
309 Otherwise return a directory name.
310 Given a Unix syntax file name, returns a string ending in slash. */)
311 (Lisp_Object filename
)
314 register const char *beg
;
318 register const char *p
;
321 CHECK_STRING (filename
);
323 /* If the file name has special constructs in it,
324 call the corresponding file handler. */
325 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
327 return call2 (handler
, Qfile_name_directory
, filename
);
329 filename
= FILE_SYSTEM_CASE (filename
);
331 beg
= (char *) alloca (SBYTES (filename
) + 1);
332 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
334 beg
= SSDATA (filename
);
336 p
= beg
+ SBYTES (filename
);
338 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
340 /* only recognise drive specifier at the beginning */
342 /* handle the "/:d:foo" and "/:foo" cases correctly */
343 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
344 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
351 /* Expansion of "c:" to drive and default directory. */
354 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
355 char *res
= alloca (MAXPATHLEN
+ 1);
358 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
360 strncpy (res
, beg
, 2);
365 if (getdefdir (toupper ((unsigned char) *beg
) - 'A' + 1, r
))
367 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
370 p
= beg
+ strlen (beg
);
373 dostounix_filename (beg
);
376 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
379 DEFUE ("file-name-nondirectory", Ffile_name_nondirectory
,
380 Sfile_name_nondirectory
, 1, 1, 0,
381 doc
: /* Return file name FILENAME sans its directory.
382 For example, in a Unix-syntax file name,
383 this is everything after the last slash,
384 or the entire name if it contains no slash. */)
385 (Lisp_Object filename
)
387 register const char *beg
, *p
, *end
;
390 CHECK_STRING (filename
);
392 /* If the file name has special constructs in it,
393 call the corresponding file handler. */
394 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
396 return call2 (handler
, Qfile_name_nondirectory
, filename
);
398 beg
= SSDATA (filename
);
399 end
= p
= beg
+ SBYTES (filename
);
401 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
403 /* only recognise drive specifier at beginning */
405 /* handle the "/:d:foo" case correctly */
406 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
411 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
414 DEFUE ("unhandled-file-name-directory", Funhandled_file_name_directory
,
415 Sunhandled_file_name_directory
, 1, 1, 0,
416 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
417 A `directly usable' directory name is one that may be used without the
418 intervention of any file handler.
419 If FILENAME is a directly usable file itself, return
420 \(file-name-directory FILENAME).
421 If FILENAME refers to a file which is not accessible from a local process,
422 then this should return nil.
423 The `call-process' and `start-process' functions use this function to
424 get a current directory to run processes in. */)
425 (Lisp_Object filename
)
429 /* If the file name has special constructs in it,
430 call the corresponding file handler. */
431 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
433 return call2 (handler
, Qunhandled_file_name_directory
, filename
);
435 return Ffile_name_directory (filename
);
440 file_name_as_directory (char *out
, const char *in
)
442 int size
= strlen (in
) - 1;
454 /* For Unix syntax, Append a slash if necessary */
455 if (!IS_DIRECTORY_SEP (out
[size
]))
457 out
[size
+ 1] = DIRECTORY_SEP
;
458 out
[size
+ 2] = '\0';
461 dostounix_filename (out
);
466 DEFUE ("file-name-as-directory", Ffile_name_as_directory
,
467 Sfile_name_as_directory
, 1, 1, 0,
468 doc
: /* Return a string representing the file name FILE interpreted as a directory.
469 This operation exists because a directory is also a file, but its name as
470 a directory is different from its name as a file.
471 The result can be used as the value of `default-directory'
472 or passed as second argument to `expand-file-name'.
473 For a Unix-syntax file name, just appends a slash. */)
483 /* If the file name has special constructs in it,
484 call the corresponding file handler. */
485 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
487 return call2 (handler
, Qfile_name_as_directory
, file
);
489 buf
= (char *) alloca (SBYTES (file
) + 10);
490 file_name_as_directory (buf
, SSDATA (file
));
491 return make_specified_string (buf
, -1, strlen (buf
),
492 STRING_MULTIBYTE (file
));
496 * Convert from directory name to filename.
497 * On UNIX, it's simple: just make sure there isn't a terminating /
499 * Value is nonzero if the string output is different from the input.
503 directory_file_name (char *src
, char *dst
)
509 /* Process as Unix format: just remove any final slash.
510 But leave "/" unchanged; do not change it to "". */
513 && IS_DIRECTORY_SEP (dst
[slen
- 1])
515 && !IS_ANY_SEP (dst
[slen
- 2])
520 dostounix_filename (dst
);
525 DEFUE ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
527 doc
: /* Returns the file name of the directory named DIRECTORY.
528 This is the name of the file that holds the data for the directory DIRECTORY.
529 This operation exists because a directory is also a file, but its name as
530 a directory is different from its name as a file.
531 In Unix-syntax, this function just removes the final slash. */)
532 (Lisp_Object directory
)
537 CHECK_STRING (directory
);
539 if (NILP (directory
))
542 /* If the file name has special constructs in it,
543 call the corresponding file handler. */
544 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
546 return call2 (handler
, Qdirectory_file_name
, directory
);
548 buf
= (char *) alloca (SBYTES (directory
) + 20);
549 directory_file_name (SSDATA (directory
), buf
);
550 return make_specified_string (buf
, -1, strlen (buf
),
551 STRING_MULTIBYTE (directory
));
554 static const char make_temp_name_tbl
[64] =
556 'A','B','C','D','E','F','G','H',
557 'I','J','K','L','M','N','O','P',
558 'Q','R','S','T','U','V','W','X',
559 'Y','Z','a','b','c','d','e','f',
560 'g','h','i','j','k','l','m','n',
561 'o','p','q','r','s','t','u','v',
562 'w','x','y','z','0','1','2','3',
563 '4','5','6','7','8','9','-','_'
566 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
568 /* Value is a temporary file name starting with PREFIX, a string.
570 The Emacs process number forms part of the result, so there is
571 no danger of generating a name being used by another process.
572 In addition, this function makes an attempt to choose a name
573 which has no existing file. To make this work, PREFIX should be
574 an absolute file name.
576 BASE64_P non-zero means add the pid as 3 characters in base64
577 encoding. In this case, 6 characters will be added to PREFIX to
578 form the file name. Otherwise, if Emacs is running on a system
579 with long file names, add the pid as a decimal number.
581 This function signals an error if no unique file name could be
585 make_temp_name (Lisp_Object prefix
, int base64_p
)
594 CHECK_STRING (prefix
);
596 /* VAL is created by adding 6 characters to PREFIX. The first
597 three are the PID of this process, in base 64, and the second
598 three are incremented if the file already exists. This ensures
599 262144 unique file names per PID per PREFIX. */
601 pid
= (int) getpid ();
605 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
606 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
607 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
612 #ifdef HAVE_LONG_FILE_NAMES
613 sprintf (pidbuf
, "%d", pid
);
614 pidlen
= strlen (pidbuf
);
616 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
617 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
618 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
623 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
624 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
625 if (!STRING_MULTIBYTE (prefix
))
626 STRING_SET_UNIBYTE (val
);
628 memcpy (data
, SSDATA (prefix
), len
);
631 memcpy (p
, pidbuf
, pidlen
);
634 /* Here we try to minimize useless stat'ing when this function is
635 invoked many times successively with the same PREFIX. We achieve
636 this by initializing count to a random value, and incrementing it
639 We don't want make-temp-name to be called while dumping,
640 because then make_temp_name_count_initialized_p would get set
641 and then make_temp_name_count would not be set when Emacs starts. */
643 if (!make_temp_name_count_initialized_p
)
645 make_temp_name_count
= (unsigned) time (NULL
);
646 make_temp_name_count_initialized_p
= 1;
652 unsigned num
= make_temp_name_count
;
654 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
655 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
656 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
658 /* Poor man's congruential RN generator. Replace with
659 ++make_temp_name_count for debugging. */
660 make_temp_name_count
+= 25229;
661 make_temp_name_count
%= 225307;
663 if (stat (data
, &ignored
) < 0)
665 /* We want to return only if errno is ENOENT. */
669 /* The error here is dubious, but there is little else we
670 can do. The alternatives are to return nil, which is
671 as bad as (and in many cases worse than) throwing the
672 error, or to ignore the error, which will likely result
673 in looping through 225307 stat's, which is not only
674 dog-slow, but also useless since eventually nil would
675 have to be returned anyway. */
676 report_file_error ("Cannot create temporary name for prefix",
677 Fcons (prefix
, Qnil
));
684 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
685 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
686 The Emacs process number forms part of the result,
687 so there is no danger of generating a name being used by another process.
689 In addition, this function makes an attempt to choose a name
690 which has no existing file. To make this work,
691 PREFIX should be an absolute file name.
693 There is a race condition between calling `make-temp-name' and creating the
694 file which opens all kinds of security holes. For that reason, you should
695 probably use `make-temp-file' instead, except in three circumstances:
697 * If you are creating the file in the user's home directory.
698 * If you are creating a directory rather than an ordinary file.
699 * If you are taking special precautions as `make-temp-file' does. */)
702 return make_temp_name (prefix
, 0);
707 DEFUE ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
708 doc
: /* Convert filename NAME to absolute, and canonicalize it.
709 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
710 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
711 the current buffer's value of `default-directory' is used.
712 NAME should be a string that is a valid file name for the underlying
714 File name components that are `.' are removed, and
715 so are file name components followed by `..', along with the `..' itself;
716 note that these simplifications are done without checking the resulting
717 file names in the file system.
718 Multiple consecutive slashes are collapsed into a single slash,
719 except at the beginning of the file name when they are significant (e.g.,
720 UNC file names on MS-Windows.)
721 An initial `~/' expands to your home directory.
722 An initial `~USER/' expands to USER's home directory.
723 See also the function `substitute-in-file-name'.
725 For technical reasons, this function can return correct but
726 non-intuitive results for the root directory; for instance,
727 \(expand-file-name ".." "/") returns "/..". For this reason, use
728 \(directory-file-name (file-name-directory dirname)) to traverse a
729 filesystem tree, not (expand-file-name ".." dirname). */)
730 (Lisp_Object name
, Lisp_Object default_directory
)
732 /* These point to SDATA and need to be careful with string-relocation
733 during GC (via DECODE_FILE). */
736 /* This should only point to alloca'd data. */
743 int collapse_newdir
= 1;
747 Lisp_Object handler
, result
;
753 /* If the file name has special constructs in it,
754 call the corresponding file handler. */
755 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
757 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
759 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
760 if (NILP (default_directory
))
761 default_directory
= BVAR (current_buffer
, directory
);
762 if (! STRINGP (default_directory
))
765 /* "/" is not considered a root directory on DOS_NT, so using "/"
766 here causes an infinite recursion in, e.g., the following:
768 (let (default-directory)
769 (expand-file-name "a"))
771 To avoid this, we set default_directory to the root of the
773 default_directory
= build_string (emacs_root_dir ());
775 default_directory
= build_string ("/");
779 if (!NILP (default_directory
))
781 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
783 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
787 char *o
= SSDATA (default_directory
);
789 /* Make sure DEFAULT_DIRECTORY is properly expanded.
790 It would be better to do this down below where we actually use
791 default_directory. Unfortunately, calling Fexpand_file_name recursively
792 could invoke GC, and the strings might be relocated. This would
793 be annoying because we have pointers into strings lying around
794 that would need adjusting, and people would add new pointers to
795 the code and forget to adjust them, resulting in intermittent bugs.
796 Putting this call here avoids all that crud.
798 The EQ test avoids infinite recursion. */
799 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
800 /* Save time in some common cases - as long as default_directory
801 is not relative, it can be canonicalized with name below (if it
802 is needed at all) without requiring it to be expanded now. */
804 /* Detect MSDOS file names with drive specifiers. */
805 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
806 && IS_DIRECTORY_SEP (o
[2]))
808 /* Detect Windows file names in UNC format. */
809 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
811 #else /* not DOS_NT */
812 /* Detect Unix absolute file names (/... alone is not absolute on
814 && ! (IS_DIRECTORY_SEP (o
[0]))
815 #endif /* not DOS_NT */
821 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
825 name
= FILE_SYSTEM_CASE (name
);
826 multibyte
= STRING_MULTIBYTE (name
);
827 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
830 default_directory
= string_to_multibyte (default_directory
);
833 name
= string_to_multibyte (name
);
838 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
839 nm
= (char *) alloca (SBYTES (name
) + 1);
840 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
843 /* Note if special escape prefix is present, but remove for now. */
844 if (nm
[0] == '/' && nm
[1] == ':')
850 /* Find and remove drive specifier if present; this makes nm absolute
851 even if the rest of the name appears to be relative. Only look for
852 drive specifier at the beginning. */
853 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
855 drive
= (unsigned char) nm
[0];
860 /* If we see "c://somedir", we want to strip the first slash after the
861 colon when stripping the drive letter. Otherwise, this expands to
863 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
866 /* Discard any previous drive specifier if nm is now in UNC format. */
867 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
871 #endif /* WINDOWSNT */
874 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
875 none are found, we can probably return right away. We will avoid
876 allocating a new string if name is already fully expanded. */
878 IS_DIRECTORY_SEP (nm
[0])
880 && drive
&& !is_escaped
883 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
887 /* If it turns out that the filename we want to return is just a
888 suffix of FILENAME, we don't need to go through and edit
889 things; we just need to construct a new string using data
890 starting at the middle of FILENAME. If we set lose to a
891 non-zero value, that means we've discovered that we can't do
898 /* Since we know the name is absolute, we can assume that each
899 element starts with a "/". */
901 /* "." and ".." are hairy. */
902 if (IS_DIRECTORY_SEP (p
[0])
904 && (IS_DIRECTORY_SEP (p
[2])
906 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
909 /* We want to replace multiple `/' in a row with a single
912 && IS_DIRECTORY_SEP (p
[0])
913 && IS_DIRECTORY_SEP (p
[1]))
920 /* Make sure directories are all separated with /, but
921 avoid allocation of a new string when not required. */
922 dostounix_filename (nm
);
924 if (IS_DIRECTORY_SEP (nm
[1]))
926 if (strcmp (nm
, SSDATA (name
)) != 0)
927 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
931 /* drive must be set, so this is okay */
932 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
936 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
937 temp
[0] = DRIVE_LETTER (drive
);
938 name
= concat2 (build_string (temp
), name
);
941 #else /* not DOS_NT */
942 if (strcmp (nm
, SSDATA (name
)) == 0)
944 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
945 #endif /* not DOS_NT */
949 /* At this point, nm might or might not be an absolute file name. We
950 need to expand ~ or ~user if present, otherwise prefix nm with
951 default_directory if nm is not absolute, and finally collapse /./
952 and /foo/../ sequences.
954 We set newdir to be the appropriate prefix if one is needed:
955 - the relevant user directory if nm starts with ~ or ~user
956 - the specified drive's working dir (DOS/NT only) if nm does not
958 - the value of default_directory.
960 Note that these prefixes are not guaranteed to be absolute (except
961 for the working dir of a drive). Therefore, to ensure we always
962 return an absolute name, if the final prefix is not absolute we
963 append it to the current working directory. */
967 if (nm
[0] == '~') /* prefix ~ */
969 if (IS_DIRECTORY_SEP (nm
[1])
970 || nm
[1] == 0) /* ~ by itself */
974 if (!(newdir
= egetenv ("HOME")))
977 /* egetenv may return a unibyte string, which will bite us since
978 we expect the directory to be multibyte. */
979 tem
= build_string (newdir
);
980 if (!STRING_MULTIBYTE (tem
))
982 hdir
= DECODE_FILE (tem
);
983 newdir
= SSDATA (hdir
);
989 else /* ~user/filename */
992 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
993 o
= alloca (p
- nm
+ 1);
994 memcpy (o
, nm
, p
- nm
);
998 pw
= (struct passwd
*) getpwnam (o
+ 1);
1002 newdir
= pw
->pw_dir
;
1005 collapse_newdir
= 0;
1009 /* If we don't find a user of that name, leave the name
1010 unchanged; don't move nm forward to p. */
1015 /* On DOS and Windows, nm is absolute if a drive name was specified;
1016 use the drive's current directory as the prefix if needed. */
1017 if (!newdir
&& drive
)
1019 /* Get default directory if needed to make nm absolute. */
1021 if (!IS_DIRECTORY_SEP (nm
[0]))
1023 adir
= alloca (MAXPATHLEN
+ 1);
1024 if (!getdefdir (toupper (drive
) - 'A' + 1, adir
))
1029 /* Either nm starts with /, or drive isn't mounted. */
1031 adir
[0] = DRIVE_LETTER (drive
);
1040 /* Finally, if no prefix has been specified and nm is not absolute,
1041 then it must be expanded relative to default_directory. */
1045 /* /... alone is not absolute on DOS and Windows. */
1046 && !IS_DIRECTORY_SEP (nm
[0])
1049 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1053 newdir
= SSDATA (default_directory
);
1055 /* Note if special escape prefix is present, but remove for now. */
1056 if (newdir
[0] == '/' && newdir
[1] == ':')
1067 /* First ensure newdir is an absolute name. */
1069 /* Detect MSDOS file names with drive specifiers. */
1070 ! (IS_DRIVE (newdir
[0])
1071 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1073 /* Detect Windows file names in UNC format. */
1074 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1078 /* Effectively, let newdir be (expand-file-name newdir cwd).
1079 Because of the admonition against calling expand-file-name
1080 when we have pointers into lisp strings, we accomplish this
1081 indirectly by prepending newdir to nm if necessary, and using
1082 cwd (or the wd of newdir's drive) as the new newdir. */
1084 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1086 drive
= (unsigned char) newdir
[0];
1089 if (!IS_DIRECTORY_SEP (nm
[0]))
1091 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1092 file_name_as_directory (tmp
, newdir
);
1096 adir
= alloca (MAXPATHLEN
+ 1);
1099 if (!getdefdir (toupper (drive
) - 'A' + 1, adir
))
1107 /* Strip off drive name from prefix, if present. */
1108 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1114 /* Keep only a prefix from newdir if nm starts with slash
1115 (//server/share for UNC, nothing otherwise). */
1116 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1119 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1121 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1123 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1125 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1138 /* Get rid of any slash at the end of newdir, unless newdir is
1139 just / or // (an incomplete UNC name). */
1140 length
= strlen (newdir
);
1141 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1143 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1147 char *temp
= (char *) alloca (length
);
1148 memcpy (temp
, newdir
, length
- 1);
1149 temp
[length
- 1] = 0;
1157 /* Now concatenate the directory and name to new space in the stack frame */
1158 tlen
+= strlen (nm
) + 1;
1160 /* Reserve space for drive specifier and escape prefix, since either
1161 or both may need to be inserted. (The Microsoft x86 compiler
1162 produces incorrect code if the following two lines are combined.) */
1163 target
= (char *) alloca (tlen
+ 4);
1165 #else /* not DOS_NT */
1166 target
= (char *) alloca (tlen
);
1167 #endif /* not DOS_NT */
1172 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1175 /* If newdir is effectively "C:/", then the drive letter will have
1176 been stripped and newdir will be "/". Concatenating with an
1177 absolute directory in nm produces "//", which will then be
1178 incorrectly treated as a network share. Ignore newdir in
1179 this case (keeping the drive letter). */
1180 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1181 && newdir
[1] == '\0'))
1183 strcpy (target
, newdir
);
1186 file_name_as_directory (target
, newdir
);
1189 strcat (target
, nm
);
1191 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1199 if (!IS_DIRECTORY_SEP (*p
))
1203 else if (p
[1] == '.'
1204 && (IS_DIRECTORY_SEP (p
[2])
1207 /* If "/." is the entire filename, keep the "/". Otherwise,
1208 just delete the whole "/.". */
1209 if (o
== target
&& p
[2] == '\0')
1213 else if (p
[1] == '.' && p
[2] == '.'
1214 /* `/../' is the "superroot" on certain file systems.
1215 Turned off on DOS_NT systems because they have no
1216 "superroot" and because this causes us to produce
1217 file names like "d:/../foo" which fail file-related
1218 functions of the underlying OS. (To reproduce, try a
1219 long series of "../../" in default_directory, longer
1220 than the number of levels from the root.) */
1224 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1229 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1232 /* Don't go below server level in UNC filenames. */
1233 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1234 && IS_DIRECTORY_SEP (*target
))
1238 /* Keep initial / only if this is the whole name. */
1239 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1243 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1244 /* Collapse multiple `/' in a row. */
1253 /* At last, set drive name. */
1255 /* Except for network file name. */
1256 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1257 #endif /* WINDOWSNT */
1259 if (!drive
) abort ();
1261 target
[0] = DRIVE_LETTER (drive
);
1264 /* Reinsert the escape prefix if required. */
1271 dostounix_filename (target
);
1274 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1277 /* Again look to see if the file name has special constructs in it
1278 and perhaps call the corresponding file handler. This is needed
1279 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1280 the ".." component gives us "/user@host:/bar/../baz" which needs
1281 to be expanded again. */
1282 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1283 if (!NILP (handler
))
1284 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1290 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1291 This is the old version of expand-file-name, before it was thoroughly
1292 rewritten for Emacs 10.31. We leave this version here commented-out,
1293 because the code is very complex and likely to have subtle bugs. If
1294 bugs _are_ found, it might be of interest to look at the old code and
1295 see what did it do in the relevant situation.
1297 Don't remove this code: it's true that it will be accessible
1298 from the repository, but a few years from deletion, people will
1299 forget it is there. */
1301 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1302 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1303 "Convert FILENAME to absolute, and canonicalize it.\n\
1304 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1305 \(does not start with slash); if DEFAULT is nil or missing,\n\
1306 the current buffer's value of default-directory is used.\n\
1307 Filenames containing `.' or `..' as components are simplified;\n\
1308 initial `~/' expands to your home directory.\n\
1309 See also the function `substitute-in-file-name'.")
1311 Lisp_Object name
, defalt
;
1315 register unsigned char *newdir
, *p
, *o
;
1317 unsigned char *target
;
1321 CHECK_STRING (name
);
1324 /* If nm is absolute, flush ...// and detect /./ and /../.
1325 If no /./ or /../ we can return right away. */
1332 if (p
[0] == '/' && p
[1] == '/'
1335 if (p
[0] == '/' && p
[1] == '~')
1336 nm
= p
+ 1, lose
= 1;
1337 if (p
[0] == '/' && p
[1] == '.'
1338 && (p
[2] == '/' || p
[2] == 0
1339 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1345 if (nm
== SDATA (name
))
1347 return build_string (nm
);
1351 /* Now determine directory to start with and put it in NEWDIR */
1355 if (nm
[0] == '~') /* prefix ~ */
1356 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1358 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1359 newdir
= (unsigned char *) "";
1362 else /* ~user/filename */
1364 /* Get past ~ to user */
1365 unsigned char *user
= nm
+ 1;
1366 /* Find end of name. */
1367 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1368 int len
= ptr
? ptr
- user
: strlen (user
);
1369 /* Copy the user name into temp storage. */
1370 o
= (unsigned char *) alloca (len
+ 1);
1371 memcpy (o
, user
, len
);
1374 /* Look up the user name. */
1376 pw
= (struct passwd
*) getpwnam (o
+ 1);
1379 error ("\"%s\" isn't a registered user", o
+ 1);
1381 newdir
= (unsigned char *) pw
->pw_dir
;
1383 /* Discard the user name from NM. */
1387 if (nm
[0] != '/' && !newdir
)
1390 defalt
= current_buffer
->directory
;
1391 CHECK_STRING (defalt
);
1392 newdir
= SDATA (defalt
);
1395 /* Now concatenate the directory and name to new space in the stack frame */
1397 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1398 target
= (unsigned char *) alloca (tlen
);
1403 if (nm
[0] == 0 || nm
[0] == '/')
1404 strcpy (target
, newdir
);
1406 file_name_as_directory (target
, newdir
);
1409 strcat (target
, nm
);
1411 /* Now canonicalize by removing /. and /foo/.. if they appear */
1422 else if (!strncmp (p
, "//", 2)
1428 else if (p
[0] == '/' && p
[1] == '.'
1429 && (p
[2] == '/' || p
[2] == 0))
1431 else if (!strncmp (p
, "/..", 3)
1432 /* `/../' is the "superroot" on certain file systems. */
1434 && (p
[3] == '/' || p
[3] == 0))
1436 while (o
!= target
&& *--o
!= '/')
1438 if (o
== target
&& *o
== '/')
1448 return make_string (target
, o
- target
);
1452 /* If /~ or // appears, discard everything through first slash. */
1454 file_name_absolute_p (const char *filename
)
1457 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1459 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1460 && IS_DIRECTORY_SEP (filename
[2]))
1466 search_embedded_absfilename (char *nm
, char *endp
)
1470 for (p
= nm
+ 1; p
< endp
; p
++)
1473 || IS_DIRECTORY_SEP (p
[-1]))
1474 && file_name_absolute_p (p
)
1475 #if defined (WINDOWSNT) || defined(CYGWIN)
1476 /* // at start of file name is meaningful in Apollo,
1477 WindowsNT and Cygwin systems. */
1478 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1479 #endif /* not (WINDOWSNT || CYGWIN) */
1482 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1483 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
1485 char *o
= alloca (s
- p
+ 1);
1487 memcpy (o
, p
, s
- p
);
1490 /* If we have ~user and `user' exists, discard
1491 everything up to ~. But if `user' does not exist, leave
1492 ~user alone, it might be a literal file name. */
1494 pw
= getpwnam (o
+ 1);
1506 DEFUE ("substitute-in-file-name", Fsubstitute_in_file_name
,
1507 Ssubstitute_in_file_name
, 1, 1, 0,
1508 doc
: /* Substitute environment variables referred to in FILENAME.
1509 `$FOO' where FOO is an environment variable name means to substitute
1510 the value of that variable. The variable name should be terminated
1511 with a character not a letter, digit or underscore; otherwise, enclose
1512 the entire variable name in braces.
1514 If `/~' appears, all of FILENAME through that `/' is discarded.
1515 If `//' appears, everything up to and including the first of
1516 those `/' is discarded. */)
1517 (Lisp_Object filename
)
1521 register char *s
, *p
, *o
, *x
, *endp
;
1522 char *target
= NULL
;
1524 int substituted
= 0;
1527 Lisp_Object handler
;
1529 CHECK_STRING (filename
);
1531 multibyte
= STRING_MULTIBYTE (filename
);
1533 /* If the file name has special constructs in it,
1534 call the corresponding file handler. */
1535 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1536 if (!NILP (handler
))
1537 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
1539 /* Always work on a copy of the string, in case GC happens during
1540 decode of environment variables, causing the original Lisp_String
1541 data to be relocated. */
1542 nm
= (char *) alloca (SBYTES (filename
) + 1);
1543 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1546 dostounix_filename (nm
);
1547 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1549 endp
= nm
+ SBYTES (filename
);
1551 /* If /~ or // appears, discard everything through first slash. */
1552 p
= search_embedded_absfilename (nm
, endp
);
1554 /* Start over with the new string, so we check the file-name-handler
1555 again. Important with filenames like "/home/foo//:/hello///there"
1556 which whould substitute to "/:/hello///there" rather than "/there". */
1557 return Fsubstitute_in_file_name
1558 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1560 /* See if any variables are substituted into the string
1561 and find the total length of their values in `total' */
1563 for (p
= nm
; p
!= endp
;)
1573 /* "$$" means a single "$" */
1582 while (p
!= endp
&& *p
!= '}') p
++;
1583 if (*p
!= '}') goto missingclose
;
1589 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1593 /* Copy out the variable name */
1594 target
= (char *) alloca (s
- o
+ 1);
1595 strncpy (target
, o
, s
- o
);
1598 strupr (target
); /* $home == $HOME etc. */
1601 /* Get variable value */
1602 o
= egetenv (target
);
1605 /* Don't try to guess a maximum length - UTF8 can use up to
1606 four bytes per character. This code is unlikely to run
1607 in a situation that requires performance, so decoding the
1608 env variables twice should be acceptable. Note that
1609 decoding may cause a garbage collect. */
1610 Lisp_Object orig
, decoded
;
1611 orig
= make_unibyte_string (o
, strlen (o
));
1612 decoded
= DECODE_FILE (orig
);
1613 total
+= SBYTES (decoded
);
1623 /* If substitution required, recopy the string and do it */
1624 /* Make space in stack frame for the new copy */
1625 xnm
= (char *) alloca (SBYTES (filename
) + total
+ 1);
1628 /* Copy the rest of the name through, replacing $ constructs with values */
1645 while (p
!= endp
&& *p
!= '}') p
++;
1646 if (*p
!= '}') goto missingclose
;
1652 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1656 /* Copy out the variable name */
1657 target
= (char *) alloca (s
- o
+ 1);
1658 strncpy (target
, o
, s
- o
);
1661 strupr (target
); /* $home == $HOME etc. */
1664 /* Get variable value */
1665 o
= egetenv (target
);
1669 strcpy (x
, target
); x
+= strlen (target
);
1673 Lisp_Object orig
, decoded
;
1674 int orig_length
, decoded_length
;
1675 orig_length
= strlen (o
);
1676 orig
= make_unibyte_string (o
, orig_length
);
1677 decoded
= DECODE_FILE (orig
);
1678 decoded_length
= SBYTES (decoded
);
1679 strncpy (x
, SSDATA (decoded
), decoded_length
);
1680 x
+= decoded_length
;
1682 /* If environment variable needed decoding, return value
1683 needs to be multibyte. */
1684 if (decoded_length
!= orig_length
1685 || strncmp (SSDATA (decoded
), o
, orig_length
))
1692 /* If /~ or // appears, discard everything through first slash. */
1693 while ((p
= search_embedded_absfilename (xnm
, x
)))
1694 /* This time we do not start over because we've already expanded envvars
1695 and replaced $$ with $. Maybe we should start over as well, but we'd
1696 need to quote some $ to $$ first. */
1699 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1702 error ("Bad format environment-variable substitution");
1704 error ("Missing \"}\" in environment-variable substitution");
1706 error ("Substituting nonexistent environment variable \"%s\"", target
);
1712 /* A slightly faster and more convenient way to get
1713 (directory-file-name (expand-file-name FOO)). */
1716 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1718 register Lisp_Object absname
;
1720 absname
= Fexpand_file_name (filename
, defdir
);
1722 /* Remove final slash, if any (unless this is the root dir).
1723 stat behaves differently depending! */
1724 if (SCHARS (absname
) > 1
1725 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1726 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
1727 /* We cannot take shortcuts; they might be wrong for magic file names. */
1728 absname
= Fdirectory_file_name (absname
);
1732 /* Signal an error if the file ABSNAME already exists.
1733 If INTERACTIVE is nonzero, ask the user whether to proceed,
1734 and bypass the error if the user says to go ahead.
1735 QUERYSTRING is a name for the action that is being considered
1738 *STATPTR is used to store the stat information if the file exists.
1739 If the file does not exist, STATPTR->st_mode is set to 0.
1740 If STATPTR is null, we don't store into it.
1742 If QUICK is nonzero, we ask for y or n, not yes or no. */
1745 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1746 int interactive
, struct stat
*statptr
, int quick
)
1748 register Lisp_Object tem
, encoded_filename
;
1749 struct stat statbuf
;
1750 struct gcpro gcpro1
;
1752 encoded_filename
= ENCODE_FILE (absname
);
1754 /* stat is a good way to tell whether the file exists,
1755 regardless of what access permissions it has. */
1756 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1759 xsignal2 (Qfile_already_exists
,
1760 build_string ("File already exists"), absname
);
1762 tem
= format2 ("File %s already exists; %s anyway? ",
1763 absname
, build_string (querystring
));
1765 tem
= call1 (intern ("y-or-n-p"), tem
);
1767 tem
= do_yes_or_no_p (tem
);
1770 xsignal2 (Qfile_already_exists
,
1771 build_string ("File already exists"), absname
);
1778 statptr
->st_mode
= 0;
1783 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1784 "fCopy file: \nGCopy %s to file: \np\nP",
1785 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1786 If NEWNAME names a directory, copy FILE there.
1788 This function always sets the file modes of the output file to match
1791 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1792 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1793 signal a `file-already-exists' error without overwriting. If
1794 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1795 about overwriting; this is what happens in interactive use with M-x.
1796 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1799 Fourth arg KEEP-TIME non-nil means give the output file the same
1800 last-modified time as the old one. (This works on only some systems.)
1802 A prefix arg makes KEEP-TIME non-nil.
1804 If PRESERVE-UID-GID is non-nil, we try to transfer the
1805 uid and gid of FILE to NEWNAME.
1807 If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
1808 on the system, we copy the SELinux context of FILE to NEWNAME. */)
1809 (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
)
1812 char buf
[16 * 1024];
1813 struct stat st
, out_st
;
1814 Lisp_Object handler
;
1815 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1816 int count
= SPECPDL_INDEX ();
1817 int input_file_statable_p
;
1818 Lisp_Object encoded_file
, encoded_newname
;
1820 security_context_t con
;
1821 int fail
, conlength
= 0;
1824 encoded_file
= encoded_newname
= Qnil
;
1825 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1826 CHECK_STRING (file
);
1827 CHECK_STRING (newname
);
1829 if (!NILP (Ffile_directory_p (newname
)))
1830 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1832 newname
= Fexpand_file_name (newname
, Qnil
);
1834 file
= Fexpand_file_name (file
, Qnil
);
1836 /* If the input file name has special constructs in it,
1837 call the corresponding file handler. */
1838 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1839 /* Likewise for output file name. */
1841 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1842 if (!NILP (handler
))
1843 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1844 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1845 preserve_selinux_context
));
1847 encoded_file
= ENCODE_FILE (file
);
1848 encoded_newname
= ENCODE_FILE (newname
);
1850 if (NILP (ok_if_already_exists
)
1851 || INTEGERP (ok_if_already_exists
))
1852 barf_or_query_if_file_exists (newname
, "copy to it",
1853 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1854 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1858 if (!CopyFile (SDATA (encoded_file
),
1859 SDATA (encoded_newname
),
1861 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1862 /* CopyFile retains the timestamp by default. */
1863 else if (NILP (keep_time
))
1869 EMACS_GET_TIME (now
);
1870 filename
= SDATA (encoded_newname
);
1872 /* Ensure file is writable while its modified time is set. */
1873 attributes
= GetFileAttributes (filename
);
1874 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1875 if (set_file_times (filename
, now
, now
))
1877 /* Restore original attributes. */
1878 SetFileAttributes (filename
, attributes
);
1879 xsignal2 (Qfile_date_error
,
1880 build_string ("Cannot set file date"), newname
);
1882 /* Restore original attributes. */
1883 SetFileAttributes (filename
, attributes
);
1885 #else /* not WINDOWSNT */
1887 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
1891 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1893 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1895 /* We can only copy regular files and symbolic links. Other files are not
1897 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
1900 if (!NILP (preserve_selinux_context
) && is_selinux_enabled ())
1902 conlength
= fgetfilecon (ifd
, &con
);
1903 if (conlength
== -1)
1904 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
1908 if (out_st
.st_mode
!= 0
1909 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
1912 report_file_error ("Input and output files are the same",
1913 Fcons (file
, Fcons (newname
, Qnil
)));
1916 if (input_file_statable_p
)
1918 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
1920 #if defined (EISDIR)
1921 /* Get a better looking error message. */
1924 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
1929 /* System's default file type was set to binary by _fmode in emacs.c. */
1930 ofd
= emacs_open (SDATA (encoded_newname
),
1931 O_WRONLY
| O_TRUNC
| O_CREAT
1932 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
1933 S_IREAD
| S_IWRITE
);
1934 #else /* not MSDOS */
1935 ofd
= emacs_open (SSDATA (encoded_newname
),
1936 O_WRONLY
| O_TRUNC
| O_CREAT
1937 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
1939 #endif /* not MSDOS */
1941 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
1943 record_unwind_protect (close_file_unwind
, make_number (ofd
));
1947 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
1948 if (emacs_write (ofd
, buf
, n
) != n
)
1949 report_file_error ("I/O error", Fcons (newname
, Qnil
));
1953 /* Preserve the original file modes, and if requested, also its
1955 if (input_file_statable_p
)
1957 if (!NILP (preserve_uid_gid
) && fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
1958 report_file_error ("Doing chown", Fcons (newname
, Qnil
));
1959 if (fchmod (ofd
, st
.st_mode
& 07777) != 0)
1960 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
1962 #endif /* not MSDOS */
1967 /* Set the modified context back to the file. */
1968 fail
= fsetfilecon (ofd
, con
);
1970 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
1976 /* Closing the output clobbers the file times on some systems. */
1977 if (emacs_close (ofd
) < 0)
1978 report_file_error ("I/O error", Fcons (newname
, Qnil
));
1980 if (input_file_statable_p
)
1982 if (!NILP (keep_time
))
1984 EMACS_TIME atime
, mtime
;
1985 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
1986 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
1987 if (set_file_times (SSDATA (encoded_newname
),
1989 xsignal2 (Qfile_date_error
,
1990 build_string ("Cannot set file date"), newname
);
1997 if (input_file_statable_p
)
1999 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2000 and if it can't, it tells so. Otherwise, under MSDOS we usually
2001 get only the READ bit, which will make the copied file read-only,
2002 so it's better not to chmod at all. */
2003 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2004 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2007 #endif /* not WINDOWSNT */
2009 /* Discard the unwind protects. */
2010 specpdl_ptr
= specpdl
+ count
;
2016 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2017 Smake_directory_internal
, 1, 1, 0,
2018 doc
: /* Create a new directory named DIRECTORY. */)
2019 (Lisp_Object directory
)
2022 Lisp_Object handler
;
2023 Lisp_Object encoded_dir
;
2025 CHECK_STRING (directory
);
2026 directory
= Fexpand_file_name (directory
, Qnil
);
2028 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2029 if (!NILP (handler
))
2030 return call2 (handler
, Qmake_directory_internal
, directory
);
2032 encoded_dir
= ENCODE_FILE (directory
);
2034 dir
= SSDATA (encoded_dir
);
2037 if (mkdir (dir
) != 0)
2039 if (mkdir (dir
, 0777) != 0)
2041 report_file_error ("Creating directory", list1 (directory
));
2046 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2047 Sdelete_directory_internal
, 1, 1, 0,
2048 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2049 (Lisp_Object directory
)
2052 Lisp_Object encoded_dir
;
2054 CHECK_STRING (directory
);
2055 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2056 encoded_dir
= ENCODE_FILE (directory
);
2057 dir
= SSDATA (encoded_dir
);
2059 if (rmdir (dir
) != 0)
2060 report_file_error ("Removing directory", list1 (directory
));
2065 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2066 "(list (read-file-name \
2067 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2068 \"Move file to trash: \" \"Delete file: \") \
2069 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2070 (null current-prefix-arg))",
2071 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2072 If file has multiple names, it continues to exist with the other names.
2073 TRASH non-nil means to trash the file instead of deleting, provided
2074 `delete-by-moving-to-trash' is non-nil.
2076 When called interactively, TRASH is t if no prefix argument is given.
2077 With a prefix argument, TRASH is nil. */)
2078 (Lisp_Object filename
, Lisp_Object trash
)
2080 Lisp_Object handler
;
2081 Lisp_Object encoded_file
;
2082 struct gcpro gcpro1
;
2085 if (!NILP (Ffile_directory_p (filename
))
2086 && NILP (Ffile_symlink_p (filename
)))
2087 xsignal2 (Qfile_error
,
2088 build_string ("Removing old name: is a directory"),
2091 filename
= Fexpand_file_name (filename
, Qnil
);
2093 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2094 if (!NILP (handler
))
2095 return call3 (handler
, Qdelete_file
, filename
, trash
);
2097 if (delete_by_moving_to_trash
&& !NILP (trash
))
2098 return call1 (Qmove_file_to_trash
, filename
);
2100 encoded_file
= ENCODE_FILE (filename
);
2102 if (0 > unlink (SSDATA (encoded_file
)))
2103 report_file_error ("Removing old name", list1 (filename
));
2108 internal_delete_file_1 (Lisp_Object ignore
)
2113 /* Delete file FILENAME, returning 1 if successful and 0 if failed.
2114 This ignores `delete-by-moving-to-trash'. */
2117 internal_delete_file (Lisp_Object filename
)
2121 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2122 Qt
, internal_delete_file_1
);
2126 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2127 "fRename file: \nGRename %s to file: \np",
2128 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2129 If file has names other than FILE, it continues to have those names.
2130 Signals a `file-already-exists' error if a file NEWNAME already exists
2131 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2132 A number as third arg means request confirmation if NEWNAME already exists.
2133 This is what happens in interactive use with M-x. */)
2134 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2136 Lisp_Object handler
;
2137 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2138 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2140 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2141 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2142 CHECK_STRING (file
);
2143 CHECK_STRING (newname
);
2144 file
= Fexpand_file_name (file
, Qnil
);
2146 if ((!NILP (Ffile_directory_p (newname
)))
2148 /* If the file names are identical but for the case,
2149 don't attempt to move directory to itself. */
2150 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2154 Lisp_Object fname
= NILP (Ffile_directory_p (file
))
2155 ? file
: Fdirectory_file_name (file
);
2156 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2159 newname
= Fexpand_file_name (newname
, Qnil
);
2161 /* If the file name has special constructs in it,
2162 call the corresponding file handler. */
2163 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2165 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2166 if (!NILP (handler
))
2167 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2168 file
, newname
, ok_if_already_exists
));
2170 encoded_file
= ENCODE_FILE (file
);
2171 encoded_newname
= ENCODE_FILE (newname
);
2174 /* If the file names are identical but for the case, don't ask for
2175 confirmation: they simply want to change the letter-case of the
2177 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2179 if (NILP (ok_if_already_exists
)
2180 || INTEGERP (ok_if_already_exists
))
2181 barf_or_query_if_file_exists (newname
, "rename to it",
2182 INTEGERP (ok_if_already_exists
), 0, 0);
2183 if (0 > rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2188 symlink_target
= Ffile_symlink_p (file
);
2189 if (! NILP (symlink_target
))
2190 Fmake_symbolic_link (symlink_target
, newname
,
2191 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2192 else if (!NILP (Ffile_directory_p (file
)))
2193 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2195 /* We have already prompted if it was an integer, so don't
2196 have copy-file prompt again. */
2197 Fcopy_file (file
, newname
,
2198 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2201 count
= SPECPDL_INDEX ();
2202 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2204 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2205 call2 (Qdelete_directory
, file
, Qt
);
2207 Fdelete_file (file
, Qnil
);
2208 unbind_to (count
, Qnil
);
2211 report_file_error ("Renaming", list2 (file
, newname
));
2217 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2218 "fAdd name to file: \nGName to add to %s: \np",
2219 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2220 Signals a `file-already-exists' error if a file NEWNAME already exists
2221 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2222 A number as third arg means request confirmation if NEWNAME already exists.
2223 This is what happens in interactive use with M-x. */)
2224 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2226 Lisp_Object handler
;
2227 Lisp_Object encoded_file
, encoded_newname
;
2228 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2230 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2231 encoded_file
= encoded_newname
= Qnil
;
2232 CHECK_STRING (file
);
2233 CHECK_STRING (newname
);
2234 file
= Fexpand_file_name (file
, Qnil
);
2236 if (!NILP (Ffile_directory_p (newname
)))
2237 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2239 newname
= Fexpand_file_name (newname
, Qnil
);
2241 /* If the file name has special constructs in it,
2242 call the corresponding file handler. */
2243 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2244 if (!NILP (handler
))
2245 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2246 newname
, ok_if_already_exists
));
2248 /* If the new name has special constructs in it,
2249 call the corresponding file handler. */
2250 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2251 if (!NILP (handler
))
2252 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2253 newname
, ok_if_already_exists
));
2255 encoded_file
= ENCODE_FILE (file
);
2256 encoded_newname
= ENCODE_FILE (newname
);
2258 if (NILP (ok_if_already_exists
)
2259 || INTEGERP (ok_if_already_exists
))
2260 barf_or_query_if_file_exists (newname
, "make it a new name",
2261 INTEGERP (ok_if_already_exists
), 0, 0);
2263 unlink (SSDATA (newname
));
2264 if (0 > link (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2265 report_file_error ("Adding new name", list2 (file
, newname
));
2271 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2272 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2273 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2274 Both args must be strings.
2275 Signals a `file-already-exists' error if a file LINKNAME already exists
2276 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2277 A number as third arg means request confirmation if LINKNAME already exists.
2278 This happens for interactive use with M-x. */)
2279 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2281 Lisp_Object handler
;
2282 Lisp_Object encoded_filename
, encoded_linkname
;
2283 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2285 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2286 encoded_filename
= encoded_linkname
= Qnil
;
2287 CHECK_STRING (filename
);
2288 CHECK_STRING (linkname
);
2289 /* If the link target has a ~, we must expand it to get
2290 a truly valid file name. Otherwise, do not expand;
2291 we want to permit links to relative file names. */
2292 if (SREF (filename
, 0) == '~')
2293 filename
= Fexpand_file_name (filename
, Qnil
);
2295 if (!NILP (Ffile_directory_p (linkname
)))
2296 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2298 linkname
= Fexpand_file_name (linkname
, Qnil
);
2300 /* If the file name has special constructs in it,
2301 call the corresponding file handler. */
2302 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2303 if (!NILP (handler
))
2304 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2305 linkname
, ok_if_already_exists
));
2307 /* If the new link name has special constructs in it,
2308 call the corresponding file handler. */
2309 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2310 if (!NILP (handler
))
2311 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2312 linkname
, ok_if_already_exists
));
2314 encoded_filename
= ENCODE_FILE (filename
);
2315 encoded_linkname
= ENCODE_FILE (linkname
);
2317 if (NILP (ok_if_already_exists
)
2318 || INTEGERP (ok_if_already_exists
))
2319 barf_or_query_if_file_exists (linkname
, "make it a link",
2320 INTEGERP (ok_if_already_exists
), 0, 0);
2321 if (0 > symlink (SSDATA (encoded_filename
),
2322 SSDATA (encoded_linkname
)))
2324 /* If we didn't complain already, silently delete existing file. */
2325 if (errno
== EEXIST
)
2327 unlink (SSDATA (encoded_linkname
));
2328 if (0 <= symlink (SSDATA (encoded_filename
),
2329 SSDATA (encoded_linkname
)))
2335 if (errno
== ENOSYS
)
2338 xsignal1 (Qfile_error
,
2339 build_string ("Symbolic links are not supported"));
2342 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2349 DEFUE ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2351 doc
: /* Return t if file FILENAME specifies an absolute file name.
2352 On Unix, this is a name starting with a `/' or a `~'. */)
2353 (Lisp_Object filename
)
2355 CHECK_STRING (filename
);
2356 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2359 /* Return nonzero if file FILENAME exists and can be executed. */
2362 check_executable (char *filename
)
2366 if (stat (filename
, &st
) < 0)
2368 return ((st
.st_mode
& S_IEXEC
) != 0);
2369 #else /* not DOS_NT */
2370 #ifdef HAVE_EUIDACCESS
2371 return (euidaccess (filename
, 1) >= 0);
2373 /* Access isn't quite right because it uses the real uid
2374 and we really want to test with the effective uid.
2375 But Unix doesn't give us a right way to do it. */
2376 return (access (filename
, 1) >= 0);
2378 #endif /* not DOS_NT */
2381 /* Return nonzero if file FILENAME exists and can be written. */
2384 check_writable (const char *filename
)
2388 if (stat (filename
, &st
) < 0)
2390 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2391 #else /* not MSDOS */
2392 #ifdef HAVE_EUIDACCESS
2393 return (euidaccess (filename
, 2) >= 0);
2395 /* Access isn't quite right because it uses the real uid
2396 and we really want to test with the effective uid.
2397 But Unix doesn't give us a right way to do it.
2398 Opening with O_WRONLY could work for an ordinary file,
2399 but would lose for directories. */
2400 return (access (filename
, 2) >= 0);
2402 #endif /* not MSDOS */
2405 DEFUE ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2406 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2407 See also `file-readable-p' and `file-attributes'.
2408 This returns nil for a symlink to a nonexistent file.
2409 Use `file-symlink-p' to test for such links. */)
2410 (Lisp_Object filename
)
2412 Lisp_Object absname
;
2413 Lisp_Object handler
;
2414 struct stat statbuf
;
2416 CHECK_STRING (filename
);
2417 absname
= Fexpand_file_name (filename
, Qnil
);
2419 /* If the file name has special constructs in it,
2420 call the corresponding file handler. */
2421 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2422 if (!NILP (handler
))
2423 return call2 (handler
, Qfile_exists_p
, absname
);
2425 absname
= ENCODE_FILE (absname
);
2427 return (stat (SSDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2430 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2431 doc
: /* Return t if FILENAME can be executed by you.
2432 For a directory, this means you can access files in that directory. */)
2433 (Lisp_Object filename
)
2435 Lisp_Object absname
;
2436 Lisp_Object handler
;
2438 CHECK_STRING (filename
);
2439 absname
= Fexpand_file_name (filename
, Qnil
);
2441 /* If the file name has special constructs in it,
2442 call the corresponding file handler. */
2443 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2444 if (!NILP (handler
))
2445 return call2 (handler
, Qfile_executable_p
, absname
);
2447 absname
= ENCODE_FILE (absname
);
2449 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2452 DEFUE ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2453 doc
: /* Return t if file FILENAME exists and you can read it.
2454 See also `file-exists-p' and `file-attributes'. */)
2455 (Lisp_Object filename
)
2457 Lisp_Object absname
;
2458 Lisp_Object handler
;
2461 struct stat statbuf
;
2463 CHECK_STRING (filename
);
2464 absname
= Fexpand_file_name (filename
, Qnil
);
2466 /* If the file name has special constructs in it,
2467 call the corresponding file handler. */
2468 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2469 if (!NILP (handler
))
2470 return call2 (handler
, Qfile_readable_p
, absname
);
2472 absname
= ENCODE_FILE (absname
);
2474 #if defined(DOS_NT) || defined(macintosh)
2475 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2477 if (access (SDATA (absname
), 0) == 0)
2480 #else /* not DOS_NT and not macintosh */
2483 /* Opening a fifo without O_NONBLOCK can wait.
2484 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2485 except in the case of a fifo, on a system which handles it. */
2486 desc
= stat (SSDATA (absname
), &statbuf
);
2489 if (S_ISFIFO (statbuf
.st_mode
))
2490 flags
|= O_NONBLOCK
;
2492 desc
= emacs_open (SSDATA (absname
), flags
, 0);
2497 #endif /* not DOS_NT and not macintosh */
2500 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2502 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2503 doc
: /* Return t if file FILENAME can be written or created by you. */)
2504 (Lisp_Object filename
)
2506 Lisp_Object absname
, dir
, encoded
;
2507 Lisp_Object handler
;
2508 struct stat statbuf
;
2510 CHECK_STRING (filename
);
2511 absname
= Fexpand_file_name (filename
, Qnil
);
2513 /* If the file name has special constructs in it,
2514 call the corresponding file handler. */
2515 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2516 if (!NILP (handler
))
2517 return call2 (handler
, Qfile_writable_p
, absname
);
2519 encoded
= ENCODE_FILE (absname
);
2520 if (stat (SSDATA (encoded
), &statbuf
) >= 0)
2521 return (check_writable (SSDATA (encoded
))
2524 dir
= Ffile_name_directory (absname
);
2527 dir
= Fdirectory_file_name (dir
);
2530 dir
= ENCODE_FILE (dir
);
2532 /* The read-only attribute of the parent directory doesn't affect
2533 whether a file or directory can be created within it. Some day we
2534 should check ACLs though, which do affect this. */
2535 if (stat (SDATA (dir
), &statbuf
) < 0)
2537 return S_ISDIR (statbuf
.st_mode
) ? Qt
: Qnil
;
2539 return (check_writable (!NILP (dir
) ? SSDATA (dir
) : "")
2544 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2545 doc
: /* Access file FILENAME, and get an error if that does not work.
2546 The second argument STRING is used in the error message.
2547 If there is no error, returns nil. */)
2548 (Lisp_Object filename
, Lisp_Object string
)
2550 Lisp_Object handler
, encoded_filename
, absname
;
2553 CHECK_STRING (filename
);
2554 absname
= Fexpand_file_name (filename
, Qnil
);
2556 CHECK_STRING (string
);
2558 /* If the file name has special constructs in it,
2559 call the corresponding file handler. */
2560 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2561 if (!NILP (handler
))
2562 return call3 (handler
, Qaccess_file
, absname
, string
);
2564 encoded_filename
= ENCODE_FILE (absname
);
2566 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2568 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2574 DEFUE ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2575 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2576 The value is the link target, as a string.
2577 Otherwise it returns nil.
2579 This function returns t when given the name of a symlink that
2580 points to a nonexistent file. */)
2581 (Lisp_Object filename
)
2583 Lisp_Object handler
;
2586 char readlink_buf
[READLINK_BUFSIZE
];
2588 CHECK_STRING (filename
);
2589 filename
= Fexpand_file_name (filename
, Qnil
);
2591 /* If the file name has special constructs in it,
2592 call the corresponding file handler. */
2593 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2594 if (!NILP (handler
))
2595 return call2 (handler
, Qfile_symlink_p
, filename
);
2597 filename
= ENCODE_FILE (filename
);
2599 buf
= emacs_readlink (SSDATA (filename
), readlink_buf
);
2603 val
= build_string (buf
);
2604 if (buf
[0] == '/' && strchr (buf
, ':'))
2605 val
= concat2 (build_string ("/:"), val
);
2606 if (buf
!= readlink_buf
)
2608 val
= DECODE_FILE (val
);
2612 DEFUE ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2613 doc
: /* Return t if FILENAME names an existing directory.
2614 Symbolic links to directories count as directories.
2615 See `file-symlink-p' to distinguish symlinks. */)
2616 (Lisp_Object filename
)
2618 register Lisp_Object absname
;
2620 Lisp_Object handler
;
2622 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2624 /* If the file name has special constructs in it,
2625 call the corresponding file handler. */
2626 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2627 if (!NILP (handler
))
2628 return call2 (handler
, Qfile_directory_p
, absname
);
2630 absname
= ENCODE_FILE (absname
);
2632 if (stat (SSDATA (absname
), &st
) < 0)
2634 return S_ISDIR (st
.st_mode
) ? Qt
: Qnil
;
2637 DEFUE ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2638 Sfile_accessible_directory_p
, 1, 1, 0,
2639 doc
: /* Return t if file FILENAME names a directory you can open.
2640 For the value to be t, FILENAME must specify the name of a directory as a file,
2641 and the directory must allow you to open files in it. In order to use a
2642 directory as a buffer's current directory, this predicate must return true.
2643 A directory name spec may be given instead; then the value is t
2644 if the directory so specified exists and really is a readable and
2645 searchable directory. */)
2646 (Lisp_Object filename
)
2648 Lisp_Object handler
;
2650 struct gcpro gcpro1
;
2652 /* If the file name has special constructs in it,
2653 call the corresponding file handler. */
2654 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2655 if (!NILP (handler
))
2656 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2659 tem
= (NILP (Ffile_directory_p (filename
))
2660 || NILP (Ffile_executable_p (filename
)));
2662 return tem
? Qnil
: Qt
;
2665 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2666 doc
: /* Return t if FILENAME names a regular file.
2667 This is the sort of file that holds an ordinary stream of data bytes.
2668 Symbolic links to regular files count as regular files.
2669 See `file-symlink-p' to distinguish symlinks. */)
2670 (Lisp_Object filename
)
2672 register Lisp_Object absname
;
2674 Lisp_Object handler
;
2676 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2678 /* If the file name has special constructs in it,
2679 call the corresponding file handler. */
2680 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2681 if (!NILP (handler
))
2682 return call2 (handler
, Qfile_regular_p
, absname
);
2684 absname
= ENCODE_FILE (absname
);
2689 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2691 /* Tell stat to use expensive method to get accurate info. */
2692 Vw32_get_true_file_attributes
= Qt
;
2693 result
= stat (SDATA (absname
), &st
);
2694 Vw32_get_true_file_attributes
= tem
;
2698 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2701 if (stat (SSDATA (absname
), &st
) < 0)
2703 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2707 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2708 Sfile_selinux_context
, 1, 1, 0,
2709 doc
: /* Return SELinux context of file named FILENAME,
2710 as a list ("user", "role", "type", "range"). Return (nil, nil, nil, nil)
2711 if file does not exist, is not accessible, or SELinux is disabled */)
2712 (Lisp_Object filename
)
2714 Lisp_Object absname
;
2715 Lisp_Object values
[4];
2716 Lisp_Object handler
;
2718 security_context_t con
;
2723 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2725 /* If the file name has special constructs in it,
2726 call the corresponding file handler. */
2727 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2728 if (!NILP (handler
))
2729 return call2 (handler
, Qfile_selinux_context
, absname
);
2731 absname
= ENCODE_FILE (absname
);
2738 if (is_selinux_enabled ())
2740 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2743 context
= context_new (con
);
2744 if (context_user_get (context
))
2745 values
[0] = build_string (context_user_get (context
));
2746 if (context_role_get (context
))
2747 values
[1] = build_string (context_role_get (context
));
2748 if (context_type_get (context
))
2749 values
[2] = build_string (context_type_get (context
));
2750 if (context_range_get (context
))
2751 values
[3] = build_string (context_range_get (context
));
2752 context_free (context
);
2759 return Flist (sizeof(values
) / sizeof(values
[0]), values
);
2762 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2763 Sset_file_selinux_context
, 2, 2, 0,
2764 doc
: /* Set SELinux context of file named FILENAME to CONTEXT
2765 as a list ("user", "role", "type", "range"). Has no effect if SELinux
2767 (Lisp_Object filename
, Lisp_Object context
)
2769 Lisp_Object absname
;
2770 Lisp_Object handler
;
2772 Lisp_Object encoded_absname
;
2773 Lisp_Object user
= CAR_SAFE (context
);
2774 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2775 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2776 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2777 security_context_t con
;
2778 int fail
, conlength
;
2779 context_t parsed_con
;
2782 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2784 /* If the file name has special constructs in it,
2785 call the corresponding file handler. */
2786 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2787 if (!NILP (handler
))
2788 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2791 if (is_selinux_enabled ())
2793 /* Get current file context. */
2794 encoded_absname
= ENCODE_FILE (absname
);
2795 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2798 parsed_con
= context_new (con
);
2799 /* Change the parts defined in the parameter.*/
2802 if (context_user_set (parsed_con
, SSDATA (user
)))
2803 error ("Doing context_user_set");
2807 if (context_role_set (parsed_con
, SSDATA (role
)))
2808 error ("Doing context_role_set");
2812 if (context_type_set (parsed_con
, SSDATA (type
)))
2813 error ("Doing context_type_set");
2815 if (STRINGP (range
))
2817 if (context_range_set (parsed_con
, SSDATA (range
)))
2818 error ("Doing context_range_set");
2821 /* Set the modified context back to the file. */
2822 fail
= lsetfilecon (SSDATA (encoded_absname
),
2823 context_str (parsed_con
));
2825 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
2827 context_free (parsed_con
);
2830 report_file_error("Doing lgetfilecon", Fcons (absname
, Qnil
));
2840 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2841 doc
: /* Return mode bits of file named FILENAME, as an integer.
2842 Return nil, if file does not exist or is not accessible. */)
2843 (Lisp_Object filename
)
2845 Lisp_Object absname
;
2847 Lisp_Object handler
;
2849 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2851 /* If the file name has special constructs in it,
2852 call the corresponding file handler. */
2853 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2854 if (!NILP (handler
))
2855 return call2 (handler
, Qfile_modes
, absname
);
2857 absname
= ENCODE_FILE (absname
);
2859 if (stat (SSDATA (absname
), &st
) < 0)
2862 return make_number (st
.st_mode
& 07777);
2865 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2866 "(let ((file (read-file-name \"File: \"))) \
2867 (list file (read-file-modes nil file)))",
2868 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2869 Only the 12 low bits of MODE are used.
2871 Interactively, mode bits are read by `read-file-modes', which accepts
2872 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2873 (Lisp_Object filename
, Lisp_Object mode
)
2875 Lisp_Object absname
, encoded_absname
;
2876 Lisp_Object handler
;
2878 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2879 CHECK_NUMBER (mode
);
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_modes
);
2884 if (!NILP (handler
))
2885 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2887 encoded_absname
= ENCODE_FILE (absname
);
2889 if (chmod (SSDATA (encoded_absname
), XINT (mode
)) < 0)
2890 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2895 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2896 doc
: /* Set the file permission bits for newly created files.
2897 The argument MODE should be an integer; only the low 9 bits are used.
2898 This setting is inherited by subprocesses. */)
2901 CHECK_NUMBER (mode
);
2903 umask ((~ XINT (mode
)) & 0777);
2908 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
2909 doc
: /* Return the default file protection for created files.
2910 The value is an integer. */)
2916 realmask
= umask (0);
2919 XSETINT (value
, (~ realmask
) & 0777);
2924 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
2925 doc
: /* Set times of file FILENAME to TIMESTAMP.
2926 Set both access and modification times.
2927 Return t on success, else nil.
2928 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
2930 (Lisp_Object filename
, Lisp_Object timestamp
)
2932 Lisp_Object absname
, encoded_absname
;
2933 Lisp_Object handler
;
2937 if (! lisp_time_argument (timestamp
, &sec
, &usec
))
2938 error ("Invalid time specification");
2940 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2942 /* If the file name has special constructs in it,
2943 call the corresponding file handler. */
2944 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
2945 if (!NILP (handler
))
2946 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
2948 encoded_absname
= ENCODE_FILE (absname
);
2953 EMACS_SET_SECS (t
, sec
);
2954 EMACS_SET_USECS (t
, usec
);
2956 if (set_file_times (SSDATA (encoded_absname
), t
, t
))
2961 /* Setting times on a directory always fails. */
2962 if (stat (SSDATA (encoded_absname
), &st
) == 0 && S_ISDIR (st
.st_mode
))
2965 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
2974 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
2975 doc
: /* Tell Unix to finish all pending disk updates. */)
2982 #endif /* HAVE_SYNC */
2984 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
2985 doc
: /* Return t if file FILE1 is newer than file FILE2.
2986 If FILE1 does not exist, the answer is nil;
2987 otherwise, if FILE2 does not exist, the answer is t. */)
2988 (Lisp_Object file1
, Lisp_Object file2
)
2990 Lisp_Object absname1
, absname2
;
2993 Lisp_Object handler
;
2994 struct gcpro gcpro1
, gcpro2
;
2996 CHECK_STRING (file1
);
2997 CHECK_STRING (file2
);
3000 GCPRO2 (absname1
, file2
);
3001 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3002 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3005 /* If the file name has special constructs in it,
3006 call the corresponding file handler. */
3007 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3009 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3010 if (!NILP (handler
))
3011 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3013 GCPRO2 (absname1
, absname2
);
3014 absname1
= ENCODE_FILE (absname1
);
3015 absname2
= ENCODE_FILE (absname2
);
3018 if (stat (SSDATA (absname1
), &st
) < 0)
3021 mtime1
= st
.st_mtime
;
3023 if (stat (SSDATA (absname2
), &st
) < 0)
3026 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3029 #ifndef READ_BUF_SIZE
3030 #define READ_BUF_SIZE (64 << 10)
3033 /* This function is called after Lisp functions to decide a coding
3034 system are called, or when they cause an error. Before they are
3035 called, the current buffer is set unibyte and it contains only a
3036 newly inserted text (thus the buffer was empty before the
3039 The functions may set markers, overlays, text properties, or even
3040 alter the buffer contents, change the current buffer.
3042 Here, we reset all those changes by:
3043 o set back the current buffer.
3044 o move all markers and overlays to BEG.
3045 o remove all text properties.
3046 o set back the buffer multibyteness. */
3049 decide_coding_unwind (Lisp_Object unwind_data
)
3051 Lisp_Object multibyte
, undo_list
, buffer
;
3053 multibyte
= XCAR (unwind_data
);
3054 unwind_data
= XCDR (unwind_data
);
3055 undo_list
= XCAR (unwind_data
);
3056 buffer
= XCDR (unwind_data
);
3058 if (current_buffer
!= XBUFFER (buffer
))
3059 set_buffer_internal (XBUFFER (buffer
));
3060 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3061 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3062 BUF_INTERVALS (current_buffer
) = 0;
3063 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3065 /* Now we are safe to change the buffer's multibyteness directly. */
3066 BVAR (current_buffer
, enable_multibyte_characters
) = multibyte
;
3067 BVAR (current_buffer
, undo_list
) = undo_list
;
3073 /* Used to pass values from insert-file-contents to read_non_regular. */
3075 static int non_regular_fd
;
3076 static EMACS_INT non_regular_inserted
;
3077 static EMACS_INT non_regular_nbytes
;
3080 /* Read from a non-regular file.
3081 Read non_regular_nbytes bytes max from non_regular_fd.
3082 Non_regular_inserted specifies where to put the read bytes.
3083 Value is the number of bytes read. */
3086 read_non_regular (Lisp_Object ignore
)
3092 nbytes
= emacs_read (non_regular_fd
,
3093 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3094 + non_regular_inserted
),
3095 non_regular_nbytes
);
3097 return make_number (nbytes
);
3101 /* Condition-case handler used when reading from non-regular files
3102 in insert-file-contents. */
3105 read_non_regular_quit (Lisp_Object ignore
)
3111 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3113 doc
: /* Insert contents of file FILENAME after point.
3114 Returns list of absolute file name and number of characters inserted.
3115 If second argument VISIT is non-nil, the buffer's visited filename and
3116 last save file modtime are set, and it is marked unmodified. If
3117 visiting and the file does not exist, visiting is completed before the
3120 The optional third and fourth arguments BEG and END specify what portion
3121 of the file to insert. These arguments count bytes in the file, not
3122 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3124 If optional fifth argument REPLACE is non-nil, replace the current
3125 buffer contents (in the accessible portion) with the file contents.
3126 This is better than simply deleting and inserting the whole thing
3127 because (1) it preserves some marker positions and (2) it puts less data
3128 in the undo list. When REPLACE is non-nil, the second return value is
3129 the number of characters that replace previous buffer contents.
3131 This function does code conversion according to the value of
3132 `coding-system-for-read' or `file-coding-system-alist', and sets the
3133 variable `last-coding-system-used' to the coding system actually used. */)
3134 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3138 EMACS_INT inserted
= 0;
3140 register EMACS_INT how_much
;
3141 register EMACS_INT unprocessed
;
3142 int count
= SPECPDL_INDEX ();
3143 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3144 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3146 EMACS_INT total
= 0;
3147 int not_regular
= 0;
3148 char read_buf
[READ_BUF_SIZE
];
3149 struct coding_system coding
;
3150 char buffer
[1 << 14];
3151 int replace_handled
= 0;
3152 int set_coding_system
= 0;
3153 Lisp_Object coding_system
;
3155 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3156 int we_locked_file
= 0;
3157 int deferred_remove_unwind_protect
= 0;
3159 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3160 error ("Cannot do file visiting in an indirect buffer");
3162 if (!NILP (BVAR (current_buffer
, read_only
)))
3163 Fbarf_if_buffer_read_only ();
3167 orig_filename
= Qnil
;
3170 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3172 CHECK_STRING (filename
);
3173 filename
= Fexpand_file_name (filename
, Qnil
);
3175 /* The value Qnil means that the coding system is not yet
3177 coding_system
= Qnil
;
3179 /* If the file name has special constructs in it,
3180 call the corresponding file handler. */
3181 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3182 if (!NILP (handler
))
3184 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3185 visit
, beg
, end
, replace
);
3186 if (CONSP (val
) && CONSP (XCDR (val
)))
3187 inserted
= XINT (XCAR (XCDR (val
)));
3191 orig_filename
= filename
;
3192 filename
= ENCODE_FILE (filename
);
3198 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3200 /* Tell stat to use expensive method to get accurate info. */
3201 Vw32_get_true_file_attributes
= Qt
;
3202 total
= stat (SSDATA (filename
), &st
);
3203 Vw32_get_true_file_attributes
= tem
;
3207 if (stat (SSDATA (filename
), &st
) < 0)
3208 #endif /* WINDOWSNT */
3212 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3215 if (!NILP (Vcoding_system_for_read
))
3216 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3220 /* This code will need to be changed in order to work on named
3221 pipes, and it's probably just not worth it. So we should at
3222 least signal an error. */
3223 if (!S_ISREG (st
.st_mode
))
3230 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3231 xsignal2 (Qfile_error
,
3232 build_string ("not a regular file"), orig_filename
);
3236 if ((fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0)) < 0)
3239 /* Replacement should preserve point as it preserves markers. */
3240 if (!NILP (replace
))
3241 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3243 record_unwind_protect (close_file_unwind
, make_number (fd
));
3246 /* Arithmetic overflow can occur if an Emacs integer cannot represent the
3247 file size, or if the calculations below overflow. The calculations below
3248 double the file size twice, so check that it can be multiplied by 4
3251 Also check whether the size is negative, which can happen on a platform
3252 that allows file sizes greater than the maximum off_t value. */
3254 && ! (0 <= st
.st_size
&& st
.st_size
<= MOST_POSITIVE_FIXNUM
/ 4))
3255 error ("Maximum buffer size exceeded");
3257 /* Prevent redisplay optimizations. */
3258 current_buffer
->clip_changed
= 1;
3262 if (!NILP (beg
) || !NILP (end
))
3263 error ("Attempt to visit less than an entire file");
3264 if (BEG
< Z
&& NILP (replace
))
3265 error ("Cannot do file visiting in a non-empty buffer");
3271 XSETFASTINT (beg
, 0);
3279 XSETINT (end
, st
.st_size
);
3281 /* The file size returned from stat may be zero, but data
3282 may be readable nonetheless, for example when this is a
3283 file in the /proc filesystem. */
3284 if (st
.st_size
== 0)
3285 XSETINT (end
, READ_BUF_SIZE
);
3289 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3291 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3292 setup_coding_system (coding_system
, &coding
);
3293 /* Ensure we set Vlast_coding_system_used. */
3294 set_coding_system
= 1;
3298 /* Decide the coding system to use for reading the file now
3299 because we can't use an optimized method for handling
3300 `coding:' tag if the current buffer is not empty. */
3301 if (!NILP (Vcoding_system_for_read
))
3302 coding_system
= Vcoding_system_for_read
;
3305 /* Don't try looking inside a file for a coding system
3306 specification if it is not seekable. */
3307 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3309 /* Find a coding system specified in the heading two
3310 lines or in the tailing several lines of the file.
3311 We assume that the 1K-byte and 3K-byte for heading
3312 and tailing respectively are sufficient for this
3316 if (st
.st_size
<= (1024 * 4))
3317 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3320 nread
= emacs_read (fd
, read_buf
, 1024);
3323 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3324 report_file_error ("Setting file position",
3325 Fcons (orig_filename
, Qnil
));
3326 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3331 error ("IO error reading %s: %s",
3332 SDATA (orig_filename
), emacs_strerror (errno
));
3335 struct buffer
*prev
= current_buffer
;
3336 Lisp_Object workbuf
;
3339 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3341 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3342 buf
= XBUFFER (workbuf
);
3344 delete_all_overlays (buf
);
3345 BVAR (buf
, directory
) = BVAR (current_buffer
, directory
);
3346 BVAR (buf
, read_only
) = Qnil
;
3347 BVAR (buf
, filename
) = Qnil
;
3348 BVAR (buf
, undo_list
) = Qt
;
3349 eassert (buf
->overlays_before
== NULL
);
3350 eassert (buf
->overlays_after
== NULL
);
3352 set_buffer_internal (buf
);
3354 BVAR (buf
, enable_multibyte_characters
) = Qnil
;
3356 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3357 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3358 coding_system
= call2 (Vset_auto_coding_function
,
3359 filename
, make_number (nread
));
3360 set_buffer_internal (prev
);
3362 /* Discard the unwind protect for recovering the
3366 /* Rewind the file for the actual read done later. */
3367 if (lseek (fd
, 0, 0) < 0)
3368 report_file_error ("Setting file position",
3369 Fcons (orig_filename
, Qnil
));
3373 if (NILP (coding_system
))
3375 /* If we have not yet decided a coding system, check
3376 file-coding-system-alist. */
3377 Lisp_Object args
[6];
3379 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3380 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3381 coding_system
= Ffind_operation_coding_system (6, args
);
3382 if (CONSP (coding_system
))
3383 coding_system
= XCAR (coding_system
);
3387 if (NILP (coding_system
))
3388 coding_system
= Qundecided
;
3390 CHECK_CODING_SYSTEM (coding_system
);
3392 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3393 /* We must suppress all character code conversion except for
3394 end-of-line conversion. */
3395 coding_system
= raw_text_coding_system (coding_system
);
3397 setup_coding_system (coding_system
, &coding
);
3398 /* Ensure we set Vlast_coding_system_used. */
3399 set_coding_system
= 1;
3402 /* If requested, replace the accessible part of the buffer
3403 with the file contents. Avoid replacing text at the
3404 beginning or end of the buffer that matches the file contents;
3405 that preserves markers pointing to the unchanged parts.
3407 Here we implement this feature in an optimized way
3408 for the case where code conversion is NOT needed.
3409 The following if-statement handles the case of conversion
3410 in a less optimal way.
3412 If the code conversion is "automatic" then we try using this
3413 method and hope for the best.
3414 But if we discover the need for conversion, we give up on this method
3415 and let the following if-statement handle the replace job. */
3418 && (NILP (coding_system
)
3419 || ! CODING_REQUIRE_DECODING (&coding
)))
3421 /* same_at_start and same_at_end count bytes,
3422 because file access counts bytes
3423 and BEG and END count bytes. */
3424 EMACS_INT same_at_start
= BEGV_BYTE
;
3425 EMACS_INT same_at_end
= ZV_BYTE
;
3427 /* There is still a possibility we will find the need to do code
3428 conversion. If that happens, we set this variable to 1 to
3429 give up on handling REPLACE in the optimized way. */
3430 int giveup_match_end
= 0;
3432 if (XINT (beg
) != 0)
3434 if (lseek (fd
, XINT (beg
), 0) < 0)
3435 report_file_error ("Setting file position",
3436 Fcons (orig_filename
, Qnil
));
3441 /* Count how many chars at the start of the file
3442 match the text at the beginning of the buffer. */
3445 EMACS_INT nread
, bufpos
;
3447 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3449 error ("IO error reading %s: %s",
3450 SSDATA (orig_filename
), emacs_strerror (errno
));
3451 else if (nread
== 0)
3454 if (CODING_REQUIRE_DETECTION (&coding
))
3456 coding_system
= detect_coding_system ((unsigned char *) buffer
,
3459 setup_coding_system (coding_system
, &coding
);
3462 if (CODING_REQUIRE_DECODING (&coding
))
3463 /* We found that the file should be decoded somehow.
3464 Let's give up here. */
3466 giveup_match_end
= 1;
3471 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3472 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3473 same_at_start
++, bufpos
++;
3474 /* If we found a discrepancy, stop the scan.
3475 Otherwise loop around and scan the next bufferful. */
3476 if (bufpos
!= nread
)
3480 /* If the file matches the buffer completely,
3481 there's no need to replace anything. */
3482 if (same_at_start
- BEGV_BYTE
== XINT (end
))
3486 /* Truncate the buffer to the size of the file. */
3487 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3492 /* Count how many chars at the end of the file
3493 match the text at the end of the buffer. But, if we have
3494 already found that decoding is necessary, don't waste time. */
3495 while (!giveup_match_end
)
3497 EMACS_INT total_read
, nread
, bufpos
, curpos
, trial
;
3499 /* At what file position are we now scanning? */
3500 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
3501 /* If the entire file matches the buffer tail, stop the scan. */
3504 /* How much can we scan in the next step? */
3505 trial
= min (curpos
, sizeof buffer
);
3506 if (lseek (fd
, curpos
- trial
, 0) < 0)
3507 report_file_error ("Setting file position",
3508 Fcons (orig_filename
, Qnil
));
3510 total_read
= nread
= 0;
3511 while (total_read
< trial
)
3513 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3515 error ("IO error reading %s: %s",
3516 SDATA (orig_filename
), emacs_strerror (errno
));
3517 else if (nread
== 0)
3519 total_read
+= nread
;
3522 /* Scan this bufferful from the end, comparing with
3523 the Emacs buffer. */
3524 bufpos
= total_read
;
3526 /* Compare with same_at_start to avoid counting some buffer text
3527 as matching both at the file's beginning and at the end. */
3528 while (bufpos
> 0 && same_at_end
> same_at_start
3529 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3530 same_at_end
--, bufpos
--;
3532 /* If we found a discrepancy, stop the scan.
3533 Otherwise loop around and scan the preceding bufferful. */
3536 /* If this discrepancy is because of code conversion,
3537 we cannot use this method; giveup and try the other. */
3538 if (same_at_end
> same_at_start
3539 && FETCH_BYTE (same_at_end
- 1) >= 0200
3540 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3541 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3542 giveup_match_end
= 1;
3551 if (! giveup_match_end
)
3555 /* We win! We can handle REPLACE the optimized way. */
3557 /* Extend the start of non-matching text area to multibyte
3558 character boundary. */
3559 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3560 while (same_at_start
> BEGV_BYTE
3561 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3564 /* Extend the end of non-matching text area to multibyte
3565 character boundary. */
3566 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3567 while (same_at_end
< ZV_BYTE
3568 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3571 /* Don't try to reuse the same piece of text twice. */
3572 overlap
= (same_at_start
- BEGV_BYTE
3573 - (same_at_end
+ st
.st_size
- ZV
));
3575 same_at_end
+= overlap
;
3577 /* Arrange to read only the nonmatching middle part of the file. */
3578 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
3579 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
3581 del_range_byte (same_at_start
, same_at_end
, 0);
3582 /* Insert from the file at the proper position. */
3583 temp
= BYTE_TO_CHAR (same_at_start
);
3584 SET_PT_BOTH (temp
, same_at_start
);
3586 /* If display currently starts at beginning of line,
3587 keep it that way. */
3588 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3589 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3591 replace_handled
= 1;
3595 /* If requested, replace the accessible part of the buffer
3596 with the file contents. Avoid replacing text at the
3597 beginning or end of the buffer that matches the file contents;
3598 that preserves markers pointing to the unchanged parts.
3600 Here we implement this feature for the case where code conversion
3601 is needed, in a simple way that needs a lot of memory.
3602 The preceding if-statement handles the case of no conversion
3603 in a more optimized way. */
3604 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3606 EMACS_INT same_at_start
= BEGV_BYTE
;
3607 EMACS_INT same_at_end
= ZV_BYTE
;
3608 EMACS_INT same_at_start_charpos
;
3609 EMACS_INT inserted_chars
;
3612 unsigned char *decoded
;
3615 int this_count
= SPECPDL_INDEX ();
3616 int multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3617 Lisp_Object conversion_buffer
;
3619 conversion_buffer
= code_conversion_save (1, multibyte
);
3621 /* First read the whole file, performing code conversion into
3622 CONVERSION_BUFFER. */
3624 if (lseek (fd
, XINT (beg
), 0) < 0)
3625 report_file_error ("Setting file position",
3626 Fcons (orig_filename
, Qnil
));
3628 total
= st
.st_size
; /* Total bytes in the file. */
3629 how_much
= 0; /* Bytes read from file so far. */
3630 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3631 unprocessed
= 0; /* Bytes not processed in previous loop. */
3633 GCPRO1 (conversion_buffer
);
3634 while (how_much
< total
)
3636 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3637 quitting while reading a huge while. */
3638 /* try is reserved in some compilers (Microsoft C) */
3639 EMACS_INT trytry
= min (total
- how_much
,
3640 READ_BUF_SIZE
- unprocessed
);
3642 /* Allow quitting out of the actual I/O. */
3645 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3653 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3654 BUF_Z (XBUFFER (conversion_buffer
)));
3655 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3656 unprocessed
+ this, conversion_buffer
);
3657 unprocessed
= coding
.carryover_bytes
;
3658 if (coding
.carryover_bytes
> 0)
3659 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3664 /* We should remove the unwind_protect calling
3665 close_file_unwind, but other stuff has been added the stack,
3666 so defer the removal till we reach the `handled' label. */
3667 deferred_remove_unwind_protect
= 1;
3669 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3670 if we couldn't read the file. */
3673 error ("IO error reading %s: %s",
3674 SDATA (orig_filename
), emacs_strerror (errno
));
3676 if (unprocessed
> 0)
3678 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3679 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3680 unprocessed
, conversion_buffer
);
3681 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3684 coding_system
= CODING_ID_NAME (coding
.id
);
3685 set_coding_system
= 1;
3686 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3687 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3688 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3690 /* Compare the beginning of the converted string with the buffer
3694 while (bufpos
< inserted
&& same_at_start
< same_at_end
3695 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3696 same_at_start
++, bufpos
++;
3698 /* If the file matches the head of buffer completely,
3699 there's no need to replace anything. */
3701 if (bufpos
== inserted
)
3703 /* Truncate the buffer to the size of the file. */
3704 if (same_at_start
== same_at_end
)
3707 del_range_byte (same_at_start
, same_at_end
, 0);
3710 unbind_to (this_count
, Qnil
);
3714 /* Extend the start of non-matching text area to the previous
3715 multibyte character boundary. */
3716 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3717 while (same_at_start
> BEGV_BYTE
3718 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3721 /* Scan this bufferful from the end, comparing with
3722 the Emacs buffer. */
3725 /* Compare with same_at_start to avoid counting some buffer text
3726 as matching both at the file's beginning and at the end. */
3727 while (bufpos
> 0 && same_at_end
> same_at_start
3728 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3729 same_at_end
--, bufpos
--;
3731 /* Extend the end of non-matching text area to the next
3732 multibyte character boundary. */
3733 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3734 while (same_at_end
< ZV_BYTE
3735 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3738 /* Don't try to reuse the same piece of text twice. */
3739 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3741 same_at_end
+= overlap
;
3743 /* If display currently starts at beginning of line,
3744 keep it that way. */
3745 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3746 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3748 /* Replace the chars that we need to replace,
3749 and update INSERTED to equal the number of bytes
3750 we are taking from the decoded string. */
3751 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3753 if (same_at_end
!= same_at_start
)
3755 del_range_byte (same_at_start
, same_at_end
, 0);
3757 same_at_start
= GPT_BYTE
;
3761 temp
= BYTE_TO_CHAR (same_at_start
);
3763 /* Insert from the file at the proper position. */
3764 SET_PT_BOTH (temp
, same_at_start
);
3765 same_at_start_charpos
3766 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3767 same_at_start
- BEGV_BYTE
3768 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3770 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3771 same_at_start
+ inserted
- BEGV_BYTE
3772 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3773 - same_at_start_charpos
);
3774 /* This binding is to avoid ask-user-about-supersession-threat
3775 being called in insert_from_buffer (via in
3776 prepare_to_modify_buffer). */
3777 specbind (intern ("buffer-file-name"), Qnil
);
3778 insert_from_buffer (XBUFFER (conversion_buffer
),
3779 same_at_start_charpos
, inserted_chars
, 0);
3780 /* Set `inserted' to the number of inserted characters. */
3781 inserted
= PT
- temp
;
3782 /* Set point before the inserted characters. */
3783 SET_PT_BOTH (temp
, same_at_start
);
3785 unbind_to (this_count
, Qnil
);
3792 register Lisp_Object temp
;
3794 total
= XINT (end
) - XINT (beg
);
3796 /* Make sure point-max won't overflow after this insertion. */
3797 XSETINT (temp
, total
);
3798 if (total
!= XINT (temp
))
3799 error ("Maximum buffer size exceeded");
3802 /* For a special file, all we can do is guess. */
3803 total
= READ_BUF_SIZE
;
3805 if (NILP (visit
) && inserted
> 0)
3807 #ifdef CLASH_DETECTION
3808 if (!NILP (BVAR (current_buffer
, file_truename
))
3809 /* Make binding buffer-file-name to nil effective. */
3810 && !NILP (BVAR (current_buffer
, filename
))
3811 && SAVE_MODIFF
>= MODIFF
)
3813 #endif /* CLASH_DETECTION */
3814 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3818 if (GAP_SIZE
< total
)
3819 make_gap (total
- GAP_SIZE
);
3821 if (XINT (beg
) != 0 || !NILP (replace
))
3823 if (lseek (fd
, XINT (beg
), 0) < 0)
3824 report_file_error ("Setting file position",
3825 Fcons (orig_filename
, Qnil
));
3828 /* In the following loop, HOW_MUCH contains the total bytes read so
3829 far for a regular file, and not changed for a special file. But,
3830 before exiting the loop, it is set to a negative value if I/O
3834 /* Total bytes inserted. */
3837 /* Here, we don't do code conversion in the loop. It is done by
3838 decode_coding_gap after all data are read into the buffer. */
3840 EMACS_INT gap_size
= GAP_SIZE
;
3842 while (how_much
< total
)
3844 /* try is reserved in some compilers (Microsoft C) */
3845 EMACS_INT trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3852 /* Maybe make more room. */
3853 if (gap_size
< trytry
)
3855 make_gap (total
- gap_size
);
3856 gap_size
= GAP_SIZE
;
3859 /* Read from the file, capturing `quit'. When an
3860 error occurs, end the loop, and arrange for a quit
3861 to be signaled after decoding the text we read. */
3862 non_regular_fd
= fd
;
3863 non_regular_inserted
= inserted
;
3864 non_regular_nbytes
= trytry
;
3865 nbytes
= internal_condition_case_1 (read_non_regular
,
3867 read_non_regular_quit
);
3874 this = XINT (nbytes
);
3878 /* Allow quitting out of the actual I/O. We don't make text
3879 part of the buffer until all the reading is done, so a C-g
3880 here doesn't do any harm. */
3883 this = emacs_read (fd
,
3884 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3898 /* For a regular file, where TOTAL is the real size,
3899 count HOW_MUCH to compare with it.
3900 For a special file, where TOTAL is just a buffer size,
3901 so don't bother counting in HOW_MUCH.
3902 (INSERTED is where we count the number of characters inserted.) */
3909 /* Now we have read all the file data into the gap.
3910 If it was empty, undo marking the buffer modified. */
3914 #ifdef CLASH_DETECTION
3916 unlock_file (BVAR (current_buffer
, file_truename
));
3918 Vdeactivate_mark
= old_Vdeactivate_mark
;
3921 Vdeactivate_mark
= Qt
;
3923 /* Make the text read part of the buffer. */
3924 GAP_SIZE
-= inserted
;
3926 GPT_BYTE
+= inserted
;
3928 ZV_BYTE
+= inserted
;
3933 /* Put an anchor to ensure multi-byte form ends at gap. */
3938 /* Discard the unwind protect for closing the file. */
3942 error ("IO error reading %s: %s",
3943 SDATA (orig_filename
), emacs_strerror (errno
));
3947 if (NILP (coding_system
))
3949 /* The coding system is not yet decided. Decide it by an
3950 optimized method for handling `coding:' tag.
3952 Note that we can get here only if the buffer was empty
3953 before the insertion. */
3955 if (!NILP (Vcoding_system_for_read
))
3956 coding_system
= Vcoding_system_for_read
;
3959 /* Since we are sure that the current buffer was empty
3960 before the insertion, we can toggle
3961 enable-multibyte-characters directly here without taking
3962 care of marker adjustment. By this way, we can run Lisp
3963 program safely before decoding the inserted text. */
3964 Lisp_Object unwind_data
;
3965 int count1
= SPECPDL_INDEX ();
3967 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
3968 Fcons (BVAR (current_buffer
, undo_list
),
3969 Fcurrent_buffer ()));
3970 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
3971 BVAR (current_buffer
, undo_list
) = Qt
;
3972 record_unwind_protect (decide_coding_unwind
, unwind_data
);
3974 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
3976 coding_system
= call2 (Vset_auto_coding_function
,
3977 filename
, make_number (inserted
));
3980 if (NILP (coding_system
))
3982 /* If the coding system is not yet decided, check
3983 file-coding-system-alist. */
3984 Lisp_Object args
[6];
3986 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3987 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
3988 coding_system
= Ffind_operation_coding_system (6, args
);
3989 if (CONSP (coding_system
))
3990 coding_system
= XCAR (coding_system
);
3992 unbind_to (count1
, Qnil
);
3993 inserted
= Z_BYTE
- BEG_BYTE
;
3996 if (NILP (coding_system
))
3997 coding_system
= Qundecided
;
3999 CHECK_CODING_SYSTEM (coding_system
);
4001 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4002 /* We must suppress all character code conversion except for
4003 end-of-line conversion. */
4004 coding_system
= raw_text_coding_system (coding_system
);
4005 setup_coding_system (coding_system
, &coding
);
4006 /* Ensure we set Vlast_coding_system_used. */
4007 set_coding_system
= 1;
4012 /* When we visit a file by raw-text, we change the buffer to
4014 if (CODING_FOR_UNIBYTE (&coding
)
4015 /* Can't do this if part of the buffer might be preserved. */
4017 /* Visiting a file with these coding system makes the buffer
4019 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
4022 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4023 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4024 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4026 move_gap_both (PT
, PT_BYTE
);
4027 GAP_SIZE
+= inserted
;
4028 ZV_BYTE
-= inserted
;
4032 decode_coding_gap (&coding
, inserted
, inserted
);
4033 inserted
= coding
.produced_char
;
4034 coding_system
= CODING_ID_NAME (coding
.id
);
4036 else if (inserted
> 0)
4037 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4040 /* Now INSERTED is measured in characters. */
4044 if (deferred_remove_unwind_protect
)
4045 /* If requested above, discard the unwind protect for closing the
4051 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4052 BVAR (current_buffer
, undo_list
) = Qnil
;
4056 current_buffer
->modtime
= st
.st_mtime
;
4057 current_buffer
->modtime_size
= st
.st_size
;
4058 BVAR (current_buffer
, filename
) = orig_filename
;
4061 SAVE_MODIFF
= MODIFF
;
4062 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4063 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4064 #ifdef CLASH_DETECTION
4067 if (!NILP (BVAR (current_buffer
, file_truename
)))
4068 unlock_file (BVAR (current_buffer
, file_truename
));
4069 unlock_file (filename
);
4071 #endif /* CLASH_DETECTION */
4073 xsignal2 (Qfile_error
,
4074 build_string ("not a regular file"), orig_filename
);
4077 if (set_coding_system
)
4078 Vlast_coding_system_used
= coding_system
;
4080 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4082 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4084 if (! NILP (insval
))
4086 CHECK_NUMBER (insval
);
4087 inserted
= XFASTINT (insval
);
4091 /* Decode file format. */
4094 /* Don't run point motion or modification hooks when decoding. */
4095 int count1
= SPECPDL_INDEX ();
4096 EMACS_INT old_inserted
= inserted
;
4097 specbind (Qinhibit_point_motion_hooks
, Qt
);
4098 specbind (Qinhibit_modification_hooks
, Qt
);
4100 /* Save old undo list and don't record undo for decoding. */
4101 old_undo
= BVAR (current_buffer
, undo_list
);
4102 BVAR (current_buffer
, undo_list
) = Qt
;
4106 insval
= call3 (Qformat_decode
,
4107 Qnil
, make_number (inserted
), visit
);
4108 CHECK_NUMBER (insval
);
4109 inserted
= XFASTINT (insval
);
4113 /* If REPLACE is non-nil and we succeeded in not replacing the
4114 beginning or end of the buffer text with the file's contents,
4115 call format-decode with `point' positioned at the beginning
4116 of the buffer and `inserted' equalling the number of
4117 characters in the buffer. Otherwise, format-decode might
4118 fail to correctly analyze the beginning or end of the buffer.
4119 Hence we temporarily save `point' and `inserted' here and
4120 restore `point' iff format-decode did not insert or delete
4121 any text. Otherwise we leave `point' at point-min. */
4122 EMACS_INT opoint
= PT
;
4123 EMACS_INT opoint_byte
= PT_BYTE
;
4124 EMACS_INT oinserted
= ZV
- BEGV
;
4125 int ochars_modiff
= CHARS_MODIFF
;
4127 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4128 insval
= call3 (Qformat_decode
,
4129 Qnil
, make_number (oinserted
), visit
);
4130 CHECK_NUMBER (insval
);
4131 if (ochars_modiff
== CHARS_MODIFF
)
4132 /* format_decode didn't modify buffer's characters => move
4133 point back to position before inserted text and leave
4134 value of inserted alone. */
4135 SET_PT_BOTH (opoint
, opoint_byte
);
4137 /* format_decode modified buffer's characters => consider
4138 entire buffer changed and leave point at point-min. */
4139 inserted
= XFASTINT (insval
);
4142 /* For consistency with format-decode call these now iff inserted > 0
4143 (martin 2007-06-28). */
4144 p
= Vafter_insert_file_functions
;
4149 insval
= call1 (XCAR (p
), make_number (inserted
));
4152 CHECK_NUMBER (insval
);
4153 inserted
= XFASTINT (insval
);
4158 /* For the rationale of this see the comment on
4159 format-decode above. */
4160 EMACS_INT opoint
= PT
;
4161 EMACS_INT opoint_byte
= PT_BYTE
;
4162 EMACS_INT oinserted
= ZV
- BEGV
;
4163 int ochars_modiff
= CHARS_MODIFF
;
4165 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4166 insval
= call1 (XCAR (p
), make_number (oinserted
));
4169 CHECK_NUMBER (insval
);
4170 if (ochars_modiff
== CHARS_MODIFF
)
4171 /* after_insert_file_functions didn't modify
4172 buffer's characters => move point back to
4173 position before inserted text and leave value of
4175 SET_PT_BOTH (opoint
, opoint_byte
);
4177 /* after_insert_file_functions did modify buffer's
4178 characters => consider entire buffer changed and
4179 leave point at point-min. */
4180 inserted
= XFASTINT (insval
);
4190 BVAR (current_buffer
, undo_list
) = old_undo
;
4191 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4193 /* Adjust the last undo record for the size change during
4194 the format conversion. */
4195 Lisp_Object tem
= XCAR (old_undo
);
4196 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4197 && INTEGERP (XCDR (tem
))
4198 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4199 XSETCDR (tem
, make_number (PT
+ inserted
));
4203 /* If undo_list was Qt before, keep it that way.
4204 Otherwise start with an empty undo_list. */
4205 BVAR (current_buffer
, undo_list
) = EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4207 unbind_to (count1
, Qnil
);
4210 /* Call after-change hooks for the inserted text, aside from the case
4211 of normal visiting (not with REPLACE), which is done in a new buffer
4212 "before" the buffer is changed. */
4213 if (inserted
> 0 && total
> 0
4214 && (NILP (visit
) || !NILP (replace
)))
4216 signal_after_change (PT
, 0, inserted
);
4217 update_compositions (PT
, PT
, CHECK_BORDER
);
4221 && current_buffer
->modtime
== -1)
4223 /* If visiting nonexistent file, return nil. */
4224 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4228 Fsignal (Qquit
, Qnil
);
4230 /* ??? Retval needs to be dealt with in all cases consistently. */
4232 val
= Fcons (orig_filename
,
4233 Fcons (make_number (inserted
),
4236 RETURN_UNGCPRO (unbind_to (count
, val
));
4239 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4242 build_annotations_unwind (Lisp_Object arg
)
4244 Vwrite_region_annotation_buffers
= arg
;
4248 /* Decide the coding-system to encode the data with. */
4251 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4252 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4253 struct coding_system
*coding
)
4256 Lisp_Object eol_parent
= Qnil
;
4259 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4260 BVAR (current_buffer
, auto_save_file_name
))))
4265 else if (!NILP (Vcoding_system_for_write
))
4267 val
= Vcoding_system_for_write
;
4268 if (coding_system_require_warning
4269 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4270 /* Confirm that VAL can surely encode the current region. */
4271 val
= call5 (Vselect_safe_coding_system_function
,
4272 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4277 /* If the variable `buffer-file-coding-system' is set locally,
4278 it means that the file was read with some kind of code
4279 conversion or the variable is explicitly set by users. We
4280 had better write it out with the same coding system even if
4281 `enable-multibyte-characters' is nil.
4283 If it is not set locally, we anyway have to convert EOL
4284 format if the default value of `buffer-file-coding-system'
4285 tells that it is not Unix-like (LF only) format. */
4286 int using_default_coding
= 0;
4287 int force_raw_text
= 0;
4289 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4291 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4294 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4300 /* Check file-coding-system-alist. */
4301 Lisp_Object args
[7], coding_systems
;
4303 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4304 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4306 coding_systems
= Ffind_operation_coding_system (7, args
);
4307 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4308 val
= XCDR (coding_systems
);
4313 /* If we still have not decided a coding system, use the
4314 default value of buffer-file-coding-system. */
4315 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4316 using_default_coding
= 1;
4319 if (! NILP (val
) && ! force_raw_text
)
4321 Lisp_Object spec
, attrs
;
4323 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4324 attrs
= AREF (spec
, 0);
4325 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4330 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4331 /* Confirm that VAL can surely encode the current region. */
4332 val
= call5 (Vselect_safe_coding_system_function
,
4333 start
, end
, val
, Qnil
, filename
);
4335 /* If the decided coding-system doesn't specify end-of-line
4336 format, we use that of
4337 `default-buffer-file-coding-system'. */
4338 if (! using_default_coding
4339 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4340 val
= (coding_inherit_eol_type
4341 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4343 /* If we decide not to encode text, use `raw-text' or one of its
4346 val
= raw_text_coding_system (val
);
4349 val
= coding_inherit_eol_type (val
, eol_parent
);
4350 setup_coding_system (val
, coding
);
4352 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4353 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4357 DEFUE ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4358 "r\nFWrite region to file: \ni\ni\ni\np",
4359 doc
: /* Write current region into specified file.
4360 When called from a program, requires three arguments:
4361 START, END and FILENAME. START and END are normally buffer positions
4362 specifying the part of the buffer to write.
4363 If START is nil, that means to use the entire buffer contents.
4364 If START is a string, then output that string to the file
4365 instead of any buffer contents; END is ignored.
4367 Optional fourth argument APPEND if non-nil means
4368 append to existing file contents (if any). If it is an integer,
4369 seek to that offset in the file before writing.
4370 Optional fifth argument VISIT, if t or a string, means
4371 set the last-save-file-modtime of buffer to this file's modtime
4372 and mark buffer not modified.
4373 If VISIT is a string, it is a second file name;
4374 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4375 VISIT is also the file name to lock and unlock for clash detection.
4376 If VISIT is neither t nor nil nor a string,
4377 that means do not display the \"Wrote file\" message.
4378 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4379 use for locking and unlocking, overriding FILENAME and VISIT.
4380 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4381 for an existing file with the same name. If MUSTBENEW is `excl',
4382 that means to get an error if the file already exists; never overwrite.
4383 If MUSTBENEW is neither nil nor `excl', that means ask for
4384 confirmation before overwriting, but do go ahead and overwrite the file
4385 if the user confirms.
4387 This does code conversion according to the value of
4388 `coding-system-for-write', `buffer-file-coding-system', or
4389 `file-coding-system-alist', and sets the variable
4390 `last-coding-system-used' to the coding system actually used.
4392 This calls `write-region-annotate-functions' at the start, and
4393 `write-region-post-annotation-function' at the end. */)
4394 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4401 int count
= SPECPDL_INDEX ();
4403 Lisp_Object handler
;
4404 Lisp_Object visit_file
;
4405 Lisp_Object annotations
;
4406 Lisp_Object encoded_filename
;
4407 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4408 int quietly
= !NILP (visit
);
4409 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4410 struct buffer
*given_buffer
;
4411 struct coding_system coding
;
4413 if (current_buffer
->base_buffer
&& visiting
)
4414 error ("Cannot do file visiting in an indirect buffer");
4416 if (!NILP (start
) && !STRINGP (start
))
4417 validate_region (&start
, &end
);
4420 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4422 filename
= Fexpand_file_name (filename
, Qnil
);
4424 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4425 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4427 if (STRINGP (visit
))
4428 visit_file
= Fexpand_file_name (visit
, Qnil
);
4430 visit_file
= filename
;
4432 if (NILP (lockname
))
4433 lockname
= visit_file
;
4437 /* If the file name has special constructs in it,
4438 call the corresponding file handler. */
4439 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4440 /* If FILENAME has no handler, see if VISIT has one. */
4441 if (NILP (handler
) && STRINGP (visit
))
4442 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4444 if (!NILP (handler
))
4447 val
= call6 (handler
, Qwrite_region
, start
, end
,
4448 filename
, append
, visit
);
4452 SAVE_MODIFF
= MODIFF
;
4453 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4454 BVAR (current_buffer
, filename
) = visit_file
;
4460 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4462 /* Special kludge to simplify auto-saving. */
4465 /* Do it later, so write-region-annotate-function can work differently
4466 if we save "the buffer" vs "a region".
4467 This is useful in tar-mode. --Stef
4468 XSETFASTINT (start, BEG);
4469 XSETFASTINT (end, Z); */
4473 record_unwind_protect (build_annotations_unwind
,
4474 Vwrite_region_annotation_buffers
);
4475 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4476 count1
= SPECPDL_INDEX ();
4478 given_buffer
= current_buffer
;
4480 if (!STRINGP (start
))
4482 annotations
= build_annotations (start
, end
);
4484 if (current_buffer
!= given_buffer
)
4486 XSETFASTINT (start
, BEGV
);
4487 XSETFASTINT (end
, ZV
);
4493 XSETFASTINT (start
, BEGV
);
4494 XSETFASTINT (end
, ZV
);
4499 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4501 /* Decide the coding-system to encode the data with.
4502 We used to make this choice before calling build_annotations, but that
4503 leads to problems when a write-annotate-function takes care of
4504 unsavable chars (as was the case with X-Symbol). */
4505 Vlast_coding_system_used
4506 = choose_write_coding_system (start
, end
, filename
,
4507 append
, visit
, lockname
, &coding
);
4509 #ifdef CLASH_DETECTION
4511 lock_file (lockname
);
4512 #endif /* CLASH_DETECTION */
4514 encoded_filename
= ENCODE_FILE (filename
);
4516 fn
= SSDATA (encoded_filename
);
4520 desc
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4521 #else /* not DOS_NT */
4522 desc
= emacs_open (fn
, O_WRONLY
, 0);
4523 #endif /* not DOS_NT */
4525 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4527 desc
= emacs_open (fn
,
4528 O_WRONLY
| O_CREAT
| O_BINARY
4529 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4530 S_IREAD
| S_IWRITE
);
4531 #else /* not DOS_NT */
4532 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4533 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4534 auto_saving
? auto_save_mode_bits
: 0666);
4535 #endif /* not DOS_NT */
4539 #ifdef CLASH_DETECTION
4541 if (!auto_saving
) unlock_file (lockname
);
4543 #endif /* CLASH_DETECTION */
4545 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4548 record_unwind_protect (close_file_unwind
, make_number (desc
));
4550 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4554 if (NUMBERP (append
))
4555 ret
= lseek (desc
, XINT (append
), 1);
4557 ret
= lseek (desc
, 0, 2);
4560 #ifdef CLASH_DETECTION
4561 if (!auto_saving
) unlock_file (lockname
);
4562 #endif /* CLASH_DETECTION */
4564 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4573 if (STRINGP (start
))
4575 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4576 &annotations
, &coding
);
4579 else if (XINT (start
) != XINT (end
))
4581 failure
= 0 > a_write (desc
, Qnil
,
4582 XINT (start
), XINT (end
) - XINT (start
),
4583 &annotations
, &coding
);
4588 /* If file was empty, still need to write the annotations */
4589 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4590 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4594 if (CODING_REQUIRE_FLUSHING (&coding
)
4595 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4598 /* We have to flush out a data. */
4599 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4600 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4607 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4608 Disk full in NFS may be reported here. */
4609 /* mib says that closing the file will try to write as fast as NFS can do
4610 it, and that means the fsync here is not crucial for autosave files. */
4611 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4613 /* If fsync fails with EINTR, don't treat that as serious. Also
4614 ignore EINVAL which happens when fsync is not supported on this
4616 if (errno
!= EINTR
&& errno
!= EINVAL
)
4617 failure
= 1, save_errno
= errno
;
4621 /* NFS can report a write failure now. */
4622 if (emacs_close (desc
) < 0)
4623 failure
= 1, save_errno
= errno
;
4627 /* Discard the unwind protect for close_file_unwind. */
4628 specpdl_ptr
= specpdl
+ count1
;
4630 /* Call write-region-post-annotation-function. */
4631 while (CONSP (Vwrite_region_annotation_buffers
))
4633 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4634 if (!NILP (Fbuffer_live_p (buf
)))
4637 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4638 call0 (Vwrite_region_post_annotation_function
);
4640 Vwrite_region_annotation_buffers
4641 = XCDR (Vwrite_region_annotation_buffers
);
4644 unbind_to (count
, Qnil
);
4646 #ifdef CLASH_DETECTION
4648 unlock_file (lockname
);
4649 #endif /* CLASH_DETECTION */
4651 /* Do this before reporting IO error
4652 to avoid a "file has changed on disk" warning on
4653 next attempt to save. */
4656 current_buffer
->modtime
= st
.st_mtime
;
4657 current_buffer
->modtime_size
= st
.st_size
;
4661 error ("IO error writing %s: %s", SDATA (filename
),
4662 emacs_strerror (save_errno
));
4666 SAVE_MODIFF
= MODIFF
;
4667 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4668 BVAR (current_buffer
, filename
) = visit_file
;
4669 update_mode_lines
++;
4674 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4675 BVAR (current_buffer
, auto_save_file_name
))))
4676 SAVE_MODIFF
= MODIFF
;
4682 message_with_string ((INTEGERP (append
)
4692 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4694 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4695 doc
: /* Return t if (car A) is numerically less than (car B). */)
4696 (Lisp_Object a
, Lisp_Object b
)
4698 return Flss (Fcar (a
), Fcar (b
));
4701 /* Build the complete list of annotations appropriate for writing out
4702 the text between START and END, by calling all the functions in
4703 write-region-annotate-functions and merging the lists they return.
4704 If one of these functions switches to a different buffer, we assume
4705 that buffer contains altered text. Therefore, the caller must
4706 make sure to restore the current buffer in all cases,
4707 as save-excursion would do. */
4710 build_annotations (Lisp_Object start
, Lisp_Object end
)
4712 Lisp_Object annotations
;
4714 struct gcpro gcpro1
, gcpro2
;
4715 Lisp_Object original_buffer
;
4716 int i
, used_global
= 0;
4718 XSETBUFFER (original_buffer
, current_buffer
);
4721 p
= Vwrite_region_annotate_functions
;
4722 GCPRO2 (annotations
, p
);
4725 struct buffer
*given_buffer
= current_buffer
;
4726 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4727 { /* Use the global value of the hook. */
4730 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4732 p
= Fappend (2, arg
);
4735 Vwrite_region_annotations_so_far
= annotations
;
4736 res
= call2 (XCAR (p
), start
, end
);
4737 /* If the function makes a different buffer current,
4738 assume that means this buffer contains altered text to be output.
4739 Reset START and END from the buffer bounds
4740 and discard all previous annotations because they should have
4741 been dealt with by this function. */
4742 if (current_buffer
!= given_buffer
)
4744 Vwrite_region_annotation_buffers
4745 = Fcons (Fcurrent_buffer (),
4746 Vwrite_region_annotation_buffers
);
4747 XSETFASTINT (start
, BEGV
);
4748 XSETFASTINT (end
, ZV
);
4751 Flength (res
); /* Check basic validity of return value */
4752 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4756 /* Now do the same for annotation functions implied by the file-format */
4757 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
4758 p
= BVAR (current_buffer
, auto_save_file_format
);
4760 p
= BVAR (current_buffer
, file_format
);
4761 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4763 struct buffer
*given_buffer
= current_buffer
;
4765 Vwrite_region_annotations_so_far
= annotations
;
4767 /* Value is either a list of annotations or nil if the function
4768 has written annotations to a temporary buffer, which is now
4770 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4771 original_buffer
, make_number (i
));
4772 if (current_buffer
!= given_buffer
)
4774 XSETFASTINT (start
, BEGV
);
4775 XSETFASTINT (end
, ZV
);
4780 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4788 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4789 If STRING is nil, POS is the character position in the current buffer.
4790 Intersperse with them the annotations from *ANNOT
4791 which fall within the range of POS to POS + NCHARS,
4792 each at its appropriate position.
4794 We modify *ANNOT by discarding elements as we use them up.
4796 The return value is negative in case of system call failure. */
4799 a_write (int desc
, Lisp_Object string
, int pos
, register int nchars
, Lisp_Object
*annot
, struct coding_system
*coding
)
4803 int lastpos
= pos
+ nchars
;
4805 while (NILP (*annot
) || CONSP (*annot
))
4807 tem
= Fcar_safe (Fcar (*annot
));
4810 nextpos
= XFASTINT (tem
);
4812 /* If there are no more annotations in this range,
4813 output the rest of the range all at once. */
4814 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4815 return e_write (desc
, string
, pos
, lastpos
, coding
);
4817 /* Output buffer text up to the next annotation's position. */
4820 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4824 /* Output the annotation. */
4825 tem
= Fcdr (Fcar (*annot
));
4828 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4831 *annot
= Fcdr (*annot
);
4837 /* Write text in the range START and END into descriptor DESC,
4838 encoding them with coding system CODING. If STRING is nil, START
4839 and END are character positions of the current buffer, else they
4840 are indexes to the string STRING. */
4843 e_write (int desc
, Lisp_Object string
, int start
, int end
, struct coding_system
*coding
)
4845 if (STRINGP (string
))
4848 end
= SCHARS (string
);
4851 /* We used to have a code for handling selective display here. But,
4852 now it is handled within encode_coding. */
4856 if (STRINGP (string
))
4858 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
4859 if (CODING_REQUIRE_ENCODING (coding
))
4861 encode_coding_object (coding
, string
,
4862 start
, string_char_to_byte (string
, start
),
4863 end
, string_char_to_byte (string
, end
), Qt
);
4867 coding
->dst_object
= string
;
4868 coding
->consumed_char
= SCHARS (string
);
4869 coding
->produced
= SBYTES (string
);
4874 int start_byte
= CHAR_TO_BYTE (start
);
4875 int end_byte
= CHAR_TO_BYTE (end
);
4877 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
4878 if (CODING_REQUIRE_ENCODING (coding
))
4880 encode_coding_object (coding
, Fcurrent_buffer (),
4881 start
, start_byte
, end
, end_byte
, Qt
);
4885 coding
->dst_object
= Qnil
;
4886 coding
->dst_pos_byte
= start_byte
;
4887 if (start
>= GPT
|| end
<= GPT
)
4889 coding
->consumed_char
= end
- start
;
4890 coding
->produced
= end_byte
- start_byte
;
4894 coding
->consumed_char
= GPT
- start
;
4895 coding
->produced
= GPT_BYTE
- start_byte
;
4900 if (coding
->produced
> 0)
4904 STRINGP (coding
->dst_object
)
4905 ? SSDATA (coding
->dst_object
)
4906 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
4909 if (coding
->produced
)
4912 start
+= coding
->consumed_char
;
4918 DEFUE ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
4919 Sverify_visited_file_modtime
, 0, 1, 0,
4920 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
4921 This means that the file has not been changed since it was visited or saved.
4922 If BUF is omitted or nil, it defaults to the current buffer.
4923 See Info node `(elisp)Modification Time' for more details. */)
4928 Lisp_Object handler
;
4929 Lisp_Object filename
;
4939 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
4940 if (b
->modtime
== 0) return Qt
;
4942 /* If the file name has special constructs in it,
4943 call the corresponding file handler. */
4944 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
4945 Qverify_visited_file_modtime
);
4946 if (!NILP (handler
))
4947 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
4949 filename
= ENCODE_FILE (BVAR (b
, filename
));
4951 if (stat (SSDATA (filename
), &st
) < 0)
4953 /* If the file doesn't exist now and didn't exist before,
4954 we say that it isn't modified, provided the error is a tame one. */
4955 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
4960 if ((st
.st_mtime
== b
->modtime
4961 /* If both are positive, accept them if they are off by one second. */
4962 || (st
.st_mtime
> 0 && b
->modtime
> 0
4963 && (st
.st_mtime
== b
->modtime
+ 1
4964 || st
.st_mtime
== b
->modtime
- 1)))
4965 && (st
.st_size
== b
->modtime_size
4966 || b
->modtime_size
< 0))
4971 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
4972 Sclear_visited_file_modtime
, 0, 0, 0,
4973 doc
: /* Clear out records of last mod time of visited file.
4974 Next attempt to save will certainly not complain of a discrepancy. */)
4977 current_buffer
->modtime
= 0;
4978 current_buffer
->modtime_size
= -1;
4982 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
4983 Svisited_file_modtime
, 0, 0, 0,
4984 doc
: /* Return the current buffer's recorded visited file modification time.
4985 The value is a list of the form (HIGH LOW), like the time values
4986 that `file-attributes' returns. If the current buffer has no recorded
4987 file modification time, this function returns 0.
4988 See Info node `(elisp)Modification Time' for more details. */)
4991 if (! current_buffer
->modtime
)
4992 return make_number (0);
4993 return make_time ((time_t) current_buffer
->modtime
);
4996 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
4997 Sset_visited_file_modtime
, 0, 1, 0,
4998 doc
: /* Update buffer's recorded modification time from the visited file's time.
4999 Useful if the buffer was not read from the file normally
5000 or if the file itself has been changed for some known benign reason.
5001 An argument specifies the modification time value to use
5002 \(instead of that of the visited file), in the form of a list
5003 \(HIGH . LOW) or (HIGH LOW). */)
5004 (Lisp_Object time_list
)
5006 if (!NILP (time_list
))
5008 current_buffer
->modtime
= cons_to_long (time_list
);
5009 current_buffer
->modtime_size
= -1;
5013 register Lisp_Object filename
;
5015 Lisp_Object handler
;
5017 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5019 /* If the file name has special constructs in it,
5020 call the corresponding file handler. */
5021 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5022 if (!NILP (handler
))
5023 /* The handler can find the file name the same way we did. */
5024 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5026 filename
= ENCODE_FILE (filename
);
5028 if (stat (SSDATA (filename
), &st
) >= 0)
5030 current_buffer
->modtime
= st
.st_mtime
;
5031 current_buffer
->modtime_size
= st
.st_size
;
5039 auto_save_error (Lisp_Object error_val
)
5041 Lisp_Object args
[3], msg
;
5043 struct gcpro gcpro1
;
5047 auto_save_error_occurred
= 1;
5049 ring_bell (XFRAME (selected_frame
));
5051 args
[0] = build_string ("Auto-saving %s: %s");
5052 args
[1] = BVAR (current_buffer
, name
);
5053 args
[2] = Ferror_message_string (error_val
);
5054 msg
= Fformat (3, args
);
5056 nbytes
= SBYTES (msg
);
5057 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5058 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5060 for (i
= 0; i
< 3; ++i
)
5063 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5065 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5066 Fsleep_for (make_number (1), Qnil
);
5080 auto_save_mode_bits
= 0666;
5082 /* Get visited file's mode to become the auto save file's mode. */
5083 if (! NILP (BVAR (current_buffer
, filename
)))
5085 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5086 /* But make sure we can overwrite it later! */
5087 auto_save_mode_bits
= st
.st_mode
| 0600;
5088 else if ((modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5090 /* Remote files don't cooperate with stat. */
5091 auto_save_mode_bits
= XINT (modes
) | 0600;
5095 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5096 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5101 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5104 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5116 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5119 minibuffer_auto_raise
= XINT (value
);
5124 do_auto_save_make_dir (Lisp_Object dir
)
5128 call2 (Qmake_directory
, dir
, Qt
);
5129 XSETFASTINT (mode
, 0700);
5130 return Fset_file_modes (dir
, mode
);
5134 do_auto_save_eh (Lisp_Object ignore
)
5139 DEFUE ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5140 doc
: /* Auto-save all buffers that need it.
5141 This is all buffers that have auto-saving enabled
5142 and are changed since last auto-saved.
5143 Auto-saving writes the buffer into a file
5144 so that your editing is not lost if the system crashes.
5145 This file is not the file you visited; that changes only when you save.
5146 Normally we run the normal hook `auto-save-hook' before saving.
5148 A non-nil NO-MESSAGE argument means do not print any message if successful.
5149 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5150 (Lisp_Object no_message
, Lisp_Object current_only
)
5152 struct buffer
*old
= current_buffer
, *b
;
5153 Lisp_Object tail
, buf
, hook
;
5155 int do_handled_files
;
5157 FILE *stream
= NULL
;
5158 int count
= SPECPDL_INDEX ();
5159 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5160 int old_message_p
= 0;
5161 struct gcpro gcpro1
, gcpro2
;
5163 if (max_specpdl_size
< specpdl_size
+ 40)
5164 max_specpdl_size
= specpdl_size
+ 40;
5169 if (NILP (no_message
))
5171 old_message_p
= push_message ();
5172 record_unwind_protect (pop_message_unwind
, Qnil
);
5175 /* Ordinarily don't quit within this function,
5176 but don't make it impossible to quit (in case we get hung in I/O). */
5180 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5181 point to non-strings reached from Vbuffer_alist. */
5183 hook
= intern ("auto-save-hook");
5184 Frun_hooks (1, &hook
);
5186 if (STRINGP (Vauto_save_list_file_name
))
5188 Lisp_Object listfile
;
5190 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5192 /* Don't try to create the directory when shutting down Emacs,
5193 because creating the directory might signal an error, and
5194 that would leave Emacs in a strange state. */
5195 if (!NILP (Vrun_hooks
))
5199 GCPRO2 (dir
, listfile
);
5200 dir
= Ffile_name_directory (listfile
);
5201 if (NILP (Ffile_directory_p (dir
)))
5202 internal_condition_case_1 (do_auto_save_make_dir
,
5203 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5208 stream
= fopen (SSDATA (listfile
), "w");
5211 record_unwind_protect (do_auto_save_unwind
,
5212 make_save_value (stream
, 0));
5213 record_unwind_protect (do_auto_save_unwind_1
,
5214 make_number (minibuffer_auto_raise
));
5215 minibuffer_auto_raise
= 0;
5217 auto_save_error_occurred
= 0;
5219 /* On first pass, save all files that don't have handlers.
5220 On second pass, save all files that do have handlers.
5222 If Emacs is crashing, the handlers may tweak what is causing
5223 Emacs to crash in the first place, and it would be a shame if
5224 Emacs failed to autosave perfectly ordinary files because it
5225 couldn't handle some ange-ftp'd file. */
5227 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5228 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5230 buf
= XCDR (XCAR (tail
));
5233 /* Record all the buffers that have auto save mode
5234 in the special file that lists them. For each of these buffers,
5235 Record visited name (if any) and auto save name. */
5236 if (STRINGP (BVAR (b
, auto_save_file_name
))
5237 && stream
!= NULL
&& do_handled_files
== 0)
5240 if (!NILP (BVAR (b
, filename
)))
5242 fwrite (SDATA (BVAR (b
, filename
)), 1,
5243 SBYTES (BVAR (b
, filename
)), stream
);
5245 putc ('\n', stream
);
5246 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5247 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5248 putc ('\n', stream
);
5252 if (!NILP (current_only
)
5253 && b
!= current_buffer
)
5256 /* Don't auto-save indirect buffers.
5257 The base buffer takes care of it. */
5261 /* Check for auto save enabled
5262 and file changed since last auto save
5263 and file changed since last real save. */
5264 if (STRINGP (BVAR (b
, auto_save_file_name
))
5265 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5266 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5267 /* -1 means we've turned off autosaving for a while--see below. */
5268 && XINT (BVAR (b
, save_length
)) >= 0
5269 && (do_handled_files
5270 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5273 EMACS_TIME before_time
, after_time
;
5275 EMACS_GET_TIME (before_time
);
5277 /* If we had a failure, don't try again for 20 minutes. */
5278 if (b
->auto_save_failure_time
>= 0
5279 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5282 set_buffer_internal (b
);
5283 if (NILP (Vauto_save_include_big_deletions
)
5284 && (XFASTINT (BVAR (b
, save_length
)) * 10
5285 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5286 /* A short file is likely to change a large fraction;
5287 spare the user annoying messages. */
5288 && XFASTINT (BVAR (b
, save_length
)) > 5000
5289 /* These messages are frequent and annoying for `*mail*'. */
5290 && !EQ (BVAR (b
, filename
), Qnil
)
5291 && NILP (no_message
))
5293 /* It has shrunk too much; turn off auto-saving here. */
5294 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5295 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5297 minibuffer_auto_raise
= 0;
5298 /* Turn off auto-saving until there's a real save,
5299 and prevent any more warnings. */
5300 XSETINT (BVAR (b
, save_length
), -1);
5301 Fsleep_for (make_number (1), Qnil
);
5304 if (!auto_saved
&& NILP (no_message
))
5305 message1 ("Auto-saving...");
5306 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5308 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5309 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5310 set_buffer_internal (old
);
5312 EMACS_GET_TIME (after_time
);
5314 /* If auto-save took more than 60 seconds,
5315 assume it was an NFS failure that got a timeout. */
5316 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5317 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5321 /* Prevent another auto save till enough input events come in. */
5322 record_auto_save ();
5324 if (auto_saved
&& NILP (no_message
))
5328 /* If we are going to restore an old message,
5329 give time to read ours. */
5330 sit_for (make_number (1), 0, 0);
5333 else if (!auto_save_error_occurred
)
5334 /* Don't overwrite the error message if an error occurred.
5335 If we displayed a message and then restored a state
5336 with no message, leave a "done" message on the screen. */
5337 message1 ("Auto-saving...done");
5342 /* This restores the message-stack status. */
5343 unbind_to (count
, Qnil
);
5347 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5348 Sset_buffer_auto_saved
, 0, 0, 0,
5349 doc
: /* Mark current buffer as auto-saved with its current text.
5350 No auto-save file will be written until the buffer changes again. */)
5353 /* FIXME: This should not be called in indirect buffers, since
5354 they're not autosaved. */
5355 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5356 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5357 current_buffer
->auto_save_failure_time
= -1;
5361 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5362 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5363 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5366 current_buffer
->auto_save_failure_time
= -1;
5370 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5372 doc
: /* Return t if current buffer has been auto-saved recently.
5373 More precisely, if it has been auto-saved since last read from or saved
5374 in the visited file. If the buffer has no visited file,
5375 then any auto-save counts as "recent". */)
5378 /* FIXME: maybe we should return nil for indirect buffers since
5379 they're never autosaved. */
5380 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5383 /* Reading and completing file names */
5385 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5386 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5387 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5388 The return value is only relevant for a call to `read-file-name' that happens
5389 before any other event (mouse or keypress) is handled. */)
5392 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5393 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5403 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5405 struct gcpro gcpro1
;
5406 Lisp_Object args
[7];
5408 GCPRO1 (default_filename
);
5409 args
[0] = intern ("read-file-name");
5412 args
[3] = default_filename
;
5413 args
[4] = mustmatch
;
5415 args
[6] = predicate
;
5416 RETURN_UNGCPRO (Ffuncall (7, args
));
5421 syms_of_fileio (void)
5423 Qoperations
= intern_c_string ("operations");
5424 Qexpand_file_name
= intern_c_string ("expand-file-name");
5425 Qsubstitute_in_file_name
= intern_c_string ("substitute-in-file-name");
5426 Qdirectory_file_name
= intern_c_string ("directory-file-name");
5427 Qfile_name_directory
= intern_c_string ("file-name-directory");
5428 Qfile_name_nondirectory
= intern_c_string ("file-name-nondirectory");
5429 Qunhandled_file_name_directory
= intern_c_string ("unhandled-file-name-directory");
5430 Qfile_name_as_directory
= intern_c_string ("file-name-as-directory");
5431 Qcopy_file
= intern_c_string ("copy-file");
5432 Qmake_directory_internal
= intern_c_string ("make-directory-internal");
5433 Qmake_directory
= intern_c_string ("make-directory");
5434 Qdelete_directory_internal
= intern_c_string ("delete-directory-internal");
5435 Qdelete_file
= intern_c_string ("delete-file");
5436 Qrename_file
= intern_c_string ("rename-file");
5437 Qadd_name_to_file
= intern_c_string ("add-name-to-file");
5438 Qmake_symbolic_link
= intern_c_string ("make-symbolic-link");
5439 Qfile_exists_p
= intern_c_string ("file-exists-p");
5440 Qfile_executable_p
= intern_c_string ("file-executable-p");
5441 Qfile_readable_p
= intern_c_string ("file-readable-p");
5442 Qfile_writable_p
= intern_c_string ("file-writable-p");
5443 Qfile_symlink_p
= intern_c_string ("file-symlink-p");
5444 Qaccess_file
= intern_c_string ("access-file");
5445 Qfile_directory_p
= intern_c_string ("file-directory-p");
5446 Qfile_regular_p
= intern_c_string ("file-regular-p");
5447 Qfile_accessible_directory_p
= intern_c_string ("file-accessible-directory-p");
5448 Qfile_modes
= intern_c_string ("file-modes");
5449 Qset_file_modes
= intern_c_string ("set-file-modes");
5450 Qset_file_times
= intern_c_string ("set-file-times");
5451 Qfile_selinux_context
= intern_c_string("file-selinux-context");
5452 Qset_file_selinux_context
= intern_c_string("set-file-selinux-context");
5453 Qfile_newer_than_file_p
= intern_c_string ("file-newer-than-file-p");
5454 Qinsert_file_contents
= intern_c_string ("insert-file-contents");
5455 Qwrite_region
= intern_c_string ("write-region");
5456 Qverify_visited_file_modtime
= intern_c_string ("verify-visited-file-modtime");
5457 Qset_visited_file_modtime
= intern_c_string ("set-visited-file-modtime");
5458 Qauto_save_coding
= intern_c_string ("auto-save-coding");
5460 staticpro (&Qoperations
);
5461 staticpro (&Qexpand_file_name
);
5462 staticpro (&Qsubstitute_in_file_name
);
5463 staticpro (&Qdirectory_file_name
);
5464 staticpro (&Qfile_name_directory
);
5465 staticpro (&Qfile_name_nondirectory
);
5466 staticpro (&Qunhandled_file_name_directory
);
5467 staticpro (&Qfile_name_as_directory
);
5468 staticpro (&Qcopy_file
);
5469 staticpro (&Qmake_directory_internal
);
5470 staticpro (&Qmake_directory
);
5471 staticpro (&Qdelete_directory_internal
);
5472 staticpro (&Qdelete_file
);
5473 staticpro (&Qrename_file
);
5474 staticpro (&Qadd_name_to_file
);
5475 staticpro (&Qmake_symbolic_link
);
5476 staticpro (&Qfile_exists_p
);
5477 staticpro (&Qfile_executable_p
);
5478 staticpro (&Qfile_readable_p
);
5479 staticpro (&Qfile_writable_p
);
5480 staticpro (&Qaccess_file
);
5481 staticpro (&Qfile_symlink_p
);
5482 staticpro (&Qfile_directory_p
);
5483 staticpro (&Qfile_regular_p
);
5484 staticpro (&Qfile_accessible_directory_p
);
5485 staticpro (&Qfile_modes
);
5486 staticpro (&Qset_file_modes
);
5487 staticpro (&Qset_file_times
);
5488 staticpro (&Qfile_selinux_context
);
5489 staticpro (&Qset_file_selinux_context
);
5490 staticpro (&Qfile_newer_than_file_p
);
5491 staticpro (&Qinsert_file_contents
);
5492 staticpro (&Qwrite_region
);
5493 staticpro (&Qverify_visited_file_modtime
);
5494 staticpro (&Qset_visited_file_modtime
);
5495 staticpro (&Qauto_save_coding
);
5497 Qfile_name_history
= intern_c_string ("file-name-history");
5498 Fset (Qfile_name_history
, Qnil
);
5499 staticpro (&Qfile_name_history
);
5501 Qfile_error
= intern_c_string ("file-error");
5502 staticpro (&Qfile_error
);
5503 Qfile_already_exists
= intern_c_string ("file-already-exists");
5504 staticpro (&Qfile_already_exists
);
5505 Qfile_date_error
= intern_c_string ("file-date-error");
5506 staticpro (&Qfile_date_error
);
5507 Qexcl
= intern_c_string ("excl");
5510 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5511 doc
: /* *Coding system for encoding file names.
5512 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5513 Vfile_name_coding_system
= Qnil
;
5515 DEFVAR_LISP ("default-file-name-coding-system",
5516 Vdefault_file_name_coding_system
,
5517 doc
: /* Default coding system for encoding file names.
5518 This variable is used only when `file-name-coding-system' is nil.
5520 This variable is set/changed by the command `set-language-environment'.
5521 User should not set this variable manually,
5522 instead use `file-name-coding-system' to get a constant encoding
5523 of file names regardless of the current language environment. */);
5524 Vdefault_file_name_coding_system
= Qnil
;
5526 Qformat_decode
= intern_c_string ("format-decode");
5527 staticpro (&Qformat_decode
);
5528 Qformat_annotate_function
= intern_c_string ("format-annotate-function");
5529 staticpro (&Qformat_annotate_function
);
5530 Qafter_insert_file_set_coding
= intern_c_string ("after-insert-file-set-coding");
5531 staticpro (&Qafter_insert_file_set_coding
);
5533 Qcar_less_than_car
= intern_c_string ("car-less-than-car");
5534 staticpro (&Qcar_less_than_car
);
5536 Fput (Qfile_error
, Qerror_conditions
,
5537 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5538 Fput (Qfile_error
, Qerror_message
,
5539 make_pure_c_string ("File error"));
5541 Fput (Qfile_already_exists
, Qerror_conditions
,
5542 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5543 Fput (Qfile_already_exists
, Qerror_message
,
5544 make_pure_c_string ("File already exists"));
5546 Fput (Qfile_date_error
, Qerror_conditions
,
5547 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5548 Fput (Qfile_date_error
, Qerror_message
,
5549 make_pure_c_string ("Cannot set file date"));
5551 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5552 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
5553 If a file name matches REGEXP, then all I/O on that file is done by calling
5556 The first argument given to HANDLER is the name of the I/O primitive
5557 to be handled; the remaining arguments are the arguments that were
5558 passed to that primitive. For example, if you do
5559 (file-exists-p FILENAME)
5560 and FILENAME is handled by HANDLER, then HANDLER is called like this:
5561 (funcall HANDLER 'file-exists-p FILENAME)
5562 The function `find-file-name-handler' checks this list for a handler
5563 for its argument. */);
5564 Vfile_name_handler_alist
= Qnil
;
5566 DEFVAR_LISP ("set-auto-coding-function",
5567 Vset_auto_coding_function
,
5568 doc
: /* If non-nil, a function to call to decide a coding system of file.
5569 Two arguments are passed to this function: the file name
5570 and the length of a file contents following the point.
5571 This function should return a coding system to decode the file contents.
5572 It should check the file name against `auto-coding-alist'.
5573 If no coding system is decided, it should check a coding system
5574 specified in the heading lines with the format:
5575 -*- ... coding: CODING-SYSTEM; ... -*-
5576 or local variable spec of the tailing lines with `coding:' tag. */);
5577 Vset_auto_coding_function
= Qnil
;
5579 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5580 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5581 Each is passed one argument, the number of characters inserted,
5582 with point at the start of the inserted text. Each function
5583 should leave point the same, and return the new character count.
5584 If `insert-file-contents' is intercepted by a handler from
5585 `file-name-handler-alist', that handler is responsible for calling the
5586 functions in `after-insert-file-functions' if appropriate. */);
5587 Vafter_insert_file_functions
= Qnil
;
5589 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5590 doc
: /* A list of functions to be called at the start of `write-region'.
5591 Each is passed two arguments, START and END as for `write-region'.
5592 These are usually two numbers but not always; see the documentation
5593 for `write-region'. The function should return a list of pairs
5594 of the form (POSITION . STRING), consisting of strings to be effectively
5595 inserted at the specified positions of the file being written (1 means to
5596 insert before the first byte written). The POSITIONs must be sorted into
5599 If there are several annotation functions, the lists returned by these
5600 functions are merged destructively. As each annotation function runs,
5601 the variable `write-region-annotations-so-far' contains a list of all
5602 annotations returned by previous annotation functions.
5604 An annotation function can return with a different buffer current.
5605 Doing so removes the annotations returned by previous functions, and
5606 resets START and END to `point-min' and `point-max' of the new buffer.
5608 After `write-region' completes, Emacs calls the function stored in
5609 `write-region-post-annotation-function', once for each buffer that was
5610 current when building the annotations (i.e., at least once), with that
5611 buffer current. */);
5612 Vwrite_region_annotate_functions
= Qnil
;
5613 staticpro (&Qwrite_region_annotate_functions
);
5614 Qwrite_region_annotate_functions
5615 = intern_c_string ("write-region-annotate-functions");
5617 DEFVAR_LISP ("write-region-post-annotation-function",
5618 Vwrite_region_post_annotation_function
,
5619 doc
: /* Function to call after `write-region' completes.
5620 The function is called with no arguments. If one or more of the
5621 annotation functions in `write-region-annotate-functions' changed the
5622 current buffer, the function stored in this variable is called for
5623 each of those additional buffers as well, in addition to the original
5624 buffer. The relevant buffer is current during each function call. */);
5625 Vwrite_region_post_annotation_function
= Qnil
;
5626 staticpro (&Vwrite_region_annotation_buffers
);
5628 DEFVAR_LISP ("write-region-annotations-so-far",
5629 Vwrite_region_annotations_so_far
,
5630 doc
: /* When an annotation function is called, this holds the previous annotations.
5631 These are the annotations made by other annotation functions
5632 that were already called. See also `write-region-annotate-functions'. */);
5633 Vwrite_region_annotations_so_far
= Qnil
;
5635 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5636 doc
: /* A list of file name handlers that temporarily should not be used.
5637 This applies only to the operation `inhibit-file-name-operation'. */);
5638 Vinhibit_file_name_handlers
= Qnil
;
5640 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5641 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5642 Vinhibit_file_name_operation
= Qnil
;
5644 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
5645 doc
: /* File name in which we write a list of all auto save file names.
5646 This variable is initialized automatically from `auto-save-list-file-prefix'
5647 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5648 a non-nil value. */);
5649 Vauto_save_list_file_name
= Qnil
;
5651 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
5652 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5653 Normally auto-save files are written under other names. */);
5654 Vauto_save_visited_file_name
= Qnil
;
5656 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
5657 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5658 If nil, deleting a substantial portion of the text disables auto-save
5659 in the buffer; this is the default behavior, because the auto-save
5660 file is usually more useful if it contains the deleted text. */);
5661 Vauto_save_include_big_deletions
= Qnil
;
5664 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
5665 doc
: /* *Non-nil means don't call fsync in `write-region'.
5666 This variable affects calls to `write-region' as well as save commands.
5667 A non-nil value may result in data loss! */);
5668 write_region_inhibit_fsync
= 0;
5671 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
5672 doc
: /* Specifies whether to use the system's trash can.
5673 When non-nil, certain file deletion commands use the function
5674 `move-file-to-trash' instead of deleting files outright.
5675 This includes interactive calls to `delete-file' and
5676 `delete-directory' and the Dired deletion commands. */);
5677 delete_by_moving_to_trash
= 0;
5678 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5679 Qmove_file_to_trash
= intern_c_string ("move-file-to-trash");
5680 staticpro (&Qmove_file_to_trash
);
5681 Qcopy_directory
= intern_c_string ("copy-directory");
5682 staticpro (&Qcopy_directory
);
5683 Qdelete_directory
= intern_c_string ("delete-directory");
5684 staticpro (&Qdelete_directory
);
5686 defsubr (&Sfind_file_name_handler
);
5687 defsubr (&Sfile_name_directory
);
5688 defsubr (&Sfile_name_nondirectory
);
5689 defsubr (&Sunhandled_file_name_directory
);
5690 defsubr (&Sfile_name_as_directory
);
5691 defsubr (&Sdirectory_file_name
);
5692 defsubr (&Smake_temp_name
);
5693 defsubr (&Sexpand_file_name
);
5694 defsubr (&Ssubstitute_in_file_name
);
5695 defsubr (&Scopy_file
);
5696 defsubr (&Smake_directory_internal
);
5697 defsubr (&Sdelete_directory_internal
);
5698 defsubr (&Sdelete_file
);
5699 defsubr (&Srename_file
);
5700 defsubr (&Sadd_name_to_file
);
5701 defsubr (&Smake_symbolic_link
);
5702 defsubr (&Sfile_name_absolute_p
);
5703 defsubr (&Sfile_exists_p
);
5704 defsubr (&Sfile_executable_p
);
5705 defsubr (&Sfile_readable_p
);
5706 defsubr (&Sfile_writable_p
);
5707 defsubr (&Saccess_file
);
5708 defsubr (&Sfile_symlink_p
);
5709 defsubr (&Sfile_directory_p
);
5710 defsubr (&Sfile_accessible_directory_p
);
5711 defsubr (&Sfile_regular_p
);
5712 defsubr (&Sfile_modes
);
5713 defsubr (&Sset_file_modes
);
5714 defsubr (&Sset_file_times
);
5715 defsubr (&Sfile_selinux_context
);
5716 defsubr (&Sset_file_selinux_context
);
5717 defsubr (&Sset_default_file_modes
);
5718 defsubr (&Sdefault_file_modes
);
5719 defsubr (&Sfile_newer_than_file_p
);
5720 defsubr (&Sinsert_file_contents
);
5721 defsubr (&Swrite_region
);
5722 defsubr (&Scar_less_than_car
);
5723 defsubr (&Sverify_visited_file_modtime
);
5724 defsubr (&Sclear_visited_file_modtime
);
5725 defsubr (&Svisited_file_modtime
);
5726 defsubr (&Sset_visited_file_modtime
);
5727 defsubr (&Sdo_auto_save
);
5728 defsubr (&Sset_buffer_auto_saved
);
5729 defsubr (&Sclear_buffer_auto_save_failure
);
5730 defsubr (&Srecent_auto_save_p
);
5732 defsubr (&Snext_read_file_uses_dialog_p
);
5735 defsubr (&Sunix_sync
);