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
, 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). */
732 /* This should only point to alloca'd data. */
739 int collapse_newdir
= 1;
743 Lisp_Object handler
, result
;
749 /* If the file name has special constructs in it,
750 call the corresponding file handler. */
751 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
753 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
755 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
756 if (NILP (default_directory
))
757 default_directory
= BVAR (current_buffer
, directory
);
758 if (! STRINGP (default_directory
))
761 /* "/" is not considered a root directory on DOS_NT, so using "/"
762 here causes an infinite recursion in, e.g., the following:
764 (let (default-directory)
765 (expand-file-name "a"))
767 To avoid this, we set default_directory to the root of the
769 default_directory
= build_string (emacs_root_dir ());
771 default_directory
= build_string ("/");
775 if (!NILP (default_directory
))
777 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
779 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
783 char *o
= SSDATA (default_directory
);
785 /* Make sure DEFAULT_DIRECTORY is properly expanded.
786 It would be better to do this down below where we actually use
787 default_directory. Unfortunately, calling Fexpand_file_name recursively
788 could invoke GC, and the strings might be relocated. This would
789 be annoying because we have pointers into strings lying around
790 that would need adjusting, and people would add new pointers to
791 the code and forget to adjust them, resulting in intermittent bugs.
792 Putting this call here avoids all that crud.
794 The EQ test avoids infinite recursion. */
795 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
796 /* Save time in some common cases - as long as default_directory
797 is not relative, it can be canonicalized with name below (if it
798 is needed at all) without requiring it to be expanded now. */
800 /* Detect MSDOS file names with drive specifiers. */
801 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
802 && IS_DIRECTORY_SEP (o
[2]))
804 /* Detect Windows file names in UNC format. */
805 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
807 #else /* not DOS_NT */
808 /* Detect Unix absolute file names (/... alone is not absolute on
810 && ! (IS_DIRECTORY_SEP (o
[0]))
811 #endif /* not DOS_NT */
817 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
821 name
= FILE_SYSTEM_CASE (name
);
822 multibyte
= STRING_MULTIBYTE (name
);
823 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
826 default_directory
= string_to_multibyte (default_directory
);
829 name
= string_to_multibyte (name
);
834 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
835 nm
= (char *) alloca (SBYTES (name
) + 1);
836 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
839 /* Note if special escape prefix is present, but remove for now. */
840 if (nm
[0] == '/' && nm
[1] == ':')
846 /* Find and remove drive specifier if present; this makes nm absolute
847 even if the rest of the name appears to be relative. Only look for
848 drive specifier at the beginning. */
849 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
851 drive
= (unsigned char) nm
[0];
856 /* If we see "c://somedir", we want to strip the first slash after the
857 colon when stripping the drive letter. Otherwise, this expands to
859 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
862 /* Discard any previous drive specifier if nm is now in UNC format. */
863 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
867 #endif /* WINDOWSNT */
870 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
871 none are found, we can probably return right away. We will avoid
872 allocating a new string if name is already fully expanded. */
874 IS_DIRECTORY_SEP (nm
[0])
876 && drive
&& !is_escaped
879 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
883 /* If it turns out that the filename we want to return is just a
884 suffix of FILENAME, we don't need to go through and edit
885 things; we just need to construct a new string using data
886 starting at the middle of FILENAME. If we set lose to a
887 non-zero value, that means we've discovered that we can't do
894 /* Since we know the name is absolute, we can assume that each
895 element starts with a "/". */
897 /* "." and ".." are hairy. */
898 if (IS_DIRECTORY_SEP (p
[0])
900 && (IS_DIRECTORY_SEP (p
[2])
902 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
905 /* We want to replace multiple `/' in a row with a single
908 && IS_DIRECTORY_SEP (p
[0])
909 && IS_DIRECTORY_SEP (p
[1]))
916 /* Make sure directories are all separated with /, but
917 avoid allocation of a new string when not required. */
918 dostounix_filename (nm
);
920 if (IS_DIRECTORY_SEP (nm
[1]))
922 if (strcmp (nm
, SSDATA (name
)) != 0)
923 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
927 /* drive must be set, so this is okay */
928 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
932 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
933 temp
[0] = DRIVE_LETTER (drive
);
934 name
= concat2 (build_string (temp
), name
);
937 #else /* not DOS_NT */
938 if (strcmp (nm
, SSDATA (name
)) == 0)
940 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
941 #endif /* not DOS_NT */
945 /* At this point, nm might or might not be an absolute file name. We
946 need to expand ~ or ~user if present, otherwise prefix nm with
947 default_directory if nm is not absolute, and finally collapse /./
948 and /foo/../ sequences.
950 We set newdir to be the appropriate prefix if one is needed:
951 - the relevant user directory if nm starts with ~ or ~user
952 - the specified drive's working dir (DOS/NT only) if nm does not
954 - the value of default_directory.
956 Note that these prefixes are not guaranteed to be absolute (except
957 for the working dir of a drive). Therefore, to ensure we always
958 return an absolute name, if the final prefix is not absolute we
959 append it to the current working directory. */
963 if (nm
[0] == '~') /* prefix ~ */
965 if (IS_DIRECTORY_SEP (nm
[1])
966 || nm
[1] == 0) /* ~ by itself */
970 if (!(newdir
= egetenv ("HOME")))
973 /* egetenv may return a unibyte string, which will bite us since
974 we expect the directory to be multibyte. */
975 tem
= build_string (newdir
);
976 if (!STRING_MULTIBYTE (tem
))
978 hdir
= DECODE_FILE (tem
);
979 newdir
= SSDATA (hdir
);
985 else /* ~user/filename */
988 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
989 o
= alloca (p
- nm
+ 1);
990 memcpy (o
, nm
, p
- nm
);
994 pw
= (struct passwd
*) getpwnam (o
+ 1);
1001 collapse_newdir
= 0;
1005 /* If we don't find a user of that name, leave the name
1006 unchanged; don't move nm forward to p. */
1011 /* On DOS and Windows, nm is absolute if a drive name was specified;
1012 use the drive's current directory as the prefix if needed. */
1013 if (!newdir
&& drive
)
1015 /* Get default directory if needed to make nm absolute. */
1016 if (!IS_DIRECTORY_SEP (nm
[0]))
1018 newdir
= alloca (MAXPATHLEN
+ 1);
1019 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1024 /* Either nm starts with /, or drive isn't mounted. */
1025 newdir
= alloca (4);
1026 newdir
[0] = DRIVE_LETTER (drive
);
1034 /* Finally, if no prefix has been specified and nm is not absolute,
1035 then it must be expanded relative to default_directory. */
1039 /* /... alone is not absolute on DOS and Windows. */
1040 && !IS_DIRECTORY_SEP (nm
[0])
1043 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1047 newdir
= SSDATA (default_directory
);
1049 /* Note if special escape prefix is present, but remove for now. */
1050 if (newdir
[0] == '/' && newdir
[1] == ':')
1061 /* First ensure newdir is an absolute name. */
1063 /* Detect MSDOS file names with drive specifiers. */
1064 ! (IS_DRIVE (newdir
[0])
1065 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1067 /* Detect Windows file names in UNC format. */
1068 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1072 /* Effectively, let newdir be (expand-file-name newdir cwd).
1073 Because of the admonition against calling expand-file-name
1074 when we have pointers into lisp strings, we accomplish this
1075 indirectly by prepending newdir to nm if necessary, and using
1076 cwd (or the wd of newdir's drive) as the new newdir. */
1078 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1080 drive
= (unsigned char) newdir
[0];
1083 if (!IS_DIRECTORY_SEP (nm
[0]))
1085 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1086 file_name_as_directory (tmp
, newdir
);
1090 newdir
= alloca (MAXPATHLEN
+ 1);
1093 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1100 /* Strip off drive name from prefix, if present. */
1101 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1107 /* Keep only a prefix from newdir if nm starts with slash
1108 (//server/share for UNC, nothing otherwise). */
1109 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1112 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1115 newdir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1117 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1119 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1131 /* Get rid of any slash at the end of newdir, unless newdir is
1132 just / or // (an incomplete UNC name). */
1133 length
= strlen (newdir
);
1134 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1136 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1140 char *temp
= (char *) alloca (length
);
1141 memcpy (temp
, newdir
, length
- 1);
1142 temp
[length
- 1] = 0;
1150 /* Now concatenate the directory and name to new space in the stack frame */
1151 tlen
+= strlen (nm
) + 1;
1153 /* Reserve space for drive specifier and escape prefix, since either
1154 or both may need to be inserted. (The Microsoft x86 compiler
1155 produces incorrect code if the following two lines are combined.) */
1156 target
= (char *) alloca (tlen
+ 4);
1158 #else /* not DOS_NT */
1159 target
= (char *) alloca (tlen
);
1160 #endif /* not DOS_NT */
1165 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1168 /* If newdir is effectively "C:/", then the drive letter will have
1169 been stripped and newdir will be "/". Concatenating with an
1170 absolute directory in nm produces "//", which will then be
1171 incorrectly treated as a network share. Ignore newdir in
1172 this case (keeping the drive letter). */
1173 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1174 && newdir
[1] == '\0'))
1176 strcpy (target
, newdir
);
1179 file_name_as_directory (target
, newdir
);
1182 strcat (target
, nm
);
1184 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1192 if (!IS_DIRECTORY_SEP (*p
))
1196 else if (p
[1] == '.'
1197 && (IS_DIRECTORY_SEP (p
[2])
1200 /* If "/." is the entire filename, keep the "/". Otherwise,
1201 just delete the whole "/.". */
1202 if (o
== target
&& p
[2] == '\0')
1206 else if (p
[1] == '.' && p
[2] == '.'
1207 /* `/../' is the "superroot" on certain file systems.
1208 Turned off on DOS_NT systems because they have no
1209 "superroot" and because this causes us to produce
1210 file names like "d:/../foo" which fail file-related
1211 functions of the underlying OS. (To reproduce, try a
1212 long series of "../../" in default_directory, longer
1213 than the number of levels from the root.) */
1217 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1222 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1225 /* Don't go below server level in UNC filenames. */
1226 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1227 && IS_DIRECTORY_SEP (*target
))
1231 /* Keep initial / only if this is the whole name. */
1232 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1236 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1237 /* Collapse multiple `/' in a row. */
1246 /* At last, set drive name. */
1248 /* Except for network file name. */
1249 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1250 #endif /* WINDOWSNT */
1252 if (!drive
) abort ();
1254 target
[0] = DRIVE_LETTER (drive
);
1257 /* Reinsert the escape prefix if required. */
1264 dostounix_filename (target
);
1267 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1270 /* Again look to see if the file name has special constructs in it
1271 and perhaps call the corresponding file handler. This is needed
1272 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1273 the ".." component gives us "/user@host:/bar/../baz" which needs
1274 to be expanded again. */
1275 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1276 if (!NILP (handler
))
1277 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1283 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1284 This is the old version of expand-file-name, before it was thoroughly
1285 rewritten for Emacs 10.31. We leave this version here commented-out,
1286 because the code is very complex and likely to have subtle bugs. If
1287 bugs _are_ found, it might be of interest to look at the old code and
1288 see what did it do in the relevant situation.
1290 Don't remove this code: it's true that it will be accessible
1291 from the repository, but a few years from deletion, people will
1292 forget it is there. */
1294 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1295 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1296 "Convert FILENAME to absolute, and canonicalize it.\n\
1297 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1298 \(does not start with slash); if DEFAULT is nil or missing,\n\
1299 the current buffer's value of default-directory is used.\n\
1300 Filenames containing `.' or `..' as components are simplified;\n\
1301 initial `~/' expands to your home directory.\n\
1302 See also the function `substitute-in-file-name'.")
1304 Lisp_Object name
, defalt
;
1308 register unsigned char *newdir
, *p
, *o
;
1310 unsigned char *target
;
1314 CHECK_STRING (name
);
1317 /* If nm is absolute, flush ...// and detect /./ and /../.
1318 If no /./ or /../ we can return right away. */
1325 if (p
[0] == '/' && p
[1] == '/'
1328 if (p
[0] == '/' && p
[1] == '~')
1329 nm
= p
+ 1, lose
= 1;
1330 if (p
[0] == '/' && p
[1] == '.'
1331 && (p
[2] == '/' || p
[2] == 0
1332 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1338 if (nm
== SDATA (name
))
1340 return build_string (nm
);
1344 /* Now determine directory to start with and put it in NEWDIR */
1348 if (nm
[0] == '~') /* prefix ~ */
1349 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1351 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1352 newdir
= (unsigned char *) "";
1355 else /* ~user/filename */
1357 /* Get past ~ to user */
1358 unsigned char *user
= nm
+ 1;
1359 /* Find end of name. */
1360 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1361 int len
= ptr
? ptr
- user
: strlen (user
);
1362 /* Copy the user name into temp storage. */
1363 o
= (unsigned char *) alloca (len
+ 1);
1364 memcpy (o
, user
, len
);
1367 /* Look up the user name. */
1369 pw
= (struct passwd
*) getpwnam (o
+ 1);
1372 error ("\"%s\" isn't a registered user", o
+ 1);
1374 newdir
= (unsigned char *) pw
->pw_dir
;
1376 /* Discard the user name from NM. */
1380 if (nm
[0] != '/' && !newdir
)
1383 defalt
= current_buffer
->directory
;
1384 CHECK_STRING (defalt
);
1385 newdir
= SDATA (defalt
);
1388 /* Now concatenate the directory and name to new space in the stack frame */
1390 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1391 target
= (unsigned char *) alloca (tlen
);
1396 if (nm
[0] == 0 || nm
[0] == '/')
1397 strcpy (target
, newdir
);
1399 file_name_as_directory (target
, newdir
);
1402 strcat (target
, nm
);
1404 /* Now canonicalize by removing /. and /foo/.. if they appear */
1415 else if (!strncmp (p
, "//", 2)
1421 else if (p
[0] == '/' && p
[1] == '.'
1422 && (p
[2] == '/' || p
[2] == 0))
1424 else if (!strncmp (p
, "/..", 3)
1425 /* `/../' is the "superroot" on certain file systems. */
1427 && (p
[3] == '/' || p
[3] == 0))
1429 while (o
!= target
&& *--o
!= '/')
1431 if (o
== target
&& *o
== '/')
1441 return make_string (target
, o
- target
);
1445 /* If /~ or // appears, discard everything through first slash. */
1447 file_name_absolute_p (const char *filename
)
1450 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1452 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1453 && IS_DIRECTORY_SEP (filename
[2]))
1459 search_embedded_absfilename (char *nm
, char *endp
)
1463 for (p
= nm
+ 1; p
< endp
; p
++)
1466 || IS_DIRECTORY_SEP (p
[-1]))
1467 && file_name_absolute_p (p
)
1468 #if defined (WINDOWSNT) || defined(CYGWIN)
1469 /* // at start of file name is meaningful in Apollo,
1470 WindowsNT and Cygwin systems. */
1471 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1472 #endif /* not (WINDOWSNT || CYGWIN) */
1475 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1476 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
1478 char *o
= alloca (s
- p
+ 1);
1480 memcpy (o
, p
, s
- p
);
1483 /* If we have ~user and `user' exists, discard
1484 everything up to ~. But if `user' does not exist, leave
1485 ~user alone, it might be a literal file name. */
1487 pw
= getpwnam (o
+ 1);
1499 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1500 Ssubstitute_in_file_name
, 1, 1, 0,
1501 doc
: /* Substitute environment variables referred to in FILENAME.
1502 `$FOO' where FOO is an environment variable name means to substitute
1503 the value of that variable. The variable name should be terminated
1504 with a character not a letter, digit or underscore; otherwise, enclose
1505 the entire variable name in braces.
1507 If `/~' appears, all of FILENAME through that `/' is discarded.
1508 If `//' appears, everything up to and including the first of
1509 those `/' is discarded. */)
1510 (Lisp_Object filename
)
1514 register char *s
, *p
, *o
, *x
, *endp
;
1515 char *target
= NULL
;
1517 int substituted
= 0;
1520 Lisp_Object handler
;
1522 CHECK_STRING (filename
);
1524 multibyte
= STRING_MULTIBYTE (filename
);
1526 /* If the file name has special constructs in it,
1527 call the corresponding file handler. */
1528 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1529 if (!NILP (handler
))
1530 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
1532 /* Always work on a copy of the string, in case GC happens during
1533 decode of environment variables, causing the original Lisp_String
1534 data to be relocated. */
1535 nm
= (char *) alloca (SBYTES (filename
) + 1);
1536 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1539 dostounix_filename (nm
);
1540 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1542 endp
= nm
+ SBYTES (filename
);
1544 /* If /~ or // appears, discard everything through first slash. */
1545 p
= search_embedded_absfilename (nm
, endp
);
1547 /* Start over with the new string, so we check the file-name-handler
1548 again. Important with filenames like "/home/foo//:/hello///there"
1549 which whould substitute to "/:/hello///there" rather than "/there". */
1550 return Fsubstitute_in_file_name
1551 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1553 /* See if any variables are substituted into the string
1554 and find the total length of their values in `total' */
1556 for (p
= nm
; p
!= endp
;)
1566 /* "$$" means a single "$" */
1575 while (p
!= endp
&& *p
!= '}') p
++;
1576 if (*p
!= '}') goto missingclose
;
1582 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1586 /* Copy out the variable name */
1587 target
= (char *) alloca (s
- o
+ 1);
1588 strncpy (target
, o
, s
- o
);
1591 strupr (target
); /* $home == $HOME etc. */
1594 /* Get variable value */
1595 o
= egetenv (target
);
1598 /* Don't try to guess a maximum length - UTF8 can use up to
1599 four bytes per character. This code is unlikely to run
1600 in a situation that requires performance, so decoding the
1601 env variables twice should be acceptable. Note that
1602 decoding may cause a garbage collect. */
1603 Lisp_Object orig
, decoded
;
1604 orig
= make_unibyte_string (o
, strlen (o
));
1605 decoded
= DECODE_FILE (orig
);
1606 total
+= SBYTES (decoded
);
1616 /* If substitution required, recopy the string and do it */
1617 /* Make space in stack frame for the new copy */
1618 xnm
= (char *) alloca (SBYTES (filename
) + total
+ 1);
1621 /* Copy the rest of the name through, replacing $ constructs with values */
1638 while (p
!= endp
&& *p
!= '}') p
++;
1639 if (*p
!= '}') goto missingclose
;
1645 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1649 /* Copy out the variable name */
1650 target
= (char *) alloca (s
- o
+ 1);
1651 strncpy (target
, o
, s
- o
);
1654 strupr (target
); /* $home == $HOME etc. */
1657 /* Get variable value */
1658 o
= egetenv (target
);
1662 strcpy (x
, target
); x
+= strlen (target
);
1666 Lisp_Object orig
, decoded
;
1667 int orig_length
, decoded_length
;
1668 orig_length
= strlen (o
);
1669 orig
= make_unibyte_string (o
, orig_length
);
1670 decoded
= DECODE_FILE (orig
);
1671 decoded_length
= SBYTES (decoded
);
1672 strncpy (x
, SSDATA (decoded
), decoded_length
);
1673 x
+= decoded_length
;
1675 /* If environment variable needed decoding, return value
1676 needs to be multibyte. */
1677 if (decoded_length
!= orig_length
1678 || strncmp (SSDATA (decoded
), o
, orig_length
))
1685 /* If /~ or // appears, discard everything through first slash. */
1686 while ((p
= search_embedded_absfilename (xnm
, x
)))
1687 /* This time we do not start over because we've already expanded envvars
1688 and replaced $$ with $. Maybe we should start over as well, but we'd
1689 need to quote some $ to $$ first. */
1692 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1695 error ("Bad format environment-variable substitution");
1697 error ("Missing \"}\" in environment-variable substitution");
1699 error ("Substituting nonexistent environment variable \"%s\"", target
);
1705 /* A slightly faster and more convenient way to get
1706 (directory-file-name (expand-file-name FOO)). */
1709 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1711 register Lisp_Object absname
;
1713 absname
= Fexpand_file_name (filename
, defdir
);
1715 /* Remove final slash, if any (unless this is the root dir).
1716 stat behaves differently depending! */
1717 if (SCHARS (absname
) > 1
1718 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1719 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
1720 /* We cannot take shortcuts; they might be wrong for magic file names. */
1721 absname
= Fdirectory_file_name (absname
);
1725 /* Signal an error if the file ABSNAME already exists.
1726 If INTERACTIVE is nonzero, ask the user whether to proceed,
1727 and bypass the error if the user says to go ahead.
1728 QUERYSTRING is a name for the action that is being considered
1731 *STATPTR is used to store the stat information if the file exists.
1732 If the file does not exist, STATPTR->st_mode is set to 0.
1733 If STATPTR is null, we don't store into it.
1735 If QUICK is nonzero, we ask for y or n, not yes or no. */
1738 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1739 int interactive
, struct stat
*statptr
, int quick
)
1741 register Lisp_Object tem
, encoded_filename
;
1742 struct stat statbuf
;
1743 struct gcpro gcpro1
;
1745 encoded_filename
= ENCODE_FILE (absname
);
1747 /* stat is a good way to tell whether the file exists,
1748 regardless of what access permissions it has. */
1749 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1752 xsignal2 (Qfile_already_exists
,
1753 build_string ("File already exists"), absname
);
1755 tem
= format2 ("File %s already exists; %s anyway? ",
1756 absname
, build_string (querystring
));
1758 tem
= call1 (intern ("y-or-n-p"), tem
);
1760 tem
= do_yes_or_no_p (tem
);
1763 xsignal2 (Qfile_already_exists
,
1764 build_string ("File already exists"), absname
);
1771 statptr
->st_mode
= 0;
1776 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1777 "fCopy file: \nGCopy %s to file: \np\nP",
1778 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1779 If NEWNAME names a directory, copy FILE there.
1781 This function always sets the file modes of the output file to match
1784 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1785 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1786 signal a `file-already-exists' error without overwriting. If
1787 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1788 about overwriting; this is what happens in interactive use with M-x.
1789 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1792 Fourth arg KEEP-TIME non-nil means give the output file the same
1793 last-modified time as the old one. (This works on only some systems.)
1795 A prefix arg makes KEEP-TIME non-nil.
1797 If PRESERVE-UID-GID is non-nil, we try to transfer the
1798 uid and gid of FILE to NEWNAME.
1800 If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
1801 on the system, we copy the SELinux context of FILE to NEWNAME. */)
1802 (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
)
1805 char buf
[16 * 1024];
1806 struct stat st
, out_st
;
1807 Lisp_Object handler
;
1808 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1809 int count
= SPECPDL_INDEX ();
1810 int input_file_statable_p
;
1811 Lisp_Object encoded_file
, encoded_newname
;
1813 security_context_t con
;
1814 int fail
, conlength
= 0;
1817 encoded_file
= encoded_newname
= Qnil
;
1818 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1819 CHECK_STRING (file
);
1820 CHECK_STRING (newname
);
1822 if (!NILP (Ffile_directory_p (newname
)))
1823 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1825 newname
= Fexpand_file_name (newname
, Qnil
);
1827 file
= Fexpand_file_name (file
, Qnil
);
1829 /* If the input file name has special constructs in it,
1830 call the corresponding file handler. */
1831 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1832 /* Likewise for output file name. */
1834 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1835 if (!NILP (handler
))
1836 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1837 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1838 preserve_selinux_context
));
1840 encoded_file
= ENCODE_FILE (file
);
1841 encoded_newname
= ENCODE_FILE (newname
);
1843 if (NILP (ok_if_already_exists
)
1844 || INTEGERP (ok_if_already_exists
))
1845 barf_or_query_if_file_exists (newname
, "copy to it",
1846 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1847 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1851 if (!CopyFile (SDATA (encoded_file
),
1852 SDATA (encoded_newname
),
1854 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1855 /* CopyFile retains the timestamp by default. */
1856 else if (NILP (keep_time
))
1862 EMACS_GET_TIME (now
);
1863 filename
= SDATA (encoded_newname
);
1865 /* Ensure file is writable while its modified time is set. */
1866 attributes
= GetFileAttributes (filename
);
1867 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1868 if (set_file_times (filename
, now
, now
))
1870 /* Restore original attributes. */
1871 SetFileAttributes (filename
, attributes
);
1872 xsignal2 (Qfile_date_error
,
1873 build_string ("Cannot set file date"), newname
);
1875 /* Restore original attributes. */
1876 SetFileAttributes (filename
, attributes
);
1878 #else /* not WINDOWSNT */
1880 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
1884 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1886 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1888 /* We can only copy regular files and symbolic links. Other files are not
1890 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
1893 if (!NILP (preserve_selinux_context
) && is_selinux_enabled ())
1895 conlength
= fgetfilecon (ifd
, &con
);
1896 if (conlength
== -1)
1897 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
1901 if (out_st
.st_mode
!= 0
1902 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
1905 report_file_error ("Input and output files are the same",
1906 Fcons (file
, Fcons (newname
, Qnil
)));
1909 if (input_file_statable_p
)
1911 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
1913 #if defined (EISDIR)
1914 /* Get a better looking error message. */
1917 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
1922 /* System's default file type was set to binary by _fmode in emacs.c. */
1923 ofd
= emacs_open (SDATA (encoded_newname
),
1924 O_WRONLY
| O_TRUNC
| O_CREAT
1925 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
1926 S_IREAD
| S_IWRITE
);
1927 #else /* not MSDOS */
1928 ofd
= emacs_open (SSDATA (encoded_newname
),
1929 O_WRONLY
| O_TRUNC
| O_CREAT
1930 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
1932 #endif /* not MSDOS */
1934 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
1936 record_unwind_protect (close_file_unwind
, make_number (ofd
));
1940 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
1941 if (emacs_write (ofd
, buf
, n
) != n
)
1942 report_file_error ("I/O error", Fcons (newname
, Qnil
));
1946 /* Preserve the original file modes, and if requested, also its
1948 if (input_file_statable_p
)
1950 if (! NILP (preserve_uid_gid
))
1951 fchown (ofd
, st
.st_uid
, st
.st_gid
);
1952 fchmod (ofd
, st
.st_mode
& 07777);
1954 #endif /* not MSDOS */
1959 /* Set the modified context back to the file. */
1960 fail
= fsetfilecon (ofd
, con
);
1962 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
1968 /* Closing the output clobbers the file times on some systems. */
1969 if (emacs_close (ofd
) < 0)
1970 report_file_error ("I/O error", Fcons (newname
, Qnil
));
1972 if (input_file_statable_p
)
1974 if (!NILP (keep_time
))
1976 EMACS_TIME atime
, mtime
;
1977 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
1978 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
1979 if (set_file_times (SSDATA (encoded_newname
),
1981 xsignal2 (Qfile_date_error
,
1982 build_string ("Cannot set file date"), newname
);
1989 if (input_file_statable_p
)
1991 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
1992 and if it can't, it tells so. Otherwise, under MSDOS we usually
1993 get only the READ bit, which will make the copied file read-only,
1994 so it's better not to chmod at all. */
1995 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
1996 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
1999 #endif /* not WINDOWSNT */
2001 /* Discard the unwind protects. */
2002 specpdl_ptr
= specpdl
+ count
;
2008 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2009 Smake_directory_internal
, 1, 1, 0,
2010 doc
: /* Create a new directory named DIRECTORY. */)
2011 (Lisp_Object directory
)
2014 Lisp_Object handler
;
2015 Lisp_Object encoded_dir
;
2017 CHECK_STRING (directory
);
2018 directory
= Fexpand_file_name (directory
, Qnil
);
2020 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2021 if (!NILP (handler
))
2022 return call2 (handler
, Qmake_directory_internal
, directory
);
2024 encoded_dir
= ENCODE_FILE (directory
);
2026 dir
= SSDATA (encoded_dir
);
2029 if (mkdir (dir
) != 0)
2031 if (mkdir (dir
, 0777) != 0)
2033 report_file_error ("Creating directory", list1 (directory
));
2038 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2039 Sdelete_directory_internal
, 1, 1, 0,
2040 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2041 (Lisp_Object directory
)
2044 Lisp_Object handler
;
2045 Lisp_Object encoded_dir
;
2047 CHECK_STRING (directory
);
2048 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2049 encoded_dir
= ENCODE_FILE (directory
);
2050 dir
= SSDATA (encoded_dir
);
2052 if (rmdir (dir
) != 0)
2053 report_file_error ("Removing directory", list1 (directory
));
2058 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2059 "(list (read-file-name \
2060 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2061 \"Move file to trash: \" \"Delete file: \") \
2062 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2063 (null current-prefix-arg))",
2064 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2065 If file has multiple names, it continues to exist with the other names.
2066 TRASH non-nil means to trash the file instead of deleting, provided
2067 `delete-by-moving-to-trash' is non-nil.
2069 When called interactively, TRASH is t if no prefix argument is given.
2070 With a prefix argument, TRASH is nil. */)
2071 (Lisp_Object filename
, Lisp_Object trash
)
2073 Lisp_Object handler
;
2074 Lisp_Object encoded_file
;
2075 struct gcpro gcpro1
;
2078 if (!NILP (Ffile_directory_p (filename
))
2079 && NILP (Ffile_symlink_p (filename
)))
2080 xsignal2 (Qfile_error
,
2081 build_string ("Removing old name: is a directory"),
2084 filename
= Fexpand_file_name (filename
, Qnil
);
2086 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2087 if (!NILP (handler
))
2088 return call3 (handler
, Qdelete_file
, filename
, trash
);
2090 if (delete_by_moving_to_trash
&& !NILP (trash
))
2091 return call1 (Qmove_file_to_trash
, filename
);
2093 encoded_file
= ENCODE_FILE (filename
);
2095 if (0 > unlink (SSDATA (encoded_file
)))
2096 report_file_error ("Removing old name", list1 (filename
));
2101 internal_delete_file_1 (Lisp_Object ignore
)
2106 /* Delete file FILENAME, returning 1 if successful and 0 if failed.
2107 This ignores `delete-by-moving-to-trash'. */
2110 internal_delete_file (Lisp_Object filename
)
2114 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2115 Qt
, internal_delete_file_1
);
2119 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2120 "fRename file: \nGRename %s to file: \np",
2121 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2122 If file has names other than FILE, it continues to have those names.
2123 Signals a `file-already-exists' error if a file NEWNAME already exists
2124 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2125 A number as third arg means request confirmation if NEWNAME already exists.
2126 This is what happens in interactive use with M-x. */)
2127 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2129 Lisp_Object handler
;
2130 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2131 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2133 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2134 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2135 CHECK_STRING (file
);
2136 CHECK_STRING (newname
);
2137 file
= Fexpand_file_name (file
, Qnil
);
2139 if ((!NILP (Ffile_directory_p (newname
)))
2141 /* If the file names are identical but for the case,
2142 don't attempt to move directory to itself. */
2143 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2147 Lisp_Object fname
= NILP (Ffile_directory_p (file
))
2148 ? file
: Fdirectory_file_name (file
);
2149 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2152 newname
= Fexpand_file_name (newname
, Qnil
);
2154 /* If the file name has special constructs in it,
2155 call the corresponding file handler. */
2156 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2158 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2159 if (!NILP (handler
))
2160 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2161 file
, newname
, ok_if_already_exists
));
2163 encoded_file
= ENCODE_FILE (file
);
2164 encoded_newname
= ENCODE_FILE (newname
);
2167 /* If the file names are identical but for the case, don't ask for
2168 confirmation: they simply want to change the letter-case of the
2170 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2172 if (NILP (ok_if_already_exists
)
2173 || INTEGERP (ok_if_already_exists
))
2174 barf_or_query_if_file_exists (newname
, "rename to it",
2175 INTEGERP (ok_if_already_exists
), 0, 0);
2176 if (0 > rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2181 symlink_target
= Ffile_symlink_p (file
);
2182 if (! NILP (symlink_target
))
2183 Fmake_symbolic_link (symlink_target
, newname
,
2184 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2185 else if (!NILP (Ffile_directory_p (file
)))
2186 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2188 /* We have already prompted if it was an integer, so don't
2189 have copy-file prompt again. */
2190 Fcopy_file (file
, newname
,
2191 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2194 count
= SPECPDL_INDEX ();
2195 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2197 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2198 call2 (Qdelete_directory
, file
, Qt
);
2200 Fdelete_file (file
, Qnil
);
2201 unbind_to (count
, Qnil
);
2204 report_file_error ("Renaming", list2 (file
, newname
));
2210 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2211 "fAdd name to file: \nGName to add to %s: \np",
2212 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2213 Signals a `file-already-exists' error if a file NEWNAME already exists
2214 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2215 A number as third arg means request confirmation if NEWNAME already exists.
2216 This is what happens in interactive use with M-x. */)
2217 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2219 Lisp_Object handler
;
2220 Lisp_Object encoded_file
, encoded_newname
;
2221 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2223 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2224 encoded_file
= encoded_newname
= Qnil
;
2225 CHECK_STRING (file
);
2226 CHECK_STRING (newname
);
2227 file
= Fexpand_file_name (file
, Qnil
);
2229 if (!NILP (Ffile_directory_p (newname
)))
2230 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2232 newname
= Fexpand_file_name (newname
, Qnil
);
2234 /* If the file name has special constructs in it,
2235 call the corresponding file handler. */
2236 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2237 if (!NILP (handler
))
2238 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2239 newname
, ok_if_already_exists
));
2241 /* If the new name has special constructs in it,
2242 call the corresponding file handler. */
2243 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2244 if (!NILP (handler
))
2245 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2246 newname
, ok_if_already_exists
));
2248 encoded_file
= ENCODE_FILE (file
);
2249 encoded_newname
= ENCODE_FILE (newname
);
2251 if (NILP (ok_if_already_exists
)
2252 || INTEGERP (ok_if_already_exists
))
2253 barf_or_query_if_file_exists (newname
, "make it a new name",
2254 INTEGERP (ok_if_already_exists
), 0, 0);
2256 unlink (SSDATA (newname
));
2257 if (0 > link (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2258 report_file_error ("Adding new name", list2 (file
, newname
));
2264 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2265 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2266 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2267 Both args must be strings.
2268 Signals a `file-already-exists' error if a file LINKNAME already exists
2269 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2270 A number as third arg means request confirmation if LINKNAME already exists.
2271 This happens for interactive use with M-x. */)
2272 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2274 Lisp_Object handler
;
2275 Lisp_Object encoded_filename
, encoded_linkname
;
2276 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2278 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2279 encoded_filename
= encoded_linkname
= Qnil
;
2280 CHECK_STRING (filename
);
2281 CHECK_STRING (linkname
);
2282 /* If the link target has a ~, we must expand it to get
2283 a truly valid file name. Otherwise, do not expand;
2284 we want to permit links to relative file names. */
2285 if (SREF (filename
, 0) == '~')
2286 filename
= Fexpand_file_name (filename
, Qnil
);
2288 if (!NILP (Ffile_directory_p (linkname
)))
2289 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2291 linkname
= Fexpand_file_name (linkname
, Qnil
);
2293 /* If the file name has special constructs in it,
2294 call the corresponding file handler. */
2295 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2296 if (!NILP (handler
))
2297 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2298 linkname
, ok_if_already_exists
));
2300 /* If the new link name has special constructs in it,
2301 call the corresponding file handler. */
2302 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2303 if (!NILP (handler
))
2304 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2305 linkname
, ok_if_already_exists
));
2307 encoded_filename
= ENCODE_FILE (filename
);
2308 encoded_linkname
= ENCODE_FILE (linkname
);
2310 if (NILP (ok_if_already_exists
)
2311 || INTEGERP (ok_if_already_exists
))
2312 barf_or_query_if_file_exists (linkname
, "make it a link",
2313 INTEGERP (ok_if_already_exists
), 0, 0);
2314 if (0 > symlink (SSDATA (encoded_filename
),
2315 SSDATA (encoded_linkname
)))
2317 /* If we didn't complain already, silently delete existing file. */
2318 if (errno
== EEXIST
)
2320 unlink (SSDATA (encoded_linkname
));
2321 if (0 <= symlink (SSDATA (encoded_filename
),
2322 SSDATA (encoded_linkname
)))
2329 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2336 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2338 doc
: /* Return t if file FILENAME specifies an absolute file name.
2339 On Unix, this is a name starting with a `/' or a `~'. */)
2340 (Lisp_Object filename
)
2342 CHECK_STRING (filename
);
2343 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2346 /* Return nonzero if file FILENAME exists and can be executed. */
2349 check_executable (char *filename
)
2352 int len
= strlen (filename
);
2355 if (stat (filename
, &st
) < 0)
2357 return ((st
.st_mode
& S_IEXEC
) != 0);
2358 #else /* not DOS_NT */
2359 #ifdef HAVE_EUIDACCESS
2360 return (euidaccess (filename
, 1) >= 0);
2362 /* Access isn't quite right because it uses the real uid
2363 and we really want to test with the effective uid.
2364 But Unix doesn't give us a right way to do it. */
2365 return (access (filename
, 1) >= 0);
2367 #endif /* not DOS_NT */
2370 /* Return nonzero if file FILENAME exists and can be written. */
2373 check_writable (const char *filename
)
2377 if (stat (filename
, &st
) < 0)
2379 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2380 #else /* not MSDOS */
2381 #ifdef HAVE_EUIDACCESS
2382 return (euidaccess (filename
, 2) >= 0);
2384 /* Access isn't quite right because it uses the real uid
2385 and we really want to test with the effective uid.
2386 But Unix doesn't give us a right way to do it.
2387 Opening with O_WRONLY could work for an ordinary file,
2388 but would lose for directories. */
2389 return (access (filename
, 2) >= 0);
2391 #endif /* not MSDOS */
2394 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2395 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2396 See also `file-readable-p' and `file-attributes'.
2397 This returns nil for a symlink to a nonexistent file.
2398 Use `file-symlink-p' to test for such links. */)
2399 (Lisp_Object filename
)
2401 Lisp_Object absname
;
2402 Lisp_Object handler
;
2403 struct stat statbuf
;
2405 CHECK_STRING (filename
);
2406 absname
= Fexpand_file_name (filename
, Qnil
);
2408 /* If the file name has special constructs in it,
2409 call the corresponding file handler. */
2410 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2411 if (!NILP (handler
))
2412 return call2 (handler
, Qfile_exists_p
, absname
);
2414 absname
= ENCODE_FILE (absname
);
2416 return (stat (SSDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2419 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2420 doc
: /* Return t if FILENAME can be executed by you.
2421 For a directory, this means you can access files in that directory. */)
2422 (Lisp_Object filename
)
2424 Lisp_Object absname
;
2425 Lisp_Object handler
;
2427 CHECK_STRING (filename
);
2428 absname
= Fexpand_file_name (filename
, Qnil
);
2430 /* If the file name has special constructs in it,
2431 call the corresponding file handler. */
2432 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2433 if (!NILP (handler
))
2434 return call2 (handler
, Qfile_executable_p
, absname
);
2436 absname
= ENCODE_FILE (absname
);
2438 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2441 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2442 doc
: /* Return t if file FILENAME exists and you can read it.
2443 See also `file-exists-p' and `file-attributes'. */)
2444 (Lisp_Object filename
)
2446 Lisp_Object absname
;
2447 Lisp_Object handler
;
2450 struct stat statbuf
;
2452 CHECK_STRING (filename
);
2453 absname
= Fexpand_file_name (filename
, Qnil
);
2455 /* If the file name has special constructs in it,
2456 call the corresponding file handler. */
2457 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2458 if (!NILP (handler
))
2459 return call2 (handler
, Qfile_readable_p
, absname
);
2461 absname
= ENCODE_FILE (absname
);
2463 #if defined(DOS_NT) || defined(macintosh)
2464 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2466 if (access (SDATA (absname
), 0) == 0)
2469 #else /* not DOS_NT and not macintosh */
2472 /* Opening a fifo without O_NONBLOCK can wait.
2473 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2474 except in the case of a fifo, on a system which handles it. */
2475 desc
= stat (SSDATA (absname
), &statbuf
);
2478 if (S_ISFIFO (statbuf
.st_mode
))
2479 flags
|= O_NONBLOCK
;
2481 desc
= emacs_open (SSDATA (absname
), flags
, 0);
2486 #endif /* not DOS_NT and not macintosh */
2489 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2491 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2492 doc
: /* Return t if file FILENAME can be written or created by you. */)
2493 (Lisp_Object filename
)
2495 Lisp_Object absname
, dir
, encoded
;
2496 Lisp_Object handler
;
2497 struct stat statbuf
;
2499 CHECK_STRING (filename
);
2500 absname
= Fexpand_file_name (filename
, Qnil
);
2502 /* If the file name has special constructs in it,
2503 call the corresponding file handler. */
2504 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2505 if (!NILP (handler
))
2506 return call2 (handler
, Qfile_writable_p
, absname
);
2508 encoded
= ENCODE_FILE (absname
);
2509 if (stat (SSDATA (encoded
), &statbuf
) >= 0)
2510 return (check_writable (SSDATA (encoded
))
2513 dir
= Ffile_name_directory (absname
);
2516 dir
= Fdirectory_file_name (dir
);
2519 dir
= ENCODE_FILE (dir
);
2521 /* The read-only attribute of the parent directory doesn't affect
2522 whether a file or directory can be created within it. Some day we
2523 should check ACLs though, which do affect this. */
2524 if (stat (SDATA (dir
), &statbuf
) < 0)
2526 return S_ISDIR (statbuf
.st_mode
) ? Qt
: Qnil
;
2528 return (check_writable (!NILP (dir
) ? SSDATA (dir
) : "")
2533 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2534 doc
: /* Access file FILENAME, and get an error if that does not work.
2535 The second argument STRING is used in the error message.
2536 If there is no error, returns nil. */)
2537 (Lisp_Object filename
, Lisp_Object string
)
2539 Lisp_Object handler
, encoded_filename
, absname
;
2542 CHECK_STRING (filename
);
2543 absname
= Fexpand_file_name (filename
, Qnil
);
2545 CHECK_STRING (string
);
2547 /* If the file name has special constructs in it,
2548 call the corresponding file handler. */
2549 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2550 if (!NILP (handler
))
2551 return call3 (handler
, Qaccess_file
, absname
, string
);
2553 encoded_filename
= ENCODE_FILE (absname
);
2555 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2557 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2563 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2564 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2565 The value is the link target, as a string.
2566 Otherwise it returns nil.
2568 This function returns t when given the name of a symlink that
2569 points to a nonexistent file. */)
2570 (Lisp_Object filename
)
2572 Lisp_Object handler
;
2578 CHECK_STRING (filename
);
2579 filename
= Fexpand_file_name (filename
, Qnil
);
2581 /* If the file name has special constructs in it,
2582 call the corresponding file handler. */
2583 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2584 if (!NILP (handler
))
2585 return call2 (handler
, Qfile_symlink_p
, filename
);
2587 filename
= ENCODE_FILE (filename
);
2594 buf
= (char *) xrealloc (buf
, bufsize
);
2595 memset (buf
, 0, bufsize
);
2598 valsize
= readlink (SSDATA (filename
), buf
, bufsize
);
2602 /* HP-UX reports ERANGE if buffer is too small. */
2603 if (errno
== ERANGE
)
2613 while (valsize
>= bufsize
);
2615 val
= make_string (buf
, valsize
);
2616 if (buf
[0] == '/' && strchr (buf
, ':'))
2617 val
= concat2 (build_string ("/:"), val
);
2619 val
= DECODE_FILE (val
);
2623 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2624 doc
: /* Return t if FILENAME names an existing directory.
2625 Symbolic links to directories count as directories.
2626 See `file-symlink-p' to distinguish symlinks. */)
2627 (Lisp_Object filename
)
2629 register Lisp_Object absname
;
2631 Lisp_Object handler
;
2633 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2635 /* If the file name has special constructs in it,
2636 call the corresponding file handler. */
2637 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2638 if (!NILP (handler
))
2639 return call2 (handler
, Qfile_directory_p
, absname
);
2641 absname
= ENCODE_FILE (absname
);
2643 if (stat (SSDATA (absname
), &st
) < 0)
2645 return S_ISDIR (st
.st_mode
) ? Qt
: Qnil
;
2648 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
2649 doc
: /* Return t if file FILENAME names a directory you can open.
2650 For the value to be t, FILENAME must specify the name of a directory as a file,
2651 and the directory must allow you to open files in it. In order to use a
2652 directory as a buffer's current directory, this predicate must return true.
2653 A directory name spec may be given instead; then the value is t
2654 if the directory so specified exists and really is a readable and
2655 searchable directory. */)
2656 (Lisp_Object filename
)
2658 Lisp_Object handler
;
2660 struct gcpro gcpro1
;
2662 /* If the file name has special constructs in it,
2663 call the corresponding file handler. */
2664 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2665 if (!NILP (handler
))
2666 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2669 tem
= (NILP (Ffile_directory_p (filename
))
2670 || NILP (Ffile_executable_p (filename
)));
2672 return tem
? Qnil
: Qt
;
2675 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2676 doc
: /* Return t if FILENAME names a regular file.
2677 This is the sort of file that holds an ordinary stream of data bytes.
2678 Symbolic links to regular files count as regular files.
2679 See `file-symlink-p' to distinguish symlinks. */)
2680 (Lisp_Object filename
)
2682 register Lisp_Object absname
;
2684 Lisp_Object handler
;
2686 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2688 /* If the file name has special constructs in it,
2689 call the corresponding file handler. */
2690 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2691 if (!NILP (handler
))
2692 return call2 (handler
, Qfile_regular_p
, absname
);
2694 absname
= ENCODE_FILE (absname
);
2699 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2701 /* Tell stat to use expensive method to get accurate info. */
2702 Vw32_get_true_file_attributes
= Qt
;
2703 result
= stat (SDATA (absname
), &st
);
2704 Vw32_get_true_file_attributes
= tem
;
2708 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2711 if (stat (SSDATA (absname
), &st
) < 0)
2713 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2717 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2718 Sfile_selinux_context
, 1, 1, 0,
2719 doc
: /* Return SELinux context of file named FILENAME,
2720 as a list ("user", "role", "type", "range"). Return (nil, nil, nil, nil)
2721 if file does not exist, is not accessible, or SELinux is disabled */)
2722 (Lisp_Object filename
)
2724 Lisp_Object absname
;
2725 Lisp_Object values
[4];
2726 Lisp_Object handler
;
2728 security_context_t con
;
2733 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2735 /* If the file name has special constructs in it,
2736 call the corresponding file handler. */
2737 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2738 if (!NILP (handler
))
2739 return call2 (handler
, Qfile_selinux_context
, absname
);
2741 absname
= ENCODE_FILE (absname
);
2748 if (is_selinux_enabled ())
2750 conlength
= lgetfilecon (SDATA (absname
), &con
);
2753 context
= context_new (con
);
2754 if (context_user_get (context
))
2755 values
[0] = build_string (context_user_get (context
));
2756 if (context_role_get (context
))
2757 values
[1] = build_string (context_role_get (context
));
2758 if (context_type_get (context
))
2759 values
[2] = build_string (context_type_get (context
));
2760 if (context_range_get (context
))
2761 values
[3] = build_string (context_range_get (context
));
2762 context_free (context
);
2769 return Flist (sizeof(values
) / sizeof(values
[0]), values
);
2772 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2773 Sset_file_selinux_context
, 2, 2, 0,
2774 doc
: /* Set SELinux context of file named FILENAME to CONTEXT
2775 as a list ("user", "role", "type", "range"). Has no effect if SELinux
2777 (Lisp_Object filename
, Lisp_Object context
)
2779 Lisp_Object absname
, encoded_absname
;
2780 Lisp_Object handler
;
2781 Lisp_Object user
= CAR_SAFE (context
);
2782 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2783 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2784 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2786 security_context_t con
;
2787 int fail
, conlength
;
2788 context_t parsed_con
;
2791 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2793 /* If the file name has special constructs in it,
2794 call the corresponding file handler. */
2795 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2796 if (!NILP (handler
))
2797 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2799 encoded_absname
= ENCODE_FILE (absname
);
2802 if (is_selinux_enabled ())
2804 /* Get current file context. */
2805 conlength
= lgetfilecon (SDATA (encoded_absname
), &con
);
2808 parsed_con
= context_new (con
);
2809 /* Change the parts defined in the parameter.*/
2812 if (context_user_set (parsed_con
, SDATA (user
)))
2813 error ("Doing context_user_set");
2817 if (context_role_set (parsed_con
, SDATA (role
)))
2818 error ("Doing context_role_set");
2822 if (context_type_set (parsed_con
, SDATA (type
)))
2823 error ("Doing context_type_set");
2825 if (STRINGP (range
))
2827 if (context_range_set (parsed_con
, SDATA (range
)))
2828 error ("Doing context_range_set");
2831 /* Set the modified context back to the file. */
2832 fail
= lsetfilecon (SDATA (encoded_absname
), context_str (parsed_con
));
2834 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
2836 context_free (parsed_con
);
2839 report_file_error("Doing lgetfilecon", Fcons (absname
, Qnil
));
2849 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2850 doc
: /* Return mode bits of file named FILENAME, as an integer.
2851 Return nil, if file does not exist or is not accessible. */)
2852 (Lisp_Object filename
)
2854 Lisp_Object absname
;
2856 Lisp_Object handler
;
2858 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2860 /* If the file name has special constructs in it,
2861 call the corresponding file handler. */
2862 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2863 if (!NILP (handler
))
2864 return call2 (handler
, Qfile_modes
, absname
);
2866 absname
= ENCODE_FILE (absname
);
2868 if (stat (SSDATA (absname
), &st
) < 0)
2871 return make_number (st
.st_mode
& 07777);
2874 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2875 "(let ((file (read-file-name \"File: \"))) \
2876 (list file (read-file-modes nil file)))",
2877 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2878 Only the 12 low bits of MODE are used.
2880 Interactively, mode bits are read by `read-file-modes', which accepts
2881 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2882 (Lisp_Object filename
, Lisp_Object mode
)
2884 Lisp_Object absname
, encoded_absname
;
2885 Lisp_Object handler
;
2887 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2888 CHECK_NUMBER (mode
);
2890 /* If the file name has special constructs in it,
2891 call the corresponding file handler. */
2892 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2893 if (!NILP (handler
))
2894 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2896 encoded_absname
= ENCODE_FILE (absname
);
2898 if (chmod (SSDATA (encoded_absname
), XINT (mode
)) < 0)
2899 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2904 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2905 doc
: /* Set the file permission bits for newly created files.
2906 The argument MODE should be an integer; only the low 9 bits are used.
2907 This setting is inherited by subprocesses. */)
2910 CHECK_NUMBER (mode
);
2912 umask ((~ XINT (mode
)) & 0777);
2917 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
2918 doc
: /* Return the default file protection for created files.
2919 The value is an integer. */)
2925 realmask
= umask (0);
2928 XSETINT (value
, (~ realmask
) & 0777);
2933 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
2934 doc
: /* Set times of file FILENAME to TIME.
2935 Set both access and modification times.
2936 Return t on success, else nil.
2937 Use the current time if TIME is nil. TIME is in the format of
2939 (Lisp_Object filename
, Lisp_Object time
)
2941 Lisp_Object absname
, encoded_absname
;
2942 Lisp_Object handler
;
2946 if (! lisp_time_argument (time
, &sec
, &usec
))
2947 error ("Invalid time specification");
2949 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2951 /* If the file name has special constructs in it,
2952 call the corresponding file handler. */
2953 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
2954 if (!NILP (handler
))
2955 return call3 (handler
, Qset_file_times
, absname
, time
);
2957 encoded_absname
= ENCODE_FILE (absname
);
2962 EMACS_SET_SECS (t
, sec
);
2963 EMACS_SET_USECS (t
, usec
);
2965 if (set_file_times (SSDATA (encoded_absname
), t
, t
))
2970 /* Setting times on a directory always fails. */
2971 if (stat (SSDATA (encoded_absname
), &st
) == 0 && S_ISDIR (st
.st_mode
))
2974 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
2983 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
2984 doc
: /* Tell Unix to finish all pending disk updates. */)
2991 #endif /* HAVE_SYNC */
2993 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
2994 doc
: /* Return t if file FILE1 is newer than file FILE2.
2995 If FILE1 does not exist, the answer is nil;
2996 otherwise, if FILE2 does not exist, the answer is t. */)
2997 (Lisp_Object file1
, Lisp_Object file2
)
2999 Lisp_Object absname1
, absname2
;
3002 Lisp_Object handler
;
3003 struct gcpro gcpro1
, gcpro2
;
3005 CHECK_STRING (file1
);
3006 CHECK_STRING (file2
);
3009 GCPRO2 (absname1
, file2
);
3010 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3011 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3014 /* If the file name has special constructs in it,
3015 call the corresponding file handler. */
3016 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3018 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3019 if (!NILP (handler
))
3020 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3022 GCPRO2 (absname1
, absname2
);
3023 absname1
= ENCODE_FILE (absname1
);
3024 absname2
= ENCODE_FILE (absname2
);
3027 if (stat (SSDATA (absname1
), &st
) < 0)
3030 mtime1
= st
.st_mtime
;
3032 if (stat (SSDATA (absname2
), &st
) < 0)
3035 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3038 #ifndef READ_BUF_SIZE
3039 #define READ_BUF_SIZE (64 << 10)
3042 /* This function is called after Lisp functions to decide a coding
3043 system are called, or when they cause an error. Before they are
3044 called, the current buffer is set unibyte and it contains only a
3045 newly inserted text (thus the buffer was empty before the
3048 The functions may set markers, overlays, text properties, or even
3049 alter the buffer contents, change the current buffer.
3051 Here, we reset all those changes by:
3052 o set back the current buffer.
3053 o move all markers and overlays to BEG.
3054 o remove all text properties.
3055 o set back the buffer multibyteness. */
3058 decide_coding_unwind (Lisp_Object unwind_data
)
3060 Lisp_Object multibyte
, undo_list
, buffer
;
3062 multibyte
= XCAR (unwind_data
);
3063 unwind_data
= XCDR (unwind_data
);
3064 undo_list
= XCAR (unwind_data
);
3065 buffer
= XCDR (unwind_data
);
3067 if (current_buffer
!= XBUFFER (buffer
))
3068 set_buffer_internal (XBUFFER (buffer
));
3069 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3070 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3071 BUF_INTERVALS (current_buffer
) = 0;
3072 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3074 /* Now we are safe to change the buffer's multibyteness directly. */
3075 BVAR (current_buffer
, enable_multibyte_characters
) = multibyte
;
3076 BVAR (current_buffer
, undo_list
) = undo_list
;
3082 /* Used to pass values from insert-file-contents to read_non_regular. */
3084 static int non_regular_fd
;
3085 static EMACS_INT non_regular_inserted
;
3086 static EMACS_INT non_regular_nbytes
;
3089 /* Read from a non-regular file.
3090 Read non_regular_nbytes bytes max from non_regular_fd.
3091 Non_regular_inserted specifies where to put the read bytes.
3092 Value is the number of bytes read. */
3095 read_non_regular (Lisp_Object ignore
)
3101 nbytes
= emacs_read (non_regular_fd
,
3102 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3103 + non_regular_inserted
),
3104 non_regular_nbytes
);
3106 return make_number (nbytes
);
3110 /* Condition-case handler used when reading from non-regular files
3111 in insert-file-contents. */
3114 read_non_regular_quit (Lisp_Object ignore
)
3120 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3122 doc
: /* Insert contents of file FILENAME after point.
3123 Returns list of absolute file name and number of characters inserted.
3124 If second argument VISIT is non-nil, the buffer's visited filename and
3125 last save file modtime are set, and it is marked unmodified. If
3126 visiting and the file does not exist, visiting is completed before the
3129 The optional third and fourth arguments BEG and END specify what portion
3130 of the file to insert. These arguments count bytes in the file, not
3131 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3133 If optional fifth argument REPLACE is non-nil, replace the current
3134 buffer contents (in the accessible portion) with the file contents.
3135 This is better than simply deleting and inserting the whole thing
3136 because (1) it preserves some marker positions and (2) it puts less data
3137 in the undo list. When REPLACE is non-nil, the second return value is
3138 the number of characters that replace previous buffer contents.
3140 This function does code conversion according to the value of
3141 `coding-system-for-read' or `file-coding-system-alist', and sets the
3142 variable `last-coding-system-used' to the coding system actually used. */)
3143 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3147 EMACS_INT inserted
= 0;
3149 register EMACS_INT how_much
;
3150 register EMACS_INT unprocessed
;
3151 int count
= SPECPDL_INDEX ();
3152 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3153 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3155 EMACS_INT total
= 0;
3156 int not_regular
= 0;
3157 char read_buf
[READ_BUF_SIZE
];
3158 struct coding_system coding
;
3159 char buffer
[1 << 14];
3160 int replace_handled
= 0;
3161 int set_coding_system
= 0;
3162 Lisp_Object coding_system
;
3164 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3165 int we_locked_file
= 0;
3166 int deferred_remove_unwind_protect
= 0;
3168 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3169 error ("Cannot do file visiting in an indirect buffer");
3171 if (!NILP (BVAR (current_buffer
, read_only
)))
3172 Fbarf_if_buffer_read_only ();
3176 orig_filename
= Qnil
;
3179 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3181 CHECK_STRING (filename
);
3182 filename
= Fexpand_file_name (filename
, Qnil
);
3184 /* The value Qnil means that the coding system is not yet
3186 coding_system
= Qnil
;
3188 /* If the file name has special constructs in it,
3189 call the corresponding file handler. */
3190 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3191 if (!NILP (handler
))
3193 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3194 visit
, beg
, end
, replace
);
3195 if (CONSP (val
) && CONSP (XCDR (val
)))
3196 inserted
= XINT (XCAR (XCDR (val
)));
3200 orig_filename
= filename
;
3201 filename
= ENCODE_FILE (filename
);
3207 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3209 /* Tell stat to use expensive method to get accurate info. */
3210 Vw32_get_true_file_attributes
= Qt
;
3211 total
= stat (SSDATA (filename
), &st
);
3212 Vw32_get_true_file_attributes
= tem
;
3216 if (stat (SSDATA (filename
), &st
) < 0)
3217 #endif /* WINDOWSNT */
3219 if (fd
>= 0) emacs_close (fd
);
3222 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3225 if (!NILP (Vcoding_system_for_read
))
3226 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3230 /* This code will need to be changed in order to work on named
3231 pipes, and it's probably just not worth it. So we should at
3232 least signal an error. */
3233 if (!S_ISREG (st
.st_mode
))
3240 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3241 xsignal2 (Qfile_error
,
3242 build_string ("not a regular file"), orig_filename
);
3246 if ((fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0)) < 0)
3249 /* Replacement should preserve point as it preserves markers. */
3250 if (!NILP (replace
))
3251 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3253 record_unwind_protect (close_file_unwind
, make_number (fd
));
3255 /* Can happen on any platform that uses long as type of off_t, but allows
3256 file sizes to exceed 2Gb, so give a suitable message. */
3257 if (! not_regular
&& st
.st_size
< 0)
3258 error ("Maximum buffer size exceeded");
3260 /* Prevent redisplay optimizations. */
3261 current_buffer
->clip_changed
= 1;
3265 if (!NILP (beg
) || !NILP (end
))
3266 error ("Attempt to visit less than an entire file");
3267 if (BEG
< Z
&& NILP (replace
))
3268 error ("Cannot do file visiting in a non-empty buffer");
3274 XSETFASTINT (beg
, 0);
3282 XSETINT (end
, st
.st_size
);
3284 /* Arithmetic overflow can occur if an Emacs integer cannot
3285 represent the file size, or if the calculations below
3286 overflow. The calculations below double the file size
3287 twice, so check that it can be multiplied by 4 safely. */
3288 if (XINT (end
) != st
.st_size
3289 /* Actually, it should test either INT_MAX or LONG_MAX
3290 depending on which one is used for EMACS_INT. But in
3291 any case, in practice, this test is redundant with the
3293 || st.st_size > INT_MAX / 4 */)
3294 error ("Maximum buffer size exceeded");
3296 /* The file size returned from stat may be zero, but data
3297 may be readable nonetheless, for example when this is a
3298 file in the /proc filesystem. */
3299 if (st
.st_size
== 0)
3300 XSETINT (end
, READ_BUF_SIZE
);
3304 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3306 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3307 setup_coding_system (coding_system
, &coding
);
3308 /* Ensure we set Vlast_coding_system_used. */
3309 set_coding_system
= 1;
3313 /* Decide the coding system to use for reading the file now
3314 because we can't use an optimized method for handling
3315 `coding:' tag if the current buffer is not empty. */
3316 if (!NILP (Vcoding_system_for_read
))
3317 coding_system
= Vcoding_system_for_read
;
3320 /* Don't try looking inside a file for a coding system
3321 specification if it is not seekable. */
3322 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3324 /* Find a coding system specified in the heading two
3325 lines or in the tailing several lines of the file.
3326 We assume that the 1K-byte and 3K-byte for heading
3327 and tailing respectively are sufficient for this
3331 if (st
.st_size
<= (1024 * 4))
3332 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3335 nread
= emacs_read (fd
, read_buf
, 1024);
3338 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3339 report_file_error ("Setting file position",
3340 Fcons (orig_filename
, Qnil
));
3341 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3346 error ("IO error reading %s: %s",
3347 SDATA (orig_filename
), emacs_strerror (errno
));
3350 struct buffer
*prev
= current_buffer
;
3354 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3356 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3357 buf
= XBUFFER (buffer
);
3359 delete_all_overlays (buf
);
3360 BVAR (buf
, directory
) = BVAR (current_buffer
, directory
);
3361 BVAR (buf
, read_only
) = Qnil
;
3362 BVAR (buf
, filename
) = Qnil
;
3363 BVAR (buf
, undo_list
) = Qt
;
3364 eassert (buf
->overlays_before
== NULL
);
3365 eassert (buf
->overlays_after
== NULL
);
3367 set_buffer_internal (buf
);
3369 BVAR (buf
, enable_multibyte_characters
) = Qnil
;
3371 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3372 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3373 coding_system
= call2 (Vset_auto_coding_function
,
3374 filename
, make_number (nread
));
3375 set_buffer_internal (prev
);
3377 /* Discard the unwind protect for recovering the
3381 /* Rewind the file for the actual read done later. */
3382 if (lseek (fd
, 0, 0) < 0)
3383 report_file_error ("Setting file position",
3384 Fcons (orig_filename
, Qnil
));
3388 if (NILP (coding_system
))
3390 /* If we have not yet decided a coding system, check
3391 file-coding-system-alist. */
3392 Lisp_Object args
[6];
3394 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3395 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3396 coding_system
= Ffind_operation_coding_system (6, args
);
3397 if (CONSP (coding_system
))
3398 coding_system
= XCAR (coding_system
);
3402 if (NILP (coding_system
))
3403 coding_system
= Qundecided
;
3405 CHECK_CODING_SYSTEM (coding_system
);
3407 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3408 /* We must suppress all character code conversion except for
3409 end-of-line conversion. */
3410 coding_system
= raw_text_coding_system (coding_system
);
3412 setup_coding_system (coding_system
, &coding
);
3413 /* Ensure we set Vlast_coding_system_used. */
3414 set_coding_system
= 1;
3417 /* If requested, replace the accessible part of the buffer
3418 with the file contents. Avoid replacing text at the
3419 beginning or end of the buffer that matches the file contents;
3420 that preserves markers pointing to the unchanged parts.
3422 Here we implement this feature in an optimized way
3423 for the case where code conversion is NOT needed.
3424 The following if-statement handles the case of conversion
3425 in a less optimal way.
3427 If the code conversion is "automatic" then we try using this
3428 method and hope for the best.
3429 But if we discover the need for conversion, we give up on this method
3430 and let the following if-statement handle the replace job. */
3433 && (NILP (coding_system
)
3434 || ! CODING_REQUIRE_DECODING (&coding
)))
3436 /* same_at_start and same_at_end count bytes,
3437 because file access counts bytes
3438 and BEG and END count bytes. */
3439 EMACS_INT same_at_start
= BEGV_BYTE
;
3440 EMACS_INT same_at_end
= ZV_BYTE
;
3442 /* There is still a possibility we will find the need to do code
3443 conversion. If that happens, we set this variable to 1 to
3444 give up on handling REPLACE in the optimized way. */
3445 int giveup_match_end
= 0;
3447 if (XINT (beg
) != 0)
3449 if (lseek (fd
, XINT (beg
), 0) < 0)
3450 report_file_error ("Setting file position",
3451 Fcons (orig_filename
, Qnil
));
3456 /* Count how many chars at the start of the file
3457 match the text at the beginning of the buffer. */
3460 EMACS_INT nread
, bufpos
;
3462 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3464 error ("IO error reading %s: %s",
3465 SSDATA (orig_filename
), emacs_strerror (errno
));
3466 else if (nread
== 0)
3469 if (CODING_REQUIRE_DETECTION (&coding
))
3471 coding_system
= detect_coding_system ((unsigned char *) buffer
,
3474 setup_coding_system (coding_system
, &coding
);
3477 if (CODING_REQUIRE_DECODING (&coding
))
3478 /* We found that the file should be decoded somehow.
3479 Let's give up here. */
3481 giveup_match_end
= 1;
3486 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3487 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3488 same_at_start
++, bufpos
++;
3489 /* If we found a discrepancy, stop the scan.
3490 Otherwise loop around and scan the next bufferful. */
3491 if (bufpos
!= nread
)
3495 /* If the file matches the buffer completely,
3496 there's no need to replace anything. */
3497 if (same_at_start
- BEGV_BYTE
== XINT (end
))
3501 /* Truncate the buffer to the size of the file. */
3502 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3507 /* Count how many chars at the end of the file
3508 match the text at the end of the buffer. But, if we have
3509 already found that decoding is necessary, don't waste time. */
3510 while (!giveup_match_end
)
3512 EMACS_INT total_read
, nread
, bufpos
, curpos
, trial
;
3514 /* At what file position are we now scanning? */
3515 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
3516 /* If the entire file matches the buffer tail, stop the scan. */
3519 /* How much can we scan in the next step? */
3520 trial
= min (curpos
, sizeof buffer
);
3521 if (lseek (fd
, curpos
- trial
, 0) < 0)
3522 report_file_error ("Setting file position",
3523 Fcons (orig_filename
, Qnil
));
3525 total_read
= nread
= 0;
3526 while (total_read
< trial
)
3528 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3530 error ("IO error reading %s: %s",
3531 SDATA (orig_filename
), emacs_strerror (errno
));
3532 else if (nread
== 0)
3534 total_read
+= nread
;
3537 /* Scan this bufferful from the end, comparing with
3538 the Emacs buffer. */
3539 bufpos
= total_read
;
3541 /* Compare with same_at_start to avoid counting some buffer text
3542 as matching both at the file's beginning and at the end. */
3543 while (bufpos
> 0 && same_at_end
> same_at_start
3544 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3545 same_at_end
--, bufpos
--;
3547 /* If we found a discrepancy, stop the scan.
3548 Otherwise loop around and scan the preceding bufferful. */
3551 /* If this discrepancy is because of code conversion,
3552 we cannot use this method; giveup and try the other. */
3553 if (same_at_end
> same_at_start
3554 && FETCH_BYTE (same_at_end
- 1) >= 0200
3555 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3556 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3557 giveup_match_end
= 1;
3566 if (! giveup_match_end
)
3570 /* We win! We can handle REPLACE the optimized way. */
3572 /* Extend the start of non-matching text area to multibyte
3573 character boundary. */
3574 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3575 while (same_at_start
> BEGV_BYTE
3576 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3579 /* Extend the end of non-matching text area to multibyte
3580 character boundary. */
3581 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3582 while (same_at_end
< ZV_BYTE
3583 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3586 /* Don't try to reuse the same piece of text twice. */
3587 overlap
= (same_at_start
- BEGV_BYTE
3588 - (same_at_end
+ st
.st_size
- ZV
));
3590 same_at_end
+= overlap
;
3592 /* Arrange to read only the nonmatching middle part of the file. */
3593 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
3594 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
3596 del_range_byte (same_at_start
, same_at_end
, 0);
3597 /* Insert from the file at the proper position. */
3598 temp
= BYTE_TO_CHAR (same_at_start
);
3599 SET_PT_BOTH (temp
, same_at_start
);
3601 /* If display currently starts at beginning of line,
3602 keep it that way. */
3603 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3604 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3606 replace_handled
= 1;
3610 /* If requested, replace the accessible part of the buffer
3611 with the file contents. Avoid replacing text at the
3612 beginning or end of the buffer that matches the file contents;
3613 that preserves markers pointing to the unchanged parts.
3615 Here we implement this feature for the case where code conversion
3616 is needed, in a simple way that needs a lot of memory.
3617 The preceding if-statement handles the case of no conversion
3618 in a more optimized way. */
3619 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3621 EMACS_INT same_at_start
= BEGV_BYTE
;
3622 EMACS_INT same_at_end
= ZV_BYTE
;
3623 EMACS_INT same_at_start_charpos
;
3624 EMACS_INT inserted_chars
;
3627 unsigned char *decoded
;
3629 int this_count
= SPECPDL_INDEX ();
3630 int multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3631 Lisp_Object conversion_buffer
;
3633 conversion_buffer
= code_conversion_save (1, multibyte
);
3635 /* First read the whole file, performing code conversion into
3636 CONVERSION_BUFFER. */
3638 if (lseek (fd
, XINT (beg
), 0) < 0)
3639 report_file_error ("Setting file position",
3640 Fcons (orig_filename
, Qnil
));
3642 total
= st
.st_size
; /* Total bytes in the file. */
3643 how_much
= 0; /* Bytes read from file so far. */
3644 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3645 unprocessed
= 0; /* Bytes not processed in previous loop. */
3647 GCPRO1 (conversion_buffer
);
3648 while (how_much
< total
)
3650 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3651 quitting while reading a huge while. */
3652 /* try is reserved in some compilers (Microsoft C) */
3653 EMACS_INT trytry
= min (total
- how_much
,
3654 READ_BUF_SIZE
- unprocessed
);
3657 /* Allow quitting out of the actual I/O. */
3660 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3672 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3673 BUF_Z (XBUFFER (conversion_buffer
)));
3674 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3675 unprocessed
+ this, conversion_buffer
);
3676 unprocessed
= coding
.carryover_bytes
;
3677 if (coding
.carryover_bytes
> 0)
3678 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3683 /* We should remove the unwind_protect calling
3684 close_file_unwind, but other stuff has been added the stack,
3685 so defer the removal till we reach the `handled' label. */
3686 deferred_remove_unwind_protect
= 1;
3688 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3689 if we couldn't read the file. */
3692 error ("IO error reading %s: %s",
3693 SDATA (orig_filename
), emacs_strerror (errno
));
3695 if (unprocessed
> 0)
3697 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3698 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3699 unprocessed
, conversion_buffer
);
3700 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3703 coding_system
= CODING_ID_NAME (coding
.id
);
3704 set_coding_system
= 1;
3705 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3706 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3707 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3709 /* Compare the beginning of the converted string with the buffer
3713 while (bufpos
< inserted
&& same_at_start
< same_at_end
3714 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3715 same_at_start
++, bufpos
++;
3717 /* If the file matches the head of buffer completely,
3718 there's no need to replace anything. */
3720 if (bufpos
== inserted
)
3722 /* Truncate the buffer to the size of the file. */
3723 if (same_at_start
== same_at_end
)
3726 del_range_byte (same_at_start
, same_at_end
, 0);
3729 unbind_to (this_count
, Qnil
);
3733 /* Extend the start of non-matching text area to the previous
3734 multibyte character boundary. */
3735 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3736 while (same_at_start
> BEGV_BYTE
3737 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3740 /* Scan this bufferful from the end, comparing with
3741 the Emacs buffer. */
3744 /* Compare with same_at_start to avoid counting some buffer text
3745 as matching both at the file's beginning and at the end. */
3746 while (bufpos
> 0 && same_at_end
> same_at_start
3747 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3748 same_at_end
--, bufpos
--;
3750 /* Extend the end of non-matching text area to the next
3751 multibyte character boundary. */
3752 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3753 while (same_at_end
< ZV_BYTE
3754 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3757 /* Don't try to reuse the same piece of text twice. */
3758 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3760 same_at_end
+= overlap
;
3762 /* If display currently starts at beginning of line,
3763 keep it that way. */
3764 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3765 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3767 /* Replace the chars that we need to replace,
3768 and update INSERTED to equal the number of bytes
3769 we are taking from the decoded string. */
3770 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3772 if (same_at_end
!= same_at_start
)
3774 del_range_byte (same_at_start
, same_at_end
, 0);
3776 same_at_start
= GPT_BYTE
;
3780 temp
= BYTE_TO_CHAR (same_at_start
);
3782 /* Insert from the file at the proper position. */
3783 SET_PT_BOTH (temp
, same_at_start
);
3784 same_at_start_charpos
3785 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3786 same_at_start
- BEGV_BYTE
3787 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3789 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3790 same_at_start
+ inserted
- BEGV_BYTE
3791 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3792 - same_at_start_charpos
);
3793 /* This binding is to avoid ask-user-about-supersession-threat
3794 being called in insert_from_buffer (via in
3795 prepare_to_modify_buffer). */
3796 specbind (intern ("buffer-file-name"), Qnil
);
3797 insert_from_buffer (XBUFFER (conversion_buffer
),
3798 same_at_start_charpos
, inserted_chars
, 0);
3799 /* Set `inserted' to the number of inserted characters. */
3800 inserted
= PT
- temp
;
3801 /* Set point before the inserted characters. */
3802 SET_PT_BOTH (temp
, same_at_start
);
3804 unbind_to (this_count
, Qnil
);
3811 register Lisp_Object temp
;
3813 total
= XINT (end
) - XINT (beg
);
3815 /* Make sure point-max won't overflow after this insertion. */
3816 XSETINT (temp
, total
);
3817 if (total
!= XINT (temp
))
3818 error ("Maximum buffer size exceeded");
3821 /* For a special file, all we can do is guess. */
3822 total
= READ_BUF_SIZE
;
3824 if (NILP (visit
) && inserted
> 0)
3826 #ifdef CLASH_DETECTION
3827 if (!NILP (BVAR (current_buffer
, file_truename
))
3828 /* Make binding buffer-file-name to nil effective. */
3829 && !NILP (BVAR (current_buffer
, filename
))
3830 && SAVE_MODIFF
>= MODIFF
)
3832 #endif /* CLASH_DETECTION */
3833 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3837 if (GAP_SIZE
< total
)
3838 make_gap (total
- GAP_SIZE
);
3840 if (XINT (beg
) != 0 || !NILP (replace
))
3842 if (lseek (fd
, XINT (beg
), 0) < 0)
3843 report_file_error ("Setting file position",
3844 Fcons (orig_filename
, Qnil
));
3847 /* In the following loop, HOW_MUCH contains the total bytes read so
3848 far for a regular file, and not changed for a special file. But,
3849 before exiting the loop, it is set to a negative value if I/O
3853 /* Total bytes inserted. */
3856 /* Here, we don't do code conversion in the loop. It is done by
3857 decode_coding_gap after all data are read into the buffer. */
3859 EMACS_INT gap_size
= GAP_SIZE
;
3861 while (how_much
< total
)
3863 /* try is reserved in some compilers (Microsoft C) */
3864 EMACS_INT trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3871 /* Maybe make more room. */
3872 if (gap_size
< trytry
)
3874 make_gap (total
- gap_size
);
3875 gap_size
= GAP_SIZE
;
3878 /* Read from the file, capturing `quit'. When an
3879 error occurs, end the loop, and arrange for a quit
3880 to be signaled after decoding the text we read. */
3881 non_regular_fd
= fd
;
3882 non_regular_inserted
= inserted
;
3883 non_regular_nbytes
= trytry
;
3884 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
3885 read_non_regular_quit
);
3896 /* Allow quitting out of the actual I/O. We don't make text
3897 part of the buffer until all the reading is done, so a C-g
3898 here doesn't do any harm. */
3901 this = emacs_read (fd
,
3902 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3916 /* For a regular file, where TOTAL is the real size,
3917 count HOW_MUCH to compare with it.
3918 For a special file, where TOTAL is just a buffer size,
3919 so don't bother counting in HOW_MUCH.
3920 (INSERTED is where we count the number of characters inserted.) */
3927 /* Now we have read all the file data into the gap.
3928 If it was empty, undo marking the buffer modified. */
3932 #ifdef CLASH_DETECTION
3934 unlock_file (BVAR (current_buffer
, file_truename
));
3936 Vdeactivate_mark
= old_Vdeactivate_mark
;
3939 Vdeactivate_mark
= Qt
;
3941 /* Make the text read part of the buffer. */
3942 GAP_SIZE
-= inserted
;
3944 GPT_BYTE
+= inserted
;
3946 ZV_BYTE
+= inserted
;
3951 /* Put an anchor to ensure multi-byte form ends at gap. */
3956 /* Discard the unwind protect for closing the file. */
3960 error ("IO error reading %s: %s",
3961 SDATA (orig_filename
), emacs_strerror (errno
));
3965 if (NILP (coding_system
))
3967 /* The coding system is not yet decided. Decide it by an
3968 optimized method for handling `coding:' tag.
3970 Note that we can get here only if the buffer was empty
3971 before the insertion. */
3973 if (!NILP (Vcoding_system_for_read
))
3974 coding_system
= Vcoding_system_for_read
;
3977 /* Since we are sure that the current buffer was empty
3978 before the insertion, we can toggle
3979 enable-multibyte-characters directly here without taking
3980 care of marker adjustment. By this way, we can run Lisp
3981 program safely before decoding the inserted text. */
3982 Lisp_Object unwind_data
;
3983 int count
= SPECPDL_INDEX ();
3985 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
3986 Fcons (BVAR (current_buffer
, undo_list
),
3987 Fcurrent_buffer ()));
3988 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
3989 BVAR (current_buffer
, undo_list
) = Qt
;
3990 record_unwind_protect (decide_coding_unwind
, unwind_data
);
3992 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
3994 coding_system
= call2 (Vset_auto_coding_function
,
3995 filename
, make_number (inserted
));
3998 if (NILP (coding_system
))
4000 /* If the coding system is not yet decided, check
4001 file-coding-system-alist. */
4002 Lisp_Object args
[6];
4004 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4005 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4006 coding_system
= Ffind_operation_coding_system (6, args
);
4007 if (CONSP (coding_system
))
4008 coding_system
= XCAR (coding_system
);
4010 unbind_to (count
, Qnil
);
4011 inserted
= Z_BYTE
- BEG_BYTE
;
4014 if (NILP (coding_system
))
4015 coding_system
= Qundecided
;
4017 CHECK_CODING_SYSTEM (coding_system
);
4019 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4020 /* We must suppress all character code conversion except for
4021 end-of-line conversion. */
4022 coding_system
= raw_text_coding_system (coding_system
);
4023 setup_coding_system (coding_system
, &coding
);
4024 /* Ensure we set Vlast_coding_system_used. */
4025 set_coding_system
= 1;
4030 /* When we visit a file by raw-text, we change the buffer to
4032 if (CODING_FOR_UNIBYTE (&coding
)
4033 /* Can't do this if part of the buffer might be preserved. */
4035 /* Visiting a file with these coding system makes the buffer
4037 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
4040 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4041 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4042 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4044 move_gap_both (PT
, PT_BYTE
);
4045 GAP_SIZE
+= inserted
;
4046 ZV_BYTE
-= inserted
;
4050 decode_coding_gap (&coding
, inserted
, inserted
);
4051 inserted
= coding
.produced_char
;
4052 coding_system
= CODING_ID_NAME (coding
.id
);
4054 else if (inserted
> 0)
4055 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4058 /* Now INSERTED is measured in characters. */
4062 if (deferred_remove_unwind_protect
)
4063 /* If requested above, discard the unwind protect for closing the
4069 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4070 BVAR (current_buffer
, undo_list
) = Qnil
;
4074 current_buffer
->modtime
= st
.st_mtime
;
4075 current_buffer
->modtime_size
= st
.st_size
;
4076 BVAR (current_buffer
, filename
) = orig_filename
;
4079 SAVE_MODIFF
= MODIFF
;
4080 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4081 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4082 #ifdef CLASH_DETECTION
4085 if (!NILP (BVAR (current_buffer
, file_truename
)))
4086 unlock_file (BVAR (current_buffer
, file_truename
));
4087 unlock_file (filename
);
4089 #endif /* CLASH_DETECTION */
4091 xsignal2 (Qfile_error
,
4092 build_string ("not a regular file"), orig_filename
);
4095 if (set_coding_system
)
4096 Vlast_coding_system_used
= coding_system
;
4098 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4100 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4102 if (! NILP (insval
))
4104 CHECK_NUMBER (insval
);
4105 inserted
= XFASTINT (insval
);
4109 /* Decode file format. */
4112 /* Don't run point motion or modification hooks when decoding. */
4113 int count
= SPECPDL_INDEX ();
4114 EMACS_INT old_inserted
= inserted
;
4115 specbind (Qinhibit_point_motion_hooks
, Qt
);
4116 specbind (Qinhibit_modification_hooks
, Qt
);
4118 /* Save old undo list and don't record undo for decoding. */
4119 old_undo
= BVAR (current_buffer
, undo_list
);
4120 BVAR (current_buffer
, undo_list
) = Qt
;
4124 insval
= call3 (Qformat_decode
,
4125 Qnil
, make_number (inserted
), visit
);
4126 CHECK_NUMBER (insval
);
4127 inserted
= XFASTINT (insval
);
4131 /* If REPLACE is non-nil and we succeeded in not replacing the
4132 beginning or end of the buffer text with the file's contents,
4133 call format-decode with `point' positioned at the beginning
4134 of the buffer and `inserted' equalling the number of
4135 characters in the buffer. Otherwise, format-decode might
4136 fail to correctly analyze the beginning or end of the buffer.
4137 Hence we temporarily save `point' and `inserted' here and
4138 restore `point' iff format-decode did not insert or delete
4139 any text. Otherwise we leave `point' at point-min. */
4140 EMACS_INT opoint
= PT
;
4141 EMACS_INT opoint_byte
= PT_BYTE
;
4142 EMACS_INT oinserted
= ZV
- BEGV
;
4143 int ochars_modiff
= CHARS_MODIFF
;
4145 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4146 insval
= call3 (Qformat_decode
,
4147 Qnil
, make_number (oinserted
), visit
);
4148 CHECK_NUMBER (insval
);
4149 if (ochars_modiff
== CHARS_MODIFF
)
4150 /* format_decode didn't modify buffer's characters => move
4151 point back to position before inserted text and leave
4152 value of inserted alone. */
4153 SET_PT_BOTH (opoint
, opoint_byte
);
4155 /* format_decode modified buffer's characters => consider
4156 entire buffer changed and leave point at point-min. */
4157 inserted
= XFASTINT (insval
);
4160 /* For consistency with format-decode call these now iff inserted > 0
4161 (martin 2007-06-28). */
4162 p
= Vafter_insert_file_functions
;
4167 insval
= call1 (XCAR (p
), make_number (inserted
));
4170 CHECK_NUMBER (insval
);
4171 inserted
= XFASTINT (insval
);
4176 /* For the rationale of this see the comment on
4177 format-decode above. */
4178 EMACS_INT opoint
= PT
;
4179 EMACS_INT opoint_byte
= PT_BYTE
;
4180 EMACS_INT oinserted
= ZV
- BEGV
;
4181 int ochars_modiff
= CHARS_MODIFF
;
4183 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4184 insval
= call1 (XCAR (p
), make_number (oinserted
));
4187 CHECK_NUMBER (insval
);
4188 if (ochars_modiff
== CHARS_MODIFF
)
4189 /* after_insert_file_functions didn't modify
4190 buffer's characters => move point back to
4191 position before inserted text and leave value of
4193 SET_PT_BOTH (opoint
, opoint_byte
);
4195 /* after_insert_file_functions did modify buffer's
4196 characters => consider entire buffer changed and
4197 leave point at point-min. */
4198 inserted
= XFASTINT (insval
);
4208 BVAR (current_buffer
, undo_list
) = old_undo
;
4209 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4211 /* Adjust the last undo record for the size change during
4212 the format conversion. */
4213 Lisp_Object tem
= XCAR (old_undo
);
4214 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4215 && INTEGERP (XCDR (tem
))
4216 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4217 XSETCDR (tem
, make_number (PT
+ inserted
));
4221 /* If undo_list was Qt before, keep it that way.
4222 Otherwise start with an empty undo_list. */
4223 BVAR (current_buffer
, undo_list
) = EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4225 unbind_to (count
, Qnil
);
4228 /* Call after-change hooks for the inserted text, aside from the case
4229 of normal visiting (not with REPLACE), which is done in a new buffer
4230 "before" the buffer is changed. */
4231 if (inserted
> 0 && total
> 0
4232 && (NILP (visit
) || !NILP (replace
)))
4234 signal_after_change (PT
, 0, inserted
);
4235 update_compositions (PT
, PT
, CHECK_BORDER
);
4239 && current_buffer
->modtime
== -1)
4241 /* If visiting nonexistent file, return nil. */
4242 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4246 Fsignal (Qquit
, Qnil
);
4248 /* ??? Retval needs to be dealt with in all cases consistently. */
4250 val
= Fcons (orig_filename
,
4251 Fcons (make_number (inserted
),
4254 RETURN_UNGCPRO (unbind_to (count
, val
));
4257 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4260 build_annotations_unwind (Lisp_Object arg
)
4262 Vwrite_region_annotation_buffers
= arg
;
4266 /* Decide the coding-system to encode the data with. */
4269 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4270 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4271 struct coding_system
*coding
)
4274 Lisp_Object eol_parent
= Qnil
;
4277 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4278 BVAR (current_buffer
, auto_save_file_name
))))
4283 else if (!NILP (Vcoding_system_for_write
))
4285 val
= Vcoding_system_for_write
;
4286 if (coding_system_require_warning
4287 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4288 /* Confirm that VAL can surely encode the current region. */
4289 val
= call5 (Vselect_safe_coding_system_function
,
4290 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4295 /* If the variable `buffer-file-coding-system' is set locally,
4296 it means that the file was read with some kind of code
4297 conversion or the variable is explicitly set by users. We
4298 had better write it out with the same coding system even if
4299 `enable-multibyte-characters' is nil.
4301 If it is not set locally, we anyway have to convert EOL
4302 format if the default value of `buffer-file-coding-system'
4303 tells that it is not Unix-like (LF only) format. */
4304 int using_default_coding
= 0;
4305 int force_raw_text
= 0;
4307 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4309 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4312 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4318 /* Check file-coding-system-alist. */
4319 Lisp_Object args
[7], coding_systems
;
4321 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4322 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4324 coding_systems
= Ffind_operation_coding_system (7, args
);
4325 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4326 val
= XCDR (coding_systems
);
4331 /* If we still have not decided a coding system, use the
4332 default value of buffer-file-coding-system. */
4333 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4334 using_default_coding
= 1;
4337 if (! NILP (val
) && ! force_raw_text
)
4339 Lisp_Object spec
, attrs
;
4341 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4342 attrs
= AREF (spec
, 0);
4343 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4348 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4349 /* Confirm that VAL can surely encode the current region. */
4350 val
= call5 (Vselect_safe_coding_system_function
,
4351 start
, end
, val
, Qnil
, filename
);
4353 /* If the decided coding-system doesn't specify end-of-line
4354 format, we use that of
4355 `default-buffer-file-coding-system'. */
4356 if (! using_default_coding
4357 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4358 val
= (coding_inherit_eol_type
4359 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4361 /* If we decide not to encode text, use `raw-text' or one of its
4364 val
= raw_text_coding_system (val
);
4367 val
= coding_inherit_eol_type (val
, eol_parent
);
4368 setup_coding_system (val
, coding
);
4370 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4371 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4375 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4376 "r\nFWrite region to file: \ni\ni\ni\np",
4377 doc
: /* Write current region into specified file.
4378 When called from a program, requires three arguments:
4379 START, END and FILENAME. START and END are normally buffer positions
4380 specifying the part of the buffer to write.
4381 If START is nil, that means to use the entire buffer contents.
4382 If START is a string, then output that string to the file
4383 instead of any buffer contents; END is ignored.
4385 Optional fourth argument APPEND if non-nil means
4386 append to existing file contents (if any). If it is an integer,
4387 seek to that offset in the file before writing.
4388 Optional fifth argument VISIT, if t or a string, means
4389 set the last-save-file-modtime of buffer to this file's modtime
4390 and mark buffer not modified.
4391 If VISIT is a string, it is a second file name;
4392 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4393 VISIT is also the file name to lock and unlock for clash detection.
4394 If VISIT is neither t nor nil nor a string,
4395 that means do not display the \"Wrote file\" message.
4396 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4397 use for locking and unlocking, overriding FILENAME and VISIT.
4398 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4399 for an existing file with the same name. If MUSTBENEW is `excl',
4400 that means to get an error if the file already exists; never overwrite.
4401 If MUSTBENEW is neither nil nor `excl', that means ask for
4402 confirmation before overwriting, but do go ahead and overwrite the file
4403 if the user confirms.
4405 This does code conversion according to the value of
4406 `coding-system-for-write', `buffer-file-coding-system', or
4407 `file-coding-system-alist', and sets the variable
4408 `last-coding-system-used' to the coding system actually used.
4410 This calls `write-region-annotate-functions' at the start, and
4411 `write-region-post-annotation-function' at the end. */)
4412 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4419 int count
= SPECPDL_INDEX ();
4421 Lisp_Object handler
;
4422 Lisp_Object visit_file
;
4423 Lisp_Object annotations
;
4424 Lisp_Object encoded_filename
;
4425 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4426 int quietly
= !NILP (visit
);
4427 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4428 struct buffer
*given_buffer
;
4429 struct coding_system coding
;
4431 if (current_buffer
->base_buffer
&& visiting
)
4432 error ("Cannot do file visiting in an indirect buffer");
4434 if (!NILP (start
) && !STRINGP (start
))
4435 validate_region (&start
, &end
);
4438 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4440 filename
= Fexpand_file_name (filename
, Qnil
);
4442 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4443 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4445 if (STRINGP (visit
))
4446 visit_file
= Fexpand_file_name (visit
, Qnil
);
4448 visit_file
= filename
;
4450 if (NILP (lockname
))
4451 lockname
= visit_file
;
4455 /* If the file name has special constructs in it,
4456 call the corresponding file handler. */
4457 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4458 /* If FILENAME has no handler, see if VISIT has one. */
4459 if (NILP (handler
) && STRINGP (visit
))
4460 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4462 if (!NILP (handler
))
4465 val
= call6 (handler
, Qwrite_region
, start
, end
,
4466 filename
, append
, visit
);
4470 SAVE_MODIFF
= MODIFF
;
4471 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4472 BVAR (current_buffer
, filename
) = visit_file
;
4478 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4480 /* Special kludge to simplify auto-saving. */
4483 /* Do it later, so write-region-annotate-function can work differently
4484 if we save "the buffer" vs "a region".
4485 This is useful in tar-mode. --Stef
4486 XSETFASTINT (start, BEG);
4487 XSETFASTINT (end, Z); */
4491 record_unwind_protect (build_annotations_unwind
,
4492 Vwrite_region_annotation_buffers
);
4493 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4494 count1
= SPECPDL_INDEX ();
4496 given_buffer
= current_buffer
;
4498 if (!STRINGP (start
))
4500 annotations
= build_annotations (start
, end
);
4502 if (current_buffer
!= given_buffer
)
4504 XSETFASTINT (start
, BEGV
);
4505 XSETFASTINT (end
, ZV
);
4511 XSETFASTINT (start
, BEGV
);
4512 XSETFASTINT (end
, ZV
);
4517 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4519 /* Decide the coding-system to encode the data with.
4520 We used to make this choice before calling build_annotations, but that
4521 leads to problems when a write-annotate-function takes care of
4522 unsavable chars (as was the case with X-Symbol). */
4523 Vlast_coding_system_used
4524 = choose_write_coding_system (start
, end
, filename
,
4525 append
, visit
, lockname
, &coding
);
4527 #ifdef CLASH_DETECTION
4529 lock_file (lockname
);
4530 #endif /* CLASH_DETECTION */
4532 encoded_filename
= ENCODE_FILE (filename
);
4534 fn
= SSDATA (encoded_filename
);
4538 desc
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4539 #else /* not DOS_NT */
4540 desc
= emacs_open (fn
, O_WRONLY
, 0);
4541 #endif /* not DOS_NT */
4543 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4545 desc
= emacs_open (fn
,
4546 O_WRONLY
| O_CREAT
| O_BINARY
4547 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4548 S_IREAD
| S_IWRITE
);
4549 #else /* not DOS_NT */
4550 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4551 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4552 auto_saving
? auto_save_mode_bits
: 0666);
4553 #endif /* not DOS_NT */
4557 #ifdef CLASH_DETECTION
4559 if (!auto_saving
) unlock_file (lockname
);
4561 #endif /* CLASH_DETECTION */
4563 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4566 record_unwind_protect (close_file_unwind
, make_number (desc
));
4568 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4572 if (NUMBERP (append
))
4573 ret
= lseek (desc
, XINT (append
), 1);
4575 ret
= lseek (desc
, 0, 2);
4578 #ifdef CLASH_DETECTION
4579 if (!auto_saving
) unlock_file (lockname
);
4580 #endif /* CLASH_DETECTION */
4582 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4591 if (STRINGP (start
))
4593 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4594 &annotations
, &coding
);
4597 else if (XINT (start
) != XINT (end
))
4599 failure
= 0 > a_write (desc
, Qnil
,
4600 XINT (start
), XINT (end
) - XINT (start
),
4601 &annotations
, &coding
);
4606 /* If file was empty, still need to write the annotations */
4607 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4608 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4612 if (CODING_REQUIRE_FLUSHING (&coding
)
4613 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4616 /* We have to flush out a data. */
4617 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4618 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4625 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4626 Disk full in NFS may be reported here. */
4627 /* mib says that closing the file will try to write as fast as NFS can do
4628 it, and that means the fsync here is not crucial for autosave files. */
4629 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4631 /* If fsync fails with EINTR, don't treat that as serious. Also
4632 ignore EINVAL which happens when fsync is not supported on this
4634 if (errno
!= EINTR
&& errno
!= EINVAL
)
4635 failure
= 1, save_errno
= errno
;
4639 /* NFS can report a write failure now. */
4640 if (emacs_close (desc
) < 0)
4641 failure
= 1, save_errno
= errno
;
4645 /* Discard the unwind protect for close_file_unwind. */
4646 specpdl_ptr
= specpdl
+ count1
;
4648 /* Call write-region-post-annotation-function. */
4649 while (CONSP (Vwrite_region_annotation_buffers
))
4651 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4652 if (!NILP (Fbuffer_live_p (buf
)))
4655 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4656 call0 (Vwrite_region_post_annotation_function
);
4658 Vwrite_region_annotation_buffers
4659 = XCDR (Vwrite_region_annotation_buffers
);
4662 unbind_to (count
, Qnil
);
4664 #ifdef CLASH_DETECTION
4666 unlock_file (lockname
);
4667 #endif /* CLASH_DETECTION */
4669 /* Do this before reporting IO error
4670 to avoid a "file has changed on disk" warning on
4671 next attempt to save. */
4674 current_buffer
->modtime
= st
.st_mtime
;
4675 current_buffer
->modtime_size
= st
.st_size
;
4679 error ("IO error writing %s: %s", SDATA (filename
),
4680 emacs_strerror (save_errno
));
4684 SAVE_MODIFF
= MODIFF
;
4685 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4686 BVAR (current_buffer
, filename
) = visit_file
;
4687 update_mode_lines
++;
4692 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4693 BVAR (current_buffer
, auto_save_file_name
))))
4694 SAVE_MODIFF
= MODIFF
;
4700 message_with_string ((INTEGERP (append
)
4710 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4712 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4713 doc
: /* Return t if (car A) is numerically less than (car B). */)
4714 (Lisp_Object a
, Lisp_Object b
)
4716 return Flss (Fcar (a
), Fcar (b
));
4719 /* Build the complete list of annotations appropriate for writing out
4720 the text between START and END, by calling all the functions in
4721 write-region-annotate-functions and merging the lists they return.
4722 If one of these functions switches to a different buffer, we assume
4723 that buffer contains altered text. Therefore, the caller must
4724 make sure to restore the current buffer in all cases,
4725 as save-excursion would do. */
4728 build_annotations (Lisp_Object start
, Lisp_Object end
)
4730 Lisp_Object annotations
;
4732 struct gcpro gcpro1
, gcpro2
;
4733 Lisp_Object original_buffer
;
4734 int i
, used_global
= 0;
4736 XSETBUFFER (original_buffer
, current_buffer
);
4739 p
= Vwrite_region_annotate_functions
;
4740 GCPRO2 (annotations
, p
);
4743 struct buffer
*given_buffer
= current_buffer
;
4744 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4745 { /* Use the global value of the hook. */
4748 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4750 p
= Fappend (2, arg
);
4753 Vwrite_region_annotations_so_far
= annotations
;
4754 res
= call2 (XCAR (p
), start
, end
);
4755 /* If the function makes a different buffer current,
4756 assume that means this buffer contains altered text to be output.
4757 Reset START and END from the buffer bounds
4758 and discard all previous annotations because they should have
4759 been dealt with by this function. */
4760 if (current_buffer
!= given_buffer
)
4762 Vwrite_region_annotation_buffers
4763 = Fcons (Fcurrent_buffer (),
4764 Vwrite_region_annotation_buffers
);
4765 XSETFASTINT (start
, BEGV
);
4766 XSETFASTINT (end
, ZV
);
4769 Flength (res
); /* Check basic validity of return value */
4770 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4774 /* Now do the same for annotation functions implied by the file-format */
4775 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
4776 p
= BVAR (current_buffer
, auto_save_file_format
);
4778 p
= BVAR (current_buffer
, file_format
);
4779 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4781 struct buffer
*given_buffer
= current_buffer
;
4783 Vwrite_region_annotations_so_far
= annotations
;
4785 /* Value is either a list of annotations or nil if the function
4786 has written annotations to a temporary buffer, which is now
4788 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4789 original_buffer
, make_number (i
));
4790 if (current_buffer
!= given_buffer
)
4792 XSETFASTINT (start
, BEGV
);
4793 XSETFASTINT (end
, ZV
);
4798 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4806 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4807 If STRING is nil, POS is the character position in the current buffer.
4808 Intersperse with them the annotations from *ANNOT
4809 which fall within the range of POS to POS + NCHARS,
4810 each at its appropriate position.
4812 We modify *ANNOT by discarding elements as we use them up.
4814 The return value is negative in case of system call failure. */
4817 a_write (int desc
, Lisp_Object string
, int pos
, register int nchars
, Lisp_Object
*annot
, struct coding_system
*coding
)
4821 int lastpos
= pos
+ nchars
;
4823 while (NILP (*annot
) || CONSP (*annot
))
4825 tem
= Fcar_safe (Fcar (*annot
));
4828 nextpos
= XFASTINT (tem
);
4830 /* If there are no more annotations in this range,
4831 output the rest of the range all at once. */
4832 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4833 return e_write (desc
, string
, pos
, lastpos
, coding
);
4835 /* Output buffer text up to the next annotation's position. */
4838 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4842 /* Output the annotation. */
4843 tem
= Fcdr (Fcar (*annot
));
4846 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4849 *annot
= Fcdr (*annot
);
4855 /* Write text in the range START and END into descriptor DESC,
4856 encoding them with coding system CODING. If STRING is nil, START
4857 and END are character positions of the current buffer, else they
4858 are indexes to the string STRING. */
4861 e_write (int desc
, Lisp_Object string
, int start
, int end
, struct coding_system
*coding
)
4863 if (STRINGP (string
))
4866 end
= SCHARS (string
);
4869 /* We used to have a code for handling selective display here. But,
4870 now it is handled within encode_coding. */
4874 if (STRINGP (string
))
4876 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
4877 if (CODING_REQUIRE_ENCODING (coding
))
4879 encode_coding_object (coding
, string
,
4880 start
, string_char_to_byte (string
, start
),
4881 end
, string_char_to_byte (string
, end
), Qt
);
4885 coding
->dst_object
= string
;
4886 coding
->consumed_char
= SCHARS (string
);
4887 coding
->produced
= SBYTES (string
);
4892 int start_byte
= CHAR_TO_BYTE (start
);
4893 int end_byte
= CHAR_TO_BYTE (end
);
4895 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
4896 if (CODING_REQUIRE_ENCODING (coding
))
4898 encode_coding_object (coding
, Fcurrent_buffer (),
4899 start
, start_byte
, end
, end_byte
, Qt
);
4903 coding
->dst_object
= Qnil
;
4904 coding
->dst_pos_byte
= start_byte
;
4905 if (start
>= GPT
|| end
<= GPT
)
4907 coding
->consumed_char
= end
- start
;
4908 coding
->produced
= end_byte
- start_byte
;
4912 coding
->consumed_char
= GPT
- start
;
4913 coding
->produced
= GPT_BYTE
- start_byte
;
4918 if (coding
->produced
> 0)
4922 STRINGP (coding
->dst_object
)
4923 ? SSDATA (coding
->dst_object
)
4924 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
4927 if (coding
->produced
)
4930 start
+= coding
->consumed_char
;
4936 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
4937 Sverify_visited_file_modtime
, 0, 1, 0,
4938 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
4939 This means that the file has not been changed since it was visited or saved.
4940 If BUF is omitted or nil, it defaults to the current buffer.
4941 See Info node `(elisp)Modification Time' for more details. */)
4946 Lisp_Object handler
;
4947 Lisp_Object filename
;
4957 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
4958 if (b
->modtime
== 0) return Qt
;
4960 /* If the file name has special constructs in it,
4961 call the corresponding file handler. */
4962 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
4963 Qverify_visited_file_modtime
);
4964 if (!NILP (handler
))
4965 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
4967 filename
= ENCODE_FILE (BVAR (b
, filename
));
4969 if (stat (SSDATA (filename
), &st
) < 0)
4971 /* If the file doesn't exist now and didn't exist before,
4972 we say that it isn't modified, provided the error is a tame one. */
4973 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
4978 if ((st
.st_mtime
== b
->modtime
4979 /* If both are positive, accept them if they are off by one second. */
4980 || (st
.st_mtime
> 0 && b
->modtime
> 0
4981 && (st
.st_mtime
== b
->modtime
+ 1
4982 || st
.st_mtime
== b
->modtime
- 1)))
4983 && (st
.st_size
== b
->modtime_size
4984 || b
->modtime_size
< 0))
4989 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
4990 Sclear_visited_file_modtime
, 0, 0, 0,
4991 doc
: /* Clear out records of last mod time of visited file.
4992 Next attempt to save will certainly not complain of a discrepancy. */)
4995 current_buffer
->modtime
= 0;
4996 current_buffer
->modtime_size
= -1;
5000 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5001 Svisited_file_modtime
, 0, 0, 0,
5002 doc
: /* Return the current buffer's recorded visited file modification time.
5003 The value is a list of the form (HIGH LOW), like the time values
5004 that `file-attributes' returns. If the current buffer has no recorded
5005 file modification time, this function returns 0.
5006 See Info node `(elisp)Modification Time' for more details. */)
5009 if (! current_buffer
->modtime
)
5010 return make_number (0);
5011 return make_time ((time_t) current_buffer
->modtime
);
5014 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5015 Sset_visited_file_modtime
, 0, 1, 0,
5016 doc
: /* Update buffer's recorded modification time from the visited file's time.
5017 Useful if the buffer was not read from the file normally
5018 or if the file itself has been changed for some known benign reason.
5019 An argument specifies the modification time value to use
5020 \(instead of that of the visited file), in the form of a list
5021 \(HIGH . LOW) or (HIGH LOW). */)
5022 (Lisp_Object time_list
)
5024 if (!NILP (time_list
))
5026 current_buffer
->modtime
= cons_to_long (time_list
);
5027 current_buffer
->modtime_size
= -1;
5031 register Lisp_Object filename
;
5033 Lisp_Object handler
;
5035 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5037 /* If the file name has special constructs in it,
5038 call the corresponding file handler. */
5039 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5040 if (!NILP (handler
))
5041 /* The handler can find the file name the same way we did. */
5042 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5044 filename
= ENCODE_FILE (filename
);
5046 if (stat (SSDATA (filename
), &st
) >= 0)
5048 current_buffer
->modtime
= st
.st_mtime
;
5049 current_buffer
->modtime_size
= st
.st_size
;
5057 auto_save_error (Lisp_Object error
)
5059 Lisp_Object args
[3], msg
;
5061 struct gcpro gcpro1
;
5065 auto_save_error_occurred
= 1;
5067 ring_bell (XFRAME (selected_frame
));
5069 args
[0] = build_string ("Auto-saving %s: %s");
5070 args
[1] = BVAR (current_buffer
, name
);
5071 args
[2] = Ferror_message_string (error
);
5072 msg
= Fformat (3, args
);
5074 nbytes
= SBYTES (msg
);
5075 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5076 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5078 for (i
= 0; i
< 3; ++i
)
5081 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5083 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5084 Fsleep_for (make_number (1), Qnil
);
5098 auto_save_mode_bits
= 0666;
5100 /* Get visited file's mode to become the auto save file's mode. */
5101 if (! NILP (BVAR (current_buffer
, filename
)))
5103 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5104 /* But make sure we can overwrite it later! */
5105 auto_save_mode_bits
= st
.st_mode
| 0600;
5106 else if ((modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5108 /* Remote files don't cooperate with stat. */
5109 auto_save_mode_bits
= XINT (modes
) | 0600;
5113 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5114 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5119 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5122 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5134 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5137 minibuffer_auto_raise
= XINT (value
);
5142 do_auto_save_make_dir (Lisp_Object dir
)
5146 call2 (Qmake_directory
, dir
, Qt
);
5147 XSETFASTINT (mode
, 0700);
5148 return Fset_file_modes (dir
, mode
);
5152 do_auto_save_eh (Lisp_Object ignore
)
5157 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5158 doc
: /* Auto-save all buffers that need it.
5159 This is all buffers that have auto-saving enabled
5160 and are changed since last auto-saved.
5161 Auto-saving writes the buffer into a file
5162 so that your editing is not lost if the system crashes.
5163 This file is not the file you visited; that changes only when you save.
5164 Normally we run the normal hook `auto-save-hook' before saving.
5166 A non-nil NO-MESSAGE argument means do not print any message if successful.
5167 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5168 (Lisp_Object no_message
, Lisp_Object current_only
)
5170 struct buffer
*old
= current_buffer
, *b
;
5171 Lisp_Object tail
, buf
;
5173 int do_handled_files
;
5175 FILE *stream
= NULL
;
5176 int count
= SPECPDL_INDEX ();
5177 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5178 int old_message_p
= 0;
5179 struct gcpro gcpro1
, gcpro2
;
5181 if (max_specpdl_size
< specpdl_size
+ 40)
5182 max_specpdl_size
= specpdl_size
+ 40;
5187 if (NILP (no_message
))
5189 old_message_p
= push_message ();
5190 record_unwind_protect (pop_message_unwind
, Qnil
);
5193 /* Ordinarily don't quit within this function,
5194 but don't make it impossible to quit (in case we get hung in I/O). */
5198 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5199 point to non-strings reached from Vbuffer_alist. */
5201 if (!NILP (Vrun_hooks
))
5202 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5204 if (STRINGP (Vauto_save_list_file_name
))
5206 Lisp_Object listfile
;
5208 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5210 /* Don't try to create the directory when shutting down Emacs,
5211 because creating the directory might signal an error, and
5212 that would leave Emacs in a strange state. */
5213 if (!NILP (Vrun_hooks
))
5217 GCPRO2 (dir
, listfile
);
5218 dir
= Ffile_name_directory (listfile
);
5219 if (NILP (Ffile_directory_p (dir
)))
5220 internal_condition_case_1 (do_auto_save_make_dir
,
5221 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5226 stream
= fopen (SSDATA (listfile
), "w");
5229 record_unwind_protect (do_auto_save_unwind
,
5230 make_save_value (stream
, 0));
5231 record_unwind_protect (do_auto_save_unwind_1
,
5232 make_number (minibuffer_auto_raise
));
5233 minibuffer_auto_raise
= 0;
5235 auto_save_error_occurred
= 0;
5237 /* On first pass, save all files that don't have handlers.
5238 On second pass, save all files that do have handlers.
5240 If Emacs is crashing, the handlers may tweak what is causing
5241 Emacs to crash in the first place, and it would be a shame if
5242 Emacs failed to autosave perfectly ordinary files because it
5243 couldn't handle some ange-ftp'd file. */
5245 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5246 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5248 buf
= XCDR (XCAR (tail
));
5251 /* Record all the buffers that have auto save mode
5252 in the special file that lists them. For each of these buffers,
5253 Record visited name (if any) and auto save name. */
5254 if (STRINGP (BVAR (b
, auto_save_file_name
))
5255 && stream
!= NULL
&& do_handled_files
== 0)
5258 if (!NILP (BVAR (b
, filename
)))
5260 fwrite (SDATA (BVAR (b
, filename
)), 1,
5261 SBYTES (BVAR (b
, filename
)), stream
);
5263 putc ('\n', stream
);
5264 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5265 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5266 putc ('\n', stream
);
5270 if (!NILP (current_only
)
5271 && b
!= current_buffer
)
5274 /* Don't auto-save indirect buffers.
5275 The base buffer takes care of it. */
5279 /* Check for auto save enabled
5280 and file changed since last auto save
5281 and file changed since last real save. */
5282 if (STRINGP (BVAR (b
, auto_save_file_name
))
5283 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5284 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5285 /* -1 means we've turned off autosaving for a while--see below. */
5286 && XINT (BVAR (b
, save_length
)) >= 0
5287 && (do_handled_files
5288 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5291 EMACS_TIME before_time
, after_time
;
5293 EMACS_GET_TIME (before_time
);
5295 /* If we had a failure, don't try again for 20 minutes. */
5296 if (b
->auto_save_failure_time
>= 0
5297 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5300 set_buffer_internal (b
);
5301 if (NILP (Vauto_save_include_big_deletions
)
5302 && (XFASTINT (BVAR (b
, save_length
)) * 10
5303 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5304 /* A short file is likely to change a large fraction;
5305 spare the user annoying messages. */
5306 && XFASTINT (BVAR (b
, save_length
)) > 5000
5307 /* These messages are frequent and annoying for `*mail*'. */
5308 && !EQ (BVAR (b
, filename
), Qnil
)
5309 && NILP (no_message
))
5311 /* It has shrunk too much; turn off auto-saving here. */
5312 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5313 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5315 minibuffer_auto_raise
= 0;
5316 /* Turn off auto-saving until there's a real save,
5317 and prevent any more warnings. */
5318 XSETINT (BVAR (b
, save_length
), -1);
5319 Fsleep_for (make_number (1), Qnil
);
5322 if (!auto_saved
&& NILP (no_message
))
5323 message1 ("Auto-saving...");
5324 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5326 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5327 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5328 set_buffer_internal (old
);
5330 EMACS_GET_TIME (after_time
);
5332 /* If auto-save took more than 60 seconds,
5333 assume it was an NFS failure that got a timeout. */
5334 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5335 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5339 /* Prevent another auto save till enough input events come in. */
5340 record_auto_save ();
5342 if (auto_saved
&& NILP (no_message
))
5346 /* If we are going to restore an old message,
5347 give time to read ours. */
5348 sit_for (make_number (1), 0, 0);
5351 else if (!auto_save_error_occurred
)
5352 /* Don't overwrite the error message if an error occurred.
5353 If we displayed a message and then restored a state
5354 with no message, leave a "done" message on the screen. */
5355 message1 ("Auto-saving...done");
5360 /* This restores the message-stack status. */
5361 unbind_to (count
, Qnil
);
5365 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5366 Sset_buffer_auto_saved
, 0, 0, 0,
5367 doc
: /* Mark current buffer as auto-saved with its current text.
5368 No auto-save file will be written until the buffer changes again. */)
5371 /* FIXME: This should not be called in indirect buffers, since
5372 they're not autosaved. */
5373 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5374 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5375 current_buffer
->auto_save_failure_time
= -1;
5379 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5380 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5381 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5384 current_buffer
->auto_save_failure_time
= -1;
5388 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5390 doc
: /* Return t if current buffer has been auto-saved recently.
5391 More precisely, if it has been auto-saved since last read from or saved
5392 in the visited file. If the buffer has no visited file,
5393 then any auto-save counts as "recent". */)
5396 /* FIXME: maybe we should return nil for indirect buffers since
5397 they're never autosaved. */
5398 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5401 /* Reading and completing file names */
5403 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5404 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5405 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5406 The return value is only relevant for a call to `read-file-name' that happens
5407 before any other event (mouse or keypress) is handled. */)
5410 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5411 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5421 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5423 struct gcpro gcpro1
, gcpro2
;
5424 Lisp_Object args
[7];
5426 GCPRO1 (default_filename
);
5427 args
[0] = intern ("read-file-name");
5430 args
[3] = default_filename
;
5431 args
[4] = mustmatch
;
5433 args
[6] = predicate
;
5434 RETURN_UNGCPRO (Ffuncall (7, args
));
5439 syms_of_fileio (void)
5441 Qoperations
= intern_c_string ("operations");
5442 Qexpand_file_name
= intern_c_string ("expand-file-name");
5443 Qsubstitute_in_file_name
= intern_c_string ("substitute-in-file-name");
5444 Qdirectory_file_name
= intern_c_string ("directory-file-name");
5445 Qfile_name_directory
= intern_c_string ("file-name-directory");
5446 Qfile_name_nondirectory
= intern_c_string ("file-name-nondirectory");
5447 Qunhandled_file_name_directory
= intern_c_string ("unhandled-file-name-directory");
5448 Qfile_name_as_directory
= intern_c_string ("file-name-as-directory");
5449 Qcopy_file
= intern_c_string ("copy-file");
5450 Qmake_directory_internal
= intern_c_string ("make-directory-internal");
5451 Qmake_directory
= intern_c_string ("make-directory");
5452 Qdelete_directory_internal
= intern_c_string ("delete-directory-internal");
5453 Qdelete_file
= intern_c_string ("delete-file");
5454 Qrename_file
= intern_c_string ("rename-file");
5455 Qadd_name_to_file
= intern_c_string ("add-name-to-file");
5456 Qmake_symbolic_link
= intern_c_string ("make-symbolic-link");
5457 Qfile_exists_p
= intern_c_string ("file-exists-p");
5458 Qfile_executable_p
= intern_c_string ("file-executable-p");
5459 Qfile_readable_p
= intern_c_string ("file-readable-p");
5460 Qfile_writable_p
= intern_c_string ("file-writable-p");
5461 Qfile_symlink_p
= intern_c_string ("file-symlink-p");
5462 Qaccess_file
= intern_c_string ("access-file");
5463 Qfile_directory_p
= intern_c_string ("file-directory-p");
5464 Qfile_regular_p
= intern_c_string ("file-regular-p");
5465 Qfile_accessible_directory_p
= intern_c_string ("file-accessible-directory-p");
5466 Qfile_modes
= intern_c_string ("file-modes");
5467 Qset_file_modes
= intern_c_string ("set-file-modes");
5468 Qset_file_times
= intern_c_string ("set-file-times");
5469 Qfile_selinux_context
= intern_c_string("file-selinux-context");
5470 Qset_file_selinux_context
= intern_c_string("set-file-selinux-context");
5471 Qfile_newer_than_file_p
= intern_c_string ("file-newer-than-file-p");
5472 Qinsert_file_contents
= intern_c_string ("insert-file-contents");
5473 Qwrite_region
= intern_c_string ("write-region");
5474 Qverify_visited_file_modtime
= intern_c_string ("verify-visited-file-modtime");
5475 Qset_visited_file_modtime
= intern_c_string ("set-visited-file-modtime");
5476 Qauto_save_coding
= intern_c_string ("auto-save-coding");
5478 staticpro (&Qoperations
);
5479 staticpro (&Qexpand_file_name
);
5480 staticpro (&Qsubstitute_in_file_name
);
5481 staticpro (&Qdirectory_file_name
);
5482 staticpro (&Qfile_name_directory
);
5483 staticpro (&Qfile_name_nondirectory
);
5484 staticpro (&Qunhandled_file_name_directory
);
5485 staticpro (&Qfile_name_as_directory
);
5486 staticpro (&Qcopy_file
);
5487 staticpro (&Qmake_directory_internal
);
5488 staticpro (&Qmake_directory
);
5489 staticpro (&Qdelete_directory_internal
);
5490 staticpro (&Qdelete_file
);
5491 staticpro (&Qrename_file
);
5492 staticpro (&Qadd_name_to_file
);
5493 staticpro (&Qmake_symbolic_link
);
5494 staticpro (&Qfile_exists_p
);
5495 staticpro (&Qfile_executable_p
);
5496 staticpro (&Qfile_readable_p
);
5497 staticpro (&Qfile_writable_p
);
5498 staticpro (&Qaccess_file
);
5499 staticpro (&Qfile_symlink_p
);
5500 staticpro (&Qfile_directory_p
);
5501 staticpro (&Qfile_regular_p
);
5502 staticpro (&Qfile_accessible_directory_p
);
5503 staticpro (&Qfile_modes
);
5504 staticpro (&Qset_file_modes
);
5505 staticpro (&Qset_file_times
);
5506 staticpro (&Qfile_selinux_context
);
5507 staticpro (&Qset_file_selinux_context
);
5508 staticpro (&Qfile_newer_than_file_p
);
5509 staticpro (&Qinsert_file_contents
);
5510 staticpro (&Qwrite_region
);
5511 staticpro (&Qverify_visited_file_modtime
);
5512 staticpro (&Qset_visited_file_modtime
);
5513 staticpro (&Qauto_save_coding
);
5515 Qfile_name_history
= intern_c_string ("file-name-history");
5516 Fset (Qfile_name_history
, Qnil
);
5517 staticpro (&Qfile_name_history
);
5519 Qfile_error
= intern_c_string ("file-error");
5520 staticpro (&Qfile_error
);
5521 Qfile_already_exists
= intern_c_string ("file-already-exists");
5522 staticpro (&Qfile_already_exists
);
5523 Qfile_date_error
= intern_c_string ("file-date-error");
5524 staticpro (&Qfile_date_error
);
5525 Qexcl
= intern_c_string ("excl");
5528 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5529 doc
: /* *Coding system for encoding file names.
5530 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5531 Vfile_name_coding_system
= Qnil
;
5533 DEFVAR_LISP ("default-file-name-coding-system",
5534 Vdefault_file_name_coding_system
,
5535 doc
: /* Default coding system for encoding file names.
5536 This variable is used only when `file-name-coding-system' is nil.
5538 This variable is set/changed by the command `set-language-environment'.
5539 User should not set this variable manually,
5540 instead use `file-name-coding-system' to get a constant encoding
5541 of file names regardless of the current language environment. */);
5542 Vdefault_file_name_coding_system
= Qnil
;
5544 Qformat_decode
= intern_c_string ("format-decode");
5545 staticpro (&Qformat_decode
);
5546 Qformat_annotate_function
= intern_c_string ("format-annotate-function");
5547 staticpro (&Qformat_annotate_function
);
5548 Qafter_insert_file_set_coding
= intern_c_string ("after-insert-file-set-coding");
5549 staticpro (&Qafter_insert_file_set_coding
);
5551 Qcar_less_than_car
= intern_c_string ("car-less-than-car");
5552 staticpro (&Qcar_less_than_car
);
5554 Fput (Qfile_error
, Qerror_conditions
,
5555 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5556 Fput (Qfile_error
, Qerror_message
,
5557 make_pure_c_string ("File error"));
5559 Fput (Qfile_already_exists
, Qerror_conditions
,
5560 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5561 Fput (Qfile_already_exists
, Qerror_message
,
5562 make_pure_c_string ("File already exists"));
5564 Fput (Qfile_date_error
, Qerror_conditions
,
5565 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5566 Fput (Qfile_date_error
, Qerror_message
,
5567 make_pure_c_string ("Cannot set file date"));
5569 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5570 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
5571 If a file name matches REGEXP, then all I/O on that file is done by calling
5574 The first argument given to HANDLER is the name of the I/O primitive
5575 to be handled; the remaining arguments are the arguments that were
5576 passed to that primitive. For example, if you do
5577 (file-exists-p FILENAME)
5578 and FILENAME is handled by HANDLER, then HANDLER is called like this:
5579 (funcall HANDLER 'file-exists-p FILENAME)
5580 The function `find-file-name-handler' checks this list for a handler
5581 for its argument. */);
5582 Vfile_name_handler_alist
= Qnil
;
5584 DEFVAR_LISP ("set-auto-coding-function",
5585 Vset_auto_coding_function
,
5586 doc
: /* If non-nil, a function to call to decide a coding system of file.
5587 Two arguments are passed to this function: the file name
5588 and the length of a file contents following the point.
5589 This function should return a coding system to decode the file contents.
5590 It should check the file name against `auto-coding-alist'.
5591 If no coding system is decided, it should check a coding system
5592 specified in the heading lines with the format:
5593 -*- ... coding: CODING-SYSTEM; ... -*-
5594 or local variable spec of the tailing lines with `coding:' tag. */);
5595 Vset_auto_coding_function
= Qnil
;
5597 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5598 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5599 Each is passed one argument, the number of characters inserted,
5600 with point at the start of the inserted text. Each function
5601 should leave point the same, and return the new character count.
5602 If `insert-file-contents' is intercepted by a handler from
5603 `file-name-handler-alist', that handler is responsible for calling the
5604 functions in `after-insert-file-functions' if appropriate. */);
5605 Vafter_insert_file_functions
= Qnil
;
5607 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5608 doc
: /* A list of functions to be called at the start of `write-region'.
5609 Each is passed two arguments, START and END as for `write-region'.
5610 These are usually two numbers but not always; see the documentation
5611 for `write-region'. The function should return a list of pairs
5612 of the form (POSITION . STRING), consisting of strings to be effectively
5613 inserted at the specified positions of the file being written (1 means to
5614 insert before the first byte written). The POSITIONs must be sorted into
5617 If there are several annotation functions, the lists returned by these
5618 functions are merged destructively. As each annotation function runs,
5619 the variable `write-region-annotations-so-far' contains a list of all
5620 annotations returned by previous annotation functions.
5622 An annotation function can return with a different buffer current.
5623 Doing so removes the annotations returned by previous functions, and
5624 resets START and END to `point-min' and `point-max' of the new buffer.
5626 After `write-region' completes, Emacs calls the function stored in
5627 `write-region-post-annotation-function', once for each buffer that was
5628 current when building the annotations (i.e., at least once), with that
5629 buffer current. */);
5630 Vwrite_region_annotate_functions
= Qnil
;
5631 staticpro (&Qwrite_region_annotate_functions
);
5632 Qwrite_region_annotate_functions
5633 = intern_c_string ("write-region-annotate-functions");
5635 DEFVAR_LISP ("write-region-post-annotation-function",
5636 Vwrite_region_post_annotation_function
,
5637 doc
: /* Function to call after `write-region' completes.
5638 The function is called with no arguments. If one or more of the
5639 annotation functions in `write-region-annotate-functions' changed the
5640 current buffer, the function stored in this variable is called for
5641 each of those additional buffers as well, in addition to the original
5642 buffer. The relevant buffer is current during each function call. */);
5643 Vwrite_region_post_annotation_function
= Qnil
;
5644 staticpro (&Vwrite_region_annotation_buffers
);
5646 DEFVAR_LISP ("write-region-annotations-so-far",
5647 Vwrite_region_annotations_so_far
,
5648 doc
: /* When an annotation function is called, this holds the previous annotations.
5649 These are the annotations made by other annotation functions
5650 that were already called. See also `write-region-annotate-functions'. */);
5651 Vwrite_region_annotations_so_far
= Qnil
;
5653 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5654 doc
: /* A list of file name handlers that temporarily should not be used.
5655 This applies only to the operation `inhibit-file-name-operation'. */);
5656 Vinhibit_file_name_handlers
= Qnil
;
5658 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5659 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5660 Vinhibit_file_name_operation
= Qnil
;
5662 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
5663 doc
: /* File name in which we write a list of all auto save file names.
5664 This variable is initialized automatically from `auto-save-list-file-prefix'
5665 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5666 a non-nil value. */);
5667 Vauto_save_list_file_name
= Qnil
;
5669 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
5670 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5671 Normally auto-save files are written under other names. */);
5672 Vauto_save_visited_file_name
= Qnil
;
5674 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
5675 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5676 If nil, deleting a substantial portion of the text disables auto-save
5677 in the buffer; this is the default behavior, because the auto-save
5678 file is usually more useful if it contains the deleted text. */);
5679 Vauto_save_include_big_deletions
= Qnil
;
5682 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
5683 doc
: /* *Non-nil means don't call fsync in `write-region'.
5684 This variable affects calls to `write-region' as well as save commands.
5685 A non-nil value may result in data loss! */);
5686 write_region_inhibit_fsync
= 0;
5689 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
5690 doc
: /* Specifies whether to use the system's trash can.
5691 When non-nil, certain file deletion commands use the function
5692 `move-file-to-trash' instead of deleting files outright.
5693 This includes interactive calls to `delete-file' and
5694 `delete-directory' and the Dired deletion commands. */);
5695 delete_by_moving_to_trash
= 0;
5696 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5697 Qmove_file_to_trash
= intern_c_string ("move-file-to-trash");
5698 staticpro (&Qmove_file_to_trash
);
5699 Qcopy_directory
= intern_c_string ("copy-directory");
5700 staticpro (&Qcopy_directory
);
5701 Qdelete_directory
= intern_c_string ("delete-directory");
5702 staticpro (&Qdelete_directory
);
5704 defsubr (&Sfind_file_name_handler
);
5705 defsubr (&Sfile_name_directory
);
5706 defsubr (&Sfile_name_nondirectory
);
5707 defsubr (&Sunhandled_file_name_directory
);
5708 defsubr (&Sfile_name_as_directory
);
5709 defsubr (&Sdirectory_file_name
);
5710 defsubr (&Smake_temp_name
);
5711 defsubr (&Sexpand_file_name
);
5712 defsubr (&Ssubstitute_in_file_name
);
5713 defsubr (&Scopy_file
);
5714 defsubr (&Smake_directory_internal
);
5715 defsubr (&Sdelete_directory_internal
);
5716 defsubr (&Sdelete_file
);
5717 defsubr (&Srename_file
);
5718 defsubr (&Sadd_name_to_file
);
5719 defsubr (&Smake_symbolic_link
);
5720 defsubr (&Sfile_name_absolute_p
);
5721 defsubr (&Sfile_exists_p
);
5722 defsubr (&Sfile_executable_p
);
5723 defsubr (&Sfile_readable_p
);
5724 defsubr (&Sfile_writable_p
);
5725 defsubr (&Saccess_file
);
5726 defsubr (&Sfile_symlink_p
);
5727 defsubr (&Sfile_directory_p
);
5728 defsubr (&Sfile_accessible_directory_p
);
5729 defsubr (&Sfile_regular_p
);
5730 defsubr (&Sfile_modes
);
5731 defsubr (&Sset_file_modes
);
5732 defsubr (&Sset_file_times
);
5733 defsubr (&Sfile_selinux_context
);
5734 defsubr (&Sset_file_selinux_context
);
5735 defsubr (&Sset_default_file_modes
);
5736 defsubr (&Sdefault_file_modes
);
5737 defsubr (&Sfile_newer_than_file_p
);
5738 defsubr (&Sinsert_file_contents
);
5739 defsubr (&Swrite_region
);
5740 defsubr (&Scar_less_than_car
);
5741 defsubr (&Sverify_visited_file_modtime
);
5742 defsubr (&Sclear_visited_file_modtime
);
5743 defsubr (&Svisited_file_modtime
);
5744 defsubr (&Sset_visited_file_modtime
);
5745 defsubr (&Sdo_auto_save
);
5746 defsubr (&Sset_buffer_auto_saved
);
5747 defsubr (&Sclear_buffer_auto_save_failure
);
5748 defsubr (&Srecent_auto_save_p
);
5750 defsubr (&Snext_read_file_uses_dialog_p
);
5753 defsubr (&Sunix_sync
);