1 /* File IO for GNU Emacs.
3 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996, 1997,
4 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
5 2009, 2010 Free Software Foundation, Inc.
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
26 #include <sys/types.h>
34 #if !defined (S_ISLNK) && defined (S_IFLNK)
35 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
38 #if !defined (S_ISFIFO) && defined (S_IFIFO)
39 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
42 #if !defined (S_ISREG) && defined (S_IFREG)
43 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
53 #ifdef HAVE_LIBSELINUX
54 #include <selinux/selinux.h>
55 #include <selinux/context.h>
59 #include "intervals.h"
61 #include "character.h"
64 #include "blockinput.h"
66 #include "dispextern.h"
72 #endif /* not WINDOWSNT */
76 #include <sys/param.h>
81 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
82 redirector allows the six letters between 'Z' and 'a' as well. */
84 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
87 #define IS_DRIVE(x) isalpha (x)
89 /* Need to lower-case the drive letter, or else expanded
90 filenames will sometimes compare inequal, because
91 `expand-file-name' doesn't always down-case the drive letter. */
92 #define DRIVE_LETTER(x) (tolower (x))
101 #include "commands.h"
107 #ifndef FILE_SYSTEM_CASE
108 #define FILE_SYSTEM_CASE(filename) (filename)
111 /* Nonzero during writing of auto-save files */
114 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
115 a new file with the same mode as the original */
116 int auto_save_mode_bits
;
118 /* Set by auto_save_1 if an error occurred during the last auto-save. */
119 int auto_save_error_occurred
;
121 /* The symbol bound to coding-system-for-read when
122 insert-file-contents is called for recovering a file. This is not
123 an actual coding system name, but just an indicator to tell
124 insert-file-contents to use `emacs-mule' with a special flag for
125 auto saving and recovering a file. */
126 Lisp_Object Qauto_save_coding
;
128 /* Coding system for file names, or nil if none. */
129 Lisp_Object Vfile_name_coding_system
;
131 /* Coding system for file names used only when
132 Vfile_name_coding_system is nil. */
133 Lisp_Object Vdefault_file_name_coding_system
;
135 /* Alist of elements (REGEXP . HANDLER) for file names
136 whose I/O is done with a special handler. */
137 Lisp_Object Vfile_name_handler_alist
;
139 /* Property name of a file name handler,
140 which gives a list of operations it handles.. */
141 Lisp_Object Qoperations
;
143 /* Lisp functions for translating file formats */
144 Lisp_Object Qformat_decode
, Qformat_annotate_function
;
146 /* Function to be called to decide a coding system of a reading file. */
147 Lisp_Object Vset_auto_coding_function
;
149 /* Functions to be called to process text properties in inserted file. */
150 Lisp_Object Vafter_insert_file_functions
;
152 /* Lisp function for setting buffer-file-coding-system and the
153 multibyteness of the current buffer after inserting a file. */
154 Lisp_Object Qafter_insert_file_set_coding
;
156 /* Functions to be called to create text property annotations for file. */
157 Lisp_Object Vwrite_region_annotate_functions
;
158 Lisp_Object Qwrite_region_annotate_functions
;
159 Lisp_Object Vwrite_region_post_annotation_function
;
161 /* During build_annotations, each time an annotation function is called,
162 this holds the annotations made by the previous functions. */
163 Lisp_Object Vwrite_region_annotations_so_far
;
165 /* Each time an annotation function changes the buffer, the new buffer
167 Lisp_Object Vwrite_region_annotation_buffers
;
169 /* File name in which we write a list of all our auto save files. */
170 Lisp_Object Vauto_save_list_file_name
;
172 /* Whether or not files are auto-saved into themselves. */
173 Lisp_Object Vauto_save_visited_file_name
;
175 /* Whether or not to continue auto-saving after a large deletion. */
176 Lisp_Object Vauto_save_include_big_deletions
;
179 /* Nonzero means skip the call to fsync in Fwrite-region. */
180 int write_region_inhibit_fsync
;
183 /* Non-zero means call move-file-to-trash in Fdelete_file or
184 Fdelete_directory_internal. */
185 int delete_by_moving_to_trash
;
187 Lisp_Object Qdelete_by_moving_to_trash
;
189 /* Lisp function for moving files to trash. */
190 Lisp_Object Qmove_file_to_trash
;
192 /* Lisp function for recursively copying directories. */
193 Lisp_Object Qcopy_directory
;
195 /* Lisp function for recursively deleting directories. */
196 Lisp_Object Qdelete_directory
;
199 extern Lisp_Object Vw32_get_true_file_attributes
;
202 /* These variables describe handlers that have "already" had a chance
203 to handle the current operation.
205 Vinhibit_file_name_handlers is a list of file name handlers.
206 Vinhibit_file_name_operation is the operation being handled.
207 If we try to handle that operation, we ignore those handlers. */
209 static Lisp_Object Vinhibit_file_name_handlers
;
210 static Lisp_Object Vinhibit_file_name_operation
;
212 Lisp_Object Qfile_error
, Qfile_already_exists
, Qfile_date_error
;
214 Lisp_Object Qfile_name_history
;
216 Lisp_Object Qcar_less_than_car
;
218 static int a_write (int, Lisp_Object
, int, int,
219 Lisp_Object
*, struct coding_system
*);
220 static int e_write (int, Lisp_Object
, int, int, struct coding_system
*);
224 report_file_error (const char *string
, Lisp_Object data
)
226 Lisp_Object errstring
;
230 synchronize_system_messages_locale ();
231 str
= strerror (errorno
);
232 errstring
= code_convert_string_norecord (make_unibyte_string (str
,
234 Vlocale_coding_system
, 0);
240 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
243 /* System error messages are capitalized. Downcase the initial
244 unless it is followed by a slash. (The slash case caters to
245 error messages that begin with "I/O" or, in German, "E/A".) */
246 if (STRING_MULTIBYTE (errstring
)
247 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
251 str
= (char *) SDATA (errstring
);
252 c
= STRING_CHAR (str
);
253 Faset (errstring
, make_number (0), make_number (DOWNCASE (c
)));
256 xsignal (Qfile_error
,
257 Fcons (build_string (string
), Fcons (errstring
, data
)));
262 close_file_unwind (Lisp_Object fd
)
264 emacs_close (XFASTINT (fd
));
268 /* Restore point, having saved it as a marker. */
271 restore_point_unwind (Lisp_Object location
)
273 Fgoto_char (location
);
274 Fset_marker (location
, Qnil
, Qnil
);
279 Lisp_Object Qexpand_file_name
;
280 Lisp_Object Qsubstitute_in_file_name
;
281 Lisp_Object Qdirectory_file_name
;
282 Lisp_Object Qfile_name_directory
;
283 Lisp_Object Qfile_name_nondirectory
;
284 Lisp_Object Qunhandled_file_name_directory
;
285 Lisp_Object Qfile_name_as_directory
;
286 Lisp_Object Qcopy_file
;
287 Lisp_Object Qmake_directory_internal
;
288 Lisp_Object Qmake_directory
;
289 Lisp_Object Qdelete_directory_internal
;
290 Lisp_Object Qdelete_file
;
291 Lisp_Object Qrename_file
;
292 Lisp_Object Qadd_name_to_file
;
293 Lisp_Object Qmake_symbolic_link
;
294 Lisp_Object Qfile_exists_p
;
295 Lisp_Object Qfile_executable_p
;
296 Lisp_Object Qfile_readable_p
;
297 Lisp_Object Qfile_writable_p
;
298 Lisp_Object Qfile_symlink_p
;
299 Lisp_Object Qaccess_file
;
300 Lisp_Object Qfile_directory_p
;
301 Lisp_Object Qfile_regular_p
;
302 Lisp_Object Qfile_accessible_directory_p
;
303 Lisp_Object Qfile_modes
;
304 Lisp_Object Qset_file_modes
;
305 Lisp_Object Qset_file_times
;
306 Lisp_Object Qfile_selinux_context
;
307 Lisp_Object Qset_file_selinux_context
;
308 Lisp_Object Qfile_newer_than_file_p
;
309 Lisp_Object Qinsert_file_contents
;
310 Lisp_Object Qwrite_region
;
311 Lisp_Object Qverify_visited_file_modtime
;
312 Lisp_Object Qset_visited_file_modtime
;
314 DEFUN ("find-file-name-handler", Ffind_file_name_handler
, Sfind_file_name_handler
, 2, 2, 0,
315 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
316 Otherwise, return nil.
317 A file name is handled if one of the regular expressions in
318 `file-name-handler-alist' matches it.
320 If OPERATION equals `inhibit-file-name-operation', then we ignore
321 any handlers that are members of `inhibit-file-name-handlers',
322 but we still do run any other handlers. This lets handlers
323 use the standard functions without calling themselves recursively. */)
324 (Lisp_Object filename
, Lisp_Object operation
)
326 /* This function must not munge the match data. */
327 Lisp_Object chain
, inhibited_handlers
, result
;
331 CHECK_STRING (filename
);
333 if (EQ (operation
, Vinhibit_file_name_operation
))
334 inhibited_handlers
= Vinhibit_file_name_handlers
;
336 inhibited_handlers
= Qnil
;
338 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
339 chain
= XCDR (chain
))
345 Lisp_Object string
= XCAR (elt
);
347 Lisp_Object handler
= XCDR (elt
);
348 Lisp_Object operations
= Qnil
;
350 if (SYMBOLP (handler
))
351 operations
= Fget (handler
, Qoperations
);
354 && (match_pos
= fast_string_match (string
, filename
)) > pos
355 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
359 handler
= XCDR (elt
);
360 tem
= Fmemq (handler
, inhibited_handlers
);
374 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
376 doc
: /* Return the directory component in file name FILENAME.
377 Return nil if FILENAME does not include a directory.
378 Otherwise return a directory name.
379 Given a Unix syntax file name, returns a string ending in slash. */)
380 (Lisp_Object filename
)
383 register const unsigned char *beg
;
385 register unsigned char *beg
;
387 register const unsigned char *p
;
390 CHECK_STRING (filename
);
392 /* If the file name has special constructs in it,
393 call the corresponding file handler. */
394 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
396 return call2 (handler
, Qfile_name_directory
, filename
);
398 filename
= FILE_SYSTEM_CASE (filename
);
400 beg
= (unsigned char *) alloca (SBYTES (filename
) + 1);
401 memcpy (beg
, SDATA (filename
), SBYTES (filename
) + 1);
403 beg
= SDATA (filename
);
405 p
= beg
+ SBYTES (filename
);
407 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
409 /* only recognise drive specifier at the beginning */
411 /* handle the "/:d:foo" and "/:foo" cases correctly */
412 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
413 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
420 /* Expansion of "c:" to drive and default directory. */
423 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
424 unsigned char *res
= alloca (MAXPATHLEN
+ 1);
425 unsigned char *r
= res
;
427 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
429 strncpy (res
, beg
, 2);
434 if (getdefdir (toupper (*beg
) - 'A' + 1, r
))
436 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
439 p
= beg
+ strlen (beg
);
442 dostounix_filename (beg
);
445 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
448 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
449 Sfile_name_nondirectory
, 1, 1, 0,
450 doc
: /* Return file name FILENAME sans its directory.
451 For example, in a Unix-syntax file name,
452 this is everything after the last slash,
453 or the entire name if it contains no slash. */)
454 (Lisp_Object filename
)
456 register const unsigned char *beg
, *p
, *end
;
459 CHECK_STRING (filename
);
461 /* If the file name has special constructs in it,
462 call the corresponding file handler. */
463 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
465 return call2 (handler
, Qfile_name_nondirectory
, filename
);
467 beg
= SDATA (filename
);
468 end
= p
= beg
+ SBYTES (filename
);
470 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
472 /* only recognise drive specifier at beginning */
474 /* handle the "/:d:foo" case correctly */
475 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
480 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
483 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
484 Sunhandled_file_name_directory
, 1, 1, 0,
485 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
486 A `directly usable' directory name is one that may be used without the
487 intervention of any file handler.
488 If FILENAME is a directly usable file itself, return
489 \(file-name-directory FILENAME).
490 If FILENAME refers to a file which is not accessible from a local process,
491 then this should return nil.
492 The `call-process' and `start-process' functions use this function to
493 get a current directory to run processes in. */)
494 (Lisp_Object filename
)
498 /* If the file name has special constructs in it,
499 call the corresponding file handler. */
500 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
502 return call2 (handler
, Qunhandled_file_name_directory
, filename
);
504 return Ffile_name_directory (filename
);
509 file_name_as_directory (char *out
, char *in
)
511 int size
= strlen (in
) - 1;
523 /* For Unix syntax, Append a slash if necessary */
524 if (!IS_DIRECTORY_SEP (out
[size
]))
526 out
[size
+ 1] = DIRECTORY_SEP
;
527 out
[size
+ 2] = '\0';
530 dostounix_filename (out
);
535 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
536 Sfile_name_as_directory
, 1, 1, 0,
537 doc
: /* Return a string representing the file name FILE interpreted as a directory.
538 This operation exists because a directory is also a file, but its name as
539 a directory is different from its name as a file.
540 The result can be used as the value of `default-directory'
541 or passed as second argument to `expand-file-name'.
542 For a Unix-syntax file name, just appends a slash. */)
552 /* If the file name has special constructs in it,
553 call the corresponding file handler. */
554 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
556 return call2 (handler
, Qfile_name_as_directory
, file
);
558 buf
= (char *) alloca (SBYTES (file
) + 10);
559 file_name_as_directory (buf
, SDATA (file
));
560 return make_specified_string (buf
, -1, strlen (buf
),
561 STRING_MULTIBYTE (file
));
565 * Convert from directory name to filename.
566 * On UNIX, it's simple: just make sure there isn't a terminating /
568 * Value is nonzero if the string output is different from the input.
572 directory_file_name (char *src
, char *dst
)
578 /* Process as Unix format: just remove any final slash.
579 But leave "/" unchanged; do not change it to "". */
582 && IS_DIRECTORY_SEP (dst
[slen
- 1])
584 && !IS_ANY_SEP (dst
[slen
- 2])
589 dostounix_filename (dst
);
594 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
596 doc
: /* Returns the file name of the directory named DIRECTORY.
597 This is the name of the file that holds the data for the directory DIRECTORY.
598 This operation exists because a directory is also a file, but its name as
599 a directory is different from its name as a file.
600 In Unix-syntax, this function just removes the final slash. */)
601 (Lisp_Object directory
)
606 CHECK_STRING (directory
);
608 if (NILP (directory
))
611 /* If the file name has special constructs in it,
612 call the corresponding file handler. */
613 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
615 return call2 (handler
, Qdirectory_file_name
, directory
);
617 buf
= (char *) alloca (SBYTES (directory
) + 20);
618 directory_file_name (SDATA (directory
), buf
);
619 return make_specified_string (buf
, -1, strlen (buf
),
620 STRING_MULTIBYTE (directory
));
623 static const char make_temp_name_tbl
[64] =
625 'A','B','C','D','E','F','G','H',
626 'I','J','K','L','M','N','O','P',
627 'Q','R','S','T','U','V','W','X',
628 'Y','Z','a','b','c','d','e','f',
629 'g','h','i','j','k','l','m','n',
630 'o','p','q','r','s','t','u','v',
631 'w','x','y','z','0','1','2','3',
632 '4','5','6','7','8','9','-','_'
635 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
637 /* Value is a temporary file name starting with PREFIX, a string.
639 The Emacs process number forms part of the result, so there is
640 no danger of generating a name being used by another process.
641 In addition, this function makes an attempt to choose a name
642 which has no existing file. To make this work, PREFIX should be
643 an absolute file name.
645 BASE64_P non-zero means add the pid as 3 characters in base64
646 encoding. In this case, 6 characters will be added to PREFIX to
647 form the file name. Otherwise, if Emacs is running on a system
648 with long file names, add the pid as a decimal number.
650 This function signals an error if no unique file name could be
654 make_temp_name (Lisp_Object prefix
, int base64_p
)
659 unsigned char *p
, *data
;
663 CHECK_STRING (prefix
);
665 /* VAL is created by adding 6 characters to PREFIX. The first
666 three are the PID of this process, in base 64, and the second
667 three are incremented if the file already exists. This ensures
668 262144 unique file names per PID per PREFIX. */
670 pid
= (int) getpid ();
674 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
675 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
676 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
681 #ifdef HAVE_LONG_FILE_NAMES
682 sprintf (pidbuf
, "%d", pid
);
683 pidlen
= strlen (pidbuf
);
685 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
686 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
687 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
692 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
693 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
694 if (!STRING_MULTIBYTE (prefix
))
695 STRING_SET_UNIBYTE (val
);
697 memcpy (data
, SDATA (prefix
), len
);
700 memcpy (p
, pidbuf
, pidlen
);
703 /* Here we try to minimize useless stat'ing when this function is
704 invoked many times successively with the same PREFIX. We achieve
705 this by initializing count to a random value, and incrementing it
708 We don't want make-temp-name to be called while dumping,
709 because then make_temp_name_count_initialized_p would get set
710 and then make_temp_name_count would not be set when Emacs starts. */
712 if (!make_temp_name_count_initialized_p
)
714 make_temp_name_count
= (unsigned) time (NULL
);
715 make_temp_name_count_initialized_p
= 1;
721 unsigned num
= make_temp_name_count
;
723 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
724 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
725 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
727 /* Poor man's congruential RN generator. Replace with
728 ++make_temp_name_count for debugging. */
729 make_temp_name_count
+= 25229;
730 make_temp_name_count
%= 225307;
732 if (stat (data
, &ignored
) < 0)
734 /* We want to return only if errno is ENOENT. */
738 /* The error here is dubious, but there is little else we
739 can do. The alternatives are to return nil, which is
740 as bad as (and in many cases worse than) throwing the
741 error, or to ignore the error, which will likely result
742 in looping through 225307 stat's, which is not only
743 dog-slow, but also useless since it will fallback to
744 the errow below, anyway. */
745 report_file_error ("Cannot create temporary name for prefix",
746 Fcons (prefix
, Qnil
));
751 error ("Cannot create temporary name for prefix `%s'",
757 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
758 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
759 The Emacs process number forms part of the result,
760 so there is no danger of generating a name being used by another process.
762 In addition, this function makes an attempt to choose a name
763 which has no existing file. To make this work,
764 PREFIX should be an absolute file name.
766 There is a race condition between calling `make-temp-name' and creating the
767 file which opens all kinds of security holes. For that reason, you should
768 probably use `make-temp-file' instead, except in three circumstances:
770 * If you are creating the file in the user's home directory.
771 * If you are creating a directory rather than an ordinary file.
772 * If you are taking special precautions as `make-temp-file' does. */)
775 return make_temp_name (prefix
, 0);
780 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
781 doc
: /* Convert filename NAME to absolute, and canonicalize it.
782 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
783 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
784 the current buffer's value of `default-directory' is used.
785 File name components that are `.' are removed, and
786 so are file name components followed by `..', along with the `..' itself;
787 note that these simplifications are done without checking the resulting
788 file names in the file system.
789 Multiple consecutive slashes are collapsed into a single slash,
790 except at the beginning of the file name when they are significant (e.g.,
791 UNC file names on MS-Windows.)
792 An initial `~/' expands to your home directory.
793 An initial `~USER/' expands to USER's home directory.
794 See also the function `substitute-in-file-name'.
796 For technical reasons, this function can return correct but
797 non-intuitive results for the root directory; for instance,
798 \(expand-file-name ".." "/") returns "/..". For this reason, use
799 \(directory-file-name (file-name-directory dirname)) to traverse a
800 filesystem tree, not (expand-file-name ".." dirname). */)
801 (Lisp_Object name
, Lisp_Object default_directory
)
803 /* These point to SDATA and need to be careful with string-relocation
804 during GC (via DECODE_FILE). */
805 unsigned char *nm
, *newdir
;
806 /* This should only point to alloca'd data. */
807 unsigned char *target
;
813 int collapse_newdir
= 1;
817 Lisp_Object handler
, result
;
823 /* If the file name has special constructs in it,
824 call the corresponding file handler. */
825 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
827 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
829 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
830 if (NILP (default_directory
))
831 default_directory
= current_buffer
->directory
;
832 if (! STRINGP (default_directory
))
835 /* "/" is not considered a root directory on DOS_NT, so using "/"
836 here causes an infinite recursion in, e.g., the following:
838 (let (default-directory)
839 (expand-file-name "a"))
841 To avoid this, we set default_directory to the root of the
843 default_directory
= build_string (emacs_root_dir ());
845 default_directory
= build_string ("/");
849 if (!NILP (default_directory
))
851 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
853 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
857 unsigned char *o
= SDATA (default_directory
);
859 /* Make sure DEFAULT_DIRECTORY is properly expanded.
860 It would be better to do this down below where we actually use
861 default_directory. Unfortunately, calling Fexpand_file_name recursively
862 could invoke GC, and the strings might be relocated. This would
863 be annoying because we have pointers into strings lying around
864 that would need adjusting, and people would add new pointers to
865 the code and forget to adjust them, resulting in intermittent bugs.
866 Putting this call here avoids all that crud.
868 The EQ test avoids infinite recursion. */
869 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
870 /* Save time in some common cases - as long as default_directory
871 is not relative, it can be canonicalized with name below (if it
872 is needed at all) without requiring it to be expanded now. */
874 /* Detect MSDOS file names with drive specifiers. */
875 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
876 && IS_DIRECTORY_SEP (o
[2]))
878 /* Detect Windows file names in UNC format. */
879 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
881 #else /* not DOS_NT */
882 /* Detect Unix absolute file names (/... alone is not absolute on
884 && ! (IS_DIRECTORY_SEP (o
[0]))
885 #endif /* not DOS_NT */
891 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
895 name
= FILE_SYSTEM_CASE (name
);
896 multibyte
= STRING_MULTIBYTE (name
);
897 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
900 default_directory
= string_to_multibyte (default_directory
);
903 name
= string_to_multibyte (name
);
908 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
909 nm
= (unsigned char *) alloca (SBYTES (name
) + 1);
910 memcpy (nm
, SDATA (name
), SBYTES (name
) + 1);
913 /* Note if special escape prefix is present, but remove for now. */
914 if (nm
[0] == '/' && nm
[1] == ':')
920 /* Find and remove drive specifier if present; this makes nm absolute
921 even if the rest of the name appears to be relative. Only look for
922 drive specifier at the beginning. */
923 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
930 /* If we see "c://somedir", we want to strip the first slash after the
931 colon when stripping the drive letter. Otherwise, this expands to
933 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
936 /* Discard any previous drive specifier if nm is now in UNC format. */
937 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
941 #endif /* WINDOWSNT */
944 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
945 none are found, we can probably return right away. We will avoid
946 allocating a new string if name is already fully expanded. */
948 IS_DIRECTORY_SEP (nm
[0])
950 && drive
&& !is_escaped
953 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
957 /* If it turns out that the filename we want to return is just a
958 suffix of FILENAME, we don't need to go through and edit
959 things; we just need to construct a new string using data
960 starting at the middle of FILENAME. If we set lose to a
961 non-zero value, that means we've discovered that we can't do
964 unsigned char *p
= nm
;
968 /* Since we know the name is absolute, we can assume that each
969 element starts with a "/". */
971 /* "." and ".." are hairy. */
972 if (IS_DIRECTORY_SEP (p
[0])
974 && (IS_DIRECTORY_SEP (p
[2])
976 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
979 /* We want to replace multiple `/' in a row with a single
982 && IS_DIRECTORY_SEP (p
[0])
983 && IS_DIRECTORY_SEP (p
[1]))
990 /* Make sure directories are all separated with /, but
991 avoid allocation of a new string when not required. */
992 dostounix_filename (nm
);
994 if (IS_DIRECTORY_SEP (nm
[1]))
996 if (strcmp (nm
, SDATA (name
)) != 0)
997 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1001 /* drive must be set, so this is okay */
1002 if (strcmp (nm
- 2, SDATA (name
)) != 0)
1006 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1007 temp
[0] = DRIVE_LETTER (drive
);
1008 name
= concat2 (build_string (temp
), name
);
1011 #else /* not DOS_NT */
1012 if (strcmp (nm
, SDATA (name
)) == 0)
1014 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1015 #endif /* not DOS_NT */
1019 /* At this point, nm might or might not be an absolute file name. We
1020 need to expand ~ or ~user if present, otherwise prefix nm with
1021 default_directory if nm is not absolute, and finally collapse /./
1022 and /foo/../ sequences.
1024 We set newdir to be the appropriate prefix if one is needed:
1025 - the relevant user directory if nm starts with ~ or ~user
1026 - the specified drive's working dir (DOS/NT only) if nm does not
1028 - the value of default_directory.
1030 Note that these prefixes are not guaranteed to be absolute (except
1031 for the working dir of a drive). Therefore, to ensure we always
1032 return an absolute name, if the final prefix is not absolute we
1033 append it to the current working directory. */
1037 if (nm
[0] == '~') /* prefix ~ */
1039 if (IS_DIRECTORY_SEP (nm
[1])
1040 || nm
[1] == 0) /* ~ by itself */
1044 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1045 newdir
= (unsigned char *) "";
1047 /* egetenv may return a unibyte string, which will bite us since
1048 we expect the directory to be multibyte. */
1049 tem
= build_string (newdir
);
1050 if (!STRING_MULTIBYTE (tem
))
1052 hdir
= DECODE_FILE (tem
);
1053 newdir
= SDATA (hdir
);
1056 collapse_newdir
= 0;
1059 else /* ~user/filename */
1061 unsigned char *o
, *p
;
1062 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1063 o
= alloca (p
- nm
+ 1);
1064 memcpy (o
, nm
, p
- nm
);
1068 pw
= (struct passwd
*) getpwnam (o
+ 1);
1072 newdir
= (unsigned char *) pw
-> pw_dir
;
1075 collapse_newdir
= 0;
1079 /* If we don't find a user of that name, leave the name
1080 unchanged; don't move nm forward to p. */
1085 /* On DOS and Windows, nm is absolute if a drive name was specified;
1086 use the drive's current directory as the prefix if needed. */
1087 if (!newdir
&& drive
)
1089 /* Get default directory if needed to make nm absolute. */
1090 if (!IS_DIRECTORY_SEP (nm
[0]))
1092 newdir
= alloca (MAXPATHLEN
+ 1);
1093 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1098 /* Either nm starts with /, or drive isn't mounted. */
1099 newdir
= alloca (4);
1100 newdir
[0] = DRIVE_LETTER (drive
);
1108 /* Finally, if no prefix has been specified and nm is not absolute,
1109 then it must be expanded relative to default_directory. */
1113 /* /... alone is not absolute on DOS and Windows. */
1114 && !IS_DIRECTORY_SEP (nm
[0])
1117 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1121 newdir
= SDATA (default_directory
);
1123 /* Note if special escape prefix is present, but remove for now. */
1124 if (newdir
[0] == '/' && newdir
[1] == ':')
1135 /* First ensure newdir is an absolute name. */
1137 /* Detect MSDOS file names with drive specifiers. */
1138 ! (IS_DRIVE (newdir
[0])
1139 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1141 /* Detect Windows file names in UNC format. */
1142 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1146 /* Effectively, let newdir be (expand-file-name newdir cwd).
1147 Because of the admonition against calling expand-file-name
1148 when we have pointers into lisp strings, we accomplish this
1149 indirectly by prepending newdir to nm if necessary, and using
1150 cwd (or the wd of newdir's drive) as the new newdir. */
1152 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1157 if (!IS_DIRECTORY_SEP (nm
[0]))
1159 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1160 file_name_as_directory (tmp
, newdir
);
1164 newdir
= alloca (MAXPATHLEN
+ 1);
1167 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1174 /* Strip off drive name from prefix, if present. */
1175 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1181 /* Keep only a prefix from newdir if nm starts with slash
1182 (//server/share for UNC, nothing otherwise). */
1183 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1186 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1189 newdir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1191 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1193 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1205 /* Get rid of any slash at the end of newdir, unless newdir is
1206 just / or // (an incomplete UNC name). */
1207 length
= strlen (newdir
);
1208 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1210 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1214 unsigned char *temp
= (unsigned char *) alloca (length
);
1215 memcpy (temp
, newdir
, length
- 1);
1216 temp
[length
- 1] = 0;
1224 /* Now concatenate the directory and name to new space in the stack frame */
1225 tlen
+= strlen (nm
) + 1;
1227 /* Reserve space for drive specifier and escape prefix, since either
1228 or both may need to be inserted. (The Microsoft x86 compiler
1229 produces incorrect code if the following two lines are combined.) */
1230 target
= (unsigned char *) alloca (tlen
+ 4);
1232 #else /* not DOS_NT */
1233 target
= (unsigned char *) alloca (tlen
);
1234 #endif /* not DOS_NT */
1239 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1242 /* If newdir is effectively "C:/", then the drive letter will have
1243 been stripped and newdir will be "/". Concatenating with an
1244 absolute directory in nm produces "//", which will then be
1245 incorrectly treated as a network share. Ignore newdir in
1246 this case (keeping the drive letter). */
1247 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1248 && newdir
[1] == '\0'))
1250 strcpy (target
, newdir
);
1253 file_name_as_directory (target
, newdir
);
1256 strcat (target
, nm
);
1258 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1261 unsigned char *p
= target
;
1262 unsigned char *o
= target
;
1266 if (!IS_DIRECTORY_SEP (*p
))
1270 else if (p
[1] == '.'
1271 && (IS_DIRECTORY_SEP (p
[2])
1274 /* If "/." is the entire filename, keep the "/". Otherwise,
1275 just delete the whole "/.". */
1276 if (o
== target
&& p
[2] == '\0')
1280 else if (p
[1] == '.' && p
[2] == '.'
1281 /* `/../' is the "superroot" on certain file systems.
1282 Turned off on DOS_NT systems because they have no
1283 "superroot" and because this causes us to produce
1284 file names like "d:/../foo" which fail file-related
1285 functions of the underlying OS. (To reproduce, try a
1286 long series of "../../" in default_directory, longer
1287 than the number of levels from the root.) */
1291 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1294 unsigned char *prev_o
= o
;
1296 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1299 /* Don't go below server level in UNC filenames. */
1300 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1301 && IS_DIRECTORY_SEP (*target
))
1305 /* Keep initial / only if this is the whole name. */
1306 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1310 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1311 /* Collapse multiple `/' in a row. */
1320 /* At last, set drive name. */
1322 /* Except for network file name. */
1323 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1324 #endif /* WINDOWSNT */
1326 if (!drive
) abort ();
1328 target
[0] = DRIVE_LETTER (drive
);
1331 /* Reinsert the escape prefix if required. */
1338 dostounix_filename (target
);
1341 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1344 /* Again look to see if the file name has special constructs in it
1345 and perhaps call the corresponding file handler. This is needed
1346 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1347 the ".." component gives us "/user@host:/bar/../baz" which needs
1348 to be expanded again. */
1349 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1350 if (!NILP (handler
))
1351 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1357 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1358 This is the old version of expand-file-name, before it was thoroughly
1359 rewritten for Emacs 10.31. We leave this version here commented-out,
1360 because the code is very complex and likely to have subtle bugs. If
1361 bugs _are_ found, it might be of interest to look at the old code and
1362 see what did it do in the relevant situation.
1364 Don't remove this code: it's true that it will be accessible
1365 from the repository, but a few years from deletion, people will
1366 forget it is there. */
1368 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1369 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1370 "Convert FILENAME to absolute, and canonicalize it.\n\
1371 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1372 \(does not start with slash); if DEFAULT is nil or missing,\n\
1373 the current buffer's value of default-directory is used.\n\
1374 Filenames containing `.' or `..' as components are simplified;\n\
1375 initial `~/' expands to your home directory.\n\
1376 See also the function `substitute-in-file-name'.")
1378 Lisp_Object name
, defalt
;
1382 register unsigned char *newdir
, *p
, *o
;
1384 unsigned char *target
;
1388 CHECK_STRING (name
);
1391 /* If nm is absolute, flush ...// and detect /./ and /../.
1392 If no /./ or /../ we can return right away. */
1399 if (p
[0] == '/' && p
[1] == '/'
1402 if (p
[0] == '/' && p
[1] == '~')
1403 nm
= p
+ 1, lose
= 1;
1404 if (p
[0] == '/' && p
[1] == '.'
1405 && (p
[2] == '/' || p
[2] == 0
1406 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1412 if (nm
== SDATA (name
))
1414 return build_string (nm
);
1418 /* Now determine directory to start with and put it in NEWDIR */
1422 if (nm
[0] == '~') /* prefix ~ */
1423 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1425 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1426 newdir
= (unsigned char *) "";
1429 else /* ~user/filename */
1431 /* Get past ~ to user */
1432 unsigned char *user
= nm
+ 1;
1433 /* Find end of name. */
1434 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1435 int len
= ptr
? ptr
- user
: strlen (user
);
1436 /* Copy the user name into temp storage. */
1437 o
= (unsigned char *) alloca (len
+ 1);
1438 memcpy (o
, user
, len
);
1441 /* Look up the user name. */
1443 pw
= (struct passwd
*) getpwnam (o
+ 1);
1446 error ("\"%s\" isn't a registered user", o
+ 1);
1448 newdir
= (unsigned char *) pw
->pw_dir
;
1450 /* Discard the user name from NM. */
1454 if (nm
[0] != '/' && !newdir
)
1457 defalt
= current_buffer
->directory
;
1458 CHECK_STRING (defalt
);
1459 newdir
= SDATA (defalt
);
1462 /* Now concatenate the directory and name to new space in the stack frame */
1464 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1465 target
= (unsigned char *) alloca (tlen
);
1470 if (nm
[0] == 0 || nm
[0] == '/')
1471 strcpy (target
, newdir
);
1473 file_name_as_directory (target
, newdir
);
1476 strcat (target
, nm
);
1478 /* Now canonicalize by removing /. and /foo/.. if they appear */
1489 else if (!strncmp (p
, "//", 2)
1495 else if (p
[0] == '/' && p
[1] == '.'
1496 && (p
[2] == '/' || p
[2] == 0))
1498 else if (!strncmp (p
, "/..", 3)
1499 /* `/../' is the "superroot" on certain file systems. */
1501 && (p
[3] == '/' || p
[3] == 0))
1503 while (o
!= target
&& *--o
!= '/')
1505 if (o
== target
&& *o
== '/')
1515 return make_string (target
, o
- target
);
1519 /* If /~ or // appears, discard everything through first slash. */
1521 file_name_absolute_p (const unsigned char *filename
)
1524 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1526 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1527 && IS_DIRECTORY_SEP (filename
[2]))
1532 static unsigned char *
1533 search_embedded_absfilename (unsigned char *nm
, unsigned char *endp
)
1535 unsigned char *p
, *s
;
1537 for (p
= nm
+ 1; p
< endp
; p
++)
1540 || IS_DIRECTORY_SEP (p
[-1]))
1541 && file_name_absolute_p (p
)
1542 #if defined (WINDOWSNT) || defined(CYGWIN)
1543 /* // at start of file name is meaningful in Apollo,
1544 WindowsNT and Cygwin systems. */
1545 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1546 #endif /* not (WINDOWSNT || CYGWIN) */
1549 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1550 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
1552 unsigned char *o
= alloca (s
- p
+ 1);
1554 memcpy (o
, p
, s
- p
);
1557 /* If we have ~user and `user' exists, discard
1558 everything up to ~. But if `user' does not exist, leave
1559 ~user alone, it might be a literal file name. */
1561 pw
= getpwnam (o
+ 1);
1573 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1574 Ssubstitute_in_file_name
, 1, 1, 0,
1575 doc
: /* Substitute environment variables referred to in FILENAME.
1576 `$FOO' where FOO is an environment variable name means to substitute
1577 the value of that variable. The variable name should be terminated
1578 with a character not a letter, digit or underscore; otherwise, enclose
1579 the entire variable name in braces.
1581 If `/~' appears, all of FILENAME through that `/' is discarded.
1582 If `//' appears, everything up to and including the first of
1583 those `/' is discarded. */)
1584 (Lisp_Object filename
)
1588 register unsigned char *s
, *p
, *o
, *x
, *endp
;
1589 unsigned char *target
= NULL
;
1591 int substituted
= 0;
1594 Lisp_Object handler
;
1596 CHECK_STRING (filename
);
1598 multibyte
= STRING_MULTIBYTE (filename
);
1600 /* If the file name has special constructs in it,
1601 call the corresponding file handler. */
1602 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1603 if (!NILP (handler
))
1604 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
1606 /* Always work on a copy of the string, in case GC happens during
1607 decode of environment variables, causing the original Lisp_String
1608 data to be relocated. */
1609 nm
= (unsigned char *) alloca (SBYTES (filename
) + 1);
1610 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1613 dostounix_filename (nm
);
1614 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1616 endp
= nm
+ SBYTES (filename
);
1618 /* If /~ or // appears, discard everything through first slash. */
1619 p
= search_embedded_absfilename (nm
, endp
);
1621 /* Start over with the new string, so we check the file-name-handler
1622 again. Important with filenames like "/home/foo//:/hello///there"
1623 which whould substitute to "/:/hello///there" rather than "/there". */
1624 return Fsubstitute_in_file_name
1625 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1627 /* See if any variables are substituted into the string
1628 and find the total length of their values in `total' */
1630 for (p
= nm
; p
!= endp
;)
1640 /* "$$" means a single "$" */
1649 while (p
!= endp
&& *p
!= '}') p
++;
1650 if (*p
!= '}') goto missingclose
;
1656 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1660 /* Copy out the variable name */
1661 target
= (unsigned char *) alloca (s
- o
+ 1);
1662 strncpy (target
, o
, s
- o
);
1665 strupr (target
); /* $home == $HOME etc. */
1668 /* Get variable value */
1669 o
= (unsigned char *) egetenv (target
);
1672 /* Don't try to guess a maximum length - UTF8 can use up to
1673 four bytes per character. This code is unlikely to run
1674 in a situation that requires performance, so decoding the
1675 env variables twice should be acceptable. Note that
1676 decoding may cause a garbage collect. */
1677 Lisp_Object orig
, decoded
;
1678 orig
= make_unibyte_string (o
, strlen (o
));
1679 decoded
= DECODE_FILE (orig
);
1680 total
+= SBYTES (decoded
);
1690 /* If substitution required, recopy the string and do it */
1691 /* Make space in stack frame for the new copy */
1692 xnm
= (unsigned char *) alloca (SBYTES (filename
) + total
+ 1);
1695 /* Copy the rest of the name through, replacing $ constructs with values */
1712 while (p
!= endp
&& *p
!= '}') p
++;
1713 if (*p
!= '}') goto missingclose
;
1719 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1723 /* Copy out the variable name */
1724 target
= (unsigned char *) alloca (s
- o
+ 1);
1725 strncpy (target
, o
, s
- o
);
1728 strupr (target
); /* $home == $HOME etc. */
1731 /* Get variable value */
1732 o
= (unsigned char *) egetenv (target
);
1736 strcpy (x
, target
); x
+= strlen (target
);
1740 Lisp_Object orig
, decoded
;
1741 int orig_length
, decoded_length
;
1742 orig_length
= strlen (o
);
1743 orig
= make_unibyte_string (o
, orig_length
);
1744 decoded
= DECODE_FILE (orig
);
1745 decoded_length
= SBYTES (decoded
);
1746 strncpy (x
, SDATA (decoded
), decoded_length
);
1747 x
+= decoded_length
;
1749 /* If environment variable needed decoding, return value
1750 needs to be multibyte. */
1751 if (decoded_length
!= orig_length
1752 || strncmp (SDATA (decoded
), o
, orig_length
))
1759 /* If /~ or // appears, discard everything through first slash. */
1760 while ((p
= search_embedded_absfilename (xnm
, x
)))
1761 /* This time we do not start over because we've already expanded envvars
1762 and replaced $$ with $. Maybe we should start over as well, but we'd
1763 need to quote some $ to $$ first. */
1766 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1769 error ("Bad format environment-variable substitution");
1771 error ("Missing \"}\" in environment-variable substitution");
1773 error ("Substituting nonexistent environment variable \"%s\"", target
);
1779 /* A slightly faster and more convenient way to get
1780 (directory-file-name (expand-file-name FOO)). */
1783 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1785 register Lisp_Object absname
;
1787 absname
= Fexpand_file_name (filename
, defdir
);
1789 /* Remove final slash, if any (unless this is the root dir).
1790 stat behaves differently depending! */
1791 if (SCHARS (absname
) > 1
1792 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1793 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
1794 /* We cannot take shortcuts; they might be wrong for magic file names. */
1795 absname
= Fdirectory_file_name (absname
);
1799 /* Signal an error if the file ABSNAME already exists.
1800 If INTERACTIVE is nonzero, ask the user whether to proceed,
1801 and bypass the error if the user says to go ahead.
1802 QUERYSTRING is a name for the action that is being considered
1805 *STATPTR is used to store the stat information if the file exists.
1806 If the file does not exist, STATPTR->st_mode is set to 0.
1807 If STATPTR is null, we don't store into it.
1809 If QUICK is nonzero, we ask for y or n, not yes or no. */
1812 barf_or_query_if_file_exists (Lisp_Object absname
, const unsigned char *querystring
, int interactive
, struct stat
*statptr
, int quick
)
1814 register Lisp_Object tem
, encoded_filename
;
1815 struct stat statbuf
;
1816 struct gcpro gcpro1
;
1818 encoded_filename
= ENCODE_FILE (absname
);
1820 /* stat is a good way to tell whether the file exists,
1821 regardless of what access permissions it has. */
1822 if (lstat (SDATA (encoded_filename
), &statbuf
) >= 0)
1825 xsignal2 (Qfile_already_exists
,
1826 build_string ("File already exists"), absname
);
1828 tem
= format2 ("File %s already exists; %s anyway? ",
1829 absname
, build_string (querystring
));
1831 tem
= call1 (intern ("y-or-n-p"), tem
);
1833 tem
= do_yes_or_no_p (tem
);
1836 xsignal2 (Qfile_already_exists
,
1837 build_string ("File already exists"), absname
);
1844 statptr
->st_mode
= 0;
1849 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1850 "fCopy file: \nGCopy %s to file: \np\nP",
1851 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1852 If NEWNAME names a directory, copy FILE there.
1854 This function always sets the file modes of the output file to match
1857 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1858 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1859 signal a `file-already-exists' error without overwriting. If
1860 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1861 about overwriting; this is what happens in interactive use with M-x.
1862 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1865 Fourth arg KEEP-TIME non-nil means give the output file the same
1866 last-modified time as the old one. (This works on only some systems.)
1868 A prefix arg makes KEEP-TIME non-nil.
1870 If PRESERVE-UID-GID is non-nil, we try to transfer the
1871 uid and gid of FILE to NEWNAME.
1873 If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
1874 on the system, we copy the SELinux context of FILE to NEWNAME. */)
1875 (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
)
1878 char buf
[16 * 1024];
1879 struct stat st
, out_st
;
1880 Lisp_Object handler
;
1881 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1882 int count
= SPECPDL_INDEX ();
1883 int input_file_statable_p
;
1884 Lisp_Object encoded_file
, encoded_newname
;
1886 security_context_t con
;
1887 int fail
, conlength
= 0;
1890 encoded_file
= encoded_newname
= Qnil
;
1891 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1892 CHECK_STRING (file
);
1893 CHECK_STRING (newname
);
1895 if (!NILP (Ffile_directory_p (newname
)))
1896 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1898 newname
= Fexpand_file_name (newname
, Qnil
);
1900 file
= Fexpand_file_name (file
, Qnil
);
1902 /* If the input file name has special constructs in it,
1903 call the corresponding file handler. */
1904 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1905 /* Likewise for output file name. */
1907 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1908 if (!NILP (handler
))
1909 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1910 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1911 preserve_selinux_context
));
1913 encoded_file
= ENCODE_FILE (file
);
1914 encoded_newname
= ENCODE_FILE (newname
);
1916 if (NILP (ok_if_already_exists
)
1917 || INTEGERP (ok_if_already_exists
))
1918 barf_or_query_if_file_exists (newname
, "copy to it",
1919 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1920 else if (stat (SDATA (encoded_newname
), &out_st
) < 0)
1924 if (!CopyFile (SDATA (encoded_file
),
1925 SDATA (encoded_newname
),
1927 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1928 /* CopyFile retains the timestamp by default. */
1929 else if (NILP (keep_time
))
1935 EMACS_GET_TIME (now
);
1936 filename
= SDATA (encoded_newname
);
1938 /* Ensure file is writable while its modified time is set. */
1939 attributes
= GetFileAttributes (filename
);
1940 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1941 if (set_file_times (filename
, now
, now
))
1943 /* Restore original attributes. */
1944 SetFileAttributes (filename
, attributes
);
1945 xsignal2 (Qfile_date_error
,
1946 build_string ("Cannot set file date"), newname
);
1948 /* Restore original attributes. */
1949 SetFileAttributes (filename
, attributes
);
1951 #else /* not WINDOWSNT */
1953 ifd
= emacs_open (SDATA (encoded_file
), O_RDONLY
, 0);
1957 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1959 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1961 /* We can only copy regular files and symbolic links. Other files are not
1963 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
1966 if (!NILP (preserve_selinux_context
) && is_selinux_enabled ())
1968 conlength
= fgetfilecon (ifd
, &con
);
1969 if (conlength
== -1)
1970 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
1974 if (out_st
.st_mode
!= 0
1975 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
1978 report_file_error ("Input and output files are the same",
1979 Fcons (file
, Fcons (newname
, Qnil
)));
1982 #if defined (S_ISREG) && defined (S_ISLNK)
1983 if (input_file_statable_p
)
1985 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
1987 #if defined (EISDIR)
1988 /* Get a better looking error message. */
1991 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
1994 #endif /* S_ISREG && S_ISLNK */
1997 /* System's default file type was set to binary by _fmode in emacs.c. */
1998 ofd
= emacs_open (SDATA (encoded_newname
),
1999 O_WRONLY
| O_TRUNC
| O_CREAT
2000 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2001 S_IREAD
| S_IWRITE
);
2002 #else /* not MSDOS */
2003 ofd
= emacs_open (SDATA (encoded_newname
),
2004 O_WRONLY
| O_TRUNC
| O_CREAT
2005 | (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 if (! NILP (preserve_uid_gid
))
2026 fchown (ofd
, st
.st_uid
, st
.st_gid
);
2027 fchmod (ofd
, st
.st_mode
& 07777);
2029 #endif /* not MSDOS */
2034 /* Set the modified context back to the file. */
2035 fail
= fsetfilecon (ofd
, con
);
2037 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2043 /* Closing the output clobbers the file times on some systems. */
2044 if (emacs_close (ofd
) < 0)
2045 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2047 if (input_file_statable_p
)
2049 if (!NILP (keep_time
))
2051 EMACS_TIME atime
, mtime
;
2052 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
2053 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
2054 if (set_file_times (SDATA (encoded_newname
),
2056 xsignal2 (Qfile_date_error
,
2057 build_string ("Cannot set file date"), newname
);
2064 if (input_file_statable_p
)
2066 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2067 and if it can't, it tells so. Otherwise, under MSDOS we usually
2068 get only the READ bit, which will make the copied file read-only,
2069 so it's better not to chmod at all. */
2070 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2071 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2074 #endif /* not WINDOWSNT */
2076 /* Discard the unwind protects. */
2077 specpdl_ptr
= specpdl
+ count
;
2083 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2084 Smake_directory_internal
, 1, 1, 0,
2085 doc
: /* Create a new directory named DIRECTORY. */)
2086 (Lisp_Object directory
)
2088 const unsigned char *dir
;
2089 Lisp_Object handler
;
2090 Lisp_Object encoded_dir
;
2092 CHECK_STRING (directory
);
2093 directory
= Fexpand_file_name (directory
, Qnil
);
2095 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2096 if (!NILP (handler
))
2097 return call2 (handler
, Qmake_directory_internal
, directory
);
2099 encoded_dir
= ENCODE_FILE (directory
);
2101 dir
= SDATA (encoded_dir
);
2104 if (mkdir (dir
) != 0)
2106 if (mkdir (dir
, 0777) != 0)
2108 report_file_error ("Creating directory", list1 (directory
));
2113 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2114 Sdelete_directory_internal
, 1, 1, 0,
2115 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2116 (Lisp_Object directory
)
2118 const unsigned char *dir
;
2119 Lisp_Object handler
;
2120 Lisp_Object encoded_dir
;
2122 CHECK_STRING (directory
);
2123 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2124 encoded_dir
= ENCODE_FILE (directory
);
2125 dir
= SDATA (encoded_dir
);
2127 if (rmdir (dir
) != 0)
2128 report_file_error ("Removing directory", list1 (directory
));
2133 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2134 "(list (read-file-name \
2135 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2136 \"Move file to trash: \" \"Delete file: \") \
2137 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2138 (null current-prefix-arg))",
2139 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2140 If file has multiple names, it continues to exist with the other names.
2141 TRASH non-nil means to trash the file instead of deleting, provided
2142 `delete-by-moving-to-trash' is non-nil.
2144 When called interactively, TRASH is t if no prefix argument is given.
2145 With a prefix argument, TRASH is nil. */)
2146 (Lisp_Object filename
, Lisp_Object trash
)
2148 Lisp_Object handler
;
2149 Lisp_Object encoded_file
;
2150 struct gcpro gcpro1
;
2153 if (!NILP (Ffile_directory_p (filename
))
2154 && NILP (Ffile_symlink_p (filename
)))
2155 xsignal2 (Qfile_error
,
2156 build_string ("Removing old name: is a directory"),
2159 filename
= Fexpand_file_name (filename
, Qnil
);
2161 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2162 if (!NILP (handler
))
2163 return call3 (handler
, Qdelete_file
, filename
, trash
);
2165 if (delete_by_moving_to_trash
&& !NILP (trash
))
2166 return call1 (Qmove_file_to_trash
, filename
);
2168 encoded_file
= ENCODE_FILE (filename
);
2170 if (0 > unlink (SDATA (encoded_file
)))
2171 report_file_error ("Removing old name", list1 (filename
));
2176 internal_delete_file_1 (Lisp_Object ignore
)
2181 /* Delete file FILENAME, returning 1 if successful and 0 if failed.
2182 This ignores `delete-by-moving-to-trash'. */
2185 internal_delete_file (Lisp_Object filename
)
2189 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2190 Qt
, internal_delete_file_1
);
2194 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2195 "fRename file: \nGRename %s to file: \np",
2196 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2197 If file has names other than FILE, it continues to have those names.
2198 Signals a `file-already-exists' error if a file NEWNAME already exists
2199 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2200 A number as third arg means request confirmation if NEWNAME already exists.
2201 This is what happens in interactive use with M-x. */)
2202 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2204 Lisp_Object handler
;
2205 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2206 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2208 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2209 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2210 CHECK_STRING (file
);
2211 CHECK_STRING (newname
);
2212 file
= Fexpand_file_name (file
, Qnil
);
2214 if ((!NILP (Ffile_directory_p (newname
)))
2216 /* If the file names are identical but for the case,
2217 don't attempt to move directory to itself. */
2218 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2222 Lisp_Object fname
= NILP (Ffile_directory_p (file
))
2223 ? file
: Fdirectory_file_name (file
);
2224 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2227 newname
= Fexpand_file_name (newname
, Qnil
);
2229 /* If the file name has special constructs in it,
2230 call the corresponding file handler. */
2231 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2233 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2234 if (!NILP (handler
))
2235 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2236 file
, newname
, ok_if_already_exists
));
2238 encoded_file
= ENCODE_FILE (file
);
2239 encoded_newname
= ENCODE_FILE (newname
);
2242 /* If the file names are identical but for the case, don't ask for
2243 confirmation: they simply want to change the letter-case of the
2245 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2247 if (NILP (ok_if_already_exists
)
2248 || INTEGERP (ok_if_already_exists
))
2249 barf_or_query_if_file_exists (newname
, "rename to it",
2250 INTEGERP (ok_if_already_exists
), 0, 0);
2251 if (0 > rename (SDATA (encoded_file
), SDATA (encoded_newname
)))
2257 symlink_target
= Ffile_symlink_p (file
);
2258 if (! NILP (symlink_target
))
2259 Fmake_symbolic_link (symlink_target
, newname
,
2260 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2263 if (!NILP (Ffile_directory_p (file
)))
2264 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2266 /* We have already prompted if it was an integer, so don't
2267 have copy-file prompt again. */
2268 Fcopy_file (file
, newname
,
2269 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2272 count
= SPECPDL_INDEX ();
2273 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2275 if (!NILP (Ffile_directory_p (file
))
2277 && NILP (symlink_target
)
2280 call2 (Qdelete_directory
, file
, Qt
);
2282 Fdelete_file (file
, Qnil
);
2283 unbind_to (count
, Qnil
);
2286 report_file_error ("Renaming", list2 (file
, newname
));
2292 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2293 "fAdd name to file: \nGName to add to %s: \np",
2294 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2295 Signals a `file-already-exists' error if a file NEWNAME already exists
2296 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2297 A number as third arg means request confirmation if NEWNAME already exists.
2298 This is what happens in interactive use with M-x. */)
2299 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2301 Lisp_Object handler
;
2302 Lisp_Object encoded_file
, encoded_newname
;
2303 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2305 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2306 encoded_file
= encoded_newname
= Qnil
;
2307 CHECK_STRING (file
);
2308 CHECK_STRING (newname
);
2309 file
= Fexpand_file_name (file
, Qnil
);
2311 if (!NILP (Ffile_directory_p (newname
)))
2312 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2314 newname
= Fexpand_file_name (newname
, Qnil
);
2316 /* If the file name has special constructs in it,
2317 call the corresponding file handler. */
2318 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2319 if (!NILP (handler
))
2320 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2321 newname
, ok_if_already_exists
));
2323 /* If the new name has special constructs in it,
2324 call the corresponding file handler. */
2325 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2326 if (!NILP (handler
))
2327 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2328 newname
, ok_if_already_exists
));
2330 encoded_file
= ENCODE_FILE (file
);
2331 encoded_newname
= ENCODE_FILE (newname
);
2333 if (NILP (ok_if_already_exists
)
2334 || INTEGERP (ok_if_already_exists
))
2335 barf_or_query_if_file_exists (newname
, "make it a new name",
2336 INTEGERP (ok_if_already_exists
), 0, 0);
2338 unlink (SDATA (newname
));
2339 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
)))
2340 report_file_error ("Adding new name", list2 (file
, newname
));
2346 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2347 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2348 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2349 Both args must be strings.
2350 Signals a `file-already-exists' error if a file LINKNAME already exists
2351 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2352 A number as third arg means request confirmation if LINKNAME already exists.
2353 This happens for interactive use with M-x. */)
2354 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2356 Lisp_Object handler
;
2357 Lisp_Object encoded_filename
, encoded_linkname
;
2358 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2360 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2361 encoded_filename
= encoded_linkname
= Qnil
;
2362 CHECK_STRING (filename
);
2363 CHECK_STRING (linkname
);
2364 /* If the link target has a ~, we must expand it to get
2365 a truly valid file name. Otherwise, do not expand;
2366 we want to permit links to relative file names. */
2367 if (SREF (filename
, 0) == '~')
2368 filename
= Fexpand_file_name (filename
, Qnil
);
2370 if (!NILP (Ffile_directory_p (linkname
)))
2371 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2373 linkname
= Fexpand_file_name (linkname
, Qnil
);
2375 /* If the file name has special constructs in it,
2376 call the corresponding file handler. */
2377 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2378 if (!NILP (handler
))
2379 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2380 linkname
, ok_if_already_exists
));
2382 /* If the new link name has special constructs in it,
2383 call the corresponding file handler. */
2384 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2385 if (!NILP (handler
))
2386 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2387 linkname
, ok_if_already_exists
));
2390 encoded_filename
= ENCODE_FILE (filename
);
2391 encoded_linkname
= ENCODE_FILE (linkname
);
2393 if (NILP (ok_if_already_exists
)
2394 || INTEGERP (ok_if_already_exists
))
2395 barf_or_query_if_file_exists (linkname
, "make it a link",
2396 INTEGERP (ok_if_already_exists
), 0, 0);
2397 if (0 > symlink (SDATA (encoded_filename
),
2398 SDATA (encoded_linkname
)))
2400 /* If we didn't complain already, silently delete existing file. */
2401 if (errno
== EEXIST
)
2403 unlink (SDATA (encoded_linkname
));
2404 if (0 <= symlink (SDATA (encoded_filename
),
2405 SDATA (encoded_linkname
)))
2412 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2419 xsignal1 (Qfile_error
, build_string ("Symbolic links are not supported"));
2421 #endif /* S_IFLNK */
2425 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2427 doc
: /* Return t if file FILENAME specifies an absolute file name.
2428 On Unix, this is a name starting with a `/' or a `~'. */)
2429 (Lisp_Object filename
)
2431 CHECK_STRING (filename
);
2432 return file_name_absolute_p (SDATA (filename
)) ? Qt
: Qnil
;
2435 /* Return nonzero if file FILENAME exists and can be executed. */
2438 check_executable (char *filename
)
2441 int len
= strlen (filename
);
2444 if (stat (filename
, &st
) < 0)
2446 return ((st
.st_mode
& S_IEXEC
) != 0);
2447 #else /* not DOS_NT */
2448 #ifdef HAVE_EUIDACCESS
2449 return (euidaccess (filename
, 1) >= 0);
2451 /* Access isn't quite right because it uses the real uid
2452 and we really want to test with the effective uid.
2453 But Unix doesn't give us a right way to do it. */
2454 return (access (filename
, 1) >= 0);
2456 #endif /* not DOS_NT */
2459 /* Return nonzero if file FILENAME exists and can be written. */
2462 check_writable (const char *filename
)
2466 if (stat (filename
, &st
) < 0)
2468 return (st
.st_mode
& S_IWRITE
|| (st
.st_mode
& S_IFMT
) == S_IFDIR
);
2469 #else /* not MSDOS */
2470 #ifdef HAVE_EUIDACCESS
2471 return (euidaccess (filename
, 2) >= 0);
2473 /* Access isn't quite right because it uses the real uid
2474 and we really want to test with the effective uid.
2475 But Unix doesn't give us a right way to do it.
2476 Opening with O_WRONLY could work for an ordinary file,
2477 but would lose for directories. */
2478 return (access (filename
, 2) >= 0);
2480 #endif /* not MSDOS */
2483 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2484 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2485 See also `file-readable-p' and `file-attributes'.
2486 This returns nil for a symlink to a nonexistent file.
2487 Use `file-symlink-p' to test for such links. */)
2488 (Lisp_Object filename
)
2490 Lisp_Object absname
;
2491 Lisp_Object handler
;
2492 struct stat statbuf
;
2494 CHECK_STRING (filename
);
2495 absname
= Fexpand_file_name (filename
, Qnil
);
2497 /* If the file name has special constructs in it,
2498 call the corresponding file handler. */
2499 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2500 if (!NILP (handler
))
2501 return call2 (handler
, Qfile_exists_p
, absname
);
2503 absname
= ENCODE_FILE (absname
);
2505 return (stat (SDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2508 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2509 doc
: /* Return t if FILENAME can be executed by you.
2510 For a directory, this means you can access files in that directory. */)
2511 (Lisp_Object filename
)
2513 Lisp_Object absname
;
2514 Lisp_Object handler
;
2516 CHECK_STRING (filename
);
2517 absname
= Fexpand_file_name (filename
, Qnil
);
2519 /* If the file name has special constructs in it,
2520 call the corresponding file handler. */
2521 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2522 if (!NILP (handler
))
2523 return call2 (handler
, Qfile_executable_p
, absname
);
2525 absname
= ENCODE_FILE (absname
);
2527 return (check_executable (SDATA (absname
)) ? Qt
: Qnil
);
2530 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2531 doc
: /* Return t if file FILENAME exists and you can read it.
2532 See also `file-exists-p' and `file-attributes'. */)
2533 (Lisp_Object filename
)
2535 Lisp_Object absname
;
2536 Lisp_Object handler
;
2539 struct stat statbuf
;
2541 CHECK_STRING (filename
);
2542 absname
= Fexpand_file_name (filename
, Qnil
);
2544 /* If the file name has special constructs in it,
2545 call the corresponding file handler. */
2546 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2547 if (!NILP (handler
))
2548 return call2 (handler
, Qfile_readable_p
, absname
);
2550 absname
= ENCODE_FILE (absname
);
2552 #if defined(DOS_NT) || defined(macintosh)
2553 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2555 if (access (SDATA (absname
), 0) == 0)
2558 #else /* not DOS_NT and not macintosh */
2560 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
2561 /* Opening a fifo without O_NONBLOCK can wait.
2562 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2563 except in the case of a fifo, on a system which handles it. */
2564 desc
= stat (SDATA (absname
), &statbuf
);
2567 if (S_ISFIFO (statbuf
.st_mode
))
2568 flags
|= O_NONBLOCK
;
2570 desc
= emacs_open (SDATA (absname
), flags
, 0);
2575 #endif /* not DOS_NT and not macintosh */
2578 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2580 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2581 doc
: /* Return t if file FILENAME can be written or created by you. */)
2582 (Lisp_Object filename
)
2584 Lisp_Object absname
, dir
, encoded
;
2585 Lisp_Object handler
;
2586 struct stat statbuf
;
2588 CHECK_STRING (filename
);
2589 absname
= Fexpand_file_name (filename
, Qnil
);
2591 /* If the file name has special constructs in it,
2592 call the corresponding file handler. */
2593 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2594 if (!NILP (handler
))
2595 return call2 (handler
, Qfile_writable_p
, absname
);
2597 encoded
= ENCODE_FILE (absname
);
2598 if (stat (SDATA (encoded
), &statbuf
) >= 0)
2599 return (check_writable (SDATA (encoded
))
2602 dir
= Ffile_name_directory (absname
);
2605 dir
= Fdirectory_file_name (dir
);
2608 dir
= ENCODE_FILE (dir
);
2610 /* The read-only attribute of the parent directory doesn't affect
2611 whether a file or directory can be created within it. Some day we
2612 should check ACLs though, which do affect this. */
2613 if (stat (SDATA (dir
), &statbuf
) < 0)
2615 return (statbuf
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2617 return (check_writable (!NILP (dir
) ? (char *) SDATA (dir
) : "")
2622 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2623 doc
: /* Access file FILENAME, and get an error if that does not work.
2624 The second argument STRING is used in the error message.
2625 If there is no error, returns nil. */)
2626 (Lisp_Object filename
, Lisp_Object string
)
2628 Lisp_Object handler
, encoded_filename
, absname
;
2631 CHECK_STRING (filename
);
2632 absname
= Fexpand_file_name (filename
, Qnil
);
2634 CHECK_STRING (string
);
2636 /* If the file name has special constructs in it,
2637 call the corresponding file handler. */
2638 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2639 if (!NILP (handler
))
2640 return call3 (handler
, Qaccess_file
, absname
, string
);
2642 encoded_filename
= ENCODE_FILE (absname
);
2644 fd
= emacs_open (SDATA (encoded_filename
), O_RDONLY
, 0);
2646 report_file_error (SDATA (string
), Fcons (filename
, Qnil
));
2652 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2653 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2654 The value is the link target, as a string.
2655 Otherwise it returns nil.
2657 This function returns t when given the name of a symlink that
2658 points to a nonexistent file. */)
2659 (Lisp_Object filename
)
2661 Lisp_Object handler
;
2663 CHECK_STRING (filename
);
2664 filename
= Fexpand_file_name (filename
, Qnil
);
2666 /* If the file name has special constructs in it,
2667 call the corresponding file handler. */
2668 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2669 if (!NILP (handler
))
2670 return call2 (handler
, Qfile_symlink_p
, filename
);
2679 filename
= ENCODE_FILE (filename
);
2686 buf
= (char *) xrealloc (buf
, bufsize
);
2687 memset (buf
, 0, bufsize
);
2690 valsize
= readlink (SDATA (filename
), buf
, bufsize
);
2694 /* HP-UX reports ERANGE if buffer is too small. */
2695 if (errno
== ERANGE
)
2705 while (valsize
>= bufsize
);
2707 val
= make_string (buf
, valsize
);
2708 if (buf
[0] == '/' && strchr (buf
, ':'))
2709 val
= concat2 (build_string ("/:"), val
);
2711 val
= DECODE_FILE (val
);
2714 #else /* not S_IFLNK */
2716 #endif /* not S_IFLNK */
2719 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2720 doc
: /* Return t if FILENAME names an existing directory.
2721 Symbolic links to directories count as directories.
2722 See `file-symlink-p' to distinguish symlinks. */)
2723 (Lisp_Object filename
)
2725 register Lisp_Object absname
;
2727 Lisp_Object handler
;
2729 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2731 /* If the file name has special constructs in it,
2732 call the corresponding file handler. */
2733 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2734 if (!NILP (handler
))
2735 return call2 (handler
, Qfile_directory_p
, absname
);
2737 absname
= ENCODE_FILE (absname
);
2739 if (stat (SDATA (absname
), &st
) < 0)
2741 return (st
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2744 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
2745 doc
: /* Return t if file FILENAME names a directory you can open.
2746 For the value to be t, FILENAME must specify the name of a directory as a file,
2747 and the directory must allow you to open files in it. In order to use a
2748 directory as a buffer's current directory, this predicate must return true.
2749 A directory name spec may be given instead; then the value is t
2750 if the directory so specified exists and really is a readable and
2751 searchable directory. */)
2752 (Lisp_Object filename
)
2754 Lisp_Object handler
;
2756 struct gcpro gcpro1
;
2758 /* If the file name has special constructs in it,
2759 call the corresponding file handler. */
2760 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2761 if (!NILP (handler
))
2762 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2765 tem
= (NILP (Ffile_directory_p (filename
))
2766 || NILP (Ffile_executable_p (filename
)));
2768 return tem
? Qnil
: Qt
;
2771 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2772 doc
: /* Return t if FILENAME names a regular file.
2773 This is the sort of file that holds an ordinary stream of data bytes.
2774 Symbolic links to regular files count as regular files.
2775 See `file-symlink-p' to distinguish symlinks. */)
2776 (Lisp_Object filename
)
2778 register Lisp_Object absname
;
2780 Lisp_Object handler
;
2782 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2784 /* If the file name has special constructs in it,
2785 call the corresponding file handler. */
2786 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2787 if (!NILP (handler
))
2788 return call2 (handler
, Qfile_regular_p
, absname
);
2790 absname
= ENCODE_FILE (absname
);
2795 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2797 /* Tell stat to use expensive method to get accurate info. */
2798 Vw32_get_true_file_attributes
= Qt
;
2799 result
= stat (SDATA (absname
), &st
);
2800 Vw32_get_true_file_attributes
= tem
;
2804 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2807 if (stat (SDATA (absname
), &st
) < 0)
2809 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2813 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2814 Sfile_selinux_context
, 1, 1, 0,
2815 doc
: /* Return SELinux context of file named FILENAME,
2816 as a list ("user", "role", "type", "range"). Return (nil, nil, nil, nil)
2817 if file does not exist, is not accessible, or SELinux is disabled */)
2818 (Lisp_Object filename
)
2820 Lisp_Object absname
;
2821 Lisp_Object values
[4];
2822 Lisp_Object handler
;
2824 security_context_t con
;
2829 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2831 /* If the file name has special constructs in it,
2832 call the corresponding file handler. */
2833 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2834 if (!NILP (handler
))
2835 return call2 (handler
, Qfile_selinux_context
, absname
);
2837 absname
= ENCODE_FILE (absname
);
2844 if (is_selinux_enabled ())
2846 conlength
= lgetfilecon (SDATA (absname
), &con
);
2849 context
= context_new (con
);
2850 if (context_user_get (context
))
2851 values
[0] = build_string (context_user_get (context
));
2852 if (context_role_get (context
))
2853 values
[1] = build_string (context_role_get (context
));
2854 if (context_type_get (context
))
2855 values
[2] = build_string (context_type_get (context
));
2856 if (context_range_get (context
))
2857 values
[3] = build_string (context_range_get (context
));
2858 context_free (context
);
2865 return Flist (sizeof(values
) / sizeof(values
[0]), values
);
2868 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2869 Sset_file_selinux_context
, 2, 2, 0,
2870 doc
: /* Set SELinux context of file named FILENAME to CONTEXT
2871 as a list ("user", "role", "type", "range"). Has no effect if SELinux
2873 (Lisp_Object filename
, Lisp_Object context
)
2875 Lisp_Object absname
, encoded_absname
;
2876 Lisp_Object handler
;
2877 Lisp_Object user
= CAR_SAFE (context
);
2878 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2879 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2880 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2882 security_context_t con
;
2883 int fail
, conlength
;
2884 context_t parsed_con
;
2887 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2889 /* If the file name has special constructs in it,
2890 call the corresponding file handler. */
2891 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2892 if (!NILP (handler
))
2893 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2895 encoded_absname
= ENCODE_FILE (absname
);
2898 if (is_selinux_enabled ())
2900 /* Get current file context. */
2901 conlength
= lgetfilecon (SDATA (encoded_absname
), &con
);
2904 parsed_con
= context_new (con
);
2905 /* Change the parts defined in the parameter.*/
2908 if (context_user_set (parsed_con
, SDATA (user
)))
2909 error ("Doing context_user_set");
2913 if (context_role_set (parsed_con
, SDATA (role
)))
2914 error ("Doing context_role_set");
2918 if (context_type_set (parsed_con
, SDATA (type
)))
2919 error ("Doing context_type_set");
2921 if (STRINGP (range
))
2923 if (context_range_set (parsed_con
, SDATA (range
)))
2924 error ("Doing context_range_set");
2927 /* Set the modified context back to the file. */
2928 fail
= lsetfilecon (SDATA (encoded_absname
), context_str (parsed_con
));
2930 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
2932 context_free (parsed_con
);
2935 report_file_error("Doing lgetfilecon", Fcons (absname
, Qnil
));
2945 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2946 doc
: /* Return mode bits of file named FILENAME, as an integer.
2947 Return nil, if file does not exist or is not accessible. */)
2948 (Lisp_Object filename
)
2950 Lisp_Object absname
;
2952 Lisp_Object handler
;
2954 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2956 /* If the file name has special constructs in it,
2957 call the corresponding file handler. */
2958 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2959 if (!NILP (handler
))
2960 return call2 (handler
, Qfile_modes
, absname
);
2962 absname
= ENCODE_FILE (absname
);
2964 if (stat (SDATA (absname
), &st
) < 0)
2967 return make_number (st
.st_mode
& 07777);
2970 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2971 "(let ((file (read-file-name \"File: \"))) \
2972 (list file (read-file-modes nil file)))",
2973 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2974 Only the 12 low bits of MODE are used.
2976 Interactively, mode bits are read by `read-file-modes', which accepts
2977 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2978 (Lisp_Object filename
, Lisp_Object mode
)
2980 Lisp_Object absname
, encoded_absname
;
2981 Lisp_Object handler
;
2983 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2984 CHECK_NUMBER (mode
);
2986 /* If the file name has special constructs in it,
2987 call the corresponding file handler. */
2988 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2989 if (!NILP (handler
))
2990 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2992 encoded_absname
= ENCODE_FILE (absname
);
2994 if (chmod (SDATA (encoded_absname
), XINT (mode
)) < 0)
2995 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3000 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3001 doc
: /* Set the file permission bits for newly created files.
3002 The argument MODE should be an integer; only the low 9 bits are used.
3003 This setting is inherited by subprocesses. */)
3006 CHECK_NUMBER (mode
);
3008 umask ((~ XINT (mode
)) & 0777);
3013 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3014 doc
: /* Return the default file protection for created files.
3015 The value is an integer. */)
3021 realmask
= umask (0);
3024 XSETINT (value
, (~ realmask
) & 0777);
3029 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3030 doc
: /* Set times of file FILENAME to TIME.
3031 Set both access and modification times.
3032 Return t on success, else nil.
3033 Use the current time if TIME is nil. TIME is in the format of
3035 (Lisp_Object filename
, Lisp_Object time
)
3037 Lisp_Object absname
, encoded_absname
;
3038 Lisp_Object handler
;
3042 if (! lisp_time_argument (time
, &sec
, &usec
))
3043 error ("Invalid time specification");
3045 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
3047 /* If the file name has special constructs in it,
3048 call the corresponding file handler. */
3049 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3050 if (!NILP (handler
))
3051 return call3 (handler
, Qset_file_times
, absname
, time
);
3053 encoded_absname
= ENCODE_FILE (absname
);
3058 EMACS_SET_SECS (t
, sec
);
3059 EMACS_SET_USECS (t
, usec
);
3061 if (set_file_times (SDATA (encoded_absname
), t
, t
))
3066 /* Setting times on a directory always fails. */
3067 if (stat (SDATA (encoded_absname
), &st
) == 0
3068 && (st
.st_mode
& S_IFMT
) == S_IFDIR
)
3071 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3080 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3081 doc
: /* Tell Unix to finish all pending disk updates. */)
3088 #endif /* HAVE_SYNC */
3090 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3091 doc
: /* Return t if file FILE1 is newer than file FILE2.
3092 If FILE1 does not exist, the answer is nil;
3093 otherwise, if FILE2 does not exist, the answer is t. */)
3094 (Lisp_Object file1
, Lisp_Object file2
)
3096 Lisp_Object absname1
, absname2
;
3099 Lisp_Object handler
;
3100 struct gcpro gcpro1
, gcpro2
;
3102 CHECK_STRING (file1
);
3103 CHECK_STRING (file2
);
3106 GCPRO2 (absname1
, file2
);
3107 absname1
= expand_and_dir_to_file (file1
, current_buffer
->directory
);
3108 absname2
= expand_and_dir_to_file (file2
, current_buffer
->directory
);
3111 /* If the file name has special constructs in it,
3112 call the corresponding file handler. */
3113 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3115 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3116 if (!NILP (handler
))
3117 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3119 GCPRO2 (absname1
, absname2
);
3120 absname1
= ENCODE_FILE (absname1
);
3121 absname2
= ENCODE_FILE (absname2
);
3124 if (stat (SDATA (absname1
), &st
) < 0)
3127 mtime1
= st
.st_mtime
;
3129 if (stat (SDATA (absname2
), &st
) < 0)
3132 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3136 Lisp_Object Qfind_buffer_file_type
;
3139 #ifndef READ_BUF_SIZE
3140 #define READ_BUF_SIZE (64 << 10)
3143 /* This function is called after Lisp functions to decide a coding
3144 system are called, or when they cause an error. Before they are
3145 called, the current buffer is set unibyte and it contains only a
3146 newly inserted text (thus the buffer was empty before the
3149 The functions may set markers, overlays, text properties, or even
3150 alter the buffer contents, change the current buffer.
3152 Here, we reset all those changes by:
3153 o set back the current buffer.
3154 o move all markers and overlays to BEG.
3155 o remove all text properties.
3156 o set back the buffer multibyteness. */
3159 decide_coding_unwind (Lisp_Object unwind_data
)
3161 Lisp_Object multibyte
, undo_list
, buffer
;
3163 multibyte
= XCAR (unwind_data
);
3164 unwind_data
= XCDR (unwind_data
);
3165 undo_list
= XCAR (unwind_data
);
3166 buffer
= XCDR (unwind_data
);
3168 if (current_buffer
!= XBUFFER (buffer
))
3169 set_buffer_internal (XBUFFER (buffer
));
3170 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3171 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3172 BUF_INTERVALS (current_buffer
) = 0;
3173 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3175 /* Now we are safe to change the buffer's multibyteness directly. */
3176 current_buffer
->enable_multibyte_characters
= multibyte
;
3177 current_buffer
->undo_list
= undo_list
;
3183 /* Used to pass values from insert-file-contents to read_non_regular. */
3185 static int non_regular_fd
;
3186 static EMACS_INT non_regular_inserted
;
3187 static EMACS_INT non_regular_nbytes
;
3190 /* Read from a non-regular file.
3191 Read non_regular_nbytes bytes max from non_regular_fd.
3192 Non_regular_inserted specifies where to put the read bytes.
3193 Value is the number of bytes read. */
3196 read_non_regular (Lisp_Object ignore
)
3202 nbytes
= emacs_read (non_regular_fd
,
3203 BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ non_regular_inserted
,
3204 non_regular_nbytes
);
3206 return make_number (nbytes
);
3210 /* Condition-case handler used when reading from non-regular files
3211 in insert-file-contents. */
3214 read_non_regular_quit (Lisp_Object ignore
)
3220 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3222 doc
: /* Insert contents of file FILENAME after point.
3223 Returns list of absolute file name and number of characters inserted.
3224 If second argument VISIT is non-nil, the buffer's visited filename and
3225 last save file modtime are set, and it is marked unmodified. If
3226 visiting and the file does not exist, visiting is completed before the
3229 The optional third and fourth arguments BEG and END specify what portion
3230 of the file to insert. These arguments count bytes in the file, not
3231 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3233 If optional fifth argument REPLACE is non-nil, replace the current
3234 buffer contents (in the accessible portion) with the file contents.
3235 This is better than simply deleting and inserting the whole thing
3236 because (1) it preserves some marker positions and (2) it puts less data
3237 in the undo list. When REPLACE is non-nil, the second return value is
3238 the number of characters that replace previous buffer contents.
3240 This function does code conversion according to the value of
3241 `coding-system-for-read' or `file-coding-system-alist', and sets the
3242 variable `last-coding-system-used' to the coding system actually used. */)
3243 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3247 EMACS_INT inserted
= 0;
3249 register EMACS_INT how_much
;
3250 register EMACS_INT unprocessed
;
3251 int count
= SPECPDL_INDEX ();
3252 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3253 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3255 EMACS_INT total
= 0;
3256 int not_regular
= 0;
3257 unsigned char read_buf
[READ_BUF_SIZE
];
3258 struct coding_system coding
;
3259 unsigned char buffer
[1 << 14];
3260 int replace_handled
= 0;
3261 int set_coding_system
= 0;
3262 Lisp_Object coding_system
;
3264 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3265 int we_locked_file
= 0;
3266 int deferred_remove_unwind_protect
= 0;
3268 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3269 error ("Cannot do file visiting in an indirect buffer");
3271 if (!NILP (current_buffer
->read_only
))
3272 Fbarf_if_buffer_read_only ();
3276 orig_filename
= Qnil
;
3279 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3281 CHECK_STRING (filename
);
3282 filename
= Fexpand_file_name (filename
, Qnil
);
3284 /* The value Qnil means that the coding system is not yet
3286 coding_system
= Qnil
;
3288 /* If the file name has special constructs in it,
3289 call the corresponding file handler. */
3290 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3291 if (!NILP (handler
))
3293 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3294 visit
, beg
, end
, replace
);
3295 if (CONSP (val
) && CONSP (XCDR (val
)))
3296 inserted
= XINT (XCAR (XCDR (val
)));
3300 orig_filename
= filename
;
3301 filename
= ENCODE_FILE (filename
);
3307 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3309 /* Tell stat to use expensive method to get accurate info. */
3310 Vw32_get_true_file_attributes
= Qt
;
3311 total
= stat (SDATA (filename
), &st
);
3312 Vw32_get_true_file_attributes
= tem
;
3316 if (stat (SDATA (filename
), &st
) < 0)
3317 #endif /* WINDOWSNT */
3319 if (fd
>= 0) emacs_close (fd
);
3322 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3325 if (!NILP (Vcoding_system_for_read
))
3326 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3331 /* This code will need to be changed in order to work on named
3332 pipes, and it's probably just not worth it. So we should at
3333 least signal an error. */
3334 if (!S_ISREG (st
.st_mode
))
3341 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3342 xsignal2 (Qfile_error
,
3343 build_string ("not a regular file"), orig_filename
);
3348 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0)
3351 /* Replacement should preserve point as it preserves markers. */
3352 if (!NILP (replace
))
3353 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3355 record_unwind_protect (close_file_unwind
, make_number (fd
));
3357 /* Can happen on any platform that uses long as type of off_t, but allows
3358 file sizes to exceed 2Gb, so give a suitable message. */
3359 if (! not_regular
&& st
.st_size
< 0)
3360 error ("Maximum buffer size exceeded");
3362 /* Prevent redisplay optimizations. */
3363 current_buffer
->clip_changed
= 1;
3367 if (!NILP (beg
) || !NILP (end
))
3368 error ("Attempt to visit less than an entire file");
3369 if (BEG
< Z
&& NILP (replace
))
3370 error ("Cannot do file visiting in a non-empty buffer");
3376 XSETFASTINT (beg
, 0);
3384 XSETINT (end
, st
.st_size
);
3386 /* Arithmetic overflow can occur if an Emacs integer cannot
3387 represent the file size, or if the calculations below
3388 overflow. The calculations below double the file size
3389 twice, so check that it can be multiplied by 4 safely. */
3390 if (XINT (end
) != st
.st_size
3391 /* Actually, it should test either INT_MAX or LONG_MAX
3392 depending on which one is used for EMACS_INT. But in
3393 any case, in practice, this test is redundant with the
3395 || st.st_size > INT_MAX / 4 */)
3396 error ("Maximum buffer size exceeded");
3398 /* The file size returned from stat may be zero, but data
3399 may be readable nonetheless, for example when this is a
3400 file in the /proc filesystem. */
3401 if (st
.st_size
== 0)
3402 XSETINT (end
, READ_BUF_SIZE
);
3406 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3408 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3409 setup_coding_system (coding_system
, &coding
);
3410 /* Ensure we set Vlast_coding_system_used. */
3411 set_coding_system
= 1;
3415 /* Decide the coding system to use for reading the file now
3416 because we can't use an optimized method for handling
3417 `coding:' tag if the current buffer is not empty. */
3418 if (!NILP (Vcoding_system_for_read
))
3419 coding_system
= Vcoding_system_for_read
;
3422 /* Don't try looking inside a file for a coding system
3423 specification if it is not seekable. */
3424 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3426 /* Find a coding system specified in the heading two
3427 lines or in the tailing several lines of the file.
3428 We assume that the 1K-byte and 3K-byte for heading
3429 and tailing respectively are sufficient for this
3433 if (st
.st_size
<= (1024 * 4))
3434 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3437 nread
= emacs_read (fd
, read_buf
, 1024);
3440 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3441 report_file_error ("Setting file position",
3442 Fcons (orig_filename
, Qnil
));
3443 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3448 error ("IO error reading %s: %s",
3449 SDATA (orig_filename
), emacs_strerror (errno
));
3452 struct buffer
*prev
= current_buffer
;
3456 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3458 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3459 buf
= XBUFFER (buffer
);
3461 delete_all_overlays (buf
);
3462 buf
->directory
= current_buffer
->directory
;
3463 buf
->read_only
= Qnil
;
3464 buf
->filename
= Qnil
;
3465 buf
->undo_list
= Qt
;
3466 eassert (buf
->overlays_before
== NULL
);
3467 eassert (buf
->overlays_after
== NULL
);
3469 set_buffer_internal (buf
);
3471 buf
->enable_multibyte_characters
= Qnil
;
3473 insert_1_both (read_buf
, nread
, nread
, 0, 0, 0);
3474 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3475 coding_system
= call2 (Vset_auto_coding_function
,
3476 filename
, make_number (nread
));
3477 set_buffer_internal (prev
);
3479 /* Discard the unwind protect for recovering the
3483 /* Rewind the file for the actual read done later. */
3484 if (lseek (fd
, 0, 0) < 0)
3485 report_file_error ("Setting file position",
3486 Fcons (orig_filename
, Qnil
));
3490 if (NILP (coding_system
))
3492 /* If we have not yet decided a coding system, check
3493 file-coding-system-alist. */
3494 Lisp_Object args
[6];
3496 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3497 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3498 coding_system
= Ffind_operation_coding_system (6, args
);
3499 if (CONSP (coding_system
))
3500 coding_system
= XCAR (coding_system
);
3504 if (NILP (coding_system
))
3505 coding_system
= Qundecided
;
3507 CHECK_CODING_SYSTEM (coding_system
);
3509 if (NILP (current_buffer
->enable_multibyte_characters
))
3510 /* We must suppress all character code conversion except for
3511 end-of-line conversion. */
3512 coding_system
= raw_text_coding_system (coding_system
);
3514 setup_coding_system (coding_system
, &coding
);
3515 /* Ensure we set Vlast_coding_system_used. */
3516 set_coding_system
= 1;
3519 /* If requested, replace the accessible part of the buffer
3520 with the file contents. Avoid replacing text at the
3521 beginning or end of the buffer that matches the file contents;
3522 that preserves markers pointing to the unchanged parts.
3524 Here we implement this feature in an optimized way
3525 for the case where code conversion is NOT needed.
3526 The following if-statement handles the case of conversion
3527 in a less optimal way.
3529 If the code conversion is "automatic" then we try using this
3530 method and hope for the best.
3531 But if we discover the need for conversion, we give up on this method
3532 and let the following if-statement handle the replace job. */
3535 && (NILP (coding_system
)
3536 || ! CODING_REQUIRE_DECODING (&coding
)))
3538 /* same_at_start and same_at_end count bytes,
3539 because file access counts bytes
3540 and BEG and END count bytes. */
3541 EMACS_INT same_at_start
= BEGV_BYTE
;
3542 EMACS_INT same_at_end
= ZV_BYTE
;
3544 /* There is still a possibility we will find the need to do code
3545 conversion. If that happens, we set this variable to 1 to
3546 give up on handling REPLACE in the optimized way. */
3547 int giveup_match_end
= 0;
3549 if (XINT (beg
) != 0)
3551 if (lseek (fd
, XINT (beg
), 0) < 0)
3552 report_file_error ("Setting file position",
3553 Fcons (orig_filename
, Qnil
));
3558 /* Count how many chars at the start of the file
3559 match the text at the beginning of the buffer. */
3562 EMACS_INT nread
, bufpos
;
3564 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3566 error ("IO error reading %s: %s",
3567 SDATA (orig_filename
), emacs_strerror (errno
));
3568 else if (nread
== 0)
3571 if (CODING_REQUIRE_DETECTION (&coding
))
3573 coding_system
= detect_coding_system (buffer
, nread
, nread
, 1, 0,
3575 setup_coding_system (coding_system
, &coding
);
3578 if (CODING_REQUIRE_DECODING (&coding
))
3579 /* We found that the file should be decoded somehow.
3580 Let's give up here. */
3582 giveup_match_end
= 1;
3587 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3588 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3589 same_at_start
++, bufpos
++;
3590 /* If we found a discrepancy, stop the scan.
3591 Otherwise loop around and scan the next bufferful. */
3592 if (bufpos
!= nread
)
3596 /* If the file matches the buffer completely,
3597 there's no need to replace anything. */
3598 if (same_at_start
- BEGV_BYTE
== XINT (end
))
3602 /* Truncate the buffer to the size of the file. */
3603 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3608 /* Count how many chars at the end of the file
3609 match the text at the end of the buffer. But, if we have
3610 already found that decoding is necessary, don't waste time. */
3611 while (!giveup_match_end
)
3613 EMACS_INT total_read
, nread
, bufpos
, curpos
, trial
;
3615 /* At what file position are we now scanning? */
3616 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
3617 /* If the entire file matches the buffer tail, stop the scan. */
3620 /* How much can we scan in the next step? */
3621 trial
= min (curpos
, sizeof buffer
);
3622 if (lseek (fd
, curpos
- trial
, 0) < 0)
3623 report_file_error ("Setting file position",
3624 Fcons (orig_filename
, Qnil
));
3626 total_read
= nread
= 0;
3627 while (total_read
< trial
)
3629 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3631 error ("IO error reading %s: %s",
3632 SDATA (orig_filename
), emacs_strerror (errno
));
3633 else if (nread
== 0)
3635 total_read
+= nread
;
3638 /* Scan this bufferful from the end, comparing with
3639 the Emacs buffer. */
3640 bufpos
= total_read
;
3642 /* Compare with same_at_start to avoid counting some buffer text
3643 as matching both at the file's beginning and at the end. */
3644 while (bufpos
> 0 && same_at_end
> same_at_start
3645 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3646 same_at_end
--, bufpos
--;
3648 /* If we found a discrepancy, stop the scan.
3649 Otherwise loop around and scan the preceding bufferful. */
3652 /* If this discrepancy is because of code conversion,
3653 we cannot use this method; giveup and try the other. */
3654 if (same_at_end
> same_at_start
3655 && FETCH_BYTE (same_at_end
- 1) >= 0200
3656 && ! NILP (current_buffer
->enable_multibyte_characters
)
3657 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3658 giveup_match_end
= 1;
3667 if (! giveup_match_end
)
3671 /* We win! We can handle REPLACE the optimized way. */
3673 /* Extend the start of non-matching text area to multibyte
3674 character boundary. */
3675 if (! NILP (current_buffer
->enable_multibyte_characters
))
3676 while (same_at_start
> BEGV_BYTE
3677 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3680 /* Extend the end of non-matching text area to multibyte
3681 character boundary. */
3682 if (! NILP (current_buffer
->enable_multibyte_characters
))
3683 while (same_at_end
< ZV_BYTE
3684 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3687 /* Don't try to reuse the same piece of text twice. */
3688 overlap
= (same_at_start
- BEGV_BYTE
3689 - (same_at_end
+ st
.st_size
- ZV
));
3691 same_at_end
+= overlap
;
3693 /* Arrange to read only the nonmatching middle part of the file. */
3694 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
3695 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
3697 del_range_byte (same_at_start
, same_at_end
, 0);
3698 /* Insert from the file at the proper position. */
3699 temp
= BYTE_TO_CHAR (same_at_start
);
3700 SET_PT_BOTH (temp
, same_at_start
);
3702 /* If display currently starts at beginning of line,
3703 keep it that way. */
3704 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3705 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3707 replace_handled
= 1;
3711 /* If requested, replace the accessible part of the buffer
3712 with the file contents. Avoid replacing text at the
3713 beginning or end of the buffer that matches the file contents;
3714 that preserves markers pointing to the unchanged parts.
3716 Here we implement this feature for the case where code conversion
3717 is needed, in a simple way that needs a lot of memory.
3718 The preceding if-statement handles the case of no conversion
3719 in a more optimized way. */
3720 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3722 EMACS_INT same_at_start
= BEGV_BYTE
;
3723 EMACS_INT same_at_end
= ZV_BYTE
;
3724 EMACS_INT same_at_start_charpos
;
3725 EMACS_INT inserted_chars
;
3728 unsigned char *decoded
;
3730 int this_count
= SPECPDL_INDEX ();
3731 int multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
3732 Lisp_Object conversion_buffer
;
3734 conversion_buffer
= code_conversion_save (1, multibyte
);
3736 /* First read the whole file, performing code conversion into
3737 CONVERSION_BUFFER. */
3739 if (lseek (fd
, XINT (beg
), 0) < 0)
3740 report_file_error ("Setting file position",
3741 Fcons (orig_filename
, Qnil
));
3743 total
= st
.st_size
; /* Total bytes in the file. */
3744 how_much
= 0; /* Bytes read from file so far. */
3745 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3746 unprocessed
= 0; /* Bytes not processed in previous loop. */
3748 GCPRO1 (conversion_buffer
);
3749 while (how_much
< total
)
3751 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3752 quitting while reading a huge while. */
3753 /* try is reserved in some compilers (Microsoft C) */
3754 EMACS_INT trytry
= min (total
- how_much
,
3755 READ_BUF_SIZE
- unprocessed
);
3758 /* Allow quitting out of the actual I/O. */
3761 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3773 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3774 BUF_Z (XBUFFER (conversion_buffer
)));
3775 decode_coding_c_string (&coding
, read_buf
, unprocessed
+ this,
3777 unprocessed
= coding
.carryover_bytes
;
3778 if (coding
.carryover_bytes
> 0)
3779 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3784 /* We should remove the unwind_protect calling
3785 close_file_unwind, but other stuff has been added the stack,
3786 so defer the removal till we reach the `handled' label. */
3787 deferred_remove_unwind_protect
= 1;
3789 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3790 if we couldn't read the file. */
3793 error ("IO error reading %s: %s",
3794 SDATA (orig_filename
), emacs_strerror (errno
));
3796 if (unprocessed
> 0)
3798 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3799 decode_coding_c_string (&coding
, read_buf
, unprocessed
,
3801 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3804 coding_system
= CODING_ID_NAME (coding
.id
);
3805 set_coding_system
= 1;
3806 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3807 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3808 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3810 /* Compare the beginning of the converted string with the buffer
3814 while (bufpos
< inserted
&& same_at_start
< same_at_end
3815 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3816 same_at_start
++, bufpos
++;
3818 /* If the file matches the head of buffer completely,
3819 there's no need to replace anything. */
3821 if (bufpos
== inserted
)
3823 /* Truncate the buffer to the size of the file. */
3824 if (same_at_start
== same_at_end
)
3827 del_range_byte (same_at_start
, same_at_end
, 0);
3830 unbind_to (this_count
, Qnil
);
3834 /* Extend the start of non-matching text area to the previous
3835 multibyte character boundary. */
3836 if (! NILP (current_buffer
->enable_multibyte_characters
))
3837 while (same_at_start
> BEGV_BYTE
3838 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3841 /* Scan this bufferful from the end, comparing with
3842 the Emacs buffer. */
3845 /* Compare with same_at_start to avoid counting some buffer text
3846 as matching both at the file's beginning and at the end. */
3847 while (bufpos
> 0 && same_at_end
> same_at_start
3848 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3849 same_at_end
--, bufpos
--;
3851 /* Extend the end of non-matching text area to the next
3852 multibyte character boundary. */
3853 if (! NILP (current_buffer
->enable_multibyte_characters
))
3854 while (same_at_end
< ZV_BYTE
3855 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3858 /* Don't try to reuse the same piece of text twice. */
3859 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3861 same_at_end
+= overlap
;
3863 /* If display currently starts at beginning of line,
3864 keep it that way. */
3865 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3866 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3868 /* Replace the chars that we need to replace,
3869 and update INSERTED to equal the number of bytes
3870 we are taking from the decoded string. */
3871 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3873 if (same_at_end
!= same_at_start
)
3875 del_range_byte (same_at_start
, same_at_end
, 0);
3877 same_at_start
= GPT_BYTE
;
3881 temp
= BYTE_TO_CHAR (same_at_start
);
3883 /* Insert from the file at the proper position. */
3884 SET_PT_BOTH (temp
, same_at_start
);
3885 same_at_start_charpos
3886 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3887 same_at_start
- BEGV_BYTE
3888 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3890 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3891 same_at_start
+ inserted
- BEGV_BYTE
3892 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3893 - same_at_start_charpos
);
3894 /* This binding is to avoid ask-user-about-supersession-threat
3895 being called in insert_from_buffer (via in
3896 prepare_to_modify_buffer). */
3897 specbind (intern ("buffer-file-name"), Qnil
);
3898 insert_from_buffer (XBUFFER (conversion_buffer
),
3899 same_at_start_charpos
, inserted_chars
, 0);
3900 /* Set `inserted' to the number of inserted characters. */
3901 inserted
= PT
- temp
;
3902 /* Set point before the inserted characters. */
3903 SET_PT_BOTH (temp
, same_at_start
);
3905 unbind_to (this_count
, Qnil
);
3912 register Lisp_Object temp
;
3914 total
= XINT (end
) - XINT (beg
);
3916 /* Make sure point-max won't overflow after this insertion. */
3917 XSETINT (temp
, total
);
3918 if (total
!= XINT (temp
))
3919 error ("Maximum buffer size exceeded");
3922 /* For a special file, all we can do is guess. */
3923 total
= READ_BUF_SIZE
;
3925 if (NILP (visit
) && inserted
> 0)
3927 #ifdef CLASH_DETECTION
3928 if (!NILP (current_buffer
->file_truename
)
3929 /* Make binding buffer-file-name to nil effective. */
3930 && !NILP (current_buffer
->filename
)
3931 && SAVE_MODIFF
>= MODIFF
)
3933 #endif /* CLASH_DETECTION */
3934 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3938 if (GAP_SIZE
< total
)
3939 make_gap (total
- GAP_SIZE
);
3941 if (XINT (beg
) != 0 || !NILP (replace
))
3943 if (lseek (fd
, XINT (beg
), 0) < 0)
3944 report_file_error ("Setting file position",
3945 Fcons (orig_filename
, Qnil
));
3948 /* In the following loop, HOW_MUCH contains the total bytes read so
3949 far for a regular file, and not changed for a special file. But,
3950 before exiting the loop, it is set to a negative value if I/O
3954 /* Total bytes inserted. */
3957 /* Here, we don't do code conversion in the loop. It is done by
3958 decode_coding_gap after all data are read into the buffer. */
3960 EMACS_INT gap_size
= GAP_SIZE
;
3962 while (how_much
< total
)
3964 /* try is reserved in some compilers (Microsoft C) */
3965 EMACS_INT trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3972 /* Maybe make more room. */
3973 if (gap_size
< trytry
)
3975 make_gap (total
- gap_size
);
3976 gap_size
= GAP_SIZE
;
3979 /* Read from the file, capturing `quit'. When an
3980 error occurs, end the loop, and arrange for a quit
3981 to be signaled after decoding the text we read. */
3982 non_regular_fd
= fd
;
3983 non_regular_inserted
= inserted
;
3984 non_regular_nbytes
= trytry
;
3985 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
3986 read_non_regular_quit
);
3997 /* Allow quitting out of the actual I/O. We don't make text
3998 part of the buffer until all the reading is done, so a C-g
3999 here doesn't do any harm. */
4002 this = emacs_read (fd
, BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ inserted
, trytry
);
4014 /* For a regular file, where TOTAL is the real size,
4015 count HOW_MUCH to compare with it.
4016 For a special file, where TOTAL is just a buffer size,
4017 so don't bother counting in HOW_MUCH.
4018 (INSERTED is where we count the number of characters inserted.) */
4025 /* Now we have read all the file data into the gap.
4026 If it was empty, undo marking the buffer modified. */
4030 #ifdef CLASH_DETECTION
4032 unlock_file (current_buffer
->file_truename
);
4034 Vdeactivate_mark
= old_Vdeactivate_mark
;
4037 Vdeactivate_mark
= Qt
;
4039 /* Make the text read part of the buffer. */
4040 GAP_SIZE
-= inserted
;
4042 GPT_BYTE
+= inserted
;
4044 ZV_BYTE
+= inserted
;
4049 /* Put an anchor to ensure multi-byte form ends at gap. */
4054 /* Discard the unwind protect for closing the file. */
4058 error ("IO error reading %s: %s",
4059 SDATA (orig_filename
), emacs_strerror (errno
));
4063 if (NILP (coding_system
))
4065 /* The coding system is not yet decided. Decide it by an
4066 optimized method for handling `coding:' tag.
4068 Note that we can get here only if the buffer was empty
4069 before the insertion. */
4071 if (!NILP (Vcoding_system_for_read
))
4072 coding_system
= Vcoding_system_for_read
;
4075 /* Since we are sure that the current buffer was empty
4076 before the insertion, we can toggle
4077 enable-multibyte-characters directly here without taking
4078 care of marker adjustment. By this way, we can run Lisp
4079 program safely before decoding the inserted text. */
4080 Lisp_Object unwind_data
;
4081 int count
= SPECPDL_INDEX ();
4083 unwind_data
= Fcons (current_buffer
->enable_multibyte_characters
,
4084 Fcons (current_buffer
->undo_list
,
4085 Fcurrent_buffer ()));
4086 current_buffer
->enable_multibyte_characters
= Qnil
;
4087 current_buffer
->undo_list
= Qt
;
4088 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4090 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4092 coding_system
= call2 (Vset_auto_coding_function
,
4093 filename
, make_number (inserted
));
4096 if (NILP (coding_system
))
4098 /* If the coding system is not yet decided, check
4099 file-coding-system-alist. */
4100 Lisp_Object args
[6];
4102 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4103 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4104 coding_system
= Ffind_operation_coding_system (6, args
);
4105 if (CONSP (coding_system
))
4106 coding_system
= XCAR (coding_system
);
4108 unbind_to (count
, Qnil
);
4109 inserted
= Z_BYTE
- BEG_BYTE
;
4112 if (NILP (coding_system
))
4113 coding_system
= Qundecided
;
4115 CHECK_CODING_SYSTEM (coding_system
);
4117 if (NILP (current_buffer
->enable_multibyte_characters
))
4118 /* We must suppress all character code conversion except for
4119 end-of-line conversion. */
4120 coding_system
= raw_text_coding_system (coding_system
);
4121 setup_coding_system (coding_system
, &coding
);
4122 /* Ensure we set Vlast_coding_system_used. */
4123 set_coding_system
= 1;
4128 /* When we visit a file by raw-text, we change the buffer to
4130 if (CODING_FOR_UNIBYTE (&coding
)
4131 /* Can't do this if part of the buffer might be preserved. */
4133 /* Visiting a file with these coding system makes the buffer
4135 current_buffer
->enable_multibyte_characters
= Qnil
;
4138 coding
.dst_multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
4139 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4140 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4142 move_gap_both (PT
, PT_BYTE
);
4143 GAP_SIZE
+= inserted
;
4144 ZV_BYTE
-= inserted
;
4148 decode_coding_gap (&coding
, inserted
, inserted
);
4149 inserted
= coding
.produced_char
;
4150 coding_system
= CODING_ID_NAME (coding
.id
);
4152 else if (inserted
> 0)
4153 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4156 /* Now INSERTED is measured in characters. */
4159 /* Use the conversion type to determine buffer-file-type
4160 (find-buffer-file-type is now used to help determine the
4162 if ((VECTORP (CODING_ID_EOL_TYPE (coding
.id
))
4163 || EQ (CODING_ID_EOL_TYPE (coding
.id
), Qunix
))
4164 && ! CODING_REQUIRE_DECODING (&coding
))
4165 current_buffer
->buffer_file_type
= Qt
;
4167 current_buffer
->buffer_file_type
= Qnil
;
4172 if (deferred_remove_unwind_protect
)
4173 /* If requested above, discard the unwind protect for closing the
4179 if (!EQ (current_buffer
->undo_list
, Qt
) && !nochange
)
4180 current_buffer
->undo_list
= Qnil
;
4184 current_buffer
->modtime
= st
.st_mtime
;
4185 current_buffer
->modtime_size
= st
.st_size
;
4186 current_buffer
->filename
= orig_filename
;
4189 SAVE_MODIFF
= MODIFF
;
4190 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4191 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4192 #ifdef CLASH_DETECTION
4195 if (!NILP (current_buffer
->file_truename
))
4196 unlock_file (current_buffer
->file_truename
);
4197 unlock_file (filename
);
4199 #endif /* CLASH_DETECTION */
4201 xsignal2 (Qfile_error
,
4202 build_string ("not a regular file"), orig_filename
);
4205 if (set_coding_system
)
4206 Vlast_coding_system_used
= coding_system
;
4208 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4210 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4212 if (! NILP (insval
))
4214 CHECK_NUMBER (insval
);
4215 inserted
= XFASTINT (insval
);
4219 /* Decode file format. */
4222 /* Don't run point motion or modification hooks when decoding. */
4223 int count
= SPECPDL_INDEX ();
4224 EMACS_INT old_inserted
= inserted
;
4225 specbind (Qinhibit_point_motion_hooks
, Qt
);
4226 specbind (Qinhibit_modification_hooks
, Qt
);
4228 /* Save old undo list and don't record undo for decoding. */
4229 old_undo
= current_buffer
->undo_list
;
4230 current_buffer
->undo_list
= Qt
;
4234 insval
= call3 (Qformat_decode
,
4235 Qnil
, make_number (inserted
), visit
);
4236 CHECK_NUMBER (insval
);
4237 inserted
= XFASTINT (insval
);
4241 /* If REPLACE is non-nil and we succeeded in not replacing the
4242 beginning or end of the buffer text with the file's contents,
4243 call format-decode with `point' positioned at the beginning
4244 of the buffer and `inserted' equalling the number of
4245 characters in the buffer. Otherwise, format-decode might
4246 fail to correctly analyze the beginning or end of the buffer.
4247 Hence we temporarily save `point' and `inserted' here and
4248 restore `point' iff format-decode did not insert or delete
4249 any text. Otherwise we leave `point' at point-min. */
4250 EMACS_INT opoint
= PT
;
4251 EMACS_INT opoint_byte
= PT_BYTE
;
4252 EMACS_INT oinserted
= ZV
- BEGV
;
4253 int ochars_modiff
= CHARS_MODIFF
;
4255 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4256 insval
= call3 (Qformat_decode
,
4257 Qnil
, make_number (oinserted
), visit
);
4258 CHECK_NUMBER (insval
);
4259 if (ochars_modiff
== CHARS_MODIFF
)
4260 /* format_decode didn't modify buffer's characters => move
4261 point back to position before inserted text and leave
4262 value of inserted alone. */
4263 SET_PT_BOTH (opoint
, opoint_byte
);
4265 /* format_decode modified buffer's characters => consider
4266 entire buffer changed and leave point at point-min. */
4267 inserted
= XFASTINT (insval
);
4270 /* For consistency with format-decode call these now iff inserted > 0
4271 (martin 2007-06-28). */
4272 p
= Vafter_insert_file_functions
;
4277 insval
= call1 (XCAR (p
), make_number (inserted
));
4280 CHECK_NUMBER (insval
);
4281 inserted
= XFASTINT (insval
);
4286 /* For the rationale of this see the comment on
4287 format-decode above. */
4288 EMACS_INT opoint
= PT
;
4289 EMACS_INT opoint_byte
= PT_BYTE
;
4290 EMACS_INT oinserted
= ZV
- BEGV
;
4291 int ochars_modiff
= CHARS_MODIFF
;
4293 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4294 insval
= call1 (XCAR (p
), make_number (oinserted
));
4297 CHECK_NUMBER (insval
);
4298 if (ochars_modiff
== CHARS_MODIFF
)
4299 /* after_insert_file_functions didn't modify
4300 buffer's characters => move point back to
4301 position before inserted text and leave value of
4303 SET_PT_BOTH (opoint
, opoint_byte
);
4305 /* after_insert_file_functions did modify buffer's
4306 characters => consider entire buffer changed and
4307 leave point at point-min. */
4308 inserted
= XFASTINT (insval
);
4318 current_buffer
->undo_list
= old_undo
;
4319 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4321 /* Adjust the last undo record for the size change during
4322 the format conversion. */
4323 Lisp_Object tem
= XCAR (old_undo
);
4324 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4325 && INTEGERP (XCDR (tem
))
4326 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4327 XSETCDR (tem
, make_number (PT
+ inserted
));
4331 /* If undo_list was Qt before, keep it that way.
4332 Otherwise start with an empty undo_list. */
4333 current_buffer
->undo_list
= EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4335 unbind_to (count
, Qnil
);
4338 /* Call after-change hooks for the inserted text, aside from the case
4339 of normal visiting (not with REPLACE), which is done in a new buffer
4340 "before" the buffer is changed. */
4341 if (inserted
> 0 && total
> 0
4342 && (NILP (visit
) || !NILP (replace
)))
4344 signal_after_change (PT
, 0, inserted
);
4345 update_compositions (PT
, PT
, CHECK_BORDER
);
4349 && current_buffer
->modtime
== -1)
4351 /* If visiting nonexistent file, return nil. */
4352 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4356 Fsignal (Qquit
, Qnil
);
4358 /* ??? Retval needs to be dealt with in all cases consistently. */
4360 val
= Fcons (orig_filename
,
4361 Fcons (make_number (inserted
),
4364 RETURN_UNGCPRO (unbind_to (count
, val
));
4367 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4370 build_annotations_unwind (Lisp_Object arg
)
4372 Vwrite_region_annotation_buffers
= arg
;
4376 /* Decide the coding-system to encode the data with. */
4379 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4380 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4381 struct coding_system
*coding
)
4384 Lisp_Object eol_parent
= Qnil
;
4387 && NILP (Fstring_equal (current_buffer
->filename
,
4388 current_buffer
->auto_save_file_name
)))
4393 else if (!NILP (Vcoding_system_for_write
))
4395 val
= Vcoding_system_for_write
;
4396 if (coding_system_require_warning
4397 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4398 /* Confirm that VAL can surely encode the current region. */
4399 val
= call5 (Vselect_safe_coding_system_function
,
4400 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4405 /* If the variable `buffer-file-coding-system' is set locally,
4406 it means that the file was read with some kind of code
4407 conversion or the variable is explicitly set by users. We
4408 had better write it out with the same coding system even if
4409 `enable-multibyte-characters' is nil.
4411 If it is not set locally, we anyway have to convert EOL
4412 format if the default value of `buffer-file-coding-system'
4413 tells that it is not Unix-like (LF only) format. */
4414 int using_default_coding
= 0;
4415 int force_raw_text
= 0;
4417 val
= current_buffer
->buffer_file_coding_system
;
4419 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4422 if (NILP (current_buffer
->enable_multibyte_characters
))
4428 /* Check file-coding-system-alist. */
4429 Lisp_Object args
[7], coding_systems
;
4431 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4432 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4434 coding_systems
= Ffind_operation_coding_system (7, args
);
4435 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4436 val
= XCDR (coding_systems
);
4441 /* If we still have not decided a coding system, use the
4442 default value of buffer-file-coding-system. */
4443 val
= current_buffer
->buffer_file_coding_system
;
4444 using_default_coding
= 1;
4447 if (! NILP (val
) && ! force_raw_text
)
4449 Lisp_Object spec
, attrs
;
4451 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4452 attrs
= AREF (spec
, 0);
4453 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4458 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4459 /* Confirm that VAL can surely encode the current region. */
4460 val
= call5 (Vselect_safe_coding_system_function
,
4461 start
, end
, val
, Qnil
, filename
);
4463 /* If the decided coding-system doesn't specify end-of-line
4464 format, we use that of
4465 `default-buffer-file-coding-system'. */
4466 if (! using_default_coding
4467 && ! NILP (buffer_defaults
.buffer_file_coding_system
))
4468 val
= (coding_inherit_eol_type
4469 (val
, buffer_defaults
.buffer_file_coding_system
));
4471 /* If we decide not to encode text, use `raw-text' or one of its
4474 val
= raw_text_coding_system (val
);
4477 val
= coding_inherit_eol_type (val
, eol_parent
);
4478 setup_coding_system (val
, coding
);
4480 if (!STRINGP (start
) && !NILP (current_buffer
->selective_display
))
4481 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4485 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4486 "r\nFWrite region to file: \ni\ni\ni\np",
4487 doc
: /* Write current region into specified file.
4488 When called from a program, requires three arguments:
4489 START, END and FILENAME. START and END are normally buffer positions
4490 specifying the part of the buffer to write.
4491 If START is nil, that means to use the entire buffer contents.
4492 If START is a string, then output that string to the file
4493 instead of any buffer contents; END is ignored.
4495 Optional fourth argument APPEND if non-nil means
4496 append to existing file contents (if any). If it is an integer,
4497 seek to that offset in the file before writing.
4498 Optional fifth argument VISIT, if t or a string, means
4499 set the last-save-file-modtime of buffer to this file's modtime
4500 and mark buffer not modified.
4501 If VISIT is a string, it is a second file name;
4502 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4503 VISIT is also the file name to lock and unlock for clash detection.
4504 If VISIT is neither t nor nil nor a string,
4505 that means do not display the \"Wrote file\" message.
4506 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4507 use for locking and unlocking, overriding FILENAME and VISIT.
4508 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4509 for an existing file with the same name. If MUSTBENEW is `excl',
4510 that means to get an error if the file already exists; never overwrite.
4511 If MUSTBENEW is neither nil nor `excl', that means ask for
4512 confirmation before overwriting, but do go ahead and overwrite the file
4513 if the user confirms.
4515 This does code conversion according to the value of
4516 `coding-system-for-write', `buffer-file-coding-system', or
4517 `file-coding-system-alist', and sets the variable
4518 `last-coding-system-used' to the coding system actually used.
4520 This calls `write-region-annotate-functions' at the start, and
4521 `write-region-post-annotation-function' at the end. */)
4522 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4527 const unsigned char *fn
;
4529 int count
= SPECPDL_INDEX ();
4531 Lisp_Object handler
;
4532 Lisp_Object visit_file
;
4533 Lisp_Object annotations
;
4534 Lisp_Object encoded_filename
;
4535 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4536 int quietly
= !NILP (visit
);
4537 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4538 struct buffer
*given_buffer
;
4540 int buffer_file_type
= O_BINARY
;
4542 struct coding_system coding
;
4544 if (current_buffer
->base_buffer
&& visiting
)
4545 error ("Cannot do file visiting in an indirect buffer");
4547 if (!NILP (start
) && !STRINGP (start
))
4548 validate_region (&start
, &end
);
4551 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4553 filename
= Fexpand_file_name (filename
, Qnil
);
4555 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4556 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4558 if (STRINGP (visit
))
4559 visit_file
= Fexpand_file_name (visit
, Qnil
);
4561 visit_file
= filename
;
4563 if (NILP (lockname
))
4564 lockname
= visit_file
;
4568 /* If the file name has special constructs in it,
4569 call the corresponding file handler. */
4570 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4571 /* If FILENAME has no handler, see if VISIT has one. */
4572 if (NILP (handler
) && STRINGP (visit
))
4573 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4575 if (!NILP (handler
))
4578 val
= call6 (handler
, Qwrite_region
, start
, end
,
4579 filename
, append
, visit
);
4583 SAVE_MODIFF
= MODIFF
;
4584 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4585 current_buffer
->filename
= visit_file
;
4591 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4593 /* Special kludge to simplify auto-saving. */
4596 /* Do it later, so write-region-annotate-function can work differently
4597 if we save "the buffer" vs "a region".
4598 This is useful in tar-mode. --Stef
4599 XSETFASTINT (start, BEG);
4600 XSETFASTINT (end, Z); */
4604 record_unwind_protect (build_annotations_unwind
,
4605 Vwrite_region_annotation_buffers
);
4606 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4607 count1
= SPECPDL_INDEX ();
4609 given_buffer
= current_buffer
;
4611 if (!STRINGP (start
))
4613 annotations
= build_annotations (start
, end
);
4615 if (current_buffer
!= given_buffer
)
4617 XSETFASTINT (start
, BEGV
);
4618 XSETFASTINT (end
, ZV
);
4624 XSETFASTINT (start
, BEGV
);
4625 XSETFASTINT (end
, ZV
);
4630 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4632 /* Decide the coding-system to encode the data with.
4633 We used to make this choice before calling build_annotations, but that
4634 leads to problems when a write-annotate-function takes care of
4635 unsavable chars (as was the case with X-Symbol). */
4636 Vlast_coding_system_used
4637 = choose_write_coding_system (start
, end
, filename
,
4638 append
, visit
, lockname
, &coding
);
4640 #ifdef CLASH_DETECTION
4642 lock_file (lockname
);
4643 #endif /* CLASH_DETECTION */
4645 encoded_filename
= ENCODE_FILE (filename
);
4647 fn
= SDATA (encoded_filename
);
4651 desc
= emacs_open (fn
, O_WRONLY
| buffer_file_type
, 0);
4652 #else /* not DOS_NT */
4653 desc
= emacs_open (fn
, O_WRONLY
, 0);
4654 #endif /* not DOS_NT */
4656 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4658 desc
= emacs_open (fn
,
4659 O_WRONLY
| O_CREAT
| buffer_file_type
4660 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4661 S_IREAD
| S_IWRITE
);
4662 #else /* not DOS_NT */
4663 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4664 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4665 auto_saving
? auto_save_mode_bits
: 0666);
4666 #endif /* not DOS_NT */
4670 #ifdef CLASH_DETECTION
4672 if (!auto_saving
) unlock_file (lockname
);
4674 #endif /* CLASH_DETECTION */
4676 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4679 record_unwind_protect (close_file_unwind
, make_number (desc
));
4681 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4685 if (NUMBERP (append
))
4686 ret
= lseek (desc
, XINT (append
), 1);
4688 ret
= lseek (desc
, 0, 2);
4691 #ifdef CLASH_DETECTION
4692 if (!auto_saving
) unlock_file (lockname
);
4693 #endif /* CLASH_DETECTION */
4695 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4704 if (STRINGP (start
))
4706 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4707 &annotations
, &coding
);
4710 else if (XINT (start
) != XINT (end
))
4712 failure
= 0 > a_write (desc
, Qnil
,
4713 XINT (start
), XINT (end
) - XINT (start
),
4714 &annotations
, &coding
);
4719 /* If file was empty, still need to write the annotations */
4720 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4721 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4725 if (CODING_REQUIRE_FLUSHING (&coding
)
4726 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4729 /* We have to flush out a data. */
4730 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4731 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4738 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4739 Disk full in NFS may be reported here. */
4740 /* mib says that closing the file will try to write as fast as NFS can do
4741 it, and that means the fsync here is not crucial for autosave files. */
4742 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4744 /* If fsync fails with EINTR, don't treat that as serious. Also
4745 ignore EINVAL which happens when fsync is not supported on this
4747 if (errno
!= EINTR
&& errno
!= EINVAL
)
4748 failure
= 1, save_errno
= errno
;
4752 /* NFS can report a write failure now. */
4753 if (emacs_close (desc
) < 0)
4754 failure
= 1, save_errno
= errno
;
4758 /* Discard the unwind protect for close_file_unwind. */
4759 specpdl_ptr
= specpdl
+ count1
;
4761 /* Call write-region-post-annotation-function. */
4762 while (CONSP (Vwrite_region_annotation_buffers
))
4764 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4765 if (!NILP (Fbuffer_live_p (buf
)))
4768 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4769 call0 (Vwrite_region_post_annotation_function
);
4771 Vwrite_region_annotation_buffers
4772 = XCDR (Vwrite_region_annotation_buffers
);
4775 unbind_to (count
, Qnil
);
4777 #ifdef CLASH_DETECTION
4779 unlock_file (lockname
);
4780 #endif /* CLASH_DETECTION */
4782 /* Do this before reporting IO error
4783 to avoid a "file has changed on disk" warning on
4784 next attempt to save. */
4787 current_buffer
->modtime
= st
.st_mtime
;
4788 current_buffer
->modtime_size
= st
.st_size
;
4792 error ("IO error writing %s: %s", SDATA (filename
),
4793 emacs_strerror (save_errno
));
4797 SAVE_MODIFF
= MODIFF
;
4798 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4799 current_buffer
->filename
= visit_file
;
4800 update_mode_lines
++;
4805 && ! NILP (Fstring_equal (current_buffer
->filename
,
4806 current_buffer
->auto_save_file_name
)))
4807 SAVE_MODIFF
= MODIFF
;
4813 message_with_string ((INTEGERP (append
)
4823 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4825 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4826 doc
: /* Return t if (car A) is numerically less than (car B). */)
4827 (Lisp_Object a
, Lisp_Object b
)
4829 return Flss (Fcar (a
), Fcar (b
));
4832 /* Build the complete list of annotations appropriate for writing out
4833 the text between START and END, by calling all the functions in
4834 write-region-annotate-functions and merging the lists they return.
4835 If one of these functions switches to a different buffer, we assume
4836 that buffer contains altered text. Therefore, the caller must
4837 make sure to restore the current buffer in all cases,
4838 as save-excursion would do. */
4841 build_annotations (Lisp_Object start
, Lisp_Object end
)
4843 Lisp_Object annotations
;
4845 struct gcpro gcpro1
, gcpro2
;
4846 Lisp_Object original_buffer
;
4847 int i
, used_global
= 0;
4849 XSETBUFFER (original_buffer
, current_buffer
);
4852 p
= Vwrite_region_annotate_functions
;
4853 GCPRO2 (annotations
, p
);
4856 struct buffer
*given_buffer
= current_buffer
;
4857 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4858 { /* Use the global value of the hook. */
4861 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4863 p
= Fappend (2, arg
);
4866 Vwrite_region_annotations_so_far
= annotations
;
4867 res
= call2 (XCAR (p
), start
, end
);
4868 /* If the function makes a different buffer current,
4869 assume that means this buffer contains altered text to be output.
4870 Reset START and END from the buffer bounds
4871 and discard all previous annotations because they should have
4872 been dealt with by this function. */
4873 if (current_buffer
!= given_buffer
)
4875 Vwrite_region_annotation_buffers
4876 = Fcons (Fcurrent_buffer (),
4877 Vwrite_region_annotation_buffers
);
4878 XSETFASTINT (start
, BEGV
);
4879 XSETFASTINT (end
, ZV
);
4882 Flength (res
); /* Check basic validity of return value */
4883 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4887 /* Now do the same for annotation functions implied by the file-format */
4888 if (auto_saving
&& (!EQ (current_buffer
->auto_save_file_format
, Qt
)))
4889 p
= current_buffer
->auto_save_file_format
;
4891 p
= current_buffer
->file_format
;
4892 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4894 struct buffer
*given_buffer
= current_buffer
;
4896 Vwrite_region_annotations_so_far
= annotations
;
4898 /* Value is either a list of annotations or nil if the function
4899 has written annotations to a temporary buffer, which is now
4901 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4902 original_buffer
, make_number (i
));
4903 if (current_buffer
!= given_buffer
)
4905 XSETFASTINT (start
, BEGV
);
4906 XSETFASTINT (end
, ZV
);
4911 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4919 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4920 If STRING is nil, POS is the character position in the current buffer.
4921 Intersperse with them the annotations from *ANNOT
4922 which fall within the range of POS to POS + NCHARS,
4923 each at its appropriate position.
4925 We modify *ANNOT by discarding elements as we use them up.
4927 The return value is negative in case of system call failure. */
4930 a_write (int desc
, Lisp_Object string
, int pos
, register int nchars
, Lisp_Object
*annot
, struct coding_system
*coding
)
4934 int lastpos
= pos
+ nchars
;
4936 while (NILP (*annot
) || CONSP (*annot
))
4938 tem
= Fcar_safe (Fcar (*annot
));
4941 nextpos
= XFASTINT (tem
);
4943 /* If there are no more annotations in this range,
4944 output the rest of the range all at once. */
4945 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4946 return e_write (desc
, string
, pos
, lastpos
, coding
);
4948 /* Output buffer text up to the next annotation's position. */
4951 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4955 /* Output the annotation. */
4956 tem
= Fcdr (Fcar (*annot
));
4959 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4962 *annot
= Fcdr (*annot
);
4968 /* Write text in the range START and END into descriptor DESC,
4969 encoding them with coding system CODING. If STRING is nil, START
4970 and END are character positions of the current buffer, else they
4971 are indexes to the string STRING. */
4974 e_write (int desc
, Lisp_Object string
, int start
, int end
, struct coding_system
*coding
)
4976 if (STRINGP (string
))
4979 end
= SCHARS (string
);
4982 /* We used to have a code for handling selective display here. But,
4983 now it is handled within encode_coding. */
4987 if (STRINGP (string
))
4989 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
4990 if (CODING_REQUIRE_ENCODING (coding
))
4992 encode_coding_object (coding
, string
,
4993 start
, string_char_to_byte (string
, start
),
4994 end
, string_char_to_byte (string
, end
), Qt
);
4998 coding
->dst_object
= string
;
4999 coding
->consumed_char
= SCHARS (string
);
5000 coding
->produced
= SBYTES (string
);
5005 int start_byte
= CHAR_TO_BYTE (start
);
5006 int end_byte
= CHAR_TO_BYTE (end
);
5008 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5009 if (CODING_REQUIRE_ENCODING (coding
))
5011 encode_coding_object (coding
, Fcurrent_buffer (),
5012 start
, start_byte
, end
, end_byte
, Qt
);
5016 coding
->dst_object
= Qnil
;
5017 coding
->dst_pos_byte
= start_byte
;
5018 if (start
>= GPT
|| end
<= GPT
)
5020 coding
->consumed_char
= end
- start
;
5021 coding
->produced
= end_byte
- start_byte
;
5025 coding
->consumed_char
= GPT
- start
;
5026 coding
->produced
= GPT_BYTE
- start_byte
;
5031 if (coding
->produced
> 0)
5035 STRINGP (coding
->dst_object
)
5036 ? SDATA (coding
->dst_object
)
5037 : BYTE_POS_ADDR (coding
->dst_pos_byte
),
5040 if (coding
->produced
)
5043 start
+= coding
->consumed_char
;
5049 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5050 Sverify_visited_file_modtime
, 0, 1, 0,
5051 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5052 This means that the file has not been changed since it was visited or saved.
5053 If BUF is omitted or nil, it defaults to the current buffer.
5054 See Info node `(elisp)Modification Time' for more details. */)
5059 Lisp_Object handler
;
5060 Lisp_Object filename
;
5070 if (!STRINGP (b
->filename
)) return Qt
;
5071 if (b
->modtime
== 0) return Qt
;
5073 /* If the file name has special constructs in it,
5074 call the corresponding file handler. */
5075 handler
= Ffind_file_name_handler (b
->filename
,
5076 Qverify_visited_file_modtime
);
5077 if (!NILP (handler
))
5078 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5080 filename
= ENCODE_FILE (b
->filename
);
5082 if (stat (SDATA (filename
), &st
) < 0)
5084 /* If the file doesn't exist now and didn't exist before,
5085 we say that it isn't modified, provided the error is a tame one. */
5086 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
5091 if ((st
.st_mtime
== b
->modtime
5092 /* If both are positive, accept them if they are off by one second. */
5093 || (st
.st_mtime
> 0 && b
->modtime
> 0
5094 && (st
.st_mtime
== b
->modtime
+ 1
5095 || st
.st_mtime
== b
->modtime
- 1)))
5096 && (st
.st_size
== b
->modtime_size
5097 || b
->modtime_size
< 0))
5102 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5103 Sclear_visited_file_modtime
, 0, 0, 0,
5104 doc
: /* Clear out records of last mod time of visited file.
5105 Next attempt to save will certainly not complain of a discrepancy. */)
5108 current_buffer
->modtime
= 0;
5109 current_buffer
->modtime_size
= -1;
5113 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5114 Svisited_file_modtime
, 0, 0, 0,
5115 doc
: /* Return the current buffer's recorded visited file modification time.
5116 The value is a list of the form (HIGH LOW), like the time values
5117 that `file-attributes' returns. If the current buffer has no recorded
5118 file modification time, this function returns 0.
5119 See Info node `(elisp)Modification Time' for more details. */)
5122 if (! current_buffer
->modtime
)
5123 return make_number (0);
5124 return make_time ((time_t) current_buffer
->modtime
);
5127 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5128 Sset_visited_file_modtime
, 0, 1, 0,
5129 doc
: /* Update buffer's recorded modification time from the visited file's time.
5130 Useful if the buffer was not read from the file normally
5131 or if the file itself has been changed for some known benign reason.
5132 An argument specifies the modification time value to use
5133 \(instead of that of the visited file), in the form of a list
5134 \(HIGH . LOW) or (HIGH LOW). */)
5135 (Lisp_Object time_list
)
5137 if (!NILP (time_list
))
5139 current_buffer
->modtime
= cons_to_long (time_list
);
5140 current_buffer
->modtime_size
= -1;
5144 register Lisp_Object filename
;
5146 Lisp_Object handler
;
5148 filename
= Fexpand_file_name (current_buffer
->filename
, Qnil
);
5150 /* If the file name has special constructs in it,
5151 call the corresponding file handler. */
5152 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5153 if (!NILP (handler
))
5154 /* The handler can find the file name the same way we did. */
5155 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5157 filename
= ENCODE_FILE (filename
);
5159 if (stat (SDATA (filename
), &st
) >= 0)
5161 current_buffer
->modtime
= st
.st_mtime
;
5162 current_buffer
->modtime_size
= st
.st_size
;
5170 auto_save_error (Lisp_Object error
)
5172 Lisp_Object args
[3], msg
;
5174 struct gcpro gcpro1
;
5178 auto_save_error_occurred
= 1;
5180 ring_bell (XFRAME (selected_frame
));
5182 args
[0] = build_string ("Auto-saving %s: %s");
5183 args
[1] = current_buffer
->name
;
5184 args
[2] = Ferror_message_string (error
);
5185 msg
= Fformat (3, args
);
5187 nbytes
= SBYTES (msg
);
5188 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5189 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5191 for (i
= 0; i
< 3; ++i
)
5194 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5196 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5197 Fsleep_for (make_number (1), Qnil
);
5211 auto_save_mode_bits
= 0666;
5213 /* Get visited file's mode to become the auto save file's mode. */
5214 if (! NILP (current_buffer
->filename
))
5216 if (stat (SDATA (current_buffer
->filename
), &st
) >= 0)
5217 /* But make sure we can overwrite it later! */
5218 auto_save_mode_bits
= st
.st_mode
| 0600;
5219 else if ((modes
= Ffile_modes (current_buffer
->filename
),
5221 /* Remote files don't cooperate with stat. */
5222 auto_save_mode_bits
= XINT (modes
) | 0600;
5226 Fwrite_region (Qnil
, Qnil
, current_buffer
->auto_save_file_name
, Qnil
,
5227 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5232 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5235 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5247 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5250 minibuffer_auto_raise
= XINT (value
);
5255 do_auto_save_make_dir (Lisp_Object dir
)
5259 call2 (Qmake_directory
, dir
, Qt
);
5260 XSETFASTINT (mode
, 0700);
5261 return Fset_file_modes (dir
, mode
);
5265 do_auto_save_eh (Lisp_Object ignore
)
5270 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5271 doc
: /* Auto-save all buffers that need it.
5272 This is all buffers that have auto-saving enabled
5273 and are changed since last auto-saved.
5274 Auto-saving writes the buffer into a file
5275 so that your editing is not lost if the system crashes.
5276 This file is not the file you visited; that changes only when you save.
5277 Normally we run the normal hook `auto-save-hook' before saving.
5279 A non-nil NO-MESSAGE argument means do not print any message if successful.
5280 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5281 (Lisp_Object no_message
, Lisp_Object current_only
)
5283 struct buffer
*old
= current_buffer
, *b
;
5284 Lisp_Object tail
, buf
;
5286 int do_handled_files
;
5288 FILE *stream
= NULL
;
5289 int count
= SPECPDL_INDEX ();
5290 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5291 int old_message_p
= 0;
5292 struct gcpro gcpro1
, gcpro2
;
5294 if (max_specpdl_size
< specpdl_size
+ 40)
5295 max_specpdl_size
= specpdl_size
+ 40;
5300 if (NILP (no_message
))
5302 old_message_p
= push_message ();
5303 record_unwind_protect (pop_message_unwind
, Qnil
);
5306 /* Ordinarily don't quit within this function,
5307 but don't make it impossible to quit (in case we get hung in I/O). */
5311 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5312 point to non-strings reached from Vbuffer_alist. */
5314 if (!NILP (Vrun_hooks
))
5315 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5317 if (STRINGP (Vauto_save_list_file_name
))
5319 Lisp_Object listfile
;
5321 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5323 /* Don't try to create the directory when shutting down Emacs,
5324 because creating the directory might signal an error, and
5325 that would leave Emacs in a strange state. */
5326 if (!NILP (Vrun_hooks
))
5330 GCPRO2 (dir
, listfile
);
5331 dir
= Ffile_name_directory (listfile
);
5332 if (NILP (Ffile_directory_p (dir
)))
5333 internal_condition_case_1 (do_auto_save_make_dir
,
5334 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5339 stream
= fopen (SDATA (listfile
), "w");
5342 record_unwind_protect (do_auto_save_unwind
,
5343 make_save_value (stream
, 0));
5344 record_unwind_protect (do_auto_save_unwind_1
,
5345 make_number (minibuffer_auto_raise
));
5346 minibuffer_auto_raise
= 0;
5348 auto_save_error_occurred
= 0;
5350 /* On first pass, save all files that don't have handlers.
5351 On second pass, save all files that do have handlers.
5353 If Emacs is crashing, the handlers may tweak what is causing
5354 Emacs to crash in the first place, and it would be a shame if
5355 Emacs failed to autosave perfectly ordinary files because it
5356 couldn't handle some ange-ftp'd file. */
5358 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5359 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5361 buf
= XCDR (XCAR (tail
));
5364 /* Record all the buffers that have auto save mode
5365 in the special file that lists them. For each of these buffers,
5366 Record visited name (if any) and auto save name. */
5367 if (STRINGP (b
->auto_save_file_name
)
5368 && stream
!= NULL
&& do_handled_files
== 0)
5371 if (!NILP (b
->filename
))
5373 fwrite (SDATA (b
->filename
), 1,
5374 SBYTES (b
->filename
), stream
);
5376 putc ('\n', stream
);
5377 fwrite (SDATA (b
->auto_save_file_name
), 1,
5378 SBYTES (b
->auto_save_file_name
), stream
);
5379 putc ('\n', stream
);
5383 if (!NILP (current_only
)
5384 && b
!= current_buffer
)
5387 /* Don't auto-save indirect buffers.
5388 The base buffer takes care of it. */
5392 /* Check for auto save enabled
5393 and file changed since last auto save
5394 and file changed since last real save. */
5395 if (STRINGP (b
->auto_save_file_name
)
5396 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5397 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5398 /* -1 means we've turned off autosaving for a while--see below. */
5399 && XINT (b
->save_length
) >= 0
5400 && (do_handled_files
5401 || NILP (Ffind_file_name_handler (b
->auto_save_file_name
,
5404 EMACS_TIME before_time
, after_time
;
5406 EMACS_GET_TIME (before_time
);
5408 /* If we had a failure, don't try again for 20 minutes. */
5409 if (b
->auto_save_failure_time
>= 0
5410 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5413 set_buffer_internal (b
);
5414 if (NILP (Vauto_save_include_big_deletions
)
5415 && (XFASTINT (b
->save_length
) * 10
5416 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5417 /* A short file is likely to change a large fraction;
5418 spare the user annoying messages. */
5419 && XFASTINT (b
->save_length
) > 5000
5420 /* These messages are frequent and annoying for `*mail*'. */
5421 && !EQ (b
->filename
, Qnil
)
5422 && NILP (no_message
))
5424 /* It has shrunk too much; turn off auto-saving here. */
5425 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5426 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5428 minibuffer_auto_raise
= 0;
5429 /* Turn off auto-saving until there's a real save,
5430 and prevent any more warnings. */
5431 XSETINT (b
->save_length
, -1);
5432 Fsleep_for (make_number (1), Qnil
);
5435 if (!auto_saved
&& NILP (no_message
))
5436 message1 ("Auto-saving...");
5437 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5439 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5440 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5441 set_buffer_internal (old
);
5443 EMACS_GET_TIME (after_time
);
5445 /* If auto-save took more than 60 seconds,
5446 assume it was an NFS failure that got a timeout. */
5447 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5448 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5452 /* Prevent another auto save till enough input events come in. */
5453 record_auto_save ();
5455 if (auto_saved
&& NILP (no_message
))
5459 /* If we are going to restore an old message,
5460 give time to read ours. */
5461 sit_for (make_number (1), 0, 0);
5464 else if (!auto_save_error_occurred
)
5465 /* Don't overwrite the error message if an error occurred.
5466 If we displayed a message and then restored a state
5467 with no message, leave a "done" message on the screen. */
5468 message1 ("Auto-saving...done");
5473 /* This restores the message-stack status. */
5474 unbind_to (count
, Qnil
);
5478 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5479 Sset_buffer_auto_saved
, 0, 0, 0,
5480 doc
: /* Mark current buffer as auto-saved with its current text.
5481 No auto-save file will be written until the buffer changes again. */)
5484 /* FIXME: This should not be called in indirect buffers, since
5485 they're not autosaved. */
5486 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5487 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5488 current_buffer
->auto_save_failure_time
= -1;
5492 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5493 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5494 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5497 current_buffer
->auto_save_failure_time
= -1;
5501 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5503 doc
: /* Return t if current buffer has been auto-saved recently.
5504 More precisely, if it has been auto-saved since last read from or saved
5505 in the visited file. If the buffer has no visited file,
5506 then any auto-save counts as "recent". */)
5509 /* FIXME: maybe we should return nil for indirect buffers since
5510 they're never autosaved. */
5511 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5514 /* Reading and completing file names */
5516 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5517 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5518 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5519 The return value is only relevant for a call to `read-file-name' that happens
5520 before any other event (mouse or keypress) is handled. */)
5523 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5524 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5534 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5536 struct gcpro gcpro1
, gcpro2
;
5537 Lisp_Object args
[7];
5539 GCPRO1 (default_filename
);
5540 args
[0] = intern ("read-file-name");
5543 args
[3] = default_filename
;
5544 args
[4] = mustmatch
;
5546 args
[6] = predicate
;
5547 RETURN_UNGCPRO (Ffuncall (7, args
));
5552 syms_of_fileio (void)
5554 Qoperations
= intern_c_string ("operations");
5555 Qexpand_file_name
= intern_c_string ("expand-file-name");
5556 Qsubstitute_in_file_name
= intern_c_string ("substitute-in-file-name");
5557 Qdirectory_file_name
= intern_c_string ("directory-file-name");
5558 Qfile_name_directory
= intern_c_string ("file-name-directory");
5559 Qfile_name_nondirectory
= intern_c_string ("file-name-nondirectory");
5560 Qunhandled_file_name_directory
= intern_c_string ("unhandled-file-name-directory");
5561 Qfile_name_as_directory
= intern_c_string ("file-name-as-directory");
5562 Qcopy_file
= intern_c_string ("copy-file");
5563 Qmake_directory_internal
= intern_c_string ("make-directory-internal");
5564 Qmake_directory
= intern_c_string ("make-directory");
5565 Qdelete_directory_internal
= intern_c_string ("delete-directory-internal");
5566 Qdelete_file
= intern_c_string ("delete-file");
5567 Qrename_file
= intern_c_string ("rename-file");
5568 Qadd_name_to_file
= intern_c_string ("add-name-to-file");
5569 Qmake_symbolic_link
= intern_c_string ("make-symbolic-link");
5570 Qfile_exists_p
= intern_c_string ("file-exists-p");
5571 Qfile_executable_p
= intern_c_string ("file-executable-p");
5572 Qfile_readable_p
= intern_c_string ("file-readable-p");
5573 Qfile_writable_p
= intern_c_string ("file-writable-p");
5574 Qfile_symlink_p
= intern_c_string ("file-symlink-p");
5575 Qaccess_file
= intern_c_string ("access-file");
5576 Qfile_directory_p
= intern_c_string ("file-directory-p");
5577 Qfile_regular_p
= intern_c_string ("file-regular-p");
5578 Qfile_accessible_directory_p
= intern_c_string ("file-accessible-directory-p");
5579 Qfile_modes
= intern_c_string ("file-modes");
5580 Qset_file_modes
= intern_c_string ("set-file-modes");
5581 Qset_file_times
= intern_c_string ("set-file-times");
5582 Qfile_selinux_context
= intern_c_string("file-selinux-context");
5583 Qset_file_selinux_context
= intern_c_string("set-file-selinux-context");
5584 Qfile_newer_than_file_p
= intern_c_string ("file-newer-than-file-p");
5585 Qinsert_file_contents
= intern_c_string ("insert-file-contents");
5586 Qwrite_region
= intern_c_string ("write-region");
5587 Qverify_visited_file_modtime
= intern_c_string ("verify-visited-file-modtime");
5588 Qset_visited_file_modtime
= intern_c_string ("set-visited-file-modtime");
5589 Qauto_save_coding
= intern_c_string ("auto-save-coding");
5591 staticpro (&Qoperations
);
5592 staticpro (&Qexpand_file_name
);
5593 staticpro (&Qsubstitute_in_file_name
);
5594 staticpro (&Qdirectory_file_name
);
5595 staticpro (&Qfile_name_directory
);
5596 staticpro (&Qfile_name_nondirectory
);
5597 staticpro (&Qunhandled_file_name_directory
);
5598 staticpro (&Qfile_name_as_directory
);
5599 staticpro (&Qcopy_file
);
5600 staticpro (&Qmake_directory_internal
);
5601 staticpro (&Qmake_directory
);
5602 staticpro (&Qdelete_directory_internal
);
5603 staticpro (&Qdelete_file
);
5604 staticpro (&Qrename_file
);
5605 staticpro (&Qadd_name_to_file
);
5606 staticpro (&Qmake_symbolic_link
);
5607 staticpro (&Qfile_exists_p
);
5608 staticpro (&Qfile_executable_p
);
5609 staticpro (&Qfile_readable_p
);
5610 staticpro (&Qfile_writable_p
);
5611 staticpro (&Qaccess_file
);
5612 staticpro (&Qfile_symlink_p
);
5613 staticpro (&Qfile_directory_p
);
5614 staticpro (&Qfile_regular_p
);
5615 staticpro (&Qfile_accessible_directory_p
);
5616 staticpro (&Qfile_modes
);
5617 staticpro (&Qset_file_modes
);
5618 staticpro (&Qset_file_times
);
5619 staticpro (&Qfile_selinux_context
);
5620 staticpro (&Qset_file_selinux_context
);
5621 staticpro (&Qfile_newer_than_file_p
);
5622 staticpro (&Qinsert_file_contents
);
5623 staticpro (&Qwrite_region
);
5624 staticpro (&Qverify_visited_file_modtime
);
5625 staticpro (&Qset_visited_file_modtime
);
5626 staticpro (&Qauto_save_coding
);
5628 Qfile_name_history
= intern_c_string ("file-name-history");
5629 Fset (Qfile_name_history
, Qnil
);
5630 staticpro (&Qfile_name_history
);
5632 Qfile_error
= intern_c_string ("file-error");
5633 staticpro (&Qfile_error
);
5634 Qfile_already_exists
= intern_c_string ("file-already-exists");
5635 staticpro (&Qfile_already_exists
);
5636 Qfile_date_error
= intern_c_string ("file-date-error");
5637 staticpro (&Qfile_date_error
);
5638 Qexcl
= intern_c_string ("excl");
5642 Qfind_buffer_file_type
= intern_c_string ("find-buffer-file-type");
5643 staticpro (&Qfind_buffer_file_type
);
5646 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system
,
5647 doc
: /* *Coding system for encoding file names.
5648 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5649 Vfile_name_coding_system
= Qnil
;
5651 DEFVAR_LISP ("default-file-name-coding-system",
5652 &Vdefault_file_name_coding_system
,
5653 doc
: /* Default coding system for encoding file names.
5654 This variable is used only when `file-name-coding-system' is nil.
5656 This variable is set/changed by the command `set-language-environment'.
5657 User should not set this variable manually,
5658 instead use `file-name-coding-system' to get a constant encoding
5659 of file names regardless of the current language environment. */);
5660 Vdefault_file_name_coding_system
= Qnil
;
5662 Qformat_decode
= intern_c_string ("format-decode");
5663 staticpro (&Qformat_decode
);
5664 Qformat_annotate_function
= intern_c_string ("format-annotate-function");
5665 staticpro (&Qformat_annotate_function
);
5666 Qafter_insert_file_set_coding
= intern_c_string ("after-insert-file-set-coding");
5667 staticpro (&Qafter_insert_file_set_coding
);
5669 Qcar_less_than_car
= intern_c_string ("car-less-than-car");
5670 staticpro (&Qcar_less_than_car
);
5672 Fput (Qfile_error
, Qerror_conditions
,
5673 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5674 Fput (Qfile_error
, Qerror_message
,
5675 make_pure_c_string ("File error"));
5677 Fput (Qfile_already_exists
, Qerror_conditions
,
5678 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5679 Fput (Qfile_already_exists
, Qerror_message
,
5680 make_pure_c_string ("File already exists"));
5682 Fput (Qfile_date_error
, Qerror_conditions
,
5683 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5684 Fput (Qfile_date_error
, Qerror_message
,
5685 make_pure_c_string ("Cannot set file date"));
5687 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist
,
5688 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
5689 If a file name matches REGEXP, then all I/O on that file is done by calling
5692 The first argument given to HANDLER is the name of the I/O primitive
5693 to be handled; the remaining arguments are the arguments that were
5694 passed to that primitive. For example, if you do
5695 (file-exists-p FILENAME)
5696 and FILENAME is handled by HANDLER, then HANDLER is called like this:
5697 (funcall HANDLER 'file-exists-p FILENAME)
5698 The function `find-file-name-handler' checks this list for a handler
5699 for its argument. */);
5700 Vfile_name_handler_alist
= Qnil
;
5702 DEFVAR_LISP ("set-auto-coding-function",
5703 &Vset_auto_coding_function
,
5704 doc
: /* If non-nil, a function to call to decide a coding system of file.
5705 Two arguments are passed to this function: the file name
5706 and the length of a file contents following the point.
5707 This function should return a coding system to decode the file contents.
5708 It should check the file name against `auto-coding-alist'.
5709 If no coding system is decided, it should check a coding system
5710 specified in the heading lines with the format:
5711 -*- ... coding: CODING-SYSTEM; ... -*-
5712 or local variable spec of the tailing lines with `coding:' tag. */);
5713 Vset_auto_coding_function
= Qnil
;
5715 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions
,
5716 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5717 Each is passed one argument, the number of characters inserted,
5718 with point at the start of the inserted text. Each function
5719 should leave point the same, and return the new character count.
5720 If `insert-file-contents' is intercepted by a handler from
5721 `file-name-handler-alist', that handler is responsible for calling the
5722 functions in `after-insert-file-functions' if appropriate. */);
5723 Vafter_insert_file_functions
= Qnil
;
5725 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions
,
5726 doc
: /* A list of functions to be called at the start of `write-region'.
5727 Each is passed two arguments, START and END as for `write-region'.
5728 These are usually two numbers but not always; see the documentation
5729 for `write-region'. The function should return a list of pairs
5730 of the form (POSITION . STRING), consisting of strings to be effectively
5731 inserted at the specified positions of the file being written (1 means to
5732 insert before the first byte written). The POSITIONs must be sorted into
5735 If there are several annotation functions, the lists returned by these
5736 functions are merged destructively. As each annotation function runs,
5737 the variable `write-region-annotations-so-far' contains a list of all
5738 annotations returned by previous annotation functions.
5740 An annotation function can return with a different buffer current.
5741 Doing so removes the annotations returned by previous functions, and
5742 resets START and END to `point-min' and `point-max' of the new buffer.
5744 After `write-region' completes, Emacs calls the function stored in
5745 `write-region-post-annotation-function', once for each buffer that was
5746 current when building the annotations (i.e., at least once), with that
5747 buffer current. */);
5748 Vwrite_region_annotate_functions
= Qnil
;
5749 staticpro (&Qwrite_region_annotate_functions
);
5750 Qwrite_region_annotate_functions
5751 = intern_c_string ("write-region-annotate-functions");
5753 DEFVAR_LISP ("write-region-post-annotation-function",
5754 &Vwrite_region_post_annotation_function
,
5755 doc
: /* Function to call after `write-region' completes.
5756 The function is called with no arguments. If one or more of the
5757 annotation functions in `write-region-annotate-functions' changed the
5758 current buffer, the function stored in this variable is called for
5759 each of those additional buffers as well, in addition to the original
5760 buffer. The relevant buffer is current during each function call. */);
5761 Vwrite_region_post_annotation_function
= Qnil
;
5762 staticpro (&Vwrite_region_annotation_buffers
);
5764 DEFVAR_LISP ("write-region-annotations-so-far",
5765 &Vwrite_region_annotations_so_far
,
5766 doc
: /* When an annotation function is called, this holds the previous annotations.
5767 These are the annotations made by other annotation functions
5768 that were already called. See also `write-region-annotate-functions'. */);
5769 Vwrite_region_annotations_so_far
= Qnil
;
5771 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers
,
5772 doc
: /* A list of file name handlers that temporarily should not be used.
5773 This applies only to the operation `inhibit-file-name-operation'. */);
5774 Vinhibit_file_name_handlers
= Qnil
;
5776 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation
,
5777 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5778 Vinhibit_file_name_operation
= Qnil
;
5780 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name
,
5781 doc
: /* File name in which we write a list of all auto save file names.
5782 This variable is initialized automatically from `auto-save-list-file-prefix'
5783 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5784 a non-nil value. */);
5785 Vauto_save_list_file_name
= Qnil
;
5787 DEFVAR_LISP ("auto-save-visited-file-name", &Vauto_save_visited_file_name
,
5788 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5789 Normally auto-save files are written under other names. */);
5790 Vauto_save_visited_file_name
= Qnil
;
5792 DEFVAR_LISP ("auto-save-include-big-deletions", &Vauto_save_include_big_deletions
,
5793 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5794 If nil, deleting a substantial portion of the text disables auto-save
5795 in the buffer; this is the default behavior, because the auto-save
5796 file is usually more useful if it contains the deleted text. */);
5797 Vauto_save_include_big_deletions
= Qnil
;
5800 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync
,
5801 doc
: /* *Non-nil means don't call fsync in `write-region'.
5802 This variable affects calls to `write-region' as well as save commands.
5803 A non-nil value may result in data loss! */);
5804 write_region_inhibit_fsync
= 0;
5807 DEFVAR_BOOL ("delete-by-moving-to-trash", &delete_by_moving_to_trash
,
5808 doc
: /* Specifies whether to use the system's trash can.
5809 When non-nil, certain file deletion commands use the function
5810 `move-file-to-trash' instead of deleting files outright.
5811 This includes interactive calls to `delete-file' and
5812 `delete-directory' and the Dired deletion commands. */);
5813 delete_by_moving_to_trash
= 0;
5814 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5815 Qmove_file_to_trash
= intern_c_string ("move-file-to-trash");
5816 staticpro (&Qmove_file_to_trash
);
5817 Qcopy_directory
= intern_c_string ("copy-directory");
5818 staticpro (&Qcopy_directory
);
5819 Qdelete_directory
= intern_c_string ("delete-directory");
5820 staticpro (&Qdelete_directory
);
5822 defsubr (&Sfind_file_name_handler
);
5823 defsubr (&Sfile_name_directory
);
5824 defsubr (&Sfile_name_nondirectory
);
5825 defsubr (&Sunhandled_file_name_directory
);
5826 defsubr (&Sfile_name_as_directory
);
5827 defsubr (&Sdirectory_file_name
);
5828 defsubr (&Smake_temp_name
);
5829 defsubr (&Sexpand_file_name
);
5830 defsubr (&Ssubstitute_in_file_name
);
5831 defsubr (&Scopy_file
);
5832 defsubr (&Smake_directory_internal
);
5833 defsubr (&Sdelete_directory_internal
);
5834 defsubr (&Sdelete_file
);
5835 defsubr (&Srename_file
);
5836 defsubr (&Sadd_name_to_file
);
5837 defsubr (&Smake_symbolic_link
);
5838 defsubr (&Sfile_name_absolute_p
);
5839 defsubr (&Sfile_exists_p
);
5840 defsubr (&Sfile_executable_p
);
5841 defsubr (&Sfile_readable_p
);
5842 defsubr (&Sfile_writable_p
);
5843 defsubr (&Saccess_file
);
5844 defsubr (&Sfile_symlink_p
);
5845 defsubr (&Sfile_directory_p
);
5846 defsubr (&Sfile_accessible_directory_p
);
5847 defsubr (&Sfile_regular_p
);
5848 defsubr (&Sfile_modes
);
5849 defsubr (&Sset_file_modes
);
5850 defsubr (&Sset_file_times
);
5851 defsubr (&Sfile_selinux_context
);
5852 defsubr (&Sset_file_selinux_context
);
5853 defsubr (&Sset_default_file_modes
);
5854 defsubr (&Sdefault_file_modes
);
5855 defsubr (&Sfile_newer_than_file_p
);
5856 defsubr (&Sinsert_file_contents
);
5857 defsubr (&Swrite_region
);
5858 defsubr (&Scar_less_than_car
);
5859 defsubr (&Sverify_visited_file_modtime
);
5860 defsubr (&Sclear_visited_file_modtime
);
5861 defsubr (&Svisited_file_modtime
);
5862 defsubr (&Sset_visited_file_modtime
);
5863 defsubr (&Sdo_auto_save
);
5864 defsubr (&Sset_buffer_auto_saved
);
5865 defsubr (&Sclear_buffer_auto_save_failure
);
5866 defsubr (&Srecent_auto_save_p
);
5868 defsubr (&Snext_read_file_uses_dialog_p
);
5871 defsubr (&Sunix_sync
);