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 Lisp_Object Qauto_save_coding
;
107 /* Property name of a file name handler,
108 which gives a list of operations it handles.. */
109 Lisp_Object Qoperations
;
111 /* Lisp functions for translating file formats */
112 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 Lisp_Object Qafter_insert_file_set_coding
;
118 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 Lisp_Object Qdelete_by_moving_to_trash
;
128 /* Lisp function for moving files to trash. */
129 Lisp_Object Qmove_file_to_trash
;
131 /* Lisp function for recursively copying directories. */
132 Lisp_Object Qcopy_directory
;
134 /* Lisp function for recursively deleting directories. */
135 Lisp_Object Qdelete_directory
;
140 Lisp_Object Qfile_error
, Qfile_already_exists
, Qfile_date_error
;
142 Lisp_Object Qfile_name_history
;
144 Lisp_Object Qcar_less_than_car
;
146 static int a_write (int, Lisp_Object
, int, int,
147 Lisp_Object
*, struct coding_system
*);
148 static int e_write (int, Lisp_Object
, int, int, struct coding_system
*);
152 report_file_error (const char *string
, Lisp_Object data
)
154 Lisp_Object errstring
;
158 synchronize_system_messages_locale ();
159 str
= strerror (errorno
);
160 errstring
= code_convert_string_norecord (make_unibyte_string (str
,
162 Vlocale_coding_system
, 0);
168 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
171 /* System error messages are capitalized. Downcase the initial
172 unless it is followed by a slash. (The slash case caters to
173 error messages that begin with "I/O" or, in German, "E/A".) */
174 if (STRING_MULTIBYTE (errstring
)
175 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
179 str
= SSDATA (errstring
);
180 c
= STRING_CHAR ((unsigned char *) str
);
181 Faset (errstring
, make_number (0), make_number (DOWNCASE (c
)));
184 xsignal (Qfile_error
,
185 Fcons (build_string (string
), Fcons (errstring
, data
)));
190 close_file_unwind (Lisp_Object fd
)
192 emacs_close (XFASTINT (fd
));
196 /* Restore point, having saved it as a marker. */
199 restore_point_unwind (Lisp_Object location
)
201 Fgoto_char (location
);
202 Fset_marker (location
, Qnil
, Qnil
);
207 Lisp_Object Qexpand_file_name
;
208 Lisp_Object Qsubstitute_in_file_name
;
209 Lisp_Object Qdirectory_file_name
;
210 Lisp_Object Qfile_name_directory
;
211 Lisp_Object Qfile_name_nondirectory
;
212 Lisp_Object Qunhandled_file_name_directory
;
213 Lisp_Object Qfile_name_as_directory
;
214 Lisp_Object Qcopy_file
;
215 Lisp_Object Qmake_directory_internal
;
216 Lisp_Object Qmake_directory
;
217 Lisp_Object Qdelete_directory_internal
;
218 Lisp_Object Qdelete_file
;
219 Lisp_Object Qrename_file
;
220 Lisp_Object Qadd_name_to_file
;
221 Lisp_Object Qmake_symbolic_link
;
222 Lisp_Object Qfile_exists_p
;
223 Lisp_Object Qfile_executable_p
;
224 Lisp_Object Qfile_readable_p
;
225 Lisp_Object Qfile_writable_p
;
226 Lisp_Object Qfile_symlink_p
;
227 Lisp_Object Qaccess_file
;
228 Lisp_Object Qfile_directory_p
;
229 Lisp_Object Qfile_regular_p
;
230 Lisp_Object Qfile_accessible_directory_p
;
231 Lisp_Object Qfile_modes
;
232 Lisp_Object Qset_file_modes
;
233 Lisp_Object Qset_file_times
;
234 Lisp_Object Qfile_selinux_context
;
235 Lisp_Object Qset_file_selinux_context
;
236 Lisp_Object Qfile_newer_than_file_p
;
237 Lisp_Object Qinsert_file_contents
;
238 Lisp_Object Qwrite_region
;
239 Lisp_Object Qverify_visited_file_modtime
;
240 Lisp_Object Qset_visited_file_modtime
;
242 DEFUN ("find-file-name-handler", Ffind_file_name_handler
, Sfind_file_name_handler
, 2, 2, 0,
243 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
244 Otherwise, return nil.
245 A file name is handled if one of the regular expressions in
246 `file-name-handler-alist' matches it.
248 If OPERATION equals `inhibit-file-name-operation', then we ignore
249 any handlers that are members of `inhibit-file-name-handlers',
250 but we still do run any other handlers. This lets handlers
251 use the standard functions without calling themselves recursively. */)
252 (Lisp_Object filename
, Lisp_Object operation
)
254 /* This function must not munge the match data. */
255 Lisp_Object chain
, inhibited_handlers
, result
;
259 CHECK_STRING (filename
);
261 if (EQ (operation
, Vinhibit_file_name_operation
))
262 inhibited_handlers
= Vinhibit_file_name_handlers
;
264 inhibited_handlers
= Qnil
;
266 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
267 chain
= XCDR (chain
))
273 Lisp_Object string
= XCAR (elt
);
275 Lisp_Object handler
= XCDR (elt
);
276 Lisp_Object operations
= Qnil
;
278 if (SYMBOLP (handler
))
279 operations
= Fget (handler
, Qoperations
);
282 && (match_pos
= fast_string_match (string
, filename
)) > pos
283 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
287 handler
= XCDR (elt
);
288 tem
= Fmemq (handler
, inhibited_handlers
);
302 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
304 doc
: /* Return the directory component in file name FILENAME.
305 Return nil if FILENAME does not include a directory.
306 Otherwise return a directory name.
307 Given a Unix syntax file name, returns a string ending in slash. */)
308 (Lisp_Object filename
)
311 register const char *beg
;
315 register const char *p
;
318 CHECK_STRING (filename
);
320 /* If the file name has special constructs in it,
321 call the corresponding file handler. */
322 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
324 return call2 (handler
, Qfile_name_directory
, filename
);
326 filename
= FILE_SYSTEM_CASE (filename
);
328 beg
= (char *) alloca (SBYTES (filename
) + 1);
329 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
331 beg
= SSDATA (filename
);
333 p
= beg
+ SBYTES (filename
);
335 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
337 /* only recognise drive specifier at the beginning */
339 /* handle the "/:d:foo" and "/:foo" cases correctly */
340 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
341 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
348 /* Expansion of "c:" to drive and default directory. */
351 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
352 char *res
= alloca (MAXPATHLEN
+ 1);
355 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
357 strncpy (res
, beg
, 2);
362 if (getdefdir (toupper ((unsigned char) *beg
) - 'A' + 1, r
))
364 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
367 p
= beg
+ strlen (beg
);
370 dostounix_filename (beg
);
373 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
376 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
377 Sfile_name_nondirectory
, 1, 1, 0,
378 doc
: /* Return file name FILENAME sans its directory.
379 For example, in a Unix-syntax file name,
380 this is everything after the last slash,
381 or the entire name if it contains no slash. */)
382 (Lisp_Object filename
)
384 register const char *beg
, *p
, *end
;
387 CHECK_STRING (filename
);
389 /* If the file name has special constructs in it,
390 call the corresponding file handler. */
391 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
393 return call2 (handler
, Qfile_name_nondirectory
, filename
);
395 beg
= SSDATA (filename
);
396 end
= p
= beg
+ SBYTES (filename
);
398 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
400 /* only recognise drive specifier at beginning */
402 /* handle the "/:d:foo" case correctly */
403 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
408 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
411 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
412 Sunhandled_file_name_directory
, 1, 1, 0,
413 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
414 A `directly usable' directory name is one that may be used without the
415 intervention of any file handler.
416 If FILENAME is a directly usable file itself, return
417 \(file-name-directory FILENAME).
418 If FILENAME refers to a file which is not accessible from a local process,
419 then this should return nil.
420 The `call-process' and `start-process' functions use this function to
421 get a current directory to run processes in. */)
422 (Lisp_Object filename
)
426 /* If the file name has special constructs in it,
427 call the corresponding file handler. */
428 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
430 return call2 (handler
, Qunhandled_file_name_directory
, filename
);
432 return Ffile_name_directory (filename
);
437 file_name_as_directory (char *out
, const char *in
)
439 int size
= strlen (in
) - 1;
451 /* For Unix syntax, Append a slash if necessary */
452 if (!IS_DIRECTORY_SEP (out
[size
]))
454 out
[size
+ 1] = DIRECTORY_SEP
;
455 out
[size
+ 2] = '\0';
458 dostounix_filename (out
);
463 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
464 Sfile_name_as_directory
, 1, 1, 0,
465 doc
: /* Return a string representing the file name FILE interpreted as a directory.
466 This operation exists because a directory is also a file, but its name as
467 a directory is different from its name as a file.
468 The result can be used as the value of `default-directory'
469 or passed as second argument to `expand-file-name'.
470 For a Unix-syntax file name, just appends a slash. */)
480 /* If the file name has special constructs in it,
481 call the corresponding file handler. */
482 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
484 return call2 (handler
, Qfile_name_as_directory
, file
);
486 buf
= (char *) alloca (SBYTES (file
) + 10);
487 file_name_as_directory (buf
, SSDATA (file
));
488 return make_specified_string (buf
, -1, strlen (buf
),
489 STRING_MULTIBYTE (file
));
493 * Convert from directory name to filename.
494 * On UNIX, it's simple: just make sure there isn't a terminating /
496 * Value is nonzero if the string output is different from the input.
500 directory_file_name (char *src
, char *dst
)
506 /* Process as Unix format: just remove any final slash.
507 But leave "/" unchanged; do not change it to "". */
510 && IS_DIRECTORY_SEP (dst
[slen
- 1])
512 && !IS_ANY_SEP (dst
[slen
- 2])
517 dostounix_filename (dst
);
522 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
524 doc
: /* Returns the file name of the directory named DIRECTORY.
525 This is the name of the file that holds the data for the directory DIRECTORY.
526 This operation exists because a directory is also a file, but its name as
527 a directory is different from its name as a file.
528 In Unix-syntax, this function just removes the final slash. */)
529 (Lisp_Object directory
)
534 CHECK_STRING (directory
);
536 if (NILP (directory
))
539 /* If the file name has special constructs in it,
540 call the corresponding file handler. */
541 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
543 return call2 (handler
, Qdirectory_file_name
, directory
);
545 buf
= (char *) alloca (SBYTES (directory
) + 20);
546 directory_file_name (SSDATA (directory
), buf
);
547 return make_specified_string (buf
, -1, strlen (buf
),
548 STRING_MULTIBYTE (directory
));
551 static const char make_temp_name_tbl
[64] =
553 'A','B','C','D','E','F','G','H',
554 'I','J','K','L','M','N','O','P',
555 'Q','R','S','T','U','V','W','X',
556 'Y','Z','a','b','c','d','e','f',
557 'g','h','i','j','k','l','m','n',
558 'o','p','q','r','s','t','u','v',
559 'w','x','y','z','0','1','2','3',
560 '4','5','6','7','8','9','-','_'
563 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
565 /* Value is a temporary file name starting with PREFIX, a string.
567 The Emacs process number forms part of the result, so there is
568 no danger of generating a name being used by another process.
569 In addition, this function makes an attempt to choose a name
570 which has no existing file. To make this work, PREFIX should be
571 an absolute file name.
573 BASE64_P non-zero means add the pid as 3 characters in base64
574 encoding. In this case, 6 characters will be added to PREFIX to
575 form the file name. Otherwise, if Emacs is running on a system
576 with long file names, add the pid as a decimal number.
578 This function signals an error if no unique file name could be
582 make_temp_name (Lisp_Object prefix
, int base64_p
)
591 CHECK_STRING (prefix
);
593 /* VAL is created by adding 6 characters to PREFIX. The first
594 three are the PID of this process, in base 64, and the second
595 three are incremented if the file already exists. This ensures
596 262144 unique file names per PID per PREFIX. */
598 pid
= (int) getpid ();
602 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
603 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
604 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
609 #ifdef HAVE_LONG_FILE_NAMES
610 sprintf (pidbuf
, "%d", pid
);
611 pidlen
= strlen (pidbuf
);
613 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
614 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
615 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
620 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
621 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
622 if (!STRING_MULTIBYTE (prefix
))
623 STRING_SET_UNIBYTE (val
);
625 memcpy (data
, SSDATA (prefix
), len
);
628 memcpy (p
, pidbuf
, pidlen
);
631 /* Here we try to minimize useless stat'ing when this function is
632 invoked many times successively with the same PREFIX. We achieve
633 this by initializing count to a random value, and incrementing it
636 We don't want make-temp-name to be called while dumping,
637 because then make_temp_name_count_initialized_p would get set
638 and then make_temp_name_count would not be set when Emacs starts. */
640 if (!make_temp_name_count_initialized_p
)
642 make_temp_name_count
= (unsigned) time (NULL
);
643 make_temp_name_count_initialized_p
= 1;
649 unsigned num
= make_temp_name_count
;
651 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
652 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
653 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
655 /* Poor man's congruential RN generator. Replace with
656 ++make_temp_name_count for debugging. */
657 make_temp_name_count
+= 25229;
658 make_temp_name_count
%= 225307;
660 if (stat (data
, &ignored
) < 0)
662 /* We want to return only if errno is ENOENT. */
666 /* The error here is dubious, but there is little else we
667 can do. The alternatives are to return nil, which is
668 as bad as (and in many cases worse than) throwing the
669 error, or to ignore the error, which will likely result
670 in looping through 225307 stat's, which is not only
671 dog-slow, but also useless since eventually nil would
672 have to be returned anyway. */
673 report_file_error ("Cannot create temporary name for prefix",
674 Fcons (prefix
, Qnil
));
681 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
682 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
683 The Emacs process number forms part of the result,
684 so there is no danger of generating a name being used by another process.
686 In addition, this function makes an attempt to choose a name
687 which has no existing file. To make this work,
688 PREFIX should be an absolute file name.
690 There is a race condition between calling `make-temp-name' and creating the
691 file which opens all kinds of security holes. For that reason, you should
692 probably use `make-temp-file' instead, except in three circumstances:
694 * If you are creating the file in the user's home directory.
695 * If you are creating a directory rather than an ordinary file.
696 * If you are taking special precautions as `make-temp-file' does. */)
699 return make_temp_name (prefix
, 0);
704 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
705 doc
: /* Convert filename NAME to absolute, and canonicalize it.
706 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
707 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
708 the current buffer's value of `default-directory' is used.
709 NAME should be a string that is a valid file name for the underlying
711 File name components that are `.' are removed, and
712 so are file name components followed by `..', along with the `..' itself;
713 note that these simplifications are done without checking the resulting
714 file names in the file system.
715 Multiple consecutive slashes are collapsed into a single slash,
716 except at the beginning of the file name when they are significant (e.g.,
717 UNC file names on MS-Windows.)
718 An initial `~/' expands to your home directory.
719 An initial `~USER/' expands to USER's home directory.
720 See also the function `substitute-in-file-name'.
722 For technical reasons, this function can return correct but
723 non-intuitive results for the root directory; for instance,
724 \(expand-file-name ".." "/") returns "/..". For this reason, use
725 \(directory-file-name (file-name-directory dirname)) to traverse a
726 filesystem tree, not (expand-file-name ".." dirname). */)
727 (Lisp_Object name
, Lisp_Object default_directory
)
729 /* These point to SDATA and need to be careful with string-relocation
730 during GC (via DECODE_FILE). */
733 /* This should only point to alloca'd data. */
740 int collapse_newdir
= 1;
744 Lisp_Object handler
, result
;
750 /* If the file name has special constructs in it,
751 call the corresponding file handler. */
752 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
754 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
756 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
757 if (NILP (default_directory
))
758 default_directory
= BVAR (current_buffer
, directory
);
759 if (! STRINGP (default_directory
))
762 /* "/" is not considered a root directory on DOS_NT, so using "/"
763 here causes an infinite recursion in, e.g., the following:
765 (let (default-directory)
766 (expand-file-name "a"))
768 To avoid this, we set default_directory to the root of the
770 default_directory
= build_string (emacs_root_dir ());
772 default_directory
= build_string ("/");
776 if (!NILP (default_directory
))
778 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
780 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
784 char *o
= SSDATA (default_directory
);
786 /* Make sure DEFAULT_DIRECTORY is properly expanded.
787 It would be better to do this down below where we actually use
788 default_directory. Unfortunately, calling Fexpand_file_name recursively
789 could invoke GC, and the strings might be relocated. This would
790 be annoying because we have pointers into strings lying around
791 that would need adjusting, and people would add new pointers to
792 the code and forget to adjust them, resulting in intermittent bugs.
793 Putting this call here avoids all that crud.
795 The EQ test avoids infinite recursion. */
796 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
797 /* Save time in some common cases - as long as default_directory
798 is not relative, it can be canonicalized with name below (if it
799 is needed at all) without requiring it to be expanded now. */
801 /* Detect MSDOS file names with drive specifiers. */
802 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
803 && IS_DIRECTORY_SEP (o
[2]))
805 /* Detect Windows file names in UNC format. */
806 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
808 #else /* not DOS_NT */
809 /* Detect Unix absolute file names (/... alone is not absolute on
811 && ! (IS_DIRECTORY_SEP (o
[0]))
812 #endif /* not DOS_NT */
818 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
822 name
= FILE_SYSTEM_CASE (name
);
823 multibyte
= STRING_MULTIBYTE (name
);
824 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
827 default_directory
= string_to_multibyte (default_directory
);
830 name
= string_to_multibyte (name
);
835 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
836 nm
= (char *) alloca (SBYTES (name
) + 1);
837 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
840 /* Note if special escape prefix is present, but remove for now. */
841 if (nm
[0] == '/' && nm
[1] == ':')
847 /* Find and remove drive specifier if present; this makes nm absolute
848 even if the rest of the name appears to be relative. Only look for
849 drive specifier at the beginning. */
850 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
852 drive
= (unsigned char) nm
[0];
857 /* If we see "c://somedir", we want to strip the first slash after the
858 colon when stripping the drive letter. Otherwise, this expands to
860 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
863 /* Discard any previous drive specifier if nm is now in UNC format. */
864 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
868 #endif /* WINDOWSNT */
871 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
872 none are found, we can probably return right away. We will avoid
873 allocating a new string if name is already fully expanded. */
875 IS_DIRECTORY_SEP (nm
[0])
877 && drive
&& !is_escaped
880 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
884 /* If it turns out that the filename we want to return is just a
885 suffix of FILENAME, we don't need to go through and edit
886 things; we just need to construct a new string using data
887 starting at the middle of FILENAME. If we set lose to a
888 non-zero value, that means we've discovered that we can't do
895 /* Since we know the name is absolute, we can assume that each
896 element starts with a "/". */
898 /* "." and ".." are hairy. */
899 if (IS_DIRECTORY_SEP (p
[0])
901 && (IS_DIRECTORY_SEP (p
[2])
903 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
906 /* We want to replace multiple `/' in a row with a single
909 && IS_DIRECTORY_SEP (p
[0])
910 && IS_DIRECTORY_SEP (p
[1]))
917 /* Make sure directories are all separated with /, but
918 avoid allocation of a new string when not required. */
919 dostounix_filename (nm
);
921 if (IS_DIRECTORY_SEP (nm
[1]))
923 if (strcmp (nm
, SSDATA (name
)) != 0)
924 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
928 /* drive must be set, so this is okay */
929 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
933 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
934 temp
[0] = DRIVE_LETTER (drive
);
935 name
= concat2 (build_string (temp
), name
);
938 #else /* not DOS_NT */
939 if (strcmp (nm
, SSDATA (name
)) == 0)
941 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
942 #endif /* not DOS_NT */
946 /* At this point, nm might or might not be an absolute file name. We
947 need to expand ~ or ~user if present, otherwise prefix nm with
948 default_directory if nm is not absolute, and finally collapse /./
949 and /foo/../ sequences.
951 We set newdir to be the appropriate prefix if one is needed:
952 - the relevant user directory if nm starts with ~ or ~user
953 - the specified drive's working dir (DOS/NT only) if nm does not
955 - the value of default_directory.
957 Note that these prefixes are not guaranteed to be absolute (except
958 for the working dir of a drive). Therefore, to ensure we always
959 return an absolute name, if the final prefix is not absolute we
960 append it to the current working directory. */
964 if (nm
[0] == '~') /* prefix ~ */
966 if (IS_DIRECTORY_SEP (nm
[1])
967 || nm
[1] == 0) /* ~ by itself */
971 if (!(newdir
= egetenv ("HOME")))
974 /* egetenv may return a unibyte string, which will bite us since
975 we expect the directory to be multibyte. */
976 tem
= build_string (newdir
);
977 if (!STRING_MULTIBYTE (tem
))
979 hdir
= DECODE_FILE (tem
);
980 newdir
= SSDATA (hdir
);
986 else /* ~user/filename */
989 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
990 o
= alloca (p
- nm
+ 1);
991 memcpy (o
, nm
, p
- nm
);
995 pw
= (struct passwd
*) getpwnam (o
+ 1);
1002 collapse_newdir
= 0;
1006 /* If we don't find a user of that name, leave the name
1007 unchanged; don't move nm forward to p. */
1012 /* On DOS and Windows, nm is absolute if a drive name was specified;
1013 use the drive's current directory as the prefix if needed. */
1014 if (!newdir
&& drive
)
1016 /* Get default directory if needed to make nm absolute. */
1018 if (!IS_DIRECTORY_SEP (nm
[0]))
1020 adir
= alloca (MAXPATHLEN
+ 1);
1021 if (!getdefdir (toupper (drive
) - 'A' + 1, adir
))
1026 /* Either nm starts with /, or drive isn't mounted. */
1028 adir
[0] = DRIVE_LETTER (drive
);
1037 /* Finally, if no prefix has been specified and nm is not absolute,
1038 then it must be expanded relative to default_directory. */
1042 /* /... alone is not absolute on DOS and Windows. */
1043 && !IS_DIRECTORY_SEP (nm
[0])
1046 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1050 newdir
= SSDATA (default_directory
);
1052 /* Note if special escape prefix is present, but remove for now. */
1053 if (newdir
[0] == '/' && newdir
[1] == ':')
1064 /* First ensure newdir is an absolute name. */
1066 /* Detect MSDOS file names with drive specifiers. */
1067 ! (IS_DRIVE (newdir
[0])
1068 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1070 /* Detect Windows file names in UNC format. */
1071 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1075 /* Effectively, let newdir be (expand-file-name newdir cwd).
1076 Because of the admonition against calling expand-file-name
1077 when we have pointers into lisp strings, we accomplish this
1078 indirectly by prepending newdir to nm if necessary, and using
1079 cwd (or the wd of newdir's drive) as the new newdir. */
1081 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1083 drive
= (unsigned char) newdir
[0];
1086 if (!IS_DIRECTORY_SEP (nm
[0]))
1088 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1089 file_name_as_directory (tmp
, newdir
);
1093 adir
= alloca (MAXPATHLEN
+ 1);
1096 if (!getdefdir (toupper (drive
) - 'A' + 1, adir
))
1104 /* Strip off drive name from prefix, if present. */
1105 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1111 /* Keep only a prefix from newdir if nm starts with slash
1112 (//server/share for UNC, nothing otherwise). */
1113 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1116 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1118 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1120 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1122 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1135 /* Get rid of any slash at the end of newdir, unless newdir is
1136 just / or // (an incomplete UNC name). */
1137 length
= strlen (newdir
);
1138 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1140 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1144 char *temp
= (char *) alloca (length
);
1145 memcpy (temp
, newdir
, length
- 1);
1146 temp
[length
- 1] = 0;
1154 /* Now concatenate the directory and name to new space in the stack frame */
1155 tlen
+= strlen (nm
) + 1;
1157 /* Reserve space for drive specifier and escape prefix, since either
1158 or both may need to be inserted. (The Microsoft x86 compiler
1159 produces incorrect code if the following two lines are combined.) */
1160 target
= (char *) alloca (tlen
+ 4);
1162 #else /* not DOS_NT */
1163 target
= (char *) alloca (tlen
);
1164 #endif /* not DOS_NT */
1169 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1172 /* If newdir is effectively "C:/", then the drive letter will have
1173 been stripped and newdir will be "/". Concatenating with an
1174 absolute directory in nm produces "//", which will then be
1175 incorrectly treated as a network share. Ignore newdir in
1176 this case (keeping the drive letter). */
1177 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1178 && newdir
[1] == '\0'))
1180 strcpy (target
, newdir
);
1183 file_name_as_directory (target
, newdir
);
1186 strcat (target
, nm
);
1188 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1196 if (!IS_DIRECTORY_SEP (*p
))
1200 else if (p
[1] == '.'
1201 && (IS_DIRECTORY_SEP (p
[2])
1204 /* If "/." is the entire filename, keep the "/". Otherwise,
1205 just delete the whole "/.". */
1206 if (o
== target
&& p
[2] == '\0')
1210 else if (p
[1] == '.' && p
[2] == '.'
1211 /* `/../' is the "superroot" on certain file systems.
1212 Turned off on DOS_NT systems because they have no
1213 "superroot" and because this causes us to produce
1214 file names like "d:/../foo" which fail file-related
1215 functions of the underlying OS. (To reproduce, try a
1216 long series of "../../" in default_directory, longer
1217 than the number of levels from the root.) */
1221 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1226 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1229 /* Don't go below server level in UNC filenames. */
1230 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1231 && IS_DIRECTORY_SEP (*target
))
1235 /* Keep initial / only if this is the whole name. */
1236 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1240 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1241 /* Collapse multiple `/' in a row. */
1250 /* At last, set drive name. */
1252 /* Except for network file name. */
1253 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1254 #endif /* WINDOWSNT */
1256 if (!drive
) abort ();
1258 target
[0] = DRIVE_LETTER (drive
);
1261 /* Reinsert the escape prefix if required. */
1268 dostounix_filename (target
);
1271 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1274 /* Again look to see if the file name has special constructs in it
1275 and perhaps call the corresponding file handler. This is needed
1276 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1277 the ".." component gives us "/user@host:/bar/../baz" which needs
1278 to be expanded again. */
1279 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1280 if (!NILP (handler
))
1281 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1287 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1288 This is the old version of expand-file-name, before it was thoroughly
1289 rewritten for Emacs 10.31. We leave this version here commented-out,
1290 because the code is very complex and likely to have subtle bugs. If
1291 bugs _are_ found, it might be of interest to look at the old code and
1292 see what did it do in the relevant situation.
1294 Don't remove this code: it's true that it will be accessible
1295 from the repository, but a few years from deletion, people will
1296 forget it is there. */
1298 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1299 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1300 "Convert FILENAME to absolute, and canonicalize it.\n\
1301 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1302 \(does not start with slash); if DEFAULT is nil or missing,\n\
1303 the current buffer's value of default-directory is used.\n\
1304 Filenames containing `.' or `..' as components are simplified;\n\
1305 initial `~/' expands to your home directory.\n\
1306 See also the function `substitute-in-file-name'.")
1308 Lisp_Object name
, defalt
;
1312 register unsigned char *newdir
, *p
, *o
;
1314 unsigned char *target
;
1318 CHECK_STRING (name
);
1321 /* If nm is absolute, flush ...// and detect /./ and /../.
1322 If no /./ or /../ we can return right away. */
1329 if (p
[0] == '/' && p
[1] == '/'
1332 if (p
[0] == '/' && p
[1] == '~')
1333 nm
= p
+ 1, lose
= 1;
1334 if (p
[0] == '/' && p
[1] == '.'
1335 && (p
[2] == '/' || p
[2] == 0
1336 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1342 if (nm
== SDATA (name
))
1344 return build_string (nm
);
1348 /* Now determine directory to start with and put it in NEWDIR */
1352 if (nm
[0] == '~') /* prefix ~ */
1353 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1355 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1356 newdir
= (unsigned char *) "";
1359 else /* ~user/filename */
1361 /* Get past ~ to user */
1362 unsigned char *user
= nm
+ 1;
1363 /* Find end of name. */
1364 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1365 int len
= ptr
? ptr
- user
: strlen (user
);
1366 /* Copy the user name into temp storage. */
1367 o
= (unsigned char *) alloca (len
+ 1);
1368 memcpy (o
, user
, len
);
1371 /* Look up the user name. */
1373 pw
= (struct passwd
*) getpwnam (o
+ 1);
1376 error ("\"%s\" isn't a registered user", o
+ 1);
1378 newdir
= (unsigned char *) pw
->pw_dir
;
1380 /* Discard the user name from NM. */
1384 if (nm
[0] != '/' && !newdir
)
1387 defalt
= current_buffer
->directory
;
1388 CHECK_STRING (defalt
);
1389 newdir
= SDATA (defalt
);
1392 /* Now concatenate the directory and name to new space in the stack frame */
1394 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1395 target
= (unsigned char *) alloca (tlen
);
1400 if (nm
[0] == 0 || nm
[0] == '/')
1401 strcpy (target
, newdir
);
1403 file_name_as_directory (target
, newdir
);
1406 strcat (target
, nm
);
1408 /* Now canonicalize by removing /. and /foo/.. if they appear */
1419 else if (!strncmp (p
, "//", 2)
1425 else if (p
[0] == '/' && p
[1] == '.'
1426 && (p
[2] == '/' || p
[2] == 0))
1428 else if (!strncmp (p
, "/..", 3)
1429 /* `/../' is the "superroot" on certain file systems. */
1431 && (p
[3] == '/' || p
[3] == 0))
1433 while (o
!= target
&& *--o
!= '/')
1435 if (o
== target
&& *o
== '/')
1445 return make_string (target
, o
- target
);
1449 /* If /~ or // appears, discard everything through first slash. */
1451 file_name_absolute_p (const char *filename
)
1454 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1456 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1457 && IS_DIRECTORY_SEP (filename
[2]))
1463 search_embedded_absfilename (char *nm
, char *endp
)
1467 for (p
= nm
+ 1; p
< endp
; p
++)
1470 || IS_DIRECTORY_SEP (p
[-1]))
1471 && file_name_absolute_p (p
)
1472 #if defined (WINDOWSNT) || defined(CYGWIN)
1473 /* // at start of file name is meaningful in Apollo,
1474 WindowsNT and Cygwin systems. */
1475 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1476 #endif /* not (WINDOWSNT || CYGWIN) */
1479 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1480 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
1482 char *o
= alloca (s
- p
+ 1);
1484 memcpy (o
, p
, s
- p
);
1487 /* If we have ~user and `user' exists, discard
1488 everything up to ~. But if `user' does not exist, leave
1489 ~user alone, it might be a literal file name. */
1491 pw
= getpwnam (o
+ 1);
1503 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1504 Ssubstitute_in_file_name
, 1, 1, 0,
1505 doc
: /* Substitute environment variables referred to in FILENAME.
1506 `$FOO' where FOO is an environment variable name means to substitute
1507 the value of that variable. The variable name should be terminated
1508 with a character not a letter, digit or underscore; otherwise, enclose
1509 the entire variable name in braces.
1511 If `/~' appears, all of FILENAME through that `/' is discarded.
1512 If `//' appears, everything up to and including the first of
1513 those `/' is discarded. */)
1514 (Lisp_Object filename
)
1518 register char *s
, *p
, *o
, *x
, *endp
;
1519 char *target
= NULL
;
1521 int substituted
= 0;
1524 Lisp_Object handler
;
1526 CHECK_STRING (filename
);
1528 multibyte
= STRING_MULTIBYTE (filename
);
1530 /* If the file name has special constructs in it,
1531 call the corresponding file handler. */
1532 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1533 if (!NILP (handler
))
1534 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
1536 /* Always work on a copy of the string, in case GC happens during
1537 decode of environment variables, causing the original Lisp_String
1538 data to be relocated. */
1539 nm
= (char *) alloca (SBYTES (filename
) + 1);
1540 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1543 dostounix_filename (nm
);
1544 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1546 endp
= nm
+ SBYTES (filename
);
1548 /* If /~ or // appears, discard everything through first slash. */
1549 p
= search_embedded_absfilename (nm
, endp
);
1551 /* Start over with the new string, so we check the file-name-handler
1552 again. Important with filenames like "/home/foo//:/hello///there"
1553 which whould substitute to "/:/hello///there" rather than "/there". */
1554 return Fsubstitute_in_file_name
1555 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1557 /* See if any variables are substituted into the string
1558 and find the total length of their values in `total' */
1560 for (p
= nm
; p
!= endp
;)
1570 /* "$$" means a single "$" */
1579 while (p
!= endp
&& *p
!= '}') p
++;
1580 if (*p
!= '}') goto missingclose
;
1586 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1590 /* Copy out the variable name */
1591 target
= (char *) alloca (s
- o
+ 1);
1592 strncpy (target
, o
, s
- o
);
1595 strupr (target
); /* $home == $HOME etc. */
1598 /* Get variable value */
1599 o
= egetenv (target
);
1602 /* Don't try to guess a maximum length - UTF8 can use up to
1603 four bytes per character. This code is unlikely to run
1604 in a situation that requires performance, so decoding the
1605 env variables twice should be acceptable. Note that
1606 decoding may cause a garbage collect. */
1607 Lisp_Object orig
, decoded
;
1608 orig
= make_unibyte_string (o
, strlen (o
));
1609 decoded
= DECODE_FILE (orig
);
1610 total
+= SBYTES (decoded
);
1620 /* If substitution required, recopy the string and do it */
1621 /* Make space in stack frame for the new copy */
1622 xnm
= (char *) alloca (SBYTES (filename
) + total
+ 1);
1625 /* Copy the rest of the name through, replacing $ constructs with values */
1642 while (p
!= endp
&& *p
!= '}') p
++;
1643 if (*p
!= '}') goto missingclose
;
1649 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1653 /* Copy out the variable name */
1654 target
= (char *) alloca (s
- o
+ 1);
1655 strncpy (target
, o
, s
- o
);
1658 strupr (target
); /* $home == $HOME etc. */
1661 /* Get variable value */
1662 o
= egetenv (target
);
1666 strcpy (x
, target
); x
+= strlen (target
);
1670 Lisp_Object orig
, decoded
;
1671 int orig_length
, decoded_length
;
1672 orig_length
= strlen (o
);
1673 orig
= make_unibyte_string (o
, orig_length
);
1674 decoded
= DECODE_FILE (orig
);
1675 decoded_length
= SBYTES (decoded
);
1676 strncpy (x
, SSDATA (decoded
), decoded_length
);
1677 x
+= decoded_length
;
1679 /* If environment variable needed decoding, return value
1680 needs to be multibyte. */
1681 if (decoded_length
!= orig_length
1682 || strncmp (SSDATA (decoded
), o
, orig_length
))
1689 /* If /~ or // appears, discard everything through first slash. */
1690 while ((p
= search_embedded_absfilename (xnm
, x
)))
1691 /* This time we do not start over because we've already expanded envvars
1692 and replaced $$ with $. Maybe we should start over as well, but we'd
1693 need to quote some $ to $$ first. */
1696 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1699 error ("Bad format environment-variable substitution");
1701 error ("Missing \"}\" in environment-variable substitution");
1703 error ("Substituting nonexistent environment variable \"%s\"", target
);
1709 /* A slightly faster and more convenient way to get
1710 (directory-file-name (expand-file-name FOO)). */
1713 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1715 register Lisp_Object absname
;
1717 absname
= Fexpand_file_name (filename
, defdir
);
1719 /* Remove final slash, if any (unless this is the root dir).
1720 stat behaves differently depending! */
1721 if (SCHARS (absname
) > 1
1722 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1723 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
1724 /* We cannot take shortcuts; they might be wrong for magic file names. */
1725 absname
= Fdirectory_file_name (absname
);
1729 /* Signal an error if the file ABSNAME already exists.
1730 If INTERACTIVE is nonzero, ask the user whether to proceed,
1731 and bypass the error if the user says to go ahead.
1732 QUERYSTRING is a name for the action that is being considered
1735 *STATPTR is used to store the stat information if the file exists.
1736 If the file does not exist, STATPTR->st_mode is set to 0.
1737 If STATPTR is null, we don't store into it.
1739 If QUICK is nonzero, we ask for y or n, not yes or no. */
1742 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1743 int interactive
, struct stat
*statptr
, int quick
)
1745 register Lisp_Object tem
, encoded_filename
;
1746 struct stat statbuf
;
1747 struct gcpro gcpro1
;
1749 encoded_filename
= ENCODE_FILE (absname
);
1751 /* stat is a good way to tell whether the file exists,
1752 regardless of what access permissions it has. */
1753 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1756 xsignal2 (Qfile_already_exists
,
1757 build_string ("File already exists"), absname
);
1759 tem
= format2 ("File %s already exists; %s anyway? ",
1760 absname
, build_string (querystring
));
1762 tem
= call1 (intern ("y-or-n-p"), tem
);
1764 tem
= do_yes_or_no_p (tem
);
1767 xsignal2 (Qfile_already_exists
,
1768 build_string ("File already exists"), absname
);
1775 statptr
->st_mode
= 0;
1780 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1781 "fCopy file: \nGCopy %s to file: \np\nP",
1782 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1783 If NEWNAME names a directory, copy FILE there.
1785 This function always sets the file modes of the output file to match
1788 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1789 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1790 signal a `file-already-exists' error without overwriting. If
1791 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1792 about overwriting; this is what happens in interactive use with M-x.
1793 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1796 Fourth arg KEEP-TIME non-nil means give the output file the same
1797 last-modified time as the old one. (This works on only some systems.)
1799 A prefix arg makes KEEP-TIME non-nil.
1801 If PRESERVE-UID-GID is non-nil, we try to transfer the
1802 uid and gid of FILE to NEWNAME.
1804 If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
1805 on the system, we copy the SELinux context of FILE to NEWNAME. */)
1806 (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
)
1809 char buf
[16 * 1024];
1810 struct stat st
, out_st
;
1811 Lisp_Object handler
;
1812 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1813 int count
= SPECPDL_INDEX ();
1814 int input_file_statable_p
;
1815 Lisp_Object encoded_file
, encoded_newname
;
1817 security_context_t con
;
1818 int fail
, conlength
= 0;
1821 encoded_file
= encoded_newname
= Qnil
;
1822 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1823 CHECK_STRING (file
);
1824 CHECK_STRING (newname
);
1826 if (!NILP (Ffile_directory_p (newname
)))
1827 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1829 newname
= Fexpand_file_name (newname
, Qnil
);
1831 file
= Fexpand_file_name (file
, Qnil
);
1833 /* If the input file name has special constructs in it,
1834 call the corresponding file handler. */
1835 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1836 /* Likewise for output file name. */
1838 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1839 if (!NILP (handler
))
1840 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1841 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1842 preserve_selinux_context
));
1844 encoded_file
= ENCODE_FILE (file
);
1845 encoded_newname
= ENCODE_FILE (newname
);
1847 if (NILP (ok_if_already_exists
)
1848 || INTEGERP (ok_if_already_exists
))
1849 barf_or_query_if_file_exists (newname
, "copy to it",
1850 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1851 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1855 if (!CopyFile (SDATA (encoded_file
),
1856 SDATA (encoded_newname
),
1858 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1859 /* CopyFile retains the timestamp by default. */
1860 else if (NILP (keep_time
))
1866 EMACS_GET_TIME (now
);
1867 filename
= SDATA (encoded_newname
);
1869 /* Ensure file is writable while its modified time is set. */
1870 attributes
= GetFileAttributes (filename
);
1871 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1872 if (set_file_times (filename
, now
, now
))
1874 /* Restore original attributes. */
1875 SetFileAttributes (filename
, attributes
);
1876 xsignal2 (Qfile_date_error
,
1877 build_string ("Cannot set file date"), newname
);
1879 /* Restore original attributes. */
1880 SetFileAttributes (filename
, attributes
);
1882 #else /* not WINDOWSNT */
1884 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
1888 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1890 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1892 /* We can only copy regular files and symbolic links. Other files are not
1894 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
1897 if (!NILP (preserve_selinux_context
) && is_selinux_enabled ())
1899 conlength
= fgetfilecon (ifd
, &con
);
1900 if (conlength
== -1)
1901 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
1905 if (out_st
.st_mode
!= 0
1906 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
1909 report_file_error ("Input and output files are the same",
1910 Fcons (file
, Fcons (newname
, Qnil
)));
1913 if (input_file_statable_p
)
1915 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
1917 #if defined (EISDIR)
1918 /* Get a better looking error message. */
1921 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
1926 /* System's default file type was set to binary by _fmode in emacs.c. */
1927 ofd
= emacs_open (SDATA (encoded_newname
),
1928 O_WRONLY
| O_TRUNC
| O_CREAT
1929 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
1930 S_IREAD
| S_IWRITE
);
1931 #else /* not MSDOS */
1932 ofd
= emacs_open (SSDATA (encoded_newname
),
1933 O_WRONLY
| O_TRUNC
| O_CREAT
1934 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
1936 #endif /* not MSDOS */
1938 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
1940 record_unwind_protect (close_file_unwind
, make_number (ofd
));
1944 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
1945 if (emacs_write (ofd
, buf
, n
) != n
)
1946 report_file_error ("I/O error", Fcons (newname
, Qnil
));
1950 /* Preserve the original file modes, and if requested, also its
1952 if (input_file_statable_p
)
1954 if (! NILP (preserve_uid_gid
))
1955 fchown (ofd
, st
.st_uid
, st
.st_gid
);
1956 fchmod (ofd
, st
.st_mode
& 07777);
1958 #endif /* not MSDOS */
1963 /* Set the modified context back to the file. */
1964 fail
= fsetfilecon (ofd
, con
);
1966 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
1972 /* Closing the output clobbers the file times on some systems. */
1973 if (emacs_close (ofd
) < 0)
1974 report_file_error ("I/O error", Fcons (newname
, Qnil
));
1976 if (input_file_statable_p
)
1978 if (!NILP (keep_time
))
1980 EMACS_TIME atime
, mtime
;
1981 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
1982 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
1983 if (set_file_times (SSDATA (encoded_newname
),
1985 xsignal2 (Qfile_date_error
,
1986 build_string ("Cannot set file date"), newname
);
1993 if (input_file_statable_p
)
1995 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
1996 and if it can't, it tells so. Otherwise, under MSDOS we usually
1997 get only the READ bit, which will make the copied file read-only,
1998 so it's better not to chmod at all. */
1999 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2000 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2003 #endif /* not WINDOWSNT */
2005 /* Discard the unwind protects. */
2006 specpdl_ptr
= specpdl
+ count
;
2012 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2013 Smake_directory_internal
, 1, 1, 0,
2014 doc
: /* Create a new directory named DIRECTORY. */)
2015 (Lisp_Object directory
)
2018 Lisp_Object handler
;
2019 Lisp_Object encoded_dir
;
2021 CHECK_STRING (directory
);
2022 directory
= Fexpand_file_name (directory
, Qnil
);
2024 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2025 if (!NILP (handler
))
2026 return call2 (handler
, Qmake_directory_internal
, directory
);
2028 encoded_dir
= ENCODE_FILE (directory
);
2030 dir
= SSDATA (encoded_dir
);
2033 if (mkdir (dir
) != 0)
2035 if (mkdir (dir
, 0777) != 0)
2037 report_file_error ("Creating directory", list1 (directory
));
2042 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2043 Sdelete_directory_internal
, 1, 1, 0,
2044 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2045 (Lisp_Object directory
)
2048 Lisp_Object encoded_dir
;
2050 CHECK_STRING (directory
);
2051 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2052 encoded_dir
= ENCODE_FILE (directory
);
2053 dir
= SSDATA (encoded_dir
);
2055 if (rmdir (dir
) != 0)
2056 report_file_error ("Removing directory", list1 (directory
));
2061 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2062 "(list (read-file-name \
2063 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2064 \"Move file to trash: \" \"Delete file: \") \
2065 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2066 (null current-prefix-arg))",
2067 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2068 If file has multiple names, it continues to exist with the other names.
2069 TRASH non-nil means to trash the file instead of deleting, provided
2070 `delete-by-moving-to-trash' is non-nil.
2072 When called interactively, TRASH is t if no prefix argument is given.
2073 With a prefix argument, TRASH is nil. */)
2074 (Lisp_Object filename
, Lisp_Object trash
)
2076 Lisp_Object handler
;
2077 Lisp_Object encoded_file
;
2078 struct gcpro gcpro1
;
2081 if (!NILP (Ffile_directory_p (filename
))
2082 && NILP (Ffile_symlink_p (filename
)))
2083 xsignal2 (Qfile_error
,
2084 build_string ("Removing old name: is a directory"),
2087 filename
= Fexpand_file_name (filename
, Qnil
);
2089 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2090 if (!NILP (handler
))
2091 return call3 (handler
, Qdelete_file
, filename
, trash
);
2093 if (delete_by_moving_to_trash
&& !NILP (trash
))
2094 return call1 (Qmove_file_to_trash
, filename
);
2096 encoded_file
= ENCODE_FILE (filename
);
2098 if (0 > unlink (SSDATA (encoded_file
)))
2099 report_file_error ("Removing old name", list1 (filename
));
2104 internal_delete_file_1 (Lisp_Object ignore
)
2109 /* Delete file FILENAME, returning 1 if successful and 0 if failed.
2110 This ignores `delete-by-moving-to-trash'. */
2113 internal_delete_file (Lisp_Object filename
)
2117 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2118 Qt
, internal_delete_file_1
);
2122 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2123 "fRename file: \nGRename %s to file: \np",
2124 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2125 If file has names other than FILE, it continues to have those names.
2126 Signals a `file-already-exists' error if a file NEWNAME already exists
2127 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2128 A number as third arg means request confirmation if NEWNAME already exists.
2129 This is what happens in interactive use with M-x. */)
2130 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2132 Lisp_Object handler
;
2133 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2134 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2136 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2137 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2138 CHECK_STRING (file
);
2139 CHECK_STRING (newname
);
2140 file
= Fexpand_file_name (file
, Qnil
);
2142 if ((!NILP (Ffile_directory_p (newname
)))
2144 /* If the file names are identical but for the case,
2145 don't attempt to move directory to itself. */
2146 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2150 Lisp_Object fname
= NILP (Ffile_directory_p (file
))
2151 ? file
: Fdirectory_file_name (file
);
2152 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2155 newname
= Fexpand_file_name (newname
, Qnil
);
2157 /* If the file name has special constructs in it,
2158 call the corresponding file handler. */
2159 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2161 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2162 if (!NILP (handler
))
2163 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2164 file
, newname
, ok_if_already_exists
));
2166 encoded_file
= ENCODE_FILE (file
);
2167 encoded_newname
= ENCODE_FILE (newname
);
2170 /* If the file names are identical but for the case, don't ask for
2171 confirmation: they simply want to change the letter-case of the
2173 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2175 if (NILP (ok_if_already_exists
)
2176 || INTEGERP (ok_if_already_exists
))
2177 barf_or_query_if_file_exists (newname
, "rename to it",
2178 INTEGERP (ok_if_already_exists
), 0, 0);
2179 if (0 > rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2184 symlink_target
= Ffile_symlink_p (file
);
2185 if (! NILP (symlink_target
))
2186 Fmake_symbolic_link (symlink_target
, newname
,
2187 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2188 else if (!NILP (Ffile_directory_p (file
)))
2189 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2191 /* We have already prompted if it was an integer, so don't
2192 have copy-file prompt again. */
2193 Fcopy_file (file
, newname
,
2194 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2197 count
= SPECPDL_INDEX ();
2198 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2200 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2201 call2 (Qdelete_directory
, file
, Qt
);
2203 Fdelete_file (file
, Qnil
);
2204 unbind_to (count
, Qnil
);
2207 report_file_error ("Renaming", list2 (file
, newname
));
2213 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2214 "fAdd name to file: \nGName to add to %s: \np",
2215 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2216 Signals a `file-already-exists' error if a file NEWNAME already exists
2217 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2218 A number as third arg means request confirmation if NEWNAME already exists.
2219 This is what happens in interactive use with M-x. */)
2220 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2222 Lisp_Object handler
;
2223 Lisp_Object encoded_file
, encoded_newname
;
2224 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2226 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2227 encoded_file
= encoded_newname
= Qnil
;
2228 CHECK_STRING (file
);
2229 CHECK_STRING (newname
);
2230 file
= Fexpand_file_name (file
, Qnil
);
2232 if (!NILP (Ffile_directory_p (newname
)))
2233 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2235 newname
= Fexpand_file_name (newname
, Qnil
);
2237 /* If the file name has special constructs in it,
2238 call the corresponding file handler. */
2239 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2240 if (!NILP (handler
))
2241 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2242 newname
, ok_if_already_exists
));
2244 /* If the new name has special constructs in it,
2245 call the corresponding file handler. */
2246 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2247 if (!NILP (handler
))
2248 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2249 newname
, ok_if_already_exists
));
2251 encoded_file
= ENCODE_FILE (file
);
2252 encoded_newname
= ENCODE_FILE (newname
);
2254 if (NILP (ok_if_already_exists
)
2255 || INTEGERP (ok_if_already_exists
))
2256 barf_or_query_if_file_exists (newname
, "make it a new name",
2257 INTEGERP (ok_if_already_exists
), 0, 0);
2259 unlink (SSDATA (newname
));
2260 if (0 > link (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2261 report_file_error ("Adding new name", list2 (file
, newname
));
2267 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2268 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2269 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2270 Both args must be strings.
2271 Signals a `file-already-exists' error if a file LINKNAME already exists
2272 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2273 A number as third arg means request confirmation if LINKNAME already exists.
2274 This happens for interactive use with M-x. */)
2275 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2277 Lisp_Object handler
;
2278 Lisp_Object encoded_filename
, encoded_linkname
;
2279 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2281 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2282 encoded_filename
= encoded_linkname
= Qnil
;
2283 CHECK_STRING (filename
);
2284 CHECK_STRING (linkname
);
2285 /* If the link target has a ~, we must expand it to get
2286 a truly valid file name. Otherwise, do not expand;
2287 we want to permit links to relative file names. */
2288 if (SREF (filename
, 0) == '~')
2289 filename
= Fexpand_file_name (filename
, Qnil
);
2291 if (!NILP (Ffile_directory_p (linkname
)))
2292 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2294 linkname
= Fexpand_file_name (linkname
, Qnil
);
2296 /* If the file name has special constructs in it,
2297 call the corresponding file handler. */
2298 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2299 if (!NILP (handler
))
2300 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2301 linkname
, ok_if_already_exists
));
2303 /* If the new link name has special constructs in it,
2304 call the corresponding file handler. */
2305 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2306 if (!NILP (handler
))
2307 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2308 linkname
, ok_if_already_exists
));
2310 encoded_filename
= ENCODE_FILE (filename
);
2311 encoded_linkname
= ENCODE_FILE (linkname
);
2313 if (NILP (ok_if_already_exists
)
2314 || INTEGERP (ok_if_already_exists
))
2315 barf_or_query_if_file_exists (linkname
, "make it a link",
2316 INTEGERP (ok_if_already_exists
), 0, 0);
2317 if (0 > symlink (SSDATA (encoded_filename
),
2318 SSDATA (encoded_linkname
)))
2320 /* If we didn't complain already, silently delete existing file. */
2321 if (errno
== EEXIST
)
2323 unlink (SSDATA (encoded_linkname
));
2324 if (0 <= symlink (SSDATA (encoded_filename
),
2325 SSDATA (encoded_linkname
)))
2331 if (errno
== ENOSYS
)
2334 xsignal1 (Qfile_error
,
2335 build_string ("Symbolic links are not supported"));
2338 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2345 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2347 doc
: /* Return t if file FILENAME specifies an absolute file name.
2348 On Unix, this is a name starting with a `/' or a `~'. */)
2349 (Lisp_Object filename
)
2351 CHECK_STRING (filename
);
2352 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2355 /* Return nonzero if file FILENAME exists and can be executed. */
2358 check_executable (char *filename
)
2361 int len
= strlen (filename
);
2364 if (stat (filename
, &st
) < 0)
2366 return ((st
.st_mode
& S_IEXEC
) != 0);
2367 #else /* not DOS_NT */
2368 #ifdef HAVE_EUIDACCESS
2369 return (euidaccess (filename
, 1) >= 0);
2371 /* Access isn't quite right because it uses the real uid
2372 and we really want to test with the effective uid.
2373 But Unix doesn't give us a right way to do it. */
2374 return (access (filename
, 1) >= 0);
2376 #endif /* not DOS_NT */
2379 /* Return nonzero if file FILENAME exists and can be written. */
2382 check_writable (const char *filename
)
2386 if (stat (filename
, &st
) < 0)
2388 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2389 #else /* not MSDOS */
2390 #ifdef HAVE_EUIDACCESS
2391 return (euidaccess (filename
, 2) >= 0);
2393 /* Access isn't quite right because it uses the real uid
2394 and we really want to test with the effective uid.
2395 But Unix doesn't give us a right way to do it.
2396 Opening with O_WRONLY could work for an ordinary file,
2397 but would lose for directories. */
2398 return (access (filename
, 2) >= 0);
2400 #endif /* not MSDOS */
2403 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2404 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2405 See also `file-readable-p' and `file-attributes'.
2406 This returns nil for a symlink to a nonexistent file.
2407 Use `file-symlink-p' to test for such links. */)
2408 (Lisp_Object filename
)
2410 Lisp_Object absname
;
2411 Lisp_Object handler
;
2412 struct stat statbuf
;
2414 CHECK_STRING (filename
);
2415 absname
= Fexpand_file_name (filename
, Qnil
);
2417 /* If the file name has special constructs in it,
2418 call the corresponding file handler. */
2419 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2420 if (!NILP (handler
))
2421 return call2 (handler
, Qfile_exists_p
, absname
);
2423 absname
= ENCODE_FILE (absname
);
2425 return (stat (SSDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2428 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2429 doc
: /* Return t if FILENAME can be executed by you.
2430 For a directory, this means you can access files in that directory. */)
2431 (Lisp_Object filename
)
2433 Lisp_Object absname
;
2434 Lisp_Object handler
;
2436 CHECK_STRING (filename
);
2437 absname
= Fexpand_file_name (filename
, Qnil
);
2439 /* If the file name has special constructs in it,
2440 call the corresponding file handler. */
2441 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2442 if (!NILP (handler
))
2443 return call2 (handler
, Qfile_executable_p
, absname
);
2445 absname
= ENCODE_FILE (absname
);
2447 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2450 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2451 doc
: /* Return t if file FILENAME exists and you can read it.
2452 See also `file-exists-p' and `file-attributes'. */)
2453 (Lisp_Object filename
)
2455 Lisp_Object absname
;
2456 Lisp_Object handler
;
2459 struct stat statbuf
;
2461 CHECK_STRING (filename
);
2462 absname
= Fexpand_file_name (filename
, Qnil
);
2464 /* If the file name has special constructs in it,
2465 call the corresponding file handler. */
2466 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2467 if (!NILP (handler
))
2468 return call2 (handler
, Qfile_readable_p
, absname
);
2470 absname
= ENCODE_FILE (absname
);
2472 #if defined(DOS_NT) || defined(macintosh)
2473 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2475 if (access (SDATA (absname
), 0) == 0)
2478 #else /* not DOS_NT and not macintosh */
2481 /* Opening a fifo without O_NONBLOCK can wait.
2482 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2483 except in the case of a fifo, on a system which handles it. */
2484 desc
= stat (SSDATA (absname
), &statbuf
);
2487 if (S_ISFIFO (statbuf
.st_mode
))
2488 flags
|= O_NONBLOCK
;
2490 desc
= emacs_open (SSDATA (absname
), flags
, 0);
2495 #endif /* not DOS_NT and not macintosh */
2498 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2500 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2501 doc
: /* Return t if file FILENAME can be written or created by you. */)
2502 (Lisp_Object filename
)
2504 Lisp_Object absname
, dir
, encoded
;
2505 Lisp_Object handler
;
2506 struct stat statbuf
;
2508 CHECK_STRING (filename
);
2509 absname
= Fexpand_file_name (filename
, Qnil
);
2511 /* If the file name has special constructs in it,
2512 call the corresponding file handler. */
2513 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2514 if (!NILP (handler
))
2515 return call2 (handler
, Qfile_writable_p
, absname
);
2517 encoded
= ENCODE_FILE (absname
);
2518 if (stat (SSDATA (encoded
), &statbuf
) >= 0)
2519 return (check_writable (SSDATA (encoded
))
2522 dir
= Ffile_name_directory (absname
);
2525 dir
= Fdirectory_file_name (dir
);
2528 dir
= ENCODE_FILE (dir
);
2530 /* The read-only attribute of the parent directory doesn't affect
2531 whether a file or directory can be created within it. Some day we
2532 should check ACLs though, which do affect this. */
2533 if (stat (SDATA (dir
), &statbuf
) < 0)
2535 return S_ISDIR (statbuf
.st_mode
) ? Qt
: Qnil
;
2537 return (check_writable (!NILP (dir
) ? SSDATA (dir
) : "")
2542 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2543 doc
: /* Access file FILENAME, and get an error if that does not work.
2544 The second argument STRING is used in the error message.
2545 If there is no error, returns nil. */)
2546 (Lisp_Object filename
, Lisp_Object string
)
2548 Lisp_Object handler
, encoded_filename
, absname
;
2551 CHECK_STRING (filename
);
2552 absname
= Fexpand_file_name (filename
, Qnil
);
2554 CHECK_STRING (string
);
2556 /* If the file name has special constructs in it,
2557 call the corresponding file handler. */
2558 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2559 if (!NILP (handler
))
2560 return call3 (handler
, Qaccess_file
, absname
, string
);
2562 encoded_filename
= ENCODE_FILE (absname
);
2564 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2566 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2572 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2573 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2574 The value is the link target, as a string.
2575 Otherwise it returns nil.
2577 This function returns t when given the name of a symlink that
2578 points to a nonexistent file. */)
2579 (Lisp_Object filename
)
2581 Lisp_Object handler
;
2587 CHECK_STRING (filename
);
2588 filename
= Fexpand_file_name (filename
, Qnil
);
2590 /* If the file name has special constructs in it,
2591 call the corresponding file handler. */
2592 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2593 if (!NILP (handler
))
2594 return call2 (handler
, Qfile_symlink_p
, filename
);
2596 filename
= ENCODE_FILE (filename
);
2603 buf
= (char *) xrealloc (buf
, bufsize
);
2604 memset (buf
, 0, bufsize
);
2607 valsize
= readlink (SSDATA (filename
), buf
, bufsize
);
2611 /* HP-UX reports ERANGE if buffer is too small. */
2612 if (errno
== ERANGE
)
2622 while (valsize
>= bufsize
);
2624 val
= make_string (buf
, valsize
);
2625 if (buf
[0] == '/' && strchr (buf
, ':'))
2626 val
= concat2 (build_string ("/:"), val
);
2628 val
= DECODE_FILE (val
);
2632 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2633 doc
: /* Return t if FILENAME names an existing directory.
2634 Symbolic links to directories count as directories.
2635 See `file-symlink-p' to distinguish symlinks. */)
2636 (Lisp_Object filename
)
2638 register Lisp_Object absname
;
2640 Lisp_Object handler
;
2642 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2644 /* If the file name has special constructs in it,
2645 call the corresponding file handler. */
2646 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2647 if (!NILP (handler
))
2648 return call2 (handler
, Qfile_directory_p
, absname
);
2650 absname
= ENCODE_FILE (absname
);
2652 if (stat (SSDATA (absname
), &st
) < 0)
2654 return S_ISDIR (st
.st_mode
) ? Qt
: Qnil
;
2657 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
2658 doc
: /* Return t if file FILENAME names a directory you can open.
2659 For the value to be t, FILENAME must specify the name of a directory as a file,
2660 and the directory must allow you to open files in it. In order to use a
2661 directory as a buffer's current directory, this predicate must return true.
2662 A directory name spec may be given instead; then the value is t
2663 if the directory so specified exists and really is a readable and
2664 searchable directory. */)
2665 (Lisp_Object filename
)
2667 Lisp_Object handler
;
2669 struct gcpro gcpro1
;
2671 /* If the file name has special constructs in it,
2672 call the corresponding file handler. */
2673 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2674 if (!NILP (handler
))
2675 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2678 tem
= (NILP (Ffile_directory_p (filename
))
2679 || NILP (Ffile_executable_p (filename
)));
2681 return tem
? Qnil
: Qt
;
2684 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2685 doc
: /* Return t if FILENAME names a regular file.
2686 This is the sort of file that holds an ordinary stream of data bytes.
2687 Symbolic links to regular files count as regular files.
2688 See `file-symlink-p' to distinguish symlinks. */)
2689 (Lisp_Object filename
)
2691 register Lisp_Object absname
;
2693 Lisp_Object handler
;
2695 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2697 /* If the file name has special constructs in it,
2698 call the corresponding file handler. */
2699 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2700 if (!NILP (handler
))
2701 return call2 (handler
, Qfile_regular_p
, absname
);
2703 absname
= ENCODE_FILE (absname
);
2708 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2710 /* Tell stat to use expensive method to get accurate info. */
2711 Vw32_get_true_file_attributes
= Qt
;
2712 result
= stat (SDATA (absname
), &st
);
2713 Vw32_get_true_file_attributes
= tem
;
2717 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2720 if (stat (SSDATA (absname
), &st
) < 0)
2722 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2726 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2727 Sfile_selinux_context
, 1, 1, 0,
2728 doc
: /* Return SELinux context of file named FILENAME,
2729 as a list ("user", "role", "type", "range"). Return (nil, nil, nil, nil)
2730 if file does not exist, is not accessible, or SELinux is disabled */)
2731 (Lisp_Object filename
)
2733 Lisp_Object absname
;
2734 Lisp_Object values
[4];
2735 Lisp_Object handler
;
2737 security_context_t con
;
2742 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2744 /* If the file name has special constructs in it,
2745 call the corresponding file handler. */
2746 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2747 if (!NILP (handler
))
2748 return call2 (handler
, Qfile_selinux_context
, absname
);
2750 absname
= ENCODE_FILE (absname
);
2757 if (is_selinux_enabled ())
2759 conlength
= lgetfilecon (SDATA (absname
), &con
);
2762 context
= context_new (con
);
2763 if (context_user_get (context
))
2764 values
[0] = build_string (context_user_get (context
));
2765 if (context_role_get (context
))
2766 values
[1] = build_string (context_role_get (context
));
2767 if (context_type_get (context
))
2768 values
[2] = build_string (context_type_get (context
));
2769 if (context_range_get (context
))
2770 values
[3] = build_string (context_range_get (context
));
2771 context_free (context
);
2778 return Flist (sizeof(values
) / sizeof(values
[0]), values
);
2781 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2782 Sset_file_selinux_context
, 2, 2, 0,
2783 doc
: /* Set SELinux context of file named FILENAME to CONTEXT
2784 as a list ("user", "role", "type", "range"). Has no effect if SELinux
2786 (Lisp_Object filename
, Lisp_Object context
)
2788 Lisp_Object absname
, encoded_absname
;
2789 Lisp_Object handler
;
2790 Lisp_Object user
= CAR_SAFE (context
);
2791 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2792 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2793 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2795 security_context_t con
;
2796 int fail
, conlength
;
2797 context_t parsed_con
;
2800 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2802 /* If the file name has special constructs in it,
2803 call the corresponding file handler. */
2804 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2805 if (!NILP (handler
))
2806 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2808 encoded_absname
= ENCODE_FILE (absname
);
2811 if (is_selinux_enabled ())
2813 /* Get current file context. */
2814 conlength
= lgetfilecon (SDATA (encoded_absname
), &con
);
2817 parsed_con
= context_new (con
);
2818 /* Change the parts defined in the parameter.*/
2821 if (context_user_set (parsed_con
, SDATA (user
)))
2822 error ("Doing context_user_set");
2826 if (context_role_set (parsed_con
, SDATA (role
)))
2827 error ("Doing context_role_set");
2831 if (context_type_set (parsed_con
, SDATA (type
)))
2832 error ("Doing context_type_set");
2834 if (STRINGP (range
))
2836 if (context_range_set (parsed_con
, SDATA (range
)))
2837 error ("Doing context_range_set");
2840 /* Set the modified context back to the file. */
2841 fail
= lsetfilecon (SDATA (encoded_absname
), context_str (parsed_con
));
2843 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
2845 context_free (parsed_con
);
2848 report_file_error("Doing lgetfilecon", Fcons (absname
, Qnil
));
2858 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2859 doc
: /* Return mode bits of file named FILENAME, as an integer.
2860 Return nil, if file does not exist or is not accessible. */)
2861 (Lisp_Object filename
)
2863 Lisp_Object absname
;
2865 Lisp_Object handler
;
2867 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2869 /* If the file name has special constructs in it,
2870 call the corresponding file handler. */
2871 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2872 if (!NILP (handler
))
2873 return call2 (handler
, Qfile_modes
, absname
);
2875 absname
= ENCODE_FILE (absname
);
2877 if (stat (SSDATA (absname
), &st
) < 0)
2880 return make_number (st
.st_mode
& 07777);
2883 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2884 "(let ((file (read-file-name \"File: \"))) \
2885 (list file (read-file-modes nil file)))",
2886 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2887 Only the 12 low bits of MODE are used.
2889 Interactively, mode bits are read by `read-file-modes', which accepts
2890 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2891 (Lisp_Object filename
, Lisp_Object mode
)
2893 Lisp_Object absname
, encoded_absname
;
2894 Lisp_Object handler
;
2896 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2897 CHECK_NUMBER (mode
);
2899 /* If the file name has special constructs in it,
2900 call the corresponding file handler. */
2901 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2902 if (!NILP (handler
))
2903 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2905 encoded_absname
= ENCODE_FILE (absname
);
2907 if (chmod (SSDATA (encoded_absname
), XINT (mode
)) < 0)
2908 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2913 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2914 doc
: /* Set the file permission bits for newly created files.
2915 The argument MODE should be an integer; only the low 9 bits are used.
2916 This setting is inherited by subprocesses. */)
2919 CHECK_NUMBER (mode
);
2921 umask ((~ XINT (mode
)) & 0777);
2926 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
2927 doc
: /* Return the default file protection for created files.
2928 The value is an integer. */)
2934 realmask
= umask (0);
2937 XSETINT (value
, (~ realmask
) & 0777);
2942 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
2943 doc
: /* Set times of file FILENAME to TIME.
2944 Set both access and modification times.
2945 Return t on success, else nil.
2946 Use the current time if TIME is nil. TIME is in the format of
2948 (Lisp_Object filename
, Lisp_Object time
)
2950 Lisp_Object absname
, encoded_absname
;
2951 Lisp_Object handler
;
2955 if (! lisp_time_argument (time
, &sec
, &usec
))
2956 error ("Invalid time specification");
2958 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2960 /* If the file name has special constructs in it,
2961 call the corresponding file handler. */
2962 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
2963 if (!NILP (handler
))
2964 return call3 (handler
, Qset_file_times
, absname
, time
);
2966 encoded_absname
= ENCODE_FILE (absname
);
2971 EMACS_SET_SECS (t
, sec
);
2972 EMACS_SET_USECS (t
, usec
);
2974 if (set_file_times (SSDATA (encoded_absname
), t
, t
))
2979 /* Setting times on a directory always fails. */
2980 if (stat (SSDATA (encoded_absname
), &st
) == 0 && S_ISDIR (st
.st_mode
))
2983 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
2992 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
2993 doc
: /* Tell Unix to finish all pending disk updates. */)
3000 #endif /* HAVE_SYNC */
3002 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3003 doc
: /* Return t if file FILE1 is newer than file FILE2.
3004 If FILE1 does not exist, the answer is nil;
3005 otherwise, if FILE2 does not exist, the answer is t. */)
3006 (Lisp_Object file1
, Lisp_Object file2
)
3008 Lisp_Object absname1
, absname2
;
3011 Lisp_Object handler
;
3012 struct gcpro gcpro1
, gcpro2
;
3014 CHECK_STRING (file1
);
3015 CHECK_STRING (file2
);
3018 GCPRO2 (absname1
, file2
);
3019 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3020 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3023 /* If the file name has special constructs in it,
3024 call the corresponding file handler. */
3025 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3027 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3028 if (!NILP (handler
))
3029 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3031 GCPRO2 (absname1
, absname2
);
3032 absname1
= ENCODE_FILE (absname1
);
3033 absname2
= ENCODE_FILE (absname2
);
3036 if (stat (SSDATA (absname1
), &st
) < 0)
3039 mtime1
= st
.st_mtime
;
3041 if (stat (SSDATA (absname2
), &st
) < 0)
3044 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3047 #ifndef READ_BUF_SIZE
3048 #define READ_BUF_SIZE (64 << 10)
3051 /* This function is called after Lisp functions to decide a coding
3052 system are called, or when they cause an error. Before they are
3053 called, the current buffer is set unibyte and it contains only a
3054 newly inserted text (thus the buffer was empty before the
3057 The functions may set markers, overlays, text properties, or even
3058 alter the buffer contents, change the current buffer.
3060 Here, we reset all those changes by:
3061 o set back the current buffer.
3062 o move all markers and overlays to BEG.
3063 o remove all text properties.
3064 o set back the buffer multibyteness. */
3067 decide_coding_unwind (Lisp_Object unwind_data
)
3069 Lisp_Object multibyte
, undo_list
, buffer
;
3071 multibyte
= XCAR (unwind_data
);
3072 unwind_data
= XCDR (unwind_data
);
3073 undo_list
= XCAR (unwind_data
);
3074 buffer
= XCDR (unwind_data
);
3076 if (current_buffer
!= XBUFFER (buffer
))
3077 set_buffer_internal (XBUFFER (buffer
));
3078 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3079 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3080 BUF_INTERVALS (current_buffer
) = 0;
3081 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3083 /* Now we are safe to change the buffer's multibyteness directly. */
3084 BVAR (current_buffer
, enable_multibyte_characters
) = multibyte
;
3085 BVAR (current_buffer
, undo_list
) = undo_list
;
3091 /* Used to pass values from insert-file-contents to read_non_regular. */
3093 static int non_regular_fd
;
3094 static EMACS_INT non_regular_inserted
;
3095 static EMACS_INT non_regular_nbytes
;
3098 /* Read from a non-regular file.
3099 Read non_regular_nbytes bytes max from non_regular_fd.
3100 Non_regular_inserted specifies where to put the read bytes.
3101 Value is the number of bytes read. */
3104 read_non_regular (Lisp_Object ignore
)
3110 nbytes
= emacs_read (non_regular_fd
,
3111 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3112 + non_regular_inserted
),
3113 non_regular_nbytes
);
3115 return make_number (nbytes
);
3119 /* Condition-case handler used when reading from non-regular files
3120 in insert-file-contents. */
3123 read_non_regular_quit (Lisp_Object ignore
)
3129 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3131 doc
: /* Insert contents of file FILENAME after point.
3132 Returns list of absolute file name and number of characters inserted.
3133 If second argument VISIT is non-nil, the buffer's visited filename and
3134 last save file modtime are set, and it is marked unmodified. If
3135 visiting and the file does not exist, visiting is completed before the
3138 The optional third and fourth arguments BEG and END specify what portion
3139 of the file to insert. These arguments count bytes in the file, not
3140 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3142 If optional fifth argument REPLACE is non-nil, replace the current
3143 buffer contents (in the accessible portion) with the file contents.
3144 This is better than simply deleting and inserting the whole thing
3145 because (1) it preserves some marker positions and (2) it puts less data
3146 in the undo list. When REPLACE is non-nil, the second return value is
3147 the number of characters that replace previous buffer contents.
3149 This function does code conversion according to the value of
3150 `coding-system-for-read' or `file-coding-system-alist', and sets the
3151 variable `last-coding-system-used' to the coding system actually used. */)
3152 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3156 EMACS_INT inserted
= 0;
3158 register EMACS_INT how_much
;
3159 register EMACS_INT unprocessed
;
3160 int count
= SPECPDL_INDEX ();
3161 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3162 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3164 EMACS_INT total
= 0;
3165 int not_regular
= 0;
3166 char read_buf
[READ_BUF_SIZE
];
3167 struct coding_system coding
;
3168 char buffer
[1 << 14];
3169 int replace_handled
= 0;
3170 int set_coding_system
= 0;
3171 Lisp_Object coding_system
;
3173 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3174 int we_locked_file
= 0;
3175 int deferred_remove_unwind_protect
= 0;
3177 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3178 error ("Cannot do file visiting in an indirect buffer");
3180 if (!NILP (BVAR (current_buffer
, read_only
)))
3181 Fbarf_if_buffer_read_only ();
3185 orig_filename
= Qnil
;
3188 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3190 CHECK_STRING (filename
);
3191 filename
= Fexpand_file_name (filename
, Qnil
);
3193 /* The value Qnil means that the coding system is not yet
3195 coding_system
= Qnil
;
3197 /* If the file name has special constructs in it,
3198 call the corresponding file handler. */
3199 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3200 if (!NILP (handler
))
3202 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3203 visit
, beg
, end
, replace
);
3204 if (CONSP (val
) && CONSP (XCDR (val
)))
3205 inserted
= XINT (XCAR (XCDR (val
)));
3209 orig_filename
= filename
;
3210 filename
= ENCODE_FILE (filename
);
3216 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3218 /* Tell stat to use expensive method to get accurate info. */
3219 Vw32_get_true_file_attributes
= Qt
;
3220 total
= stat (SSDATA (filename
), &st
);
3221 Vw32_get_true_file_attributes
= tem
;
3225 if (stat (SSDATA (filename
), &st
) < 0)
3226 #endif /* WINDOWSNT */
3228 if (fd
>= 0) emacs_close (fd
);
3231 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3234 if (!NILP (Vcoding_system_for_read
))
3235 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3239 /* This code will need to be changed in order to work on named
3240 pipes, and it's probably just not worth it. So we should at
3241 least signal an error. */
3242 if (!S_ISREG (st
.st_mode
))
3249 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3250 xsignal2 (Qfile_error
,
3251 build_string ("not a regular file"), orig_filename
);
3255 if ((fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0)) < 0)
3258 /* Replacement should preserve point as it preserves markers. */
3259 if (!NILP (replace
))
3260 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3262 record_unwind_protect (close_file_unwind
, make_number (fd
));
3264 /* Can happen on any platform that uses long as type of off_t, but allows
3265 file sizes to exceed 2Gb, so give a suitable message. */
3266 if (! not_regular
&& st
.st_size
< 0)
3267 error ("Maximum buffer size exceeded");
3269 /* Prevent redisplay optimizations. */
3270 current_buffer
->clip_changed
= 1;
3274 if (!NILP (beg
) || !NILP (end
))
3275 error ("Attempt to visit less than an entire file");
3276 if (BEG
< Z
&& NILP (replace
))
3277 error ("Cannot do file visiting in a non-empty buffer");
3283 XSETFASTINT (beg
, 0);
3291 XSETINT (end
, st
.st_size
);
3293 /* Arithmetic overflow can occur if an Emacs integer cannot
3294 represent the file size, or if the calculations below
3295 overflow. The calculations below double the file size
3296 twice, so check that it can be multiplied by 4 safely. */
3297 if (XINT (end
) != st
.st_size
3298 /* Actually, it should test either INT_MAX or LONG_MAX
3299 depending on which one is used for EMACS_INT. But in
3300 any case, in practice, this test is redundant with the
3302 || st.st_size > INT_MAX / 4 */)
3303 error ("Maximum buffer size exceeded");
3305 /* The file size returned from stat may be zero, but data
3306 may be readable nonetheless, for example when this is a
3307 file in the /proc filesystem. */
3308 if (st
.st_size
== 0)
3309 XSETINT (end
, READ_BUF_SIZE
);
3313 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3315 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3316 setup_coding_system (coding_system
, &coding
);
3317 /* Ensure we set Vlast_coding_system_used. */
3318 set_coding_system
= 1;
3322 /* Decide the coding system to use for reading the file now
3323 because we can't use an optimized method for handling
3324 `coding:' tag if the current buffer is not empty. */
3325 if (!NILP (Vcoding_system_for_read
))
3326 coding_system
= Vcoding_system_for_read
;
3329 /* Don't try looking inside a file for a coding system
3330 specification if it is not seekable. */
3331 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3333 /* Find a coding system specified in the heading two
3334 lines or in the tailing several lines of the file.
3335 We assume that the 1K-byte and 3K-byte for heading
3336 and tailing respectively are sufficient for this
3340 if (st
.st_size
<= (1024 * 4))
3341 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3344 nread
= emacs_read (fd
, read_buf
, 1024);
3347 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3348 report_file_error ("Setting file position",
3349 Fcons (orig_filename
, Qnil
));
3350 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3355 error ("IO error reading %s: %s",
3356 SDATA (orig_filename
), emacs_strerror (errno
));
3359 struct buffer
*prev
= current_buffer
;
3363 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3365 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3366 buf
= XBUFFER (buffer
);
3368 delete_all_overlays (buf
);
3369 BVAR (buf
, directory
) = BVAR (current_buffer
, directory
);
3370 BVAR (buf
, read_only
) = Qnil
;
3371 BVAR (buf
, filename
) = Qnil
;
3372 BVAR (buf
, undo_list
) = Qt
;
3373 eassert (buf
->overlays_before
== NULL
);
3374 eassert (buf
->overlays_after
== NULL
);
3376 set_buffer_internal (buf
);
3378 BVAR (buf
, enable_multibyte_characters
) = Qnil
;
3380 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3381 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3382 coding_system
= call2 (Vset_auto_coding_function
,
3383 filename
, make_number (nread
));
3384 set_buffer_internal (prev
);
3386 /* Discard the unwind protect for recovering the
3390 /* Rewind the file for the actual read done later. */
3391 if (lseek (fd
, 0, 0) < 0)
3392 report_file_error ("Setting file position",
3393 Fcons (orig_filename
, Qnil
));
3397 if (NILP (coding_system
))
3399 /* If we have not yet decided a coding system, check
3400 file-coding-system-alist. */
3401 Lisp_Object args
[6];
3403 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3404 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3405 coding_system
= Ffind_operation_coding_system (6, args
);
3406 if (CONSP (coding_system
))
3407 coding_system
= XCAR (coding_system
);
3411 if (NILP (coding_system
))
3412 coding_system
= Qundecided
;
3414 CHECK_CODING_SYSTEM (coding_system
);
3416 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3417 /* We must suppress all character code conversion except for
3418 end-of-line conversion. */
3419 coding_system
= raw_text_coding_system (coding_system
);
3421 setup_coding_system (coding_system
, &coding
);
3422 /* Ensure we set Vlast_coding_system_used. */
3423 set_coding_system
= 1;
3426 /* If requested, replace the accessible part of the buffer
3427 with the file contents. Avoid replacing text at the
3428 beginning or end of the buffer that matches the file contents;
3429 that preserves markers pointing to the unchanged parts.
3431 Here we implement this feature in an optimized way
3432 for the case where code conversion is NOT needed.
3433 The following if-statement handles the case of conversion
3434 in a less optimal way.
3436 If the code conversion is "automatic" then we try using this
3437 method and hope for the best.
3438 But if we discover the need for conversion, we give up on this method
3439 and let the following if-statement handle the replace job. */
3442 && (NILP (coding_system
)
3443 || ! CODING_REQUIRE_DECODING (&coding
)))
3445 /* same_at_start and same_at_end count bytes,
3446 because file access counts bytes
3447 and BEG and END count bytes. */
3448 EMACS_INT same_at_start
= BEGV_BYTE
;
3449 EMACS_INT same_at_end
= ZV_BYTE
;
3451 /* There is still a possibility we will find the need to do code
3452 conversion. If that happens, we set this variable to 1 to
3453 give up on handling REPLACE in the optimized way. */
3454 int giveup_match_end
= 0;
3456 if (XINT (beg
) != 0)
3458 if (lseek (fd
, XINT (beg
), 0) < 0)
3459 report_file_error ("Setting file position",
3460 Fcons (orig_filename
, Qnil
));
3465 /* Count how many chars at the start of the file
3466 match the text at the beginning of the buffer. */
3469 EMACS_INT nread
, bufpos
;
3471 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3473 error ("IO error reading %s: %s",
3474 SSDATA (orig_filename
), emacs_strerror (errno
));
3475 else if (nread
== 0)
3478 if (CODING_REQUIRE_DETECTION (&coding
))
3480 coding_system
= detect_coding_system ((unsigned char *) buffer
,
3483 setup_coding_system (coding_system
, &coding
);
3486 if (CODING_REQUIRE_DECODING (&coding
))
3487 /* We found that the file should be decoded somehow.
3488 Let's give up here. */
3490 giveup_match_end
= 1;
3495 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3496 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3497 same_at_start
++, bufpos
++;
3498 /* If we found a discrepancy, stop the scan.
3499 Otherwise loop around and scan the next bufferful. */
3500 if (bufpos
!= nread
)
3504 /* If the file matches the buffer completely,
3505 there's no need to replace anything. */
3506 if (same_at_start
- BEGV_BYTE
== XINT (end
))
3510 /* Truncate the buffer to the size of the file. */
3511 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3516 /* Count how many chars at the end of the file
3517 match the text at the end of the buffer. But, if we have
3518 already found that decoding is necessary, don't waste time. */
3519 while (!giveup_match_end
)
3521 EMACS_INT total_read
, nread
, bufpos
, curpos
, trial
;
3523 /* At what file position are we now scanning? */
3524 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
3525 /* If the entire file matches the buffer tail, stop the scan. */
3528 /* How much can we scan in the next step? */
3529 trial
= min (curpos
, sizeof buffer
);
3530 if (lseek (fd
, curpos
- trial
, 0) < 0)
3531 report_file_error ("Setting file position",
3532 Fcons (orig_filename
, Qnil
));
3534 total_read
= nread
= 0;
3535 while (total_read
< trial
)
3537 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3539 error ("IO error reading %s: %s",
3540 SDATA (orig_filename
), emacs_strerror (errno
));
3541 else if (nread
== 0)
3543 total_read
+= nread
;
3546 /* Scan this bufferful from the end, comparing with
3547 the Emacs buffer. */
3548 bufpos
= total_read
;
3550 /* Compare with same_at_start to avoid counting some buffer text
3551 as matching both at the file's beginning and at the end. */
3552 while (bufpos
> 0 && same_at_end
> same_at_start
3553 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3554 same_at_end
--, bufpos
--;
3556 /* If we found a discrepancy, stop the scan.
3557 Otherwise loop around and scan the preceding bufferful. */
3560 /* If this discrepancy is because of code conversion,
3561 we cannot use this method; giveup and try the other. */
3562 if (same_at_end
> same_at_start
3563 && FETCH_BYTE (same_at_end
- 1) >= 0200
3564 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3565 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3566 giveup_match_end
= 1;
3575 if (! giveup_match_end
)
3579 /* We win! We can handle REPLACE the optimized way. */
3581 /* Extend the start of non-matching text area to multibyte
3582 character boundary. */
3583 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3584 while (same_at_start
> BEGV_BYTE
3585 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3588 /* Extend the end of non-matching text area to multibyte
3589 character boundary. */
3590 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3591 while (same_at_end
< ZV_BYTE
3592 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3595 /* Don't try to reuse the same piece of text twice. */
3596 overlap
= (same_at_start
- BEGV_BYTE
3597 - (same_at_end
+ st
.st_size
- ZV
));
3599 same_at_end
+= overlap
;
3601 /* Arrange to read only the nonmatching middle part of the file. */
3602 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
3603 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
3605 del_range_byte (same_at_start
, same_at_end
, 0);
3606 /* Insert from the file at the proper position. */
3607 temp
= BYTE_TO_CHAR (same_at_start
);
3608 SET_PT_BOTH (temp
, same_at_start
);
3610 /* If display currently starts at beginning of line,
3611 keep it that way. */
3612 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3613 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3615 replace_handled
= 1;
3619 /* If requested, replace the accessible part of the buffer
3620 with the file contents. Avoid replacing text at the
3621 beginning or end of the buffer that matches the file contents;
3622 that preserves markers pointing to the unchanged parts.
3624 Here we implement this feature for the case where code conversion
3625 is needed, in a simple way that needs a lot of memory.
3626 The preceding if-statement handles the case of no conversion
3627 in a more optimized way. */
3628 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3630 EMACS_INT same_at_start
= BEGV_BYTE
;
3631 EMACS_INT same_at_end
= ZV_BYTE
;
3632 EMACS_INT same_at_start_charpos
;
3633 EMACS_INT inserted_chars
;
3636 unsigned char *decoded
;
3638 int this_count
= SPECPDL_INDEX ();
3639 int multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3640 Lisp_Object conversion_buffer
;
3642 conversion_buffer
= code_conversion_save (1, multibyte
);
3644 /* First read the whole file, performing code conversion into
3645 CONVERSION_BUFFER. */
3647 if (lseek (fd
, XINT (beg
), 0) < 0)
3648 report_file_error ("Setting file position",
3649 Fcons (orig_filename
, Qnil
));
3651 total
= st
.st_size
; /* Total bytes in the file. */
3652 how_much
= 0; /* Bytes read from file so far. */
3653 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3654 unprocessed
= 0; /* Bytes not processed in previous loop. */
3656 GCPRO1 (conversion_buffer
);
3657 while (how_much
< total
)
3659 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3660 quitting while reading a huge while. */
3661 /* try is reserved in some compilers (Microsoft C) */
3662 EMACS_INT trytry
= min (total
- how_much
,
3663 READ_BUF_SIZE
- unprocessed
);
3666 /* Allow quitting out of the actual I/O. */
3669 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3681 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3682 BUF_Z (XBUFFER (conversion_buffer
)));
3683 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3684 unprocessed
+ this, conversion_buffer
);
3685 unprocessed
= coding
.carryover_bytes
;
3686 if (coding
.carryover_bytes
> 0)
3687 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3692 /* We should remove the unwind_protect calling
3693 close_file_unwind, but other stuff has been added the stack,
3694 so defer the removal till we reach the `handled' label. */
3695 deferred_remove_unwind_protect
= 1;
3697 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3698 if we couldn't read the file. */
3701 error ("IO error reading %s: %s",
3702 SDATA (orig_filename
), emacs_strerror (errno
));
3704 if (unprocessed
> 0)
3706 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3707 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3708 unprocessed
, conversion_buffer
);
3709 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3712 coding_system
= CODING_ID_NAME (coding
.id
);
3713 set_coding_system
= 1;
3714 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3715 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3716 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3718 /* Compare the beginning of the converted string with the buffer
3722 while (bufpos
< inserted
&& same_at_start
< same_at_end
3723 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3724 same_at_start
++, bufpos
++;
3726 /* If the file matches the head of buffer completely,
3727 there's no need to replace anything. */
3729 if (bufpos
== inserted
)
3731 /* Truncate the buffer to the size of the file. */
3732 if (same_at_start
== same_at_end
)
3735 del_range_byte (same_at_start
, same_at_end
, 0);
3738 unbind_to (this_count
, Qnil
);
3742 /* Extend the start of non-matching text area to the previous
3743 multibyte character boundary. */
3744 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3745 while (same_at_start
> BEGV_BYTE
3746 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3749 /* Scan this bufferful from the end, comparing with
3750 the Emacs buffer. */
3753 /* Compare with same_at_start to avoid counting some buffer text
3754 as matching both at the file's beginning and at the end. */
3755 while (bufpos
> 0 && same_at_end
> same_at_start
3756 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3757 same_at_end
--, bufpos
--;
3759 /* Extend the end of non-matching text area to the next
3760 multibyte character boundary. */
3761 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3762 while (same_at_end
< ZV_BYTE
3763 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3766 /* Don't try to reuse the same piece of text twice. */
3767 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3769 same_at_end
+= overlap
;
3771 /* If display currently starts at beginning of line,
3772 keep it that way. */
3773 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3774 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3776 /* Replace the chars that we need to replace,
3777 and update INSERTED to equal the number of bytes
3778 we are taking from the decoded string. */
3779 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3781 if (same_at_end
!= same_at_start
)
3783 del_range_byte (same_at_start
, same_at_end
, 0);
3785 same_at_start
= GPT_BYTE
;
3789 temp
= BYTE_TO_CHAR (same_at_start
);
3791 /* Insert from the file at the proper position. */
3792 SET_PT_BOTH (temp
, same_at_start
);
3793 same_at_start_charpos
3794 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3795 same_at_start
- BEGV_BYTE
3796 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3798 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3799 same_at_start
+ inserted
- BEGV_BYTE
3800 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3801 - same_at_start_charpos
);
3802 /* This binding is to avoid ask-user-about-supersession-threat
3803 being called in insert_from_buffer (via in
3804 prepare_to_modify_buffer). */
3805 specbind (intern ("buffer-file-name"), Qnil
);
3806 insert_from_buffer (XBUFFER (conversion_buffer
),
3807 same_at_start_charpos
, inserted_chars
, 0);
3808 /* Set `inserted' to the number of inserted characters. */
3809 inserted
= PT
- temp
;
3810 /* Set point before the inserted characters. */
3811 SET_PT_BOTH (temp
, same_at_start
);
3813 unbind_to (this_count
, Qnil
);
3820 register Lisp_Object temp
;
3822 total
= XINT (end
) - XINT (beg
);
3824 /* Make sure point-max won't overflow after this insertion. */
3825 XSETINT (temp
, total
);
3826 if (total
!= XINT (temp
))
3827 error ("Maximum buffer size exceeded");
3830 /* For a special file, all we can do is guess. */
3831 total
= READ_BUF_SIZE
;
3833 if (NILP (visit
) && inserted
> 0)
3835 #ifdef CLASH_DETECTION
3836 if (!NILP (BVAR (current_buffer
, file_truename
))
3837 /* Make binding buffer-file-name to nil effective. */
3838 && !NILP (BVAR (current_buffer
, filename
))
3839 && SAVE_MODIFF
>= MODIFF
)
3841 #endif /* CLASH_DETECTION */
3842 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3846 if (GAP_SIZE
< total
)
3847 make_gap (total
- GAP_SIZE
);
3849 if (XINT (beg
) != 0 || !NILP (replace
))
3851 if (lseek (fd
, XINT (beg
), 0) < 0)
3852 report_file_error ("Setting file position",
3853 Fcons (orig_filename
, Qnil
));
3856 /* In the following loop, HOW_MUCH contains the total bytes read so
3857 far for a regular file, and not changed for a special file. But,
3858 before exiting the loop, it is set to a negative value if I/O
3862 /* Total bytes inserted. */
3865 /* Here, we don't do code conversion in the loop. It is done by
3866 decode_coding_gap after all data are read into the buffer. */
3868 EMACS_INT gap_size
= GAP_SIZE
;
3870 while (how_much
< total
)
3872 /* try is reserved in some compilers (Microsoft C) */
3873 EMACS_INT trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3880 /* Maybe make more room. */
3881 if (gap_size
< trytry
)
3883 make_gap (total
- gap_size
);
3884 gap_size
= GAP_SIZE
;
3887 /* Read from the file, capturing `quit'. When an
3888 error occurs, end the loop, and arrange for a quit
3889 to be signaled after decoding the text we read. */
3890 non_regular_fd
= fd
;
3891 non_regular_inserted
= inserted
;
3892 non_regular_nbytes
= trytry
;
3893 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
3894 read_non_regular_quit
);
3905 /* Allow quitting out of the actual I/O. We don't make text
3906 part of the buffer until all the reading is done, so a C-g
3907 here doesn't do any harm. */
3910 this = emacs_read (fd
,
3911 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3925 /* For a regular file, where TOTAL is the real size,
3926 count HOW_MUCH to compare with it.
3927 For a special file, where TOTAL is just a buffer size,
3928 so don't bother counting in HOW_MUCH.
3929 (INSERTED is where we count the number of characters inserted.) */
3936 /* Now we have read all the file data into the gap.
3937 If it was empty, undo marking the buffer modified. */
3941 #ifdef CLASH_DETECTION
3943 unlock_file (BVAR (current_buffer
, file_truename
));
3945 Vdeactivate_mark
= old_Vdeactivate_mark
;
3948 Vdeactivate_mark
= Qt
;
3950 /* Make the text read part of the buffer. */
3951 GAP_SIZE
-= inserted
;
3953 GPT_BYTE
+= inserted
;
3955 ZV_BYTE
+= inserted
;
3960 /* Put an anchor to ensure multi-byte form ends at gap. */
3965 /* Discard the unwind protect for closing the file. */
3969 error ("IO error reading %s: %s",
3970 SDATA (orig_filename
), emacs_strerror (errno
));
3974 if (NILP (coding_system
))
3976 /* The coding system is not yet decided. Decide it by an
3977 optimized method for handling `coding:' tag.
3979 Note that we can get here only if the buffer was empty
3980 before the insertion. */
3982 if (!NILP (Vcoding_system_for_read
))
3983 coding_system
= Vcoding_system_for_read
;
3986 /* Since we are sure that the current buffer was empty
3987 before the insertion, we can toggle
3988 enable-multibyte-characters directly here without taking
3989 care of marker adjustment. By this way, we can run Lisp
3990 program safely before decoding the inserted text. */
3991 Lisp_Object unwind_data
;
3992 int count
= SPECPDL_INDEX ();
3994 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
3995 Fcons (BVAR (current_buffer
, undo_list
),
3996 Fcurrent_buffer ()));
3997 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
3998 BVAR (current_buffer
, undo_list
) = Qt
;
3999 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4001 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4003 coding_system
= call2 (Vset_auto_coding_function
,
4004 filename
, make_number (inserted
));
4007 if (NILP (coding_system
))
4009 /* If the coding system is not yet decided, check
4010 file-coding-system-alist. */
4011 Lisp_Object args
[6];
4013 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4014 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4015 coding_system
= Ffind_operation_coding_system (6, args
);
4016 if (CONSP (coding_system
))
4017 coding_system
= XCAR (coding_system
);
4019 unbind_to (count
, Qnil
);
4020 inserted
= Z_BYTE
- BEG_BYTE
;
4023 if (NILP (coding_system
))
4024 coding_system
= Qundecided
;
4026 CHECK_CODING_SYSTEM (coding_system
);
4028 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4029 /* We must suppress all character code conversion except for
4030 end-of-line conversion. */
4031 coding_system
= raw_text_coding_system (coding_system
);
4032 setup_coding_system (coding_system
, &coding
);
4033 /* Ensure we set Vlast_coding_system_used. */
4034 set_coding_system
= 1;
4039 /* When we visit a file by raw-text, we change the buffer to
4041 if (CODING_FOR_UNIBYTE (&coding
)
4042 /* Can't do this if part of the buffer might be preserved. */
4044 /* Visiting a file with these coding system makes the buffer
4046 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
4049 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4050 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4051 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4053 move_gap_both (PT
, PT_BYTE
);
4054 GAP_SIZE
+= inserted
;
4055 ZV_BYTE
-= inserted
;
4059 decode_coding_gap (&coding
, inserted
, inserted
);
4060 inserted
= coding
.produced_char
;
4061 coding_system
= CODING_ID_NAME (coding
.id
);
4063 else if (inserted
> 0)
4064 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4067 /* Now INSERTED is measured in characters. */
4071 if (deferred_remove_unwind_protect
)
4072 /* If requested above, discard the unwind protect for closing the
4078 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4079 BVAR (current_buffer
, undo_list
) = Qnil
;
4083 current_buffer
->modtime
= st
.st_mtime
;
4084 current_buffer
->modtime_size
= st
.st_size
;
4085 BVAR (current_buffer
, filename
) = orig_filename
;
4088 SAVE_MODIFF
= MODIFF
;
4089 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4090 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4091 #ifdef CLASH_DETECTION
4094 if (!NILP (BVAR (current_buffer
, file_truename
)))
4095 unlock_file (BVAR (current_buffer
, file_truename
));
4096 unlock_file (filename
);
4098 #endif /* CLASH_DETECTION */
4100 xsignal2 (Qfile_error
,
4101 build_string ("not a regular file"), orig_filename
);
4104 if (set_coding_system
)
4105 Vlast_coding_system_used
= coding_system
;
4107 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4109 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4111 if (! NILP (insval
))
4113 CHECK_NUMBER (insval
);
4114 inserted
= XFASTINT (insval
);
4118 /* Decode file format. */
4121 /* Don't run point motion or modification hooks when decoding. */
4122 int count
= SPECPDL_INDEX ();
4123 EMACS_INT old_inserted
= inserted
;
4124 specbind (Qinhibit_point_motion_hooks
, Qt
);
4125 specbind (Qinhibit_modification_hooks
, Qt
);
4127 /* Save old undo list and don't record undo for decoding. */
4128 old_undo
= BVAR (current_buffer
, undo_list
);
4129 BVAR (current_buffer
, undo_list
) = Qt
;
4133 insval
= call3 (Qformat_decode
,
4134 Qnil
, make_number (inserted
), visit
);
4135 CHECK_NUMBER (insval
);
4136 inserted
= XFASTINT (insval
);
4140 /* If REPLACE is non-nil and we succeeded in not replacing the
4141 beginning or end of the buffer text with the file's contents,
4142 call format-decode with `point' positioned at the beginning
4143 of the buffer and `inserted' equalling the number of
4144 characters in the buffer. Otherwise, format-decode might
4145 fail to correctly analyze the beginning or end of the buffer.
4146 Hence we temporarily save `point' and `inserted' here and
4147 restore `point' iff format-decode did not insert or delete
4148 any text. Otherwise we leave `point' at point-min. */
4149 EMACS_INT opoint
= PT
;
4150 EMACS_INT opoint_byte
= PT_BYTE
;
4151 EMACS_INT oinserted
= ZV
- BEGV
;
4152 int ochars_modiff
= CHARS_MODIFF
;
4154 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4155 insval
= call3 (Qformat_decode
,
4156 Qnil
, make_number (oinserted
), visit
);
4157 CHECK_NUMBER (insval
);
4158 if (ochars_modiff
== CHARS_MODIFF
)
4159 /* format_decode didn't modify buffer's characters => move
4160 point back to position before inserted text and leave
4161 value of inserted alone. */
4162 SET_PT_BOTH (opoint
, opoint_byte
);
4164 /* format_decode modified buffer's characters => consider
4165 entire buffer changed and leave point at point-min. */
4166 inserted
= XFASTINT (insval
);
4169 /* For consistency with format-decode call these now iff inserted > 0
4170 (martin 2007-06-28). */
4171 p
= Vafter_insert_file_functions
;
4176 insval
= call1 (XCAR (p
), make_number (inserted
));
4179 CHECK_NUMBER (insval
);
4180 inserted
= XFASTINT (insval
);
4185 /* For the rationale of this see the comment on
4186 format-decode above. */
4187 EMACS_INT opoint
= PT
;
4188 EMACS_INT opoint_byte
= PT_BYTE
;
4189 EMACS_INT oinserted
= ZV
- BEGV
;
4190 int ochars_modiff
= CHARS_MODIFF
;
4192 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4193 insval
= call1 (XCAR (p
), make_number (oinserted
));
4196 CHECK_NUMBER (insval
);
4197 if (ochars_modiff
== CHARS_MODIFF
)
4198 /* after_insert_file_functions didn't modify
4199 buffer's characters => move point back to
4200 position before inserted text and leave value of
4202 SET_PT_BOTH (opoint
, opoint_byte
);
4204 /* after_insert_file_functions did modify buffer's
4205 characters => consider entire buffer changed and
4206 leave point at point-min. */
4207 inserted
= XFASTINT (insval
);
4217 BVAR (current_buffer
, undo_list
) = old_undo
;
4218 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4220 /* Adjust the last undo record for the size change during
4221 the format conversion. */
4222 Lisp_Object tem
= XCAR (old_undo
);
4223 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4224 && INTEGERP (XCDR (tem
))
4225 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4226 XSETCDR (tem
, make_number (PT
+ inserted
));
4230 /* If undo_list was Qt before, keep it that way.
4231 Otherwise start with an empty undo_list. */
4232 BVAR (current_buffer
, undo_list
) = EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4234 unbind_to (count
, Qnil
);
4237 /* Call after-change hooks for the inserted text, aside from the case
4238 of normal visiting (not with REPLACE), which is done in a new buffer
4239 "before" the buffer is changed. */
4240 if (inserted
> 0 && total
> 0
4241 && (NILP (visit
) || !NILP (replace
)))
4243 signal_after_change (PT
, 0, inserted
);
4244 update_compositions (PT
, PT
, CHECK_BORDER
);
4248 && current_buffer
->modtime
== -1)
4250 /* If visiting nonexistent file, return nil. */
4251 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4255 Fsignal (Qquit
, Qnil
);
4257 /* ??? Retval needs to be dealt with in all cases consistently. */
4259 val
= Fcons (orig_filename
,
4260 Fcons (make_number (inserted
),
4263 RETURN_UNGCPRO (unbind_to (count
, val
));
4266 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4269 build_annotations_unwind (Lisp_Object arg
)
4271 Vwrite_region_annotation_buffers
= arg
;
4275 /* Decide the coding-system to encode the data with. */
4278 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4279 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4280 struct coding_system
*coding
)
4283 Lisp_Object eol_parent
= Qnil
;
4286 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4287 BVAR (current_buffer
, auto_save_file_name
))))
4292 else if (!NILP (Vcoding_system_for_write
))
4294 val
= Vcoding_system_for_write
;
4295 if (coding_system_require_warning
4296 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4297 /* Confirm that VAL can surely encode the current region. */
4298 val
= call5 (Vselect_safe_coding_system_function
,
4299 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4304 /* If the variable `buffer-file-coding-system' is set locally,
4305 it means that the file was read with some kind of code
4306 conversion or the variable is explicitly set by users. We
4307 had better write it out with the same coding system even if
4308 `enable-multibyte-characters' is nil.
4310 If it is not set locally, we anyway have to convert EOL
4311 format if the default value of `buffer-file-coding-system'
4312 tells that it is not Unix-like (LF only) format. */
4313 int using_default_coding
= 0;
4314 int force_raw_text
= 0;
4316 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4318 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4321 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4327 /* Check file-coding-system-alist. */
4328 Lisp_Object args
[7], coding_systems
;
4330 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4331 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4333 coding_systems
= Ffind_operation_coding_system (7, args
);
4334 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4335 val
= XCDR (coding_systems
);
4340 /* If we still have not decided a coding system, use the
4341 default value of buffer-file-coding-system. */
4342 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4343 using_default_coding
= 1;
4346 if (! NILP (val
) && ! force_raw_text
)
4348 Lisp_Object spec
, attrs
;
4350 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4351 attrs
= AREF (spec
, 0);
4352 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4357 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4358 /* Confirm that VAL can surely encode the current region. */
4359 val
= call5 (Vselect_safe_coding_system_function
,
4360 start
, end
, val
, Qnil
, filename
);
4362 /* If the decided coding-system doesn't specify end-of-line
4363 format, we use that of
4364 `default-buffer-file-coding-system'. */
4365 if (! using_default_coding
4366 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4367 val
= (coding_inherit_eol_type
4368 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4370 /* If we decide not to encode text, use `raw-text' or one of its
4373 val
= raw_text_coding_system (val
);
4376 val
= coding_inherit_eol_type (val
, eol_parent
);
4377 setup_coding_system (val
, coding
);
4379 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4380 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4384 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4385 "r\nFWrite region to file: \ni\ni\ni\np",
4386 doc
: /* Write current region into specified file.
4387 When called from a program, requires three arguments:
4388 START, END and FILENAME. START and END are normally buffer positions
4389 specifying the part of the buffer to write.
4390 If START is nil, that means to use the entire buffer contents.
4391 If START is a string, then output that string to the file
4392 instead of any buffer contents; END is ignored.
4394 Optional fourth argument APPEND if non-nil means
4395 append to existing file contents (if any). If it is an integer,
4396 seek to that offset in the file before writing.
4397 Optional fifth argument VISIT, if t or a string, means
4398 set the last-save-file-modtime of buffer to this file's modtime
4399 and mark buffer not modified.
4400 If VISIT is a string, it is a second file name;
4401 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4402 VISIT is also the file name to lock and unlock for clash detection.
4403 If VISIT is neither t nor nil nor a string,
4404 that means do not display the \"Wrote file\" message.
4405 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4406 use for locking and unlocking, overriding FILENAME and VISIT.
4407 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4408 for an existing file with the same name. If MUSTBENEW is `excl',
4409 that means to get an error if the file already exists; never overwrite.
4410 If MUSTBENEW is neither nil nor `excl', that means ask for
4411 confirmation before overwriting, but do go ahead and overwrite the file
4412 if the user confirms.
4414 This does code conversion according to the value of
4415 `coding-system-for-write', `buffer-file-coding-system', or
4416 `file-coding-system-alist', and sets the variable
4417 `last-coding-system-used' to the coding system actually used.
4419 This calls `write-region-annotate-functions' at the start, and
4420 `write-region-post-annotation-function' at the end. */)
4421 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4428 int count
= SPECPDL_INDEX ();
4430 Lisp_Object handler
;
4431 Lisp_Object visit_file
;
4432 Lisp_Object annotations
;
4433 Lisp_Object encoded_filename
;
4434 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4435 int quietly
= !NILP (visit
);
4436 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4437 struct buffer
*given_buffer
;
4438 struct coding_system coding
;
4440 if (current_buffer
->base_buffer
&& visiting
)
4441 error ("Cannot do file visiting in an indirect buffer");
4443 if (!NILP (start
) && !STRINGP (start
))
4444 validate_region (&start
, &end
);
4447 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4449 filename
= Fexpand_file_name (filename
, Qnil
);
4451 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4452 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4454 if (STRINGP (visit
))
4455 visit_file
= Fexpand_file_name (visit
, Qnil
);
4457 visit_file
= filename
;
4459 if (NILP (lockname
))
4460 lockname
= visit_file
;
4464 /* If the file name has special constructs in it,
4465 call the corresponding file handler. */
4466 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4467 /* If FILENAME has no handler, see if VISIT has one. */
4468 if (NILP (handler
) && STRINGP (visit
))
4469 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4471 if (!NILP (handler
))
4474 val
= call6 (handler
, Qwrite_region
, start
, end
,
4475 filename
, append
, visit
);
4479 SAVE_MODIFF
= MODIFF
;
4480 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4481 BVAR (current_buffer
, filename
) = visit_file
;
4487 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4489 /* Special kludge to simplify auto-saving. */
4492 /* Do it later, so write-region-annotate-function can work differently
4493 if we save "the buffer" vs "a region".
4494 This is useful in tar-mode. --Stef
4495 XSETFASTINT (start, BEG);
4496 XSETFASTINT (end, Z); */
4500 record_unwind_protect (build_annotations_unwind
,
4501 Vwrite_region_annotation_buffers
);
4502 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4503 count1
= SPECPDL_INDEX ();
4505 given_buffer
= current_buffer
;
4507 if (!STRINGP (start
))
4509 annotations
= build_annotations (start
, end
);
4511 if (current_buffer
!= given_buffer
)
4513 XSETFASTINT (start
, BEGV
);
4514 XSETFASTINT (end
, ZV
);
4520 XSETFASTINT (start
, BEGV
);
4521 XSETFASTINT (end
, ZV
);
4526 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4528 /* Decide the coding-system to encode the data with.
4529 We used to make this choice before calling build_annotations, but that
4530 leads to problems when a write-annotate-function takes care of
4531 unsavable chars (as was the case with X-Symbol). */
4532 Vlast_coding_system_used
4533 = choose_write_coding_system (start
, end
, filename
,
4534 append
, visit
, lockname
, &coding
);
4536 #ifdef CLASH_DETECTION
4538 lock_file (lockname
);
4539 #endif /* CLASH_DETECTION */
4541 encoded_filename
= ENCODE_FILE (filename
);
4543 fn
= SSDATA (encoded_filename
);
4547 desc
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4548 #else /* not DOS_NT */
4549 desc
= emacs_open (fn
, O_WRONLY
, 0);
4550 #endif /* not DOS_NT */
4552 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4554 desc
= emacs_open (fn
,
4555 O_WRONLY
| O_CREAT
| O_BINARY
4556 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4557 S_IREAD
| S_IWRITE
);
4558 #else /* not DOS_NT */
4559 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4560 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4561 auto_saving
? auto_save_mode_bits
: 0666);
4562 #endif /* not DOS_NT */
4566 #ifdef CLASH_DETECTION
4568 if (!auto_saving
) unlock_file (lockname
);
4570 #endif /* CLASH_DETECTION */
4572 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4575 record_unwind_protect (close_file_unwind
, make_number (desc
));
4577 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4581 if (NUMBERP (append
))
4582 ret
= lseek (desc
, XINT (append
), 1);
4584 ret
= lseek (desc
, 0, 2);
4587 #ifdef CLASH_DETECTION
4588 if (!auto_saving
) unlock_file (lockname
);
4589 #endif /* CLASH_DETECTION */
4591 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4600 if (STRINGP (start
))
4602 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4603 &annotations
, &coding
);
4606 else if (XINT (start
) != XINT (end
))
4608 failure
= 0 > a_write (desc
, Qnil
,
4609 XINT (start
), XINT (end
) - XINT (start
),
4610 &annotations
, &coding
);
4615 /* If file was empty, still need to write the annotations */
4616 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4617 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4621 if (CODING_REQUIRE_FLUSHING (&coding
)
4622 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4625 /* We have to flush out a data. */
4626 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4627 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4634 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4635 Disk full in NFS may be reported here. */
4636 /* mib says that closing the file will try to write as fast as NFS can do
4637 it, and that means the fsync here is not crucial for autosave files. */
4638 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4640 /* If fsync fails with EINTR, don't treat that as serious. Also
4641 ignore EINVAL which happens when fsync is not supported on this
4643 if (errno
!= EINTR
&& errno
!= EINVAL
)
4644 failure
= 1, save_errno
= errno
;
4648 /* NFS can report a write failure now. */
4649 if (emacs_close (desc
) < 0)
4650 failure
= 1, save_errno
= errno
;
4654 /* Discard the unwind protect for close_file_unwind. */
4655 specpdl_ptr
= specpdl
+ count1
;
4657 /* Call write-region-post-annotation-function. */
4658 while (CONSP (Vwrite_region_annotation_buffers
))
4660 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4661 if (!NILP (Fbuffer_live_p (buf
)))
4664 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4665 call0 (Vwrite_region_post_annotation_function
);
4667 Vwrite_region_annotation_buffers
4668 = XCDR (Vwrite_region_annotation_buffers
);
4671 unbind_to (count
, Qnil
);
4673 #ifdef CLASH_DETECTION
4675 unlock_file (lockname
);
4676 #endif /* CLASH_DETECTION */
4678 /* Do this before reporting IO error
4679 to avoid a "file has changed on disk" warning on
4680 next attempt to save. */
4683 current_buffer
->modtime
= st
.st_mtime
;
4684 current_buffer
->modtime_size
= st
.st_size
;
4688 error ("IO error writing %s: %s", SDATA (filename
),
4689 emacs_strerror (save_errno
));
4693 SAVE_MODIFF
= MODIFF
;
4694 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4695 BVAR (current_buffer
, filename
) = visit_file
;
4696 update_mode_lines
++;
4701 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4702 BVAR (current_buffer
, auto_save_file_name
))))
4703 SAVE_MODIFF
= MODIFF
;
4709 message_with_string ((INTEGERP (append
)
4719 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4721 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4722 doc
: /* Return t if (car A) is numerically less than (car B). */)
4723 (Lisp_Object a
, Lisp_Object b
)
4725 return Flss (Fcar (a
), Fcar (b
));
4728 /* Build the complete list of annotations appropriate for writing out
4729 the text between START and END, by calling all the functions in
4730 write-region-annotate-functions and merging the lists they return.
4731 If one of these functions switches to a different buffer, we assume
4732 that buffer contains altered text. Therefore, the caller must
4733 make sure to restore the current buffer in all cases,
4734 as save-excursion would do. */
4737 build_annotations (Lisp_Object start
, Lisp_Object end
)
4739 Lisp_Object annotations
;
4741 struct gcpro gcpro1
, gcpro2
;
4742 Lisp_Object original_buffer
;
4743 int i
, used_global
= 0;
4745 XSETBUFFER (original_buffer
, current_buffer
);
4748 p
= Vwrite_region_annotate_functions
;
4749 GCPRO2 (annotations
, p
);
4752 struct buffer
*given_buffer
= current_buffer
;
4753 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4754 { /* Use the global value of the hook. */
4757 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4759 p
= Fappend (2, arg
);
4762 Vwrite_region_annotations_so_far
= annotations
;
4763 res
= call2 (XCAR (p
), start
, end
);
4764 /* If the function makes a different buffer current,
4765 assume that means this buffer contains altered text to be output.
4766 Reset START and END from the buffer bounds
4767 and discard all previous annotations because they should have
4768 been dealt with by this function. */
4769 if (current_buffer
!= given_buffer
)
4771 Vwrite_region_annotation_buffers
4772 = Fcons (Fcurrent_buffer (),
4773 Vwrite_region_annotation_buffers
);
4774 XSETFASTINT (start
, BEGV
);
4775 XSETFASTINT (end
, ZV
);
4778 Flength (res
); /* Check basic validity of return value */
4779 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4783 /* Now do the same for annotation functions implied by the file-format */
4784 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
4785 p
= BVAR (current_buffer
, auto_save_file_format
);
4787 p
= BVAR (current_buffer
, file_format
);
4788 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4790 struct buffer
*given_buffer
= current_buffer
;
4792 Vwrite_region_annotations_so_far
= annotations
;
4794 /* Value is either a list of annotations or nil if the function
4795 has written annotations to a temporary buffer, which is now
4797 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4798 original_buffer
, make_number (i
));
4799 if (current_buffer
!= given_buffer
)
4801 XSETFASTINT (start
, BEGV
);
4802 XSETFASTINT (end
, ZV
);
4807 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4815 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4816 If STRING is nil, POS is the character position in the current buffer.
4817 Intersperse with them the annotations from *ANNOT
4818 which fall within the range of POS to POS + NCHARS,
4819 each at its appropriate position.
4821 We modify *ANNOT by discarding elements as we use them up.
4823 The return value is negative in case of system call failure. */
4826 a_write (int desc
, Lisp_Object string
, int pos
, register int nchars
, Lisp_Object
*annot
, struct coding_system
*coding
)
4830 int lastpos
= pos
+ nchars
;
4832 while (NILP (*annot
) || CONSP (*annot
))
4834 tem
= Fcar_safe (Fcar (*annot
));
4837 nextpos
= XFASTINT (tem
);
4839 /* If there are no more annotations in this range,
4840 output the rest of the range all at once. */
4841 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4842 return e_write (desc
, string
, pos
, lastpos
, coding
);
4844 /* Output buffer text up to the next annotation's position. */
4847 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4851 /* Output the annotation. */
4852 tem
= Fcdr (Fcar (*annot
));
4855 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4858 *annot
= Fcdr (*annot
);
4864 /* Write text in the range START and END into descriptor DESC,
4865 encoding them with coding system CODING. If STRING is nil, START
4866 and END are character positions of the current buffer, else they
4867 are indexes to the string STRING. */
4870 e_write (int desc
, Lisp_Object string
, int start
, int end
, struct coding_system
*coding
)
4872 if (STRINGP (string
))
4875 end
= SCHARS (string
);
4878 /* We used to have a code for handling selective display here. But,
4879 now it is handled within encode_coding. */
4883 if (STRINGP (string
))
4885 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
4886 if (CODING_REQUIRE_ENCODING (coding
))
4888 encode_coding_object (coding
, string
,
4889 start
, string_char_to_byte (string
, start
),
4890 end
, string_char_to_byte (string
, end
), Qt
);
4894 coding
->dst_object
= string
;
4895 coding
->consumed_char
= SCHARS (string
);
4896 coding
->produced
= SBYTES (string
);
4901 int start_byte
= CHAR_TO_BYTE (start
);
4902 int end_byte
= CHAR_TO_BYTE (end
);
4904 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
4905 if (CODING_REQUIRE_ENCODING (coding
))
4907 encode_coding_object (coding
, Fcurrent_buffer (),
4908 start
, start_byte
, end
, end_byte
, Qt
);
4912 coding
->dst_object
= Qnil
;
4913 coding
->dst_pos_byte
= start_byte
;
4914 if (start
>= GPT
|| end
<= GPT
)
4916 coding
->consumed_char
= end
- start
;
4917 coding
->produced
= end_byte
- start_byte
;
4921 coding
->consumed_char
= GPT
- start
;
4922 coding
->produced
= GPT_BYTE
- start_byte
;
4927 if (coding
->produced
> 0)
4931 STRINGP (coding
->dst_object
)
4932 ? SSDATA (coding
->dst_object
)
4933 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
4936 if (coding
->produced
)
4939 start
+= coding
->consumed_char
;
4945 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
4946 Sverify_visited_file_modtime
, 0, 1, 0,
4947 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
4948 This means that the file has not been changed since it was visited or saved.
4949 If BUF is omitted or nil, it defaults to the current buffer.
4950 See Info node `(elisp)Modification Time' for more details. */)
4955 Lisp_Object handler
;
4956 Lisp_Object filename
;
4966 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
4967 if (b
->modtime
== 0) return Qt
;
4969 /* If the file name has special constructs in it,
4970 call the corresponding file handler. */
4971 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
4972 Qverify_visited_file_modtime
);
4973 if (!NILP (handler
))
4974 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
4976 filename
= ENCODE_FILE (BVAR (b
, filename
));
4978 if (stat (SSDATA (filename
), &st
) < 0)
4980 /* If the file doesn't exist now and didn't exist before,
4981 we say that it isn't modified, provided the error is a tame one. */
4982 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
4987 if ((st
.st_mtime
== b
->modtime
4988 /* If both are positive, accept them if they are off by one second. */
4989 || (st
.st_mtime
> 0 && b
->modtime
> 0
4990 && (st
.st_mtime
== b
->modtime
+ 1
4991 || st
.st_mtime
== b
->modtime
- 1)))
4992 && (st
.st_size
== b
->modtime_size
4993 || b
->modtime_size
< 0))
4998 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
4999 Sclear_visited_file_modtime
, 0, 0, 0,
5000 doc
: /* Clear out records of last mod time of visited file.
5001 Next attempt to save will certainly not complain of a discrepancy. */)
5004 current_buffer
->modtime
= 0;
5005 current_buffer
->modtime_size
= -1;
5009 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5010 Svisited_file_modtime
, 0, 0, 0,
5011 doc
: /* Return the current buffer's recorded visited file modification time.
5012 The value is a list of the form (HIGH LOW), like the time values
5013 that `file-attributes' returns. If the current buffer has no recorded
5014 file modification time, this function returns 0.
5015 See Info node `(elisp)Modification Time' for more details. */)
5018 if (! current_buffer
->modtime
)
5019 return make_number (0);
5020 return make_time ((time_t) current_buffer
->modtime
);
5023 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5024 Sset_visited_file_modtime
, 0, 1, 0,
5025 doc
: /* Update buffer's recorded modification time from the visited file's time.
5026 Useful if the buffer was not read from the file normally
5027 or if the file itself has been changed for some known benign reason.
5028 An argument specifies the modification time value to use
5029 \(instead of that of the visited file), in the form of a list
5030 \(HIGH . LOW) or (HIGH LOW). */)
5031 (Lisp_Object time_list
)
5033 if (!NILP (time_list
))
5035 current_buffer
->modtime
= cons_to_long (time_list
);
5036 current_buffer
->modtime_size
= -1;
5040 register Lisp_Object filename
;
5042 Lisp_Object handler
;
5044 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5046 /* If the file name has special constructs in it,
5047 call the corresponding file handler. */
5048 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5049 if (!NILP (handler
))
5050 /* The handler can find the file name the same way we did. */
5051 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5053 filename
= ENCODE_FILE (filename
);
5055 if (stat (SSDATA (filename
), &st
) >= 0)
5057 current_buffer
->modtime
= st
.st_mtime
;
5058 current_buffer
->modtime_size
= st
.st_size
;
5066 auto_save_error (Lisp_Object error
)
5068 Lisp_Object args
[3], msg
;
5070 struct gcpro gcpro1
;
5074 auto_save_error_occurred
= 1;
5076 ring_bell (XFRAME (selected_frame
));
5078 args
[0] = build_string ("Auto-saving %s: %s");
5079 args
[1] = BVAR (current_buffer
, name
);
5080 args
[2] = Ferror_message_string (error
);
5081 msg
= Fformat (3, args
);
5083 nbytes
= SBYTES (msg
);
5084 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5085 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5087 for (i
= 0; i
< 3; ++i
)
5090 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5092 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5093 Fsleep_for (make_number (1), Qnil
);
5107 auto_save_mode_bits
= 0666;
5109 /* Get visited file's mode to become the auto save file's mode. */
5110 if (! NILP (BVAR (current_buffer
, filename
)))
5112 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5113 /* But make sure we can overwrite it later! */
5114 auto_save_mode_bits
= st
.st_mode
| 0600;
5115 else if ((modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5117 /* Remote files don't cooperate with stat. */
5118 auto_save_mode_bits
= XINT (modes
) | 0600;
5122 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5123 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5128 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5131 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5143 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5146 minibuffer_auto_raise
= XINT (value
);
5151 do_auto_save_make_dir (Lisp_Object dir
)
5155 call2 (Qmake_directory
, dir
, Qt
);
5156 XSETFASTINT (mode
, 0700);
5157 return Fset_file_modes (dir
, mode
);
5161 do_auto_save_eh (Lisp_Object ignore
)
5166 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5167 doc
: /* Auto-save all buffers that need it.
5168 This is all buffers that have auto-saving enabled
5169 and are changed since last auto-saved.
5170 Auto-saving writes the buffer into a file
5171 so that your editing is not lost if the system crashes.
5172 This file is not the file you visited; that changes only when you save.
5173 Normally we run the normal hook `auto-save-hook' before saving.
5175 A non-nil NO-MESSAGE argument means do not print any message if successful.
5176 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5177 (Lisp_Object no_message
, Lisp_Object current_only
)
5179 struct buffer
*old
= current_buffer
, *b
;
5180 Lisp_Object tail
, buf
;
5182 int do_handled_files
;
5184 FILE *stream
= NULL
;
5185 int count
= SPECPDL_INDEX ();
5186 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5187 int old_message_p
= 0;
5188 struct gcpro gcpro1
, gcpro2
;
5190 if (max_specpdl_size
< specpdl_size
+ 40)
5191 max_specpdl_size
= specpdl_size
+ 40;
5196 if (NILP (no_message
))
5198 old_message_p
= push_message ();
5199 record_unwind_protect (pop_message_unwind
, Qnil
);
5202 /* Ordinarily don't quit within this function,
5203 but don't make it impossible to quit (in case we get hung in I/O). */
5207 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5208 point to non-strings reached from Vbuffer_alist. */
5210 if (!NILP (Vrun_hooks
))
5211 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5213 if (STRINGP (Vauto_save_list_file_name
))
5215 Lisp_Object listfile
;
5217 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5219 /* Don't try to create the directory when shutting down Emacs,
5220 because creating the directory might signal an error, and
5221 that would leave Emacs in a strange state. */
5222 if (!NILP (Vrun_hooks
))
5226 GCPRO2 (dir
, listfile
);
5227 dir
= Ffile_name_directory (listfile
);
5228 if (NILP (Ffile_directory_p (dir
)))
5229 internal_condition_case_1 (do_auto_save_make_dir
,
5230 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5235 stream
= fopen (SSDATA (listfile
), "w");
5238 record_unwind_protect (do_auto_save_unwind
,
5239 make_save_value (stream
, 0));
5240 record_unwind_protect (do_auto_save_unwind_1
,
5241 make_number (minibuffer_auto_raise
));
5242 minibuffer_auto_raise
= 0;
5244 auto_save_error_occurred
= 0;
5246 /* On first pass, save all files that don't have handlers.
5247 On second pass, save all files that do have handlers.
5249 If Emacs is crashing, the handlers may tweak what is causing
5250 Emacs to crash in the first place, and it would be a shame if
5251 Emacs failed to autosave perfectly ordinary files because it
5252 couldn't handle some ange-ftp'd file. */
5254 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5255 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5257 buf
= XCDR (XCAR (tail
));
5260 /* Record all the buffers that have auto save mode
5261 in the special file that lists them. For each of these buffers,
5262 Record visited name (if any) and auto save name. */
5263 if (STRINGP (BVAR (b
, auto_save_file_name
))
5264 && stream
!= NULL
&& do_handled_files
== 0)
5267 if (!NILP (BVAR (b
, filename
)))
5269 fwrite (SDATA (BVAR (b
, filename
)), 1,
5270 SBYTES (BVAR (b
, filename
)), stream
);
5272 putc ('\n', stream
);
5273 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5274 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5275 putc ('\n', stream
);
5279 if (!NILP (current_only
)
5280 && b
!= current_buffer
)
5283 /* Don't auto-save indirect buffers.
5284 The base buffer takes care of it. */
5288 /* Check for auto save enabled
5289 and file changed since last auto save
5290 and file changed since last real save. */
5291 if (STRINGP (BVAR (b
, auto_save_file_name
))
5292 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5293 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5294 /* -1 means we've turned off autosaving for a while--see below. */
5295 && XINT (BVAR (b
, save_length
)) >= 0
5296 && (do_handled_files
5297 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5300 EMACS_TIME before_time
, after_time
;
5302 EMACS_GET_TIME (before_time
);
5304 /* If we had a failure, don't try again for 20 minutes. */
5305 if (b
->auto_save_failure_time
>= 0
5306 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5309 set_buffer_internal (b
);
5310 if (NILP (Vauto_save_include_big_deletions
)
5311 && (XFASTINT (BVAR (b
, save_length
)) * 10
5312 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5313 /* A short file is likely to change a large fraction;
5314 spare the user annoying messages. */
5315 && XFASTINT (BVAR (b
, save_length
)) > 5000
5316 /* These messages are frequent and annoying for `*mail*'. */
5317 && !EQ (BVAR (b
, filename
), Qnil
)
5318 && NILP (no_message
))
5320 /* It has shrunk too much; turn off auto-saving here. */
5321 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5322 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5324 minibuffer_auto_raise
= 0;
5325 /* Turn off auto-saving until there's a real save,
5326 and prevent any more warnings. */
5327 XSETINT (BVAR (b
, save_length
), -1);
5328 Fsleep_for (make_number (1), Qnil
);
5331 if (!auto_saved
&& NILP (no_message
))
5332 message1 ("Auto-saving...");
5333 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5335 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5336 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5337 set_buffer_internal (old
);
5339 EMACS_GET_TIME (after_time
);
5341 /* If auto-save took more than 60 seconds,
5342 assume it was an NFS failure that got a timeout. */
5343 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5344 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5348 /* Prevent another auto save till enough input events come in. */
5349 record_auto_save ();
5351 if (auto_saved
&& NILP (no_message
))
5355 /* If we are going to restore an old message,
5356 give time to read ours. */
5357 sit_for (make_number (1), 0, 0);
5360 else if (!auto_save_error_occurred
)
5361 /* Don't overwrite the error message if an error occurred.
5362 If we displayed a message and then restored a state
5363 with no message, leave a "done" message on the screen. */
5364 message1 ("Auto-saving...done");
5369 /* This restores the message-stack status. */
5370 unbind_to (count
, Qnil
);
5374 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5375 Sset_buffer_auto_saved
, 0, 0, 0,
5376 doc
: /* Mark current buffer as auto-saved with its current text.
5377 No auto-save file will be written until the buffer changes again. */)
5380 /* FIXME: This should not be called in indirect buffers, since
5381 they're not autosaved. */
5382 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5383 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5384 current_buffer
->auto_save_failure_time
= -1;
5388 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5389 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5390 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5393 current_buffer
->auto_save_failure_time
= -1;
5397 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5399 doc
: /* Return t if current buffer has been auto-saved recently.
5400 More precisely, if it has been auto-saved since last read from or saved
5401 in the visited file. If the buffer has no visited file,
5402 then any auto-save counts as "recent". */)
5405 /* FIXME: maybe we should return nil for indirect buffers since
5406 they're never autosaved. */
5407 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5410 /* Reading and completing file names */
5412 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5413 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5414 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5415 The return value is only relevant for a call to `read-file-name' that happens
5416 before any other event (mouse or keypress) is handled. */)
5419 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5420 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5430 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5432 struct gcpro gcpro1
;
5433 Lisp_Object args
[7];
5435 GCPRO1 (default_filename
);
5436 args
[0] = intern ("read-file-name");
5439 args
[3] = default_filename
;
5440 args
[4] = mustmatch
;
5442 args
[6] = predicate
;
5443 RETURN_UNGCPRO (Ffuncall (7, args
));
5448 syms_of_fileio (void)
5450 Qoperations
= intern_c_string ("operations");
5451 Qexpand_file_name
= intern_c_string ("expand-file-name");
5452 Qsubstitute_in_file_name
= intern_c_string ("substitute-in-file-name");
5453 Qdirectory_file_name
= intern_c_string ("directory-file-name");
5454 Qfile_name_directory
= intern_c_string ("file-name-directory");
5455 Qfile_name_nondirectory
= intern_c_string ("file-name-nondirectory");
5456 Qunhandled_file_name_directory
= intern_c_string ("unhandled-file-name-directory");
5457 Qfile_name_as_directory
= intern_c_string ("file-name-as-directory");
5458 Qcopy_file
= intern_c_string ("copy-file");
5459 Qmake_directory_internal
= intern_c_string ("make-directory-internal");
5460 Qmake_directory
= intern_c_string ("make-directory");
5461 Qdelete_directory_internal
= intern_c_string ("delete-directory-internal");
5462 Qdelete_file
= intern_c_string ("delete-file");
5463 Qrename_file
= intern_c_string ("rename-file");
5464 Qadd_name_to_file
= intern_c_string ("add-name-to-file");
5465 Qmake_symbolic_link
= intern_c_string ("make-symbolic-link");
5466 Qfile_exists_p
= intern_c_string ("file-exists-p");
5467 Qfile_executable_p
= intern_c_string ("file-executable-p");
5468 Qfile_readable_p
= intern_c_string ("file-readable-p");
5469 Qfile_writable_p
= intern_c_string ("file-writable-p");
5470 Qfile_symlink_p
= intern_c_string ("file-symlink-p");
5471 Qaccess_file
= intern_c_string ("access-file");
5472 Qfile_directory_p
= intern_c_string ("file-directory-p");
5473 Qfile_regular_p
= intern_c_string ("file-regular-p");
5474 Qfile_accessible_directory_p
= intern_c_string ("file-accessible-directory-p");
5475 Qfile_modes
= intern_c_string ("file-modes");
5476 Qset_file_modes
= intern_c_string ("set-file-modes");
5477 Qset_file_times
= intern_c_string ("set-file-times");
5478 Qfile_selinux_context
= intern_c_string("file-selinux-context");
5479 Qset_file_selinux_context
= intern_c_string("set-file-selinux-context");
5480 Qfile_newer_than_file_p
= intern_c_string ("file-newer-than-file-p");
5481 Qinsert_file_contents
= intern_c_string ("insert-file-contents");
5482 Qwrite_region
= intern_c_string ("write-region");
5483 Qverify_visited_file_modtime
= intern_c_string ("verify-visited-file-modtime");
5484 Qset_visited_file_modtime
= intern_c_string ("set-visited-file-modtime");
5485 Qauto_save_coding
= intern_c_string ("auto-save-coding");
5487 staticpro (&Qoperations
);
5488 staticpro (&Qexpand_file_name
);
5489 staticpro (&Qsubstitute_in_file_name
);
5490 staticpro (&Qdirectory_file_name
);
5491 staticpro (&Qfile_name_directory
);
5492 staticpro (&Qfile_name_nondirectory
);
5493 staticpro (&Qunhandled_file_name_directory
);
5494 staticpro (&Qfile_name_as_directory
);
5495 staticpro (&Qcopy_file
);
5496 staticpro (&Qmake_directory_internal
);
5497 staticpro (&Qmake_directory
);
5498 staticpro (&Qdelete_directory_internal
);
5499 staticpro (&Qdelete_file
);
5500 staticpro (&Qrename_file
);
5501 staticpro (&Qadd_name_to_file
);
5502 staticpro (&Qmake_symbolic_link
);
5503 staticpro (&Qfile_exists_p
);
5504 staticpro (&Qfile_executable_p
);
5505 staticpro (&Qfile_readable_p
);
5506 staticpro (&Qfile_writable_p
);
5507 staticpro (&Qaccess_file
);
5508 staticpro (&Qfile_symlink_p
);
5509 staticpro (&Qfile_directory_p
);
5510 staticpro (&Qfile_regular_p
);
5511 staticpro (&Qfile_accessible_directory_p
);
5512 staticpro (&Qfile_modes
);
5513 staticpro (&Qset_file_modes
);
5514 staticpro (&Qset_file_times
);
5515 staticpro (&Qfile_selinux_context
);
5516 staticpro (&Qset_file_selinux_context
);
5517 staticpro (&Qfile_newer_than_file_p
);
5518 staticpro (&Qinsert_file_contents
);
5519 staticpro (&Qwrite_region
);
5520 staticpro (&Qverify_visited_file_modtime
);
5521 staticpro (&Qset_visited_file_modtime
);
5522 staticpro (&Qauto_save_coding
);
5524 Qfile_name_history
= intern_c_string ("file-name-history");
5525 Fset (Qfile_name_history
, Qnil
);
5526 staticpro (&Qfile_name_history
);
5528 Qfile_error
= intern_c_string ("file-error");
5529 staticpro (&Qfile_error
);
5530 Qfile_already_exists
= intern_c_string ("file-already-exists");
5531 staticpro (&Qfile_already_exists
);
5532 Qfile_date_error
= intern_c_string ("file-date-error");
5533 staticpro (&Qfile_date_error
);
5534 Qexcl
= intern_c_string ("excl");
5537 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5538 doc
: /* *Coding system for encoding file names.
5539 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5540 Vfile_name_coding_system
= Qnil
;
5542 DEFVAR_LISP ("default-file-name-coding-system",
5543 Vdefault_file_name_coding_system
,
5544 doc
: /* Default coding system for encoding file names.
5545 This variable is used only when `file-name-coding-system' is nil.
5547 This variable is set/changed by the command `set-language-environment'.
5548 User should not set this variable manually,
5549 instead use `file-name-coding-system' to get a constant encoding
5550 of file names regardless of the current language environment. */);
5551 Vdefault_file_name_coding_system
= Qnil
;
5553 Qformat_decode
= intern_c_string ("format-decode");
5554 staticpro (&Qformat_decode
);
5555 Qformat_annotate_function
= intern_c_string ("format-annotate-function");
5556 staticpro (&Qformat_annotate_function
);
5557 Qafter_insert_file_set_coding
= intern_c_string ("after-insert-file-set-coding");
5558 staticpro (&Qafter_insert_file_set_coding
);
5560 Qcar_less_than_car
= intern_c_string ("car-less-than-car");
5561 staticpro (&Qcar_less_than_car
);
5563 Fput (Qfile_error
, Qerror_conditions
,
5564 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5565 Fput (Qfile_error
, Qerror_message
,
5566 make_pure_c_string ("File error"));
5568 Fput (Qfile_already_exists
, Qerror_conditions
,
5569 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5570 Fput (Qfile_already_exists
, Qerror_message
,
5571 make_pure_c_string ("File already exists"));
5573 Fput (Qfile_date_error
, Qerror_conditions
,
5574 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5575 Fput (Qfile_date_error
, Qerror_message
,
5576 make_pure_c_string ("Cannot set file date"));
5578 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5579 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
5580 If a file name matches REGEXP, then all I/O on that file is done by calling
5583 The first argument given to HANDLER is the name of the I/O primitive
5584 to be handled; the remaining arguments are the arguments that were
5585 passed to that primitive. For example, if you do
5586 (file-exists-p FILENAME)
5587 and FILENAME is handled by HANDLER, then HANDLER is called like this:
5588 (funcall HANDLER 'file-exists-p FILENAME)
5589 The function `find-file-name-handler' checks this list for a handler
5590 for its argument. */);
5591 Vfile_name_handler_alist
= Qnil
;
5593 DEFVAR_LISP ("set-auto-coding-function",
5594 Vset_auto_coding_function
,
5595 doc
: /* If non-nil, a function to call to decide a coding system of file.
5596 Two arguments are passed to this function: the file name
5597 and the length of a file contents following the point.
5598 This function should return a coding system to decode the file contents.
5599 It should check the file name against `auto-coding-alist'.
5600 If no coding system is decided, it should check a coding system
5601 specified in the heading lines with the format:
5602 -*- ... coding: CODING-SYSTEM; ... -*-
5603 or local variable spec of the tailing lines with `coding:' tag. */);
5604 Vset_auto_coding_function
= Qnil
;
5606 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5607 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5608 Each is passed one argument, the number of characters inserted,
5609 with point at the start of the inserted text. Each function
5610 should leave point the same, and return the new character count.
5611 If `insert-file-contents' is intercepted by a handler from
5612 `file-name-handler-alist', that handler is responsible for calling the
5613 functions in `after-insert-file-functions' if appropriate. */);
5614 Vafter_insert_file_functions
= Qnil
;
5616 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5617 doc
: /* A list of functions to be called at the start of `write-region'.
5618 Each is passed two arguments, START and END as for `write-region'.
5619 These are usually two numbers but not always; see the documentation
5620 for `write-region'. The function should return a list of pairs
5621 of the form (POSITION . STRING), consisting of strings to be effectively
5622 inserted at the specified positions of the file being written (1 means to
5623 insert before the first byte written). The POSITIONs must be sorted into
5626 If there are several annotation functions, the lists returned by these
5627 functions are merged destructively. As each annotation function runs,
5628 the variable `write-region-annotations-so-far' contains a list of all
5629 annotations returned by previous annotation functions.
5631 An annotation function can return with a different buffer current.
5632 Doing so removes the annotations returned by previous functions, and
5633 resets START and END to `point-min' and `point-max' of the new buffer.
5635 After `write-region' completes, Emacs calls the function stored in
5636 `write-region-post-annotation-function', once for each buffer that was
5637 current when building the annotations (i.e., at least once), with that
5638 buffer current. */);
5639 Vwrite_region_annotate_functions
= Qnil
;
5640 staticpro (&Qwrite_region_annotate_functions
);
5641 Qwrite_region_annotate_functions
5642 = intern_c_string ("write-region-annotate-functions");
5644 DEFVAR_LISP ("write-region-post-annotation-function",
5645 Vwrite_region_post_annotation_function
,
5646 doc
: /* Function to call after `write-region' completes.
5647 The function is called with no arguments. If one or more of the
5648 annotation functions in `write-region-annotate-functions' changed the
5649 current buffer, the function stored in this variable is called for
5650 each of those additional buffers as well, in addition to the original
5651 buffer. The relevant buffer is current during each function call. */);
5652 Vwrite_region_post_annotation_function
= Qnil
;
5653 staticpro (&Vwrite_region_annotation_buffers
);
5655 DEFVAR_LISP ("write-region-annotations-so-far",
5656 Vwrite_region_annotations_so_far
,
5657 doc
: /* When an annotation function is called, this holds the previous annotations.
5658 These are the annotations made by other annotation functions
5659 that were already called. See also `write-region-annotate-functions'. */);
5660 Vwrite_region_annotations_so_far
= Qnil
;
5662 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5663 doc
: /* A list of file name handlers that temporarily should not be used.
5664 This applies only to the operation `inhibit-file-name-operation'. */);
5665 Vinhibit_file_name_handlers
= Qnil
;
5667 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5668 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5669 Vinhibit_file_name_operation
= Qnil
;
5671 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
5672 doc
: /* File name in which we write a list of all auto save file names.
5673 This variable is initialized automatically from `auto-save-list-file-prefix'
5674 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5675 a non-nil value. */);
5676 Vauto_save_list_file_name
= Qnil
;
5678 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
5679 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5680 Normally auto-save files are written under other names. */);
5681 Vauto_save_visited_file_name
= Qnil
;
5683 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
5684 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5685 If nil, deleting a substantial portion of the text disables auto-save
5686 in the buffer; this is the default behavior, because the auto-save
5687 file is usually more useful if it contains the deleted text. */);
5688 Vauto_save_include_big_deletions
= Qnil
;
5691 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
5692 doc
: /* *Non-nil means don't call fsync in `write-region'.
5693 This variable affects calls to `write-region' as well as save commands.
5694 A non-nil value may result in data loss! */);
5695 write_region_inhibit_fsync
= 0;
5698 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
5699 doc
: /* Specifies whether to use the system's trash can.
5700 When non-nil, certain file deletion commands use the function
5701 `move-file-to-trash' instead of deleting files outright.
5702 This includes interactive calls to `delete-file' and
5703 `delete-directory' and the Dired deletion commands. */);
5704 delete_by_moving_to_trash
= 0;
5705 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5706 Qmove_file_to_trash
= intern_c_string ("move-file-to-trash");
5707 staticpro (&Qmove_file_to_trash
);
5708 Qcopy_directory
= intern_c_string ("copy-directory");
5709 staticpro (&Qcopy_directory
);
5710 Qdelete_directory
= intern_c_string ("delete-directory");
5711 staticpro (&Qdelete_directory
);
5713 defsubr (&Sfind_file_name_handler
);
5714 defsubr (&Sfile_name_directory
);
5715 defsubr (&Sfile_name_nondirectory
);
5716 defsubr (&Sunhandled_file_name_directory
);
5717 defsubr (&Sfile_name_as_directory
);
5718 defsubr (&Sdirectory_file_name
);
5719 defsubr (&Smake_temp_name
);
5720 defsubr (&Sexpand_file_name
);
5721 defsubr (&Ssubstitute_in_file_name
);
5722 defsubr (&Scopy_file
);
5723 defsubr (&Smake_directory_internal
);
5724 defsubr (&Sdelete_directory_internal
);
5725 defsubr (&Sdelete_file
);
5726 defsubr (&Srename_file
);
5727 defsubr (&Sadd_name_to_file
);
5728 defsubr (&Smake_symbolic_link
);
5729 defsubr (&Sfile_name_absolute_p
);
5730 defsubr (&Sfile_exists_p
);
5731 defsubr (&Sfile_executable_p
);
5732 defsubr (&Sfile_readable_p
);
5733 defsubr (&Sfile_writable_p
);
5734 defsubr (&Saccess_file
);
5735 defsubr (&Sfile_symlink_p
);
5736 defsubr (&Sfile_directory_p
);
5737 defsubr (&Sfile_accessible_directory_p
);
5738 defsubr (&Sfile_regular_p
);
5739 defsubr (&Sfile_modes
);
5740 defsubr (&Sset_file_modes
);
5741 defsubr (&Sset_file_times
);
5742 defsubr (&Sfile_selinux_context
);
5743 defsubr (&Sset_file_selinux_context
);
5744 defsubr (&Sset_default_file_modes
);
5745 defsubr (&Sdefault_file_modes
);
5746 defsubr (&Sfile_newer_than_file_p
);
5747 defsubr (&Sinsert_file_contents
);
5748 defsubr (&Swrite_region
);
5749 defsubr (&Scar_less_than_car
);
5750 defsubr (&Sverify_visited_file_modtime
);
5751 defsubr (&Sclear_visited_file_modtime
);
5752 defsubr (&Svisited_file_modtime
);
5753 defsubr (&Sset_visited_file_modtime
);
5754 defsubr (&Sdo_auto_save
);
5755 defsubr (&Sset_buffer_auto_saved
);
5756 defsubr (&Sclear_buffer_auto_save_failure
);
5757 defsubr (&Srecent_auto_save_p
);
5759 defsubr (&Snext_read_file_uses_dialog_p
);
5762 defsubr (&Sunix_sync
);