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 */
91 static int auto_saving
;
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 static int auto_save_mode_bits
;
97 /* Set by auto_save_1 if an error occurred during the last auto-save. */
98 static int auto_save_error_occurred
;
100 /* The symbol bound to coding-system-for-read when
101 insert-file-contents is called for recovering a file. This is not
102 an actual coding system name, but just an indicator to tell
103 insert-file-contents to use `emacs-mule' with a special flag for
104 auto saving and recovering a file. */
105 static Lisp_Object Qauto_save_coding
;
107 /* Property name of a file name handler,
108 which gives a list of operations it handles.. */
109 static Lisp_Object Qoperations
;
111 /* Lisp functions for translating file formats */
112 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
114 /* Lisp function for setting buffer-file-coding-system and the
115 multibyteness of the current buffer after inserting a file. */
116 static Lisp_Object Qafter_insert_file_set_coding
;
118 static Lisp_Object Qwrite_region_annotate_functions
;
119 /* Each time an annotation function changes the buffer, the new buffer
121 static Lisp_Object Vwrite_region_annotation_buffers
;
126 static Lisp_Object Qdelete_by_moving_to_trash
;
128 /* Lisp function for moving files to trash. */
129 static Lisp_Object Qmove_file_to_trash
;
131 /* Lisp function for recursively copying directories. */
132 static Lisp_Object Qcopy_directory
;
134 /* Lisp function for recursively deleting directories. */
135 static Lisp_Object Qdelete_directory
;
140 Lisp_Object Qfile_error
;
141 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
142 static Lisp_Object Qexcl
;
143 Lisp_Object Qfile_name_history
;
145 static Lisp_Object Qcar_less_than_car
;
147 static Lisp_Object
Fmake_symbolic_link (Lisp_Object
, Lisp_Object
, Lisp_Object
);
148 static int a_write (int, Lisp_Object
, EMACS_INT
, EMACS_INT
,
149 Lisp_Object
*, struct coding_system
*);
150 static int e_write (int, Lisp_Object
, EMACS_INT
, EMACS_INT
,
151 struct coding_system
*);
155 report_file_error (const char *string
, Lisp_Object data
)
157 Lisp_Object errstring
;
161 synchronize_system_messages_locale ();
162 str
= strerror (errorno
);
163 errstring
= code_convert_string_norecord (make_unibyte_string (str
,
165 Vlocale_coding_system
, 0);
171 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
174 /* System error messages are capitalized. Downcase the initial
175 unless it is followed by a slash. (The slash case caters to
176 error messages that begin with "I/O" or, in German, "E/A".) */
177 if (STRING_MULTIBYTE (errstring
)
178 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
182 str
= SSDATA (errstring
);
183 c
= STRING_CHAR ((unsigned char *) str
);
184 Faset (errstring
, make_number (0), make_number (downcase (c
)));
187 xsignal (Qfile_error
,
188 Fcons (build_string (string
), Fcons (errstring
, data
)));
193 close_file_unwind (Lisp_Object fd
)
195 emacs_close (XFASTINT (fd
));
199 /* Restore point, having saved it as a marker. */
202 restore_point_unwind (Lisp_Object location
)
204 Fgoto_char (location
);
205 Fset_marker (location
, Qnil
, Qnil
);
210 static Lisp_Object Qexpand_file_name
;
211 static Lisp_Object Qsubstitute_in_file_name
;
212 static Lisp_Object Qdirectory_file_name
;
213 static Lisp_Object Qfile_name_directory
;
214 static Lisp_Object Qfile_name_nondirectory
;
215 static Lisp_Object Qunhandled_file_name_directory
;
216 static Lisp_Object Qfile_name_as_directory
;
217 static Lisp_Object Qcopy_file
;
218 static Lisp_Object Qmake_directory_internal
;
219 static Lisp_Object Qmake_directory
;
220 static Lisp_Object Qdelete_directory_internal
;
221 Lisp_Object Qdelete_file
;
222 static Lisp_Object Qrename_file
;
223 static Lisp_Object Qadd_name_to_file
;
224 static Lisp_Object Qmake_symbolic_link
;
225 Lisp_Object Qfile_exists_p
;
226 static Lisp_Object Qfile_executable_p
;
227 static Lisp_Object Qfile_readable_p
;
228 static Lisp_Object Qfile_writable_p
;
229 static Lisp_Object Qfile_symlink_p
;
230 static Lisp_Object Qaccess_file
;
231 Lisp_Object Qfile_directory_p
;
232 static Lisp_Object Qfile_regular_p
;
233 static Lisp_Object Qfile_accessible_directory_p
;
234 static Lisp_Object Qfile_modes
;
235 static Lisp_Object Qset_file_modes
;
236 static Lisp_Object Qset_file_times
;
237 static Lisp_Object Qfile_selinux_context
;
238 static Lisp_Object Qset_file_selinux_context
;
239 static Lisp_Object Qfile_newer_than_file_p
;
240 Lisp_Object Qinsert_file_contents
;
241 Lisp_Object Qwrite_region
;
242 static Lisp_Object Qverify_visited_file_modtime
;
243 static Lisp_Object Qset_visited_file_modtime
;
245 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
246 Sfind_file_name_handler
, 2, 2, 0,
247 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
248 Otherwise, return nil.
249 A file name is handled if one of the regular expressions in
250 `file-name-handler-alist' matches it.
252 If OPERATION equals `inhibit-file-name-operation', then we ignore
253 any handlers that are members of `inhibit-file-name-handlers',
254 but we still do run any other handlers. This lets handlers
255 use the standard functions without calling themselves recursively. */)
256 (Lisp_Object filename
, Lisp_Object operation
)
258 /* This function must not munge the match data. */
259 Lisp_Object chain
, inhibited_handlers
, result
;
263 CHECK_STRING (filename
);
265 if (EQ (operation
, Vinhibit_file_name_operation
))
266 inhibited_handlers
= Vinhibit_file_name_handlers
;
268 inhibited_handlers
= Qnil
;
270 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
271 chain
= XCDR (chain
))
277 Lisp_Object string
= XCAR (elt
);
279 Lisp_Object handler
= XCDR (elt
);
280 Lisp_Object operations
= Qnil
;
282 if (SYMBOLP (handler
))
283 operations
= Fget (handler
, Qoperations
);
286 && (match_pos
= fast_string_match (string
, filename
)) > pos
287 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
291 handler
= XCDR (elt
);
292 tem
= Fmemq (handler
, inhibited_handlers
);
306 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
308 doc
: /* Return the directory component in file name FILENAME.
309 Return nil if FILENAME does not include a directory.
310 Otherwise return a directory name.
311 Given a Unix syntax file name, returns a string ending in slash. */)
312 (Lisp_Object filename
)
315 register const char *beg
;
319 register const char *p
;
322 CHECK_STRING (filename
);
324 /* If the file name has special constructs in it,
325 call the corresponding file handler. */
326 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
328 return call2 (handler
, Qfile_name_directory
, filename
);
330 filename
= FILE_SYSTEM_CASE (filename
);
332 beg
= (char *) alloca (SBYTES (filename
) + 1);
333 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
335 beg
= SSDATA (filename
);
337 p
= beg
+ SBYTES (filename
);
339 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
341 /* only recognise drive specifier at the beginning */
343 /* handle the "/:d:foo" and "/:foo" cases correctly */
344 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
345 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
352 /* Expansion of "c:" to drive and default directory. */
355 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
356 char *res
= alloca (MAXPATHLEN
+ 1);
359 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
361 strncpy (res
, beg
, 2);
366 if (getdefdir (toupper ((unsigned char) *beg
) - 'A' + 1, r
))
368 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
371 p
= beg
+ strlen (beg
);
374 dostounix_filename (beg
);
377 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
380 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
381 Sfile_name_nondirectory
, 1, 1, 0,
382 doc
: /* Return file name FILENAME sans its directory.
383 For example, in a Unix-syntax file name,
384 this is everything after the last slash,
385 or the entire name if it contains no slash. */)
386 (Lisp_Object filename
)
388 register const char *beg
, *p
, *end
;
391 CHECK_STRING (filename
);
393 /* If the file name has special constructs in it,
394 call the corresponding file handler. */
395 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
397 return call2 (handler
, Qfile_name_nondirectory
, filename
);
399 beg
= SSDATA (filename
);
400 end
= p
= beg
+ SBYTES (filename
);
402 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
404 /* only recognise drive specifier at beginning */
406 /* handle the "/:d:foo" case correctly */
407 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
412 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
415 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
416 Sunhandled_file_name_directory
, 1, 1, 0,
417 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
418 A `directly usable' directory name is one that may be used without the
419 intervention of any file handler.
420 If FILENAME is a directly usable file itself, return
421 \(file-name-directory FILENAME).
422 If FILENAME refers to a file which is not accessible from a local process,
423 then this should return nil.
424 The `call-process' and `start-process' functions use this function to
425 get a current directory to run processes in. */)
426 (Lisp_Object filename
)
430 /* If the file name has special constructs in it,
431 call the corresponding file handler. */
432 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
434 return call2 (handler
, Qunhandled_file_name_directory
, filename
);
436 return Ffile_name_directory (filename
);
441 file_name_as_directory (char *out
, const char *in
)
443 int size
= strlen (in
) - 1;
455 /* For Unix syntax, Append a slash if necessary */
456 if (!IS_DIRECTORY_SEP (out
[size
]))
458 out
[size
+ 1] = DIRECTORY_SEP
;
459 out
[size
+ 2] = '\0';
462 dostounix_filename (out
);
467 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
468 Sfile_name_as_directory
, 1, 1, 0,
469 doc
: /* Return a string representing the file name FILE interpreted as a directory.
470 This operation exists because a directory is also a file, but its name as
471 a directory is different from its name as a file.
472 The result can be used as the value of `default-directory'
473 or passed as second argument to `expand-file-name'.
474 For a Unix-syntax file name, just appends a slash. */)
484 /* If the file name has special constructs in it,
485 call the corresponding file handler. */
486 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
488 return call2 (handler
, Qfile_name_as_directory
, file
);
490 buf
= (char *) alloca (SBYTES (file
) + 10);
491 file_name_as_directory (buf
, SSDATA (file
));
492 return make_specified_string (buf
, -1, strlen (buf
),
493 STRING_MULTIBYTE (file
));
497 * Convert from directory name to filename.
498 * On UNIX, it's simple: just make sure there isn't a terminating /
500 * Value is nonzero if the string output is different from the input.
504 directory_file_name (char *src
, char *dst
)
510 /* Process as Unix format: just remove any final slash.
511 But leave "/" unchanged; do not change it to "". */
514 && IS_DIRECTORY_SEP (dst
[slen
- 1])
516 && !IS_ANY_SEP (dst
[slen
- 2])
521 dostounix_filename (dst
);
526 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
528 doc
: /* Returns the file name of the directory named DIRECTORY.
529 This is the name of the file that holds the data for the directory DIRECTORY.
530 This operation exists because a directory is also a file, but its name as
531 a directory is different from its name as a file.
532 In Unix-syntax, this function just removes the final slash. */)
533 (Lisp_Object directory
)
538 CHECK_STRING (directory
);
540 if (NILP (directory
))
543 /* If the file name has special constructs in it,
544 call the corresponding file handler. */
545 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
547 return call2 (handler
, Qdirectory_file_name
, directory
);
549 buf
= (char *) alloca (SBYTES (directory
) + 20);
550 directory_file_name (SSDATA (directory
), buf
);
551 return make_specified_string (buf
, -1, strlen (buf
),
552 STRING_MULTIBYTE (directory
));
555 static const char make_temp_name_tbl
[64] =
557 'A','B','C','D','E','F','G','H',
558 'I','J','K','L','M','N','O','P',
559 'Q','R','S','T','U','V','W','X',
560 'Y','Z','a','b','c','d','e','f',
561 'g','h','i','j','k','l','m','n',
562 'o','p','q','r','s','t','u','v',
563 'w','x','y','z','0','1','2','3',
564 '4','5','6','7','8','9','-','_'
567 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
569 /* Value is a temporary file name starting with PREFIX, a string.
571 The Emacs process number forms part of the result, so there is
572 no danger of generating a name being used by another process.
573 In addition, this function makes an attempt to choose a name
574 which has no existing file. To make this work, PREFIX should be
575 an absolute file name.
577 BASE64_P non-zero means add the pid as 3 characters in base64
578 encoding. In this case, 6 characters will be added to PREFIX to
579 form the file name. Otherwise, if Emacs is running on a system
580 with long file names, add the pid as a decimal number.
582 This function signals an error if no unique file name could be
586 make_temp_name (Lisp_Object prefix
, int base64_p
)
595 CHECK_STRING (prefix
);
597 /* VAL is created by adding 6 characters to PREFIX. The first
598 three are the PID of this process, in base 64, and the second
599 three are incremented if the file already exists. This ensures
600 262144 unique file names per PID per PREFIX. */
602 pid
= (int) getpid ();
606 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
607 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
608 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
613 #ifdef HAVE_LONG_FILE_NAMES
614 sprintf (pidbuf
, "%d", pid
);
615 pidlen
= strlen (pidbuf
);
617 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
618 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
619 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
624 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
625 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
626 if (!STRING_MULTIBYTE (prefix
))
627 STRING_SET_UNIBYTE (val
);
629 memcpy (data
, SSDATA (prefix
), len
);
632 memcpy (p
, pidbuf
, pidlen
);
635 /* Here we try to minimize useless stat'ing when this function is
636 invoked many times successively with the same PREFIX. We achieve
637 this by initializing count to a random value, and incrementing it
640 We don't want make-temp-name to be called while dumping,
641 because then make_temp_name_count_initialized_p would get set
642 and then make_temp_name_count would not be set when Emacs starts. */
644 if (!make_temp_name_count_initialized_p
)
646 make_temp_name_count
= time (NULL
);
647 make_temp_name_count_initialized_p
= 1;
653 unsigned num
= make_temp_name_count
;
655 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
656 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
657 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
659 /* Poor man's congruential RN generator. Replace with
660 ++make_temp_name_count for debugging. */
661 make_temp_name_count
+= 25229;
662 make_temp_name_count
%= 225307;
664 if (stat (data
, &ignored
) < 0)
666 /* We want to return only if errno is ENOENT. */
670 /* The error here is dubious, but there is little else we
671 can do. The alternatives are to return nil, which is
672 as bad as (and in many cases worse than) throwing the
673 error, or to ignore the error, which will likely result
674 in looping through 225307 stat's, which is not only
675 dog-slow, but also useless since eventually nil would
676 have to be returned anyway. */
677 report_file_error ("Cannot create temporary name for prefix",
678 Fcons (prefix
, Qnil
));
685 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
686 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
687 The Emacs process number forms part of the result,
688 so there is no danger of generating a name being used by another process.
690 In addition, this function makes an attempt to choose a name
691 which has no existing file. To make this work,
692 PREFIX should be an absolute file name.
694 There is a race condition between calling `make-temp-name' and creating the
695 file which opens all kinds of security holes. For that reason, you should
696 probably use `make-temp-file' instead, except in three circumstances:
698 * If you are creating the file in the user's home directory.
699 * If you are creating a directory rather than an ordinary file.
700 * If you are taking special precautions as `make-temp-file' does. */)
703 return make_temp_name (prefix
, 0);
708 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
709 doc
: /* Convert filename NAME to absolute, and canonicalize it.
710 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
711 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
712 the current buffer's value of `default-directory' is used.
713 NAME should be a string that is a valid file name for the underlying
715 File name components that are `.' are removed, and
716 so are file name components followed by `..', along with the `..' itself;
717 note that these simplifications are done without checking the resulting
718 file names in the file system.
719 Multiple consecutive slashes are collapsed into a single slash,
720 except at the beginning of the file name when they are significant (e.g.,
721 UNC file names on MS-Windows.)
722 An initial `~/' expands to your home directory.
723 An initial `~USER/' expands to USER's home directory.
724 See also the function `substitute-in-file-name'.
726 For technical reasons, this function can return correct but
727 non-intuitive results for the root directory; for instance,
728 \(expand-file-name ".." "/") returns "/..". For this reason, use
729 \(directory-file-name (file-name-directory dirname)) to traverse a
730 filesystem tree, not (expand-file-name ".." dirname). */)
731 (Lisp_Object name
, Lisp_Object default_directory
)
733 /* These point to SDATA and need to be careful with string-relocation
734 during GC (via DECODE_FILE). */
737 /* This should only point to alloca'd data. */
744 int collapse_newdir
= 1;
748 Lisp_Object handler
, result
;
754 /* If the file name has special constructs in it,
755 call the corresponding file handler. */
756 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
758 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
760 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
761 if (NILP (default_directory
))
762 default_directory
= BVAR (current_buffer
, directory
);
763 if (! STRINGP (default_directory
))
766 /* "/" is not considered a root directory on DOS_NT, so using "/"
767 here causes an infinite recursion in, e.g., the following:
769 (let (default-directory)
770 (expand-file-name "a"))
772 To avoid this, we set default_directory to the root of the
774 default_directory
= build_string (emacs_root_dir ());
776 default_directory
= build_string ("/");
780 if (!NILP (default_directory
))
782 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
784 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
788 char *o
= SSDATA (default_directory
);
790 /* Make sure DEFAULT_DIRECTORY is properly expanded.
791 It would be better to do this down below where we actually use
792 default_directory. Unfortunately, calling Fexpand_file_name recursively
793 could invoke GC, and the strings might be relocated. This would
794 be annoying because we have pointers into strings lying around
795 that would need adjusting, and people would add new pointers to
796 the code and forget to adjust them, resulting in intermittent bugs.
797 Putting this call here avoids all that crud.
799 The EQ test avoids infinite recursion. */
800 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
801 /* Save time in some common cases - as long as default_directory
802 is not relative, it can be canonicalized with name below (if it
803 is needed at all) without requiring it to be expanded now. */
805 /* Detect MSDOS file names with drive specifiers. */
806 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
807 && IS_DIRECTORY_SEP (o
[2]))
809 /* Detect Windows file names in UNC format. */
810 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
812 #else /* not DOS_NT */
813 /* Detect Unix absolute file names (/... alone is not absolute on
815 && ! (IS_DIRECTORY_SEP (o
[0]))
816 #endif /* not DOS_NT */
822 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
826 name
= FILE_SYSTEM_CASE (name
);
827 multibyte
= STRING_MULTIBYTE (name
);
828 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
831 default_directory
= string_to_multibyte (default_directory
);
834 name
= string_to_multibyte (name
);
839 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
840 nm
= (char *) alloca (SBYTES (name
) + 1);
841 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
844 /* Note if special escape prefix is present, but remove for now. */
845 if (nm
[0] == '/' && nm
[1] == ':')
851 /* Find and remove drive specifier if present; this makes nm absolute
852 even if the rest of the name appears to be relative. Only look for
853 drive specifier at the beginning. */
854 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
856 drive
= (unsigned char) nm
[0];
861 /* If we see "c://somedir", we want to strip the first slash after the
862 colon when stripping the drive letter. Otherwise, this expands to
864 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
867 /* Discard any previous drive specifier if nm is now in UNC format. */
868 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
872 #endif /* WINDOWSNT */
875 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
876 none are found, we can probably return right away. We will avoid
877 allocating a new string if name is already fully expanded. */
879 IS_DIRECTORY_SEP (nm
[0])
881 && drive
&& !is_escaped
884 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
888 /* If it turns out that the filename we want to return is just a
889 suffix of FILENAME, we don't need to go through and edit
890 things; we just need to construct a new string using data
891 starting at the middle of FILENAME. If we set lose to a
892 non-zero value, that means we've discovered that we can't do
899 /* Since we know the name is absolute, we can assume that each
900 element starts with a "/". */
902 /* "." and ".." are hairy. */
903 if (IS_DIRECTORY_SEP (p
[0])
905 && (IS_DIRECTORY_SEP (p
[2])
907 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
910 /* We want to replace multiple `/' in a row with a single
913 && IS_DIRECTORY_SEP (p
[0])
914 && IS_DIRECTORY_SEP (p
[1]))
921 /* Make sure directories are all separated with /, but
922 avoid allocation of a new string when not required. */
923 dostounix_filename (nm
);
925 if (IS_DIRECTORY_SEP (nm
[1]))
927 if (strcmp (nm
, SSDATA (name
)) != 0)
928 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
932 /* drive must be set, so this is okay */
933 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
937 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
938 temp
[0] = DRIVE_LETTER (drive
);
939 name
= concat2 (build_string (temp
), name
);
942 #else /* not DOS_NT */
943 if (strcmp (nm
, SSDATA (name
)) == 0)
945 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
946 #endif /* not DOS_NT */
950 /* At this point, nm might or might not be an absolute file name. We
951 need to expand ~ or ~user if present, otherwise prefix nm with
952 default_directory if nm is not absolute, and finally collapse /./
953 and /foo/../ sequences.
955 We set newdir to be the appropriate prefix if one is needed:
956 - the relevant user directory if nm starts with ~ or ~user
957 - the specified drive's working dir (DOS/NT only) if nm does not
959 - the value of default_directory.
961 Note that these prefixes are not guaranteed to be absolute (except
962 for the working dir of a drive). Therefore, to ensure we always
963 return an absolute name, if the final prefix is not absolute we
964 append it to the current working directory. */
968 if (nm
[0] == '~') /* prefix ~ */
970 if (IS_DIRECTORY_SEP (nm
[1])
971 || nm
[1] == 0) /* ~ by itself */
975 if (!(newdir
= egetenv ("HOME")))
978 /* egetenv may return a unibyte string, which will bite us since
979 we expect the directory to be multibyte. */
980 tem
= build_string (newdir
);
981 if (!STRING_MULTIBYTE (tem
))
983 hdir
= DECODE_FILE (tem
);
984 newdir
= SSDATA (hdir
);
990 else /* ~user/filename */
993 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
994 o
= alloca (p
- nm
+ 1);
995 memcpy (o
, nm
, p
- nm
);
999 pw
= (struct passwd
*) getpwnam (o
+ 1);
1003 newdir
= pw
->pw_dir
;
1006 collapse_newdir
= 0;
1010 /* If we don't find a user of that name, leave the name
1011 unchanged; don't move nm forward to p. */
1016 /* On DOS and Windows, nm is absolute if a drive name was specified;
1017 use the drive's current directory as the prefix if needed. */
1018 if (!newdir
&& drive
)
1020 /* Get default directory if needed to make nm absolute. */
1022 if (!IS_DIRECTORY_SEP (nm
[0]))
1024 adir
= alloca (MAXPATHLEN
+ 1);
1025 if (!getdefdir (toupper (drive
) - 'A' + 1, adir
))
1030 /* Either nm starts with /, or drive isn't mounted. */
1032 adir
[0] = DRIVE_LETTER (drive
);
1041 /* Finally, if no prefix has been specified and nm is not absolute,
1042 then it must be expanded relative to default_directory. */
1046 /* /... alone is not absolute on DOS and Windows. */
1047 && !IS_DIRECTORY_SEP (nm
[0])
1050 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1054 newdir
= SSDATA (default_directory
);
1056 /* Note if special escape prefix is present, but remove for now. */
1057 if (newdir
[0] == '/' && newdir
[1] == ':')
1068 /* First ensure newdir is an absolute name. */
1070 /* Detect MSDOS file names with drive specifiers. */
1071 ! (IS_DRIVE (newdir
[0])
1072 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1074 /* Detect Windows file names in UNC format. */
1075 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1079 /* Effectively, let newdir be (expand-file-name newdir cwd).
1080 Because of the admonition against calling expand-file-name
1081 when we have pointers into lisp strings, we accomplish this
1082 indirectly by prepending newdir to nm if necessary, and using
1083 cwd (or the wd of newdir's drive) as the new newdir. */
1085 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1087 drive
= (unsigned char) newdir
[0];
1090 if (!IS_DIRECTORY_SEP (nm
[0]))
1092 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1093 file_name_as_directory (tmp
, newdir
);
1097 adir
= alloca (MAXPATHLEN
+ 1);
1100 if (!getdefdir (toupper (drive
) - 'A' + 1, adir
))
1108 /* Strip off drive name from prefix, if present. */
1109 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1115 /* Keep only a prefix from newdir if nm starts with slash
1116 (//server/share for UNC, nothing otherwise). */
1117 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1120 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1122 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1124 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1126 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1139 /* Get rid of any slash at the end of newdir, unless newdir is
1140 just / or // (an incomplete UNC name). */
1141 length
= strlen (newdir
);
1142 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1144 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1148 char *temp
= (char *) alloca (length
);
1149 memcpy (temp
, newdir
, length
- 1);
1150 temp
[length
- 1] = 0;
1158 /* Now concatenate the directory and name to new space in the stack frame */
1159 tlen
+= strlen (nm
) + 1;
1161 /* Reserve space for drive specifier and escape prefix, since either
1162 or both may need to be inserted. (The Microsoft x86 compiler
1163 produces incorrect code if the following two lines are combined.) */
1164 target
= (char *) alloca (tlen
+ 4);
1166 #else /* not DOS_NT */
1167 target
= (char *) alloca (tlen
);
1168 #endif /* not DOS_NT */
1173 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1176 /* If newdir is effectively "C:/", then the drive letter will have
1177 been stripped and newdir will be "/". Concatenating with an
1178 absolute directory in nm produces "//", which will then be
1179 incorrectly treated as a network share. Ignore newdir in
1180 this case (keeping the drive letter). */
1181 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1182 && newdir
[1] == '\0'))
1184 strcpy (target
, newdir
);
1187 file_name_as_directory (target
, newdir
);
1190 strcat (target
, nm
);
1192 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1200 if (!IS_DIRECTORY_SEP (*p
))
1204 else if (p
[1] == '.'
1205 && (IS_DIRECTORY_SEP (p
[2])
1208 /* If "/." is the entire filename, keep the "/". Otherwise,
1209 just delete the whole "/.". */
1210 if (o
== target
&& p
[2] == '\0')
1214 else if (p
[1] == '.' && p
[2] == '.'
1215 /* `/../' is the "superroot" on certain file systems.
1216 Turned off on DOS_NT systems because they have no
1217 "superroot" and because this causes us to produce
1218 file names like "d:/../foo" which fail file-related
1219 functions of the underlying OS. (To reproduce, try a
1220 long series of "../../" in default_directory, longer
1221 than the number of levels from the root.) */
1225 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1230 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1233 /* Don't go below server level in UNC filenames. */
1234 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1235 && IS_DIRECTORY_SEP (*target
))
1239 /* Keep initial / only if this is the whole name. */
1240 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1244 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1245 /* Collapse multiple `/' in a row. */
1254 /* At last, set drive name. */
1256 /* Except for network file name. */
1257 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1258 #endif /* WINDOWSNT */
1260 if (!drive
) abort ();
1262 target
[0] = DRIVE_LETTER (drive
);
1265 /* Reinsert the escape prefix if required. */
1272 dostounix_filename (target
);
1275 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1278 /* Again look to see if the file name has special constructs in it
1279 and perhaps call the corresponding file handler. This is needed
1280 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1281 the ".." component gives us "/user@host:/bar/../baz" which needs
1282 to be expanded again. */
1283 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1284 if (!NILP (handler
))
1285 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1291 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1292 This is the old version of expand-file-name, before it was thoroughly
1293 rewritten for Emacs 10.31. We leave this version here commented-out,
1294 because the code is very complex and likely to have subtle bugs. If
1295 bugs _are_ found, it might be of interest to look at the old code and
1296 see what did it do in the relevant situation.
1298 Don't remove this code: it's true that it will be accessible
1299 from the repository, but a few years from deletion, people will
1300 forget it is there. */
1302 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1303 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1304 "Convert FILENAME to absolute, and canonicalize it.\n\
1305 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1306 \(does not start with slash); if DEFAULT is nil or missing,\n\
1307 the current buffer's value of default-directory is used.\n\
1308 Filenames containing `.' or `..' as components are simplified;\n\
1309 initial `~/' expands to your home directory.\n\
1310 See also the function `substitute-in-file-name'.")
1312 Lisp_Object name
, defalt
;
1316 register unsigned char *newdir
, *p
, *o
;
1318 unsigned char *target
;
1322 CHECK_STRING (name
);
1325 /* If nm is absolute, flush ...// and detect /./ and /../.
1326 If no /./ or /../ we can return right away. */
1333 if (p
[0] == '/' && p
[1] == '/'
1336 if (p
[0] == '/' && p
[1] == '~')
1337 nm
= p
+ 1, lose
= 1;
1338 if (p
[0] == '/' && p
[1] == '.'
1339 && (p
[2] == '/' || p
[2] == 0
1340 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1346 if (nm
== SDATA (name
))
1348 return build_string (nm
);
1352 /* Now determine directory to start with and put it in NEWDIR */
1356 if (nm
[0] == '~') /* prefix ~ */
1357 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1359 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1360 newdir
= (unsigned char *) "";
1363 else /* ~user/filename */
1365 /* Get past ~ to user */
1366 unsigned char *user
= nm
+ 1;
1367 /* Find end of name. */
1368 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1369 int len
= ptr
? ptr
- user
: strlen (user
);
1370 /* Copy the user name into temp storage. */
1371 o
= (unsigned char *) alloca (len
+ 1);
1372 memcpy (o
, user
, len
);
1375 /* Look up the user name. */
1377 pw
= (struct passwd
*) getpwnam (o
+ 1);
1380 error ("\"%s\" isn't a registered user", o
+ 1);
1382 newdir
= (unsigned char *) pw
->pw_dir
;
1384 /* Discard the user name from NM. */
1388 if (nm
[0] != '/' && !newdir
)
1391 defalt
= current_buffer
->directory
;
1392 CHECK_STRING (defalt
);
1393 newdir
= SDATA (defalt
);
1396 /* Now concatenate the directory and name to new space in the stack frame */
1398 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1399 target
= (unsigned char *) alloca (tlen
);
1404 if (nm
[0] == 0 || nm
[0] == '/')
1405 strcpy (target
, newdir
);
1407 file_name_as_directory (target
, newdir
);
1410 strcat (target
, nm
);
1412 /* Now canonicalize by removing /. and /foo/.. if they appear */
1423 else if (!strncmp (p
, "//", 2)
1429 else if (p
[0] == '/' && p
[1] == '.'
1430 && (p
[2] == '/' || p
[2] == 0))
1432 else if (!strncmp (p
, "/..", 3)
1433 /* `/../' is the "superroot" on certain file systems. */
1435 && (p
[3] == '/' || p
[3] == 0))
1437 while (o
!= target
&& *--o
!= '/')
1439 if (o
== target
&& *o
== '/')
1449 return make_string (target
, o
- target
);
1453 /* If /~ or // appears, discard everything through first slash. */
1455 file_name_absolute_p (const char *filename
)
1458 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1460 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1461 && IS_DIRECTORY_SEP (filename
[2]))
1467 search_embedded_absfilename (char *nm
, char *endp
)
1471 for (p
= nm
+ 1; p
< endp
; p
++)
1474 || IS_DIRECTORY_SEP (p
[-1]))
1475 && file_name_absolute_p (p
)
1476 #if defined (WINDOWSNT) || defined(CYGWIN)
1477 /* // at start of file name is meaningful in Apollo,
1478 WindowsNT and Cygwin systems. */
1479 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1480 #endif /* not (WINDOWSNT || CYGWIN) */
1483 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1484 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
1486 char *o
= alloca (s
- p
+ 1);
1488 memcpy (o
, p
, s
- p
);
1491 /* If we have ~user and `user' exists, discard
1492 everything up to ~. But if `user' does not exist, leave
1493 ~user alone, it might be a literal file name. */
1495 pw
= getpwnam (o
+ 1);
1507 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1508 Ssubstitute_in_file_name
, 1, 1, 0,
1509 doc
: /* Substitute environment variables referred to in FILENAME.
1510 `$FOO' where FOO is an environment variable name means to substitute
1511 the value of that variable. The variable name should be terminated
1512 with a character not a letter, digit or underscore; otherwise, enclose
1513 the entire variable name in braces.
1515 If `/~' appears, all of FILENAME through that `/' is discarded.
1516 If `//' appears, everything up to and including the first of
1517 those `/' is discarded. */)
1518 (Lisp_Object filename
)
1522 register char *s
, *p
, *o
, *x
, *endp
;
1523 char *target
= NULL
;
1525 int substituted
= 0;
1528 Lisp_Object handler
;
1530 CHECK_STRING (filename
);
1532 multibyte
= STRING_MULTIBYTE (filename
);
1534 /* If the file name has special constructs in it,
1535 call the corresponding file handler. */
1536 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1537 if (!NILP (handler
))
1538 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
1540 /* Always work on a copy of the string, in case GC happens during
1541 decode of environment variables, causing the original Lisp_String
1542 data to be relocated. */
1543 nm
= (char *) alloca (SBYTES (filename
) + 1);
1544 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1547 dostounix_filename (nm
);
1548 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1550 endp
= nm
+ SBYTES (filename
);
1552 /* If /~ or // appears, discard everything through first slash. */
1553 p
= search_embedded_absfilename (nm
, endp
);
1555 /* Start over with the new string, so we check the file-name-handler
1556 again. Important with filenames like "/home/foo//:/hello///there"
1557 which whould substitute to "/:/hello///there" rather than "/there". */
1558 return Fsubstitute_in_file_name
1559 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1561 /* See if any variables are substituted into the string
1562 and find the total length of their values in `total' */
1564 for (p
= nm
; p
!= endp
;)
1574 /* "$$" means a single "$" */
1583 while (p
!= endp
&& *p
!= '}') p
++;
1584 if (*p
!= '}') goto missingclose
;
1590 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1594 /* Copy out the variable name */
1595 target
= (char *) alloca (s
- o
+ 1);
1596 strncpy (target
, o
, s
- o
);
1599 strupr (target
); /* $home == $HOME etc. */
1602 /* Get variable value */
1603 o
= egetenv (target
);
1606 /* Don't try to guess a maximum length - UTF8 can use up to
1607 four bytes per character. This code is unlikely to run
1608 in a situation that requires performance, so decoding the
1609 env variables twice should be acceptable. Note that
1610 decoding may cause a garbage collect. */
1611 Lisp_Object orig
, decoded
;
1612 orig
= make_unibyte_string (o
, strlen (o
));
1613 decoded
= DECODE_FILE (orig
);
1614 total
+= SBYTES (decoded
);
1624 /* If substitution required, recopy the string and do it */
1625 /* Make space in stack frame for the new copy */
1626 xnm
= (char *) alloca (SBYTES (filename
) + total
+ 1);
1629 /* Copy the rest of the name through, replacing $ constructs with values */
1646 while (p
!= endp
&& *p
!= '}') p
++;
1647 if (*p
!= '}') goto missingclose
;
1653 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1657 /* Copy out the variable name */
1658 target
= (char *) alloca (s
- o
+ 1);
1659 strncpy (target
, o
, s
- o
);
1662 strupr (target
); /* $home == $HOME etc. */
1665 /* Get variable value */
1666 o
= egetenv (target
);
1670 strcpy (x
, target
); x
+= strlen (target
);
1674 Lisp_Object orig
, decoded
;
1675 int orig_length
, decoded_length
;
1676 orig_length
= strlen (o
);
1677 orig
= make_unibyte_string (o
, orig_length
);
1678 decoded
= DECODE_FILE (orig
);
1679 decoded_length
= SBYTES (decoded
);
1680 strncpy (x
, SSDATA (decoded
), decoded_length
);
1681 x
+= decoded_length
;
1683 /* If environment variable needed decoding, return value
1684 needs to be multibyte. */
1685 if (decoded_length
!= orig_length
1686 || strncmp (SSDATA (decoded
), o
, orig_length
))
1693 /* If /~ or // appears, discard everything through first slash. */
1694 while ((p
= search_embedded_absfilename (xnm
, x
)))
1695 /* This time we do not start over because we've already expanded envvars
1696 and replaced $$ with $. Maybe we should start over as well, but we'd
1697 need to quote some $ to $$ first. */
1700 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1703 error ("Bad format environment-variable substitution");
1705 error ("Missing \"}\" in environment-variable substitution");
1707 error ("Substituting nonexistent environment variable \"%s\"", target
);
1713 /* A slightly faster and more convenient way to get
1714 (directory-file-name (expand-file-name FOO)). */
1717 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1719 register Lisp_Object absname
;
1721 absname
= Fexpand_file_name (filename
, defdir
);
1723 /* Remove final slash, if any (unless this is the root dir).
1724 stat behaves differently depending! */
1725 if (SCHARS (absname
) > 1
1726 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1727 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
1728 /* We cannot take shortcuts; they might be wrong for magic file names. */
1729 absname
= Fdirectory_file_name (absname
);
1733 /* Signal an error if the file ABSNAME already exists.
1734 If INTERACTIVE is nonzero, ask the user whether to proceed,
1735 and bypass the error if the user says to go ahead.
1736 QUERYSTRING is a name for the action that is being considered
1739 *STATPTR is used to store the stat information if the file exists.
1740 If the file does not exist, STATPTR->st_mode is set to 0.
1741 If STATPTR is null, we don't store into it.
1743 If QUICK is nonzero, we ask for y or n, not yes or no. */
1746 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1747 int interactive
, struct stat
*statptr
, int quick
)
1749 register Lisp_Object tem
, encoded_filename
;
1750 struct stat statbuf
;
1751 struct gcpro gcpro1
;
1753 encoded_filename
= ENCODE_FILE (absname
);
1755 /* stat is a good way to tell whether the file exists,
1756 regardless of what access permissions it has. */
1757 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1760 xsignal2 (Qfile_already_exists
,
1761 build_string ("File already exists"), absname
);
1763 tem
= format2 ("File %s already exists; %s anyway? ",
1764 absname
, build_string (querystring
));
1766 tem
= call1 (intern ("y-or-n-p"), tem
);
1768 tem
= do_yes_or_no_p (tem
);
1771 xsignal2 (Qfile_already_exists
,
1772 build_string ("File already exists"), absname
);
1779 statptr
->st_mode
= 0;
1784 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1785 "fCopy file: \nGCopy %s to file: \np\nP",
1786 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1787 If NEWNAME names a directory, copy FILE there.
1789 This function always sets the file modes of the output file to match
1792 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1793 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1794 signal a `file-already-exists' error without overwriting. If
1795 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1796 about overwriting; this is what happens in interactive use with M-x.
1797 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1800 Fourth arg KEEP-TIME non-nil means give the output file the same
1801 last-modified time as the old one. (This works on only some systems.)
1803 A prefix arg makes KEEP-TIME non-nil.
1805 If PRESERVE-UID-GID is non-nil, we try to transfer the
1806 uid and gid of FILE to NEWNAME.
1808 If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
1809 on the system, we copy the SELinux context of FILE to NEWNAME. */)
1810 (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
)
1814 char buf
[16 * 1024];
1815 struct stat st
, out_st
;
1816 Lisp_Object handler
;
1817 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1818 int count
= SPECPDL_INDEX ();
1819 int input_file_statable_p
;
1820 Lisp_Object encoded_file
, encoded_newname
;
1822 security_context_t con
;
1823 int fail
, conlength
= 0;
1826 encoded_file
= encoded_newname
= Qnil
;
1827 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1828 CHECK_STRING (file
);
1829 CHECK_STRING (newname
);
1831 if (!NILP (Ffile_directory_p (newname
)))
1832 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1834 newname
= Fexpand_file_name (newname
, Qnil
);
1836 file
= Fexpand_file_name (file
, Qnil
);
1838 /* If the input file name has special constructs in it,
1839 call the corresponding file handler. */
1840 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1841 /* Likewise for output file name. */
1843 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1844 if (!NILP (handler
))
1845 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1846 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1847 preserve_selinux_context
));
1849 encoded_file
= ENCODE_FILE (file
);
1850 encoded_newname
= ENCODE_FILE (newname
);
1852 if (NILP (ok_if_already_exists
)
1853 || INTEGERP (ok_if_already_exists
))
1854 barf_or_query_if_file_exists (newname
, "copy to it",
1855 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1856 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1860 if (!CopyFile (SDATA (encoded_file
),
1861 SDATA (encoded_newname
),
1863 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1864 /* CopyFile retains the timestamp by default. */
1865 else if (NILP (keep_time
))
1871 EMACS_GET_TIME (now
);
1872 filename
= SDATA (encoded_newname
);
1874 /* Ensure file is writable while its modified time is set. */
1875 attributes
= GetFileAttributes (filename
);
1876 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1877 if (set_file_times (filename
, now
, now
))
1879 /* Restore original attributes. */
1880 SetFileAttributes (filename
, attributes
);
1881 xsignal2 (Qfile_date_error
,
1882 build_string ("Cannot set file date"), newname
);
1884 /* Restore original attributes. */
1885 SetFileAttributes (filename
, attributes
);
1887 #else /* not WINDOWSNT */
1889 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
1893 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1895 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1897 /* We can only copy regular files and symbolic links. Other files are not
1899 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
1902 if (!NILP (preserve_selinux_context
) && is_selinux_enabled ())
1904 conlength
= fgetfilecon (ifd
, &con
);
1905 if (conlength
== -1)
1906 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
1910 if (out_st
.st_mode
!= 0
1911 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
1914 report_file_error ("Input and output files are the same",
1915 Fcons (file
, Fcons (newname
, Qnil
)));
1918 if (input_file_statable_p
)
1920 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
1922 #if defined (EISDIR)
1923 /* Get a better looking error message. */
1926 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
1931 /* System's default file type was set to binary by _fmode in emacs.c. */
1932 ofd
= emacs_open (SDATA (encoded_newname
),
1933 O_WRONLY
| O_TRUNC
| O_CREAT
1934 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
1935 S_IREAD
| S_IWRITE
);
1936 #else /* not MSDOS */
1937 ofd
= emacs_open (SSDATA (encoded_newname
),
1938 O_WRONLY
| O_TRUNC
| O_CREAT
1939 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
1941 #endif /* not MSDOS */
1943 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
1945 record_unwind_protect (close_file_unwind
, make_number (ofd
));
1949 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
1950 if (emacs_write (ofd
, buf
, n
) != n
)
1951 report_file_error ("I/O error", Fcons (newname
, Qnil
));
1955 /* Preserve the original file modes, and if requested, also its
1957 if (input_file_statable_p
)
1959 if (!NILP (preserve_uid_gid
) && fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
1960 report_file_error ("Doing chown", Fcons (newname
, Qnil
));
1961 if (fchmod (ofd
, st
.st_mode
& 07777) != 0)
1962 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
1964 #endif /* not MSDOS */
1969 /* Set the modified context back to the file. */
1970 fail
= fsetfilecon (ofd
, con
);
1972 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
1978 /* Closing the output clobbers the file times on some systems. */
1979 if (emacs_close (ofd
) < 0)
1980 report_file_error ("I/O error", Fcons (newname
, Qnil
));
1982 if (input_file_statable_p
)
1984 if (!NILP (keep_time
))
1986 EMACS_TIME atime
, mtime
;
1987 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
1988 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
1989 if (set_file_times (SSDATA (encoded_newname
),
1991 xsignal2 (Qfile_date_error
,
1992 build_string ("Cannot set file date"), newname
);
1999 if (input_file_statable_p
)
2001 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2002 and if it can't, it tells so. Otherwise, under MSDOS we usually
2003 get only the READ bit, which will make the copied file read-only,
2004 so it's better not to chmod at all. */
2005 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2006 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2009 #endif /* not WINDOWSNT */
2011 /* Discard the unwind protects. */
2012 specpdl_ptr
= specpdl
+ count
;
2018 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2019 Smake_directory_internal
, 1, 1, 0,
2020 doc
: /* Create a new directory named DIRECTORY. */)
2021 (Lisp_Object directory
)
2024 Lisp_Object handler
;
2025 Lisp_Object encoded_dir
;
2027 CHECK_STRING (directory
);
2028 directory
= Fexpand_file_name (directory
, Qnil
);
2030 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2031 if (!NILP (handler
))
2032 return call2 (handler
, Qmake_directory_internal
, directory
);
2034 encoded_dir
= ENCODE_FILE (directory
);
2036 dir
= SSDATA (encoded_dir
);
2039 if (mkdir (dir
) != 0)
2041 if (mkdir (dir
, 0777) != 0)
2043 report_file_error ("Creating directory", list1 (directory
));
2048 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2049 Sdelete_directory_internal
, 1, 1, 0,
2050 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2051 (Lisp_Object directory
)
2054 Lisp_Object encoded_dir
;
2056 CHECK_STRING (directory
);
2057 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2058 encoded_dir
= ENCODE_FILE (directory
);
2059 dir
= SSDATA (encoded_dir
);
2061 if (rmdir (dir
) != 0)
2062 report_file_error ("Removing directory", list1 (directory
));
2067 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2068 "(list (read-file-name \
2069 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2070 \"Move file to trash: \" \"Delete file: \") \
2071 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2072 (null current-prefix-arg))",
2073 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2074 If file has multiple names, it continues to exist with the other names.
2075 TRASH non-nil means to trash the file instead of deleting, provided
2076 `delete-by-moving-to-trash' is non-nil.
2078 When called interactively, TRASH is t if no prefix argument is given.
2079 With a prefix argument, TRASH is nil. */)
2080 (Lisp_Object filename
, Lisp_Object trash
)
2082 Lisp_Object handler
;
2083 Lisp_Object encoded_file
;
2084 struct gcpro gcpro1
;
2087 if (!NILP (Ffile_directory_p (filename
))
2088 && NILP (Ffile_symlink_p (filename
)))
2089 xsignal2 (Qfile_error
,
2090 build_string ("Removing old name: is a directory"),
2093 filename
= Fexpand_file_name (filename
, Qnil
);
2095 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2096 if (!NILP (handler
))
2097 return call3 (handler
, Qdelete_file
, filename
, trash
);
2099 if (delete_by_moving_to_trash
&& !NILP (trash
))
2100 return call1 (Qmove_file_to_trash
, filename
);
2102 encoded_file
= ENCODE_FILE (filename
);
2104 if (0 > unlink (SSDATA (encoded_file
)))
2105 report_file_error ("Removing old name", list1 (filename
));
2110 internal_delete_file_1 (Lisp_Object ignore
)
2115 /* Delete file FILENAME, returning 1 if successful and 0 if failed.
2116 This ignores `delete-by-moving-to-trash'. */
2119 internal_delete_file (Lisp_Object filename
)
2123 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2124 Qt
, internal_delete_file_1
);
2128 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2129 "fRename file: \nGRename %s to file: \np",
2130 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2131 If file has names other than FILE, it continues to have those names.
2132 Signals a `file-already-exists' error if a file NEWNAME already exists
2133 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2134 A number as third arg means request confirmation if NEWNAME already exists.
2135 This is what happens in interactive use with M-x. */)
2136 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2138 Lisp_Object handler
;
2139 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2140 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2142 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2143 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2144 CHECK_STRING (file
);
2145 CHECK_STRING (newname
);
2146 file
= Fexpand_file_name (file
, Qnil
);
2148 if ((!NILP (Ffile_directory_p (newname
)))
2150 /* If the file names are identical but for the case,
2151 don't attempt to move directory to itself. */
2152 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2156 Lisp_Object fname
= NILP (Ffile_directory_p (file
))
2157 ? file
: Fdirectory_file_name (file
);
2158 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2161 newname
= Fexpand_file_name (newname
, Qnil
);
2163 /* If the file name has special constructs in it,
2164 call the corresponding file handler. */
2165 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2167 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2168 if (!NILP (handler
))
2169 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2170 file
, newname
, ok_if_already_exists
));
2172 encoded_file
= ENCODE_FILE (file
);
2173 encoded_newname
= ENCODE_FILE (newname
);
2176 /* If the file names are identical but for the case, don't ask for
2177 confirmation: they simply want to change the letter-case of the
2179 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2181 if (NILP (ok_if_already_exists
)
2182 || INTEGERP (ok_if_already_exists
))
2183 barf_or_query_if_file_exists (newname
, "rename to it",
2184 INTEGERP (ok_if_already_exists
), 0, 0);
2185 if (0 > rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2190 symlink_target
= Ffile_symlink_p (file
);
2191 if (! NILP (symlink_target
))
2192 Fmake_symbolic_link (symlink_target
, newname
,
2193 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2194 else if (!NILP (Ffile_directory_p (file
)))
2195 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2197 /* We have already prompted if it was an integer, so don't
2198 have copy-file prompt again. */
2199 Fcopy_file (file
, newname
,
2200 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2203 count
= SPECPDL_INDEX ();
2204 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2206 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2207 call2 (Qdelete_directory
, file
, Qt
);
2209 Fdelete_file (file
, Qnil
);
2210 unbind_to (count
, Qnil
);
2213 report_file_error ("Renaming", list2 (file
, newname
));
2219 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2220 "fAdd name to file: \nGName to add to %s: \np",
2221 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2222 Signals a `file-already-exists' error if a file NEWNAME already exists
2223 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2224 A number as third arg means request confirmation if NEWNAME already exists.
2225 This is what happens in interactive use with M-x. */)
2226 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2228 Lisp_Object handler
;
2229 Lisp_Object encoded_file
, encoded_newname
;
2230 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2232 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2233 encoded_file
= encoded_newname
= Qnil
;
2234 CHECK_STRING (file
);
2235 CHECK_STRING (newname
);
2236 file
= Fexpand_file_name (file
, Qnil
);
2238 if (!NILP (Ffile_directory_p (newname
)))
2239 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2241 newname
= Fexpand_file_name (newname
, Qnil
);
2243 /* If the file name has special constructs in it,
2244 call the corresponding file handler. */
2245 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2246 if (!NILP (handler
))
2247 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2248 newname
, ok_if_already_exists
));
2250 /* If the new name has special constructs in it,
2251 call the corresponding file handler. */
2252 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2253 if (!NILP (handler
))
2254 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2255 newname
, ok_if_already_exists
));
2257 encoded_file
= ENCODE_FILE (file
);
2258 encoded_newname
= ENCODE_FILE (newname
);
2260 if (NILP (ok_if_already_exists
)
2261 || INTEGERP (ok_if_already_exists
))
2262 barf_or_query_if_file_exists (newname
, "make it a new name",
2263 INTEGERP (ok_if_already_exists
), 0, 0);
2265 unlink (SSDATA (newname
));
2266 if (0 > link (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2267 report_file_error ("Adding new name", list2 (file
, newname
));
2273 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2274 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2275 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2276 Both args must be strings.
2277 Signals a `file-already-exists' error if a file LINKNAME already exists
2278 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2279 A number as third arg means request confirmation if LINKNAME already exists.
2280 This happens for interactive use with M-x. */)
2281 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2283 Lisp_Object handler
;
2284 Lisp_Object encoded_filename
, encoded_linkname
;
2285 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2287 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2288 encoded_filename
= encoded_linkname
= Qnil
;
2289 CHECK_STRING (filename
);
2290 CHECK_STRING (linkname
);
2291 /* If the link target has a ~, we must expand it to get
2292 a truly valid file name. Otherwise, do not expand;
2293 we want to permit links to relative file names. */
2294 if (SREF (filename
, 0) == '~')
2295 filename
= Fexpand_file_name (filename
, Qnil
);
2297 if (!NILP (Ffile_directory_p (linkname
)))
2298 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2300 linkname
= Fexpand_file_name (linkname
, Qnil
);
2302 /* If the file name has special constructs in it,
2303 call the corresponding file handler. */
2304 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2305 if (!NILP (handler
))
2306 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2307 linkname
, ok_if_already_exists
));
2309 /* If the new link name has special constructs in it,
2310 call the corresponding file handler. */
2311 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2312 if (!NILP (handler
))
2313 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2314 linkname
, ok_if_already_exists
));
2316 encoded_filename
= ENCODE_FILE (filename
);
2317 encoded_linkname
= ENCODE_FILE (linkname
);
2319 if (NILP (ok_if_already_exists
)
2320 || INTEGERP (ok_if_already_exists
))
2321 barf_or_query_if_file_exists (linkname
, "make it a link",
2322 INTEGERP (ok_if_already_exists
), 0, 0);
2323 if (0 > symlink (SSDATA (encoded_filename
),
2324 SSDATA (encoded_linkname
)))
2326 /* If we didn't complain already, silently delete existing file. */
2327 if (errno
== EEXIST
)
2329 unlink (SSDATA (encoded_linkname
));
2330 if (0 <= symlink (SSDATA (encoded_filename
),
2331 SSDATA (encoded_linkname
)))
2337 if (errno
== ENOSYS
)
2340 xsignal1 (Qfile_error
,
2341 build_string ("Symbolic links are not supported"));
2344 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2351 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2353 doc
: /* Return t if file FILENAME specifies an absolute file name.
2354 On Unix, this is a name starting with a `/' or a `~'. */)
2355 (Lisp_Object filename
)
2357 CHECK_STRING (filename
);
2358 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2361 /* Return nonzero if file FILENAME exists and can be executed. */
2364 check_executable (char *filename
)
2368 if (stat (filename
, &st
) < 0)
2370 return ((st
.st_mode
& S_IEXEC
) != 0);
2371 #else /* not DOS_NT */
2372 #ifdef HAVE_EUIDACCESS
2373 return (euidaccess (filename
, 1) >= 0);
2375 /* Access isn't quite right because it uses the real uid
2376 and we really want to test with the effective uid.
2377 But Unix doesn't give us a right way to do it. */
2378 return (access (filename
, 1) >= 0);
2380 #endif /* not DOS_NT */
2383 /* Return nonzero if file FILENAME exists and can be written. */
2386 check_writable (const char *filename
)
2390 if (stat (filename
, &st
) < 0)
2392 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2393 #else /* not MSDOS */
2394 #ifdef HAVE_EUIDACCESS
2395 return (euidaccess (filename
, 2) >= 0);
2397 /* Access isn't quite right because it uses the real uid
2398 and we really want to test with the effective uid.
2399 But Unix doesn't give us a right way to do it.
2400 Opening with O_WRONLY could work for an ordinary file,
2401 but would lose for directories. */
2402 return (access (filename
, 2) >= 0);
2404 #endif /* not MSDOS */
2407 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2408 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2409 See also `file-readable-p' and `file-attributes'.
2410 This returns nil for a symlink to a nonexistent file.
2411 Use `file-symlink-p' to test for such links. */)
2412 (Lisp_Object filename
)
2414 Lisp_Object absname
;
2415 Lisp_Object handler
;
2416 struct stat statbuf
;
2418 CHECK_STRING (filename
);
2419 absname
= Fexpand_file_name (filename
, Qnil
);
2421 /* If the file name has special constructs in it,
2422 call the corresponding file handler. */
2423 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2424 if (!NILP (handler
))
2425 return call2 (handler
, Qfile_exists_p
, absname
);
2427 absname
= ENCODE_FILE (absname
);
2429 return (stat (SSDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2432 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2433 doc
: /* Return t if FILENAME can be executed by you.
2434 For a directory, this means you can access files in that directory. */)
2435 (Lisp_Object filename
)
2437 Lisp_Object absname
;
2438 Lisp_Object handler
;
2440 CHECK_STRING (filename
);
2441 absname
= Fexpand_file_name (filename
, Qnil
);
2443 /* If the file name has special constructs in it,
2444 call the corresponding file handler. */
2445 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2446 if (!NILP (handler
))
2447 return call2 (handler
, Qfile_executable_p
, absname
);
2449 absname
= ENCODE_FILE (absname
);
2451 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2454 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2455 doc
: /* Return t if file FILENAME exists and you can read it.
2456 See also `file-exists-p' and `file-attributes'. */)
2457 (Lisp_Object filename
)
2459 Lisp_Object absname
;
2460 Lisp_Object handler
;
2463 struct stat statbuf
;
2465 CHECK_STRING (filename
);
2466 absname
= Fexpand_file_name (filename
, Qnil
);
2468 /* If the file name has special constructs in it,
2469 call the corresponding file handler. */
2470 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2471 if (!NILP (handler
))
2472 return call2 (handler
, Qfile_readable_p
, absname
);
2474 absname
= ENCODE_FILE (absname
);
2476 #if defined(DOS_NT) || defined(macintosh)
2477 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2479 if (access (SDATA (absname
), 0) == 0)
2482 #else /* not DOS_NT and not macintosh */
2485 /* Opening a fifo without O_NONBLOCK can wait.
2486 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2487 except in the case of a fifo, on a system which handles it. */
2488 desc
= stat (SSDATA (absname
), &statbuf
);
2491 if (S_ISFIFO (statbuf
.st_mode
))
2492 flags
|= O_NONBLOCK
;
2494 desc
= emacs_open (SSDATA (absname
), flags
, 0);
2499 #endif /* not DOS_NT and not macintosh */
2502 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2504 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2505 doc
: /* Return t if file FILENAME can be written or created by you. */)
2506 (Lisp_Object filename
)
2508 Lisp_Object absname
, dir
, encoded
;
2509 Lisp_Object handler
;
2510 struct stat statbuf
;
2512 CHECK_STRING (filename
);
2513 absname
= Fexpand_file_name (filename
, Qnil
);
2515 /* If the file name has special constructs in it,
2516 call the corresponding file handler. */
2517 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2518 if (!NILP (handler
))
2519 return call2 (handler
, Qfile_writable_p
, absname
);
2521 encoded
= ENCODE_FILE (absname
);
2522 if (stat (SSDATA (encoded
), &statbuf
) >= 0)
2523 return (check_writable (SSDATA (encoded
))
2526 dir
= Ffile_name_directory (absname
);
2529 dir
= Fdirectory_file_name (dir
);
2532 dir
= ENCODE_FILE (dir
);
2534 /* The read-only attribute of the parent directory doesn't affect
2535 whether a file or directory can be created within it. Some day we
2536 should check ACLs though, which do affect this. */
2537 if (stat (SDATA (dir
), &statbuf
) < 0)
2539 return S_ISDIR (statbuf
.st_mode
) ? Qt
: Qnil
;
2541 return (check_writable (!NILP (dir
) ? SSDATA (dir
) : "")
2546 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2547 doc
: /* Access file FILENAME, and get an error if that does not work.
2548 The second argument STRING is used in the error message.
2549 If there is no error, returns nil. */)
2550 (Lisp_Object filename
, Lisp_Object string
)
2552 Lisp_Object handler
, encoded_filename
, absname
;
2555 CHECK_STRING (filename
);
2556 absname
= Fexpand_file_name (filename
, Qnil
);
2558 CHECK_STRING (string
);
2560 /* If the file name has special constructs in it,
2561 call the corresponding file handler. */
2562 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2563 if (!NILP (handler
))
2564 return call3 (handler
, Qaccess_file
, absname
, string
);
2566 encoded_filename
= ENCODE_FILE (absname
);
2568 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2570 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2576 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2577 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2578 The value is the link target, as a string.
2579 Otherwise it returns nil.
2581 This function returns t when given the name of a symlink that
2582 points to a nonexistent file. */)
2583 (Lisp_Object filename
)
2585 Lisp_Object handler
;
2588 char readlink_buf
[READLINK_BUFSIZE
];
2590 CHECK_STRING (filename
);
2591 filename
= Fexpand_file_name (filename
, Qnil
);
2593 /* If the file name has special constructs in it,
2594 call the corresponding file handler. */
2595 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2596 if (!NILP (handler
))
2597 return call2 (handler
, Qfile_symlink_p
, filename
);
2599 filename
= ENCODE_FILE (filename
);
2601 buf
= emacs_readlink (SSDATA (filename
), readlink_buf
);
2605 val
= build_string (buf
);
2606 if (buf
[0] == '/' && strchr (buf
, ':'))
2607 val
= concat2 (build_string ("/:"), val
);
2608 if (buf
!= readlink_buf
)
2610 val
= DECODE_FILE (val
);
2614 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2615 doc
: /* Return t if FILENAME names an existing directory.
2616 Symbolic links to directories count as directories.
2617 See `file-symlink-p' to distinguish symlinks. */)
2618 (Lisp_Object filename
)
2620 register Lisp_Object absname
;
2622 Lisp_Object handler
;
2624 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2626 /* If the file name has special constructs in it,
2627 call the corresponding file handler. */
2628 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2629 if (!NILP (handler
))
2630 return call2 (handler
, Qfile_directory_p
, absname
);
2632 absname
= ENCODE_FILE (absname
);
2634 if (stat (SSDATA (absname
), &st
) < 0)
2636 return S_ISDIR (st
.st_mode
) ? Qt
: Qnil
;
2639 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2640 Sfile_accessible_directory_p
, 1, 1, 0,
2641 doc
: /* Return t if file FILENAME names a directory you can open.
2642 For the value to be t, FILENAME must specify the name of a directory as a file,
2643 and the directory must allow you to open files in it. In order to use a
2644 directory as a buffer's current directory, this predicate must return true.
2645 A directory name spec may be given instead; then the value is t
2646 if the directory so specified exists and really is a readable and
2647 searchable directory. */)
2648 (Lisp_Object filename
)
2650 Lisp_Object handler
;
2652 struct gcpro gcpro1
;
2654 /* If the file name has special constructs in it,
2655 call the corresponding file handler. */
2656 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2657 if (!NILP (handler
))
2658 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2661 tem
= (NILP (Ffile_directory_p (filename
))
2662 || NILP (Ffile_executable_p (filename
)));
2664 return tem
? Qnil
: Qt
;
2667 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2668 doc
: /* Return t if FILENAME names a regular file.
2669 This is the sort of file that holds an ordinary stream of data bytes.
2670 Symbolic links to regular files count as regular files.
2671 See `file-symlink-p' to distinguish symlinks. */)
2672 (Lisp_Object filename
)
2674 register Lisp_Object absname
;
2676 Lisp_Object handler
;
2678 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2680 /* If the file name has special constructs in it,
2681 call the corresponding file handler. */
2682 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2683 if (!NILP (handler
))
2684 return call2 (handler
, Qfile_regular_p
, absname
);
2686 absname
= ENCODE_FILE (absname
);
2691 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2693 /* Tell stat to use expensive method to get accurate info. */
2694 Vw32_get_true_file_attributes
= Qt
;
2695 result
= stat (SDATA (absname
), &st
);
2696 Vw32_get_true_file_attributes
= tem
;
2700 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2703 if (stat (SSDATA (absname
), &st
) < 0)
2705 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2709 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2710 Sfile_selinux_context
, 1, 1, 0,
2711 doc
: /* Return SELinux context of file named FILENAME,
2712 as a list ("user", "role", "type", "range"). Return (nil, nil, nil, nil)
2713 if file does not exist, is not accessible, or SELinux is disabled */)
2714 (Lisp_Object filename
)
2716 Lisp_Object absname
;
2717 Lisp_Object values
[4];
2718 Lisp_Object handler
;
2720 security_context_t con
;
2725 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2727 /* If the file name has special constructs in it,
2728 call the corresponding file handler. */
2729 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2730 if (!NILP (handler
))
2731 return call2 (handler
, Qfile_selinux_context
, absname
);
2733 absname
= ENCODE_FILE (absname
);
2740 if (is_selinux_enabled ())
2742 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2745 context
= context_new (con
);
2746 if (context_user_get (context
))
2747 values
[0] = build_string (context_user_get (context
));
2748 if (context_role_get (context
))
2749 values
[1] = build_string (context_role_get (context
));
2750 if (context_type_get (context
))
2751 values
[2] = build_string (context_type_get (context
));
2752 if (context_range_get (context
))
2753 values
[3] = build_string (context_range_get (context
));
2754 context_free (context
);
2761 return Flist (sizeof(values
) / sizeof(values
[0]), values
);
2764 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2765 Sset_file_selinux_context
, 2, 2, 0,
2766 doc
: /* Set SELinux context of file named FILENAME to CONTEXT
2767 as a list ("user", "role", "type", "range"). Has no effect if SELinux
2769 (Lisp_Object filename
, Lisp_Object context
)
2771 Lisp_Object absname
;
2772 Lisp_Object handler
;
2774 Lisp_Object encoded_absname
;
2775 Lisp_Object user
= CAR_SAFE (context
);
2776 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2777 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2778 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2779 security_context_t con
;
2780 int fail
, conlength
;
2781 context_t parsed_con
;
2784 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2786 /* If the file name has special constructs in it,
2787 call the corresponding file handler. */
2788 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2789 if (!NILP (handler
))
2790 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2793 if (is_selinux_enabled ())
2795 /* Get current file context. */
2796 encoded_absname
= ENCODE_FILE (absname
);
2797 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2800 parsed_con
= context_new (con
);
2801 /* Change the parts defined in the parameter.*/
2804 if (context_user_set (parsed_con
, SSDATA (user
)))
2805 error ("Doing context_user_set");
2809 if (context_role_set (parsed_con
, SSDATA (role
)))
2810 error ("Doing context_role_set");
2814 if (context_type_set (parsed_con
, SSDATA (type
)))
2815 error ("Doing context_type_set");
2817 if (STRINGP (range
))
2819 if (context_range_set (parsed_con
, SSDATA (range
)))
2820 error ("Doing context_range_set");
2823 /* Set the modified context back to the file. */
2824 fail
= lsetfilecon (SSDATA (encoded_absname
),
2825 context_str (parsed_con
));
2827 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
2829 context_free (parsed_con
);
2832 report_file_error("Doing lgetfilecon", Fcons (absname
, Qnil
));
2842 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2843 doc
: /* Return mode bits of file named FILENAME, as an integer.
2844 Return nil, if file does not exist or is not accessible. */)
2845 (Lisp_Object filename
)
2847 Lisp_Object absname
;
2849 Lisp_Object handler
;
2851 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2853 /* If the file name has special constructs in it,
2854 call the corresponding file handler. */
2855 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2856 if (!NILP (handler
))
2857 return call2 (handler
, Qfile_modes
, absname
);
2859 absname
= ENCODE_FILE (absname
);
2861 if (stat (SSDATA (absname
), &st
) < 0)
2864 return make_number (st
.st_mode
& 07777);
2867 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2868 "(let ((file (read-file-name \"File: \"))) \
2869 (list file (read-file-modes nil file)))",
2870 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2871 Only the 12 low bits of MODE are used.
2873 Interactively, mode bits are read by `read-file-modes', which accepts
2874 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2875 (Lisp_Object filename
, Lisp_Object mode
)
2877 Lisp_Object absname
, encoded_absname
;
2878 Lisp_Object handler
;
2880 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2881 CHECK_NUMBER (mode
);
2883 /* If the file name has special constructs in it,
2884 call the corresponding file handler. */
2885 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2886 if (!NILP (handler
))
2887 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2889 encoded_absname
= ENCODE_FILE (absname
);
2891 if (chmod (SSDATA (encoded_absname
), XINT (mode
)) < 0)
2892 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2897 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2898 doc
: /* Set the file permission bits for newly created files.
2899 The argument MODE should be an integer; only the low 9 bits are used.
2900 This setting is inherited by subprocesses. */)
2903 CHECK_NUMBER (mode
);
2905 umask ((~ XINT (mode
)) & 0777);
2910 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
2911 doc
: /* Return the default file protection for created files.
2912 The value is an integer. */)
2918 realmask
= umask (0);
2921 XSETINT (value
, (~ realmask
) & 0777);
2926 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
2927 doc
: /* Set times of file FILENAME to TIMESTAMP.
2928 Set both access and modification times.
2929 Return t on success, else nil.
2930 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
2932 (Lisp_Object filename
, Lisp_Object timestamp
)
2934 Lisp_Object absname
, encoded_absname
;
2935 Lisp_Object handler
;
2939 if (! lisp_time_argument (timestamp
, &sec
, &usec
))
2940 error ("Invalid time specification");
2942 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2944 /* If the file name has special constructs in it,
2945 call the corresponding file handler. */
2946 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
2947 if (!NILP (handler
))
2948 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
2950 encoded_absname
= ENCODE_FILE (absname
);
2955 EMACS_SET_SECS (t
, sec
);
2956 EMACS_SET_USECS (t
, usec
);
2958 if (set_file_times (SSDATA (encoded_absname
), t
, t
))
2963 /* Setting times on a directory always fails. */
2964 if (stat (SSDATA (encoded_absname
), &st
) == 0 && S_ISDIR (st
.st_mode
))
2967 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
2976 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
2977 doc
: /* Tell Unix to finish all pending disk updates. */)
2984 #endif /* HAVE_SYNC */
2986 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
2987 doc
: /* Return t if file FILE1 is newer than file FILE2.
2988 If FILE1 does not exist, the answer is nil;
2989 otherwise, if FILE2 does not exist, the answer is t. */)
2990 (Lisp_Object file1
, Lisp_Object file2
)
2992 Lisp_Object absname1
, absname2
;
2995 Lisp_Object handler
;
2996 struct gcpro gcpro1
, gcpro2
;
2998 CHECK_STRING (file1
);
2999 CHECK_STRING (file2
);
3002 GCPRO2 (absname1
, file2
);
3003 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3004 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3007 /* If the file name has special constructs in it,
3008 call the corresponding file handler. */
3009 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3011 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3012 if (!NILP (handler
))
3013 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3015 GCPRO2 (absname1
, absname2
);
3016 absname1
= ENCODE_FILE (absname1
);
3017 absname2
= ENCODE_FILE (absname2
);
3020 if (stat (SSDATA (absname1
), &st
) < 0)
3023 mtime1
= st
.st_mtime
;
3025 if (stat (SSDATA (absname2
), &st
) < 0)
3028 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3031 #ifndef READ_BUF_SIZE
3032 #define READ_BUF_SIZE (64 << 10)
3035 /* This function is called after Lisp functions to decide a coding
3036 system are called, or when they cause an error. Before they are
3037 called, the current buffer is set unibyte and it contains only a
3038 newly inserted text (thus the buffer was empty before the
3041 The functions may set markers, overlays, text properties, or even
3042 alter the buffer contents, change the current buffer.
3044 Here, we reset all those changes by:
3045 o set back the current buffer.
3046 o move all markers and overlays to BEG.
3047 o remove all text properties.
3048 o set back the buffer multibyteness. */
3051 decide_coding_unwind (Lisp_Object unwind_data
)
3053 Lisp_Object multibyte
, undo_list
, buffer
;
3055 multibyte
= XCAR (unwind_data
);
3056 unwind_data
= XCDR (unwind_data
);
3057 undo_list
= XCAR (unwind_data
);
3058 buffer
= XCDR (unwind_data
);
3060 if (current_buffer
!= XBUFFER (buffer
))
3061 set_buffer_internal (XBUFFER (buffer
));
3062 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3063 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3064 BUF_INTERVALS (current_buffer
) = 0;
3065 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3067 /* Now we are safe to change the buffer's multibyteness directly. */
3068 BVAR (current_buffer
, enable_multibyte_characters
) = multibyte
;
3069 BVAR (current_buffer
, undo_list
) = undo_list
;
3075 /* Used to pass values from insert-file-contents to read_non_regular. */
3077 static int non_regular_fd
;
3078 static EMACS_INT non_regular_inserted
;
3079 static EMACS_INT non_regular_nbytes
;
3082 /* Read from a non-regular file.
3083 Read non_regular_nbytes bytes max from non_regular_fd.
3084 Non_regular_inserted specifies where to put the read bytes.
3085 Value is the number of bytes read. */
3088 read_non_regular (Lisp_Object ignore
)
3094 nbytes
= emacs_read (non_regular_fd
,
3095 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3096 + non_regular_inserted
),
3097 non_regular_nbytes
);
3099 return make_number (nbytes
);
3103 /* Condition-case handler used when reading from non-regular files
3104 in insert-file-contents. */
3107 read_non_regular_quit (Lisp_Object ignore
)
3112 /* Reposition FD to OFFSET, based on WHENCE. This acts like lseek
3113 except that it also tests for OFFSET being out of lseek's range. */
3115 emacs_lseek (int fd
, EMACS_INT offset
, int whence
)
3117 /* Use "&" rather than "&&" to suppress a bogus GCC warning; see
3118 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43772>. */
3119 if (! ((TYPE_MINIMUM (off_t
) <= offset
) & (offset
<= TYPE_MAXIMUM (off_t
))))
3124 return lseek (fd
, offset
, whence
);
3128 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3130 doc
: /* Insert contents of file FILENAME after point.
3131 Returns list of absolute file name and number of characters inserted.
3132 If second argument VISIT is non-nil, the buffer's visited filename and
3133 last save file modtime are set, and it is marked unmodified. If
3134 visiting and the file does not exist, visiting is completed before the
3137 The optional third and fourth arguments BEG and END specify what portion
3138 of the file to insert. These arguments count bytes in the file, not
3139 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3141 If optional fifth argument REPLACE is non-nil, replace the current
3142 buffer contents (in the accessible portion) with the file contents.
3143 This is better than simply deleting and inserting the whole thing
3144 because (1) it preserves some marker positions and (2) it puts less data
3145 in the undo list. When REPLACE is non-nil, the second return value is
3146 the number of characters that replace previous buffer contents.
3148 This function does code conversion according to the value of
3149 `coding-system-for-read' or `file-coding-system-alist', and sets the
3150 variable `last-coding-system-used' to the coding system actually used. */)
3151 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3155 EMACS_INT inserted
= 0;
3157 register EMACS_INT how_much
;
3158 register EMACS_INT unprocessed
;
3159 int count
= SPECPDL_INDEX ();
3160 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3161 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3163 EMACS_INT total
= 0;
3164 int not_regular
= 0;
3165 char read_buf
[READ_BUF_SIZE
];
3166 struct coding_system coding
;
3167 char buffer
[1 << 14];
3168 int replace_handled
= 0;
3169 int set_coding_system
= 0;
3170 Lisp_Object coding_system
;
3172 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3173 int we_locked_file
= 0;
3174 int deferred_remove_unwind_protect
= 0;
3176 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3177 error ("Cannot do file visiting in an indirect buffer");
3179 if (!NILP (BVAR (current_buffer
, read_only
)))
3180 Fbarf_if_buffer_read_only ();
3184 orig_filename
= Qnil
;
3187 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3189 CHECK_STRING (filename
);
3190 filename
= Fexpand_file_name (filename
, Qnil
);
3192 /* The value Qnil means that the coding system is not yet
3194 coding_system
= Qnil
;
3196 /* If the file name has special constructs in it,
3197 call the corresponding file handler. */
3198 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3199 if (!NILP (handler
))
3201 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3202 visit
, beg
, end
, replace
);
3203 if (CONSP (val
) && CONSP (XCDR (val
)))
3204 inserted
= XINT (XCAR (XCDR (val
)));
3208 orig_filename
= filename
;
3209 filename
= ENCODE_FILE (filename
);
3215 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3217 /* Tell stat to use expensive method to get accurate info. */
3218 Vw32_get_true_file_attributes
= Qt
;
3219 total
= stat (SSDATA (filename
), &st
);
3220 Vw32_get_true_file_attributes
= tem
;
3224 if (stat (SSDATA (filename
), &st
) < 0)
3225 #endif /* WINDOWSNT */
3229 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3232 if (!NILP (Vcoding_system_for_read
))
3233 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3237 /* This code will need to be changed in order to work on named
3238 pipes, and it's probably just not worth it. So we should at
3239 least signal an error. */
3240 if (!S_ISREG (st
.st_mode
))
3247 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3248 xsignal2 (Qfile_error
,
3249 build_string ("not a regular file"), orig_filename
);
3253 if ((fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0)) < 0)
3256 /* Replacement should preserve point as it preserves markers. */
3257 if (!NILP (replace
))
3258 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3260 record_unwind_protect (close_file_unwind
, make_number (fd
));
3263 /* Check whether the size is too large or negative, which can happen on a
3264 platform that allows file sizes greater than the maximum off_t value. */
3266 && ! (0 <= st
.st_size
&& st
.st_size
<= BUF_BYTES_MAX
))
3267 error ("Maximum buffer size exceeded");
3269 /* Prevent redisplay optimizations. */
3270 current_buffer
->clip_changed
= 1;
3274 if (!NILP (beg
) || !NILP (end
))
3275 error ("Attempt to visit less than an entire file");
3276 if (BEG
< Z
&& NILP (replace
))
3277 error ("Cannot do file visiting in a non-empty buffer");
3283 XSETFASTINT (beg
, 0);
3291 XSETINT (end
, st
.st_size
);
3293 /* The file size returned from stat may be zero, but data
3294 may be readable nonetheless, for example when this is a
3295 file in the /proc filesystem. */
3296 if (st
.st_size
== 0)
3297 XSETINT (end
, READ_BUF_SIZE
);
3301 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3303 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3304 setup_coding_system (coding_system
, &coding
);
3305 /* Ensure we set Vlast_coding_system_used. */
3306 set_coding_system
= 1;
3310 /* Decide the coding system to use for reading the file now
3311 because we can't use an optimized method for handling
3312 `coding:' tag if the current buffer is not empty. */
3313 if (!NILP (Vcoding_system_for_read
))
3314 coding_system
= Vcoding_system_for_read
;
3317 /* Don't try looking inside a file for a coding system
3318 specification if it is not seekable. */
3319 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3321 /* Find a coding system specified in the heading two
3322 lines or in the tailing several lines of the file.
3323 We assume that the 1K-byte and 3K-byte for heading
3324 and tailing respectively are sufficient for this
3328 if (st
.st_size
<= (1024 * 4))
3329 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3332 nread
= emacs_read (fd
, read_buf
, 1024);
3335 if (lseek (fd
, st
.st_size
- (1024 * 3), SEEK_SET
) < 0)
3336 report_file_error ("Setting file position",
3337 Fcons (orig_filename
, Qnil
));
3338 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3343 error ("IO error reading %s: %s",
3344 SDATA (orig_filename
), emacs_strerror (errno
));
3347 struct buffer
*prev
= current_buffer
;
3348 Lisp_Object workbuf
;
3351 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3353 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3354 buf
= XBUFFER (workbuf
);
3356 delete_all_overlays (buf
);
3357 BVAR (buf
, directory
) = BVAR (current_buffer
, directory
);
3358 BVAR (buf
, read_only
) = Qnil
;
3359 BVAR (buf
, filename
) = Qnil
;
3360 BVAR (buf
, undo_list
) = Qt
;
3361 eassert (buf
->overlays_before
== NULL
);
3362 eassert (buf
->overlays_after
== NULL
);
3364 set_buffer_internal (buf
);
3366 BVAR (buf
, enable_multibyte_characters
) = Qnil
;
3368 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3369 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3370 coding_system
= call2 (Vset_auto_coding_function
,
3371 filename
, make_number (nread
));
3372 set_buffer_internal (prev
);
3374 /* Discard the unwind protect for recovering the
3378 /* Rewind the file for the actual read done later. */
3379 if (lseek (fd
, 0, SEEK_SET
) < 0)
3380 report_file_error ("Setting file position",
3381 Fcons (orig_filename
, Qnil
));
3385 if (NILP (coding_system
))
3387 /* If we have not yet decided a coding system, check
3388 file-coding-system-alist. */
3389 Lisp_Object args
[6];
3391 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3392 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3393 coding_system
= Ffind_operation_coding_system (6, args
);
3394 if (CONSP (coding_system
))
3395 coding_system
= XCAR (coding_system
);
3399 if (NILP (coding_system
))
3400 coding_system
= Qundecided
;
3402 CHECK_CODING_SYSTEM (coding_system
);
3404 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3405 /* We must suppress all character code conversion except for
3406 end-of-line conversion. */
3407 coding_system
= raw_text_coding_system (coding_system
);
3409 setup_coding_system (coding_system
, &coding
);
3410 /* Ensure we set Vlast_coding_system_used. */
3411 set_coding_system
= 1;
3414 /* If requested, replace the accessible part of the buffer
3415 with the file contents. Avoid replacing text at the
3416 beginning or end of the buffer that matches the file contents;
3417 that preserves markers pointing to the unchanged parts.
3419 Here we implement this feature in an optimized way
3420 for the case where code conversion is NOT needed.
3421 The following if-statement handles the case of conversion
3422 in a less optimal way.
3424 If the code conversion is "automatic" then we try using this
3425 method and hope for the best.
3426 But if we discover the need for conversion, we give up on this method
3427 and let the following if-statement handle the replace job. */
3430 && (NILP (coding_system
)
3431 || ! CODING_REQUIRE_DECODING (&coding
)))
3433 /* same_at_start and same_at_end count bytes,
3434 because file access counts bytes
3435 and BEG and END count bytes. */
3436 EMACS_INT same_at_start
= BEGV_BYTE
;
3437 EMACS_INT same_at_end
= ZV_BYTE
;
3439 /* There is still a possibility we will find the need to do code
3440 conversion. If that happens, we set this variable to 1 to
3441 give up on handling REPLACE in the optimized way. */
3442 int giveup_match_end
= 0;
3444 if (XINT (beg
) != 0)
3446 if (emacs_lseek (fd
, XINT (beg
), SEEK_SET
) < 0)
3447 report_file_error ("Setting file position",
3448 Fcons (orig_filename
, Qnil
));
3453 /* Count how many chars at the start of the file
3454 match the text at the beginning of the buffer. */
3457 EMACS_INT nread
, bufpos
;
3459 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3461 error ("IO error reading %s: %s",
3462 SSDATA (orig_filename
), emacs_strerror (errno
));
3463 else if (nread
== 0)
3466 if (CODING_REQUIRE_DETECTION (&coding
))
3468 coding_system
= detect_coding_system ((unsigned char *) buffer
,
3471 setup_coding_system (coding_system
, &coding
);
3474 if (CODING_REQUIRE_DECODING (&coding
))
3475 /* We found that the file should be decoded somehow.
3476 Let's give up here. */
3478 giveup_match_end
= 1;
3483 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3484 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3485 same_at_start
++, bufpos
++;
3486 /* If we found a discrepancy, stop the scan.
3487 Otherwise loop around and scan the next bufferful. */
3488 if (bufpos
!= nread
)
3492 /* If the file matches the buffer completely,
3493 there's no need to replace anything. */
3494 if (same_at_start
- BEGV_BYTE
== XINT (end
))
3498 /* Truncate the buffer to the size of the file. */
3499 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3504 /* Count how many chars at the end of the file
3505 match the text at the end of the buffer. But, if we have
3506 already found that decoding is necessary, don't waste time. */
3507 while (!giveup_match_end
)
3509 EMACS_INT total_read
, nread
, bufpos
, curpos
, trial
;
3511 /* At what file position are we now scanning? */
3512 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
3513 /* If the entire file matches the buffer tail, stop the scan. */
3516 /* How much can we scan in the next step? */
3517 trial
= min (curpos
, sizeof buffer
);
3518 if (emacs_lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3519 report_file_error ("Setting file position",
3520 Fcons (orig_filename
, Qnil
));
3522 total_read
= nread
= 0;
3523 while (total_read
< trial
)
3525 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3527 error ("IO error reading %s: %s",
3528 SDATA (orig_filename
), emacs_strerror (errno
));
3529 else if (nread
== 0)
3531 total_read
+= nread
;
3534 /* Scan this bufferful from the end, comparing with
3535 the Emacs buffer. */
3536 bufpos
= total_read
;
3538 /* Compare with same_at_start to avoid counting some buffer text
3539 as matching both at the file's beginning and at the end. */
3540 while (bufpos
> 0 && same_at_end
> same_at_start
3541 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3542 same_at_end
--, bufpos
--;
3544 /* If we found a discrepancy, stop the scan.
3545 Otherwise loop around and scan the preceding bufferful. */
3548 /* If this discrepancy is because of code conversion,
3549 we cannot use this method; giveup and try the other. */
3550 if (same_at_end
> same_at_start
3551 && FETCH_BYTE (same_at_end
- 1) >= 0200
3552 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3553 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3554 giveup_match_end
= 1;
3563 if (! giveup_match_end
)
3567 /* We win! We can handle REPLACE the optimized way. */
3569 /* Extend the start of non-matching text area to multibyte
3570 character boundary. */
3571 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3572 while (same_at_start
> BEGV_BYTE
3573 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3576 /* Extend the end of non-matching text area to multibyte
3577 character boundary. */
3578 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3579 while (same_at_end
< ZV_BYTE
3580 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3583 /* Don't try to reuse the same piece of text twice. */
3584 overlap
= (same_at_start
- BEGV_BYTE
3585 - (same_at_end
+ st
.st_size
- ZV
));
3587 same_at_end
+= overlap
;
3589 /* Arrange to read only the nonmatching middle part of the file. */
3590 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
3591 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
3593 del_range_byte (same_at_start
, same_at_end
, 0);
3594 /* Insert from the file at the proper position. */
3595 temp
= BYTE_TO_CHAR (same_at_start
);
3596 SET_PT_BOTH (temp
, same_at_start
);
3598 /* If display currently starts at beginning of line,
3599 keep it that way. */
3600 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3601 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3603 replace_handled
= 1;
3607 /* If requested, replace the accessible part of the buffer
3608 with the file contents. Avoid replacing text at the
3609 beginning or end of the buffer that matches the file contents;
3610 that preserves markers pointing to the unchanged parts.
3612 Here we implement this feature for the case where code conversion
3613 is needed, in a simple way that needs a lot of memory.
3614 The preceding if-statement handles the case of no conversion
3615 in a more optimized way. */
3616 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3618 EMACS_INT same_at_start
= BEGV_BYTE
;
3619 EMACS_INT same_at_end
= ZV_BYTE
;
3620 EMACS_INT same_at_start_charpos
;
3621 EMACS_INT inserted_chars
;
3624 unsigned char *decoded
;
3627 int this_count
= SPECPDL_INDEX ();
3628 int multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3629 Lisp_Object conversion_buffer
;
3631 conversion_buffer
= code_conversion_save (1, multibyte
);
3633 /* First read the whole file, performing code conversion into
3634 CONVERSION_BUFFER. */
3636 if (emacs_lseek (fd
, XINT (beg
), SEEK_SET
) < 0)
3637 report_file_error ("Setting file position",
3638 Fcons (orig_filename
, Qnil
));
3640 total
= st
.st_size
; /* Total bytes in the file. */
3641 how_much
= 0; /* Bytes read from file so far. */
3642 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3643 unprocessed
= 0; /* Bytes not processed in previous loop. */
3645 GCPRO1 (conversion_buffer
);
3646 while (how_much
< total
)
3648 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3649 quitting while reading a huge while. */
3650 /* try is reserved in some compilers (Microsoft C) */
3651 EMACS_INT trytry
= min (total
- how_much
,
3652 READ_BUF_SIZE
- unprocessed
);
3654 /* Allow quitting out of the actual I/O. */
3657 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3665 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3666 BUF_Z (XBUFFER (conversion_buffer
)));
3667 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3668 unprocessed
+ this, conversion_buffer
);
3669 unprocessed
= coding
.carryover_bytes
;
3670 if (coding
.carryover_bytes
> 0)
3671 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3676 /* We should remove the unwind_protect calling
3677 close_file_unwind, but other stuff has been added the stack,
3678 so defer the removal till we reach the `handled' label. */
3679 deferred_remove_unwind_protect
= 1;
3681 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3682 if we couldn't read the file. */
3685 error ("IO error reading %s: %s",
3686 SDATA (orig_filename
), emacs_strerror (errno
));
3688 if (unprocessed
> 0)
3690 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3691 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3692 unprocessed
, conversion_buffer
);
3693 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3696 coding_system
= CODING_ID_NAME (coding
.id
);
3697 set_coding_system
= 1;
3698 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3699 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3700 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3702 /* Compare the beginning of the converted string with the buffer
3706 while (bufpos
< inserted
&& same_at_start
< same_at_end
3707 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3708 same_at_start
++, bufpos
++;
3710 /* If the file matches the head of buffer completely,
3711 there's no need to replace anything. */
3713 if (bufpos
== inserted
)
3715 /* Truncate the buffer to the size of the file. */
3716 if (same_at_start
== same_at_end
)
3719 del_range_byte (same_at_start
, same_at_end
, 0);
3722 unbind_to (this_count
, Qnil
);
3726 /* Extend the start of non-matching text area to the previous
3727 multibyte character boundary. */
3728 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3729 while (same_at_start
> BEGV_BYTE
3730 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3733 /* Scan this bufferful from the end, comparing with
3734 the Emacs buffer. */
3737 /* Compare with same_at_start to avoid counting some buffer text
3738 as matching both at the file's beginning and at the end. */
3739 while (bufpos
> 0 && same_at_end
> same_at_start
3740 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3741 same_at_end
--, bufpos
--;
3743 /* Extend the end of non-matching text area to the next
3744 multibyte character boundary. */
3745 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3746 while (same_at_end
< ZV_BYTE
3747 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3750 /* Don't try to reuse the same piece of text twice. */
3751 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3753 same_at_end
+= overlap
;
3755 /* If display currently starts at beginning of line,
3756 keep it that way. */
3757 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3758 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3760 /* Replace the chars that we need to replace,
3761 and update INSERTED to equal the number of bytes
3762 we are taking from the decoded string. */
3763 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3765 if (same_at_end
!= same_at_start
)
3767 del_range_byte (same_at_start
, same_at_end
, 0);
3769 same_at_start
= GPT_BYTE
;
3773 temp
= BYTE_TO_CHAR (same_at_start
);
3775 /* Insert from the file at the proper position. */
3776 SET_PT_BOTH (temp
, same_at_start
);
3777 same_at_start_charpos
3778 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3779 same_at_start
- BEGV_BYTE
3780 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3782 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3783 same_at_start
+ inserted
- BEGV_BYTE
3784 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3785 - same_at_start_charpos
);
3786 /* This binding is to avoid ask-user-about-supersession-threat
3787 being called in insert_from_buffer (via in
3788 prepare_to_modify_buffer). */
3789 specbind (intern ("buffer-file-name"), Qnil
);
3790 insert_from_buffer (XBUFFER (conversion_buffer
),
3791 same_at_start_charpos
, inserted_chars
, 0);
3792 /* Set `inserted' to the number of inserted characters. */
3793 inserted
= PT
- temp
;
3794 /* Set point before the inserted characters. */
3795 SET_PT_BOTH (temp
, same_at_start
);
3797 unbind_to (this_count
, Qnil
);
3804 register Lisp_Object temp
;
3806 total
= XINT (end
) - XINT (beg
);
3808 /* Make sure point-max won't overflow after this insertion. */
3809 XSETINT (temp
, total
);
3810 if (total
!= XINT (temp
))
3811 error ("Maximum buffer size exceeded");
3814 /* For a special file, all we can do is guess. */
3815 total
= READ_BUF_SIZE
;
3817 if (NILP (visit
) && total
> 0)
3819 #ifdef CLASH_DETECTION
3820 if (!NILP (BVAR (current_buffer
, file_truename
))
3821 /* Make binding buffer-file-name to nil effective. */
3822 && !NILP (BVAR (current_buffer
, filename
))
3823 && SAVE_MODIFF
>= MODIFF
)
3825 #endif /* CLASH_DETECTION */
3826 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3830 if (GAP_SIZE
< total
)
3831 make_gap (total
- GAP_SIZE
);
3833 if (XINT (beg
) != 0 || !NILP (replace
))
3835 if (emacs_lseek (fd
, XINT (beg
), SEEK_SET
) < 0)
3836 report_file_error ("Setting file position",
3837 Fcons (orig_filename
, Qnil
));
3840 /* In the following loop, HOW_MUCH contains the total bytes read so
3841 far for a regular file, and not changed for a special file. But,
3842 before exiting the loop, it is set to a negative value if I/O
3846 /* Total bytes inserted. */
3849 /* Here, we don't do code conversion in the loop. It is done by
3850 decode_coding_gap after all data are read into the buffer. */
3852 EMACS_INT gap_size
= GAP_SIZE
;
3854 while (how_much
< total
)
3856 /* try is reserved in some compilers (Microsoft C) */
3857 EMACS_INT trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3864 /* Maybe make more room. */
3865 if (gap_size
< trytry
)
3867 make_gap (total
- gap_size
);
3868 gap_size
= GAP_SIZE
;
3871 /* Read from the file, capturing `quit'. When an
3872 error occurs, end the loop, and arrange for a quit
3873 to be signaled after decoding the text we read. */
3874 non_regular_fd
= fd
;
3875 non_regular_inserted
= inserted
;
3876 non_regular_nbytes
= trytry
;
3877 nbytes
= internal_condition_case_1 (read_non_regular
,
3879 read_non_regular_quit
);
3886 this = XINT (nbytes
);
3890 /* Allow quitting out of the actual I/O. We don't make text
3891 part of the buffer until all the reading is done, so a C-g
3892 here doesn't do any harm. */
3895 this = emacs_read (fd
,
3896 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3910 /* For a regular file, where TOTAL is the real size,
3911 count HOW_MUCH to compare with it.
3912 For a special file, where TOTAL is just a buffer size,
3913 so don't bother counting in HOW_MUCH.
3914 (INSERTED is where we count the number of characters inserted.) */
3921 /* Now we have read all the file data into the gap.
3922 If it was empty, undo marking the buffer modified. */
3926 #ifdef CLASH_DETECTION
3928 unlock_file (BVAR (current_buffer
, file_truename
));
3930 Vdeactivate_mark
= old_Vdeactivate_mark
;
3933 Vdeactivate_mark
= Qt
;
3935 /* Make the text read part of the buffer. */
3936 GAP_SIZE
-= inserted
;
3938 GPT_BYTE
+= inserted
;
3940 ZV_BYTE
+= inserted
;
3945 /* Put an anchor to ensure multi-byte form ends at gap. */
3950 /* Discard the unwind protect for closing the file. */
3954 error ("IO error reading %s: %s",
3955 SDATA (orig_filename
), emacs_strerror (errno
));
3959 if (NILP (coding_system
))
3961 /* The coding system is not yet decided. Decide it by an
3962 optimized method for handling `coding:' tag.
3964 Note that we can get here only if the buffer was empty
3965 before the insertion. */
3967 if (!NILP (Vcoding_system_for_read
))
3968 coding_system
= Vcoding_system_for_read
;
3971 /* Since we are sure that the current buffer was empty
3972 before the insertion, we can toggle
3973 enable-multibyte-characters directly here without taking
3974 care of marker adjustment. By this way, we can run Lisp
3975 program safely before decoding the inserted text. */
3976 Lisp_Object unwind_data
;
3977 int count1
= SPECPDL_INDEX ();
3979 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
3980 Fcons (BVAR (current_buffer
, undo_list
),
3981 Fcurrent_buffer ()));
3982 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
3983 BVAR (current_buffer
, undo_list
) = Qt
;
3984 record_unwind_protect (decide_coding_unwind
, unwind_data
);
3986 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
3988 coding_system
= call2 (Vset_auto_coding_function
,
3989 filename
, make_number (inserted
));
3992 if (NILP (coding_system
))
3994 /* If the coding system is not yet decided, check
3995 file-coding-system-alist. */
3996 Lisp_Object args
[6];
3998 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3999 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4000 coding_system
= Ffind_operation_coding_system (6, args
);
4001 if (CONSP (coding_system
))
4002 coding_system
= XCAR (coding_system
);
4004 unbind_to (count1
, Qnil
);
4005 inserted
= Z_BYTE
- BEG_BYTE
;
4008 if (NILP (coding_system
))
4009 coding_system
= Qundecided
;
4011 CHECK_CODING_SYSTEM (coding_system
);
4013 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4014 /* We must suppress all character code conversion except for
4015 end-of-line conversion. */
4016 coding_system
= raw_text_coding_system (coding_system
);
4017 setup_coding_system (coding_system
, &coding
);
4018 /* Ensure we set Vlast_coding_system_used. */
4019 set_coding_system
= 1;
4024 /* When we visit a file by raw-text, we change the buffer to
4026 if (CODING_FOR_UNIBYTE (&coding
)
4027 /* Can't do this if part of the buffer might be preserved. */
4029 /* Visiting a file with these coding system makes the buffer
4031 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
4034 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4035 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4036 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4038 move_gap_both (PT
, PT_BYTE
);
4039 GAP_SIZE
+= inserted
;
4040 ZV_BYTE
-= inserted
;
4044 decode_coding_gap (&coding
, inserted
, inserted
);
4045 inserted
= coding
.produced_char
;
4046 coding_system
= CODING_ID_NAME (coding
.id
);
4048 else if (inserted
> 0)
4049 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4052 /* Now INSERTED is measured in characters. */
4056 if (deferred_remove_unwind_protect
)
4057 /* If requested above, discard the unwind protect for closing the
4063 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4064 BVAR (current_buffer
, undo_list
) = Qnil
;
4068 current_buffer
->modtime
= st
.st_mtime
;
4069 current_buffer
->modtime_size
= st
.st_size
;
4070 BVAR (current_buffer
, filename
) = orig_filename
;
4073 SAVE_MODIFF
= MODIFF
;
4074 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4075 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4076 #ifdef CLASH_DETECTION
4079 if (!NILP (BVAR (current_buffer
, file_truename
)))
4080 unlock_file (BVAR (current_buffer
, file_truename
));
4081 unlock_file (filename
);
4083 #endif /* CLASH_DETECTION */
4085 xsignal2 (Qfile_error
,
4086 build_string ("not a regular file"), orig_filename
);
4089 if (set_coding_system
)
4090 Vlast_coding_system_used
= coding_system
;
4092 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4094 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4096 if (! NILP (insval
))
4098 CHECK_NUMBER (insval
);
4099 inserted
= XFASTINT (insval
);
4103 /* Decode file format. */
4106 /* Don't run point motion or modification hooks when decoding. */
4107 int count1
= SPECPDL_INDEX ();
4108 EMACS_INT old_inserted
= inserted
;
4109 specbind (Qinhibit_point_motion_hooks
, Qt
);
4110 specbind (Qinhibit_modification_hooks
, Qt
);
4112 /* Save old undo list and don't record undo for decoding. */
4113 old_undo
= BVAR (current_buffer
, undo_list
);
4114 BVAR (current_buffer
, undo_list
) = Qt
;
4118 insval
= call3 (Qformat_decode
,
4119 Qnil
, make_number (inserted
), visit
);
4120 CHECK_NUMBER (insval
);
4121 inserted
= XFASTINT (insval
);
4125 /* If REPLACE is non-nil and we succeeded in not replacing the
4126 beginning or end of the buffer text with the file's contents,
4127 call format-decode with `point' positioned at the beginning
4128 of the buffer and `inserted' equalling the number of
4129 characters in the buffer. Otherwise, format-decode might
4130 fail to correctly analyze the beginning or end of the buffer.
4131 Hence we temporarily save `point' and `inserted' here and
4132 restore `point' iff format-decode did not insert or delete
4133 any text. Otherwise we leave `point' at point-min. */
4134 EMACS_INT opoint
= PT
;
4135 EMACS_INT opoint_byte
= PT_BYTE
;
4136 EMACS_INT oinserted
= ZV
- BEGV
;
4137 int ochars_modiff
= CHARS_MODIFF
;
4139 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4140 insval
= call3 (Qformat_decode
,
4141 Qnil
, make_number (oinserted
), visit
);
4142 CHECK_NUMBER (insval
);
4143 if (ochars_modiff
== CHARS_MODIFF
)
4144 /* format_decode didn't modify buffer's characters => move
4145 point back to position before inserted text and leave
4146 value of inserted alone. */
4147 SET_PT_BOTH (opoint
, opoint_byte
);
4149 /* format_decode modified buffer's characters => consider
4150 entire buffer changed and leave point at point-min. */
4151 inserted
= XFASTINT (insval
);
4154 /* For consistency with format-decode call these now iff inserted > 0
4155 (martin 2007-06-28). */
4156 p
= Vafter_insert_file_functions
;
4161 insval
= call1 (XCAR (p
), make_number (inserted
));
4164 CHECK_NUMBER (insval
);
4165 inserted
= XFASTINT (insval
);
4170 /* For the rationale of this see the comment on
4171 format-decode above. */
4172 EMACS_INT opoint
= PT
;
4173 EMACS_INT opoint_byte
= PT_BYTE
;
4174 EMACS_INT oinserted
= ZV
- BEGV
;
4175 int ochars_modiff
= CHARS_MODIFF
;
4177 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4178 insval
= call1 (XCAR (p
), make_number (oinserted
));
4181 CHECK_NUMBER (insval
);
4182 if (ochars_modiff
== CHARS_MODIFF
)
4183 /* after_insert_file_functions didn't modify
4184 buffer's characters => move point back to
4185 position before inserted text and leave value of
4187 SET_PT_BOTH (opoint
, opoint_byte
);
4189 /* after_insert_file_functions did modify buffer's
4190 characters => consider entire buffer changed and
4191 leave point at point-min. */
4192 inserted
= XFASTINT (insval
);
4202 BVAR (current_buffer
, undo_list
) = old_undo
;
4203 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4205 /* Adjust the last undo record for the size change during
4206 the format conversion. */
4207 Lisp_Object tem
= XCAR (old_undo
);
4208 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4209 && INTEGERP (XCDR (tem
))
4210 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4211 XSETCDR (tem
, make_number (PT
+ inserted
));
4215 /* If undo_list was Qt before, keep it that way.
4216 Otherwise start with an empty undo_list. */
4217 BVAR (current_buffer
, undo_list
) = EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4219 unbind_to (count1
, Qnil
);
4222 /* Call after-change hooks for the inserted text, aside from the case
4223 of normal visiting (not with REPLACE), which is done in a new buffer
4224 "before" the buffer is changed. */
4225 if (inserted
> 0 && total
> 0
4226 && (NILP (visit
) || !NILP (replace
)))
4228 signal_after_change (PT
, 0, inserted
);
4229 update_compositions (PT
, PT
, CHECK_BORDER
);
4233 && current_buffer
->modtime
== -1)
4235 /* If visiting nonexistent file, return nil. */
4236 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4240 Fsignal (Qquit
, Qnil
);
4242 /* ??? Retval needs to be dealt with in all cases consistently. */
4244 val
= Fcons (orig_filename
,
4245 Fcons (make_number (inserted
),
4248 RETURN_UNGCPRO (unbind_to (count
, val
));
4251 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4254 build_annotations_unwind (Lisp_Object arg
)
4256 Vwrite_region_annotation_buffers
= arg
;
4260 /* Decide the coding-system to encode the data with. */
4263 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4264 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4265 struct coding_system
*coding
)
4268 Lisp_Object eol_parent
= Qnil
;
4271 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4272 BVAR (current_buffer
, auto_save_file_name
))))
4277 else if (!NILP (Vcoding_system_for_write
))
4279 val
= Vcoding_system_for_write
;
4280 if (coding_system_require_warning
4281 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4282 /* Confirm that VAL can surely encode the current region. */
4283 val
= call5 (Vselect_safe_coding_system_function
,
4284 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4289 /* If the variable `buffer-file-coding-system' is set locally,
4290 it means that the file was read with some kind of code
4291 conversion or the variable is explicitly set by users. We
4292 had better write it out with the same coding system even if
4293 `enable-multibyte-characters' is nil.
4295 If it is not set locally, we anyway have to convert EOL
4296 format if the default value of `buffer-file-coding-system'
4297 tells that it is not Unix-like (LF only) format. */
4298 int using_default_coding
= 0;
4299 int force_raw_text
= 0;
4301 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4303 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4306 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4312 /* Check file-coding-system-alist. */
4313 Lisp_Object args
[7], coding_systems
;
4315 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4316 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4318 coding_systems
= Ffind_operation_coding_system (7, args
);
4319 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4320 val
= XCDR (coding_systems
);
4325 /* If we still have not decided a coding system, use the
4326 default value of buffer-file-coding-system. */
4327 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4328 using_default_coding
= 1;
4331 if (! NILP (val
) && ! force_raw_text
)
4333 Lisp_Object spec
, attrs
;
4335 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4336 attrs
= AREF (spec
, 0);
4337 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4342 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4343 /* Confirm that VAL can surely encode the current region. */
4344 val
= call5 (Vselect_safe_coding_system_function
,
4345 start
, end
, val
, Qnil
, filename
);
4347 /* If the decided coding-system doesn't specify end-of-line
4348 format, we use that of
4349 `default-buffer-file-coding-system'. */
4350 if (! using_default_coding
4351 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4352 val
= (coding_inherit_eol_type
4353 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4355 /* If we decide not to encode text, use `raw-text' or one of its
4358 val
= raw_text_coding_system (val
);
4361 val
= coding_inherit_eol_type (val
, eol_parent
);
4362 setup_coding_system (val
, coding
);
4364 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4365 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4369 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4370 "r\nFWrite region to file: \ni\ni\ni\np",
4371 doc
: /* Write current region into specified file.
4372 When called from a program, requires three arguments:
4373 START, END and FILENAME. START and END are normally buffer positions
4374 specifying the part of the buffer to write.
4375 If START is nil, that means to use the entire buffer contents.
4376 If START is a string, then output that string to the file
4377 instead of any buffer contents; END is ignored.
4379 Optional fourth argument APPEND if non-nil means
4380 append to existing file contents (if any). If it is an integer,
4381 seek to that offset in the file before writing.
4382 Optional fifth argument VISIT, if t or a string, means
4383 set the last-save-file-modtime of buffer to this file's modtime
4384 and mark buffer not modified.
4385 If VISIT is a string, it is a second file name;
4386 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4387 VISIT is also the file name to lock and unlock for clash detection.
4388 If VISIT is neither t nor nil nor a string,
4389 that means do not display the \"Wrote file\" message.
4390 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4391 use for locking and unlocking, overriding FILENAME and VISIT.
4392 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4393 for an existing file with the same name. If MUSTBENEW is `excl',
4394 that means to get an error if the file already exists; never overwrite.
4395 If MUSTBENEW is neither nil nor `excl', that means ask for
4396 confirmation before overwriting, but do go ahead and overwrite the file
4397 if the user confirms.
4399 This does code conversion according to the value of
4400 `coding-system-for-write', `buffer-file-coding-system', or
4401 `file-coding-system-alist', and sets the variable
4402 `last-coding-system-used' to the coding system actually used.
4404 This calls `write-region-annotate-functions' at the start, and
4405 `write-region-post-annotation-function' at the end. */)
4406 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4413 int count
= SPECPDL_INDEX ();
4415 Lisp_Object handler
;
4416 Lisp_Object visit_file
;
4417 Lisp_Object annotations
;
4418 Lisp_Object encoded_filename
;
4419 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4420 int quietly
= !NILP (visit
);
4421 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4422 struct buffer
*given_buffer
;
4423 struct coding_system coding
;
4425 if (current_buffer
->base_buffer
&& visiting
)
4426 error ("Cannot do file visiting in an indirect buffer");
4428 if (!NILP (start
) && !STRINGP (start
))
4429 validate_region (&start
, &end
);
4432 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4434 filename
= Fexpand_file_name (filename
, Qnil
);
4436 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4437 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4439 if (STRINGP (visit
))
4440 visit_file
= Fexpand_file_name (visit
, Qnil
);
4442 visit_file
= filename
;
4444 if (NILP (lockname
))
4445 lockname
= visit_file
;
4449 /* If the file name has special constructs in it,
4450 call the corresponding file handler. */
4451 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4452 /* If FILENAME has no handler, see if VISIT has one. */
4453 if (NILP (handler
) && STRINGP (visit
))
4454 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4456 if (!NILP (handler
))
4459 val
= call6 (handler
, Qwrite_region
, start
, end
,
4460 filename
, append
, visit
);
4464 SAVE_MODIFF
= MODIFF
;
4465 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4466 BVAR (current_buffer
, filename
) = visit_file
;
4472 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4474 /* Special kludge to simplify auto-saving. */
4477 /* Do it later, so write-region-annotate-function can work differently
4478 if we save "the buffer" vs "a region".
4479 This is useful in tar-mode. --Stef
4480 XSETFASTINT (start, BEG);
4481 XSETFASTINT (end, Z); */
4485 record_unwind_protect (build_annotations_unwind
,
4486 Vwrite_region_annotation_buffers
);
4487 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4488 count1
= SPECPDL_INDEX ();
4490 given_buffer
= current_buffer
;
4492 if (!STRINGP (start
))
4494 annotations
= build_annotations (start
, end
);
4496 if (current_buffer
!= given_buffer
)
4498 XSETFASTINT (start
, BEGV
);
4499 XSETFASTINT (end
, ZV
);
4505 XSETFASTINT (start
, BEGV
);
4506 XSETFASTINT (end
, ZV
);
4511 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4513 /* Decide the coding-system to encode the data with.
4514 We used to make this choice before calling build_annotations, but that
4515 leads to problems when a write-annotate-function takes care of
4516 unsavable chars (as was the case with X-Symbol). */
4517 Vlast_coding_system_used
4518 = choose_write_coding_system (start
, end
, filename
,
4519 append
, visit
, lockname
, &coding
);
4521 #ifdef CLASH_DETECTION
4523 lock_file (lockname
);
4524 #endif /* CLASH_DETECTION */
4526 encoded_filename
= ENCODE_FILE (filename
);
4528 fn
= SSDATA (encoded_filename
);
4532 desc
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4533 #else /* not DOS_NT */
4534 desc
= emacs_open (fn
, O_WRONLY
, 0);
4535 #endif /* not DOS_NT */
4537 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4539 desc
= emacs_open (fn
,
4540 O_WRONLY
| O_CREAT
| O_BINARY
4541 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4542 S_IREAD
| S_IWRITE
);
4543 #else /* not DOS_NT */
4544 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4545 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4546 auto_saving
? auto_save_mode_bits
: 0666);
4547 #endif /* not DOS_NT */
4551 #ifdef CLASH_DETECTION
4553 if (!auto_saving
) unlock_file (lockname
);
4555 #endif /* CLASH_DETECTION */
4557 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4560 record_unwind_protect (close_file_unwind
, make_number (desc
));
4562 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4566 if (NUMBERP (append
))
4567 ret
= emacs_lseek (desc
, XINT (append
), SEEK_CUR
);
4569 ret
= lseek (desc
, 0, SEEK_END
);
4572 #ifdef CLASH_DETECTION
4573 if (!auto_saving
) unlock_file (lockname
);
4574 #endif /* CLASH_DETECTION */
4576 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4585 if (STRINGP (start
))
4587 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4588 &annotations
, &coding
);
4591 else if (XINT (start
) != XINT (end
))
4593 failure
= 0 > a_write (desc
, Qnil
,
4594 XINT (start
), XINT (end
) - XINT (start
),
4595 &annotations
, &coding
);
4600 /* If file was empty, still need to write the annotations */
4601 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4602 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4606 if (CODING_REQUIRE_FLUSHING (&coding
)
4607 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4610 /* We have to flush out a data. */
4611 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4612 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4619 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4620 Disk full in NFS may be reported here. */
4621 /* mib says that closing the file will try to write as fast as NFS can do
4622 it, and that means the fsync here is not crucial for autosave files. */
4623 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4625 /* If fsync fails with EINTR, don't treat that as serious. Also
4626 ignore EINVAL which happens when fsync is not supported on this
4628 if (errno
!= EINTR
&& errno
!= EINVAL
)
4629 failure
= 1, save_errno
= errno
;
4633 /* NFS can report a write failure now. */
4634 if (emacs_close (desc
) < 0)
4635 failure
= 1, save_errno
= errno
;
4639 /* Discard the unwind protect for close_file_unwind. */
4640 specpdl_ptr
= specpdl
+ count1
;
4642 /* Call write-region-post-annotation-function. */
4643 while (CONSP (Vwrite_region_annotation_buffers
))
4645 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4646 if (!NILP (Fbuffer_live_p (buf
)))
4649 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4650 call0 (Vwrite_region_post_annotation_function
);
4652 Vwrite_region_annotation_buffers
4653 = XCDR (Vwrite_region_annotation_buffers
);
4656 unbind_to (count
, Qnil
);
4658 #ifdef CLASH_DETECTION
4660 unlock_file (lockname
);
4661 #endif /* CLASH_DETECTION */
4663 /* Do this before reporting IO error
4664 to avoid a "file has changed on disk" warning on
4665 next attempt to save. */
4668 current_buffer
->modtime
= st
.st_mtime
;
4669 current_buffer
->modtime_size
= st
.st_size
;
4673 error ("IO error writing %s: %s", SDATA (filename
),
4674 emacs_strerror (save_errno
));
4678 SAVE_MODIFF
= MODIFF
;
4679 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4680 BVAR (current_buffer
, filename
) = visit_file
;
4681 update_mode_lines
++;
4686 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4687 BVAR (current_buffer
, auto_save_file_name
))))
4688 SAVE_MODIFF
= MODIFF
;
4694 message_with_string ((INTEGERP (append
)
4704 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4706 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4707 doc
: /* Return t if (car A) is numerically less than (car B). */)
4708 (Lisp_Object a
, Lisp_Object b
)
4710 return Flss (Fcar (a
), Fcar (b
));
4713 /* Build the complete list of annotations appropriate for writing out
4714 the text between START and END, by calling all the functions in
4715 write-region-annotate-functions and merging the lists they return.
4716 If one of these functions switches to a different buffer, we assume
4717 that buffer contains altered text. Therefore, the caller must
4718 make sure to restore the current buffer in all cases,
4719 as save-excursion would do. */
4722 build_annotations (Lisp_Object start
, Lisp_Object end
)
4724 Lisp_Object annotations
;
4726 struct gcpro gcpro1
, gcpro2
;
4727 Lisp_Object original_buffer
;
4728 int i
, used_global
= 0;
4730 XSETBUFFER (original_buffer
, current_buffer
);
4733 p
= Vwrite_region_annotate_functions
;
4734 GCPRO2 (annotations
, p
);
4737 struct buffer
*given_buffer
= current_buffer
;
4738 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4739 { /* Use the global value of the hook. */
4742 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4744 p
= Fappend (2, arg
);
4747 Vwrite_region_annotations_so_far
= annotations
;
4748 res
= call2 (XCAR (p
), start
, end
);
4749 /* If the function makes a different buffer current,
4750 assume that means this buffer contains altered text to be output.
4751 Reset START and END from the buffer bounds
4752 and discard all previous annotations because they should have
4753 been dealt with by this function. */
4754 if (current_buffer
!= given_buffer
)
4756 Vwrite_region_annotation_buffers
4757 = Fcons (Fcurrent_buffer (),
4758 Vwrite_region_annotation_buffers
);
4759 XSETFASTINT (start
, BEGV
);
4760 XSETFASTINT (end
, ZV
);
4763 Flength (res
); /* Check basic validity of return value */
4764 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4768 /* Now do the same for annotation functions implied by the file-format */
4769 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
4770 p
= BVAR (current_buffer
, auto_save_file_format
);
4772 p
= BVAR (current_buffer
, file_format
);
4773 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4775 struct buffer
*given_buffer
= current_buffer
;
4777 Vwrite_region_annotations_so_far
= annotations
;
4779 /* Value is either a list of annotations or nil if the function
4780 has written annotations to a temporary buffer, which is now
4782 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4783 original_buffer
, make_number (i
));
4784 if (current_buffer
!= given_buffer
)
4786 XSETFASTINT (start
, BEGV
);
4787 XSETFASTINT (end
, ZV
);
4792 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4800 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4801 If STRING is nil, POS is the character position in the current buffer.
4802 Intersperse with them the annotations from *ANNOT
4803 which fall within the range of POS to POS + NCHARS,
4804 each at its appropriate position.
4806 We modify *ANNOT by discarding elements as we use them up.
4808 The return value is negative in case of system call failure. */
4811 a_write (int desc
, Lisp_Object string
, EMACS_INT pos
,
4812 register EMACS_INT nchars
, Lisp_Object
*annot
,
4813 struct coding_system
*coding
)
4817 EMACS_INT lastpos
= pos
+ nchars
;
4819 while (NILP (*annot
) || CONSP (*annot
))
4821 tem
= Fcar_safe (Fcar (*annot
));
4824 nextpos
= XFASTINT (tem
);
4826 /* If there are no more annotations in this range,
4827 output the rest of the range all at once. */
4828 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4829 return e_write (desc
, string
, pos
, lastpos
, coding
);
4831 /* Output buffer text up to the next annotation's position. */
4834 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4838 /* Output the annotation. */
4839 tem
= Fcdr (Fcar (*annot
));
4842 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4845 *annot
= Fcdr (*annot
);
4851 /* Write text in the range START and END into descriptor DESC,
4852 encoding them with coding system CODING. If STRING is nil, START
4853 and END are character positions of the current buffer, else they
4854 are indexes to the string STRING. */
4857 e_write (int desc
, Lisp_Object string
, EMACS_INT start
, EMACS_INT end
,
4858 struct coding_system
*coding
)
4860 if (STRINGP (string
))
4863 end
= SCHARS (string
);
4866 /* We used to have a code for handling selective display here. But,
4867 now it is handled within encode_coding. */
4871 if (STRINGP (string
))
4873 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
4874 if (CODING_REQUIRE_ENCODING (coding
))
4876 encode_coding_object (coding
, string
,
4877 start
, string_char_to_byte (string
, start
),
4878 end
, string_char_to_byte (string
, end
), Qt
);
4882 coding
->dst_object
= string
;
4883 coding
->consumed_char
= SCHARS (string
);
4884 coding
->produced
= SBYTES (string
);
4889 EMACS_INT start_byte
= CHAR_TO_BYTE (start
);
4890 EMACS_INT end_byte
= CHAR_TO_BYTE (end
);
4892 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
4893 if (CODING_REQUIRE_ENCODING (coding
))
4895 encode_coding_object (coding
, Fcurrent_buffer (),
4896 start
, start_byte
, end
, end_byte
, Qt
);
4900 coding
->dst_object
= Qnil
;
4901 coding
->dst_pos_byte
= start_byte
;
4902 if (start
>= GPT
|| end
<= GPT
)
4904 coding
->consumed_char
= end
- start
;
4905 coding
->produced
= end_byte
- start_byte
;
4909 coding
->consumed_char
= GPT
- start
;
4910 coding
->produced
= GPT_BYTE
- start_byte
;
4915 if (coding
->produced
> 0)
4919 STRINGP (coding
->dst_object
)
4920 ? SSDATA (coding
->dst_object
)
4921 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
4924 if (coding
->produced
)
4927 start
+= coding
->consumed_char
;
4933 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
4934 Sverify_visited_file_modtime
, 0, 1, 0,
4935 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
4936 This means that the file has not been changed since it was visited or saved.
4937 If BUF is omitted or nil, it defaults to the current buffer.
4938 See Info node `(elisp)Modification Time' for more details. */)
4943 Lisp_Object handler
;
4944 Lisp_Object filename
;
4954 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
4955 if (b
->modtime
== 0) return Qt
;
4957 /* If the file name has special constructs in it,
4958 call the corresponding file handler. */
4959 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
4960 Qverify_visited_file_modtime
);
4961 if (!NILP (handler
))
4962 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
4964 filename
= ENCODE_FILE (BVAR (b
, filename
));
4966 if (stat (SSDATA (filename
), &st
) < 0)
4968 /* If the file doesn't exist now and didn't exist before,
4969 we say that it isn't modified, provided the error is a tame one. */
4970 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
4975 if ((st
.st_mtime
== b
->modtime
4976 /* If both are positive, accept them if they are off by one second. */
4977 || (st
.st_mtime
> 0 && b
->modtime
> 0
4978 && (st
.st_mtime
- 1 == b
->modtime
4979 || st
.st_mtime
== b
->modtime
- 1)))
4980 && (st
.st_size
== b
->modtime_size
4981 || b
->modtime_size
< 0))
4986 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
4987 Sclear_visited_file_modtime
, 0, 0, 0,
4988 doc
: /* Clear out records of last mod time of visited file.
4989 Next attempt to save will certainly not complain of a discrepancy. */)
4992 current_buffer
->modtime
= 0;
4993 current_buffer
->modtime_size
= -1;
4997 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
4998 Svisited_file_modtime
, 0, 0, 0,
4999 doc
: /* Return the current buffer's recorded visited file modification time.
5000 The value is a list of the form (HIGH LOW), like the time values
5001 that `file-attributes' returns. If the current buffer has no recorded
5002 file modification time, this function returns 0.
5003 See Info node `(elisp)Modification Time' for more details. */)
5006 if (! current_buffer
->modtime
)
5007 return make_number (0);
5008 return make_time (current_buffer
->modtime
);
5011 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5012 Sset_visited_file_modtime
, 0, 1, 0,
5013 doc
: /* Update buffer's recorded modification time from the visited file's time.
5014 Useful if the buffer was not read from the file normally
5015 or if the file itself has been changed for some known benign reason.
5016 An argument specifies the modification time value to use
5017 \(instead of that of the visited file), in the form of a list
5018 \(HIGH . LOW) or (HIGH LOW). */)
5019 (Lisp_Object time_list
)
5021 if (!NILP (time_list
))
5023 CONS_TO_INTEGER (time_list
, time_t, current_buffer
->modtime
);
5024 current_buffer
->modtime_size
= -1;
5028 register Lisp_Object filename
;
5030 Lisp_Object handler
;
5032 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5034 /* If the file name has special constructs in it,
5035 call the corresponding file handler. */
5036 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5037 if (!NILP (handler
))
5038 /* The handler can find the file name the same way we did. */
5039 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5041 filename
= ENCODE_FILE (filename
);
5043 if (stat (SSDATA (filename
), &st
) >= 0)
5045 current_buffer
->modtime
= st
.st_mtime
;
5046 current_buffer
->modtime_size
= st
.st_size
;
5054 auto_save_error (Lisp_Object error_val
)
5056 Lisp_Object args
[3], msg
;
5058 struct gcpro gcpro1
;
5062 auto_save_error_occurred
= 1;
5064 ring_bell (XFRAME (selected_frame
));
5066 args
[0] = build_string ("Auto-saving %s: %s");
5067 args
[1] = BVAR (current_buffer
, name
);
5068 args
[2] = Ferror_message_string (error_val
);
5069 msg
= Fformat (3, args
);
5071 nbytes
= SBYTES (msg
);
5072 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5073 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5075 for (i
= 0; i
< 3; ++i
)
5078 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5080 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5081 Fsleep_for (make_number (1), Qnil
);
5095 auto_save_mode_bits
= 0666;
5097 /* Get visited file's mode to become the auto save file's mode. */
5098 if (! NILP (BVAR (current_buffer
, filename
)))
5100 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5101 /* But make sure we can overwrite it later! */
5102 auto_save_mode_bits
= st
.st_mode
| 0600;
5103 else if ((modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5105 /* Remote files don't cooperate with stat. */
5106 auto_save_mode_bits
= XINT (modes
) | 0600;
5110 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5111 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5116 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5119 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5131 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5134 minibuffer_auto_raise
= XINT (value
);
5139 do_auto_save_make_dir (Lisp_Object dir
)
5143 call2 (Qmake_directory
, dir
, Qt
);
5144 XSETFASTINT (mode
, 0700);
5145 return Fset_file_modes (dir
, mode
);
5149 do_auto_save_eh (Lisp_Object ignore
)
5154 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5155 doc
: /* Auto-save all buffers that need it.
5156 This is all buffers that have auto-saving enabled
5157 and are changed since last auto-saved.
5158 Auto-saving writes the buffer into a file
5159 so that your editing is not lost if the system crashes.
5160 This file is not the file you visited; that changes only when you save.
5161 Normally we run the normal hook `auto-save-hook' before saving.
5163 A non-nil NO-MESSAGE argument means do not print any message if successful.
5164 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5165 (Lisp_Object no_message
, Lisp_Object current_only
)
5167 struct buffer
*old
= current_buffer
, *b
;
5168 Lisp_Object tail
, buf
, hook
;
5170 int do_handled_files
;
5172 FILE *stream
= NULL
;
5173 int count
= SPECPDL_INDEX ();
5174 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5175 int old_message_p
= 0;
5176 struct gcpro gcpro1
, gcpro2
;
5178 if (max_specpdl_size
< specpdl_size
+ 40)
5179 max_specpdl_size
= specpdl_size
+ 40;
5184 if (NILP (no_message
))
5186 old_message_p
= push_message ();
5187 record_unwind_protect (pop_message_unwind
, Qnil
);
5190 /* Ordinarily don't quit within this function,
5191 but don't make it impossible to quit (in case we get hung in I/O). */
5195 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5196 point to non-strings reached from Vbuffer_alist. */
5198 hook
= intern ("auto-save-hook");
5199 Frun_hooks (1, &hook
);
5201 if (STRINGP (Vauto_save_list_file_name
))
5203 Lisp_Object listfile
;
5205 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5207 /* Don't try to create the directory when shutting down Emacs,
5208 because creating the directory might signal an error, and
5209 that would leave Emacs in a strange state. */
5210 if (!NILP (Vrun_hooks
))
5214 GCPRO2 (dir
, listfile
);
5215 dir
= Ffile_name_directory (listfile
);
5216 if (NILP (Ffile_directory_p (dir
)))
5217 internal_condition_case_1 (do_auto_save_make_dir
,
5218 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5223 stream
= fopen (SSDATA (listfile
), "w");
5226 record_unwind_protect (do_auto_save_unwind
,
5227 make_save_value (stream
, 0));
5228 record_unwind_protect (do_auto_save_unwind_1
,
5229 make_number (minibuffer_auto_raise
));
5230 minibuffer_auto_raise
= 0;
5232 auto_save_error_occurred
= 0;
5234 /* On first pass, save all files that don't have handlers.
5235 On second pass, save all files that do have handlers.
5237 If Emacs is crashing, the handlers may tweak what is causing
5238 Emacs to crash in the first place, and it would be a shame if
5239 Emacs failed to autosave perfectly ordinary files because it
5240 couldn't handle some ange-ftp'd file. */
5242 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5243 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5245 buf
= XCDR (XCAR (tail
));
5248 /* Record all the buffers that have auto save mode
5249 in the special file that lists them. For each of these buffers,
5250 Record visited name (if any) and auto save name. */
5251 if (STRINGP (BVAR (b
, auto_save_file_name
))
5252 && stream
!= NULL
&& do_handled_files
== 0)
5255 if (!NILP (BVAR (b
, filename
)))
5257 fwrite (SDATA (BVAR (b
, filename
)), 1,
5258 SBYTES (BVAR (b
, filename
)), stream
);
5260 putc ('\n', stream
);
5261 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5262 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5263 putc ('\n', stream
);
5267 if (!NILP (current_only
)
5268 && b
!= current_buffer
)
5271 /* Don't auto-save indirect buffers.
5272 The base buffer takes care of it. */
5276 /* Check for auto save enabled
5277 and file changed since last auto save
5278 and file changed since last real save. */
5279 if (STRINGP (BVAR (b
, auto_save_file_name
))
5280 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5281 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5282 /* -1 means we've turned off autosaving for a while--see below. */
5283 && XINT (BVAR (b
, save_length
)) >= 0
5284 && (do_handled_files
5285 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5288 EMACS_TIME before_time
, after_time
;
5290 EMACS_GET_TIME (before_time
);
5292 /* If we had a failure, don't try again for 20 minutes. */
5293 if (b
->auto_save_failure_time
>= 0
5294 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5297 set_buffer_internal (b
);
5298 if (NILP (Vauto_save_include_big_deletions
)
5299 && (XFASTINT (BVAR (b
, save_length
)) * 10
5300 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5301 /* A short file is likely to change a large fraction;
5302 spare the user annoying messages. */
5303 && XFASTINT (BVAR (b
, save_length
)) > 5000
5304 /* These messages are frequent and annoying for `*mail*'. */
5305 && !EQ (BVAR (b
, filename
), Qnil
)
5306 && NILP (no_message
))
5308 /* It has shrunk too much; turn off auto-saving here. */
5309 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5310 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5312 minibuffer_auto_raise
= 0;
5313 /* Turn off auto-saving until there's a real save,
5314 and prevent any more warnings. */
5315 XSETINT (BVAR (b
, save_length
), -1);
5316 Fsleep_for (make_number (1), Qnil
);
5319 if (!auto_saved
&& NILP (no_message
))
5320 message1 ("Auto-saving...");
5321 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5323 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5324 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5325 set_buffer_internal (old
);
5327 EMACS_GET_TIME (after_time
);
5329 /* If auto-save took more than 60 seconds,
5330 assume it was an NFS failure that got a timeout. */
5331 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5332 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5336 /* Prevent another auto save till enough input events come in. */
5337 record_auto_save ();
5339 if (auto_saved
&& NILP (no_message
))
5343 /* If we are going to restore an old message,
5344 give time to read ours. */
5345 sit_for (make_number (1), 0, 0);
5348 else if (!auto_save_error_occurred
)
5349 /* Don't overwrite the error message if an error occurred.
5350 If we displayed a message and then restored a state
5351 with no message, leave a "done" message on the screen. */
5352 message1 ("Auto-saving...done");
5357 /* This restores the message-stack status. */
5358 unbind_to (count
, Qnil
);
5362 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5363 Sset_buffer_auto_saved
, 0, 0, 0,
5364 doc
: /* Mark current buffer as auto-saved with its current text.
5365 No auto-save file will be written until the buffer changes again. */)
5368 /* FIXME: This should not be called in indirect buffers, since
5369 they're not autosaved. */
5370 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5371 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5372 current_buffer
->auto_save_failure_time
= -1;
5376 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5377 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5378 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5381 current_buffer
->auto_save_failure_time
= -1;
5385 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5387 doc
: /* Return t if current buffer has been auto-saved recently.
5388 More precisely, if it has been auto-saved since last read from or saved
5389 in the visited file. If the buffer has no visited file,
5390 then any auto-save counts as "recent". */)
5393 /* FIXME: maybe we should return nil for indirect buffers since
5394 they're never autosaved. */
5395 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5398 /* Reading and completing file names */
5400 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5401 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5402 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5403 The return value is only relevant for a call to `read-file-name' that happens
5404 before any other event (mouse or keypress) is handled. */)
5407 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5408 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5418 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5420 struct gcpro gcpro1
;
5421 Lisp_Object args
[7];
5423 GCPRO1 (default_filename
);
5424 args
[0] = intern ("read-file-name");
5427 args
[3] = default_filename
;
5428 args
[4] = mustmatch
;
5430 args
[6] = predicate
;
5431 RETURN_UNGCPRO (Ffuncall (7, args
));
5436 syms_of_fileio (void)
5438 Qoperations
= intern_c_string ("operations");
5439 Qexpand_file_name
= intern_c_string ("expand-file-name");
5440 Qsubstitute_in_file_name
= intern_c_string ("substitute-in-file-name");
5441 Qdirectory_file_name
= intern_c_string ("directory-file-name");
5442 Qfile_name_directory
= intern_c_string ("file-name-directory");
5443 Qfile_name_nondirectory
= intern_c_string ("file-name-nondirectory");
5444 Qunhandled_file_name_directory
= intern_c_string ("unhandled-file-name-directory");
5445 Qfile_name_as_directory
= intern_c_string ("file-name-as-directory");
5446 Qcopy_file
= intern_c_string ("copy-file");
5447 Qmake_directory_internal
= intern_c_string ("make-directory-internal");
5448 Qmake_directory
= intern_c_string ("make-directory");
5449 Qdelete_directory_internal
= intern_c_string ("delete-directory-internal");
5450 Qdelete_file
= intern_c_string ("delete-file");
5451 Qrename_file
= intern_c_string ("rename-file");
5452 Qadd_name_to_file
= intern_c_string ("add-name-to-file");
5453 Qmake_symbolic_link
= intern_c_string ("make-symbolic-link");
5454 Qfile_exists_p
= intern_c_string ("file-exists-p");
5455 Qfile_executable_p
= intern_c_string ("file-executable-p");
5456 Qfile_readable_p
= intern_c_string ("file-readable-p");
5457 Qfile_writable_p
= intern_c_string ("file-writable-p");
5458 Qfile_symlink_p
= intern_c_string ("file-symlink-p");
5459 Qaccess_file
= intern_c_string ("access-file");
5460 Qfile_directory_p
= intern_c_string ("file-directory-p");
5461 Qfile_regular_p
= intern_c_string ("file-regular-p");
5462 Qfile_accessible_directory_p
= intern_c_string ("file-accessible-directory-p");
5463 Qfile_modes
= intern_c_string ("file-modes");
5464 Qset_file_modes
= intern_c_string ("set-file-modes");
5465 Qset_file_times
= intern_c_string ("set-file-times");
5466 Qfile_selinux_context
= intern_c_string("file-selinux-context");
5467 Qset_file_selinux_context
= intern_c_string("set-file-selinux-context");
5468 Qfile_newer_than_file_p
= intern_c_string ("file-newer-than-file-p");
5469 Qinsert_file_contents
= intern_c_string ("insert-file-contents");
5470 Qwrite_region
= intern_c_string ("write-region");
5471 Qverify_visited_file_modtime
= intern_c_string ("verify-visited-file-modtime");
5472 Qset_visited_file_modtime
= intern_c_string ("set-visited-file-modtime");
5473 Qauto_save_coding
= intern_c_string ("auto-save-coding");
5475 staticpro (&Qoperations
);
5476 staticpro (&Qexpand_file_name
);
5477 staticpro (&Qsubstitute_in_file_name
);
5478 staticpro (&Qdirectory_file_name
);
5479 staticpro (&Qfile_name_directory
);
5480 staticpro (&Qfile_name_nondirectory
);
5481 staticpro (&Qunhandled_file_name_directory
);
5482 staticpro (&Qfile_name_as_directory
);
5483 staticpro (&Qcopy_file
);
5484 staticpro (&Qmake_directory_internal
);
5485 staticpro (&Qmake_directory
);
5486 staticpro (&Qdelete_directory_internal
);
5487 staticpro (&Qdelete_file
);
5488 staticpro (&Qrename_file
);
5489 staticpro (&Qadd_name_to_file
);
5490 staticpro (&Qmake_symbolic_link
);
5491 staticpro (&Qfile_exists_p
);
5492 staticpro (&Qfile_executable_p
);
5493 staticpro (&Qfile_readable_p
);
5494 staticpro (&Qfile_writable_p
);
5495 staticpro (&Qaccess_file
);
5496 staticpro (&Qfile_symlink_p
);
5497 staticpro (&Qfile_directory_p
);
5498 staticpro (&Qfile_regular_p
);
5499 staticpro (&Qfile_accessible_directory_p
);
5500 staticpro (&Qfile_modes
);
5501 staticpro (&Qset_file_modes
);
5502 staticpro (&Qset_file_times
);
5503 staticpro (&Qfile_selinux_context
);
5504 staticpro (&Qset_file_selinux_context
);
5505 staticpro (&Qfile_newer_than_file_p
);
5506 staticpro (&Qinsert_file_contents
);
5507 staticpro (&Qwrite_region
);
5508 staticpro (&Qverify_visited_file_modtime
);
5509 staticpro (&Qset_visited_file_modtime
);
5510 staticpro (&Qauto_save_coding
);
5512 Qfile_name_history
= intern_c_string ("file-name-history");
5513 Fset (Qfile_name_history
, Qnil
);
5514 staticpro (&Qfile_name_history
);
5516 Qfile_error
= intern_c_string ("file-error");
5517 staticpro (&Qfile_error
);
5518 Qfile_already_exists
= intern_c_string ("file-already-exists");
5519 staticpro (&Qfile_already_exists
);
5520 Qfile_date_error
= intern_c_string ("file-date-error");
5521 staticpro (&Qfile_date_error
);
5522 Qexcl
= intern_c_string ("excl");
5525 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5526 doc
: /* *Coding system for encoding file names.
5527 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5528 Vfile_name_coding_system
= Qnil
;
5530 DEFVAR_LISP ("default-file-name-coding-system",
5531 Vdefault_file_name_coding_system
,
5532 doc
: /* Default coding system for encoding file names.
5533 This variable is used only when `file-name-coding-system' is nil.
5535 This variable is set/changed by the command `set-language-environment'.
5536 User should not set this variable manually,
5537 instead use `file-name-coding-system' to get a constant encoding
5538 of file names regardless of the current language environment. */);
5539 Vdefault_file_name_coding_system
= Qnil
;
5541 Qformat_decode
= intern_c_string ("format-decode");
5542 staticpro (&Qformat_decode
);
5543 Qformat_annotate_function
= intern_c_string ("format-annotate-function");
5544 staticpro (&Qformat_annotate_function
);
5545 Qafter_insert_file_set_coding
= intern_c_string ("after-insert-file-set-coding");
5546 staticpro (&Qafter_insert_file_set_coding
);
5548 Qcar_less_than_car
= intern_c_string ("car-less-than-car");
5549 staticpro (&Qcar_less_than_car
);
5551 Fput (Qfile_error
, Qerror_conditions
,
5552 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5553 Fput (Qfile_error
, Qerror_message
,
5554 make_pure_c_string ("File error"));
5556 Fput (Qfile_already_exists
, Qerror_conditions
,
5557 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5558 Fput (Qfile_already_exists
, Qerror_message
,
5559 make_pure_c_string ("File already exists"));
5561 Fput (Qfile_date_error
, Qerror_conditions
,
5562 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5563 Fput (Qfile_date_error
, Qerror_message
,
5564 make_pure_c_string ("Cannot set file date"));
5566 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5567 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
5568 If a file name matches REGEXP, then all I/O on that file is done by calling
5571 The first argument given to HANDLER is the name of the I/O primitive
5572 to be handled; the remaining arguments are the arguments that were
5573 passed to that primitive. For example, if you do
5574 (file-exists-p FILENAME)
5575 and FILENAME is handled by HANDLER, then HANDLER is called like this:
5576 (funcall HANDLER 'file-exists-p FILENAME)
5577 The function `find-file-name-handler' checks this list for a handler
5578 for its argument. */);
5579 Vfile_name_handler_alist
= Qnil
;
5581 DEFVAR_LISP ("set-auto-coding-function",
5582 Vset_auto_coding_function
,
5583 doc
: /* If non-nil, a function to call to decide a coding system of file.
5584 Two arguments are passed to this function: the file name
5585 and the length of a file contents following the point.
5586 This function should return a coding system to decode the file contents.
5587 It should check the file name against `auto-coding-alist'.
5588 If no coding system is decided, it should check a coding system
5589 specified in the heading lines with the format:
5590 -*- ... coding: CODING-SYSTEM; ... -*-
5591 or local variable spec of the tailing lines with `coding:' tag. */);
5592 Vset_auto_coding_function
= Qnil
;
5594 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5595 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5596 Each is passed one argument, the number of characters inserted,
5597 with point at the start of the inserted text. Each function
5598 should leave point the same, and return the new character count.
5599 If `insert-file-contents' is intercepted by a handler from
5600 `file-name-handler-alist', that handler is responsible for calling the
5601 functions in `after-insert-file-functions' if appropriate. */);
5602 Vafter_insert_file_functions
= Qnil
;
5604 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5605 doc
: /* A list of functions to be called at the start of `write-region'.
5606 Each is passed two arguments, START and END as for `write-region'.
5607 These are usually two numbers but not always; see the documentation
5608 for `write-region'. The function should return a list of pairs
5609 of the form (POSITION . STRING), consisting of strings to be effectively
5610 inserted at the specified positions of the file being written (1 means to
5611 insert before the first byte written). The POSITIONs must be sorted into
5614 If there are several annotation functions, the lists returned by these
5615 functions are merged destructively. As each annotation function runs,
5616 the variable `write-region-annotations-so-far' contains a list of all
5617 annotations returned by previous annotation functions.
5619 An annotation function can return with a different buffer current.
5620 Doing so removes the annotations returned by previous functions, and
5621 resets START and END to `point-min' and `point-max' of the new buffer.
5623 After `write-region' completes, Emacs calls the function stored in
5624 `write-region-post-annotation-function', once for each buffer that was
5625 current when building the annotations (i.e., at least once), with that
5626 buffer current. */);
5627 Vwrite_region_annotate_functions
= Qnil
;
5628 staticpro (&Qwrite_region_annotate_functions
);
5629 Qwrite_region_annotate_functions
5630 = intern_c_string ("write-region-annotate-functions");
5632 DEFVAR_LISP ("write-region-post-annotation-function",
5633 Vwrite_region_post_annotation_function
,
5634 doc
: /* Function to call after `write-region' completes.
5635 The function is called with no arguments. If one or more of the
5636 annotation functions in `write-region-annotate-functions' changed the
5637 current buffer, the function stored in this variable is called for
5638 each of those additional buffers as well, in addition to the original
5639 buffer. The relevant buffer is current during each function call. */);
5640 Vwrite_region_post_annotation_function
= Qnil
;
5641 staticpro (&Vwrite_region_annotation_buffers
);
5643 DEFVAR_LISP ("write-region-annotations-so-far",
5644 Vwrite_region_annotations_so_far
,
5645 doc
: /* When an annotation function is called, this holds the previous annotations.
5646 These are the annotations made by other annotation functions
5647 that were already called. See also `write-region-annotate-functions'. */);
5648 Vwrite_region_annotations_so_far
= Qnil
;
5650 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5651 doc
: /* A list of file name handlers that temporarily should not be used.
5652 This applies only to the operation `inhibit-file-name-operation'. */);
5653 Vinhibit_file_name_handlers
= Qnil
;
5655 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5656 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5657 Vinhibit_file_name_operation
= Qnil
;
5659 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
5660 doc
: /* File name in which we write a list of all auto save file names.
5661 This variable is initialized automatically from `auto-save-list-file-prefix'
5662 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5663 a non-nil value. */);
5664 Vauto_save_list_file_name
= Qnil
;
5666 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
5667 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5668 Normally auto-save files are written under other names. */);
5669 Vauto_save_visited_file_name
= Qnil
;
5671 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
5672 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5673 If nil, deleting a substantial portion of the text disables auto-save
5674 in the buffer; this is the default behavior, because the auto-save
5675 file is usually more useful if it contains the deleted text. */);
5676 Vauto_save_include_big_deletions
= Qnil
;
5679 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
5680 doc
: /* *Non-nil means don't call fsync in `write-region'.
5681 This variable affects calls to `write-region' as well as save commands.
5682 A non-nil value may result in data loss! */);
5683 write_region_inhibit_fsync
= 0;
5686 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
5687 doc
: /* Specifies whether to use the system's trash can.
5688 When non-nil, certain file deletion commands use the function
5689 `move-file-to-trash' instead of deleting files outright.
5690 This includes interactive calls to `delete-file' and
5691 `delete-directory' and the Dired deletion commands. */);
5692 delete_by_moving_to_trash
= 0;
5693 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5694 Qmove_file_to_trash
= intern_c_string ("move-file-to-trash");
5695 staticpro (&Qmove_file_to_trash
);
5696 Qcopy_directory
= intern_c_string ("copy-directory");
5697 staticpro (&Qcopy_directory
);
5698 Qdelete_directory
= intern_c_string ("delete-directory");
5699 staticpro (&Qdelete_directory
);
5701 defsubr (&Sfind_file_name_handler
);
5702 defsubr (&Sfile_name_directory
);
5703 defsubr (&Sfile_name_nondirectory
);
5704 defsubr (&Sunhandled_file_name_directory
);
5705 defsubr (&Sfile_name_as_directory
);
5706 defsubr (&Sdirectory_file_name
);
5707 defsubr (&Smake_temp_name
);
5708 defsubr (&Sexpand_file_name
);
5709 defsubr (&Ssubstitute_in_file_name
);
5710 defsubr (&Scopy_file
);
5711 defsubr (&Smake_directory_internal
);
5712 defsubr (&Sdelete_directory_internal
);
5713 defsubr (&Sdelete_file
);
5714 defsubr (&Srename_file
);
5715 defsubr (&Sadd_name_to_file
);
5716 defsubr (&Smake_symbolic_link
);
5717 defsubr (&Sfile_name_absolute_p
);
5718 defsubr (&Sfile_exists_p
);
5719 defsubr (&Sfile_executable_p
);
5720 defsubr (&Sfile_readable_p
);
5721 defsubr (&Sfile_writable_p
);
5722 defsubr (&Saccess_file
);
5723 defsubr (&Sfile_symlink_p
);
5724 defsubr (&Sfile_directory_p
);
5725 defsubr (&Sfile_accessible_directory_p
);
5726 defsubr (&Sfile_regular_p
);
5727 defsubr (&Sfile_modes
);
5728 defsubr (&Sset_file_modes
);
5729 defsubr (&Sset_file_times
);
5730 defsubr (&Sfile_selinux_context
);
5731 defsubr (&Sset_file_selinux_context
);
5732 defsubr (&Sset_default_file_modes
);
5733 defsubr (&Sdefault_file_modes
);
5734 defsubr (&Sfile_newer_than_file_p
);
5735 defsubr (&Sinsert_file_contents
);
5736 defsubr (&Swrite_region
);
5737 defsubr (&Scar_less_than_car
);
5738 defsubr (&Sverify_visited_file_modtime
);
5739 defsubr (&Sclear_visited_file_modtime
);
5740 defsubr (&Svisited_file_modtime
);
5741 defsubr (&Sset_visited_file_modtime
);
5742 defsubr (&Sdo_auto_save
);
5743 defsubr (&Sset_buffer_auto_saved
);
5744 defsubr (&Sclear_buffer_auto_save_failure
);
5745 defsubr (&Srecent_auto_save_p
);
5747 defsubr (&Snext_read_file_uses_dialog_p
);
5750 defsubr (&Sunix_sync
);