1 /* File IO for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
25 #include <sys/types.h>
33 #if !defined (S_ISLNK) && defined (S_IFLNK)
34 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
37 #if !defined (S_ISFIFO) && defined (S_IFIFO)
38 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
41 #if !defined (S_ISREG) && defined (S_IFREG)
42 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
52 #ifdef HAVE_LIBSELINUX
53 #include <selinux/selinux.h>
54 #include <selinux/context.h>
58 #include "intervals.h"
60 #include "character.h"
63 #include "blockinput.h"
65 #include "dispextern.h"
71 #endif /* not WINDOWSNT */
75 #include <sys/param.h>
80 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
81 redirector allows the six letters between 'Z' and 'a' as well. */
83 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
86 #define IS_DRIVE(x) isalpha (x)
88 /* Need to lower-case the drive letter, or else expanded
89 filenames will sometimes compare inequal, because
90 `expand-file-name' doesn't always down-case the drive letter. */
91 #define DRIVE_LETTER(x) (tolower (x))
100 #include "commands.h"
106 #ifndef FILE_SYSTEM_CASE
107 #define FILE_SYSTEM_CASE(filename) (filename)
110 /* Nonzero during writing of auto-save files */
113 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
114 a new file with the same mode as the original */
115 int auto_save_mode_bits
;
117 /* Set by auto_save_1 if an error occurred during the last auto-save. */
118 int auto_save_error_occurred
;
120 /* The symbol bound to coding-system-for-read when
121 insert-file-contents is called for recovering a file. This is not
122 an actual coding system name, but just an indicator to tell
123 insert-file-contents to use `emacs-mule' with a special flag for
124 auto saving and recovering a file. */
125 Lisp_Object Qauto_save_coding
;
127 /* Coding system for file names, or nil if none. */
128 Lisp_Object Vfile_name_coding_system
;
130 /* Coding system for file names used only when
131 Vfile_name_coding_system is nil. */
132 Lisp_Object Vdefault_file_name_coding_system
;
134 /* Alist of elements (REGEXP . HANDLER) for file names
135 whose I/O is done with a special handler. */
136 Lisp_Object Vfile_name_handler_alist
;
138 /* Property name of a file name handler,
139 which gives a list of operations it handles.. */
140 Lisp_Object Qoperations
;
142 /* Lisp functions for translating file formats */
143 Lisp_Object Qformat_decode
, Qformat_annotate_function
;
145 /* Function to be called to decide a coding system of a reading file. */
146 Lisp_Object Vset_auto_coding_function
;
148 /* Functions to be called to process text properties in inserted file. */
149 Lisp_Object Vafter_insert_file_functions
;
151 /* Lisp function for setting buffer-file-coding-system and the
152 multibyteness of the current buffer after inserting a file. */
153 Lisp_Object Qafter_insert_file_set_coding
;
155 /* Functions to be called to create text property annotations for file. */
156 Lisp_Object Vwrite_region_annotate_functions
;
157 Lisp_Object Qwrite_region_annotate_functions
;
158 Lisp_Object Vwrite_region_post_annotation_function
;
160 /* During build_annotations, each time an annotation function is called,
161 this holds the annotations made by the previous functions. */
162 Lisp_Object Vwrite_region_annotations_so_far
;
164 /* Each time an annotation function changes the buffer, the new buffer
166 Lisp_Object Vwrite_region_annotation_buffers
;
168 /* File name in which we write a list of all our auto save files. */
169 Lisp_Object Vauto_save_list_file_name
;
171 /* Whether or not files are auto-saved into themselves. */
172 Lisp_Object Vauto_save_visited_file_name
;
174 /* Whether or not to continue auto-saving after a large deletion. */
175 Lisp_Object Vauto_save_include_big_deletions
;
178 /* Nonzero means skip the call to fsync in Fwrite-region. */
179 int write_region_inhibit_fsync
;
182 /* Non-zero means call move-file-to-trash in Fdelete_file or
183 Fdelete_directory_internal. */
184 int delete_by_moving_to_trash
;
186 Lisp_Object Qdelete_by_moving_to_trash
;
188 /* Lisp function for moving files to trash. */
189 Lisp_Object Qmove_file_to_trash
;
191 /* Lisp function for recursively copying directories. */
192 Lisp_Object Qcopy_directory
;
194 /* Lisp function for recursively deleting directories. */
195 Lisp_Object Qdelete_directory
;
198 extern Lisp_Object Vw32_get_true_file_attributes
;
201 /* These variables describe handlers that have "already" had a chance
202 to handle the current operation.
204 Vinhibit_file_name_handlers is a list of file name handlers.
205 Vinhibit_file_name_operation is the operation being handled.
206 If we try to handle that operation, we ignore those handlers. */
208 static Lisp_Object Vinhibit_file_name_handlers
;
209 static Lisp_Object Vinhibit_file_name_operation
;
211 Lisp_Object Qfile_error
, Qfile_already_exists
, Qfile_date_error
;
213 Lisp_Object Qfile_name_history
;
215 Lisp_Object Qcar_less_than_car
;
217 static int a_write (int, Lisp_Object
, int, int,
218 Lisp_Object
*, struct coding_system
*);
219 static int e_write (int, Lisp_Object
, int, int, struct coding_system
*);
223 report_file_error (const char *string
, Lisp_Object data
)
225 Lisp_Object errstring
;
229 synchronize_system_messages_locale ();
230 str
= strerror (errorno
);
231 errstring
= code_convert_string_norecord (make_unibyte_string (str
,
233 Vlocale_coding_system
, 0);
239 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
242 /* System error messages are capitalized. Downcase the initial
243 unless it is followed by a slash. (The slash case caters to
244 error messages that begin with "I/O" or, in German, "E/A".) */
245 if (STRING_MULTIBYTE (errstring
)
246 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
250 str
= (char *) SDATA (errstring
);
251 c
= STRING_CHAR (str
);
252 Faset (errstring
, make_number (0), make_number (DOWNCASE (c
)));
255 xsignal (Qfile_error
,
256 Fcons (build_string (string
), Fcons (errstring
, data
)));
261 close_file_unwind (Lisp_Object fd
)
263 emacs_close (XFASTINT (fd
));
267 /* Restore point, having saved it as a marker. */
270 restore_point_unwind (Lisp_Object location
)
272 Fgoto_char (location
);
273 Fset_marker (location
, Qnil
, Qnil
);
278 Lisp_Object Qexpand_file_name
;
279 Lisp_Object Qsubstitute_in_file_name
;
280 Lisp_Object Qdirectory_file_name
;
281 Lisp_Object Qfile_name_directory
;
282 Lisp_Object Qfile_name_nondirectory
;
283 Lisp_Object Qunhandled_file_name_directory
;
284 Lisp_Object Qfile_name_as_directory
;
285 Lisp_Object Qcopy_file
;
286 Lisp_Object Qmake_directory_internal
;
287 Lisp_Object Qmake_directory
;
288 Lisp_Object Qdelete_directory_internal
;
289 Lisp_Object Qdelete_file
;
290 Lisp_Object Qrename_file
;
291 Lisp_Object Qadd_name_to_file
;
292 Lisp_Object Qmake_symbolic_link
;
293 Lisp_Object Qfile_exists_p
;
294 Lisp_Object Qfile_executable_p
;
295 Lisp_Object Qfile_readable_p
;
296 Lisp_Object Qfile_writable_p
;
297 Lisp_Object Qfile_symlink_p
;
298 Lisp_Object Qaccess_file
;
299 Lisp_Object Qfile_directory_p
;
300 Lisp_Object Qfile_regular_p
;
301 Lisp_Object Qfile_accessible_directory_p
;
302 Lisp_Object Qfile_modes
;
303 Lisp_Object Qset_file_modes
;
304 Lisp_Object Qset_file_times
;
305 Lisp_Object Qfile_selinux_context
;
306 Lisp_Object Qset_file_selinux_context
;
307 Lisp_Object Qfile_newer_than_file_p
;
308 Lisp_Object Qinsert_file_contents
;
309 Lisp_Object Qwrite_region
;
310 Lisp_Object Qverify_visited_file_modtime
;
311 Lisp_Object Qset_visited_file_modtime
;
313 DEFUN ("find-file-name-handler", Ffind_file_name_handler
, Sfind_file_name_handler
, 2, 2, 0,
314 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
315 Otherwise, return nil.
316 A file name is handled if one of the regular expressions in
317 `file-name-handler-alist' matches it.
319 If OPERATION equals `inhibit-file-name-operation', then we ignore
320 any handlers that are members of `inhibit-file-name-handlers',
321 but we still do run any other handlers. This lets handlers
322 use the standard functions without calling themselves recursively. */)
323 (Lisp_Object filename
, Lisp_Object operation
)
325 /* This function must not munge the match data. */
326 Lisp_Object chain
, inhibited_handlers
, result
;
330 CHECK_STRING (filename
);
332 if (EQ (operation
, Vinhibit_file_name_operation
))
333 inhibited_handlers
= Vinhibit_file_name_handlers
;
335 inhibited_handlers
= Qnil
;
337 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
338 chain
= XCDR (chain
))
344 Lisp_Object string
= XCAR (elt
);
346 Lisp_Object handler
= XCDR (elt
);
347 Lisp_Object operations
= Qnil
;
349 if (SYMBOLP (handler
))
350 operations
= Fget (handler
, Qoperations
);
353 && (match_pos
= fast_string_match (string
, filename
)) > pos
354 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
358 handler
= XCDR (elt
);
359 tem
= Fmemq (handler
, inhibited_handlers
);
373 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
375 doc
: /* Return the directory component in file name FILENAME.
376 Return nil if FILENAME does not include a directory.
377 Otherwise return a directory name.
378 Given a Unix syntax file name, returns a string ending in slash. */)
379 (Lisp_Object filename
)
382 register const unsigned char *beg
;
384 register unsigned char *beg
;
386 register const unsigned char *p
;
389 CHECK_STRING (filename
);
391 /* If the file name has special constructs in it,
392 call the corresponding file handler. */
393 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
395 return call2 (handler
, Qfile_name_directory
, filename
);
397 filename
= FILE_SYSTEM_CASE (filename
);
399 beg
= (unsigned char *) alloca (SBYTES (filename
) + 1);
400 memcpy (beg
, SDATA (filename
), SBYTES (filename
) + 1);
402 beg
= SDATA (filename
);
404 p
= beg
+ SBYTES (filename
);
406 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
408 /* only recognise drive specifier at the beginning */
410 /* handle the "/:d:foo" and "/:foo" cases correctly */
411 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
412 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
419 /* Expansion of "c:" to drive and default directory. */
422 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
423 unsigned char *res
= alloca (MAXPATHLEN
+ 1);
424 unsigned char *r
= res
;
426 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
428 strncpy (res
, beg
, 2);
433 if (getdefdir (toupper (*beg
) - 'A' + 1, r
))
435 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
438 p
= beg
+ strlen (beg
);
441 dostounix_filename (beg
);
444 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
447 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
448 Sfile_name_nondirectory
, 1, 1, 0,
449 doc
: /* Return file name FILENAME sans its directory.
450 For example, in a Unix-syntax file name,
451 this is everything after the last slash,
452 or the entire name if it contains no slash. */)
453 (Lisp_Object filename
)
455 register const unsigned char *beg
, *p
, *end
;
458 CHECK_STRING (filename
);
460 /* If the file name has special constructs in it,
461 call the corresponding file handler. */
462 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
464 return call2 (handler
, Qfile_name_nondirectory
, filename
);
466 beg
= SDATA (filename
);
467 end
= p
= beg
+ SBYTES (filename
);
469 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
471 /* only recognise drive specifier at beginning */
473 /* handle the "/:d:foo" case correctly */
474 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
479 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
482 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
483 Sunhandled_file_name_directory
, 1, 1, 0,
484 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
485 A `directly usable' directory name is one that may be used without the
486 intervention of any file handler.
487 If FILENAME is a directly usable file itself, return
488 \(file-name-directory FILENAME).
489 If FILENAME refers to a file which is not accessible from a local process,
490 then this should return nil.
491 The `call-process' and `start-process' functions use this function to
492 get a current directory to run processes in. */)
493 (Lisp_Object filename
)
497 /* If the file name has special constructs in it,
498 call the corresponding file handler. */
499 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
501 return call2 (handler
, Qunhandled_file_name_directory
, filename
);
503 return Ffile_name_directory (filename
);
508 file_name_as_directory (char *out
, char *in
)
510 int size
= strlen (in
) - 1;
522 /* For Unix syntax, Append a slash if necessary */
523 if (!IS_DIRECTORY_SEP (out
[size
]))
525 out
[size
+ 1] = DIRECTORY_SEP
;
526 out
[size
+ 2] = '\0';
529 dostounix_filename (out
);
534 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
535 Sfile_name_as_directory
, 1, 1, 0,
536 doc
: /* Return a string representing the file name FILE interpreted as a directory.
537 This operation exists because a directory is also a file, but its name as
538 a directory is different from its name as a file.
539 The result can be used as the value of `default-directory'
540 or passed as second argument to `expand-file-name'.
541 For a Unix-syntax file name, just appends a slash. */)
551 /* If the file name has special constructs in it,
552 call the corresponding file handler. */
553 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
555 return call2 (handler
, Qfile_name_as_directory
, file
);
557 buf
= (char *) alloca (SBYTES (file
) + 10);
558 file_name_as_directory (buf
, SDATA (file
));
559 return make_specified_string (buf
, -1, strlen (buf
),
560 STRING_MULTIBYTE (file
));
564 * Convert from directory name to filename.
565 * On UNIX, it's simple: just make sure there isn't a terminating /
567 * Value is nonzero if the string output is different from the input.
571 directory_file_name (char *src
, char *dst
)
577 /* Process as Unix format: just remove any final slash.
578 But leave "/" unchanged; do not change it to "". */
581 && IS_DIRECTORY_SEP (dst
[slen
- 1])
583 && !IS_ANY_SEP (dst
[slen
- 2])
588 dostounix_filename (dst
);
593 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
595 doc
: /* Returns the file name of the directory named DIRECTORY.
596 This is the name of the file that holds the data for the directory DIRECTORY.
597 This operation exists because a directory is also a file, but its name as
598 a directory is different from its name as a file.
599 In Unix-syntax, this function just removes the final slash. */)
600 (Lisp_Object directory
)
605 CHECK_STRING (directory
);
607 if (NILP (directory
))
610 /* If the file name has special constructs in it,
611 call the corresponding file handler. */
612 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
614 return call2 (handler
, Qdirectory_file_name
, directory
);
616 buf
= (char *) alloca (SBYTES (directory
) + 20);
617 directory_file_name (SDATA (directory
), buf
);
618 return make_specified_string (buf
, -1, strlen (buf
),
619 STRING_MULTIBYTE (directory
));
622 static const char make_temp_name_tbl
[64] =
624 'A','B','C','D','E','F','G','H',
625 'I','J','K','L','M','N','O','P',
626 'Q','R','S','T','U','V','W','X',
627 'Y','Z','a','b','c','d','e','f',
628 'g','h','i','j','k','l','m','n',
629 'o','p','q','r','s','t','u','v',
630 'w','x','y','z','0','1','2','3',
631 '4','5','6','7','8','9','-','_'
634 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
636 /* Value is a temporary file name starting with PREFIX, a string.
638 The Emacs process number forms part of the result, so there is
639 no danger of generating a name being used by another process.
640 In addition, this function makes an attempt to choose a name
641 which has no existing file. To make this work, PREFIX should be
642 an absolute file name.
644 BASE64_P non-zero means add the pid as 3 characters in base64
645 encoding. In this case, 6 characters will be added to PREFIX to
646 form the file name. Otherwise, if Emacs is running on a system
647 with long file names, add the pid as a decimal number.
649 This function signals an error if no unique file name could be
653 make_temp_name (Lisp_Object prefix
, int base64_p
)
658 unsigned char *p
, *data
;
662 CHECK_STRING (prefix
);
664 /* VAL is created by adding 6 characters to PREFIX. The first
665 three are the PID of this process, in base 64, and the second
666 three are incremented if the file already exists. This ensures
667 262144 unique file names per PID per PREFIX. */
669 pid
= (int) getpid ();
673 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
674 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
675 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
680 #ifdef HAVE_LONG_FILE_NAMES
681 sprintf (pidbuf
, "%d", pid
);
682 pidlen
= strlen (pidbuf
);
684 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
685 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
686 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
691 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
692 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
693 if (!STRING_MULTIBYTE (prefix
))
694 STRING_SET_UNIBYTE (val
);
696 memcpy (data
, SDATA (prefix
), len
);
699 memcpy (p
, pidbuf
, pidlen
);
702 /* Here we try to minimize useless stat'ing when this function is
703 invoked many times successively with the same PREFIX. We achieve
704 this by initializing count to a random value, and incrementing it
707 We don't want make-temp-name to be called while dumping,
708 because then make_temp_name_count_initialized_p would get set
709 and then make_temp_name_count would not be set when Emacs starts. */
711 if (!make_temp_name_count_initialized_p
)
713 make_temp_name_count
= (unsigned) time (NULL
);
714 make_temp_name_count_initialized_p
= 1;
720 unsigned num
= make_temp_name_count
;
722 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
723 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
724 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
726 /* Poor man's congruential RN generator. Replace with
727 ++make_temp_name_count for debugging. */
728 make_temp_name_count
+= 25229;
729 make_temp_name_count
%= 225307;
731 if (stat (data
, &ignored
) < 0)
733 /* We want to return only if errno is ENOENT. */
737 /* The error here is dubious, but there is little else we
738 can do. The alternatives are to return nil, which is
739 as bad as (and in many cases worse than) throwing the
740 error, or to ignore the error, which will likely result
741 in looping through 225307 stat's, which is not only
742 dog-slow, but also useless since it will fallback to
743 the errow below, anyway. */
744 report_file_error ("Cannot create temporary name for prefix",
745 Fcons (prefix
, Qnil
));
750 error ("Cannot create temporary name for prefix `%s'",
756 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
757 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
758 The Emacs process number forms part of the result,
759 so there is no danger of generating a name being used by another process.
761 In addition, this function makes an attempt to choose a name
762 which has no existing file. To make this work,
763 PREFIX should be an absolute file name.
765 There is a race condition between calling `make-temp-name' and creating the
766 file which opens all kinds of security holes. For that reason, you should
767 probably use `make-temp-file' instead, except in three circumstances:
769 * If you are creating the file in the user's home directory.
770 * If you are creating a directory rather than an ordinary file.
771 * If you are taking special precautions as `make-temp-file' does. */)
774 return make_temp_name (prefix
, 0);
779 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
780 doc
: /* Convert filename NAME to absolute, and canonicalize it.
781 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
782 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
783 the current buffer's value of `default-directory' is used.
784 NAME should be a string that is a valid file name for the underlying
786 File name components that are `.' are removed, and
787 so are file name components followed by `..', along with the `..' itself;
788 note that these simplifications are done without checking the resulting
789 file names in the file system.
790 Multiple consecutive slashes are collapsed into a single slash,
791 except at the beginning of the file name when they are significant (e.g.,
792 UNC file names on MS-Windows.)
793 An initial `~/' expands to your home directory.
794 An initial `~USER/' expands to USER's home directory.
795 See also the function `substitute-in-file-name'.
797 For technical reasons, this function can return correct but
798 non-intuitive results for the root directory; for instance,
799 \(expand-file-name ".." "/") returns "/..". For this reason, use
800 \(directory-file-name (file-name-directory dirname)) to traverse a
801 filesystem tree, not (expand-file-name ".." dirname). */)
802 (Lisp_Object name
, Lisp_Object default_directory
)
804 /* These point to SDATA and need to be careful with string-relocation
805 during GC (via DECODE_FILE). */
806 unsigned char *nm
, *newdir
;
807 /* This should only point to alloca'd data. */
808 unsigned char *target
;
814 int collapse_newdir
= 1;
818 Lisp_Object handler
, result
;
824 /* If the file name has special constructs in it,
825 call the corresponding file handler. */
826 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
828 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
830 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
831 if (NILP (default_directory
))
832 default_directory
= current_buffer
->directory
;
833 if (! STRINGP (default_directory
))
836 /* "/" is not considered a root directory on DOS_NT, so using "/"
837 here causes an infinite recursion in, e.g., the following:
839 (let (default-directory)
840 (expand-file-name "a"))
842 To avoid this, we set default_directory to the root of the
844 default_directory
= build_string (emacs_root_dir ());
846 default_directory
= build_string ("/");
850 if (!NILP (default_directory
))
852 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
854 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
858 unsigned char *o
= SDATA (default_directory
);
860 /* Make sure DEFAULT_DIRECTORY is properly expanded.
861 It would be better to do this down below where we actually use
862 default_directory. Unfortunately, calling Fexpand_file_name recursively
863 could invoke GC, and the strings might be relocated. This would
864 be annoying because we have pointers into strings lying around
865 that would need adjusting, and people would add new pointers to
866 the code and forget to adjust them, resulting in intermittent bugs.
867 Putting this call here avoids all that crud.
869 The EQ test avoids infinite recursion. */
870 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
871 /* Save time in some common cases - as long as default_directory
872 is not relative, it can be canonicalized with name below (if it
873 is needed at all) without requiring it to be expanded now. */
875 /* Detect MSDOS file names with drive specifiers. */
876 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
877 && IS_DIRECTORY_SEP (o
[2]))
879 /* Detect Windows file names in UNC format. */
880 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
882 #else /* not DOS_NT */
883 /* Detect Unix absolute file names (/... alone is not absolute on
885 && ! (IS_DIRECTORY_SEP (o
[0]))
886 #endif /* not DOS_NT */
892 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
896 name
= FILE_SYSTEM_CASE (name
);
897 multibyte
= STRING_MULTIBYTE (name
);
898 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
901 default_directory
= string_to_multibyte (default_directory
);
904 name
= string_to_multibyte (name
);
909 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
910 nm
= (unsigned char *) alloca (SBYTES (name
) + 1);
911 memcpy (nm
, SDATA (name
), SBYTES (name
) + 1);
914 /* Note if special escape prefix is present, but remove for now. */
915 if (nm
[0] == '/' && nm
[1] == ':')
921 /* Find and remove drive specifier if present; this makes nm absolute
922 even if the rest of the name appears to be relative. Only look for
923 drive specifier at the beginning. */
924 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
931 /* If we see "c://somedir", we want to strip the first slash after the
932 colon when stripping the drive letter. Otherwise, this expands to
934 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
937 /* Discard any previous drive specifier if nm is now in UNC format. */
938 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
942 #endif /* WINDOWSNT */
945 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
946 none are found, we can probably return right away. We will avoid
947 allocating a new string if name is already fully expanded. */
949 IS_DIRECTORY_SEP (nm
[0])
951 && drive
&& !is_escaped
954 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
958 /* If it turns out that the filename we want to return is just a
959 suffix of FILENAME, we don't need to go through and edit
960 things; we just need to construct a new string using data
961 starting at the middle of FILENAME. If we set lose to a
962 non-zero value, that means we've discovered that we can't do
965 unsigned char *p
= nm
;
969 /* Since we know the name is absolute, we can assume that each
970 element starts with a "/". */
972 /* "." and ".." are hairy. */
973 if (IS_DIRECTORY_SEP (p
[0])
975 && (IS_DIRECTORY_SEP (p
[2])
977 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
980 /* We want to replace multiple `/' in a row with a single
983 && IS_DIRECTORY_SEP (p
[0])
984 && IS_DIRECTORY_SEP (p
[1]))
991 /* Make sure directories are all separated with /, but
992 avoid allocation of a new string when not required. */
993 dostounix_filename (nm
);
995 if (IS_DIRECTORY_SEP (nm
[1]))
997 if (strcmp (nm
, SDATA (name
)) != 0)
998 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1002 /* drive must be set, so this is okay */
1003 if (strcmp (nm
- 2, SDATA (name
)) != 0)
1007 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1008 temp
[0] = DRIVE_LETTER (drive
);
1009 name
= concat2 (build_string (temp
), name
);
1012 #else /* not DOS_NT */
1013 if (strcmp (nm
, SDATA (name
)) == 0)
1015 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1016 #endif /* not DOS_NT */
1020 /* At this point, nm might or might not be an absolute file name. We
1021 need to expand ~ or ~user if present, otherwise prefix nm with
1022 default_directory if nm is not absolute, and finally collapse /./
1023 and /foo/../ sequences.
1025 We set newdir to be the appropriate prefix if one is needed:
1026 - the relevant user directory if nm starts with ~ or ~user
1027 - the specified drive's working dir (DOS/NT only) if nm does not
1029 - the value of default_directory.
1031 Note that these prefixes are not guaranteed to be absolute (except
1032 for the working dir of a drive). Therefore, to ensure we always
1033 return an absolute name, if the final prefix is not absolute we
1034 append it to the current working directory. */
1038 if (nm
[0] == '~') /* prefix ~ */
1040 if (IS_DIRECTORY_SEP (nm
[1])
1041 || nm
[1] == 0) /* ~ by itself */
1045 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1046 newdir
= (unsigned char *) "";
1048 /* egetenv may return a unibyte string, which will bite us since
1049 we expect the directory to be multibyte. */
1050 tem
= build_string (newdir
);
1051 if (!STRING_MULTIBYTE (tem
))
1053 hdir
= DECODE_FILE (tem
);
1054 newdir
= SDATA (hdir
);
1057 collapse_newdir
= 0;
1060 else /* ~user/filename */
1062 unsigned char *o
, *p
;
1063 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1064 o
= alloca (p
- nm
+ 1);
1065 memcpy (o
, nm
, p
- nm
);
1069 pw
= (struct passwd
*) getpwnam (o
+ 1);
1073 newdir
= (unsigned char *) pw
-> pw_dir
;
1076 collapse_newdir
= 0;
1080 /* If we don't find a user of that name, leave the name
1081 unchanged; don't move nm forward to p. */
1086 /* On DOS and Windows, nm is absolute if a drive name was specified;
1087 use the drive's current directory as the prefix if needed. */
1088 if (!newdir
&& drive
)
1090 /* Get default directory if needed to make nm absolute. */
1091 if (!IS_DIRECTORY_SEP (nm
[0]))
1093 newdir
= alloca (MAXPATHLEN
+ 1);
1094 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1099 /* Either nm starts with /, or drive isn't mounted. */
1100 newdir
= alloca (4);
1101 newdir
[0] = DRIVE_LETTER (drive
);
1109 /* Finally, if no prefix has been specified and nm is not absolute,
1110 then it must be expanded relative to default_directory. */
1114 /* /... alone is not absolute on DOS and Windows. */
1115 && !IS_DIRECTORY_SEP (nm
[0])
1118 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1122 newdir
= SDATA (default_directory
);
1124 /* Note if special escape prefix is present, but remove for now. */
1125 if (newdir
[0] == '/' && newdir
[1] == ':')
1136 /* First ensure newdir is an absolute name. */
1138 /* Detect MSDOS file names with drive specifiers. */
1139 ! (IS_DRIVE (newdir
[0])
1140 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1142 /* Detect Windows file names in UNC format. */
1143 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1147 /* Effectively, let newdir be (expand-file-name newdir cwd).
1148 Because of the admonition against calling expand-file-name
1149 when we have pointers into lisp strings, we accomplish this
1150 indirectly by prepending newdir to nm if necessary, and using
1151 cwd (or the wd of newdir's drive) as the new newdir. */
1153 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1158 if (!IS_DIRECTORY_SEP (nm
[0]))
1160 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1161 file_name_as_directory (tmp
, newdir
);
1165 newdir
= alloca (MAXPATHLEN
+ 1);
1168 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1175 /* Strip off drive name from prefix, if present. */
1176 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1182 /* Keep only a prefix from newdir if nm starts with slash
1183 (//server/share for UNC, nothing otherwise). */
1184 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1187 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1190 newdir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1192 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1194 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1206 /* Get rid of any slash at the end of newdir, unless newdir is
1207 just / or // (an incomplete UNC name). */
1208 length
= strlen (newdir
);
1209 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1211 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1215 unsigned char *temp
= (unsigned char *) alloca (length
);
1216 memcpy (temp
, newdir
, length
- 1);
1217 temp
[length
- 1] = 0;
1225 /* Now concatenate the directory and name to new space in the stack frame */
1226 tlen
+= strlen (nm
) + 1;
1228 /* Reserve space for drive specifier and escape prefix, since either
1229 or both may need to be inserted. (The Microsoft x86 compiler
1230 produces incorrect code if the following two lines are combined.) */
1231 target
= (unsigned char *) alloca (tlen
+ 4);
1233 #else /* not DOS_NT */
1234 target
= (unsigned char *) alloca (tlen
);
1235 #endif /* not DOS_NT */
1240 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1243 /* If newdir is effectively "C:/", then the drive letter will have
1244 been stripped and newdir will be "/". Concatenating with an
1245 absolute directory in nm produces "//", which will then be
1246 incorrectly treated as a network share. Ignore newdir in
1247 this case (keeping the drive letter). */
1248 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1249 && newdir
[1] == '\0'))
1251 strcpy (target
, newdir
);
1254 file_name_as_directory (target
, newdir
);
1257 strcat (target
, nm
);
1259 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1262 unsigned char *p
= target
;
1263 unsigned char *o
= target
;
1267 if (!IS_DIRECTORY_SEP (*p
))
1271 else if (p
[1] == '.'
1272 && (IS_DIRECTORY_SEP (p
[2])
1275 /* If "/." is the entire filename, keep the "/". Otherwise,
1276 just delete the whole "/.". */
1277 if (o
== target
&& p
[2] == '\0')
1281 else if (p
[1] == '.' && p
[2] == '.'
1282 /* `/../' is the "superroot" on certain file systems.
1283 Turned off on DOS_NT systems because they have no
1284 "superroot" and because this causes us to produce
1285 file names like "d:/../foo" which fail file-related
1286 functions of the underlying OS. (To reproduce, try a
1287 long series of "../../" in default_directory, longer
1288 than the number of levels from the root.) */
1292 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1295 unsigned char *prev_o
= o
;
1297 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1300 /* Don't go below server level in UNC filenames. */
1301 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1302 && IS_DIRECTORY_SEP (*target
))
1306 /* Keep initial / only if this is the whole name. */
1307 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1311 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1312 /* Collapse multiple `/' in a row. */
1321 /* At last, set drive name. */
1323 /* Except for network file name. */
1324 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1325 #endif /* WINDOWSNT */
1327 if (!drive
) abort ();
1329 target
[0] = DRIVE_LETTER (drive
);
1332 /* Reinsert the escape prefix if required. */
1339 dostounix_filename (target
);
1342 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1345 /* Again look to see if the file name has special constructs in it
1346 and perhaps call the corresponding file handler. This is needed
1347 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1348 the ".." component gives us "/user@host:/bar/../baz" which needs
1349 to be expanded again. */
1350 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1351 if (!NILP (handler
))
1352 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1358 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1359 This is the old version of expand-file-name, before it was thoroughly
1360 rewritten for Emacs 10.31. We leave this version here commented-out,
1361 because the code is very complex and likely to have subtle bugs. If
1362 bugs _are_ found, it might be of interest to look at the old code and
1363 see what did it do in the relevant situation.
1365 Don't remove this code: it's true that it will be accessible
1366 from the repository, but a few years from deletion, people will
1367 forget it is there. */
1369 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1370 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1371 "Convert FILENAME to absolute, and canonicalize it.\n\
1372 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1373 \(does not start with slash); if DEFAULT is nil or missing,\n\
1374 the current buffer's value of default-directory is used.\n\
1375 Filenames containing `.' or `..' as components are simplified;\n\
1376 initial `~/' expands to your home directory.\n\
1377 See also the function `substitute-in-file-name'.")
1379 Lisp_Object name
, defalt
;
1383 register unsigned char *newdir
, *p
, *o
;
1385 unsigned char *target
;
1389 CHECK_STRING (name
);
1392 /* If nm is absolute, flush ...// and detect /./ and /../.
1393 If no /./ or /../ we can return right away. */
1400 if (p
[0] == '/' && p
[1] == '/'
1403 if (p
[0] == '/' && p
[1] == '~')
1404 nm
= p
+ 1, lose
= 1;
1405 if (p
[0] == '/' && p
[1] == '.'
1406 && (p
[2] == '/' || p
[2] == 0
1407 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1413 if (nm
== SDATA (name
))
1415 return build_string (nm
);
1419 /* Now determine directory to start with and put it in NEWDIR */
1423 if (nm
[0] == '~') /* prefix ~ */
1424 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1426 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1427 newdir
= (unsigned char *) "";
1430 else /* ~user/filename */
1432 /* Get past ~ to user */
1433 unsigned char *user
= nm
+ 1;
1434 /* Find end of name. */
1435 unsigned char *ptr
= (unsigned char *) strchr (user
, '/');
1436 int len
= ptr
? ptr
- user
: strlen (user
);
1437 /* Copy the user name into temp storage. */
1438 o
= (unsigned char *) alloca (len
+ 1);
1439 memcpy (o
, user
, len
);
1442 /* Look up the user name. */
1444 pw
= (struct passwd
*) getpwnam (o
+ 1);
1447 error ("\"%s\" isn't a registered user", o
+ 1);
1449 newdir
= (unsigned char *) pw
->pw_dir
;
1451 /* Discard the user name from NM. */
1455 if (nm
[0] != '/' && !newdir
)
1458 defalt
= current_buffer
->directory
;
1459 CHECK_STRING (defalt
);
1460 newdir
= SDATA (defalt
);
1463 /* Now concatenate the directory and name to new space in the stack frame */
1465 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1466 target
= (unsigned char *) alloca (tlen
);
1471 if (nm
[0] == 0 || nm
[0] == '/')
1472 strcpy (target
, newdir
);
1474 file_name_as_directory (target
, newdir
);
1477 strcat (target
, nm
);
1479 /* Now canonicalize by removing /. and /foo/.. if they appear */
1490 else if (!strncmp (p
, "//", 2)
1496 else if (p
[0] == '/' && p
[1] == '.'
1497 && (p
[2] == '/' || p
[2] == 0))
1499 else if (!strncmp (p
, "/..", 3)
1500 /* `/../' is the "superroot" on certain file systems. */
1502 && (p
[3] == '/' || p
[3] == 0))
1504 while (o
!= target
&& *--o
!= '/')
1506 if (o
== target
&& *o
== '/')
1516 return make_string (target
, o
- target
);
1520 /* If /~ or // appears, discard everything through first slash. */
1522 file_name_absolute_p (const unsigned char *filename
)
1525 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1527 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1528 && IS_DIRECTORY_SEP (filename
[2]))
1533 static unsigned char *
1534 search_embedded_absfilename (unsigned char *nm
, unsigned char *endp
)
1536 unsigned char *p
, *s
;
1538 for (p
= nm
+ 1; p
< endp
; p
++)
1541 || IS_DIRECTORY_SEP (p
[-1]))
1542 && file_name_absolute_p (p
)
1543 #if defined (WINDOWSNT) || defined(CYGWIN)
1544 /* // at start of file name is meaningful in Apollo,
1545 WindowsNT and Cygwin systems. */
1546 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1547 #endif /* not (WINDOWSNT || CYGWIN) */
1550 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1551 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
1553 unsigned char *o
= alloca (s
- p
+ 1);
1555 memcpy (o
, p
, s
- p
);
1558 /* If we have ~user and `user' exists, discard
1559 everything up to ~. But if `user' does not exist, leave
1560 ~user alone, it might be a literal file name. */
1562 pw
= getpwnam (o
+ 1);
1574 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1575 Ssubstitute_in_file_name
, 1, 1, 0,
1576 doc
: /* Substitute environment variables referred to in FILENAME.
1577 `$FOO' where FOO is an environment variable name means to substitute
1578 the value of that variable. The variable name should be terminated
1579 with a character not a letter, digit or underscore; otherwise, enclose
1580 the entire variable name in braces.
1582 If `/~' appears, all of FILENAME through that `/' is discarded.
1583 If `//' appears, everything up to and including the first of
1584 those `/' is discarded. */)
1585 (Lisp_Object filename
)
1589 register unsigned char *s
, *p
, *o
, *x
, *endp
;
1590 unsigned char *target
= NULL
;
1592 int substituted
= 0;
1595 Lisp_Object handler
;
1597 CHECK_STRING (filename
);
1599 multibyte
= STRING_MULTIBYTE (filename
);
1601 /* If the file name has special constructs in it,
1602 call the corresponding file handler. */
1603 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1604 if (!NILP (handler
))
1605 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
1607 /* Always work on a copy of the string, in case GC happens during
1608 decode of environment variables, causing the original Lisp_String
1609 data to be relocated. */
1610 nm
= (unsigned char *) alloca (SBYTES (filename
) + 1);
1611 memcpy (nm
, SDATA (filename
), SBYTES (filename
) + 1);
1614 dostounix_filename (nm
);
1615 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1617 endp
= nm
+ SBYTES (filename
);
1619 /* If /~ or // appears, discard everything through first slash. */
1620 p
= search_embedded_absfilename (nm
, endp
);
1622 /* Start over with the new string, so we check the file-name-handler
1623 again. Important with filenames like "/home/foo//:/hello///there"
1624 which whould substitute to "/:/hello///there" rather than "/there". */
1625 return Fsubstitute_in_file_name
1626 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1628 /* See if any variables are substituted into the string
1629 and find the total length of their values in `total' */
1631 for (p
= nm
; p
!= endp
;)
1641 /* "$$" means a single "$" */
1650 while (p
!= endp
&& *p
!= '}') p
++;
1651 if (*p
!= '}') goto missingclose
;
1657 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1661 /* Copy out the variable name */
1662 target
= (unsigned char *) alloca (s
- o
+ 1);
1663 strncpy (target
, o
, s
- o
);
1666 strupr (target
); /* $home == $HOME etc. */
1669 /* Get variable value */
1670 o
= (unsigned char *) egetenv (target
);
1673 /* Don't try to guess a maximum length - UTF8 can use up to
1674 four bytes per character. This code is unlikely to run
1675 in a situation that requires performance, so decoding the
1676 env variables twice should be acceptable. Note that
1677 decoding may cause a garbage collect. */
1678 Lisp_Object orig
, decoded
;
1679 orig
= make_unibyte_string (o
, strlen (o
));
1680 decoded
= DECODE_FILE (orig
);
1681 total
+= SBYTES (decoded
);
1691 /* If substitution required, recopy the string and do it */
1692 /* Make space in stack frame for the new copy */
1693 xnm
= (unsigned char *) alloca (SBYTES (filename
) + total
+ 1);
1696 /* Copy the rest of the name through, replacing $ constructs with values */
1713 while (p
!= endp
&& *p
!= '}') p
++;
1714 if (*p
!= '}') goto missingclose
;
1720 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1724 /* Copy out the variable name */
1725 target
= (unsigned char *) alloca (s
- o
+ 1);
1726 strncpy (target
, o
, s
- o
);
1729 strupr (target
); /* $home == $HOME etc. */
1732 /* Get variable value */
1733 o
= (unsigned char *) egetenv (target
);
1737 strcpy (x
, target
); x
+= strlen (target
);
1741 Lisp_Object orig
, decoded
;
1742 int orig_length
, decoded_length
;
1743 orig_length
= strlen (o
);
1744 orig
= make_unibyte_string (o
, orig_length
);
1745 decoded
= DECODE_FILE (orig
);
1746 decoded_length
= SBYTES (decoded
);
1747 strncpy (x
, SDATA (decoded
), decoded_length
);
1748 x
+= decoded_length
;
1750 /* If environment variable needed decoding, return value
1751 needs to be multibyte. */
1752 if (decoded_length
!= orig_length
1753 || strncmp (SDATA (decoded
), o
, orig_length
))
1760 /* If /~ or // appears, discard everything through first slash. */
1761 while ((p
= search_embedded_absfilename (xnm
, x
)))
1762 /* This time we do not start over because we've already expanded envvars
1763 and replaced $$ with $. Maybe we should start over as well, but we'd
1764 need to quote some $ to $$ first. */
1767 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1770 error ("Bad format environment-variable substitution");
1772 error ("Missing \"}\" in environment-variable substitution");
1774 error ("Substituting nonexistent environment variable \"%s\"", target
);
1780 /* A slightly faster and more convenient way to get
1781 (directory-file-name (expand-file-name FOO)). */
1784 expand_and_dir_to_file (Lisp_Object filename
, Lisp_Object defdir
)
1786 register Lisp_Object absname
;
1788 absname
= Fexpand_file_name (filename
, defdir
);
1790 /* Remove final slash, if any (unless this is the root dir).
1791 stat behaves differently depending! */
1792 if (SCHARS (absname
) > 1
1793 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1794 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
1795 /* We cannot take shortcuts; they might be wrong for magic file names. */
1796 absname
= Fdirectory_file_name (absname
);
1800 /* Signal an error if the file ABSNAME already exists.
1801 If INTERACTIVE is nonzero, ask the user whether to proceed,
1802 and bypass the error if the user says to go ahead.
1803 QUERYSTRING is a name for the action that is being considered
1806 *STATPTR is used to store the stat information if the file exists.
1807 If the file does not exist, STATPTR->st_mode is set to 0.
1808 If STATPTR is null, we don't store into it.
1810 If QUICK is nonzero, we ask for y or n, not yes or no. */
1813 barf_or_query_if_file_exists (Lisp_Object absname
, const unsigned char *querystring
, int interactive
, struct stat
*statptr
, int quick
)
1815 register Lisp_Object tem
, encoded_filename
;
1816 struct stat statbuf
;
1817 struct gcpro gcpro1
;
1819 encoded_filename
= ENCODE_FILE (absname
);
1821 /* stat is a good way to tell whether the file exists,
1822 regardless of what access permissions it has. */
1823 if (lstat (SDATA (encoded_filename
), &statbuf
) >= 0)
1826 xsignal2 (Qfile_already_exists
,
1827 build_string ("File already exists"), absname
);
1829 tem
= format2 ("File %s already exists; %s anyway? ",
1830 absname
, build_string (querystring
));
1832 tem
= call1 (intern ("y-or-n-p"), tem
);
1834 tem
= do_yes_or_no_p (tem
);
1837 xsignal2 (Qfile_already_exists
,
1838 build_string ("File already exists"), absname
);
1845 statptr
->st_mode
= 0;
1850 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
1851 "fCopy file: \nGCopy %s to file: \np\nP",
1852 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1853 If NEWNAME names a directory, copy FILE there.
1855 This function always sets the file modes of the output file to match
1858 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1859 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1860 signal a `file-already-exists' error without overwriting. If
1861 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1862 about overwriting; this is what happens in interactive use with M-x.
1863 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1866 Fourth arg KEEP-TIME non-nil means give the output file the same
1867 last-modified time as the old one. (This works on only some systems.)
1869 A prefix arg makes KEEP-TIME non-nil.
1871 If PRESERVE-UID-GID is non-nil, we try to transfer the
1872 uid and gid of FILE to NEWNAME.
1874 If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
1875 on the system, we copy the SELinux context of FILE to NEWNAME. */)
1876 (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
)
1879 char buf
[16 * 1024];
1880 struct stat st
, out_st
;
1881 Lisp_Object handler
;
1882 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1883 int count
= SPECPDL_INDEX ();
1884 int input_file_statable_p
;
1885 Lisp_Object encoded_file
, encoded_newname
;
1887 security_context_t con
;
1888 int fail
, conlength
= 0;
1891 encoded_file
= encoded_newname
= Qnil
;
1892 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1893 CHECK_STRING (file
);
1894 CHECK_STRING (newname
);
1896 if (!NILP (Ffile_directory_p (newname
)))
1897 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1899 newname
= Fexpand_file_name (newname
, Qnil
);
1901 file
= Fexpand_file_name (file
, Qnil
);
1903 /* If the input file name has special constructs in it,
1904 call the corresponding file handler. */
1905 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1906 /* Likewise for output file name. */
1908 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1909 if (!NILP (handler
))
1910 RETURN_UNGCPRO (call7 (handler
, Qcopy_file
, file
, newname
,
1911 ok_if_already_exists
, keep_time
, preserve_uid_gid
,
1912 preserve_selinux_context
));
1914 encoded_file
= ENCODE_FILE (file
);
1915 encoded_newname
= ENCODE_FILE (newname
);
1917 if (NILP (ok_if_already_exists
)
1918 || INTEGERP (ok_if_already_exists
))
1919 barf_or_query_if_file_exists (newname
, "copy to it",
1920 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1921 else if (stat (SDATA (encoded_newname
), &out_st
) < 0)
1925 if (!CopyFile (SDATA (encoded_file
),
1926 SDATA (encoded_newname
),
1928 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1929 /* CopyFile retains the timestamp by default. */
1930 else if (NILP (keep_time
))
1936 EMACS_GET_TIME (now
);
1937 filename
= SDATA (encoded_newname
);
1939 /* Ensure file is writable while its modified time is set. */
1940 attributes
= GetFileAttributes (filename
);
1941 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1942 if (set_file_times (filename
, now
, now
))
1944 /* Restore original attributes. */
1945 SetFileAttributes (filename
, attributes
);
1946 xsignal2 (Qfile_date_error
,
1947 build_string ("Cannot set file date"), newname
);
1949 /* Restore original attributes. */
1950 SetFileAttributes (filename
, attributes
);
1952 #else /* not WINDOWSNT */
1954 ifd
= emacs_open (SDATA (encoded_file
), O_RDONLY
, 0);
1958 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1960 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1962 /* We can only copy regular files and symbolic links. Other files are not
1964 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
1967 if (!NILP (preserve_selinux_context
) && is_selinux_enabled ())
1969 conlength
= fgetfilecon (ifd
, &con
);
1970 if (conlength
== -1)
1971 report_file_error ("Doing fgetfilecon", Fcons (file
, Qnil
));
1975 if (out_st
.st_mode
!= 0
1976 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
1979 report_file_error ("Input and output files are the same",
1980 Fcons (file
, Fcons (newname
, Qnil
)));
1983 #if defined (S_ISREG) && defined (S_ISLNK)
1984 if (input_file_statable_p
)
1986 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
1988 #if defined (EISDIR)
1989 /* Get a better looking error message. */
1992 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
1995 #endif /* S_ISREG && S_ISLNK */
1998 /* System's default file type was set to binary by _fmode in emacs.c. */
1999 ofd
= emacs_open (SDATA (encoded_newname
),
2000 O_WRONLY
| O_TRUNC
| O_CREAT
2001 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2002 S_IREAD
| S_IWRITE
);
2003 #else /* not MSDOS */
2004 ofd
= emacs_open (SDATA (encoded_newname
),
2005 O_WRONLY
| O_TRUNC
| O_CREAT
2006 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2008 #endif /* not MSDOS */
2010 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2012 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2016 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2017 if (emacs_write (ofd
, buf
, n
) != n
)
2018 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2022 /* Preserve the original file modes, and if requested, also its
2024 if (input_file_statable_p
)
2026 if (! NILP (preserve_uid_gid
))
2027 fchown (ofd
, st
.st_uid
, st
.st_gid
);
2028 fchmod (ofd
, st
.st_mode
& 07777);
2030 #endif /* not MSDOS */
2035 /* Set the modified context back to the file. */
2036 fail
= fsetfilecon (ofd
, con
);
2038 report_file_error ("Doing fsetfilecon", Fcons (newname
, Qnil
));
2044 /* Closing the output clobbers the file times on some systems. */
2045 if (emacs_close (ofd
) < 0)
2046 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2048 if (input_file_statable_p
)
2050 if (!NILP (keep_time
))
2052 EMACS_TIME atime
, mtime
;
2053 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
2054 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
2055 if (set_file_times (SDATA (encoded_newname
),
2057 xsignal2 (Qfile_date_error
,
2058 build_string ("Cannot set file date"), newname
);
2065 if (input_file_statable_p
)
2067 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2068 and if it can't, it tells so. Otherwise, under MSDOS we usually
2069 get only the READ bit, which will make the copied file read-only,
2070 so it's better not to chmod at all. */
2071 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2072 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2075 #endif /* not WINDOWSNT */
2077 /* Discard the unwind protects. */
2078 specpdl_ptr
= specpdl
+ count
;
2084 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2085 Smake_directory_internal
, 1, 1, 0,
2086 doc
: /* Create a new directory named DIRECTORY. */)
2087 (Lisp_Object directory
)
2089 const unsigned char *dir
;
2090 Lisp_Object handler
;
2091 Lisp_Object encoded_dir
;
2093 CHECK_STRING (directory
);
2094 directory
= Fexpand_file_name (directory
, Qnil
);
2096 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2097 if (!NILP (handler
))
2098 return call2 (handler
, Qmake_directory_internal
, directory
);
2100 encoded_dir
= ENCODE_FILE (directory
);
2102 dir
= SDATA (encoded_dir
);
2105 if (mkdir (dir
) != 0)
2107 if (mkdir (dir
, 0777) != 0)
2109 report_file_error ("Creating directory", list1 (directory
));
2114 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2115 Sdelete_directory_internal
, 1, 1, 0,
2116 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2117 (Lisp_Object directory
)
2119 const unsigned char *dir
;
2120 Lisp_Object handler
;
2121 Lisp_Object encoded_dir
;
2123 CHECK_STRING (directory
);
2124 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2125 encoded_dir
= ENCODE_FILE (directory
);
2126 dir
= SDATA (encoded_dir
);
2128 if (rmdir (dir
) != 0)
2129 report_file_error ("Removing directory", list1 (directory
));
2134 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 2,
2135 "(list (read-file-name \
2136 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2137 \"Move file to trash: \" \"Delete file: \") \
2138 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2139 (null current-prefix-arg))",
2140 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2141 If file has multiple names, it continues to exist with the other names.
2142 TRASH non-nil means to trash the file instead of deleting, provided
2143 `delete-by-moving-to-trash' is non-nil.
2145 When called interactively, TRASH is t if no prefix argument is given.
2146 With a prefix argument, TRASH is nil. */)
2147 (Lisp_Object filename
, Lisp_Object trash
)
2149 Lisp_Object handler
;
2150 Lisp_Object encoded_file
;
2151 struct gcpro gcpro1
;
2154 if (!NILP (Ffile_directory_p (filename
))
2155 && NILP (Ffile_symlink_p (filename
)))
2156 xsignal2 (Qfile_error
,
2157 build_string ("Removing old name: is a directory"),
2160 filename
= Fexpand_file_name (filename
, Qnil
);
2162 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2163 if (!NILP (handler
))
2164 return call3 (handler
, Qdelete_file
, filename
, trash
);
2166 if (delete_by_moving_to_trash
&& !NILP (trash
))
2167 return call1 (Qmove_file_to_trash
, filename
);
2169 encoded_file
= ENCODE_FILE (filename
);
2171 if (0 > unlink (SDATA (encoded_file
)))
2172 report_file_error ("Removing old name", list1 (filename
));
2177 internal_delete_file_1 (Lisp_Object ignore
)
2182 /* Delete file FILENAME, returning 1 if successful and 0 if failed.
2183 This ignores `delete-by-moving-to-trash'. */
2186 internal_delete_file (Lisp_Object filename
)
2190 tem
= internal_condition_case_2 (Fdelete_file
, filename
, Qnil
,
2191 Qt
, internal_delete_file_1
);
2195 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2196 "fRename file: \nGRename %s to file: \np",
2197 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2198 If file has names other than FILE, it continues to have those names.
2199 Signals a `file-already-exists' error if a file NEWNAME already exists
2200 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2201 A number as third arg means request confirmation if NEWNAME already exists.
2202 This is what happens in interactive use with M-x. */)
2203 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2205 Lisp_Object handler
;
2206 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2207 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2209 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2210 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2211 CHECK_STRING (file
);
2212 CHECK_STRING (newname
);
2213 file
= Fexpand_file_name (file
, Qnil
);
2215 if ((!NILP (Ffile_directory_p (newname
)))
2217 /* If the file names are identical but for the case,
2218 don't attempt to move directory to itself. */
2219 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2223 Lisp_Object fname
= NILP (Ffile_directory_p (file
))
2224 ? file
: Fdirectory_file_name (file
);
2225 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2228 newname
= Fexpand_file_name (newname
, Qnil
);
2230 /* If the file name has special constructs in it,
2231 call the corresponding file handler. */
2232 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2234 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2235 if (!NILP (handler
))
2236 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2237 file
, newname
, ok_if_already_exists
));
2239 encoded_file
= ENCODE_FILE (file
);
2240 encoded_newname
= ENCODE_FILE (newname
);
2243 /* If the file names are identical but for the case, don't ask for
2244 confirmation: they simply want to change the letter-case of the
2246 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2248 if (NILP (ok_if_already_exists
)
2249 || INTEGERP (ok_if_already_exists
))
2250 barf_or_query_if_file_exists (newname
, "rename to it",
2251 INTEGERP (ok_if_already_exists
), 0, 0);
2252 if (0 > rename (SDATA (encoded_file
), SDATA (encoded_newname
)))
2258 symlink_target
= Ffile_symlink_p (file
);
2259 if (! NILP (symlink_target
))
2260 Fmake_symbolic_link (symlink_target
, newname
,
2261 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2264 if (!NILP (Ffile_directory_p (file
)))
2265 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2267 /* We have already prompted if it was an integer, so don't
2268 have copy-file prompt again. */
2269 Fcopy_file (file
, newname
,
2270 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2273 count
= SPECPDL_INDEX ();
2274 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2276 if (!NILP (Ffile_directory_p (file
))
2278 && NILP (symlink_target
)
2281 call2 (Qdelete_directory
, file
, Qt
);
2283 Fdelete_file (file
, Qnil
);
2284 unbind_to (count
, Qnil
);
2287 report_file_error ("Renaming", list2 (file
, newname
));
2293 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2294 "fAdd name to file: \nGName to add to %s: \np",
2295 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2296 Signals a `file-already-exists' error if a file NEWNAME already exists
2297 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2298 A number as third arg means request confirmation if NEWNAME already exists.
2299 This is what happens in interactive use with M-x. */)
2300 (Lisp_Object file
, Lisp_Object newname
, Lisp_Object ok_if_already_exists
)
2302 Lisp_Object handler
;
2303 Lisp_Object encoded_file
, encoded_newname
;
2304 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2306 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2307 encoded_file
= encoded_newname
= Qnil
;
2308 CHECK_STRING (file
);
2309 CHECK_STRING (newname
);
2310 file
= Fexpand_file_name (file
, Qnil
);
2312 if (!NILP (Ffile_directory_p (newname
)))
2313 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2315 newname
= Fexpand_file_name (newname
, Qnil
);
2317 /* If the file name has special constructs in it,
2318 call the corresponding file handler. */
2319 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2320 if (!NILP (handler
))
2321 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2322 newname
, ok_if_already_exists
));
2324 /* If the new name has special constructs in it,
2325 call the corresponding file handler. */
2326 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2327 if (!NILP (handler
))
2328 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2329 newname
, ok_if_already_exists
));
2331 encoded_file
= ENCODE_FILE (file
);
2332 encoded_newname
= ENCODE_FILE (newname
);
2334 if (NILP (ok_if_already_exists
)
2335 || INTEGERP (ok_if_already_exists
))
2336 barf_or_query_if_file_exists (newname
, "make it a new name",
2337 INTEGERP (ok_if_already_exists
), 0, 0);
2339 unlink (SDATA (newname
));
2340 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
)))
2341 report_file_error ("Adding new name", list2 (file
, newname
));
2347 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2348 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2349 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2350 Both args must be strings.
2351 Signals a `file-already-exists' error if a file LINKNAME already exists
2352 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2353 A number as third arg means request confirmation if LINKNAME already exists.
2354 This happens for interactive use with M-x. */)
2355 (Lisp_Object filename
, Lisp_Object linkname
, Lisp_Object ok_if_already_exists
)
2357 Lisp_Object handler
;
2358 Lisp_Object encoded_filename
, encoded_linkname
;
2359 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2361 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2362 encoded_filename
= encoded_linkname
= Qnil
;
2363 CHECK_STRING (filename
);
2364 CHECK_STRING (linkname
);
2365 /* If the link target has a ~, we must expand it to get
2366 a truly valid file name. Otherwise, do not expand;
2367 we want to permit links to relative file names. */
2368 if (SREF (filename
, 0) == '~')
2369 filename
= Fexpand_file_name (filename
, Qnil
);
2371 if (!NILP (Ffile_directory_p (linkname
)))
2372 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2374 linkname
= Fexpand_file_name (linkname
, Qnil
);
2376 /* If the file name has special constructs in it,
2377 call the corresponding file handler. */
2378 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2379 if (!NILP (handler
))
2380 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2381 linkname
, ok_if_already_exists
));
2383 /* If the new link name has special constructs in it,
2384 call the corresponding file handler. */
2385 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2386 if (!NILP (handler
))
2387 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2388 linkname
, ok_if_already_exists
));
2391 encoded_filename
= ENCODE_FILE (filename
);
2392 encoded_linkname
= ENCODE_FILE (linkname
);
2394 if (NILP (ok_if_already_exists
)
2395 || INTEGERP (ok_if_already_exists
))
2396 barf_or_query_if_file_exists (linkname
, "make it a link",
2397 INTEGERP (ok_if_already_exists
), 0, 0);
2398 if (0 > symlink (SDATA (encoded_filename
),
2399 SDATA (encoded_linkname
)))
2401 /* If we didn't complain already, silently delete existing file. */
2402 if (errno
== EEXIST
)
2404 unlink (SDATA (encoded_linkname
));
2405 if (0 <= symlink (SDATA (encoded_filename
),
2406 SDATA (encoded_linkname
)))
2413 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2420 xsignal1 (Qfile_error
, build_string ("Symbolic links are not supported"));
2422 #endif /* S_IFLNK */
2426 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2428 doc
: /* Return t if file FILENAME specifies an absolute file name.
2429 On Unix, this is a name starting with a `/' or a `~'. */)
2430 (Lisp_Object filename
)
2432 CHECK_STRING (filename
);
2433 return file_name_absolute_p (SDATA (filename
)) ? Qt
: Qnil
;
2436 /* Return nonzero if file FILENAME exists and can be executed. */
2439 check_executable (char *filename
)
2442 int len
= strlen (filename
);
2445 if (stat (filename
, &st
) < 0)
2447 return ((st
.st_mode
& S_IEXEC
) != 0);
2448 #else /* not DOS_NT */
2449 #ifdef HAVE_EUIDACCESS
2450 return (euidaccess (filename
, 1) >= 0);
2452 /* Access isn't quite right because it uses the real uid
2453 and we really want to test with the effective uid.
2454 But Unix doesn't give us a right way to do it. */
2455 return (access (filename
, 1) >= 0);
2457 #endif /* not DOS_NT */
2460 /* Return nonzero if file FILENAME exists and can be written. */
2463 check_writable (const char *filename
)
2467 if (stat (filename
, &st
) < 0)
2469 return (st
.st_mode
& S_IWRITE
|| (st
.st_mode
& S_IFMT
) == S_IFDIR
);
2470 #else /* not MSDOS */
2471 #ifdef HAVE_EUIDACCESS
2472 return (euidaccess (filename
, 2) >= 0);
2474 /* Access isn't quite right because it uses the real uid
2475 and we really want to test with the effective uid.
2476 But Unix doesn't give us a right way to do it.
2477 Opening with O_WRONLY could work for an ordinary file,
2478 but would lose for directories. */
2479 return (access (filename
, 2) >= 0);
2481 #endif /* not MSDOS */
2484 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2485 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2486 See also `file-readable-p' and `file-attributes'.
2487 This returns nil for a symlink to a nonexistent file.
2488 Use `file-symlink-p' to test for such links. */)
2489 (Lisp_Object filename
)
2491 Lisp_Object absname
;
2492 Lisp_Object handler
;
2493 struct stat statbuf
;
2495 CHECK_STRING (filename
);
2496 absname
= Fexpand_file_name (filename
, Qnil
);
2498 /* If the file name has special constructs in it,
2499 call the corresponding file handler. */
2500 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2501 if (!NILP (handler
))
2502 return call2 (handler
, Qfile_exists_p
, absname
);
2504 absname
= ENCODE_FILE (absname
);
2506 return (stat (SDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2509 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2510 doc
: /* Return t if FILENAME can be executed by you.
2511 For a directory, this means you can access files in that directory. */)
2512 (Lisp_Object filename
)
2514 Lisp_Object absname
;
2515 Lisp_Object handler
;
2517 CHECK_STRING (filename
);
2518 absname
= Fexpand_file_name (filename
, Qnil
);
2520 /* If the file name has special constructs in it,
2521 call the corresponding file handler. */
2522 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2523 if (!NILP (handler
))
2524 return call2 (handler
, Qfile_executable_p
, absname
);
2526 absname
= ENCODE_FILE (absname
);
2528 return (check_executable (SDATA (absname
)) ? Qt
: Qnil
);
2531 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2532 doc
: /* Return t if file FILENAME exists and you can read it.
2533 See also `file-exists-p' and `file-attributes'. */)
2534 (Lisp_Object filename
)
2536 Lisp_Object absname
;
2537 Lisp_Object handler
;
2540 struct stat statbuf
;
2542 CHECK_STRING (filename
);
2543 absname
= Fexpand_file_name (filename
, Qnil
);
2545 /* If the file name has special constructs in it,
2546 call the corresponding file handler. */
2547 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2548 if (!NILP (handler
))
2549 return call2 (handler
, Qfile_readable_p
, absname
);
2551 absname
= ENCODE_FILE (absname
);
2553 #if defined(DOS_NT) || defined(macintosh)
2554 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2556 if (access (SDATA (absname
), 0) == 0)
2559 #else /* not DOS_NT and not macintosh */
2561 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
2562 /* Opening a fifo without O_NONBLOCK can wait.
2563 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2564 except in the case of a fifo, on a system which handles it. */
2565 desc
= stat (SDATA (absname
), &statbuf
);
2568 if (S_ISFIFO (statbuf
.st_mode
))
2569 flags
|= O_NONBLOCK
;
2571 desc
= emacs_open (SDATA (absname
), flags
, 0);
2576 #endif /* not DOS_NT and not macintosh */
2579 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2581 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2582 doc
: /* Return t if file FILENAME can be written or created by you. */)
2583 (Lisp_Object filename
)
2585 Lisp_Object absname
, dir
, encoded
;
2586 Lisp_Object handler
;
2587 struct stat statbuf
;
2589 CHECK_STRING (filename
);
2590 absname
= Fexpand_file_name (filename
, Qnil
);
2592 /* If the file name has special constructs in it,
2593 call the corresponding file handler. */
2594 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2595 if (!NILP (handler
))
2596 return call2 (handler
, Qfile_writable_p
, absname
);
2598 encoded
= ENCODE_FILE (absname
);
2599 if (stat (SDATA (encoded
), &statbuf
) >= 0)
2600 return (check_writable (SDATA (encoded
))
2603 dir
= Ffile_name_directory (absname
);
2606 dir
= Fdirectory_file_name (dir
);
2609 dir
= ENCODE_FILE (dir
);
2611 /* The read-only attribute of the parent directory doesn't affect
2612 whether a file or directory can be created within it. Some day we
2613 should check ACLs though, which do affect this. */
2614 if (stat (SDATA (dir
), &statbuf
) < 0)
2616 return (statbuf
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2618 return (check_writable (!NILP (dir
) ? (char *) SDATA (dir
) : "")
2623 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2624 doc
: /* Access file FILENAME, and get an error if that does not work.
2625 The second argument STRING is used in the error message.
2626 If there is no error, returns nil. */)
2627 (Lisp_Object filename
, Lisp_Object string
)
2629 Lisp_Object handler
, encoded_filename
, absname
;
2632 CHECK_STRING (filename
);
2633 absname
= Fexpand_file_name (filename
, Qnil
);
2635 CHECK_STRING (string
);
2637 /* If the file name has special constructs in it,
2638 call the corresponding file handler. */
2639 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2640 if (!NILP (handler
))
2641 return call3 (handler
, Qaccess_file
, absname
, string
);
2643 encoded_filename
= ENCODE_FILE (absname
);
2645 fd
= emacs_open (SDATA (encoded_filename
), O_RDONLY
, 0);
2647 report_file_error (SDATA (string
), Fcons (filename
, Qnil
));
2653 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2654 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2655 The value is the link target, as a string.
2656 Otherwise it returns nil.
2658 This function returns t when given the name of a symlink that
2659 points to a nonexistent file. */)
2660 (Lisp_Object filename
)
2662 Lisp_Object handler
;
2664 CHECK_STRING (filename
);
2665 filename
= Fexpand_file_name (filename
, Qnil
);
2667 /* If the file name has special constructs in it,
2668 call the corresponding file handler. */
2669 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2670 if (!NILP (handler
))
2671 return call2 (handler
, Qfile_symlink_p
, filename
);
2680 filename
= ENCODE_FILE (filename
);
2687 buf
= (char *) xrealloc (buf
, bufsize
);
2688 memset (buf
, 0, bufsize
);
2691 valsize
= readlink (SDATA (filename
), buf
, bufsize
);
2695 /* HP-UX reports ERANGE if buffer is too small. */
2696 if (errno
== ERANGE
)
2706 while (valsize
>= bufsize
);
2708 val
= make_string (buf
, valsize
);
2709 if (buf
[0] == '/' && strchr (buf
, ':'))
2710 val
= concat2 (build_string ("/:"), val
);
2712 val
= DECODE_FILE (val
);
2715 #else /* not S_IFLNK */
2717 #endif /* not S_IFLNK */
2720 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2721 doc
: /* Return t if FILENAME names an existing directory.
2722 Symbolic links to directories count as directories.
2723 See `file-symlink-p' to distinguish symlinks. */)
2724 (Lisp_Object filename
)
2726 register Lisp_Object absname
;
2728 Lisp_Object handler
;
2730 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2732 /* If the file name has special constructs in it,
2733 call the corresponding file handler. */
2734 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2735 if (!NILP (handler
))
2736 return call2 (handler
, Qfile_directory_p
, absname
);
2738 absname
= ENCODE_FILE (absname
);
2740 if (stat (SDATA (absname
), &st
) < 0)
2742 return (st
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2745 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
2746 doc
: /* Return t if file FILENAME names a directory you can open.
2747 For the value to be t, FILENAME must specify the name of a directory as a file,
2748 and the directory must allow you to open files in it. In order to use a
2749 directory as a buffer's current directory, this predicate must return true.
2750 A directory name spec may be given instead; then the value is t
2751 if the directory so specified exists and really is a readable and
2752 searchable directory. */)
2753 (Lisp_Object filename
)
2755 Lisp_Object handler
;
2757 struct gcpro gcpro1
;
2759 /* If the file name has special constructs in it,
2760 call the corresponding file handler. */
2761 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2762 if (!NILP (handler
))
2763 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2766 tem
= (NILP (Ffile_directory_p (filename
))
2767 || NILP (Ffile_executable_p (filename
)));
2769 return tem
? Qnil
: Qt
;
2772 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2773 doc
: /* Return t if FILENAME names a regular file.
2774 This is the sort of file that holds an ordinary stream of data bytes.
2775 Symbolic links to regular files count as regular files.
2776 See `file-symlink-p' to distinguish symlinks. */)
2777 (Lisp_Object filename
)
2779 register Lisp_Object absname
;
2781 Lisp_Object handler
;
2783 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2785 /* If the file name has special constructs in it,
2786 call the corresponding file handler. */
2787 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2788 if (!NILP (handler
))
2789 return call2 (handler
, Qfile_regular_p
, absname
);
2791 absname
= ENCODE_FILE (absname
);
2796 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2798 /* Tell stat to use expensive method to get accurate info. */
2799 Vw32_get_true_file_attributes
= Qt
;
2800 result
= stat (SDATA (absname
), &st
);
2801 Vw32_get_true_file_attributes
= tem
;
2805 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2808 if (stat (SDATA (absname
), &st
) < 0)
2810 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2814 DEFUN ("file-selinux-context", Ffile_selinux_context
,
2815 Sfile_selinux_context
, 1, 1, 0,
2816 doc
: /* Return SELinux context of file named FILENAME,
2817 as a list ("user", "role", "type", "range"). Return (nil, nil, nil, nil)
2818 if file does not exist, is not accessible, or SELinux is disabled */)
2819 (Lisp_Object filename
)
2821 Lisp_Object absname
;
2822 Lisp_Object values
[4];
2823 Lisp_Object handler
;
2825 security_context_t con
;
2830 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2832 /* If the file name has special constructs in it,
2833 call the corresponding file handler. */
2834 handler
= Ffind_file_name_handler (absname
, Qfile_selinux_context
);
2835 if (!NILP (handler
))
2836 return call2 (handler
, Qfile_selinux_context
, absname
);
2838 absname
= ENCODE_FILE (absname
);
2845 if (is_selinux_enabled ())
2847 conlength
= lgetfilecon (SDATA (absname
), &con
);
2850 context
= context_new (con
);
2851 if (context_user_get (context
))
2852 values
[0] = build_string (context_user_get (context
));
2853 if (context_role_get (context
))
2854 values
[1] = build_string (context_role_get (context
));
2855 if (context_type_get (context
))
2856 values
[2] = build_string (context_type_get (context
));
2857 if (context_range_get (context
))
2858 values
[3] = build_string (context_range_get (context
));
2859 context_free (context
);
2866 return Flist (sizeof(values
) / sizeof(values
[0]), values
);
2869 DEFUN ("set-file-selinux-context", Fset_file_selinux_context
,
2870 Sset_file_selinux_context
, 2, 2, 0,
2871 doc
: /* Set SELinux context of file named FILENAME to CONTEXT
2872 as a list ("user", "role", "type", "range"). Has no effect if SELinux
2874 (Lisp_Object filename
, Lisp_Object context
)
2876 Lisp_Object absname
, encoded_absname
;
2877 Lisp_Object handler
;
2878 Lisp_Object user
= CAR_SAFE (context
);
2879 Lisp_Object role
= CAR_SAFE (CDR_SAFE (context
));
2880 Lisp_Object type
= CAR_SAFE (CDR_SAFE (CDR_SAFE (context
)));
2881 Lisp_Object range
= CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context
))));
2883 security_context_t con
;
2884 int fail
, conlength
;
2885 context_t parsed_con
;
2888 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2890 /* If the file name has special constructs in it,
2891 call the corresponding file handler. */
2892 handler
= Ffind_file_name_handler (absname
, Qset_file_selinux_context
);
2893 if (!NILP (handler
))
2894 return call3 (handler
, Qset_file_selinux_context
, absname
, context
);
2896 encoded_absname
= ENCODE_FILE (absname
);
2899 if (is_selinux_enabled ())
2901 /* Get current file context. */
2902 conlength
= lgetfilecon (SDATA (encoded_absname
), &con
);
2905 parsed_con
= context_new (con
);
2906 /* Change the parts defined in the parameter.*/
2909 if (context_user_set (parsed_con
, SDATA (user
)))
2910 error ("Doing context_user_set");
2914 if (context_role_set (parsed_con
, SDATA (role
)))
2915 error ("Doing context_role_set");
2919 if (context_type_set (parsed_con
, SDATA (type
)))
2920 error ("Doing context_type_set");
2922 if (STRINGP (range
))
2924 if (context_range_set (parsed_con
, SDATA (range
)))
2925 error ("Doing context_range_set");
2928 /* Set the modified context back to the file. */
2929 fail
= lsetfilecon (SDATA (encoded_absname
), context_str (parsed_con
));
2931 report_file_error ("Doing lsetfilecon", Fcons (absname
, Qnil
));
2933 context_free (parsed_con
);
2936 report_file_error("Doing lgetfilecon", Fcons (absname
, Qnil
));
2946 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2947 doc
: /* Return mode bits of file named FILENAME, as an integer.
2948 Return nil, if file does not exist or is not accessible. */)
2949 (Lisp_Object filename
)
2951 Lisp_Object absname
;
2953 Lisp_Object handler
;
2955 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2957 /* If the file name has special constructs in it,
2958 call the corresponding file handler. */
2959 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2960 if (!NILP (handler
))
2961 return call2 (handler
, Qfile_modes
, absname
);
2963 absname
= ENCODE_FILE (absname
);
2965 if (stat (SDATA (absname
), &st
) < 0)
2968 return make_number (st
.st_mode
& 07777);
2971 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2972 "(let ((file (read-file-name \"File: \"))) \
2973 (list file (read-file-modes nil file)))",
2974 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2975 Only the 12 low bits of MODE are used.
2977 Interactively, mode bits are read by `read-file-modes', which accepts
2978 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2979 (Lisp_Object filename
, Lisp_Object mode
)
2981 Lisp_Object absname
, encoded_absname
;
2982 Lisp_Object handler
;
2984 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2985 CHECK_NUMBER (mode
);
2987 /* If the file name has special constructs in it,
2988 call the corresponding file handler. */
2989 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2990 if (!NILP (handler
))
2991 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2993 encoded_absname
= ENCODE_FILE (absname
);
2995 if (chmod (SDATA (encoded_absname
), XINT (mode
)) < 0)
2996 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3001 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3002 doc
: /* Set the file permission bits for newly created files.
3003 The argument MODE should be an integer; only the low 9 bits are used.
3004 This setting is inherited by subprocesses. */)
3007 CHECK_NUMBER (mode
);
3009 umask ((~ XINT (mode
)) & 0777);
3014 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3015 doc
: /* Return the default file protection for created files.
3016 The value is an integer. */)
3022 realmask
= umask (0);
3025 XSETINT (value
, (~ realmask
) & 0777);
3030 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3031 doc
: /* Set times of file FILENAME to TIME.
3032 Set both access and modification times.
3033 Return t on success, else nil.
3034 Use the current time if TIME is nil. TIME is in the format of
3036 (Lisp_Object filename
, Lisp_Object time
)
3038 Lisp_Object absname
, encoded_absname
;
3039 Lisp_Object handler
;
3043 if (! lisp_time_argument (time
, &sec
, &usec
))
3044 error ("Invalid time specification");
3046 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
3048 /* If the file name has special constructs in it,
3049 call the corresponding file handler. */
3050 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3051 if (!NILP (handler
))
3052 return call3 (handler
, Qset_file_times
, absname
, time
);
3054 encoded_absname
= ENCODE_FILE (absname
);
3059 EMACS_SET_SECS (t
, sec
);
3060 EMACS_SET_USECS (t
, usec
);
3062 if (set_file_times (SDATA (encoded_absname
), t
, t
))
3067 /* Setting times on a directory always fails. */
3068 if (stat (SDATA (encoded_absname
), &st
) == 0
3069 && (st
.st_mode
& S_IFMT
) == S_IFDIR
)
3072 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3081 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3082 doc
: /* Tell Unix to finish all pending disk updates. */)
3089 #endif /* HAVE_SYNC */
3091 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3092 doc
: /* Return t if file FILE1 is newer than file FILE2.
3093 If FILE1 does not exist, the answer is nil;
3094 otherwise, if FILE2 does not exist, the answer is t. */)
3095 (Lisp_Object file1
, Lisp_Object file2
)
3097 Lisp_Object absname1
, absname2
;
3100 Lisp_Object handler
;
3101 struct gcpro gcpro1
, gcpro2
;
3103 CHECK_STRING (file1
);
3104 CHECK_STRING (file2
);
3107 GCPRO2 (absname1
, file2
);
3108 absname1
= expand_and_dir_to_file (file1
, current_buffer
->directory
);
3109 absname2
= expand_and_dir_to_file (file2
, current_buffer
->directory
);
3112 /* If the file name has special constructs in it,
3113 call the corresponding file handler. */
3114 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3116 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3117 if (!NILP (handler
))
3118 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3120 GCPRO2 (absname1
, absname2
);
3121 absname1
= ENCODE_FILE (absname1
);
3122 absname2
= ENCODE_FILE (absname2
);
3125 if (stat (SDATA (absname1
), &st
) < 0)
3128 mtime1
= st
.st_mtime
;
3130 if (stat (SDATA (absname2
), &st
) < 0)
3133 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3137 Lisp_Object Qfind_buffer_file_type
;
3140 #ifndef READ_BUF_SIZE
3141 #define READ_BUF_SIZE (64 << 10)
3144 /* This function is called after Lisp functions to decide a coding
3145 system are called, or when they cause an error. Before they are
3146 called, the current buffer is set unibyte and it contains only a
3147 newly inserted text (thus the buffer was empty before the
3150 The functions may set markers, overlays, text properties, or even
3151 alter the buffer contents, change the current buffer.
3153 Here, we reset all those changes by:
3154 o set back the current buffer.
3155 o move all markers and overlays to BEG.
3156 o remove all text properties.
3157 o set back the buffer multibyteness. */
3160 decide_coding_unwind (Lisp_Object unwind_data
)
3162 Lisp_Object multibyte
, undo_list
, buffer
;
3164 multibyte
= XCAR (unwind_data
);
3165 unwind_data
= XCDR (unwind_data
);
3166 undo_list
= XCAR (unwind_data
);
3167 buffer
= XCDR (unwind_data
);
3169 if (current_buffer
!= XBUFFER (buffer
))
3170 set_buffer_internal (XBUFFER (buffer
));
3171 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3172 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3173 BUF_INTERVALS (current_buffer
) = 0;
3174 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3176 /* Now we are safe to change the buffer's multibyteness directly. */
3177 current_buffer
->enable_multibyte_characters
= multibyte
;
3178 current_buffer
->undo_list
= undo_list
;
3184 /* Used to pass values from insert-file-contents to read_non_regular. */
3186 static int non_regular_fd
;
3187 static EMACS_INT non_regular_inserted
;
3188 static EMACS_INT non_regular_nbytes
;
3191 /* Read from a non-regular file.
3192 Read non_regular_nbytes bytes max from non_regular_fd.
3193 Non_regular_inserted specifies where to put the read bytes.
3194 Value is the number of bytes read. */
3197 read_non_regular (Lisp_Object ignore
)
3203 nbytes
= emacs_read (non_regular_fd
,
3204 BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ non_regular_inserted
,
3205 non_regular_nbytes
);
3207 return make_number (nbytes
);
3211 /* Condition-case handler used when reading from non-regular files
3212 in insert-file-contents. */
3215 read_non_regular_quit (Lisp_Object ignore
)
3221 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3223 doc
: /* Insert contents of file FILENAME after point.
3224 Returns list of absolute file name and number of characters inserted.
3225 If second argument VISIT is non-nil, the buffer's visited filename and
3226 last save file modtime are set, and it is marked unmodified. If
3227 visiting and the file does not exist, visiting is completed before the
3230 The optional third and fourth arguments BEG and END specify what portion
3231 of the file to insert. These arguments count bytes in the file, not
3232 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3234 If optional fifth argument REPLACE is non-nil, replace the current
3235 buffer contents (in the accessible portion) with the file contents.
3236 This is better than simply deleting and inserting the whole thing
3237 because (1) it preserves some marker positions and (2) it puts less data
3238 in the undo list. When REPLACE is non-nil, the second return value is
3239 the number of characters that replace previous buffer contents.
3241 This function does code conversion according to the value of
3242 `coding-system-for-read' or `file-coding-system-alist', and sets the
3243 variable `last-coding-system-used' to the coding system actually used. */)
3244 (Lisp_Object filename
, Lisp_Object visit
, Lisp_Object beg
, Lisp_Object end
, Lisp_Object replace
)
3248 EMACS_INT inserted
= 0;
3250 register EMACS_INT how_much
;
3251 register EMACS_INT unprocessed
;
3252 int count
= SPECPDL_INDEX ();
3253 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3254 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3256 EMACS_INT total
= 0;
3257 int not_regular
= 0;
3258 unsigned char read_buf
[READ_BUF_SIZE
];
3259 struct coding_system coding
;
3260 unsigned char buffer
[1 << 14];
3261 int replace_handled
= 0;
3262 int set_coding_system
= 0;
3263 Lisp_Object coding_system
;
3265 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3266 int we_locked_file
= 0;
3267 int deferred_remove_unwind_protect
= 0;
3269 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3270 error ("Cannot do file visiting in an indirect buffer");
3272 if (!NILP (current_buffer
->read_only
))
3273 Fbarf_if_buffer_read_only ();
3277 orig_filename
= Qnil
;
3280 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3282 CHECK_STRING (filename
);
3283 filename
= Fexpand_file_name (filename
, Qnil
);
3285 /* The value Qnil means that the coding system is not yet
3287 coding_system
= Qnil
;
3289 /* If the file name has special constructs in it,
3290 call the corresponding file handler. */
3291 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3292 if (!NILP (handler
))
3294 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3295 visit
, beg
, end
, replace
);
3296 if (CONSP (val
) && CONSP (XCDR (val
)))
3297 inserted
= XINT (XCAR (XCDR (val
)));
3301 orig_filename
= filename
;
3302 filename
= ENCODE_FILE (filename
);
3308 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3310 /* Tell stat to use expensive method to get accurate info. */
3311 Vw32_get_true_file_attributes
= Qt
;
3312 total
= stat (SDATA (filename
), &st
);
3313 Vw32_get_true_file_attributes
= tem
;
3317 if (stat (SDATA (filename
), &st
) < 0)
3318 #endif /* WINDOWSNT */
3320 if (fd
>= 0) emacs_close (fd
);
3323 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3326 if (!NILP (Vcoding_system_for_read
))
3327 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3332 /* This code will need to be changed in order to work on named
3333 pipes, and it's probably just not worth it. So we should at
3334 least signal an error. */
3335 if (!S_ISREG (st
.st_mode
))
3342 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3343 xsignal2 (Qfile_error
,
3344 build_string ("not a regular file"), orig_filename
);
3349 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0)
3352 /* Replacement should preserve point as it preserves markers. */
3353 if (!NILP (replace
))
3354 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3356 record_unwind_protect (close_file_unwind
, make_number (fd
));
3358 /* Can happen on any platform that uses long as type of off_t, but allows
3359 file sizes to exceed 2Gb, so give a suitable message. */
3360 if (! not_regular
&& st
.st_size
< 0)
3361 error ("Maximum buffer size exceeded");
3363 /* Prevent redisplay optimizations. */
3364 current_buffer
->clip_changed
= 1;
3368 if (!NILP (beg
) || !NILP (end
))
3369 error ("Attempt to visit less than an entire file");
3370 if (BEG
< Z
&& NILP (replace
))
3371 error ("Cannot do file visiting in a non-empty buffer");
3377 XSETFASTINT (beg
, 0);
3385 XSETINT (end
, st
.st_size
);
3387 /* Arithmetic overflow can occur if an Emacs integer cannot
3388 represent the file size, or if the calculations below
3389 overflow. The calculations below double the file size
3390 twice, so check that it can be multiplied by 4 safely. */
3391 if (XINT (end
) != st
.st_size
3392 /* Actually, it should test either INT_MAX or LONG_MAX
3393 depending on which one is used for EMACS_INT. But in
3394 any case, in practice, this test is redundant with the
3396 || st.st_size > INT_MAX / 4 */)
3397 error ("Maximum buffer size exceeded");
3399 /* The file size returned from stat may be zero, but data
3400 may be readable nonetheless, for example when this is a
3401 file in the /proc filesystem. */
3402 if (st
.st_size
== 0)
3403 XSETINT (end
, READ_BUF_SIZE
);
3407 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3409 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3410 setup_coding_system (coding_system
, &coding
);
3411 /* Ensure we set Vlast_coding_system_used. */
3412 set_coding_system
= 1;
3416 /* Decide the coding system to use for reading the file now
3417 because we can't use an optimized method for handling
3418 `coding:' tag if the current buffer is not empty. */
3419 if (!NILP (Vcoding_system_for_read
))
3420 coding_system
= Vcoding_system_for_read
;
3423 /* Don't try looking inside a file for a coding system
3424 specification if it is not seekable. */
3425 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3427 /* Find a coding system specified in the heading two
3428 lines or in the tailing several lines of the file.
3429 We assume that the 1K-byte and 3K-byte for heading
3430 and tailing respectively are sufficient for this
3434 if (st
.st_size
<= (1024 * 4))
3435 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3438 nread
= emacs_read (fd
, read_buf
, 1024);
3441 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3442 report_file_error ("Setting file position",
3443 Fcons (orig_filename
, Qnil
));
3444 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3449 error ("IO error reading %s: %s",
3450 SDATA (orig_filename
), emacs_strerror (errno
));
3453 struct buffer
*prev
= current_buffer
;
3457 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3459 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3460 buf
= XBUFFER (buffer
);
3462 delete_all_overlays (buf
);
3463 buf
->directory
= current_buffer
->directory
;
3464 buf
->read_only
= Qnil
;
3465 buf
->filename
= Qnil
;
3466 buf
->undo_list
= Qt
;
3467 eassert (buf
->overlays_before
== NULL
);
3468 eassert (buf
->overlays_after
== NULL
);
3470 set_buffer_internal (buf
);
3472 buf
->enable_multibyte_characters
= Qnil
;
3474 insert_1_both (read_buf
, nread
, nread
, 0, 0, 0);
3475 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3476 coding_system
= call2 (Vset_auto_coding_function
,
3477 filename
, make_number (nread
));
3478 set_buffer_internal (prev
);
3480 /* Discard the unwind protect for recovering the
3484 /* Rewind the file for the actual read done later. */
3485 if (lseek (fd
, 0, 0) < 0)
3486 report_file_error ("Setting file position",
3487 Fcons (orig_filename
, Qnil
));
3491 if (NILP (coding_system
))
3493 /* If we have not yet decided a coding system, check
3494 file-coding-system-alist. */
3495 Lisp_Object args
[6];
3497 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3498 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3499 coding_system
= Ffind_operation_coding_system (6, args
);
3500 if (CONSP (coding_system
))
3501 coding_system
= XCAR (coding_system
);
3505 if (NILP (coding_system
))
3506 coding_system
= Qundecided
;
3508 CHECK_CODING_SYSTEM (coding_system
);
3510 if (NILP (current_buffer
->enable_multibyte_characters
))
3511 /* We must suppress all character code conversion except for
3512 end-of-line conversion. */
3513 coding_system
= raw_text_coding_system (coding_system
);
3515 setup_coding_system (coding_system
, &coding
);
3516 /* Ensure we set Vlast_coding_system_used. */
3517 set_coding_system
= 1;
3520 /* If requested, replace the accessible part of the buffer
3521 with the file contents. Avoid replacing text at the
3522 beginning or end of the buffer that matches the file contents;
3523 that preserves markers pointing to the unchanged parts.
3525 Here we implement this feature in an optimized way
3526 for the case where code conversion is NOT needed.
3527 The following if-statement handles the case of conversion
3528 in a less optimal way.
3530 If the code conversion is "automatic" then we try using this
3531 method and hope for the best.
3532 But if we discover the need for conversion, we give up on this method
3533 and let the following if-statement handle the replace job. */
3536 && (NILP (coding_system
)
3537 || ! CODING_REQUIRE_DECODING (&coding
)))
3539 /* same_at_start and same_at_end count bytes,
3540 because file access counts bytes
3541 and BEG and END count bytes. */
3542 EMACS_INT same_at_start
= BEGV_BYTE
;
3543 EMACS_INT same_at_end
= ZV_BYTE
;
3545 /* There is still a possibility we will find the need to do code
3546 conversion. If that happens, we set this variable to 1 to
3547 give up on handling REPLACE in the optimized way. */
3548 int giveup_match_end
= 0;
3550 if (XINT (beg
) != 0)
3552 if (lseek (fd
, XINT (beg
), 0) < 0)
3553 report_file_error ("Setting file position",
3554 Fcons (orig_filename
, Qnil
));
3559 /* Count how many chars at the start of the file
3560 match the text at the beginning of the buffer. */
3563 EMACS_INT nread
, bufpos
;
3565 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3567 error ("IO error reading %s: %s",
3568 SDATA (orig_filename
), emacs_strerror (errno
));
3569 else if (nread
== 0)
3572 if (CODING_REQUIRE_DETECTION (&coding
))
3574 coding_system
= detect_coding_system (buffer
, nread
, nread
, 1, 0,
3576 setup_coding_system (coding_system
, &coding
);
3579 if (CODING_REQUIRE_DECODING (&coding
))
3580 /* We found that the file should be decoded somehow.
3581 Let's give up here. */
3583 giveup_match_end
= 1;
3588 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3589 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3590 same_at_start
++, bufpos
++;
3591 /* If we found a discrepancy, stop the scan.
3592 Otherwise loop around and scan the next bufferful. */
3593 if (bufpos
!= nread
)
3597 /* If the file matches the buffer completely,
3598 there's no need to replace anything. */
3599 if (same_at_start
- BEGV_BYTE
== XINT (end
))
3603 /* Truncate the buffer to the size of the file. */
3604 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3609 /* Count how many chars at the end of the file
3610 match the text at the end of the buffer. But, if we have
3611 already found that decoding is necessary, don't waste time. */
3612 while (!giveup_match_end
)
3614 EMACS_INT total_read
, nread
, bufpos
, curpos
, trial
;
3616 /* At what file position are we now scanning? */
3617 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
3618 /* If the entire file matches the buffer tail, stop the scan. */
3621 /* How much can we scan in the next step? */
3622 trial
= min (curpos
, sizeof buffer
);
3623 if (lseek (fd
, curpos
- trial
, 0) < 0)
3624 report_file_error ("Setting file position",
3625 Fcons (orig_filename
, Qnil
));
3627 total_read
= nread
= 0;
3628 while (total_read
< trial
)
3630 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3632 error ("IO error reading %s: %s",
3633 SDATA (orig_filename
), emacs_strerror (errno
));
3634 else if (nread
== 0)
3636 total_read
+= nread
;
3639 /* Scan this bufferful from the end, comparing with
3640 the Emacs buffer. */
3641 bufpos
= total_read
;
3643 /* Compare with same_at_start to avoid counting some buffer text
3644 as matching both at the file's beginning and at the end. */
3645 while (bufpos
> 0 && same_at_end
> same_at_start
3646 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3647 same_at_end
--, bufpos
--;
3649 /* If we found a discrepancy, stop the scan.
3650 Otherwise loop around and scan the preceding bufferful. */
3653 /* If this discrepancy is because of code conversion,
3654 we cannot use this method; giveup and try the other. */
3655 if (same_at_end
> same_at_start
3656 && FETCH_BYTE (same_at_end
- 1) >= 0200
3657 && ! NILP (current_buffer
->enable_multibyte_characters
)
3658 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3659 giveup_match_end
= 1;
3668 if (! giveup_match_end
)
3672 /* We win! We can handle REPLACE the optimized way. */
3674 /* Extend the start of non-matching text area to multibyte
3675 character boundary. */
3676 if (! NILP (current_buffer
->enable_multibyte_characters
))
3677 while (same_at_start
> BEGV_BYTE
3678 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3681 /* Extend the end of non-matching text area to multibyte
3682 character boundary. */
3683 if (! NILP (current_buffer
->enable_multibyte_characters
))
3684 while (same_at_end
< ZV_BYTE
3685 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3688 /* Don't try to reuse the same piece of text twice. */
3689 overlap
= (same_at_start
- BEGV_BYTE
3690 - (same_at_end
+ st
.st_size
- ZV
));
3692 same_at_end
+= overlap
;
3694 /* Arrange to read only the nonmatching middle part of the file. */
3695 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
3696 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
3698 del_range_byte (same_at_start
, same_at_end
, 0);
3699 /* Insert from the file at the proper position. */
3700 temp
= BYTE_TO_CHAR (same_at_start
);
3701 SET_PT_BOTH (temp
, same_at_start
);
3703 /* If display currently starts at beginning of line,
3704 keep it that way. */
3705 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3706 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3708 replace_handled
= 1;
3712 /* If requested, replace the accessible part of the buffer
3713 with the file contents. Avoid replacing text at the
3714 beginning or end of the buffer that matches the file contents;
3715 that preserves markers pointing to the unchanged parts.
3717 Here we implement this feature for the case where code conversion
3718 is needed, in a simple way that needs a lot of memory.
3719 The preceding if-statement handles the case of no conversion
3720 in a more optimized way. */
3721 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3723 EMACS_INT same_at_start
= BEGV_BYTE
;
3724 EMACS_INT same_at_end
= ZV_BYTE
;
3725 EMACS_INT same_at_start_charpos
;
3726 EMACS_INT inserted_chars
;
3729 unsigned char *decoded
;
3731 int this_count
= SPECPDL_INDEX ();
3732 int multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
3733 Lisp_Object conversion_buffer
;
3735 conversion_buffer
= code_conversion_save (1, multibyte
);
3737 /* First read the whole file, performing code conversion into
3738 CONVERSION_BUFFER. */
3740 if (lseek (fd
, XINT (beg
), 0) < 0)
3741 report_file_error ("Setting file position",
3742 Fcons (orig_filename
, Qnil
));
3744 total
= st
.st_size
; /* Total bytes in the file. */
3745 how_much
= 0; /* Bytes read from file so far. */
3746 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3747 unprocessed
= 0; /* Bytes not processed in previous loop. */
3749 GCPRO1 (conversion_buffer
);
3750 while (how_much
< total
)
3752 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3753 quitting while reading a huge while. */
3754 /* try is reserved in some compilers (Microsoft C) */
3755 EMACS_INT trytry
= min (total
- how_much
,
3756 READ_BUF_SIZE
- unprocessed
);
3759 /* Allow quitting out of the actual I/O. */
3762 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3774 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3775 BUF_Z (XBUFFER (conversion_buffer
)));
3776 decode_coding_c_string (&coding
, read_buf
, unprocessed
+ this,
3778 unprocessed
= coding
.carryover_bytes
;
3779 if (coding
.carryover_bytes
> 0)
3780 memcpy (read_buf
, coding
.carryover
, unprocessed
);
3785 /* We should remove the unwind_protect calling
3786 close_file_unwind, but other stuff has been added the stack,
3787 so defer the removal till we reach the `handled' label. */
3788 deferred_remove_unwind_protect
= 1;
3790 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3791 if we couldn't read the file. */
3794 error ("IO error reading %s: %s",
3795 SDATA (orig_filename
), emacs_strerror (errno
));
3797 if (unprocessed
> 0)
3799 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3800 decode_coding_c_string (&coding
, read_buf
, unprocessed
,
3802 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3805 coding_system
= CODING_ID_NAME (coding
.id
);
3806 set_coding_system
= 1;
3807 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3808 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3809 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3811 /* Compare the beginning of the converted string with the buffer
3815 while (bufpos
< inserted
&& same_at_start
< same_at_end
3816 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3817 same_at_start
++, bufpos
++;
3819 /* If the file matches the head of buffer completely,
3820 there's no need to replace anything. */
3822 if (bufpos
== inserted
)
3824 /* Truncate the buffer to the size of the file. */
3825 if (same_at_start
== same_at_end
)
3828 del_range_byte (same_at_start
, same_at_end
, 0);
3831 unbind_to (this_count
, Qnil
);
3835 /* Extend the start of non-matching text area to the previous
3836 multibyte character boundary. */
3837 if (! NILP (current_buffer
->enable_multibyte_characters
))
3838 while (same_at_start
> BEGV_BYTE
3839 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3842 /* Scan this bufferful from the end, comparing with
3843 the Emacs buffer. */
3846 /* Compare with same_at_start to avoid counting some buffer text
3847 as matching both at the file's beginning and at the end. */
3848 while (bufpos
> 0 && same_at_end
> same_at_start
3849 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3850 same_at_end
--, bufpos
--;
3852 /* Extend the end of non-matching text area to the next
3853 multibyte character boundary. */
3854 if (! NILP (current_buffer
->enable_multibyte_characters
))
3855 while (same_at_end
< ZV_BYTE
3856 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3859 /* Don't try to reuse the same piece of text twice. */
3860 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3862 same_at_end
+= overlap
;
3864 /* If display currently starts at beginning of line,
3865 keep it that way. */
3866 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3867 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3869 /* Replace the chars that we need to replace,
3870 and update INSERTED to equal the number of bytes
3871 we are taking from the decoded string. */
3872 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3874 if (same_at_end
!= same_at_start
)
3876 del_range_byte (same_at_start
, same_at_end
, 0);
3878 same_at_start
= GPT_BYTE
;
3882 temp
= BYTE_TO_CHAR (same_at_start
);
3884 /* Insert from the file at the proper position. */
3885 SET_PT_BOTH (temp
, same_at_start
);
3886 same_at_start_charpos
3887 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3888 same_at_start
- BEGV_BYTE
3889 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3891 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3892 same_at_start
+ inserted
- BEGV_BYTE
3893 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3894 - same_at_start_charpos
);
3895 /* This binding is to avoid ask-user-about-supersession-threat
3896 being called in insert_from_buffer (via in
3897 prepare_to_modify_buffer). */
3898 specbind (intern ("buffer-file-name"), Qnil
);
3899 insert_from_buffer (XBUFFER (conversion_buffer
),
3900 same_at_start_charpos
, inserted_chars
, 0);
3901 /* Set `inserted' to the number of inserted characters. */
3902 inserted
= PT
- temp
;
3903 /* Set point before the inserted characters. */
3904 SET_PT_BOTH (temp
, same_at_start
);
3906 unbind_to (this_count
, Qnil
);
3913 register Lisp_Object temp
;
3915 total
= XINT (end
) - XINT (beg
);
3917 /* Make sure point-max won't overflow after this insertion. */
3918 XSETINT (temp
, total
);
3919 if (total
!= XINT (temp
))
3920 error ("Maximum buffer size exceeded");
3923 /* For a special file, all we can do is guess. */
3924 total
= READ_BUF_SIZE
;
3926 if (NILP (visit
) && inserted
> 0)
3928 #ifdef CLASH_DETECTION
3929 if (!NILP (current_buffer
->file_truename
)
3930 /* Make binding buffer-file-name to nil effective. */
3931 && !NILP (current_buffer
->filename
)
3932 && SAVE_MODIFF
>= MODIFF
)
3934 #endif /* CLASH_DETECTION */
3935 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3939 if (GAP_SIZE
< total
)
3940 make_gap (total
- GAP_SIZE
);
3942 if (XINT (beg
) != 0 || !NILP (replace
))
3944 if (lseek (fd
, XINT (beg
), 0) < 0)
3945 report_file_error ("Setting file position",
3946 Fcons (orig_filename
, Qnil
));
3949 /* In the following loop, HOW_MUCH contains the total bytes read so
3950 far for a regular file, and not changed for a special file. But,
3951 before exiting the loop, it is set to a negative value if I/O
3955 /* Total bytes inserted. */
3958 /* Here, we don't do code conversion in the loop. It is done by
3959 decode_coding_gap after all data are read into the buffer. */
3961 EMACS_INT gap_size
= GAP_SIZE
;
3963 while (how_much
< total
)
3965 /* try is reserved in some compilers (Microsoft C) */
3966 EMACS_INT trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3973 /* Maybe make more room. */
3974 if (gap_size
< trytry
)
3976 make_gap (total
- gap_size
);
3977 gap_size
= GAP_SIZE
;
3980 /* Read from the file, capturing `quit'. When an
3981 error occurs, end the loop, and arrange for a quit
3982 to be signaled after decoding the text we read. */
3983 non_regular_fd
= fd
;
3984 non_regular_inserted
= inserted
;
3985 non_regular_nbytes
= trytry
;
3986 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
3987 read_non_regular_quit
);
3998 /* Allow quitting out of the actual I/O. We don't make text
3999 part of the buffer until all the reading is done, so a C-g
4000 here doesn't do any harm. */
4003 this = emacs_read (fd
, BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ inserted
, trytry
);
4015 /* For a regular file, where TOTAL is the real size,
4016 count HOW_MUCH to compare with it.
4017 For a special file, where TOTAL is just a buffer size,
4018 so don't bother counting in HOW_MUCH.
4019 (INSERTED is where we count the number of characters inserted.) */
4026 /* Now we have read all the file data into the gap.
4027 If it was empty, undo marking the buffer modified. */
4031 #ifdef CLASH_DETECTION
4033 unlock_file (current_buffer
->file_truename
);
4035 Vdeactivate_mark
= old_Vdeactivate_mark
;
4038 Vdeactivate_mark
= Qt
;
4040 /* Make the text read part of the buffer. */
4041 GAP_SIZE
-= inserted
;
4043 GPT_BYTE
+= inserted
;
4045 ZV_BYTE
+= inserted
;
4050 /* Put an anchor to ensure multi-byte form ends at gap. */
4055 /* Discard the unwind protect for closing the file. */
4059 error ("IO error reading %s: %s",
4060 SDATA (orig_filename
), emacs_strerror (errno
));
4064 if (NILP (coding_system
))
4066 /* The coding system is not yet decided. Decide it by an
4067 optimized method for handling `coding:' tag.
4069 Note that we can get here only if the buffer was empty
4070 before the insertion. */
4072 if (!NILP (Vcoding_system_for_read
))
4073 coding_system
= Vcoding_system_for_read
;
4076 /* Since we are sure that the current buffer was empty
4077 before the insertion, we can toggle
4078 enable-multibyte-characters directly here without taking
4079 care of marker adjustment. By this way, we can run Lisp
4080 program safely before decoding the inserted text. */
4081 Lisp_Object unwind_data
;
4082 int count
= SPECPDL_INDEX ();
4084 unwind_data
= Fcons (current_buffer
->enable_multibyte_characters
,
4085 Fcons (current_buffer
->undo_list
,
4086 Fcurrent_buffer ()));
4087 current_buffer
->enable_multibyte_characters
= Qnil
;
4088 current_buffer
->undo_list
= Qt
;
4089 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4091 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4093 coding_system
= call2 (Vset_auto_coding_function
,
4094 filename
, make_number (inserted
));
4097 if (NILP (coding_system
))
4099 /* If the coding system is not yet decided, check
4100 file-coding-system-alist. */
4101 Lisp_Object args
[6];
4103 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4104 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4105 coding_system
= Ffind_operation_coding_system (6, args
);
4106 if (CONSP (coding_system
))
4107 coding_system
= XCAR (coding_system
);
4109 unbind_to (count
, Qnil
);
4110 inserted
= Z_BYTE
- BEG_BYTE
;
4113 if (NILP (coding_system
))
4114 coding_system
= Qundecided
;
4116 CHECK_CODING_SYSTEM (coding_system
);
4118 if (NILP (current_buffer
->enable_multibyte_characters
))
4119 /* We must suppress all character code conversion except for
4120 end-of-line conversion. */
4121 coding_system
= raw_text_coding_system (coding_system
);
4122 setup_coding_system (coding_system
, &coding
);
4123 /* Ensure we set Vlast_coding_system_used. */
4124 set_coding_system
= 1;
4129 /* When we visit a file by raw-text, we change the buffer to
4131 if (CODING_FOR_UNIBYTE (&coding
)
4132 /* Can't do this if part of the buffer might be preserved. */
4134 /* Visiting a file with these coding system makes the buffer
4136 current_buffer
->enable_multibyte_characters
= Qnil
;
4139 coding
.dst_multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
4140 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4141 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4143 move_gap_both (PT
, PT_BYTE
);
4144 GAP_SIZE
+= inserted
;
4145 ZV_BYTE
-= inserted
;
4149 decode_coding_gap (&coding
, inserted
, inserted
);
4150 inserted
= coding
.produced_char
;
4151 coding_system
= CODING_ID_NAME (coding
.id
);
4153 else if (inserted
> 0)
4154 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4157 /* Now INSERTED is measured in characters. */
4160 /* Use the conversion type to determine buffer-file-type
4161 (find-buffer-file-type is now used to help determine the
4163 if ((VECTORP (CODING_ID_EOL_TYPE (coding
.id
))
4164 || EQ (CODING_ID_EOL_TYPE (coding
.id
), Qunix
))
4165 && ! CODING_REQUIRE_DECODING (&coding
))
4166 current_buffer
->buffer_file_type
= Qt
;
4168 current_buffer
->buffer_file_type
= Qnil
;
4173 if (deferred_remove_unwind_protect
)
4174 /* If requested above, discard the unwind protect for closing the
4180 if (!EQ (current_buffer
->undo_list
, Qt
) && !nochange
)
4181 current_buffer
->undo_list
= Qnil
;
4185 current_buffer
->modtime
= st
.st_mtime
;
4186 current_buffer
->modtime_size
= st
.st_size
;
4187 current_buffer
->filename
= orig_filename
;
4190 SAVE_MODIFF
= MODIFF
;
4191 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4192 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4193 #ifdef CLASH_DETECTION
4196 if (!NILP (current_buffer
->file_truename
))
4197 unlock_file (current_buffer
->file_truename
);
4198 unlock_file (filename
);
4200 #endif /* CLASH_DETECTION */
4202 xsignal2 (Qfile_error
,
4203 build_string ("not a regular file"), orig_filename
);
4206 if (set_coding_system
)
4207 Vlast_coding_system_used
= coding_system
;
4209 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4211 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4213 if (! NILP (insval
))
4215 CHECK_NUMBER (insval
);
4216 inserted
= XFASTINT (insval
);
4220 /* Decode file format. */
4223 /* Don't run point motion or modification hooks when decoding. */
4224 int count
= SPECPDL_INDEX ();
4225 EMACS_INT old_inserted
= inserted
;
4226 specbind (Qinhibit_point_motion_hooks
, Qt
);
4227 specbind (Qinhibit_modification_hooks
, Qt
);
4229 /* Save old undo list and don't record undo for decoding. */
4230 old_undo
= current_buffer
->undo_list
;
4231 current_buffer
->undo_list
= Qt
;
4235 insval
= call3 (Qformat_decode
,
4236 Qnil
, make_number (inserted
), visit
);
4237 CHECK_NUMBER (insval
);
4238 inserted
= XFASTINT (insval
);
4242 /* If REPLACE is non-nil and we succeeded in not replacing the
4243 beginning or end of the buffer text with the file's contents,
4244 call format-decode with `point' positioned at the beginning
4245 of the buffer and `inserted' equalling the number of
4246 characters in the buffer. Otherwise, format-decode might
4247 fail to correctly analyze the beginning or end of the buffer.
4248 Hence we temporarily save `point' and `inserted' here and
4249 restore `point' iff format-decode did not insert or delete
4250 any text. Otherwise we leave `point' at point-min. */
4251 EMACS_INT opoint
= PT
;
4252 EMACS_INT opoint_byte
= PT_BYTE
;
4253 EMACS_INT oinserted
= ZV
- BEGV
;
4254 int ochars_modiff
= CHARS_MODIFF
;
4256 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4257 insval
= call3 (Qformat_decode
,
4258 Qnil
, make_number (oinserted
), visit
);
4259 CHECK_NUMBER (insval
);
4260 if (ochars_modiff
== CHARS_MODIFF
)
4261 /* format_decode didn't modify buffer's characters => move
4262 point back to position before inserted text and leave
4263 value of inserted alone. */
4264 SET_PT_BOTH (opoint
, opoint_byte
);
4266 /* format_decode modified buffer's characters => consider
4267 entire buffer changed and leave point at point-min. */
4268 inserted
= XFASTINT (insval
);
4271 /* For consistency with format-decode call these now iff inserted > 0
4272 (martin 2007-06-28). */
4273 p
= Vafter_insert_file_functions
;
4278 insval
= call1 (XCAR (p
), make_number (inserted
));
4281 CHECK_NUMBER (insval
);
4282 inserted
= XFASTINT (insval
);
4287 /* For the rationale of this see the comment on
4288 format-decode above. */
4289 EMACS_INT opoint
= PT
;
4290 EMACS_INT opoint_byte
= PT_BYTE
;
4291 EMACS_INT oinserted
= ZV
- BEGV
;
4292 int ochars_modiff
= CHARS_MODIFF
;
4294 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4295 insval
= call1 (XCAR (p
), make_number (oinserted
));
4298 CHECK_NUMBER (insval
);
4299 if (ochars_modiff
== CHARS_MODIFF
)
4300 /* after_insert_file_functions didn't modify
4301 buffer's characters => move point back to
4302 position before inserted text and leave value of
4304 SET_PT_BOTH (opoint
, opoint_byte
);
4306 /* after_insert_file_functions did modify buffer's
4307 characters => consider entire buffer changed and
4308 leave point at point-min. */
4309 inserted
= XFASTINT (insval
);
4319 current_buffer
->undo_list
= old_undo
;
4320 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4322 /* Adjust the last undo record for the size change during
4323 the format conversion. */
4324 Lisp_Object tem
= XCAR (old_undo
);
4325 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4326 && INTEGERP (XCDR (tem
))
4327 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4328 XSETCDR (tem
, make_number (PT
+ inserted
));
4332 /* If undo_list was Qt before, keep it that way.
4333 Otherwise start with an empty undo_list. */
4334 current_buffer
->undo_list
= EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4336 unbind_to (count
, Qnil
);
4339 /* Call after-change hooks for the inserted text, aside from the case
4340 of normal visiting (not with REPLACE), which is done in a new buffer
4341 "before" the buffer is changed. */
4342 if (inserted
> 0 && total
> 0
4343 && (NILP (visit
) || !NILP (replace
)))
4345 signal_after_change (PT
, 0, inserted
);
4346 update_compositions (PT
, PT
, CHECK_BORDER
);
4350 && current_buffer
->modtime
== -1)
4352 /* If visiting nonexistent file, return nil. */
4353 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4357 Fsignal (Qquit
, Qnil
);
4359 /* ??? Retval needs to be dealt with in all cases consistently. */
4361 val
= Fcons (orig_filename
,
4362 Fcons (make_number (inserted
),
4365 RETURN_UNGCPRO (unbind_to (count
, val
));
4368 static Lisp_Object
build_annotations (Lisp_Object
, Lisp_Object
);
4371 build_annotations_unwind (Lisp_Object arg
)
4373 Vwrite_region_annotation_buffers
= arg
;
4377 /* Decide the coding-system to encode the data with. */
4380 choose_write_coding_system (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
,
4381 Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
,
4382 struct coding_system
*coding
)
4385 Lisp_Object eol_parent
= Qnil
;
4388 && NILP (Fstring_equal (current_buffer
->filename
,
4389 current_buffer
->auto_save_file_name
)))
4394 else if (!NILP (Vcoding_system_for_write
))
4396 val
= Vcoding_system_for_write
;
4397 if (coding_system_require_warning
4398 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4399 /* Confirm that VAL can surely encode the current region. */
4400 val
= call5 (Vselect_safe_coding_system_function
,
4401 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4406 /* If the variable `buffer-file-coding-system' is set locally,
4407 it means that the file was read with some kind of code
4408 conversion or the variable is explicitly set by users. We
4409 had better write it out with the same coding system even if
4410 `enable-multibyte-characters' is nil.
4412 If it is not set locally, we anyway have to convert EOL
4413 format if the default value of `buffer-file-coding-system'
4414 tells that it is not Unix-like (LF only) format. */
4415 int using_default_coding
= 0;
4416 int force_raw_text
= 0;
4418 val
= current_buffer
->buffer_file_coding_system
;
4420 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4423 if (NILP (current_buffer
->enable_multibyte_characters
))
4429 /* Check file-coding-system-alist. */
4430 Lisp_Object args
[7], coding_systems
;
4432 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4433 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4435 coding_systems
= Ffind_operation_coding_system (7, args
);
4436 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4437 val
= XCDR (coding_systems
);
4442 /* If we still have not decided a coding system, use the
4443 default value of buffer-file-coding-system. */
4444 val
= current_buffer
->buffer_file_coding_system
;
4445 using_default_coding
= 1;
4448 if (! NILP (val
) && ! force_raw_text
)
4450 Lisp_Object spec
, attrs
;
4452 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4453 attrs
= AREF (spec
, 0);
4454 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4459 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4460 /* Confirm that VAL can surely encode the current region. */
4461 val
= call5 (Vselect_safe_coding_system_function
,
4462 start
, end
, val
, Qnil
, filename
);
4464 /* If the decided coding-system doesn't specify end-of-line
4465 format, we use that of
4466 `default-buffer-file-coding-system'. */
4467 if (! using_default_coding
4468 && ! NILP (buffer_defaults
.buffer_file_coding_system
))
4469 val
= (coding_inherit_eol_type
4470 (val
, buffer_defaults
.buffer_file_coding_system
));
4472 /* If we decide not to encode text, use `raw-text' or one of its
4475 val
= raw_text_coding_system (val
);
4478 val
= coding_inherit_eol_type (val
, eol_parent
);
4479 setup_coding_system (val
, coding
);
4481 if (!STRINGP (start
) && !NILP (current_buffer
->selective_display
))
4482 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4486 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4487 "r\nFWrite region to file: \ni\ni\ni\np",
4488 doc
: /* Write current region into specified file.
4489 When called from a program, requires three arguments:
4490 START, END and FILENAME. START and END are normally buffer positions
4491 specifying the part of the buffer to write.
4492 If START is nil, that means to use the entire buffer contents.
4493 If START is a string, then output that string to the file
4494 instead of any buffer contents; END is ignored.
4496 Optional fourth argument APPEND if non-nil means
4497 append to existing file contents (if any). If it is an integer,
4498 seek to that offset in the file before writing.
4499 Optional fifth argument VISIT, if t or a string, means
4500 set the last-save-file-modtime of buffer to this file's modtime
4501 and mark buffer not modified.
4502 If VISIT is a string, it is a second file name;
4503 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4504 VISIT is also the file name to lock and unlock for clash detection.
4505 If VISIT is neither t nor nil nor a string,
4506 that means do not display the \"Wrote file\" message.
4507 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4508 use for locking and unlocking, overriding FILENAME and VISIT.
4509 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4510 for an existing file with the same name. If MUSTBENEW is `excl',
4511 that means to get an error if the file already exists; never overwrite.
4512 If MUSTBENEW is neither nil nor `excl', that means ask for
4513 confirmation before overwriting, but do go ahead and overwrite the file
4514 if the user confirms.
4516 This does code conversion according to the value of
4517 `coding-system-for-write', `buffer-file-coding-system', or
4518 `file-coding-system-alist', and sets the variable
4519 `last-coding-system-used' to the coding system actually used.
4521 This calls `write-region-annotate-functions' at the start, and
4522 `write-region-post-annotation-function' at the end. */)
4523 (Lisp_Object start
, Lisp_Object end
, Lisp_Object filename
, Lisp_Object append
, Lisp_Object visit
, Lisp_Object lockname
, Lisp_Object mustbenew
)
4528 const unsigned char *fn
;
4530 int count
= SPECPDL_INDEX ();
4532 Lisp_Object handler
;
4533 Lisp_Object visit_file
;
4534 Lisp_Object annotations
;
4535 Lisp_Object encoded_filename
;
4536 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4537 int quietly
= !NILP (visit
);
4538 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4539 struct buffer
*given_buffer
;
4541 int buffer_file_type
= O_BINARY
;
4543 struct coding_system coding
;
4545 if (current_buffer
->base_buffer
&& visiting
)
4546 error ("Cannot do file visiting in an indirect buffer");
4548 if (!NILP (start
) && !STRINGP (start
))
4549 validate_region (&start
, &end
);
4552 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4554 filename
= Fexpand_file_name (filename
, Qnil
);
4556 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4557 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4559 if (STRINGP (visit
))
4560 visit_file
= Fexpand_file_name (visit
, Qnil
);
4562 visit_file
= filename
;
4564 if (NILP (lockname
))
4565 lockname
= visit_file
;
4569 /* If the file name has special constructs in it,
4570 call the corresponding file handler. */
4571 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4572 /* If FILENAME has no handler, see if VISIT has one. */
4573 if (NILP (handler
) && STRINGP (visit
))
4574 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4576 if (!NILP (handler
))
4579 val
= call6 (handler
, Qwrite_region
, start
, end
,
4580 filename
, append
, visit
);
4584 SAVE_MODIFF
= MODIFF
;
4585 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4586 current_buffer
->filename
= visit_file
;
4592 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4594 /* Special kludge to simplify auto-saving. */
4597 /* Do it later, so write-region-annotate-function can work differently
4598 if we save "the buffer" vs "a region".
4599 This is useful in tar-mode. --Stef
4600 XSETFASTINT (start, BEG);
4601 XSETFASTINT (end, Z); */
4605 record_unwind_protect (build_annotations_unwind
,
4606 Vwrite_region_annotation_buffers
);
4607 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4608 count1
= SPECPDL_INDEX ();
4610 given_buffer
= current_buffer
;
4612 if (!STRINGP (start
))
4614 annotations
= build_annotations (start
, end
);
4616 if (current_buffer
!= given_buffer
)
4618 XSETFASTINT (start
, BEGV
);
4619 XSETFASTINT (end
, ZV
);
4625 XSETFASTINT (start
, BEGV
);
4626 XSETFASTINT (end
, ZV
);
4631 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4633 /* Decide the coding-system to encode the data with.
4634 We used to make this choice before calling build_annotations, but that
4635 leads to problems when a write-annotate-function takes care of
4636 unsavable chars (as was the case with X-Symbol). */
4637 Vlast_coding_system_used
4638 = choose_write_coding_system (start
, end
, filename
,
4639 append
, visit
, lockname
, &coding
);
4641 #ifdef CLASH_DETECTION
4643 lock_file (lockname
);
4644 #endif /* CLASH_DETECTION */
4646 encoded_filename
= ENCODE_FILE (filename
);
4648 fn
= SDATA (encoded_filename
);
4652 desc
= emacs_open (fn
, O_WRONLY
| buffer_file_type
, 0);
4653 #else /* not DOS_NT */
4654 desc
= emacs_open (fn
, O_WRONLY
, 0);
4655 #endif /* not DOS_NT */
4657 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4659 desc
= emacs_open (fn
,
4660 O_WRONLY
| O_CREAT
| buffer_file_type
4661 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4662 S_IREAD
| S_IWRITE
);
4663 #else /* not DOS_NT */
4664 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4665 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4666 auto_saving
? auto_save_mode_bits
: 0666);
4667 #endif /* not DOS_NT */
4671 #ifdef CLASH_DETECTION
4673 if (!auto_saving
) unlock_file (lockname
);
4675 #endif /* CLASH_DETECTION */
4677 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4680 record_unwind_protect (close_file_unwind
, make_number (desc
));
4682 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4686 if (NUMBERP (append
))
4687 ret
= lseek (desc
, XINT (append
), 1);
4689 ret
= lseek (desc
, 0, 2);
4692 #ifdef CLASH_DETECTION
4693 if (!auto_saving
) unlock_file (lockname
);
4694 #endif /* CLASH_DETECTION */
4696 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4705 if (STRINGP (start
))
4707 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4708 &annotations
, &coding
);
4711 else if (XINT (start
) != XINT (end
))
4713 failure
= 0 > a_write (desc
, Qnil
,
4714 XINT (start
), XINT (end
) - XINT (start
),
4715 &annotations
, &coding
);
4720 /* If file was empty, still need to write the annotations */
4721 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4722 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4726 if (CODING_REQUIRE_FLUSHING (&coding
)
4727 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4730 /* We have to flush out a data. */
4731 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4732 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4739 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4740 Disk full in NFS may be reported here. */
4741 /* mib says that closing the file will try to write as fast as NFS can do
4742 it, and that means the fsync here is not crucial for autosave files. */
4743 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4745 /* If fsync fails with EINTR, don't treat that as serious. Also
4746 ignore EINVAL which happens when fsync is not supported on this
4748 if (errno
!= EINTR
&& errno
!= EINVAL
)
4749 failure
= 1, save_errno
= errno
;
4753 /* NFS can report a write failure now. */
4754 if (emacs_close (desc
) < 0)
4755 failure
= 1, save_errno
= errno
;
4759 /* Discard the unwind protect for close_file_unwind. */
4760 specpdl_ptr
= specpdl
+ count1
;
4762 /* Call write-region-post-annotation-function. */
4763 while (CONSP (Vwrite_region_annotation_buffers
))
4765 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4766 if (!NILP (Fbuffer_live_p (buf
)))
4769 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4770 call0 (Vwrite_region_post_annotation_function
);
4772 Vwrite_region_annotation_buffers
4773 = XCDR (Vwrite_region_annotation_buffers
);
4776 unbind_to (count
, Qnil
);
4778 #ifdef CLASH_DETECTION
4780 unlock_file (lockname
);
4781 #endif /* CLASH_DETECTION */
4783 /* Do this before reporting IO error
4784 to avoid a "file has changed on disk" warning on
4785 next attempt to save. */
4788 current_buffer
->modtime
= st
.st_mtime
;
4789 current_buffer
->modtime_size
= st
.st_size
;
4793 error ("IO error writing %s: %s", SDATA (filename
),
4794 emacs_strerror (save_errno
));
4798 SAVE_MODIFF
= MODIFF
;
4799 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4800 current_buffer
->filename
= visit_file
;
4801 update_mode_lines
++;
4806 && ! NILP (Fstring_equal (current_buffer
->filename
,
4807 current_buffer
->auto_save_file_name
)))
4808 SAVE_MODIFF
= MODIFF
;
4814 message_with_string ((INTEGERP (append
)
4824 Lisp_Object
merge (Lisp_Object
, Lisp_Object
, Lisp_Object
);
4826 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4827 doc
: /* Return t if (car A) is numerically less than (car B). */)
4828 (Lisp_Object a
, Lisp_Object b
)
4830 return Flss (Fcar (a
), Fcar (b
));
4833 /* Build the complete list of annotations appropriate for writing out
4834 the text between START and END, by calling all the functions in
4835 write-region-annotate-functions and merging the lists they return.
4836 If one of these functions switches to a different buffer, we assume
4837 that buffer contains altered text. Therefore, the caller must
4838 make sure to restore the current buffer in all cases,
4839 as save-excursion would do. */
4842 build_annotations (Lisp_Object start
, Lisp_Object end
)
4844 Lisp_Object annotations
;
4846 struct gcpro gcpro1
, gcpro2
;
4847 Lisp_Object original_buffer
;
4848 int i
, used_global
= 0;
4850 XSETBUFFER (original_buffer
, current_buffer
);
4853 p
= Vwrite_region_annotate_functions
;
4854 GCPRO2 (annotations
, p
);
4857 struct buffer
*given_buffer
= current_buffer
;
4858 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4859 { /* Use the global value of the hook. */
4862 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4864 p
= Fappend (2, arg
);
4867 Vwrite_region_annotations_so_far
= annotations
;
4868 res
= call2 (XCAR (p
), start
, end
);
4869 /* If the function makes a different buffer current,
4870 assume that means this buffer contains altered text to be output.
4871 Reset START and END from the buffer bounds
4872 and discard all previous annotations because they should have
4873 been dealt with by this function. */
4874 if (current_buffer
!= given_buffer
)
4876 Vwrite_region_annotation_buffers
4877 = Fcons (Fcurrent_buffer (),
4878 Vwrite_region_annotation_buffers
);
4879 XSETFASTINT (start
, BEGV
);
4880 XSETFASTINT (end
, ZV
);
4883 Flength (res
); /* Check basic validity of return value */
4884 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4888 /* Now do the same for annotation functions implied by the file-format */
4889 if (auto_saving
&& (!EQ (current_buffer
->auto_save_file_format
, Qt
)))
4890 p
= current_buffer
->auto_save_file_format
;
4892 p
= current_buffer
->file_format
;
4893 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4895 struct buffer
*given_buffer
= current_buffer
;
4897 Vwrite_region_annotations_so_far
= annotations
;
4899 /* Value is either a list of annotations or nil if the function
4900 has written annotations to a temporary buffer, which is now
4902 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4903 original_buffer
, make_number (i
));
4904 if (current_buffer
!= given_buffer
)
4906 XSETFASTINT (start
, BEGV
);
4907 XSETFASTINT (end
, ZV
);
4912 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4920 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4921 If STRING is nil, POS is the character position in the current buffer.
4922 Intersperse with them the annotations from *ANNOT
4923 which fall within the range of POS to POS + NCHARS,
4924 each at its appropriate position.
4926 We modify *ANNOT by discarding elements as we use them up.
4928 The return value is negative in case of system call failure. */
4931 a_write (int desc
, Lisp_Object string
, int pos
, register int nchars
, Lisp_Object
*annot
, struct coding_system
*coding
)
4935 int lastpos
= pos
+ nchars
;
4937 while (NILP (*annot
) || CONSP (*annot
))
4939 tem
= Fcar_safe (Fcar (*annot
));
4942 nextpos
= XFASTINT (tem
);
4944 /* If there are no more annotations in this range,
4945 output the rest of the range all at once. */
4946 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4947 return e_write (desc
, string
, pos
, lastpos
, coding
);
4949 /* Output buffer text up to the next annotation's position. */
4952 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4956 /* Output the annotation. */
4957 tem
= Fcdr (Fcar (*annot
));
4960 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4963 *annot
= Fcdr (*annot
);
4969 /* Write text in the range START and END into descriptor DESC,
4970 encoding them with coding system CODING. If STRING is nil, START
4971 and END are character positions of the current buffer, else they
4972 are indexes to the string STRING. */
4975 e_write (int desc
, Lisp_Object string
, int start
, int end
, struct coding_system
*coding
)
4977 if (STRINGP (string
))
4980 end
= SCHARS (string
);
4983 /* We used to have a code for handling selective display here. But,
4984 now it is handled within encode_coding. */
4988 if (STRINGP (string
))
4990 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
4991 if (CODING_REQUIRE_ENCODING (coding
))
4993 encode_coding_object (coding
, string
,
4994 start
, string_char_to_byte (string
, start
),
4995 end
, string_char_to_byte (string
, end
), Qt
);
4999 coding
->dst_object
= string
;
5000 coding
->consumed_char
= SCHARS (string
);
5001 coding
->produced
= SBYTES (string
);
5006 int start_byte
= CHAR_TO_BYTE (start
);
5007 int end_byte
= CHAR_TO_BYTE (end
);
5009 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
5010 if (CODING_REQUIRE_ENCODING (coding
))
5012 encode_coding_object (coding
, Fcurrent_buffer (),
5013 start
, start_byte
, end
, end_byte
, Qt
);
5017 coding
->dst_object
= Qnil
;
5018 coding
->dst_pos_byte
= start_byte
;
5019 if (start
>= GPT
|| end
<= GPT
)
5021 coding
->consumed_char
= end
- start
;
5022 coding
->produced
= end_byte
- start_byte
;
5026 coding
->consumed_char
= GPT
- start
;
5027 coding
->produced
= GPT_BYTE
- start_byte
;
5032 if (coding
->produced
> 0)
5036 STRINGP (coding
->dst_object
)
5037 ? SDATA (coding
->dst_object
)
5038 : BYTE_POS_ADDR (coding
->dst_pos_byte
),
5041 if (coding
->produced
)
5044 start
+= coding
->consumed_char
;
5050 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5051 Sverify_visited_file_modtime
, 0, 1, 0,
5052 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5053 This means that the file has not been changed since it was visited or saved.
5054 If BUF is omitted or nil, it defaults to the current buffer.
5055 See Info node `(elisp)Modification Time' for more details. */)
5060 Lisp_Object handler
;
5061 Lisp_Object filename
;
5071 if (!STRINGP (b
->filename
)) return Qt
;
5072 if (b
->modtime
== 0) return Qt
;
5074 /* If the file name has special constructs in it,
5075 call the corresponding file handler. */
5076 handler
= Ffind_file_name_handler (b
->filename
,
5077 Qverify_visited_file_modtime
);
5078 if (!NILP (handler
))
5079 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5081 filename
= ENCODE_FILE (b
->filename
);
5083 if (stat (SDATA (filename
), &st
) < 0)
5085 /* If the file doesn't exist now and didn't exist before,
5086 we say that it isn't modified, provided the error is a tame one. */
5087 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
5092 if ((st
.st_mtime
== b
->modtime
5093 /* If both are positive, accept them if they are off by one second. */
5094 || (st
.st_mtime
> 0 && b
->modtime
> 0
5095 && (st
.st_mtime
== b
->modtime
+ 1
5096 || st
.st_mtime
== b
->modtime
- 1)))
5097 && (st
.st_size
== b
->modtime_size
5098 || b
->modtime_size
< 0))
5103 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5104 Sclear_visited_file_modtime
, 0, 0, 0,
5105 doc
: /* Clear out records of last mod time of visited file.
5106 Next attempt to save will certainly not complain of a discrepancy. */)
5109 current_buffer
->modtime
= 0;
5110 current_buffer
->modtime_size
= -1;
5114 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5115 Svisited_file_modtime
, 0, 0, 0,
5116 doc
: /* Return the current buffer's recorded visited file modification time.
5117 The value is a list of the form (HIGH LOW), like the time values
5118 that `file-attributes' returns. If the current buffer has no recorded
5119 file modification time, this function returns 0.
5120 See Info node `(elisp)Modification Time' for more details. */)
5123 if (! current_buffer
->modtime
)
5124 return make_number (0);
5125 return make_time ((time_t) current_buffer
->modtime
);
5128 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5129 Sset_visited_file_modtime
, 0, 1, 0,
5130 doc
: /* Update buffer's recorded modification time from the visited file's time.
5131 Useful if the buffer was not read from the file normally
5132 or if the file itself has been changed for some known benign reason.
5133 An argument specifies the modification time value to use
5134 \(instead of that of the visited file), in the form of a list
5135 \(HIGH . LOW) or (HIGH LOW). */)
5136 (Lisp_Object time_list
)
5138 if (!NILP (time_list
))
5140 current_buffer
->modtime
= cons_to_long (time_list
);
5141 current_buffer
->modtime_size
= -1;
5145 register Lisp_Object filename
;
5147 Lisp_Object handler
;
5149 filename
= Fexpand_file_name (current_buffer
->filename
, Qnil
);
5151 /* If the file name has special constructs in it,
5152 call the corresponding file handler. */
5153 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5154 if (!NILP (handler
))
5155 /* The handler can find the file name the same way we did. */
5156 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5158 filename
= ENCODE_FILE (filename
);
5160 if (stat (SDATA (filename
), &st
) >= 0)
5162 current_buffer
->modtime
= st
.st_mtime
;
5163 current_buffer
->modtime_size
= st
.st_size
;
5171 auto_save_error (Lisp_Object error
)
5173 Lisp_Object args
[3], msg
;
5175 struct gcpro gcpro1
;
5179 auto_save_error_occurred
= 1;
5181 ring_bell (XFRAME (selected_frame
));
5183 args
[0] = build_string ("Auto-saving %s: %s");
5184 args
[1] = current_buffer
->name
;
5185 args
[2] = Ferror_message_string (error
);
5186 msg
= Fformat (3, args
);
5188 nbytes
= SBYTES (msg
);
5189 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5190 memcpy (msgbuf
, SDATA (msg
), nbytes
);
5192 for (i
= 0; i
< 3; ++i
)
5195 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5197 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5198 Fsleep_for (make_number (1), Qnil
);
5212 auto_save_mode_bits
= 0666;
5214 /* Get visited file's mode to become the auto save file's mode. */
5215 if (! NILP (current_buffer
->filename
))
5217 if (stat (SDATA (current_buffer
->filename
), &st
) >= 0)
5218 /* But make sure we can overwrite it later! */
5219 auto_save_mode_bits
= st
.st_mode
| 0600;
5220 else if ((modes
= Ffile_modes (current_buffer
->filename
),
5222 /* Remote files don't cooperate with stat. */
5223 auto_save_mode_bits
= XINT (modes
) | 0600;
5227 Fwrite_region (Qnil
, Qnil
, current_buffer
->auto_save_file_name
, Qnil
,
5228 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5233 do_auto_save_unwind (Lisp_Object arg
) /* used as unwind-protect function */
5236 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5248 do_auto_save_unwind_1 (Lisp_Object value
) /* used as unwind-protect function */
5251 minibuffer_auto_raise
= XINT (value
);
5256 do_auto_save_make_dir (Lisp_Object dir
)
5260 call2 (Qmake_directory
, dir
, Qt
);
5261 XSETFASTINT (mode
, 0700);
5262 return Fset_file_modes (dir
, mode
);
5266 do_auto_save_eh (Lisp_Object ignore
)
5271 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5272 doc
: /* Auto-save all buffers that need it.
5273 This is all buffers that have auto-saving enabled
5274 and are changed since last auto-saved.
5275 Auto-saving writes the buffer into a file
5276 so that your editing is not lost if the system crashes.
5277 This file is not the file you visited; that changes only when you save.
5278 Normally we run the normal hook `auto-save-hook' before saving.
5280 A non-nil NO-MESSAGE argument means do not print any message if successful.
5281 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5282 (Lisp_Object no_message
, Lisp_Object current_only
)
5284 struct buffer
*old
= current_buffer
, *b
;
5285 Lisp_Object tail
, buf
;
5287 int do_handled_files
;
5289 FILE *stream
= NULL
;
5290 int count
= SPECPDL_INDEX ();
5291 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5292 int old_message_p
= 0;
5293 struct gcpro gcpro1
, gcpro2
;
5295 if (max_specpdl_size
< specpdl_size
+ 40)
5296 max_specpdl_size
= specpdl_size
+ 40;
5301 if (NILP (no_message
))
5303 old_message_p
= push_message ();
5304 record_unwind_protect (pop_message_unwind
, Qnil
);
5307 /* Ordinarily don't quit within this function,
5308 but don't make it impossible to quit (in case we get hung in I/O). */
5312 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5313 point to non-strings reached from Vbuffer_alist. */
5315 if (!NILP (Vrun_hooks
))
5316 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5318 if (STRINGP (Vauto_save_list_file_name
))
5320 Lisp_Object listfile
;
5322 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5324 /* Don't try to create the directory when shutting down Emacs,
5325 because creating the directory might signal an error, and
5326 that would leave Emacs in a strange state. */
5327 if (!NILP (Vrun_hooks
))
5331 GCPRO2 (dir
, listfile
);
5332 dir
= Ffile_name_directory (listfile
);
5333 if (NILP (Ffile_directory_p (dir
)))
5334 internal_condition_case_1 (do_auto_save_make_dir
,
5335 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5340 stream
= fopen (SDATA (listfile
), "w");
5343 record_unwind_protect (do_auto_save_unwind
,
5344 make_save_value (stream
, 0));
5345 record_unwind_protect (do_auto_save_unwind_1
,
5346 make_number (minibuffer_auto_raise
));
5347 minibuffer_auto_raise
= 0;
5349 auto_save_error_occurred
= 0;
5351 /* On first pass, save all files that don't have handlers.
5352 On second pass, save all files that do have handlers.
5354 If Emacs is crashing, the handlers may tweak what is causing
5355 Emacs to crash in the first place, and it would be a shame if
5356 Emacs failed to autosave perfectly ordinary files because it
5357 couldn't handle some ange-ftp'd file. */
5359 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5360 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5362 buf
= XCDR (XCAR (tail
));
5365 /* Record all the buffers that have auto save mode
5366 in the special file that lists them. For each of these buffers,
5367 Record visited name (if any) and auto save name. */
5368 if (STRINGP (b
->auto_save_file_name
)
5369 && stream
!= NULL
&& do_handled_files
== 0)
5372 if (!NILP (b
->filename
))
5374 fwrite (SDATA (b
->filename
), 1,
5375 SBYTES (b
->filename
), stream
);
5377 putc ('\n', stream
);
5378 fwrite (SDATA (b
->auto_save_file_name
), 1,
5379 SBYTES (b
->auto_save_file_name
), stream
);
5380 putc ('\n', stream
);
5384 if (!NILP (current_only
)
5385 && b
!= current_buffer
)
5388 /* Don't auto-save indirect buffers.
5389 The base buffer takes care of it. */
5393 /* Check for auto save enabled
5394 and file changed since last auto save
5395 and file changed since last real save. */
5396 if (STRINGP (b
->auto_save_file_name
)
5397 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5398 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5399 /* -1 means we've turned off autosaving for a while--see below. */
5400 && XINT (b
->save_length
) >= 0
5401 && (do_handled_files
5402 || NILP (Ffind_file_name_handler (b
->auto_save_file_name
,
5405 EMACS_TIME before_time
, after_time
;
5407 EMACS_GET_TIME (before_time
);
5409 /* If we had a failure, don't try again for 20 minutes. */
5410 if (b
->auto_save_failure_time
>= 0
5411 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5414 set_buffer_internal (b
);
5415 if (NILP (Vauto_save_include_big_deletions
)
5416 && (XFASTINT (b
->save_length
) * 10
5417 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5418 /* A short file is likely to change a large fraction;
5419 spare the user annoying messages. */
5420 && XFASTINT (b
->save_length
) > 5000
5421 /* These messages are frequent and annoying for `*mail*'. */
5422 && !EQ (b
->filename
, Qnil
)
5423 && NILP (no_message
))
5425 /* It has shrunk too much; turn off auto-saving here. */
5426 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5427 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5429 minibuffer_auto_raise
= 0;
5430 /* Turn off auto-saving until there's a real save,
5431 and prevent any more warnings. */
5432 XSETINT (b
->save_length
, -1);
5433 Fsleep_for (make_number (1), Qnil
);
5436 if (!auto_saved
&& NILP (no_message
))
5437 message1 ("Auto-saving...");
5438 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5440 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5441 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5442 set_buffer_internal (old
);
5444 EMACS_GET_TIME (after_time
);
5446 /* If auto-save took more than 60 seconds,
5447 assume it was an NFS failure that got a timeout. */
5448 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5449 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5453 /* Prevent another auto save till enough input events come in. */
5454 record_auto_save ();
5456 if (auto_saved
&& NILP (no_message
))
5460 /* If we are going to restore an old message,
5461 give time to read ours. */
5462 sit_for (make_number (1), 0, 0);
5465 else if (!auto_save_error_occurred
)
5466 /* Don't overwrite the error message if an error occurred.
5467 If we displayed a message and then restored a state
5468 with no message, leave a "done" message on the screen. */
5469 message1 ("Auto-saving...done");
5474 /* This restores the message-stack status. */
5475 unbind_to (count
, Qnil
);
5479 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5480 Sset_buffer_auto_saved
, 0, 0, 0,
5481 doc
: /* Mark current buffer as auto-saved with its current text.
5482 No auto-save file will be written until the buffer changes again. */)
5485 /* FIXME: This should not be called in indirect buffers, since
5486 they're not autosaved. */
5487 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5488 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5489 current_buffer
->auto_save_failure_time
= -1;
5493 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5494 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5495 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5498 current_buffer
->auto_save_failure_time
= -1;
5502 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5504 doc
: /* Return t if current buffer has been auto-saved recently.
5505 More precisely, if it has been auto-saved since last read from or saved
5506 in the visited file. If the buffer has no visited file,
5507 then any auto-save counts as "recent". */)
5510 /* FIXME: maybe we should return nil for indirect buffers since
5511 they're never autosaved. */
5512 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5515 /* Reading and completing file names */
5517 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5518 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5519 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5520 The return value is only relevant for a call to `read-file-name' that happens
5521 before any other event (mouse or keypress) is handled. */)
5524 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5525 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5535 Fread_file_name (Lisp_Object prompt
, Lisp_Object dir
, Lisp_Object default_filename
, Lisp_Object mustmatch
, Lisp_Object initial
, Lisp_Object predicate
)
5537 struct gcpro gcpro1
, gcpro2
;
5538 Lisp_Object args
[7];
5540 GCPRO1 (default_filename
);
5541 args
[0] = intern ("read-file-name");
5544 args
[3] = default_filename
;
5545 args
[4] = mustmatch
;
5547 args
[6] = predicate
;
5548 RETURN_UNGCPRO (Ffuncall (7, args
));
5553 syms_of_fileio (void)
5555 Qoperations
= intern_c_string ("operations");
5556 Qexpand_file_name
= intern_c_string ("expand-file-name");
5557 Qsubstitute_in_file_name
= intern_c_string ("substitute-in-file-name");
5558 Qdirectory_file_name
= intern_c_string ("directory-file-name");
5559 Qfile_name_directory
= intern_c_string ("file-name-directory");
5560 Qfile_name_nondirectory
= intern_c_string ("file-name-nondirectory");
5561 Qunhandled_file_name_directory
= intern_c_string ("unhandled-file-name-directory");
5562 Qfile_name_as_directory
= intern_c_string ("file-name-as-directory");
5563 Qcopy_file
= intern_c_string ("copy-file");
5564 Qmake_directory_internal
= intern_c_string ("make-directory-internal");
5565 Qmake_directory
= intern_c_string ("make-directory");
5566 Qdelete_directory_internal
= intern_c_string ("delete-directory-internal");
5567 Qdelete_file
= intern_c_string ("delete-file");
5568 Qrename_file
= intern_c_string ("rename-file");
5569 Qadd_name_to_file
= intern_c_string ("add-name-to-file");
5570 Qmake_symbolic_link
= intern_c_string ("make-symbolic-link");
5571 Qfile_exists_p
= intern_c_string ("file-exists-p");
5572 Qfile_executable_p
= intern_c_string ("file-executable-p");
5573 Qfile_readable_p
= intern_c_string ("file-readable-p");
5574 Qfile_writable_p
= intern_c_string ("file-writable-p");
5575 Qfile_symlink_p
= intern_c_string ("file-symlink-p");
5576 Qaccess_file
= intern_c_string ("access-file");
5577 Qfile_directory_p
= intern_c_string ("file-directory-p");
5578 Qfile_regular_p
= intern_c_string ("file-regular-p");
5579 Qfile_accessible_directory_p
= intern_c_string ("file-accessible-directory-p");
5580 Qfile_modes
= intern_c_string ("file-modes");
5581 Qset_file_modes
= intern_c_string ("set-file-modes");
5582 Qset_file_times
= intern_c_string ("set-file-times");
5583 Qfile_selinux_context
= intern_c_string("file-selinux-context");
5584 Qset_file_selinux_context
= intern_c_string("set-file-selinux-context");
5585 Qfile_newer_than_file_p
= intern_c_string ("file-newer-than-file-p");
5586 Qinsert_file_contents
= intern_c_string ("insert-file-contents");
5587 Qwrite_region
= intern_c_string ("write-region");
5588 Qverify_visited_file_modtime
= intern_c_string ("verify-visited-file-modtime");
5589 Qset_visited_file_modtime
= intern_c_string ("set-visited-file-modtime");
5590 Qauto_save_coding
= intern_c_string ("auto-save-coding");
5592 staticpro (&Qoperations
);
5593 staticpro (&Qexpand_file_name
);
5594 staticpro (&Qsubstitute_in_file_name
);
5595 staticpro (&Qdirectory_file_name
);
5596 staticpro (&Qfile_name_directory
);
5597 staticpro (&Qfile_name_nondirectory
);
5598 staticpro (&Qunhandled_file_name_directory
);
5599 staticpro (&Qfile_name_as_directory
);
5600 staticpro (&Qcopy_file
);
5601 staticpro (&Qmake_directory_internal
);
5602 staticpro (&Qmake_directory
);
5603 staticpro (&Qdelete_directory_internal
);
5604 staticpro (&Qdelete_file
);
5605 staticpro (&Qrename_file
);
5606 staticpro (&Qadd_name_to_file
);
5607 staticpro (&Qmake_symbolic_link
);
5608 staticpro (&Qfile_exists_p
);
5609 staticpro (&Qfile_executable_p
);
5610 staticpro (&Qfile_readable_p
);
5611 staticpro (&Qfile_writable_p
);
5612 staticpro (&Qaccess_file
);
5613 staticpro (&Qfile_symlink_p
);
5614 staticpro (&Qfile_directory_p
);
5615 staticpro (&Qfile_regular_p
);
5616 staticpro (&Qfile_accessible_directory_p
);
5617 staticpro (&Qfile_modes
);
5618 staticpro (&Qset_file_modes
);
5619 staticpro (&Qset_file_times
);
5620 staticpro (&Qfile_selinux_context
);
5621 staticpro (&Qset_file_selinux_context
);
5622 staticpro (&Qfile_newer_than_file_p
);
5623 staticpro (&Qinsert_file_contents
);
5624 staticpro (&Qwrite_region
);
5625 staticpro (&Qverify_visited_file_modtime
);
5626 staticpro (&Qset_visited_file_modtime
);
5627 staticpro (&Qauto_save_coding
);
5629 Qfile_name_history
= intern_c_string ("file-name-history");
5630 Fset (Qfile_name_history
, Qnil
);
5631 staticpro (&Qfile_name_history
);
5633 Qfile_error
= intern_c_string ("file-error");
5634 staticpro (&Qfile_error
);
5635 Qfile_already_exists
= intern_c_string ("file-already-exists");
5636 staticpro (&Qfile_already_exists
);
5637 Qfile_date_error
= intern_c_string ("file-date-error");
5638 staticpro (&Qfile_date_error
);
5639 Qexcl
= intern_c_string ("excl");
5643 Qfind_buffer_file_type
= intern_c_string ("find-buffer-file-type");
5644 staticpro (&Qfind_buffer_file_type
);
5647 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system
,
5648 doc
: /* *Coding system for encoding file names.
5649 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5650 Vfile_name_coding_system
= Qnil
;
5652 DEFVAR_LISP ("default-file-name-coding-system",
5653 &Vdefault_file_name_coding_system
,
5654 doc
: /* Default coding system for encoding file names.
5655 This variable is used only when `file-name-coding-system' is nil.
5657 This variable is set/changed by the command `set-language-environment'.
5658 User should not set this variable manually,
5659 instead use `file-name-coding-system' to get a constant encoding
5660 of file names regardless of the current language environment. */);
5661 Vdefault_file_name_coding_system
= Qnil
;
5663 Qformat_decode
= intern_c_string ("format-decode");
5664 staticpro (&Qformat_decode
);
5665 Qformat_annotate_function
= intern_c_string ("format-annotate-function");
5666 staticpro (&Qformat_annotate_function
);
5667 Qafter_insert_file_set_coding
= intern_c_string ("after-insert-file-set-coding");
5668 staticpro (&Qafter_insert_file_set_coding
);
5670 Qcar_less_than_car
= intern_c_string ("car-less-than-car");
5671 staticpro (&Qcar_less_than_car
);
5673 Fput (Qfile_error
, Qerror_conditions
,
5674 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5675 Fput (Qfile_error
, Qerror_message
,
5676 make_pure_c_string ("File error"));
5678 Fput (Qfile_already_exists
, Qerror_conditions
,
5679 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5680 Fput (Qfile_already_exists
, Qerror_message
,
5681 make_pure_c_string ("File already exists"));
5683 Fput (Qfile_date_error
, Qerror_conditions
,
5684 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5685 Fput (Qfile_date_error
, Qerror_message
,
5686 make_pure_c_string ("Cannot set file date"));
5688 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist
,
5689 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
5690 If a file name matches REGEXP, then all I/O on that file is done by calling
5693 The first argument given to HANDLER is the name of the I/O primitive
5694 to be handled; the remaining arguments are the arguments that were
5695 passed to that primitive. For example, if you do
5696 (file-exists-p FILENAME)
5697 and FILENAME is handled by HANDLER, then HANDLER is called like this:
5698 (funcall HANDLER 'file-exists-p FILENAME)
5699 The function `find-file-name-handler' checks this list for a handler
5700 for its argument. */);
5701 Vfile_name_handler_alist
= Qnil
;
5703 DEFVAR_LISP ("set-auto-coding-function",
5704 &Vset_auto_coding_function
,
5705 doc
: /* If non-nil, a function to call to decide a coding system of file.
5706 Two arguments are passed to this function: the file name
5707 and the length of a file contents following the point.
5708 This function should return a coding system to decode the file contents.
5709 It should check the file name against `auto-coding-alist'.
5710 If no coding system is decided, it should check a coding system
5711 specified in the heading lines with the format:
5712 -*- ... coding: CODING-SYSTEM; ... -*-
5713 or local variable spec of the tailing lines with `coding:' tag. */);
5714 Vset_auto_coding_function
= Qnil
;
5716 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions
,
5717 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5718 Each is passed one argument, the number of characters inserted,
5719 with point at the start of the inserted text. Each function
5720 should leave point the same, and return the new character count.
5721 If `insert-file-contents' is intercepted by a handler from
5722 `file-name-handler-alist', that handler is responsible for calling the
5723 functions in `after-insert-file-functions' if appropriate. */);
5724 Vafter_insert_file_functions
= Qnil
;
5726 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions
,
5727 doc
: /* A list of functions to be called at the start of `write-region'.
5728 Each is passed two arguments, START and END as for `write-region'.
5729 These are usually two numbers but not always; see the documentation
5730 for `write-region'. The function should return a list of pairs
5731 of the form (POSITION . STRING), consisting of strings to be effectively
5732 inserted at the specified positions of the file being written (1 means to
5733 insert before the first byte written). The POSITIONs must be sorted into
5736 If there are several annotation functions, the lists returned by these
5737 functions are merged destructively. As each annotation function runs,
5738 the variable `write-region-annotations-so-far' contains a list of all
5739 annotations returned by previous annotation functions.
5741 An annotation function can return with a different buffer current.
5742 Doing so removes the annotations returned by previous functions, and
5743 resets START and END to `point-min' and `point-max' of the new buffer.
5745 After `write-region' completes, Emacs calls the function stored in
5746 `write-region-post-annotation-function', once for each buffer that was
5747 current when building the annotations (i.e., at least once), with that
5748 buffer current. */);
5749 Vwrite_region_annotate_functions
= Qnil
;
5750 staticpro (&Qwrite_region_annotate_functions
);
5751 Qwrite_region_annotate_functions
5752 = intern_c_string ("write-region-annotate-functions");
5754 DEFVAR_LISP ("write-region-post-annotation-function",
5755 &Vwrite_region_post_annotation_function
,
5756 doc
: /* Function to call after `write-region' completes.
5757 The function is called with no arguments. If one or more of the
5758 annotation functions in `write-region-annotate-functions' changed the
5759 current buffer, the function stored in this variable is called for
5760 each of those additional buffers as well, in addition to the original
5761 buffer. The relevant buffer is current during each function call. */);
5762 Vwrite_region_post_annotation_function
= Qnil
;
5763 staticpro (&Vwrite_region_annotation_buffers
);
5765 DEFVAR_LISP ("write-region-annotations-so-far",
5766 &Vwrite_region_annotations_so_far
,
5767 doc
: /* When an annotation function is called, this holds the previous annotations.
5768 These are the annotations made by other annotation functions
5769 that were already called. See also `write-region-annotate-functions'. */);
5770 Vwrite_region_annotations_so_far
= Qnil
;
5772 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers
,
5773 doc
: /* A list of file name handlers that temporarily should not be used.
5774 This applies only to the operation `inhibit-file-name-operation'. */);
5775 Vinhibit_file_name_handlers
= Qnil
;
5777 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation
,
5778 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5779 Vinhibit_file_name_operation
= Qnil
;
5781 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name
,
5782 doc
: /* File name in which we write a list of all auto save file names.
5783 This variable is initialized automatically from `auto-save-list-file-prefix'
5784 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5785 a non-nil value. */);
5786 Vauto_save_list_file_name
= Qnil
;
5788 DEFVAR_LISP ("auto-save-visited-file-name", &Vauto_save_visited_file_name
,
5789 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5790 Normally auto-save files are written under other names. */);
5791 Vauto_save_visited_file_name
= Qnil
;
5793 DEFVAR_LISP ("auto-save-include-big-deletions", &Vauto_save_include_big_deletions
,
5794 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5795 If nil, deleting a substantial portion of the text disables auto-save
5796 in the buffer; this is the default behavior, because the auto-save
5797 file is usually more useful if it contains the deleted text. */);
5798 Vauto_save_include_big_deletions
= Qnil
;
5801 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync
,
5802 doc
: /* *Non-nil means don't call fsync in `write-region'.
5803 This variable affects calls to `write-region' as well as save commands.
5804 A non-nil value may result in data loss! */);
5805 write_region_inhibit_fsync
= 0;
5808 DEFVAR_BOOL ("delete-by-moving-to-trash", &delete_by_moving_to_trash
,
5809 doc
: /* Specifies whether to use the system's trash can.
5810 When non-nil, certain file deletion commands use the function
5811 `move-file-to-trash' instead of deleting files outright.
5812 This includes interactive calls to `delete-file' and
5813 `delete-directory' and the Dired deletion commands. */);
5814 delete_by_moving_to_trash
= 0;
5815 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5816 Qmove_file_to_trash
= intern_c_string ("move-file-to-trash");
5817 staticpro (&Qmove_file_to_trash
);
5818 Qcopy_directory
= intern_c_string ("copy-directory");
5819 staticpro (&Qcopy_directory
);
5820 Qdelete_directory
= intern_c_string ("delete-directory");
5821 staticpro (&Qdelete_directory
);
5823 defsubr (&Sfind_file_name_handler
);
5824 defsubr (&Sfile_name_directory
);
5825 defsubr (&Sfile_name_nondirectory
);
5826 defsubr (&Sunhandled_file_name_directory
);
5827 defsubr (&Sfile_name_as_directory
);
5828 defsubr (&Sdirectory_file_name
);
5829 defsubr (&Smake_temp_name
);
5830 defsubr (&Sexpand_file_name
);
5831 defsubr (&Ssubstitute_in_file_name
);
5832 defsubr (&Scopy_file
);
5833 defsubr (&Smake_directory_internal
);
5834 defsubr (&Sdelete_directory_internal
);
5835 defsubr (&Sdelete_file
);
5836 defsubr (&Srename_file
);
5837 defsubr (&Sadd_name_to_file
);
5838 defsubr (&Smake_symbolic_link
);
5839 defsubr (&Sfile_name_absolute_p
);
5840 defsubr (&Sfile_exists_p
);
5841 defsubr (&Sfile_executable_p
);
5842 defsubr (&Sfile_readable_p
);
5843 defsubr (&Sfile_writable_p
);
5844 defsubr (&Saccess_file
);
5845 defsubr (&Sfile_symlink_p
);
5846 defsubr (&Sfile_directory_p
);
5847 defsubr (&Sfile_accessible_directory_p
);
5848 defsubr (&Sfile_regular_p
);
5849 defsubr (&Sfile_modes
);
5850 defsubr (&Sset_file_modes
);
5851 defsubr (&Sset_file_times
);
5852 defsubr (&Sfile_selinux_context
);
5853 defsubr (&Sset_file_selinux_context
);
5854 defsubr (&Sset_default_file_modes
);
5855 defsubr (&Sdefault_file_modes
);
5856 defsubr (&Sfile_newer_than_file_p
);
5857 defsubr (&Sinsert_file_contents
);
5858 defsubr (&Swrite_region
);
5859 defsubr (&Scar_less_than_car
);
5860 defsubr (&Sverify_visited_file_modtime
);
5861 defsubr (&Sclear_visited_file_modtime
);
5862 defsubr (&Svisited_file_modtime
);
5863 defsubr (&Sset_visited_file_modtime
);
5864 defsubr (&Sdo_auto_save
);
5865 defsubr (&Sset_buffer_auto_saved
);
5866 defsubr (&Sclear_buffer_auto_save_failure
);
5867 defsubr (&Srecent_auto_save_p
);
5869 defsubr (&Snext_read_file_uses_dialog_p
);
5872 defsubr (&Sunix_sync
);