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 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/>. */
29 #include <sys/types.h>
37 #if !defined (S_ISLNK) && defined (S_IFLNK)
38 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
41 #if !defined (S_ISFIFO) && defined (S_IFIFO)
42 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
45 #if !defined (S_ISREG) && defined (S_IFREG)
46 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
63 #include "intervals.h"
65 #include "character.h"
68 #include "blockinput.h"
70 #include "dispextern.h"
77 #endif /* not WINDOWSNT */
81 #include <sys/param.h>
89 #define CORRECT_DIR_SEPS(s) \
90 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
91 else unixtodos_filename (s); \
93 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
94 redirector allows the six letters between 'Z' and 'a' as well. */
96 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
99 #define IS_DRIVE(x) isalpha (x)
101 /* Need to lower-case the drive letter, or else expanded
102 filenames will sometimes compare inequal, because
103 `expand-file-name' doesn't always down-case the drive letter. */
104 #define DRIVE_LETTER(x) (tolower (x))
113 #include "commands.h"
114 extern int use_dialog_box
;
115 extern int use_file_dialog
;
129 #ifndef FILE_SYSTEM_CASE
130 #define FILE_SYSTEM_CASE(filename) (filename)
133 /* Nonzero during writing of auto-save files */
136 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
137 a new file with the same mode as the original */
138 int auto_save_mode_bits
;
140 /* Set by auto_save_1 if an error occurred during the last auto-save. */
141 int auto_save_error_occurred
;
143 /* The symbol bound to coding-system-for-read when
144 insert-file-contents is called for recovering a file. This is not
145 an actual coding system name, but just an indicator to tell
146 insert-file-contents to use `emacs-mule' with a special flag for
147 auto saving and recovering a file. */
148 Lisp_Object Qauto_save_coding
;
150 /* Coding system for file names, or nil if none. */
151 Lisp_Object Vfile_name_coding_system
;
153 /* Coding system for file names used only when
154 Vfile_name_coding_system is nil. */
155 Lisp_Object Vdefault_file_name_coding_system
;
157 /* Alist of elements (REGEXP . HANDLER) for file names
158 whose I/O is done with a special handler. */
159 Lisp_Object Vfile_name_handler_alist
;
161 /* Property name of a file name handler,
162 which gives a list of operations it handles.. */
163 Lisp_Object Qoperations
;
165 /* Lisp functions for translating file formats */
166 Lisp_Object Qformat_decode
, Qformat_annotate_function
;
168 /* Function to be called to decide a coding system of a reading file. */
169 Lisp_Object Vset_auto_coding_function
;
171 /* Functions to be called to process text properties in inserted file. */
172 Lisp_Object Vafter_insert_file_functions
;
174 /* Lisp function for setting buffer-file-coding-system and the
175 multibyteness of the current buffer after inserting a file. */
176 Lisp_Object Qafter_insert_file_set_coding
;
178 /* Functions to be called to create text property annotations for file. */
179 Lisp_Object Vwrite_region_annotate_functions
;
180 Lisp_Object Qwrite_region_annotate_functions
;
181 Lisp_Object Vwrite_region_post_annotation_function
;
183 /* During build_annotations, each time an annotation function is called,
184 this holds the annotations made by the previous functions. */
185 Lisp_Object Vwrite_region_annotations_so_far
;
187 /* Each time an annotation function changes the buffer, the new buffer
189 Lisp_Object Vwrite_region_annotation_buffers
;
191 /* File name in which we write a list of all our auto save files. */
192 Lisp_Object Vauto_save_list_file_name
;
194 /* Whether or not files are auto-saved into themselves. */
195 Lisp_Object Vauto_save_visited_file_name
;
197 /* Whether or not to continue auto-saving after a large deletion. */
198 Lisp_Object Vauto_save_include_big_deletions
;
200 /* On NT, specifies the directory separator character, used (eg.) when
201 expanding file names. This can be bound to / or \. */
202 Lisp_Object Vdirectory_sep_char
;
205 /* Nonzero means skip the call to fsync in Fwrite-region. */
206 int write_region_inhibit_fsync
;
209 /* Non-zero means call move-file-to-trash in Fdelete_file or
210 Fdelete_directory_internal. */
211 int delete_by_moving_to_trash
;
213 Lisp_Object Qdelete_by_moving_to_trash
;
215 /* Lisp function for moving files to trash. */
216 Lisp_Object Qmove_file_to_trash
;
218 extern Lisp_Object Vuser_login_name
;
221 extern Lisp_Object Vw32_get_true_file_attributes
;
224 extern int minibuf_level
;
226 extern int minibuffer_auto_raise
;
228 /* These variables describe handlers that have "already" had a chance
229 to handle the current operation.
231 Vinhibit_file_name_handlers is a list of file name handlers.
232 Vinhibit_file_name_operation is the operation being handled.
233 If we try to handle that operation, we ignore those handlers. */
235 static Lisp_Object Vinhibit_file_name_handlers
;
236 static Lisp_Object Vinhibit_file_name_operation
;
238 Lisp_Object Qfile_error
, Qfile_already_exists
, Qfile_date_error
;
240 Lisp_Object Qfile_name_history
;
242 Lisp_Object Qcar_less_than_car
;
244 static int a_write
P_ ((int, Lisp_Object
, int, int,
245 Lisp_Object
*, struct coding_system
*));
246 static int e_write
P_ ((int, Lisp_Object
, int, int, struct coding_system
*));
250 report_file_error (string
, data
)
254 Lisp_Object errstring
;
258 synchronize_system_messages_locale ();
259 str
= strerror (errorno
);
260 errstring
= code_convert_string_norecord (make_unibyte_string (str
,
262 Vlocale_coding_system
, 0);
268 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
271 /* System error messages are capitalized. Downcase the initial
272 unless it is followed by a slash. (The slash case caters to
273 error messages that begin with "I/O" or, in German, "E/A".) */
274 if (STRING_MULTIBYTE (errstring
)
275 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
279 str
= (char *) SDATA (errstring
);
280 c
= STRING_CHAR (str
, 0);
281 Faset (errstring
, make_number (0), make_number (DOWNCASE (c
)));
284 xsignal (Qfile_error
,
285 Fcons (build_string (string
), Fcons (errstring
, data
)));
290 close_file_unwind (fd
)
293 emacs_close (XFASTINT (fd
));
297 /* Restore point, having saved it as a marker. */
300 restore_point_unwind (location
)
301 Lisp_Object location
;
303 Fgoto_char (location
);
304 Fset_marker (location
, Qnil
, Qnil
);
309 Lisp_Object Qexpand_file_name
;
310 Lisp_Object Qsubstitute_in_file_name
;
311 Lisp_Object Qdirectory_file_name
;
312 Lisp_Object Qfile_name_directory
;
313 Lisp_Object Qfile_name_nondirectory
;
314 Lisp_Object Qunhandled_file_name_directory
;
315 Lisp_Object Qfile_name_as_directory
;
316 Lisp_Object Qcopy_file
;
317 Lisp_Object Qmake_directory_internal
;
318 Lisp_Object Qmake_directory
;
319 Lisp_Object Qdelete_directory_internal
;
320 Lisp_Object Qdelete_file
;
321 Lisp_Object Qrename_file
;
322 Lisp_Object Qadd_name_to_file
;
323 Lisp_Object Qmake_symbolic_link
;
324 Lisp_Object Qfile_exists_p
;
325 Lisp_Object Qfile_executable_p
;
326 Lisp_Object Qfile_readable_p
;
327 Lisp_Object Qfile_writable_p
;
328 Lisp_Object Qfile_symlink_p
;
329 Lisp_Object Qaccess_file
;
330 Lisp_Object Qfile_directory_p
;
331 Lisp_Object Qfile_regular_p
;
332 Lisp_Object Qfile_accessible_directory_p
;
333 Lisp_Object Qfile_modes
;
334 Lisp_Object Qset_file_modes
;
335 Lisp_Object Qset_file_times
;
336 Lisp_Object Qfile_newer_than_file_p
;
337 Lisp_Object Qinsert_file_contents
;
338 Lisp_Object Qwrite_region
;
339 Lisp_Object Qverify_visited_file_modtime
;
340 Lisp_Object Qset_visited_file_modtime
;
342 DEFUN ("find-file-name-handler", Ffind_file_name_handler
, Sfind_file_name_handler
, 2, 2, 0,
343 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
344 Otherwise, return nil.
345 A file name is handled if one of the regular expressions in
346 `file-name-handler-alist' matches it.
348 If OPERATION equals `inhibit-file-name-operation', then we ignore
349 any handlers that are members of `inhibit-file-name-handlers',
350 but we still do run any other handlers. This lets handlers
351 use the standard functions without calling themselves recursively. */)
352 (filename
, operation
)
353 Lisp_Object filename
, operation
;
355 /* This function must not munge the match data. */
356 Lisp_Object chain
, inhibited_handlers
, result
;
360 CHECK_STRING (filename
);
362 if (EQ (operation
, Vinhibit_file_name_operation
))
363 inhibited_handlers
= Vinhibit_file_name_handlers
;
365 inhibited_handlers
= Qnil
;
367 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
368 chain
= XCDR (chain
))
374 Lisp_Object string
= XCAR (elt
);
376 Lisp_Object handler
= XCDR (elt
);
377 Lisp_Object operations
= Qnil
;
379 if (SYMBOLP (handler
))
380 operations
= Fget (handler
, Qoperations
);
383 && (match_pos
= fast_string_match (string
, filename
)) > pos
384 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
388 handler
= XCDR (elt
);
389 tem
= Fmemq (handler
, inhibited_handlers
);
403 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
405 doc
: /* Return the directory component in file name FILENAME.
406 Return nil if FILENAME does not include a directory.
407 Otherwise return a directory name.
408 Given a Unix syntax file name, returns a string ending in slash. */)
410 Lisp_Object filename
;
413 register const unsigned char *beg
;
415 register unsigned char *beg
;
417 register const unsigned char *p
;
420 CHECK_STRING (filename
);
422 /* If the file name has special constructs in it,
423 call the corresponding file handler. */
424 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
426 return call2 (handler
, Qfile_name_directory
, filename
);
428 filename
= FILE_SYSTEM_CASE (filename
);
430 beg
= (unsigned char *) alloca (SBYTES (filename
) + 1);
431 bcopy (SDATA (filename
), beg
, SBYTES (filename
) + 1);
433 beg
= SDATA (filename
);
435 p
= beg
+ SBYTES (filename
);
437 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
439 /* only recognise drive specifier at the beginning */
441 /* handle the "/:d:foo" and "/:foo" cases correctly */
442 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
443 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
450 /* Expansion of "c:" to drive and default directory. */
453 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
454 unsigned char *res
= alloca (MAXPATHLEN
+ 1);
455 unsigned char *r
= res
;
457 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
459 strncpy (res
, beg
, 2);
464 if (getdefdir (toupper (*beg
) - 'A' + 1, r
))
466 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
469 p
= beg
+ strlen (beg
);
472 CORRECT_DIR_SEPS (beg
);
475 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
478 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
479 Sfile_name_nondirectory
, 1, 1, 0,
480 doc
: /* Return file name FILENAME sans its directory.
481 For example, in a Unix-syntax file name,
482 this is everything after the last slash,
483 or the entire name if it contains no slash. */)
485 Lisp_Object filename
;
487 register const unsigned char *beg
, *p
, *end
;
490 CHECK_STRING (filename
);
492 /* If the file name has special constructs in it,
493 call the corresponding file handler. */
494 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
496 return call2 (handler
, Qfile_name_nondirectory
, filename
);
498 beg
= SDATA (filename
);
499 end
= p
= beg
+ SBYTES (filename
);
501 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
503 /* only recognise drive specifier at beginning */
505 /* handle the "/:d:foo" case correctly */
506 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
511 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
514 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
515 Sunhandled_file_name_directory
, 1, 1, 0,
516 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
517 A `directly usable' directory name is one that may be used without the
518 intervention of any file handler.
519 If FILENAME is a directly usable file itself, return
520 \(file-name-directory FILENAME).
521 If FILENAME refers to a file which is not accessible from a local process,
522 then this should return nil.
523 The `call-process' and `start-process' functions use this function to
524 get a current directory to run processes in. */)
526 Lisp_Object filename
;
530 /* If the file name has special constructs in it,
531 call the corresponding file handler. */
532 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
534 return call2 (handler
, Qunhandled_file_name_directory
, filename
);
536 return Ffile_name_directory (filename
);
541 file_name_as_directory (out
, in
)
544 int size
= strlen (in
) - 1;
556 /* For Unix syntax, Append a slash if necessary */
557 if (!IS_DIRECTORY_SEP (out
[size
]))
559 /* Cannot use DIRECTORY_SEP, which could have any value */
561 out
[size
+ 2] = '\0';
564 CORRECT_DIR_SEPS (out
);
569 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
570 Sfile_name_as_directory
, 1, 1, 0,
571 doc
: /* Return a string representing the file name FILE interpreted as a directory.
572 This operation exists because a directory is also a file, but its name as
573 a directory is different from its name as a file.
574 The result can be used as the value of `default-directory'
575 or passed as second argument to `expand-file-name'.
576 For a Unix-syntax file name, just appends a slash. */)
587 /* If the file name has special constructs in it,
588 call the corresponding file handler. */
589 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
591 return call2 (handler
, Qfile_name_as_directory
, file
);
593 buf
= (char *) alloca (SBYTES (file
) + 10);
594 file_name_as_directory (buf
, SDATA (file
));
595 return make_specified_string (buf
, -1, strlen (buf
),
596 STRING_MULTIBYTE (file
));
600 * Convert from directory name to filename.
601 * On UNIX, it's simple: just make sure there isn't a terminating /
603 * Value is nonzero if the string output is different from the input.
607 directory_file_name (src
, dst
)
614 /* Process as Unix format: just remove any final slash.
615 But leave "/" unchanged; do not change it to "". */
618 && IS_DIRECTORY_SEP (dst
[slen
- 1])
620 && !IS_ANY_SEP (dst
[slen
- 2])
625 CORRECT_DIR_SEPS (dst
);
630 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
632 doc
: /* Returns the file name of the directory named DIRECTORY.
633 This is the name of the file that holds the data for the directory DIRECTORY.
634 This operation exists because a directory is also a file, but its name as
635 a directory is different from its name as a file.
636 In Unix-syntax, this function just removes the final slash. */)
638 Lisp_Object directory
;
643 CHECK_STRING (directory
);
645 if (NILP (directory
))
648 /* If the file name has special constructs in it,
649 call the corresponding file handler. */
650 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
652 return call2 (handler
, Qdirectory_file_name
, directory
);
654 buf
= (char *) alloca (SBYTES (directory
) + 20);
655 directory_file_name (SDATA (directory
), buf
);
656 return make_specified_string (buf
, -1, strlen (buf
),
657 STRING_MULTIBYTE (directory
));
660 static char make_temp_name_tbl
[64] =
662 'A','B','C','D','E','F','G','H',
663 'I','J','K','L','M','N','O','P',
664 'Q','R','S','T','U','V','W','X',
665 'Y','Z','a','b','c','d','e','f',
666 'g','h','i','j','k','l','m','n',
667 'o','p','q','r','s','t','u','v',
668 'w','x','y','z','0','1','2','3',
669 '4','5','6','7','8','9','-','_'
672 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
674 /* Value is a temporary file name starting with PREFIX, a string.
676 The Emacs process number forms part of the result, so there is
677 no danger of generating a name being used by another process.
678 In addition, this function makes an attempt to choose a name
679 which has no existing file. To make this work, PREFIX should be
680 an absolute file name.
682 BASE64_P non-zero means add the pid as 3 characters in base64
683 encoding. In this case, 6 characters will be added to PREFIX to
684 form the file name. Otherwise, if Emacs is running on a system
685 with long file names, add the pid as a decimal number.
687 This function signals an error if no unique file name could be
691 make_temp_name (prefix
, base64_p
)
698 unsigned char *p
, *data
;
702 CHECK_STRING (prefix
);
704 /* VAL is created by adding 6 characters to PREFIX. The first
705 three are the PID of this process, in base 64, and the second
706 three are incremented if the file already exists. This ensures
707 262144 unique file names per PID per PREFIX. */
709 pid
= (int) getpid ();
713 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
714 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
715 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
720 #ifdef HAVE_LONG_FILE_NAMES
721 sprintf (pidbuf
, "%d", pid
);
722 pidlen
= strlen (pidbuf
);
724 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
725 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
726 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
731 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
732 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
733 if (!STRING_MULTIBYTE (prefix
))
734 STRING_SET_UNIBYTE (val
);
736 bcopy(SDATA (prefix
), data
, len
);
739 bcopy (pidbuf
, p
, pidlen
);
742 /* Here we try to minimize useless stat'ing when this function is
743 invoked many times successively with the same PREFIX. We achieve
744 this by initializing count to a random value, and incrementing it
747 We don't want make-temp-name to be called while dumping,
748 because then make_temp_name_count_initialized_p would get set
749 and then make_temp_name_count would not be set when Emacs starts. */
751 if (!make_temp_name_count_initialized_p
)
753 make_temp_name_count
= (unsigned) time (NULL
);
754 make_temp_name_count_initialized_p
= 1;
760 unsigned num
= make_temp_name_count
;
762 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
763 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
764 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
766 /* Poor man's congruential RN generator. Replace with
767 ++make_temp_name_count for debugging. */
768 make_temp_name_count
+= 25229;
769 make_temp_name_count
%= 225307;
771 if (stat (data
, &ignored
) < 0)
773 /* We want to return only if errno is ENOENT. */
777 /* The error here is dubious, but there is little else we
778 can do. The alternatives are to return nil, which is
779 as bad as (and in many cases worse than) throwing the
780 error, or to ignore the error, which will likely result
781 in looping through 225307 stat's, which is not only
782 dog-slow, but also useless since it will fallback to
783 the errow below, anyway. */
784 report_file_error ("Cannot create temporary name for prefix",
785 Fcons (prefix
, Qnil
));
790 error ("Cannot create temporary name for prefix `%s'",
796 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
797 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
798 The Emacs process number forms part of the result,
799 so there is no danger of generating a name being used by another process.
801 In addition, this function makes an attempt to choose a name
802 which has no existing file. To make this work,
803 PREFIX should be an absolute file name.
805 There is a race condition between calling `make-temp-name' and creating the
806 file which opens all kinds of security holes. For that reason, you should
807 probably use `make-temp-file' instead, except in three circumstances:
809 * If you are creating the file in the user's home directory.
810 * If you are creating a directory rather than an ordinary file.
811 * If you are taking special precautions as `make-temp-file' does. */)
815 return make_temp_name (prefix
, 0);
820 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
821 doc
: /* Convert filename NAME to absolute, and canonicalize it.
822 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
823 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
824 the current buffer's value of `default-directory' is used.
825 File name components that are `.' are removed, and
826 so are file name components followed by `..', along with the `..' itself;
827 note that these simplifications are done without checking the resulting
828 file names in the file system.
829 An initial `~/' expands to your home directory.
830 An initial `~USER/' expands to USER's home directory.
831 See also the function `substitute-in-file-name'.
833 For technical reasons, this function can return correct but
834 non-intuitive results for the root directory; for instance,
835 \(expand-file-name ".." "/") returns "/..". For this reason, use
836 (directory-file-name (file-name-directory dirname)) to traverse a
837 filesystem tree, not (expand-file-name ".." dirname). */)
838 (name
, default_directory
)
839 Lisp_Object name
, default_directory
;
841 /* These point to SDATA and need to be careful with string-relocation
842 during GC (via DECODE_FILE). */
843 unsigned char *nm
, *newdir
;
844 /* This should only point to alloca'd data. */
845 unsigned char *target
;
851 int collapse_newdir
= 1;
855 Lisp_Object handler
, result
;
861 /* If the file name has special constructs in it,
862 call the corresponding file handler. */
863 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
865 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
867 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
868 if (NILP (default_directory
))
869 default_directory
= current_buffer
->directory
;
870 if (! STRINGP (default_directory
))
873 /* "/" is not considered a root directory on DOS_NT, so using "/"
874 here causes an infinite recursion in, e.g., the following:
876 (let (default-directory)
877 (expand-file-name "a"))
879 To avoid this, we set default_directory to the root of the
881 extern char *emacs_root_dir (void);
883 default_directory
= build_string (emacs_root_dir ());
885 default_directory
= build_string ("/");
889 if (!NILP (default_directory
))
891 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
893 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
897 unsigned char *o
= SDATA (default_directory
);
899 /* Make sure DEFAULT_DIRECTORY is properly expanded.
900 It would be better to do this down below where we actually use
901 default_directory. Unfortunately, calling Fexpand_file_name recursively
902 could invoke GC, and the strings might be relocated. This would
903 be annoying because we have pointers into strings lying around
904 that would need adjusting, and people would add new pointers to
905 the code and forget to adjust them, resulting in intermittent bugs.
906 Putting this call here avoids all that crud.
908 The EQ test avoids infinite recursion. */
909 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
910 /* Save time in some common cases - as long as default_directory
911 is not relative, it can be canonicalized with name below (if it
912 is needed at all) without requiring it to be expanded now. */
914 /* Detect MSDOS file names with drive specifiers. */
915 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
916 && IS_DIRECTORY_SEP (o
[2]))
918 /* Detect Windows file names in UNC format. */
919 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
921 #else /* not DOS_NT */
922 /* Detect Unix absolute file names (/... alone is not absolute on
924 && ! (IS_DIRECTORY_SEP (o
[0]))
925 #endif /* not DOS_NT */
931 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
935 name
= FILE_SYSTEM_CASE (name
);
936 multibyte
= STRING_MULTIBYTE (name
);
937 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
940 default_directory
= string_to_multibyte (default_directory
);
943 name
= string_to_multibyte (name
);
948 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
949 nm
= (unsigned char *) alloca (SBYTES (name
) + 1);
950 bcopy (SDATA (name
), nm
, SBYTES (name
) + 1);
953 /* Note if special escape prefix is present, but remove for now. */
954 if (nm
[0] == '/' && nm
[1] == ':')
960 /* Find and remove drive specifier if present; this makes nm absolute
961 even if the rest of the name appears to be relative. Only look for
962 drive specifier at the beginning. */
963 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
970 /* If we see "c://somedir", we want to strip the first slash after the
971 colon when stripping the drive letter. Otherwise, this expands to
973 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
976 /* Discard any previous drive specifier if nm is now in UNC format. */
977 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
981 #endif /* WINDOWSNT */
984 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
985 none are found, we can probably return right away. We will avoid
986 allocating a new string if name is already fully expanded. */
988 IS_DIRECTORY_SEP (nm
[0])
990 && drive
&& !is_escaped
993 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
997 /* If it turns out that the filename we want to return is just a
998 suffix of FILENAME, we don't need to go through and edit
999 things; we just need to construct a new string using data
1000 starting at the middle of FILENAME. If we set lose to a
1001 non-zero value, that means we've discovered that we can't do
1004 unsigned char *p
= nm
;
1008 /* Since we know the name is absolute, we can assume that each
1009 element starts with a "/". */
1011 /* "." and ".." are hairy. */
1012 if (IS_DIRECTORY_SEP (p
[0])
1014 && (IS_DIRECTORY_SEP (p
[2])
1016 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1019 /* We want to replace multiple `/' in a row with a single
1022 && IS_DIRECTORY_SEP (p
[0])
1023 && IS_DIRECTORY_SEP (p
[1]))
1030 /* Make sure directories are all separated with / or \ as
1031 desired, but avoid allocation of a new string when not
1033 CORRECT_DIR_SEPS (nm
);
1035 if (IS_DIRECTORY_SEP (nm
[1]))
1037 if (strcmp (nm
, SDATA (name
)) != 0)
1038 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1042 /* drive must be set, so this is okay */
1043 if (strcmp (nm
- 2, SDATA (name
)) != 0)
1047 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1048 temp
[0] = DRIVE_LETTER (drive
);
1049 name
= concat2 (build_string (temp
), name
);
1052 #else /* not DOS_NT */
1053 if (strcmp (nm
, SDATA (name
)) == 0)
1055 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1056 #endif /* not DOS_NT */
1060 /* At this point, nm might or might not be an absolute file name. We
1061 need to expand ~ or ~user if present, otherwise prefix nm with
1062 default_directory if nm is not absolute, and finally collapse /./
1063 and /foo/../ sequences.
1065 We set newdir to be the appropriate prefix if one is needed:
1066 - the relevant user directory if nm starts with ~ or ~user
1067 - the specified drive's working dir (DOS/NT only) if nm does not
1069 - the value of default_directory.
1071 Note that these prefixes are not guaranteed to be absolute (except
1072 for the working dir of a drive). Therefore, to ensure we always
1073 return an absolute name, if the final prefix is not absolute we
1074 append it to the current working directory. */
1078 if (nm
[0] == '~') /* prefix ~ */
1080 if (IS_DIRECTORY_SEP (nm
[1])
1081 || nm
[1] == 0) /* ~ by itself */
1085 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1086 newdir
= (unsigned char *) "";
1088 /* egetenv may return a unibyte string, which will bite us since
1089 we expect the directory to be multibyte. */
1090 tem
= build_string (newdir
);
1091 if (!STRING_MULTIBYTE (tem
))
1093 hdir
= DECODE_FILE (tem
);
1094 newdir
= SDATA (hdir
);
1097 collapse_newdir
= 0;
1100 else /* ~user/filename */
1102 unsigned char *o
, *p
;
1103 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1104 o
= alloca (p
- nm
+ 1);
1105 bcopy ((char *) nm
, o
, p
- nm
);
1109 pw
= (struct passwd
*) getpwnam (o
+ 1);
1113 newdir
= (unsigned char *) pw
-> pw_dir
;
1116 collapse_newdir
= 0;
1120 /* If we don't find a user of that name, leave the name
1121 unchanged; don't move nm forward to p. */
1126 /* On DOS and Windows, nm is absolute if a drive name was specified;
1127 use the drive's current directory as the prefix if needed. */
1128 if (!newdir
&& drive
)
1130 /* Get default directory if needed to make nm absolute. */
1131 if (!IS_DIRECTORY_SEP (nm
[0]))
1133 newdir
= alloca (MAXPATHLEN
+ 1);
1134 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1139 /* Either nm starts with /, or drive isn't mounted. */
1140 newdir
= alloca (4);
1141 newdir
[0] = DRIVE_LETTER (drive
);
1149 /* Finally, if no prefix has been specified and nm is not absolute,
1150 then it must be expanded relative to default_directory. */
1154 /* /... alone is not absolute on DOS and Windows. */
1155 && !IS_DIRECTORY_SEP (nm
[0])
1158 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1162 newdir
= SDATA (default_directory
);
1164 /* Note if special escape prefix is present, but remove for now. */
1165 if (newdir
[0] == '/' && newdir
[1] == ':')
1176 /* First ensure newdir is an absolute name. */
1178 /* Detect MSDOS file names with drive specifiers. */
1179 ! (IS_DRIVE (newdir
[0])
1180 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1182 /* Detect Windows file names in UNC format. */
1183 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1187 /* Effectively, let newdir be (expand-file-name newdir cwd).
1188 Because of the admonition against calling expand-file-name
1189 when we have pointers into lisp strings, we accomplish this
1190 indirectly by prepending newdir to nm if necessary, and using
1191 cwd (or the wd of newdir's drive) as the new newdir. */
1193 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1198 if (!IS_DIRECTORY_SEP (nm
[0]))
1200 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1201 file_name_as_directory (tmp
, newdir
);
1205 newdir
= alloca (MAXPATHLEN
+ 1);
1208 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1215 /* Strip off drive name from prefix, if present. */
1216 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1222 /* Keep only a prefix from newdir if nm starts with slash
1223 (//server/share for UNC, nothing otherwise). */
1224 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1227 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1230 newdir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1232 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1234 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1246 /* Get rid of any slash at the end of newdir, unless newdir is
1247 just / or // (an incomplete UNC name). */
1248 length
= strlen (newdir
);
1249 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1251 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1255 unsigned char *temp
= (unsigned char *) alloca (length
);
1256 bcopy (newdir
, temp
, length
- 1);
1257 temp
[length
- 1] = 0;
1265 /* Now concatenate the directory and name to new space in the stack frame */
1266 tlen
+= strlen (nm
) + 1;
1268 /* Reserve space for drive specifier and escape prefix, since either
1269 or both may need to be inserted. (The Microsoft x86 compiler
1270 produces incorrect code if the following two lines are combined.) */
1271 target
= (unsigned char *) alloca (tlen
+ 4);
1273 #else /* not DOS_NT */
1274 target
= (unsigned char *) alloca (tlen
);
1275 #endif /* not DOS_NT */
1280 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1283 /* If newdir is effectively "C:/", then the drive letter will have
1284 been stripped and newdir will be "/". Concatenating with an
1285 absolute directory in nm produces "//", which will then be
1286 incorrectly treated as a network share. Ignore newdir in
1287 this case (keeping the drive letter). */
1288 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1289 && newdir
[1] == '\0'))
1291 strcpy (target
, newdir
);
1294 file_name_as_directory (target
, newdir
);
1297 strcat (target
, nm
);
1299 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1302 unsigned char *p
= target
;
1303 unsigned char *o
= target
;
1307 if (!IS_DIRECTORY_SEP (*p
))
1311 else if (p
[1] == '.'
1312 && (IS_DIRECTORY_SEP (p
[2])
1315 /* If "/." is the entire filename, keep the "/". Otherwise,
1316 just delete the whole "/.". */
1317 if (o
== target
&& p
[2] == '\0')
1321 else if (p
[1] == '.' && p
[2] == '.'
1322 /* `/../' is the "superroot" on certain file systems.
1323 Turned off on DOS_NT systems because they have no
1324 "superroot" and because this causes us to produce
1325 file names like "d:/../foo" which fail file-related
1326 functions of the underlying OS. (To reproduce, try a
1327 long series of "../../" in default_directory, longer
1328 than the number of levels from the root.) */
1332 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1335 unsigned char *prev_o
= o
;
1337 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1340 /* Don't go below server level in UNC filenames. */
1341 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1342 && IS_DIRECTORY_SEP (*target
))
1346 /* Keep initial / only if this is the whole name. */
1347 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1351 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1352 /* Collapse multiple `/' in a row. */
1361 /* At last, set drive name. */
1363 /* Except for network file name. */
1364 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1365 #endif /* WINDOWSNT */
1367 if (!drive
) abort ();
1369 target
[0] = DRIVE_LETTER (drive
);
1372 /* Reinsert the escape prefix if required. */
1379 CORRECT_DIR_SEPS (target
);
1382 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1385 /* Again look to see if the file name has special constructs in it
1386 and perhaps call the corresponding file handler. This is needed
1387 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1388 the ".." component gives us "/user@host:/bar/../baz" which needs
1389 to be expanded again. */
1390 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1391 if (!NILP (handler
))
1392 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1398 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1399 This is the old version of expand-file-name, before it was thoroughly
1400 rewritten for Emacs 10.31. We leave this version here commented-out,
1401 because the code is very complex and likely to have subtle bugs. If
1402 bugs _are_ found, it might be of interest to look at the old code and
1403 see what did it do in the relevant situation.
1405 Don't remove this code: it's true that it will be accessible via CVS,
1406 but a few years from deletion, people will forget it is there. */
1408 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1409 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1410 "Convert FILENAME to absolute, and canonicalize it.\n\
1411 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1412 \(does not start with slash); if DEFAULT is nil or missing,\n\
1413 the current buffer's value of default-directory is used.\n\
1414 Filenames containing `.' or `..' as components are simplified;\n\
1415 initial `~/' expands to your home directory.\n\
1416 See also the function `substitute-in-file-name'.")
1418 Lisp_Object name
, defalt
;
1422 register unsigned char *newdir
, *p
, *o
;
1424 unsigned char *target
;
1428 CHECK_STRING (name
);
1431 /* If nm is absolute, flush ...// and detect /./ and /../.
1432 If no /./ or /../ we can return right away. */
1439 if (p
[0] == '/' && p
[1] == '/'
1442 if (p
[0] == '/' && p
[1] == '~')
1443 nm
= p
+ 1, lose
= 1;
1444 if (p
[0] == '/' && p
[1] == '.'
1445 && (p
[2] == '/' || p
[2] == 0
1446 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1452 if (nm
== SDATA (name
))
1454 return build_string (nm
);
1458 /* Now determine directory to start with and put it in NEWDIR */
1462 if (nm
[0] == '~') /* prefix ~ */
1463 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1465 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1466 newdir
= (unsigned char *) "";
1469 else /* ~user/filename */
1471 /* Get past ~ to user */
1472 unsigned char *user
= nm
+ 1;
1473 /* Find end of name. */
1474 unsigned char *ptr
= (unsigned char *) index (user
, '/');
1475 int len
= ptr
? ptr
- user
: strlen (user
);
1476 /* Copy the user name into temp storage. */
1477 o
= (unsigned char *) alloca (len
+ 1);
1478 bcopy ((char *) user
, o
, len
);
1481 /* Look up the user name. */
1483 pw
= (struct passwd
*) getpwnam (o
+ 1);
1486 error ("\"%s\" isn't a registered user", o
+ 1);
1488 newdir
= (unsigned char *) pw
->pw_dir
;
1490 /* Discard the user name from NM. */
1494 if (nm
[0] != '/' && !newdir
)
1497 defalt
= current_buffer
->directory
;
1498 CHECK_STRING (defalt
);
1499 newdir
= SDATA (defalt
);
1502 /* Now concatenate the directory and name to new space in the stack frame */
1504 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1505 target
= (unsigned char *) alloca (tlen
);
1510 if (nm
[0] == 0 || nm
[0] == '/')
1511 strcpy (target
, newdir
);
1513 file_name_as_directory (target
, newdir
);
1516 strcat (target
, nm
);
1518 /* Now canonicalize by removing /. and /foo/.. if they appear */
1529 else if (!strncmp (p
, "//", 2)
1535 else if (p
[0] == '/' && p
[1] == '.'
1536 && (p
[2] == '/' || p
[2] == 0))
1538 else if (!strncmp (p
, "/..", 3)
1539 /* `/../' is the "superroot" on certain file systems. */
1541 && (p
[3] == '/' || p
[3] == 0))
1543 while (o
!= target
&& *--o
!= '/')
1545 if (o
== target
&& *o
== '/')
1555 return make_string (target
, o
- target
);
1559 /* If /~ or // appears, discard everything through first slash. */
1561 file_name_absolute_p (filename
)
1562 const unsigned char *filename
;
1565 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1567 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1568 && IS_DIRECTORY_SEP (filename
[2]))
1573 static unsigned char *
1574 search_embedded_absfilename (nm
, endp
)
1575 unsigned char *nm
, *endp
;
1577 unsigned char *p
, *s
;
1579 for (p
= nm
+ 1; p
< endp
; p
++)
1582 || IS_DIRECTORY_SEP (p
[-1]))
1583 && file_name_absolute_p (p
)
1584 #if defined (WINDOWSNT) || defined(CYGWIN)
1585 /* // at start of file name is meaningful in Apollo,
1586 WindowsNT and Cygwin systems. */
1587 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1588 #endif /* not (WINDOWSNT || CYGWIN) */
1591 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1592 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
1594 unsigned char *o
= alloca (s
- p
+ 1);
1596 bcopy (p
, o
, s
- p
);
1599 /* If we have ~user and `user' exists, discard
1600 everything up to ~. But if `user' does not exist, leave
1601 ~user alone, it might be a literal file name. */
1603 pw
= getpwnam (o
+ 1);
1615 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1616 Ssubstitute_in_file_name
, 1, 1, 0,
1617 doc
: /* Substitute environment variables referred to in FILENAME.
1618 `$FOO' where FOO is an environment variable name means to substitute
1619 the value of that variable. The variable name should be terminated
1620 with a character not a letter, digit or underscore; otherwise, enclose
1621 the entire variable name in braces.
1623 If `/~' appears, all of FILENAME through that `/' is discarded.
1624 If `//' appears, everything up to and including the first of
1625 those `/' is discarded. */)
1627 Lisp_Object filename
;
1631 register unsigned char *s
, *p
, *o
, *x
, *endp
;
1632 unsigned char *target
= NULL
;
1634 int substituted
= 0;
1637 Lisp_Object handler
;
1639 CHECK_STRING (filename
);
1641 multibyte
= STRING_MULTIBYTE (filename
);
1643 /* If the file name has special constructs in it,
1644 call the corresponding file handler. */
1645 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1646 if (!NILP (handler
))
1647 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
1649 /* Always work on a copy of the string, in case GC happens during
1650 decode of environment variables, causing the original Lisp_String
1651 data to be relocated. */
1652 nm
= (unsigned char *) alloca (SBYTES (filename
) + 1);
1653 bcopy (SDATA (filename
), nm
, SBYTES (filename
) + 1);
1656 CORRECT_DIR_SEPS (nm
);
1657 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1659 endp
= nm
+ SBYTES (filename
);
1661 /* If /~ or // appears, discard everything through first slash. */
1662 p
= search_embedded_absfilename (nm
, endp
);
1664 /* Start over with the new string, so we check the file-name-handler
1665 again. Important with filenames like "/home/foo//:/hello///there"
1666 which whould substitute to "/:/hello///there" rather than "/there". */
1667 return Fsubstitute_in_file_name
1668 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1670 /* See if any variables are substituted into the string
1671 and find the total length of their values in `total' */
1673 for (p
= nm
; p
!= endp
;)
1683 /* "$$" means a single "$" */
1692 while (p
!= endp
&& *p
!= '}') p
++;
1693 if (*p
!= '}') goto missingclose
;
1699 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1703 /* Copy out the variable name */
1704 target
= (unsigned char *) alloca (s
- o
+ 1);
1705 strncpy (target
, o
, s
- o
);
1708 strupr (target
); /* $home == $HOME etc. */
1711 /* Get variable value */
1712 o
= (unsigned char *) egetenv (target
);
1715 /* Don't try to guess a maximum length - UTF8 can use up to
1716 four bytes per character. This code is unlikely to run
1717 in a situation that requires performance, so decoding the
1718 env variables twice should be acceptable. Note that
1719 decoding may cause a garbage collect. */
1720 Lisp_Object orig
, decoded
;
1721 orig
= make_unibyte_string (o
, strlen (o
));
1722 decoded
= DECODE_FILE (orig
);
1723 total
+= SBYTES (decoded
);
1733 /* If substitution required, recopy the string and do it */
1734 /* Make space in stack frame for the new copy */
1735 xnm
= (unsigned char *) alloca (SBYTES (filename
) + total
+ 1);
1738 /* Copy the rest of the name through, replacing $ constructs with values */
1755 while (p
!= endp
&& *p
!= '}') p
++;
1756 if (*p
!= '}') goto missingclose
;
1762 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1766 /* Copy out the variable name */
1767 target
= (unsigned char *) alloca (s
- o
+ 1);
1768 strncpy (target
, o
, s
- o
);
1771 strupr (target
); /* $home == $HOME etc. */
1774 /* Get variable value */
1775 o
= (unsigned char *) egetenv (target
);
1779 strcpy (x
, target
); x
+= strlen (target
);
1783 Lisp_Object orig
, decoded
;
1784 int orig_length
, decoded_length
;
1785 orig_length
= strlen (o
);
1786 orig
= make_unibyte_string (o
, orig_length
);
1787 decoded
= DECODE_FILE (orig
);
1788 decoded_length
= SBYTES (decoded
);
1789 strncpy (x
, SDATA (decoded
), decoded_length
);
1790 x
+= decoded_length
;
1792 /* If environment variable needed decoding, return value
1793 needs to be multibyte. */
1794 if (decoded_length
!= orig_length
1795 || strncmp (SDATA (decoded
), o
, orig_length
))
1802 /* If /~ or // appears, discard everything through first slash. */
1803 while ((p
= search_embedded_absfilename (xnm
, x
)))
1804 /* This time we do not start over because we've already expanded envvars
1805 and replaced $$ with $. Maybe we should start over as well, but we'd
1806 need to quote some $ to $$ first. */
1809 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1812 error ("Bad format environment-variable substitution");
1814 error ("Missing \"}\" in environment-variable substitution");
1816 error ("Substituting nonexistent environment variable \"%s\"", target
);
1822 /* A slightly faster and more convenient way to get
1823 (directory-file-name (expand-file-name FOO)). */
1826 expand_and_dir_to_file (filename
, defdir
)
1827 Lisp_Object filename
, defdir
;
1829 register Lisp_Object absname
;
1831 absname
= Fexpand_file_name (filename
, defdir
);
1833 /* Remove final slash, if any (unless this is the root dir).
1834 stat behaves differently depending! */
1835 if (SCHARS (absname
) > 1
1836 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1837 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
1838 /* We cannot take shortcuts; they might be wrong for magic file names. */
1839 absname
= Fdirectory_file_name (absname
);
1843 /* Signal an error if the file ABSNAME already exists.
1844 If INTERACTIVE is nonzero, ask the user whether to proceed,
1845 and bypass the error if the user says to go ahead.
1846 QUERYSTRING is a name for the action that is being considered
1849 *STATPTR is used to store the stat information if the file exists.
1850 If the file does not exist, STATPTR->st_mode is set to 0.
1851 If STATPTR is null, we don't store into it.
1853 If QUICK is nonzero, we ask for y or n, not yes or no. */
1856 barf_or_query_if_file_exists (absname
, querystring
, interactive
, statptr
, quick
)
1857 Lisp_Object absname
;
1858 unsigned char *querystring
;
1860 struct stat
*statptr
;
1863 register Lisp_Object tem
, encoded_filename
;
1864 struct stat statbuf
;
1865 struct gcpro gcpro1
;
1867 encoded_filename
= ENCODE_FILE (absname
);
1869 /* stat is a good way to tell whether the file exists,
1870 regardless of what access permissions it has. */
1871 if (lstat (SDATA (encoded_filename
), &statbuf
) >= 0)
1874 xsignal2 (Qfile_already_exists
,
1875 build_string ("File already exists"), absname
);
1877 tem
= format2 ("File %s already exists; %s anyway? ",
1878 absname
, build_string (querystring
));
1880 tem
= Fy_or_n_p (tem
);
1882 tem
= do_yes_or_no_p (tem
);
1885 xsignal2 (Qfile_already_exists
,
1886 build_string ("File already exists"), absname
);
1893 statptr
->st_mode
= 0;
1898 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 5,
1899 "fCopy file: \nGCopy %s to file: \np\nP",
1900 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1901 If NEWNAME names a directory, copy FILE there.
1903 This function always sets the file modes of the output file to match
1906 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1907 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1908 signal a `file-already-exists' error without overwriting. If
1909 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1910 about overwriting; this is what happens in interactive use with M-x.
1911 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1914 Fourth arg KEEP-TIME non-nil means give the output file the same
1915 last-modified time as the old one. (This works on only some systems.)
1917 A prefix arg makes KEEP-TIME non-nil.
1919 If PRESERVE-UID-GID is non-nil, we try to transfer the
1920 uid and gid of FILE to NEWNAME. */)
1921 (file
, newname
, ok_if_already_exists
, keep_time
, preserve_uid_gid
)
1922 Lisp_Object file
, newname
, ok_if_already_exists
, keep_time
;
1923 Lisp_Object preserve_uid_gid
;
1926 char buf
[16 * 1024];
1927 struct stat st
, out_st
;
1928 Lisp_Object handler
;
1929 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1930 int count
= SPECPDL_INDEX ();
1931 int input_file_statable_p
;
1932 Lisp_Object encoded_file
, encoded_newname
;
1934 encoded_file
= encoded_newname
= Qnil
;
1935 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1936 CHECK_STRING (file
);
1937 CHECK_STRING (newname
);
1939 if (!NILP (Ffile_directory_p (newname
)))
1940 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1942 newname
= Fexpand_file_name (newname
, Qnil
);
1944 file
= Fexpand_file_name (file
, Qnil
);
1946 /* If the input file name has special constructs in it,
1947 call the corresponding file handler. */
1948 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1949 /* Likewise for output file name. */
1951 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1952 if (!NILP (handler
))
1953 RETURN_UNGCPRO (call6 (handler
, Qcopy_file
, file
, newname
,
1954 ok_if_already_exists
, keep_time
, preserve_uid_gid
));
1956 encoded_file
= ENCODE_FILE (file
);
1957 encoded_newname
= ENCODE_FILE (newname
);
1959 if (NILP (ok_if_already_exists
)
1960 || INTEGERP (ok_if_already_exists
))
1961 barf_or_query_if_file_exists (newname
, "copy to it",
1962 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1963 else if (stat (SDATA (encoded_newname
), &out_st
) < 0)
1967 if (!CopyFile (SDATA (encoded_file
),
1968 SDATA (encoded_newname
),
1970 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1971 /* CopyFile retains the timestamp by default. */
1972 else if (NILP (keep_time
))
1978 EMACS_GET_TIME (now
);
1979 filename
= SDATA (encoded_newname
);
1981 /* Ensure file is writable while its modified time is set. */
1982 attributes
= GetFileAttributes (filename
);
1983 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1984 if (set_file_times (filename
, now
, now
))
1986 /* Restore original attributes. */
1987 SetFileAttributes (filename
, attributes
);
1988 xsignal2 (Qfile_date_error
,
1989 build_string ("Cannot set file date"), newname
);
1991 /* Restore original attributes. */
1992 SetFileAttributes (filename
, attributes
);
1994 #else /* not WINDOWSNT */
1996 ifd
= emacs_open (SDATA (encoded_file
), O_RDONLY
, 0);
2000 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2002 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2004 /* We can only copy regular files and symbolic links. Other files are not
2006 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
2008 #if !defined (MSDOS) || __DJGPP__ > 1
2009 if (out_st
.st_mode
!= 0
2010 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2013 report_file_error ("Input and output files are the same",
2014 Fcons (file
, Fcons (newname
, Qnil
)));
2018 #if defined (S_ISREG) && defined (S_ISLNK)
2019 if (input_file_statable_p
)
2021 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
2023 #if defined (EISDIR)
2024 /* Get a better looking error message. */
2027 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2030 #endif /* S_ISREG && S_ISLNK */
2033 /* System's default file type was set to binary by _fmode in emacs.c. */
2034 ofd
= emacs_open (SDATA (encoded_newname
),
2035 O_WRONLY
| O_TRUNC
| O_CREAT
2036 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2037 S_IREAD
| S_IWRITE
);
2038 #else /* not MSDOS */
2039 ofd
= emacs_open (SDATA (encoded_newname
),
2040 O_WRONLY
| O_TRUNC
| O_CREAT
2041 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2043 #endif /* not MSDOS */
2045 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2047 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2051 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2052 if (emacs_write (ofd
, buf
, n
) != n
)
2053 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2057 /* Preserve the original file modes, and if requested, also its
2059 if (input_file_statable_p
)
2061 if (! NILP (preserve_uid_gid
))
2062 fchown (ofd
, st
.st_uid
, st
.st_gid
);
2063 fchmod (ofd
, st
.st_mode
& 07777);
2065 #endif /* not MSDOS */
2067 /* Closing the output clobbers the file times on some systems. */
2068 if (emacs_close (ofd
) < 0)
2069 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2071 if (input_file_statable_p
)
2073 if (!NILP (keep_time
))
2075 EMACS_TIME atime
, mtime
;
2076 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
2077 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
2078 if (set_file_times (SDATA (encoded_newname
),
2080 xsignal2 (Qfile_date_error
,
2081 build_string ("Cannot set file date"), newname
);
2087 #if defined (__DJGPP__) && __DJGPP__ > 1
2088 if (input_file_statable_p
)
2090 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2091 and if it can't, it tells so. Otherwise, under MSDOS we usually
2092 get only the READ bit, which will make the copied file read-only,
2093 so it's better not to chmod at all. */
2094 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2095 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2097 #endif /* DJGPP version 2 or newer */
2098 #endif /* not WINDOWSNT */
2100 /* Discard the unwind protects. */
2101 specpdl_ptr
= specpdl
+ count
;
2107 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2108 Smake_directory_internal
, 1, 1, 0,
2109 doc
: /* Create a new directory named DIRECTORY. */)
2111 Lisp_Object directory
;
2113 const unsigned char *dir
;
2114 Lisp_Object handler
;
2115 Lisp_Object encoded_dir
;
2117 CHECK_STRING (directory
);
2118 directory
= Fexpand_file_name (directory
, Qnil
);
2120 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2121 if (!NILP (handler
))
2122 return call2 (handler
, Qmake_directory_internal
, directory
);
2124 encoded_dir
= ENCODE_FILE (directory
);
2126 dir
= SDATA (encoded_dir
);
2129 if (mkdir (dir
) != 0)
2131 if (mkdir (dir
, 0777) != 0)
2133 report_file_error ("Creating directory", list1 (directory
));
2138 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2139 Sdelete_directory_internal
, 1, 1, 0,
2140 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2142 Lisp_Object directory
;
2144 const unsigned char *dir
;
2145 Lisp_Object handler
;
2146 Lisp_Object encoded_dir
;
2148 CHECK_STRING (directory
);
2149 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2151 if (delete_by_moving_to_trash
)
2152 return call1 (Qmove_file_to_trash
, directory
);
2154 encoded_dir
= ENCODE_FILE (directory
);
2156 dir
= SDATA (encoded_dir
);
2158 if (rmdir (dir
) != 0)
2159 report_file_error ("Removing directory", list1 (directory
));
2164 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 1, "fDelete file: ",
2165 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2166 If file has multiple names, it continues to exist with the other names. */)
2168 Lisp_Object filename
;
2170 Lisp_Object handler
;
2171 Lisp_Object encoded_file
;
2172 struct gcpro gcpro1
;
2175 if (!NILP (Ffile_directory_p (filename
))
2176 && NILP (Ffile_symlink_p (filename
)))
2177 xsignal2 (Qfile_error
,
2178 build_string ("Removing old name: is a directory"),
2181 filename
= Fexpand_file_name (filename
, Qnil
);
2183 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2184 if (!NILP (handler
))
2185 return call2 (handler
, Qdelete_file
, filename
);
2187 if (delete_by_moving_to_trash
)
2188 return call1 (Qmove_file_to_trash
, filename
);
2190 encoded_file
= ENCODE_FILE (filename
);
2192 if (0 > unlink (SDATA (encoded_file
)))
2193 report_file_error ("Removing old name", list1 (filename
));
2198 internal_delete_file_1 (ignore
)
2204 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2207 internal_delete_file (filename
)
2208 Lisp_Object filename
;
2211 tem
= internal_condition_case_1 (Fdelete_file
, filename
,
2212 Qt
, internal_delete_file_1
);
2216 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2217 "fRename file: \nGRename %s to file: \np",
2218 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2219 If file has names other than FILE, it continues to have those names.
2220 Signals a `file-already-exists' error if a file NEWNAME already exists
2221 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2222 A number as third arg means request confirmation if NEWNAME already exists.
2223 This is what happens in interactive use with M-x. */)
2224 (file
, newname
, ok_if_already_exists
)
2225 Lisp_Object file
, newname
, ok_if_already_exists
;
2227 Lisp_Object handler
;
2228 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2229 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2231 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2232 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2233 CHECK_STRING (file
);
2234 CHECK_STRING (newname
);
2235 file
= Fexpand_file_name (file
, Qnil
);
2237 if ((!NILP (Ffile_directory_p (newname
)))
2239 /* If the file names are identical but for the case,
2240 don't attempt to move directory to itself. */
2241 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2244 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2246 newname
= Fexpand_file_name (newname
, Qnil
);
2248 /* If the file name has special constructs in it,
2249 call the corresponding file handler. */
2250 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2252 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2253 if (!NILP (handler
))
2254 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2255 file
, newname
, ok_if_already_exists
));
2257 encoded_file
= ENCODE_FILE (file
);
2258 encoded_newname
= ENCODE_FILE (newname
);
2261 /* If the file names are identical but for the case, don't ask for
2262 confirmation: they simply want to change the letter-case of the
2264 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2266 if (NILP (ok_if_already_exists
)
2267 || INTEGERP (ok_if_already_exists
))
2268 barf_or_query_if_file_exists (newname
, "rename to it",
2269 INTEGERP (ok_if_already_exists
), 0, 0);
2270 if (0 > rename (SDATA (encoded_file
), SDATA (encoded_newname
)))
2276 symlink_target
= Ffile_symlink_p (file
);
2277 if (! NILP (symlink_target
))
2278 Fmake_symbolic_link (symlink_target
, newname
,
2279 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2282 Fcopy_file (file
, newname
,
2283 /* We have already prompted if it was an integer,
2284 so don't have copy-file prompt again. */
2285 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2288 count
= SPECPDL_INDEX ();
2289 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2290 Fdelete_file (file
);
2291 unbind_to (count
, Qnil
);
2294 report_file_error ("Renaming", list2 (file
, newname
));
2300 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2301 "fAdd name to file: \nGName to add to %s: \np",
2302 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2303 Signals a `file-already-exists' error if a file NEWNAME already exists
2304 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2305 A number as third arg means request confirmation if NEWNAME already exists.
2306 This is what happens in interactive use with M-x. */)
2307 (file
, newname
, ok_if_already_exists
)
2308 Lisp_Object file
, newname
, ok_if_already_exists
;
2310 Lisp_Object handler
;
2311 Lisp_Object encoded_file
, encoded_newname
;
2312 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2314 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2315 encoded_file
= encoded_newname
= Qnil
;
2316 CHECK_STRING (file
);
2317 CHECK_STRING (newname
);
2318 file
= Fexpand_file_name (file
, Qnil
);
2320 if (!NILP (Ffile_directory_p (newname
)))
2321 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2323 newname
= Fexpand_file_name (newname
, Qnil
);
2325 /* If the file name has special constructs in it,
2326 call the corresponding file handler. */
2327 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2328 if (!NILP (handler
))
2329 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2330 newname
, ok_if_already_exists
));
2332 /* If the new name has special constructs in it,
2333 call the corresponding file handler. */
2334 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2335 if (!NILP (handler
))
2336 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2337 newname
, ok_if_already_exists
));
2339 encoded_file
= ENCODE_FILE (file
);
2340 encoded_newname
= ENCODE_FILE (newname
);
2342 if (NILP (ok_if_already_exists
)
2343 || INTEGERP (ok_if_already_exists
))
2344 barf_or_query_if_file_exists (newname
, "make it a new name",
2345 INTEGERP (ok_if_already_exists
), 0, 0);
2347 unlink (SDATA (newname
));
2348 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
)))
2349 report_file_error ("Adding new name", list2 (file
, newname
));
2355 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2356 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2357 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2358 Both args must be strings.
2359 Signals a `file-already-exists' error if a file LINKNAME already exists
2360 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2361 A number as third arg means request confirmation if LINKNAME already exists.
2362 This happens for interactive use with M-x. */)
2363 (filename
, linkname
, ok_if_already_exists
)
2364 Lisp_Object filename
, linkname
, ok_if_already_exists
;
2366 Lisp_Object handler
;
2367 Lisp_Object encoded_filename
, encoded_linkname
;
2368 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2370 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2371 encoded_filename
= encoded_linkname
= Qnil
;
2372 CHECK_STRING (filename
);
2373 CHECK_STRING (linkname
);
2374 /* If the link target has a ~, we must expand it to get
2375 a truly valid file name. Otherwise, do not expand;
2376 we want to permit links to relative file names. */
2377 if (SREF (filename
, 0) == '~')
2378 filename
= Fexpand_file_name (filename
, Qnil
);
2380 if (!NILP (Ffile_directory_p (linkname
)))
2381 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2383 linkname
= Fexpand_file_name (linkname
, Qnil
);
2385 /* If the file name has special constructs in it,
2386 call the corresponding file handler. */
2387 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2388 if (!NILP (handler
))
2389 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2390 linkname
, ok_if_already_exists
));
2392 /* If the new link name has special constructs in it,
2393 call the corresponding file handler. */
2394 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2395 if (!NILP (handler
))
2396 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2397 linkname
, ok_if_already_exists
));
2400 encoded_filename
= ENCODE_FILE (filename
);
2401 encoded_linkname
= ENCODE_FILE (linkname
);
2403 if (NILP (ok_if_already_exists
)
2404 || INTEGERP (ok_if_already_exists
))
2405 barf_or_query_if_file_exists (linkname
, "make it a link",
2406 INTEGERP (ok_if_already_exists
), 0, 0);
2407 if (0 > symlink (SDATA (encoded_filename
),
2408 SDATA (encoded_linkname
)))
2410 /* If we didn't complain already, silently delete existing file. */
2411 if (errno
== EEXIST
)
2413 unlink (SDATA (encoded_linkname
));
2414 if (0 <= symlink (SDATA (encoded_filename
),
2415 SDATA (encoded_linkname
)))
2422 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2429 xsignal1 (Qfile_error
, build_string ("Symbolic links are not supported"));
2431 #endif /* S_IFLNK */
2435 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2437 doc
: /* Return t if file FILENAME specifies an absolute file name.
2438 On Unix, this is a name starting with a `/' or a `~'. */)
2440 Lisp_Object filename
;
2442 CHECK_STRING (filename
);
2443 return file_name_absolute_p (SDATA (filename
)) ? Qt
: Qnil
;
2446 /* Return nonzero if file FILENAME exists and can be executed. */
2449 check_executable (filename
)
2453 int len
= strlen (filename
);
2456 if (stat (filename
, &st
) < 0)
2458 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
2459 return ((st
.st_mode
& S_IEXEC
) != 0);
2461 return (S_ISREG (st
.st_mode
)
2463 && (xstrcasecmp ((suffix
= filename
+ len
-4), ".com") == 0
2464 || xstrcasecmp (suffix
, ".exe") == 0
2465 || xstrcasecmp (suffix
, ".bat") == 0)
2466 || (st
.st_mode
& S_IFMT
) == S_IFDIR
);
2467 #endif /* not WINDOWSNT */
2468 #else /* not DOS_NT */
2469 #ifdef HAVE_EUIDACCESS
2470 return (euidaccess (filename
, 1) >= 0);
2472 /* Access isn't quite right because it uses the real uid
2473 and we really want to test with the effective uid.
2474 But Unix doesn't give us a right way to do it. */
2475 return (access (filename
, 1) >= 0);
2477 #endif /* not DOS_NT */
2480 /* Return nonzero if file FILENAME exists and can be written. */
2483 check_writable (filename
)
2488 if (stat (filename
, &st
) < 0)
2490 return (st
.st_mode
& S_IWRITE
|| (st
.st_mode
& S_IFMT
) == S_IFDIR
);
2491 #else /* not MSDOS */
2492 #ifdef HAVE_EUIDACCESS
2493 return (euidaccess (filename
, 2) >= 0);
2495 /* Access isn't quite right because it uses the real uid
2496 and we really want to test with the effective uid.
2497 But Unix doesn't give us a right way to do it.
2498 Opening with O_WRONLY could work for an ordinary file,
2499 but would lose for directories. */
2500 return (access (filename
, 2) >= 0);
2502 #endif /* not MSDOS */
2505 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2506 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2507 See also `file-readable-p' and `file-attributes'.
2508 This returns nil for a symlink to a nonexistent file.
2509 Use `file-symlink-p' to test for such links. */)
2511 Lisp_Object filename
;
2513 Lisp_Object absname
;
2514 Lisp_Object handler
;
2515 struct stat statbuf
;
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_exists_p
);
2523 if (!NILP (handler
))
2524 return call2 (handler
, Qfile_exists_p
, absname
);
2526 absname
= ENCODE_FILE (absname
);
2528 return (stat (SDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2531 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2532 doc
: /* Return t if FILENAME can be executed by you.
2533 For a directory, this means you can access files in that directory. */)
2535 Lisp_Object filename
;
2537 Lisp_Object absname
;
2538 Lisp_Object handler
;
2540 CHECK_STRING (filename
);
2541 absname
= Fexpand_file_name (filename
, Qnil
);
2543 /* If the file name has special constructs in it,
2544 call the corresponding file handler. */
2545 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2546 if (!NILP (handler
))
2547 return call2 (handler
, Qfile_executable_p
, absname
);
2549 absname
= ENCODE_FILE (absname
);
2551 return (check_executable (SDATA (absname
)) ? Qt
: Qnil
);
2554 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2555 doc
: /* Return t if file FILENAME exists and you can read it.
2556 See also `file-exists-p' and `file-attributes'. */)
2558 Lisp_Object filename
;
2560 Lisp_Object absname
;
2561 Lisp_Object handler
;
2564 struct stat statbuf
;
2566 CHECK_STRING (filename
);
2567 absname
= Fexpand_file_name (filename
, Qnil
);
2569 /* If the file name has special constructs in it,
2570 call the corresponding file handler. */
2571 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2572 if (!NILP (handler
))
2573 return call2 (handler
, Qfile_readable_p
, absname
);
2575 absname
= ENCODE_FILE (absname
);
2577 #if defined(DOS_NT) || defined(macintosh)
2578 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2580 if (access (SDATA (absname
), 0) == 0)
2583 #else /* not DOS_NT and not macintosh */
2585 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
2586 /* Opening a fifo without O_NONBLOCK can wait.
2587 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2588 except in the case of a fifo, on a system which handles it. */
2589 desc
= stat (SDATA (absname
), &statbuf
);
2592 if (S_ISFIFO (statbuf
.st_mode
))
2593 flags
|= O_NONBLOCK
;
2595 desc
= emacs_open (SDATA (absname
), flags
, 0);
2600 #endif /* not DOS_NT and not macintosh */
2603 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2605 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2606 doc
: /* Return t if file FILENAME can be written or created by you. */)
2608 Lisp_Object filename
;
2610 Lisp_Object absname
, dir
, encoded
;
2611 Lisp_Object handler
;
2612 struct stat statbuf
;
2614 CHECK_STRING (filename
);
2615 absname
= Fexpand_file_name (filename
, Qnil
);
2617 /* If the file name has special constructs in it,
2618 call the corresponding file handler. */
2619 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2620 if (!NILP (handler
))
2621 return call2 (handler
, Qfile_writable_p
, absname
);
2623 encoded
= ENCODE_FILE (absname
);
2624 if (stat (SDATA (encoded
), &statbuf
) >= 0)
2625 return (check_writable (SDATA (encoded
))
2628 dir
= Ffile_name_directory (absname
);
2631 dir
= Fdirectory_file_name (dir
);
2634 dir
= ENCODE_FILE (dir
);
2636 /* The read-only attribute of the parent directory doesn't affect
2637 whether a file or directory can be created within it. Some day we
2638 should check ACLs though, which do affect this. */
2639 if (stat (SDATA (dir
), &statbuf
) < 0)
2641 return (statbuf
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2643 return (check_writable (!NILP (dir
) ? (char *) SDATA (dir
) : "")
2648 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2649 doc
: /* Access file FILENAME, and get an error if that does not work.
2650 The second argument STRING is used in the error message.
2651 If there is no error, returns nil. */)
2653 Lisp_Object filename
, string
;
2655 Lisp_Object handler
, encoded_filename
, absname
;
2658 CHECK_STRING (filename
);
2659 absname
= Fexpand_file_name (filename
, Qnil
);
2661 CHECK_STRING (string
);
2663 /* If the file name has special constructs in it,
2664 call the corresponding file handler. */
2665 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2666 if (!NILP (handler
))
2667 return call3 (handler
, Qaccess_file
, absname
, string
);
2669 encoded_filename
= ENCODE_FILE (absname
);
2671 fd
= emacs_open (SDATA (encoded_filename
), O_RDONLY
, 0);
2673 report_file_error (SDATA (string
), Fcons (filename
, Qnil
));
2679 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2680 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2681 The value is the link target, as a string.
2682 Otherwise it returns nil.
2684 This function returns t when given the name of a symlink that
2685 points to a nonexistent file. */)
2687 Lisp_Object filename
;
2689 Lisp_Object handler
;
2691 CHECK_STRING (filename
);
2692 filename
= Fexpand_file_name (filename
, Qnil
);
2694 /* If the file name has special constructs in it,
2695 call the corresponding file handler. */
2696 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2697 if (!NILP (handler
))
2698 return call2 (handler
, Qfile_symlink_p
, filename
);
2707 filename
= ENCODE_FILE (filename
);
2714 buf
= (char *) xrealloc (buf
, bufsize
);
2715 bzero (buf
, bufsize
);
2718 valsize
= readlink (SDATA (filename
), buf
, bufsize
);
2722 /* HP-UX reports ERANGE if buffer is too small. */
2723 if (errno
== ERANGE
)
2733 while (valsize
>= bufsize
);
2735 val
= make_string (buf
, valsize
);
2736 if (buf
[0] == '/' && index (buf
, ':'))
2737 val
= concat2 (build_string ("/:"), val
);
2739 val
= DECODE_FILE (val
);
2742 #else /* not S_IFLNK */
2744 #endif /* not S_IFLNK */
2747 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2748 doc
: /* Return t if FILENAME names an existing directory.
2749 Symbolic links to directories count as directories.
2750 See `file-symlink-p' to distinguish symlinks. */)
2752 Lisp_Object filename
;
2754 register Lisp_Object absname
;
2756 Lisp_Object handler
;
2758 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2760 /* If the file name has special constructs in it,
2761 call the corresponding file handler. */
2762 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2763 if (!NILP (handler
))
2764 return call2 (handler
, Qfile_directory_p
, absname
);
2766 absname
= ENCODE_FILE (absname
);
2768 if (stat (SDATA (absname
), &st
) < 0)
2770 return (st
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2773 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
2774 doc
: /* Return t if file FILENAME names a directory you can open.
2775 For the value to be t, FILENAME must specify the name of a directory as a file,
2776 and the directory must allow you to open files in it. In order to use a
2777 directory as a buffer's current directory, this predicate must return true.
2778 A directory name spec may be given instead; then the value is t
2779 if the directory so specified exists and really is a readable and
2780 searchable directory. */)
2782 Lisp_Object filename
;
2784 Lisp_Object handler
;
2786 struct gcpro gcpro1
;
2788 /* If the file name has special constructs in it,
2789 call the corresponding file handler. */
2790 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2791 if (!NILP (handler
))
2792 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2795 tem
= (NILP (Ffile_directory_p (filename
))
2796 || NILP (Ffile_executable_p (filename
)));
2798 return tem
? Qnil
: Qt
;
2801 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2802 doc
: /* Return t if FILENAME names a regular file.
2803 This is the sort of file that holds an ordinary stream of data bytes.
2804 Symbolic links to regular files count as regular files.
2805 See `file-symlink-p' to distinguish symlinks. */)
2807 Lisp_Object filename
;
2809 register Lisp_Object absname
;
2811 Lisp_Object handler
;
2813 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2815 /* If the file name has special constructs in it,
2816 call the corresponding file handler. */
2817 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2818 if (!NILP (handler
))
2819 return call2 (handler
, Qfile_regular_p
, absname
);
2821 absname
= ENCODE_FILE (absname
);
2826 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2828 /* Tell stat to use expensive method to get accurate info. */
2829 Vw32_get_true_file_attributes
= Qt
;
2830 result
= stat (SDATA (absname
), &st
);
2831 Vw32_get_true_file_attributes
= tem
;
2835 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2838 if (stat (SDATA (absname
), &st
) < 0)
2840 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2844 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2845 doc
: /* Return mode bits of file named FILENAME, as an integer.
2846 Return nil, if file does not exist or is not accessible. */)
2848 Lisp_Object filename
;
2850 Lisp_Object absname
;
2852 Lisp_Object handler
;
2854 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2856 /* If the file name has special constructs in it,
2857 call the corresponding file handler. */
2858 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2859 if (!NILP (handler
))
2860 return call2 (handler
, Qfile_modes
, absname
);
2862 absname
= ENCODE_FILE (absname
);
2864 if (stat (SDATA (absname
), &st
) < 0)
2866 #if defined (MSDOS) && __DJGPP__ < 2
2867 if (check_executable (SDATA (absname
)))
2868 st
.st_mode
|= S_IEXEC
;
2869 #endif /* MSDOS && __DJGPP__ < 2 */
2871 return make_number (st
.st_mode
& 07777);
2874 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2875 "(let ((file (read-file-name \"File: \"))) \
2876 (list file (read-file-modes nil file)))",
2877 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2878 Only the 12 low bits of MODE are used.
2880 Interactively, mode bits are read by `read-file-modes', which accepts
2881 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2883 Lisp_Object filename
, mode
;
2885 Lisp_Object absname
, encoded_absname
;
2886 Lisp_Object handler
;
2888 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2889 CHECK_NUMBER (mode
);
2891 /* If the file name has special constructs in it,
2892 call the corresponding file handler. */
2893 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2894 if (!NILP (handler
))
2895 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2897 encoded_absname
= ENCODE_FILE (absname
);
2899 if (chmod (SDATA (encoded_absname
), XINT (mode
)) < 0)
2900 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2905 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2906 doc
: /* Set the file permission bits for newly created files.
2907 The argument MODE should be an integer; only the low 9 bits are used.
2908 This setting is inherited by subprocesses. */)
2912 CHECK_NUMBER (mode
);
2914 umask ((~ XINT (mode
)) & 0777);
2919 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
2920 doc
: /* Return the default file protection for created files.
2921 The value is an integer. */)
2927 realmask
= umask (0);
2930 XSETINT (value
, (~ realmask
) & 0777);
2934 extern int lisp_time_argument
P_ ((Lisp_Object
, time_t *, int *));
2936 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
2937 doc
: /* Set times of file FILENAME to TIME.
2938 Set both access and modification times.
2939 Return t on success, else nil.
2940 Use the current time if TIME is nil. TIME is in the format of
2943 Lisp_Object filename
, time
;
2945 Lisp_Object absname
, encoded_absname
;
2946 Lisp_Object handler
;
2950 if (! lisp_time_argument (time
, &sec
, &usec
))
2951 error ("Invalid time specification");
2953 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2955 /* If the file name has special constructs in it,
2956 call the corresponding file handler. */
2957 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
2958 if (!NILP (handler
))
2959 return call3 (handler
, Qset_file_times
, absname
, time
);
2961 encoded_absname
= ENCODE_FILE (absname
);
2966 EMACS_SET_SECS (t
, sec
);
2967 EMACS_SET_USECS (t
, usec
);
2969 if (set_file_times (SDATA (encoded_absname
), t
, t
))
2974 /* Setting times on a directory always fails. */
2975 if (stat (SDATA (encoded_absname
), &st
) == 0
2976 && (st
.st_mode
& S_IFMT
) == S_IFDIR
)
2979 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
2988 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
2989 doc
: /* Tell Unix to finish all pending disk updates. */)
2996 #endif /* HAVE_SYNC */
2998 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
2999 doc
: /* Return t if file FILE1 is newer than file FILE2.
3000 If FILE1 does not exist, the answer is nil;
3001 otherwise, if FILE2 does not exist, the answer is t. */)
3003 Lisp_Object file1
, file2
;
3005 Lisp_Object absname1
, absname2
;
3008 Lisp_Object handler
;
3009 struct gcpro gcpro1
, gcpro2
;
3011 CHECK_STRING (file1
);
3012 CHECK_STRING (file2
);
3015 GCPRO2 (absname1
, file2
);
3016 absname1
= expand_and_dir_to_file (file1
, current_buffer
->directory
);
3017 absname2
= expand_and_dir_to_file (file2
, current_buffer
->directory
);
3020 /* If the file name has special constructs in it,
3021 call the corresponding file handler. */
3022 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3024 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3025 if (!NILP (handler
))
3026 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3028 GCPRO2 (absname1
, absname2
);
3029 absname1
= ENCODE_FILE (absname1
);
3030 absname2
= ENCODE_FILE (absname2
);
3033 if (stat (SDATA (absname1
), &st
) < 0)
3036 mtime1
= st
.st_mtime
;
3038 if (stat (SDATA (absname2
), &st
) < 0)
3041 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3045 Lisp_Object Qfind_buffer_file_type
;
3048 #ifndef READ_BUF_SIZE
3049 #define READ_BUF_SIZE (64 << 10)
3052 /* This function is called after Lisp functions to decide a coding
3053 system are called, or when they cause an error. Before they are
3054 called, the current buffer is set unibyte and it contains only a
3055 newly inserted text (thus the buffer was empty before the
3058 The functions may set markers, overlays, text properties, or even
3059 alter the buffer contents, change the current buffer.
3061 Here, we reset all those changes by:
3062 o set back the current buffer.
3063 o move all markers and overlays to BEG.
3064 o remove all text properties.
3065 o set back the buffer multibyteness. */
3068 decide_coding_unwind (unwind_data
)
3069 Lisp_Object unwind_data
;
3071 Lisp_Object multibyte
, undo_list
, buffer
;
3073 multibyte
= XCAR (unwind_data
);
3074 unwind_data
= XCDR (unwind_data
);
3075 undo_list
= XCAR (unwind_data
);
3076 buffer
= XCDR (unwind_data
);
3078 if (current_buffer
!= XBUFFER (buffer
))
3079 set_buffer_internal (XBUFFER (buffer
));
3080 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3081 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3082 BUF_INTERVALS (current_buffer
) = 0;
3083 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3085 /* Now we are safe to change the buffer's multibyteness directly. */
3086 current_buffer
->enable_multibyte_characters
= multibyte
;
3087 current_buffer
->undo_list
= undo_list
;
3093 /* Used to pass values from insert-file-contents to read_non_regular. */
3095 static int non_regular_fd
;
3096 static EMACS_INT non_regular_inserted
;
3097 static EMACS_INT non_regular_nbytes
;
3100 /* Read from a non-regular file.
3101 Read non_regular_trytry bytes max from non_regular_fd.
3102 Non_regular_inserted specifies where to put the read bytes.
3103 Value is the number of bytes read. */
3112 nbytes
= emacs_read (non_regular_fd
,
3113 BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ non_regular_inserted
,
3114 non_regular_nbytes
);
3116 return make_number (nbytes
);
3120 /* Condition-case handler used when reading from non-regular files
3121 in insert-file-contents. */
3124 read_non_regular_quit ()
3130 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3132 doc
: /* Insert contents of file FILENAME after point.
3133 Returns list of absolute file name and number of characters inserted.
3134 If second argument VISIT is non-nil, the buffer's visited filename and
3135 last save file modtime are set, and it is marked unmodified. If
3136 visiting and the file does not exist, visiting is completed before the
3139 The optional third and fourth arguments BEG and END specify what portion
3140 of the file to insert. These arguments count bytes in the file, not
3141 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3143 If optional fifth argument REPLACE is non-nil, replace the current
3144 buffer contents (in the accessible portion) with the file contents.
3145 This is better than simply deleting and inserting the whole thing
3146 because (1) it preserves some marker positions and (2) it puts less data
3147 in the undo list. When REPLACE is non-nil, the second return value is
3148 the number of characters that replace previous buffer contents.
3150 This function does code conversion according to the value of
3151 `coding-system-for-read' or `file-coding-system-alist', and sets the
3152 variable `last-coding-system-used' to the coding system actually used. */)
3153 (filename
, visit
, beg
, end
, replace
)
3154 Lisp_Object filename
, visit
, beg
, end
, replace
;
3158 EMACS_INT inserted
= 0;
3160 register EMACS_INT how_much
;
3161 register EMACS_INT unprocessed
;
3162 int count
= SPECPDL_INDEX ();
3163 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3164 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3166 EMACS_INT total
= 0;
3167 int not_regular
= 0;
3168 unsigned char read_buf
[READ_BUF_SIZE
];
3169 struct coding_system coding
;
3170 unsigned char buffer
[1 << 14];
3171 int replace_handled
= 0;
3172 int set_coding_system
= 0;
3173 Lisp_Object coding_system
;
3175 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3176 int we_locked_file
= 0;
3177 int deferred_remove_unwind_protect
= 0;
3179 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3180 error ("Cannot do file visiting in an indirect buffer");
3182 if (!NILP (current_buffer
->read_only
))
3183 Fbarf_if_buffer_read_only ();
3187 orig_filename
= Qnil
;
3190 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3192 CHECK_STRING (filename
);
3193 filename
= Fexpand_file_name (filename
, Qnil
);
3195 /* The value Qnil means that the coding system is not yet
3197 coding_system
= Qnil
;
3199 /* If the file name has special constructs in it,
3200 call the corresponding file handler. */
3201 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3202 if (!NILP (handler
))
3204 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3205 visit
, beg
, end
, replace
);
3206 if (CONSP (val
) && CONSP (XCDR (val
)))
3207 inserted
= XINT (XCAR (XCDR (val
)));
3211 orig_filename
= filename
;
3212 filename
= ENCODE_FILE (filename
);
3218 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3220 /* Tell stat to use expensive method to get accurate info. */
3221 Vw32_get_true_file_attributes
= Qt
;
3222 total
= stat (SDATA (filename
), &st
);
3223 Vw32_get_true_file_attributes
= tem
;
3227 if (stat (SDATA (filename
), &st
) < 0)
3228 #endif /* WINDOWSNT */
3230 if (fd
>= 0) emacs_close (fd
);
3233 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3236 if (!NILP (Vcoding_system_for_read
))
3237 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3242 /* This code will need to be changed in order to work on named
3243 pipes, and it's probably just not worth it. So we should at
3244 least signal an error. */
3245 if (!S_ISREG (st
.st_mode
))
3252 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3253 xsignal2 (Qfile_error
,
3254 build_string ("not a regular file"), orig_filename
);
3259 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0)
3262 /* Replacement should preserve point as it preserves markers. */
3263 if (!NILP (replace
))
3264 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3266 record_unwind_protect (close_file_unwind
, make_number (fd
));
3268 /* Can happen on any platform that uses long as type of off_t, but allows
3269 file sizes to exceed 2Gb, so give a suitable message. */
3270 if (! not_regular
&& st
.st_size
< 0)
3271 error ("Maximum buffer size exceeded");
3273 /* Prevent redisplay optimizations. */
3274 current_buffer
->clip_changed
= 1;
3278 if (!NILP (beg
) || !NILP (end
))
3279 error ("Attempt to visit less than an entire file");
3280 if (BEG
< Z
&& NILP (replace
))
3281 error ("Cannot do file visiting in a non-empty buffer");
3287 XSETFASTINT (beg
, 0);
3295 XSETINT (end
, st
.st_size
);
3297 /* Arithmetic overflow can occur if an Emacs integer cannot
3298 represent the file size, or if the calculations below
3299 overflow. The calculations below double the file size
3300 twice, so check that it can be multiplied by 4 safely. */
3301 if (XINT (end
) != st
.st_size
3302 /* Actually, it should test either INT_MAX or LONG_MAX
3303 depending on which one is used for EMACS_INT. But in
3304 any case, in practice, this test is redundant with the
3306 || st.st_size > INT_MAX / 4 */)
3307 error ("Maximum buffer size exceeded");
3309 /* The file size returned from stat may be zero, but data
3310 may be readable nonetheless, for example when this is a
3311 file in the /proc filesystem. */
3312 if (st
.st_size
== 0)
3313 XSETINT (end
, READ_BUF_SIZE
);
3317 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3319 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3320 setup_coding_system (coding_system
, &coding
);
3321 /* Ensure we set Vlast_coding_system_used. */
3322 set_coding_system
= 1;
3326 /* Decide the coding system to use for reading the file now
3327 because we can't use an optimized method for handling
3328 `coding:' tag if the current buffer is not empty. */
3329 if (!NILP (Vcoding_system_for_read
))
3330 coding_system
= Vcoding_system_for_read
;
3333 /* Don't try looking inside a file for a coding system
3334 specification if it is not seekable. */
3335 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3337 /* Find a coding system specified in the heading two
3338 lines or in the tailing several lines of the file.
3339 We assume that the 1K-byte and 3K-byte for heading
3340 and tailing respectively are sufficient for this
3344 if (st
.st_size
<= (1024 * 4))
3345 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3348 nread
= emacs_read (fd
, read_buf
, 1024);
3351 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3352 report_file_error ("Setting file position",
3353 Fcons (orig_filename
, Qnil
));
3354 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3359 error ("IO error reading %s: %s",
3360 SDATA (orig_filename
), emacs_strerror (errno
));
3363 struct buffer
*prev
= current_buffer
;
3367 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3369 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3370 buf
= XBUFFER (buffer
);
3372 delete_all_overlays (buf
);
3373 buf
->directory
= current_buffer
->directory
;
3374 buf
->read_only
= Qnil
;
3375 buf
->filename
= Qnil
;
3376 buf
->undo_list
= Qt
;
3377 eassert (buf
->overlays_before
== NULL
);
3378 eassert (buf
->overlays_after
== NULL
);
3380 set_buffer_internal (buf
);
3382 buf
->enable_multibyte_characters
= Qnil
;
3384 insert_1_both (read_buf
, nread
, nread
, 0, 0, 0);
3385 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3386 coding_system
= call2 (Vset_auto_coding_function
,
3387 filename
, make_number (nread
));
3388 set_buffer_internal (prev
);
3390 /* Discard the unwind protect for recovering the
3394 /* Rewind the file for the actual read done later. */
3395 if (lseek (fd
, 0, 0) < 0)
3396 report_file_error ("Setting file position",
3397 Fcons (orig_filename
, Qnil
));
3401 if (NILP (coding_system
))
3403 /* If we have not yet decided a coding system, check
3404 file-coding-system-alist. */
3405 Lisp_Object args
[6];
3407 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3408 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3409 coding_system
= Ffind_operation_coding_system (6, args
);
3410 if (CONSP (coding_system
))
3411 coding_system
= XCAR (coding_system
);
3415 if (NILP (coding_system
))
3416 coding_system
= Qundecided
;
3418 CHECK_CODING_SYSTEM (coding_system
);
3420 if (NILP (current_buffer
->enable_multibyte_characters
))
3421 /* We must suppress all character code conversion except for
3422 end-of-line conversion. */
3423 coding_system
= raw_text_coding_system (coding_system
);
3425 setup_coding_system (coding_system
, &coding
);
3426 /* Ensure we set Vlast_coding_system_used. */
3427 set_coding_system
= 1;
3430 /* If requested, replace the accessible part of the buffer
3431 with the file contents. Avoid replacing text at the
3432 beginning or end of the buffer that matches the file contents;
3433 that preserves markers pointing to the unchanged parts.
3435 Here we implement this feature in an optimized way
3436 for the case where code conversion is NOT needed.
3437 The following if-statement handles the case of conversion
3438 in a less optimal way.
3440 If the code conversion is "automatic" then we try using this
3441 method and hope for the best.
3442 But if we discover the need for conversion, we give up on this method
3443 and let the following if-statement handle the replace job. */
3446 && (NILP (coding_system
)
3447 || ! CODING_REQUIRE_DECODING (&coding
)))
3449 /* same_at_start and same_at_end count bytes,
3450 because file access counts bytes
3451 and BEG and END count bytes. */
3452 EMACS_INT same_at_start
= BEGV_BYTE
;
3453 EMACS_INT same_at_end
= ZV_BYTE
;
3455 /* There is still a possibility we will find the need to do code
3456 conversion. If that happens, we set this variable to 1 to
3457 give up on handling REPLACE in the optimized way. */
3458 int giveup_match_end
= 0;
3460 if (XINT (beg
) != 0)
3462 if (lseek (fd
, XINT (beg
), 0) < 0)
3463 report_file_error ("Setting file position",
3464 Fcons (orig_filename
, Qnil
));
3469 /* Count how many chars at the start of the file
3470 match the text at the beginning of the buffer. */
3473 EMACS_INT nread
, bufpos
;
3475 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3477 error ("IO error reading %s: %s",
3478 SDATA (orig_filename
), emacs_strerror (errno
));
3479 else if (nread
== 0)
3482 if (CODING_REQUIRE_DETECTION (&coding
))
3484 coding_system
= detect_coding_system (buffer
, nread
, nread
, 1, 0,
3486 setup_coding_system (coding_system
, &coding
);
3489 if (CODING_REQUIRE_DECODING (&coding
))
3490 /* We found that the file should be decoded somehow.
3491 Let's give up here. */
3493 giveup_match_end
= 1;
3498 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3499 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3500 same_at_start
++, bufpos
++;
3501 /* If we found a discrepancy, stop the scan.
3502 Otherwise loop around and scan the next bufferful. */
3503 if (bufpos
!= nread
)
3507 /* If the file matches the buffer completely,
3508 there's no need to replace anything. */
3509 if (same_at_start
- BEGV_BYTE
== XINT (end
))
3513 /* Truncate the buffer to the size of the file. */
3514 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3519 /* Count how many chars at the end of the file
3520 match the text at the end of the buffer. But, if we have
3521 already found that decoding is necessary, don't waste time. */
3522 while (!giveup_match_end
)
3524 EMACS_INT total_read
, nread
, bufpos
, curpos
, trial
;
3526 /* At what file position are we now scanning? */
3527 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
3528 /* If the entire file matches the buffer tail, stop the scan. */
3531 /* How much can we scan in the next step? */
3532 trial
= min (curpos
, sizeof buffer
);
3533 if (lseek (fd
, curpos
- trial
, 0) < 0)
3534 report_file_error ("Setting file position",
3535 Fcons (orig_filename
, Qnil
));
3537 total_read
= nread
= 0;
3538 while (total_read
< trial
)
3540 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3542 error ("IO error reading %s: %s",
3543 SDATA (orig_filename
), emacs_strerror (errno
));
3544 else if (nread
== 0)
3546 total_read
+= nread
;
3549 /* Scan this bufferful from the end, comparing with
3550 the Emacs buffer. */
3551 bufpos
= total_read
;
3553 /* Compare with same_at_start to avoid counting some buffer text
3554 as matching both at the file's beginning and at the end. */
3555 while (bufpos
> 0 && same_at_end
> same_at_start
3556 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3557 same_at_end
--, bufpos
--;
3559 /* If we found a discrepancy, stop the scan.
3560 Otherwise loop around and scan the preceding bufferful. */
3563 /* If this discrepancy is because of code conversion,
3564 we cannot use this method; giveup and try the other. */
3565 if (same_at_end
> same_at_start
3566 && FETCH_BYTE (same_at_end
- 1) >= 0200
3567 && ! NILP (current_buffer
->enable_multibyte_characters
)
3568 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3569 giveup_match_end
= 1;
3578 if (! giveup_match_end
)
3582 /* We win! We can handle REPLACE the optimized way. */
3584 /* Extend the start of non-matching text area to multibyte
3585 character boundary. */
3586 if (! NILP (current_buffer
->enable_multibyte_characters
))
3587 while (same_at_start
> BEGV_BYTE
3588 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3591 /* Extend the end of non-matching text area to multibyte
3592 character boundary. */
3593 if (! NILP (current_buffer
->enable_multibyte_characters
))
3594 while (same_at_end
< ZV_BYTE
3595 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3598 /* Don't try to reuse the same piece of text twice. */
3599 overlap
= (same_at_start
- BEGV_BYTE
3600 - (same_at_end
+ st
.st_size
- ZV
));
3602 same_at_end
+= overlap
;
3604 /* Arrange to read only the nonmatching middle part of the file. */
3605 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
3606 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
3608 del_range_byte (same_at_start
, same_at_end
, 0);
3609 /* Insert from the file at the proper position. */
3610 temp
= BYTE_TO_CHAR (same_at_start
);
3611 SET_PT_BOTH (temp
, same_at_start
);
3613 /* If display currently starts at beginning of line,
3614 keep it that way. */
3615 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3616 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3618 replace_handled
= 1;
3622 /* If requested, replace the accessible part of the buffer
3623 with the file contents. Avoid replacing text at the
3624 beginning or end of the buffer that matches the file contents;
3625 that preserves markers pointing to the unchanged parts.
3627 Here we implement this feature for the case where code conversion
3628 is needed, in a simple way that needs a lot of memory.
3629 The preceding if-statement handles the case of no conversion
3630 in a more optimized way. */
3631 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3633 EMACS_INT same_at_start
= BEGV_BYTE
;
3634 EMACS_INT same_at_end
= ZV_BYTE
;
3635 EMACS_INT same_at_start_charpos
;
3636 EMACS_INT inserted_chars
;
3639 unsigned char *decoded
;
3641 int this_count
= SPECPDL_INDEX ();
3642 int multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
3643 Lisp_Object conversion_buffer
;
3645 conversion_buffer
= code_conversion_save (1, multibyte
);
3647 /* First read the whole file, performing code conversion into
3648 CONVERSION_BUFFER. */
3650 if (lseek (fd
, XINT (beg
), 0) < 0)
3651 report_file_error ("Setting file position",
3652 Fcons (orig_filename
, Qnil
));
3654 total
= st
.st_size
; /* Total bytes in the file. */
3655 how_much
= 0; /* Bytes read from file so far. */
3656 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3657 unprocessed
= 0; /* Bytes not processed in previous loop. */
3659 GCPRO1 (conversion_buffer
);
3660 while (how_much
< total
)
3662 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3663 quitting while reading a huge while. */
3664 /* try is reserved in some compilers (Microsoft C) */
3665 EMACS_INT trytry
= min (total
- how_much
,
3666 READ_BUF_SIZE
- unprocessed
);
3669 /* Allow quitting out of the actual I/O. */
3672 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3684 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3685 BUF_Z (XBUFFER (conversion_buffer
)));
3686 decode_coding_c_string (&coding
, read_buf
, unprocessed
+ this,
3688 unprocessed
= coding
.carryover_bytes
;
3689 if (coding
.carryover_bytes
> 0)
3690 bcopy (coding
.carryover
, read_buf
, unprocessed
);
3695 /* We should remove the unwind_protect calling
3696 close_file_unwind, but other stuff has been added the stack,
3697 so defer the removal till we reach the `handled' label. */
3698 deferred_remove_unwind_protect
= 1;
3700 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3701 if we couldn't read the file. */
3704 error ("IO error reading %s: %s",
3705 SDATA (orig_filename
), emacs_strerror (errno
));
3707 if (unprocessed
> 0)
3709 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3710 decode_coding_c_string (&coding
, read_buf
, unprocessed
,
3712 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3715 coding_system
= CODING_ID_NAME (coding
.id
);
3716 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3717 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3718 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3720 /* Compare the beginning of the converted string with the buffer
3724 while (bufpos
< inserted
&& same_at_start
< same_at_end
3725 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3726 same_at_start
++, bufpos
++;
3728 /* If the file matches the head of buffer completely,
3729 there's no need to replace anything. */
3731 if (bufpos
== inserted
)
3733 /* Truncate the buffer to the size of the file. */
3734 if (same_at_start
== same_at_end
)
3737 del_range_byte (same_at_start
, same_at_end
, 0);
3740 unbind_to (this_count
, Qnil
);
3744 /* Extend the start of non-matching text area to the previous
3745 multibyte character boundary. */
3746 if (! NILP (current_buffer
->enable_multibyte_characters
))
3747 while (same_at_start
> BEGV_BYTE
3748 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3751 /* Scan this bufferful from the end, comparing with
3752 the Emacs buffer. */
3755 /* Compare with same_at_start to avoid counting some buffer text
3756 as matching both at the file's beginning and at the end. */
3757 while (bufpos
> 0 && same_at_end
> same_at_start
3758 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3759 same_at_end
--, bufpos
--;
3761 /* Extend the end of non-matching text area to the next
3762 multibyte character boundary. */
3763 if (! NILP (current_buffer
->enable_multibyte_characters
))
3764 while (same_at_end
< ZV_BYTE
3765 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3768 /* Don't try to reuse the same piece of text twice. */
3769 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3771 same_at_end
+= overlap
;
3773 /* If display currently starts at beginning of line,
3774 keep it that way. */
3775 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3776 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3778 /* Replace the chars that we need to replace,
3779 and update INSERTED to equal the number of bytes
3780 we are taking from the decoded string. */
3781 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3783 if (same_at_end
!= same_at_start
)
3785 del_range_byte (same_at_start
, same_at_end
, 0);
3787 same_at_start
= GPT_BYTE
;
3791 temp
= BYTE_TO_CHAR (same_at_start
);
3793 /* Insert from the file at the proper position. */
3794 SET_PT_BOTH (temp
, same_at_start
);
3795 same_at_start_charpos
3796 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3797 same_at_start
- BEGV_BYTE
3798 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3800 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3801 same_at_start
+ inserted
- BEGV_BYTE
3802 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3803 - same_at_start_charpos
);
3804 /* This binding is to avoid ask-user-about-supersession-threat
3805 being called in insert_from_buffer (via in
3806 prepare_to_modify_buffer). */
3807 specbind (intern ("buffer-file-name"), Qnil
);
3808 insert_from_buffer (XBUFFER (conversion_buffer
),
3809 same_at_start_charpos
, inserted_chars
, 0);
3810 /* Set `inserted' to the number of inserted characters. */
3811 inserted
= PT
- temp
;
3812 /* Set point before the inserted characters. */
3813 SET_PT_BOTH (temp
, same_at_start
);
3815 unbind_to (this_count
, Qnil
);
3822 register Lisp_Object temp
;
3824 total
= XINT (end
) - XINT (beg
);
3826 /* Make sure point-max won't overflow after this insertion. */
3827 XSETINT (temp
, total
);
3828 if (total
!= XINT (temp
))
3829 error ("Maximum buffer size exceeded");
3832 /* For a special file, all we can do is guess. */
3833 total
= READ_BUF_SIZE
;
3835 if (NILP (visit
) && inserted
> 0)
3837 #ifdef CLASH_DETECTION
3838 if (!NILP (current_buffer
->file_truename
)
3839 /* Make binding buffer-file-name to nil effective. */
3840 && !NILP (current_buffer
->filename
)
3841 && SAVE_MODIFF
>= MODIFF
)
3843 #endif /* CLASH_DETECTION */
3844 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3848 if (GAP_SIZE
< total
)
3849 make_gap (total
- GAP_SIZE
);
3851 if (XINT (beg
) != 0 || !NILP (replace
))
3853 if (lseek (fd
, XINT (beg
), 0) < 0)
3854 report_file_error ("Setting file position",
3855 Fcons (orig_filename
, Qnil
));
3858 /* In the following loop, HOW_MUCH contains the total bytes read so
3859 far for a regular file, and not changed for a special file. But,
3860 before exiting the loop, it is set to a negative value if I/O
3864 /* Total bytes inserted. */
3867 /* Here, we don't do code conversion in the loop. It is done by
3868 decode_coding_gap after all data are read into the buffer. */
3870 EMACS_INT gap_size
= GAP_SIZE
;
3872 while (how_much
< total
)
3874 /* try is reserved in some compilers (Microsoft C) */
3875 EMACS_INT trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3882 /* Maybe make more room. */
3883 if (gap_size
< trytry
)
3885 make_gap (total
- gap_size
);
3886 gap_size
= GAP_SIZE
;
3889 /* Read from the file, capturing `quit'. When an
3890 error occurs, end the loop, and arrange for a quit
3891 to be signaled after decoding the text we read. */
3892 non_regular_fd
= fd
;
3893 non_regular_inserted
= inserted
;
3894 non_regular_nbytes
= trytry
;
3895 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
3896 read_non_regular_quit
);
3907 /* Allow quitting out of the actual I/O. We don't make text
3908 part of the buffer until all the reading is done, so a C-g
3909 here doesn't do any harm. */
3912 this = emacs_read (fd
, BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ inserted
, trytry
);
3924 /* For a regular file, where TOTAL is the real size,
3925 count HOW_MUCH to compare with it.
3926 For a special file, where TOTAL is just a buffer size,
3927 so don't bother counting in HOW_MUCH.
3928 (INSERTED is where we count the number of characters inserted.) */
3935 /* Now we have read all the file data into the gap.
3936 If it was empty, undo marking the buffer modified. */
3940 #ifdef CLASH_DETECTION
3942 unlock_file (current_buffer
->file_truename
);
3944 Vdeactivate_mark
= old_Vdeactivate_mark
;
3947 Vdeactivate_mark
= Qt
;
3949 /* Make the text read part of the buffer. */
3950 GAP_SIZE
-= inserted
;
3952 GPT_BYTE
+= inserted
;
3954 ZV_BYTE
+= inserted
;
3959 /* Put an anchor to ensure multi-byte form ends at gap. */
3964 /* Discard the unwind protect for closing the file. */
3968 error ("IO error reading %s: %s",
3969 SDATA (orig_filename
), emacs_strerror (errno
));
3973 if (NILP (coding_system
))
3975 /* The coding system is not yet decided. Decide it by an
3976 optimized method for handling `coding:' tag.
3978 Note that we can get here only if the buffer was empty
3979 before the insertion. */
3981 if (!NILP (Vcoding_system_for_read
))
3982 coding_system
= Vcoding_system_for_read
;
3985 /* Since we are sure that the current buffer was empty
3986 before the insertion, we can toggle
3987 enable-multibyte-characters directly here without taking
3988 care of marker adjustment. By this way, we can run Lisp
3989 program safely before decoding the inserted text. */
3990 Lisp_Object unwind_data
;
3991 int count
= SPECPDL_INDEX ();
3993 unwind_data
= Fcons (current_buffer
->enable_multibyte_characters
,
3994 Fcons (current_buffer
->undo_list
,
3995 Fcurrent_buffer ()));
3996 current_buffer
->enable_multibyte_characters
= Qnil
;
3997 current_buffer
->undo_list
= Qt
;
3998 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4000 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4002 coding_system
= call2 (Vset_auto_coding_function
,
4003 filename
, make_number (inserted
));
4006 if (NILP (coding_system
))
4008 /* If the coding system is not yet decided, check
4009 file-coding-system-alist. */
4010 Lisp_Object args
[6];
4012 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4013 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4014 coding_system
= Ffind_operation_coding_system (6, args
);
4015 if (CONSP (coding_system
))
4016 coding_system
= XCAR (coding_system
);
4018 unbind_to (count
, Qnil
);
4019 inserted
= Z_BYTE
- BEG_BYTE
;
4022 if (NILP (coding_system
))
4023 coding_system
= Qundecided
;
4025 CHECK_CODING_SYSTEM (coding_system
);
4027 if (NILP (current_buffer
->enable_multibyte_characters
))
4028 /* We must suppress all character code conversion except for
4029 end-of-line conversion. */
4030 coding_system
= raw_text_coding_system (coding_system
);
4031 setup_coding_system (coding_system
, &coding
);
4032 /* Ensure we set Vlast_coding_system_used. */
4033 set_coding_system
= 1;
4038 /* When we visit a file by raw-text, we change the buffer to
4040 if (CODING_FOR_UNIBYTE (&coding
)
4041 /* Can't do this if part of the buffer might be preserved. */
4043 /* Visiting a file with these coding system makes the buffer
4045 current_buffer
->enable_multibyte_characters
= Qnil
;
4048 coding
.dst_multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
4049 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4050 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4052 move_gap_both (PT
, PT_BYTE
);
4053 GAP_SIZE
+= inserted
;
4054 ZV_BYTE
-= inserted
;
4058 decode_coding_gap (&coding
, inserted
, inserted
);
4059 inserted
= coding
.produced_char
;
4060 coding_system
= CODING_ID_NAME (coding
.id
);
4062 else if (inserted
> 0)
4063 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4066 /* Now INSERTED is measured in characters. */
4069 /* Use the conversion type to determine buffer-file-type
4070 (find-buffer-file-type is now used to help determine the
4072 if ((VECTORP (CODING_ID_EOL_TYPE (coding
.id
))
4073 || EQ (CODING_ID_EOL_TYPE (coding
.id
), Qunix
))
4074 && ! CODING_REQUIRE_DECODING (&coding
))
4075 current_buffer
->buffer_file_type
= Qt
;
4077 current_buffer
->buffer_file_type
= Qnil
;
4082 if (deferred_remove_unwind_protect
)
4083 /* If requested above, discard the unwind protect for closing the
4089 if (!EQ (current_buffer
->undo_list
, Qt
) && !nochange
)
4090 current_buffer
->undo_list
= Qnil
;
4094 current_buffer
->modtime
= st
.st_mtime
;
4095 current_buffer
->filename
= orig_filename
;
4098 SAVE_MODIFF
= MODIFF
;
4099 current_buffer
->auto_save_modified
= MODIFF
;
4100 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4101 #ifdef CLASH_DETECTION
4104 if (!NILP (current_buffer
->file_truename
))
4105 unlock_file (current_buffer
->file_truename
);
4106 unlock_file (filename
);
4108 #endif /* CLASH_DETECTION */
4110 xsignal2 (Qfile_error
,
4111 build_string ("not a regular file"), orig_filename
);
4114 if (set_coding_system
)
4115 Vlast_coding_system_used
= coding_system
;
4117 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4119 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4121 if (! NILP (insval
))
4123 CHECK_NUMBER (insval
);
4124 inserted
= XFASTINT (insval
);
4128 /* Decode file format. */
4131 /* Don't run point motion or modification hooks when decoding. */
4132 int count
= SPECPDL_INDEX ();
4133 EMACS_INT old_inserted
= inserted
;
4134 specbind (Qinhibit_point_motion_hooks
, Qt
);
4135 specbind (Qinhibit_modification_hooks
, Qt
);
4137 /* Save old undo list and don't record undo for decoding. */
4138 old_undo
= current_buffer
->undo_list
;
4139 current_buffer
->undo_list
= Qt
;
4143 insval
= call3 (Qformat_decode
,
4144 Qnil
, make_number (inserted
), visit
);
4145 CHECK_NUMBER (insval
);
4146 inserted
= XFASTINT (insval
);
4150 /* If REPLACE is non-nil and we succeeded in not replacing the
4151 beginning or end of the buffer text with the file's contents,
4152 call format-decode with `point' positioned at the beginning
4153 of the buffer and `inserted' equalling the number of
4154 characters in the buffer. Otherwise, format-decode might
4155 fail to correctly analyze the beginning or end of the buffer.
4156 Hence we temporarily save `point' and `inserted' here and
4157 restore `point' iff format-decode did not insert or delete
4158 any text. Otherwise we leave `point' at point-min. */
4159 EMACS_INT opoint
= PT
;
4160 EMACS_INT opoint_byte
= PT_BYTE
;
4161 EMACS_INT oinserted
= ZV
- BEGV
;
4162 int ochars_modiff
= CHARS_MODIFF
;
4164 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4165 insval
= call3 (Qformat_decode
,
4166 Qnil
, make_number (oinserted
), visit
);
4167 CHECK_NUMBER (insval
);
4168 if (ochars_modiff
== CHARS_MODIFF
)
4169 /* format_decode didn't modify buffer's characters => move
4170 point back to position before inserted text and leave
4171 value of inserted alone. */
4172 SET_PT_BOTH (opoint
, opoint_byte
);
4174 /* format_decode modified buffer's characters => consider
4175 entire buffer changed and leave point at point-min. */
4176 inserted
= XFASTINT (insval
);
4179 /* For consistency with format-decode call these now iff inserted > 0
4180 (martin 2007-06-28). */
4181 p
= Vafter_insert_file_functions
;
4186 insval
= call1 (XCAR (p
), make_number (inserted
));
4189 CHECK_NUMBER (insval
);
4190 inserted
= XFASTINT (insval
);
4195 /* For the rationale of this see the comment on
4196 format-decode above. */
4197 EMACS_INT opoint
= PT
;
4198 EMACS_INT opoint_byte
= PT_BYTE
;
4199 EMACS_INT oinserted
= ZV
- BEGV
;
4200 int ochars_modiff
= CHARS_MODIFF
;
4202 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4203 insval
= call1 (XCAR (p
), make_number (oinserted
));
4206 CHECK_NUMBER (insval
);
4207 if (ochars_modiff
== CHARS_MODIFF
)
4208 /* after_insert_file_functions didn't modify
4209 buffer's characters => move point back to
4210 position before inserted text and leave value of
4212 SET_PT_BOTH (opoint
, opoint_byte
);
4214 /* after_insert_file_functions did modify buffer's
4215 characters => consider entire buffer changed and
4216 leave point at point-min. */
4217 inserted
= XFASTINT (insval
);
4227 current_buffer
->undo_list
= old_undo
;
4228 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4230 /* Adjust the last undo record for the size change during
4231 the format conversion. */
4232 Lisp_Object tem
= XCAR (old_undo
);
4233 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4234 && INTEGERP (XCDR (tem
))
4235 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4236 XSETCDR (tem
, make_number (PT
+ inserted
));
4240 /* If undo_list was Qt before, keep it that way.
4241 Otherwise start with an empty undo_list. */
4242 current_buffer
->undo_list
= EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4244 unbind_to (count
, Qnil
);
4247 /* Call after-change hooks for the inserted text, aside from the case
4248 of normal visiting (not with REPLACE), which is done in a new buffer
4249 "before" the buffer is changed. */
4250 if (inserted
> 0 && total
> 0
4251 && (NILP (visit
) || !NILP (replace
)))
4253 signal_after_change (PT
, 0, inserted
);
4254 update_compositions (PT
, PT
, CHECK_BORDER
);
4258 && current_buffer
->modtime
== -1)
4260 /* If visiting nonexistent file, return nil. */
4261 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4265 Fsignal (Qquit
, Qnil
);
4267 /* ??? Retval needs to be dealt with in all cases consistently. */
4269 val
= Fcons (orig_filename
,
4270 Fcons (make_number (inserted
),
4273 RETURN_UNGCPRO (unbind_to (count
, val
));
4276 static Lisp_Object build_annotations
P_ ((Lisp_Object
, Lisp_Object
));
4279 build_annotations_unwind (arg
)
4282 Vwrite_region_annotation_buffers
= arg
;
4286 /* Decide the coding-system to encode the data with. */
4289 choose_write_coding_system (start
, end
, filename
,
4290 append
, visit
, lockname
, coding
)
4291 Lisp_Object start
, end
, filename
, append
, visit
, lockname
;
4292 struct coding_system
*coding
;
4295 Lisp_Object eol_parent
= Qnil
;
4298 && NILP (Fstring_equal (current_buffer
->filename
,
4299 current_buffer
->auto_save_file_name
)))
4304 else if (!NILP (Vcoding_system_for_write
))
4306 val
= Vcoding_system_for_write
;
4307 if (coding_system_require_warning
4308 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4309 /* Confirm that VAL can surely encode the current region. */
4310 val
= call5 (Vselect_safe_coding_system_function
,
4311 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4316 /* If the variable `buffer-file-coding-system' is set locally,
4317 it means that the file was read with some kind of code
4318 conversion or the variable is explicitly set by users. We
4319 had better write it out with the same coding system even if
4320 `enable-multibyte-characters' is nil.
4322 If it is not set locally, we anyway have to convert EOL
4323 format if the default value of `buffer-file-coding-system'
4324 tells that it is not Unix-like (LF only) format. */
4325 int using_default_coding
= 0;
4326 int force_raw_text
= 0;
4328 val
= current_buffer
->buffer_file_coding_system
;
4330 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4333 if (NILP (current_buffer
->enable_multibyte_characters
))
4339 /* Check file-coding-system-alist. */
4340 Lisp_Object args
[7], coding_systems
;
4342 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4343 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4345 coding_systems
= Ffind_operation_coding_system (7, args
);
4346 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4347 val
= XCDR (coding_systems
);
4352 /* If we still have not decided a coding system, use the
4353 default value of buffer-file-coding-system. */
4354 val
= current_buffer
->buffer_file_coding_system
;
4355 using_default_coding
= 1;
4358 if (! NILP (val
) && ! force_raw_text
)
4360 Lisp_Object spec
, attrs
;
4362 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4363 attrs
= AREF (spec
, 0);
4364 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4369 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4370 /* Confirm that VAL can surely encode the current region. */
4371 val
= call5 (Vselect_safe_coding_system_function
,
4372 start
, end
, val
, Qnil
, filename
);
4374 /* If the decided coding-system doesn't specify end-of-line
4375 format, we use that of
4376 `default-buffer-file-coding-system'. */
4377 if (! using_default_coding
4378 && ! NILP (buffer_defaults
.buffer_file_coding_system
))
4379 val
= (coding_inherit_eol_type
4380 (val
, buffer_defaults
.buffer_file_coding_system
));
4382 /* If we decide not to encode text, use `raw-text' or one of its
4385 val
= raw_text_coding_system (val
);
4388 val
= coding_inherit_eol_type (val
, eol_parent
);
4389 setup_coding_system (val
, coding
);
4391 if (!STRINGP (start
) && !NILP (current_buffer
->selective_display
))
4392 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4396 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4397 "r\nFWrite region to file: \ni\ni\ni\np",
4398 doc
: /* Write current region into specified file.
4399 When called from a program, requires three arguments:
4400 START, END and FILENAME. START and END are normally buffer positions
4401 specifying the part of the buffer to write.
4402 If START is nil, that means to use the entire buffer contents.
4403 If START is a string, then output that string to the file
4404 instead of any buffer contents; END is ignored.
4406 Optional fourth argument APPEND if non-nil means
4407 append to existing file contents (if any). If it is an integer,
4408 seek to that offset in the file before writing.
4409 Optional fifth argument VISIT, if t or a string, means
4410 set the last-save-file-modtime of buffer to this file's modtime
4411 and mark buffer not modified.
4412 If VISIT is a string, it is a second file name;
4413 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4414 VISIT is also the file name to lock and unlock for clash detection.
4415 If VISIT is neither t nor nil nor a string,
4416 that means do not display the \"Wrote file\" message.
4417 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4418 use for locking and unlocking, overriding FILENAME and VISIT.
4419 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4420 for an existing file with the same name. If MUSTBENEW is `excl',
4421 that means to get an error if the file already exists; never overwrite.
4422 If MUSTBENEW is neither nil nor `excl', that means ask for
4423 confirmation before overwriting, but do go ahead and overwrite the file
4424 if the user confirms.
4426 This does code conversion according to the value of
4427 `coding-system-for-write', `buffer-file-coding-system', or
4428 `file-coding-system-alist', and sets the variable
4429 `last-coding-system-used' to the coding system actually used.
4431 This calls `write-region-annotate-functions' at the start, and
4432 `write-region-post-annotation-function' at the end. */)
4433 (start
, end
, filename
, append
, visit
, lockname
, mustbenew
)
4434 Lisp_Object start
, end
, filename
, append
, visit
, lockname
, mustbenew
;
4439 const unsigned char *fn
;
4441 int count
= SPECPDL_INDEX ();
4443 Lisp_Object handler
;
4444 Lisp_Object visit_file
;
4445 Lisp_Object annotations
;
4446 Lisp_Object encoded_filename
;
4447 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4448 int quietly
= !NILP (visit
);
4449 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4450 struct buffer
*given_buffer
;
4452 int buffer_file_type
= O_BINARY
;
4454 struct coding_system coding
;
4456 if (current_buffer
->base_buffer
&& visiting
)
4457 error ("Cannot do file visiting in an indirect buffer");
4459 if (!NILP (start
) && !STRINGP (start
))
4460 validate_region (&start
, &end
);
4463 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4465 filename
= Fexpand_file_name (filename
, Qnil
);
4467 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4468 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4470 if (STRINGP (visit
))
4471 visit_file
= Fexpand_file_name (visit
, Qnil
);
4473 visit_file
= filename
;
4475 if (NILP (lockname
))
4476 lockname
= visit_file
;
4480 /* If the file name has special constructs in it,
4481 call the corresponding file handler. */
4482 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4483 /* If FILENAME has no handler, see if VISIT has one. */
4484 if (NILP (handler
) && STRINGP (visit
))
4485 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4487 if (!NILP (handler
))
4490 val
= call6 (handler
, Qwrite_region
, start
, end
,
4491 filename
, append
, visit
);
4495 SAVE_MODIFF
= MODIFF
;
4496 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4497 current_buffer
->filename
= visit_file
;
4503 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4505 /* Special kludge to simplify auto-saving. */
4508 /* Do it later, so write-region-annotate-function can work differently
4509 if we save "the buffer" vs "a region".
4510 This is useful in tar-mode. --Stef
4511 XSETFASTINT (start, BEG);
4512 XSETFASTINT (end, Z); */
4516 record_unwind_protect (build_annotations_unwind
,
4517 Vwrite_region_annotation_buffers
);
4518 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4519 count1
= SPECPDL_INDEX ();
4521 given_buffer
= current_buffer
;
4523 if (!STRINGP (start
))
4525 annotations
= build_annotations (start
, end
);
4527 if (current_buffer
!= given_buffer
)
4529 XSETFASTINT (start
, BEGV
);
4530 XSETFASTINT (end
, ZV
);
4536 XSETFASTINT (start
, BEGV
);
4537 XSETFASTINT (end
, ZV
);
4542 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4544 /* Decide the coding-system to encode the data with.
4545 We used to make this choice before calling build_annotations, but that
4546 leads to problems when a write-annotate-function takes care of
4547 unsavable chars (as was the case with X-Symbol). */
4548 Vlast_coding_system_used
4549 = choose_write_coding_system (start
, end
, filename
,
4550 append
, visit
, lockname
, &coding
);
4552 #ifdef CLASH_DETECTION
4554 lock_file (lockname
);
4555 #endif /* CLASH_DETECTION */
4557 encoded_filename
= ENCODE_FILE (filename
);
4559 fn
= SDATA (encoded_filename
);
4563 desc
= emacs_open (fn
, O_WRONLY
| buffer_file_type
, 0);
4564 #else /* not DOS_NT */
4565 desc
= emacs_open (fn
, O_WRONLY
, 0);
4566 #endif /* not DOS_NT */
4568 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4570 desc
= emacs_open (fn
,
4571 O_WRONLY
| O_CREAT
| buffer_file_type
4572 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4573 S_IREAD
| S_IWRITE
);
4574 #else /* not DOS_NT */
4575 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4576 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4577 auto_saving
? auto_save_mode_bits
: 0666);
4578 #endif /* not DOS_NT */
4582 #ifdef CLASH_DETECTION
4584 if (!auto_saving
) unlock_file (lockname
);
4586 #endif /* CLASH_DETECTION */
4588 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4591 record_unwind_protect (close_file_unwind
, make_number (desc
));
4593 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4597 if (NUMBERP (append
))
4598 ret
= lseek (desc
, XINT (append
), 1);
4600 ret
= lseek (desc
, 0, 2);
4603 #ifdef CLASH_DETECTION
4604 if (!auto_saving
) unlock_file (lockname
);
4605 #endif /* CLASH_DETECTION */
4607 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4616 if (STRINGP (start
))
4618 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4619 &annotations
, &coding
);
4622 else if (XINT (start
) != XINT (end
))
4624 failure
= 0 > a_write (desc
, Qnil
,
4625 XINT (start
), XINT (end
) - XINT (start
),
4626 &annotations
, &coding
);
4631 /* If file was empty, still need to write the annotations */
4632 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4633 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4637 if (CODING_REQUIRE_FLUSHING (&coding
)
4638 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4641 /* We have to flush out a data. */
4642 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4643 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4650 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4651 Disk full in NFS may be reported here. */
4652 /* mib says that closing the file will try to write as fast as NFS can do
4653 it, and that means the fsync here is not crucial for autosave files. */
4654 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4656 /* If fsync fails with EINTR, don't treat that as serious. Also
4657 ignore EINVAL which happens when fsync is not supported on this
4659 if (errno
!= EINTR
&& errno
!= EINVAL
)
4660 failure
= 1, save_errno
= errno
;
4664 /* NFS can report a write failure now. */
4665 if (emacs_close (desc
) < 0)
4666 failure
= 1, save_errno
= errno
;
4670 /* Discard the unwind protect for close_file_unwind. */
4671 specpdl_ptr
= specpdl
+ count1
;
4673 /* Call write-region-post-annotation-function. */
4674 while (CONSP (Vwrite_region_annotation_buffers
))
4676 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4677 if (!NILP (Fbuffer_live_p (buf
)))
4680 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4681 call0 (Vwrite_region_post_annotation_function
);
4683 Vwrite_region_annotation_buffers
4684 = XCDR (Vwrite_region_annotation_buffers
);
4687 unbind_to (count
, Qnil
);
4689 #ifdef CLASH_DETECTION
4691 unlock_file (lockname
);
4692 #endif /* CLASH_DETECTION */
4694 /* Do this before reporting IO error
4695 to avoid a "file has changed on disk" warning on
4696 next attempt to save. */
4698 current_buffer
->modtime
= st
.st_mtime
;
4701 error ("IO error writing %s: %s", SDATA (filename
),
4702 emacs_strerror (save_errno
));
4706 SAVE_MODIFF
= MODIFF
;
4707 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4708 current_buffer
->filename
= visit_file
;
4709 update_mode_lines
++;
4714 && ! NILP (Fstring_equal (current_buffer
->filename
,
4715 current_buffer
->auto_save_file_name
)))
4716 SAVE_MODIFF
= MODIFF
;
4722 message_with_string ((INTEGERP (append
)
4732 Lisp_Object
merge ();
4734 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4735 doc
: /* Return t if (car A) is numerically less than (car B). */)
4739 return Flss (Fcar (a
), Fcar (b
));
4742 /* Build the complete list of annotations appropriate for writing out
4743 the text between START and END, by calling all the functions in
4744 write-region-annotate-functions and merging the lists they return.
4745 If one of these functions switches to a different buffer, we assume
4746 that buffer contains altered text. Therefore, the caller must
4747 make sure to restore the current buffer in all cases,
4748 as save-excursion would do. */
4751 build_annotations (start
, end
)
4752 Lisp_Object start
, end
;
4754 Lisp_Object annotations
;
4756 struct gcpro gcpro1
, gcpro2
;
4757 Lisp_Object original_buffer
;
4758 int i
, used_global
= 0;
4760 XSETBUFFER (original_buffer
, current_buffer
);
4763 p
= Vwrite_region_annotate_functions
;
4764 GCPRO2 (annotations
, p
);
4767 struct buffer
*given_buffer
= current_buffer
;
4768 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4769 { /* Use the global value of the hook. */
4772 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4774 p
= Fappend (2, arg
);
4777 Vwrite_region_annotations_so_far
= annotations
;
4778 res
= call2 (XCAR (p
), start
, end
);
4779 /* If the function makes a different buffer current,
4780 assume that means this buffer contains altered text to be output.
4781 Reset START and END from the buffer bounds
4782 and discard all previous annotations because they should have
4783 been dealt with by this function. */
4784 if (current_buffer
!= given_buffer
)
4786 Vwrite_region_annotation_buffers
4787 = Fcons (Fcurrent_buffer (),
4788 Vwrite_region_annotation_buffers
);
4789 XSETFASTINT (start
, BEGV
);
4790 XSETFASTINT (end
, ZV
);
4793 Flength (res
); /* Check basic validity of return value */
4794 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4798 /* Now do the same for annotation functions implied by the file-format */
4799 if (auto_saving
&& (!EQ (current_buffer
->auto_save_file_format
, Qt
)))
4800 p
= current_buffer
->auto_save_file_format
;
4802 p
= current_buffer
->file_format
;
4803 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4805 struct buffer
*given_buffer
= current_buffer
;
4807 Vwrite_region_annotations_so_far
= annotations
;
4809 /* Value is either a list of annotations or nil if the function
4810 has written annotations to a temporary buffer, which is now
4812 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4813 original_buffer
, make_number (i
));
4814 if (current_buffer
!= given_buffer
)
4816 XSETFASTINT (start
, BEGV
);
4817 XSETFASTINT (end
, ZV
);
4822 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4830 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4831 If STRING is nil, POS is the character position in the current buffer.
4832 Intersperse with them the annotations from *ANNOT
4833 which fall within the range of POS to POS + NCHARS,
4834 each at its appropriate position.
4836 We modify *ANNOT by discarding elements as we use them up.
4838 The return value is negative in case of system call failure. */
4841 a_write (desc
, string
, pos
, nchars
, annot
, coding
)
4844 register int nchars
;
4847 struct coding_system
*coding
;
4851 int lastpos
= pos
+ nchars
;
4853 while (NILP (*annot
) || CONSP (*annot
))
4855 tem
= Fcar_safe (Fcar (*annot
));
4858 nextpos
= XFASTINT (tem
);
4860 /* If there are no more annotations in this range,
4861 output the rest of the range all at once. */
4862 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4863 return e_write (desc
, string
, pos
, lastpos
, coding
);
4865 /* Output buffer text up to the next annotation's position. */
4868 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4872 /* Output the annotation. */
4873 tem
= Fcdr (Fcar (*annot
));
4876 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4879 *annot
= Fcdr (*annot
);
4885 /* Write text in the range START and END into descriptor DESC,
4886 encoding them with coding system CODING. If STRING is nil, START
4887 and END are character positions of the current buffer, else they
4888 are indexes to the string STRING. */
4891 e_write (desc
, string
, start
, end
, coding
)
4895 struct coding_system
*coding
;
4897 if (STRINGP (string
))
4900 end
= SCHARS (string
);
4903 /* We used to have a code for handling selective display here. But,
4904 now it is handled within encode_coding. */
4908 if (STRINGP (string
))
4910 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
4911 if (CODING_REQUIRE_ENCODING (coding
))
4913 encode_coding_object (coding
, string
,
4914 start
, string_char_to_byte (string
, start
),
4915 end
, string_char_to_byte (string
, end
), Qt
);
4919 coding
->dst_object
= string
;
4920 coding
->consumed_char
= SCHARS (string
);
4921 coding
->produced
= SBYTES (string
);
4926 int start_byte
= CHAR_TO_BYTE (start
);
4927 int end_byte
= CHAR_TO_BYTE (end
);
4929 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
4930 if (CODING_REQUIRE_ENCODING (coding
))
4932 encode_coding_object (coding
, Fcurrent_buffer (),
4933 start
, start_byte
, end
, end_byte
, Qt
);
4937 coding
->dst_object
= Qnil
;
4938 coding
->dst_pos_byte
= start_byte
;
4939 if (start
>= GPT
|| end
<= GPT
)
4941 coding
->consumed_char
= end
- start
;
4942 coding
->produced
= end_byte
- start_byte
;
4946 coding
->consumed_char
= GPT
- start
;
4947 coding
->produced
= GPT_BYTE
- start_byte
;
4952 if (coding
->produced
> 0)
4956 STRINGP (coding
->dst_object
)
4957 ? SDATA (coding
->dst_object
)
4958 : BYTE_POS_ADDR (coding
->dst_pos_byte
),
4961 if (coding
->produced
)
4964 start
+= coding
->consumed_char
;
4970 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
4971 Sverify_visited_file_modtime
, 1, 1, 0,
4972 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
4973 This means that the file has not been changed since it was visited or saved.
4974 See Info node `(elisp)Modification Time' for more details. */)
4980 Lisp_Object handler
;
4981 Lisp_Object filename
;
4986 if (!STRINGP (b
->filename
)) return Qt
;
4987 if (b
->modtime
== 0) return Qt
;
4989 /* If the file name has special constructs in it,
4990 call the corresponding file handler. */
4991 handler
= Ffind_file_name_handler (b
->filename
,
4992 Qverify_visited_file_modtime
);
4993 if (!NILP (handler
))
4994 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
4996 filename
= ENCODE_FILE (b
->filename
);
4998 if (stat (SDATA (filename
), &st
) < 0)
5000 /* If the file doesn't exist now and didn't exist before,
5001 we say that it isn't modified, provided the error is a tame one. */
5002 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
5007 if (st
.st_mtime
== b
->modtime
5008 /* If both are positive, accept them if they are off by one second. */
5009 || (st
.st_mtime
> 0 && b
->modtime
> 0
5010 && (st
.st_mtime
== b
->modtime
+ 1
5011 || st
.st_mtime
== b
->modtime
- 1)))
5016 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5017 Sclear_visited_file_modtime
, 0, 0, 0,
5018 doc
: /* Clear out records of last mod time of visited file.
5019 Next attempt to save will certainly not complain of a discrepancy. */)
5022 current_buffer
->modtime
= 0;
5026 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5027 Svisited_file_modtime
, 0, 0, 0,
5028 doc
: /* Return the current buffer's recorded visited file modification time.
5029 The value is a list of the form (HIGH LOW), like the time values
5030 that `file-attributes' returns. If the current buffer has no recorded
5031 file modification time, this function returns 0.
5032 See Info node `(elisp)Modification Time' for more details. */)
5035 if (! current_buffer
->modtime
)
5036 return make_number (0);
5037 return make_time ((time_t) current_buffer
->modtime
);
5040 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5041 Sset_visited_file_modtime
, 0, 1, 0,
5042 doc
: /* Update buffer's recorded modification time from the visited file's time.
5043 Useful if the buffer was not read from the file normally
5044 or if the file itself has been changed for some known benign reason.
5045 An argument specifies the modification time value to use
5046 \(instead of that of the visited file), in the form of a list
5047 \(HIGH . LOW) or (HIGH LOW). */)
5049 Lisp_Object time_list
;
5051 if (!NILP (time_list
))
5052 current_buffer
->modtime
= cons_to_long (time_list
);
5055 register Lisp_Object filename
;
5057 Lisp_Object handler
;
5059 filename
= Fexpand_file_name (current_buffer
->filename
, Qnil
);
5061 /* If the file name has special constructs in it,
5062 call the corresponding file handler. */
5063 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5064 if (!NILP (handler
))
5065 /* The handler can find the file name the same way we did. */
5066 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5068 filename
= ENCODE_FILE (filename
);
5070 if (stat (SDATA (filename
), &st
) >= 0)
5071 current_buffer
->modtime
= st
.st_mtime
;
5078 auto_save_error (error
)
5081 Lisp_Object args
[3], msg
;
5083 struct gcpro gcpro1
;
5087 auto_save_error_occurred
= 1;
5089 ring_bell (XFRAME (selected_frame
));
5091 args
[0] = build_string ("Auto-saving %s: %s");
5092 args
[1] = current_buffer
->name
;
5093 args
[2] = Ferror_message_string (error
);
5094 msg
= Fformat (3, args
);
5096 nbytes
= SBYTES (msg
);
5097 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5098 bcopy (SDATA (msg
), msgbuf
, nbytes
);
5100 for (i
= 0; i
< 3; ++i
)
5103 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5105 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5106 Fsleep_for (make_number (1), Qnil
);
5120 auto_save_mode_bits
= 0666;
5122 /* Get visited file's mode to become the auto save file's mode. */
5123 if (! NILP (current_buffer
->filename
))
5125 if (stat (SDATA (current_buffer
->filename
), &st
) >= 0)
5126 /* But make sure we can overwrite it later! */
5127 auto_save_mode_bits
= st
.st_mode
| 0600;
5128 else if ((modes
= Ffile_modes (current_buffer
->filename
),
5130 /* Remote files don't cooperate with stat. */
5131 auto_save_mode_bits
= XINT (modes
) | 0600;
5135 Fwrite_region (Qnil
, Qnil
, current_buffer
->auto_save_file_name
, Qnil
,
5136 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5141 do_auto_save_unwind (arg
) /* used as unwind-protect function */
5144 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5156 do_auto_save_unwind_1 (value
) /* used as unwind-protect function */
5159 minibuffer_auto_raise
= XINT (value
);
5164 do_auto_save_make_dir (dir
)
5169 call2 (Qmake_directory
, dir
, Qt
);
5170 XSETFASTINT (mode
, 0700);
5171 return Fset_file_modes (dir
, mode
);
5175 do_auto_save_eh (ignore
)
5181 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5182 doc
: /* Auto-save all buffers that need it.
5183 This is all buffers that have auto-saving enabled
5184 and are changed since last auto-saved.
5185 Auto-saving writes the buffer into a file
5186 so that your editing is not lost if the system crashes.
5187 This file is not the file you visited; that changes only when you save.
5188 Normally we run the normal hook `auto-save-hook' before saving.
5190 A non-nil NO-MESSAGE argument means do not print any message if successful.
5191 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5192 (no_message
, current_only
)
5193 Lisp_Object no_message
, current_only
;
5195 struct buffer
*old
= current_buffer
, *b
;
5196 Lisp_Object tail
, buf
;
5198 int do_handled_files
;
5200 FILE *stream
= NULL
;
5201 int count
= SPECPDL_INDEX ();
5202 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5203 int old_message_p
= 0;
5204 struct gcpro gcpro1
, gcpro2
;
5206 if (max_specpdl_size
< specpdl_size
+ 40)
5207 max_specpdl_size
= specpdl_size
+ 40;
5212 if (NILP (no_message
))
5214 old_message_p
= push_message ();
5215 record_unwind_protect (pop_message_unwind
, Qnil
);
5218 /* Ordinarily don't quit within this function,
5219 but don't make it impossible to quit (in case we get hung in I/O). */
5223 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5224 point to non-strings reached from Vbuffer_alist. */
5226 if (!NILP (Vrun_hooks
))
5227 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5229 if (STRINGP (Vauto_save_list_file_name
))
5231 Lisp_Object listfile
;
5233 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5235 /* Don't try to create the directory when shutting down Emacs,
5236 because creating the directory might signal an error, and
5237 that would leave Emacs in a strange state. */
5238 if (!NILP (Vrun_hooks
))
5242 GCPRO2 (dir
, listfile
);
5243 dir
= Ffile_name_directory (listfile
);
5244 if (NILP (Ffile_directory_p (dir
)))
5245 internal_condition_case_1 (do_auto_save_make_dir
,
5246 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5251 stream
= fopen (SDATA (listfile
), "w");
5254 record_unwind_protect (do_auto_save_unwind
,
5255 make_save_value (stream
, 0));
5256 record_unwind_protect (do_auto_save_unwind_1
,
5257 make_number (minibuffer_auto_raise
));
5258 minibuffer_auto_raise
= 0;
5260 auto_save_error_occurred
= 0;
5262 /* On first pass, save all files that don't have handlers.
5263 On second pass, save all files that do have handlers.
5265 If Emacs is crashing, the handlers may tweak what is causing
5266 Emacs to crash in the first place, and it would be a shame if
5267 Emacs failed to autosave perfectly ordinary files because it
5268 couldn't handle some ange-ftp'd file. */
5270 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5271 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5273 buf
= XCDR (XCAR (tail
));
5276 /* Record all the buffers that have auto save mode
5277 in the special file that lists them. For each of these buffers,
5278 Record visited name (if any) and auto save name. */
5279 if (STRINGP (b
->auto_save_file_name
)
5280 && stream
!= NULL
&& do_handled_files
== 0)
5283 if (!NILP (b
->filename
))
5285 fwrite (SDATA (b
->filename
), 1,
5286 SBYTES (b
->filename
), stream
);
5288 putc ('\n', stream
);
5289 fwrite (SDATA (b
->auto_save_file_name
), 1,
5290 SBYTES (b
->auto_save_file_name
), stream
);
5291 putc ('\n', stream
);
5295 if (!NILP (current_only
)
5296 && b
!= current_buffer
)
5299 /* Don't auto-save indirect buffers.
5300 The base buffer takes care of it. */
5304 /* Check for auto save enabled
5305 and file changed since last auto save
5306 and file changed since last real save. */
5307 if (STRINGP (b
->auto_save_file_name
)
5308 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5309 && b
->auto_save_modified
< BUF_MODIFF (b
)
5310 /* -1 means we've turned off autosaving for a while--see below. */
5311 && XINT (b
->save_length
) >= 0
5312 && (do_handled_files
5313 || NILP (Ffind_file_name_handler (b
->auto_save_file_name
,
5316 EMACS_TIME before_time
, after_time
;
5318 EMACS_GET_TIME (before_time
);
5320 /* If we had a failure, don't try again for 20 minutes. */
5321 if (b
->auto_save_failure_time
>= 0
5322 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5325 set_buffer_internal (b
);
5326 if (NILP (Vauto_save_include_big_deletions
)
5327 && (XFASTINT (b
->save_length
) * 10
5328 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5329 /* A short file is likely to change a large fraction;
5330 spare the user annoying messages. */
5331 && XFASTINT (b
->save_length
) > 5000
5332 /* These messages are frequent and annoying for `*mail*'. */
5333 && !EQ (b
->filename
, Qnil
)
5334 && NILP (no_message
))
5336 /* It has shrunk too much; turn off auto-saving here. */
5337 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5338 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5340 minibuffer_auto_raise
= 0;
5341 /* Turn off auto-saving until there's a real save,
5342 and prevent any more warnings. */
5343 XSETINT (b
->save_length
, -1);
5344 Fsleep_for (make_number (1), Qnil
);
5347 if (!auto_saved
&& NILP (no_message
))
5348 message1 ("Auto-saving...");
5349 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5351 b
->auto_save_modified
= BUF_MODIFF (b
);
5352 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5353 set_buffer_internal (old
);
5355 EMACS_GET_TIME (after_time
);
5357 /* If auto-save took more than 60 seconds,
5358 assume it was an NFS failure that got a timeout. */
5359 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5360 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5364 /* Prevent another auto save till enough input events come in. */
5365 record_auto_save ();
5367 if (auto_saved
&& NILP (no_message
))
5371 /* If we are going to restore an old message,
5372 give time to read ours. */
5373 sit_for (make_number (1), 0, 0);
5376 else if (!auto_save_error_occurred
)
5377 /* Don't overwrite the error message if an error occurred.
5378 If we displayed a message and then restored a state
5379 with no message, leave a "done" message on the screen. */
5380 message1 ("Auto-saving...done");
5385 /* This restores the message-stack status. */
5386 unbind_to (count
, Qnil
);
5390 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5391 Sset_buffer_auto_saved
, 0, 0, 0,
5392 doc
: /* Mark current buffer as auto-saved with its current text.
5393 No auto-save file will be written until the buffer changes again. */)
5396 current_buffer
->auto_save_modified
= MODIFF
;
5397 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5398 current_buffer
->auto_save_failure_time
= -1;
5402 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5403 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5404 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5407 current_buffer
->auto_save_failure_time
= -1;
5411 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5413 doc
: /* Return t if current buffer has been auto-saved recently.
5414 More precisely, if it has been auto-saved since last read from or saved
5415 in the visited file. If the buffer has no visited file,
5416 then any auto-save counts as "recent". */)
5419 return (SAVE_MODIFF
< current_buffer
->auto_save_modified
) ? Qt
: Qnil
;
5422 /* Reading and completing file names */
5424 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5425 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5426 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5427 The return value is only relevant for a call to `read-file-name' that happens
5428 before any other event (mouse or keypress) is handled. */)
5431 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5432 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5442 Fread_file_name (prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
)
5443 Lisp_Object prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
;
5445 struct gcpro gcpro1
, gcpro2
;
5446 Lisp_Object args
[7];
5448 GCPRO1 (default_filename
);
5449 args
[0] = intern ("read-file-name");
5452 args
[3] = default_filename
;
5453 args
[4] = mustmatch
;
5455 args
[6] = predicate
;
5456 RETURN_UNGCPRO (Ffuncall (7, args
));
5463 Qoperations
= intern ("operations");
5464 Qexpand_file_name
= intern ("expand-file-name");
5465 Qsubstitute_in_file_name
= intern ("substitute-in-file-name");
5466 Qdirectory_file_name
= intern ("directory-file-name");
5467 Qfile_name_directory
= intern ("file-name-directory");
5468 Qfile_name_nondirectory
= intern ("file-name-nondirectory");
5469 Qunhandled_file_name_directory
= intern ("unhandled-file-name-directory");
5470 Qfile_name_as_directory
= intern ("file-name-as-directory");
5471 Qcopy_file
= intern ("copy-file");
5472 Qmake_directory_internal
= intern ("make-directory-internal");
5473 Qmake_directory
= intern ("make-directory");
5474 Qdelete_directory_internal
= intern ("delete-directory-internal");
5475 Qdelete_file
= intern ("delete-file");
5476 Qrename_file
= intern ("rename-file");
5477 Qadd_name_to_file
= intern ("add-name-to-file");
5478 Qmake_symbolic_link
= intern ("make-symbolic-link");
5479 Qfile_exists_p
= intern ("file-exists-p");
5480 Qfile_executable_p
= intern ("file-executable-p");
5481 Qfile_readable_p
= intern ("file-readable-p");
5482 Qfile_writable_p
= intern ("file-writable-p");
5483 Qfile_symlink_p
= intern ("file-symlink-p");
5484 Qaccess_file
= intern ("access-file");
5485 Qfile_directory_p
= intern ("file-directory-p");
5486 Qfile_regular_p
= intern ("file-regular-p");
5487 Qfile_accessible_directory_p
= intern ("file-accessible-directory-p");
5488 Qfile_modes
= intern ("file-modes");
5489 Qset_file_modes
= intern ("set-file-modes");
5490 Qset_file_times
= intern ("set-file-times");
5491 Qfile_newer_than_file_p
= intern ("file-newer-than-file-p");
5492 Qinsert_file_contents
= intern ("insert-file-contents");
5493 Qwrite_region
= intern ("write-region");
5494 Qverify_visited_file_modtime
= intern ("verify-visited-file-modtime");
5495 Qset_visited_file_modtime
= intern ("set-visited-file-modtime");
5496 Qauto_save_coding
= intern ("auto-save-coding");
5498 staticpro (&Qoperations
);
5499 staticpro (&Qexpand_file_name
);
5500 staticpro (&Qsubstitute_in_file_name
);
5501 staticpro (&Qdirectory_file_name
);
5502 staticpro (&Qfile_name_directory
);
5503 staticpro (&Qfile_name_nondirectory
);
5504 staticpro (&Qunhandled_file_name_directory
);
5505 staticpro (&Qfile_name_as_directory
);
5506 staticpro (&Qcopy_file
);
5507 staticpro (&Qmake_directory_internal
);
5508 staticpro (&Qmake_directory
);
5509 staticpro (&Qdelete_directory_internal
);
5510 staticpro (&Qdelete_file
);
5511 staticpro (&Qrename_file
);
5512 staticpro (&Qadd_name_to_file
);
5513 staticpro (&Qmake_symbolic_link
);
5514 staticpro (&Qfile_exists_p
);
5515 staticpro (&Qfile_executable_p
);
5516 staticpro (&Qfile_readable_p
);
5517 staticpro (&Qfile_writable_p
);
5518 staticpro (&Qaccess_file
);
5519 staticpro (&Qfile_symlink_p
);
5520 staticpro (&Qfile_directory_p
);
5521 staticpro (&Qfile_regular_p
);
5522 staticpro (&Qfile_accessible_directory_p
);
5523 staticpro (&Qfile_modes
);
5524 staticpro (&Qset_file_modes
);
5525 staticpro (&Qset_file_times
);
5526 staticpro (&Qfile_newer_than_file_p
);
5527 staticpro (&Qinsert_file_contents
);
5528 staticpro (&Qwrite_region
);
5529 staticpro (&Qverify_visited_file_modtime
);
5530 staticpro (&Qset_visited_file_modtime
);
5531 staticpro (&Qauto_save_coding
);
5533 Qfile_name_history
= intern ("file-name-history");
5534 Fset (Qfile_name_history
, Qnil
);
5535 staticpro (&Qfile_name_history
);
5537 Qfile_error
= intern ("file-error");
5538 staticpro (&Qfile_error
);
5539 Qfile_already_exists
= intern ("file-already-exists");
5540 staticpro (&Qfile_already_exists
);
5541 Qfile_date_error
= intern ("file-date-error");
5542 staticpro (&Qfile_date_error
);
5543 Qexcl
= intern ("excl");
5547 Qfind_buffer_file_type
= intern ("find-buffer-file-type");
5548 staticpro (&Qfind_buffer_file_type
);
5551 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system
,
5552 doc
: /* *Coding system for encoding file names.
5553 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5554 Vfile_name_coding_system
= Qnil
;
5556 DEFVAR_LISP ("default-file-name-coding-system",
5557 &Vdefault_file_name_coding_system
,
5558 doc
: /* Default coding system for encoding file names.
5559 This variable is used only when `file-name-coding-system' is nil.
5561 This variable is set/changed by the command `set-language-environment'.
5562 User should not set this variable manually,
5563 instead use `file-name-coding-system' to get a constant encoding
5564 of file names regardless of the current language environment. */);
5565 Vdefault_file_name_coding_system
= Qnil
;
5567 Qformat_decode
= intern ("format-decode");
5568 staticpro (&Qformat_decode
);
5569 Qformat_annotate_function
= intern ("format-annotate-function");
5570 staticpro (&Qformat_annotate_function
);
5571 Qafter_insert_file_set_coding
= intern ("after-insert-file-set-coding");
5572 staticpro (&Qafter_insert_file_set_coding
);
5574 Qcar_less_than_car
= intern ("car-less-than-car");
5575 staticpro (&Qcar_less_than_car
);
5577 Fput (Qfile_error
, Qerror_conditions
,
5578 list2 (Qfile_error
, Qerror
));
5579 Fput (Qfile_error
, Qerror_message
,
5580 build_string ("File error"));
5582 Fput (Qfile_already_exists
, Qerror_conditions
,
5583 list3 (Qfile_already_exists
, Qfile_error
, Qerror
));
5584 Fput (Qfile_already_exists
, Qerror_message
,
5585 build_string ("File already exists"));
5587 Fput (Qfile_date_error
, Qerror_conditions
,
5588 list3 (Qfile_date_error
, Qfile_error
, Qerror
));
5589 Fput (Qfile_date_error
, Qerror_message
,
5590 build_string ("Cannot set file date"));
5592 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char
,
5593 doc
: /* Directory separator character for built-in functions that return file names.
5594 The value is always ?/. Don't use this variable, just use `/'. */);
5595 XSETFASTINT (Vdirectory_sep_char
, '/');
5597 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist
,
5598 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
5599 If a file name matches REGEXP, then all I/O on that file is done by calling
5602 The first argument given to HANDLER is the name of the I/O primitive
5603 to be handled; the remaining arguments are the arguments that were
5604 passed to that primitive. For example, if you do
5605 (file-exists-p FILENAME)
5606 and FILENAME is handled by HANDLER, then HANDLER is called like this:
5607 (funcall HANDLER 'file-exists-p FILENAME)
5608 The function `find-file-name-handler' checks this list for a handler
5609 for its argument. */);
5610 Vfile_name_handler_alist
= Qnil
;
5612 DEFVAR_LISP ("set-auto-coding-function",
5613 &Vset_auto_coding_function
,
5614 doc
: /* If non-nil, a function to call to decide a coding system of file.
5615 Two arguments are passed to this function: the file name
5616 and the length of a file contents following the point.
5617 This function should return a coding system to decode the file contents.
5618 It should check the file name against `auto-coding-alist'.
5619 If no coding system is decided, it should check a coding system
5620 specified in the heading lines with the format:
5621 -*- ... coding: CODING-SYSTEM; ... -*-
5622 or local variable spec of the tailing lines with `coding:' tag. */);
5623 Vset_auto_coding_function
= Qnil
;
5625 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions
,
5626 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5627 Each is passed one argument, the number of characters inserted,
5628 with point at the start of the inserted text. Each function
5629 should leave point the same, and return the new character count.
5630 If `insert-file-contents' is intercepted by a handler from
5631 `file-name-handler-alist', that handler is responsible for calling the
5632 functions in `after-insert-file-functions' if appropriate. */);
5633 Vafter_insert_file_functions
= Qnil
;
5635 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions
,
5636 doc
: /* A list of functions to be called at the start of `write-region'.
5637 Each is passed two arguments, START and END as for `write-region'.
5638 These are usually two numbers but not always; see the documentation
5639 for `write-region'. The function should return a list of pairs
5640 of the form (POSITION . STRING), consisting of strings to be effectively
5641 inserted at the specified positions of the file being written (1 means to
5642 insert before the first byte written). The POSITIONs must be sorted into
5645 If there are several annotation functions, the lists returned by these
5646 functions are merged destructively. As each annotation function runs,
5647 the variable `write-region-annotations-so-far' contains a list of all
5648 annotations returned by previous annotation functions.
5650 An annotation function can return with a different buffer current.
5651 Doing so removes the annotations returned by previous functions, and
5652 resets START and END to `point-min' and `point-max' of the new buffer.
5654 After `write-region' completes, Emacs calls the function stored in
5655 `write-region-post-annotation-function', once for each buffer that was
5656 current when building the annotations (i.e., at least once), with that
5657 buffer current. */);
5658 Vwrite_region_annotate_functions
= Qnil
;
5659 staticpro (&Qwrite_region_annotate_functions
);
5660 Qwrite_region_annotate_functions
5661 = intern ("write-region-annotate-functions");
5663 DEFVAR_LISP ("write-region-post-annotation-function",
5664 &Vwrite_region_post_annotation_function
,
5665 doc
: /* Function to call after `write-region' completes.
5666 The function is called with no arguments. If one or more of the
5667 annotation functions in `write-region-annotate-functions' changed the
5668 current buffer, the function stored in this variable is called for
5669 each of those additional buffers as well, in addition to the original
5670 buffer. The relevant buffer is current during each function call. */);
5671 Vwrite_region_post_annotation_function
= Qnil
;
5672 staticpro (&Vwrite_region_annotation_buffers
);
5674 DEFVAR_LISP ("write-region-annotations-so-far",
5675 &Vwrite_region_annotations_so_far
,
5676 doc
: /* When an annotation function is called, this holds the previous annotations.
5677 These are the annotations made by other annotation functions
5678 that were already called. See also `write-region-annotate-functions'. */);
5679 Vwrite_region_annotations_so_far
= Qnil
;
5681 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers
,
5682 doc
: /* A list of file name handlers that temporarily should not be used.
5683 This applies only to the operation `inhibit-file-name-operation'. */);
5684 Vinhibit_file_name_handlers
= Qnil
;
5686 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation
,
5687 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5688 Vinhibit_file_name_operation
= Qnil
;
5690 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name
,
5691 doc
: /* File name in which we write a list of all auto save file names.
5692 This variable is initialized automatically from `auto-save-list-file-prefix'
5693 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5694 a non-nil value. */);
5695 Vauto_save_list_file_name
= Qnil
;
5697 DEFVAR_LISP ("auto-save-visited-file-name", &Vauto_save_visited_file_name
,
5698 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5699 Normally auto-save files are written under other names. */);
5700 Vauto_save_visited_file_name
= Qnil
;
5702 DEFVAR_LISP ("auto-save-include-big-deletions", &Vauto_save_include_big_deletions
,
5703 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5704 If nil, deleting a substantial portion of the text disables auto-save
5705 in the buffer; this is the default behavior, because the auto-save
5706 file is usually more useful if it contains the deleted text. */);
5707 Vauto_save_include_big_deletions
= Qnil
;
5710 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync
,
5711 doc
: /* *Non-nil means don't call fsync in `write-region'.
5712 This variable affects calls to `write-region' as well as save commands.
5713 A non-nil value may result in data loss! */);
5714 write_region_inhibit_fsync
= 0;
5717 DEFVAR_BOOL ("delete-by-moving-to-trash", &delete_by_moving_to_trash
,
5718 doc
: /* Specifies whether to use the system's trash can.
5719 When non-nil, the function `move-file-to-trash' will be used by
5720 `delete-file' and `delete-directory'. */);
5721 delete_by_moving_to_trash
= 0;
5722 Qdelete_by_moving_to_trash
= intern ("delete-by-moving-to-trash");
5723 Qmove_file_to_trash
= intern ("move-file-to-trash");
5724 staticpro (&Qmove_file_to_trash
);
5726 defsubr (&Sfind_file_name_handler
);
5727 defsubr (&Sfile_name_directory
);
5728 defsubr (&Sfile_name_nondirectory
);
5729 defsubr (&Sunhandled_file_name_directory
);
5730 defsubr (&Sfile_name_as_directory
);
5731 defsubr (&Sdirectory_file_name
);
5732 defsubr (&Smake_temp_name
);
5733 defsubr (&Sexpand_file_name
);
5734 defsubr (&Ssubstitute_in_file_name
);
5735 defsubr (&Scopy_file
);
5736 defsubr (&Smake_directory_internal
);
5737 defsubr (&Sdelete_directory_internal
);
5738 defsubr (&Sdelete_file
);
5739 defsubr (&Srename_file
);
5740 defsubr (&Sadd_name_to_file
);
5741 defsubr (&Smake_symbolic_link
);
5742 defsubr (&Sfile_name_absolute_p
);
5743 defsubr (&Sfile_exists_p
);
5744 defsubr (&Sfile_executable_p
);
5745 defsubr (&Sfile_readable_p
);
5746 defsubr (&Sfile_writable_p
);
5747 defsubr (&Saccess_file
);
5748 defsubr (&Sfile_symlink_p
);
5749 defsubr (&Sfile_directory_p
);
5750 defsubr (&Sfile_accessible_directory_p
);
5751 defsubr (&Sfile_regular_p
);
5752 defsubr (&Sfile_modes
);
5753 defsubr (&Sset_file_modes
);
5754 defsubr (&Sset_file_times
);
5755 defsubr (&Sset_default_file_modes
);
5756 defsubr (&Sdefault_file_modes
);
5757 defsubr (&Sfile_newer_than_file_p
);
5758 defsubr (&Sinsert_file_contents
);
5759 defsubr (&Swrite_region
);
5760 defsubr (&Scar_less_than_car
);
5761 defsubr (&Sverify_visited_file_modtime
);
5762 defsubr (&Sclear_visited_file_modtime
);
5763 defsubr (&Svisited_file_modtime
);
5764 defsubr (&Sset_visited_file_modtime
);
5765 defsubr (&Sdo_auto_save
);
5766 defsubr (&Sset_buffer_auto_saved
);
5767 defsubr (&Sclear_buffer_auto_save_failure
);
5768 defsubr (&Srecent_auto_save_p
);
5770 defsubr (&Snext_read_file_uses_dialog_p
);
5773 defsubr (&Sunix_sync
);
5777 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
5778 (do not change this comment) */