1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2013 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>
34 #ifdef HAVE_LIBSELINUX
35 #include <selinux/selinux.h>
36 #include <selinux/context.h>
39 #ifdef HAVE_ACL_SET_FILE
46 #include "intervals.h"
47 #include "character.h"
51 #include "blockinput.h"
53 #include "dispextern.h"
60 #endif /* not WINDOWSNT */
64 #include <sys/param.h>
68 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
69 redirector allows the six letters between 'Z' and 'a' as well. */
71 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
74 #define IS_DRIVE(x) c_isalpha (x)
76 /* Need to lower-case the drive letter, or else expanded
77 filenames will sometimes compare unequal, because
78 `expand-file-name' doesn't always down-case the drive letter. */
79 #define DRIVE_LETTER(x) c_tolower (x)
84 #include <allocator.h>
85 #include <careadlinkat.h>
86 #include <stat-time.h>
94 /* True during writing of auto-save files. */
95 static bool auto_saving
;
97 /* Nonzero umask during creation of auto-save directories. */
98 static mode_t auto_saving_dir_umask
;
100 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
101 a new file with the same mode as the original. */
102 static mode_t auto_save_mode_bits
;
104 /* Set by auto_save_1 if an error occurred during the last auto-save. */
105 static bool auto_save_error_occurred
;
107 /* If VALID_TIMESTAMP_FILE_SYSTEM, then TIMESTAMP_FILE_SYSTEM is the device
108 number of a file system where time stamps were observed to to work. */
109 static bool valid_timestamp_file_system
;
110 static dev_t timestamp_file_system
;
112 /* The symbol bound to coding-system-for-read when
113 insert-file-contents is called for recovering a file. This is not
114 an actual coding system name, but just an indicator to tell
115 insert-file-contents to use `emacs-mule' with a special flag for
116 auto saving and recovering a file. */
117 static Lisp_Object Qauto_save_coding
;
119 /* Property name of a file name handler,
120 which gives a list of operations it handles.. */
121 static Lisp_Object Qoperations
;
123 /* Lisp functions for translating file formats. */
124 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
126 /* Lisp function for setting buffer-file-coding-system and the
127 multibyteness of the current buffer after inserting a file. */
128 static Lisp_Object Qafter_insert_file_set_coding
;
130 static Lisp_Object Qwrite_region_annotate_functions
;
131 /* Each time an annotation function changes the buffer, the new buffer
133 static Lisp_Object Vwrite_region_annotation_buffers
;
135 static Lisp_Object Qdelete_by_moving_to_trash
;
137 /* Lisp function for moving files to trash. */
138 static Lisp_Object Qmove_file_to_trash
;
140 /* Lisp function for recursively copying directories. */
141 static Lisp_Object Qcopy_directory
;
143 /* Lisp function for recursively deleting directories. */
144 static Lisp_Object Qdelete_directory
;
149 Lisp_Object Qfile_error
, Qfile_notify_error
;
150 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
151 static Lisp_Object Qexcl
;
152 Lisp_Object Qfile_name_history
;
154 static Lisp_Object Qcar_less_than_car
;
156 static bool a_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
157 Lisp_Object
*, struct coding_system
*);
158 static bool e_write (int, Lisp_Object
, ptrdiff_t, ptrdiff_t,
159 struct coding_system
*);
163 report_file_error (const char *string
, Lisp_Object data
)
165 Lisp_Object errstring
;
169 synchronize_system_messages_locale ();
170 str
= strerror (errorno
);
171 errstring
= code_convert_string_norecord (build_unibyte_string (str
),
172 Vlocale_coding_system
, 0);
178 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
181 /* System error messages are capitalized. Downcase the initial
182 unless it is followed by a slash. (The slash case caters to
183 error messages that begin with "I/O" or, in German, "E/A".) */
184 if (STRING_MULTIBYTE (errstring
)
185 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
189 str
= SSDATA (errstring
);
190 c
= STRING_CHAR ((unsigned char *) str
);
191 Faset (errstring
, make_number (0), make_number (downcase (c
)));
194 xsignal (Qfile_error
,
195 Fcons (build_string (string
), Fcons (errstring
, data
)));
200 close_file_unwind (Lisp_Object fd
)
202 emacs_close (XFASTINT (fd
));
206 /* Restore point, having saved it as a marker. */
209 restore_point_unwind (Lisp_Object location
)
211 Fgoto_char (location
);
212 Fset_marker (location
, Qnil
, Qnil
);
217 static Lisp_Object Qexpand_file_name
;
218 static Lisp_Object Qsubstitute_in_file_name
;
219 static Lisp_Object Qdirectory_file_name
;
220 static Lisp_Object Qfile_name_directory
;
221 static Lisp_Object Qfile_name_nondirectory
;
222 static Lisp_Object Qunhandled_file_name_directory
;
223 static Lisp_Object Qfile_name_as_directory
;
224 static Lisp_Object Qcopy_file
;
225 static Lisp_Object Qmake_directory_internal
;
226 static Lisp_Object Qmake_directory
;
227 static Lisp_Object Qdelete_directory_internal
;
228 Lisp_Object Qdelete_file
;
229 static Lisp_Object Qrename_file
;
230 static Lisp_Object Qadd_name_to_file
;
231 static Lisp_Object Qmake_symbolic_link
;
232 Lisp_Object Qfile_exists_p
;
233 static Lisp_Object Qfile_executable_p
;
234 static Lisp_Object Qfile_readable_p
;
235 static Lisp_Object Qfile_writable_p
;
236 static Lisp_Object Qfile_symlink_p
;
237 static Lisp_Object Qaccess_file
;
238 Lisp_Object Qfile_directory_p
;
239 static Lisp_Object Qfile_regular_p
;
240 static Lisp_Object Qfile_accessible_directory_p
;
241 static Lisp_Object Qfile_modes
;
242 static Lisp_Object Qset_file_modes
;
243 static Lisp_Object Qset_file_times
;
244 static Lisp_Object Qfile_selinux_context
;
245 static Lisp_Object Qset_file_selinux_context
;
246 static Lisp_Object Qfile_acl
;
247 static Lisp_Object Qset_file_acl
;
248 static Lisp_Object Qfile_newer_than_file_p
;
249 Lisp_Object Qinsert_file_contents
;
250 static Lisp_Object Qchoose_write_coding_system
;
251 Lisp_Object Qwrite_region
;
252 static Lisp_Object Qverify_visited_file_modtime
;
253 static Lisp_Object Qset_visited_file_modtime
;
255 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
256 Sfind_file_name_handler
, 2, 2, 0,
257 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
258 Otherwise, return nil.
259 A file name is handled if one of the regular expressions in
260 `file-name-handler-alist' matches it.
262 If OPERATION equals `inhibit-file-name-operation', then we ignore
263 any handlers that are members of `inhibit-file-name-handlers',
264 but we still do run any other handlers. This lets handlers
265 use the standard functions without calling themselves recursively. */)
266 (Lisp_Object filename
, Lisp_Object operation
)
268 /* This function must not munge the match data. */
269 Lisp_Object chain
, inhibited_handlers
, result
;
273 CHECK_STRING (filename
);
275 if (EQ (operation
, Vinhibit_file_name_operation
))
276 inhibited_handlers
= Vinhibit_file_name_handlers
;
278 inhibited_handlers
= Qnil
;
280 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
281 chain
= XCDR (chain
))
287 Lisp_Object string
= XCAR (elt
);
289 Lisp_Object handler
= XCDR (elt
);
290 Lisp_Object operations
= Qnil
;
292 if (SYMBOLP (handler
))
293 operations
= Fget (handler
, Qoperations
);
296 && (match_pos
= fast_string_match (string
, filename
)) > pos
297 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
301 handler
= XCDR (elt
);
302 tem
= Fmemq (handler
, inhibited_handlers
);
316 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
318 doc
: /* Return the directory component in file name FILENAME.
319 Return nil if FILENAME does not include a directory.
320 Otherwise return a directory name.
321 Given a Unix syntax file name, returns a string ending in slash. */)
322 (Lisp_Object filename
)
325 register const char *beg
;
330 register const char *p
;
333 CHECK_STRING (filename
);
335 /* If the file name has special constructs in it,
336 call the corresponding file handler. */
337 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
340 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
342 return STRINGP (handled_name
) ? handled_name
: Qnil
;
346 beg
= alloca (SBYTES (filename
) + 1);
347 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
349 beg
= SSDATA (filename
);
351 p
= beg
+ SBYTES (filename
);
353 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
355 /* only recognize drive specifier at the beginning */
357 /* handle the "/:d:foo" and "/:foo" cases correctly */
358 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
359 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
366 /* Expansion of "c:" to drive and default directory. */
369 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
370 char *res
= alloca (MAXPATHLEN
+ 1);
373 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
375 memcpy (res
, beg
, 2);
380 if (getdefdir (c_toupper (*beg
) - 'A' + 1, r
))
382 size_t l
= strlen (res
);
384 if (l
> 3 || !IS_DIRECTORY_SEP (res
[l
- 1]))
387 p
= beg
+ strlen (beg
);
388 dostounix_filename (beg
, 0);
389 tem_fn
= make_specified_string (beg
, -1, p
- beg
,
390 STRING_MULTIBYTE (filename
));
393 tem_fn
= make_specified_string (beg
- 2, -1, p
- beg
+ 2,
394 STRING_MULTIBYTE (filename
));
396 else if (STRING_MULTIBYTE (filename
))
398 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 1);
399 dostounix_filename (SSDATA (tem_fn
), 1);
401 if (!NILP (Vw32_downcase_file_names
))
402 tem_fn
= Fdowncase (tem_fn
);
407 dostounix_filename (beg
, 0);
408 tem_fn
= make_specified_string (beg
, -1, p
- beg
, 0);
412 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
416 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
417 Sfile_name_nondirectory
, 1, 1, 0,
418 doc
: /* Return file name FILENAME sans its directory.
419 For example, in a Unix-syntax file name,
420 this is everything after the last slash,
421 or the entire name if it contains no slash. */)
422 (Lisp_Object filename
)
424 register const char *beg
, *p
, *end
;
427 CHECK_STRING (filename
);
429 /* If the file name has special constructs in it,
430 call the corresponding file handler. */
431 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
434 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
436 if (STRINGP (handled_name
))
438 error ("Invalid handler in `file-name-handler-alist'");
441 beg
= SSDATA (filename
);
442 end
= p
= beg
+ SBYTES (filename
);
444 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
446 /* only recognize drive specifier at beginning */
448 /* handle the "/:d:foo" case correctly */
449 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
454 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
457 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
458 Sunhandled_file_name_directory
, 1, 1, 0,
459 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
460 A `directly usable' directory name is one that may be used without the
461 intervention of any file handler.
462 If FILENAME is a directly usable file itself, return
463 \(file-name-directory FILENAME).
464 If FILENAME refers to a file which is not accessible from a local process,
465 then this should return nil.
466 The `call-process' and `start-process' functions use this function to
467 get a current directory to run processes in. */)
468 (Lisp_Object filename
)
472 /* If the file name has special constructs in it,
473 call the corresponding file handler. */
474 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
477 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
479 return STRINGP (handled_name
) ? handled_name
: Qnil
;
482 return Ffile_name_directory (filename
);
485 /* Convert from file name SRC of length SRCLEN to directory name in
486 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
487 string. On UNIX, just make sure there is a terminating /. Return
488 the length of DST in bytes. */
491 file_name_as_directory (char *dst
, const char *src
, ptrdiff_t srclen
,
504 if (!IS_DIRECTORY_SEP (dst
[srclen
- 1]))
506 dst
[srclen
] = DIRECTORY_SEP
;
507 dst
[srclen
+ 1] = '\0';
511 dostounix_filename (dst
, multibyte
);
516 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
517 Sfile_name_as_directory
, 1, 1, 0,
518 doc
: /* Return a string representing the file name FILE interpreted as a directory.
519 This operation exists because a directory is also a file, but its name as
520 a directory is different from its name as a file.
521 The result can be used as the value of `default-directory'
522 or passed as second argument to `expand-file-name'.
523 For a Unix-syntax file name, just appends a slash. */)
534 /* If the file name has special constructs in it,
535 call the corresponding file handler. */
536 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
539 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
541 if (STRINGP (handled_name
))
543 error ("Invalid handler in `file-name-handler-alist'");
547 if (!NILP (Vw32_downcase_file_names
))
548 file
= Fdowncase (file
);
550 buf
= alloca (SBYTES (file
) + 10);
551 length
= file_name_as_directory (buf
, SSDATA (file
), SBYTES (file
),
552 STRING_MULTIBYTE (file
));
553 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (file
));
556 /* Convert from directory name SRC of length SRCLEN to file name in
557 DST. MULTIBYTE non-zero means the file name in SRC is a multibyte
558 string. On UNIX, just make sure there isn't a terminating /.
559 Return the length of DST in bytes. */
562 directory_file_name (char *dst
, char *src
, ptrdiff_t srclen
, bool multibyte
)
564 /* Process as Unix format: just remove any final slash.
565 But leave "/" unchanged; do not change it to "". */
568 && IS_DIRECTORY_SEP (dst
[srclen
- 1])
570 && !IS_ANY_SEP (dst
[srclen
- 2])
578 dostounix_filename (dst
, multibyte
);
583 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
585 doc
: /* Returns the file name of the directory named DIRECTORY.
586 This is the name of the file that holds the data for the directory DIRECTORY.
587 This operation exists because a directory is also a file, but its name as
588 a directory is different from its name as a file.
589 In Unix-syntax, this function just removes the final slash. */)
590 (Lisp_Object directory
)
596 CHECK_STRING (directory
);
598 if (NILP (directory
))
601 /* If the file name has special constructs in it,
602 call the corresponding file handler. */
603 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
606 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
608 if (STRINGP (handled_name
))
610 error ("Invalid handler in `file-name-handler-alist'");
614 if (!NILP (Vw32_downcase_file_names
))
615 directory
= Fdowncase (directory
);
617 buf
= alloca (SBYTES (directory
) + 20);
618 length
= directory_file_name (buf
, SSDATA (directory
), SBYTES (directory
),
619 STRING_MULTIBYTE (directory
));
620 return make_specified_string (buf
, -1, length
, STRING_MULTIBYTE (directory
));
623 static const char make_temp_name_tbl
[64] =
625 'A','B','C','D','E','F','G','H',
626 'I','J','K','L','M','N','O','P',
627 'Q','R','S','T','U','V','W','X',
628 'Y','Z','a','b','c','d','e','f',
629 'g','h','i','j','k','l','m','n',
630 'o','p','q','r','s','t','u','v',
631 'w','x','y','z','0','1','2','3',
632 '4','5','6','7','8','9','-','_'
635 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
637 /* Value is a temporary file name starting with PREFIX, a string.
639 The Emacs process number forms part of the result, so there is
640 no danger of generating a name being used by another process.
641 In addition, this function makes an attempt to choose a name
642 which has no existing file. To make this work, PREFIX should be
643 an absolute file name.
645 BASE64_P means add the pid as 3 characters in base64
646 encoding. In this case, 6 characters will be added to PREFIX to
647 form the file name. Otherwise, if Emacs is running on a system
648 with long file names, add the pid as a decimal number.
650 This function signals an error if no unique file name could be
654 make_temp_name (Lisp_Object prefix
, bool base64_p
)
660 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
663 CHECK_STRING (prefix
);
665 /* VAL is created by adding 6 characters to PREFIX. The first
666 three are the PID of this process, in base 64, and the second
667 three are incremented if the file already exists. This ensures
668 262144 unique file names per PID per PREFIX. */
674 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
675 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
676 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
681 #ifdef HAVE_LONG_FILE_NAMES
682 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
684 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
685 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
686 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
691 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
692 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
693 if (!STRING_MULTIBYTE (prefix
))
694 STRING_SET_UNIBYTE (val
);
696 memcpy (data
, SSDATA (prefix
), len
);
699 memcpy (p
, pidbuf
, pidlen
);
702 /* Here we try to minimize useless stat'ing when this function is
703 invoked many times successively with the same PREFIX. We achieve
704 this by initializing count to a random value, and incrementing it
707 We don't want make-temp-name to be called while dumping,
708 because then make_temp_name_count_initialized_p would get set
709 and then make_temp_name_count would not be set when Emacs starts. */
711 if (!make_temp_name_count_initialized_p
)
713 make_temp_name_count
= time (NULL
);
714 make_temp_name_count_initialized_p
= 1;
719 unsigned num
= make_temp_name_count
;
721 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
722 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
723 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
725 /* Poor man's congruential RN generator. Replace with
726 ++make_temp_name_count for debugging. */
727 make_temp_name_count
+= 25229;
728 make_temp_name_count
%= 225307;
730 if (!check_existing (data
))
732 /* We want to return only if errno is ENOENT. */
736 /* The error here is dubious, but there is little else we
737 can do. The alternatives are to return nil, which is
738 as bad as (and in many cases worse than) throwing the
739 error, or to ignore the error, which will likely result
740 in looping through 225307 stat's, which is not only
741 dog-slow, but also useless since eventually nil would
742 have to be returned anyway. */
743 report_file_error ("Cannot create temporary name for prefix",
744 Fcons (prefix
, Qnil
));
751 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
752 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
753 The Emacs process number forms part of the result,
754 so there is no danger of generating a name being used by another process.
756 In addition, this function makes an attempt to choose a name
757 which has no existing file. To make this work,
758 PREFIX should be an absolute file name.
760 There is a race condition between calling `make-temp-name' and creating the
761 file which opens all kinds of security holes. For that reason, you should
762 probably use `make-temp-file' instead, except in three circumstances:
764 * If you are creating the file in the user's home directory.
765 * If you are creating a directory rather than an ordinary file.
766 * If you are taking special precautions as `make-temp-file' does. */)
769 return make_temp_name (prefix
, 0);
774 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
775 doc
: /* Convert filename NAME to absolute, and canonicalize it.
776 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
777 \(does not start with slash or tilde); both the directory name and
778 a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or
779 missing, the current buffer's value of `default-directory' is used.
780 NAME should be a string that is a valid file name for the underlying
782 File name components that are `.' are removed, and
783 so are file name components followed by `..', along with the `..' itself;
784 note that these simplifications are done without checking the resulting
785 file names in the file system.
786 Multiple consecutive slashes are collapsed into a single slash,
787 except at the beginning of the file name when they are significant (e.g.,
788 UNC file names on MS-Windows.)
789 An initial `~/' expands to your home directory.
790 An initial `~USER/' expands to USER's home directory.
791 See also the function `substitute-in-file-name'.
793 For technical reasons, this function can return correct but
794 non-intuitive results for the root directory; for instance,
795 \(expand-file-name ".." "/") returns "/..". For this reason, use
796 \(directory-file-name (file-name-directory dirname)) to traverse a
797 filesystem tree, not (expand-file-name ".." dirname). */)
798 (Lisp_Object name
, Lisp_Object default_directory
)
800 /* These point to SDATA and need to be careful with string-relocation
801 during GC (via DECODE_FILE). */
804 /* This should only point to alloca'd data. */
811 bool collapse_newdir
= 1;
815 Lisp_Object handler
, result
, handled_name
;
821 /* If the file name has special constructs in it,
822 call the corresponding file handler. */
823 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
826 handled_name
= call3 (handler
, Qexpand_file_name
,
827 name
, default_directory
);
828 if (STRINGP (handled_name
))
830 error ("Invalid handler in `file-name-handler-alist'");
834 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
835 if (NILP (default_directory
))
836 default_directory
= BVAR (current_buffer
, directory
);
837 if (! STRINGP (default_directory
))
840 /* "/" is not considered a root directory on DOS_NT, so using "/"
841 here causes an infinite recursion in, e.g., the following:
843 (let (default-directory)
844 (expand-file-name "a"))
846 To avoid this, we set default_directory to the root of the
848 default_directory
= build_string (emacs_root_dir ());
850 default_directory
= build_string ("/");
854 if (!NILP (default_directory
))
856 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
859 handled_name
= call3 (handler
, Qexpand_file_name
,
860 name
, default_directory
);
861 if (STRINGP (handled_name
))
863 error ("Invalid handler in `file-name-handler-alist'");
868 char *o
= SSDATA (default_directory
);
870 /* Make sure DEFAULT_DIRECTORY is properly expanded.
871 It would be better to do this down below where we actually use
872 default_directory. Unfortunately, calling Fexpand_file_name recursively
873 could invoke GC, and the strings might be relocated. This would
874 be annoying because we have pointers into strings lying around
875 that would need adjusting, and people would add new pointers to
876 the code and forget to adjust them, resulting in intermittent bugs.
877 Putting this call here avoids all that crud.
879 The EQ test avoids infinite recursion. */
880 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
881 /* Save time in some common cases - as long as default_directory
882 is not relative, it can be canonicalized with name below (if it
883 is needed at all) without requiring it to be expanded now. */
885 /* Detect MSDOS file names with drive specifiers. */
886 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
887 && IS_DIRECTORY_SEP (o
[2]))
889 /* Detect Windows file names in UNC format. */
890 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
892 #else /* not DOS_NT */
893 /* Detect Unix absolute file names (/... alone is not absolute on
895 && ! (IS_DIRECTORY_SEP (o
[0]))
896 #endif /* not DOS_NT */
902 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
906 multibyte
= STRING_MULTIBYTE (name
);
907 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
910 default_directory
= string_to_multibyte (default_directory
);
913 name
= string_to_multibyte (name
);
919 if (!NILP (Vw32_downcase_file_names
))
920 default_directory
= Fdowncase (default_directory
);
923 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
924 nm
= alloca (SBYTES (name
) + 1);
925 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
928 /* Note if special escape prefix is present, but remove for now. */
929 if (nm
[0] == '/' && nm
[1] == ':')
935 /* Find and remove drive specifier if present; this makes nm absolute
936 even if the rest of the name appears to be relative. Only look for
937 drive specifier at the beginning. */
938 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
940 drive
= (unsigned char) nm
[0];
945 /* If we see "c://somedir", we want to strip the first slash after the
946 colon when stripping the drive letter. Otherwise, this expands to
948 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
951 /* Discard any previous drive specifier if nm is now in UNC format. */
952 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
956 #endif /* WINDOWSNT */
959 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
960 none are found, we can probably return right away. We will avoid
961 allocating a new string if name is already fully expanded. */
963 IS_DIRECTORY_SEP (nm
[0])
965 && drive
&& !is_escaped
968 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
972 /* If it turns out that the filename we want to return is just a
973 suffix of FILENAME, we don't need to go through and edit
974 things; we just need to construct a new string using data
975 starting at the middle of FILENAME. If we set LOSE, that
976 means we've discovered that we can't do that cool trick. */
982 /* Since we know the name is absolute, we can assume that each
983 element starts with a "/". */
985 /* "." and ".." are hairy. */
986 if (IS_DIRECTORY_SEP (p
[0])
988 && (IS_DIRECTORY_SEP (p
[2])
990 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
993 /* We want to replace multiple `/' in a row with a single
996 && IS_DIRECTORY_SEP (p
[0])
997 && IS_DIRECTORY_SEP (p
[1]))
1004 /* Make sure directories are all separated with /, but
1005 avoid allocation of a new string when not required. */
1006 dostounix_filename (nm
, multibyte
);
1008 if (IS_DIRECTORY_SEP (nm
[1]))
1010 if (strcmp (nm
, SSDATA (name
)) != 0)
1011 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1015 /* Drive must be set, so this is okay. */
1016 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
1020 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1021 temp
[0] = DRIVE_LETTER (drive
);
1022 name
= concat2 (build_string (temp
), name
);
1025 if (!NILP (Vw32_downcase_file_names
))
1026 name
= Fdowncase (name
);
1029 #else /* not DOS_NT */
1030 if (strcmp (nm
, SSDATA (name
)) == 0)
1032 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1033 #endif /* not DOS_NT */
1037 /* At this point, nm might or might not be an absolute file name. We
1038 need to expand ~ or ~user if present, otherwise prefix nm with
1039 default_directory if nm is not absolute, and finally collapse /./
1040 and /foo/../ sequences.
1042 We set newdir to be the appropriate prefix if one is needed:
1043 - the relevant user directory if nm starts with ~ or ~user
1044 - the specified drive's working dir (DOS/NT only) if nm does not
1046 - the value of default_directory.
1048 Note that these prefixes are not guaranteed to be absolute (except
1049 for the working dir of a drive). Therefore, to ensure we always
1050 return an absolute name, if the final prefix is not absolute we
1051 append it to the current working directory. */
1055 if (nm
[0] == '~') /* prefix ~ */
1057 if (IS_DIRECTORY_SEP (nm
[1])
1058 || nm
[1] == 0) /* ~ by itself */
1062 if (!(newdir
= egetenv ("HOME")))
1065 /* `egetenv' may return a unibyte string, which will bite us since
1066 we expect the directory to be multibyte. */
1067 tem
= build_string (newdir
);
1068 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1070 hdir
= DECODE_FILE (tem
);
1071 newdir
= SSDATA (hdir
);
1074 collapse_newdir
= 0;
1077 else /* ~user/filename */
1080 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1081 o
= alloca (p
- nm
+ 1);
1082 memcpy (o
, nm
, p
- nm
);
1086 pw
= getpwnam (o
+ 1);
1092 newdir
= pw
->pw_dir
;
1093 /* `getpwnam' may return a unibyte string, which will
1094 bite us since we expect the directory to be
1096 tem
= build_string (newdir
);
1097 if (multibyte
&& !STRING_MULTIBYTE (tem
))
1099 hdir
= DECODE_FILE (tem
);
1100 newdir
= SSDATA (hdir
);
1104 collapse_newdir
= 0;
1108 /* If we don't find a user of that name, leave the name
1109 unchanged; don't move nm forward to p. */
1114 /* On DOS and Windows, nm is absolute if a drive name was specified;
1115 use the drive's current directory as the prefix if needed. */
1116 if (!newdir
&& drive
)
1118 /* Get default directory if needed to make nm absolute. */
1120 if (!IS_DIRECTORY_SEP (nm
[0]))
1122 adir
= alloca (MAXPATHLEN
+ 1);
1123 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1127 Lisp_Object tem
= build_string (adir
);
1129 tem
= DECODE_FILE (tem
);
1130 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1135 /* Either nm starts with /, or drive isn't mounted. */
1137 adir
[0] = DRIVE_LETTER (drive
);
1146 /* Finally, if no prefix has been specified and nm is not absolute,
1147 then it must be expanded relative to default_directory. */
1151 /* /... alone is not absolute on DOS and Windows. */
1152 && !IS_DIRECTORY_SEP (nm
[0])
1155 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1159 newdir
= SSDATA (default_directory
);
1161 /* Note if special escape prefix is present, but remove for now. */
1162 if (newdir
[0] == '/' && newdir
[1] == ':')
1173 /* First ensure newdir is an absolute name. */
1175 /* Detect MSDOS file names with drive specifiers. */
1176 ! (IS_DRIVE (newdir
[0])
1177 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1179 /* Detect Windows file names in UNC format. */
1180 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1184 /* Effectively, let newdir be (expand-file-name newdir cwd).
1185 Because of the admonition against calling expand-file-name
1186 when we have pointers into lisp strings, we accomplish this
1187 indirectly by prepending newdir to nm if necessary, and using
1188 cwd (or the wd of newdir's drive) as the new newdir. */
1191 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1193 drive
= (unsigned char) newdir
[0];
1196 if (!IS_DIRECTORY_SEP (nm
[0]))
1198 ptrdiff_t newlen
= strlen (newdir
);
1199 char *tmp
= alloca (newlen
+ strlen (nm
) + 2);
1200 file_name_as_directory (tmp
, newdir
, newlen
, multibyte
);
1204 adir
= alloca (MAXPATHLEN
+ 1);
1207 if (!getdefdir (c_toupper (drive
) - 'A' + 1, adir
))
1211 getcwd (adir
, MAXPATHLEN
+ 1);
1214 Lisp_Object tem
= build_string (adir
);
1216 tem
= DECODE_FILE (tem
);
1217 memcpy (adir
, SSDATA (tem
), SBYTES (tem
) + 1);
1222 /* Strip off drive name from prefix, if present. */
1223 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1229 /* Keep only a prefix from newdir if nm starts with slash
1230 (//server/share for UNC, nothing otherwise). */
1231 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1234 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1236 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1238 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1240 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1253 /* Get rid of any slash at the end of newdir, unless newdir is
1254 just / or // (an incomplete UNC name). */
1255 length
= strlen (newdir
);
1257 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1259 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1263 char *temp
= alloca (length
);
1264 memcpy (temp
, newdir
, length
- 1);
1265 temp
[length
- 1] = 0;
1276 /* Now concatenate the directory and name to new space in the stack frame. */
1277 tlen
+= strlen (nm
) + 1;
1279 /* Reserve space for drive specifier and escape prefix, since either
1280 or both may need to be inserted. (The Microsoft x86 compiler
1281 produces incorrect code if the following two lines are combined.) */
1282 target
= alloca (tlen
+ 4);
1284 #else /* not DOS_NT */
1285 target
= alloca (tlen
);
1286 #endif /* not DOS_NT */
1291 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1294 /* If newdir is effectively "C:/", then the drive letter will have
1295 been stripped and newdir will be "/". Concatenating with an
1296 absolute directory in nm produces "//", which will then be
1297 incorrectly treated as a network share. Ignore newdir in
1298 this case (keeping the drive letter). */
1299 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1300 && newdir
[1] == '\0'))
1302 strcpy (target
, newdir
);
1305 file_name_as_directory (target
, newdir
, length
, multibyte
);
1308 strcat (target
, nm
);
1310 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1318 if (!IS_DIRECTORY_SEP (*p
))
1322 else if (p
[1] == '.'
1323 && (IS_DIRECTORY_SEP (p
[2])
1326 /* If "/." is the entire filename, keep the "/". Otherwise,
1327 just delete the whole "/.". */
1328 if (o
== target
&& p
[2] == '\0')
1332 else if (p
[1] == '.' && p
[2] == '.'
1333 /* `/../' is the "superroot" on certain file systems.
1334 Turned off on DOS_NT systems because they have no
1335 "superroot" and because this causes us to produce
1336 file names like "d:/../foo" which fail file-related
1337 functions of the underlying OS. (To reproduce, try a
1338 long series of "../../" in default_directory, longer
1339 than the number of levels from the root.) */
1343 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1348 while (o
!= target
&& (--o
, !IS_DIRECTORY_SEP (*o
)))
1351 /* Don't go below server level in UNC filenames. */
1352 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1353 && IS_DIRECTORY_SEP (*target
))
1357 /* Keep initial / only if this is the whole name. */
1358 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1362 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1363 /* Collapse multiple `/' in a row. */
1372 /* At last, set drive name. */
1374 /* Except for network file name. */
1375 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1376 #endif /* WINDOWSNT */
1378 if (!drive
) emacs_abort ();
1380 target
[0] = DRIVE_LETTER (drive
);
1383 /* Reinsert the escape prefix if required. */
1390 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1391 dostounix_filename (SSDATA (result
), multibyte
);
1393 if (!NILP (Vw32_downcase_file_names
))
1394 result
= Fdowncase (result
);
1397 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1398 #endif /* !DOS_NT */
1401 /* Again look to see if the file name has special constructs in it
1402 and perhaps call the corresponding file handler. This is needed
1403 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1404 the ".." component gives us "/user@host:/bar/../baz" which needs
1405 to be expanded again. */
1406 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1407 if (!NILP (handler
))
1409 handled_name
= call3 (handler
, Qexpand_file_name
,
1410 result
, default_directory
);
1411 if (STRINGP (handled_name
))
1412 return handled_name
;
1413 error ("Invalid handler in `file-name-handler-alist'");
1420 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1421 This is the old version of expand-file-name, before it was thoroughly
1422 rewritten for Emacs 10.31. We leave this version here commented-out,
1423 because the code is very complex and likely to have subtle bugs. If
1424 bugs _are_ found, it might be of interest to look at the old code and
1425 see what did it do in the relevant situation.
1427 Don't remove this code: it's true that it will be accessible
1428 from the repository, but a few years from deletion, people will
1429 forget it is there. */
1431 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1432 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1433 "Convert FILENAME to absolute, and canonicalize it.\n\
1434 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1435 \(does not start with slash); if DEFAULT is nil or missing,\n\
1436 the current buffer's value of default-directory is used.\n\
1437 Filenames containing `.' or `..' as components are simplified;\n\
1438 initial `~/' expands to your home directory.\n\
1439 See also the function `substitute-in-file-name'.")
1441 Lisp_Object name
, defalt
;
1445 register unsigned char *newdir
, *p
, *o
;
1447 unsigned char *target
;
1450 CHECK_STRING (name
);
1453 /* If nm is absolute, flush ...// and detect /./ and /../.
1454 If no /./ or /../ we can return right away. */
1461 if (p
[0] == '/' && p
[1] == '/')
1463 if (p
[0] == '/' && p
[1] == '~')
1464 nm
= p
+ 1, lose
= 1;
1465 if (p
[0] == '/' && p
[1] == '.'
1466 && (p
[2] == '/' || p
[2] == 0
1467 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1473 if (nm
== SDATA (name
))
1475 return build_string (nm
);
1479 /* Now determine directory to start with and put it in NEWDIR. */
1483 if (nm
[0] == '~') /* prefix ~ */
1484 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1486 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1487 newdir
= (unsigned char *) "";
1490 else /* ~user/filename */
1492 /* Get past ~ to user. */
1493 unsigned char *user
= nm
+ 1;
1494 /* Find end of name. */
1495 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1496 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1497 /* Copy the user name into temp storage. */
1498 o
= alloca (len
+ 1);
1499 memcpy (o
, user
, len
);
1502 /* Look up the user name. */
1504 pw
= (struct passwd
*) getpwnam (o
+ 1);
1507 error ("\"%s\" isn't a registered user", o
+ 1);
1509 newdir
= (unsigned char *) pw
->pw_dir
;
1511 /* Discard the user name from NM. */
1515 if (nm
[0] != '/' && !newdir
)
1518 defalt
= current_buffer
->directory
;
1519 CHECK_STRING (defalt
);
1520 newdir
= SDATA (defalt
);
1523 /* Now concatenate the directory and name to new space in the stack frame. */
1525 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1526 target
= alloca (tlen
);
1531 if (nm
[0] == 0 || nm
[0] == '/')
1532 strcpy (target
, newdir
);
1534 file_name_as_directory (target
, newdir
);
1537 strcat (target
, nm
);
1539 /* Now canonicalize by removing /. and /foo/.. if they appear. */
1550 else if (!strncmp (p
, "//", 2)
1556 else if (p
[0] == '/' && p
[1] == '.'
1557 && (p
[2] == '/' || p
[2] == 0))
1559 else if (!strncmp (p
, "/..", 3)
1560 /* `/../' is the "superroot" on certain file systems. */
1562 && (p
[3] == '/' || p
[3] == 0))
1564 while (o
!= target
&& *--o
!= '/')
1566 if (o
== target
&& *o
== '/')
1576 return make_string (target
, o
- target
);
1580 /* If /~ or // appears, discard everything through first slash. */
1582 file_name_absolute_p (const char *filename
)
1585 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1587 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1588 && IS_DIRECTORY_SEP (filename
[2]))
1594 search_embedded_absfilename (char *nm
, char *endp
)
1598 for (p
= nm
+ 1; p
< endp
; p
++)
1600 if (IS_DIRECTORY_SEP (p
[-1])
1601 && file_name_absolute_p (p
)
1602 #if defined (WINDOWSNT) || defined (CYGWIN)
1603 /* // at start of file name is meaningful in Apollo,
1604 WindowsNT and Cygwin systems. */
1605 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1606 #endif /* not (WINDOWSNT || CYGWIN) */
1609 for (s
= p
; *s
&& !IS_DIRECTORY_SEP (*s
); s
++);
1610 if (p
[0] == '~' && s
> p
+ 1) /* We've got "/~something/". */
1612 char *o
= alloca (s
- p
+ 1);
1614 memcpy (o
, p
, s
- p
);
1617 /* If we have ~user and `user' exists, discard
1618 everything up to ~. But if `user' does not exist, leave
1619 ~user alone, it might be a literal file name. */
1621 pw
= getpwnam (o
+ 1);
1633 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1634 Ssubstitute_in_file_name
, 1, 1, 0,
1635 doc
: /* Substitute environment variables referred to in FILENAME.
1636 `$FOO' where FOO is an environment variable name means to substitute
1637 the value of that variable. The variable name should be terminated
1638 with a character not a letter, digit or underscore; otherwise, enclose
1639 the entire variable name in braces.
1641 If `/~' appears, all of FILENAME through that `/' is discarded.
1642 If `//' appears, everything up to and including the first of
1643 those `/' is discarded. */)
1644 (Lisp_Object filename
)
1646 char *nm
, *s
, *p
, *o
, *x
, *endp
;
1647 char *target
= NULL
;
1648 ptrdiff_t total
= 0;
1649 bool substituted
= 0;
1652 Lisp_Object handler
;
1654 CHECK_STRING (filename
);
1656 multibyte
= STRING_MULTIBYTE (filename
);
1658 /* If the file name has special constructs in it,
1659 call the corresponding file handler. */
1660 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1661 if (!NILP (handler
))
1663 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1665 if (STRINGP (handled_name
))
1666 return handled_name
;
1667 error ("Invalid handler in `file-name-handler-alist'");
1670 /* Always work on a copy of the string, in case GC happens during
1671 decode of environment variables, causing the original Lisp_String
1672 data to be relocated. */
1673 nm
= alloca (SBYTES (filename
) + 1);
1674 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1677 dostounix_filename (nm
, multibyte
);
1678 substituted
= (memcmp (nm
, SDATA (filename
), SBYTES (filename
)) != 0);
1680 endp
= nm
+ SBYTES (filename
);
1682 /* If /~ or // appears, discard everything through first slash. */
1683 p
= search_embedded_absfilename (nm
, endp
);
1685 /* Start over with the new string, so we check the file-name-handler
1686 again. Important with filenames like "/home/foo//:/hello///there"
1687 which would substitute to "/:/hello///there" rather than "/there". */
1688 return Fsubstitute_in_file_name
1689 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1691 /* See if any variables are substituted into the string
1692 and find the total length of their values in `total'. */
1694 for (p
= nm
; p
!= endp
;)
1704 /* "$$" means a single "$". */
1713 p
= memchr (p
, '}', endp
- p
);
1721 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1725 /* Copy out the variable name. */
1726 target
= alloca (s
- o
+ 1);
1727 memcpy (target
, o
, s
- o
);
1730 strupr (target
); /* $home == $HOME etc. */
1733 /* Get variable value. */
1734 o
= egetenv (target
);
1737 /* Don't try to guess a maximum length - UTF8 can use up to
1738 four bytes per character. This code is unlikely to run
1739 in a situation that requires performance, so decoding the
1740 env variables twice should be acceptable. Note that
1741 decoding may cause a garbage collect. */
1742 Lisp_Object orig
, decoded
;
1743 orig
= build_unibyte_string (o
);
1744 decoded
= DECODE_FILE (orig
);
1745 total
+= SBYTES (decoded
);
1755 if (!NILP (Vw32_downcase_file_names
))
1756 filename
= Fdowncase (filename
);
1761 /* If substitution required, recopy the string and do it. */
1762 /* Make space in stack frame for the new copy. */
1763 xnm
= alloca (SBYTES (filename
) + total
+ 1);
1766 /* Copy the rest of the name through, replacing $ constructs with values. */
1783 p
= memchr (p
, '}', endp
- p
);
1791 while (p
!= endp
&& (c_isalnum (*p
) || *p
== '_')) p
++;
1795 /* Copy out the variable name. */
1796 target
= alloca (s
- o
+ 1);
1797 memcpy (target
, o
, s
- o
);
1800 /* Get variable value. */
1801 o
= egetenv (target
);
1805 strcpy (x
, target
); x
+= strlen (target
);
1809 Lisp_Object orig
, decoded
;
1810 ptrdiff_t orig_length
, decoded_length
;
1811 orig_length
= strlen (o
);
1812 orig
= make_unibyte_string (o
, orig_length
);
1813 decoded
= DECODE_FILE (orig
);
1814 decoded_length
= SBYTES (decoded
);
1815 memcpy (x
, SDATA (decoded
), decoded_length
);
1816 x
+= decoded_length
;
1818 /* If environment variable needed decoding, return value
1819 needs to be multibyte. */
1820 if (decoded_length
!= orig_length
1821 || memcmp (SDATA (decoded
), o
, orig_length
))
1828 /* If /~ or // appears, discard everything through first slash. */
1829 while ((p
= search_embedded_absfilename (xnm
, x
)) != NULL
)
1830 /* This time we do not start over because we've already expanded envvars
1831 and replaced $$ with $. Maybe we should start over as well, but we'd
1832 need to quote some $ to $$ first. */
1836 if (!NILP (Vw32_downcase_file_names
))
1838 Lisp_Object xname
= make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1840 xname
= Fdowncase (xname
);
1845 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1848 error ("Bad format environment-variable substitution");
1850 error ("Missing \"}\" in environment-variable substitution");
1852 error ("Substituting nonexistent environment variable \"%s\"", target
);
1855 /* A slightly faster and more convenient way to get
1856 (directory-file-name (expand-file-name FOO)). */
1859 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1861 register Lisp_Object absname
;
1863 absname
= Fexpand_file_name (filename
, defdir
);
1865 /* Remove final slash, if any (unless this is the root dir).
1866 stat behaves differently depending! */
1867 if (SCHARS (absname
) > 1
1868 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1869 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
) - 2)))
1870 /* We cannot take shortcuts; they might be wrong for magic file names. */
1871 absname
= Fdirectory_file_name (absname
);
1875 /* Signal an error if the file ABSNAME already exists.
1876 If INTERACTIVE, ask the user whether to proceed,
1877 and bypass the error if the user says to go ahead.
1878 QUERYSTRING is a name for the action that is being considered
1881 *STATPTR is used to store the stat information if the file exists.
1882 If the file does not exist, STATPTR->st_mode is set to 0.
1883 If STATPTR is null, we don't store into it.
1885 If QUICK, ask for y or n, not yes or no. */
1888 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1889 bool interactive
, struct stat
*statptr
,
1892 Lisp_Object tem
, encoded_filename
;
1893 struct stat statbuf
;
1894 struct gcpro gcpro1
;
1896 encoded_filename
= ENCODE_FILE (absname
);
1898 /* `stat' is a good way to tell whether the file exists,
1899 regardless of what access permissions it has. */
1900 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1902 if (S_ISDIR (statbuf
.st_mode
))
1903 xsignal2 (Qfile_error
,
1904 build_string ("File is a directory"), absname
);
1907 xsignal2 (Qfile_already_exists
,
1908 build_string ("File already exists"), absname
);
1910 tem
= format2 ("File %s already exists; %s anyway? ",
1911 absname
, build_string (querystring
));
1913 tem
= call1 (intern ("y-or-n-p"), tem
);
1915 tem
= do_yes_or_no_p (tem
);
1918 xsignal2 (Qfile_already_exists
,
1919 build_string ("File already exists"), absname
);
1926 statptr
->st_mode
= 0;
1931 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1932 "fCopy file: \nGCopy %s to file: \np\nP",
1933 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1934 If NEWNAME names a directory, copy FILE there.
1936 This function always sets the file modes of the output file to match
1939 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1940 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1941 signal a `file-already-exists' error without overwriting. If
1942 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1943 about overwriting; this is what happens in interactive use with M-x.
1944 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1947 Fourth arg KEEP-TIME non-nil means give the output file the same
1948 last-modified time as the old one. (This works on only some systems.)
1950 A prefix arg makes KEEP-TIME non-nil.
1952 If PRESERVE-UID-GID is non-nil, we try to transfer the
1953 uid and gid of FILE to NEWNAME.
1955 If PRESERVE-EXTENDED-ATTRIBUTES is non-nil, we try to copy additional
1956 attributes of FILE to NEWNAME, such as its SELinux context and ACL
1957 entries (depending on how Emacs was built). */)
1958 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
, Lisp_Object keep_time
, Lisp_Object preserve_uid_gid
, Lisp_Object preserve_extended_attributes
)
1962 char buf
[16 * 1024];
1963 struct stat st
, out_st
;
1964 Lisp_Object handler
;
1965 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1966 ptrdiff_t count
= SPECPDL_INDEX ();
1967 Lisp_Object encoded_file
, encoded_newname
;
1969 security_context_t con
;
1976 encoded_file
= encoded_newname
= Qnil
;
1977 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1978 CHECK_STRING (file
);
1979 CHECK_STRING (newname
);
1981 if (!NILP (Ffile_directory_p (newname
)))
1982 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1984 newname
= Fexpand_file_name (newname
, Qnil
);
1986 file
= Fexpand_file_name (file
, Qnil
);
1988 /* If the input file name has special constructs in it,
1989 call the corresponding file handler. */
1990 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1991 /* Likewise for output file name. */
1993 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1994 if (!NILP (handler
))
1995 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1996 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1997 preserve_extended_attributes
));
1999 encoded_file
= ENCODE_FILE (file
);
2000 encoded_newname
= ENCODE_FILE (newname
);
2002 if (NILP (ok_if_already_exists
)
2003 || INTEGERP (ok_if_already_exists
))
2004 barf_or_query_if_file_exists (newname
, "copy to it",
2005 INTEGERP (ok_if_already_exists
), &out_st
, 0);
2006 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
2010 if (!NILP (preserve_extended_attributes
))
2012 acl
= acl_get_file (SDATA (encoded_file
), ACL_TYPE_ACCESS
);
2013 if (acl
== NULL
&& acl_errno_valid (errno
))
2014 report_file_error ("Getting ACL", Fcons (file
, Qnil
));
2016 if (!CopyFile (SDATA (encoded_file
),
2017 SDATA (encoded_newname
),
2020 /* CopyFile doesn't set errno when it fails. By far the most
2021 "popular" reason is that the target is read-only. */
2022 if (GetLastError () == 5)
2026 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
2028 /* CopyFile retains the timestamp by default. */
2029 else if (NILP (keep_time
))
2035 filename
= SDATA (encoded_newname
);
2037 /* Ensure file is writable while its modified time is set. */
2038 attributes
= GetFileAttributes (filename
);
2039 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2040 now
= current_emacs_time ();
2041 if (set_file_times (-1, filename
, now
, now
))
2043 /* Restore original attributes. */
2044 SetFileAttributes (filename
, attributes
);
2045 xsignal2 (Qfile_date_error
,
2046 build_string ("Cannot set file date"), newname
);
2048 /* Restore original attributes. */
2049 SetFileAttributes (filename
, attributes
);
2054 acl_set_file (SDATA (encoded_newname
), ACL_TYPE_ACCESS
, acl
) != 0;
2055 if (fail
&& acl_errno_valid (errno
))
2056 report_file_error ("Setting ACL", Fcons (newname
, Qnil
));
2060 #else /* not WINDOWSNT */
2062 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
2066 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2068 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2070 if (fstat (ifd
, &st
) != 0)
2071 report_file_error ("Input file status", Fcons (file
, Qnil
));
2073 if (!NILP (preserve_extended_attributes
))
2076 if (is_selinux_enabled ())
2078 conlength
= fgetfilecon (ifd
, &con
);
2079 if (conlength
== -1)
2080 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
2085 if (out_st
.st_mode
!= 0
2086 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2089 report_file_error ("Input and output files are the same",
2090 Fcons (file
, Fcons (newname
, Qnil
)));
2093 /* We can copy only regular files. */
2094 if (!S_ISREG (st
.st_mode
))
2096 /* Get a better looking error message. */
2097 errno
= S_ISDIR (st
.st_mode
) ? EISDIR
: EINVAL
;
2098 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2102 /* System's default file type was set to binary by _fmode in emacs.c. */
2103 ofd
= emacs_open (SDATA (encoded_newname
),
2104 O_WRONLY
| O_TRUNC
| O_CREAT
2105 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2106 S_IREAD
| S_IWRITE
);
2107 #else /* not MSDOS */
2109 mode_t new_mask
= !NILP (preserve_uid_gid
) ? 0600 : 0666;
2110 new_mask
&= st
.st_mode
;
2111 ofd
= emacs_open (SSDATA (encoded_newname
),
2112 (O_WRONLY
| O_TRUNC
| O_CREAT
2113 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2116 #endif /* not MSDOS */
2118 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2120 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2124 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2125 if (emacs_write_sig (ofd
, buf
, n
) != n
)
2126 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2130 /* Preserve the original file permissions, and if requested, also its
2133 mode_t mode_mask
= 07777;
2134 if (!NILP (preserve_uid_gid
))
2136 /* Attempt to change owner and group. If that doesn't work
2137 attempt to change just the group, as that is sometimes allowed.
2138 Adjust the mode mask to eliminate setuid or setgid bits
2139 that are inappropriate if the owner and group are wrong. */
2140 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2142 mode_mask
&= ~06000;
2143 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2148 switch (!NILP (preserve_extended_attributes
)
2149 ? qcopy_acl (SSDATA (encoded_file
), ifd
,
2150 SSDATA (encoded_newname
), ofd
,
2151 st
.st_mode
& mode_mask
)
2152 : fchmod (ofd
, st
.st_mode
& mode_mask
))
2154 case -2: report_file_error ("Copying permissions from", list1 (file
));
2155 case -1: report_file_error ("Copying permissions to", list1 (newname
));
2158 #endif /* not MSDOS */
2163 /* Set the modified context back to the file. */
2164 bool fail
= fsetfilecon (ofd
, con
) != 0;
2165 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2166 if (fail
&& errno
!= ENOTSUP
)
2167 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2173 if (!NILP (keep_time
))
2175 EMACS_TIME atime
= get_stat_atime (&st
);
2176 EMACS_TIME mtime
= get_stat_mtime (&st
);
2177 if (set_file_times (ofd
, SSDATA (encoded_newname
), atime
, mtime
))
2178 xsignal2 (Qfile_date_error
,
2179 build_string ("Cannot set file date"), newname
);
2182 if (emacs_close (ofd
) < 0)
2183 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2188 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2189 and if it can't, it tells so. Otherwise, under MSDOS we usually
2190 get only the READ bit, which will make the copied file read-only,
2191 so it's better not to chmod at all. */
2192 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2193 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2195 #endif /* not WINDOWSNT */
2197 /* Discard the unwind protects. */
2198 specpdl_ptr
= specpdl
+ count
;
2204 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2205 Smake_directory_internal
, 1, 1, 0,
2206 doc
: /* Create a new directory named DIRECTORY. */)
2207 (Lisp_Object directory
)
2210 Lisp_Object handler
;
2211 Lisp_Object encoded_dir
;
2213 CHECK_STRING (directory
);
2214 directory
= Fexpand_file_name (directory
, Qnil
);
2216 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2217 if (!NILP (handler
))
2218 return call2 (handler
, Qmake_directory_internal
, directory
);
2220 encoded_dir
= ENCODE_FILE (directory
);
2222 dir
= SSDATA (encoded_dir
);
2225 if (mkdir (dir
) != 0)
2227 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2229 report_file_error ("Creating directory", list1 (directory
));
2234 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2235 Sdelete_directory_internal
, 1, 1, 0,
2236 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2237 (Lisp_Object directory
)
2240 Lisp_Object encoded_dir
;
2242 CHECK_STRING (directory
);
2243 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2244 encoded_dir
= ENCODE_FILE (directory
);
2245 dir
= SSDATA (encoded_dir
);
2247 if (rmdir (dir
) != 0)
2248 report_file_error ("Removing directory", list1 (directory
));
2253 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2254 "(list (read-file-name \
2255 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2256 \"Move file to trash: \" \"Delete file: \") \
2257 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2258 (null current-prefix-arg))",
2259 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2260 If file has multiple names, it continues to exist with the other names.
2261 TRASH non-nil means to trash the file instead of deleting, provided
2262 `delete-by-moving-to-trash' is non-nil.
2264 When called interactively, TRASH is t if no prefix argument is given.
2265 With a prefix argument, TRASH is nil. */)
2266 (Lisp_Object filename
, Lisp_Object trash
)
2268 Lisp_Object handler
;
2269 Lisp_Object encoded_file
;
2270 struct gcpro gcpro1
;
2273 if (!NILP (Ffile_directory_p (filename
))
2274 && NILP (Ffile_symlink_p (filename
)))
2275 xsignal2 (Qfile_error
,
2276 build_string ("Removing old name: is a directory"),
2279 filename
= Fexpand_file_name (filename
, Qnil
);
2281 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2282 if (!NILP (handler
))
2283 return call3 (handler
, Qdelete_file
, filename
, trash
);
2285 if (delete_by_moving_to_trash
&& !NILP (trash
))
2286 return call1 (Qmove_file_to_trash
, filename
);
2288 encoded_file
= ENCODE_FILE (filename
);
2290 if (unlink (SSDATA (encoded_file
)) < 0)
2291 report_file_error ("Removing old name", list1 (filename
));
2296 internal_delete_file_1 (Lisp_Object ignore
)
2301 /* Delete file FILENAME, returning true if successful.
2302 This ignores `delete-by-moving-to-trash'. */
2305 internal_delete_file (Lisp_Object filename
)
2309 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2310 Qt
, internal_delete_file_1
);
2314 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2315 "fRename file: \nGRename %s to file: \np",
2316 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2317 If file has names other than FILE, it continues to have those names.
2318 Signals a `file-already-exists' error if a file NEWNAME already exists
2319 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2320 A number as third arg means request confirmation if NEWNAME already exists.
2321 This is what happens in interactive use with M-x. */)
2322 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2324 Lisp_Object handler
;
2325 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2326 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2328 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2329 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2330 CHECK_STRING (file
);
2331 CHECK_STRING (newname
);
2332 file
= Fexpand_file_name (file
, Qnil
);
2334 if ((!NILP (Ffile_directory_p (newname
)))
2336 /* If the file names are identical but for the case,
2337 don't attempt to move directory to itself. */
2338 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2342 Lisp_Object fname
= (NILP (Ffile_directory_p (file
))
2343 ? file
: Fdirectory_file_name (file
));
2344 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2347 newname
= Fexpand_file_name (newname
, Qnil
);
2349 /* If the file name has special constructs in it,
2350 call the corresponding file handler. */
2351 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2353 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2354 if (!NILP (handler
))
2355 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2356 file
, newname
, ok_if_already_exists
));
2358 encoded_file
= ENCODE_FILE (file
);
2359 encoded_newname
= ENCODE_FILE (newname
);
2362 /* If the file names are identical but for the case, don't ask for
2363 confirmation: they simply want to change the letter-case of the
2365 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2367 if (NILP (ok_if_already_exists
)
2368 || INTEGERP (ok_if_already_exists
))
2369 barf_or_query_if_file_exists (newname
, "rename to it",
2370 INTEGERP (ok_if_already_exists
), 0, 0);
2371 if (rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2376 symlink_target
= Ffile_symlink_p (file
);
2377 if (! NILP (symlink_target
))
2378 Fmake_symbolic_link (symlink_target
, newname
,
2379 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2380 else if (!NILP (Ffile_directory_p (file
)))
2381 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2383 /* We have already prompted if it was an integer, so don't
2384 have copy-file prompt again. */
2385 Fcopy_file (file
, newname
,
2386 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2389 count
= SPECPDL_INDEX ();
2390 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2392 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2393 call2 (Qdelete_directory
, file
, Qt
);
2395 Fdelete_file (file
, Qnil
);
2396 unbind_to (count
, Qnil
);
2399 report_file_error ("Renaming", list2 (file
, newname
));
2405 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2406 "fAdd name to file: \nGName to add to %s: \np",
2407 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2408 Signals a `file-already-exists' error if a file NEWNAME already exists
2409 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2410 A number as third arg means request confirmation if NEWNAME already exists.
2411 This is what happens in interactive use with M-x. */)
2412 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2414 Lisp_Object handler
;
2415 Lisp_Object encoded_file
, encoded_newname
;
2416 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2418 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2419 encoded_file
= encoded_newname
= Qnil
;
2420 CHECK_STRING (file
);
2421 CHECK_STRING (newname
);
2422 file
= Fexpand_file_name (file
, Qnil
);
2424 if (!NILP (Ffile_directory_p (newname
)))
2425 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2427 newname
= Fexpand_file_name (newname
, Qnil
);
2429 /* If the file name has special constructs in it,
2430 call the corresponding file handler. */
2431 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2432 if (!NILP (handler
))
2433 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2434 newname
, ok_if_already_exists
));
2436 /* If the new name has special constructs in it,
2437 call the corresponding file handler. */
2438 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2439 if (!NILP (handler
))
2440 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2441 newname
, ok_if_already_exists
));
2443 encoded_file
= ENCODE_FILE (file
);
2444 encoded_newname
= ENCODE_FILE (newname
);
2446 if (NILP (ok_if_already_exists
)
2447 || INTEGERP (ok_if_already_exists
))
2448 barf_or_query_if_file_exists (newname
, "make it a new name",
2449 INTEGERP (ok_if_already_exists
), 0, 0);
2451 unlink (SSDATA (newname
));
2452 if (link (SSDATA (encoded_file
), SSDATA (encoded_newname
)) < 0)
2453 report_file_error ("Adding new name", list2 (file
, newname
));
2459 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2460 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2461 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2462 Both args must be strings.
2463 Signals a `file-already-exists' error if a file LINKNAME already exists
2464 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2465 A number as third arg means request confirmation if LINKNAME already exists.
2466 This happens for interactive use with M-x. */)
2467 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2469 Lisp_Object handler
;
2470 Lisp_Object encoded_filename
, encoded_linkname
;
2471 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2473 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2474 encoded_filename
= encoded_linkname
= Qnil
;
2475 CHECK_STRING (filename
);
2476 CHECK_STRING (linkname
);
2477 /* If the link target has a ~, we must expand it to get
2478 a truly valid file name. Otherwise, do not expand;
2479 we want to permit links to relative file names. */
2480 if (SREF (filename
, 0) == '~')
2481 filename
= Fexpand_file_name (filename
, Qnil
);
2483 if (!NILP (Ffile_directory_p (linkname
)))
2484 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2486 linkname
= Fexpand_file_name (linkname
, Qnil
);
2488 /* If the file name has special constructs in it,
2489 call the corresponding file handler. */
2490 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2491 if (!NILP (handler
))
2492 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2493 linkname
, ok_if_already_exists
));
2495 /* If the new link name has special constructs in it,
2496 call the corresponding file handler. */
2497 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2498 if (!NILP (handler
))
2499 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2500 linkname
, ok_if_already_exists
));
2502 encoded_filename
= ENCODE_FILE (filename
);
2503 encoded_linkname
= ENCODE_FILE (linkname
);
2505 if (NILP (ok_if_already_exists
)
2506 || INTEGERP (ok_if_already_exists
))
2507 barf_or_query_if_file_exists (linkname
, "make it a link",
2508 INTEGERP (ok_if_already_exists
), 0, 0);
2509 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
)) < 0)
2511 /* If we didn't complain already, silently delete existing file. */
2512 if (errno
== EEXIST
)
2514 unlink (SSDATA (encoded_linkname
));
2515 if (symlink (SSDATA (encoded_filename
), SSDATA (encoded_linkname
))
2522 if (errno
== ENOSYS
)
2525 xsignal1 (Qfile_error
,
2526 build_string ("Symbolic links are not supported"));
2529 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2536 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2538 doc
: /* Return t if file FILENAME specifies an absolute file name.
2539 On Unix, this is a name starting with a `/' or a `~'. */)
2540 (Lisp_Object filename
)
2542 CHECK_STRING (filename
);
2543 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2546 /* Return true if FILENAME exists. */
2548 check_existing (const char *filename
)
2550 return faccessat (AT_FDCWD
, filename
, F_OK
, AT_EACCESS
) == 0;
2553 /* Return true if file FILENAME exists and can be executed. */
2556 check_executable (char *filename
)
2558 return faccessat (AT_FDCWD
, filename
, X_OK
, AT_EACCESS
) == 0;
2561 /* Return true if file FILENAME exists and can be accessed
2562 according to AMODE, which should include W_OK.
2563 On failure, return false and set errno. */
2566 check_writable (const char *filename
, int amode
)
2569 /* FIXME: an faccessat implementation should be added to the
2570 DOS/Windows ports and this #ifdef branch should be removed. */
2572 if (stat (filename
, &st
) < 0)
2575 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2576 #else /* not MSDOS */
2577 bool res
= faccessat (AT_FDCWD
, filename
, amode
, AT_EACCESS
) == 0;
2579 /* faccessat may have returned failure because Cygwin couldn't
2580 determine the file's UID or GID; if so, we return success. */
2583 int faccessat_errno
= errno
;
2585 if (stat (filename
, &st
) < 0)
2587 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2588 errno
= faccessat_errno
;
2592 #endif /* not MSDOS */
2595 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2596 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2597 See also `file-readable-p' and `file-attributes'.
2598 This returns nil for a symlink to a nonexistent file.
2599 Use `file-symlink-p' to test for such links. */)
2600 (Lisp_Object filename
)
2602 Lisp_Object absname
;
2603 Lisp_Object handler
;
2605 CHECK_STRING (filename
);
2606 absname
= Fexpand_file_name (filename
, Qnil
);
2608 /* If the file name has special constructs in it,
2609 call the corresponding file handler. */
2610 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2611 if (!NILP (handler
))
2612 return call2 (handler
, Qfile_exists_p
, absname
);
2614 absname
= ENCODE_FILE (absname
);
2616 return (check_existing (SSDATA (absname
))) ? Qt
: Qnil
;
2619 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2620 doc
: /* Return t if FILENAME can be executed by you.
2621 For a directory, this means you can access files in that directory. */)
2622 (Lisp_Object filename
)
2624 Lisp_Object absname
;
2625 Lisp_Object handler
;
2627 CHECK_STRING (filename
);
2628 absname
= Fexpand_file_name (filename
, Qnil
);
2630 /* If the file name has special constructs in it,
2631 call the corresponding file handler. */
2632 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2633 if (!NILP (handler
))
2634 return call2 (handler
, Qfile_executable_p
, absname
);
2636 absname
= ENCODE_FILE (absname
);
2638 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2641 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2642 doc
: /* Return t if file FILENAME exists and you can read it.
2643 See also `file-exists-p' and `file-attributes'. */)
2644 (Lisp_Object filename
)
2646 Lisp_Object absname
;
2647 Lisp_Object handler
;
2649 CHECK_STRING (filename
);
2650 absname
= Fexpand_file_name (filename
, Qnil
);
2652 /* If the file name has special constructs in it,
2653 call the corresponding file handler. */
2654 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2655 if (!NILP (handler
))
2656 return call2 (handler
, Qfile_readable_p
, absname
);
2658 absname
= ENCODE_FILE (absname
);
2659 return (faccessat (AT_FDCWD
, SSDATA (absname
), R_OK
, AT_EACCESS
) == 0
2663 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2664 doc
: /* Return t if file FILENAME can be written or created by you. */)
2665 (Lisp_Object filename
)
2667 Lisp_Object absname
, dir
, encoded
;
2668 Lisp_Object handler
;
2670 CHECK_STRING (filename
);
2671 absname
= Fexpand_file_name (filename
, Qnil
);
2673 /* If the file name has special constructs in it,
2674 call the corresponding file handler. */
2675 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2676 if (!NILP (handler
))
2677 return call2 (handler
, Qfile_writable_p
, absname
);
2679 encoded
= ENCODE_FILE (absname
);
2680 if (check_writable (SSDATA (encoded
), W_OK
))
2682 if (errno
!= ENOENT
)
2685 dir
= Ffile_name_directory (absname
);
2686 eassert (!NILP (dir
));
2688 dir
= Fdirectory_file_name (dir
);
2691 dir
= ENCODE_FILE (dir
);
2693 /* The read-only attribute of the parent directory doesn't affect
2694 whether a file or directory can be created within it. Some day we
2695 should check ACLs though, which do affect this. */
2696 return file_directory_p (SDATA (dir
)) ? Qt
: Qnil
;
2698 return check_writable (SSDATA (dir
), W_OK
| X_OK
) ? Qt
: Qnil
;
2702 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2703 doc
: /* Access file FILENAME, and get an error if that does not work.
2704 The second argument STRING is used in the error message.
2705 If there is no error, returns nil. */)
2706 (Lisp_Object filename
, Lisp_Object string
)
2708 Lisp_Object handler
, encoded_filename
, absname
;
2711 CHECK_STRING (filename
);
2712 absname
= Fexpand_file_name (filename
, Qnil
);
2714 CHECK_STRING (string
);
2716 /* If the file name has special constructs in it,
2717 call the corresponding file handler. */
2718 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2719 if (!NILP (handler
))
2720 return call3 (handler
, Qaccess_file
, absname
, string
);
2722 encoded_filename
= ENCODE_FILE (absname
);
2724 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2726 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2732 /* Relative to directory FD, return the symbolic link value of FILENAME.
2733 On failure, return nil. */
2735 emacs_readlinkat (int fd
, char const *filename
)
2737 static struct allocator
const emacs_norealloc_allocator
=
2738 { xmalloc
, NULL
, xfree
, memory_full
};
2740 char readlink_buf
[1024];
2741 char *buf
= careadlinkat (fd
, filename
, readlink_buf
, sizeof readlink_buf
,
2742 &emacs_norealloc_allocator
, readlinkat
);
2746 val
= build_string (buf
);
2747 if (buf
[0] == '/' && strchr (buf
, ':'))
2748 val
= concat2 (build_string ("/:"), val
);
2749 if (buf
!= readlink_buf
)
2751 val
= DECODE_FILE (val
);
2755 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2756 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2757 The value is the link target, as a string.
2758 Otherwise it returns nil.
2760 This function returns t when given the name of a symlink that
2761 points to a nonexistent file. */)
2762 (Lisp_Object filename
)
2764 Lisp_Object handler
;
2766 CHECK_STRING (filename
);
2767 filename
= Fexpand_file_name (filename
, Qnil
);
2769 /* If the file name has special constructs in it,
2770 call the corresponding file handler. */
2771 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2772 if (!NILP (handler
))
2773 return call2 (handler
, Qfile_symlink_p
, filename
);
2775 filename
= ENCODE_FILE (filename
);
2777 return emacs_readlinkat (AT_FDCWD
, SSDATA (filename
));
2780 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2781 doc
: /* Return t if FILENAME names an existing directory.
2782 Symbolic links to directories count as directories.
2783 See `file-symlink-p' to distinguish symlinks. */)
2784 (Lisp_Object filename
)
2786 Lisp_Object absname
;
2787 Lisp_Object handler
;
2789 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2791 /* If the file name has special constructs in it,
2792 call the corresponding file handler. */
2793 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2794 if (!NILP (handler
))
2795 return call2 (handler
, Qfile_directory_p
, absname
);
2797 absname
= ENCODE_FILE (absname
);
2799 return file_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2802 /* Return true if FILE is a directory or a symlink to a directory. */
2804 file_directory_p (char const *file
)
2807 /* This is cheaper than 'stat'. */
2808 return faccessat (AT_FDCWD
, file
, D_OK
, AT_EACCESS
) == 0;
2811 return stat (file
, &st
) == 0 && S_ISDIR (st
.st_mode
);
2815 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2816 Sfile_accessible_directory_p
, 1, 1, 0,
2817 doc
: /* Return t if file FILENAME names a directory you can open.
2818 For the value to be t, FILENAME must specify the name of a directory as a file,
2819 and the directory must allow you to open files in it. In order to use a
2820 directory as a buffer's current directory, this predicate must return true.
2821 A directory name spec may be given instead; then the value is t
2822 if the directory so specified exists and really is a readable and
2823 searchable directory. */)
2824 (Lisp_Object filename
)
2826 Lisp_Object absname
;
2827 Lisp_Object handler
;
2829 CHECK_STRING (filename
);
2830 absname
= Fexpand_file_name (filename
, Qnil
);
2832 /* If the file name has special constructs in it,
2833 call the corresponding file handler. */
2834 handler
= Ffind_file_name_handler (absname
, Qfile_accessible_directory_p
);
2835 if (!NILP (handler
))
2836 return call2 (handler
, Qfile_accessible_directory_p
, absname
);
2838 absname
= ENCODE_FILE (absname
);
2839 return file_accessible_directory_p (SSDATA (absname
)) ? Qt
: Qnil
;
2842 /* If FILE is a searchable directory or a symlink to a
2843 searchable directory, return true. Otherwise return
2844 false and set errno to an error number. */
2846 file_accessible_directory_p (char const *file
)
2849 /* There's no need to test whether FILE is searchable, as the
2850 searchable/executable bit is invented on DOS_NT platforms. */
2851 return file_directory_p (file
);
2853 /* On POSIXish platforms, use just one system call; this avoids a
2854 race and is typically faster. */
2855 ptrdiff_t len
= strlen (file
);
2861 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2862 There are three exceptions: "", "/", and "//". Leave "" alone,
2863 as it's invalid. Append only "." to the other two exceptions as
2864 "/" and "//" are distinct on some platforms, whereas "/", "///",
2865 "////", etc. are all equivalent. */
2870 /* Just check for trailing '/' when deciding whether to append '/'.
2871 That's simpler than testing the two special cases "/" and "//",
2872 and it's a safe optimization here. */
2873 char *buf
= SAFE_ALLOCA (len
+ 3);
2874 memcpy (buf
, file
, len
);
2875 strcpy (buf
+ len
, &"/."[file
[len
- 1] == '/']);
2879 ok
= check_existing (dir
);
2880 saved_errno
= errno
;
2882 errno
= saved_errno
;
2887 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2888 doc
: /* Return t if FILENAME names a regular file.
2889 This is the sort of file that holds an ordinary stream of data bytes.
2890 Symbolic links to regular files count as regular files.
2891 See `file-symlink-p' to distinguish symlinks. */)
2892 (Lisp_Object filename
)
2894 register Lisp_Object absname
;
2896 Lisp_Object handler
;
2898 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2900 /* If the file name has special constructs in it,
2901 call the corresponding file handler. */
2902 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2903 if (!NILP (handler
))
2904 return call2 (handler
, Qfile_regular_p
, absname
);
2906 absname
= ENCODE_FILE (absname
);
2911 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2913 /* Tell stat to use expensive method to get accurate info. */
2914 Vw32_get_true_file_attributes
= Qt
;
2915 result
= stat (SDATA (absname
), &st
);
2916 Vw32_get_true_file_attributes
= tem
;
2920 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2923 if (stat (SSDATA (absname
), &st
) < 0)
2925 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2929 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2930 Sfile_selinux_context
, 1, 1, 0,
2931 doc
: /* Return SELinux context of file named FILENAME.
2932 The return value is a list (USER ROLE TYPE RANGE), where the list
2933 elements are strings naming the user, role, type, and range of the
2934 file's SELinux security context.
2936 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2937 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2938 (Lisp_Object filename
)
2940 Lisp_Object absname
;
2941 Lisp_Object values
[4];
2942 Lisp_Object handler
;
2944 security_context_t con
;
2949 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2951 /* If the file name has special constructs in it,
2952 call the corresponding file handler. */
2953 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2954 if (!NILP (handler
))
2955 return call2 (handler
, Qfile_selinux_context
, absname
);
2957 absname
= ENCODE_FILE (absname
);
2964 if (is_selinux_enabled ())
2966 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2969 context
= context_new (con
);
2970 if (context_user_get (context
))
2971 values
[0] = build_string (context_user_get (context
));
2972 if (context_role_get (context
))
2973 values
[1] = build_string (context_role_get (context
));
2974 if (context_type_get (context
))
2975 values
[2] = build_string (context_type_get (context
));
2976 if (context_range_get (context
))
2977 values
[3] = build_string (context_range_get (context
));
2978 context_free (context
);
2984 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2987 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2988 Sset_file_selinux_context
, 2, 2, 0,
2989 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2990 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2991 elements are strings naming the components of a SELinux context.
2993 Value is t if setting of SELinux context was successful, nil otherwise.
2995 This function does nothing and returns nil if SELinux is disabled,
2996 or if Emacs was not compiled with SELinux support. */)
2997 (Lisp_Object filename
, Lisp_Object context
)
2999 Lisp_Object absname
;
3000 Lisp_Object handler
;
3002 Lisp_Object encoded_absname
;
3003 Lisp_Object user
= CAR_SAFE (context
);
3004 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
3005 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
3006 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
3007 security_context_t con
;
3010 context_t parsed_con
;
3013 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3015 /* If the file name has special constructs in it,
3016 call the corresponding file handler. */
3017 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
3018 if (!NILP (handler
))
3019 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
3022 if (is_selinux_enabled ())
3024 /* Get current file context. */
3025 encoded_absname
= ENCODE_FILE (absname
);
3026 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
3029 parsed_con
= context_new (con
);
3030 /* Change the parts defined in the parameter.*/
3033 if (context_user_set (parsed_con
, SSDATA (user
)))
3034 error ("Doing context_user_set");
3038 if (context_role_set (parsed_con
, SSDATA (role
)))
3039 error ("Doing context_role_set");
3043 if (context_type_set (parsed_con
, SSDATA (type
)))
3044 error ("Doing context_type_set");
3046 if (STRINGP (range
))
3048 if (context_range_set (parsed_con
, SSDATA (range
)))
3049 error ("Doing context_range_set");
3052 /* Set the modified context back to the file. */
3053 fail
= (lsetfilecon (SSDATA (encoded_absname
),
3054 context_str (parsed_con
))
3056 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
3057 if (fail
&& errno
!= ENOTSUP
)
3058 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
3060 context_free (parsed_con
);
3062 return fail
? Qnil
: Qt
;
3065 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
3072 DEFUN ("file-acl", Ffile_acl
, Sfile_acl
, 1, 1, 0,
3073 doc
: /* Return ACL entries of file named FILENAME.
3074 The entries are returned in a format suitable for use in `set-file-acl'
3075 but is otherwise undocumented and subject to change.
3076 Return nil if file does not exist or is not accessible, or if Emacs
3077 was unable to determine the ACL entries. */)
3078 (Lisp_Object filename
)
3080 Lisp_Object absname
;
3081 Lisp_Object handler
;
3082 #ifdef HAVE_ACL_SET_FILE
3084 Lisp_Object acl_string
;
3088 absname
= expand_and_dir_to_file (filename
,
3089 BVAR (current_buffer
, directory
));
3091 /* If the file name has special constructs in it,
3092 call the corresponding file handler. */
3093 handler
= Ffind_file_name_handler (absname
, Qfile_acl
);
3094 if (!NILP (handler
))
3095 return call2 (handler
, Qfile_acl
, absname
);
3097 #ifdef HAVE_ACL_SET_FILE
3098 absname
= ENCODE_FILE (absname
);
3100 acl
= acl_get_file (SSDATA (absname
), ACL_TYPE_ACCESS
);
3104 str
= acl_to_text (acl
, NULL
);
3111 acl_string
= build_string (str
);
3121 DEFUN ("set-file-acl", Fset_file_acl
, Sset_file_acl
,
3123 doc
: /* Set ACL of file named FILENAME to ACL-STRING.
3124 ACL-STRING should contain the textual representation of the ACL
3125 entries in a format suitable for the platform.
3127 Value is t if setting of ACL was successful, nil otherwise.
3129 Setting ACL for local files requires Emacs to be built with ACL
3131 (Lisp_Object filename
, Lisp_Object acl_string
)
3133 Lisp_Object absname
;
3134 Lisp_Object handler
;
3135 #ifdef HAVE_ACL_SET_FILE
3136 Lisp_Object encoded_absname
;
3141 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3143 /* If the file name has special constructs in it,
3144 call the corresponding file handler. */
3145 handler
= Ffind_file_name_handler (absname
, Qset_file_acl
);
3146 if (!NILP (handler
))
3147 return call3 (handler
, Qset_file_acl
, absname
, acl_string
);
3149 #ifdef HAVE_ACL_SET_FILE
3150 if (STRINGP (acl_string
))
3152 acl
= acl_from_text (SSDATA (acl_string
));
3155 report_file_error ("Converting ACL", Fcons (absname
, Qnil
));
3159 encoded_absname
= ENCODE_FILE (absname
);
3161 fail
= (acl_set_file (SSDATA (encoded_absname
), ACL_TYPE_ACCESS
,
3164 if (fail
&& acl_errno_valid (errno
))
3165 report_file_error ("Setting ACL", Fcons (absname
, Qnil
));
3168 return fail
? Qnil
: Qt
;
3175 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3176 doc
: /* Return mode bits of file named FILENAME, as an integer.
3177 Return nil, if file does not exist or is not accessible. */)
3178 (Lisp_Object filename
)
3180 Lisp_Object absname
;
3182 Lisp_Object handler
;
3184 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
3186 /* If the file name has special constructs in it,
3187 call the corresponding file handler. */
3188 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3189 if (!NILP (handler
))
3190 return call2 (handler
, Qfile_modes
, absname
);
3192 absname
= ENCODE_FILE (absname
);
3194 if (stat (SSDATA (absname
), &st
) < 0)
3197 return make_number (st
.st_mode
& 07777);
3200 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
3201 "(let ((file (read-file-name \"File: \"))) \
3202 (list file (read-file-modes nil file)))",
3203 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3204 Only the 12 low bits of MODE are used.
3206 Interactively, mode bits are read by `read-file-modes', which accepts
3207 symbolic notation, like the `chmod' command from GNU Coreutils. */)
3208 (Lisp_Object filename
, Lisp_Object mode
)
3210 Lisp_Object absname
, encoded_absname
;
3211 Lisp_Object handler
;
3213 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3214 CHECK_NUMBER (mode
);
3216 /* If the file name has special constructs in it,
3217 call the corresponding file handler. */
3218 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3219 if (!NILP (handler
))
3220 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3222 encoded_absname
= ENCODE_FILE (absname
);
3224 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
3225 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3230 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3231 doc
: /* Set the file permission bits for newly created files.
3232 The argument MODE should be an integer; only the low 9 bits are used.
3233 This setting is inherited by subprocesses. */)
3236 CHECK_NUMBER (mode
);
3238 umask ((~ XINT (mode
)) & 0777);
3243 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3244 doc
: /* Return the default file protection for created files.
3245 The value is an integer. */)
3252 realmask
= umask (0);
3256 XSETINT (value
, (~ realmask
) & 0777);
3261 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3262 doc
: /* Set times of file FILENAME to TIMESTAMP.
3263 Set both access and modification times.
3264 Return t on success, else nil.
3265 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3267 (Lisp_Object filename
, Lisp_Object timestamp
)
3269 Lisp_Object absname
, encoded_absname
;
3270 Lisp_Object handler
;
3271 EMACS_TIME t
= lisp_time_argument (timestamp
);
3273 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3275 /* If the file name has special constructs in it,
3276 call the corresponding file handler. */
3277 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3278 if (!NILP (handler
))
3279 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3281 encoded_absname
= ENCODE_FILE (absname
);
3284 if (set_file_times (-1, SSDATA (encoded_absname
), t
, t
))
3287 /* Setting times on a directory always fails. */
3288 if (file_directory_p (SSDATA (encoded_absname
)))
3291 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3299 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3300 doc
: /* Tell Unix to finish all pending disk updates. */)
3307 #endif /* HAVE_SYNC */
3309 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3310 doc
: /* Return t if file FILE1 is newer than file FILE2.
3311 If FILE1 does not exist, the answer is nil;
3312 otherwise, if FILE2 does not exist, the answer is t. */)
3313 (Lisp_Object file1
, Lisp_Object file2
)
3315 Lisp_Object absname1
, absname2
;
3316 struct stat st1
, st2
;
3317 Lisp_Object handler
;
3318 struct gcpro gcpro1
, gcpro2
;
3320 CHECK_STRING (file1
);
3321 CHECK_STRING (file2
);
3324 GCPRO2 (absname1
, file2
);
3325 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3326 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3329 /* If the file name has special constructs in it,
3330 call the corresponding file handler. */
3331 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3333 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3334 if (!NILP (handler
))
3335 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3337 GCPRO2 (absname1
, absname2
);
3338 absname1
= ENCODE_FILE (absname1
);
3339 absname2
= ENCODE_FILE (absname2
);
3342 if (stat (SSDATA (absname1
), &st1
) < 0)
3345 if (stat (SSDATA (absname2
), &st2
) < 0)
3348 return (EMACS_TIME_LT (get_stat_mtime (&st2
), get_stat_mtime (&st1
))
3352 #ifndef READ_BUF_SIZE
3353 #define READ_BUF_SIZE (64 << 10)
3355 /* Some buffer offsets are stored in 'int' variables. */
3356 verify (READ_BUF_SIZE
<= INT_MAX
);
3358 /* This function is called after Lisp functions to decide a coding
3359 system are called, or when they cause an error. Before they are
3360 called, the current buffer is set unibyte and it contains only a
3361 newly inserted text (thus the buffer was empty before the
3364 The functions may set markers, overlays, text properties, or even
3365 alter the buffer contents, change the current buffer.
3367 Here, we reset all those changes by:
3368 o set back the current buffer.
3369 o move all markers and overlays to BEG.
3370 o remove all text properties.
3371 o set back the buffer multibyteness. */
3374 decide_coding_unwind (Lisp_Object unwind_data
)
3376 Lisp_Object multibyte
, undo_list
, buffer
;
3378 multibyte
= XCAR (unwind_data
);
3379 unwind_data
= XCDR (unwind_data
);
3380 undo_list
= XCAR (unwind_data
);
3381 buffer
= XCDR (unwind_data
);
3383 set_buffer_internal (XBUFFER (buffer
));
3384 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3385 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3386 set_buffer_intervals (current_buffer
, NULL
);
3387 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3389 /* Now we are safe to change the buffer's multibyteness directly. */
3390 bset_enable_multibyte_characters (current_buffer
, multibyte
);
3391 bset_undo_list (current_buffer
, undo_list
);
3396 /* Read from a non-regular file. STATE is a Lisp_Save_Value
3397 object where slot 0 is the file descriptor, slot 1 specifies
3398 an offset to put the read bytes, and slot 2 is the maximum
3399 amount of bytes to read. Value is the number of bytes read. */
3402 read_non_regular (Lisp_Object state
)
3408 nbytes
= emacs_read (XSAVE_INTEGER (state
, 0),
3409 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3410 + XSAVE_INTEGER (state
, 1)),
3411 XSAVE_INTEGER (state
, 2));
3413 /* Fast recycle this object for the likely next call. */
3415 return make_number (nbytes
);
3419 /* Condition-case handler used when reading from non-regular files
3420 in insert-file-contents. */
3423 read_non_regular_quit (Lisp_Object ignore
)
3428 /* Return the file offset that VAL represents, checking for type
3429 errors and overflow. */
3431 file_offset (Lisp_Object val
)
3433 if (RANGED_INTEGERP (0, val
, TYPE_MAXIMUM (off_t
)))
3438 double v
= XFLOAT_DATA (val
);
3440 && (sizeof (off_t
) < sizeof v
3441 ? v
<= TYPE_MAXIMUM (off_t
)
3442 : v
< TYPE_MAXIMUM (off_t
)))
3446 wrong_type_argument (intern ("file-offset"), val
);
3449 /* Return a special time value indicating the error number ERRNUM. */
3451 time_error_value (int errnum
)
3453 int ns
= (errnum
== ENOENT
|| errnum
== EACCES
|| errnum
== ENOTDIR
3454 ? NONEXISTENT_MODTIME_NSECS
3455 : UNKNOWN_MODTIME_NSECS
);
3456 return make_emacs_time (0, ns
);
3459 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3461 doc
: /* Insert contents of file FILENAME after point.
3462 Returns list of absolute file name and number of characters inserted.
3463 If second argument VISIT is non-nil, the buffer's visited filename and
3464 last save file modtime are set, and it is marked unmodified. If
3465 visiting and the file does not exist, visiting is completed before the
3468 The optional third and fourth arguments BEG and END specify what portion
3469 of the file to insert. These arguments count bytes in the file, not
3470 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3472 If optional fifth argument REPLACE is non-nil, replace the current
3473 buffer contents (in the accessible portion) with the file contents.
3474 This is better than simply deleting and inserting the whole thing
3475 because (1) it preserves some marker positions and (2) it puts less data
3476 in the undo list. When REPLACE is non-nil, the second return value is
3477 the number of characters that replace previous buffer contents.
3479 This function does code conversion according to the value of
3480 `coding-system-for-read' or `file-coding-system-alist', and sets the
3481 variable `last-coding-system-used' to the coding system actually used.
3483 In addition, this function decodes the inserted text from known formats
3484 by calling `format-decode', which see. */)
3485 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3490 ptrdiff_t inserted
= 0;
3492 off_t beg_offset
, end_offset
;
3494 ptrdiff_t count
= SPECPDL_INDEX ();
3495 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3496 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3498 ptrdiff_t total
= 0;
3499 bool not_regular
= 0;
3501 char read_buf
[READ_BUF_SIZE
];
3502 struct coding_system coding
;
3503 bool replace_handled
= 0;
3504 bool set_coding_system
= 0;
3505 Lisp_Object coding_system
;
3507 /* If the undo log only contains the insertion, there's no point
3508 keeping it. It's typically when we first fill a file-buffer. */
3509 bool empty_undo_list_p
3510 = (!NILP (visit
) && NILP (BVAR (current_buffer
, undo_list
))
3512 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3513 bool we_locked_file
= 0;
3514 bool deferred_remove_unwind_protect
= 0;
3516 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3517 error ("Cannot do file visiting in an indirect buffer");
3519 if (!NILP (BVAR (current_buffer
, read_only
)))
3520 Fbarf_if_buffer_read_only ();
3524 orig_filename
= Qnil
;
3527 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3529 CHECK_STRING (filename
);
3530 filename
= Fexpand_file_name (filename
, Qnil
);
3532 /* The value Qnil means that the coding system is not yet
3534 coding_system
= Qnil
;
3536 /* If the file name has special constructs in it,
3537 call the corresponding file handler. */
3538 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3539 if (!NILP (handler
))
3541 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3542 visit
, beg
, end
, replace
);
3543 if (CONSP (val
) && CONSP (XCDR (val
))
3544 && RANGED_INTEGERP (0, XCAR (XCDR (val
)), ZV
- PT
))
3545 inserted
= XINT (XCAR (XCDR (val
)));
3549 orig_filename
= filename
;
3550 filename
= ENCODE_FILE (filename
);
3552 fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0);
3557 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3558 mtime
= time_error_value (save_errno
);
3560 if (!NILP (Vcoding_system_for_read
))
3561 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3565 /* Replacement should preserve point as it preserves markers. */
3566 if (!NILP (replace
))
3567 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3569 record_unwind_protect (close_file_unwind
, make_number (fd
));
3571 if (fstat (fd
, &st
) != 0)
3572 report_file_error ("Input file status", Fcons (orig_filename
, Qnil
));
3573 mtime
= get_stat_mtime (&st
);
3575 /* This code will need to be changed in order to work on named
3576 pipes, and it's probably just not worth it. So we should at
3577 least signal an error. */
3578 if (!S_ISREG (st
.st_mode
))
3585 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3586 xsignal2 (Qfile_error
,
3587 build_string ("not a regular file"), orig_filename
);
3592 if (!NILP (beg
) || !NILP (end
))
3593 error ("Attempt to visit less than an entire file");
3594 if (BEG
< Z
&& NILP (replace
))
3595 error ("Cannot do file visiting in a non-empty buffer");
3599 beg_offset
= file_offset (beg
);
3604 end_offset
= file_offset (end
);
3608 end_offset
= TYPE_MAXIMUM (off_t
);
3611 end_offset
= st
.st_size
;
3613 /* A negative size can happen on a platform that allows file
3614 sizes greater than the maximum off_t value. */
3618 /* The file size returned from stat may be zero, but data
3619 may be readable nonetheless, for example when this is a
3620 file in the /proc filesystem. */
3621 if (end_offset
== 0)
3622 end_offset
= READ_BUF_SIZE
;
3626 /* Check now whether the buffer will become too large,
3627 in the likely case where the file's length is not changing.
3628 This saves a lot of needless work before a buffer overflow. */
3631 /* The likely offset where we will stop reading. We could read
3632 more (or less), if the file grows (or shrinks) as we read it. */
3633 off_t likely_end
= min (end_offset
, st
.st_size
);
3635 if (beg_offset
< likely_end
)
3638 = Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3639 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3640 off_t likely_growth
= likely_end
- beg_offset
;
3641 if (buf_growth_max
< likely_growth
)
3646 /* Prevent redisplay optimizations. */
3647 current_buffer
->clip_changed
= 1;
3649 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3651 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3652 setup_coding_system (coding_system
, &coding
);
3653 /* Ensure we set Vlast_coding_system_used. */
3654 set_coding_system
= 1;
3658 /* Decide the coding system to use for reading the file now
3659 because we can't use an optimized method for handling
3660 `coding:' tag if the current buffer is not empty. */
3661 if (!NILP (Vcoding_system_for_read
))
3662 coding_system
= Vcoding_system_for_read
;
3665 /* Don't try looking inside a file for a coding system
3666 specification if it is not seekable. */
3667 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3669 /* Find a coding system specified in the heading two
3670 lines or in the tailing several lines of the file.
3671 We assume that the 1K-byte and 3K-byte for heading
3672 and tailing respectively are sufficient for this
3676 if (st
.st_size
<= (1024 * 4))
3677 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3680 nread
= emacs_read (fd
, read_buf
, 1024);
3684 if (lseek (fd
, - (1024 * 3), SEEK_END
) < 0)
3685 report_file_error ("Setting file position",
3686 Fcons (orig_filename
, Qnil
));
3687 ntail
= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3688 nread
= ntail
< 0 ? ntail
: nread
+ ntail
;
3693 error ("IO error reading %s: %s",
3694 SDATA (orig_filename
), emacs_strerror (errno
));
3697 struct buffer
*prev
= current_buffer
;
3698 Lisp_Object workbuf
;
3701 record_unwind_current_buffer ();
3703 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3704 buf
= XBUFFER (workbuf
);
3706 delete_all_overlays (buf
);
3707 bset_directory (buf
, BVAR (current_buffer
, directory
));
3708 bset_read_only (buf
, Qnil
);
3709 bset_filename (buf
, Qnil
);
3710 bset_undo_list (buf
, Qt
);
3711 eassert (buf
->overlays_before
== NULL
);
3712 eassert (buf
->overlays_after
== NULL
);
3714 set_buffer_internal (buf
);
3716 bset_enable_multibyte_characters (buf
, Qnil
);
3718 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3719 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3720 coding_system
= call2 (Vset_auto_coding_function
,
3721 filename
, make_number (nread
));
3722 set_buffer_internal (prev
);
3724 /* Discard the unwind protect for recovering the
3728 /* Rewind the file for the actual read done later. */
3729 if (lseek (fd
, 0, SEEK_SET
) < 0)
3730 report_file_error ("Setting file position",
3731 Fcons (orig_filename
, Qnil
));
3735 if (NILP (coding_system
))
3737 /* If we have not yet decided a coding system, check
3738 file-coding-system-alist. */
3739 Lisp_Object args
[6];
3741 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3742 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3743 coding_system
= Ffind_operation_coding_system (6, args
);
3744 if (CONSP (coding_system
))
3745 coding_system
= XCAR (coding_system
);
3749 if (NILP (coding_system
))
3750 coding_system
= Qundecided
;
3752 CHECK_CODING_SYSTEM (coding_system
);
3754 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3755 /* We must suppress all character code conversion except for
3756 end-of-line conversion. */
3757 coding_system
= raw_text_coding_system (coding_system
);
3759 setup_coding_system (coding_system
, &coding
);
3760 /* Ensure we set Vlast_coding_system_used. */
3761 set_coding_system
= 1;
3764 /* If requested, replace the accessible part of the buffer
3765 with the file contents. Avoid replacing text at the
3766 beginning or end of the buffer that matches the file contents;
3767 that preserves markers pointing to the unchanged parts.
3769 Here we implement this feature in an optimized way
3770 for the case where code conversion is NOT needed.
3771 The following if-statement handles the case of conversion
3772 in a less optimal way.
3774 If the code conversion is "automatic" then we try using this
3775 method and hope for the best.
3776 But if we discover the need for conversion, we give up on this method
3777 and let the following if-statement handle the replace job. */
3780 && (NILP (coding_system
)
3781 || ! CODING_REQUIRE_DECODING (&coding
)))
3783 /* same_at_start and same_at_end count bytes,
3784 because file access counts bytes
3785 and BEG and END count bytes. */
3786 ptrdiff_t same_at_start
= BEGV_BYTE
;
3787 ptrdiff_t same_at_end
= ZV_BYTE
;
3789 /* There is still a possibility we will find the need to do code
3790 conversion. If that happens, set this variable to
3791 give up on handling REPLACE in the optimized way. */
3792 bool giveup_match_end
= 0;
3794 if (beg_offset
!= 0)
3796 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3797 report_file_error ("Setting file position",
3798 Fcons (orig_filename
, Qnil
));
3803 /* Count how many chars at the start of the file
3804 match the text at the beginning of the buffer. */
3809 nread
= emacs_read (fd
, read_buf
, sizeof read_buf
);
3811 error ("IO error reading %s: %s",
3812 SSDATA (orig_filename
), emacs_strerror (errno
));
3813 else if (nread
== 0)
3816 if (CODING_REQUIRE_DETECTION (&coding
))
3818 coding_system
= detect_coding_system ((unsigned char *) read_buf
,
3821 setup_coding_system (coding_system
, &coding
);
3824 if (CODING_REQUIRE_DECODING (&coding
))
3825 /* We found that the file should be decoded somehow.
3826 Let's give up here. */
3828 giveup_match_end
= 1;
3833 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3834 && FETCH_BYTE (same_at_start
) == read_buf
[bufpos
])
3835 same_at_start
++, bufpos
++;
3836 /* If we found a discrepancy, stop the scan.
3837 Otherwise loop around and scan the next bufferful. */
3838 if (bufpos
!= nread
)
3842 /* If the file matches the buffer completely,
3843 there's no need to replace anything. */
3844 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3848 /* Truncate the buffer to the size of the file. */
3849 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3854 /* Count how many chars at the end of the file
3855 match the text at the end of the buffer. But, if we have
3856 already found that decoding is necessary, don't waste time. */
3857 while (!giveup_match_end
)
3859 int total_read
, nread
, bufpos
, trial
;
3862 /* At what file position are we now scanning? */
3863 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3864 /* If the entire file matches the buffer tail, stop the scan. */
3867 /* How much can we scan in the next step? */
3868 trial
= min (curpos
, sizeof read_buf
);
3869 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3870 report_file_error ("Setting file position",
3871 Fcons (orig_filename
, Qnil
));
3873 total_read
= nread
= 0;
3874 while (total_read
< trial
)
3876 nread
= emacs_read (fd
, read_buf
+ total_read
, trial
- total_read
);
3878 error ("IO error reading %s: %s",
3879 SDATA (orig_filename
), emacs_strerror (errno
));
3880 else if (nread
== 0)
3882 total_read
+= nread
;
3885 /* Scan this bufferful from the end, comparing with
3886 the Emacs buffer. */
3887 bufpos
= total_read
;
3889 /* Compare with same_at_start to avoid counting some buffer text
3890 as matching both at the file's beginning and at the end. */
3891 while (bufpos
> 0 && same_at_end
> same_at_start
3892 && FETCH_BYTE (same_at_end
- 1) == read_buf
[bufpos
- 1])
3893 same_at_end
--, bufpos
--;
3895 /* If we found a discrepancy, stop the scan.
3896 Otherwise loop around and scan the preceding bufferful. */
3899 /* If this discrepancy is because of code conversion,
3900 we cannot use this method; giveup and try the other. */
3901 if (same_at_end
> same_at_start
3902 && FETCH_BYTE (same_at_end
- 1) >= 0200
3903 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3904 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3905 giveup_match_end
= 1;
3914 if (! giveup_match_end
)
3918 /* We win! We can handle REPLACE the optimized way. */
3920 /* Extend the start of non-matching text area to multibyte
3921 character boundary. */
3922 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3923 while (same_at_start
> BEGV_BYTE
3924 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3927 /* Extend the end of non-matching text area to multibyte
3928 character boundary. */
3929 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3930 while (same_at_end
< ZV_BYTE
3931 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3934 /* Don't try to reuse the same piece of text twice. */
3935 overlap
= (same_at_start
- BEGV_BYTE
3937 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3939 same_at_end
+= overlap
;
3941 /* Arrange to read only the nonmatching middle part of the file. */
3942 beg_offset
+= same_at_start
- BEGV_BYTE
;
3943 end_offset
-= ZV_BYTE
- same_at_end
;
3945 del_range_byte (same_at_start
, same_at_end
, 0);
3946 /* Insert from the file at the proper position. */
3947 temp
= BYTE_TO_CHAR (same_at_start
);
3948 SET_PT_BOTH (temp
, same_at_start
);
3950 /* If display currently starts at beginning of line,
3951 keep it that way. */
3952 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
3953 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
3955 replace_handled
= 1;
3959 /* If requested, replace the accessible part of the buffer
3960 with the file contents. Avoid replacing text at the
3961 beginning or end of the buffer that matches the file contents;
3962 that preserves markers pointing to the unchanged parts.
3964 Here we implement this feature for the case where code conversion
3965 is needed, in a simple way that needs a lot of memory.
3966 The preceding if-statement handles the case of no conversion
3967 in a more optimized way. */
3968 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3970 ptrdiff_t same_at_start
= BEGV_BYTE
;
3971 ptrdiff_t same_at_end
= ZV_BYTE
;
3972 ptrdiff_t same_at_start_charpos
;
3973 ptrdiff_t inserted_chars
;
3976 unsigned char *decoded
;
3979 ptrdiff_t this_count
= SPECPDL_INDEX ();
3981 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3982 Lisp_Object conversion_buffer
;
3983 struct gcpro gcpro1
;
3985 conversion_buffer
= code_conversion_save (1, multibyte
);
3987 /* First read the whole file, performing code conversion into
3988 CONVERSION_BUFFER. */
3990 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3991 report_file_error ("Setting file position",
3992 Fcons (orig_filename
, Qnil
));
3994 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3995 unprocessed
= 0; /* Bytes not processed in previous loop. */
3997 GCPRO1 (conversion_buffer
);
4000 /* Read at most READ_BUF_SIZE bytes at a time, to allow
4001 quitting while reading a huge file. */
4003 /* Allow quitting out of the actual I/O. */
4006 this = emacs_read (fd
, read_buf
+ unprocessed
,
4007 READ_BUF_SIZE
- unprocessed
);
4013 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
4014 BUF_Z (XBUFFER (conversion_buffer
)));
4015 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4016 unprocessed
+ this, conversion_buffer
);
4017 unprocessed
= coding
.carryover_bytes
;
4018 if (coding
.carryover_bytes
> 0)
4019 memcpy (read_buf
, coding
.carryover
, unprocessed
);
4024 /* We should remove the unwind_protect calling
4025 close_file_unwind, but other stuff has been added the stack,
4026 so defer the removal till we reach the `handled' label. */
4027 deferred_remove_unwind_protect
= 1;
4030 error ("IO error reading %s: %s",
4031 SDATA (orig_filename
), emacs_strerror (errno
));
4033 if (unprocessed
> 0)
4035 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4036 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
4037 unprocessed
, conversion_buffer
);
4038 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
4041 coding_system
= CODING_ID_NAME (coding
.id
);
4042 set_coding_system
= 1;
4043 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
4044 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
4045 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4047 /* Compare the beginning of the converted string with the buffer
4051 while (bufpos
< inserted
&& same_at_start
< same_at_end
4052 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
4053 same_at_start
++, bufpos
++;
4055 /* If the file matches the head of buffer completely,
4056 there's no need to replace anything. */
4058 if (bufpos
== inserted
)
4060 /* Truncate the buffer to the size of the file. */
4061 if (same_at_start
!= same_at_end
)
4062 del_range_byte (same_at_start
, same_at_end
, 0);
4065 unbind_to (this_count
, Qnil
);
4069 /* Extend the start of non-matching text area to the previous
4070 multibyte character boundary. */
4071 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4072 while (same_at_start
> BEGV_BYTE
4073 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4076 /* Scan this bufferful from the end, comparing with
4077 the Emacs buffer. */
4080 /* Compare with same_at_start to avoid counting some buffer text
4081 as matching both at the file's beginning and at the end. */
4082 while (bufpos
> 0 && same_at_end
> same_at_start
4083 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
4084 same_at_end
--, bufpos
--;
4086 /* Extend the end of non-matching text area to the next
4087 multibyte character boundary. */
4088 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4089 while (same_at_end
< ZV_BYTE
4090 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4093 /* Don't try to reuse the same piece of text twice. */
4094 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4096 same_at_end
+= overlap
;
4098 /* If display currently starts at beginning of line,
4099 keep it that way. */
4100 if (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
)
4101 XWINDOW (selected_window
)->start_at_line_beg
= !NILP (Fbolp ());
4103 /* Replace the chars that we need to replace,
4104 and update INSERTED to equal the number of bytes
4105 we are taking from the decoded string. */
4106 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4108 if (same_at_end
!= same_at_start
)
4110 del_range_byte (same_at_start
, same_at_end
, 0);
4112 eassert (same_at_start
== GPT_BYTE
);
4113 same_at_start
= GPT_BYTE
;
4117 temp
= BYTE_TO_CHAR (same_at_start
);
4119 /* Insert from the file at the proper position. */
4120 SET_PT_BOTH (temp
, same_at_start
);
4121 same_at_start_charpos
4122 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4123 same_at_start
- BEGV_BYTE
4124 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
4125 eassert (same_at_start_charpos
== temp
- (BEGV
- BEG
));
4127 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
4128 same_at_start
+ inserted
- BEGV_BYTE
4129 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
4130 - same_at_start_charpos
);
4131 /* This binding is to avoid ask-user-about-supersession-threat
4132 being called in insert_from_buffer (via in
4133 prepare_to_modify_buffer). */
4134 specbind (intern ("buffer-file-name"), Qnil
);
4135 insert_from_buffer (XBUFFER (conversion_buffer
),
4136 same_at_start_charpos
, inserted_chars
, 0);
4137 /* Set `inserted' to the number of inserted characters. */
4138 inserted
= PT
- temp
;
4139 /* Set point before the inserted characters. */
4140 SET_PT_BOTH (temp
, same_at_start
);
4142 unbind_to (this_count
, Qnil
);
4148 total
= end_offset
- beg_offset
;
4150 /* For a special file, all we can do is guess. */
4151 total
= READ_BUF_SIZE
;
4153 if (NILP (visit
) && total
> 0)
4155 #ifdef CLASH_DETECTION
4156 if (!NILP (BVAR (current_buffer
, file_truename
))
4157 /* Make binding buffer-file-name to nil effective. */
4158 && !NILP (BVAR (current_buffer
, filename
))
4159 && SAVE_MODIFF
>= MODIFF
)
4161 #endif /* CLASH_DETECTION */
4162 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4165 move_gap_both (PT
, PT_BYTE
);
4166 if (GAP_SIZE
< total
)
4167 make_gap (total
- GAP_SIZE
);
4169 if (beg_offset
!= 0 || !NILP (replace
))
4171 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
4172 report_file_error ("Setting file position",
4173 Fcons (orig_filename
, Qnil
));
4176 /* In the following loop, HOW_MUCH contains the total bytes read so
4177 far for a regular file, and not changed for a special file. But,
4178 before exiting the loop, it is set to a negative value if I/O
4182 /* Total bytes inserted. */
4185 /* Here, we don't do code conversion in the loop. It is done by
4186 decode_coding_gap after all data are read into the buffer. */
4188 ptrdiff_t gap_size
= GAP_SIZE
;
4190 while (how_much
< total
)
4192 /* try is reserved in some compilers (Microsoft C) */
4193 ptrdiff_t trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4200 /* Maybe make more room. */
4201 if (gap_size
< trytry
)
4203 make_gap (trytry
- gap_size
);
4204 gap_size
= GAP_SIZE
- inserted
;
4207 /* Read from the file, capturing `quit'. When an
4208 error occurs, end the loop, and arrange for a quit
4209 to be signaled after decoding the text we read. */
4210 nbytes
= internal_condition_case_1
4212 make_save_value (SAVE_TYPE_INT_INT_INT
, (ptrdiff_t) fd
,
4214 Qerror
, read_non_regular_quit
);
4222 this = XINT (nbytes
);
4226 /* Allow quitting out of the actual I/O. We don't make text
4227 part of the buffer until all the reading is done, so a C-g
4228 here doesn't do any harm. */
4231 this = emacs_read (fd
,
4232 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4246 /* For a regular file, where TOTAL is the real size,
4247 count HOW_MUCH to compare with it.
4248 For a special file, where TOTAL is just a buffer size,
4249 so don't bother counting in HOW_MUCH.
4250 (INSERTED is where we count the number of characters inserted.) */
4257 /* Now we have either read all the file data into the gap,
4258 or stop reading on I/O error or quit. If nothing was
4259 read, undo marking the buffer modified. */
4263 #ifdef CLASH_DETECTION
4265 unlock_file (BVAR (current_buffer
, file_truename
));
4267 Vdeactivate_mark
= old_Vdeactivate_mark
;
4270 Vdeactivate_mark
= Qt
;
4274 /* Discard the unwind protect for closing the file. */
4278 error ("IO error reading %s: %s",
4279 SDATA (orig_filename
), emacs_strerror (errno
));
4281 /* Make the text read part of the buffer. */
4282 GAP_SIZE
-= inserted
;
4284 GPT_BYTE
+= inserted
;
4286 ZV_BYTE
+= inserted
;
4291 /* Put an anchor to ensure multi-byte form ends at gap. */
4296 if (NILP (coding_system
))
4298 /* The coding system is not yet decided. Decide it by an
4299 optimized method for handling `coding:' tag.
4301 Note that we can get here only if the buffer was empty
4302 before the insertion. */
4304 if (!NILP (Vcoding_system_for_read
))
4305 coding_system
= Vcoding_system_for_read
;
4308 /* Since we are sure that the current buffer was empty
4309 before the insertion, we can toggle
4310 enable-multibyte-characters directly here without taking
4311 care of marker adjustment. By this way, we can run Lisp
4312 program safely before decoding the inserted text. */
4313 Lisp_Object unwind_data
;
4314 ptrdiff_t count1
= SPECPDL_INDEX ();
4316 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4317 Fcons (BVAR (current_buffer
, undo_list
),
4318 Fcurrent_buffer ()));
4319 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4320 bset_undo_list (current_buffer
, Qt
);
4321 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4323 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4325 coding_system
= call2 (Vset_auto_coding_function
,
4326 filename
, make_number (inserted
));
4329 if (NILP (coding_system
))
4331 /* If the coding system is not yet decided, check
4332 file-coding-system-alist. */
4333 Lisp_Object args
[6];
4335 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4336 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4337 coding_system
= Ffind_operation_coding_system (6, args
);
4338 if (CONSP (coding_system
))
4339 coding_system
= XCAR (coding_system
);
4341 unbind_to (count1
, Qnil
);
4342 inserted
= Z_BYTE
- BEG_BYTE
;
4345 if (NILP (coding_system
))
4346 coding_system
= Qundecided
;
4348 CHECK_CODING_SYSTEM (coding_system
);
4350 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4351 /* We must suppress all character code conversion except for
4352 end-of-line conversion. */
4353 coding_system
= raw_text_coding_system (coding_system
);
4354 setup_coding_system (coding_system
, &coding
);
4355 /* Ensure we set Vlast_coding_system_used. */
4356 set_coding_system
= 1;
4361 /* When we visit a file by raw-text, we change the buffer to
4363 if (CODING_FOR_UNIBYTE (&coding
)
4364 /* Can't do this if part of the buffer might be preserved. */
4366 /* Visiting a file with these coding system makes the buffer
4368 bset_enable_multibyte_characters (current_buffer
, Qnil
);
4371 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4372 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4373 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4375 move_gap_both (PT
, PT_BYTE
);
4376 GAP_SIZE
+= inserted
;
4377 ZV_BYTE
-= inserted
;
4381 decode_coding_gap (&coding
, inserted
, inserted
);
4382 inserted
= coding
.produced_char
;
4383 coding_system
= CODING_ID_NAME (coding
.id
);
4385 else if (inserted
> 0)
4386 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4389 /* Call after-change hooks for the inserted text, aside from the case
4390 of normal visiting (not with REPLACE), which is done in a new buffer
4391 "before" the buffer is changed. */
4392 if (inserted
> 0 && total
> 0
4393 && (NILP (visit
) || !NILP (replace
)))
4395 signal_after_change (PT
, 0, inserted
);
4396 update_compositions (PT
, PT
, CHECK_BORDER
);
4399 /* Now INSERTED is measured in characters. */
4403 if (deferred_remove_unwind_protect
)
4404 /* If requested above, discard the unwind protect for closing the
4410 if (empty_undo_list_p
)
4411 bset_undo_list (current_buffer
, Qnil
);
4415 current_buffer
->modtime
= mtime
;
4416 current_buffer
->modtime_size
= st
.st_size
;
4417 bset_filename (current_buffer
, orig_filename
);
4420 SAVE_MODIFF
= MODIFF
;
4421 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4422 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4423 #ifdef CLASH_DETECTION
4426 if (!NILP (BVAR (current_buffer
, file_truename
)))
4427 unlock_file (BVAR (current_buffer
, file_truename
));
4428 unlock_file (filename
);
4430 #endif /* CLASH_DETECTION */
4432 xsignal2 (Qfile_error
,
4433 build_string ("not a regular file"), orig_filename
);
4436 if (set_coding_system
)
4437 Vlast_coding_system_used
= coding_system
;
4439 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4441 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4443 if (! NILP (insval
))
4445 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4446 wrong_type_argument (intern ("inserted-chars"), insval
);
4447 inserted
= XFASTINT (insval
);
4451 /* Decode file format. */
4454 /* Don't run point motion or modification hooks when decoding. */
4455 ptrdiff_t count1
= SPECPDL_INDEX ();
4456 ptrdiff_t old_inserted
= inserted
;
4457 specbind (Qinhibit_point_motion_hooks
, Qt
);
4458 specbind (Qinhibit_modification_hooks
, Qt
);
4460 /* Save old undo list and don't record undo for decoding. */
4461 old_undo
= BVAR (current_buffer
, undo_list
);
4462 bset_undo_list (current_buffer
, Qt
);
4466 insval
= call3 (Qformat_decode
,
4467 Qnil
, make_number (inserted
), visit
);
4468 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4469 wrong_type_argument (intern ("inserted-chars"), insval
);
4470 inserted
= XFASTINT (insval
);
4474 /* If REPLACE is non-nil and we succeeded in not replacing the
4475 beginning or end of the buffer text with the file's contents,
4476 call format-decode with `point' positioned at the beginning
4477 of the buffer and `inserted' equaling the number of
4478 characters in the buffer. Otherwise, format-decode might
4479 fail to correctly analyze the beginning or end of the buffer.
4480 Hence we temporarily save `point' and `inserted' here and
4481 restore `point' iff format-decode did not insert or delete
4482 any text. Otherwise we leave `point' at point-min. */
4483 ptrdiff_t opoint
= PT
;
4484 ptrdiff_t opoint_byte
= PT_BYTE
;
4485 ptrdiff_t oinserted
= ZV
- BEGV
;
4486 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4488 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4489 insval
= call3 (Qformat_decode
,
4490 Qnil
, make_number (oinserted
), visit
);
4491 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4492 wrong_type_argument (intern ("inserted-chars"), insval
);
4493 if (ochars_modiff
== CHARS_MODIFF
)
4494 /* format_decode didn't modify buffer's characters => move
4495 point back to position before inserted text and leave
4496 value of inserted alone. */
4497 SET_PT_BOTH (opoint
, opoint_byte
);
4499 /* format_decode modified buffer's characters => consider
4500 entire buffer changed and leave point at point-min. */
4501 inserted
= XFASTINT (insval
);
4504 /* For consistency with format-decode call these now iff inserted > 0
4505 (martin 2007-06-28). */
4506 p
= Vafter_insert_file_functions
;
4511 insval
= call1 (XCAR (p
), make_number (inserted
));
4514 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4515 wrong_type_argument (intern ("inserted-chars"), insval
);
4516 inserted
= XFASTINT (insval
);
4521 /* For the rationale of this see the comment on
4522 format-decode above. */
4523 ptrdiff_t opoint
= PT
;
4524 ptrdiff_t opoint_byte
= PT_BYTE
;
4525 ptrdiff_t oinserted
= ZV
- BEGV
;
4526 EMACS_INT ochars_modiff
= CHARS_MODIFF
;
4528 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4529 insval
= call1 (XCAR (p
), make_number (oinserted
));
4532 if (! RANGED_INTEGERP (0, insval
, ZV
- PT
))
4533 wrong_type_argument (intern ("inserted-chars"), insval
);
4534 if (ochars_modiff
== CHARS_MODIFF
)
4535 /* after_insert_file_functions didn't modify
4536 buffer's characters => move point back to
4537 position before inserted text and leave value of
4539 SET_PT_BOTH (opoint
, opoint_byte
);
4541 /* after_insert_file_functions did modify buffer's
4542 characters => consider entire buffer changed and
4543 leave point at point-min. */
4544 inserted
= XFASTINT (insval
);
4552 if (!empty_undo_list_p
)
4554 bset_undo_list (current_buffer
, old_undo
);
4555 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4557 /* Adjust the last undo record for the size change during
4558 the format conversion. */
4559 Lisp_Object tem
= XCAR (old_undo
);
4560 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4561 && INTEGERP (XCDR (tem
))
4562 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4563 XSETCDR (tem
, make_number (PT
+ inserted
));
4567 /* If undo_list was Qt before, keep it that way.
4568 Otherwise start with an empty undo_list. */
4569 bset_undo_list (current_buffer
, EQ (old_undo
, Qt
) ? Qt
: Qnil
);
4571 unbind_to (count1
, Qnil
);
4575 && EMACS_NSECS (current_buffer
->modtime
) == NONEXISTENT_MODTIME_NSECS
)
4577 /* If visiting nonexistent file, return nil. */
4579 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4583 Fsignal (Qquit
, Qnil
);
4585 /* Retval needs to be dealt with in all cases consistently. */
4587 val
= list2 (orig_filename
, make_number (inserted
));
4589 RETURN_UNGCPRO (unbind_to (count
, val
));
4592 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4595 build_annotations_unwind (Lisp_Object arg
)
4597 Vwrite_region_annotation_buffers
= arg
;
4601 /* Decide the coding-system to encode the data with. */
4603 DEFUN ("choose-write-coding-system", Fchoose_write_coding_system
,
4604 Schoose_write_coding_system
, 3, 6, 0,
4605 doc
: /* Choose the coding system for writing a file.
4606 Arguments are as for `write-region'.
4607 This function is for internal use only. It may prompt the user. */ )
4608 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4609 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
)
4612 Lisp_Object eol_parent
= Qnil
;
4614 /* Mimic write-region behavior. */
4617 XSETFASTINT (start
, BEGV
);
4618 XSETFASTINT (end
, ZV
);
4622 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4623 BVAR (current_buffer
, auto_save_file_name
))))
4628 else if (!NILP (Vcoding_system_for_write
))
4630 val
= Vcoding_system_for_write
;
4631 if (coding_system_require_warning
4632 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4633 /* Confirm that VAL can surely encode the current region. */
4634 val
= call5 (Vselect_safe_coding_system_function
,
4635 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4640 /* If the variable `buffer-file-coding-system' is set locally,
4641 it means that the file was read with some kind of code
4642 conversion or the variable is explicitly set by users. We
4643 had better write it out with the same coding system even if
4644 `enable-multibyte-characters' is nil.
4646 If it is not set locally, we anyway have to convert EOL
4647 format if the default value of `buffer-file-coding-system'
4648 tells that it is not Unix-like (LF only) format. */
4649 bool using_default_coding
= 0;
4650 bool force_raw_text
= 0;
4652 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4654 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4657 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4663 /* Check file-coding-system-alist. */
4664 Lisp_Object args
[7], coding_systems
;
4666 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4667 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4669 coding_systems
= Ffind_operation_coding_system (7, args
);
4670 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4671 val
= XCDR (coding_systems
);
4676 /* If we still have not decided a coding system, use the
4677 default value of buffer-file-coding-system. */
4678 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4679 using_default_coding
= 1;
4682 if (! NILP (val
) && ! force_raw_text
)
4684 Lisp_Object spec
, attrs
;
4686 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4687 attrs
= AREF (spec
, 0);
4688 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4693 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4694 /* Confirm that VAL can surely encode the current region. */
4695 val
= call5 (Vselect_safe_coding_system_function
,
4696 start
, end
, val
, Qnil
, filename
);
4698 /* If the decided coding-system doesn't specify end-of-line
4699 format, we use that of
4700 `default-buffer-file-coding-system'. */
4701 if (! using_default_coding
4702 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4703 val
= (coding_inherit_eol_type
4704 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4706 /* If we decide not to encode text, use `raw-text' or one of its
4709 val
= raw_text_coding_system (val
);
4712 val
= coding_inherit_eol_type (val
, eol_parent
);
4716 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4717 "r\nFWrite region to file: \ni\ni\ni\np",
4718 doc
: /* Write current region into specified file.
4719 When called from a program, requires three arguments:
4720 START, END and FILENAME. START and END are normally buffer positions
4721 specifying the part of the buffer to write.
4722 If START is nil, that means to use the entire buffer contents.
4723 If START is a string, then output that string to the file
4724 instead of any buffer contents; END is ignored.
4726 Optional fourth argument APPEND if non-nil means
4727 append to existing file contents (if any). If it is a number,
4728 seek to that offset in the file before writing.
4729 Optional fifth argument VISIT, if t or a string, means
4730 set the last-save-file-modtime of buffer to this file's modtime
4731 and mark buffer not modified.
4732 If VISIT is a string, it is a second file name;
4733 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4734 VISIT is also the file name to lock and unlock for clash detection.
4735 If VISIT is neither t nor nil nor a string,
4736 that means do not display the \"Wrote file\" message.
4737 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4738 use for locking and unlocking, overriding FILENAME and VISIT.
4739 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4740 for an existing file with the same name. If MUSTBENEW is `excl',
4741 that means to get an error if the file already exists; never overwrite.
4742 If MUSTBENEW is neither nil nor `excl', that means ask for
4743 confirmation before overwriting, but do go ahead and overwrite the file
4744 if the user confirms.
4746 This does code conversion according to the value of
4747 `coding-system-for-write', `buffer-file-coding-system', or
4748 `file-coding-system-alist', and sets the variable
4749 `last-coding-system-used' to the coding system actually used.
4751 This calls `write-region-annotate-functions' at the start, and
4752 `write-region-post-annotation-function' at the end. */)
4753 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4758 off_t offset
IF_LINT (= 0);
4764 ptrdiff_t count
= SPECPDL_INDEX ();
4766 Lisp_Object handler
;
4767 Lisp_Object visit_file
;
4768 Lisp_Object annotations
;
4769 Lisp_Object encoded_filename
;
4770 bool visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4771 bool quietly
= !NILP (visit
);
4772 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4773 struct buffer
*given_buffer
;
4774 struct coding_system coding
;
4776 if (current_buffer
->base_buffer
&& visiting
)
4777 error ("Cannot do file visiting in an indirect buffer");
4779 if (!NILP (start
) && !STRINGP (start
))
4780 validate_region (&start
, &end
);
4783 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4785 filename
= Fexpand_file_name (filename
, Qnil
);
4787 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4788 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4790 if (STRINGP (visit
))
4791 visit_file
= Fexpand_file_name (visit
, Qnil
);
4793 visit_file
= filename
;
4795 if (NILP (lockname
))
4796 lockname
= visit_file
;
4800 /* If the file name has special constructs in it,
4801 call the corresponding file handler. */
4802 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4803 /* If FILENAME has no handler, see if VISIT has one. */
4804 if (NILP (handler
) && STRINGP (visit
))
4805 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4807 if (!NILP (handler
))
4810 val
= call6 (handler
, Qwrite_region
, start
, end
,
4811 filename
, append
, visit
);
4815 SAVE_MODIFF
= MODIFF
;
4816 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4817 bset_filename (current_buffer
, visit_file
);
4823 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4825 /* Special kludge to simplify auto-saving. */
4828 /* Do it later, so write-region-annotate-function can work differently
4829 if we save "the buffer" vs "a region".
4830 This is useful in tar-mode. --Stef
4831 XSETFASTINT (start, BEG);
4832 XSETFASTINT (end, Z); */
4836 record_unwind_protect (build_annotations_unwind
,
4837 Vwrite_region_annotation_buffers
);
4838 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4839 count1
= SPECPDL_INDEX ();
4841 given_buffer
= current_buffer
;
4843 if (!STRINGP (start
))
4845 annotations
= build_annotations (start
, end
);
4847 if (current_buffer
!= given_buffer
)
4849 XSETFASTINT (start
, BEGV
);
4850 XSETFASTINT (end
, ZV
);
4856 XSETFASTINT (start
, BEGV
);
4857 XSETFASTINT (end
, ZV
);
4862 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4864 /* Decide the coding-system to encode the data with.
4865 We used to make this choice before calling build_annotations, but that
4866 leads to problems when a write-annotate-function takes care of
4867 unsavable chars (as was the case with X-Symbol). */
4868 Vlast_coding_system_used
=
4869 Fchoose_write_coding_system (start
, end
, filename
,
4870 append
, visit
, lockname
);
4872 setup_coding_system (Vlast_coding_system_used
, &coding
);
4874 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4875 coding
.mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4877 #ifdef CLASH_DETECTION
4879 lock_file (lockname
);
4880 #endif /* CLASH_DETECTION */
4882 encoded_filename
= ENCODE_FILE (filename
);
4883 fn
= SSDATA (encoded_filename
);
4884 open_flags
= O_WRONLY
| O_BINARY
| O_CREAT
;
4885 open_flags
|= EQ (mustbenew
, Qexcl
) ? O_EXCL
: !NILP (append
) ? 0 : O_TRUNC
;
4886 if (NUMBERP (append
))
4887 offset
= file_offset (append
);
4888 else if (!NILP (append
))
4889 open_flags
|= O_APPEND
;
4891 mode
= S_IREAD
| S_IWRITE
;
4893 mode
= auto_saving
? auto_save_mode_bits
: 0666;
4896 desc
= emacs_open (fn
, open_flags
, mode
);
4900 #ifdef CLASH_DETECTION
4902 if (!auto_saving
) unlock_file (lockname
);
4904 #endif /* CLASH_DETECTION */
4906 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4909 record_unwind_protect (close_file_unwind
, make_number (desc
));
4911 if (NUMBERP (append
))
4913 off_t ret
= lseek (desc
, offset
, SEEK_SET
);
4916 #ifdef CLASH_DETECTION
4918 if (!auto_saving
) unlock_file (lockname
);
4920 #endif /* CLASH_DETECTION */
4922 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4930 if (STRINGP (start
))
4931 ok
= a_write (desc
, start
, 0, SCHARS (start
), &annotations
, &coding
);
4932 else if (XINT (start
) != XINT (end
))
4933 ok
= a_write (desc
, Qnil
, XINT (start
), XINT (end
) - XINT (start
),
4934 &annotations
, &coding
);
4937 /* If file was empty, still need to write the annotations. */
4938 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4939 ok
= a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4943 if (ok
&& CODING_REQUIRE_FLUSHING (&coding
)
4944 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
))
4946 /* We have to flush out a data. */
4947 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4948 ok
= e_write (desc
, Qnil
, 1, 1, &coding
);
4954 /* fsync is not crucial for auto-save files, since they might lose
4955 some work anyway. */
4956 if (!auto_saving
&& !write_region_inhibit_fsync
)
4958 /* Transfer data and metadata to disk, retrying if interrupted.
4959 fsync can report a write failure here, e.g., due to disk full
4960 under NFS. But ignore EINVAL, which means fsync is not
4961 supported on this file. */
4962 while (fsync (desc
) != 0)
4965 if (errno
!= EINVAL
)
4966 ok
= 0, save_errno
= errno
;
4971 modtime
= invalid_emacs_time ();
4974 if (fstat (desc
, &st
) == 0)
4975 modtime
= get_stat_mtime (&st
);
4977 ok
= 0, save_errno
= errno
;
4980 /* NFS can report a write failure now. */
4981 if (emacs_close (desc
) < 0)
4982 ok
= 0, save_errno
= errno
;
4984 /* Discard the unwind protect for close_file_unwind. */
4985 specpdl_ptr
= specpdl
+ count1
;
4987 /* Some file systems have a bug where st_mtime is not updated
4988 properly after a write. For example, CIFS might not see the
4989 st_mtime change until after the file is opened again.
4991 Attempt to detect this file system bug, and update MODTIME to the
4992 newer st_mtime if the bug appears to be present. This introduces
4993 a race condition, so to avoid most instances of the race condition
4994 on non-buggy file systems, skip this check if the most recently
4995 encountered non-buggy file system was the current file system.
4997 A race condition can occur if some other process modifies the
4998 file between the fstat above and the fstat below, but the race is
4999 unlikely and a similar race between the last write and the fstat
5000 above cannot possibly be closed anyway. */
5002 if (EMACS_TIME_VALID_P (modtime
)
5003 && ! (valid_timestamp_file_system
&& st
.st_dev
== timestamp_file_system
))
5005 int desc1
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
5009 if (fstat (desc1
, &st1
) == 0
5010 && st
.st_dev
== st1
.st_dev
&& st
.st_ino
== st1
.st_ino
)
5012 /* Use the heuristic if it appears to be valid. With neither
5013 O_EXCL nor O_TRUNC, if Emacs happened to write nothing to the
5014 file, the time stamp won't change. Also, some non-POSIX
5015 systems don't update an empty file's time stamp when
5016 truncating it. Finally, file systems with 100 ns or worse
5017 resolution sometimes seem to have bugs: on a system with ns
5018 resolution, checking ns % 100 incorrectly avoids the heuristic
5019 1% of the time, but the problem should be temporary as we will
5020 try again on the next time stamp. */
5022 = ((open_flags
& (O_EXCL
| O_TRUNC
)) != 0
5024 && EMACS_NSECS (modtime
) % 100 != 0);
5026 EMACS_TIME modtime1
= get_stat_mtime (&st1
);
5028 && EMACS_TIME_EQ (modtime
, modtime1
)
5029 && st
.st_size
== st1
.st_size
)
5031 timestamp_file_system
= st
.st_dev
;
5032 valid_timestamp_file_system
= 1;
5036 st
.st_size
= st1
.st_size
;
5040 emacs_close (desc1
);
5044 /* Call write-region-post-annotation-function. */
5045 while (CONSP (Vwrite_region_annotation_buffers
))
5047 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
5048 if (!NILP (Fbuffer_live_p (buf
)))
5051 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
5052 call0 (Vwrite_region_post_annotation_function
);
5054 Vwrite_region_annotation_buffers
5055 = XCDR (Vwrite_region_annotation_buffers
);
5058 unbind_to (count
, Qnil
);
5060 #ifdef CLASH_DETECTION
5062 unlock_file (lockname
);
5063 #endif /* CLASH_DETECTION */
5065 /* Do this before reporting IO error
5066 to avoid a "file has changed on disk" warning on
5067 next attempt to save. */
5068 if (EMACS_TIME_VALID_P (modtime
))
5070 current_buffer
->modtime
= modtime
;
5071 current_buffer
->modtime_size
= st
.st_size
;
5075 error ("IO error writing %s: %s", SDATA (filename
),
5076 emacs_strerror (save_errno
));
5080 SAVE_MODIFF
= MODIFF
;
5081 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5082 bset_filename (current_buffer
, visit_file
);
5083 update_mode_lines
++;
5088 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
5089 BVAR (current_buffer
, auto_save_file_name
))))
5090 SAVE_MODIFF
= MODIFF
;
5096 message_with_string ((NUMBERP (append
)
5106 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
5108 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5109 doc
: /* Return t if (car A) is numerically less than (car B). */)
5110 (Lisp_Object a
, Lisp_Object b
)
5112 return Flss (Fcar (a
), Fcar (b
));
5115 /* Build the complete list of annotations appropriate for writing out
5116 the text between START and END, by calling all the functions in
5117 write-region-annotate-functions and merging the lists they return.
5118 If one of these functions switches to a different buffer, we assume
5119 that buffer contains altered text. Therefore, the caller must
5120 make sure to restore the current buffer in all cases,
5121 as save-excursion would do. */
5124 build_annotations (Lisp_Object start
, Lisp_Object end
)
5126 Lisp_Object annotations
;
5128 struct gcpro gcpro1
, gcpro2
;
5129 Lisp_Object original_buffer
;
5131 bool used_global
= 0;
5133 XSETBUFFER (original_buffer
, current_buffer
);
5136 p
= Vwrite_region_annotate_functions
;
5137 GCPRO2 (annotations
, p
);
5140 struct buffer
*given_buffer
= current_buffer
;
5141 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5142 { /* Use the global value of the hook. */
5145 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5147 p
= Fappend (2, arg
);
5150 Vwrite_region_annotations_so_far
= annotations
;
5151 res
= call2 (XCAR (p
), start
, end
);
5152 /* If the function makes a different buffer current,
5153 assume that means this buffer contains altered text to be output.
5154 Reset START and END from the buffer bounds
5155 and discard all previous annotations because they should have
5156 been dealt with by this function. */
5157 if (current_buffer
!= given_buffer
)
5159 Vwrite_region_annotation_buffers
5160 = Fcons (Fcurrent_buffer (),
5161 Vwrite_region_annotation_buffers
);
5162 XSETFASTINT (start
, BEGV
);
5163 XSETFASTINT (end
, ZV
);
5166 Flength (res
); /* Check basic validity of return value */
5167 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5171 /* Now do the same for annotation functions implied by the file-format */
5172 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
5173 p
= BVAR (current_buffer
, auto_save_file_format
);
5175 p
= BVAR (current_buffer
, file_format
);
5176 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5178 struct buffer
*given_buffer
= current_buffer
;
5180 Vwrite_region_annotations_so_far
= annotations
;
5182 /* Value is either a list of annotations or nil if the function
5183 has written annotations to a temporary buffer, which is now
5185 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5186 original_buffer
, make_number (i
));
5187 if (current_buffer
!= given_buffer
)
5189 XSETFASTINT (start
, BEGV
);
5190 XSETFASTINT (end
, ZV
);
5195 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5203 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5204 If STRING is nil, POS is the character position in the current buffer.
5205 Intersperse with them the annotations from *ANNOT
5206 which fall within the range of POS to POS + NCHARS,
5207 each at its appropriate position.
5209 We modify *ANNOT by discarding elements as we use them up.
5211 Return true if successful. */
5214 a_write (int desc
, Lisp_Object string
, ptrdiff_t pos
,
5215 ptrdiff_t nchars
, Lisp_Object
*annot
,
5216 struct coding_system
*coding
)
5220 ptrdiff_t lastpos
= pos
+ nchars
;
5222 while (NILP (*annot
) || CONSP (*annot
))
5224 tem
= Fcar_safe (Fcar (*annot
));
5227 nextpos
= XFASTINT (tem
);
5229 /* If there are no more annotations in this range,
5230 output the rest of the range all at once. */
5231 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5232 return e_write (desc
, string
, pos
, lastpos
, coding
);
5234 /* Output buffer text up to the next annotation's position. */
5237 if (!e_write (desc
, string
, pos
, nextpos
, coding
))
5241 /* Output the annotation. */
5242 tem
= Fcdr (Fcar (*annot
));
5245 if (!e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5248 *annot
= Fcdr (*annot
);
5254 /* Write text in the range START and END into descriptor DESC,
5255 encoding them with coding system CODING. If STRING is nil, START
5256 and END are character positions of the current buffer, else they
5257 are indexes to the string STRING. Return true if successful. */
5260 e_write (int desc
, Lisp_Object string
, ptrdiff_t start
, ptrdiff_t end
,
5261 struct coding_system
*coding
)
5263 if (STRINGP (string
))
5266 end
= SCHARS (string
);
5269 /* We used to have a code for handling selective display here. But,
5270 now it is handled within encode_coding. */
5274 if (STRINGP (string
))
5276 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5277 if (CODING_REQUIRE_ENCODING (coding
))
5279 encode_coding_object (coding
, string
,
5280 start
, string_char_to_byte (string
, start
),
5281 end
, string_char_to_byte (string
, end
), Qt
);
5285 coding
->dst_object
= string
;
5286 coding
->consumed_char
= SCHARS (string
);
5287 coding
->produced
= SBYTES (string
);
5292 ptrdiff_t start_byte
= CHAR_TO_BYTE (start
);
5293 ptrdiff_t end_byte
= CHAR_TO_BYTE (end
);
5295 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5296 if (CODING_REQUIRE_ENCODING (coding
))
5298 encode_coding_object (coding
, Fcurrent_buffer (),
5299 start
, start_byte
, end
, end_byte
, Qt
);
5303 coding
->dst_object
= Qnil
;
5304 coding
->dst_pos_byte
= start_byte
;
5305 if (start
>= GPT
|| end
<= GPT
)
5307 coding
->consumed_char
= end
- start
;
5308 coding
->produced
= end_byte
- start_byte
;
5312 coding
->consumed_char
= GPT
- start
;
5313 coding
->produced
= GPT_BYTE
- start_byte
;
5318 if (coding
->produced
> 0)
5320 char *buf
= (STRINGP (coding
->dst_object
)
5321 ? SSDATA (coding
->dst_object
)
5322 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
));
5323 coding
->produced
-= emacs_write_sig (desc
, buf
, coding
->produced
);
5325 if (coding
->produced
)
5328 start
+= coding
->consumed_char
;
5334 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5335 Sverify_visited_file_modtime
, 0, 1, 0,
5336 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5337 This means that the file has not been changed since it was visited or saved.
5338 If BUF is omitted or nil, it defaults to the current buffer.
5339 See Info node `(elisp)Modification Time' for more details. */)
5344 Lisp_Object handler
;
5345 Lisp_Object filename
;
5356 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5357 if (EMACS_NSECS (b
->modtime
) == UNKNOWN_MODTIME_NSECS
) return Qt
;
5359 /* If the file name has special constructs in it,
5360 call the corresponding file handler. */
5361 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5362 Qverify_visited_file_modtime
);
5363 if (!NILP (handler
))
5364 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5366 filename
= ENCODE_FILE (BVAR (b
, filename
));
5368 mtime
= (stat (SSDATA (filename
), &st
) == 0
5369 ? get_stat_mtime (&st
)
5370 : time_error_value (errno
));
5371 if (EMACS_TIME_EQ (mtime
, b
->modtime
)
5372 && (b
->modtime_size
< 0
5373 || st
.st_size
== b
->modtime_size
))
5378 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5379 Svisited_file_modtime
, 0, 0, 0,
5380 doc
: /* Return the current buffer's recorded visited file modification time.
5381 The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
5382 `file-attributes' returns. If the current buffer has no recorded file
5383 modification time, this function returns 0. If the visited file
5384 doesn't exist, return -1.
5385 See Info node `(elisp)Modification Time' for more details. */)
5388 int ns
= EMACS_NSECS (current_buffer
->modtime
);
5390 return make_number (UNKNOWN_MODTIME_NSECS
- ns
);
5391 return make_lisp_time (current_buffer
->modtime
);
5394 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5395 Sset_visited_file_modtime
, 0, 1, 0,
5396 doc
: /* Update buffer's recorded modification time from the visited file's time.
5397 Useful if the buffer was not read from the file normally
5398 or if the file itself has been changed for some known benign reason.
5399 An argument specifies the modification time value to use
5400 \(instead of that of the visited file), in the form of a list
5401 \(HIGH LOW USEC PSEC) or an integer flag as returned by
5402 `visited-file-modtime'. */)
5403 (Lisp_Object time_flag
)
5405 if (!NILP (time_flag
))
5408 if (INTEGERP (time_flag
))
5410 CHECK_RANGED_INTEGER (time_flag
, -1, 0);
5411 mtime
= make_emacs_time (0, UNKNOWN_MODTIME_NSECS
- XINT (time_flag
));
5414 mtime
= lisp_time_argument (time_flag
);
5416 current_buffer
->modtime
= mtime
;
5417 current_buffer
->modtime_size
= -1;
5421 register Lisp_Object filename
;
5423 Lisp_Object handler
;
5425 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5427 /* If the file name has special constructs in it,
5428 call the corresponding file handler. */
5429 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5430 if (!NILP (handler
))
5431 /* The handler can find the file name the same way we did. */
5432 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5434 filename
= ENCODE_FILE (filename
);
5436 if (stat (SSDATA (filename
), &st
) >= 0)
5438 current_buffer
->modtime
= get_stat_mtime (&st
);
5439 current_buffer
->modtime_size
= st
.st_size
;
5447 auto_save_error (Lisp_Object error_val
)
5449 Lisp_Object args
[3], msg
;
5451 struct gcpro gcpro1
;
5453 auto_save_error_occurred
= 1;
5455 ring_bell (XFRAME (selected_frame
));
5457 args
[0] = build_string ("Auto-saving %s: %s");
5458 args
[1] = BVAR (current_buffer
, name
);
5459 args
[2] = Ferror_message_string (error_val
);
5460 msg
= Fformat (3, args
);
5463 for (i
= 0; i
< 3; ++i
)
5468 message3_nolog (msg
);
5469 Fsleep_for (make_number (1), Qnil
);
5482 auto_save_mode_bits
= 0666;
5484 /* Get visited file's mode to become the auto save file's mode. */
5485 if (! NILP (BVAR (current_buffer
, filename
)))
5487 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5488 /* But make sure we can overwrite it later! */
5489 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5490 else if (modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5492 /* Remote files don't cooperate with stat. */
5493 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5497 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5498 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5503 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5506 FILE *stream
= XSAVE_POINTER (arg
, 0);
5518 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5521 minibuffer_auto_raise
= XINT (value
);
5526 do_auto_save_make_dir (Lisp_Object dir
)
5530 auto_saving_dir_umask
= 077;
5531 result
= call2 (Qmake_directory
, dir
, Qt
);
5532 auto_saving_dir_umask
= 0;
5537 do_auto_save_eh (Lisp_Object ignore
)
5539 auto_saving_dir_umask
= 0;
5543 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5544 doc
: /* Auto-save all buffers that need it.
5545 This is all buffers that have auto-saving enabled
5546 and are changed since last auto-saved.
5547 Auto-saving writes the buffer into a file
5548 so that your editing is not lost if the system crashes.
5549 This file is not the file you visited; that changes only when you save.
5550 Normally we run the normal hook `auto-save-hook' before saving.
5552 A non-nil NO-MESSAGE argument means do not print any message if successful.
5553 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5554 (Lisp_Object no_message
, Lisp_Object current_only
)
5556 struct buffer
*old
= current_buffer
, *b
;
5557 Lisp_Object tail
, buf
, hook
;
5558 bool auto_saved
= 0;
5559 int do_handled_files
;
5561 FILE *stream
= NULL
;
5562 ptrdiff_t count
= SPECPDL_INDEX ();
5563 bool orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5564 bool old_message_p
= 0;
5565 struct gcpro gcpro1
, gcpro2
;
5567 if (max_specpdl_size
< specpdl_size
+ 40)
5568 max_specpdl_size
= specpdl_size
+ 40;
5573 if (NILP (no_message
))
5575 old_message_p
= push_message ();
5576 record_unwind_protect (pop_message_unwind
, Qnil
);
5579 /* Ordinarily don't quit within this function,
5580 but don't make it impossible to quit (in case we get hung in I/O). */
5584 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5585 point to non-strings reached from Vbuffer_alist. */
5587 hook
= intern ("auto-save-hook");
5588 safe_run_hooks (hook
);
5590 if (STRINGP (Vauto_save_list_file_name
))
5592 Lisp_Object listfile
;
5594 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5596 /* Don't try to create the directory when shutting down Emacs,
5597 because creating the directory might signal an error, and
5598 that would leave Emacs in a strange state. */
5599 if (!NILP (Vrun_hooks
))
5603 GCPRO2 (dir
, listfile
);
5604 dir
= Ffile_name_directory (listfile
);
5605 if (NILP (Ffile_directory_p (dir
)))
5606 internal_condition_case_1 (do_auto_save_make_dir
,
5612 stream
= emacs_fopen (SSDATA (listfile
), "w");
5615 record_unwind_protect (do_auto_save_unwind
,
5616 make_save_pointer (stream
));
5617 record_unwind_protect (do_auto_save_unwind_1
,
5618 make_number (minibuffer_auto_raise
));
5619 minibuffer_auto_raise
= 0;
5621 auto_save_error_occurred
= 0;
5623 /* On first pass, save all files that don't have handlers.
5624 On second pass, save all files that do have handlers.
5626 If Emacs is crashing, the handlers may tweak what is causing
5627 Emacs to crash in the first place, and it would be a shame if
5628 Emacs failed to autosave perfectly ordinary files because it
5629 couldn't handle some ange-ftp'd file. */
5631 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5632 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5634 buf
= XCDR (XCAR (tail
));
5637 /* Record all the buffers that have auto save mode
5638 in the special file that lists them. For each of these buffers,
5639 Record visited name (if any) and auto save name. */
5640 if (STRINGP (BVAR (b
, auto_save_file_name
))
5641 && stream
!= NULL
&& do_handled_files
== 0)
5644 if (!NILP (BVAR (b
, filename
)))
5646 fwrite (SDATA (BVAR (b
, filename
)), 1,
5647 SBYTES (BVAR (b
, filename
)), stream
);
5649 putc ('\n', stream
);
5650 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5651 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5652 putc ('\n', stream
);
5656 if (!NILP (current_only
)
5657 && b
!= current_buffer
)
5660 /* Don't auto-save indirect buffers.
5661 The base buffer takes care of it. */
5665 /* Check for auto save enabled
5666 and file changed since last auto save
5667 and file changed since last real save. */
5668 if (STRINGP (BVAR (b
, auto_save_file_name
))
5669 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5670 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5671 /* -1 means we've turned off autosaving for a while--see below. */
5672 && XINT (BVAR (b
, save_length
)) >= 0
5673 && (do_handled_files
5674 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5677 EMACS_TIME before_time
= current_emacs_time ();
5678 EMACS_TIME after_time
;
5680 /* If we had a failure, don't try again for 20 minutes. */
5681 if (b
->auto_save_failure_time
> 0
5682 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5685 set_buffer_internal (b
);
5686 if (NILP (Vauto_save_include_big_deletions
)
5687 && (XFASTINT (BVAR (b
, save_length
)) * 10
5688 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5689 /* A short file is likely to change a large fraction;
5690 spare the user annoying messages. */
5691 && XFASTINT (BVAR (b
, save_length
)) > 5000
5692 /* These messages are frequent and annoying for `*mail*'. */
5693 && !EQ (BVAR (b
, filename
), Qnil
)
5694 && NILP (no_message
))
5696 /* It has shrunk too much; turn off auto-saving here. */
5697 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5698 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5700 minibuffer_auto_raise
= 0;
5701 /* Turn off auto-saving until there's a real save,
5702 and prevent any more warnings. */
5703 XSETINT (BVAR (b
, save_length
), -1);
5704 Fsleep_for (make_number (1), Qnil
);
5707 if (!auto_saved
&& NILP (no_message
))
5708 message1 ("Auto-saving...");
5709 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5711 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5712 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5713 set_buffer_internal (old
);
5715 after_time
= current_emacs_time ();
5717 /* If auto-save took more than 60 seconds,
5718 assume it was an NFS failure that got a timeout. */
5719 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5720 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5724 /* Prevent another auto save till enough input events come in. */
5725 record_auto_save ();
5727 if (auto_saved
&& NILP (no_message
))
5731 /* If we are going to restore an old message,
5732 give time to read ours. */
5733 sit_for (make_number (1), 0, 0);
5736 else if (!auto_save_error_occurred
)
5737 /* Don't overwrite the error message if an error occurred.
5738 If we displayed a message and then restored a state
5739 with no message, leave a "done" message on the screen. */
5740 message1 ("Auto-saving...done");
5745 /* This restores the message-stack status. */
5746 unbind_to (count
, Qnil
);
5750 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5751 Sset_buffer_auto_saved
, 0, 0, 0,
5752 doc
: /* Mark current buffer as auto-saved with its current text.
5753 No auto-save file will be written until the buffer changes again. */)
5756 /* FIXME: This should not be called in indirect buffers, since
5757 they're not autosaved. */
5758 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5759 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5760 current_buffer
->auto_save_failure_time
= 0;
5764 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5765 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5766 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5769 current_buffer
->auto_save_failure_time
= 0;
5773 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5775 doc
: /* Return t if current buffer has been auto-saved recently.
5776 More precisely, if it has been auto-saved since last read from or saved
5777 in the visited file. If the buffer has no visited file,
5778 then any auto-save counts as "recent". */)
5781 /* FIXME: maybe we should return nil for indirect buffers since
5782 they're never autosaved. */
5783 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5786 /* Reading and completing file names */
5788 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5789 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5790 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5791 The return value is only relevant for a call to `read-file-name' that happens
5792 before any other event (mouse or keypress) is handled. */)
5795 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5796 || defined (HAVE_NS)
5797 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5800 && window_system_available (SELECTED_FRAME ()))
5807 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5809 struct gcpro gcpro1
;
5810 Lisp_Object args
[7];
5812 GCPRO1 (default_filename
);
5813 args
[0] = intern ("read-file-name");
5816 args
[3] = default_filename
;
5817 args
[4] = mustmatch
;
5819 args
[6] = predicate
;
5820 RETURN_UNGCPRO (Ffuncall (7, args
));
5827 valid_timestamp_file_system
= 0;
5831 syms_of_fileio (void)
5833 DEFSYM (Qoperations
, "operations");
5834 DEFSYM (Qexpand_file_name
, "expand-file-name");
5835 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5836 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5837 DEFSYM (Qfile_name_directory
, "file-name-directory");
5838 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5839 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5840 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5841 DEFSYM (Qcopy_file
, "copy-file");
5842 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5843 DEFSYM (Qmake_directory
, "make-directory");
5844 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5845 DEFSYM (Qdelete_file
, "delete-file");
5846 DEFSYM (Qrename_file
, "rename-file");
5847 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5848 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5849 DEFSYM (Qfile_exists_p
, "file-exists-p");
5850 DEFSYM (Qfile_executable_p
, "file-executable-p");
5851 DEFSYM (Qfile_readable_p
, "file-readable-p");
5852 DEFSYM (Qfile_writable_p
, "file-writable-p");
5853 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5854 DEFSYM (Qaccess_file
, "access-file");
5855 DEFSYM (Qfile_directory_p
, "file-directory-p");
5856 DEFSYM (Qfile_regular_p
, "file-regular-p");
5857 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5858 DEFSYM (Qfile_modes
, "file-modes");
5859 DEFSYM (Qset_file_modes
, "set-file-modes");
5860 DEFSYM (Qset_file_times
, "set-file-times");
5861 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5862 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5863 DEFSYM (Qfile_acl
, "file-acl");
5864 DEFSYM (Qset_file_acl
, "set-file-acl");
5865 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5866 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5867 DEFSYM (Qchoose_write_coding_system
, "choose-write-coding-system");
5868 DEFSYM (Qwrite_region
, "write-region");
5869 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5870 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5871 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5873 DEFSYM (Qfile_name_history
, "file-name-history");
5874 Fset (Qfile_name_history
, Qnil
);
5876 DEFSYM (Qfile_error
, "file-error");
5877 DEFSYM (Qfile_already_exists
, "file-already-exists");
5878 DEFSYM (Qfile_date_error
, "file-date-error");
5879 DEFSYM (Qfile_notify_error
, "file-notify-error");
5880 DEFSYM (Qexcl
, "excl");
5882 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5883 doc
: /* Coding system for encoding file names.
5884 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5885 Vfile_name_coding_system
= Qnil
;
5887 DEFVAR_LISP ("default-file-name-coding-system",
5888 Vdefault_file_name_coding_system
,
5889 doc
: /* Default coding system for encoding file names.
5890 This variable is used only when `file-name-coding-system' is nil.
5892 This variable is set/changed by the command `set-language-environment'.
5893 User should not set this variable manually,
5894 instead use `file-name-coding-system' to get a constant encoding
5895 of file names regardless of the current language environment. */);
5896 Vdefault_file_name_coding_system
= Qnil
;
5898 DEFSYM (Qformat_decode
, "format-decode");
5899 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5900 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5901 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5903 Fput (Qfile_error
, Qerror_conditions
,
5904 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5905 Fput (Qfile_error
, Qerror_message
,
5906 build_pure_c_string ("File error"));
5908 Fput (Qfile_already_exists
, Qerror_conditions
,
5909 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5910 Fput (Qfile_already_exists
, Qerror_message
,
5911 build_pure_c_string ("File already exists"));
5913 Fput (Qfile_date_error
, Qerror_conditions
,
5914 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5915 Fput (Qfile_date_error
, Qerror_message
,
5916 build_pure_c_string ("Cannot set file date"));
5918 Fput (Qfile_notify_error
, Qerror_conditions
,
5919 Fpurecopy (list3 (Qfile_notify_error
, Qfile_error
, Qerror
)));
5920 Fput (Qfile_notify_error
, Qerror_message
,
5921 build_pure_c_string ("File notification error"));
5923 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5924 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5925 If a file name matches REGEXP, all I/O on that file is done by calling
5926 HANDLER. If a file name matches more than one handler, the handler
5927 whose match starts last in the file name gets precedence. The
5928 function `find-file-name-handler' checks this list for a handler for
5931 HANDLER should be a function. The first argument given to it is the
5932 name of the I/O primitive to be handled; the remaining arguments are
5933 the arguments that were passed to that primitive. For example, if you
5934 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5935 HANDLER is called like this:
5937 (funcall HANDLER 'file-exists-p FILENAME)
5939 Note that HANDLER must be able to handle all I/O primitives; if it has
5940 nothing special to do for a primitive, it should reinvoke the
5941 primitive to handle the operation \"the usual way\".
5942 See Info node `(elisp)Magic File Names' for more details. */);
5943 Vfile_name_handler_alist
= Qnil
;
5945 DEFVAR_LISP ("set-auto-coding-function",
5946 Vset_auto_coding_function
,
5947 doc
: /* If non-nil, a function to call to decide a coding system of file.
5948 Two arguments are passed to this function: the file name
5949 and the length of a file contents following the point.
5950 This function should return a coding system to decode the file contents.
5951 It should check the file name against `auto-coding-alist'.
5952 If no coding system is decided, it should check a coding system
5953 specified in the heading lines with the format:
5954 -*- ... coding: CODING-SYSTEM; ... -*-
5955 or local variable spec of the tailing lines with `coding:' tag. */);
5956 Vset_auto_coding_function
= Qnil
;
5958 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5959 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5960 Each is passed one argument, the number of characters inserted,
5961 with point at the start of the inserted text. Each function
5962 should leave point the same, and return the new character count.
5963 If `insert-file-contents' is intercepted by a handler from
5964 `file-name-handler-alist', that handler is responsible for calling the
5965 functions in `after-insert-file-functions' if appropriate. */);
5966 Vafter_insert_file_functions
= Qnil
;
5968 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5969 doc
: /* A list of functions to be called at the start of `write-region'.
5970 Each is passed two arguments, START and END as for `write-region'.
5971 These are usually two numbers but not always; see the documentation
5972 for `write-region'. The function should return a list of pairs
5973 of the form (POSITION . STRING), consisting of strings to be effectively
5974 inserted at the specified positions of the file being written (1 means to
5975 insert before the first byte written). The POSITIONs must be sorted into
5978 If there are several annotation functions, the lists returned by these
5979 functions are merged destructively. As each annotation function runs,
5980 the variable `write-region-annotations-so-far' contains a list of all
5981 annotations returned by previous annotation functions.
5983 An annotation function can return with a different buffer current.
5984 Doing so removes the annotations returned by previous functions, and
5985 resets START and END to `point-min' and `point-max' of the new buffer.
5987 After `write-region' completes, Emacs calls the function stored in
5988 `write-region-post-annotation-function', once for each buffer that was
5989 current when building the annotations (i.e., at least once), with that
5990 buffer current. */);
5991 Vwrite_region_annotate_functions
= Qnil
;
5992 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5994 DEFVAR_LISP ("write-region-post-annotation-function",
5995 Vwrite_region_post_annotation_function
,
5996 doc
: /* Function to call after `write-region' completes.
5997 The function is called with no arguments. If one or more of the
5998 annotation functions in `write-region-annotate-functions' changed the
5999 current buffer, the function stored in this variable is called for
6000 each of those additional buffers as well, in addition to the original
6001 buffer. The relevant buffer is current during each function call. */);
6002 Vwrite_region_post_annotation_function
= Qnil
;
6003 staticpro (&Vwrite_region_annotation_buffers
);
6005 DEFVAR_LISP ("write-region-annotations-so-far",
6006 Vwrite_region_annotations_so_far
,
6007 doc
: /* When an annotation function is called, this holds the previous annotations.
6008 These are the annotations made by other annotation functions
6009 that were already called. See also `write-region-annotate-functions'. */);
6010 Vwrite_region_annotations_so_far
= Qnil
;
6012 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
6013 doc
: /* A list of file name handlers that temporarily should not be used.
6014 This applies only to the operation `inhibit-file-name-operation'. */);
6015 Vinhibit_file_name_handlers
= Qnil
;
6017 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
6018 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6019 Vinhibit_file_name_operation
= Qnil
;
6021 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
6022 doc
: /* File name in which we write a list of all auto save file names.
6023 This variable is initialized automatically from `auto-save-list-file-prefix'
6024 shortly after Emacs reads your init file, if you have not yet given it
6025 a non-nil value. */);
6026 Vauto_save_list_file_name
= Qnil
;
6028 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
6029 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
6030 Normally auto-save files are written under other names. */);
6031 Vauto_save_visited_file_name
= Qnil
;
6033 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
6034 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
6035 If nil, deleting a substantial portion of the text disables auto-save
6036 in the buffer; this is the default behavior, because the auto-save
6037 file is usually more useful if it contains the deleted text. */);
6038 Vauto_save_include_big_deletions
= Qnil
;
6040 /* fsync can be a significant performance hit. Often it doesn't
6041 suffice to make the file-save operation survive a crash. For
6042 batch scripts, which are typically part of larger shell commands
6043 that don't fsync other files, its effect on performance can be
6044 significant so its utility is particularly questionable.
6045 Hence, for now by default fsync is used only when interactive.
6047 For more on why fsync often fails to work on today's hardware, see:
6048 Zheng M et al. Understanding the robustness of SSDs under power fault.
6049 11th USENIX Conf. on File and Storage Technologies, 2013 (FAST '13), 271-84
6050 http://www.usenix.org/system/files/conference/fast13/fast13-final80.pdf
6052 For more on why fsync does not suffice even if it works properly, see:
6053 Roche X. Necessary step(s) to synchronize filename operations on disk.
6054 Austin Group Defect 672, 2013-03-19
6055 http://austingroupbugs.net/view.php?id=672 */
6056 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
6057 doc
: /* Non-nil means don't call fsync in `write-region'.
6058 This variable affects calls to `write-region' as well as save commands.
6059 Setting this to nil may avoid data loss if the system loses power or
6060 the operating system crashes. */);
6061 write_region_inhibit_fsync
= noninteractive
;
6063 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
6064 doc
: /* Specifies whether to use the system's trash can.
6065 When non-nil, certain file deletion commands use the function
6066 `move-file-to-trash' instead of deleting files outright.
6067 This includes interactive calls to `delete-file' and
6068 `delete-directory' and the Dired deletion commands. */);
6069 delete_by_moving_to_trash
= 0;
6070 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
6072 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
6073 DEFSYM (Qcopy_directory
, "copy-directory");
6074 DEFSYM (Qdelete_directory
, "delete-directory");
6076 defsubr (&Sfind_file_name_handler
);
6077 defsubr (&Sfile_name_directory
);
6078 defsubr (&Sfile_name_nondirectory
);
6079 defsubr (&Sunhandled_file_name_directory
);
6080 defsubr (&Sfile_name_as_directory
);
6081 defsubr (&Sdirectory_file_name
);
6082 defsubr (&Smake_temp_name
);
6083 defsubr (&Sexpand_file_name
);
6084 defsubr (&Ssubstitute_in_file_name
);
6085 defsubr (&Scopy_file
);
6086 defsubr (&Smake_directory_internal
);
6087 defsubr (&Sdelete_directory_internal
);
6088 defsubr (&Sdelete_file
);
6089 defsubr (&Srename_file
);
6090 defsubr (&Sadd_name_to_file
);
6091 defsubr (&Smake_symbolic_link
);
6092 defsubr (&Sfile_name_absolute_p
);
6093 defsubr (&Sfile_exists_p
);
6094 defsubr (&Sfile_executable_p
);
6095 defsubr (&Sfile_readable_p
);
6096 defsubr (&Sfile_writable_p
);
6097 defsubr (&Saccess_file
);
6098 defsubr (&Sfile_symlink_p
);
6099 defsubr (&Sfile_directory_p
);
6100 defsubr (&Sfile_accessible_directory_p
);
6101 defsubr (&Sfile_regular_p
);
6102 defsubr (&Sfile_modes
);
6103 defsubr (&Sset_file_modes
);
6104 defsubr (&Sset_file_times
);
6105 defsubr (&Sfile_selinux_context
);
6106 defsubr (&Sfile_acl
);
6107 defsubr (&Sset_file_acl
);
6108 defsubr (&Sset_file_selinux_context
);
6109 defsubr (&Sset_default_file_modes
);
6110 defsubr (&Sdefault_file_modes
);
6111 defsubr (&Sfile_newer_than_file_p
);
6112 defsubr (&Sinsert_file_contents
);
6113 defsubr (&Schoose_write_coding_system
);
6114 defsubr (&Swrite_region
);
6115 defsubr (&Scar_less_than_car
);
6116 defsubr (&Sverify_visited_file_modtime
);
6117 defsubr (&Svisited_file_modtime
);
6118 defsubr (&Sset_visited_file_modtime
);
6119 defsubr (&Sdo_auto_save
);
6120 defsubr (&Sset_buffer_auto_saved
);
6121 defsubr (&Sclear_buffer_auto_save_failure
);
6122 defsubr (&Srecent_auto_save_p
);
6124 defsubr (&Snext_read_file_uses_dialog_p
);
6127 defsubr (&Sunix_sync
);