1 /* File IO for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 #include <sys/types.h>
36 #ifdef HAVE_LIBSELINUX
37 #include <selinux/selinux.h>
38 #include <selinux/context.h>
42 #include "intervals.h"
44 #include "character.h"
47 #include "blockinput.h"
49 #include "dispextern.h"
55 #endif /* not WINDOWSNT */
59 #include <sys/param.h>
64 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
65 redirector allows the six letters between 'Z' and 'a' as well. */
67 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
70 #define IS_DRIVE(x) isalpha ((unsigned char) (x))
72 /* Need to lower-case the drive letter, or else expanded
73 filenames will sometimes compare unequal, because
74 `expand-file-name' doesn't always down-case the drive letter. */
75 #define DRIVE_LETTER(x) (tolower ((unsigned char) (x)))
86 #ifndef FILE_SYSTEM_CASE
87 #define FILE_SYSTEM_CASE(filename) (filename)
90 /* Nonzero during writing of auto-save files */
91 static int auto_saving
;
93 /* Nonzero umask during creation of auto-save directories */
94 static int auto_saving_dir_umask
;
96 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
97 a new file with the same mode as the original */
98 static int auto_save_mode_bits
;
100 /* Set by auto_save_1 if an error occurred during the last auto-save. */
101 static int auto_save_error_occurred
;
103 /* The symbol bound to coding-system-for-read when
104 insert-file-contents is called for recovering a file. This is not
105 an actual coding system name, but just an indicator to tell
106 insert-file-contents to use `emacs-mule' with a special flag for
107 auto saving and recovering a file. */
108 static Lisp_Object Qauto_save_coding
;
110 /* Property name of a file name handler,
111 which gives a list of operations it handles.. */
112 static Lisp_Object Qoperations
;
114 /* Lisp functions for translating file formats */
115 static Lisp_Object Qformat_decode
, Qformat_annotate_function
;
117 /* Lisp function for setting buffer-file-coding-system and the
118 multibyteness of the current buffer after inserting a file. */
119 static Lisp_Object Qafter_insert_file_set_coding
;
121 static Lisp_Object Qwrite_region_annotate_functions
;
122 /* Each time an annotation function changes the buffer, the new buffer
124 static Lisp_Object Vwrite_region_annotation_buffers
;
129 static Lisp_Object Qdelete_by_moving_to_trash
;
131 /* Lisp function for moving files to trash. */
132 static Lisp_Object Qmove_file_to_trash
;
134 /* Lisp function for recursively copying directories. */
135 static Lisp_Object Qcopy_directory
;
137 /* Lisp function for recursively deleting directories. */
138 static Lisp_Object Qdelete_directory
;
143 Lisp_Object Qfile_error
;
144 static Lisp_Object Qfile_already_exists
, Qfile_date_error
;
145 static Lisp_Object Qexcl
;
146 Lisp_Object Qfile_name_history
;
148 static Lisp_Object Qcar_less_than_car
;
150 static Lisp_Object
Fmake_symbolic_link (Lisp_Object
, Lisp_Object
, Lisp_Object
);
151 static int a_write (int, Lisp_Object
, EMACS_INT
, EMACS_INT
,
152 Lisp_Object
*, struct coding_system
*);
153 static int e_write (int, Lisp_Object
, EMACS_INT
, EMACS_INT
,
154 struct coding_system
*);
158 report_file_error (const char *string
, Lisp_Object data
)
160 Lisp_Object errstring
;
164 synchronize_system_messages_locale ();
165 str
= strerror (errorno
);
166 errstring
= code_convert_string_norecord (make_unibyte_string (str
,
168 Vlocale_coding_system
, 0);
174 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
177 /* System error messages are capitalized. Downcase the initial
178 unless it is followed by a slash. (The slash case caters to
179 error messages that begin with "I/O" or, in German, "E/A".) */
180 if (STRING_MULTIBYTE (errstring
)
181 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
185 str
= SSDATA (errstring
);
186 c
= STRING_CHAR ((unsigned char *) str
);
187 Faset (errstring
, make_number (0), make_number (downcase (c
)));
190 xsignal (Qfile_error
,
191 Fcons (build_string (string
), Fcons (errstring
, data
)));
196 close_file_unwind (Lisp_Object fd
)
198 emacs_close (XFASTINT (fd
));
202 /* Restore point, having saved it as a marker. */
205 restore_point_unwind (Lisp_Object location
)
207 Fgoto_char (location
);
208 Fset_marker (location
, Qnil
, Qnil
);
213 static Lisp_Object Qexpand_file_name
;
214 static Lisp_Object Qsubstitute_in_file_name
;
215 static Lisp_Object Qdirectory_file_name
;
216 static Lisp_Object Qfile_name_directory
;
217 static Lisp_Object Qfile_name_nondirectory
;
218 static Lisp_Object Qunhandled_file_name_directory
;
219 static Lisp_Object Qfile_name_as_directory
;
220 static Lisp_Object Qcopy_file
;
221 static Lisp_Object Qmake_directory_internal
;
222 static Lisp_Object Qmake_directory
;
223 static Lisp_Object Qdelete_directory_internal
;
224 Lisp_Object Qdelete_file
;
225 static Lisp_Object Qrename_file
;
226 static Lisp_Object Qadd_name_to_file
;
227 static Lisp_Object Qmake_symbolic_link
;
228 Lisp_Object Qfile_exists_p
;
229 static Lisp_Object Qfile_executable_p
;
230 static Lisp_Object Qfile_readable_p
;
231 static Lisp_Object Qfile_writable_p
;
232 static Lisp_Object Qfile_symlink_p
;
233 static Lisp_Object Qaccess_file
;
234 Lisp_Object Qfile_directory_p
;
235 static Lisp_Object Qfile_regular_p
;
236 static Lisp_Object Qfile_accessible_directory_p
;
237 static Lisp_Object Qfile_modes
;
238 static Lisp_Object Qset_file_modes
;
239 static Lisp_Object Qset_file_times
;
240 static Lisp_Object Qfile_selinux_context
;
241 static Lisp_Object Qset_file_selinux_context
;
242 static Lisp_Object Qfile_newer_than_file_p
;
243 Lisp_Object Qinsert_file_contents
;
244 Lisp_Object Qwrite_region
;
245 static Lisp_Object Qverify_visited_file_modtime
;
246 static Lisp_Object Qset_visited_file_modtime
;
248 DEFUN ("find-file-name-handler", Ffind_file_name_handler
,
249 Sfind_file_name_handler
, 2, 2, 0,
250 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
251 Otherwise, return nil.
252 A file name is handled if one of the regular expressions in
253 `file-name-handler-alist' matches it.
255 If OPERATION equals `inhibit-file-name-operation', then we ignore
256 any handlers that are members of `inhibit-file-name-handlers',
257 but we still do run any other handlers. This lets handlers
258 use the standard functions without calling themselves recursively. */)
259 (Lisp_Object filename
, Lisp_Object operation
)
261 /* This function must not munge the match data. */
262 Lisp_Object chain
, inhibited_handlers
, result
;
266 CHECK_STRING (filename
);
268 if (EQ (operation
, Vinhibit_file_name_operation
))
269 inhibited_handlers
= Vinhibit_file_name_handlers
;
271 inhibited_handlers
= Qnil
;
273 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
274 chain
= XCDR (chain
))
280 Lisp_Object string
= XCAR (elt
);
282 Lisp_Object handler
= XCDR (elt
);
283 Lisp_Object operations
= Qnil
;
285 if (SYMBOLP (handler
))
286 operations
= Fget (handler
, Qoperations
);
289 && (match_pos
= fast_string_match (string
, filename
)) > pos
290 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
294 handler
= XCDR (elt
);
295 tem
= Fmemq (handler
, inhibited_handlers
);
309 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
311 doc
: /* Return the directory component in file name FILENAME.
312 Return nil if FILENAME does not include a directory.
313 Otherwise return a directory name.
314 Given a Unix syntax file name, returns a string ending in slash. */)
315 (Lisp_Object filename
)
318 register const char *beg
;
322 register const char *p
;
325 CHECK_STRING (filename
);
327 /* If the file name has special constructs in it,
328 call the corresponding file handler. */
329 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
332 Lisp_Object handled_name
= call2 (handler
, Qfile_name_directory
,
334 return STRINGP (handled_name
) ? handled_name
: Qnil
;
337 filename
= FILE_SYSTEM_CASE (filename
);
339 beg
= (char *) alloca (SBYTES (filename
) + 1);
340 memcpy (beg
, SSDATA (filename
), SBYTES (filename
) + 1);
342 beg
= SSDATA (filename
);
344 p
= beg
+ SBYTES (filename
);
346 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
348 /* only recognize drive specifier at the beginning */
350 /* handle the "/:d:foo" and "/:foo" cases correctly */
351 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
352 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
359 /* Expansion of "c:" to drive and default directory. */
362 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
363 char *res
= alloca (MAXPATHLEN
+ 1);
366 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
368 strncpy (res
, beg
, 2);
373 if (getdefdir (toupper ((unsigned char) *beg
) - 'A' + 1, r
))
375 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
378 p
= beg
+ strlen (beg
);
381 dostounix_filename (beg
);
384 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
387 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
388 Sfile_name_nondirectory
, 1, 1, 0,
389 doc
: /* Return file name FILENAME sans its directory.
390 For example, in a Unix-syntax file name,
391 this is everything after the last slash,
392 or the entire name if it contains no slash. */)
393 (Lisp_Object filename
)
395 register const char *beg
, *p
, *end
;
398 CHECK_STRING (filename
);
400 /* If the file name has special constructs in it,
401 call the corresponding file handler. */
402 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
405 Lisp_Object handled_name
= call2 (handler
, Qfile_name_nondirectory
,
407 if (STRINGP (handled_name
))
409 error ("Invalid handler in `file-name-handler-alist'");
412 beg
= SSDATA (filename
);
413 end
= p
= beg
+ SBYTES (filename
);
415 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
417 /* only recognize drive specifier at beginning */
419 /* handle the "/:d:foo" case correctly */
420 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
425 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
428 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
429 Sunhandled_file_name_directory
, 1, 1, 0,
430 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
431 A `directly usable' directory name is one that may be used without the
432 intervention of any file handler.
433 If FILENAME is a directly usable file itself, return
434 \(file-name-directory FILENAME).
435 If FILENAME refers to a file which is not accessible from a local process,
436 then this should return nil.
437 The `call-process' and `start-process' functions use this function to
438 get a current directory to run processes in. */)
439 (Lisp_Object filename
)
443 /* If the file name has special constructs in it,
444 call the corresponding file handler. */
445 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
448 Lisp_Object handled_name
= call2 (handler
, Qunhandled_file_name_directory
,
450 return STRINGP (handled_name
) ? handled_name
: Qnil
;
453 return Ffile_name_directory (filename
);
458 file_name_as_directory (char *out
, const char *in
)
460 ptrdiff_t len
= strlen (in
);
472 /* For Unix syntax, Append a slash if necessary */
473 if (!IS_DIRECTORY_SEP (out
[len
- 1]))
475 out
[len
] = DIRECTORY_SEP
;
479 dostounix_filename (out
);
484 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
485 Sfile_name_as_directory
, 1, 1, 0,
486 doc
: /* Return a string representing the file name FILE interpreted as a directory.
487 This operation exists because a directory is also a file, but its name as
488 a directory is different from its name as a file.
489 The result can be used as the value of `default-directory'
490 or passed as second argument to `expand-file-name'.
491 For a Unix-syntax file name, just appends a slash. */)
501 /* If the file name has special constructs in it,
502 call the corresponding file handler. */
503 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
506 Lisp_Object handled_name
= call2 (handler
, Qfile_name_as_directory
,
508 if (STRINGP (handled_name
))
510 error ("Invalid handler in `file-name-handler-alist'");
513 buf
= (char *) alloca (SBYTES (file
) + 10);
514 file_name_as_directory (buf
, SSDATA (file
));
515 return make_specified_string (buf
, -1, strlen (buf
),
516 STRING_MULTIBYTE (file
));
520 * Convert from directory name to filename.
521 * On UNIX, it's simple: just make sure there isn't a terminating /
523 * Value is nonzero if the string output is different from the input.
527 directory_file_name (char *src
, char *dst
)
533 /* Process as Unix format: just remove any final slash.
534 But leave "/" unchanged; do not change it to "". */
537 && IS_DIRECTORY_SEP (dst
[slen
- 1])
539 && !IS_ANY_SEP (dst
[slen
- 2])
544 dostounix_filename (dst
);
549 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
551 doc
: /* Returns the file name of the directory named DIRECTORY.
552 This is the name of the file that holds the data for the directory DIRECTORY.
553 This operation exists because a directory is also a file, but its name as
554 a directory is different from its name as a file.
555 In Unix-syntax, this function just removes the final slash. */)
556 (Lisp_Object directory
)
561 CHECK_STRING (directory
);
563 if (NILP (directory
))
566 /* If the file name has special constructs in it,
567 call the corresponding file handler. */
568 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
571 Lisp_Object handled_name
= call2 (handler
, Qdirectory_file_name
,
573 if (STRINGP (handled_name
))
575 error ("Invalid handler in `file-name-handler-alist'");
578 buf
= (char *) alloca (SBYTES (directory
) + 20);
579 directory_file_name (SSDATA (directory
), buf
);
580 return make_specified_string (buf
, -1, strlen (buf
),
581 STRING_MULTIBYTE (directory
));
584 static const char make_temp_name_tbl
[64] =
586 'A','B','C','D','E','F','G','H',
587 'I','J','K','L','M','N','O','P',
588 'Q','R','S','T','U','V','W','X',
589 'Y','Z','a','b','c','d','e','f',
590 'g','h','i','j','k','l','m','n',
591 'o','p','q','r','s','t','u','v',
592 'w','x','y','z','0','1','2','3',
593 '4','5','6','7','8','9','-','_'
596 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
598 /* Value is a temporary file name starting with PREFIX, a string.
600 The Emacs process number forms part of the result, so there is
601 no danger of generating a name being used by another process.
602 In addition, this function makes an attempt to choose a name
603 which has no existing file. To make this work, PREFIX should be
604 an absolute file name.
606 BASE64_P non-zero means add the pid as 3 characters in base64
607 encoding. In this case, 6 characters will be added to PREFIX to
608 form the file name. Otherwise, if Emacs is running on a system
609 with long file names, add the pid as a decimal number.
611 This function signals an error if no unique file name could be
615 make_temp_name (Lisp_Object prefix
, int base64_p
)
621 char pidbuf
[INT_BUFSIZE_BOUND (printmax_t
)];
624 CHECK_STRING (prefix
);
626 /* VAL is created by adding 6 characters to PREFIX. The first
627 three are the PID of this process, in base 64, and the second
628 three are incremented if the file already exists. This ensures
629 262144 unique file names per PID per PREFIX. */
635 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
636 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
637 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
642 #ifdef HAVE_LONG_FILE_NAMES
643 pidlen
= sprintf (pidbuf
, "%"pMd
, pid
);
645 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
646 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
647 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
652 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
653 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
654 if (!STRING_MULTIBYTE (prefix
))
655 STRING_SET_UNIBYTE (val
);
657 memcpy (data
, SSDATA (prefix
), len
);
660 memcpy (p
, pidbuf
, pidlen
);
663 /* Here we try to minimize useless stat'ing when this function is
664 invoked many times successively with the same PREFIX. We achieve
665 this by initializing count to a random value, and incrementing it
668 We don't want make-temp-name to be called while dumping,
669 because then make_temp_name_count_initialized_p would get set
670 and then make_temp_name_count would not be set when Emacs starts. */
672 if (!make_temp_name_count_initialized_p
)
674 make_temp_name_count
= time (NULL
);
675 make_temp_name_count_initialized_p
= 1;
681 unsigned num
= make_temp_name_count
;
683 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
684 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
685 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
687 /* Poor man's congruential RN generator. Replace with
688 ++make_temp_name_count for debugging. */
689 make_temp_name_count
+= 25229;
690 make_temp_name_count
%= 225307;
692 if (stat (data
, &ignored
) < 0)
694 /* We want to return only if errno is ENOENT. */
698 /* The error here is dubious, but there is little else we
699 can do. The alternatives are to return nil, which is
700 as bad as (and in many cases worse than) throwing the
701 error, or to ignore the error, which will likely result
702 in looping through 225307 stat's, which is not only
703 dog-slow, but also useless since eventually nil would
704 have to be returned anyway. */
705 report_file_error ("Cannot create temporary name for prefix",
706 Fcons (prefix
, Qnil
));
713 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
714 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
715 The Emacs process number forms part of the result,
716 so there is no danger of generating a name being used by another process.
718 In addition, this function makes an attempt to choose a name
719 which has no existing file. To make this work,
720 PREFIX should be an absolute file name.
722 There is a race condition between calling `make-temp-name' and creating the
723 file which opens all kinds of security holes. For that reason, you should
724 probably use `make-temp-file' instead, except in three circumstances:
726 * If you are creating the file in the user's home directory.
727 * If you are creating a directory rather than an ordinary file.
728 * If you are taking special precautions as `make-temp-file' does. */)
731 return make_temp_name (prefix
, 0);
736 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
737 doc
: /* Convert filename NAME to absolute, and canonicalize it.
738 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
739 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
740 the current buffer's value of `default-directory' is used.
741 NAME should be a string that is a valid file name for the underlying
743 File name components that are `.' are removed, and
744 so are file name components followed by `..', along with the `..' itself;
745 note that these simplifications are done without checking the resulting
746 file names in the file system.
747 Multiple consecutive slashes are collapsed into a single slash,
748 except at the beginning of the file name when they are significant (e.g.,
749 UNC file names on MS-Windows.)
750 An initial `~/' expands to your home directory.
751 An initial `~USER/' expands to USER's home directory.
752 See also the function `substitute-in-file-name'.
754 For technical reasons, this function can return correct but
755 non-intuitive results for the root directory; for instance,
756 \(expand-file-name ".." "/") returns "/..". For this reason, use
757 \(directory-file-name (file-name-directory dirname)) to traverse a
758 filesystem tree, not (expand-file-name ".." dirname). */)
759 (Lisp_Object name
, Lisp_Object default_directory
)
761 /* These point to SDATA and need to be careful with string-relocation
762 during GC (via DECODE_FILE). */
765 /* This should only point to alloca'd data. */
772 int collapse_newdir
= 1;
776 Lisp_Object handler
, result
, handled_name
;
782 /* If the file name has special constructs in it,
783 call the corresponding file handler. */
784 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
787 handled_name
= call3 (handler
, Qexpand_file_name
,
788 name
, default_directory
);
789 if (STRINGP (handled_name
))
791 error ("Invalid handler in `file-name-handler-alist'");
795 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
796 if (NILP (default_directory
))
797 default_directory
= BVAR (current_buffer
, directory
);
798 if (! STRINGP (default_directory
))
801 /* "/" is not considered a root directory on DOS_NT, so using "/"
802 here causes an infinite recursion in, e.g., the following:
804 (let (default-directory)
805 (expand-file-name "a"))
807 To avoid this, we set default_directory to the root of the
809 default_directory
= build_string (emacs_root_dir ());
811 default_directory
= build_string ("/");
815 if (!NILP (default_directory
))
817 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
820 handled_name
= call3 (handler
, Qexpand_file_name
,
821 name
, default_directory
);
822 if (STRINGP (handled_name
))
824 error ("Invalid handler in `file-name-handler-alist'");
829 char *o
= SSDATA (default_directory
);
831 /* Make sure DEFAULT_DIRECTORY is properly expanded.
832 It would be better to do this down below where we actually use
833 default_directory. Unfortunately, calling Fexpand_file_name recursively
834 could invoke GC, and the strings might be relocated. This would
835 be annoying because we have pointers into strings lying around
836 that would need adjusting, and people would add new pointers to
837 the code and forget to adjust them, resulting in intermittent bugs.
838 Putting this call here avoids all that crud.
840 The EQ test avoids infinite recursion. */
841 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
842 /* Save time in some common cases - as long as default_directory
843 is not relative, it can be canonicalized with name below (if it
844 is needed at all) without requiring it to be expanded now. */
846 /* Detect MSDOS file names with drive specifiers. */
847 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
848 && IS_DIRECTORY_SEP (o
[2]))
850 /* Detect Windows file names in UNC format. */
851 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
853 #else /* not DOS_NT */
854 /* Detect Unix absolute file names (/... alone is not absolute on
856 && ! (IS_DIRECTORY_SEP (o
[0]))
857 #endif /* not DOS_NT */
863 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
867 name
= FILE_SYSTEM_CASE (name
);
868 multibyte
= STRING_MULTIBYTE (name
);
869 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
872 default_directory
= string_to_multibyte (default_directory
);
875 name
= string_to_multibyte (name
);
880 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
881 nm
= (char *) alloca (SBYTES (name
) + 1);
882 memcpy (nm
, SSDATA (name
), SBYTES (name
) + 1);
885 /* Note if special escape prefix is present, but remove for now. */
886 if (nm
[0] == '/' && nm
[1] == ':')
892 /* Find and remove drive specifier if present; this makes nm absolute
893 even if the rest of the name appears to be relative. Only look for
894 drive specifier at the beginning. */
895 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
897 drive
= (unsigned char) nm
[0];
902 /* If we see "c://somedir", we want to strip the first slash after the
903 colon when stripping the drive letter. Otherwise, this expands to
905 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
908 /* Discard any previous drive specifier if nm is now in UNC format. */
909 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
913 #endif /* WINDOWSNT */
916 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
917 none are found, we can probably return right away. We will avoid
918 allocating a new string if name is already fully expanded. */
920 IS_DIRECTORY_SEP (nm
[0])
922 && drive
&& !is_escaped
925 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
929 /* If it turns out that the filename we want to return is just a
930 suffix of FILENAME, we don't need to go through and edit
931 things; we just need to construct a new string using data
932 starting at the middle of FILENAME. If we set lose to a
933 non-zero value, that means we've discovered that we can't do
940 /* Since we know the name is absolute, we can assume that each
941 element starts with a "/". */
943 /* "." and ".." are hairy. */
944 if (IS_DIRECTORY_SEP (p
[0])
946 && (IS_DIRECTORY_SEP (p
[2])
948 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
951 /* We want to replace multiple `/' in a row with a single
954 && IS_DIRECTORY_SEP (p
[0])
955 && IS_DIRECTORY_SEP (p
[1]))
962 /* Make sure directories are all separated with /, but
963 avoid allocation of a new string when not required. */
964 dostounix_filename (nm
);
966 if (IS_DIRECTORY_SEP (nm
[1]))
968 if (strcmp (nm
, SSDATA (name
)) != 0)
969 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
973 /* drive must be set, so this is okay */
974 if (strcmp (nm
- 2, SSDATA (name
)) != 0)
978 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
979 temp
[0] = DRIVE_LETTER (drive
);
980 name
= concat2 (build_string (temp
), name
);
983 #else /* not DOS_NT */
984 if (strcmp (nm
, SSDATA (name
)) == 0)
986 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
987 #endif /* not DOS_NT */
991 /* At this point, nm might or might not be an absolute file name. We
992 need to expand ~ or ~user if present, otherwise prefix nm with
993 default_directory if nm is not absolute, and finally collapse /./
994 and /foo/../ sequences.
996 We set newdir to be the appropriate prefix if one is needed:
997 - the relevant user directory if nm starts with ~ or ~user
998 - the specified drive's working dir (DOS/NT only) if nm does not
1000 - the value of default_directory.
1002 Note that these prefixes are not guaranteed to be absolute (except
1003 for the working dir of a drive). Therefore, to ensure we always
1004 return an absolute name, if the final prefix is not absolute we
1005 append it to the current working directory. */
1009 if (nm
[0] == '~') /* prefix ~ */
1011 if (IS_DIRECTORY_SEP (nm
[1])
1012 || nm
[1] == 0) /* ~ by itself */
1016 if (!(newdir
= egetenv ("HOME")))
1019 /* egetenv may return a unibyte string, which will bite us since
1020 we expect the directory to be multibyte. */
1021 tem
= build_string (newdir
);
1022 if (!STRING_MULTIBYTE (tem
))
1024 hdir
= DECODE_FILE (tem
);
1025 newdir
= SSDATA (hdir
);
1028 collapse_newdir
= 0;
1031 else /* ~user/filename */
1034 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1035 o
= alloca (p
- nm
+ 1);
1036 memcpy (o
, nm
, p
- nm
);
1040 pw
= (struct passwd
*) getpwnam (o
+ 1);
1044 newdir
= pw
->pw_dir
;
1047 collapse_newdir
= 0;
1051 /* If we don't find a user of that name, leave the name
1052 unchanged; don't move nm forward to p. */
1057 /* On DOS and Windows, nm is absolute if a drive name was specified;
1058 use the drive's current directory as the prefix if needed. */
1059 if (!newdir
&& drive
)
1061 /* Get default directory if needed to make nm absolute. */
1063 if (!IS_DIRECTORY_SEP (nm
[0]))
1065 adir
= alloca (MAXPATHLEN
+ 1);
1066 if (!getdefdir (toupper (drive
) - 'A' + 1, adir
))
1071 /* Either nm starts with /, or drive isn't mounted. */
1073 adir
[0] = DRIVE_LETTER (drive
);
1082 /* Finally, if no prefix has been specified and nm is not absolute,
1083 then it must be expanded relative to default_directory. */
1087 /* /... alone is not absolute on DOS and Windows. */
1088 && !IS_DIRECTORY_SEP (nm
[0])
1091 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1095 newdir
= SSDATA (default_directory
);
1097 /* Note if special escape prefix is present, but remove for now. */
1098 if (newdir
[0] == '/' && newdir
[1] == ':')
1109 /* First ensure newdir is an absolute name. */
1111 /* Detect MSDOS file names with drive specifiers. */
1112 ! (IS_DRIVE (newdir
[0])
1113 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1115 /* Detect Windows file names in UNC format. */
1116 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1120 /* Effectively, let newdir be (expand-file-name newdir cwd).
1121 Because of the admonition against calling expand-file-name
1122 when we have pointers into lisp strings, we accomplish this
1123 indirectly by prepending newdir to nm if necessary, and using
1124 cwd (or the wd of newdir's drive) as the new newdir. */
1126 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1128 drive
= (unsigned char) newdir
[0];
1131 if (!IS_DIRECTORY_SEP (nm
[0]))
1133 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1134 file_name_as_directory (tmp
, newdir
);
1138 adir
= alloca (MAXPATHLEN
+ 1);
1141 if (!getdefdir (toupper (drive
) - 'A' + 1, adir
))
1149 /* Strip off drive name from prefix, if present. */
1150 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1156 /* Keep only a prefix from newdir if nm starts with slash
1157 (//server/share for UNC, nothing otherwise). */
1158 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1161 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1163 char *adir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1165 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1167 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1180 /* Get rid of any slash at the end of newdir, unless newdir is
1181 just / or // (an incomplete UNC name). */
1182 length
= strlen (newdir
);
1183 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1185 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1189 char *temp
= (char *) alloca (length
);
1190 memcpy (temp
, newdir
, length
- 1);
1191 temp
[length
- 1] = 0;
1199 /* Now concatenate the directory and name to new space in the stack frame */
1200 tlen
+= strlen (nm
) + 1;
1202 /* Reserve space for drive specifier and escape prefix, since either
1203 or both may need to be inserted. (The Microsoft x86 compiler
1204 produces incorrect code if the following two lines are combined.) */
1205 target
= (char *) alloca (tlen
+ 4);
1207 #else /* not DOS_NT */
1208 target
= (char *) alloca (tlen
);
1209 #endif /* not DOS_NT */
1214 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1217 /* If newdir is effectively "C:/", then the drive letter will have
1218 been stripped and newdir will be "/". Concatenating with an
1219 absolute directory in nm produces "//", which will then be
1220 incorrectly treated as a network share. Ignore newdir in
1221 this case (keeping the drive letter). */
1222 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1223 && newdir
[1] == '\0'))
1225 strcpy (target
, newdir
);
1228 file_name_as_directory (target
, newdir
);
1231 strcat (target
, nm
);
1233 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1241 if (!IS_DIRECTORY_SEP (*p
))
1245 else if (p
[1] == '.'
1246 && (IS_DIRECTORY_SEP (p
[2])
1249 /* If "/." is the entire filename, keep the "/". Otherwise,
1250 just delete the whole "/.". */
1251 if (o
== target
&& p
[2] == '\0')
1255 else if (p
[1] == '.' && p
[2] == '.'
1256 /* `/../' is the "superroot" on certain file systems.
1257 Turned off on DOS_NT systems because they have no
1258 "superroot" and because this causes us to produce
1259 file names like "d:/../foo" which fail file-related
1260 functions of the underlying OS. (To reproduce, try a
1261 long series of "../../" in default_directory, longer
1262 than the number of levels from the root.) */
1266 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1271 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1274 /* Don't go below server level in UNC filenames. */
1275 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1276 && IS_DIRECTORY_SEP (*target
))
1280 /* Keep initial / only if this is the whole name. */
1281 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1285 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1286 /* Collapse multiple `/' in a row. */
1295 /* At last, set drive name. */
1297 /* Except for network file name. */
1298 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1299 #endif /* WINDOWSNT */
1301 if (!drive
) abort ();
1303 target
[0] = DRIVE_LETTER (drive
);
1306 /* Reinsert the escape prefix if required. */
1313 dostounix_filename (target
);
1316 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1319 /* Again look to see if the file name has special constructs in it
1320 and perhaps call the corresponding file handler. This is needed
1321 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1322 the ".." component gives us "/user@host:/bar/../baz" which needs
1323 to be expanded again. */
1324 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1325 if (!NILP (handler
))
1327 handled_name
= call3 (handler
, Qexpand_file_name
,
1328 result
, default_directory
);
1329 if (STRINGP (handled_name
))
1330 return handled_name
;
1331 error ("Invalid handler in `file-name-handler-alist'");
1338 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1339 This is the old version of expand-file-name, before it was thoroughly
1340 rewritten for Emacs 10.31. We leave this version here commented-out,
1341 because the code is very complex and likely to have subtle bugs. If
1342 bugs _are_ found, it might be of interest to look at the old code and
1343 see what did it do in the relevant situation.
1345 Don't remove this code: it's true that it will be accessible
1346 from the repository, but a few years from deletion, people will
1347 forget it is there. */
1349 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1350 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1351 "Convert FILENAME to absolute, and canonicalize it.\n\
1352 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1353 \(does not start with slash); if DEFAULT is nil or missing,\n\
1354 the current buffer's value of default-directory is used.\n\
1355 Filenames containing `.' or `..' as components are simplified;\n\
1356 initial `~/' expands to your home directory.\n\
1357 See also the function `substitute-in-file-name'.")
1359 Lisp_Object name
, defalt
;
1363 register unsigned char *newdir
, *p
, *o
;
1365 unsigned char *target
;
1369 CHECK_STRING (name
);
1372 /* If nm is absolute, flush ...// and detect /./ and /../.
1373 If no /./ or /../ we can return right away. */
1380 if (p
[0] == '/' && p
[1] == '/'
1383 if (p
[0] == '/' && p
[1] == '~')
1384 nm
= p
+ 1, lose
= 1;
1385 if (p
[0] == '/' && p
[1] == '.'
1386 && (p
[2] == '/' || p
[2] == 0
1387 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1393 if (nm
== SDATA (name
))
1395 return build_string (nm
);
1399 /* Now determine directory to start with and put it in NEWDIR */
1403 if (nm
[0] == '~') /* prefix ~ */
1404 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1406 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1407 newdir
= (unsigned char *) "";
1410 else /* ~user/filename */
1412 /* Get past ~ to user */
1413 unsigned char *user
= nm
+ 1;
1414 /* Find end of name. */
1415 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1416 ptrdiff_t len
= ptr
? ptr
- user
: strlen (user
);
1417 /* Copy the user name into temp storage. */
1418 o
= (unsigned char *) alloca (len
+ 1);
1419 memcpy (o
, user
, len
);
1422 /* Look up the user name. */
1424 pw
= (struct passwd
*) getpwnam (o
+ 1);
1427 error ("\"%s\" isn't a registered user", o
+ 1);
1429 newdir
= (unsigned char *) pw
->pw_dir
;
1431 /* Discard the user name from NM. */
1435 if (nm
[0] != '/' && !newdir
)
1438 defalt
= current_buffer
->directory
;
1439 CHECK_STRING (defalt
);
1440 newdir
= SDATA (defalt
);
1443 /* Now concatenate the directory and name to new space in the stack frame */
1445 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1446 target
= (unsigned char *) alloca (tlen
);
1451 if (nm
[0] == 0 || nm
[0] == '/')
1452 strcpy (target
, newdir
);
1454 file_name_as_directory (target
, newdir
);
1457 strcat (target
, nm
);
1459 /* Now canonicalize by removing /. and /foo/.. if they appear */
1470 else if (!strncmp (p
, "//", 2)
1476 else if (p
[0] == '/' && p
[1] == '.'
1477 && (p
[2] == '/' || p
[2] == 0))
1479 else if (!strncmp (p
, "/..", 3)
1480 /* `/../' is the "superroot" on certain file systems. */
1482 && (p
[3] == '/' || p
[3] == 0))
1484 while (o
!= target
&& *--o
!= '/')
1486 if (o
== target
&& *o
== '/')
1496 return make_string (target
, o
- target
);
1500 /* If /~ or // appears, discard everything through first slash. */
1502 file_name_absolute_p (const char *filename
)
1505 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1507 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1508 && IS_DIRECTORY_SEP (filename
[2]))
1514 search_embedded_absfilename (char *nm
, char *endp
)
1518 for (p
= nm
+ 1; p
< endp
; p
++)
1521 || IS_DIRECTORY_SEP (p
[-1]))
1522 && file_name_absolute_p (p
)
1523 #if defined (WINDOWSNT) || defined (CYGWIN)
1524 /* // at start of file name is meaningful in Apollo,
1525 WindowsNT and Cygwin systems. */
1526 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1527 #endif /* not (WINDOWSNT || CYGWIN) */
1530 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1531 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
1533 char *o
= alloca (s
- p
+ 1);
1535 memcpy (o
, p
, s
- p
);
1538 /* If we have ~user and `user' exists, discard
1539 everything up to ~. But if `user' does not exist, leave
1540 ~user alone, it might be a literal file name. */
1542 pw
= getpwnam (o
+ 1);
1554 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1555 Ssubstitute_in_file_name
, 1, 1, 0,
1556 doc
: /* Substitute environment variables referred to in FILENAME.
1557 `$FOO' where FOO is an environment variable name means to substitute
1558 the value of that variable. The variable name should be terminated
1559 with a character not a letter, digit or underscore; otherwise, enclose
1560 the entire variable name in braces.
1562 If `/~' appears, all of FILENAME through that `/' is discarded.
1563 If `//' appears, everything up to and including the first of
1564 those `/' is discarded. */)
1565 (Lisp_Object filename
)
1569 register char *s
, *p
, *o
, *x
, *endp
;
1570 char *target
= NULL
;
1572 int substituted
= 0;
1575 Lisp_Object handler
;
1577 CHECK_STRING (filename
);
1579 multibyte
= STRING_MULTIBYTE (filename
);
1581 /* If the file name has special constructs in it,
1582 call the corresponding file handler. */
1583 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1584 if (!NILP (handler
))
1586 Lisp_Object handled_name
= call2 (handler
, Qsubstitute_in_file_name
,
1588 if (STRINGP (handled_name
))
1589 return handled_name
;
1590 error ("Invalid handler in `file-name-handler-alist'");
1593 /* Always work on a copy of the string, in case GC happens during
1594 decode of environment variables, causing the original Lisp_String
1595 data to be relocated. */
1596 nm
= (char *) alloca (SBYTES (filename
) + 1);
1597 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1600 dostounix_filename (nm
);
1601 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1603 endp
= nm
+ SBYTES (filename
);
1605 /* If /~ or // appears, discard everything through first slash. */
1606 p
= search_embedded_absfilename (nm
, endp
);
1608 /* Start over with the new string, so we check the file-name-handler
1609 again. Important with filenames like "/home/foo//:/hello///there"
1610 which would substitute to "/:/hello///there" rather than "/there". */
1611 return Fsubstitute_in_file_name
1612 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1614 /* See if any variables are substituted into the string
1615 and find the total length of their values in `total' */
1617 for (p
= nm
; p
!= endp
;)
1627 /* "$$" means a single "$" */
1636 while (p
!= endp
&& *p
!= '}') p
++;
1637 if (*p
!= '}') goto missingclose
;
1643 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1647 /* Copy out the variable name */
1648 target
= (char *) alloca (s
- o
+ 1);
1649 strncpy (target
, o
, s
- o
);
1652 strupr (target
); /* $home == $HOME etc. */
1655 /* Get variable value */
1656 o
= egetenv (target
);
1659 /* Don't try to guess a maximum length - UTF8 can use up to
1660 four bytes per character. This code is unlikely to run
1661 in a situation that requires performance, so decoding the
1662 env variables twice should be acceptable. Note that
1663 decoding may cause a garbage collect. */
1664 Lisp_Object orig
, decoded
;
1665 orig
= make_unibyte_string (o
, strlen (o
));
1666 decoded
= DECODE_FILE (orig
);
1667 total
+= SBYTES (decoded
);
1677 /* If substitution required, recopy the string and do it */
1678 /* Make space in stack frame for the new copy */
1679 xnm
= (char *) alloca (SBYTES (filename
) + total
+ 1);
1682 /* Copy the rest of the name through, replacing $ constructs with values */
1699 while (p
!= endp
&& *p
!= '}') p
++;
1700 if (*p
!= '}') goto missingclose
;
1706 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1710 /* Copy out the variable name */
1711 target
= (char *) alloca (s
- o
+ 1);
1712 strncpy (target
, o
, s
- o
);
1715 strupr (target
); /* $home == $HOME etc. */
1718 /* Get variable value */
1719 o
= egetenv (target
);
1723 strcpy (x
, target
); x
+= strlen (target
);
1727 Lisp_Object orig
, decoded
;
1728 ptrdiff_t orig_length
, decoded_length
;
1729 orig_length
= strlen (o
);
1730 orig
= make_unibyte_string (o
, orig_length
);
1731 decoded
= DECODE_FILE (orig
);
1732 decoded_length
= SBYTES (decoded
);
1733 strncpy (x
, SSDATA (decoded
), decoded_length
);
1734 x
+= decoded_length
;
1736 /* If environment variable needed decoding, return value
1737 needs to be multibyte. */
1738 if (decoded_length
!= orig_length
1739 || strncmp (SSDATA (decoded
), o
, orig_length
))
1746 /* If /~ or // appears, discard everything through first slash. */
1747 while ((p
= search_embedded_absfilename (xnm
, x
)))
1748 /* This time we do not start over because we've already expanded envvars
1749 and replaced $$ with $. Maybe we should start over as well, but we'd
1750 need to quote some $ to $$ first. */
1753 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1756 error ("Bad format environment-variable substitution");
1758 error ("Missing \"}\" in environment-variable substitution");
1760 error ("Substituting nonexistent environment variable \"%s\"", target
);
1766 /* A slightly faster and more convenient way to get
1767 (directory-file-name (expand-file-name FOO)). */
1770 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1772 register Lisp_Object absname
;
1774 absname
= Fexpand_file_name (filename
, defdir
);
1776 /* Remove final slash, if any (unless this is the root dir).
1777 stat behaves differently depending! */
1778 if (SCHARS (absname
) > 1
1779 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1780 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
1781 /* We cannot take shortcuts; they might be wrong for magic file names. */
1782 absname
= Fdirectory_file_name (absname
);
1786 /* Signal an error if the file ABSNAME already exists.
1787 If INTERACTIVE is nonzero, ask the user whether to proceed,
1788 and bypass the error if the user says to go ahead.
1789 QUERYSTRING is a name for the action that is being considered
1792 *STATPTR is used to store the stat information if the file exists.
1793 If the file does not exist, STATPTR->st_mode is set to 0.
1794 If STATPTR is null, we don't store into it.
1796 If QUICK is nonzero, we ask for y or n, not yes or no. */
1799 barf_or_query_if_file_exists (Lisp_Object absname
, const char *querystring
,
1800 int interactive
, struct stat
*statptr
, int quick
)
1802 register Lisp_Object tem
, encoded_filename
;
1803 struct stat statbuf
;
1804 struct gcpro gcpro1
;
1806 encoded_filename
= ENCODE_FILE (absname
);
1808 /* stat is a good way to tell whether the file exists,
1809 regardless of what access permissions it has. */
1810 if (lstat (SSDATA (encoded_filename
), &statbuf
) >= 0)
1812 if (S_ISDIR (statbuf
.st_mode
))
1813 xsignal2 (Qfile_error
,
1814 build_string ("File is a directory"), absname
);
1817 xsignal2 (Qfile_already_exists
,
1818 build_string ("File already exists"), absname
);
1820 tem
= format2 ("File %s already exists; %s anyway? ",
1821 absname
, build_string (querystring
));
1823 tem
= call1 (intern ("y-or-n-p"), tem
);
1825 tem
= do_yes_or_no_p (tem
);
1828 xsignal2 (Qfile_already_exists
,
1829 build_string ("File already exists"), absname
);
1836 statptr
->st_mode
= 0;
1841 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1842 "fCopy file: \nGCopy %s to file: \np\nP",
1843 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1844 If NEWNAME names a directory, copy FILE there.
1846 This function always sets the file modes of the output file to match
1849 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1850 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1851 signal a `file-already-exists' error without overwriting. If
1852 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1853 about overwriting; this is what happens in interactive use with M-x.
1854 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1857 Fourth arg KEEP-TIME non-nil means give the output file the same
1858 last-modified time as the old one. (This works on only some systems.)
1860 A prefix arg makes KEEP-TIME non-nil.
1862 If PRESERVE-UID-GID is non-nil, we try to transfer the
1863 uid and gid of FILE to NEWNAME.
1865 If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
1866 on the system, we copy the SELinux context of FILE to NEWNAME. */)
1867 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
, Lisp_Object keep_time
, Lisp_Object preserve_uid_gid
, Lisp_Object preserve_selinux_context
)
1871 char buf
[16 * 1024];
1872 struct stat st
, out_st
;
1873 Lisp_Object handler
;
1874 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1875 int count
= SPECPDL_INDEX ();
1876 int input_file_statable_p
;
1877 Lisp_Object encoded_file
, encoded_newname
;
1879 security_context_t con
;
1880 int fail
, conlength
= 0;
1883 encoded_file
= encoded_newname
= Qnil
;
1884 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1885 CHECK_STRING (file
);
1886 CHECK_STRING (newname
);
1888 if (!NILP (Ffile_directory_p (newname
)))
1889 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1891 newname
= Fexpand_file_name (newname
, Qnil
);
1893 file
= Fexpand_file_name (file
, Qnil
);
1895 /* If the input file name has special constructs in it,
1896 call the corresponding file handler. */
1897 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1898 /* Likewise for output file name. */
1900 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1901 if (!NILP (handler
))
1902 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1903 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1904 preserve_selinux_context
));
1906 encoded_file
= ENCODE_FILE (file
);
1907 encoded_newname
= ENCODE_FILE (newname
);
1909 if (NILP (ok_if_already_exists
)
1910 || INTEGERP (ok_if_already_exists
))
1911 barf_or_query_if_file_exists (newname
, "copy to it",
1912 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1913 else if (stat (SSDATA (encoded_newname
), &out_st
) < 0)
1917 if (!CopyFile (SDATA (encoded_file
),
1918 SDATA (encoded_newname
),
1920 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1921 /* CopyFile retains the timestamp by default. */
1922 else if (NILP (keep_time
))
1928 EMACS_GET_TIME (now
);
1929 filename
= SDATA (encoded_newname
);
1931 /* Ensure file is writable while its modified time is set. */
1932 attributes
= GetFileAttributes (filename
);
1933 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1934 if (set_file_times (filename
, now
, now
))
1936 /* Restore original attributes. */
1937 SetFileAttributes (filename
, attributes
);
1938 xsignal2 (Qfile_date_error
,
1939 build_string ("Cannot set file date"), newname
);
1941 /* Restore original attributes. */
1942 SetFileAttributes (filename
, attributes
);
1944 #else /* not WINDOWSNT */
1946 ifd
= emacs_open (SSDATA (encoded_file
), O_RDONLY
, 0);
1950 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1952 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1954 /* We can only copy regular files and symbolic links. Other files are not
1956 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
1959 if (!NILP (preserve_selinux_context
) && is_selinux_enabled ())
1961 conlength
= fgetfilecon (ifd
, &con
);
1962 if (conlength
== -1)
1963 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
1967 if (out_st
.st_mode
!= 0
1968 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
1971 report_file_error ("Input and output files are the same",
1972 Fcons (file
, Fcons (newname
, Qnil
)));
1975 if (input_file_statable_p
)
1977 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
1979 #if defined (EISDIR)
1980 /* Get a better looking error message. */
1983 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
1988 /* System's default file type was set to binary by _fmode in emacs.c. */
1989 ofd
= emacs_open (SDATA (encoded_newname
),
1990 O_WRONLY
| O_TRUNC
| O_CREAT
1991 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
1992 S_IREAD
| S_IWRITE
);
1993 #else /* not MSDOS */
1995 int new_mask
= 0666;
1996 if (input_file_statable_p
)
1998 if (!NILP (preserve_uid_gid
))
2000 new_mask
&= st
.st_mode
;
2002 ofd
= emacs_open (SSDATA (encoded_newname
),
2003 (O_WRONLY
| O_TRUNC
| O_CREAT
2004 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0)),
2007 #endif /* not MSDOS */
2009 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2011 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2015 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2016 if (emacs_write (ofd
, buf
, n
) != n
)
2017 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2021 /* Preserve the original file modes, and if requested, also its
2023 if (input_file_statable_p
)
2025 int mode_mask
= 07777;
2026 if (!NILP (preserve_uid_gid
))
2028 /* Attempt to change owner and group. If that doesn't work
2029 attempt to change just the group, as that is sometimes allowed.
2030 Adjust the mode mask to eliminate setuid or setgid bits
2031 that are inappropriate if the owner and group are wrong. */
2032 if (fchown (ofd
, st
.st_uid
, st
.st_gid
) != 0)
2034 mode_mask
&= ~06000;
2035 if (fchown (ofd
, -1, st
.st_gid
) == 0)
2039 if (fchmod (ofd
, st
.st_mode
& mode_mask
) != 0)
2040 report_file_error ("Doing chmod", Fcons (newname
, Qnil
));
2042 #endif /* not MSDOS */
2047 /* Set the modified context back to the file. */
2048 fail
= fsetfilecon (ofd
, con
);
2050 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2056 /* Closing the output clobbers the file times on some systems. */
2057 if (emacs_close (ofd
) < 0)
2058 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2060 if (input_file_statable_p
)
2062 if (!NILP (keep_time
))
2064 EMACS_TIME atime
, mtime
;
2065 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
2066 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
2067 if (set_file_times (SSDATA (encoded_newname
),
2069 xsignal2 (Qfile_date_error
,
2070 build_string ("Cannot set file date"), newname
);
2077 if (input_file_statable_p
)
2079 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2080 and if it can't, it tells so. Otherwise, under MSDOS we usually
2081 get only the READ bit, which will make the copied file read-only,
2082 so it's better not to chmod at all. */
2083 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2084 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2087 #endif /* not WINDOWSNT */
2089 /* Discard the unwind protects. */
2090 specpdl_ptr
= specpdl
+ count
;
2096 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2097 Smake_directory_internal
, 1, 1, 0,
2098 doc
: /* Create a new directory named DIRECTORY. */)
2099 (Lisp_Object directory
)
2102 Lisp_Object handler
;
2103 Lisp_Object encoded_dir
;
2105 CHECK_STRING (directory
);
2106 directory
= Fexpand_file_name (directory
, Qnil
);
2108 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2109 if (!NILP (handler
))
2110 return call2 (handler
, Qmake_directory_internal
, directory
);
2112 encoded_dir
= ENCODE_FILE (directory
);
2114 dir
= SSDATA (encoded_dir
);
2117 if (mkdir (dir
) != 0)
2119 if (mkdir (dir
, 0777 & ~auto_saving_dir_umask
) != 0)
2121 report_file_error ("Creating directory", list1 (directory
));
2126 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2127 Sdelete_directory_internal
, 1, 1, 0,
2128 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2129 (Lisp_Object directory
)
2132 Lisp_Object encoded_dir
;
2134 CHECK_STRING (directory
);
2135 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2136 encoded_dir
= ENCODE_FILE (directory
);
2137 dir
= SSDATA (encoded_dir
);
2139 if (rmdir (dir
) != 0)
2140 report_file_error ("Removing directory", list1 (directory
));
2145 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2146 "(list (read-file-name \
2147 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2148 \"Move file to trash: \" \"Delete file: \") \
2149 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2150 (null current-prefix-arg))",
2151 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2152 If file has multiple names, it continues to exist with the other names.
2153 TRASH non-nil means to trash the file instead of deleting, provided
2154 `delete-by-moving-to-trash' is non-nil.
2156 When called interactively, TRASH is t if no prefix argument is given.
2157 With a prefix argument, TRASH is nil. */)
2158 (Lisp_Object filename
, Lisp_Object trash
)
2160 Lisp_Object handler
;
2161 Lisp_Object encoded_file
;
2162 struct gcpro gcpro1
;
2165 if (!NILP (Ffile_directory_p (filename
))
2166 && NILP (Ffile_symlink_p (filename
)))
2167 xsignal2 (Qfile_error
,
2168 build_string ("Removing old name: is a directory"),
2171 filename
= Fexpand_file_name (filename
, Qnil
);
2173 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2174 if (!NILP (handler
))
2175 return call3 (handler
, Qdelete_file
, filename
, trash
);
2177 if (delete_by_moving_to_trash
&& !NILP (trash
))
2178 return call1 (Qmove_file_to_trash
, filename
);
2180 encoded_file
= ENCODE_FILE (filename
);
2182 if (0 > unlink (SSDATA (encoded_file
)))
2183 report_file_error ("Removing old name", list1 (filename
));
2188 internal_delete_file_1 (Lisp_Object ignore
)
2193 /* Delete file FILENAME, returning 1 if successful and 0 if failed.
2194 This ignores `delete-by-moving-to-trash'. */
2197 internal_delete_file (Lisp_Object filename
)
2201 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2202 Qt
, internal_delete_file_1
);
2206 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2207 "fRename file: \nGRename %s to file: \np",
2208 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2209 If file has names other than FILE, it continues to have those names.
2210 Signals a `file-already-exists' error if a file NEWNAME already exists
2211 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2212 A number as third arg means request confirmation if NEWNAME already exists.
2213 This is what happens in interactive use with M-x. */)
2214 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2216 Lisp_Object handler
;
2217 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2218 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2220 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2221 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2222 CHECK_STRING (file
);
2223 CHECK_STRING (newname
);
2224 file
= Fexpand_file_name (file
, Qnil
);
2226 if ((!NILP (Ffile_directory_p (newname
)))
2228 /* If the file names are identical but for the case,
2229 don't attempt to move directory to itself. */
2230 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2234 Lisp_Object fname
= NILP (Ffile_directory_p (file
))
2235 ? file
: Fdirectory_file_name (file
);
2236 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2239 newname
= Fexpand_file_name (newname
, Qnil
);
2241 /* If the file name has special constructs in it,
2242 call the corresponding file handler. */
2243 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2245 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2246 if (!NILP (handler
))
2247 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2248 file
, newname
, ok_if_already_exists
));
2250 encoded_file
= ENCODE_FILE (file
);
2251 encoded_newname
= ENCODE_FILE (newname
);
2254 /* If the file names are identical but for the case, don't ask for
2255 confirmation: they simply want to change the letter-case of the
2257 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2259 if (NILP (ok_if_already_exists
)
2260 || INTEGERP (ok_if_already_exists
))
2261 barf_or_query_if_file_exists (newname
, "rename to it",
2262 INTEGERP (ok_if_already_exists
), 0, 0);
2263 if (0 > rename (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2268 symlink_target
= Ffile_symlink_p (file
);
2269 if (! NILP (symlink_target
))
2270 Fmake_symbolic_link (symlink_target
, newname
,
2271 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2272 else if (!NILP (Ffile_directory_p (file
)))
2273 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2275 /* We have already prompted if it was an integer, so don't
2276 have copy-file prompt again. */
2277 Fcopy_file (file
, newname
,
2278 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2281 count
= SPECPDL_INDEX ();
2282 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2284 if (!NILP (Ffile_directory_p (file
)) && NILP (symlink_target
))
2285 call2 (Qdelete_directory
, file
, Qt
);
2287 Fdelete_file (file
, Qnil
);
2288 unbind_to (count
, Qnil
);
2291 report_file_error ("Renaming", list2 (file
, newname
));
2297 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2298 "fAdd name to file: \nGName to add to %s: \np",
2299 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2300 Signals a `file-already-exists' error if a file NEWNAME already exists
2301 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2302 A number as third arg means request confirmation if NEWNAME already exists.
2303 This is what happens in interactive use with M-x. */)
2304 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2306 Lisp_Object handler
;
2307 Lisp_Object encoded_file
, encoded_newname
;
2308 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2310 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2311 encoded_file
= encoded_newname
= Qnil
;
2312 CHECK_STRING (file
);
2313 CHECK_STRING (newname
);
2314 file
= Fexpand_file_name (file
, Qnil
);
2316 if (!NILP (Ffile_directory_p (newname
)))
2317 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2319 newname
= Fexpand_file_name (newname
, Qnil
);
2321 /* If the file name has special constructs in it,
2322 call the corresponding file handler. */
2323 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2324 if (!NILP (handler
))
2325 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2326 newname
, ok_if_already_exists
));
2328 /* If the new name has special constructs in it,
2329 call the corresponding file handler. */
2330 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2331 if (!NILP (handler
))
2332 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2333 newname
, ok_if_already_exists
));
2335 encoded_file
= ENCODE_FILE (file
);
2336 encoded_newname
= ENCODE_FILE (newname
);
2338 if (NILP (ok_if_already_exists
)
2339 || INTEGERP (ok_if_already_exists
))
2340 barf_or_query_if_file_exists (newname
, "make it a new name",
2341 INTEGERP (ok_if_already_exists
), 0, 0);
2343 unlink (SSDATA (newname
));
2344 if (0 > link (SSDATA (encoded_file
), SSDATA (encoded_newname
)))
2345 report_file_error ("Adding new name", list2 (file
, newname
));
2351 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2352 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2353 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2354 Both args must be strings.
2355 Signals a `file-already-exists' error if a file LINKNAME already exists
2356 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2357 A number as third arg means request confirmation if LINKNAME already exists.
2358 This happens for interactive use with M-x. */)
2359 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2361 Lisp_Object handler
;
2362 Lisp_Object encoded_filename
, encoded_linkname
;
2363 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2365 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2366 encoded_filename
= encoded_linkname
= Qnil
;
2367 CHECK_STRING (filename
);
2368 CHECK_STRING (linkname
);
2369 /* If the link target has a ~, we must expand it to get
2370 a truly valid file name. Otherwise, do not expand;
2371 we want to permit links to relative file names. */
2372 if (SREF (filename
, 0) == '~')
2373 filename
= Fexpand_file_name (filename
, Qnil
);
2375 if (!NILP (Ffile_directory_p (linkname
)))
2376 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2378 linkname
= Fexpand_file_name (linkname
, Qnil
);
2380 /* If the file name has special constructs in it,
2381 call the corresponding file handler. */
2382 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2383 if (!NILP (handler
))
2384 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2385 linkname
, ok_if_already_exists
));
2387 /* If the new link name has special constructs in it,
2388 call the corresponding file handler. */
2389 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2390 if (!NILP (handler
))
2391 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2392 linkname
, ok_if_already_exists
));
2394 encoded_filename
= ENCODE_FILE (filename
);
2395 encoded_linkname
= ENCODE_FILE (linkname
);
2397 if (NILP (ok_if_already_exists
)
2398 || INTEGERP (ok_if_already_exists
))
2399 barf_or_query_if_file_exists (linkname
, "make it a link",
2400 INTEGERP (ok_if_already_exists
), 0, 0);
2401 if (0 > symlink (SSDATA (encoded_filename
),
2402 SSDATA (encoded_linkname
)))
2404 /* If we didn't complain already, silently delete existing file. */
2405 if (errno
== EEXIST
)
2407 unlink (SSDATA (encoded_linkname
));
2408 if (0 <= symlink (SSDATA (encoded_filename
),
2409 SSDATA (encoded_linkname
)))
2415 if (errno
== ENOSYS
)
2418 xsignal1 (Qfile_error
,
2419 build_string ("Symbolic links are not supported"));
2422 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2429 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2431 doc
: /* Return t if file FILENAME specifies an absolute file name.
2432 On Unix, this is a name starting with a `/' or a `~'. */)
2433 (Lisp_Object filename
)
2435 CHECK_STRING (filename
);
2436 return file_name_absolute_p (SSDATA (filename
)) ? Qt
: Qnil
;
2439 /* Return nonzero if file FILENAME exists and can be executed. */
2442 check_executable (char *filename
)
2446 if (stat (filename
, &st
) < 0)
2448 return ((st
.st_mode
& S_IEXEC
) != 0);
2449 #else /* not DOS_NT */
2450 #ifdef HAVE_EUIDACCESS
2451 return (euidaccess (filename
, 1) >= 0);
2453 /* Access isn't quite right because it uses the real uid
2454 and we really want to test with the effective uid.
2455 But Unix doesn't give us a right way to do it. */
2456 return (access (filename
, 1) >= 0);
2458 #endif /* not DOS_NT */
2461 /* Return nonzero if file FILENAME exists and can be written. */
2464 check_writable (const char *filename
)
2468 if (stat (filename
, &st
) < 0)
2470 return (st
.st_mode
& S_IWRITE
|| S_ISDIR (st
.st_mode
));
2471 #else /* not MSDOS */
2472 #ifdef HAVE_EUIDACCESS
2473 int res
= (euidaccess (filename
, 2) >= 0);
2475 /* euidaccess may have returned failure because Cygwin couldn't
2476 determine the file's UID or GID; if so, we return success. */
2480 if (stat (filename
, &st
) < 0)
2482 res
= (st
.st_uid
== -1 || st
.st_gid
== -1);
2486 #else /* not HAVE_EUIDACCESS */
2487 /* Access isn't quite right because it uses the real uid
2488 and we really want to test with the effective uid.
2489 But Unix doesn't give us a right way to do it.
2490 Opening with O_WRONLY could work for an ordinary file,
2491 but would lose for directories. */
2492 return (access (filename
, 2) >= 0);
2493 #endif /* not HAVE_EUIDACCESS */
2494 #endif /* not MSDOS */
2497 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2498 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2499 See also `file-readable-p' and `file-attributes'.
2500 This returns nil for a symlink to a nonexistent file.
2501 Use `file-symlink-p' to test for such links. */)
2502 (Lisp_Object filename
)
2504 Lisp_Object absname
;
2505 Lisp_Object handler
;
2506 struct stat statbuf
;
2508 CHECK_STRING (filename
);
2509 absname
= Fexpand_file_name (filename
, Qnil
);
2511 /* If the file name has special constructs in it,
2512 call the corresponding file handler. */
2513 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2514 if (!NILP (handler
))
2515 return call2 (handler
, Qfile_exists_p
, absname
);
2517 absname
= ENCODE_FILE (absname
);
2519 return (stat (SSDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2522 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2523 doc
: /* Return t if FILENAME can be executed by you.
2524 For a directory, this means you can access files in that directory. */)
2525 (Lisp_Object filename
)
2527 Lisp_Object absname
;
2528 Lisp_Object handler
;
2530 CHECK_STRING (filename
);
2531 absname
= Fexpand_file_name (filename
, Qnil
);
2533 /* If the file name has special constructs in it,
2534 call the corresponding file handler. */
2535 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2536 if (!NILP (handler
))
2537 return call2 (handler
, Qfile_executable_p
, absname
);
2539 absname
= ENCODE_FILE (absname
);
2541 return (check_executable (SSDATA (absname
)) ? Qt
: Qnil
);
2544 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2545 doc
: /* Return t if file FILENAME exists and you can read it.
2546 See also `file-exists-p' and `file-attributes'. */)
2547 (Lisp_Object filename
)
2549 Lisp_Object absname
;
2550 Lisp_Object handler
;
2553 struct stat statbuf
;
2555 CHECK_STRING (filename
);
2556 absname
= Fexpand_file_name (filename
, Qnil
);
2558 /* If the file name has special constructs in it,
2559 call the corresponding file handler. */
2560 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2561 if (!NILP (handler
))
2562 return call2 (handler
, Qfile_readable_p
, absname
);
2564 absname
= ENCODE_FILE (absname
);
2566 #if defined (DOS_NT) || defined (macintosh)
2567 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2569 if (access (SDATA (absname
), 0) == 0)
2572 #else /* not DOS_NT and not macintosh */
2575 /* Opening a fifo without O_NONBLOCK can wait.
2576 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2577 except in the case of a fifo, on a system which handles it. */
2578 desc
= stat (SSDATA (absname
), &statbuf
);
2581 if (S_ISFIFO (statbuf
.st_mode
))
2582 flags
|= O_NONBLOCK
;
2584 desc
= emacs_open (SSDATA (absname
), flags
, 0);
2589 #endif /* not DOS_NT and not macintosh */
2592 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2594 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2595 doc
: /* Return t if file FILENAME can be written or created by you. */)
2596 (Lisp_Object filename
)
2598 Lisp_Object absname
, dir
, encoded
;
2599 Lisp_Object handler
;
2600 struct stat statbuf
;
2602 CHECK_STRING (filename
);
2603 absname
= Fexpand_file_name (filename
, Qnil
);
2605 /* If the file name has special constructs in it,
2606 call the corresponding file handler. */
2607 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2608 if (!NILP (handler
))
2609 return call2 (handler
, Qfile_writable_p
, absname
);
2611 encoded
= ENCODE_FILE (absname
);
2612 if (stat (SSDATA (encoded
), &statbuf
) >= 0)
2613 return (check_writable (SSDATA (encoded
))
2616 dir
= Ffile_name_directory (absname
);
2619 dir
= Fdirectory_file_name (dir
);
2622 dir
= ENCODE_FILE (dir
);
2624 /* The read-only attribute of the parent directory doesn't affect
2625 whether a file or directory can be created within it. Some day we
2626 should check ACLs though, which do affect this. */
2627 if (stat (SDATA (dir
), &statbuf
) < 0)
2629 return S_ISDIR (statbuf
.st_mode
) ? Qt
: Qnil
;
2631 return (check_writable (!NILP (dir
) ? SSDATA (dir
) : "")
2636 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2637 doc
: /* Access file FILENAME, and get an error if that does not work.
2638 The second argument STRING is used in the error message.
2639 If there is no error, returns nil. */)
2640 (Lisp_Object filename
, Lisp_Object string
)
2642 Lisp_Object handler
, encoded_filename
, absname
;
2645 CHECK_STRING (filename
);
2646 absname
= Fexpand_file_name (filename
, Qnil
);
2648 CHECK_STRING (string
);
2650 /* If the file name has special constructs in it,
2651 call the corresponding file handler. */
2652 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2653 if (!NILP (handler
))
2654 return call3 (handler
, Qaccess_file
, absname
, string
);
2656 encoded_filename
= ENCODE_FILE (absname
);
2658 fd
= emacs_open (SSDATA (encoded_filename
), O_RDONLY
, 0);
2660 report_file_error (SSDATA (string
), Fcons (filename
, Qnil
));
2666 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2667 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2668 The value is the link target, as a string.
2669 Otherwise it returns nil.
2671 This function returns t when given the name of a symlink that
2672 points to a nonexistent file. */)
2673 (Lisp_Object filename
)
2675 Lisp_Object handler
;
2678 char readlink_buf
[READLINK_BUFSIZE
];
2680 CHECK_STRING (filename
);
2681 filename
= Fexpand_file_name (filename
, Qnil
);
2683 /* If the file name has special constructs in it,
2684 call the corresponding file handler. */
2685 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2686 if (!NILP (handler
))
2687 return call2 (handler
, Qfile_symlink_p
, filename
);
2689 filename
= ENCODE_FILE (filename
);
2691 buf
= emacs_readlink (SSDATA (filename
), readlink_buf
);
2695 val
= build_string (buf
);
2696 if (buf
[0] == '/' && strchr (buf
, ':'))
2697 val
= concat2 (build_string ("/:"), val
);
2698 if (buf
!= readlink_buf
)
2700 val
= DECODE_FILE (val
);
2704 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2705 doc
: /* Return t if FILENAME names an existing directory.
2706 Symbolic links to directories count as directories.
2707 See `file-symlink-p' to distinguish symlinks. */)
2708 (Lisp_Object filename
)
2710 register Lisp_Object absname
;
2712 Lisp_Object handler
;
2714 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2716 /* If the file name has special constructs in it,
2717 call the corresponding file handler. */
2718 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2719 if (!NILP (handler
))
2720 return call2 (handler
, Qfile_directory_p
, absname
);
2722 absname
= ENCODE_FILE (absname
);
2724 if (stat (SSDATA (absname
), &st
) < 0)
2726 return S_ISDIR (st
.st_mode
) ? Qt
: Qnil
;
2729 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
,
2730 Sfile_accessible_directory_p
, 1, 1, 0,
2731 doc
: /* Return t if file FILENAME names a directory you can open.
2732 For the value to be t, FILENAME must specify the name of a directory as a file,
2733 and the directory must allow you to open files in it. In order to use a
2734 directory as a buffer's current directory, this predicate must return true.
2735 A directory name spec may be given instead; then the value is t
2736 if the directory so specified exists and really is a readable and
2737 searchable directory. */)
2738 (Lisp_Object filename
)
2740 Lisp_Object handler
;
2742 struct gcpro gcpro1
;
2744 /* If the file name has special constructs in it,
2745 call the corresponding file handler. */
2746 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2747 if (!NILP (handler
))
2748 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2751 tem
= (NILP (Ffile_directory_p (filename
))
2752 || NILP (Ffile_executable_p (filename
)));
2754 return tem
? Qnil
: Qt
;
2757 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2758 doc
: /* Return t if FILENAME names a regular file.
2759 This is the sort of file that holds an ordinary stream of data bytes.
2760 Symbolic links to regular files count as regular files.
2761 See `file-symlink-p' to distinguish symlinks. */)
2762 (Lisp_Object filename
)
2764 register Lisp_Object absname
;
2766 Lisp_Object handler
;
2768 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2770 /* If the file name has special constructs in it,
2771 call the corresponding file handler. */
2772 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2773 if (!NILP (handler
))
2774 return call2 (handler
, Qfile_regular_p
, absname
);
2776 absname
= ENCODE_FILE (absname
);
2781 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2783 /* Tell stat to use expensive method to get accurate info. */
2784 Vw32_get_true_file_attributes
= Qt
;
2785 result
= stat (SDATA (absname
), &st
);
2786 Vw32_get_true_file_attributes
= tem
;
2790 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2793 if (stat (SSDATA (absname
), &st
) < 0)
2795 return S_ISREG (st
.st_mode
) ? Qt
: Qnil
;
2799 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2800 Sfile_selinux_context
, 1, 1, 0,
2801 doc
: /* Return SELinux context of file named FILENAME.
2802 The return value is a list (USER ROLE TYPE RANGE), where the list
2803 elements are strings naming the user, role, type, and range of the
2804 file's SELinux security context.
2806 Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2807 or if SELinux is disabled, or if Emacs lacks SELinux support. */)
2808 (Lisp_Object filename
)
2810 Lisp_Object absname
;
2811 Lisp_Object values
[4];
2812 Lisp_Object handler
;
2814 security_context_t con
;
2819 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2821 /* If the file name has special constructs in it,
2822 call the corresponding file handler. */
2823 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2824 if (!NILP (handler
))
2825 return call2 (handler
, Qfile_selinux_context
, absname
);
2827 absname
= ENCODE_FILE (absname
);
2834 if (is_selinux_enabled ())
2836 conlength
= lgetfilecon (SSDATA (absname
), &con
);
2839 context
= context_new (con
);
2840 if (context_user_get (context
))
2841 values
[0] = build_string (context_user_get (context
));
2842 if (context_role_get (context
))
2843 values
[1] = build_string (context_role_get (context
));
2844 if (context_type_get (context
))
2845 values
[2] = build_string (context_type_get (context
));
2846 if (context_range_get (context
))
2847 values
[3] = build_string (context_range_get (context
));
2848 context_free (context
);
2855 return Flist (sizeof (values
) / sizeof (values
[0]), values
);
2858 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2859 Sset_file_selinux_context
, 2, 2, 0,
2860 doc
: /* Set SELinux context of file named FILENAME to CONTEXT.
2861 CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2862 elements are strings naming the components of a SELinux context.
2864 This function does nothing if SELinux is disabled, or if Emacs was not
2865 compiled with SELinux support. */)
2866 (Lisp_Object filename
, Lisp_Object context
)
2868 Lisp_Object absname
;
2869 Lisp_Object handler
;
2871 Lisp_Object encoded_absname
;
2872 Lisp_Object user
= CAR_SAFE (context
);
2873 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2874 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2875 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2876 security_context_t con
;
2877 int fail
, conlength
;
2878 context_t parsed_con
;
2881 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2883 /* If the file name has special constructs in it,
2884 call the corresponding file handler. */
2885 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2886 if (!NILP (handler
))
2887 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2890 if (is_selinux_enabled ())
2892 /* Get current file context. */
2893 encoded_absname
= ENCODE_FILE (absname
);
2894 conlength
= lgetfilecon (SSDATA (encoded_absname
), &con
);
2897 parsed_con
= context_new (con
);
2898 /* Change the parts defined in the parameter.*/
2901 if (context_user_set (parsed_con
, SSDATA (user
)))
2902 error ("Doing context_user_set");
2906 if (context_role_set (parsed_con
, SSDATA (role
)))
2907 error ("Doing context_role_set");
2911 if (context_type_set (parsed_con
, SSDATA (type
)))
2912 error ("Doing context_type_set");
2914 if (STRINGP (range
))
2916 if (context_range_set (parsed_con
, SSDATA (range
)))
2917 error ("Doing context_range_set");
2920 /* Set the modified context back to the file. */
2921 fail
= lsetfilecon (SSDATA (encoded_absname
),
2922 context_str (parsed_con
));
2924 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
2926 context_free (parsed_con
);
2929 report_file_error ("Doing lgetfilecon", Fcons (absname
, Qnil
));
2939 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2940 doc
: /* Return mode bits of file named FILENAME, as an integer.
2941 Return nil, if file does not exist or is not accessible. */)
2942 (Lisp_Object filename
)
2944 Lisp_Object absname
;
2946 Lisp_Object handler
;
2948 absname
= expand_and_dir_to_file (filename
, BVAR (current_buffer
, directory
));
2950 /* If the file name has special constructs in it,
2951 call the corresponding file handler. */
2952 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2953 if (!NILP (handler
))
2954 return call2 (handler
, Qfile_modes
, absname
);
2956 absname
= ENCODE_FILE (absname
);
2958 if (stat (SSDATA (absname
), &st
) < 0)
2961 return make_number (st
.st_mode
& 07777);
2964 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2965 "(let ((file (read-file-name \"File: \"))) \
2966 (list file (read-file-modes nil file)))",
2967 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2968 Only the 12 low bits of MODE are used.
2970 Interactively, mode bits are read by `read-file-modes', which accepts
2971 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2972 (Lisp_Object filename
, Lisp_Object mode
)
2974 Lisp_Object absname
, encoded_absname
;
2975 Lisp_Object handler
;
2977 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
2978 CHECK_NUMBER (mode
);
2980 /* If the file name has special constructs in it,
2981 call the corresponding file handler. */
2982 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2983 if (!NILP (handler
))
2984 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2986 encoded_absname
= ENCODE_FILE (absname
);
2988 if (chmod (SSDATA (encoded_absname
), XINT (mode
) & 07777) < 0)
2989 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2994 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2995 doc
: /* Set the file permission bits for newly created files.
2996 The argument MODE should be an integer; only the low 9 bits are used.
2997 This setting is inherited by subprocesses. */)
3000 CHECK_NUMBER (mode
);
3002 umask ((~ XINT (mode
)) & 0777);
3007 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3008 doc
: /* Return the default file protection for created files.
3009 The value is an integer. */)
3015 realmask
= umask (0);
3018 XSETINT (value
, (~ realmask
) & 0777);
3023 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3024 doc
: /* Set times of file FILENAME to TIMESTAMP.
3025 Set both access and modification times.
3026 Return t on success, else nil.
3027 Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
3029 (Lisp_Object filename
, Lisp_Object timestamp
)
3031 Lisp_Object absname
, encoded_absname
;
3032 Lisp_Object handler
;
3036 if (! lisp_time_argument (timestamp
, &sec
, &usec
))
3037 error ("Invalid time specification");
3039 absname
= Fexpand_file_name (filename
, BVAR (current_buffer
, directory
));
3041 /* If the file name has special constructs in it,
3042 call the corresponding file handler. */
3043 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3044 if (!NILP (handler
))
3045 return call3 (handler
, Qset_file_times
, absname
, timestamp
);
3047 encoded_absname
= ENCODE_FILE (absname
);
3052 EMACS_SET_SECS (t
, sec
);
3053 EMACS_SET_USECS (t
, usec
);
3055 if (set_file_times (SSDATA (encoded_absname
), t
, t
))
3060 /* Setting times on a directory always fails. */
3061 if (stat (SSDATA (encoded_absname
), &st
) == 0 && S_ISDIR (st
.st_mode
))
3064 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3073 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3074 doc
: /* Tell Unix to finish all pending disk updates. */)
3081 #endif /* HAVE_SYNC */
3083 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3084 doc
: /* Return t if file FILE1 is newer than file FILE2.
3085 If FILE1 does not exist, the answer is nil;
3086 otherwise, if FILE2 does not exist, the answer is t. */)
3087 (Lisp_Object file1
, Lisp_Object file2
)
3089 Lisp_Object absname1
, absname2
;
3092 Lisp_Object handler
;
3093 struct gcpro gcpro1
, gcpro2
;
3095 CHECK_STRING (file1
);
3096 CHECK_STRING (file2
);
3099 GCPRO2 (absname1
, file2
);
3100 absname1
= expand_and_dir_to_file (file1
, BVAR (current_buffer
, directory
));
3101 absname2
= expand_and_dir_to_file (file2
, BVAR (current_buffer
, directory
));
3104 /* If the file name has special constructs in it,
3105 call the corresponding file handler. */
3106 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3108 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3109 if (!NILP (handler
))
3110 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3112 GCPRO2 (absname1
, absname2
);
3113 absname1
= ENCODE_FILE (absname1
);
3114 absname2
= ENCODE_FILE (absname2
);
3117 if (stat (SSDATA (absname1
), &st
) < 0)
3120 mtime1
= st
.st_mtime
;
3122 if (stat (SSDATA (absname2
), &st
) < 0)
3125 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3128 #ifndef READ_BUF_SIZE
3129 #define READ_BUF_SIZE (64 << 10)
3132 /* This function is called after Lisp functions to decide a coding
3133 system are called, or when they cause an error. Before they are
3134 called, the current buffer is set unibyte and it contains only a
3135 newly inserted text (thus the buffer was empty before the
3138 The functions may set markers, overlays, text properties, or even
3139 alter the buffer contents, change the current buffer.
3141 Here, we reset all those changes by:
3142 o set back the current buffer.
3143 o move all markers and overlays to BEG.
3144 o remove all text properties.
3145 o set back the buffer multibyteness. */
3148 decide_coding_unwind (Lisp_Object unwind_data
)
3150 Lisp_Object multibyte
, undo_list
, buffer
;
3152 multibyte
= XCAR (unwind_data
);
3153 unwind_data
= XCDR (unwind_data
);
3154 undo_list
= XCAR (unwind_data
);
3155 buffer
= XCDR (unwind_data
);
3157 if (current_buffer
!= XBUFFER (buffer
))
3158 set_buffer_internal (XBUFFER (buffer
));
3159 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3160 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3161 BUF_INTERVALS (current_buffer
) = 0;
3162 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3164 /* Now we are safe to change the buffer's multibyteness directly. */
3165 BVAR (current_buffer
, enable_multibyte_characters
) = multibyte
;
3166 BVAR (current_buffer
, undo_list
) = undo_list
;
3172 /* Used to pass values from insert-file-contents to read_non_regular. */
3174 static int non_regular_fd
;
3175 static EMACS_INT non_regular_inserted
;
3176 static EMACS_INT non_regular_nbytes
;
3179 /* Read from a non-regular file.
3180 Read non_regular_nbytes bytes max from non_regular_fd.
3181 Non_regular_inserted specifies where to put the read bytes.
3182 Value is the number of bytes read. */
3185 read_non_regular (Lisp_Object ignore
)
3191 nbytes
= emacs_read (non_regular_fd
,
3192 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
3193 + non_regular_inserted
),
3194 non_regular_nbytes
);
3196 return make_number (nbytes
);
3200 /* Condition-case handler used when reading from non-regular files
3201 in insert-file-contents. */
3204 read_non_regular_quit (Lisp_Object ignore
)
3209 /* Reposition FD to OFFSET, based on WHENCE. This acts like lseek
3210 except that it also tests for OFFSET being out of lseek's range. */
3212 emacs_lseek (int fd
, EMACS_INT offset
, int whence
)
3214 /* Use "&" rather than "&&" to suppress a bogus GCC warning; see
3215 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43772>. */
3216 if (! ((TYPE_MINIMUM (off_t
) <= offset
) & (offset
<= TYPE_MAXIMUM (off_t
))))
3221 return lseek (fd
, offset
, whence
);
3225 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3227 doc
: /* Insert contents of file FILENAME after point.
3228 Returns list of absolute file name and number of characters inserted.
3229 If second argument VISIT is non-nil, the buffer's visited filename and
3230 last save file modtime are set, and it is marked unmodified. If
3231 visiting and the file does not exist, visiting is completed before the
3234 The optional third and fourth arguments BEG and END specify what portion
3235 of the file to insert. These arguments count bytes in the file, not
3236 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3238 If optional fifth argument REPLACE is non-nil, replace the current
3239 buffer contents (in the accessible portion) with the file contents.
3240 This is better than simply deleting and inserting the whole thing
3241 because (1) it preserves some marker positions and (2) it puts less data
3242 in the undo list. When REPLACE is non-nil, the second return value is
3243 the number of characters that replace previous buffer contents.
3245 This function does code conversion according to the value of
3246 `coding-system-for-read' or `file-coding-system-alist', and sets the
3247 variable `last-coding-system-used' to the coding system actually used. */)
3248 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3252 EMACS_INT inserted
= 0;
3254 register EMACS_INT how_much
;
3255 off_t beg_offset
, end_offset
;
3256 register EMACS_INT unprocessed
;
3257 int count
= SPECPDL_INDEX ();
3258 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3259 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3261 EMACS_INT total
= 0;
3262 int not_regular
= 0;
3264 char read_buf
[READ_BUF_SIZE
];
3265 struct coding_system coding
;
3266 char buffer
[1 << 14];
3267 int replace_handled
= 0;
3268 int set_coding_system
= 0;
3269 Lisp_Object coding_system
;
3271 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3272 int we_locked_file
= 0;
3273 int deferred_remove_unwind_protect
= 0;
3275 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3276 error ("Cannot do file visiting in an indirect buffer");
3278 if (!NILP (BVAR (current_buffer
, read_only
)))
3279 Fbarf_if_buffer_read_only ();
3283 orig_filename
= Qnil
;
3286 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3288 CHECK_STRING (filename
);
3289 filename
= Fexpand_file_name (filename
, Qnil
);
3291 /* The value Qnil means that the coding system is not yet
3293 coding_system
= Qnil
;
3295 /* If the file name has special constructs in it,
3296 call the corresponding file handler. */
3297 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3298 if (!NILP (handler
))
3300 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3301 visit
, beg
, end
, replace
);
3302 if (CONSP (val
) && CONSP (XCDR (val
)))
3303 inserted
= XINT (XCAR (XCDR (val
)));
3307 orig_filename
= filename
;
3308 filename
= ENCODE_FILE (filename
);
3314 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3316 /* Tell stat to use expensive method to get accurate info. */
3317 Vw32_get_true_file_attributes
= Qt
;
3318 total
= stat (SSDATA (filename
), &st
);
3319 Vw32_get_true_file_attributes
= tem
;
3323 if (stat (SSDATA (filename
), &st
) < 0)
3324 #endif /* WINDOWSNT */
3329 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3333 if (!NILP (Vcoding_system_for_read
))
3334 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3338 /* This code will need to be changed in order to work on named
3339 pipes, and it's probably just not worth it. So we should at
3340 least signal an error. */
3341 if (!S_ISREG (st
.st_mode
))
3348 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3349 xsignal2 (Qfile_error
,
3350 build_string ("not a regular file"), orig_filename
);
3354 if ((fd
= emacs_open (SSDATA (filename
), O_RDONLY
, 0)) < 0)
3357 /* Replacement should preserve point as it preserves markers. */
3358 if (!NILP (replace
))
3359 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3361 record_unwind_protect (close_file_unwind
, make_number (fd
));
3366 if (!NILP (beg
) || !NILP (end
))
3367 error ("Attempt to visit less than an entire file");
3368 if (BEG
< Z
&& NILP (replace
))
3369 error ("Cannot do file visiting in a non-empty buffer");
3374 if (! (RANGED_INTEGERP (0, beg
, TYPE_MAXIMUM (off_t
))))
3375 wrong_type_argument (intern ("file-offset"), beg
);
3376 beg_offset
= XFASTINT (beg
);
3383 if (! (RANGED_INTEGERP (0, end
, TYPE_MAXIMUM (off_t
))))
3384 wrong_type_argument (intern ("file-offset"), end
);
3385 end_offset
= XFASTINT (end
);
3390 end_offset
= TYPE_MAXIMUM (off_t
);
3393 end_offset
= st
.st_size
;
3395 /* A negative size can happen on a platform that allows file
3396 sizes greater than the maximum off_t value. */
3400 /* The file size returned from stat may be zero, but data
3401 may be readable nonetheless, for example when this is a
3402 file in the /proc filesystem. */
3403 if (end_offset
== 0)
3404 end_offset
= READ_BUF_SIZE
;
3408 /* Check now whether the buffer will become too large,
3409 in the likely case where the file's length is not changing.
3410 This saves a lot of needless work before a buffer overflow. */
3413 /* The likely offset where we will stop reading. We could read
3414 more (or less), if the file grows (or shrinks) as we read it. */
3415 off_t likely_end
= min (end_offset
, st
.st_size
);
3417 if (beg_offset
< likely_end
)
3419 ptrdiff_t buf_bytes
=
3420 Z_BYTE
- (!NILP (replace
) ? ZV_BYTE
- BEGV_BYTE
: 0);
3421 ptrdiff_t buf_growth_max
= BUF_BYTES_MAX
- buf_bytes
;
3422 off_t likely_growth
= likely_end
- beg_offset
;
3423 if (buf_growth_max
< likely_growth
)
3428 /* Prevent redisplay optimizations. */
3429 current_buffer
->clip_changed
= 1;
3431 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3433 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3434 setup_coding_system (coding_system
, &coding
);
3435 /* Ensure we set Vlast_coding_system_used. */
3436 set_coding_system
= 1;
3440 /* Decide the coding system to use for reading the file now
3441 because we can't use an optimized method for handling
3442 `coding:' tag if the current buffer is not empty. */
3443 if (!NILP (Vcoding_system_for_read
))
3444 coding_system
= Vcoding_system_for_read
;
3447 /* Don't try looking inside a file for a coding system
3448 specification if it is not seekable. */
3449 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3451 /* Find a coding system specified in the heading two
3452 lines or in the tailing several lines of the file.
3453 We assume that the 1K-byte and 3K-byte for heading
3454 and tailing respectively are sufficient for this
3458 if (st
.st_size
<= (1024 * 4))
3459 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3462 nread
= emacs_read (fd
, read_buf
, 1024);
3465 if (lseek (fd
, st
.st_size
- (1024 * 3), SEEK_SET
) < 0)
3466 report_file_error ("Setting file position",
3467 Fcons (orig_filename
, Qnil
));
3468 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3473 error ("IO error reading %s: %s",
3474 SDATA (orig_filename
), emacs_strerror (errno
));
3477 struct buffer
*prev
= current_buffer
;
3478 Lisp_Object workbuf
;
3481 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3483 workbuf
= Fget_buffer_create (build_string (" *code-converting-work*"));
3484 buf
= XBUFFER (workbuf
);
3486 delete_all_overlays (buf
);
3487 BVAR (buf
, directory
) = BVAR (current_buffer
, directory
);
3488 BVAR (buf
, read_only
) = Qnil
;
3489 BVAR (buf
, filename
) = Qnil
;
3490 BVAR (buf
, undo_list
) = Qt
;
3491 eassert (buf
->overlays_before
== NULL
);
3492 eassert (buf
->overlays_after
== NULL
);
3494 set_buffer_internal (buf
);
3496 BVAR (buf
, enable_multibyte_characters
) = Qnil
;
3498 insert_1_both ((char *) read_buf
, nread
, nread
, 0, 0, 0);
3499 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3500 coding_system
= call2 (Vset_auto_coding_function
,
3501 filename
, make_number (nread
));
3502 set_buffer_internal (prev
);
3504 /* Discard the unwind protect for recovering the
3508 /* Rewind the file for the actual read done later. */
3509 if (lseek (fd
, 0, SEEK_SET
) < 0)
3510 report_file_error ("Setting file position",
3511 Fcons (orig_filename
, Qnil
));
3515 if (NILP (coding_system
))
3517 /* If we have not yet decided a coding system, check
3518 file-coding-system-alist. */
3519 Lisp_Object args
[6];
3521 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3522 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3523 coding_system
= Ffind_operation_coding_system (6, args
);
3524 if (CONSP (coding_system
))
3525 coding_system
= XCAR (coding_system
);
3529 if (NILP (coding_system
))
3530 coding_system
= Qundecided
;
3532 CHECK_CODING_SYSTEM (coding_system
);
3534 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3535 /* We must suppress all character code conversion except for
3536 end-of-line conversion. */
3537 coding_system
= raw_text_coding_system (coding_system
);
3539 setup_coding_system (coding_system
, &coding
);
3540 /* Ensure we set Vlast_coding_system_used. */
3541 set_coding_system
= 1;
3544 /* If requested, replace the accessible part of the buffer
3545 with the file contents. Avoid replacing text at the
3546 beginning or end of the buffer that matches the file contents;
3547 that preserves markers pointing to the unchanged parts.
3549 Here we implement this feature in an optimized way
3550 for the case where code conversion is NOT needed.
3551 The following if-statement handles the case of conversion
3552 in a less optimal way.
3554 If the code conversion is "automatic" then we try using this
3555 method and hope for the best.
3556 But if we discover the need for conversion, we give up on this method
3557 and let the following if-statement handle the replace job. */
3560 && (NILP (coding_system
)
3561 || ! CODING_REQUIRE_DECODING (&coding
)))
3563 /* same_at_start and same_at_end count bytes,
3564 because file access counts bytes
3565 and BEG and END count bytes. */
3566 EMACS_INT same_at_start
= BEGV_BYTE
;
3567 EMACS_INT same_at_end
= ZV_BYTE
;
3569 /* There is still a possibility we will find the need to do code
3570 conversion. If that happens, we set this variable to 1 to
3571 give up on handling REPLACE in the optimized way. */
3572 int giveup_match_end
= 0;
3574 if (beg_offset
!= 0)
3576 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3577 report_file_error ("Setting file position",
3578 Fcons (orig_filename
, Qnil
));
3583 /* Count how many chars at the start of the file
3584 match the text at the beginning of the buffer. */
3587 EMACS_INT nread
, bufpos
;
3589 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3591 error ("IO error reading %s: %s",
3592 SSDATA (orig_filename
), emacs_strerror (errno
));
3593 else if (nread
== 0)
3596 if (CODING_REQUIRE_DETECTION (&coding
))
3598 coding_system
= detect_coding_system ((unsigned char *) buffer
,
3601 setup_coding_system (coding_system
, &coding
);
3604 if (CODING_REQUIRE_DECODING (&coding
))
3605 /* We found that the file should be decoded somehow.
3606 Let's give up here. */
3608 giveup_match_end
= 1;
3613 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3614 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3615 same_at_start
++, bufpos
++;
3616 /* If we found a discrepancy, stop the scan.
3617 Otherwise loop around and scan the next bufferful. */
3618 if (bufpos
!= nread
)
3622 /* If the file matches the buffer completely,
3623 there's no need to replace anything. */
3624 if (same_at_start
- BEGV_BYTE
== end_offset
- beg_offset
)
3628 /* Truncate the buffer to the size of the file. */
3629 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3634 /* Count how many chars at the end of the file
3635 match the text at the end of the buffer. But, if we have
3636 already found that decoding is necessary, don't waste time. */
3637 while (!giveup_match_end
)
3639 int total_read
, nread
, bufpos
, trial
;
3642 /* At what file position are we now scanning? */
3643 curpos
= end_offset
- (ZV_BYTE
- same_at_end
);
3644 /* If the entire file matches the buffer tail, stop the scan. */
3647 /* How much can we scan in the next step? */
3648 trial
= min (curpos
, sizeof buffer
);
3649 if (lseek (fd
, curpos
- trial
, SEEK_SET
) < 0)
3650 report_file_error ("Setting file position",
3651 Fcons (orig_filename
, Qnil
));
3653 total_read
= nread
= 0;
3654 while (total_read
< trial
)
3656 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3658 error ("IO error reading %s: %s",
3659 SDATA (orig_filename
), emacs_strerror (errno
));
3660 else if (nread
== 0)
3662 total_read
+= nread
;
3665 /* Scan this bufferful from the end, comparing with
3666 the Emacs buffer. */
3667 bufpos
= total_read
;
3669 /* Compare with same_at_start to avoid counting some buffer text
3670 as matching both at the file's beginning and at the end. */
3671 while (bufpos
> 0 && same_at_end
> same_at_start
3672 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3673 same_at_end
--, bufpos
--;
3675 /* If we found a discrepancy, stop the scan.
3676 Otherwise loop around and scan the preceding bufferful. */
3679 /* If this discrepancy is because of code conversion,
3680 we cannot use this method; giveup and try the other. */
3681 if (same_at_end
> same_at_start
3682 && FETCH_BYTE (same_at_end
- 1) >= 0200
3683 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
))
3684 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3685 giveup_match_end
= 1;
3694 if (! giveup_match_end
)
3698 /* We win! We can handle REPLACE the optimized way. */
3700 /* Extend the start of non-matching text area to multibyte
3701 character boundary. */
3702 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3703 while (same_at_start
> BEGV_BYTE
3704 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3707 /* Extend the end of non-matching text area to multibyte
3708 character boundary. */
3709 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3710 while (same_at_end
< ZV_BYTE
3711 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3714 /* Don't try to reuse the same piece of text twice. */
3715 overlap
= (same_at_start
- BEGV_BYTE
3717 + (! NILP (end
) ? end_offset
: st
.st_size
) - ZV_BYTE
));
3719 same_at_end
+= overlap
;
3721 /* Arrange to read only the nonmatching middle part of the file. */
3722 beg_offset
+= same_at_start
- BEGV_BYTE
;
3723 end_offset
-= ZV_BYTE
- same_at_end
;
3725 del_range_byte (same_at_start
, same_at_end
, 0);
3726 /* Insert from the file at the proper position. */
3727 temp
= BYTE_TO_CHAR (same_at_start
);
3728 SET_PT_BOTH (temp
, same_at_start
);
3730 /* If display currently starts at beginning of line,
3731 keep it that way. */
3732 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3733 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3735 replace_handled
= 1;
3739 /* If requested, replace the accessible part of the buffer
3740 with the file contents. Avoid replacing text at the
3741 beginning or end of the buffer that matches the file contents;
3742 that preserves markers pointing to the unchanged parts.
3744 Here we implement this feature for the case where code conversion
3745 is needed, in a simple way that needs a lot of memory.
3746 The preceding if-statement handles the case of no conversion
3747 in a more optimized way. */
3748 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3750 EMACS_INT same_at_start
= BEGV_BYTE
;
3751 EMACS_INT same_at_end
= ZV_BYTE
;
3752 EMACS_INT same_at_start_charpos
;
3753 EMACS_INT inserted_chars
;
3756 unsigned char *decoded
;
3759 int this_count
= SPECPDL_INDEX ();
3760 int multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
3761 Lisp_Object conversion_buffer
;
3762 struct gcpro gcpro1
;
3764 conversion_buffer
= code_conversion_save (1, multibyte
);
3766 /* First read the whole file, performing code conversion into
3767 CONVERSION_BUFFER. */
3769 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3770 report_file_error ("Setting file position",
3771 Fcons (orig_filename
, Qnil
));
3773 total
= st
.st_size
; /* Total bytes in the file. */
3774 how_much
= 0; /* Bytes read from file so far. */
3775 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3776 unprocessed
= 0; /* Bytes not processed in previous loop. */
3778 GCPRO1 (conversion_buffer
);
3779 while (how_much
< total
)
3781 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3782 quitting while reading a huge while. */
3783 /* `try'' is reserved in some compilers (Microsoft C). */
3784 EMACS_INT trytry
= min (total
- how_much
,
3785 READ_BUF_SIZE
- unprocessed
);
3787 /* Allow quitting out of the actual I/O. */
3790 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3798 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3799 BUF_Z (XBUFFER (conversion_buffer
)));
3800 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3801 unprocessed
+ this, conversion_buffer
);
3802 unprocessed
= coding
.carryover_bytes
;
3803 if (coding
.carryover_bytes
> 0)
3804 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3809 /* We should remove the unwind_protect calling
3810 close_file_unwind, but other stuff has been added the stack,
3811 so defer the removal till we reach the `handled' label. */
3812 deferred_remove_unwind_protect
= 1;
3814 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3815 if we couldn't read the file. */
3818 error ("IO error reading %s: %s",
3819 SDATA (orig_filename
), emacs_strerror (errno
));
3821 if (unprocessed
> 0)
3823 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3824 decode_coding_c_string (&coding
, (unsigned char *) read_buf
,
3825 unprocessed
, conversion_buffer
);
3826 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3829 coding_system
= CODING_ID_NAME (coding
.id
);
3830 set_coding_system
= 1;
3831 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3832 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3833 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3835 /* Compare the beginning of the converted string with the buffer
3839 while (bufpos
< inserted
&& same_at_start
< same_at_end
3840 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3841 same_at_start
++, bufpos
++;
3843 /* If the file matches the head of buffer completely,
3844 there's no need to replace anything. */
3846 if (bufpos
== inserted
)
3848 /* Truncate the buffer to the size of the file. */
3849 if (same_at_start
== same_at_end
)
3852 del_range_byte (same_at_start
, same_at_end
, 0);
3855 unbind_to (this_count
, Qnil
);
3859 /* Extend the start of non-matching text area to the previous
3860 multibyte character boundary. */
3861 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3862 while (same_at_start
> BEGV_BYTE
3863 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3866 /* Scan this bufferful from the end, comparing with
3867 the Emacs buffer. */
3870 /* Compare with same_at_start to avoid counting some buffer text
3871 as matching both at the file's beginning and at the end. */
3872 while (bufpos
> 0 && same_at_end
> same_at_start
3873 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3874 same_at_end
--, bufpos
--;
3876 /* Extend the end of non-matching text area to the next
3877 multibyte character boundary. */
3878 if (! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
3879 while (same_at_end
< ZV_BYTE
3880 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3883 /* Don't try to reuse the same piece of text twice. */
3884 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3886 same_at_end
+= overlap
;
3888 /* If display currently starts at beginning of line,
3889 keep it that way. */
3890 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3891 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3893 /* Replace the chars that we need to replace,
3894 and update INSERTED to equal the number of bytes
3895 we are taking from the decoded string. */
3896 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3898 if (same_at_end
!= same_at_start
)
3900 del_range_byte (same_at_start
, same_at_end
, 0);
3902 same_at_start
= GPT_BYTE
;
3906 temp
= BYTE_TO_CHAR (same_at_start
);
3908 /* Insert from the file at the proper position. */
3909 SET_PT_BOTH (temp
, same_at_start
);
3910 same_at_start_charpos
3911 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3912 same_at_start
- BEGV_BYTE
3913 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3915 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3916 same_at_start
+ inserted
- BEGV_BYTE
3917 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3918 - same_at_start_charpos
);
3919 /* This binding is to avoid ask-user-about-supersession-threat
3920 being called in insert_from_buffer (via in
3921 prepare_to_modify_buffer). */
3922 specbind (intern ("buffer-file-name"), Qnil
);
3923 insert_from_buffer (XBUFFER (conversion_buffer
),
3924 same_at_start_charpos
, inserted_chars
, 0);
3925 /* Set `inserted' to the number of inserted characters. */
3926 inserted
= PT
- temp
;
3927 /* Set point before the inserted characters. */
3928 SET_PT_BOTH (temp
, same_at_start
);
3930 unbind_to (this_count
, Qnil
);
3936 total
= end_offset
- beg_offset
;
3938 /* For a special file, all we can do is guess. */
3939 total
= READ_BUF_SIZE
;
3941 if (NILP (visit
) && total
> 0)
3943 #ifdef CLASH_DETECTION
3944 if (!NILP (BVAR (current_buffer
, file_truename
))
3945 /* Make binding buffer-file-name to nil effective. */
3946 && !NILP (BVAR (current_buffer
, filename
))
3947 && SAVE_MODIFF
>= MODIFF
)
3949 #endif /* CLASH_DETECTION */
3950 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3954 if (GAP_SIZE
< total
)
3955 make_gap (total
- GAP_SIZE
);
3957 if (beg_offset
!= 0 || !NILP (replace
))
3959 if (lseek (fd
, beg_offset
, SEEK_SET
) < 0)
3960 report_file_error ("Setting file position",
3961 Fcons (orig_filename
, Qnil
));
3964 /* In the following loop, HOW_MUCH contains the total bytes read so
3965 far for a regular file, and not changed for a special file. But,
3966 before exiting the loop, it is set to a negative value if I/O
3970 /* Total bytes inserted. */
3973 /* Here, we don't do code conversion in the loop. It is done by
3974 decode_coding_gap after all data are read into the buffer. */
3976 EMACS_INT gap_size
= GAP_SIZE
;
3978 while (how_much
< total
)
3980 /* try is reserved in some compilers (Microsoft C) */
3981 EMACS_INT trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3988 /* Maybe make more room. */
3989 if (gap_size
< trytry
)
3991 make_gap (total
- gap_size
);
3992 gap_size
= GAP_SIZE
;
3995 /* Read from the file, capturing `quit'. When an
3996 error occurs, end the loop, and arrange for a quit
3997 to be signaled after decoding the text we read. */
3998 non_regular_fd
= fd
;
3999 non_regular_inserted
= inserted
;
4000 non_regular_nbytes
= trytry
;
4001 nbytes
= internal_condition_case_1 (read_non_regular
,
4003 read_non_regular_quit
);
4010 this = XINT (nbytes
);
4014 /* Allow quitting out of the actual I/O. We don't make text
4015 part of the buffer until all the reading is done, so a C-g
4016 here doesn't do any harm. */
4019 this = emacs_read (fd
,
4020 ((char *) BEG_ADDR
+ PT_BYTE
- BEG_BYTE
4034 /* For a regular file, where TOTAL is the real size,
4035 count HOW_MUCH to compare with it.
4036 For a special file, where TOTAL is just a buffer size,
4037 so don't bother counting in HOW_MUCH.
4038 (INSERTED is where we count the number of characters inserted.) */
4045 /* Now we have read all the file data into the gap.
4046 If it was empty, undo marking the buffer modified. */
4050 #ifdef CLASH_DETECTION
4052 unlock_file (BVAR (current_buffer
, file_truename
));
4054 Vdeactivate_mark
= old_Vdeactivate_mark
;
4057 Vdeactivate_mark
= Qt
;
4059 /* Make the text read part of the buffer. */
4060 GAP_SIZE
-= inserted
;
4062 GPT_BYTE
+= inserted
;
4064 ZV_BYTE
+= inserted
;
4069 /* Put an anchor to ensure multi-byte form ends at gap. */
4074 /* Discard the unwind protect for closing the file. */
4078 error ("IO error reading %s: %s",
4079 SDATA (orig_filename
), emacs_strerror (errno
));
4083 if (NILP (coding_system
))
4085 /* The coding system is not yet decided. Decide it by an
4086 optimized method for handling `coding:' tag.
4088 Note that we can get here only if the buffer was empty
4089 before the insertion. */
4091 if (!NILP (Vcoding_system_for_read
))
4092 coding_system
= Vcoding_system_for_read
;
4095 /* Since we are sure that the current buffer was empty
4096 before the insertion, we can toggle
4097 enable-multibyte-characters directly here without taking
4098 care of marker adjustment. By this way, we can run Lisp
4099 program safely before decoding the inserted text. */
4100 Lisp_Object unwind_data
;
4101 int count1
= SPECPDL_INDEX ();
4103 unwind_data
= Fcons (BVAR (current_buffer
, enable_multibyte_characters
),
4104 Fcons (BVAR (current_buffer
, undo_list
),
4105 Fcurrent_buffer ()));
4106 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
4107 BVAR (current_buffer
, undo_list
) = Qt
;
4108 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4110 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4112 coding_system
= call2 (Vset_auto_coding_function
,
4113 filename
, make_number (inserted
));
4116 if (NILP (coding_system
))
4118 /* If the coding system is not yet decided, check
4119 file-coding-system-alist. */
4120 Lisp_Object args
[6];
4122 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4123 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4124 coding_system
= Ffind_operation_coding_system (6, args
);
4125 if (CONSP (coding_system
))
4126 coding_system
= XCAR (coding_system
);
4128 unbind_to (count1
, Qnil
);
4129 inserted
= Z_BYTE
- BEG_BYTE
;
4132 if (NILP (coding_system
))
4133 coding_system
= Qundecided
;
4135 CHECK_CODING_SYSTEM (coding_system
);
4137 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4138 /* We must suppress all character code conversion except for
4139 end-of-line conversion. */
4140 coding_system
= raw_text_coding_system (coding_system
);
4141 setup_coding_system (coding_system
, &coding
);
4142 /* Ensure we set Vlast_coding_system_used. */
4143 set_coding_system
= 1;
4148 /* When we visit a file by raw-text, we change the buffer to
4150 if (CODING_FOR_UNIBYTE (&coding
)
4151 /* Can't do this if part of the buffer might be preserved. */
4153 /* Visiting a file with these coding system makes the buffer
4155 BVAR (current_buffer
, enable_multibyte_characters
) = Qnil
;
4158 coding
.dst_multibyte
= ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
4159 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4160 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4162 move_gap_both (PT
, PT_BYTE
);
4163 GAP_SIZE
+= inserted
;
4164 ZV_BYTE
-= inserted
;
4168 decode_coding_gap (&coding
, inserted
, inserted
);
4169 inserted
= coding
.produced_char
;
4170 coding_system
= CODING_ID_NAME (coding
.id
);
4172 else if (inserted
> 0)
4173 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4176 /* Call after-change hooks for the inserted text, aside from the case
4177 of normal visiting (not with REPLACE), which is done in a new buffer
4178 "before" the buffer is changed. */
4179 if (inserted
> 0 && total
> 0
4180 && (NILP (visit
) || !NILP (replace
)))
4182 signal_after_change (PT
, 0, inserted
);
4183 update_compositions (PT
, PT
, CHECK_BORDER
);
4186 /* Now INSERTED is measured in characters. */
4190 if (deferred_remove_unwind_protect
)
4191 /* If requested above, discard the unwind protect for closing the
4197 if (!EQ (BVAR (current_buffer
, undo_list
), Qt
) && !nochange
)
4198 BVAR (current_buffer
, undo_list
) = Qnil
;
4202 current_buffer
->modtime
= st
.st_mtime
;
4203 current_buffer
->modtime_size
= st
.st_size
;
4204 BVAR (current_buffer
, filename
) = orig_filename
;
4207 SAVE_MODIFF
= MODIFF
;
4208 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4209 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4210 #ifdef CLASH_DETECTION
4213 if (!NILP (BVAR (current_buffer
, file_truename
)))
4214 unlock_file (BVAR (current_buffer
, file_truename
));
4215 unlock_file (filename
);
4217 #endif /* CLASH_DETECTION */
4219 xsignal2 (Qfile_error
,
4220 build_string ("not a regular file"), orig_filename
);
4223 if (set_coding_system
)
4224 Vlast_coding_system_used
= coding_system
;
4226 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4228 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4230 if (! NILP (insval
))
4232 CHECK_NUMBER (insval
);
4233 inserted
= XFASTINT (insval
);
4237 /* Decode file format. */
4240 /* Don't run point motion or modification hooks when decoding. */
4241 int count1
= SPECPDL_INDEX ();
4242 EMACS_INT old_inserted
= inserted
;
4243 specbind (Qinhibit_point_motion_hooks
, Qt
);
4244 specbind (Qinhibit_modification_hooks
, Qt
);
4246 /* Save old undo list and don't record undo for decoding. */
4247 old_undo
= BVAR (current_buffer
, undo_list
);
4248 BVAR (current_buffer
, undo_list
) = Qt
;
4252 insval
= call3 (Qformat_decode
,
4253 Qnil
, make_number (inserted
), visit
);
4254 CHECK_NUMBER (insval
);
4255 inserted
= XFASTINT (insval
);
4259 /* If REPLACE is non-nil and we succeeded in not replacing the
4260 beginning or end of the buffer text with the file's contents,
4261 call format-decode with `point' positioned at the beginning
4262 of the buffer and `inserted' equaling the number of
4263 characters in the buffer. Otherwise, format-decode might
4264 fail to correctly analyze the beginning or end of the buffer.
4265 Hence we temporarily save `point' and `inserted' here and
4266 restore `point' iff format-decode did not insert or delete
4267 any text. Otherwise we leave `point' at point-min. */
4268 EMACS_INT opoint
= PT
;
4269 EMACS_INT opoint_byte
= PT_BYTE
;
4270 EMACS_INT oinserted
= ZV
- BEGV
;
4271 int ochars_modiff
= CHARS_MODIFF
;
4273 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4274 insval
= call3 (Qformat_decode
,
4275 Qnil
, make_number (oinserted
), visit
);
4276 CHECK_NUMBER (insval
);
4277 if (ochars_modiff
== CHARS_MODIFF
)
4278 /* format_decode didn't modify buffer's characters => move
4279 point back to position before inserted text and leave
4280 value of inserted alone. */
4281 SET_PT_BOTH (opoint
, opoint_byte
);
4283 /* format_decode modified buffer's characters => consider
4284 entire buffer changed and leave point at point-min. */
4285 inserted
= XFASTINT (insval
);
4288 /* For consistency with format-decode call these now iff inserted > 0
4289 (martin 2007-06-28). */
4290 p
= Vafter_insert_file_functions
;
4295 insval
= call1 (XCAR (p
), make_number (inserted
));
4298 CHECK_NUMBER (insval
);
4299 inserted
= XFASTINT (insval
);
4304 /* For the rationale of this see the comment on
4305 format-decode above. */
4306 EMACS_INT opoint
= PT
;
4307 EMACS_INT opoint_byte
= PT_BYTE
;
4308 EMACS_INT oinserted
= ZV
- BEGV
;
4309 int ochars_modiff
= CHARS_MODIFF
;
4311 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4312 insval
= call1 (XCAR (p
), make_number (oinserted
));
4315 CHECK_NUMBER (insval
);
4316 if (ochars_modiff
== CHARS_MODIFF
)
4317 /* after_insert_file_functions didn't modify
4318 buffer's characters => move point back to
4319 position before inserted text and leave value of
4321 SET_PT_BOTH (opoint
, opoint_byte
);
4323 /* after_insert_file_functions did modify buffer's
4324 characters => consider entire buffer changed and
4325 leave point at point-min. */
4326 inserted
= XFASTINT (insval
);
4336 BVAR (current_buffer
, undo_list
) = old_undo
;
4337 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4339 /* Adjust the last undo record for the size change during
4340 the format conversion. */
4341 Lisp_Object tem
= XCAR (old_undo
);
4342 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4343 && INTEGERP (XCDR (tem
))
4344 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4345 XSETCDR (tem
, make_number (PT
+ inserted
));
4349 /* If undo_list was Qt before, keep it that way.
4350 Otherwise start with an empty undo_list. */
4351 BVAR (current_buffer
, undo_list
) = EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4353 unbind_to (count1
, Qnil
);
4357 && current_buffer
->modtime
== -1)
4359 /* If visiting nonexistent file, return nil. */
4361 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4365 Fsignal (Qquit
, Qnil
);
4367 /* ??? Retval needs to be dealt with in all cases consistently. */
4369 val
= Fcons (orig_filename
,
4370 Fcons (make_number (inserted
),
4373 RETURN_UNGCPRO (unbind_to (count
, val
));
4376 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4379 build_annotations_unwind (Lisp_Object arg
)
4381 Vwrite_region_annotation_buffers
= arg
;
4385 /* Decide the coding-system to encode the data with. */
4388 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4389 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4390 struct coding_system
*coding
)
4393 Lisp_Object eol_parent
= Qnil
;
4396 && NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4397 BVAR (current_buffer
, auto_save_file_name
))))
4402 else if (!NILP (Vcoding_system_for_write
))
4404 val
= Vcoding_system_for_write
;
4405 if (coding_system_require_warning
4406 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4407 /* Confirm that VAL can surely encode the current region. */
4408 val
= call5 (Vselect_safe_coding_system_function
,
4409 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4414 /* If the variable `buffer-file-coding-system' is set locally,
4415 it means that the file was read with some kind of code
4416 conversion or the variable is explicitly set by users. We
4417 had better write it out with the same coding system even if
4418 `enable-multibyte-characters' is nil.
4420 If it is not set locally, we anyway have to convert EOL
4421 format if the default value of `buffer-file-coding-system'
4422 tells that it is not Unix-like (LF only) format. */
4423 int using_default_coding
= 0;
4424 int force_raw_text
= 0;
4426 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4428 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4431 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
4437 /* Check file-coding-system-alist. */
4438 Lisp_Object args
[7], coding_systems
;
4440 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4441 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4443 coding_systems
= Ffind_operation_coding_system (7, args
);
4444 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4445 val
= XCDR (coding_systems
);
4450 /* If we still have not decided a coding system, use the
4451 default value of buffer-file-coding-system. */
4452 val
= BVAR (current_buffer
, buffer_file_coding_system
);
4453 using_default_coding
= 1;
4456 if (! NILP (val
) && ! force_raw_text
)
4458 Lisp_Object spec
, attrs
;
4460 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4461 attrs
= AREF (spec
, 0);
4462 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4467 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4468 /* Confirm that VAL can surely encode the current region. */
4469 val
= call5 (Vselect_safe_coding_system_function
,
4470 start
, end
, val
, Qnil
, filename
);
4472 /* If the decided coding-system doesn't specify end-of-line
4473 format, we use that of
4474 `default-buffer-file-coding-system'. */
4475 if (! using_default_coding
4476 && ! NILP (BVAR (&buffer_defaults
, buffer_file_coding_system
)))
4477 val
= (coding_inherit_eol_type
4478 (val
, BVAR (&buffer_defaults
, buffer_file_coding_system
)));
4480 /* If we decide not to encode text, use `raw-text' or one of its
4483 val
= raw_text_coding_system (val
);
4486 val
= coding_inherit_eol_type (val
, eol_parent
);
4487 setup_coding_system (val
, coding
);
4489 if (!STRINGP (start
) && !NILP (BVAR (current_buffer
, selective_display
)))
4490 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4494 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4495 "r\nFWrite region to file: \ni\ni\ni\np",
4496 doc
: /* Write current region into specified file.
4497 When called from a program, requires three arguments:
4498 START, END and FILENAME. START and END are normally buffer positions
4499 specifying the part of the buffer to write.
4500 If START is nil, that means to use the entire buffer contents.
4501 If START is a string, then output that string to the file
4502 instead of any buffer contents; END is ignored.
4504 Optional fourth argument APPEND if non-nil means
4505 append to existing file contents (if any). If it is an integer,
4506 seek to that offset in the file before writing.
4507 Optional fifth argument VISIT, if t or a string, means
4508 set the last-save-file-modtime of buffer to this file's modtime
4509 and mark buffer not modified.
4510 If VISIT is a string, it is a second file name;
4511 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4512 VISIT is also the file name to lock and unlock for clash detection.
4513 If VISIT is neither t nor nil nor a string,
4514 that means do not display the \"Wrote file\" message.
4515 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4516 use for locking and unlocking, overriding FILENAME and VISIT.
4517 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4518 for an existing file with the same name. If MUSTBENEW is `excl',
4519 that means to get an error if the file already exists; never overwrite.
4520 If MUSTBENEW is neither nil nor `excl', that means ask for
4521 confirmation before overwriting, but do go ahead and overwrite the file
4522 if the user confirms.
4524 This does code conversion according to the value of
4525 `coding-system-for-write', `buffer-file-coding-system', or
4526 `file-coding-system-alist', and sets the variable
4527 `last-coding-system-used' to the coding system actually used.
4529 This calls `write-region-annotate-functions' at the start, and
4530 `write-region-post-annotation-function' at the end. */)
4531 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4538 int count
= SPECPDL_INDEX ();
4540 Lisp_Object handler
;
4541 Lisp_Object visit_file
;
4542 Lisp_Object annotations
;
4543 Lisp_Object encoded_filename
;
4544 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4545 int quietly
= !NILP (visit
);
4546 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4547 struct buffer
*given_buffer
;
4548 struct coding_system coding
;
4550 if (current_buffer
->base_buffer
&& visiting
)
4551 error ("Cannot do file visiting in an indirect buffer");
4553 if (!NILP (start
) && !STRINGP (start
))
4554 validate_region (&start
, &end
);
4557 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4559 filename
= Fexpand_file_name (filename
, Qnil
);
4561 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4562 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4564 if (STRINGP (visit
))
4565 visit_file
= Fexpand_file_name (visit
, Qnil
);
4567 visit_file
= filename
;
4569 if (NILP (lockname
))
4570 lockname
= visit_file
;
4574 /* If the file name has special constructs in it,
4575 call the corresponding file handler. */
4576 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4577 /* If FILENAME has no handler, see if VISIT has one. */
4578 if (NILP (handler
) && STRINGP (visit
))
4579 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4581 if (!NILP (handler
))
4584 val
= call6 (handler
, Qwrite_region
, start
, end
,
4585 filename
, append
, visit
);
4589 SAVE_MODIFF
= MODIFF
;
4590 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4591 BVAR (current_buffer
, filename
) = visit_file
;
4597 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4599 /* Special kludge to simplify auto-saving. */
4602 /* Do it later, so write-region-annotate-function can work differently
4603 if we save "the buffer" vs "a region".
4604 This is useful in tar-mode. --Stef
4605 XSETFASTINT (start, BEG);
4606 XSETFASTINT (end, Z); */
4610 record_unwind_protect (build_annotations_unwind
,
4611 Vwrite_region_annotation_buffers
);
4612 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4613 count1
= SPECPDL_INDEX ();
4615 given_buffer
= current_buffer
;
4617 if (!STRINGP (start
))
4619 annotations
= build_annotations (start
, end
);
4621 if (current_buffer
!= given_buffer
)
4623 XSETFASTINT (start
, BEGV
);
4624 XSETFASTINT (end
, ZV
);
4630 XSETFASTINT (start
, BEGV
);
4631 XSETFASTINT (end
, ZV
);
4636 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4638 /* Decide the coding-system to encode the data with.
4639 We used to make this choice before calling build_annotations, but that
4640 leads to problems when a write-annotate-function takes care of
4641 unsavable chars (as was the case with X-Symbol). */
4642 Vlast_coding_system_used
4643 = choose_write_coding_system (start
, end
, filename
,
4644 append
, visit
, lockname
, &coding
);
4646 #ifdef CLASH_DETECTION
4648 lock_file (lockname
);
4649 #endif /* CLASH_DETECTION */
4651 encoded_filename
= ENCODE_FILE (filename
);
4653 fn
= SSDATA (encoded_filename
);
4657 desc
= emacs_open (fn
, O_WRONLY
| O_BINARY
, 0);
4658 #else /* not DOS_NT */
4659 desc
= emacs_open (fn
, O_WRONLY
, 0);
4660 #endif /* not DOS_NT */
4662 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4664 desc
= emacs_open (fn
,
4665 O_WRONLY
| O_CREAT
| O_BINARY
4666 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4667 S_IREAD
| S_IWRITE
);
4668 #else /* not DOS_NT */
4669 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4670 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4671 auto_saving
? auto_save_mode_bits
: 0666);
4672 #endif /* not DOS_NT */
4676 #ifdef CLASH_DETECTION
4678 if (!auto_saving
) unlock_file (lockname
);
4680 #endif /* CLASH_DETECTION */
4682 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4685 record_unwind_protect (close_file_unwind
, make_number (desc
));
4687 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4691 if (NUMBERP (append
))
4692 ret
= emacs_lseek (desc
, XINT (append
), SEEK_CUR
);
4694 ret
= lseek (desc
, 0, SEEK_END
);
4697 #ifdef CLASH_DETECTION
4699 if (!auto_saving
) unlock_file (lockname
);
4701 #endif /* CLASH_DETECTION */
4703 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4712 if (STRINGP (start
))
4714 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4715 &annotations
, &coding
);
4718 else if (XINT (start
) != XINT (end
))
4720 failure
= 0 > a_write (desc
, Qnil
,
4721 XINT (start
), XINT (end
) - XINT (start
),
4722 &annotations
, &coding
);
4727 /* If file was empty, still need to write the annotations */
4728 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4729 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4733 if (CODING_REQUIRE_FLUSHING (&coding
)
4734 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4737 /* We have to flush out a data. */
4738 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4739 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4746 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4747 Disk full in NFS may be reported here. */
4748 /* mib says that closing the file will try to write as fast as NFS can do
4749 it, and that means the fsync here is not crucial for autosave files. */
4750 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4752 /* If fsync fails with EINTR, don't treat that as serious. Also
4753 ignore EINVAL which happens when fsync is not supported on this
4755 if (errno
!= EINTR
&& errno
!= EINVAL
)
4756 failure
= 1, save_errno
= errno
;
4760 /* NFS can report a write failure now. */
4761 if (emacs_close (desc
) < 0)
4762 failure
= 1, save_errno
= errno
;
4766 /* Discard the unwind protect for close_file_unwind. */
4767 specpdl_ptr
= specpdl
+ count1
;
4769 /* Call write-region-post-annotation-function. */
4770 while (CONSP (Vwrite_region_annotation_buffers
))
4772 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4773 if (!NILP (Fbuffer_live_p (buf
)))
4776 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4777 call0 (Vwrite_region_post_annotation_function
);
4779 Vwrite_region_annotation_buffers
4780 = XCDR (Vwrite_region_annotation_buffers
);
4783 unbind_to (count
, Qnil
);
4785 #ifdef CLASH_DETECTION
4787 unlock_file (lockname
);
4788 #endif /* CLASH_DETECTION */
4790 /* Do this before reporting IO error
4791 to avoid a "file has changed on disk" warning on
4792 next attempt to save. */
4795 current_buffer
->modtime
= st
.st_mtime
;
4796 current_buffer
->modtime_size
= st
.st_size
;
4800 error ("IO error writing %s: %s", SDATA (filename
),
4801 emacs_strerror (save_errno
));
4805 SAVE_MODIFF
= MODIFF
;
4806 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
4807 BVAR (current_buffer
, filename
) = visit_file
;
4808 update_mode_lines
++;
4813 && ! NILP (Fstring_equal (BVAR (current_buffer
, filename
),
4814 BVAR (current_buffer
, auto_save_file_name
))))
4815 SAVE_MODIFF
= MODIFF
;
4821 message_with_string ((INTEGERP (append
)
4831 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4833 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4834 doc
: /* Return t if (car A) is numerically less than (car B). */)
4835 (Lisp_Object a
, Lisp_Object b
)
4837 return Flss (Fcar (a
), Fcar (b
));
4840 /* Build the complete list of annotations appropriate for writing out
4841 the text between START and END, by calling all the functions in
4842 write-region-annotate-functions and merging the lists they return.
4843 If one of these functions switches to a different buffer, we assume
4844 that buffer contains altered text. Therefore, the caller must
4845 make sure to restore the current buffer in all cases,
4846 as save-excursion would do. */
4849 build_annotations (Lisp_Object start
, Lisp_Object end
)
4851 Lisp_Object annotations
;
4853 struct gcpro gcpro1
, gcpro2
;
4854 Lisp_Object original_buffer
;
4855 int i
, used_global
= 0;
4857 XSETBUFFER (original_buffer
, current_buffer
);
4860 p
= Vwrite_region_annotate_functions
;
4861 GCPRO2 (annotations
, p
);
4864 struct buffer
*given_buffer
= current_buffer
;
4865 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4866 { /* Use the global value of the hook. */
4869 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4871 p
= Fappend (2, arg
);
4874 Vwrite_region_annotations_so_far
= annotations
;
4875 res
= call2 (XCAR (p
), start
, end
);
4876 /* If the function makes a different buffer current,
4877 assume that means this buffer contains altered text to be output.
4878 Reset START and END from the buffer bounds
4879 and discard all previous annotations because they should have
4880 been dealt with by this function. */
4881 if (current_buffer
!= given_buffer
)
4883 Vwrite_region_annotation_buffers
4884 = Fcons (Fcurrent_buffer (),
4885 Vwrite_region_annotation_buffers
);
4886 XSETFASTINT (start
, BEGV
);
4887 XSETFASTINT (end
, ZV
);
4890 Flength (res
); /* Check basic validity of return value */
4891 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4895 /* Now do the same for annotation functions implied by the file-format */
4896 if (auto_saving
&& (!EQ (BVAR (current_buffer
, auto_save_file_format
), Qt
)))
4897 p
= BVAR (current_buffer
, auto_save_file_format
);
4899 p
= BVAR (current_buffer
, file_format
);
4900 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4902 struct buffer
*given_buffer
= current_buffer
;
4904 Vwrite_region_annotations_so_far
= annotations
;
4906 /* Value is either a list of annotations or nil if the function
4907 has written annotations to a temporary buffer, which is now
4909 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4910 original_buffer
, make_number (i
));
4911 if (current_buffer
!= given_buffer
)
4913 XSETFASTINT (start
, BEGV
);
4914 XSETFASTINT (end
, ZV
);
4919 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4927 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4928 If STRING is nil, POS is the character position in the current buffer.
4929 Intersperse with them the annotations from *ANNOT
4930 which fall within the range of POS to POS + NCHARS,
4931 each at its appropriate position.
4933 We modify *ANNOT by discarding elements as we use them up.
4935 The return value is negative in case of system call failure. */
4938 a_write (int desc
, Lisp_Object string
, EMACS_INT pos
,
4939 register EMACS_INT nchars
, Lisp_Object
*annot
,
4940 struct coding_system
*coding
)
4944 EMACS_INT lastpos
= pos
+ nchars
;
4946 while (NILP (*annot
) || CONSP (*annot
))
4948 tem
= Fcar_safe (Fcar (*annot
));
4951 nextpos
= XFASTINT (tem
);
4953 /* If there are no more annotations in this range,
4954 output the rest of the range all at once. */
4955 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4956 return e_write (desc
, string
, pos
, lastpos
, coding
);
4958 /* Output buffer text up to the next annotation's position. */
4961 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4965 /* Output the annotation. */
4966 tem
= Fcdr (Fcar (*annot
));
4969 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4972 *annot
= Fcdr (*annot
);
4978 /* Write text in the range START and END into descriptor DESC,
4979 encoding them with coding system CODING. If STRING is nil, START
4980 and END are character positions of the current buffer, else they
4981 are indexes to the string STRING. */
4984 e_write (int desc
, Lisp_Object string
, EMACS_INT start
, EMACS_INT end
,
4985 struct coding_system
*coding
)
4987 if (STRINGP (string
))
4990 end
= SCHARS (string
);
4993 /* We used to have a code for handling selective display here. But,
4994 now it is handled within encode_coding. */
4998 if (STRINGP (string
))
5000 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
5001 if (CODING_REQUIRE_ENCODING (coding
))
5003 encode_coding_object (coding
, string
,
5004 start
, string_char_to_byte (string
, start
),
5005 end
, string_char_to_byte (string
, end
), Qt
);
5009 coding
->dst_object
= string
;
5010 coding
->consumed_char
= SCHARS (string
);
5011 coding
->produced
= SBYTES (string
);
5016 EMACS_INT start_byte
= CHAR_TO_BYTE (start
);
5017 EMACS_INT end_byte
= CHAR_TO_BYTE (end
);
5019 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5020 if (CODING_REQUIRE_ENCODING (coding
))
5022 encode_coding_object (coding
, Fcurrent_buffer (),
5023 start
, start_byte
, end
, end_byte
, Qt
);
5027 coding
->dst_object
= Qnil
;
5028 coding
->dst_pos_byte
= start_byte
;
5029 if (start
>= GPT
|| end
<= GPT
)
5031 coding
->consumed_char
= end
- start
;
5032 coding
->produced
= end_byte
- start_byte
;
5036 coding
->consumed_char
= GPT
- start
;
5037 coding
->produced
= GPT_BYTE
- start_byte
;
5042 if (coding
->produced
> 0)
5046 STRINGP (coding
->dst_object
)
5047 ? SSDATA (coding
->dst_object
)
5048 : (char *) BYTE_POS_ADDR (coding
->dst_pos_byte
),
5051 if (coding
->produced
)
5054 start
+= coding
->consumed_char
;
5060 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5061 Sverify_visited_file_modtime
, 0, 1, 0,
5062 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5063 This means that the file has not been changed since it was visited or saved.
5064 If BUF is omitted or nil, it defaults to the current buffer.
5065 See Info node `(elisp)Modification Time' for more details. */)
5070 Lisp_Object handler
;
5071 Lisp_Object filename
;
5081 if (!STRINGP (BVAR (b
, filename
))) return Qt
;
5082 if (b
->modtime
== 0) return Qt
;
5084 /* If the file name has special constructs in it,
5085 call the corresponding file handler. */
5086 handler
= Ffind_file_name_handler (BVAR (b
, filename
),
5087 Qverify_visited_file_modtime
);
5088 if (!NILP (handler
))
5089 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5091 filename
= ENCODE_FILE (BVAR (b
, filename
));
5093 if (stat (SSDATA (filename
), &st
) < 0)
5095 /* If the file doesn't exist now and didn't exist before,
5096 we say that it isn't modified, provided the error is a tame one. */
5097 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
5102 if ((st
.st_mtime
== b
->modtime
5103 /* If both are positive, accept them if they are off by one second. */
5104 || (st
.st_mtime
> 0 && b
->modtime
> 0
5105 && (st
.st_mtime
- 1 == b
->modtime
5106 || st
.st_mtime
== b
->modtime
- 1)))
5107 && (st
.st_size
== b
->modtime_size
5108 || b
->modtime_size
< 0))
5113 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5114 Sclear_visited_file_modtime
, 0, 0, 0,
5115 doc
: /* Clear out records of last mod time of visited file.
5116 Next attempt to save will certainly not complain of a discrepancy. */)
5119 current_buffer
->modtime
= 0;
5120 current_buffer
->modtime_size
= -1;
5124 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5125 Svisited_file_modtime
, 0, 0, 0,
5126 doc
: /* Return the current buffer's recorded visited file modification time.
5127 The value is a list of the form (HIGH LOW), like the time values that
5128 `file-attributes' returns. If the current buffer has no recorded file
5129 modification time, this function returns 0. If the visited file
5130 doesn't exist, HIGH will be -1.
5131 See Info node `(elisp)Modification Time' for more details. */)
5134 if (! current_buffer
->modtime
)
5135 return make_number (0);
5136 return make_time (current_buffer
->modtime
);
5139 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5140 Sset_visited_file_modtime
, 0, 1, 0,
5141 doc
: /* Update buffer's recorded modification time from the visited file's time.
5142 Useful if the buffer was not read from the file normally
5143 or if the file itself has been changed for some known benign reason.
5144 An argument specifies the modification time value to use
5145 \(instead of that of the visited file), in the form of a list
5146 \(HIGH . LOW) or (HIGH LOW). */)
5147 (Lisp_Object time_list
)
5149 if (!NILP (time_list
))
5151 CONS_TO_INTEGER (time_list
, time_t, current_buffer
->modtime
);
5152 current_buffer
->modtime_size
= -1;
5156 register Lisp_Object filename
;
5158 Lisp_Object handler
;
5160 filename
= Fexpand_file_name (BVAR (current_buffer
, filename
), Qnil
);
5162 /* If the file name has special constructs in it,
5163 call the corresponding file handler. */
5164 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5165 if (!NILP (handler
))
5166 /* The handler can find the file name the same way we did. */
5167 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5169 filename
= ENCODE_FILE (filename
);
5171 if (stat (SSDATA (filename
), &st
) >= 0)
5173 current_buffer
->modtime
= st
.st_mtime
;
5174 current_buffer
->modtime_size
= st
.st_size
;
5182 auto_save_error (Lisp_Object error_val
)
5184 Lisp_Object args
[3], msg
;
5186 struct gcpro gcpro1
;
5190 auto_save_error_occurred
= 1;
5192 ring_bell (XFRAME (selected_frame
));
5194 args
[0] = build_string ("Auto-saving %s: %s");
5195 args
[1] = BVAR (current_buffer
, name
);
5196 args
[2] = Ferror_message_string (error_val
);
5197 msg
= Fformat (3, args
);
5199 nbytes
= SBYTES (msg
);
5200 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5201 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5203 for (i
= 0; i
< 3; ++i
)
5206 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5208 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5209 Fsleep_for (make_number (1), Qnil
);
5223 auto_save_mode_bits
= 0666;
5225 /* Get visited file's mode to become the auto save file's mode. */
5226 if (! NILP (BVAR (current_buffer
, filename
)))
5228 if (stat (SSDATA (BVAR (current_buffer
, filename
)), &st
) >= 0)
5229 /* But make sure we can overwrite it later! */
5230 auto_save_mode_bits
= (st
.st_mode
| 0600) & 0777;
5231 else if ((modes
= Ffile_modes (BVAR (current_buffer
, filename
)),
5233 /* Remote files don't cooperate with stat. */
5234 auto_save_mode_bits
= (XINT (modes
) | 0600) & 0777;
5238 Fwrite_region (Qnil
, Qnil
, BVAR (current_buffer
, auto_save_file_name
), Qnil
,
5239 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5244 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5247 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5259 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5262 minibuffer_auto_raise
= XINT (value
);
5267 do_auto_save_make_dir (Lisp_Object dir
)
5271 auto_saving_dir_umask
= 077;
5272 result
= call2 (Qmake_directory
, dir
, Qt
);
5273 auto_saving_dir_umask
= 0;
5278 do_auto_save_eh (Lisp_Object ignore
)
5280 auto_saving_dir_umask
= 0;
5284 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5285 doc
: /* Auto-save all buffers that need it.
5286 This is all buffers that have auto-saving enabled
5287 and are changed since last auto-saved.
5288 Auto-saving writes the buffer into a file
5289 so that your editing is not lost if the system crashes.
5290 This file is not the file you visited; that changes only when you save.
5291 Normally we run the normal hook `auto-save-hook' before saving.
5293 A non-nil NO-MESSAGE argument means do not print any message if successful.
5294 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5295 (Lisp_Object no_message
, Lisp_Object current_only
)
5297 struct buffer
*old
= current_buffer
, *b
;
5298 Lisp_Object tail
, buf
, hook
;
5300 int do_handled_files
;
5302 FILE *stream
= NULL
;
5303 int count
= SPECPDL_INDEX ();
5304 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5305 int old_message_p
= 0;
5306 struct gcpro gcpro1
, gcpro2
;
5308 if (max_specpdl_size
< specpdl_size
+ 40)
5309 max_specpdl_size
= specpdl_size
+ 40;
5314 if (NILP (no_message
))
5316 old_message_p
= push_message ();
5317 record_unwind_protect (pop_message_unwind
, Qnil
);
5320 /* Ordinarily don't quit within this function,
5321 but don't make it impossible to quit (in case we get hung in I/O). */
5325 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5326 point to non-strings reached from Vbuffer_alist. */
5328 hook
= intern ("auto-save-hook");
5329 Frun_hooks (1, &hook
);
5331 if (STRINGP (Vauto_save_list_file_name
))
5333 Lisp_Object listfile
;
5335 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5337 /* Don't try to create the directory when shutting down Emacs,
5338 because creating the directory might signal an error, and
5339 that would leave Emacs in a strange state. */
5340 if (!NILP (Vrun_hooks
))
5344 GCPRO2 (dir
, listfile
);
5345 dir
= Ffile_name_directory (listfile
);
5346 if (NILP (Ffile_directory_p (dir
)))
5347 internal_condition_case_1 (do_auto_save_make_dir
,
5353 stream
= fopen (SSDATA (listfile
), "w");
5356 record_unwind_protect (do_auto_save_unwind
,
5357 make_save_value (stream
, 0));
5358 record_unwind_protect (do_auto_save_unwind_1
,
5359 make_number (minibuffer_auto_raise
));
5360 minibuffer_auto_raise
= 0;
5362 auto_save_error_occurred
= 0;
5364 /* On first pass, save all files that don't have handlers.
5365 On second pass, save all files that do have handlers.
5367 If Emacs is crashing, the handlers may tweak what is causing
5368 Emacs to crash in the first place, and it would be a shame if
5369 Emacs failed to autosave perfectly ordinary files because it
5370 couldn't handle some ange-ftp'd file. */
5372 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5373 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5375 buf
= XCDR (XCAR (tail
));
5378 /* Record all the buffers that have auto save mode
5379 in the special file that lists them. For each of these buffers,
5380 Record visited name (if any) and auto save name. */
5381 if (STRINGP (BVAR (b
, auto_save_file_name
))
5382 && stream
!= NULL
&& do_handled_files
== 0)
5385 if (!NILP (BVAR (b
, filename
)))
5387 fwrite (SDATA (BVAR (b
, filename
)), 1,
5388 SBYTES (BVAR (b
, filename
)), stream
);
5390 putc ('\n', stream
);
5391 fwrite (SDATA (BVAR (b
, auto_save_file_name
)), 1,
5392 SBYTES (BVAR (b
, auto_save_file_name
)), stream
);
5393 putc ('\n', stream
);
5397 if (!NILP (current_only
)
5398 && b
!= current_buffer
)
5401 /* Don't auto-save indirect buffers.
5402 The base buffer takes care of it. */
5406 /* Check for auto save enabled
5407 and file changed since last auto save
5408 and file changed since last real save. */
5409 if (STRINGP (BVAR (b
, auto_save_file_name
))
5410 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5411 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5412 /* -1 means we've turned off autosaving for a while--see below. */
5413 && XINT (BVAR (b
, save_length
)) >= 0
5414 && (do_handled_files
5415 || NILP (Ffind_file_name_handler (BVAR (b
, auto_save_file_name
),
5418 EMACS_TIME before_time
, after_time
;
5420 EMACS_GET_TIME (before_time
);
5422 /* If we had a failure, don't try again for 20 minutes. */
5423 if (b
->auto_save_failure_time
> 0
5424 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5427 set_buffer_internal (b
);
5428 if (NILP (Vauto_save_include_big_deletions
)
5429 && (XFASTINT (BVAR (b
, save_length
)) * 10
5430 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5431 /* A short file is likely to change a large fraction;
5432 spare the user annoying messages. */
5433 && XFASTINT (BVAR (b
, save_length
)) > 5000
5434 /* These messages are frequent and annoying for `*mail*'. */
5435 && !EQ (BVAR (b
, filename
), Qnil
)
5436 && NILP (no_message
))
5438 /* It has shrunk too much; turn off auto-saving here. */
5439 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5440 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5442 minibuffer_auto_raise
= 0;
5443 /* Turn off auto-saving until there's a real save,
5444 and prevent any more warnings. */
5445 XSETINT (BVAR (b
, save_length
), -1);
5446 Fsleep_for (make_number (1), Qnil
);
5449 if (!auto_saved
&& NILP (no_message
))
5450 message1 ("Auto-saving...");
5451 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5453 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5454 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5455 set_buffer_internal (old
);
5457 EMACS_GET_TIME (after_time
);
5459 /* If auto-save took more than 60 seconds,
5460 assume it was an NFS failure that got a timeout. */
5461 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5462 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5466 /* Prevent another auto save till enough input events come in. */
5467 record_auto_save ();
5469 if (auto_saved
&& NILP (no_message
))
5473 /* If we are going to restore an old message,
5474 give time to read ours. */
5475 sit_for (make_number (1), 0, 0);
5478 else if (!auto_save_error_occurred
)
5479 /* Don't overwrite the error message if an error occurred.
5480 If we displayed a message and then restored a state
5481 with no message, leave a "done" message on the screen. */
5482 message1 ("Auto-saving...done");
5487 /* This restores the message-stack status. */
5488 unbind_to (count
, Qnil
);
5492 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5493 Sset_buffer_auto_saved
, 0, 0, 0,
5494 doc
: /* Mark current buffer as auto-saved with its current text.
5495 No auto-save file will be written until the buffer changes again. */)
5498 /* FIXME: This should not be called in indirect buffers, since
5499 they're not autosaved. */
5500 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5501 XSETFASTINT (BVAR (current_buffer
, save_length
), Z
- BEG
);
5502 current_buffer
->auto_save_failure_time
= 0;
5506 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5507 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5508 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5511 current_buffer
->auto_save_failure_time
= 0;
5515 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5517 doc
: /* Return t if current buffer has been auto-saved recently.
5518 More precisely, if it has been auto-saved since last read from or saved
5519 in the visited file. If the buffer has no visited file,
5520 then any auto-save counts as "recent". */)
5523 /* FIXME: maybe we should return nil for indirect buffers since
5524 they're never autosaved. */
5525 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5528 /* Reading and completing file names */
5530 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5531 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5532 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5533 The return value is only relevant for a call to `read-file-name' that happens
5534 before any other event (mouse or keypress) is handled. */)
5537 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5538 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5548 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5550 struct gcpro gcpro1
;
5551 Lisp_Object args
[7];
5553 GCPRO1 (default_filename
);
5554 args
[0] = intern ("read-file-name");
5557 args
[3] = default_filename
;
5558 args
[4] = mustmatch
;
5560 args
[6] = predicate
;
5561 RETURN_UNGCPRO (Ffuncall (7, args
));
5566 syms_of_fileio (void)
5568 DEFSYM (Qoperations
, "operations");
5569 DEFSYM (Qexpand_file_name
, "expand-file-name");
5570 DEFSYM (Qsubstitute_in_file_name
, "substitute-in-file-name");
5571 DEFSYM (Qdirectory_file_name
, "directory-file-name");
5572 DEFSYM (Qfile_name_directory
, "file-name-directory");
5573 DEFSYM (Qfile_name_nondirectory
, "file-name-nondirectory");
5574 DEFSYM (Qunhandled_file_name_directory
, "unhandled-file-name-directory");
5575 DEFSYM (Qfile_name_as_directory
, "file-name-as-directory");
5576 DEFSYM (Qcopy_file
, "copy-file");
5577 DEFSYM (Qmake_directory_internal
, "make-directory-internal");
5578 DEFSYM (Qmake_directory
, "make-directory");
5579 DEFSYM (Qdelete_directory_internal
, "delete-directory-internal");
5580 DEFSYM (Qdelete_file
, "delete-file");
5581 DEFSYM (Qrename_file
, "rename-file");
5582 DEFSYM (Qadd_name_to_file
, "add-name-to-file");
5583 DEFSYM (Qmake_symbolic_link
, "make-symbolic-link");
5584 DEFSYM (Qfile_exists_p
, "file-exists-p");
5585 DEFSYM (Qfile_executable_p
, "file-executable-p");
5586 DEFSYM (Qfile_readable_p
, "file-readable-p");
5587 DEFSYM (Qfile_writable_p
, "file-writable-p");
5588 DEFSYM (Qfile_symlink_p
, "file-symlink-p");
5589 DEFSYM (Qaccess_file
, "access-file");
5590 DEFSYM (Qfile_directory_p
, "file-directory-p");
5591 DEFSYM (Qfile_regular_p
, "file-regular-p");
5592 DEFSYM (Qfile_accessible_directory_p
, "file-accessible-directory-p");
5593 DEFSYM (Qfile_modes
, "file-modes");
5594 DEFSYM (Qset_file_modes
, "set-file-modes");
5595 DEFSYM (Qset_file_times
, "set-file-times");
5596 DEFSYM (Qfile_selinux_context
, "file-selinux-context");
5597 DEFSYM (Qset_file_selinux_context
, "set-file-selinux-context");
5598 DEFSYM (Qfile_newer_than_file_p
, "file-newer-than-file-p");
5599 DEFSYM (Qinsert_file_contents
, "insert-file-contents");
5600 DEFSYM (Qwrite_region
, "write-region");
5601 DEFSYM (Qverify_visited_file_modtime
, "verify-visited-file-modtime");
5602 DEFSYM (Qset_visited_file_modtime
, "set-visited-file-modtime");
5603 DEFSYM (Qauto_save_coding
, "auto-save-coding");
5605 DEFSYM (Qfile_name_history
, "file-name-history");
5606 Fset (Qfile_name_history
, Qnil
);
5608 DEFSYM (Qfile_error
, "file-error");
5609 DEFSYM (Qfile_already_exists
, "file-already-exists");
5610 DEFSYM (Qfile_date_error
, "file-date-error");
5611 DEFSYM (Qexcl
, "excl");
5613 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system
,
5614 doc
: /* Coding system for encoding file names.
5615 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5616 Vfile_name_coding_system
= Qnil
;
5618 DEFVAR_LISP ("default-file-name-coding-system",
5619 Vdefault_file_name_coding_system
,
5620 doc
: /* Default coding system for encoding file names.
5621 This variable is used only when `file-name-coding-system' is nil.
5623 This variable is set/changed by the command `set-language-environment'.
5624 User should not set this variable manually,
5625 instead use `file-name-coding-system' to get a constant encoding
5626 of file names regardless of the current language environment. */);
5627 Vdefault_file_name_coding_system
= Qnil
;
5629 DEFSYM (Qformat_decode
, "format-decode");
5630 DEFSYM (Qformat_annotate_function
, "format-annotate-function");
5631 DEFSYM (Qafter_insert_file_set_coding
, "after-insert-file-set-coding");
5632 DEFSYM (Qcar_less_than_car
, "car-less-than-car");
5634 Fput (Qfile_error
, Qerror_conditions
,
5635 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5636 Fput (Qfile_error
, Qerror_message
,
5637 make_pure_c_string ("File error"));
5639 Fput (Qfile_already_exists
, Qerror_conditions
,
5640 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5641 Fput (Qfile_already_exists
, Qerror_message
,
5642 make_pure_c_string ("File already exists"));
5644 Fput (Qfile_date_error
, Qerror_conditions
,
5645 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5646 Fput (Qfile_date_error
, Qerror_message
,
5647 make_pure_c_string ("Cannot set file date"));
5649 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist
,
5650 doc
: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5651 If a file name matches REGEXP, all I/O on that file is done by calling
5652 HANDLER. If a file name matches more than one handler, the handler
5653 whose match starts last in the file name gets precedence. The
5654 function `find-file-name-handler' checks this list for a handler for
5657 HANDLER should be a function. The first argument given to it is the
5658 name of the I/O primitive to be handled; the remaining arguments are
5659 the arguments that were passed to that primitive. For example, if you
5660 do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5661 HANDLER is called like this:
5663 (funcall HANDLER 'file-exists-p FILENAME)
5665 Note that HANDLER must be able to handle all I/O primitives; if it has
5666 nothing special to do for a primitive, it should reinvoke the
5667 primitive to handle the operation \"the usual way\".
5668 See Info node `(elisp)Magic File Names' for more details. */);
5669 Vfile_name_handler_alist
= Qnil
;
5671 DEFVAR_LISP ("set-auto-coding-function",
5672 Vset_auto_coding_function
,
5673 doc
: /* If non-nil, a function to call to decide a coding system of file.
5674 Two arguments are passed to this function: the file name
5675 and the length of a file contents following the point.
5676 This function should return a coding system to decode the file contents.
5677 It should check the file name against `auto-coding-alist'.
5678 If no coding system is decided, it should check a coding system
5679 specified in the heading lines with the format:
5680 -*- ... coding: CODING-SYSTEM; ... -*-
5681 or local variable spec of the tailing lines with `coding:' tag. */);
5682 Vset_auto_coding_function
= Qnil
;
5684 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions
,
5685 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5686 Each is passed one argument, the number of characters inserted,
5687 with point at the start of the inserted text. Each function
5688 should leave point the same, and return the new character count.
5689 If `insert-file-contents' is intercepted by a handler from
5690 `file-name-handler-alist', that handler is responsible for calling the
5691 functions in `after-insert-file-functions' if appropriate. */);
5692 Vafter_insert_file_functions
= Qnil
;
5694 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions
,
5695 doc
: /* A list of functions to be called at the start of `write-region'.
5696 Each is passed two arguments, START and END as for `write-region'.
5697 These are usually two numbers but not always; see the documentation
5698 for `write-region'. The function should return a list of pairs
5699 of the form (POSITION . STRING), consisting of strings to be effectively
5700 inserted at the specified positions of the file being written (1 means to
5701 insert before the first byte written). The POSITIONs must be sorted into
5704 If there are several annotation functions, the lists returned by these
5705 functions are merged destructively. As each annotation function runs,
5706 the variable `write-region-annotations-so-far' contains a list of all
5707 annotations returned by previous annotation functions.
5709 An annotation function can return with a different buffer current.
5710 Doing so removes the annotations returned by previous functions, and
5711 resets START and END to `point-min' and `point-max' of the new buffer.
5713 After `write-region' completes, Emacs calls the function stored in
5714 `write-region-post-annotation-function', once for each buffer that was
5715 current when building the annotations (i.e., at least once), with that
5716 buffer current. */);
5717 Vwrite_region_annotate_functions
= Qnil
;
5718 DEFSYM (Qwrite_region_annotate_functions
, "write-region-annotate-functions");
5720 DEFVAR_LISP ("write-region-post-annotation-function",
5721 Vwrite_region_post_annotation_function
,
5722 doc
: /* Function to call after `write-region' completes.
5723 The function is called with no arguments. If one or more of the
5724 annotation functions in `write-region-annotate-functions' changed the
5725 current buffer, the function stored in this variable is called for
5726 each of those additional buffers as well, in addition to the original
5727 buffer. The relevant buffer is current during each function call. */);
5728 Vwrite_region_post_annotation_function
= Qnil
;
5729 staticpro (&Vwrite_region_annotation_buffers
);
5731 DEFVAR_LISP ("write-region-annotations-so-far",
5732 Vwrite_region_annotations_so_far
,
5733 doc
: /* When an annotation function is called, this holds the previous annotations.
5734 These are the annotations made by other annotation functions
5735 that were already called. See also `write-region-annotate-functions'. */);
5736 Vwrite_region_annotations_so_far
= Qnil
;
5738 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers
,
5739 doc
: /* A list of file name handlers that temporarily should not be used.
5740 This applies only to the operation `inhibit-file-name-operation'. */);
5741 Vinhibit_file_name_handlers
= Qnil
;
5743 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation
,
5744 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5745 Vinhibit_file_name_operation
= Qnil
;
5747 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name
,
5748 doc
: /* File name in which we write a list of all auto save file names.
5749 This variable is initialized automatically from `auto-save-list-file-prefix'
5750 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5751 a non-nil value. */);
5752 Vauto_save_list_file_name
= Qnil
;
5754 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name
,
5755 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5756 Normally auto-save files are written under other names. */);
5757 Vauto_save_visited_file_name
= Qnil
;
5759 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions
,
5760 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5761 If nil, deleting a substantial portion of the text disables auto-save
5762 in the buffer; this is the default behavior, because the auto-save
5763 file is usually more useful if it contains the deleted text. */);
5764 Vauto_save_include_big_deletions
= Qnil
;
5767 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync
,
5768 doc
: /* Non-nil means don't call fsync in `write-region'.
5769 This variable affects calls to `write-region' as well as save commands.
5770 A non-nil value may result in data loss! */);
5771 write_region_inhibit_fsync
= 0;
5774 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash
,
5775 doc
: /* Specifies whether to use the system's trash can.
5776 When non-nil, certain file deletion commands use the function
5777 `move-file-to-trash' instead of deleting files outright.
5778 This includes interactive calls to `delete-file' and
5779 `delete-directory' and the Dired deletion commands. */);
5780 delete_by_moving_to_trash
= 0;
5781 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5783 DEFSYM (Qmove_file_to_trash
, "move-file-to-trash");
5784 DEFSYM (Qcopy_directory
, "copy-directory");
5785 DEFSYM (Qdelete_directory
, "delete-directory");
5787 defsubr (&Sfind_file_name_handler
);
5788 defsubr (&Sfile_name_directory
);
5789 defsubr (&Sfile_name_nondirectory
);
5790 defsubr (&Sunhandled_file_name_directory
);
5791 defsubr (&Sfile_name_as_directory
);
5792 defsubr (&Sdirectory_file_name
);
5793 defsubr (&Smake_temp_name
);
5794 defsubr (&Sexpand_file_name
);
5795 defsubr (&Ssubstitute_in_file_name
);
5796 defsubr (&Scopy_file
);
5797 defsubr (&Smake_directory_internal
);
5798 defsubr (&Sdelete_directory_internal
);
5799 defsubr (&Sdelete_file
);
5800 defsubr (&Srename_file
);
5801 defsubr (&Sadd_name_to_file
);
5802 defsubr (&Smake_symbolic_link
);
5803 defsubr (&Sfile_name_absolute_p
);
5804 defsubr (&Sfile_exists_p
);
5805 defsubr (&Sfile_executable_p
);
5806 defsubr (&Sfile_readable_p
);
5807 defsubr (&Sfile_writable_p
);
5808 defsubr (&Saccess_file
);
5809 defsubr (&Sfile_symlink_p
);
5810 defsubr (&Sfile_directory_p
);
5811 defsubr (&Sfile_accessible_directory_p
);
5812 defsubr (&Sfile_regular_p
);
5813 defsubr (&Sfile_modes
);
5814 defsubr (&Sset_file_modes
);
5815 defsubr (&Sset_file_times
);
5816 defsubr (&Sfile_selinux_context
);
5817 defsubr (&Sset_file_selinux_context
);
5818 defsubr (&Sset_default_file_modes
);
5819 defsubr (&Sdefault_file_modes
);
5820 defsubr (&Sfile_newer_than_file_p
);
5821 defsubr (&Sinsert_file_contents
);
5822 defsubr (&Swrite_region
);
5823 defsubr (&Scar_less_than_car
);
5824 defsubr (&Sverify_visited_file_modtime
);
5825 defsubr (&Sclear_visited_file_modtime
);
5826 defsubr (&Svisited_file_modtime
);
5827 defsubr (&Sset_visited_file_modtime
);
5828 defsubr (&Sdo_auto_save
);
5829 defsubr (&Sset_buffer_auto_saved
);
5830 defsubr (&Sclear_buffer_auto_save_failure
);
5831 defsubr (&Srecent_auto_save_p
);
5833 defsubr (&Snext_read_file_uses_dialog_p
);
5836 defsubr (&Sunix_sync
);