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>
36 #if !defined (S_ISLNK) && defined (S_IFLNK)
37 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
40 #if !defined (S_ISFIFO) && defined (S_IFIFO)
41 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
44 #if !defined (S_ISREG) && defined (S_IFREG)
45 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
62 #include "intervals.h"
64 #include "character.h"
67 #include "blockinput.h"
69 #include "dispextern.h"
76 #endif /* not WINDOWSNT */
80 #include <sys/param.h>
88 #define CORRECT_DIR_SEPS(s) \
89 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
90 else unixtodos_filename (s); \
92 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
93 redirector allows the six letters between 'Z' and 'a' as well. */
95 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
98 #define IS_DRIVE(x) isalpha (x)
100 /* Need to lower-case the drive letter, or else expanded
101 filenames will sometimes compare inequal, because
102 `expand-file-name' doesn't always down-case the drive letter. */
103 #define DRIVE_LETTER(x) (tolower (x))
112 #include "commands.h"
113 extern int use_dialog_box
;
114 extern int use_file_dialog
;
128 #ifndef FILE_SYSTEM_CASE
129 #define FILE_SYSTEM_CASE(filename) (filename)
132 /* Nonzero during writing of auto-save files */
135 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
136 a new file with the same mode as the original */
137 int auto_save_mode_bits
;
139 /* Set by auto_save_1 if an error occurred during the last auto-save. */
140 int auto_save_error_occurred
;
142 /* The symbol bound to coding-system-for-read when
143 insert-file-contents is called for recovering a file. This is not
144 an actual coding system name, but just an indicator to tell
145 insert-file-contents to use `emacs-mule' with a special flag for
146 auto saving and recovering a file. */
147 Lisp_Object Qauto_save_coding
;
149 /* Coding system for file names, or nil if none. */
150 Lisp_Object Vfile_name_coding_system
;
152 /* Coding system for file names used only when
153 Vfile_name_coding_system is nil. */
154 Lisp_Object Vdefault_file_name_coding_system
;
156 /* Alist of elements (REGEXP . HANDLER) for file names
157 whose I/O is done with a special handler. */
158 Lisp_Object Vfile_name_handler_alist
;
160 /* Property name of a file name handler,
161 which gives a list of operations it handles.. */
162 Lisp_Object Qoperations
;
164 /* Lisp functions for translating file formats */
165 Lisp_Object Qformat_decode
, Qformat_annotate_function
;
167 /* Function to be called to decide a coding system of a reading file. */
168 Lisp_Object Vset_auto_coding_function
;
170 /* Functions to be called to process text properties in inserted file. */
171 Lisp_Object Vafter_insert_file_functions
;
173 /* Lisp function for setting buffer-file-coding-system and the
174 multibyteness of the current buffer after inserting a file. */
175 Lisp_Object Qafter_insert_file_set_coding
;
177 /* Functions to be called to create text property annotations for file. */
178 Lisp_Object Vwrite_region_annotate_functions
;
179 Lisp_Object Qwrite_region_annotate_functions
;
180 Lisp_Object Vwrite_region_post_annotation_function
;
182 /* During build_annotations, each time an annotation function is called,
183 this holds the annotations made by the previous functions. */
184 Lisp_Object Vwrite_region_annotations_so_far
;
186 /* Each time an annotation function changes the buffer, the new buffer
188 Lisp_Object Vwrite_region_annotation_buffers
;
190 /* File name in which we write a list of all our auto save files. */
191 Lisp_Object Vauto_save_list_file_name
;
193 /* Whether or not files are auto-saved into themselves. */
194 Lisp_Object Vauto_save_visited_file_name
;
196 /* Whether or not to continue auto-saving after a large deletion. */
197 Lisp_Object Vauto_save_include_big_deletions
;
199 /* On NT, specifies the directory separator character, used (eg.) when
200 expanding file names. This can be bound to / or \. */
201 Lisp_Object Vdirectory_sep_char
;
204 /* Nonzero means skip the call to fsync in Fwrite-region. */
205 int write_region_inhibit_fsync
;
208 /* Non-zero means call move-file-to-trash in Fdelete_file or
209 Fdelete_directory_internal. */
210 int delete_by_moving_to_trash
;
212 Lisp_Object Qdelete_by_moving_to_trash
;
214 /* Lisp function for moving files to trash. */
215 Lisp_Object Qmove_file_to_trash
;
217 extern Lisp_Object Vuser_login_name
;
220 extern Lisp_Object Vw32_get_true_file_attributes
;
223 extern int minibuf_level
;
225 extern int minibuffer_auto_raise
;
227 /* These variables describe handlers that have "already" had a chance
228 to handle the current operation.
230 Vinhibit_file_name_handlers is a list of file name handlers.
231 Vinhibit_file_name_operation is the operation being handled.
232 If we try to handle that operation, we ignore those handlers. */
234 static Lisp_Object Vinhibit_file_name_handlers
;
235 static Lisp_Object Vinhibit_file_name_operation
;
237 Lisp_Object Qfile_error
, Qfile_already_exists
, Qfile_date_error
;
239 Lisp_Object Qfile_name_history
;
241 Lisp_Object Qcar_less_than_car
;
243 static int a_write
P_ ((int, Lisp_Object
, int, int,
244 Lisp_Object
*, struct coding_system
*));
245 static int e_write
P_ ((int, Lisp_Object
, int, int, struct coding_system
*));
249 report_file_error (string
, data
)
253 Lisp_Object errstring
;
257 synchronize_system_messages_locale ();
258 str
= strerror (errorno
);
259 errstring
= code_convert_string_norecord (make_unibyte_string (str
,
261 Vlocale_coding_system
, 0);
267 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
270 /* System error messages are capitalized. Downcase the initial
271 unless it is followed by a slash. (The slash case caters to
272 error messages that begin with "I/O" or, in German, "E/A".) */
273 if (STRING_MULTIBYTE (errstring
)
274 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
278 str
= (char *) SDATA (errstring
);
279 c
= STRING_CHAR (str
, 0);
280 Faset (errstring
, make_number (0), make_number (DOWNCASE (c
)));
283 xsignal (Qfile_error
,
284 Fcons (build_string (string
), Fcons (errstring
, data
)));
289 close_file_unwind (fd
)
292 emacs_close (XFASTINT (fd
));
296 /* Restore point, having saved it as a marker. */
299 restore_point_unwind (location
)
300 Lisp_Object location
;
302 Fgoto_char (location
);
303 Fset_marker (location
, Qnil
, Qnil
);
308 Lisp_Object Qexpand_file_name
;
309 Lisp_Object Qsubstitute_in_file_name
;
310 Lisp_Object Qdirectory_file_name
;
311 Lisp_Object Qfile_name_directory
;
312 Lisp_Object Qfile_name_nondirectory
;
313 Lisp_Object Qunhandled_file_name_directory
;
314 Lisp_Object Qfile_name_as_directory
;
315 Lisp_Object Qcopy_file
;
316 Lisp_Object Qmake_directory_internal
;
317 Lisp_Object Qmake_directory
;
318 Lisp_Object Qdelete_directory_internal
;
319 Lisp_Object Qdelete_file
;
320 Lisp_Object Qrename_file
;
321 Lisp_Object Qadd_name_to_file
;
322 Lisp_Object Qmake_symbolic_link
;
323 Lisp_Object Qfile_exists_p
;
324 Lisp_Object Qfile_executable_p
;
325 Lisp_Object Qfile_readable_p
;
326 Lisp_Object Qfile_writable_p
;
327 Lisp_Object Qfile_symlink_p
;
328 Lisp_Object Qaccess_file
;
329 Lisp_Object Qfile_directory_p
;
330 Lisp_Object Qfile_regular_p
;
331 Lisp_Object Qfile_accessible_directory_p
;
332 Lisp_Object Qfile_modes
;
333 Lisp_Object Qset_file_modes
;
334 Lisp_Object Qset_file_times
;
335 Lisp_Object Qfile_newer_than_file_p
;
336 Lisp_Object Qinsert_file_contents
;
337 Lisp_Object Qwrite_region
;
338 Lisp_Object Qverify_visited_file_modtime
;
339 Lisp_Object Qset_visited_file_modtime
;
341 DEFUN ("find-file-name-handler", Ffind_file_name_handler
, Sfind_file_name_handler
, 2, 2, 0,
342 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
343 Otherwise, return nil.
344 A file name is handled if one of the regular expressions in
345 `file-name-handler-alist' matches it.
347 If OPERATION equals `inhibit-file-name-operation', then we ignore
348 any handlers that are members of `inhibit-file-name-handlers',
349 but we still do run any other handlers. This lets handlers
350 use the standard functions without calling themselves recursively. */)
351 (filename
, operation
)
352 Lisp_Object filename
, operation
;
354 /* This function must not munge the match data. */
355 Lisp_Object chain
, inhibited_handlers
, result
;
359 CHECK_STRING (filename
);
361 if (EQ (operation
, Vinhibit_file_name_operation
))
362 inhibited_handlers
= Vinhibit_file_name_handlers
;
364 inhibited_handlers
= Qnil
;
366 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
367 chain
= XCDR (chain
))
373 Lisp_Object string
= XCAR (elt
);
375 Lisp_Object handler
= XCDR (elt
);
376 Lisp_Object operations
= Qnil
;
378 if (SYMBOLP (handler
))
379 operations
= Fget (handler
, Qoperations
);
382 && (match_pos
= fast_string_match (string
, filename
)) > pos
383 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
387 handler
= XCDR (elt
);
388 tem
= Fmemq (handler
, inhibited_handlers
);
402 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
404 doc
: /* Return the directory component in file name FILENAME.
405 Return nil if FILENAME does not include a directory.
406 Otherwise return a directory name.
407 Given a Unix syntax file name, returns a string ending in slash. */)
409 Lisp_Object filename
;
412 register const unsigned char *beg
;
414 register unsigned char *beg
;
416 register const unsigned char *p
;
419 CHECK_STRING (filename
);
421 /* If the file name has special constructs in it,
422 call the corresponding file handler. */
423 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
425 return call2 (handler
, Qfile_name_directory
, filename
);
427 filename
= FILE_SYSTEM_CASE (filename
);
429 beg
= (unsigned char *) alloca (SBYTES (filename
) + 1);
430 bcopy (SDATA (filename
), beg
, SBYTES (filename
) + 1);
432 beg
= SDATA (filename
);
434 p
= beg
+ SBYTES (filename
);
436 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
438 /* only recognise drive specifier at the beginning */
440 /* handle the "/:d:foo" and "/:foo" cases correctly */
441 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
442 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
449 /* Expansion of "c:" to drive and default directory. */
452 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
453 unsigned char *res
= alloca (MAXPATHLEN
+ 1);
454 unsigned char *r
= res
;
456 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
458 strncpy (res
, beg
, 2);
463 if (getdefdir (toupper (*beg
) - 'A' + 1, r
))
465 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
468 p
= beg
+ strlen (beg
);
471 CORRECT_DIR_SEPS (beg
);
474 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
477 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
478 Sfile_name_nondirectory
, 1, 1, 0,
479 doc
: /* Return file name FILENAME sans its directory.
480 For example, in a Unix-syntax file name,
481 this is everything after the last slash,
482 or the entire name if it contains no slash. */)
484 Lisp_Object filename
;
486 register const unsigned char *beg
, *p
, *end
;
489 CHECK_STRING (filename
);
491 /* If the file name has special constructs in it,
492 call the corresponding file handler. */
493 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
495 return call2 (handler
, Qfile_name_nondirectory
, filename
);
497 beg
= SDATA (filename
);
498 end
= p
= beg
+ SBYTES (filename
);
500 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
502 /* only recognise drive specifier at beginning */
504 /* handle the "/:d:foo" case correctly */
505 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
510 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
513 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
514 Sunhandled_file_name_directory
, 1, 1, 0,
515 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
516 A `directly usable' directory name is one that may be used without the
517 intervention of any file handler.
518 If FILENAME is a directly usable file itself, return
519 \(file-name-directory FILENAME).
520 If FILENAME refers to a file which is not accessible from a local process,
521 then this should return nil.
522 The `call-process' and `start-process' functions use this function to
523 get a current directory to run processes in. */)
525 Lisp_Object filename
;
529 /* If the file name has special constructs in it,
530 call the corresponding file handler. */
531 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
533 return call2 (handler
, Qunhandled_file_name_directory
, filename
);
535 return Ffile_name_directory (filename
);
540 file_name_as_directory (out
, in
)
543 int size
= strlen (in
) - 1;
555 /* For Unix syntax, Append a slash if necessary */
556 if (!IS_DIRECTORY_SEP (out
[size
]))
558 /* Cannot use DIRECTORY_SEP, which could have any value */
560 out
[size
+ 2] = '\0';
563 CORRECT_DIR_SEPS (out
);
568 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
569 Sfile_name_as_directory
, 1, 1, 0,
570 doc
: /* Return a string representing the file name FILE interpreted as a directory.
571 This operation exists because a directory is also a file, but its name as
572 a directory is different from its name as a file.
573 The result can be used as the value of `default-directory'
574 or passed as second argument to `expand-file-name'.
575 For a Unix-syntax file name, just appends a slash. */)
586 /* If the file name has special constructs in it,
587 call the corresponding file handler. */
588 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
590 return call2 (handler
, Qfile_name_as_directory
, file
);
592 buf
= (char *) alloca (SBYTES (file
) + 10);
593 file_name_as_directory (buf
, SDATA (file
));
594 return make_specified_string (buf
, -1, strlen (buf
),
595 STRING_MULTIBYTE (file
));
599 * Convert from directory name to filename.
600 * On UNIX, it's simple: just make sure there isn't a terminating /
602 * Value is nonzero if the string output is different from the input.
606 directory_file_name (src
, dst
)
613 /* Process as Unix format: just remove any final slash.
614 But leave "/" unchanged; do not change it to "". */
617 && IS_DIRECTORY_SEP (dst
[slen
- 1])
619 && !IS_ANY_SEP (dst
[slen
- 2])
624 CORRECT_DIR_SEPS (dst
);
629 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
631 doc
: /* Returns the file name of the directory named DIRECTORY.
632 This is the name of the file that holds the data for the directory DIRECTORY.
633 This operation exists because a directory is also a file, but its name as
634 a directory is different from its name as a file.
635 In Unix-syntax, this function just removes the final slash. */)
637 Lisp_Object directory
;
642 CHECK_STRING (directory
);
644 if (NILP (directory
))
647 /* If the file name has special constructs in it,
648 call the corresponding file handler. */
649 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
651 return call2 (handler
, Qdirectory_file_name
, directory
);
653 buf
= (char *) alloca (SBYTES (directory
) + 20);
654 directory_file_name (SDATA (directory
), buf
);
655 return make_specified_string (buf
, -1, strlen (buf
),
656 STRING_MULTIBYTE (directory
));
659 static char make_temp_name_tbl
[64] =
661 'A','B','C','D','E','F','G','H',
662 'I','J','K','L','M','N','O','P',
663 'Q','R','S','T','U','V','W','X',
664 'Y','Z','a','b','c','d','e','f',
665 'g','h','i','j','k','l','m','n',
666 'o','p','q','r','s','t','u','v',
667 'w','x','y','z','0','1','2','3',
668 '4','5','6','7','8','9','-','_'
671 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
673 /* Value is a temporary file name starting with PREFIX, a string.
675 The Emacs process number forms part of the result, so there is
676 no danger of generating a name being used by another process.
677 In addition, this function makes an attempt to choose a name
678 which has no existing file. To make this work, PREFIX should be
679 an absolute file name.
681 BASE64_P non-zero means add the pid as 3 characters in base64
682 encoding. In this case, 6 characters will be added to PREFIX to
683 form the file name. Otherwise, if Emacs is running on a system
684 with long file names, add the pid as a decimal number.
686 This function signals an error if no unique file name could be
690 make_temp_name (prefix
, base64_p
)
697 unsigned char *p
, *data
;
701 CHECK_STRING (prefix
);
703 /* VAL is created by adding 6 characters to PREFIX. The first
704 three are the PID of this process, in base 64, and the second
705 three are incremented if the file already exists. This ensures
706 262144 unique file names per PID per PREFIX. */
708 pid
= (int) getpid ();
712 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
713 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
714 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
719 #ifdef HAVE_LONG_FILE_NAMES
720 sprintf (pidbuf
, "%d", pid
);
721 pidlen
= strlen (pidbuf
);
723 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
724 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
725 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
730 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
731 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
732 if (!STRING_MULTIBYTE (prefix
))
733 STRING_SET_UNIBYTE (val
);
735 bcopy(SDATA (prefix
), data
, len
);
738 bcopy (pidbuf
, p
, pidlen
);
741 /* Here we try to minimize useless stat'ing when this function is
742 invoked many times successively with the same PREFIX. We achieve
743 this by initializing count to a random value, and incrementing it
746 We don't want make-temp-name to be called while dumping,
747 because then make_temp_name_count_initialized_p would get set
748 and then make_temp_name_count would not be set when Emacs starts. */
750 if (!make_temp_name_count_initialized_p
)
752 make_temp_name_count
= (unsigned) time (NULL
);
753 make_temp_name_count_initialized_p
= 1;
759 unsigned num
= make_temp_name_count
;
761 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
762 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
763 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
765 /* Poor man's congruential RN generator. Replace with
766 ++make_temp_name_count for debugging. */
767 make_temp_name_count
+= 25229;
768 make_temp_name_count
%= 225307;
770 if (stat (data
, &ignored
) < 0)
772 /* We want to return only if errno is ENOENT. */
776 /* The error here is dubious, but there is little else we
777 can do. The alternatives are to return nil, which is
778 as bad as (and in many cases worse than) throwing the
779 error, or to ignore the error, which will likely result
780 in looping through 225307 stat's, which is not only
781 dog-slow, but also useless since it will fallback to
782 the errow below, anyway. */
783 report_file_error ("Cannot create temporary name for prefix",
784 Fcons (prefix
, Qnil
));
789 error ("Cannot create temporary name for prefix `%s'",
795 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
796 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
797 The Emacs process number forms part of the result,
798 so there is no danger of generating a name being used by another process.
800 In addition, this function makes an attempt to choose a name
801 which has no existing file. To make this work,
802 PREFIX should be an absolute file name.
804 There is a race condition between calling `make-temp-name' and creating the
805 file which opens all kinds of security holes. For that reason, you should
806 probably use `make-temp-file' instead, except in three circumstances:
808 * If you are creating the file in the user's home directory.
809 * If you are creating a directory rather than an ordinary file.
810 * If you are taking special precautions as `make-temp-file' does. */)
814 return make_temp_name (prefix
, 0);
819 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
820 doc
: /* Convert filename NAME to absolute, and canonicalize it.
821 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
822 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
823 the current buffer's value of `default-directory' is used.
824 File name components that are `.' are removed, and
825 so are file name components followed by `..', along with the `..' itself;
826 note that these simplifications are done without checking the resulting
827 file names in the file system.
828 An initial `~/' expands to your home directory.
829 An initial `~USER/' expands to USER's home directory.
830 See also the function `substitute-in-file-name'.
832 For technical reasons, this function can return correct but
833 non-intuitive results for the root directory; for instance,
834 \(expand-file-name ".." "/") returns "/..". For this reason, use
835 (directory-file-name (file-name-directory dirname)) to traverse a
836 filesystem tree, not (expand-file-name ".." dirname). */)
837 (name
, default_directory
)
838 Lisp_Object name
, default_directory
;
840 /* These point to SDATA and need to be careful with string-relocation
841 during GC (via DECODE_FILE). */
842 unsigned char *nm
, *newdir
;
843 /* This should only point to alloca'd data. */
844 unsigned char *target
;
850 int collapse_newdir
= 1;
854 Lisp_Object handler
, result
;
860 /* If the file name has special constructs in it,
861 call the corresponding file handler. */
862 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
864 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
866 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
867 if (NILP (default_directory
))
868 default_directory
= current_buffer
->directory
;
869 if (! STRINGP (default_directory
))
872 /* "/" is not considered a root directory on DOS_NT, so using "/"
873 here causes an infinite recursion in, e.g., the following:
875 (let (default-directory)
876 (expand-file-name "a"))
878 To avoid this, we set default_directory to the root of the
880 extern char *emacs_root_dir (void);
882 default_directory
= build_string (emacs_root_dir ());
884 default_directory
= build_string ("/");
888 if (!NILP (default_directory
))
890 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
892 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
896 unsigned char *o
= SDATA (default_directory
);
898 /* Make sure DEFAULT_DIRECTORY is properly expanded.
899 It would be better to do this down below where we actually use
900 default_directory. Unfortunately, calling Fexpand_file_name recursively
901 could invoke GC, and the strings might be relocated. This would
902 be annoying because we have pointers into strings lying around
903 that would need adjusting, and people would add new pointers to
904 the code and forget to adjust them, resulting in intermittent bugs.
905 Putting this call here avoids all that crud.
907 The EQ test avoids infinite recursion. */
908 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
909 /* Save time in some common cases - as long as default_directory
910 is not relative, it can be canonicalized with name below (if it
911 is needed at all) without requiring it to be expanded now. */
913 /* Detect MSDOS file names with drive specifiers. */
914 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
915 && IS_DIRECTORY_SEP (o
[2]))
917 /* Detect Windows file names in UNC format. */
918 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
920 #else /* not DOS_NT */
921 /* Detect Unix absolute file names (/... alone is not absolute on
923 && ! (IS_DIRECTORY_SEP (o
[0]))
924 #endif /* not DOS_NT */
930 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
934 name
= FILE_SYSTEM_CASE (name
);
935 multibyte
= STRING_MULTIBYTE (name
);
936 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
939 default_directory
= string_to_multibyte (default_directory
);
942 name
= string_to_multibyte (name
);
947 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
948 nm
= (unsigned char *) alloca (SBYTES (name
) + 1);
949 bcopy (SDATA (name
), nm
, SBYTES (name
) + 1);
952 /* Note if special escape prefix is present, but remove for now. */
953 if (nm
[0] == '/' && nm
[1] == ':')
959 /* Find and remove drive specifier if present; this makes nm absolute
960 even if the rest of the name appears to be relative. Only look for
961 drive specifier at the beginning. */
962 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
969 /* If we see "c://somedir", we want to strip the first slash after the
970 colon when stripping the drive letter. Otherwise, this expands to
972 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
975 /* Discard any previous drive specifier if nm is now in UNC format. */
976 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
980 #endif /* WINDOWSNT */
983 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
984 none are found, we can probably return right away. We will avoid
985 allocating a new string if name is already fully expanded. */
987 IS_DIRECTORY_SEP (nm
[0])
989 && drive
&& !is_escaped
992 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
996 /* If it turns out that the filename we want to return is just a
997 suffix of FILENAME, we don't need to go through and edit
998 things; we just need to construct a new string using data
999 starting at the middle of FILENAME. If we set lose to a
1000 non-zero value, that means we've discovered that we can't do
1003 unsigned char *p
= nm
;
1007 /* Since we know the name is absolute, we can assume that each
1008 element starts with a "/". */
1010 /* "." and ".." are hairy. */
1011 if (IS_DIRECTORY_SEP (p
[0])
1013 && (IS_DIRECTORY_SEP (p
[2])
1015 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1018 /* We want to replace multiple `/' in a row with a single
1021 && IS_DIRECTORY_SEP (p
[0])
1022 && IS_DIRECTORY_SEP (p
[1]))
1029 /* Make sure directories are all separated with / or \ as
1030 desired, but avoid allocation of a new string when not
1032 CORRECT_DIR_SEPS (nm
);
1034 if (IS_DIRECTORY_SEP (nm
[1]))
1036 if (strcmp (nm
, SDATA (name
)) != 0)
1037 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1041 /* drive must be set, so this is okay */
1042 if (strcmp (nm
- 2, SDATA (name
)) != 0)
1046 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1047 temp
[0] = DRIVE_LETTER (drive
);
1048 name
= concat2 (build_string (temp
), name
);
1051 #else /* not DOS_NT */
1052 if (strcmp (nm
, SDATA (name
)) == 0)
1054 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1055 #endif /* not DOS_NT */
1059 /* At this point, nm might or might not be an absolute file name. We
1060 need to expand ~ or ~user if present, otherwise prefix nm with
1061 default_directory if nm is not absolute, and finally collapse /./
1062 and /foo/../ sequences.
1064 We set newdir to be the appropriate prefix if one is needed:
1065 - the relevant user directory if nm starts with ~ or ~user
1066 - the specified drive's working dir (DOS/NT only) if nm does not
1068 - the value of default_directory.
1070 Note that these prefixes are not guaranteed to be absolute (except
1071 for the working dir of a drive). Therefore, to ensure we always
1072 return an absolute name, if the final prefix is not absolute we
1073 append it to the current working directory. */
1077 if (nm
[0] == '~') /* prefix ~ */
1079 if (IS_DIRECTORY_SEP (nm
[1])
1080 || nm
[1] == 0) /* ~ by itself */
1084 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1085 newdir
= (unsigned char *) "";
1087 /* egetenv may return a unibyte string, which will bite us since
1088 we expect the directory to be multibyte. */
1089 tem
= build_string (newdir
);
1090 if (!STRING_MULTIBYTE (tem
))
1092 hdir
= DECODE_FILE (tem
);
1093 newdir
= SDATA (hdir
);
1096 collapse_newdir
= 0;
1099 else /* ~user/filename */
1101 unsigned char *o
, *p
;
1102 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1103 o
= alloca (p
- nm
+ 1);
1104 bcopy ((char *) nm
, o
, p
- nm
);
1108 pw
= (struct passwd
*) getpwnam (o
+ 1);
1112 newdir
= (unsigned char *) pw
-> pw_dir
;
1115 collapse_newdir
= 0;
1119 /* If we don't find a user of that name, leave the name
1120 unchanged; don't move nm forward to p. */
1125 /* On DOS and Windows, nm is absolute if a drive name was specified;
1126 use the drive's current directory as the prefix if needed. */
1127 if (!newdir
&& drive
)
1129 /* Get default directory if needed to make nm absolute. */
1130 if (!IS_DIRECTORY_SEP (nm
[0]))
1132 newdir
= alloca (MAXPATHLEN
+ 1);
1133 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1138 /* Either nm starts with /, or drive isn't mounted. */
1139 newdir
= alloca (4);
1140 newdir
[0] = DRIVE_LETTER (drive
);
1148 /* Finally, if no prefix has been specified and nm is not absolute,
1149 then it must be expanded relative to default_directory. */
1153 /* /... alone is not absolute on DOS and Windows. */
1154 && !IS_DIRECTORY_SEP (nm
[0])
1157 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1161 newdir
= SDATA (default_directory
);
1163 /* Note if special escape prefix is present, but remove for now. */
1164 if (newdir
[0] == '/' && newdir
[1] == ':')
1175 /* First ensure newdir is an absolute name. */
1177 /* Detect MSDOS file names with drive specifiers. */
1178 ! (IS_DRIVE (newdir
[0])
1179 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1181 /* Detect Windows file names in UNC format. */
1182 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1186 /* Effectively, let newdir be (expand-file-name newdir cwd).
1187 Because of the admonition against calling expand-file-name
1188 when we have pointers into lisp strings, we accomplish this
1189 indirectly by prepending newdir to nm if necessary, and using
1190 cwd (or the wd of newdir's drive) as the new newdir. */
1192 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1197 if (!IS_DIRECTORY_SEP (nm
[0]))
1199 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1200 file_name_as_directory (tmp
, newdir
);
1204 newdir
= alloca (MAXPATHLEN
+ 1);
1207 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1214 /* Strip off drive name from prefix, if present. */
1215 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1221 /* Keep only a prefix from newdir if nm starts with slash
1222 (//server/share for UNC, nothing otherwise). */
1223 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1226 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1229 newdir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1231 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1233 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1245 /* Get rid of any slash at the end of newdir, unless newdir is
1246 just / or // (an incomplete UNC name). */
1247 length
= strlen (newdir
);
1248 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1250 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1254 unsigned char *temp
= (unsigned char *) alloca (length
);
1255 bcopy (newdir
, temp
, length
- 1);
1256 temp
[length
- 1] = 0;
1264 /* Now concatenate the directory and name to new space in the stack frame */
1265 tlen
+= strlen (nm
) + 1;
1267 /* Reserve space for drive specifier and escape prefix, since either
1268 or both may need to be inserted. (The Microsoft x86 compiler
1269 produces incorrect code if the following two lines are combined.) */
1270 target
= (unsigned char *) alloca (tlen
+ 4);
1272 #else /* not DOS_NT */
1273 target
= (unsigned char *) alloca (tlen
);
1274 #endif /* not DOS_NT */
1279 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1282 /* If newdir is effectively "C:/", then the drive letter will have
1283 been stripped and newdir will be "/". Concatenating with an
1284 absolute directory in nm produces "//", which will then be
1285 incorrectly treated as a network share. Ignore newdir in
1286 this case (keeping the drive letter). */
1287 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1288 && newdir
[1] == '\0'))
1290 strcpy (target
, newdir
);
1293 file_name_as_directory (target
, newdir
);
1296 strcat (target
, nm
);
1298 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1301 unsigned char *p
= target
;
1302 unsigned char *o
= target
;
1306 if (!IS_DIRECTORY_SEP (*p
))
1310 else if (p
[1] == '.'
1311 && (IS_DIRECTORY_SEP (p
[2])
1314 /* If "/." is the entire filename, keep the "/". Otherwise,
1315 just delete the whole "/.". */
1316 if (o
== target
&& p
[2] == '\0')
1320 else if (p
[1] == '.' && p
[2] == '.'
1321 /* `/../' is the "superroot" on certain file systems.
1322 Turned off on DOS_NT systems because they have no
1323 "superroot" and because this causes us to produce
1324 file names like "d:/../foo" which fail file-related
1325 functions of the underlying OS. (To reproduce, try a
1326 long series of "../../" in default_directory, longer
1327 than the number of levels from the root.) */
1331 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1334 unsigned char *prev_o
= o
;
1336 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1339 /* Don't go below server level in UNC filenames. */
1340 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1341 && IS_DIRECTORY_SEP (*target
))
1345 /* Keep initial / only if this is the whole name. */
1346 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1350 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1351 /* Collapse multiple `/' in a row. */
1360 /* At last, set drive name. */
1362 /* Except for network file name. */
1363 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1364 #endif /* WINDOWSNT */
1366 if (!drive
) abort ();
1368 target
[0] = DRIVE_LETTER (drive
);
1371 /* Reinsert the escape prefix if required. */
1378 CORRECT_DIR_SEPS (target
);
1381 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1384 /* Again look to see if the file name has special constructs in it
1385 and perhaps call the corresponding file handler. This is needed
1386 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1387 the ".." component gives us "/user@host:/bar/../baz" which needs
1388 to be expanded again. */
1389 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1390 if (!NILP (handler
))
1391 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1397 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1398 This is the old version of expand-file-name, before it was thoroughly
1399 rewritten for Emacs 10.31. We leave this version here commented-out,
1400 because the code is very complex and likely to have subtle bugs. If
1401 bugs _are_ found, it might be of interest to look at the old code and
1402 see what did it do in the relevant situation.
1404 Don't remove this code: it's true that it will be accessible via CVS,
1405 but a few years from deletion, people will forget it is there. */
1407 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1408 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1409 "Convert FILENAME to absolute, and canonicalize it.\n\
1410 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1411 \(does not start with slash); if DEFAULT is nil or missing,\n\
1412 the current buffer's value of default-directory is used.\n\
1413 Filenames containing `.' or `..' as components are simplified;\n\
1414 initial `~/' expands to your home directory.\n\
1415 See also the function `substitute-in-file-name'.")
1417 Lisp_Object name
, defalt
;
1421 register unsigned char *newdir
, *p
, *o
;
1423 unsigned char *target
;
1427 CHECK_STRING (name
);
1430 /* If nm is absolute, flush ...// and detect /./ and /../.
1431 If no /./ or /../ we can return right away. */
1438 if (p
[0] == '/' && p
[1] == '/'
1441 if (p
[0] == '/' && p
[1] == '~')
1442 nm
= p
+ 1, lose
= 1;
1443 if (p
[0] == '/' && p
[1] == '.'
1444 && (p
[2] == '/' || p
[2] == 0
1445 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1451 if (nm
== SDATA (name
))
1453 return build_string (nm
);
1457 /* Now determine directory to start with and put it in NEWDIR */
1461 if (nm
[0] == '~') /* prefix ~ */
1462 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1464 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1465 newdir
= (unsigned char *) "";
1468 else /* ~user/filename */
1470 /* Get past ~ to user */
1471 unsigned char *user
= nm
+ 1;
1472 /* Find end of name. */
1473 unsigned char *ptr
= (unsigned char *) index (user
, '/');
1474 int len
= ptr
? ptr
- user
: strlen (user
);
1475 /* Copy the user name into temp storage. */
1476 o
= (unsigned char *) alloca (len
+ 1);
1477 bcopy ((char *) user
, o
, len
);
1480 /* Look up the user name. */
1482 pw
= (struct passwd
*) getpwnam (o
+ 1);
1485 error ("\"%s\" isn't a registered user", o
+ 1);
1487 newdir
= (unsigned char *) pw
->pw_dir
;
1489 /* Discard the user name from NM. */
1493 if (nm
[0] != '/' && !newdir
)
1496 defalt
= current_buffer
->directory
;
1497 CHECK_STRING (defalt
);
1498 newdir
= SDATA (defalt
);
1501 /* Now concatenate the directory and name to new space in the stack frame */
1503 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1504 target
= (unsigned char *) alloca (tlen
);
1509 if (nm
[0] == 0 || nm
[0] == '/')
1510 strcpy (target
, newdir
);
1512 file_name_as_directory (target
, newdir
);
1515 strcat (target
, nm
);
1517 /* Now canonicalize by removing /. and /foo/.. if they appear */
1528 else if (!strncmp (p
, "//", 2)
1534 else if (p
[0] == '/' && p
[1] == '.'
1535 && (p
[2] == '/' || p
[2] == 0))
1537 else if (!strncmp (p
, "/..", 3)
1538 /* `/../' is the "superroot" on certain file systems. */
1540 && (p
[3] == '/' || p
[3] == 0))
1542 while (o
!= target
&& *--o
!= '/')
1544 if (o
== target
&& *o
== '/')
1554 return make_string (target
, o
- target
);
1558 /* If /~ or // appears, discard everything through first slash. */
1560 file_name_absolute_p (filename
)
1561 const unsigned char *filename
;
1564 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1566 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1567 && IS_DIRECTORY_SEP (filename
[2]))
1572 static unsigned char *
1573 search_embedded_absfilename (nm
, endp
)
1574 unsigned char *nm
, *endp
;
1576 unsigned char *p
, *s
;
1578 for (p
= nm
+ 1; p
< endp
; p
++)
1581 || IS_DIRECTORY_SEP (p
[-1]))
1582 && file_name_absolute_p (p
)
1583 #if defined (WINDOWSNT) || defined(CYGWIN)
1584 /* // at start of file name is meaningful in Apollo,
1585 WindowsNT and Cygwin systems. */
1586 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1587 #endif /* not (WINDOWSNT || CYGWIN) */
1590 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1591 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
1593 unsigned char *o
= alloca (s
- p
+ 1);
1595 bcopy (p
, o
, s
- p
);
1598 /* If we have ~user and `user' exists, discard
1599 everything up to ~. But if `user' does not exist, leave
1600 ~user alone, it might be a literal file name. */
1602 pw
= getpwnam (o
+ 1);
1614 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1615 Ssubstitute_in_file_name
, 1, 1, 0,
1616 doc
: /* Substitute environment variables referred to in FILENAME.
1617 `$FOO' where FOO is an environment variable name means to substitute
1618 the value of that variable. The variable name should be terminated
1619 with a character not a letter, digit or underscore; otherwise, enclose
1620 the entire variable name in braces.
1622 If `/~' appears, all of FILENAME through that `/' is discarded.
1623 If `//' appears, everything up to and including the first of
1624 those `/' is discarded. */)
1626 Lisp_Object filename
;
1630 register unsigned char *s
, *p
, *o
, *x
, *endp
;
1631 unsigned char *target
= NULL
;
1633 int substituted
= 0;
1636 Lisp_Object handler
;
1638 CHECK_STRING (filename
);
1640 multibyte
= STRING_MULTIBYTE (filename
);
1642 /* If the file name has special constructs in it,
1643 call the corresponding file handler. */
1644 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1645 if (!NILP (handler
))
1646 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
1648 /* Always work on a copy of the string, in case GC happens during
1649 decode of environment variables, causing the original Lisp_String
1650 data to be relocated. */
1651 nm
= (unsigned char *) alloca (SBYTES (filename
) + 1);
1652 bcopy (SDATA (filename
), nm
, SBYTES (filename
) + 1);
1655 CORRECT_DIR_SEPS (nm
);
1656 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1658 endp
= nm
+ SBYTES (filename
);
1660 /* If /~ or // appears, discard everything through first slash. */
1661 p
= search_embedded_absfilename (nm
, endp
);
1663 /* Start over with the new string, so we check the file-name-handler
1664 again. Important with filenames like "/home/foo//:/hello///there"
1665 which whould substitute to "/:/hello///there" rather than "/there". */
1666 return Fsubstitute_in_file_name
1667 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1669 /* See if any variables are substituted into the string
1670 and find the total length of their values in `total' */
1672 for (p
= nm
; p
!= endp
;)
1682 /* "$$" means a single "$" */
1691 while (p
!= endp
&& *p
!= '}') p
++;
1692 if (*p
!= '}') goto missingclose
;
1698 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1702 /* Copy out the variable name */
1703 target
= (unsigned char *) alloca (s
- o
+ 1);
1704 strncpy (target
, o
, s
- o
);
1707 strupr (target
); /* $home == $HOME etc. */
1710 /* Get variable value */
1711 o
= (unsigned char *) egetenv (target
);
1714 /* Don't try to guess a maximum length - UTF8 can use up to
1715 four bytes per character. This code is unlikely to run
1716 in a situation that requires performance, so decoding the
1717 env variables twice should be acceptable. Note that
1718 decoding may cause a garbage collect. */
1719 Lisp_Object orig
, decoded
;
1720 orig
= make_unibyte_string (o
, strlen (o
));
1721 decoded
= DECODE_FILE (orig
);
1722 total
+= SBYTES (decoded
);
1732 /* If substitution required, recopy the string and do it */
1733 /* Make space in stack frame for the new copy */
1734 xnm
= (unsigned char *) alloca (SBYTES (filename
) + total
+ 1);
1737 /* Copy the rest of the name through, replacing $ constructs with values */
1754 while (p
!= endp
&& *p
!= '}') p
++;
1755 if (*p
!= '}') goto missingclose
;
1761 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1765 /* Copy out the variable name */
1766 target
= (unsigned char *) alloca (s
- o
+ 1);
1767 strncpy (target
, o
, s
- o
);
1770 strupr (target
); /* $home == $HOME etc. */
1773 /* Get variable value */
1774 o
= (unsigned char *) egetenv (target
);
1778 strcpy (x
, target
); x
+= strlen (target
);
1782 Lisp_Object orig
, decoded
;
1783 int orig_length
, decoded_length
;
1784 orig_length
= strlen (o
);
1785 orig
= make_unibyte_string (o
, orig_length
);
1786 decoded
= DECODE_FILE (orig
);
1787 decoded_length
= SBYTES (decoded
);
1788 strncpy (x
, SDATA (decoded
), decoded_length
);
1789 x
+= decoded_length
;
1791 /* If environment variable needed decoding, return value
1792 needs to be multibyte. */
1793 if (decoded_length
!= orig_length
1794 || strncmp (SDATA (decoded
), o
, orig_length
))
1801 /* If /~ or // appears, discard everything through first slash. */
1802 while ((p
= search_embedded_absfilename (xnm
, x
)))
1803 /* This time we do not start over because we've already expanded envvars
1804 and replaced $$ with $. Maybe we should start over as well, but we'd
1805 need to quote some $ to $$ first. */
1808 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1811 error ("Bad format environment-variable substitution");
1813 error ("Missing \"}\" in environment-variable substitution");
1815 error ("Substituting nonexistent environment variable \"%s\"", target
);
1821 /* A slightly faster and more convenient way to get
1822 (directory-file-name (expand-file-name FOO)). */
1825 expand_and_dir_to_file (filename
, defdir
)
1826 Lisp_Object filename
, defdir
;
1828 register Lisp_Object absname
;
1830 absname
= Fexpand_file_name (filename
, defdir
);
1832 /* Remove final slash, if any (unless this is the root dir).
1833 stat behaves differently depending! */
1834 if (SCHARS (absname
) > 1
1835 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1836 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
1837 /* We cannot take shortcuts; they might be wrong for magic file names. */
1838 absname
= Fdirectory_file_name (absname
);
1842 /* Signal an error if the file ABSNAME already exists.
1843 If INTERACTIVE is nonzero, ask the user whether to proceed,
1844 and bypass the error if the user says to go ahead.
1845 QUERYSTRING is a name for the action that is being considered
1848 *STATPTR is used to store the stat information if the file exists.
1849 If the file does not exist, STATPTR->st_mode is set to 0.
1850 If STATPTR is null, we don't store into it.
1852 If QUICK is nonzero, we ask for y or n, not yes or no. */
1855 barf_or_query_if_file_exists (absname
, querystring
, interactive
, statptr
, quick
)
1856 Lisp_Object absname
;
1857 unsigned char *querystring
;
1859 struct stat
*statptr
;
1862 register Lisp_Object tem
, encoded_filename
;
1863 struct stat statbuf
;
1864 struct gcpro gcpro1
;
1866 encoded_filename
= ENCODE_FILE (absname
);
1868 /* stat is a good way to tell whether the file exists,
1869 regardless of what access permissions it has. */
1870 if (lstat (SDATA (encoded_filename
), &statbuf
) >= 0)
1873 xsignal2 (Qfile_already_exists
,
1874 build_string ("File already exists"), absname
);
1876 tem
= format2 ("File %s already exists; %s anyway? ",
1877 absname
, build_string (querystring
));
1879 tem
= Fy_or_n_p (tem
);
1881 tem
= do_yes_or_no_p (tem
);
1884 xsignal2 (Qfile_already_exists
,
1885 build_string ("File already exists"), absname
);
1892 statptr
->st_mode
= 0;
1897 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 5,
1898 "fCopy file: \nGCopy %s to file: \np\nP",
1899 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1900 If NEWNAME names a directory, copy FILE there.
1902 This function always sets the file modes of the output file to match
1905 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1906 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1907 signal a `file-already-exists' error without overwriting. If
1908 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1909 about overwriting; this is what happens in interactive use with M-x.
1910 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1913 Fourth arg KEEP-TIME non-nil means give the output file the same
1914 last-modified time as the old one. (This works on only some systems.)
1916 A prefix arg makes KEEP-TIME non-nil.
1918 If PRESERVE-UID-GID is non-nil, we try to transfer the
1919 uid and gid of FILE to NEWNAME. */)
1920 (file
, newname
, ok_if_already_exists
, keep_time
, preserve_uid_gid
)
1921 Lisp_Object file
, newname
, ok_if_already_exists
, keep_time
;
1922 Lisp_Object preserve_uid_gid
;
1925 char buf
[16 * 1024];
1926 struct stat st
, out_st
;
1927 Lisp_Object handler
;
1928 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1929 int count
= SPECPDL_INDEX ();
1930 int input_file_statable_p
;
1931 Lisp_Object encoded_file
, encoded_newname
;
1933 encoded_file
= encoded_newname
= Qnil
;
1934 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1935 CHECK_STRING (file
);
1936 CHECK_STRING (newname
);
1938 if (!NILP (Ffile_directory_p (newname
)))
1939 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1941 newname
= Fexpand_file_name (newname
, Qnil
);
1943 file
= Fexpand_file_name (file
, Qnil
);
1945 /* If the input file name has special constructs in it,
1946 call the corresponding file handler. */
1947 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1948 /* Likewise for output file name. */
1950 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1951 if (!NILP (handler
))
1952 RETURN_UNGCPRO (call6 (handler
, Qcopy_file
, file
, newname
,
1953 ok_if_already_exists
, keep_time
, preserve_uid_gid
));
1955 encoded_file
= ENCODE_FILE (file
);
1956 encoded_newname
= ENCODE_FILE (newname
);
1958 if (NILP (ok_if_already_exists
)
1959 || INTEGERP (ok_if_already_exists
))
1960 barf_or_query_if_file_exists (newname
, "copy to it",
1961 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1962 else if (stat (SDATA (encoded_newname
), &out_st
) < 0)
1966 if (!CopyFile (SDATA (encoded_file
),
1967 SDATA (encoded_newname
),
1969 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1970 /* CopyFile retains the timestamp by default. */
1971 else if (NILP (keep_time
))
1977 EMACS_GET_TIME (now
);
1978 filename
= SDATA (encoded_newname
);
1980 /* Ensure file is writable while its modified time is set. */
1981 attributes
= GetFileAttributes (filename
);
1982 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1983 if (set_file_times (filename
, now
, now
))
1985 /* Restore original attributes. */
1986 SetFileAttributes (filename
, attributes
);
1987 xsignal2 (Qfile_date_error
,
1988 build_string ("Cannot set file date"), newname
);
1990 /* Restore original attributes. */
1991 SetFileAttributes (filename
, attributes
);
1993 #else /* not WINDOWSNT */
1995 ifd
= emacs_open (SDATA (encoded_file
), O_RDONLY
, 0);
1999 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2001 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2003 /* We can only copy regular files and symbolic links. Other files are not
2005 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
2007 #if !defined (MSDOS) || __DJGPP__ > 1
2008 if (out_st
.st_mode
!= 0
2009 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2012 report_file_error ("Input and output files are the same",
2013 Fcons (file
, Fcons (newname
, Qnil
)));
2017 #if defined (S_ISREG) && defined (S_ISLNK)
2018 if (input_file_statable_p
)
2020 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
2022 #if defined (EISDIR)
2023 /* Get a better looking error message. */
2026 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2029 #endif /* S_ISREG && S_ISLNK */
2032 /* System's default file type was set to binary by _fmode in emacs.c. */
2033 ofd
= emacs_open (SDATA (encoded_newname
),
2034 O_WRONLY
| O_TRUNC
| O_CREAT
2035 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2036 S_IREAD
| S_IWRITE
);
2037 #else /* not MSDOS */
2038 ofd
= emacs_open (SDATA (encoded_newname
),
2039 O_WRONLY
| O_TRUNC
| O_CREAT
2040 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2042 #endif /* not MSDOS */
2044 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2046 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2050 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2051 if (emacs_write (ofd
, buf
, n
) != n
)
2052 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2056 /* Preserve the original file modes, and if requested, also its
2058 if (input_file_statable_p
)
2060 if (! NILP (preserve_uid_gid
))
2061 fchown (ofd
, st
.st_uid
, st
.st_gid
);
2062 fchmod (ofd
, st
.st_mode
& 07777);
2064 #endif /* not MSDOS */
2066 /* Closing the output clobbers the file times on some systems. */
2067 if (emacs_close (ofd
) < 0)
2068 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2070 if (input_file_statable_p
)
2072 if (!NILP (keep_time
))
2074 EMACS_TIME atime
, mtime
;
2075 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
2076 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
2077 if (set_file_times (SDATA (encoded_newname
),
2079 xsignal2 (Qfile_date_error
,
2080 build_string ("Cannot set file date"), newname
);
2086 #if defined (__DJGPP__) && __DJGPP__ > 1
2087 if (input_file_statable_p
)
2089 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2090 and if it can't, it tells so. Otherwise, under MSDOS we usually
2091 get only the READ bit, which will make the copied file read-only,
2092 so it's better not to chmod at all. */
2093 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2094 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2096 #endif /* DJGPP version 2 or newer */
2097 #endif /* not WINDOWSNT */
2099 /* Discard the unwind protects. */
2100 specpdl_ptr
= specpdl
+ count
;
2106 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2107 Smake_directory_internal
, 1, 1, 0,
2108 doc
: /* Create a new directory named DIRECTORY. */)
2110 Lisp_Object directory
;
2112 const unsigned char *dir
;
2113 Lisp_Object handler
;
2114 Lisp_Object encoded_dir
;
2116 CHECK_STRING (directory
);
2117 directory
= Fexpand_file_name (directory
, Qnil
);
2119 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2120 if (!NILP (handler
))
2121 return call2 (handler
, Qmake_directory_internal
, directory
);
2123 encoded_dir
= ENCODE_FILE (directory
);
2125 dir
= SDATA (encoded_dir
);
2128 if (mkdir (dir
) != 0)
2130 if (mkdir (dir
, 0777) != 0)
2132 report_file_error ("Creating directory", list1 (directory
));
2137 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2138 Sdelete_directory_internal
, 1, 1, 0,
2139 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2141 Lisp_Object directory
;
2143 const unsigned char *dir
;
2144 Lisp_Object handler
;
2145 Lisp_Object encoded_dir
;
2147 CHECK_STRING (directory
);
2148 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2150 if (delete_by_moving_to_trash
)
2151 return call1 (Qmove_file_to_trash
, directory
);
2153 encoded_dir
= ENCODE_FILE (directory
);
2155 dir
= SDATA (encoded_dir
);
2157 if (rmdir (dir
) != 0)
2158 report_file_error ("Removing directory", list1 (directory
));
2163 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 1, "fDelete file: ",
2164 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2165 If file has multiple names, it continues to exist with the other names. */)
2167 Lisp_Object filename
;
2169 Lisp_Object handler
;
2170 Lisp_Object encoded_file
;
2171 struct gcpro gcpro1
;
2174 if (!NILP (Ffile_directory_p (filename
))
2175 && NILP (Ffile_symlink_p (filename
)))
2176 xsignal2 (Qfile_error
,
2177 build_string ("Removing old name: is a directory"),
2180 filename
= Fexpand_file_name (filename
, Qnil
);
2182 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2183 if (!NILP (handler
))
2184 return call2 (handler
, Qdelete_file
, filename
);
2186 if (delete_by_moving_to_trash
)
2187 return call1 (Qmove_file_to_trash
, filename
);
2189 encoded_file
= ENCODE_FILE (filename
);
2191 if (0 > unlink (SDATA (encoded_file
)))
2192 report_file_error ("Removing old name", list1 (filename
));
2197 internal_delete_file_1 (ignore
)
2203 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2206 internal_delete_file (filename
)
2207 Lisp_Object filename
;
2210 tem
= internal_condition_case_1 (Fdelete_file
, filename
,
2211 Qt
, internal_delete_file_1
);
2215 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2216 "fRename file: \nGRename %s to file: \np",
2217 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2218 If file has names other than FILE, it continues to have those names.
2219 Signals a `file-already-exists' error if a file NEWNAME already exists
2220 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2221 A number as third arg means request confirmation if NEWNAME already exists.
2222 This is what happens in interactive use with M-x. */)
2223 (file
, newname
, ok_if_already_exists
)
2224 Lisp_Object file
, newname
, ok_if_already_exists
;
2226 Lisp_Object handler
;
2227 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2228 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2230 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2231 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2232 CHECK_STRING (file
);
2233 CHECK_STRING (newname
);
2234 file
= Fexpand_file_name (file
, Qnil
);
2236 if ((!NILP (Ffile_directory_p (newname
)))
2238 /* If the file names are identical but for the case,
2239 don't attempt to move directory to itself. */
2240 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2243 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2245 newname
= Fexpand_file_name (newname
, Qnil
);
2247 /* If the file name has special constructs in it,
2248 call the corresponding file handler. */
2249 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2251 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2252 if (!NILP (handler
))
2253 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2254 file
, newname
, ok_if_already_exists
));
2256 encoded_file
= ENCODE_FILE (file
);
2257 encoded_newname
= ENCODE_FILE (newname
);
2260 /* If the file names are identical but for the case, don't ask for
2261 confirmation: they simply want to change the letter-case of the
2263 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2265 if (NILP (ok_if_already_exists
)
2266 || INTEGERP (ok_if_already_exists
))
2267 barf_or_query_if_file_exists (newname
, "rename to it",
2268 INTEGERP (ok_if_already_exists
), 0, 0);
2269 if (0 > rename (SDATA (encoded_file
), SDATA (encoded_newname
)))
2275 symlink_target
= Ffile_symlink_p (file
);
2276 if (! NILP (symlink_target
))
2277 Fmake_symbolic_link (symlink_target
, newname
,
2278 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2281 Fcopy_file (file
, newname
,
2282 /* We have already prompted if it was an integer,
2283 so don't have copy-file prompt again. */
2284 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2287 count
= SPECPDL_INDEX ();
2288 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2289 Fdelete_file (file
);
2290 unbind_to (count
, Qnil
);
2293 report_file_error ("Renaming", list2 (file
, newname
));
2299 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2300 "fAdd name to file: \nGName to add to %s: \np",
2301 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2302 Signals a `file-already-exists' error if a file NEWNAME already exists
2303 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2304 A number as third arg means request confirmation if NEWNAME already exists.
2305 This is what happens in interactive use with M-x. */)
2306 (file
, newname
, ok_if_already_exists
)
2307 Lisp_Object file
, newname
, ok_if_already_exists
;
2309 Lisp_Object handler
;
2310 Lisp_Object encoded_file
, encoded_newname
;
2311 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2313 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2314 encoded_file
= encoded_newname
= Qnil
;
2315 CHECK_STRING (file
);
2316 CHECK_STRING (newname
);
2317 file
= Fexpand_file_name (file
, Qnil
);
2319 if (!NILP (Ffile_directory_p (newname
)))
2320 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2322 newname
= Fexpand_file_name (newname
, Qnil
);
2324 /* If the file name has special constructs in it,
2325 call the corresponding file handler. */
2326 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2327 if (!NILP (handler
))
2328 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2329 newname
, ok_if_already_exists
));
2331 /* If the new name has special constructs in it,
2332 call the corresponding file handler. */
2333 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2334 if (!NILP (handler
))
2335 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2336 newname
, ok_if_already_exists
));
2338 encoded_file
= ENCODE_FILE (file
);
2339 encoded_newname
= ENCODE_FILE (newname
);
2341 if (NILP (ok_if_already_exists
)
2342 || INTEGERP (ok_if_already_exists
))
2343 barf_or_query_if_file_exists (newname
, "make it a new name",
2344 INTEGERP (ok_if_already_exists
), 0, 0);
2346 unlink (SDATA (newname
));
2347 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
)))
2348 report_file_error ("Adding new name", list2 (file
, newname
));
2354 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2355 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2356 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2357 Both args must be strings.
2358 Signals a `file-already-exists' error if a file LINKNAME already exists
2359 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2360 A number as third arg means request confirmation if LINKNAME already exists.
2361 This happens for interactive use with M-x. */)
2362 (filename
, linkname
, ok_if_already_exists
)
2363 Lisp_Object filename
, linkname
, ok_if_already_exists
;
2365 Lisp_Object handler
;
2366 Lisp_Object encoded_filename
, encoded_linkname
;
2367 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2369 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2370 encoded_filename
= encoded_linkname
= Qnil
;
2371 CHECK_STRING (filename
);
2372 CHECK_STRING (linkname
);
2373 /* If the link target has a ~, we must expand it to get
2374 a truly valid file name. Otherwise, do not expand;
2375 we want to permit links to relative file names. */
2376 if (SREF (filename
, 0) == '~')
2377 filename
= Fexpand_file_name (filename
, Qnil
);
2379 if (!NILP (Ffile_directory_p (linkname
)))
2380 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2382 linkname
= Fexpand_file_name (linkname
, Qnil
);
2384 /* If the file name has special constructs in it,
2385 call the corresponding file handler. */
2386 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2387 if (!NILP (handler
))
2388 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2389 linkname
, ok_if_already_exists
));
2391 /* If the new link name has special constructs in it,
2392 call the corresponding file handler. */
2393 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2394 if (!NILP (handler
))
2395 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2396 linkname
, ok_if_already_exists
));
2399 encoded_filename
= ENCODE_FILE (filename
);
2400 encoded_linkname
= ENCODE_FILE (linkname
);
2402 if (NILP (ok_if_already_exists
)
2403 || INTEGERP (ok_if_already_exists
))
2404 barf_or_query_if_file_exists (linkname
, "make it a link",
2405 INTEGERP (ok_if_already_exists
), 0, 0);
2406 if (0 > symlink (SDATA (encoded_filename
),
2407 SDATA (encoded_linkname
)))
2409 /* If we didn't complain already, silently delete existing file. */
2410 if (errno
== EEXIST
)
2412 unlink (SDATA (encoded_linkname
));
2413 if (0 <= symlink (SDATA (encoded_filename
),
2414 SDATA (encoded_linkname
)))
2421 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2428 xsignal1 (Qfile_error
, build_string ("Symbolic links are not supported"));
2430 #endif /* S_IFLNK */
2434 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2436 doc
: /* Return t if file FILENAME specifies an absolute file name.
2437 On Unix, this is a name starting with a `/' or a `~'. */)
2439 Lisp_Object filename
;
2441 CHECK_STRING (filename
);
2442 return file_name_absolute_p (SDATA (filename
)) ? Qt
: Qnil
;
2445 /* Return nonzero if file FILENAME exists and can be executed. */
2448 check_executable (filename
)
2452 int len
= strlen (filename
);
2455 if (stat (filename
, &st
) < 0)
2457 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
2458 return ((st
.st_mode
& S_IEXEC
) != 0);
2460 return (S_ISREG (st
.st_mode
)
2462 && (xstrcasecmp ((suffix
= filename
+ len
-4), ".com") == 0
2463 || xstrcasecmp (suffix
, ".exe") == 0
2464 || xstrcasecmp (suffix
, ".bat") == 0)
2465 || (st
.st_mode
& S_IFMT
) == S_IFDIR
);
2466 #endif /* not WINDOWSNT */
2467 #else /* not DOS_NT */
2468 #ifdef HAVE_EUIDACCESS
2469 return (euidaccess (filename
, 1) >= 0);
2471 /* Access isn't quite right because it uses the real uid
2472 and we really want to test with the effective uid.
2473 But Unix doesn't give us a right way to do it. */
2474 return (access (filename
, 1) >= 0);
2476 #endif /* not DOS_NT */
2479 /* Return nonzero if file FILENAME exists and can be written. */
2482 check_writable (filename
)
2487 if (stat (filename
, &st
) < 0)
2489 return (st
.st_mode
& S_IWRITE
|| (st
.st_mode
& S_IFMT
) == S_IFDIR
);
2490 #else /* not MSDOS */
2491 #ifdef HAVE_EUIDACCESS
2492 return (euidaccess (filename
, 2) >= 0);
2494 /* Access isn't quite right because it uses the real uid
2495 and we really want to test with the effective uid.
2496 But Unix doesn't give us a right way to do it.
2497 Opening with O_WRONLY could work for an ordinary file,
2498 but would lose for directories. */
2499 return (access (filename
, 2) >= 0);
2501 #endif /* not MSDOS */
2504 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2505 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2506 See also `file-readable-p' and `file-attributes'.
2507 This returns nil for a symlink to a nonexistent file.
2508 Use `file-symlink-p' to test for such links. */)
2510 Lisp_Object filename
;
2512 Lisp_Object absname
;
2513 Lisp_Object handler
;
2514 struct stat statbuf
;
2516 CHECK_STRING (filename
);
2517 absname
= Fexpand_file_name (filename
, Qnil
);
2519 /* If the file name has special constructs in it,
2520 call the corresponding file handler. */
2521 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2522 if (!NILP (handler
))
2523 return call2 (handler
, Qfile_exists_p
, absname
);
2525 absname
= ENCODE_FILE (absname
);
2527 return (stat (SDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2530 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2531 doc
: /* Return t if FILENAME can be executed by you.
2532 For a directory, this means you can access files in that directory. */)
2534 Lisp_Object filename
;
2536 Lisp_Object absname
;
2537 Lisp_Object handler
;
2539 CHECK_STRING (filename
);
2540 absname
= Fexpand_file_name (filename
, Qnil
);
2542 /* If the file name has special constructs in it,
2543 call the corresponding file handler. */
2544 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2545 if (!NILP (handler
))
2546 return call2 (handler
, Qfile_executable_p
, absname
);
2548 absname
= ENCODE_FILE (absname
);
2550 return (check_executable (SDATA (absname
)) ? Qt
: Qnil
);
2553 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2554 doc
: /* Return t if file FILENAME exists and you can read it.
2555 See also `file-exists-p' and `file-attributes'. */)
2557 Lisp_Object filename
;
2559 Lisp_Object absname
;
2560 Lisp_Object handler
;
2563 struct stat statbuf
;
2565 CHECK_STRING (filename
);
2566 absname
= Fexpand_file_name (filename
, Qnil
);
2568 /* If the file name has special constructs in it,
2569 call the corresponding file handler. */
2570 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2571 if (!NILP (handler
))
2572 return call2 (handler
, Qfile_readable_p
, absname
);
2574 absname
= ENCODE_FILE (absname
);
2576 #if defined(DOS_NT) || defined(macintosh)
2577 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2579 if (access (SDATA (absname
), 0) == 0)
2582 #else /* not DOS_NT and not macintosh */
2584 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
2585 /* Opening a fifo without O_NONBLOCK can wait.
2586 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2587 except in the case of a fifo, on a system which handles it. */
2588 desc
= stat (SDATA (absname
), &statbuf
);
2591 if (S_ISFIFO (statbuf
.st_mode
))
2592 flags
|= O_NONBLOCK
;
2594 desc
= emacs_open (SDATA (absname
), flags
, 0);
2599 #endif /* not DOS_NT and not macintosh */
2602 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2604 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2605 doc
: /* Return t if file FILENAME can be written or created by you. */)
2607 Lisp_Object filename
;
2609 Lisp_Object absname
, dir
, encoded
;
2610 Lisp_Object handler
;
2611 struct stat statbuf
;
2613 CHECK_STRING (filename
);
2614 absname
= Fexpand_file_name (filename
, Qnil
);
2616 /* If the file name has special constructs in it,
2617 call the corresponding file handler. */
2618 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2619 if (!NILP (handler
))
2620 return call2 (handler
, Qfile_writable_p
, absname
);
2622 encoded
= ENCODE_FILE (absname
);
2623 if (stat (SDATA (encoded
), &statbuf
) >= 0)
2624 return (check_writable (SDATA (encoded
))
2627 dir
= Ffile_name_directory (absname
);
2630 dir
= Fdirectory_file_name (dir
);
2633 dir
= ENCODE_FILE (dir
);
2635 /* The read-only attribute of the parent directory doesn't affect
2636 whether a file or directory can be created within it. Some day we
2637 should check ACLs though, which do affect this. */
2638 if (stat (SDATA (dir
), &statbuf
) < 0)
2640 return (statbuf
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2642 return (check_writable (!NILP (dir
) ? (char *) SDATA (dir
) : "")
2647 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2648 doc
: /* Access file FILENAME, and get an error if that does not work.
2649 The second argument STRING is used in the error message.
2650 If there is no error, returns nil. */)
2652 Lisp_Object filename
, string
;
2654 Lisp_Object handler
, encoded_filename
, absname
;
2657 CHECK_STRING (filename
);
2658 absname
= Fexpand_file_name (filename
, Qnil
);
2660 CHECK_STRING (string
);
2662 /* If the file name has special constructs in it,
2663 call the corresponding file handler. */
2664 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2665 if (!NILP (handler
))
2666 return call3 (handler
, Qaccess_file
, absname
, string
);
2668 encoded_filename
= ENCODE_FILE (absname
);
2670 fd
= emacs_open (SDATA (encoded_filename
), O_RDONLY
, 0);
2672 report_file_error (SDATA (string
), Fcons (filename
, Qnil
));
2678 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2679 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2680 The value is the link target, as a string.
2681 Otherwise it returns nil.
2683 This function returns t when given the name of a symlink that
2684 points to a nonexistent file. */)
2686 Lisp_Object filename
;
2688 Lisp_Object handler
;
2690 CHECK_STRING (filename
);
2691 filename
= Fexpand_file_name (filename
, Qnil
);
2693 /* If the file name has special constructs in it,
2694 call the corresponding file handler. */
2695 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2696 if (!NILP (handler
))
2697 return call2 (handler
, Qfile_symlink_p
, filename
);
2706 filename
= ENCODE_FILE (filename
);
2713 buf
= (char *) xrealloc (buf
, bufsize
);
2714 bzero (buf
, bufsize
);
2717 valsize
= readlink (SDATA (filename
), buf
, bufsize
);
2721 /* HP-UX reports ERANGE if buffer is too small. */
2722 if (errno
== ERANGE
)
2732 while (valsize
>= bufsize
);
2734 val
= make_string (buf
, valsize
);
2735 if (buf
[0] == '/' && index (buf
, ':'))
2736 val
= concat2 (build_string ("/:"), val
);
2738 val
= DECODE_FILE (val
);
2741 #else /* not S_IFLNK */
2743 #endif /* not S_IFLNK */
2746 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2747 doc
: /* Return t if FILENAME names an existing directory.
2748 Symbolic links to directories count as directories.
2749 See `file-symlink-p' to distinguish symlinks. */)
2751 Lisp_Object filename
;
2753 register Lisp_Object absname
;
2755 Lisp_Object handler
;
2757 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2759 /* If the file name has special constructs in it,
2760 call the corresponding file handler. */
2761 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2762 if (!NILP (handler
))
2763 return call2 (handler
, Qfile_directory_p
, absname
);
2765 absname
= ENCODE_FILE (absname
);
2767 if (stat (SDATA (absname
), &st
) < 0)
2769 return (st
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2772 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
2773 doc
: /* Return t if file FILENAME names a directory you can open.
2774 For the value to be t, FILENAME must specify the name of a directory as a file,
2775 and the directory must allow you to open files in it. In order to use a
2776 directory as a buffer's current directory, this predicate must return true.
2777 A directory name spec may be given instead; then the value is t
2778 if the directory so specified exists and really is a readable and
2779 searchable directory. */)
2781 Lisp_Object filename
;
2783 Lisp_Object handler
;
2785 struct gcpro gcpro1
;
2787 /* If the file name has special constructs in it,
2788 call the corresponding file handler. */
2789 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2790 if (!NILP (handler
))
2791 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2794 tem
= (NILP (Ffile_directory_p (filename
))
2795 || NILP (Ffile_executable_p (filename
)));
2797 return tem
? Qnil
: Qt
;
2800 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2801 doc
: /* Return t if FILENAME names a regular file.
2802 This is the sort of file that holds an ordinary stream of data bytes.
2803 Symbolic links to regular files count as regular files.
2804 See `file-symlink-p' to distinguish symlinks. */)
2806 Lisp_Object filename
;
2808 register Lisp_Object absname
;
2810 Lisp_Object handler
;
2812 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2814 /* If the file name has special constructs in it,
2815 call the corresponding file handler. */
2816 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2817 if (!NILP (handler
))
2818 return call2 (handler
, Qfile_regular_p
, absname
);
2820 absname
= ENCODE_FILE (absname
);
2825 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2827 /* Tell stat to use expensive method to get accurate info. */
2828 Vw32_get_true_file_attributes
= Qt
;
2829 result
= stat (SDATA (absname
), &st
);
2830 Vw32_get_true_file_attributes
= tem
;
2834 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2837 if (stat (SDATA (absname
), &st
) < 0)
2839 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2843 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2844 doc
: /* Return mode bits of file named FILENAME, as an integer.
2845 Return nil, if file does not exist or is not accessible. */)
2847 Lisp_Object filename
;
2849 Lisp_Object absname
;
2851 Lisp_Object handler
;
2853 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2855 /* If the file name has special constructs in it,
2856 call the corresponding file handler. */
2857 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2858 if (!NILP (handler
))
2859 return call2 (handler
, Qfile_modes
, absname
);
2861 absname
= ENCODE_FILE (absname
);
2863 if (stat (SDATA (absname
), &st
) < 0)
2865 #if defined (MSDOS) && __DJGPP__ < 2
2866 if (check_executable (SDATA (absname
)))
2867 st
.st_mode
|= S_IEXEC
;
2868 #endif /* MSDOS && __DJGPP__ < 2 */
2870 return make_number (st
.st_mode
& 07777);
2873 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2874 "(let ((file (read-file-name \"File: \"))) \
2875 (list file (read-file-modes nil file)))",
2876 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2877 Only the 12 low bits of MODE are used.
2879 Interactively, mode bits are read by `read-file-modes', which accepts
2880 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2882 Lisp_Object filename
, mode
;
2884 Lisp_Object absname
, encoded_absname
;
2885 Lisp_Object handler
;
2887 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2888 CHECK_NUMBER (mode
);
2890 /* If the file name has special constructs in it,
2891 call the corresponding file handler. */
2892 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2893 if (!NILP (handler
))
2894 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2896 encoded_absname
= ENCODE_FILE (absname
);
2898 if (chmod (SDATA (encoded_absname
), XINT (mode
)) < 0)
2899 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2904 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2905 doc
: /* Set the file permission bits for newly created files.
2906 The argument MODE should be an integer; only the low 9 bits are used.
2907 This setting is inherited by subprocesses. */)
2911 CHECK_NUMBER (mode
);
2913 umask ((~ XINT (mode
)) & 0777);
2918 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
2919 doc
: /* Return the default file protection for created files.
2920 The value is an integer. */)
2926 realmask
= umask (0);
2929 XSETINT (value
, (~ realmask
) & 0777);
2933 extern int lisp_time_argument
P_ ((Lisp_Object
, time_t *, int *));
2935 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
2936 doc
: /* Set times of file FILENAME to TIME.
2937 Set both access and modification times.
2938 Return t on success, else nil.
2939 Use the current time if TIME is nil. TIME is in the format of
2942 Lisp_Object filename
, time
;
2944 Lisp_Object absname
, encoded_absname
;
2945 Lisp_Object handler
;
2949 if (! lisp_time_argument (time
, &sec
, &usec
))
2950 error ("Invalid time specification");
2952 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2954 /* If the file name has special constructs in it,
2955 call the corresponding file handler. */
2956 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
2957 if (!NILP (handler
))
2958 return call3 (handler
, Qset_file_times
, absname
, time
);
2960 encoded_absname
= ENCODE_FILE (absname
);
2965 EMACS_SET_SECS (t
, sec
);
2966 EMACS_SET_USECS (t
, usec
);
2968 if (set_file_times (SDATA (encoded_absname
), t
, t
))
2973 /* Setting times on a directory always fails. */
2974 if (stat (SDATA (encoded_absname
), &st
) == 0
2975 && (st
.st_mode
& S_IFMT
) == S_IFDIR
)
2978 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
2987 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
2988 doc
: /* Tell Unix to finish all pending disk updates. */)
2995 #endif /* HAVE_SYNC */
2997 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
2998 doc
: /* Return t if file FILE1 is newer than file FILE2.
2999 If FILE1 does not exist, the answer is nil;
3000 otherwise, if FILE2 does not exist, the answer is t. */)
3002 Lisp_Object file1
, file2
;
3004 Lisp_Object absname1
, absname2
;
3007 Lisp_Object handler
;
3008 struct gcpro gcpro1
, gcpro2
;
3010 CHECK_STRING (file1
);
3011 CHECK_STRING (file2
);
3014 GCPRO2 (absname1
, file2
);
3015 absname1
= expand_and_dir_to_file (file1
, current_buffer
->directory
);
3016 absname2
= expand_and_dir_to_file (file2
, current_buffer
->directory
);
3019 /* If the file name has special constructs in it,
3020 call the corresponding file handler. */
3021 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3023 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3024 if (!NILP (handler
))
3025 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3027 GCPRO2 (absname1
, absname2
);
3028 absname1
= ENCODE_FILE (absname1
);
3029 absname2
= ENCODE_FILE (absname2
);
3032 if (stat (SDATA (absname1
), &st
) < 0)
3035 mtime1
= st
.st_mtime
;
3037 if (stat (SDATA (absname2
), &st
) < 0)
3040 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3044 Lisp_Object Qfind_buffer_file_type
;
3047 #ifndef READ_BUF_SIZE
3048 #define READ_BUF_SIZE (64 << 10)
3051 /* This function is called after Lisp functions to decide a coding
3052 system are called, or when they cause an error. Before they are
3053 called, the current buffer is set unibyte and it contains only a
3054 newly inserted text (thus the buffer was empty before the
3057 The functions may set markers, overlays, text properties, or even
3058 alter the buffer contents, change the current buffer.
3060 Here, we reset all those changes by:
3061 o set back the current buffer.
3062 o move all markers and overlays to BEG.
3063 o remove all text properties.
3064 o set back the buffer multibyteness. */
3067 decide_coding_unwind (unwind_data
)
3068 Lisp_Object unwind_data
;
3070 Lisp_Object multibyte
, undo_list
, buffer
;
3072 multibyte
= XCAR (unwind_data
);
3073 unwind_data
= XCDR (unwind_data
);
3074 undo_list
= XCAR (unwind_data
);
3075 buffer
= XCDR (unwind_data
);
3077 if (current_buffer
!= XBUFFER (buffer
))
3078 set_buffer_internal (XBUFFER (buffer
));
3079 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3080 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3081 BUF_INTERVALS (current_buffer
) = 0;
3082 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3084 /* Now we are safe to change the buffer's multibyteness directly. */
3085 current_buffer
->enable_multibyte_characters
= multibyte
;
3086 current_buffer
->undo_list
= undo_list
;
3092 /* Used to pass values from insert-file-contents to read_non_regular. */
3094 static int non_regular_fd
;
3095 static EMACS_INT non_regular_inserted
;
3096 static EMACS_INT non_regular_nbytes
;
3099 /* Read from a non-regular file.
3100 Read non_regular_trytry bytes max from non_regular_fd.
3101 Non_regular_inserted specifies where to put the read bytes.
3102 Value is the number of bytes read. */
3111 nbytes
= emacs_read (non_regular_fd
,
3112 BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ non_regular_inserted
,
3113 non_regular_nbytes
);
3115 return make_number (nbytes
);
3119 /* Condition-case handler used when reading from non-regular files
3120 in insert-file-contents. */
3123 read_non_regular_quit ()
3129 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3131 doc
: /* Insert contents of file FILENAME after point.
3132 Returns list of absolute file name and number of characters inserted.
3133 If second argument VISIT is non-nil, the buffer's visited filename and
3134 last save file modtime are set, and it is marked unmodified. If
3135 visiting and the file does not exist, visiting is completed before the
3138 The optional third and fourth arguments BEG and END specify what portion
3139 of the file to insert. These arguments count bytes in the file, not
3140 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3142 If optional fifth argument REPLACE is non-nil, replace the current
3143 buffer contents (in the accessible portion) with the file contents.
3144 This is better than simply deleting and inserting the whole thing
3145 because (1) it preserves some marker positions and (2) it puts less data
3146 in the undo list. When REPLACE is non-nil, the second return value is
3147 the number of characters that replace previous buffer contents.
3149 This function does code conversion according to the value of
3150 `coding-system-for-read' or `file-coding-system-alist', and sets the
3151 variable `last-coding-system-used' to the coding system actually used. */)
3152 (filename
, visit
, beg
, end
, replace
)
3153 Lisp_Object filename
, visit
, beg
, end
, replace
;
3157 EMACS_INT inserted
= 0;
3159 register EMACS_INT how_much
;
3160 register EMACS_INT unprocessed
;
3161 int count
= SPECPDL_INDEX ();
3162 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3163 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3165 EMACS_INT total
= 0;
3166 int not_regular
= 0;
3167 unsigned char read_buf
[READ_BUF_SIZE
];
3168 struct coding_system coding
;
3169 unsigned char buffer
[1 << 14];
3170 int replace_handled
= 0;
3171 int set_coding_system
= 0;
3172 Lisp_Object coding_system
;
3174 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3175 int we_locked_file
= 0;
3176 int deferred_remove_unwind_protect
= 0;
3178 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3179 error ("Cannot do file visiting in an indirect buffer");
3181 if (!NILP (current_buffer
->read_only
))
3182 Fbarf_if_buffer_read_only ();
3186 orig_filename
= Qnil
;
3189 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3191 CHECK_STRING (filename
);
3192 filename
= Fexpand_file_name (filename
, Qnil
);
3194 /* The value Qnil means that the coding system is not yet
3196 coding_system
= Qnil
;
3198 /* If the file name has special constructs in it,
3199 call the corresponding file handler. */
3200 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3201 if (!NILP (handler
))
3203 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3204 visit
, beg
, end
, replace
);
3205 if (CONSP (val
) && CONSP (XCDR (val
)))
3206 inserted
= XINT (XCAR (XCDR (val
)));
3210 orig_filename
= filename
;
3211 filename
= ENCODE_FILE (filename
);
3217 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3219 /* Tell stat to use expensive method to get accurate info. */
3220 Vw32_get_true_file_attributes
= Qt
;
3221 total
= stat (SDATA (filename
), &st
);
3222 Vw32_get_true_file_attributes
= tem
;
3226 if (stat (SDATA (filename
), &st
) < 0)
3227 #endif /* WINDOWSNT */
3229 if (fd
>= 0) emacs_close (fd
);
3232 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3235 if (!NILP (Vcoding_system_for_read
))
3236 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3241 /* This code will need to be changed in order to work on named
3242 pipes, and it's probably just not worth it. So we should at
3243 least signal an error. */
3244 if (!S_ISREG (st
.st_mode
))
3251 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3252 xsignal2 (Qfile_error
,
3253 build_string ("not a regular file"), orig_filename
);
3258 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0)
3261 /* Replacement should preserve point as it preserves markers. */
3262 if (!NILP (replace
))
3263 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3265 record_unwind_protect (close_file_unwind
, make_number (fd
));
3267 /* Can happen on any platform that uses long as type of off_t, but allows
3268 file sizes to exceed 2Gb, so give a suitable message. */
3269 if (! not_regular
&& st
.st_size
< 0)
3270 error ("Maximum buffer size exceeded");
3272 /* Prevent redisplay optimizations. */
3273 current_buffer
->clip_changed
= 1;
3277 if (!NILP (beg
) || !NILP (end
))
3278 error ("Attempt to visit less than an entire file");
3279 if (BEG
< Z
&& NILP (replace
))
3280 error ("Cannot do file visiting in a non-empty buffer");
3286 XSETFASTINT (beg
, 0);
3294 XSETINT (end
, st
.st_size
);
3296 /* Arithmetic overflow can occur if an Emacs integer cannot
3297 represent the file size, or if the calculations below
3298 overflow. The calculations below double the file size
3299 twice, so check that it can be multiplied by 4 safely. */
3300 if (XINT (end
) != st
.st_size
3301 /* Actually, it should test either INT_MAX or LONG_MAX
3302 depending on which one is used for EMACS_INT. But in
3303 any case, in practice, this test is redundant with the
3305 || st.st_size > INT_MAX / 4 */)
3306 error ("Maximum buffer size exceeded");
3308 /* The file size returned from stat may be zero, but data
3309 may be readable nonetheless, for example when this is a
3310 file in the /proc filesystem. */
3311 if (st
.st_size
== 0)
3312 XSETINT (end
, READ_BUF_SIZE
);
3316 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3318 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3319 setup_coding_system (coding_system
, &coding
);
3320 /* Ensure we set Vlast_coding_system_used. */
3321 set_coding_system
= 1;
3325 /* Decide the coding system to use for reading the file now
3326 because we can't use an optimized method for handling
3327 `coding:' tag if the current buffer is not empty. */
3328 if (!NILP (Vcoding_system_for_read
))
3329 coding_system
= Vcoding_system_for_read
;
3332 /* Don't try looking inside a file for a coding system
3333 specification if it is not seekable. */
3334 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3336 /* Find a coding system specified in the heading two
3337 lines or in the tailing several lines of the file.
3338 We assume that the 1K-byte and 3K-byte for heading
3339 and tailing respectively are sufficient for this
3343 if (st
.st_size
<= (1024 * 4))
3344 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3347 nread
= emacs_read (fd
, read_buf
, 1024);
3350 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3351 report_file_error ("Setting file position",
3352 Fcons (orig_filename
, Qnil
));
3353 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3358 error ("IO error reading %s: %s",
3359 SDATA (orig_filename
), emacs_strerror (errno
));
3362 struct buffer
*prev
= current_buffer
;
3366 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3368 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3369 buf
= XBUFFER (buffer
);
3371 delete_all_overlays (buf
);
3372 buf
->directory
= current_buffer
->directory
;
3373 buf
->read_only
= Qnil
;
3374 buf
->filename
= Qnil
;
3375 buf
->undo_list
= Qt
;
3376 eassert (buf
->overlays_before
== NULL
);
3377 eassert (buf
->overlays_after
== NULL
);
3379 set_buffer_internal (buf
);
3381 buf
->enable_multibyte_characters
= Qnil
;
3383 insert_1_both (read_buf
, nread
, nread
, 0, 0, 0);
3384 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3385 coding_system
= call2 (Vset_auto_coding_function
,
3386 filename
, make_number (nread
));
3387 set_buffer_internal (prev
);
3389 /* Discard the unwind protect for recovering the
3393 /* Rewind the file for the actual read done later. */
3394 if (lseek (fd
, 0, 0) < 0)
3395 report_file_error ("Setting file position",
3396 Fcons (orig_filename
, Qnil
));
3400 if (NILP (coding_system
))
3402 /* If we have not yet decided a coding system, check
3403 file-coding-system-alist. */
3404 Lisp_Object args
[6];
3406 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3407 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3408 coding_system
= Ffind_operation_coding_system (6, args
);
3409 if (CONSP (coding_system
))
3410 coding_system
= XCAR (coding_system
);
3414 if (NILP (coding_system
))
3415 coding_system
= Qundecided
;
3417 CHECK_CODING_SYSTEM (coding_system
);
3419 if (NILP (current_buffer
->enable_multibyte_characters
))
3420 /* We must suppress all character code conversion except for
3421 end-of-line conversion. */
3422 coding_system
= raw_text_coding_system (coding_system
);
3424 setup_coding_system (coding_system
, &coding
);
3425 /* Ensure we set Vlast_coding_system_used. */
3426 set_coding_system
= 1;
3429 /* If requested, replace the accessible part of the buffer
3430 with the file contents. Avoid replacing text at the
3431 beginning or end of the buffer that matches the file contents;
3432 that preserves markers pointing to the unchanged parts.
3434 Here we implement this feature in an optimized way
3435 for the case where code conversion is NOT needed.
3436 The following if-statement handles the case of conversion
3437 in a less optimal way.
3439 If the code conversion is "automatic" then we try using this
3440 method and hope for the best.
3441 But if we discover the need for conversion, we give up on this method
3442 and let the following if-statement handle the replace job. */
3445 && (NILP (coding_system
)
3446 || ! CODING_REQUIRE_DECODING (&coding
)))
3448 /* same_at_start and same_at_end count bytes,
3449 because file access counts bytes
3450 and BEG and END count bytes. */
3451 EMACS_INT same_at_start
= BEGV_BYTE
;
3452 EMACS_INT same_at_end
= ZV_BYTE
;
3454 /* There is still a possibility we will find the need to do code
3455 conversion. If that happens, we set this variable to 1 to
3456 give up on handling REPLACE in the optimized way. */
3457 int giveup_match_end
= 0;
3459 if (XINT (beg
) != 0)
3461 if (lseek (fd
, XINT (beg
), 0) < 0)
3462 report_file_error ("Setting file position",
3463 Fcons (orig_filename
, Qnil
));
3468 /* Count how many chars at the start of the file
3469 match the text at the beginning of the buffer. */
3472 EMACS_INT nread
, bufpos
;
3474 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3476 error ("IO error reading %s: %s",
3477 SDATA (orig_filename
), emacs_strerror (errno
));
3478 else if (nread
== 0)
3481 if (CODING_REQUIRE_DETECTION (&coding
))
3483 coding_system
= detect_coding_system (buffer
, nread
, nread
, 1, 0,
3485 setup_coding_system (coding_system
, &coding
);
3488 if (CODING_REQUIRE_DECODING (&coding
))
3489 /* We found that the file should be decoded somehow.
3490 Let's give up here. */
3492 giveup_match_end
= 1;
3497 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3498 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3499 same_at_start
++, bufpos
++;
3500 /* If we found a discrepancy, stop the scan.
3501 Otherwise loop around and scan the next bufferful. */
3502 if (bufpos
!= nread
)
3506 /* If the file matches the buffer completely,
3507 there's no need to replace anything. */
3508 if (same_at_start
- BEGV_BYTE
== XINT (end
))
3512 /* Truncate the buffer to the size of the file. */
3513 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3518 /* Count how many chars at the end of the file
3519 match the text at the end of the buffer. But, if we have
3520 already found that decoding is necessary, don't waste time. */
3521 while (!giveup_match_end
)
3523 EMACS_INT total_read
, nread
, bufpos
, curpos
, trial
;
3525 /* At what file position are we now scanning? */
3526 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
3527 /* If the entire file matches the buffer tail, stop the scan. */
3530 /* How much can we scan in the next step? */
3531 trial
= min (curpos
, sizeof buffer
);
3532 if (lseek (fd
, curpos
- trial
, 0) < 0)
3533 report_file_error ("Setting file position",
3534 Fcons (orig_filename
, Qnil
));
3536 total_read
= nread
= 0;
3537 while (total_read
< trial
)
3539 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3541 error ("IO error reading %s: %s",
3542 SDATA (orig_filename
), emacs_strerror (errno
));
3543 else if (nread
== 0)
3545 total_read
+= nread
;
3548 /* Scan this bufferful from the end, comparing with
3549 the Emacs buffer. */
3550 bufpos
= total_read
;
3552 /* Compare with same_at_start to avoid counting some buffer text
3553 as matching both at the file's beginning and at the end. */
3554 while (bufpos
> 0 && same_at_end
> same_at_start
3555 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3556 same_at_end
--, bufpos
--;
3558 /* If we found a discrepancy, stop the scan.
3559 Otherwise loop around and scan the preceding bufferful. */
3562 /* If this discrepancy is because of code conversion,
3563 we cannot use this method; giveup and try the other. */
3564 if (same_at_end
> same_at_start
3565 && FETCH_BYTE (same_at_end
- 1) >= 0200
3566 && ! NILP (current_buffer
->enable_multibyte_characters
)
3567 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3568 giveup_match_end
= 1;
3577 if (! giveup_match_end
)
3581 /* We win! We can handle REPLACE the optimized way. */
3583 /* Extend the start of non-matching text area to multibyte
3584 character boundary. */
3585 if (! NILP (current_buffer
->enable_multibyte_characters
))
3586 while (same_at_start
> BEGV_BYTE
3587 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3590 /* Extend the end of non-matching text area to multibyte
3591 character boundary. */
3592 if (! NILP (current_buffer
->enable_multibyte_characters
))
3593 while (same_at_end
< ZV_BYTE
3594 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3597 /* Don't try to reuse the same piece of text twice. */
3598 overlap
= (same_at_start
- BEGV_BYTE
3599 - (same_at_end
+ st
.st_size
- ZV
));
3601 same_at_end
+= overlap
;
3603 /* Arrange to read only the nonmatching middle part of the file. */
3604 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
3605 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
3607 del_range_byte (same_at_start
, same_at_end
, 0);
3608 /* Insert from the file at the proper position. */
3609 temp
= BYTE_TO_CHAR (same_at_start
);
3610 SET_PT_BOTH (temp
, same_at_start
);
3612 /* If display currently starts at beginning of line,
3613 keep it that way. */
3614 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3615 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3617 replace_handled
= 1;
3621 /* If requested, replace the accessible part of the buffer
3622 with the file contents. Avoid replacing text at the
3623 beginning or end of the buffer that matches the file contents;
3624 that preserves markers pointing to the unchanged parts.
3626 Here we implement this feature for the case where code conversion
3627 is needed, in a simple way that needs a lot of memory.
3628 The preceding if-statement handles the case of no conversion
3629 in a more optimized way. */
3630 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3632 EMACS_INT same_at_start
= BEGV_BYTE
;
3633 EMACS_INT same_at_end
= ZV_BYTE
;
3634 EMACS_INT same_at_start_charpos
;
3635 EMACS_INT inserted_chars
;
3638 unsigned char *decoded
;
3640 int this_count
= SPECPDL_INDEX ();
3641 int multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
3642 Lisp_Object conversion_buffer
;
3644 conversion_buffer
= code_conversion_save (1, multibyte
);
3646 /* First read the whole file, performing code conversion into
3647 CONVERSION_BUFFER. */
3649 if (lseek (fd
, XINT (beg
), 0) < 0)
3650 report_file_error ("Setting file position",
3651 Fcons (orig_filename
, Qnil
));
3653 total
= st
.st_size
; /* Total bytes in the file. */
3654 how_much
= 0; /* Bytes read from file so far. */
3655 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3656 unprocessed
= 0; /* Bytes not processed in previous loop. */
3658 GCPRO1 (conversion_buffer
);
3659 while (how_much
< total
)
3661 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3662 quitting while reading a huge while. */
3663 /* try is reserved in some compilers (Microsoft C) */
3664 EMACS_INT trytry
= min (total
- how_much
,
3665 READ_BUF_SIZE
- unprocessed
);
3668 /* Allow quitting out of the actual I/O. */
3671 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3683 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3684 BUF_Z (XBUFFER (conversion_buffer
)));
3685 decode_coding_c_string (&coding
, read_buf
, unprocessed
+ this,
3687 unprocessed
= coding
.carryover_bytes
;
3688 if (coding
.carryover_bytes
> 0)
3689 bcopy (coding
.carryover
, read_buf
, unprocessed
);
3694 /* We should remove the unwind_protect calling
3695 close_file_unwind, but other stuff has been added the stack,
3696 so defer the removal till we reach the `handled' label. */
3697 deferred_remove_unwind_protect
= 1;
3699 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3700 if we couldn't read the file. */
3703 error ("IO error reading %s: %s",
3704 SDATA (orig_filename
), emacs_strerror (errno
));
3706 if (unprocessed
> 0)
3708 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3709 decode_coding_c_string (&coding
, read_buf
, unprocessed
,
3711 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3714 coding_system
= CODING_ID_NAME (coding
.id
);
3715 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3716 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3717 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3719 /* Compare the beginning of the converted string with the buffer
3723 while (bufpos
< inserted
&& same_at_start
< same_at_end
3724 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3725 same_at_start
++, bufpos
++;
3727 /* If the file matches the head of buffer completely,
3728 there's no need to replace anything. */
3730 if (bufpos
== inserted
)
3732 /* Truncate the buffer to the size of the file. */
3733 if (same_at_start
== same_at_end
)
3736 del_range_byte (same_at_start
, same_at_end
, 0);
3739 unbind_to (this_count
, Qnil
);
3743 /* Extend the start of non-matching text area to the previous
3744 multibyte character boundary. */
3745 if (! NILP (current_buffer
->enable_multibyte_characters
))
3746 while (same_at_start
> BEGV_BYTE
3747 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3750 /* Scan this bufferful from the end, comparing with
3751 the Emacs buffer. */
3754 /* Compare with same_at_start to avoid counting some buffer text
3755 as matching both at the file's beginning and at the end. */
3756 while (bufpos
> 0 && same_at_end
> same_at_start
3757 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3758 same_at_end
--, bufpos
--;
3760 /* Extend the end of non-matching text area to the next
3761 multibyte character boundary. */
3762 if (! NILP (current_buffer
->enable_multibyte_characters
))
3763 while (same_at_end
< ZV_BYTE
3764 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3767 /* Don't try to reuse the same piece of text twice. */
3768 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3770 same_at_end
+= overlap
;
3772 /* If display currently starts at beginning of line,
3773 keep it that way. */
3774 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3775 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3777 /* Replace the chars that we need to replace,
3778 and update INSERTED to equal the number of bytes
3779 we are taking from the decoded string. */
3780 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3782 if (same_at_end
!= same_at_start
)
3784 del_range_byte (same_at_start
, same_at_end
, 0);
3786 same_at_start
= GPT_BYTE
;
3790 temp
= BYTE_TO_CHAR (same_at_start
);
3792 /* Insert from the file at the proper position. */
3793 SET_PT_BOTH (temp
, same_at_start
);
3794 same_at_start_charpos
3795 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3796 same_at_start
- BEGV_BYTE
3797 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3799 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3800 same_at_start
+ inserted
- BEGV_BYTE
3801 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3802 - same_at_start_charpos
);
3803 /* This binding is to avoid ask-user-about-supersession-threat
3804 being called in insert_from_buffer (via in
3805 prepare_to_modify_buffer). */
3806 specbind (intern ("buffer-file-name"), Qnil
);
3807 insert_from_buffer (XBUFFER (conversion_buffer
),
3808 same_at_start_charpos
, inserted_chars
, 0);
3809 /* Set `inserted' to the number of inserted characters. */
3810 inserted
= PT
- temp
;
3811 /* Set point before the inserted characters. */
3812 SET_PT_BOTH (temp
, same_at_start
);
3814 unbind_to (this_count
, Qnil
);
3821 register Lisp_Object temp
;
3823 total
= XINT (end
) - XINT (beg
);
3825 /* Make sure point-max won't overflow after this insertion. */
3826 XSETINT (temp
, total
);
3827 if (total
!= XINT (temp
))
3828 error ("Maximum buffer size exceeded");
3831 /* For a special file, all we can do is guess. */
3832 total
= READ_BUF_SIZE
;
3834 if (NILP (visit
) && inserted
> 0)
3836 #ifdef CLASH_DETECTION
3837 if (!NILP (current_buffer
->file_truename
)
3838 /* Make binding buffer-file-name to nil effective. */
3839 && !NILP (current_buffer
->filename
)
3840 && SAVE_MODIFF
>= MODIFF
)
3842 #endif /* CLASH_DETECTION */
3843 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3847 if (GAP_SIZE
< total
)
3848 make_gap (total
- GAP_SIZE
);
3850 if (XINT (beg
) != 0 || !NILP (replace
))
3852 if (lseek (fd
, XINT (beg
), 0) < 0)
3853 report_file_error ("Setting file position",
3854 Fcons (orig_filename
, Qnil
));
3857 /* In the following loop, HOW_MUCH contains the total bytes read so
3858 far for a regular file, and not changed for a special file. But,
3859 before exiting the loop, it is set to a negative value if I/O
3863 /* Total bytes inserted. */
3866 /* Here, we don't do code conversion in the loop. It is done by
3867 decode_coding_gap after all data are read into the buffer. */
3869 EMACS_INT gap_size
= GAP_SIZE
;
3871 while (how_much
< total
)
3873 /* try is reserved in some compilers (Microsoft C) */
3874 EMACS_INT trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3881 /* Maybe make more room. */
3882 if (gap_size
< trytry
)
3884 make_gap (total
- gap_size
);
3885 gap_size
= GAP_SIZE
;
3888 /* Read from the file, capturing `quit'. When an
3889 error occurs, end the loop, and arrange for a quit
3890 to be signaled after decoding the text we read. */
3891 non_regular_fd
= fd
;
3892 non_regular_inserted
= inserted
;
3893 non_regular_nbytes
= trytry
;
3894 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
3895 read_non_regular_quit
);
3906 /* Allow quitting out of the actual I/O. We don't make text
3907 part of the buffer until all the reading is done, so a C-g
3908 here doesn't do any harm. */
3911 this = emacs_read (fd
, BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ inserted
, trytry
);
3923 /* For a regular file, where TOTAL is the real size,
3924 count HOW_MUCH to compare with it.
3925 For a special file, where TOTAL is just a buffer size,
3926 so don't bother counting in HOW_MUCH.
3927 (INSERTED is where we count the number of characters inserted.) */
3934 /* Now we have read all the file data into the gap.
3935 If it was empty, undo marking the buffer modified. */
3939 #ifdef CLASH_DETECTION
3941 unlock_file (current_buffer
->file_truename
);
3943 Vdeactivate_mark
= old_Vdeactivate_mark
;
3946 Vdeactivate_mark
= Qt
;
3948 /* Make the text read part of the buffer. */
3949 GAP_SIZE
-= inserted
;
3951 GPT_BYTE
+= inserted
;
3953 ZV_BYTE
+= inserted
;
3958 /* Put an anchor to ensure multi-byte form ends at gap. */
3963 /* Discard the unwind protect for closing the file. */
3967 error ("IO error reading %s: %s",
3968 SDATA (orig_filename
), emacs_strerror (errno
));
3972 if (NILP (coding_system
))
3974 /* The coding system is not yet decided. Decide it by an
3975 optimized method for handling `coding:' tag.
3977 Note that we can get here only if the buffer was empty
3978 before the insertion. */
3980 if (!NILP (Vcoding_system_for_read
))
3981 coding_system
= Vcoding_system_for_read
;
3984 /* Since we are sure that the current buffer was empty
3985 before the insertion, we can toggle
3986 enable-multibyte-characters directly here without taking
3987 care of marker adjustment. By this way, we can run Lisp
3988 program safely before decoding the inserted text. */
3989 Lisp_Object unwind_data
;
3990 int count
= SPECPDL_INDEX ();
3992 unwind_data
= Fcons (current_buffer
->enable_multibyte_characters
,
3993 Fcons (current_buffer
->undo_list
,
3994 Fcurrent_buffer ()));
3995 current_buffer
->enable_multibyte_characters
= Qnil
;
3996 current_buffer
->undo_list
= Qt
;
3997 record_unwind_protect (decide_coding_unwind
, unwind_data
);
3999 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4001 coding_system
= call2 (Vset_auto_coding_function
,
4002 filename
, make_number (inserted
));
4005 if (NILP (coding_system
))
4007 /* If the coding system is not yet decided, check
4008 file-coding-system-alist. */
4009 Lisp_Object args
[6];
4011 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4012 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4013 coding_system
= Ffind_operation_coding_system (6, args
);
4014 if (CONSP (coding_system
))
4015 coding_system
= XCAR (coding_system
);
4017 unbind_to (count
, Qnil
);
4018 inserted
= Z_BYTE
- BEG_BYTE
;
4021 if (NILP (coding_system
))
4022 coding_system
= Qundecided
;
4024 CHECK_CODING_SYSTEM (coding_system
);
4026 if (NILP (current_buffer
->enable_multibyte_characters
))
4027 /* We must suppress all character code conversion except for
4028 end-of-line conversion. */
4029 coding_system
= raw_text_coding_system (coding_system
);
4030 setup_coding_system (coding_system
, &coding
);
4031 /* Ensure we set Vlast_coding_system_used. */
4032 set_coding_system
= 1;
4037 /* When we visit a file by raw-text, we change the buffer to
4039 if (CODING_FOR_UNIBYTE (&coding
)
4040 /* Can't do this if part of the buffer might be preserved. */
4042 /* Visiting a file with these coding system makes the buffer
4044 current_buffer
->enable_multibyte_characters
= Qnil
;
4047 coding
.dst_multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
4048 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4049 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4051 move_gap_both (PT
, PT_BYTE
);
4052 GAP_SIZE
+= inserted
;
4053 ZV_BYTE
-= inserted
;
4057 decode_coding_gap (&coding
, inserted
, inserted
);
4058 inserted
= coding
.produced_char
;
4059 coding_system
= CODING_ID_NAME (coding
.id
);
4061 else if (inserted
> 0)
4062 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4065 /* Now INSERTED is measured in characters. */
4068 /* Use the conversion type to determine buffer-file-type
4069 (find-buffer-file-type is now used to help determine the
4071 if ((VECTORP (CODING_ID_EOL_TYPE (coding
.id
))
4072 || EQ (CODING_ID_EOL_TYPE (coding
.id
), Qunix
))
4073 && ! CODING_REQUIRE_DECODING (&coding
))
4074 current_buffer
->buffer_file_type
= Qt
;
4076 current_buffer
->buffer_file_type
= Qnil
;
4081 if (deferred_remove_unwind_protect
)
4082 /* If requested above, discard the unwind protect for closing the
4088 if (!EQ (current_buffer
->undo_list
, Qt
) && !nochange
)
4089 current_buffer
->undo_list
= Qnil
;
4093 current_buffer
->modtime
= st
.st_mtime
;
4094 current_buffer
->filename
= orig_filename
;
4097 SAVE_MODIFF
= MODIFF
;
4098 current_buffer
->auto_save_modified
= MODIFF
;
4099 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4100 #ifdef CLASH_DETECTION
4103 if (!NILP (current_buffer
->file_truename
))
4104 unlock_file (current_buffer
->file_truename
);
4105 unlock_file (filename
);
4107 #endif /* CLASH_DETECTION */
4109 xsignal2 (Qfile_error
,
4110 build_string ("not a regular file"), orig_filename
);
4113 if (set_coding_system
)
4114 Vlast_coding_system_used
= coding_system
;
4116 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4118 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4120 if (! NILP (insval
))
4122 CHECK_NUMBER (insval
);
4123 inserted
= XFASTINT (insval
);
4127 /* Decode file format. */
4130 /* Don't run point motion or modification hooks when decoding. */
4131 int count
= SPECPDL_INDEX ();
4132 EMACS_INT old_inserted
= inserted
;
4133 specbind (Qinhibit_point_motion_hooks
, Qt
);
4134 specbind (Qinhibit_modification_hooks
, Qt
);
4136 /* Save old undo list and don't record undo for decoding. */
4137 old_undo
= current_buffer
->undo_list
;
4138 current_buffer
->undo_list
= Qt
;
4142 insval
= call3 (Qformat_decode
,
4143 Qnil
, make_number (inserted
), visit
);
4144 CHECK_NUMBER (insval
);
4145 inserted
= XFASTINT (insval
);
4149 /* If REPLACE is non-nil and we succeeded in not replacing the
4150 beginning or end of the buffer text with the file's contents,
4151 call format-decode with `point' positioned at the beginning
4152 of the buffer and `inserted' equalling the number of
4153 characters in the buffer. Otherwise, format-decode might
4154 fail to correctly analyze the beginning or end of the buffer.
4155 Hence we temporarily save `point' and `inserted' here and
4156 restore `point' iff format-decode did not insert or delete
4157 any text. Otherwise we leave `point' at point-min. */
4158 EMACS_INT opoint
= PT
;
4159 EMACS_INT opoint_byte
= PT_BYTE
;
4160 EMACS_INT oinserted
= ZV
- BEGV
;
4161 int ochars_modiff
= CHARS_MODIFF
;
4163 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4164 insval
= call3 (Qformat_decode
,
4165 Qnil
, make_number (oinserted
), visit
);
4166 CHECK_NUMBER (insval
);
4167 if (ochars_modiff
== CHARS_MODIFF
)
4168 /* format_decode didn't modify buffer's characters => move
4169 point back to position before inserted text and leave
4170 value of inserted alone. */
4171 SET_PT_BOTH (opoint
, opoint_byte
);
4173 /* format_decode modified buffer's characters => consider
4174 entire buffer changed and leave point at point-min. */
4175 inserted
= XFASTINT (insval
);
4178 /* For consistency with format-decode call these now iff inserted > 0
4179 (martin 2007-06-28). */
4180 p
= Vafter_insert_file_functions
;
4185 insval
= call1 (XCAR (p
), make_number (inserted
));
4188 CHECK_NUMBER (insval
);
4189 inserted
= XFASTINT (insval
);
4194 /* For the rationale of this see the comment on
4195 format-decode above. */
4196 EMACS_INT opoint
= PT
;
4197 EMACS_INT opoint_byte
= PT_BYTE
;
4198 EMACS_INT oinserted
= ZV
- BEGV
;
4199 int ochars_modiff
= CHARS_MODIFF
;
4201 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4202 insval
= call1 (XCAR (p
), make_number (oinserted
));
4205 CHECK_NUMBER (insval
);
4206 if (ochars_modiff
== CHARS_MODIFF
)
4207 /* after_insert_file_functions didn't modify
4208 buffer's characters => move point back to
4209 position before inserted text and leave value of
4211 SET_PT_BOTH (opoint
, opoint_byte
);
4213 /* after_insert_file_functions did modify buffer's
4214 characters => consider entire buffer changed and
4215 leave point at point-min. */
4216 inserted
= XFASTINT (insval
);
4226 current_buffer
->undo_list
= old_undo
;
4227 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4229 /* Adjust the last undo record for the size change during
4230 the format conversion. */
4231 Lisp_Object tem
= XCAR (old_undo
);
4232 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4233 && INTEGERP (XCDR (tem
))
4234 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4235 XSETCDR (tem
, make_number (PT
+ inserted
));
4239 /* If undo_list was Qt before, keep it that way.
4240 Otherwise start with an empty undo_list. */
4241 current_buffer
->undo_list
= EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4243 unbind_to (count
, Qnil
);
4246 /* Call after-change hooks for the inserted text, aside from the case
4247 of normal visiting (not with REPLACE), which is done in a new buffer
4248 "before" the buffer is changed. */
4249 if (inserted
> 0 && total
> 0
4250 && (NILP (visit
) || !NILP (replace
)))
4252 signal_after_change (PT
, 0, inserted
);
4253 update_compositions (PT
, PT
, CHECK_BORDER
);
4257 && current_buffer
->modtime
== -1)
4259 /* If visiting nonexistent file, return nil. */
4260 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4264 Fsignal (Qquit
, Qnil
);
4266 /* ??? Retval needs to be dealt with in all cases consistently. */
4268 val
= Fcons (orig_filename
,
4269 Fcons (make_number (inserted
),
4272 RETURN_UNGCPRO (unbind_to (count
, val
));
4275 static Lisp_Object build_annotations
P_ ((Lisp_Object
, Lisp_Object
));
4278 build_annotations_unwind (arg
)
4281 Vwrite_region_annotation_buffers
= arg
;
4285 /* Decide the coding-system to encode the data with. */
4288 choose_write_coding_system (start
, end
, filename
,
4289 append
, visit
, lockname
, coding
)
4290 Lisp_Object start
, end
, filename
, append
, visit
, lockname
;
4291 struct coding_system
*coding
;
4294 Lisp_Object eol_parent
= Qnil
;
4297 && NILP (Fstring_equal (current_buffer
->filename
,
4298 current_buffer
->auto_save_file_name
)))
4303 else if (!NILP (Vcoding_system_for_write
))
4305 val
= Vcoding_system_for_write
;
4306 if (coding_system_require_warning
4307 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4308 /* Confirm that VAL can surely encode the current region. */
4309 val
= call5 (Vselect_safe_coding_system_function
,
4310 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4315 /* If the variable `buffer-file-coding-system' is set locally,
4316 it means that the file was read with some kind of code
4317 conversion or the variable is explicitly set by users. We
4318 had better write it out with the same coding system even if
4319 `enable-multibyte-characters' is nil.
4321 If it is not set locally, we anyway have to convert EOL
4322 format if the default value of `buffer-file-coding-system'
4323 tells that it is not Unix-like (LF only) format. */
4324 int using_default_coding
= 0;
4325 int force_raw_text
= 0;
4327 val
= current_buffer
->buffer_file_coding_system
;
4329 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4332 if (NILP (current_buffer
->enable_multibyte_characters
))
4338 /* Check file-coding-system-alist. */
4339 Lisp_Object args
[7], coding_systems
;
4341 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4342 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4344 coding_systems
= Ffind_operation_coding_system (7, args
);
4345 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4346 val
= XCDR (coding_systems
);
4351 /* If we still have not decided a coding system, use the
4352 default value of buffer-file-coding-system. */
4353 val
= current_buffer
->buffer_file_coding_system
;
4354 using_default_coding
= 1;
4357 if (! NILP (val
) && ! force_raw_text
)
4359 Lisp_Object spec
, attrs
;
4361 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4362 attrs
= AREF (spec
, 0);
4363 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4368 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4369 /* Confirm that VAL can surely encode the current region. */
4370 val
= call5 (Vselect_safe_coding_system_function
,
4371 start
, end
, val
, Qnil
, filename
);
4373 /* If the decided coding-system doesn't specify end-of-line
4374 format, we use that of
4375 `default-buffer-file-coding-system'. */
4376 if (! using_default_coding
4377 && ! NILP (buffer_defaults
.buffer_file_coding_system
))
4378 val
= (coding_inherit_eol_type
4379 (val
, buffer_defaults
.buffer_file_coding_system
));
4381 /* If we decide not to encode text, use `raw-text' or one of its
4384 val
= raw_text_coding_system (val
);
4387 val
= coding_inherit_eol_type (val
, eol_parent
);
4388 setup_coding_system (val
, coding
);
4390 if (!STRINGP (start
) && !NILP (current_buffer
->selective_display
))
4391 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4395 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4396 "r\nFWrite region to file: \ni\ni\ni\np",
4397 doc
: /* Write current region into specified file.
4398 When called from a program, requires three arguments:
4399 START, END and FILENAME. START and END are normally buffer positions
4400 specifying the part of the buffer to write.
4401 If START is nil, that means to use the entire buffer contents.
4402 If START is a string, then output that string to the file
4403 instead of any buffer contents; END is ignored.
4405 Optional fourth argument APPEND if non-nil means
4406 append to existing file contents (if any). If it is an integer,
4407 seek to that offset in the file before writing.
4408 Optional fifth argument VISIT, if t or a string, means
4409 set the last-save-file-modtime of buffer to this file's modtime
4410 and mark buffer not modified.
4411 If VISIT is a string, it is a second file name;
4412 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4413 VISIT is also the file name to lock and unlock for clash detection.
4414 If VISIT is neither t nor nil nor a string,
4415 that means do not display the \"Wrote file\" message.
4416 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4417 use for locking and unlocking, overriding FILENAME and VISIT.
4418 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4419 for an existing file with the same name. If MUSTBENEW is `excl',
4420 that means to get an error if the file already exists; never overwrite.
4421 If MUSTBENEW is neither nil nor `excl', that means ask for
4422 confirmation before overwriting, but do go ahead and overwrite the file
4423 if the user confirms.
4425 This does code conversion according to the value of
4426 `coding-system-for-write', `buffer-file-coding-system', or
4427 `file-coding-system-alist', and sets the variable
4428 `last-coding-system-used' to the coding system actually used.
4430 This calls `write-region-annotate-functions' at the start, and
4431 `write-region-post-annotation-function' at the end. */)
4432 (start
, end
, filename
, append
, visit
, lockname
, mustbenew
)
4433 Lisp_Object start
, end
, filename
, append
, visit
, lockname
, mustbenew
;
4438 const unsigned char *fn
;
4440 int count
= SPECPDL_INDEX ();
4442 Lisp_Object handler
;
4443 Lisp_Object visit_file
;
4444 Lisp_Object annotations
;
4445 Lisp_Object encoded_filename
;
4446 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4447 int quietly
= !NILP (visit
);
4448 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4449 struct buffer
*given_buffer
;
4451 int buffer_file_type
= O_BINARY
;
4453 struct coding_system coding
;
4455 if (current_buffer
->base_buffer
&& visiting
)
4456 error ("Cannot do file visiting in an indirect buffer");
4458 if (!NILP (start
) && !STRINGP (start
))
4459 validate_region (&start
, &end
);
4462 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4464 filename
= Fexpand_file_name (filename
, Qnil
);
4466 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4467 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4469 if (STRINGP (visit
))
4470 visit_file
= Fexpand_file_name (visit
, Qnil
);
4472 visit_file
= filename
;
4474 if (NILP (lockname
))
4475 lockname
= visit_file
;
4479 /* If the file name has special constructs in it,
4480 call the corresponding file handler. */
4481 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4482 /* If FILENAME has no handler, see if VISIT has one. */
4483 if (NILP (handler
) && STRINGP (visit
))
4484 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4486 if (!NILP (handler
))
4489 val
= call6 (handler
, Qwrite_region
, start
, end
,
4490 filename
, append
, visit
);
4494 SAVE_MODIFF
= MODIFF
;
4495 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4496 current_buffer
->filename
= visit_file
;
4502 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4504 /* Special kludge to simplify auto-saving. */
4507 /* Do it later, so write-region-annotate-function can work differently
4508 if we save "the buffer" vs "a region".
4509 This is useful in tar-mode. --Stef
4510 XSETFASTINT (start, BEG);
4511 XSETFASTINT (end, Z); */
4515 record_unwind_protect (build_annotations_unwind
,
4516 Vwrite_region_annotation_buffers
);
4517 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4518 count1
= SPECPDL_INDEX ();
4520 given_buffer
= current_buffer
;
4522 if (!STRINGP (start
))
4524 annotations
= build_annotations (start
, end
);
4526 if (current_buffer
!= given_buffer
)
4528 XSETFASTINT (start
, BEGV
);
4529 XSETFASTINT (end
, ZV
);
4535 XSETFASTINT (start
, BEGV
);
4536 XSETFASTINT (end
, ZV
);
4541 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4543 /* Decide the coding-system to encode the data with.
4544 We used to make this choice before calling build_annotations, but that
4545 leads to problems when a write-annotate-function takes care of
4546 unsavable chars (as was the case with X-Symbol). */
4547 Vlast_coding_system_used
4548 = choose_write_coding_system (start
, end
, filename
,
4549 append
, visit
, lockname
, &coding
);
4551 #ifdef CLASH_DETECTION
4553 lock_file (lockname
);
4554 #endif /* CLASH_DETECTION */
4556 encoded_filename
= ENCODE_FILE (filename
);
4558 fn
= SDATA (encoded_filename
);
4562 desc
= emacs_open (fn
, O_WRONLY
| buffer_file_type
, 0);
4563 #else /* not DOS_NT */
4564 desc
= emacs_open (fn
, O_WRONLY
, 0);
4565 #endif /* not DOS_NT */
4567 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4569 desc
= emacs_open (fn
,
4570 O_WRONLY
| O_CREAT
| buffer_file_type
4571 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4572 S_IREAD
| S_IWRITE
);
4573 #else /* not DOS_NT */
4574 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4575 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4576 auto_saving
? auto_save_mode_bits
: 0666);
4577 #endif /* not DOS_NT */
4581 #ifdef CLASH_DETECTION
4583 if (!auto_saving
) unlock_file (lockname
);
4585 #endif /* CLASH_DETECTION */
4587 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4590 record_unwind_protect (close_file_unwind
, make_number (desc
));
4592 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4596 if (NUMBERP (append
))
4597 ret
= lseek (desc
, XINT (append
), 1);
4599 ret
= lseek (desc
, 0, 2);
4602 #ifdef CLASH_DETECTION
4603 if (!auto_saving
) unlock_file (lockname
);
4604 #endif /* CLASH_DETECTION */
4606 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4615 if (STRINGP (start
))
4617 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4618 &annotations
, &coding
);
4621 else if (XINT (start
) != XINT (end
))
4623 failure
= 0 > a_write (desc
, Qnil
,
4624 XINT (start
), XINT (end
) - XINT (start
),
4625 &annotations
, &coding
);
4630 /* If file was empty, still need to write the annotations */
4631 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4632 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4636 if (CODING_REQUIRE_FLUSHING (&coding
)
4637 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4640 /* We have to flush out a data. */
4641 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4642 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4649 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4650 Disk full in NFS may be reported here. */
4651 /* mib says that closing the file will try to write as fast as NFS can do
4652 it, and that means the fsync here is not crucial for autosave files. */
4653 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4655 /* If fsync fails with EINTR, don't treat that as serious. Also
4656 ignore EINVAL which happens when fsync is not supported on this
4658 if (errno
!= EINTR
&& errno
!= EINVAL
)
4659 failure
= 1, save_errno
= errno
;
4663 /* NFS can report a write failure now. */
4664 if (emacs_close (desc
) < 0)
4665 failure
= 1, save_errno
= errno
;
4669 /* Discard the unwind protect for close_file_unwind. */
4670 specpdl_ptr
= specpdl
+ count1
;
4672 /* Call write-region-post-annotation-function. */
4673 while (CONSP (Vwrite_region_annotation_buffers
))
4675 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4676 if (!NILP (Fbuffer_live_p (buf
)))
4679 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4680 call0 (Vwrite_region_post_annotation_function
);
4682 Vwrite_region_annotation_buffers
4683 = XCDR (Vwrite_region_annotation_buffers
);
4686 unbind_to (count
, Qnil
);
4688 #ifdef CLASH_DETECTION
4690 unlock_file (lockname
);
4691 #endif /* CLASH_DETECTION */
4693 /* Do this before reporting IO error
4694 to avoid a "file has changed on disk" warning on
4695 next attempt to save. */
4697 current_buffer
->modtime
= st
.st_mtime
;
4700 error ("IO error writing %s: %s", SDATA (filename
),
4701 emacs_strerror (save_errno
));
4705 SAVE_MODIFF
= MODIFF
;
4706 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4707 current_buffer
->filename
= visit_file
;
4708 update_mode_lines
++;
4713 && ! NILP (Fstring_equal (current_buffer
->filename
,
4714 current_buffer
->auto_save_file_name
)))
4715 SAVE_MODIFF
= MODIFF
;
4721 message_with_string ((INTEGERP (append
)
4731 Lisp_Object
merge ();
4733 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4734 doc
: /* Return t if (car A) is numerically less than (car B). */)
4738 return Flss (Fcar (a
), Fcar (b
));
4741 /* Build the complete list of annotations appropriate for writing out
4742 the text between START and END, by calling all the functions in
4743 write-region-annotate-functions and merging the lists they return.
4744 If one of these functions switches to a different buffer, we assume
4745 that buffer contains altered text. Therefore, the caller must
4746 make sure to restore the current buffer in all cases,
4747 as save-excursion would do. */
4750 build_annotations (start
, end
)
4751 Lisp_Object start
, end
;
4753 Lisp_Object annotations
;
4755 struct gcpro gcpro1
, gcpro2
;
4756 Lisp_Object original_buffer
;
4757 int i
, used_global
= 0;
4759 XSETBUFFER (original_buffer
, current_buffer
);
4762 p
= Vwrite_region_annotate_functions
;
4763 GCPRO2 (annotations
, p
);
4766 struct buffer
*given_buffer
= current_buffer
;
4767 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4768 { /* Use the global value of the hook. */
4771 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4773 p
= Fappend (2, arg
);
4776 Vwrite_region_annotations_so_far
= annotations
;
4777 res
= call2 (XCAR (p
), start
, end
);
4778 /* If the function makes a different buffer current,
4779 assume that means this buffer contains altered text to be output.
4780 Reset START and END from the buffer bounds
4781 and discard all previous annotations because they should have
4782 been dealt with by this function. */
4783 if (current_buffer
!= given_buffer
)
4785 Vwrite_region_annotation_buffers
4786 = Fcons (Fcurrent_buffer (),
4787 Vwrite_region_annotation_buffers
);
4788 XSETFASTINT (start
, BEGV
);
4789 XSETFASTINT (end
, ZV
);
4792 Flength (res
); /* Check basic validity of return value */
4793 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4797 /* Now do the same for annotation functions implied by the file-format */
4798 if (auto_saving
&& (!EQ (current_buffer
->auto_save_file_format
, Qt
)))
4799 p
= current_buffer
->auto_save_file_format
;
4801 p
= current_buffer
->file_format
;
4802 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4804 struct buffer
*given_buffer
= current_buffer
;
4806 Vwrite_region_annotations_so_far
= annotations
;
4808 /* Value is either a list of annotations or nil if the function
4809 has written annotations to a temporary buffer, which is now
4811 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4812 original_buffer
, make_number (i
));
4813 if (current_buffer
!= given_buffer
)
4815 XSETFASTINT (start
, BEGV
);
4816 XSETFASTINT (end
, ZV
);
4821 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4829 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4830 If STRING is nil, POS is the character position in the current buffer.
4831 Intersperse with them the annotations from *ANNOT
4832 which fall within the range of POS to POS + NCHARS,
4833 each at its appropriate position.
4835 We modify *ANNOT by discarding elements as we use them up.
4837 The return value is negative in case of system call failure. */
4840 a_write (desc
, string
, pos
, nchars
, annot
, coding
)
4843 register int nchars
;
4846 struct coding_system
*coding
;
4850 int lastpos
= pos
+ nchars
;
4852 while (NILP (*annot
) || CONSP (*annot
))
4854 tem
= Fcar_safe (Fcar (*annot
));
4857 nextpos
= XFASTINT (tem
);
4859 /* If there are no more annotations in this range,
4860 output the rest of the range all at once. */
4861 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4862 return e_write (desc
, string
, pos
, lastpos
, coding
);
4864 /* Output buffer text up to the next annotation's position. */
4867 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4871 /* Output the annotation. */
4872 tem
= Fcdr (Fcar (*annot
));
4875 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4878 *annot
= Fcdr (*annot
);
4884 /* Write text in the range START and END into descriptor DESC,
4885 encoding them with coding system CODING. If STRING is nil, START
4886 and END are character positions of the current buffer, else they
4887 are indexes to the string STRING. */
4890 e_write (desc
, string
, start
, end
, coding
)
4894 struct coding_system
*coding
;
4896 if (STRINGP (string
))
4899 end
= SCHARS (string
);
4902 /* We used to have a code for handling selective display here. But,
4903 now it is handled within encode_coding. */
4907 if (STRINGP (string
))
4909 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
4910 if (CODING_REQUIRE_ENCODING (coding
))
4912 encode_coding_object (coding
, string
,
4913 start
, string_char_to_byte (string
, start
),
4914 end
, string_char_to_byte (string
, end
), Qt
);
4918 coding
->dst_object
= string
;
4919 coding
->consumed_char
= SCHARS (string
);
4920 coding
->produced
= SBYTES (string
);
4925 int start_byte
= CHAR_TO_BYTE (start
);
4926 int end_byte
= CHAR_TO_BYTE (end
);
4928 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
4929 if (CODING_REQUIRE_ENCODING (coding
))
4931 encode_coding_object (coding
, Fcurrent_buffer (),
4932 start
, start_byte
, end
, end_byte
, Qt
);
4936 coding
->dst_object
= Qnil
;
4937 coding
->dst_pos_byte
= start_byte
;
4938 if (start
>= GPT
|| end
<= GPT
)
4940 coding
->consumed_char
= end
- start
;
4941 coding
->produced
= end_byte
- start_byte
;
4945 coding
->consumed_char
= GPT
- start
;
4946 coding
->produced
= GPT_BYTE
- start_byte
;
4951 if (coding
->produced
> 0)
4955 STRINGP (coding
->dst_object
)
4956 ? SDATA (coding
->dst_object
)
4957 : BYTE_POS_ADDR (coding
->dst_pos_byte
),
4960 if (coding
->produced
)
4963 start
+= coding
->consumed_char
;
4969 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
4970 Sverify_visited_file_modtime
, 1, 1, 0,
4971 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
4972 This means that the file has not been changed since it was visited or saved.
4973 See Info node `(elisp)Modification Time' for more details. */)
4979 Lisp_Object handler
;
4980 Lisp_Object filename
;
4985 if (!STRINGP (b
->filename
)) return Qt
;
4986 if (b
->modtime
== 0) return Qt
;
4988 /* If the file name has special constructs in it,
4989 call the corresponding file handler. */
4990 handler
= Ffind_file_name_handler (b
->filename
,
4991 Qverify_visited_file_modtime
);
4992 if (!NILP (handler
))
4993 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
4995 filename
= ENCODE_FILE (b
->filename
);
4997 if (stat (SDATA (filename
), &st
) < 0)
4999 /* If the file doesn't exist now and didn't exist before,
5000 we say that it isn't modified, provided the error is a tame one. */
5001 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
5006 if (st
.st_mtime
== b
->modtime
5007 /* If both are positive, accept them if they are off by one second. */
5008 || (st
.st_mtime
> 0 && b
->modtime
> 0
5009 && (st
.st_mtime
== b
->modtime
+ 1
5010 || st
.st_mtime
== b
->modtime
- 1)))
5015 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5016 Sclear_visited_file_modtime
, 0, 0, 0,
5017 doc
: /* Clear out records of last mod time of visited file.
5018 Next attempt to save will certainly not complain of a discrepancy. */)
5021 current_buffer
->modtime
= 0;
5025 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5026 Svisited_file_modtime
, 0, 0, 0,
5027 doc
: /* Return the current buffer's recorded visited file modification time.
5028 The value is a list of the form (HIGH LOW), like the time values
5029 that `file-attributes' returns. If the current buffer has no recorded
5030 file modification time, this function returns 0.
5031 See Info node `(elisp)Modification Time' for more details. */)
5034 if (! current_buffer
->modtime
)
5035 return make_number (0);
5036 return make_time ((time_t) current_buffer
->modtime
);
5039 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5040 Sset_visited_file_modtime
, 0, 1, 0,
5041 doc
: /* Update buffer's recorded modification time from the visited file's time.
5042 Useful if the buffer was not read from the file normally
5043 or if the file itself has been changed for some known benign reason.
5044 An argument specifies the modification time value to use
5045 \(instead of that of the visited file), in the form of a list
5046 \(HIGH . LOW) or (HIGH LOW). */)
5048 Lisp_Object time_list
;
5050 if (!NILP (time_list
))
5051 current_buffer
->modtime
= cons_to_long (time_list
);
5054 register Lisp_Object filename
;
5056 Lisp_Object handler
;
5058 filename
= Fexpand_file_name (current_buffer
->filename
, Qnil
);
5060 /* If the file name has special constructs in it,
5061 call the corresponding file handler. */
5062 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5063 if (!NILP (handler
))
5064 /* The handler can find the file name the same way we did. */
5065 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5067 filename
= ENCODE_FILE (filename
);
5069 if (stat (SDATA (filename
), &st
) >= 0)
5070 current_buffer
->modtime
= st
.st_mtime
;
5077 auto_save_error (error
)
5080 Lisp_Object args
[3], msg
;
5082 struct gcpro gcpro1
;
5086 auto_save_error_occurred
= 1;
5088 ring_bell (XFRAME (selected_frame
));
5090 args
[0] = build_string ("Auto-saving %s: %s");
5091 args
[1] = current_buffer
->name
;
5092 args
[2] = Ferror_message_string (error
);
5093 msg
= Fformat (3, args
);
5095 nbytes
= SBYTES (msg
);
5096 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5097 bcopy (SDATA (msg
), msgbuf
, nbytes
);
5099 for (i
= 0; i
< 3; ++i
)
5102 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5104 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5105 Fsleep_for (make_number (1), Qnil
);
5119 auto_save_mode_bits
= 0666;
5121 /* Get visited file's mode to become the auto save file's mode. */
5122 if (! NILP (current_buffer
->filename
))
5124 if (stat (SDATA (current_buffer
->filename
), &st
) >= 0)
5125 /* But make sure we can overwrite it later! */
5126 auto_save_mode_bits
= st
.st_mode
| 0600;
5127 else if ((modes
= Ffile_modes (current_buffer
->filename
),
5129 /* Remote files don't cooperate with stat. */
5130 auto_save_mode_bits
= XINT (modes
) | 0600;
5134 Fwrite_region (Qnil
, Qnil
, current_buffer
->auto_save_file_name
, Qnil
,
5135 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5140 do_auto_save_unwind (arg
) /* used as unwind-protect function */
5143 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5155 do_auto_save_unwind_1 (value
) /* used as unwind-protect function */
5158 minibuffer_auto_raise
= XINT (value
);
5163 do_auto_save_make_dir (dir
)
5168 call2 (Qmake_directory
, dir
, Qt
);
5169 XSETFASTINT (mode
, 0700);
5170 return Fset_file_modes (dir
, mode
);
5174 do_auto_save_eh (ignore
)
5180 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5181 doc
: /* Auto-save all buffers that need it.
5182 This is all buffers that have auto-saving enabled
5183 and are changed since last auto-saved.
5184 Auto-saving writes the buffer into a file
5185 so that your editing is not lost if the system crashes.
5186 This file is not the file you visited; that changes only when you save.
5187 Normally we run the normal hook `auto-save-hook' before saving.
5189 A non-nil NO-MESSAGE argument means do not print any message if successful.
5190 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5191 (no_message
, current_only
)
5192 Lisp_Object no_message
, current_only
;
5194 struct buffer
*old
= current_buffer
, *b
;
5195 Lisp_Object tail
, buf
;
5197 int do_handled_files
;
5199 FILE *stream
= NULL
;
5200 int count
= SPECPDL_INDEX ();
5201 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5202 int old_message_p
= 0;
5203 struct gcpro gcpro1
, gcpro2
;
5205 if (max_specpdl_size
< specpdl_size
+ 40)
5206 max_specpdl_size
= specpdl_size
+ 40;
5211 if (NILP (no_message
))
5213 old_message_p
= push_message ();
5214 record_unwind_protect (pop_message_unwind
, Qnil
);
5217 /* Ordinarily don't quit within this function,
5218 but don't make it impossible to quit (in case we get hung in I/O). */
5222 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5223 point to non-strings reached from Vbuffer_alist. */
5225 if (!NILP (Vrun_hooks
))
5226 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5228 if (STRINGP (Vauto_save_list_file_name
))
5230 Lisp_Object listfile
;
5232 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5234 /* Don't try to create the directory when shutting down Emacs,
5235 because creating the directory might signal an error, and
5236 that would leave Emacs in a strange state. */
5237 if (!NILP (Vrun_hooks
))
5241 GCPRO2 (dir
, listfile
);
5242 dir
= Ffile_name_directory (listfile
);
5243 if (NILP (Ffile_directory_p (dir
)))
5244 internal_condition_case_1 (do_auto_save_make_dir
,
5245 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5250 stream
= fopen (SDATA (listfile
), "w");
5253 record_unwind_protect (do_auto_save_unwind
,
5254 make_save_value (stream
, 0));
5255 record_unwind_protect (do_auto_save_unwind_1
,
5256 make_number (minibuffer_auto_raise
));
5257 minibuffer_auto_raise
= 0;
5259 auto_save_error_occurred
= 0;
5261 /* On first pass, save all files that don't have handlers.
5262 On second pass, save all files that do have handlers.
5264 If Emacs is crashing, the handlers may tweak what is causing
5265 Emacs to crash in the first place, and it would be a shame if
5266 Emacs failed to autosave perfectly ordinary files because it
5267 couldn't handle some ange-ftp'd file. */
5269 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5270 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5272 buf
= XCDR (XCAR (tail
));
5275 /* Record all the buffers that have auto save mode
5276 in the special file that lists them. For each of these buffers,
5277 Record visited name (if any) and auto save name. */
5278 if (STRINGP (b
->auto_save_file_name
)
5279 && stream
!= NULL
&& do_handled_files
== 0)
5282 if (!NILP (b
->filename
))
5284 fwrite (SDATA (b
->filename
), 1,
5285 SBYTES (b
->filename
), stream
);
5287 putc ('\n', stream
);
5288 fwrite (SDATA (b
->auto_save_file_name
), 1,
5289 SBYTES (b
->auto_save_file_name
), stream
);
5290 putc ('\n', stream
);
5294 if (!NILP (current_only
)
5295 && b
!= current_buffer
)
5298 /* Don't auto-save indirect buffers.
5299 The base buffer takes care of it. */
5303 /* Check for auto save enabled
5304 and file changed since last auto save
5305 and file changed since last real save. */
5306 if (STRINGP (b
->auto_save_file_name
)
5307 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5308 && b
->auto_save_modified
< BUF_MODIFF (b
)
5309 /* -1 means we've turned off autosaving for a while--see below. */
5310 && XINT (b
->save_length
) >= 0
5311 && (do_handled_files
5312 || NILP (Ffind_file_name_handler (b
->auto_save_file_name
,
5315 EMACS_TIME before_time
, after_time
;
5317 EMACS_GET_TIME (before_time
);
5319 /* If we had a failure, don't try again for 20 minutes. */
5320 if (b
->auto_save_failure_time
>= 0
5321 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5324 set_buffer_internal (b
);
5325 if (NILP (Vauto_save_include_big_deletions
)
5326 && (XFASTINT (b
->save_length
) * 10
5327 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5328 /* A short file is likely to change a large fraction;
5329 spare the user annoying messages. */
5330 && XFASTINT (b
->save_length
) > 5000
5331 /* These messages are frequent and annoying for `*mail*'. */
5332 && !EQ (b
->filename
, Qnil
)
5333 && NILP (no_message
))
5335 /* It has shrunk too much; turn off auto-saving here. */
5336 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5337 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5339 minibuffer_auto_raise
= 0;
5340 /* Turn off auto-saving until there's a real save,
5341 and prevent any more warnings. */
5342 XSETINT (b
->save_length
, -1);
5343 Fsleep_for (make_number (1), Qnil
);
5346 if (!auto_saved
&& NILP (no_message
))
5347 message1 ("Auto-saving...");
5348 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5350 b
->auto_save_modified
= BUF_MODIFF (b
);
5351 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5352 set_buffer_internal (old
);
5354 EMACS_GET_TIME (after_time
);
5356 /* If auto-save took more than 60 seconds,
5357 assume it was an NFS failure that got a timeout. */
5358 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5359 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5363 /* Prevent another auto save till enough input events come in. */
5364 record_auto_save ();
5366 if (auto_saved
&& NILP (no_message
))
5370 /* If we are going to restore an old message,
5371 give time to read ours. */
5372 sit_for (make_number (1), 0, 0);
5375 else if (!auto_save_error_occurred
)
5376 /* Don't overwrite the error message if an error occurred.
5377 If we displayed a message and then restored a state
5378 with no message, leave a "done" message on the screen. */
5379 message1 ("Auto-saving...done");
5384 /* This restores the message-stack status. */
5385 unbind_to (count
, Qnil
);
5389 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5390 Sset_buffer_auto_saved
, 0, 0, 0,
5391 doc
: /* Mark current buffer as auto-saved with its current text.
5392 No auto-save file will be written until the buffer changes again. */)
5395 current_buffer
->auto_save_modified
= MODIFF
;
5396 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5397 current_buffer
->auto_save_failure_time
= -1;
5401 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5402 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5403 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5406 current_buffer
->auto_save_failure_time
= -1;
5410 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5412 doc
: /* Return t if current buffer has been auto-saved recently.
5413 More precisely, if it has been auto-saved since last read from or saved
5414 in the visited file. If the buffer has no visited file,
5415 then any auto-save counts as "recent". */)
5418 return (SAVE_MODIFF
< current_buffer
->auto_save_modified
) ? Qt
: Qnil
;
5421 /* Reading and completing file names */
5423 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5424 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5425 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5426 The return value is only relevant for a call to `read-file-name' that happens
5427 before any other event (mouse or keypress) is handled. */)
5430 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5431 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5441 Fread_file_name (prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
)
5442 Lisp_Object prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
;
5444 struct gcpro gcpro1
, gcpro2
;
5445 Lisp_Object args
[7];
5447 GCPRO1 (default_filename
);
5448 args
[0] = intern ("read-file-name");
5451 args
[3] = default_filename
;
5452 args
[4] = mustmatch
;
5454 args
[6] = predicate
;
5455 RETURN_UNGCPRO (Ffuncall (7, args
));
5462 /* Must be set before any path manipulation is performed. */
5463 XSETFASTINT (Vdirectory_sep_char
, '/');
5470 Qoperations
= intern ("operations");
5471 Qexpand_file_name
= intern ("expand-file-name");
5472 Qsubstitute_in_file_name
= intern ("substitute-in-file-name");
5473 Qdirectory_file_name
= intern ("directory-file-name");
5474 Qfile_name_directory
= intern ("file-name-directory");
5475 Qfile_name_nondirectory
= intern ("file-name-nondirectory");
5476 Qunhandled_file_name_directory
= intern ("unhandled-file-name-directory");
5477 Qfile_name_as_directory
= intern ("file-name-as-directory");
5478 Qcopy_file
= intern ("copy-file");
5479 Qmake_directory_internal
= intern ("make-directory-internal");
5480 Qmake_directory
= intern ("make-directory");
5481 Qdelete_directory_internal
= intern ("delete-directory-internal");
5482 Qdelete_file
= intern ("delete-file");
5483 Qrename_file
= intern ("rename-file");
5484 Qadd_name_to_file
= intern ("add-name-to-file");
5485 Qmake_symbolic_link
= intern ("make-symbolic-link");
5486 Qfile_exists_p
= intern ("file-exists-p");
5487 Qfile_executable_p
= intern ("file-executable-p");
5488 Qfile_readable_p
= intern ("file-readable-p");
5489 Qfile_writable_p
= intern ("file-writable-p");
5490 Qfile_symlink_p
= intern ("file-symlink-p");
5491 Qaccess_file
= intern ("access-file");
5492 Qfile_directory_p
= intern ("file-directory-p");
5493 Qfile_regular_p
= intern ("file-regular-p");
5494 Qfile_accessible_directory_p
= intern ("file-accessible-directory-p");
5495 Qfile_modes
= intern ("file-modes");
5496 Qset_file_modes
= intern ("set-file-modes");
5497 Qset_file_times
= intern ("set-file-times");
5498 Qfile_newer_than_file_p
= intern ("file-newer-than-file-p");
5499 Qinsert_file_contents
= intern ("insert-file-contents");
5500 Qwrite_region
= intern ("write-region");
5501 Qverify_visited_file_modtime
= intern ("verify-visited-file-modtime");
5502 Qset_visited_file_modtime
= intern ("set-visited-file-modtime");
5503 Qauto_save_coding
= intern ("auto-save-coding");
5505 staticpro (&Qoperations
);
5506 staticpro (&Qexpand_file_name
);
5507 staticpro (&Qsubstitute_in_file_name
);
5508 staticpro (&Qdirectory_file_name
);
5509 staticpro (&Qfile_name_directory
);
5510 staticpro (&Qfile_name_nondirectory
);
5511 staticpro (&Qunhandled_file_name_directory
);
5512 staticpro (&Qfile_name_as_directory
);
5513 staticpro (&Qcopy_file
);
5514 staticpro (&Qmake_directory_internal
);
5515 staticpro (&Qmake_directory
);
5516 staticpro (&Qdelete_directory_internal
);
5517 staticpro (&Qdelete_file
);
5518 staticpro (&Qrename_file
);
5519 staticpro (&Qadd_name_to_file
);
5520 staticpro (&Qmake_symbolic_link
);
5521 staticpro (&Qfile_exists_p
);
5522 staticpro (&Qfile_executable_p
);
5523 staticpro (&Qfile_readable_p
);
5524 staticpro (&Qfile_writable_p
);
5525 staticpro (&Qaccess_file
);
5526 staticpro (&Qfile_symlink_p
);
5527 staticpro (&Qfile_directory_p
);
5528 staticpro (&Qfile_regular_p
);
5529 staticpro (&Qfile_accessible_directory_p
);
5530 staticpro (&Qfile_modes
);
5531 staticpro (&Qset_file_modes
);
5532 staticpro (&Qset_file_times
);
5533 staticpro (&Qfile_newer_than_file_p
);
5534 staticpro (&Qinsert_file_contents
);
5535 staticpro (&Qwrite_region
);
5536 staticpro (&Qverify_visited_file_modtime
);
5537 staticpro (&Qset_visited_file_modtime
);
5538 staticpro (&Qauto_save_coding
);
5540 Qfile_name_history
= intern ("file-name-history");
5541 Fset (Qfile_name_history
, Qnil
);
5542 staticpro (&Qfile_name_history
);
5544 Qfile_error
= intern ("file-error");
5545 staticpro (&Qfile_error
);
5546 Qfile_already_exists
= intern ("file-already-exists");
5547 staticpro (&Qfile_already_exists
);
5548 Qfile_date_error
= intern ("file-date-error");
5549 staticpro (&Qfile_date_error
);
5550 Qexcl
= intern ("excl");
5554 Qfind_buffer_file_type
= intern ("find-buffer-file-type");
5555 staticpro (&Qfind_buffer_file_type
);
5558 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system
,
5559 doc
: /* *Coding system for encoding file names.
5560 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5561 Vfile_name_coding_system
= Qnil
;
5563 DEFVAR_LISP ("default-file-name-coding-system",
5564 &Vdefault_file_name_coding_system
,
5565 doc
: /* Default coding system for encoding file names.
5566 This variable is used only when `file-name-coding-system' is nil.
5568 This variable is set/changed by the command `set-language-environment'.
5569 User should not set this variable manually,
5570 instead use `file-name-coding-system' to get a constant encoding
5571 of file names regardless of the current language environment. */);
5572 Vdefault_file_name_coding_system
= Qnil
;
5574 Qformat_decode
= intern ("format-decode");
5575 staticpro (&Qformat_decode
);
5576 Qformat_annotate_function
= intern ("format-annotate-function");
5577 staticpro (&Qformat_annotate_function
);
5578 Qafter_insert_file_set_coding
= intern ("after-insert-file-set-coding");
5579 staticpro (&Qafter_insert_file_set_coding
);
5581 Qcar_less_than_car
= intern ("car-less-than-car");
5582 staticpro (&Qcar_less_than_car
);
5584 Fput (Qfile_error
, Qerror_conditions
,
5585 list2 (Qfile_error
, Qerror
));
5586 Fput (Qfile_error
, Qerror_message
,
5587 build_string ("File error"));
5589 Fput (Qfile_already_exists
, Qerror_conditions
,
5590 list3 (Qfile_already_exists
, Qfile_error
, Qerror
));
5591 Fput (Qfile_already_exists
, Qerror_message
,
5592 build_string ("File already exists"));
5594 Fput (Qfile_date_error
, Qerror_conditions
,
5595 list3 (Qfile_date_error
, Qfile_error
, Qerror
));
5596 Fput (Qfile_date_error
, Qerror_message
,
5597 build_string ("Cannot set file date"));
5599 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char
,
5600 doc
: /* Directory separator character for built-in functions that return file names.
5601 The value is always ?/. Don't use this variable, just use `/'. */);
5603 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist
,
5604 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
5605 If a file name matches REGEXP, then all I/O on that file is done by calling
5608 The first argument given to HANDLER is the name of the I/O primitive
5609 to be handled; the remaining arguments are the arguments that were
5610 passed to that primitive. For example, if you do
5611 (file-exists-p FILENAME)
5612 and FILENAME is handled by HANDLER, then HANDLER is called like this:
5613 (funcall HANDLER 'file-exists-p FILENAME)
5614 The function `find-file-name-handler' checks this list for a handler
5615 for its argument. */);
5616 Vfile_name_handler_alist
= Qnil
;
5618 DEFVAR_LISP ("set-auto-coding-function",
5619 &Vset_auto_coding_function
,
5620 doc
: /* If non-nil, a function to call to decide a coding system of file.
5621 Two arguments are passed to this function: the file name
5622 and the length of a file contents following the point.
5623 This function should return a coding system to decode the file contents.
5624 It should check the file name against `auto-coding-alist'.
5625 If no coding system is decided, it should check a coding system
5626 specified in the heading lines with the format:
5627 -*- ... coding: CODING-SYSTEM; ... -*-
5628 or local variable spec of the tailing lines with `coding:' tag. */);
5629 Vset_auto_coding_function
= Qnil
;
5631 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions
,
5632 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5633 Each is passed one argument, the number of characters inserted,
5634 with point at the start of the inserted text. Each function
5635 should leave point the same, and return the new character count.
5636 If `insert-file-contents' is intercepted by a handler from
5637 `file-name-handler-alist', that handler is responsible for calling the
5638 functions in `after-insert-file-functions' if appropriate. */);
5639 Vafter_insert_file_functions
= Qnil
;
5641 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions
,
5642 doc
: /* A list of functions to be called at the start of `write-region'.
5643 Each is passed two arguments, START and END as for `write-region'.
5644 These are usually two numbers but not always; see the documentation
5645 for `write-region'. The function should return a list of pairs
5646 of the form (POSITION . STRING), consisting of strings to be effectively
5647 inserted at the specified positions of the file being written (1 means to
5648 insert before the first byte written). The POSITIONs must be sorted into
5651 If there are several annotation functions, the lists returned by these
5652 functions are merged destructively. As each annotation function runs,
5653 the variable `write-region-annotations-so-far' contains a list of all
5654 annotations returned by previous annotation functions.
5656 An annotation function can return with a different buffer current.
5657 Doing so removes the annotations returned by previous functions, and
5658 resets START and END to `point-min' and `point-max' of the new buffer.
5660 After `write-region' completes, Emacs calls the function stored in
5661 `write-region-post-annotation-function', once for each buffer that was
5662 current when building the annotations (i.e., at least once), with that
5663 buffer current. */);
5664 Vwrite_region_annotate_functions
= Qnil
;
5665 staticpro (&Qwrite_region_annotate_functions
);
5666 Qwrite_region_annotate_functions
5667 = intern ("write-region-annotate-functions");
5669 DEFVAR_LISP ("write-region-post-annotation-function",
5670 &Vwrite_region_post_annotation_function
,
5671 doc
: /* Function to call after `write-region' completes.
5672 The function is called with no arguments. If one or more of the
5673 annotation functions in `write-region-annotate-functions' changed the
5674 current buffer, the function stored in this variable is called for
5675 each of those additional buffers as well, in addition to the original
5676 buffer. The relevant buffer is current during each function call. */);
5677 Vwrite_region_post_annotation_function
= Qnil
;
5678 staticpro (&Vwrite_region_annotation_buffers
);
5680 DEFVAR_LISP ("write-region-annotations-so-far",
5681 &Vwrite_region_annotations_so_far
,
5682 doc
: /* When an annotation function is called, this holds the previous annotations.
5683 These are the annotations made by other annotation functions
5684 that were already called. See also `write-region-annotate-functions'. */);
5685 Vwrite_region_annotations_so_far
= Qnil
;
5687 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers
,
5688 doc
: /* A list of file name handlers that temporarily should not be used.
5689 This applies only to the operation `inhibit-file-name-operation'. */);
5690 Vinhibit_file_name_handlers
= Qnil
;
5692 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation
,
5693 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5694 Vinhibit_file_name_operation
= Qnil
;
5696 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name
,
5697 doc
: /* File name in which we write a list of all auto save file names.
5698 This variable is initialized automatically from `auto-save-list-file-prefix'
5699 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5700 a non-nil value. */);
5701 Vauto_save_list_file_name
= Qnil
;
5703 DEFVAR_LISP ("auto-save-visited-file-name", &Vauto_save_visited_file_name
,
5704 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5705 Normally auto-save files are written under other names. */);
5706 Vauto_save_visited_file_name
= Qnil
;
5708 DEFVAR_LISP ("auto-save-include-big-deletions", &Vauto_save_include_big_deletions
,
5709 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5710 If nil, deleting a substantial portion of the text disables auto-save
5711 in the buffer; this is the default behavior, because the auto-save
5712 file is usually more useful if it contains the deleted text. */);
5713 Vauto_save_include_big_deletions
= Qnil
;
5716 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync
,
5717 doc
: /* *Non-nil means don't call fsync in `write-region'.
5718 This variable affects calls to `write-region' as well as save commands.
5719 A non-nil value may result in data loss! */);
5720 write_region_inhibit_fsync
= 0;
5723 DEFVAR_BOOL ("delete-by-moving-to-trash", &delete_by_moving_to_trash
,
5724 doc
: /* Specifies whether to use the system's trash can.
5725 When non-nil, the function `move-file-to-trash' will be used by
5726 `delete-file' and `delete-directory'. */);
5727 delete_by_moving_to_trash
= 0;
5728 Qdelete_by_moving_to_trash
= intern ("delete-by-moving-to-trash");
5729 Qmove_file_to_trash
= intern ("move-file-to-trash");
5730 staticpro (&Qmove_file_to_trash
);
5732 defsubr (&Sfind_file_name_handler
);
5733 defsubr (&Sfile_name_directory
);
5734 defsubr (&Sfile_name_nondirectory
);
5735 defsubr (&Sunhandled_file_name_directory
);
5736 defsubr (&Sfile_name_as_directory
);
5737 defsubr (&Sdirectory_file_name
);
5738 defsubr (&Smake_temp_name
);
5739 defsubr (&Sexpand_file_name
);
5740 defsubr (&Ssubstitute_in_file_name
);
5741 defsubr (&Scopy_file
);
5742 defsubr (&Smake_directory_internal
);
5743 defsubr (&Sdelete_directory_internal
);
5744 defsubr (&Sdelete_file
);
5745 defsubr (&Srename_file
);
5746 defsubr (&Sadd_name_to_file
);
5747 defsubr (&Smake_symbolic_link
);
5748 defsubr (&Sfile_name_absolute_p
);
5749 defsubr (&Sfile_exists_p
);
5750 defsubr (&Sfile_executable_p
);
5751 defsubr (&Sfile_readable_p
);
5752 defsubr (&Sfile_writable_p
);
5753 defsubr (&Saccess_file
);
5754 defsubr (&Sfile_symlink_p
);
5755 defsubr (&Sfile_directory_p
);
5756 defsubr (&Sfile_accessible_directory_p
);
5757 defsubr (&Sfile_regular_p
);
5758 defsubr (&Sfile_modes
);
5759 defsubr (&Sset_file_modes
);
5760 defsubr (&Sset_file_times
);
5761 defsubr (&Sset_default_file_modes
);
5762 defsubr (&Sdefault_file_modes
);
5763 defsubr (&Sfile_newer_than_file_p
);
5764 defsubr (&Sinsert_file_contents
);
5765 defsubr (&Swrite_region
);
5766 defsubr (&Scar_less_than_car
);
5767 defsubr (&Sverify_visited_file_modtime
);
5768 defsubr (&Sclear_visited_file_modtime
);
5769 defsubr (&Svisited_file_modtime
);
5770 defsubr (&Sset_visited_file_modtime
);
5771 defsubr (&Sdo_auto_save
);
5772 defsubr (&Sset_buffer_auto_saved
);
5773 defsubr (&Sclear_buffer_auto_save_failure
);
5774 defsubr (&Srecent_auto_save_p
);
5776 defsubr (&Snext_read_file_uses_dialog_p
);
5779 defsubr (&Sunix_sync
);
5783 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
5784 (do not change this comment) */