1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
36 #ifdef HAVE_LIBSELINUX
37 #include <selinux/selinux.h>
38 #include <selinux/context.h>
42 #include "intervals.h"
44 #include "character.h"
47 #include "blockinput.h"
49 #include "dispextern.h"
55 #endif /* not WINDOWSNT */
59 #include <sys/param.h>
64 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
65 redirector allows the six letters between 'Z' and 'a' as well. */
67 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
70 #define IS_DRIVE(x) isalpha ((unsigned char) (x))
72 /* Need to lower-case the drive letter, or else expanded
73 filenames will sometimes compare inequal, because
74 `expand-file-name' doesn't always down-case the drive letter. */
75 #define DRIVE_LETTER(x) (tolower ((unsigned char) (x)))
86 #ifndef FILE_SYSTEM_CASE
87 #define FILE_SYSTEM_CASE(filename) (filename)
90 /* Nonzero during writing of auto-save files */
93 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
94 a new file with the same mode as the original */
95 int auto_save_mode_bits
;
97 /* Set by auto_save_1 if an error occurred during the last auto-save. */
98 int auto_save_error_occurred
;
100 /* The symbol bound to coding-system-for-read when
101 insert-file-contents is called for recovering a file. This is not
102 an actual coding system name, but just an indicator to tell
103 insert-file-contents to use `emacs-mule' with a special flag for
104 auto saving and recovering a file. */
105 Lisp_Object Qauto_save_coding
;
107 /* Property name of a file name handler,
108 which gives a list of operations it handles.. */
109 Lisp_Object Qoperations
;
111 /* Lisp functions for translating file formats */
112 Lisp_Object Qformat_decode
, Qformat_annotate_function
;
114 /* Lisp function for setting buffer-file-coding-system and the
115 multibyteness of the current buffer after inserting a file. */
116 Lisp_Object Qafter_insert_file_set_coding
;
118 Lisp_Object Qwrite_region_annotate_functions
;
119 /* Each time an annotation function changes the buffer, the new buffer
121 Lisp_Object Vwrite_region_annotation_buffers
;
126 Lisp_Object Qdelete_by_moving_to_trash
;
128 /* Lisp function for moving files to trash. */
129 Lisp_Object Qmove_file_to_trash
;
131 /* Lisp function for recursively copying directories. */
132 Lisp_Object Qcopy_directory
;
134 /* Lisp function for recursively deleting directories. */
135 Lisp_Object Qdelete_directory
;
140 Lisp_Object Qfile_error
, Qfile_already_exists
, Qfile_date_error
;
142 Lisp_Object Qfile_name_history
;
144 Lisp_Object Qcar_less_than_car
;
146 static int a_write (int, Lisp_Object
, int, int,
147 Lisp_Object
*, struct coding_system
*);
148 static int e_write (int, Lisp_Object
, int, int, struct coding_system
*);
152 report_file_error (const char *string
, Lisp_Object data
)
154 Lisp_Object errstring
;
158 synchronize_system_messages_locale ();
159 str
= strerror (errorno
);
160 errstring
= code_convert_string_norecord (make_unibyte_string (str
,
162 Vlocale_coding_system
, 0);
168 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
171 /* System error messages are capitalized. Downcase the initial
172 unless it is followed by a slash. (The slash case caters to
173 error messages that begin with "I/O" or, in German, "E/A".) */
174 if (STRING_MULTIBYTE (errstring
)
175 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
179 str
= SSDATA (errstring
);
180 c
= STRING_CHAR ((unsigned char *) str
);
181 Faset (errstring
, make_number (0), make_number (DOWNCASE (c
)));
184 xsignal (Qfile_error
,
185 Fcons (build_string (string
), Fcons (errstring
, data
)));
190 close_file_unwind (Lisp_Object fd
)
192 emacs_close (XFASTINT (fd
));
196 /* Restore point, having saved it as a marker. */
199 restore_point_unwind (Lisp_Object location
)
201 Fgoto_char (location
);
202 Fset_marker (location
, Qnil
, Qnil
);
207 Lisp_Object Qexpand_file_name
;
208 Lisp_Object Qsubstitute_in_file_name
;
209 Lisp_Object Qdirectory_file_name
;
210 Lisp_Object Qfile_name_directory
;
211 Lisp_Object Qfile_name_nondirectory
;
212 Lisp_Object Qunhandled_file_name_directory
;
213 Lisp_Object Qfile_name_as_directory
;
214 Lisp_Object Qcopy_file
;
215 Lisp_Object Qmake_directory_internal
;
216 Lisp_Object Qmake_directory
;
217 Lisp_Object Qdelete_directory_internal
;
218 Lisp_Object Qdelete_file
;
219 Lisp_Object Qrename_file
;
220 Lisp_Object Qadd_name_to_file
;
221 Lisp_Object Qmake_symbolic_link
;
222 Lisp_Object Qfile_exists_p
;
223 Lisp_Object Qfile_executable_p
;
224 Lisp_Object Qfile_readable_p
;
225 Lisp_Object Qfile_writable_p
;
226 Lisp_Object Qfile_symlink_p
;
227 Lisp_Object Qaccess_file
;
228 Lisp_Object Qfile_directory_p
;
229 Lisp_Object Qfile_regular_p
;
230 Lisp_Object Qfile_accessible_directory_p
;
231 Lisp_Object Qfile_modes
;
232 Lisp_Object Qset_file_modes
;
233 Lisp_Object Qset_file_times
;
234 Lisp_Object Qfile_selinux_context
;
235 Lisp_Object Qset_file_selinux_context
;
236 Lisp_Object Qfile_newer_than_file_p
;
237 Lisp_Object Qinsert_file_contents
;
238 Lisp_Object Qwrite_region
;
239 Lisp_Object Qverify_visited_file_modtime
;
240 Lisp_Object Qset_visited_file_modtime
;
242 DEFUN ("find-file-name-handler", Ffind_file_name_handler
, Sfind_file_name_handler
, 2, 2, 0,
243 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
244 Otherwise, return nil.
245 A file name is handled if one of the regular expressions in
246 `file-name-handler-alist' matches it.
248 If OPERATION equals `inhibit-file-name-operation', then we ignore
249 any handlers that are members of `inhibit-file-name-handlers',
250 but we still do run any other handlers. This lets handlers
251 use the standard functions without calling themselves recursively. */)
252 (Lisp_Object filename
, Lisp_Object operation
)
254 /* This function must not munge the match data. */
255 Lisp_Object chain
, inhibited_handlers
, result
;
259 CHECK_STRING (filename
);
261 if (EQ (operation
, Vinhibit_file_name_operation
))
262 inhibited_handlers
= Vinhibit_file_name_handlers
;
264 inhibited_handlers
= Qnil
;
266 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
267 chain
= XCDR (chain
))
273 Lisp_Object string
= XCAR (elt
);
275 Lisp_Object handler
= XCDR (elt
);
276 Lisp_Object operations
= Qnil
;
278 if (SYMBOLP (handler
))
279 operations
= Fget (handler
, Qoperations
);
282 && (match_pos
= fast_string_match (string
, filename
)) > pos
283 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
287 handler
= XCDR (elt
);
288 tem
= Fmemq (handler
, inhibited_handlers
);
302 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
304 doc
: /* Return the directory component in file name FILENAME.
305 Return nil if FILENAME does not include a directory.
306 Otherwise return a directory name.
307 Given a Unix syntax file name, returns a string ending in slash. */)
308 (Lisp_Object filename
)
311 register const char *beg
;
315 register const char *p
;
318 CHECK_STRING (filename
);
320 /* If the file name has special constructs in it,
321 call the corresponding file handler. */
322 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
324 return call2 (handler
, Qfile_name_directory
, filename
);
326 filename
= FILE_SYSTEM_CASE (filename
);
328 beg
= (char *) alloca (SBYTES (filename
) + 1);
329 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
331 beg
= SSDATA (filename
);
333 p
= beg
+ SBYTES (filename
);
335 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
337 /* only recognise drive specifier at the beginning */
339 /* handle the "/:d:foo" and "/:foo" cases correctly */
340 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
341 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
348 /* Expansion of "c:" to drive and default directory. */
351 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
352 char *res
= alloca (MAXPATHLEN
+ 1);
355 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
357 strncpy (res
, beg
, 2);
362 if (getdefdir (toupper ((unsigned char) *beg
) - 'A' + 1, r
))
364 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
367 p
= beg
+ strlen (beg
);
370 dostounix_filename (beg
);
373 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
376 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
377 Sfile_name_nondirectory
, 1, 1, 0,
378 doc
: /* Return file name FILENAME sans its directory.
379 For example, in a Unix-syntax file name,
380 this is everything after the last slash,
381 or the entire name if it contains no slash. */)
382 (Lisp_Object filename
)
384 register const char *beg
, *p
, *end
;
387 CHECK_STRING (filename
);
389 /* If the file name has special constructs in it,
390 call the corresponding file handler. */
391 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
393 return call2 (handler
, Qfile_name_nondirectory
, filename
);
395 beg
= SSDATA (filename
);
396 end
= p
= beg
+ SBYTES (filename
);
398 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
400 /* only recognise drive specifier at beginning */
402 /* handle the "/:d:foo" case correctly */
403 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
408 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
411 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
412 Sunhandled_file_name_directory
, 1, 1, 0,
413 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
414 A `directly usable' directory name is one that may be used without the
415 intervention of any file handler.
416 If FILENAME is a directly usable file itself, return
417 \(file-name-directory FILENAME).
418 If FILENAME refers to a file which is not accessible from a local process,
419 then this should return nil.
420 The `call-process' and `start-process' functions use this function to
421 get a current directory to run processes in. */)
422 (Lisp_Object filename
)
426 /* If the file name has special constructs in it,
427 call the corresponding file handler. */
428 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
430 return call2 (handler
, Qunhandled_file_name_directory
, filename
);
432 return Ffile_name_directory (filename
);
437 file_name_as_directory (char *out
, char *in
)
439 int size
= strlen (in
) - 1;
451 /* For Unix syntax, Append a slash if necessary */
452 if (!IS_DIRECTORY_SEP (out
[size
]))
454 out
[size
+ 1] = DIRECTORY_SEP
;
455 out
[size
+ 2] = '\0';
458 dostounix_filename (out
);
463 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
464 Sfile_name_as_directory
, 1, 1, 0,
465 doc
: /* Return a string representing the file name FILE interpreted as a directory.
466 This operation exists because a directory is also a file, but its name as
467 a directory is different from its name as a file.
468 The result can be used as the value of `default-directory'
469 or passed as second argument to `expand-file-name'.
470 For a Unix-syntax file name, just appends a slash. */)
480 /* If the file name has special constructs in it,
481 call the corresponding file handler. */
482 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
484 return call2 (handler
, Qfile_name_as_directory
, file
);
486 buf
= (char *) alloca (SBYTES (file
) + 10);
487 file_name_as_directory (buf
, SSDATA (file
));
488 return make_specified_string (buf
, -1, strlen (buf
),
489 STRING_MULTIBYTE (file
));
493 * Convert from directory name to filename.
494 * On UNIX, it's simple: just make sure there isn't a terminating /
496 * Value is nonzero if the string output is different from the input.
500 directory_file_name (char *src
, char *dst
)
506 /* Process as Unix format: just remove any final slash.
507 But leave "/" unchanged; do not change it to "". */
510 && IS_DIRECTORY_SEP (dst
[slen
- 1])
512 && !IS_ANY_SEP (dst
[slen
- 2])
517 dostounix_filename (dst
);
522 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
524 doc
: /* Returns the file name of the directory named DIRECTORY.
525 This is the name of the file that holds the data for the directory DIRECTORY.
526 This operation exists because a directory is also a file, but its name as
527 a directory is different from its name as a file.
528 In Unix-syntax, this function just removes the final slash. */)
529 (Lisp_Object directory
)
534 CHECK_STRING (directory
);
536 if (NILP (directory
))
539 /* If the file name has special constructs in it,
540 call the corresponding file handler. */
541 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
543 return call2 (handler
, Qdirectory_file_name
, directory
);
545 buf
= (char *) alloca (SBYTES (directory
) + 20);
546 directory_file_name (SSDATA (directory
), buf
);
547 return make_specified_string (buf
, -1, strlen (buf
),
548 STRING_MULTIBYTE (directory
));
551 static const char make_temp_name_tbl
[64] =
553 'A','B','C','D','E','F','G','H',
554 'I','J','K','L','M','N','O','P',
555 'Q','R','S','T','U','V','W','X',
556 'Y','Z','a','b','c','d','e','f',
557 'g','h','i','j','k','l','m','n',
558 'o','p','q','r','s','t','u','v',
559 'w','x','y','z','0','1','2','3',
560 '4','5','6','7','8','9','-','_'
563 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
565 /* Value is a temporary file name starting with PREFIX, a string.
567 The Emacs process number forms part of the result, so there is
568 no danger of generating a name being used by another process.
569 In addition, this function makes an attempt to choose a name
570 which has no existing file. To make this work, PREFIX should be
571 an absolute file name.
573 BASE64_P non-zero means add the pid as 3 characters in base64
574 encoding. In this case, 6 characters will be added to PREFIX to
575 form the file name. Otherwise, if Emacs is running on a system
576 with long file names, add the pid as a decimal number.
578 This function signals an error if no unique file name could be
582 make_temp_name (Lisp_Object prefix
, int base64_p
)
591 CHECK_STRING (prefix
);
593 /* VAL is created by adding 6 characters to PREFIX. The first
594 three are the PID of this process, in base 64, and the second
595 three are incremented if the file already exists. This ensures
596 262144 unique file names per PID per PREFIX. */
598 pid
= (int) getpid ();
602 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
603 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
604 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
609 #ifdef HAVE_LONG_FILE_NAMES
610 sprintf (pidbuf
, "%d", pid
);
611 pidlen
= strlen (pidbuf
);
613 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
614 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
615 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
620 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
621 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
622 if (!STRING_MULTIBYTE (prefix
))
623 STRING_SET_UNIBYTE (val
);
625 memcpy (data
, SSDATA (prefix
), len
);
628 memcpy (p
, pidbuf
, pidlen
);
631 /* Here we try to minimize useless stat'ing when this function is
632 invoked many times successively with the same PREFIX. We achieve
633 this by initializing count to a random value, and incrementing it
636 We don't want make-temp-name to be called while dumping,
637 because then make_temp_name_count_initialized_p would get set
638 and then make_temp_name_count would not be set when Emacs starts. */
640 if (!make_temp_name_count_initialized_p
)
642 make_temp_name_count
= (unsigned) time (NULL
);
643 make_temp_name_count_initialized_p
= 1;
649 unsigned num
= make_temp_name_count
;
651 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
652 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
653 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
655 /* Poor man's congruential RN generator. Replace with
656 ++make_temp_name_count for debugging. */
657 make_temp_name_count
+= 25229;
658 make_temp_name_count
%= 225307;
660 if (stat (data
, &ignored
) < 0)
662 /* We want to return only if errno is ENOENT. */
666 /* The error here is dubious, but there is little else we
667 can do. The alternatives are to return nil, which is
668 as bad as (and in many cases worse than) throwing the
669 error, or to ignore the error, which will likely result
670 in looping through 225307 stat's, which is not only
671 dog-slow, but also useless since eventually nil would
672 have to be returned anyway. */
673 report_file_error ("Cannot create temporary name for prefix",
674 Fcons (prefix
, Qnil
));
681 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
682 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
683 The Emacs process number forms part of the result,
684 so there is no danger of generating a name being used by another process.
686 In addition, this function makes an attempt to choose a name
687 which has no existing file. To make this work,
688 PREFIX should be an absolute file name.
690 There is a race condition between calling `make-temp-name' and creating the
691 file which opens all kinds of security holes. For that reason, you should
692 probably use `make-temp-file' instead, except in three circumstances:
694 * If you are creating the file in the user's home directory.
695 * If you are creating a directory rather than an ordinary file.
696 * If you are taking special precautions as `make-temp-file' does. */)
699 return make_temp_name (prefix
, 0);
704 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
705 doc
: /* Convert filename NAME to absolute, and canonicalize it.
706 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
707 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
708 the current buffer's value of `default-directory' is used.
709 NAME should be a string that is a valid file name for the underlying
711 File name components that are `.' are removed, and
712 so are file name components followed by `..', along with the `..' itself;
713 note that these simplifications are done without checking the resulting
714 file names in the file system.
715 Multiple consecutive slashes are collapsed into a single slash,
716 except at the beginning of the file name when they are significant (e.g.,
717 UNC file names on MS-Windows.)
718 An initial `~/' expands to your home directory.
719 An initial `~USER/' expands to USER's home directory.
720 See also the function `substitute-in-file-name'.
722 For technical reasons, this function can return correct but
723 non-intuitive results for the root directory; for instance,
724 \(expand-file-name ".." "/") returns "/..". For this reason, use
725 \(directory-file-name (file-name-directory dirname)) to traverse a
726 filesystem tree, not (expand-file-name ".." dirname). */)
727 (Lisp_Object name
, Lisp_Object default_directory
)
729 /* These point to SDATA and need to be careful with string-relocation
730 during GC (via DECODE_FILE). */
732 /* This should only point to alloca'd data. */
739 int collapse_newdir
= 1;
743 Lisp_Object handler
, result
;
749 /* If the file name has special constructs in it,
750 call the corresponding file handler. */
751 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
753 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
755 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
756 if (NILP (default_directory
))
757 default_directory
= BVAR (current_buffer
, directory
);
758 if (! STRINGP (default_directory
))
761 /* "/" is not considered a root directory on DOS_NT, so using "/"
762 here causes an infinite recursion in, e.g., the following:
764 (let (default-directory)
765 (expand-file-name "a"))
767 To avoid this, we set default_directory to the root of the
769 default_directory
= build_string (emacs_root_dir ());
771 default_directory
= build_string ("/");
775 if (!NILP (default_directory
))
777 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
779 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
783 char *o
= SSDATA (default_directory
);
785 /* Make sure DEFAULT_DIRECTORY is properly expanded.
786 It would be better to do this down below where we actually use
787 default_directory. Unfortunately, calling Fexpand_file_name recursively
788 could invoke GC, and the strings might be relocated. This would
789 be annoying because we have pointers into strings lying around
790 that would need adjusting, and people would add new pointers to
791 the code and forget to adjust them, resulting in intermittent bugs.
792 Putting this call here avoids all that crud.
794 The EQ test avoids infinite recursion. */
795 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
796 /* Save time in some common cases - as long as default_directory
797 is not relative, it can be canonicalized with name below (if it
798 is needed at all) without requiring it to be expanded now. */
800 /* Detect MSDOS file names with drive specifiers. */
801 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
802 && IS_DIRECTORY_SEP (o
[2]))
804 /* Detect Windows file names in UNC format. */
805 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
807 #else /* not DOS_NT */
808 /* Detect Unix absolute file names (/... alone is not absolute on
810 && ! (IS_DIRECTORY_SEP (o
[0]))
811 #endif /* not DOS_NT */
817 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
821 name
= FILE_SYSTEM_CASE (name
);
822 multibyte
= STRING_MULTIBYTE (name
);
823 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
826 default_directory
= string_to_multibyte (default_directory
);
829 name
= string_to_multibyte (name
);
834 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
835 nm
= (char *) alloca (SBYTES (name
) + 1);
836 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
839 /* Note if special escape prefix is present, but remove for now. */
840 if (nm
[0] == '/' && nm
[1] == ':')
846 /* Find and remove drive specifier if present; this makes nm absolute
847 even if the rest of the name appears to be relative. Only look for
848 drive specifier at the beginning. */
849 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
851 drive
= (unsigned char) nm
[0];
856 /* If we see "c://somedir", we want to strip the first slash after the
857 colon when stripping the drive letter. Otherwise, this expands to
859 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
862 /* Discard any previous drive specifier if nm is now in UNC format. */
863 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
867 #endif /* WINDOWSNT */
870 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
871 none are found, we can probably return right away. We will avoid
872 allocating a new string if name is already fully expanded. */
874 IS_DIRECTORY_SEP (nm
[0])
876 && drive
&& !is_escaped
879 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
883 /* If it turns out that the filename we want to return is just a
884 suffix of FILENAME, we don't need to go through and edit
885 things; we just need to construct a new string using data
886 starting at the middle of FILENAME. If we set lose to a
887 non-zero value, that means we've discovered that we can't do
894 /* Since we know the name is absolute, we can assume that each
895 element starts with a "/". */
897 /* "." and ".." are hairy. */
898 if (IS_DIRECTORY_SEP (p
[0])
900 && (IS_DIRECTORY_SEP (p
[2])
902 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
905 /* We want to replace multiple `/' in a row with a single
908 && IS_DIRECTORY_SEP (p
[0])
909 && IS_DIRECTORY_SEP (p
[1]))
916 /* Make sure directories are all separated with /, but
917 avoid allocation of a new string when not required. */
918 dostounix_filename (nm
);
920 if (IS_DIRECTORY_SEP (nm
[1]))
922 if (strcmp (nm
, SSDATA (name
)) != 0)
923 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
927 /* drive must be set, so this is okay */
928 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
932 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
933 temp
[0] = DRIVE_LETTER (drive
);
934 name
= concat2 (build_string (temp
), name
);
937 #else /* not DOS_NT */
938 if (strcmp (nm
, SSDATA (name
)) == 0)
940 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
941 #endif /* not DOS_NT */
945 /* At this point, nm might or might not be an absolute file name. We
946 need to expand ~ or ~user if present, otherwise prefix nm with
947 default_directory if nm is not absolute, and finally collapse /./
948 and /foo/../ sequences.
950 We set newdir to be the appropriate prefix if one is needed:
951 - the relevant user directory if nm starts with ~ or ~user
952 - the specified drive's working dir (DOS/NT only) if nm does not
954 - the value of default_directory.
956 Note that these prefixes are not guaranteed to be absolute (except
957 for the working dir of a drive). Therefore, to ensure we always
958 return an absolute name, if the final prefix is not absolute we
959 append it to the current working directory. */
963 if (nm
[0] == '~') /* prefix ~ */
965 if (IS_DIRECTORY_SEP (nm
[1])
966 || nm
[1] == 0) /* ~ by itself */
970 if (!(newdir
= egetenv ("HOME")))
973 /* egetenv may return a unibyte string, which will bite us since
974 we expect the directory to be multibyte. */
975 tem
= build_string (newdir
);
976 if (!STRING_MULTIBYTE (tem
))
978 hdir
= DECODE_FILE (tem
);
979 newdir
= SSDATA (hdir
);
985 else /* ~user/filename */
988 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
989 o
= alloca (p
- nm
+ 1);
990 memcpy (o
, nm
, p
- nm
);
994 pw
= (struct passwd
*) getpwnam (o
+ 1);
1001 collapse_newdir
= 0;
1005 /* If we don't find a user of that name, leave the name
1006 unchanged; don't move nm forward to p. */
1011 /* On DOS and Windows, nm is absolute if a drive name was specified;
1012 use the drive's current directory as the prefix if needed. */
1013 if (!newdir
&& drive
)
1015 /* Get default directory if needed to make nm absolute. */
1016 if (!IS_DIRECTORY_SEP (nm
[0]))
1018 newdir
= alloca (MAXPATHLEN
+ 1);
1019 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1024 /* Either nm starts with /, or drive isn't mounted. */
1025 newdir
= alloca (4);
1026 newdir
[0] = DRIVE_LETTER (drive
);
1034 /* Finally, if no prefix has been specified and nm is not absolute,
1035 then it must be expanded relative to default_directory. */
1039 /* /... alone is not absolute on DOS and Windows. */
1040 && !IS_DIRECTORY_SEP (nm
[0])
1043 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1047 newdir
= SSDATA (default_directory
);
1049 /* Note if special escape prefix is present, but remove for now. */
1050 if (newdir
[0] == '/' && newdir
[1] == ':')
1061 /* First ensure newdir is an absolute name. */
1063 /* Detect MSDOS file names with drive specifiers. */
1064 ! (IS_DRIVE (newdir
[0])
1065 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1067 /* Detect Windows file names in UNC format. */
1068 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1072 /* Effectively, let newdir be (expand-file-name newdir cwd).
1073 Because of the admonition against calling expand-file-name
1074 when we have pointers into lisp strings, we accomplish this
1075 indirectly by prepending newdir to nm if necessary, and using
1076 cwd (or the wd of newdir's drive) as the new newdir. */
1078 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1080 drive
= (unsigned char) newdir
[0];
1083 if (!IS_DIRECTORY_SEP (nm
[0]))
1085 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1086 file_name_as_directory (tmp
, newdir
);
1090 newdir
= alloca (MAXPATHLEN
+ 1);
1093 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1100 /* Strip off drive name from prefix, if present. */
1101 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1107 /* Keep only a prefix from newdir if nm starts with slash
1108 (//server/share for UNC, nothing otherwise). */
1109 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1112 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1115 newdir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1117 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1119 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1131 /* Get rid of any slash at the end of newdir, unless newdir is
1132 just / or // (an incomplete UNC name). */
1133 length
= strlen (newdir
);
1134 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1136 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1140 char *temp
= (char *) alloca (length
);
1141 memcpy (temp
, newdir
, length
- 1);
1142 temp
[length
- 1] = 0;
1150 /* Now concatenate the directory and name to new space in the stack frame */
1151 tlen
+= strlen (nm
) + 1;
1153 /* Reserve space for drive specifier and escape prefix, since either
1154 or both may need to be inserted. (The Microsoft x86 compiler
1155 produces incorrect code if the following two lines are combined.) */
1156 target
= (char *) alloca (tlen
+ 4);
1158 #else /* not DOS_NT */
1159 target
= (char *) alloca (tlen
);
1160 #endif /* not DOS_NT */
1165 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1168 /* If newdir is effectively "C:/", then the drive letter will have
1169 been stripped and newdir will be "/". Concatenating with an
1170 absolute directory in nm produces "//", which will then be
1171 incorrectly treated as a network share. Ignore newdir in
1172 this case (keeping the drive letter). */
1173 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1174 && newdir
[1] == '\0'))
1176 strcpy (target
, newdir
);
1179 file_name_as_directory (target
, newdir
);
1182 strcat (target
, nm
);
1184 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1192 if (!IS_DIRECTORY_SEP (*p
))
1196 else if (p
[1] == '.'
1197 && (IS_DIRECTORY_SEP (p
[2])
1200 /* If "/." is the entire filename, keep the "/". Otherwise,
1201 just delete the whole "/.". */
1202 if (o
== target
&& p
[2] == '\0')
1206 else if (p
[1] == '.' && p
[2] == '.'
1207 /* `/../' is the "superroot" on certain file systems.
1208 Turned off on DOS_NT systems because they have no
1209 "superroot" and because this causes us to produce
1210 file names like "d:/../foo" which fail file-related
1211 functions of the underlying OS. (To reproduce, try a
1212 long series of "../../" in default_directory, longer
1213 than the number of levels from the root.) */
1217 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1222 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1225 /* Don't go below server level in UNC filenames. */
1226 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1227 && IS_DIRECTORY_SEP (*target
))
1231 /* Keep initial / only if this is the whole name. */
1232 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1236 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1237 /* Collapse multiple `/' in a row. */
1246 /* At last, set drive name. */
1248 /* Except for network file name. */
1249 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1250 #endif /* WINDOWSNT */
1252 if (!drive
) abort ();
1254 target
[0] = DRIVE_LETTER (drive
);
1257 /* Reinsert the escape prefix if required. */
1264 dostounix_filename (target
);
1267 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1270 /* Again look to see if the file name has special constructs in it
1271 and perhaps call the corresponding file handler. This is needed
1272 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1273 the ".." component gives us "/user@host:/bar/../baz" which needs
1274 to be expanded again. */
1275 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1276 if (!NILP (handler
))
1277 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1283 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1284 This is the old version of expand-file-name, before it was thoroughly
1285 rewritten for Emacs 10.31. We leave this version here commented-out,
1286 because the code is very complex and likely to have subtle bugs. If
1287 bugs _are_ found, it might be of interest to look at the old code and
1288 see what did it do in the relevant situation.
1290 Don't remove this code: it's true that it will be accessible
1291 from the repository, but a few years from deletion, people will
1292 forget it is there. */
1294 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1295 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1296 "Convert FILENAME to absolute, and canonicalize it.\n\
1297 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1298 \(does not start with slash); if DEFAULT is nil or missing,\n\
1299 the current buffer's value of default-directory is used.\n\
1300 Filenames containing `.' or `..' as components are simplified;\n\
1301 initial `~/' expands to your home directory.\n\
1302 See also the function `substitute-in-file-name'.")
1304 Lisp_Object name
, defalt
;
1308 register unsigned char *newdir
, *p
, *o
;
1310 unsigned char *target
;
1314 CHECK_STRING (name
);
1317 /* If nm is absolute, flush ...// and detect /./ and /../.
1318 If no /./ or /../ we can return right away. */
1325 if (p
[0] == '/' && p
[1] == '/'
1328 if (p
[0] == '/' && p
[1] == '~')
1329 nm
= p
+ 1, lose
= 1;
1330 if (p
[0] == '/' && p
[1] == '.'
1331 && (p
[2] == '/' || p
[2] == 0
1332 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1338 if (nm
== SDATA (name
))
1340 return build_string (nm
);
1344 /* Now determine directory to start with and put it in NEWDIR */
1348 if (nm
[0] == '~') /* prefix ~ */
1349 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1351 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1352 newdir
= (unsigned char *) "";
1355 else /* ~user/filename */
1357 /* Get past ~ to user */
1358 unsigned char *user
= nm
+ 1;
1359 /* Find end of name. */
1360 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1361 int len
= ptr
? ptr
- user
: strlen (user
);
1362 /* Copy the user name into temp storage. */
1363 o
= (unsigned char *) alloca (len
+ 1);
1364 memcpy (o
, user
, len
);
1367 /* Look up the user name. */
1369 pw
= (struct passwd
*) getpwnam (o
+ 1);
1372 error ("\"%s\" isn't a registered user", o
+ 1);
1374 newdir
= (unsigned char *) pw
->pw_dir
;
1376 /* Discard the user name from NM. */
1380 if (nm
[0] != '/' && !newdir
)
1383 defalt
= current_buffer
->directory
;
1384 CHECK_STRING (defalt
);
1385 newdir
= SDATA (defalt
);
1388 /* Now concatenate the directory and name to new space in the stack frame */
1390 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1391 target
= (unsigned char *) alloca (tlen
);
1396 if (nm
[0] == 0 || nm
[0] == '/')
1397 strcpy (target
, newdir
);
1399 file_name_as_directory (target
, newdir
);
1402 strcat (target
, nm
);
1404 /* Now canonicalize by removing /. and /foo/.. if they appear */
1415 else if (!strncmp (p
, "//", 2)
1421 else if (p
[0] == '/' && p
[1] == '.'
1422 && (p
[2] == '/' || p
[2] == 0))
1424 else if (!strncmp (p
, "/..", 3)
1425 /* `/../' is the "superroot" on certain file systems. */
1427 && (p
[3] == '/' || p
[3] == 0))
1429 while (o
!= target
&& *--o
!= '/')
1431 if (o
== target
&& *o
== '/')
1441 return make_string (target
, o
- target
);
1445 /* If /~ or // appears, discard everything through first slash. */
1447 file_name_absolute_p (const char *filename
)
1450 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1452 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1453 && IS_DIRECTORY_SEP (filename
[2]))
1459 search_embedded_absfilename (char *nm
, char *endp
)
1463 for (p
= nm
+ 1; p
< endp
; p
++)
1466 || IS_DIRECTORY_SEP (p
[-1]))
1467 && file_name_absolute_p (p
)
1468 #if defined (WINDOWSNT) || defined(CYGWIN)
1469 /* // at start of file name is meaningful in Apollo,
1470 WindowsNT and Cygwin systems. */
1471 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1472 #endif /* not (WINDOWSNT || CYGWIN) */
1475 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1476 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
1478 char *o
= alloca (s
- p
+ 1);
1480 memcpy (o
, p
, s
- p
);
1483 /* If we have ~user and `user' exists, discard
1484 everything up to ~. But if `user' does not exist, leave
1485 ~user alone, it might be a literal file name. */
1487 pw
= getpwnam (o
+ 1);
1499 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1500 Ssubstitute_in_file_name
, 1, 1, 0,
1501 doc
: /* Substitute environment variables referred to in FILENAME.
1502 `$FOO' where FOO is an environment variable name means to substitute
1503 the value of that variable. The variable name should be terminated
1504 with a character not a letter, digit or underscore; otherwise, enclose
1505 the entire variable name in braces.
1507 If `/~' appears, all of FILENAME through that `/' is discarded.
1508 If `//' appears, everything up to and including the first of
1509 those `/' is discarded. */)
1510 (Lisp_Object filename
)
1514 register char *s
, *p
, *o
, *x
, *endp
;
1515 char *target
= NULL
;
1517 int substituted
= 0;
1520 Lisp_Object handler
;
1522 CHECK_STRING (filename
);
1524 multibyte
= STRING_MULTIBYTE (filename
);
1526 /* If the file name has special constructs in it,
1527 call the corresponding file handler. */
1528 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1529 if (!NILP (handler
))
1530 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
1532 /* Always work on a copy of the string, in case GC happens during
1533 decode of environment variables, causing the original Lisp_String
1534 data to be relocated. */
1535 nm
= (char *) alloca (SBYTES (filename
) + 1);
1536 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1539 dostounix_filename (nm
);
1540 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1542 endp
= nm
+ SBYTES (filename
);
1544 /* If /~ or // appears, discard everything through first slash. */
1545 p
= search_embedded_absfilename (nm
, endp
);
1547 /* Start over with the new string, so we check the file-name-handler
1548 again. Important with filenames like "/home/foo//:/hello///there"
1549 which whould substitute to "/:/hello///there" rather than "/there". */
1550 return Fsubstitute_in_file_name
1551 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1553 /* See if any variables are substituted into the string
1554 and find the total length of their values in `total' */
1556 for (p
= nm
; p
!= endp
;)
1566 /* "$$" means a single "$" */
1575 while (p
!= endp
&& *p
!= '}') p
++;
1576 if (*p
!= '}') goto missingclose
;
1582 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1586 /* Copy out the variable name */
1587 target
= (char *) alloca (s
- o
+ 1);
1588 strncpy (target
, o
, s
- o
);
1591 strupr (target
); /* $home == $HOME etc. */
1594 /* Get variable value */
1595 o
= egetenv (target
);
1598 /* Don't try to guess a maximum length - UTF8 can use up to
1599 four bytes per character. This code is unlikely to run
1600 in a situation that requires performance, so decoding the
1601 env variables twice should be acceptable. Note that
1602 decoding may cause a garbage collect. */
1603 Lisp_Object orig
, decoded
;
1604 orig
= make_unibyte_string (o
, strlen (o
));
1605 decoded
= DECODE_FILE (orig
);
1606 total
+= SBYTES (decoded
);
1616 /* If substitution required, recopy the string and do it */
1617 /* Make space in stack frame for the new copy */
1618 xnm
= (char *) alloca (SBYTES (filename
) + total
+ 1);
1621 /* Copy the rest of the name through, replacing $ constructs with values */
1638 while (p
!= endp
&& *p
!= '}') p
++;
1639 if (*p
!= '}') goto missingclose
;
1645 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1649 /* Copy out the variable name */
1650 target
= (char *) alloca (s
- o
+ 1);
1651 strncpy (target
, o
, s
- o
);
1654 strupr (target
); /* $home == $HOME etc. */
1657 /* Get variable value */
1658 o
= egetenv (target
);
1662 strcpy (x
, target
); x
+= strlen (target
);
1666 Lisp_Object orig
, decoded
;
1667 int orig_length
, decoded_length
;
1668 orig_length
= strlen (o
);
1669 orig
= make_unibyte_string (o
, orig_length
);
1670 decoded
= DECODE_FILE (orig
);
1671 decoded_length
= SBYTES (decoded
);
1672 strncpy (x
, SSDATA (decoded
), decoded_length
);
1673 x
+= decoded_length
;
1675 /* If environment variable needed decoding, return value
1676 needs to be multibyte. */
1677 if (decoded_length
!= orig_length
1678 || strncmp (SSDATA (decoded
), o
, orig_length
))
1685 /* If /~ or // appears, discard everything through first slash. */
1686 while ((p
= search_embedded_absfilename (xnm
, x
)))
1687 /* This time we do not start over because we've already expanded envvars
1688 and replaced $$ with $. Maybe we should start over as well, but we'd
1689 need to quote some $ to $$ first. */
1692 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1695 error ("Bad format environment-variable substitution");
1697 error ("Missing \"}\" in environment-variable substitution");
1699 error ("Substituting nonexistent environment variable \"%s\"", target
);
1705 /* A slightly faster and more convenient way to get
1706 (directory-file-name (expand-file-name FOO)). */
1709 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1711 register Lisp_Object absname
;
1713 absname
= Fexpand_file_name (filename
, defdir
);
1715 /* Remove final slash, if any (unless this is the root dir).
1716 stat behaves differently depending! */
1717 if (SCHARS (absname
) > 1
1718 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1719 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
1720 /* We cannot take shortcuts; they might be wrong for magic file names. */
1721 absname
= Fdirectory_file_name (absname
);
1725 /* Signal an error if the file ABSNAME already exists.
1726 If INTERACTIVE is nonzero, ask the user whether to proceed,
1727 and bypass the error if the user says to go ahead.
1728 QUERYSTRING is a name for the action that is being considered
1731 *STATPTR is used to store the stat information if the file exists.
1732 If the file does not exist, STATPTR->st_mode is set to 0.
1733 If STATPTR is null, we don't store into it.
1735 If QUICK is nonzero, we ask for y or n, not yes or no. */
1738 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1739 int interactive
, struct stat
*statptr
, int quick
)
1741 register Lisp_Object tem
, encoded_filename
;
1742 struct stat statbuf
;
1743 struct gcpro gcpro1
;
1745 encoded_filename
= ENCODE_FILE (absname
);
1747 /* stat is a good way to tell whether the file exists,
1748 regardless of what access permissions it has. */
1749 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1752 xsignal2 (Qfile_already_exists
,
1753 build_string ("File already exists"), absname
);
1755 tem
= format2 ("File %s already exists; %s anyway? ",
1756 absname
, build_string (querystring
));
1758 tem
= call1 (intern ("y-or-n-p"), tem
);
1760 tem
= do_yes_or_no_p (tem
);
1763 xsignal2 (Qfile_already_exists
,
1764 build_string ("File already exists"), absname
);
1771 statptr
->st_mode
= 0;
1776 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1777 "fCopy file: \nGCopy %s to file: \np\nP",
1778 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1779 If NEWNAME names a directory, copy FILE there.
1781 This function always sets the file modes of the output file to match
1784 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1785 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1786 signal a `file-already-exists' error without overwriting. If
1787 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1788 about overwriting; this is what happens in interactive use with M-x.
1789 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1792 Fourth arg KEEP-TIME non-nil means give the output file the same
1793 last-modified time as the old one. (This works on only some systems.)
1795 A prefix arg makes KEEP-TIME non-nil.
1797 If PRESERVE-UID-GID is non-nil, we try to transfer the
1798 uid and gid of FILE to NEWNAME.
1800 If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
1801 on the system, we copy the SELinux context of FILE to NEWNAME. */)
1802 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
, Lisp_Object keep_time
, Lisp_Object preserve_uid_gid
, Lisp_Object preserve_selinux_context
)
1805 char buf
[16 * 1024];
1806 struct stat st
, out_st
;
1807 Lisp_Object handler
;
1808 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1809 int count
= SPECPDL_INDEX ();
1810 int input_file_statable_p
;
1811 Lisp_Object encoded_file
, encoded_newname
;
1813 security_context_t con
;
1814 int fail
, conlength
= 0;
1817 encoded_file
= encoded_newname
= Qnil
;
1818 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1819 CHECK_STRING (file
);
1820 CHECK_STRING (newname
);
1822 if (!NILP (Ffile_directory_p (newname
)))
1823 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1825 newname
= Fexpand_file_name (newname
, Qnil
);
1827 file
= Fexpand_file_name (file
, Qnil
);
1829 /* If the input file name has special constructs in it,
1830 call the corresponding file handler. */
1831 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1832 /* Likewise for output file name. */
1834 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1835 if (!NILP (handler
))
1836 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1837 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1838 preserve_selinux_context
));
1840 encoded_file
= ENCODE_FILE (file
);
1841 encoded_newname
= ENCODE_FILE (newname
);
1843 if (NILP (ok_if_already_exists
)
1844 || INTEGERP (ok_if_already_exists
))
1845 barf_or_query_if_file_exists (newname
, "copy to it",
1846 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1847 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1851 if (!CopyFile (SDATA (encoded_file
),
1852 SDATA (encoded_newname
),
1854 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1855 /* CopyFile retains the timestamp by default. */
1856 else if (NILP (keep_time
))
1862 EMACS_GET_TIME (now
);
1863 filename
= SDATA (encoded_newname
);
1865 /* Ensure file is writable while its modified time is set. */
1866 attributes
= GetFileAttributes (filename
);
1867 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1868 if (set_file_times (filename
, now
, now
))
1870 /* Restore original attributes. */
1871 SetFileAttributes (filename
, attributes
);
1872 xsignal2 (Qfile_date_error
,
1873 build_string ("Cannot set file date"), newname
);
1875 /* Restore original attributes. */
1876 SetFileAttributes (filename
, attributes
);
1878 #else /* not WINDOWSNT */
1880 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
1884 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1886 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1888 /* We can only copy regular files and symbolic links. Other files are not
1890 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
1893 if (!NILP (preserve_selinux_context
) && is_selinux_enabled ())
1895 conlength
= fgetfilecon (ifd
, &con
);
1896 if (conlength
== -1)
1897 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
1901 if (out_st
.st_mode
!= 0
1902 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
1905 report_file_error ("Input and output files are the same",
1906 Fcons (file
, Fcons (newname
, Qnil
)));
1909 if (input_file_statable_p
)
1911 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
1913 #if defined (EISDIR)
1914 /* Get a better looking error message. */
1917 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
1922 /* System's default file type was set to binary by _fmode in emacs.c. */
1923 ofd
= emacs_open (SDATA (encoded_newname
),
1924 O_WRONLY
| O_TRUNC
| O_CREAT
1925 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
1926 S_IREAD
| S_IWRITE
);
1927 #else /* not MSDOS */
1928 ofd
= emacs_open (SSDATA (encoded_newname
),
1929 O_WRONLY
| O_TRUNC
| O_CREAT
1930 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
1932 #endif /* not MSDOS */
1934 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
1936 record_unwind_protect (close_file_unwind
, make_number (ofd
));
1940 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
1941 if (emacs_write (ofd
, buf
, n
) != n
)
1942 report_file_error ("I/O error", Fcons (newname
, Qnil
));
1946 /* Preserve the original file modes, and if requested, also its
1948 if (input_file_statable_p
)
1950 if (! NILP (preserve_uid_gid
))
1951 fchown (ofd
, st
.st_uid
, st
.st_gid
);
1952 fchmod (ofd
, st
.st_mode
& 07777);
1954 #endif /* not MSDOS */
1959 /* Set the modified context back to the file. */
1960 fail
= fsetfilecon (ofd
, con
);
1962 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
1968 /* Closing the output clobbers the file times on some systems. */
1969 if (emacs_close (ofd
) < 0)
1970 report_file_error ("I/O error", Fcons (newname
, Qnil
));
1972 if (input_file_statable_p
)
1974 if (!NILP (keep_time
))
1976 EMACS_TIME atime
, mtime
;
1977 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
1978 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
1979 if (set_file_times (SSDATA (encoded_newname
),
1981 xsignal2 (Qfile_date_error
,
1982 build_string ("Cannot set file date"), newname
);
1989 if (input_file_statable_p
)
1991 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
1992 and if it can't, it tells so. Otherwise, under MSDOS we usually
1993 get only the READ bit, which will make the copied file read-only,
1994 so it's better not to chmod at all. */
1995 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
1996 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
1999 #endif /* not WINDOWSNT */
2001 /* Discard the unwind protects. */
2002 specpdl_ptr
= specpdl
+ count
;
2008 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2009 Smake_directory_internal
, 1, 1, 0,
2010 doc
: /* Create a new directory named DIRECTORY. */)
2011 (Lisp_Object directory
)
2014 Lisp_Object handler
;
2015 Lisp_Object encoded_dir
;
2017 CHECK_STRING (directory
);
2018 directory
= Fexpand_file_name (directory
, Qnil
);
2020 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2021 if (!NILP (handler
))
2022 return call2 (handler
, Qmake_directory_internal
, directory
);
2024 encoded_dir
= ENCODE_FILE (directory
);
2026 dir
= SSDATA (encoded_dir
);
2029 if (mkdir (dir
) != 0)
2031 if (mkdir (dir
, 0777) != 0)
2033 report_file_error ("Creating directory", list1 (directory
));
2038 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2039 Sdelete_directory_internal
, 1, 1, 0,
2040 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2041 (Lisp_Object directory
)
2044 Lisp_Object handler
;
2045 Lisp_Object encoded_dir
;
2047 CHECK_STRING (directory
);
2048 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2049 encoded_dir
= ENCODE_FILE (directory
);
2050 dir
= SSDATA (encoded_dir
);
2052 if (rmdir (dir
) != 0)
2053 report_file_error ("Removing directory", list1 (directory
));
2058 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2059 "(list (read-file-name \
2060 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2061 \"Move file to trash: \" \"Delete file: \") \
2062 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2063 (null current-prefix-arg))",
2064 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2065 If file has multiple names, it continues to exist with the other names.
2066 TRASH non-nil means to trash the file instead of deleting, provided
2067 `delete-by-moving-to-trash' is non-nil.
2069 When called interactively, TRASH is t if no prefix argument is given.
2070 With a prefix argument, TRASH is nil. */)
2071 (Lisp_Object filename
, Lisp_Object trash
)
2073 Lisp_Object handler
;
2074 Lisp_Object encoded_file
;
2075 struct gcpro gcpro1
;
2078 if (!NILP (Ffile_directory_p (filename
))
2079 && NILP (Ffile_symlink_p (filename
)))
2080 xsignal2 (Qfile_error
,
2081 build_string ("Removing old name: is a directory"),
2084 filename
= Fexpand_file_name (filename
, Qnil
);
2086 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2087 if (!NILP (handler
))
2088 return call3 (handler
, Qdelete_file
, filename
, trash
);
2090 if (delete_by_moving_to_trash
&& !NILP (trash
))
2091 return call1 (Qmove_file_to_trash
, filename
);
2093 encoded_file
= ENCODE_FILE (filename
);
2095 if (0 > unlink (SSDATA (encoded_file
)))
2096 report_file_error ("Removing old name", list1 (filename
));
2101 internal_delete_file_1 (Lisp_Object ignore
)
2106 /* Delete file FILENAME, returning 1 if successful and 0 if failed.
2107 This ignores `delete-by-moving-to-trash'. */
2110 internal_delete_file (Lisp_Object filename
)
2114 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2115 Qt
, internal_delete_file_1
);
2119 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2120 "fRename file: \nGRename %s to file: \np",
2121 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2122 If file has names other than FILE, it continues to have those names.
2123 Signals a `file-already-exists' error if a file NEWNAME already exists
2124 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2125 A number as third arg means request confirmation if NEWNAME already exists.
2126 This is what happens in interactive use with M-x. */)
2127 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2129 Lisp_Object handler
;
2130 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2131 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2133 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2134 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2135 CHECK_STRING (file
);
2136 CHECK_STRING (newname
);
2137 file
= Fexpand_file_name (file
, Qnil
);
2139 if ((!NILP (Ffile_directory_p (newname
)))
2141 /* If the file names are identical but for the case,
2142 don't attempt to move directory to itself. */
2143 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2147 Lisp_Object fname
= NILP (Ffile_directory_p (file
))
2148 ? file
: Fdirectory_file_name (file
);
2149 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2152 newname
= Fexpand_file_name (newname
, Qnil
);
2154 /* If the file name has special constructs in it,
2155 call the corresponding file handler. */
2156 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2158 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2159 if (!NILP (handler
))
2160 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2161 file
, newname
, ok_if_already_exists
));
2163 encoded_file
= ENCODE_FILE (file
);
2164 encoded_newname
= ENCODE_FILE (newname
);
2167 /* If the file names are identical but for the case, don't ask for
2168 confirmation: they simply want to change the letter-case of the
2170 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2172 if (NILP (ok_if_already_exists
)
2173 || INTEGERP (ok_if_already_exists
))
2174 barf_or_query_if_file_exists (newname
, "rename to it",
2175 INTEGERP (ok_if_already_exists
), 0, 0);
2176 if (0 > rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2182 symlink_target
= Ffile_symlink_p (file
);
2183 if (! NILP (symlink_target
))
2184 Fmake_symbolic_link (symlink_target
, newname
,
2185 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2188 if (!NILP (Ffile_directory_p (file
)))
2189 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2191 /* We have already prompted if it was an integer, so don't
2192 have copy-file prompt again. */
2193 Fcopy_file (file
, newname
,
2194 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2197 count
= SPECPDL_INDEX ();
2198 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2200 if (!NILP (Ffile_directory_p (file
))
2202 && NILP (symlink_target
)
2205 call2 (Qdelete_directory
, file
, Qt
);
2207 Fdelete_file (file
, Qnil
);
2208 unbind_to (count
, Qnil
);
2211 report_file_error ("Renaming", list2 (file
, newname
));
2217 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2218 "fAdd name to file: \nGName to add to %s: \np",
2219 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2220 Signals a `file-already-exists' error if a file NEWNAME already exists
2221 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2222 A number as third arg means request confirmation if NEWNAME already exists.
2223 This is what happens in interactive use with M-x. */)
2224 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2226 Lisp_Object handler
;
2227 Lisp_Object encoded_file
, encoded_newname
;
2228 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2230 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2231 encoded_file
= encoded_newname
= Qnil
;
2232 CHECK_STRING (file
);
2233 CHECK_STRING (newname
);
2234 file
= Fexpand_file_name (file
, Qnil
);
2236 if (!NILP (Ffile_directory_p (newname
)))
2237 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2239 newname
= Fexpand_file_name (newname
, Qnil
);
2241 /* If the file name has special constructs in it,
2242 call the corresponding file handler. */
2243 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2244 if (!NILP (handler
))
2245 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2246 newname
, ok_if_already_exists
));
2248 /* If the new name has special constructs in it,
2249 call the corresponding file handler. */
2250 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2251 if (!NILP (handler
))
2252 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2253 newname
, ok_if_already_exists
));
2255 encoded_file
= ENCODE_FILE (file
);
2256 encoded_newname
= ENCODE_FILE (newname
);
2258 if (NILP (ok_if_already_exists
)
2259 || INTEGERP (ok_if_already_exists
))
2260 barf_or_query_if_file_exists (newname
, "make it a new name",
2261 INTEGERP (ok_if_already_exists
), 0, 0);
2263 unlink (SSDATA (newname
));
2264 if (0 > link (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2265 report_file_error ("Adding new name", list2 (file
, newname
));
2271 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2272 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2273 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2274 Both args must be strings.
2275 Signals a `file-already-exists' error if a file LINKNAME already exists
2276 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2277 A number as third arg means request confirmation if LINKNAME already exists.
2278 This happens for interactive use with M-x. */)
2279 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2281 Lisp_Object handler
;
2282 Lisp_Object encoded_filename
, encoded_linkname
;
2283 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2285 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2286 encoded_filename
= encoded_linkname
= Qnil
;
2287 CHECK_STRING (filename
);
2288 CHECK_STRING (linkname
);
2289 /* If the link target has a ~, we must expand it to get
2290 a truly valid file name. Otherwise, do not expand;
2291 we want to permit links to relative file names. */
2292 if (SREF (filename
, 0) == '~')
2293 filename
= Fexpand_file_name (filename
, Qnil
);
2295 if (!NILP (Ffile_directory_p (linkname
)))
2296 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2298 linkname
= Fexpand_file_name (linkname
, Qnil
);
2300 /* If the file name has special constructs in it,
2301 call the corresponding file handler. */
2302 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2303 if (!NILP (handler
))
2304 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2305 linkname
, ok_if_already_exists
));
2307 /* If the new link name has special constructs in it,
2308 call the corresponding file handler. */
2309 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2310 if (!NILP (handler
))
2311 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2312 linkname
, ok_if_already_exists
));
2315 encoded_filename
= ENCODE_FILE (filename
);
2316 encoded_linkname
= ENCODE_FILE (linkname
);
2318 if (NILP (ok_if_already_exists
)
2319 || INTEGERP (ok_if_already_exists
))
2320 barf_or_query_if_file_exists (linkname
, "make it a link",
2321 INTEGERP (ok_if_already_exists
), 0, 0);
2322 if (0 > symlink (SSDATA (encoded_filename
),
2323 SSDATA (encoded_linkname
)))
2325 /* If we didn't complain already, silently delete existing file. */
2326 if (errno
== EEXIST
)
2328 unlink (SSDATA (encoded_linkname
));
2329 if (0 <= symlink (SSDATA (encoded_filename
),
2330 SSDATA (encoded_linkname
)))
2337 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2344 xsignal1 (Qfile_error
, build_string ("Symbolic links are not supported"));
2346 #endif /* S_IFLNK */
2350 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2352 doc
: /* Return t if file FILENAME specifies an absolute file name.
2353 On Unix, this is a name starting with a `/' or a `~'. */)
2354 (Lisp_Object filename
)
2356 CHECK_STRING (filename
);
2357 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2360 /* Return nonzero if file FILENAME exists and can be executed. */
2363 check_executable (char *filename
)
2366 int len
= strlen (filename
);
2369 if (stat (filename
, &st
) < 0)
2371 return ((st
.st_mode
& S_IEXEC
) != 0);
2372 #else /* not DOS_NT */
2373 #ifdef HAVE_EUIDACCESS
2374 return (euidaccess (filename
, 1) >= 0);
2376 /* Access isn't quite right because it uses the real uid
2377 and we really want to test with the effective uid.
2378 But Unix doesn't give us a right way to do it. */
2379 return (access (filename
, 1) >= 0);
2381 #endif /* not DOS_NT */
2384 /* Return nonzero if file FILENAME exists and can be written. */
2387 check_writable (const char *filename
)
2391 if (stat (filename
, &st
) < 0)
2393 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2394 #else /* not MSDOS */
2395 #ifdef HAVE_EUIDACCESS
2396 return (euidaccess (filename
, 2) >= 0);
2398 /* Access isn't quite right because it uses the real uid
2399 and we really want to test with the effective uid.
2400 But Unix doesn't give us a right way to do it.
2401 Opening with O_WRONLY could work for an ordinary file,
2402 but would lose for directories. */
2403 return (access (filename
, 2) >= 0);
2405 #endif /* not MSDOS */
2408 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2409 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2410 See also `file-readable-p' and `file-attributes'.
2411 This returns nil for a symlink to a nonexistent file.
2412 Use `file-symlink-p' to test for such links. */)
2413 (Lisp_Object filename
)
2415 Lisp_Object absname
;
2416 Lisp_Object handler
;
2417 struct stat statbuf
;
2419 CHECK_STRING (filename
);
2420 absname
= Fexpand_file_name (filename
, Qnil
);
2422 /* If the file name has special constructs in it,
2423 call the corresponding file handler. */
2424 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2425 if (!NILP (handler
))
2426 return call2 (handler
, Qfile_exists_p
, absname
);
2428 absname
= ENCODE_FILE (absname
);
2430 return (stat (SSDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2433 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2434 doc
: /* Return t if FILENAME can be executed by you.
2435 For a directory, this means you can access files in that directory. */)
2436 (Lisp_Object filename
)
2438 Lisp_Object absname
;
2439 Lisp_Object handler
;
2441 CHECK_STRING (filename
);
2442 absname
= Fexpand_file_name (filename
, Qnil
);
2444 /* If the file name has special constructs in it,
2445 call the corresponding file handler. */
2446 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2447 if (!NILP (handler
))
2448 return call2 (handler
, Qfile_executable_p
, absname
);
2450 absname
= ENCODE_FILE (absname
);
2452 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2455 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2456 doc
: /* Return t if file FILENAME exists and you can read it.
2457 See also `file-exists-p' and `file-attributes'. */)
2458 (Lisp_Object filename
)
2460 Lisp_Object absname
;
2461 Lisp_Object handler
;
2464 struct stat statbuf
;
2466 CHECK_STRING (filename
);
2467 absname
= Fexpand_file_name (filename
, Qnil
);
2469 /* If the file name has special constructs in it,
2470 call the corresponding file handler. */
2471 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2472 if (!NILP (handler
))
2473 return call2 (handler
, Qfile_readable_p
, absname
);
2475 absname
= ENCODE_FILE (absname
);
2477 #if defined(DOS_NT) || defined(macintosh)
2478 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2480 if (access (SDATA (absname
), 0) == 0)
2483 #else /* not DOS_NT and not macintosh */
2485 #if defined (S_IFIFO) && defined (O_NONBLOCK)
2486 /* Opening a fifo without O_NONBLOCK can wait.
2487 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2488 except in the case of a fifo, on a system which handles it. */
2489 desc
= stat (SSDATA (absname
), &statbuf
);
2492 if (S_ISFIFO (statbuf
.st_mode
))
2493 flags
|= O_NONBLOCK
;
2495 desc
= emacs_open (SSDATA (absname
), flags
, 0);
2500 #endif /* not DOS_NT and not macintosh */
2503 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2505 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2506 doc
: /* Return t if file FILENAME can be written or created by you. */)
2507 (Lisp_Object filename
)
2509 Lisp_Object absname
, dir
, encoded
;
2510 Lisp_Object handler
;
2511 struct stat statbuf
;
2513 CHECK_STRING (filename
);
2514 absname
= Fexpand_file_name (filename
, Qnil
);
2516 /* If the file name has special constructs in it,
2517 call the corresponding file handler. */
2518 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2519 if (!NILP (handler
))
2520 return call2 (handler
, Qfile_writable_p
, absname
);
2522 encoded
= ENCODE_FILE (absname
);
2523 if (stat (SSDATA (encoded
), &statbuf
) >= 0)
2524 return (check_writable (SSDATA (encoded
))
2527 dir
= Ffile_name_directory (absname
);
2530 dir
= Fdirectory_file_name (dir
);
2533 dir
= ENCODE_FILE (dir
);
2535 /* The read-only attribute of the parent directory doesn't affect
2536 whether a file or directory can be created within it. Some day we
2537 should check ACLs though, which do affect this. */
2538 if (stat (SDATA (dir
), &statbuf
) < 0)
2540 return S_ISDIR (statbuf
.st_mode
) ? Qt
: Qnil
;
2542 return (check_writable (!NILP (dir
) ? SSDATA (dir
) : "")
2547 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2548 doc
: /* Access file FILENAME, and get an error if that does not work.
2549 The second argument STRING is used in the error message.
2550 If there is no error, returns nil. */)
2551 (Lisp_Object filename
, Lisp_Object string
)
2553 Lisp_Object handler
, encoded_filename
, absname
;
2556 CHECK_STRING (filename
);
2557 absname
= Fexpand_file_name (filename
, Qnil
);
2559 CHECK_STRING (string
);
2561 /* If the file name has special constructs in it,
2562 call the corresponding file handler. */
2563 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2564 if (!NILP (handler
))
2565 return call3 (handler
, Qaccess_file
, absname
, string
);
2567 encoded_filename
= ENCODE_FILE (absname
);
2569 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2571 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2577 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2578 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2579 The value is the link target, as a string.
2580 Otherwise it returns nil.
2582 This function returns t when given the name of a symlink that
2583 points to a nonexistent file. */)
2584 (Lisp_Object filename
)
2586 Lisp_Object handler
;
2588 CHECK_STRING (filename
);
2589 filename
= Fexpand_file_name (filename
, Qnil
);
2591 /* If the file name has special constructs in it,
2592 call the corresponding file handler. */
2593 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2594 if (!NILP (handler
))
2595 return call2 (handler
, Qfile_symlink_p
, filename
);
2604 filename
= ENCODE_FILE (filename
);
2611 buf
= (char *) xrealloc (buf
, bufsize
);
2612 memset (buf
, 0, bufsize
);
2615 valsize
= readlink (SSDATA (filename
), buf
, bufsize
);
2619 /* HP-UX reports ERANGE if buffer is too small. */
2620 if (errno
== ERANGE
)
2630 while (valsize
>= bufsize
);
2632 val
= make_string (buf
, valsize
);
2633 if (buf
[0] == '/' && strchr (buf
, ':'))
2634 val
= concat2 (build_string ("/:"), val
);
2636 val
= DECODE_FILE (val
);
2639 #else /* not S_IFLNK */
2641 #endif /* not S_IFLNK */
2644 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2645 doc
: /* Return t if FILENAME names an existing directory.
2646 Symbolic links to directories count as directories.
2647 See `file-symlink-p' to distinguish symlinks. */)
2648 (Lisp_Object filename
)
2650 register Lisp_Object absname
;
2652 Lisp_Object handler
;
2654 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2656 /* If the file name has special constructs in it,
2657 call the corresponding file handler. */
2658 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2659 if (!NILP (handler
))
2660 return call2 (handler
, Qfile_directory_p
, absname
);
2662 absname
= ENCODE_FILE (absname
);
2664 if (stat (SSDATA (absname
), &st
) < 0)
2666 return S_ISDIR (st
.st_mode
) ? Qt
: Qnil
;
2669 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
2670 doc
: /* Return t if file FILENAME names a directory you can open.
2671 For the value to be t, FILENAME must specify the name of a directory as a file,
2672 and the directory must allow you to open files in it. In order to use a
2673 directory as a buffer's current directory, this predicate must return true.
2674 A directory name spec may be given instead; then the value is t
2675 if the directory so specified exists and really is a readable and
2676 searchable directory. */)
2677 (Lisp_Object filename
)
2679 Lisp_Object handler
;
2681 struct gcpro gcpro1
;
2683 /* If the file name has special constructs in it,
2684 call the corresponding file handler. */
2685 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2686 if (!NILP (handler
))
2687 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2690 tem
= (NILP (Ffile_directory_p (filename
))
2691 || NILP (Ffile_executable_p (filename
)));
2693 return tem
? Qnil
: Qt
;
2696 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2697 doc
: /* Return t if FILENAME names a regular file.
2698 This is the sort of file that holds an ordinary stream of data bytes.
2699 Symbolic links to regular files count as regular files.
2700 See `file-symlink-p' to distinguish symlinks. */)
2701 (Lisp_Object filename
)
2703 register Lisp_Object absname
;
2705 Lisp_Object handler
;
2707 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2709 /* If the file name has special constructs in it,
2710 call the corresponding file handler. */
2711 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2712 if (!NILP (handler
))
2713 return call2 (handler
, Qfile_regular_p
, absname
);
2715 absname
= ENCODE_FILE (absname
);
2720 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2722 /* Tell stat to use expensive method to get accurate info. */
2723 Vw32_get_true_file_attributes
= Qt
;
2724 result
= stat (SDATA (absname
), &st
);
2725 Vw32_get_true_file_attributes
= tem
;
2729 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2732 if (stat (SSDATA (absname
), &st
) < 0)
2734 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2738 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2739 Sfile_selinux_context
, 1, 1, 0,
2740 doc
: /* Return SELinux context of file named FILENAME,
2741 as a list ("user", "role", "type", "range"). Return (nil, nil, nil, nil)
2742 if file does not exist, is not accessible, or SELinux is disabled */)
2743 (Lisp_Object filename
)
2745 Lisp_Object absname
;
2746 Lisp_Object values
[4];
2747 Lisp_Object handler
;
2749 security_context_t con
;
2754 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2756 /* If the file name has special constructs in it,
2757 call the corresponding file handler. */
2758 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2759 if (!NILP (handler
))
2760 return call2 (handler
, Qfile_selinux_context
, absname
);
2762 absname
= ENCODE_FILE (absname
);
2769 if (is_selinux_enabled ())
2771 conlength
= lgetfilecon (SDATA (absname
), &con
);
2774 context
= context_new (con
);
2775 if (context_user_get (context
))
2776 values
[0] = build_string (context_user_get (context
));
2777 if (context_role_get (context
))
2778 values
[1] = build_string (context_role_get (context
));
2779 if (context_type_get (context
))
2780 values
[2] = build_string (context_type_get (context
));
2781 if (context_range_get (context
))
2782 values
[3] = build_string (context_range_get (context
));
2783 context_free (context
);
2790 return Flist (sizeof(values
) / sizeof(values
[0]), values
);
2793 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2794 Sset_file_selinux_context
, 2, 2, 0,
2795 doc
: /* Set SELinux context of file named FILENAME to CONTEXT
2796 as a list ("user", "role", "type", "range"). Has no effect if SELinux
2798 (Lisp_Object filename
, Lisp_Object context
)
2800 Lisp_Object absname
, encoded_absname
;
2801 Lisp_Object handler
;
2802 Lisp_Object user
= CAR_SAFE (context
);
2803 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2804 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2805 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2807 security_context_t con
;
2808 int fail
, conlength
;
2809 context_t parsed_con
;
2812 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2814 /* If the file name has special constructs in it,
2815 call the corresponding file handler. */
2816 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2817 if (!NILP (handler
))
2818 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2820 encoded_absname
= ENCODE_FILE (absname
);
2823 if (is_selinux_enabled ())
2825 /* Get current file context. */
2826 conlength
= lgetfilecon (SDATA (encoded_absname
), &con
);
2829 parsed_con
= context_new (con
);
2830 /* Change the parts defined in the parameter.*/
2833 if (context_user_set (parsed_con
, SDATA (user
)))
2834 error ("Doing context_user_set");
2838 if (context_role_set (parsed_con
, SDATA (role
)))
2839 error ("Doing context_role_set");
2843 if (context_type_set (parsed_con
, SDATA (type
)))
2844 error ("Doing context_type_set");
2846 if (STRINGP (range
))
2848 if (context_range_set (parsed_con
, SDATA (range
)))
2849 error ("Doing context_range_set");
2852 /* Set the modified context back to the file. */
2853 fail
= lsetfilecon (SDATA (encoded_absname
), context_str (parsed_con
));
2855 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
2857 context_free (parsed_con
);
2860 report_file_error("Doing lgetfilecon", Fcons (absname
, Qnil
));
2870 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2871 doc
: /* Return mode bits of file named FILENAME, as an integer.
2872 Return nil, if file does not exist or is not accessible. */)
2873 (Lisp_Object filename
)
2875 Lisp_Object absname
;
2877 Lisp_Object handler
;
2879 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2881 /* If the file name has special constructs in it,
2882 call the corresponding file handler. */
2883 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2884 if (!NILP (handler
))
2885 return call2 (handler
, Qfile_modes
, absname
);
2887 absname
= ENCODE_FILE (absname
);
2889 if (stat (SSDATA (absname
), &st
) < 0)
2892 return make_number (st
.st_mode
& 07777);
2895 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2896 "(let ((file (read-file-name \"File: \"))) \
2897 (list file (read-file-modes nil file)))",
2898 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2899 Only the 12 low bits of MODE are used.
2901 Interactively, mode bits are read by `read-file-modes', which accepts
2902 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2903 (Lisp_Object filename
, Lisp_Object mode
)
2905 Lisp_Object absname
, encoded_absname
;
2906 Lisp_Object handler
;
2908 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2909 CHECK_NUMBER (mode
);
2911 /* If the file name has special constructs in it,
2912 call the corresponding file handler. */
2913 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2914 if (!NILP (handler
))
2915 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2917 encoded_absname
= ENCODE_FILE (absname
);
2919 if (chmod (SSDATA (encoded_absname
), XINT (mode
)) < 0)
2920 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2925 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2926 doc
: /* Set the file permission bits for newly created files.
2927 The argument MODE should be an integer; only the low 9 bits are used.
2928 This setting is inherited by subprocesses. */)
2931 CHECK_NUMBER (mode
);
2933 umask ((~ XINT (mode
)) & 0777);
2938 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
2939 doc
: /* Return the default file protection for created files.
2940 The value is an integer. */)
2946 realmask
= umask (0);
2949 XSETINT (value
, (~ realmask
) & 0777);
2954 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
2955 doc
: /* Set times of file FILENAME to TIME.
2956 Set both access and modification times.
2957 Return t on success, else nil.
2958 Use the current time if TIME is nil. TIME is in the format of
2960 (Lisp_Object filename
, Lisp_Object time
)
2962 Lisp_Object absname
, encoded_absname
;
2963 Lisp_Object handler
;
2967 if (! lisp_time_argument (time
, &sec
, &usec
))
2968 error ("Invalid time specification");
2970 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2972 /* If the file name has special constructs in it,
2973 call the corresponding file handler. */
2974 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
2975 if (!NILP (handler
))
2976 return call3 (handler
, Qset_file_times
, absname
, time
);
2978 encoded_absname
= ENCODE_FILE (absname
);
2983 EMACS_SET_SECS (t
, sec
);
2984 EMACS_SET_USECS (t
, usec
);
2986 if (set_file_times (SSDATA (encoded_absname
), t
, t
))
2991 /* Setting times on a directory always fails. */
2992 if (stat (SSDATA (encoded_absname
), &st
) == 0 && S_ISDIR (st
.st_mode
))
2995 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3004 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3005 doc
: /* Tell Unix to finish all pending disk updates. */)
3012 #endif /* HAVE_SYNC */
3014 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3015 doc
: /* Return t if file FILE1 is newer than file FILE2.
3016 If FILE1 does not exist, the answer is nil;
3017 otherwise, if FILE2 does not exist, the answer is t. */)
3018 (Lisp_Object file1
, Lisp_Object file2
)
3020 Lisp_Object absname1
, absname2
;
3023 Lisp_Object handler
;
3024 struct gcpro gcpro1
, gcpro2
;
3026 CHECK_STRING (file1
);
3027 CHECK_STRING (file2
);
3030 GCPRO2 (absname1
, file2
);
3031 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3032 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3035 /* If the file name has special constructs in it,
3036 call the corresponding file handler. */
3037 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3039 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3040 if (!NILP (handler
))
3041 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3043 GCPRO2 (absname1
, absname2
);
3044 absname1
= ENCODE_FILE (absname1
);
3045 absname2
= ENCODE_FILE (absname2
);
3048 if (stat (SSDATA (absname1
), &st
) < 0)
3051 mtime1
= st
.st_mtime
;
3053 if (stat (SSDATA (absname2
), &st
) < 0)
3056 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3059 #ifndef READ_BUF_SIZE
3060 #define READ_BUF_SIZE (64 << 10)
3063 /* This function is called after Lisp functions to decide a coding
3064 system are called, or when they cause an error. Before they are
3065 called, the current buffer is set unibyte and it contains only a
3066 newly inserted text (thus the buffer was empty before the
3069 The functions may set markers, overlays, text properties, or even
3070 alter the buffer contents, change the current buffer.
3072 Here, we reset all those changes by:
3073 o set back the current buffer.
3074 o move all markers and overlays to BEG.
3075 o remove all text properties.
3076 o set back the buffer multibyteness. */
3079 decide_coding_unwind (Lisp_Object unwind_data
)
3081 Lisp_Object multibyte
, undo_list
, buffer
;
3083 multibyte
= XCAR (unwind_data
);
3084 unwind_data
= XCDR (unwind_data
);
3085 undo_list
= XCAR (unwind_data
);
3086 buffer
= XCDR (unwind_data
);
3088 if (current_buffer
!= XBUFFER (buffer
))
3089 set_buffer_internal (XBUFFER (buffer
));
3090 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3091 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3092 BUF_INTERVALS (current_buffer
) = 0;
3093 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3095 /* Now we are safe to change the buffer's multibyteness directly. */
3096 BVAR (current_buffer
, enable_multibyte_characters
) = multibyte
;
3097 BVAR (current_buffer
, undo_list
) = undo_list
;
3103 /* Used to pass values from insert-file-contents to read_non_regular. */
3105 static int non_regular_fd
;
3106 static EMACS_INT non_regular_inserted
;
3107 static EMACS_INT non_regular_nbytes
;
3110 /* Read from a non-regular file.
3111 Read non_regular_nbytes bytes max from non_regular_fd.
3112 Non_regular_inserted specifies where to put the read bytes.
3113 Value is the number of bytes read. */
3116 read_non_regular (Lisp_Object ignore
)
3122 nbytes
= emacs_read (non_regular_fd
,
3123 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3124 + non_regular_inserted
),
3125 non_regular_nbytes
);
3127 return make_number (nbytes
);
3131 /* Condition-case handler used when reading from non-regular files
3132 in insert-file-contents. */
3135 read_non_regular_quit (Lisp_Object ignore
)
3141 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3143 doc
: /* Insert contents of file FILENAME after point.
3144 Returns list of absolute file name and number of characters inserted.
3145 If second argument VISIT is non-nil, the buffer's visited filename and
3146 last save file modtime are set, and it is marked unmodified. If
3147 visiting and the file does not exist, visiting is completed before the
3150 The optional third and fourth arguments BEG and END specify what portion
3151 of the file to insert. These arguments count bytes in the file, not
3152 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3154 If optional fifth argument REPLACE is non-nil, replace the current
3155 buffer contents (in the accessible portion) with the file contents.
3156 This is better than simply deleting and inserting the whole thing
3157 because (1) it preserves some marker positions and (2) it puts less data
3158 in the undo list. When REPLACE is non-nil, the second return value is
3159 the number of characters that replace previous buffer contents.
3161 This function does code conversion according to the value of
3162 `coding-system-for-read' or `file-coding-system-alist', and sets the
3163 variable `last-coding-system-used' to the coding system actually used. */)
3164 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3168 EMACS_INT inserted
= 0;
3170 register EMACS_INT how_much
;
3171 register EMACS_INT unprocessed
;
3172 int count
= SPECPDL_INDEX ();
3173 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3174 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3176 EMACS_INT total
= 0;
3177 int not_regular
= 0;
3178 char read_buf
[READ_BUF_SIZE
];
3179 struct coding_system coding
;
3180 char buffer
[1 << 14];
3181 int replace_handled
= 0;
3182 int set_coding_system
= 0;
3183 Lisp_Object coding_system
;
3185 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3186 int we_locked_file
= 0;
3187 int deferred_remove_unwind_protect
= 0;
3189 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3190 error ("Cannot do file visiting in an indirect buffer");
3192 if (!NILP (BVAR (current_buffer
, read_only
)))
3193 Fbarf_if_buffer_read_only ();
3197 orig_filename
= Qnil
;
3200 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3202 CHECK_STRING (filename
);
3203 filename
= Fexpand_file_name (filename
, Qnil
);
3205 /* The value Qnil means that the coding system is not yet
3207 coding_system
= Qnil
;
3209 /* If the file name has special constructs in it,
3210 call the corresponding file handler. */
3211 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3212 if (!NILP (handler
))
3214 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3215 visit
, beg
, end
, replace
);
3216 if (CONSP (val
) && CONSP (XCDR (val
)))
3217 inserted
= XINT (XCAR (XCDR (val
)));
3221 orig_filename
= filename
;
3222 filename
= ENCODE_FILE (filename
);
3228 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3230 /* Tell stat to use expensive method to get accurate info. */
3231 Vw32_get_true_file_attributes
= Qt
;
3232 total
= stat (SSDATA (filename
), &st
);
3233 Vw32_get_true_file_attributes
= tem
;
3237 if (stat (SSDATA (filename
), &st
) < 0)
3238 #endif /* WINDOWSNT */
3240 if (fd
>= 0) emacs_close (fd
);
3243 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3246 if (!NILP (Vcoding_system_for_read
))
3247 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3251 /* This code will need to be changed in order to work on named
3252 pipes, and it's probably just not worth it. So we should at
3253 least signal an error. */
3254 if (!S_ISREG (st
.st_mode
))
3261 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3262 xsignal2 (Qfile_error
,
3263 build_string ("not a regular file"), orig_filename
);
3267 if ((fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0)) < 0)
3270 /* Replacement should preserve point as it preserves markers. */
3271 if (!NILP (replace
))
3272 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3274 record_unwind_protect (close_file_unwind
, make_number (fd
));
3276 /* Can happen on any platform that uses long as type of off_t, but allows
3277 file sizes to exceed 2Gb, so give a suitable message. */
3278 if (! not_regular
&& st
.st_size
< 0)
3279 error ("Maximum buffer size exceeded");
3281 /* Prevent redisplay optimizations. */
3282 current_buffer
->clip_changed
= 1;
3286 if (!NILP (beg
) || !NILP (end
))
3287 error ("Attempt to visit less than an entire file");
3288 if (BEG
< Z
&& NILP (replace
))
3289 error ("Cannot do file visiting in a non-empty buffer");
3295 XSETFASTINT (beg
, 0);
3303 XSETINT (end
, st
.st_size
);
3305 /* Arithmetic overflow can occur if an Emacs integer cannot
3306 represent the file size, or if the calculations below
3307 overflow. The calculations below double the file size
3308 twice, so check that it can be multiplied by 4 safely. */
3309 if (XINT (end
) != st
.st_size
3310 /* Actually, it should test either INT_MAX or LONG_MAX
3311 depending on which one is used for EMACS_INT. But in
3312 any case, in practice, this test is redundant with the
3314 || st.st_size > INT_MAX / 4 */)
3315 error ("Maximum buffer size exceeded");
3317 /* The file size returned from stat may be zero, but data
3318 may be readable nonetheless, for example when this is a
3319 file in the /proc filesystem. */
3320 if (st
.st_size
== 0)
3321 XSETINT (end
, READ_BUF_SIZE
);
3325 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3327 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3328 setup_coding_system (coding_system
, &coding
);
3329 /* Ensure we set Vlast_coding_system_used. */
3330 set_coding_system
= 1;
3334 /* Decide the coding system to use for reading the file now
3335 because we can't use an optimized method for handling
3336 `coding:' tag if the current buffer is not empty. */
3337 if (!NILP (Vcoding_system_for_read
))
3338 coding_system
= Vcoding_system_for_read
;
3341 /* Don't try looking inside a file for a coding system
3342 specification if it is not seekable. */
3343 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3345 /* Find a coding system specified in the heading two
3346 lines or in the tailing several lines of the file.
3347 We assume that the 1K-byte and 3K-byte for heading
3348 and tailing respectively are sufficient for this
3352 if (st
.st_size
<= (1024 * 4))
3353 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3356 nread
= emacs_read (fd
, read_buf
, 1024);
3359 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3360 report_file_error ("Setting file position",
3361 Fcons (orig_filename
, Qnil
));
3362 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3367 error ("IO error reading %s: %s",
3368 SDATA (orig_filename
), emacs_strerror (errno
));
3371 struct buffer
*prev
= current_buffer
;
3375 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3377 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3378 buf
= XBUFFER (buffer
);
3380 delete_all_overlays (buf
);
3381 BVAR (buf
, directory
) = BVAR (current_buffer
, directory
);
3382 BVAR (buf
, read_only
) = Qnil
;
3383 BVAR (buf
, filename
) = Qnil
;
3384 BVAR (buf
, undo_list
) = Qt
;
3385 eassert (buf
->overlays_before
== NULL
);
3386 eassert (buf
->overlays_after
== NULL
);
3388 set_buffer_internal (buf
);
3390 BVAR (buf
, enable_multibyte_characters
) = Qnil
;
3392 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3393 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3394 coding_system
= call2 (Vset_auto_coding_function
,
3395 filename
, make_number (nread
));
3396 set_buffer_internal (prev
);
3398 /* Discard the unwind protect for recovering the
3402 /* Rewind the file for the actual read done later. */
3403 if (lseek (fd
, 0, 0) < 0)
3404 report_file_error ("Setting file position",
3405 Fcons (orig_filename
, Qnil
));
3409 if (NILP (coding_system
))
3411 /* If we have not yet decided a coding system, check
3412 file-coding-system-alist. */
3413 Lisp_Object args
[6];
3415 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3416 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3417 coding_system
= Ffind_operation_coding_system (6, args
);
3418 if (CONSP (coding_system
))
3419 coding_system
= XCAR (coding_system
);
3423 if (NILP (coding_system
))
3424 coding_system
= Qundecided
;
3426 CHECK_CODING_SYSTEM (coding_system
);
3428 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3429 /* We must suppress all character code conversion except for
3430 end-of-line conversion. */
3431 coding_system
= raw_text_coding_system (coding_system
);
3433 setup_coding_system (coding_system
, &coding
);
3434 /* Ensure we set Vlast_coding_system_used. */
3435 set_coding_system
= 1;
3438 /* If requested, replace the accessible part of the buffer
3439 with the file contents. Avoid replacing text at the
3440 beginning or end of the buffer that matches the file contents;
3441 that preserves markers pointing to the unchanged parts.
3443 Here we implement this feature in an optimized way
3444 for the case where code conversion is NOT needed.
3445 The following if-statement handles the case of conversion
3446 in a less optimal way.
3448 If the code conversion is "automatic" then we try using this
3449 method and hope for the best.
3450 But if we discover the need for conversion, we give up on this method
3451 and let the following if-statement handle the replace job. */
3454 && (NILP (coding_system
)
3455 || ! CODING_REQUIRE_DECODING (&coding
)))
3457 /* same_at_start and same_at_end count bytes,
3458 because file access counts bytes
3459 and BEG and END count bytes. */
3460 EMACS_INT same_at_start
= BEGV_BYTE
;
3461 EMACS_INT same_at_end
= ZV_BYTE
;
3463 /* There is still a possibility we will find the need to do code
3464 conversion. If that happens, we set this variable to 1 to
3465 give up on handling REPLACE in the optimized way. */
3466 int giveup_match_end
= 0;
3468 if (XINT (beg
) != 0)
3470 if (lseek (fd
, XINT (beg
), 0) < 0)
3471 report_file_error ("Setting file position",
3472 Fcons (orig_filename
, Qnil
));
3477 /* Count how many chars at the start of the file
3478 match the text at the beginning of the buffer. */
3481 EMACS_INT nread
, bufpos
;
3483 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3485 error ("IO error reading %s: %s",
3486 SSDATA (orig_filename
), emacs_strerror (errno
));
3487 else if (nread
== 0)
3490 if (CODING_REQUIRE_DETECTION (&coding
))
3492 coding_system
= detect_coding_system ((unsigned char *) buffer
,
3495 setup_coding_system (coding_system
, &coding
);
3498 if (CODING_REQUIRE_DECODING (&coding
))
3499 /* We found that the file should be decoded somehow.
3500 Let's give up here. */
3502 giveup_match_end
= 1;
3507 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3508 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3509 same_at_start
++, bufpos
++;
3510 /* If we found a discrepancy, stop the scan.
3511 Otherwise loop around and scan the next bufferful. */
3512 if (bufpos
!= nread
)
3516 /* If the file matches the buffer completely,
3517 there's no need to replace anything. */
3518 if (same_at_start
- BEGV_BYTE
== XINT (end
))
3522 /* Truncate the buffer to the size of the file. */
3523 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3528 /* Count how many chars at the end of the file
3529 match the text at the end of the buffer. But, if we have
3530 already found that decoding is necessary, don't waste time. */
3531 while (!giveup_match_end
)
3533 EMACS_INT total_read
, nread
, bufpos
, curpos
, trial
;
3535 /* At what file position are we now scanning? */
3536 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
3537 /* If the entire file matches the buffer tail, stop the scan. */
3540 /* How much can we scan in the next step? */
3541 trial
= min (curpos
, sizeof buffer
);
3542 if (lseek (fd
, curpos
- trial
, 0) < 0)
3543 report_file_error ("Setting file position",
3544 Fcons (orig_filename
, Qnil
));
3546 total_read
= nread
= 0;
3547 while (total_read
< trial
)
3549 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3551 error ("IO error reading %s: %s",
3552 SDATA (orig_filename
), emacs_strerror (errno
));
3553 else if (nread
== 0)
3555 total_read
+= nread
;
3558 /* Scan this bufferful from the end, comparing with
3559 the Emacs buffer. */
3560 bufpos
= total_read
;
3562 /* Compare with same_at_start to avoid counting some buffer text
3563 as matching both at the file's beginning and at the end. */
3564 while (bufpos
> 0 && same_at_end
> same_at_start
3565 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3566 same_at_end
--, bufpos
--;
3568 /* If we found a discrepancy, stop the scan.
3569 Otherwise loop around and scan the preceding bufferful. */
3572 /* If this discrepancy is because of code conversion,
3573 we cannot use this method; giveup and try the other. */
3574 if (same_at_end
> same_at_start
3575 && FETCH_BYTE (same_at_end
- 1) >= 0200
3576 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3577 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3578 giveup_match_end
= 1;
3587 if (! giveup_match_end
)
3591 /* We win! We can handle REPLACE the optimized way. */
3593 /* Extend the start of non-matching text area to multibyte
3594 character boundary. */
3595 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3596 while (same_at_start
> BEGV_BYTE
3597 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3600 /* Extend the end of non-matching text area to multibyte
3601 character boundary. */
3602 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3603 while (same_at_end
< ZV_BYTE
3604 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3607 /* Don't try to reuse the same piece of text twice. */
3608 overlap
= (same_at_start
- BEGV_BYTE
3609 - (same_at_end
+ st
.st_size
- ZV
));
3611 same_at_end
+= overlap
;
3613 /* Arrange to read only the nonmatching middle part of the file. */
3614 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
3615 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
3617 del_range_byte (same_at_start
, same_at_end
, 0);
3618 /* Insert from the file at the proper position. */
3619 temp
= BYTE_TO_CHAR (same_at_start
);
3620 SET_PT_BOTH (temp
, same_at_start
);
3622 /* If display currently starts at beginning of line,
3623 keep it that way. */
3624 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3625 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3627 replace_handled
= 1;
3631 /* If requested, replace the accessible part of the buffer
3632 with the file contents. Avoid replacing text at the
3633 beginning or end of the buffer that matches the file contents;
3634 that preserves markers pointing to the unchanged parts.
3636 Here we implement this feature for the case where code conversion
3637 is needed, in a simple way that needs a lot of memory.
3638 The preceding if-statement handles the case of no conversion
3639 in a more optimized way. */
3640 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3642 EMACS_INT same_at_start
= BEGV_BYTE
;
3643 EMACS_INT same_at_end
= ZV_BYTE
;
3644 EMACS_INT same_at_start_charpos
;
3645 EMACS_INT inserted_chars
;
3648 unsigned char *decoded
;
3650 int this_count
= SPECPDL_INDEX ();
3651 int multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3652 Lisp_Object conversion_buffer
;
3654 conversion_buffer
= code_conversion_save (1, multibyte
);
3656 /* First read the whole file, performing code conversion into
3657 CONVERSION_BUFFER. */
3659 if (lseek (fd
, XINT (beg
), 0) < 0)
3660 report_file_error ("Setting file position",
3661 Fcons (orig_filename
, Qnil
));
3663 total
= st
.st_size
; /* Total bytes in the file. */
3664 how_much
= 0; /* Bytes read from file so far. */
3665 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3666 unprocessed
= 0; /* Bytes not processed in previous loop. */
3668 GCPRO1 (conversion_buffer
);
3669 while (how_much
< total
)
3671 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3672 quitting while reading a huge while. */
3673 /* try is reserved in some compilers (Microsoft C) */
3674 EMACS_INT trytry
= min (total
- how_much
,
3675 READ_BUF_SIZE
- unprocessed
);
3678 /* Allow quitting out of the actual I/O. */
3681 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3693 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3694 BUF_Z (XBUFFER (conversion_buffer
)));
3695 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3696 unprocessed
+ this, conversion_buffer
);
3697 unprocessed
= coding
.carryover_bytes
;
3698 if (coding
.carryover_bytes
> 0)
3699 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3704 /* We should remove the unwind_protect calling
3705 close_file_unwind, but other stuff has been added the stack,
3706 so defer the removal till we reach the `handled' label. */
3707 deferred_remove_unwind_protect
= 1;
3709 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3710 if we couldn't read the file. */
3713 error ("IO error reading %s: %s",
3714 SDATA (orig_filename
), emacs_strerror (errno
));
3716 if (unprocessed
> 0)
3718 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3719 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3720 unprocessed
, conversion_buffer
);
3721 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3724 coding_system
= CODING_ID_NAME (coding
.id
);
3725 set_coding_system
= 1;
3726 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3727 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3728 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3730 /* Compare the beginning of the converted string with the buffer
3734 while (bufpos
< inserted
&& same_at_start
< same_at_end
3735 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3736 same_at_start
++, bufpos
++;
3738 /* If the file matches the head of buffer completely,
3739 there's no need to replace anything. */
3741 if (bufpos
== inserted
)
3743 /* Truncate the buffer to the size of the file. */
3744 if (same_at_start
== same_at_end
)
3747 del_range_byte (same_at_start
, same_at_end
, 0);
3750 unbind_to (this_count
, Qnil
);
3754 /* Extend the start of non-matching text area to the previous
3755 multibyte character boundary. */
3756 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3757 while (same_at_start
> BEGV_BYTE
3758 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3761 /* Scan this bufferful from the end, comparing with
3762 the Emacs buffer. */
3765 /* Compare with same_at_start to avoid counting some buffer text
3766 as matching both at the file's beginning and at the end. */
3767 while (bufpos
> 0 && same_at_end
> same_at_start
3768 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3769 same_at_end
--, bufpos
--;
3771 /* Extend the end of non-matching text area to the next
3772 multibyte character boundary. */
3773 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3774 while (same_at_end
< ZV_BYTE
3775 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3778 /* Don't try to reuse the same piece of text twice. */
3779 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3781 same_at_end
+= overlap
;
3783 /* If display currently starts at beginning of line,
3784 keep it that way. */
3785 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3786 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3788 /* Replace the chars that we need to replace,
3789 and update INSERTED to equal the number of bytes
3790 we are taking from the decoded string. */
3791 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3793 if (same_at_end
!= same_at_start
)
3795 del_range_byte (same_at_start
, same_at_end
, 0);
3797 same_at_start
= GPT_BYTE
;
3801 temp
= BYTE_TO_CHAR (same_at_start
);
3803 /* Insert from the file at the proper position. */
3804 SET_PT_BOTH (temp
, same_at_start
);
3805 same_at_start_charpos
3806 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3807 same_at_start
- BEGV_BYTE
3808 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3810 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3811 same_at_start
+ inserted
- BEGV_BYTE
3812 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3813 - same_at_start_charpos
);
3814 /* This binding is to avoid ask-user-about-supersession-threat
3815 being called in insert_from_buffer (via in
3816 prepare_to_modify_buffer). */
3817 specbind (intern ("buffer-file-name"), Qnil
);
3818 insert_from_buffer (XBUFFER (conversion_buffer
),
3819 same_at_start_charpos
, inserted_chars
, 0);
3820 /* Set `inserted' to the number of inserted characters. */
3821 inserted
= PT
- temp
;
3822 /* Set point before the inserted characters. */
3823 SET_PT_BOTH (temp
, same_at_start
);
3825 unbind_to (this_count
, Qnil
);
3832 register Lisp_Object temp
;
3834 total
= XINT (end
) - XINT (beg
);
3836 /* Make sure point-max won't overflow after this insertion. */
3837 XSETINT (temp
, total
);
3838 if (total
!= XINT (temp
))
3839 error ("Maximum buffer size exceeded");
3842 /* For a special file, all we can do is guess. */
3843 total
= READ_BUF_SIZE
;
3845 if (NILP (visit
) && inserted
> 0)
3847 #ifdef CLASH_DETECTION
3848 if (!NILP (BVAR (current_buffer
, file_truename
))
3849 /* Make binding buffer-file-name to nil effective. */
3850 && !NILP (BVAR (current_buffer
, filename
))
3851 && SAVE_MODIFF
>= MODIFF
)
3853 #endif /* CLASH_DETECTION */
3854 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3858 if (GAP_SIZE
< total
)
3859 make_gap (total
- GAP_SIZE
);
3861 if (XINT (beg
) != 0 || !NILP (replace
))
3863 if (lseek (fd
, XINT (beg
), 0) < 0)
3864 report_file_error ("Setting file position",
3865 Fcons (orig_filename
, Qnil
));
3868 /* In the following loop, HOW_MUCH contains the total bytes read so
3869 far for a regular file, and not changed for a special file. But,
3870 before exiting the loop, it is set to a negative value if I/O
3874 /* Total bytes inserted. */
3877 /* Here, we don't do code conversion in the loop. It is done by
3878 decode_coding_gap after all data are read into the buffer. */
3880 EMACS_INT gap_size
= GAP_SIZE
;
3882 while (how_much
< total
)
3884 /* try is reserved in some compilers (Microsoft C) */
3885 EMACS_INT trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3892 /* Maybe make more room. */
3893 if (gap_size
< trytry
)
3895 make_gap (total
- gap_size
);
3896 gap_size
= GAP_SIZE
;
3899 /* Read from the file, capturing `quit'. When an
3900 error occurs, end the loop, and arrange for a quit
3901 to be signaled after decoding the text we read. */
3902 non_regular_fd
= fd
;
3903 non_regular_inserted
= inserted
;
3904 non_regular_nbytes
= trytry
;
3905 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
3906 read_non_regular_quit
);
3917 /* Allow quitting out of the actual I/O. We don't make text
3918 part of the buffer until all the reading is done, so a C-g
3919 here doesn't do any harm. */
3922 this = emacs_read (fd
,
3923 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3937 /* For a regular file, where TOTAL is the real size,
3938 count HOW_MUCH to compare with it.
3939 For a special file, where TOTAL is just a buffer size,
3940 so don't bother counting in HOW_MUCH.
3941 (INSERTED is where we count the number of characters inserted.) */
3948 /* Now we have read all the file data into the gap.
3949 If it was empty, undo marking the buffer modified. */
3953 #ifdef CLASH_DETECTION
3955 unlock_file (BVAR (current_buffer
, file_truename
));
3957 Vdeactivate_mark
= old_Vdeactivate_mark
;
3960 Vdeactivate_mark
= Qt
;
3962 /* Make the text read part of the buffer. */
3963 GAP_SIZE
-= inserted
;
3965 GPT_BYTE
+= inserted
;
3967 ZV_BYTE
+= inserted
;
3972 /* Put an anchor to ensure multi-byte form ends at gap. */
3977 /* Discard the unwind protect for closing the file. */
3981 error ("IO error reading %s: %s",
3982 SDATA (orig_filename
), emacs_strerror (errno
));
3986 if (NILP (coding_system
))
3988 /* The coding system is not yet decided. Decide it by an
3989 optimized method for handling `coding:' tag.
3991 Note that we can get here only if the buffer was empty
3992 before the insertion. */
3994 if (!NILP (Vcoding_system_for_read
))
3995 coding_system
= Vcoding_system_for_read
;
3998 /* Since we are sure that the current buffer was empty
3999 before the insertion, we can toggle
4000 enable-multibyte-characters directly here without taking
4001 care of marker adjustment. By this way, we can run Lisp
4002 program safely before decoding the inserted text. */
4003 Lisp_Object unwind_data
;
4004 int count
= SPECPDL_INDEX ();
4006 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4007 Fcons (BVAR (current_buffer
, undo_list
),
4008 Fcurrent_buffer ()));
4009 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
4010 BVAR (current_buffer
, undo_list
) = Qt
;
4011 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4013 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4015 coding_system
= call2 (Vset_auto_coding_function
,
4016 filename
, make_number (inserted
));
4019 if (NILP (coding_system
))
4021 /* If the coding system is not yet decided, check
4022 file-coding-system-alist. */
4023 Lisp_Object args
[6];
4025 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4026 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4027 coding_system
= Ffind_operation_coding_system (6, args
);
4028 if (CONSP (coding_system
))
4029 coding_system
= XCAR (coding_system
);
4031 unbind_to (count
, Qnil
);
4032 inserted
= Z_BYTE
- BEG_BYTE
;
4035 if (NILP (coding_system
))
4036 coding_system
= Qundecided
;
4038 CHECK_CODING_SYSTEM (coding_system
);
4040 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4041 /* We must suppress all character code conversion except for
4042 end-of-line conversion. */
4043 coding_system
= raw_text_coding_system (coding_system
);
4044 setup_coding_system (coding_system
, &coding
);
4045 /* Ensure we set Vlast_coding_system_used. */
4046 set_coding_system
= 1;
4051 /* When we visit a file by raw-text, we change the buffer to
4053 if (CODING_FOR_UNIBYTE (&coding
)
4054 /* Can't do this if part of the buffer might be preserved. */
4056 /* Visiting a file with these coding system makes the buffer
4058 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
4061 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4062 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4063 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4065 move_gap_both (PT
, PT_BYTE
);
4066 GAP_SIZE
+= inserted
;
4067 ZV_BYTE
-= inserted
;
4071 decode_coding_gap (&coding
, inserted
, inserted
);
4072 inserted
= coding
.produced_char
;
4073 coding_system
= CODING_ID_NAME (coding
.id
);
4075 else if (inserted
> 0)
4076 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4079 /* Now INSERTED is measured in characters. */
4083 if (deferred_remove_unwind_protect
)
4084 /* If requested above, discard the unwind protect for closing the
4090 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4091 BVAR (current_buffer
, undo_list
) = Qnil
;
4095 current_buffer
->modtime
= st
.st_mtime
;
4096 current_buffer
->modtime_size
= st
.st_size
;
4097 BVAR (current_buffer
, filename
) = orig_filename
;
4100 SAVE_MODIFF
= MODIFF
;
4101 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4102 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4103 #ifdef CLASH_DETECTION
4106 if (!NILP (BVAR (current_buffer
, file_truename
)))
4107 unlock_file (BVAR (current_buffer
, file_truename
));
4108 unlock_file (filename
);
4110 #endif /* CLASH_DETECTION */
4112 xsignal2 (Qfile_error
,
4113 build_string ("not a regular file"), orig_filename
);
4116 if (set_coding_system
)
4117 Vlast_coding_system_used
= coding_system
;
4119 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4121 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4123 if (! NILP (insval
))
4125 CHECK_NUMBER (insval
);
4126 inserted
= XFASTINT (insval
);
4130 /* Decode file format. */
4133 /* Don't run point motion or modification hooks when decoding. */
4134 int count
= SPECPDL_INDEX ();
4135 EMACS_INT old_inserted
= inserted
;
4136 specbind (Qinhibit_point_motion_hooks
, Qt
);
4137 specbind (Qinhibit_modification_hooks
, Qt
);
4139 /* Save old undo list and don't record undo for decoding. */
4140 old_undo
= BVAR (current_buffer
, undo_list
);
4141 BVAR (current_buffer
, undo_list
) = Qt
;
4145 insval
= call3 (Qformat_decode
,
4146 Qnil
, make_number (inserted
), visit
);
4147 CHECK_NUMBER (insval
);
4148 inserted
= XFASTINT (insval
);
4152 /* If REPLACE is non-nil and we succeeded in not replacing the
4153 beginning or end of the buffer text with the file's contents,
4154 call format-decode with `point' positioned at the beginning
4155 of the buffer and `inserted' equalling the number of
4156 characters in the buffer. Otherwise, format-decode might
4157 fail to correctly analyze the beginning or end of the buffer.
4158 Hence we temporarily save `point' and `inserted' here and
4159 restore `point' iff format-decode did not insert or delete
4160 any text. Otherwise we leave `point' at point-min. */
4161 EMACS_INT opoint
= PT
;
4162 EMACS_INT opoint_byte
= PT_BYTE
;
4163 EMACS_INT oinserted
= ZV
- BEGV
;
4164 int ochars_modiff
= CHARS_MODIFF
;
4166 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4167 insval
= call3 (Qformat_decode
,
4168 Qnil
, make_number (oinserted
), visit
);
4169 CHECK_NUMBER (insval
);
4170 if (ochars_modiff
== CHARS_MODIFF
)
4171 /* format_decode didn't modify buffer's characters => move
4172 point back to position before inserted text and leave
4173 value of inserted alone. */
4174 SET_PT_BOTH (opoint
, opoint_byte
);
4176 /* format_decode modified buffer's characters => consider
4177 entire buffer changed and leave point at point-min. */
4178 inserted
= XFASTINT (insval
);
4181 /* For consistency with format-decode call these now iff inserted > 0
4182 (martin 2007-06-28). */
4183 p
= Vafter_insert_file_functions
;
4188 insval
= call1 (XCAR (p
), make_number (inserted
));
4191 CHECK_NUMBER (insval
);
4192 inserted
= XFASTINT (insval
);
4197 /* For the rationale of this see the comment on
4198 format-decode above. */
4199 EMACS_INT opoint
= PT
;
4200 EMACS_INT opoint_byte
= PT_BYTE
;
4201 EMACS_INT oinserted
= ZV
- BEGV
;
4202 int ochars_modiff
= CHARS_MODIFF
;
4204 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4205 insval
= call1 (XCAR (p
), make_number (oinserted
));
4208 CHECK_NUMBER (insval
);
4209 if (ochars_modiff
== CHARS_MODIFF
)
4210 /* after_insert_file_functions didn't modify
4211 buffer's characters => move point back to
4212 position before inserted text and leave value of
4214 SET_PT_BOTH (opoint
, opoint_byte
);
4216 /* after_insert_file_functions did modify buffer's
4217 characters => consider entire buffer changed and
4218 leave point at point-min. */
4219 inserted
= XFASTINT (insval
);
4229 BVAR (current_buffer
, undo_list
) = old_undo
;
4230 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4232 /* Adjust the last undo record for the size change during
4233 the format conversion. */
4234 Lisp_Object tem
= XCAR (old_undo
);
4235 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4236 && INTEGERP (XCDR (tem
))
4237 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4238 XSETCDR (tem
, make_number (PT
+ inserted
));
4242 /* If undo_list was Qt before, keep it that way.
4243 Otherwise start with an empty undo_list. */
4244 BVAR (current_buffer
, undo_list
) = EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4246 unbind_to (count
, Qnil
);
4249 /* Call after-change hooks for the inserted text, aside from the case
4250 of normal visiting (not with REPLACE), which is done in a new buffer
4251 "before" the buffer is changed. */
4252 if (inserted
> 0 && total
> 0
4253 && (NILP (visit
) || !NILP (replace
)))
4255 signal_after_change (PT
, 0, inserted
);
4256 update_compositions (PT
, PT
, CHECK_BORDER
);
4260 && current_buffer
->modtime
== -1)
4262 /* If visiting nonexistent file, return nil. */
4263 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4267 Fsignal (Qquit
, Qnil
);
4269 /* ??? Retval needs to be dealt with in all cases consistently. */
4271 val
= Fcons (orig_filename
,
4272 Fcons (make_number (inserted
),
4275 RETURN_UNGCPRO (unbind_to (count
, val
));
4278 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4281 build_annotations_unwind (Lisp_Object arg
)
4283 Vwrite_region_annotation_buffers
= arg
;
4287 /* Decide the coding-system to encode the data with. */
4290 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4291 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4292 struct coding_system
*coding
)
4295 Lisp_Object eol_parent
= Qnil
;
4298 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4299 BVAR (current_buffer
, auto_save_file_name
))))
4304 else if (!NILP (Vcoding_system_for_write
))
4306 val
= Vcoding_system_for_write
;
4307 if (coding_system_require_warning
4308 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4309 /* Confirm that VAL can surely encode the current region. */
4310 val
= call5 (Vselect_safe_coding_system_function
,
4311 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4316 /* If the variable `buffer-file-coding-system' is set locally,
4317 it means that the file was read with some kind of code
4318 conversion or the variable is explicitly set by users. We
4319 had better write it out with the same coding system even if
4320 `enable-multibyte-characters' is nil.
4322 If it is not set locally, we anyway have to convert EOL
4323 format if the default value of `buffer-file-coding-system'
4324 tells that it is not Unix-like (LF only) format. */
4325 int using_default_coding
= 0;
4326 int force_raw_text
= 0;
4328 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4330 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4333 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4339 /* Check file-coding-system-alist. */
4340 Lisp_Object args
[7], coding_systems
;
4342 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4343 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4345 coding_systems
= Ffind_operation_coding_system (7, args
);
4346 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4347 val
= XCDR (coding_systems
);
4352 /* If we still have not decided a coding system, use the
4353 default value of buffer-file-coding-system. */
4354 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4355 using_default_coding
= 1;
4358 if (! NILP (val
) && ! force_raw_text
)
4360 Lisp_Object spec
, attrs
;
4362 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4363 attrs
= AREF (spec
, 0);
4364 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4369 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4370 /* Confirm that VAL can surely encode the current region. */
4371 val
= call5 (Vselect_safe_coding_system_function
,
4372 start
, end
, val
, Qnil
, filename
);
4374 /* If the decided coding-system doesn't specify end-of-line
4375 format, we use that of
4376 `default-buffer-file-coding-system'. */
4377 if (! using_default_coding
4378 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4379 val
= (coding_inherit_eol_type
4380 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4382 /* If we decide not to encode text, use `raw-text' or one of its
4385 val
= raw_text_coding_system (val
);
4388 val
= coding_inherit_eol_type (val
, eol_parent
);
4389 setup_coding_system (val
, coding
);
4391 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4392 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4396 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4397 "r\nFWrite region to file: \ni\ni\ni\np",
4398 doc
: /* Write current region into specified file.
4399 When called from a program, requires three arguments:
4400 START, END and FILENAME. START and END are normally buffer positions
4401 specifying the part of the buffer to write.
4402 If START is nil, that means to use the entire buffer contents.
4403 If START is a string, then output that string to the file
4404 instead of any buffer contents; END is ignored.
4406 Optional fourth argument APPEND if non-nil means
4407 append to existing file contents (if any). If it is an integer,
4408 seek to that offset in the file before writing.
4409 Optional fifth argument VISIT, if t or a string, means
4410 set the last-save-file-modtime of buffer to this file's modtime
4411 and mark buffer not modified.
4412 If VISIT is a string, it is a second file name;
4413 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4414 VISIT is also the file name to lock and unlock for clash detection.
4415 If VISIT is neither t nor nil nor a string,
4416 that means do not display the \"Wrote file\" message.
4417 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4418 use for locking and unlocking, overriding FILENAME and VISIT.
4419 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4420 for an existing file with the same name. If MUSTBENEW is `excl',
4421 that means to get an error if the file already exists; never overwrite.
4422 If MUSTBENEW is neither nil nor `excl', that means ask for
4423 confirmation before overwriting, but do go ahead and overwrite the file
4424 if the user confirms.
4426 This does code conversion according to the value of
4427 `coding-system-for-write', `buffer-file-coding-system', or
4428 `file-coding-system-alist', and sets the variable
4429 `last-coding-system-used' to the coding system actually used.
4431 This calls `write-region-annotate-functions' at the start, and
4432 `write-region-post-annotation-function' at the end. */)
4433 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4440 int count
= SPECPDL_INDEX ();
4442 Lisp_Object handler
;
4443 Lisp_Object visit_file
;
4444 Lisp_Object annotations
;
4445 Lisp_Object encoded_filename
;
4446 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4447 int quietly
= !NILP (visit
);
4448 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4449 struct buffer
*given_buffer
;
4450 struct coding_system coding
;
4452 if (current_buffer
->base_buffer
&& visiting
)
4453 error ("Cannot do file visiting in an indirect buffer");
4455 if (!NILP (start
) && !STRINGP (start
))
4456 validate_region (&start
, &end
);
4459 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4461 filename
= Fexpand_file_name (filename
, Qnil
);
4463 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4464 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4466 if (STRINGP (visit
))
4467 visit_file
= Fexpand_file_name (visit
, Qnil
);
4469 visit_file
= filename
;
4471 if (NILP (lockname
))
4472 lockname
= visit_file
;
4476 /* If the file name has special constructs in it,
4477 call the corresponding file handler. */
4478 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4479 /* If FILENAME has no handler, see if VISIT has one. */
4480 if (NILP (handler
) && STRINGP (visit
))
4481 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4483 if (!NILP (handler
))
4486 val
= call6 (handler
, Qwrite_region
, start
, end
,
4487 filename
, append
, visit
);
4491 SAVE_MODIFF
= MODIFF
;
4492 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4493 BVAR (current_buffer
, filename
) = visit_file
;
4499 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4501 /* Special kludge to simplify auto-saving. */
4504 /* Do it later, so write-region-annotate-function can work differently
4505 if we save "the buffer" vs "a region".
4506 This is useful in tar-mode. --Stef
4507 XSETFASTINT (start, BEG);
4508 XSETFASTINT (end, Z); */
4512 record_unwind_protect (build_annotations_unwind
,
4513 Vwrite_region_annotation_buffers
);
4514 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4515 count1
= SPECPDL_INDEX ();
4517 given_buffer
= current_buffer
;
4519 if (!STRINGP (start
))
4521 annotations
= build_annotations (start
, end
);
4523 if (current_buffer
!= given_buffer
)
4525 XSETFASTINT (start
, BEGV
);
4526 XSETFASTINT (end
, ZV
);
4532 XSETFASTINT (start
, BEGV
);
4533 XSETFASTINT (end
, ZV
);
4538 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4540 /* Decide the coding-system to encode the data with.
4541 We used to make this choice before calling build_annotations, but that
4542 leads to problems when a write-annotate-function takes care of
4543 unsavable chars (as was the case with X-Symbol). */
4544 Vlast_coding_system_used
4545 = choose_write_coding_system (start
, end
, filename
,
4546 append
, visit
, lockname
, &coding
);
4548 #ifdef CLASH_DETECTION
4550 lock_file (lockname
);
4551 #endif /* CLASH_DETECTION */
4553 encoded_filename
= ENCODE_FILE (filename
);
4555 fn
= SSDATA (encoded_filename
);
4559 desc
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4560 #else /* not DOS_NT */
4561 desc
= emacs_open (fn
, O_WRONLY
, 0);
4562 #endif /* not DOS_NT */
4564 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4566 desc
= emacs_open (fn
,
4567 O_WRONLY
| O_CREAT
| O_BINARY
4568 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4569 S_IREAD
| S_IWRITE
);
4570 #else /* not DOS_NT */
4571 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4572 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4573 auto_saving
? auto_save_mode_bits
: 0666);
4574 #endif /* not DOS_NT */
4578 #ifdef CLASH_DETECTION
4580 if (!auto_saving
) unlock_file (lockname
);
4582 #endif /* CLASH_DETECTION */
4584 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4587 record_unwind_protect (close_file_unwind
, make_number (desc
));
4589 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4593 if (NUMBERP (append
))
4594 ret
= lseek (desc
, XINT (append
), 1);
4596 ret
= lseek (desc
, 0, 2);
4599 #ifdef CLASH_DETECTION
4600 if (!auto_saving
) unlock_file (lockname
);
4601 #endif /* CLASH_DETECTION */
4603 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4612 if (STRINGP (start
))
4614 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4615 &annotations
, &coding
);
4618 else if (XINT (start
) != XINT (end
))
4620 failure
= 0 > a_write (desc
, Qnil
,
4621 XINT (start
), XINT (end
) - XINT (start
),
4622 &annotations
, &coding
);
4627 /* If file was empty, still need to write the annotations */
4628 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4629 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4633 if (CODING_REQUIRE_FLUSHING (&coding
)
4634 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4637 /* We have to flush out a data. */
4638 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4639 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4646 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4647 Disk full in NFS may be reported here. */
4648 /* mib says that closing the file will try to write as fast as NFS can do
4649 it, and that means the fsync here is not crucial for autosave files. */
4650 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4652 /* If fsync fails with EINTR, don't treat that as serious. Also
4653 ignore EINVAL which happens when fsync is not supported on this
4655 if (errno
!= EINTR
&& errno
!= EINVAL
)
4656 failure
= 1, save_errno
= errno
;
4660 /* NFS can report a write failure now. */
4661 if (emacs_close (desc
) < 0)
4662 failure
= 1, save_errno
= errno
;
4666 /* Discard the unwind protect for close_file_unwind. */
4667 specpdl_ptr
= specpdl
+ count1
;
4669 /* Call write-region-post-annotation-function. */
4670 while (CONSP (Vwrite_region_annotation_buffers
))
4672 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4673 if (!NILP (Fbuffer_live_p (buf
)))
4676 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4677 call0 (Vwrite_region_post_annotation_function
);
4679 Vwrite_region_annotation_buffers
4680 = XCDR (Vwrite_region_annotation_buffers
);
4683 unbind_to (count
, Qnil
);
4685 #ifdef CLASH_DETECTION
4687 unlock_file (lockname
);
4688 #endif /* CLASH_DETECTION */
4690 /* Do this before reporting IO error
4691 to avoid a "file has changed on disk" warning on
4692 next attempt to save. */
4695 current_buffer
->modtime
= st
.st_mtime
;
4696 current_buffer
->modtime_size
= st
.st_size
;
4700 error ("IO error writing %s: %s", SDATA (filename
),
4701 emacs_strerror (save_errno
));
4705 SAVE_MODIFF
= MODIFF
;
4706 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4707 BVAR (current_buffer
, filename
) = visit_file
;
4708 update_mode_lines
++;
4713 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4714 BVAR (current_buffer
, auto_save_file_name
))))
4715 SAVE_MODIFF
= MODIFF
;
4721 message_with_string ((INTEGERP (append
)
4731 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4733 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4734 doc
: /* Return t if (car A) is numerically less than (car B). */)
4735 (Lisp_Object a
, Lisp_Object b
)
4737 return Flss (Fcar (a
), Fcar (b
));
4740 /* Build the complete list of annotations appropriate for writing out
4741 the text between START and END, by calling all the functions in
4742 write-region-annotate-functions and merging the lists they return.
4743 If one of these functions switches to a different buffer, we assume
4744 that buffer contains altered text. Therefore, the caller must
4745 make sure to restore the current buffer in all cases,
4746 as save-excursion would do. */
4749 build_annotations (Lisp_Object start
, Lisp_Object end
)
4751 Lisp_Object annotations
;
4753 struct gcpro gcpro1
, gcpro2
;
4754 Lisp_Object original_buffer
;
4755 int i
, used_global
= 0;
4757 XSETBUFFER (original_buffer
, current_buffer
);
4760 p
= Vwrite_region_annotate_functions
;
4761 GCPRO2 (annotations
, p
);
4764 struct buffer
*given_buffer
= current_buffer
;
4765 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4766 { /* Use the global value of the hook. */
4769 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4771 p
= Fappend (2, arg
);
4774 Vwrite_region_annotations_so_far
= annotations
;
4775 res
= call2 (XCAR (p
), start
, end
);
4776 /* If the function makes a different buffer current,
4777 assume that means this buffer contains altered text to be output.
4778 Reset START and END from the buffer bounds
4779 and discard all previous annotations because they should have
4780 been dealt with by this function. */
4781 if (current_buffer
!= given_buffer
)
4783 Vwrite_region_annotation_buffers
4784 = Fcons (Fcurrent_buffer (),
4785 Vwrite_region_annotation_buffers
);
4786 XSETFASTINT (start
, BEGV
);
4787 XSETFASTINT (end
, ZV
);
4790 Flength (res
); /* Check basic validity of return value */
4791 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4795 /* Now do the same for annotation functions implied by the file-format */
4796 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
4797 p
= BVAR (current_buffer
, auto_save_file_format
);
4799 p
= BVAR (current_buffer
, file_format
);
4800 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4802 struct buffer
*given_buffer
= current_buffer
;
4804 Vwrite_region_annotations_so_far
= annotations
;
4806 /* Value is either a list of annotations or nil if the function
4807 has written annotations to a temporary buffer, which is now
4809 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4810 original_buffer
, make_number (i
));
4811 if (current_buffer
!= given_buffer
)
4813 XSETFASTINT (start
, BEGV
);
4814 XSETFASTINT (end
, ZV
);
4819 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4827 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4828 If STRING is nil, POS is the character position in the current buffer.
4829 Intersperse with them the annotations from *ANNOT
4830 which fall within the range of POS to POS + NCHARS,
4831 each at its appropriate position.
4833 We modify *ANNOT by discarding elements as we use them up.
4835 The return value is negative in case of system call failure. */
4838 a_write (int desc
, Lisp_Object string
, int pos
, register int nchars
, Lisp_Object
*annot
, struct coding_system
*coding
)
4842 int lastpos
= pos
+ nchars
;
4844 while (NILP (*annot
) || CONSP (*annot
))
4846 tem
= Fcar_safe (Fcar (*annot
));
4849 nextpos
= XFASTINT (tem
);
4851 /* If there are no more annotations in this range,
4852 output the rest of the range all at once. */
4853 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4854 return e_write (desc
, string
, pos
, lastpos
, coding
);
4856 /* Output buffer text up to the next annotation's position. */
4859 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4863 /* Output the annotation. */
4864 tem
= Fcdr (Fcar (*annot
));
4867 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4870 *annot
= Fcdr (*annot
);
4876 /* Write text in the range START and END into descriptor DESC,
4877 encoding them with coding system CODING. If STRING is nil, START
4878 and END are character positions of the current buffer, else they
4879 are indexes to the string STRING. */
4882 e_write (int desc
, Lisp_Object string
, int start
, int end
, struct coding_system
*coding
)
4884 if (STRINGP (string
))
4887 end
= SCHARS (string
);
4890 /* We used to have a code for handling selective display here. But,
4891 now it is handled within encode_coding. */
4895 if (STRINGP (string
))
4897 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
4898 if (CODING_REQUIRE_ENCODING (coding
))
4900 encode_coding_object (coding
, string
,
4901 start
, string_char_to_byte (string
, start
),
4902 end
, string_char_to_byte (string
, end
), Qt
);
4906 coding
->dst_object
= string
;
4907 coding
->consumed_char
= SCHARS (string
);
4908 coding
->produced
= SBYTES (string
);
4913 int start_byte
= CHAR_TO_BYTE (start
);
4914 int end_byte
= CHAR_TO_BYTE (end
);
4916 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
4917 if (CODING_REQUIRE_ENCODING (coding
))
4919 encode_coding_object (coding
, Fcurrent_buffer (),
4920 start
, start_byte
, end
, end_byte
, Qt
);
4924 coding
->dst_object
= Qnil
;
4925 coding
->dst_pos_byte
= start_byte
;
4926 if (start
>= GPT
|| end
<= GPT
)
4928 coding
->consumed_char
= end
- start
;
4929 coding
->produced
= end_byte
- start_byte
;
4933 coding
->consumed_char
= GPT
- start
;
4934 coding
->produced
= GPT_BYTE
- start_byte
;
4939 if (coding
->produced
> 0)
4943 STRINGP (coding
->dst_object
)
4944 ? SSDATA (coding
->dst_object
)
4945 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
4948 if (coding
->produced
)
4951 start
+= coding
->consumed_char
;
4957 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
4958 Sverify_visited_file_modtime
, 0, 1, 0,
4959 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
4960 This means that the file has not been changed since it was visited or saved.
4961 If BUF is omitted or nil, it defaults to the current buffer.
4962 See Info node `(elisp)Modification Time' for more details. */)
4967 Lisp_Object handler
;
4968 Lisp_Object filename
;
4978 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
4979 if (b
->modtime
== 0) return Qt
;
4981 /* If the file name has special constructs in it,
4982 call the corresponding file handler. */
4983 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
4984 Qverify_visited_file_modtime
);
4985 if (!NILP (handler
))
4986 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
4988 filename
= ENCODE_FILE (BVAR (b
, filename
));
4990 if (stat (SSDATA (filename
), &st
) < 0)
4992 /* If the file doesn't exist now and didn't exist before,
4993 we say that it isn't modified, provided the error is a tame one. */
4994 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
4999 if ((st
.st_mtime
== b
->modtime
5000 /* If both are positive, accept them if they are off by one second. */
5001 || (st
.st_mtime
> 0 && b
->modtime
> 0
5002 && (st
.st_mtime
== b
->modtime
+ 1
5003 || st
.st_mtime
== b
->modtime
- 1)))
5004 && (st
.st_size
== b
->modtime_size
5005 || b
->modtime_size
< 0))
5010 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5011 Sclear_visited_file_modtime
, 0, 0, 0,
5012 doc
: /* Clear out records of last mod time of visited file.
5013 Next attempt to save will certainly not complain of a discrepancy. */)
5016 current_buffer
->modtime
= 0;
5017 current_buffer
->modtime_size
= -1;
5021 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5022 Svisited_file_modtime
, 0, 0, 0,
5023 doc
: /* Return the current buffer's recorded visited file modification time.
5024 The value is a list of the form (HIGH LOW), like the time values
5025 that `file-attributes' returns. If the current buffer has no recorded
5026 file modification time, this function returns 0.
5027 See Info node `(elisp)Modification Time' for more details. */)
5030 if (! current_buffer
->modtime
)
5031 return make_number (0);
5032 return make_time ((time_t) current_buffer
->modtime
);
5035 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5036 Sset_visited_file_modtime
, 0, 1, 0,
5037 doc
: /* Update buffer's recorded modification time from the visited file's time.
5038 Useful if the buffer was not read from the file normally
5039 or if the file itself has been changed for some known benign reason.
5040 An argument specifies the modification time value to use
5041 \(instead of that of the visited file), in the form of a list
5042 \(HIGH . LOW) or (HIGH LOW). */)
5043 (Lisp_Object time_list
)
5045 if (!NILP (time_list
))
5047 current_buffer
->modtime
= cons_to_long (time_list
);
5048 current_buffer
->modtime_size
= -1;
5052 register Lisp_Object filename
;
5054 Lisp_Object handler
;
5056 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5058 /* If the file name has special constructs in it,
5059 call the corresponding file handler. */
5060 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5061 if (!NILP (handler
))
5062 /* The handler can find the file name the same way we did. */
5063 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5065 filename
= ENCODE_FILE (filename
);
5067 if (stat (SSDATA (filename
), &st
) >= 0)
5069 current_buffer
->modtime
= st
.st_mtime
;
5070 current_buffer
->modtime_size
= st
.st_size
;
5078 auto_save_error (Lisp_Object error
)
5080 Lisp_Object args
[3], msg
;
5082 struct gcpro gcpro1
;
5086 auto_save_error_occurred
= 1;
5088 ring_bell (XFRAME (selected_frame
));
5090 args
[0] = build_string ("Auto-saving %s: %s");
5091 args
[1] = BVAR (current_buffer
, name
);
5092 args
[2] = Ferror_message_string (error
);
5093 msg
= Fformat (3, args
);
5095 nbytes
= SBYTES (msg
);
5096 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5097 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5099 for (i
= 0; i
< 3; ++i
)
5102 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5104 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5105 Fsleep_for (make_number (1), Qnil
);
5119 auto_save_mode_bits
= 0666;
5121 /* Get visited file's mode to become the auto save file's mode. */
5122 if (! NILP (BVAR (current_buffer
, filename
)))
5124 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5125 /* But make sure we can overwrite it later! */
5126 auto_save_mode_bits
= st
.st_mode
| 0600;
5127 else if ((modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5129 /* Remote files don't cooperate with stat. */
5130 auto_save_mode_bits
= XINT (modes
) | 0600;
5134 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5135 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5140 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5143 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5155 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5158 minibuffer_auto_raise
= XINT (value
);
5163 do_auto_save_make_dir (Lisp_Object dir
)
5167 call2 (Qmake_directory
, dir
, Qt
);
5168 XSETFASTINT (mode
, 0700);
5169 return Fset_file_modes (dir
, mode
);
5173 do_auto_save_eh (Lisp_Object ignore
)
5178 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5179 doc
: /* Auto-save all buffers that need it.
5180 This is all buffers that have auto-saving enabled
5181 and are changed since last auto-saved.
5182 Auto-saving writes the buffer into a file
5183 so that your editing is not lost if the system crashes.
5184 This file is not the file you visited; that changes only when you save.
5185 Normally we run the normal hook `auto-save-hook' before saving.
5187 A non-nil NO-MESSAGE argument means do not print any message if successful.
5188 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5189 (Lisp_Object no_message
, Lisp_Object current_only
)
5191 struct buffer
*old
= current_buffer
, *b
;
5192 Lisp_Object tail
, buf
;
5194 int do_handled_files
;
5196 FILE *stream
= NULL
;
5197 int count
= SPECPDL_INDEX ();
5198 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5199 int old_message_p
= 0;
5200 struct gcpro gcpro1
, gcpro2
;
5202 if (max_specpdl_size
< specpdl_size
+ 40)
5203 max_specpdl_size
= specpdl_size
+ 40;
5208 if (NILP (no_message
))
5210 old_message_p
= push_message ();
5211 record_unwind_protect (pop_message_unwind
, Qnil
);
5214 /* Ordinarily don't quit within this function,
5215 but don't make it impossible to quit (in case we get hung in I/O). */
5219 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5220 point to non-strings reached from Vbuffer_alist. */
5222 if (!NILP (Vrun_hooks
))
5223 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5225 if (STRINGP (Vauto_save_list_file_name
))
5227 Lisp_Object listfile
;
5229 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5231 /* Don't try to create the directory when shutting down Emacs,
5232 because creating the directory might signal an error, and
5233 that would leave Emacs in a strange state. */
5234 if (!NILP (Vrun_hooks
))
5238 GCPRO2 (dir
, listfile
);
5239 dir
= Ffile_name_directory (listfile
);
5240 if (NILP (Ffile_directory_p (dir
)))
5241 internal_condition_case_1 (do_auto_save_make_dir
,
5242 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5247 stream
= fopen (SSDATA (listfile
), "w");
5250 record_unwind_protect (do_auto_save_unwind
,
5251 make_save_value (stream
, 0));
5252 record_unwind_protect (do_auto_save_unwind_1
,
5253 make_number (minibuffer_auto_raise
));
5254 minibuffer_auto_raise
= 0;
5256 auto_save_error_occurred
= 0;
5258 /* On first pass, save all files that don't have handlers.
5259 On second pass, save all files that do have handlers.
5261 If Emacs is crashing, the handlers may tweak what is causing
5262 Emacs to crash in the first place, and it would be a shame if
5263 Emacs failed to autosave perfectly ordinary files because it
5264 couldn't handle some ange-ftp'd file. */
5266 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5267 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5269 buf
= XCDR (XCAR (tail
));
5272 /* Record all the buffers that have auto save mode
5273 in the special file that lists them. For each of these buffers,
5274 Record visited name (if any) and auto save name. */
5275 if (STRINGP (BVAR (b
, auto_save_file_name
))
5276 && stream
!= NULL
&& do_handled_files
== 0)
5279 if (!NILP (BVAR (b
, filename
)))
5281 fwrite (SDATA (BVAR (b
, filename
)), 1,
5282 SBYTES (BVAR (b
, filename
)), stream
);
5284 putc ('\n', stream
);
5285 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5286 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5287 putc ('\n', stream
);
5291 if (!NILP (current_only
)
5292 && b
!= current_buffer
)
5295 /* Don't auto-save indirect buffers.
5296 The base buffer takes care of it. */
5300 /* Check for auto save enabled
5301 and file changed since last auto save
5302 and file changed since last real save. */
5303 if (STRINGP (BVAR (b
, auto_save_file_name
))
5304 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5305 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5306 /* -1 means we've turned off autosaving for a while--see below. */
5307 && XINT (BVAR (b
, save_length
)) >= 0
5308 && (do_handled_files
5309 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5312 EMACS_TIME before_time
, after_time
;
5314 EMACS_GET_TIME (before_time
);
5316 /* If we had a failure, don't try again for 20 minutes. */
5317 if (b
->auto_save_failure_time
>= 0
5318 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5321 set_buffer_internal (b
);
5322 if (NILP (Vauto_save_include_big_deletions
)
5323 && (XFASTINT (BVAR (b
, save_length
)) * 10
5324 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5325 /* A short file is likely to change a large fraction;
5326 spare the user annoying messages. */
5327 && XFASTINT (BVAR (b
, save_length
)) > 5000
5328 /* These messages are frequent and annoying for `*mail*'. */
5329 && !EQ (BVAR (b
, filename
), Qnil
)
5330 && NILP (no_message
))
5332 /* It has shrunk too much; turn off auto-saving here. */
5333 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5334 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5336 minibuffer_auto_raise
= 0;
5337 /* Turn off auto-saving until there's a real save,
5338 and prevent any more warnings. */
5339 XSETINT (BVAR (b
, save_length
), -1);
5340 Fsleep_for (make_number (1), Qnil
);
5343 if (!auto_saved
&& NILP (no_message
))
5344 message1 ("Auto-saving...");
5345 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5347 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5348 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5349 set_buffer_internal (old
);
5351 EMACS_GET_TIME (after_time
);
5353 /* If auto-save took more than 60 seconds,
5354 assume it was an NFS failure that got a timeout. */
5355 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5356 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5360 /* Prevent another auto save till enough input events come in. */
5361 record_auto_save ();
5363 if (auto_saved
&& NILP (no_message
))
5367 /* If we are going to restore an old message,
5368 give time to read ours. */
5369 sit_for (make_number (1), 0, 0);
5372 else if (!auto_save_error_occurred
)
5373 /* Don't overwrite the error message if an error occurred.
5374 If we displayed a message and then restored a state
5375 with no message, leave a "done" message on the screen. */
5376 message1 ("Auto-saving...done");
5381 /* This restores the message-stack status. */
5382 unbind_to (count
, Qnil
);
5386 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5387 Sset_buffer_auto_saved
, 0, 0, 0,
5388 doc
: /* Mark current buffer as auto-saved with its current text.
5389 No auto-save file will be written until the buffer changes again. */)
5392 /* FIXME: This should not be called in indirect buffers, since
5393 they're not autosaved. */
5394 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5395 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5396 current_buffer
->auto_save_failure_time
= -1;
5400 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5401 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5402 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5405 current_buffer
->auto_save_failure_time
= -1;
5409 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5411 doc
: /* Return t if current buffer has been auto-saved recently.
5412 More precisely, if it has been auto-saved since last read from or saved
5413 in the visited file. If the buffer has no visited file,
5414 then any auto-save counts as "recent". */)
5417 /* FIXME: maybe we should return nil for indirect buffers since
5418 they're never autosaved. */
5419 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5422 /* Reading and completing file names */
5424 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5425 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5426 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5427 The return value is only relevant for a call to `read-file-name' that happens
5428 before any other event (mouse or keypress) is handled. */)
5431 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5432 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5442 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5444 struct gcpro gcpro1
, gcpro2
;
5445 Lisp_Object args
[7];
5447 GCPRO1 (default_filename
);
5448 args
[0] = intern ("read-file-name");
5451 args
[3] = default_filename
;
5452 args
[4] = mustmatch
;
5454 args
[6] = predicate
;
5455 RETURN_UNGCPRO (Ffuncall (7, args
));
5460 syms_of_fileio (void)
5462 Qoperations
= intern_c_string ("operations");
5463 Qexpand_file_name
= intern_c_string ("expand-file-name");
5464 Qsubstitute_in_file_name
= intern_c_string ("substitute-in-file-name");
5465 Qdirectory_file_name
= intern_c_string ("directory-file-name");
5466 Qfile_name_directory
= intern_c_string ("file-name-directory");
5467 Qfile_name_nondirectory
= intern_c_string ("file-name-nondirectory");
5468 Qunhandled_file_name_directory
= intern_c_string ("unhandled-file-name-directory");
5469 Qfile_name_as_directory
= intern_c_string ("file-name-as-directory");
5470 Qcopy_file
= intern_c_string ("copy-file");
5471 Qmake_directory_internal
= intern_c_string ("make-directory-internal");
5472 Qmake_directory
= intern_c_string ("make-directory");
5473 Qdelete_directory_internal
= intern_c_string ("delete-directory-internal");
5474 Qdelete_file
= intern_c_string ("delete-file");
5475 Qrename_file
= intern_c_string ("rename-file");
5476 Qadd_name_to_file
= intern_c_string ("add-name-to-file");
5477 Qmake_symbolic_link
= intern_c_string ("make-symbolic-link");
5478 Qfile_exists_p
= intern_c_string ("file-exists-p");
5479 Qfile_executable_p
= intern_c_string ("file-executable-p");
5480 Qfile_readable_p
= intern_c_string ("file-readable-p");
5481 Qfile_writable_p
= intern_c_string ("file-writable-p");
5482 Qfile_symlink_p
= intern_c_string ("file-symlink-p");
5483 Qaccess_file
= intern_c_string ("access-file");
5484 Qfile_directory_p
= intern_c_string ("file-directory-p");
5485 Qfile_regular_p
= intern_c_string ("file-regular-p");
5486 Qfile_accessible_directory_p
= intern_c_string ("file-accessible-directory-p");
5487 Qfile_modes
= intern_c_string ("file-modes");
5488 Qset_file_modes
= intern_c_string ("set-file-modes");
5489 Qset_file_times
= intern_c_string ("set-file-times");
5490 Qfile_selinux_context
= intern_c_string("file-selinux-context");
5491 Qset_file_selinux_context
= intern_c_string("set-file-selinux-context");
5492 Qfile_newer_than_file_p
= intern_c_string ("file-newer-than-file-p");
5493 Qinsert_file_contents
= intern_c_string ("insert-file-contents");
5494 Qwrite_region
= intern_c_string ("write-region");
5495 Qverify_visited_file_modtime
= intern_c_string ("verify-visited-file-modtime");
5496 Qset_visited_file_modtime
= intern_c_string ("set-visited-file-modtime");
5497 Qauto_save_coding
= intern_c_string ("auto-save-coding");
5499 staticpro (&Qoperations
);
5500 staticpro (&Qexpand_file_name
);
5501 staticpro (&Qsubstitute_in_file_name
);
5502 staticpro (&Qdirectory_file_name
);
5503 staticpro (&Qfile_name_directory
);
5504 staticpro (&Qfile_name_nondirectory
);
5505 staticpro (&Qunhandled_file_name_directory
);
5506 staticpro (&Qfile_name_as_directory
);
5507 staticpro (&Qcopy_file
);
5508 staticpro (&Qmake_directory_internal
);
5509 staticpro (&Qmake_directory
);
5510 staticpro (&Qdelete_directory_internal
);
5511 staticpro (&Qdelete_file
);
5512 staticpro (&Qrename_file
);
5513 staticpro (&Qadd_name_to_file
);
5514 staticpro (&Qmake_symbolic_link
);
5515 staticpro (&Qfile_exists_p
);
5516 staticpro (&Qfile_executable_p
);
5517 staticpro (&Qfile_readable_p
);
5518 staticpro (&Qfile_writable_p
);
5519 staticpro (&Qaccess_file
);
5520 staticpro (&Qfile_symlink_p
);
5521 staticpro (&Qfile_directory_p
);
5522 staticpro (&Qfile_regular_p
);
5523 staticpro (&Qfile_accessible_directory_p
);
5524 staticpro (&Qfile_modes
);
5525 staticpro (&Qset_file_modes
);
5526 staticpro (&Qset_file_times
);
5527 staticpro (&Qfile_selinux_context
);
5528 staticpro (&Qset_file_selinux_context
);
5529 staticpro (&Qfile_newer_than_file_p
);
5530 staticpro (&Qinsert_file_contents
);
5531 staticpro (&Qwrite_region
);
5532 staticpro (&Qverify_visited_file_modtime
);
5533 staticpro (&Qset_visited_file_modtime
);
5534 staticpro (&Qauto_save_coding
);
5536 Qfile_name_history
= intern_c_string ("file-name-history");
5537 Fset (Qfile_name_history
, Qnil
);
5538 staticpro (&Qfile_name_history
);
5540 Qfile_error
= intern_c_string ("file-error");
5541 staticpro (&Qfile_error
);
5542 Qfile_already_exists
= intern_c_string ("file-already-exists");
5543 staticpro (&Qfile_already_exists
);
5544 Qfile_date_error
= intern_c_string ("file-date-error");
5545 staticpro (&Qfile_date_error
);
5546 Qexcl
= intern_c_string ("excl");
5549 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5550 doc
: /* *Coding system for encoding file names.
5551 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5552 Vfile_name_coding_system
= Qnil
;
5554 DEFVAR_LISP ("default-file-name-coding-system",
5555 Vdefault_file_name_coding_system
,
5556 doc
: /* Default coding system for encoding file names.
5557 This variable is used only when `file-name-coding-system' is nil.
5559 This variable is set/changed by the command `set-language-environment'.
5560 User should not set this variable manually,
5561 instead use `file-name-coding-system' to get a constant encoding
5562 of file names regardless of the current language environment. */);
5563 Vdefault_file_name_coding_system
= Qnil
;
5565 Qformat_decode
= intern_c_string ("format-decode");
5566 staticpro (&Qformat_decode
);
5567 Qformat_annotate_function
= intern_c_string ("format-annotate-function");
5568 staticpro (&Qformat_annotate_function
);
5569 Qafter_insert_file_set_coding
= intern_c_string ("after-insert-file-set-coding");
5570 staticpro (&Qafter_insert_file_set_coding
);
5572 Qcar_less_than_car
= intern_c_string ("car-less-than-car");
5573 staticpro (&Qcar_less_than_car
);
5575 Fput (Qfile_error
, Qerror_conditions
,
5576 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5577 Fput (Qfile_error
, Qerror_message
,
5578 make_pure_c_string ("File error"));
5580 Fput (Qfile_already_exists
, Qerror_conditions
,
5581 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5582 Fput (Qfile_already_exists
, Qerror_message
,
5583 make_pure_c_string ("File already exists"));
5585 Fput (Qfile_date_error
, Qerror_conditions
,
5586 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5587 Fput (Qfile_date_error
, Qerror_message
,
5588 make_pure_c_string ("Cannot set file date"));
5590 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5591 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
5592 If a file name matches REGEXP, then all I/O on that file is done by calling
5595 The first argument given to HANDLER is the name of the I/O primitive
5596 to be handled; the remaining arguments are the arguments that were
5597 passed to that primitive. For example, if you do
5598 (file-exists-p FILENAME)
5599 and FILENAME is handled by HANDLER, then HANDLER is called like this:
5600 (funcall HANDLER 'file-exists-p FILENAME)
5601 The function `find-file-name-handler' checks this list for a handler
5602 for its argument. */);
5603 Vfile_name_handler_alist
= Qnil
;
5605 DEFVAR_LISP ("set-auto-coding-function",
5606 Vset_auto_coding_function
,
5607 doc
: /* If non-nil, a function to call to decide a coding system of file.
5608 Two arguments are passed to this function: the file name
5609 and the length of a file contents following the point.
5610 This function should return a coding system to decode the file contents.
5611 It should check the file name against `auto-coding-alist'.
5612 If no coding system is decided, it should check a coding system
5613 specified in the heading lines with the format:
5614 -*- ... coding: CODING-SYSTEM; ... -*-
5615 or local variable spec of the tailing lines with `coding:' tag. */);
5616 Vset_auto_coding_function
= Qnil
;
5618 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5619 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5620 Each is passed one argument, the number of characters inserted,
5621 with point at the start of the inserted text. Each function
5622 should leave point the same, and return the new character count.
5623 If `insert-file-contents' is intercepted by a handler from
5624 `file-name-handler-alist', that handler is responsible for calling the
5625 functions in `after-insert-file-functions' if appropriate. */);
5626 Vafter_insert_file_functions
= Qnil
;
5628 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5629 doc
: /* A list of functions to be called at the start of `write-region'.
5630 Each is passed two arguments, START and END as for `write-region'.
5631 These are usually two numbers but not always; see the documentation
5632 for `write-region'. The function should return a list of pairs
5633 of the form (POSITION . STRING), consisting of strings to be effectively
5634 inserted at the specified positions of the file being written (1 means to
5635 insert before the first byte written). The POSITIONs must be sorted into
5638 If there are several annotation functions, the lists returned by these
5639 functions are merged destructively. As each annotation function runs,
5640 the variable `write-region-annotations-so-far' contains a list of all
5641 annotations returned by previous annotation functions.
5643 An annotation function can return with a different buffer current.
5644 Doing so removes the annotations returned by previous functions, and
5645 resets START and END to `point-min' and `point-max' of the new buffer.
5647 After `write-region' completes, Emacs calls the function stored in
5648 `write-region-post-annotation-function', once for each buffer that was
5649 current when building the annotations (i.e., at least once), with that
5650 buffer current. */);
5651 Vwrite_region_annotate_functions
= Qnil
;
5652 staticpro (&Qwrite_region_annotate_functions
);
5653 Qwrite_region_annotate_functions
5654 = intern_c_string ("write-region-annotate-functions");
5656 DEFVAR_LISP ("write-region-post-annotation-function",
5657 Vwrite_region_post_annotation_function
,
5658 doc
: /* Function to call after `write-region' completes.
5659 The function is called with no arguments. If one or more of the
5660 annotation functions in `write-region-annotate-functions' changed the
5661 current buffer, the function stored in this variable is called for
5662 each of those additional buffers as well, in addition to the original
5663 buffer. The relevant buffer is current during each function call. */);
5664 Vwrite_region_post_annotation_function
= Qnil
;
5665 staticpro (&Vwrite_region_annotation_buffers
);
5667 DEFVAR_LISP ("write-region-annotations-so-far",
5668 Vwrite_region_annotations_so_far
,
5669 doc
: /* When an annotation function is called, this holds the previous annotations.
5670 These are the annotations made by other annotation functions
5671 that were already called. See also `write-region-annotate-functions'. */);
5672 Vwrite_region_annotations_so_far
= Qnil
;
5674 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5675 doc
: /* A list of file name handlers that temporarily should not be used.
5676 This applies only to the operation `inhibit-file-name-operation'. */);
5677 Vinhibit_file_name_handlers
= Qnil
;
5679 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5680 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5681 Vinhibit_file_name_operation
= Qnil
;
5683 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
5684 doc
: /* File name in which we write a list of all auto save file names.
5685 This variable is initialized automatically from `auto-save-list-file-prefix'
5686 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5687 a non-nil value. */);
5688 Vauto_save_list_file_name
= Qnil
;
5690 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
5691 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5692 Normally auto-save files are written under other names. */);
5693 Vauto_save_visited_file_name
= Qnil
;
5695 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
5696 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5697 If nil, deleting a substantial portion of the text disables auto-save
5698 in the buffer; this is the default behavior, because the auto-save
5699 file is usually more useful if it contains the deleted text. */);
5700 Vauto_save_include_big_deletions
= Qnil
;
5703 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
5704 doc
: /* *Non-nil means don't call fsync in `write-region'.
5705 This variable affects calls to `write-region' as well as save commands.
5706 A non-nil value may result in data loss! */);
5707 write_region_inhibit_fsync
= 0;
5710 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
5711 doc
: /* Specifies whether to use the system's trash can.
5712 When non-nil, certain file deletion commands use the function
5713 `move-file-to-trash' instead of deleting files outright.
5714 This includes interactive calls to `delete-file' and
5715 `delete-directory' and the Dired deletion commands. */);
5716 delete_by_moving_to_trash
= 0;
5717 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5718 Qmove_file_to_trash
= intern_c_string ("move-file-to-trash");
5719 staticpro (&Qmove_file_to_trash
);
5720 Qcopy_directory
= intern_c_string ("copy-directory");
5721 staticpro (&Qcopy_directory
);
5722 Qdelete_directory
= intern_c_string ("delete-directory");
5723 staticpro (&Qdelete_directory
);
5725 defsubr (&Sfind_file_name_handler
);
5726 defsubr (&Sfile_name_directory
);
5727 defsubr (&Sfile_name_nondirectory
);
5728 defsubr (&Sunhandled_file_name_directory
);
5729 defsubr (&Sfile_name_as_directory
);
5730 defsubr (&Sdirectory_file_name
);
5731 defsubr (&Smake_temp_name
);
5732 defsubr (&Sexpand_file_name
);
5733 defsubr (&Ssubstitute_in_file_name
);
5734 defsubr (&Scopy_file
);
5735 defsubr (&Smake_directory_internal
);
5736 defsubr (&Sdelete_directory_internal
);
5737 defsubr (&Sdelete_file
);
5738 defsubr (&Srename_file
);
5739 defsubr (&Sadd_name_to_file
);
5740 defsubr (&Smake_symbolic_link
);
5741 defsubr (&Sfile_name_absolute_p
);
5742 defsubr (&Sfile_exists_p
);
5743 defsubr (&Sfile_executable_p
);
5744 defsubr (&Sfile_readable_p
);
5745 defsubr (&Sfile_writable_p
);
5746 defsubr (&Saccess_file
);
5747 defsubr (&Sfile_symlink_p
);
5748 defsubr (&Sfile_directory_p
);
5749 defsubr (&Sfile_accessible_directory_p
);
5750 defsubr (&Sfile_regular_p
);
5751 defsubr (&Sfile_modes
);
5752 defsubr (&Sset_file_modes
);
5753 defsubr (&Sset_file_times
);
5754 defsubr (&Sfile_selinux_context
);
5755 defsubr (&Sset_file_selinux_context
);
5756 defsubr (&Sset_default_file_modes
);
5757 defsubr (&Sdefault_file_modes
);
5758 defsubr (&Sfile_newer_than_file_p
);
5759 defsubr (&Sinsert_file_contents
);
5760 defsubr (&Swrite_region
);
5761 defsubr (&Scar_less_than_car
);
5762 defsubr (&Sverify_visited_file_modtime
);
5763 defsubr (&Sclear_visited_file_modtime
);
5764 defsubr (&Svisited_file_modtime
);
5765 defsubr (&Sset_visited_file_modtime
);
5766 defsubr (&Sdo_auto_save
);
5767 defsubr (&Sset_buffer_auto_saved
);
5768 defsubr (&Sclear_buffer_auto_save_failure
);
5769 defsubr (&Srecent_auto_save_p
);
5771 defsubr (&Snext_read_file_uses_dialog_p
);
5774 defsubr (&Sunix_sync
);