1 /* File IO for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 #include <sys/types.h>
37 #if !defined (S_ISLNK) && defined (S_IFLNK)
38 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
41 #if !defined (S_ISFIFO) && defined (S_IFIFO)
42 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
45 #if !defined (S_ISREG) && defined (S_IFREG)
46 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
63 #include "intervals.h"
65 #include "character.h"
68 #include "blockinput.h"
70 #include "dispextern.h"
77 #endif /* not WINDOWSNT */
81 #include <sys/param.h>
89 #define CORRECT_DIR_SEPS(s) \
90 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
91 else unixtodos_filename (s); \
93 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
94 redirector allows the six letters between 'Z' and 'a' as well. */
96 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
99 #define IS_DRIVE(x) isalpha (x)
101 /* Need to lower-case the drive letter, or else expanded
102 filenames will sometimes compare inequal, because
103 `expand-file-name' doesn't always down-case the drive letter. */
104 #define DRIVE_LETTER(x) (tolower (x))
113 #include "commands.h"
114 extern int use_dialog_box
;
115 extern int use_file_dialog
;
129 #ifndef FILE_SYSTEM_CASE
130 #define FILE_SYSTEM_CASE(filename) (filename)
133 /* Nonzero during writing of auto-save files */
136 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
137 a new file with the same mode as the original */
138 int auto_save_mode_bits
;
140 /* Set by auto_save_1 if an error occurred during the last auto-save. */
141 int auto_save_error_occurred
;
143 /* The symbol bound to coding-system-for-read when
144 insert-file-contents is called for recovering a file. This is not
145 an actual coding system name, but just an indicator to tell
146 insert-file-contents to use `emacs-mule' with a special flag for
147 auto saving and recovering a file. */
148 Lisp_Object Qauto_save_coding
;
150 /* Coding system for file names, or nil if none. */
151 Lisp_Object Vfile_name_coding_system
;
153 /* Coding system for file names used only when
154 Vfile_name_coding_system is nil. */
155 Lisp_Object Vdefault_file_name_coding_system
;
157 /* Alist of elements (REGEXP . HANDLER) for file names
158 whose I/O is done with a special handler. */
159 Lisp_Object Vfile_name_handler_alist
;
161 /* Property name of a file name handler,
162 which gives a list of operations it handles.. */
163 Lisp_Object Qoperations
;
165 /* Lisp functions for translating file formats */
166 Lisp_Object Qformat_decode
, Qformat_annotate_function
;
168 /* Function to be called to decide a coding system of a reading file. */
169 Lisp_Object Vset_auto_coding_function
;
171 /* Functions to be called to process text properties in inserted file. */
172 Lisp_Object Vafter_insert_file_functions
;
174 /* Lisp function for setting buffer-file-coding-system and the
175 multibyteness of the current buffer after inserting a file. */
176 Lisp_Object Qafter_insert_file_set_coding
;
178 /* Functions to be called to create text property annotations for file. */
179 Lisp_Object Vwrite_region_annotate_functions
;
180 Lisp_Object Qwrite_region_annotate_functions
;
181 Lisp_Object Vwrite_region_post_annotation_function
;
183 /* During build_annotations, each time an annotation function is called,
184 this holds the annotations made by the previous functions. */
185 Lisp_Object Vwrite_region_annotations_so_far
;
187 /* Each time an annotation function changes the buffer, the new buffer
189 Lisp_Object Vwrite_region_annotation_buffers
;
191 /* File name in which we write a list of all our auto save files. */
192 Lisp_Object Vauto_save_list_file_name
;
194 /* Whether or not files are auto-saved into themselves. */
195 Lisp_Object Vauto_save_visited_file_name
;
197 /* Whether or not to continue auto-saving after a large deletion. */
198 Lisp_Object Vauto_save_include_big_deletions
;
200 /* On NT, specifies the directory separator character, used (eg.) when
201 expanding file names. This can be bound to / or \. */
202 Lisp_Object Vdirectory_sep_char
;
205 /* Nonzero means skip the call to fsync in Fwrite-region. */
206 int write_region_inhibit_fsync
;
209 /* Non-zero means call move-file-to-trash in Fdelete_file or
210 Fdelete_directory_internal. */
211 int delete_by_moving_to_trash
;
213 Lisp_Object Qdelete_by_moving_to_trash
;
215 /* Lisp function for moving files to trash. */
216 Lisp_Object Qmove_file_to_trash
;
218 /* Lisp function for recursively copying directories. */
219 Lisp_Object Qcopy_directory
;
221 /* Lisp function for recursively deleting directories. */
222 Lisp_Object Qdelete_directory
;
224 extern Lisp_Object Vuser_login_name
;
227 extern Lisp_Object Vw32_get_true_file_attributes
;
230 extern int minibuf_level
;
232 extern int minibuffer_auto_raise
;
234 /* These variables describe handlers that have "already" had a chance
235 to handle the current operation.
237 Vinhibit_file_name_handlers is a list of file name handlers.
238 Vinhibit_file_name_operation is the operation being handled.
239 If we try to handle that operation, we ignore those handlers. */
241 static Lisp_Object Vinhibit_file_name_handlers
;
242 static Lisp_Object Vinhibit_file_name_operation
;
244 Lisp_Object Qfile_error
, Qfile_already_exists
, Qfile_date_error
;
246 Lisp_Object Qfile_name_history
;
248 Lisp_Object Qcar_less_than_car
;
250 static int a_write
P_ ((int, Lisp_Object
, int, int,
251 Lisp_Object
*, struct coding_system
*));
252 static int e_write
P_ ((int, Lisp_Object
, int, int, struct coding_system
*));
256 report_file_error (string
, data
)
260 Lisp_Object errstring
;
264 synchronize_system_messages_locale ();
265 str
= strerror (errorno
);
266 errstring
= code_convert_string_norecord (make_unibyte_string (str
,
268 Vlocale_coding_system
, 0);
274 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
277 /* System error messages are capitalized. Downcase the initial
278 unless it is followed by a slash. (The slash case caters to
279 error messages that begin with "I/O" or, in German, "E/A".) */
280 if (STRING_MULTIBYTE (errstring
)
281 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
285 str
= (char *) SDATA (errstring
);
286 c
= STRING_CHAR (str
);
287 Faset (errstring
, make_number (0), make_number (DOWNCASE (c
)));
290 xsignal (Qfile_error
,
291 Fcons (build_string (string
), Fcons (errstring
, data
)));
296 close_file_unwind (fd
)
299 emacs_close (XFASTINT (fd
));
303 /* Restore point, having saved it as a marker. */
306 restore_point_unwind (location
)
307 Lisp_Object location
;
309 Fgoto_char (location
);
310 Fset_marker (location
, Qnil
, Qnil
);
315 Lisp_Object Qexpand_file_name
;
316 Lisp_Object Qsubstitute_in_file_name
;
317 Lisp_Object Qdirectory_file_name
;
318 Lisp_Object Qfile_name_directory
;
319 Lisp_Object Qfile_name_nondirectory
;
320 Lisp_Object Qunhandled_file_name_directory
;
321 Lisp_Object Qfile_name_as_directory
;
322 Lisp_Object Qcopy_file
;
323 Lisp_Object Qmake_directory_internal
;
324 Lisp_Object Qmake_directory
;
325 Lisp_Object Qdelete_directory_internal
;
326 Lisp_Object Qdelete_file
;
327 Lisp_Object Qrename_file
;
328 Lisp_Object Qadd_name_to_file
;
329 Lisp_Object Qmake_symbolic_link
;
330 Lisp_Object Qfile_exists_p
;
331 Lisp_Object Qfile_executable_p
;
332 Lisp_Object Qfile_readable_p
;
333 Lisp_Object Qfile_writable_p
;
334 Lisp_Object Qfile_symlink_p
;
335 Lisp_Object Qaccess_file
;
336 Lisp_Object Qfile_directory_p
;
337 Lisp_Object Qfile_regular_p
;
338 Lisp_Object Qfile_accessible_directory_p
;
339 Lisp_Object Qfile_modes
;
340 Lisp_Object Qset_file_modes
;
341 Lisp_Object Qset_file_times
;
342 Lisp_Object Qfile_newer_than_file_p
;
343 Lisp_Object Qinsert_file_contents
;
344 Lisp_Object Qwrite_region
;
345 Lisp_Object Qverify_visited_file_modtime
;
346 Lisp_Object Qset_visited_file_modtime
;
348 DEFUN ("find-file-name-handler", Ffind_file_name_handler
, Sfind_file_name_handler
, 2, 2, 0,
349 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
350 Otherwise, return nil.
351 A file name is handled if one of the regular expressions in
352 `file-name-handler-alist' matches it.
354 If OPERATION equals `inhibit-file-name-operation', then we ignore
355 any handlers that are members of `inhibit-file-name-handlers',
356 but we still do run any other handlers. This lets handlers
357 use the standard functions without calling themselves recursively. */)
358 (filename
, operation
)
359 Lisp_Object filename
, operation
;
361 /* This function must not munge the match data. */
362 Lisp_Object chain
, inhibited_handlers
, result
;
366 CHECK_STRING (filename
);
368 if (EQ (operation
, Vinhibit_file_name_operation
))
369 inhibited_handlers
= Vinhibit_file_name_handlers
;
371 inhibited_handlers
= Qnil
;
373 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
374 chain
= XCDR (chain
))
380 Lisp_Object string
= XCAR (elt
);
382 Lisp_Object handler
= XCDR (elt
);
383 Lisp_Object operations
= Qnil
;
385 if (SYMBOLP (handler
))
386 operations
= Fget (handler
, Qoperations
);
389 && (match_pos
= fast_string_match (string
, filename
)) > pos
390 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
394 handler
= XCDR (elt
);
395 tem
= Fmemq (handler
, inhibited_handlers
);
409 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
411 doc
: /* Return the directory component in file name FILENAME.
412 Return nil if FILENAME does not include a directory.
413 Otherwise return a directory name.
414 Given a Unix syntax file name, returns a string ending in slash. */)
416 Lisp_Object filename
;
419 register const unsigned char *beg
;
421 register unsigned char *beg
;
423 register const unsigned char *p
;
426 CHECK_STRING (filename
);
428 /* If the file name has special constructs in it,
429 call the corresponding file handler. */
430 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
432 return call2 (handler
, Qfile_name_directory
, filename
);
434 filename
= FILE_SYSTEM_CASE (filename
);
436 beg
= (unsigned char *) alloca (SBYTES (filename
) + 1);
437 bcopy (SDATA (filename
), beg
, SBYTES (filename
) + 1);
439 beg
= SDATA (filename
);
441 p
= beg
+ SBYTES (filename
);
443 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
445 /* only recognise drive specifier at the beginning */
447 /* handle the "/:d:foo" and "/:foo" cases correctly */
448 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
449 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
456 /* Expansion of "c:" to drive and default directory. */
459 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
460 unsigned char *res
= alloca (MAXPATHLEN
+ 1);
461 unsigned char *r
= res
;
463 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
465 strncpy (res
, beg
, 2);
470 if (getdefdir (toupper (*beg
) - 'A' + 1, r
))
472 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
475 p
= beg
+ strlen (beg
);
478 CORRECT_DIR_SEPS (beg
);
481 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
484 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
485 Sfile_name_nondirectory
, 1, 1, 0,
486 doc
: /* Return file name FILENAME sans its directory.
487 For example, in a Unix-syntax file name,
488 this is everything after the last slash,
489 or the entire name if it contains no slash. */)
491 Lisp_Object filename
;
493 register const unsigned char *beg
, *p
, *end
;
496 CHECK_STRING (filename
);
498 /* If the file name has special constructs in it,
499 call the corresponding file handler. */
500 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
502 return call2 (handler
, Qfile_name_nondirectory
, filename
);
504 beg
= SDATA (filename
);
505 end
= p
= beg
+ SBYTES (filename
);
507 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
509 /* only recognise drive specifier at beginning */
511 /* handle the "/:d:foo" case correctly */
512 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
517 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
520 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
521 Sunhandled_file_name_directory
, 1, 1, 0,
522 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
523 A `directly usable' directory name is one that may be used without the
524 intervention of any file handler.
525 If FILENAME is a directly usable file itself, return
526 \(file-name-directory FILENAME).
527 If FILENAME refers to a file which is not accessible from a local process,
528 then this should return nil.
529 The `call-process' and `start-process' functions use this function to
530 get a current directory to run processes in. */)
532 Lisp_Object filename
;
536 /* If the file name has special constructs in it,
537 call the corresponding file handler. */
538 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
540 return call2 (handler
, Qunhandled_file_name_directory
, filename
);
542 return Ffile_name_directory (filename
);
547 file_name_as_directory (out
, in
)
550 int size
= strlen (in
) - 1;
562 /* For Unix syntax, Append a slash if necessary */
563 if (!IS_DIRECTORY_SEP (out
[size
]))
565 /* Cannot use DIRECTORY_SEP, which could have any value */
567 out
[size
+ 2] = '\0';
570 CORRECT_DIR_SEPS (out
);
575 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
576 Sfile_name_as_directory
, 1, 1, 0,
577 doc
: /* Return a string representing the file name FILE interpreted as a directory.
578 This operation exists because a directory is also a file, but its name as
579 a directory is different from its name as a file.
580 The result can be used as the value of `default-directory'
581 or passed as second argument to `expand-file-name'.
582 For a Unix-syntax file name, just appends a slash. */)
593 /* If the file name has special constructs in it,
594 call the corresponding file handler. */
595 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
597 return call2 (handler
, Qfile_name_as_directory
, file
);
599 buf
= (char *) alloca (SBYTES (file
) + 10);
600 file_name_as_directory (buf
, SDATA (file
));
601 return make_specified_string (buf
, -1, strlen (buf
),
602 STRING_MULTIBYTE (file
));
606 * Convert from directory name to filename.
607 * On UNIX, it's simple: just make sure there isn't a terminating /
609 * Value is nonzero if the string output is different from the input.
613 directory_file_name (src
, dst
)
620 /* Process as Unix format: just remove any final slash.
621 But leave "/" unchanged; do not change it to "". */
624 && IS_DIRECTORY_SEP (dst
[slen
- 1])
626 && !IS_ANY_SEP (dst
[slen
- 2])
631 CORRECT_DIR_SEPS (dst
);
636 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
638 doc
: /* Returns the file name of the directory named DIRECTORY.
639 This is the name of the file that holds the data for the directory DIRECTORY.
640 This operation exists because a directory is also a file, but its name as
641 a directory is different from its name as a file.
642 In Unix-syntax, this function just removes the final slash. */)
644 Lisp_Object directory
;
649 CHECK_STRING (directory
);
651 if (NILP (directory
))
654 /* If the file name has special constructs in it,
655 call the corresponding file handler. */
656 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
658 return call2 (handler
, Qdirectory_file_name
, directory
);
660 buf
= (char *) alloca (SBYTES (directory
) + 20);
661 directory_file_name (SDATA (directory
), buf
);
662 return make_specified_string (buf
, -1, strlen (buf
),
663 STRING_MULTIBYTE (directory
));
666 static const char make_temp_name_tbl
[64] =
668 'A','B','C','D','E','F','G','H',
669 'I','J','K','L','M','N','O','P',
670 'Q','R','S','T','U','V','W','X',
671 'Y','Z','a','b','c','d','e','f',
672 'g','h','i','j','k','l','m','n',
673 'o','p','q','r','s','t','u','v',
674 'w','x','y','z','0','1','2','3',
675 '4','5','6','7','8','9','-','_'
678 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
680 /* Value is a temporary file name starting with PREFIX, a string.
682 The Emacs process number forms part of the result, so there is
683 no danger of generating a name being used by another process.
684 In addition, this function makes an attempt to choose a name
685 which has no existing file. To make this work, PREFIX should be
686 an absolute file name.
688 BASE64_P non-zero means add the pid as 3 characters in base64
689 encoding. In this case, 6 characters will be added to PREFIX to
690 form the file name. Otherwise, if Emacs is running on a system
691 with long file names, add the pid as a decimal number.
693 This function signals an error if no unique file name could be
697 make_temp_name (prefix
, base64_p
)
704 unsigned char *p
, *data
;
708 CHECK_STRING (prefix
);
710 /* VAL is created by adding 6 characters to PREFIX. The first
711 three are the PID of this process, in base 64, and the second
712 three are incremented if the file already exists. This ensures
713 262144 unique file names per PID per PREFIX. */
715 pid
= (int) getpid ();
719 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
720 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
721 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
726 #ifdef HAVE_LONG_FILE_NAMES
727 sprintf (pidbuf
, "%d", pid
);
728 pidlen
= strlen (pidbuf
);
730 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
731 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
732 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
737 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
738 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
739 if (!STRING_MULTIBYTE (prefix
))
740 STRING_SET_UNIBYTE (val
);
742 bcopy(SDATA (prefix
), data
, len
);
745 bcopy (pidbuf
, p
, pidlen
);
748 /* Here we try to minimize useless stat'ing when this function is
749 invoked many times successively with the same PREFIX. We achieve
750 this by initializing count to a random value, and incrementing it
753 We don't want make-temp-name to be called while dumping,
754 because then make_temp_name_count_initialized_p would get set
755 and then make_temp_name_count would not be set when Emacs starts. */
757 if (!make_temp_name_count_initialized_p
)
759 make_temp_name_count
= (unsigned) time (NULL
);
760 make_temp_name_count_initialized_p
= 1;
766 unsigned num
= make_temp_name_count
;
768 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
769 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
770 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
772 /* Poor man's congruential RN generator. Replace with
773 ++make_temp_name_count for debugging. */
774 make_temp_name_count
+= 25229;
775 make_temp_name_count
%= 225307;
777 if (stat (data
, &ignored
) < 0)
779 /* We want to return only if errno is ENOENT. */
783 /* The error here is dubious, but there is little else we
784 can do. The alternatives are to return nil, which is
785 as bad as (and in many cases worse than) throwing the
786 error, or to ignore the error, which will likely result
787 in looping through 225307 stat's, which is not only
788 dog-slow, but also useless since it will fallback to
789 the errow below, anyway. */
790 report_file_error ("Cannot create temporary name for prefix",
791 Fcons (prefix
, Qnil
));
796 error ("Cannot create temporary name for prefix `%s'",
802 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
803 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
804 The Emacs process number forms part of the result,
805 so there is no danger of generating a name being used by another process.
807 In addition, this function makes an attempt to choose a name
808 which has no existing file. To make this work,
809 PREFIX should be an absolute file name.
811 There is a race condition between calling `make-temp-name' and creating the
812 file which opens all kinds of security holes. For that reason, you should
813 probably use `make-temp-file' instead, except in three circumstances:
815 * If you are creating the file in the user's home directory.
816 * If you are creating a directory rather than an ordinary file.
817 * If you are taking special precautions as `make-temp-file' does. */)
821 return make_temp_name (prefix
, 0);
826 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
827 doc
: /* Convert filename NAME to absolute, and canonicalize it.
828 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
829 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
830 the current buffer's value of `default-directory' is used.
831 File name components that are `.' are removed, and
832 so are file name components followed by `..', along with the `..' itself;
833 note that these simplifications are done without checking the resulting
834 file names in the file system.
835 An initial `~/' expands to your home directory.
836 An initial `~USER/' expands to USER's home directory.
837 See also the function `substitute-in-file-name'.
839 For technical reasons, this function can return correct but
840 non-intuitive results for the root directory; for instance,
841 \(expand-file-name ".." "/") returns "/..". For this reason, use
842 (directory-file-name (file-name-directory dirname)) to traverse a
843 filesystem tree, not (expand-file-name ".." dirname). */)
844 (name
, default_directory
)
845 Lisp_Object name
, default_directory
;
847 /* These point to SDATA and need to be careful with string-relocation
848 during GC (via DECODE_FILE). */
849 unsigned char *nm
, *newdir
;
850 /* This should only point to alloca'd data. */
851 unsigned char *target
;
857 int collapse_newdir
= 1;
861 Lisp_Object handler
, result
;
867 /* If the file name has special constructs in it,
868 call the corresponding file handler. */
869 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
871 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
873 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
874 if (NILP (default_directory
))
875 default_directory
= current_buffer
->directory
;
876 if (! STRINGP (default_directory
))
879 /* "/" is not considered a root directory on DOS_NT, so using "/"
880 here causes an infinite recursion in, e.g., the following:
882 (let (default-directory)
883 (expand-file-name "a"))
885 To avoid this, we set default_directory to the root of the
887 extern char *emacs_root_dir (void);
889 default_directory
= build_string (emacs_root_dir ());
891 default_directory
= build_string ("/");
895 if (!NILP (default_directory
))
897 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
899 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
903 unsigned char *o
= SDATA (default_directory
);
905 /* Make sure DEFAULT_DIRECTORY is properly expanded.
906 It would be better to do this down below where we actually use
907 default_directory. Unfortunately, calling Fexpand_file_name recursively
908 could invoke GC, and the strings might be relocated. This would
909 be annoying because we have pointers into strings lying around
910 that would need adjusting, and people would add new pointers to
911 the code and forget to adjust them, resulting in intermittent bugs.
912 Putting this call here avoids all that crud.
914 The EQ test avoids infinite recursion. */
915 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
916 /* Save time in some common cases - as long as default_directory
917 is not relative, it can be canonicalized with name below (if it
918 is needed at all) without requiring it to be expanded now. */
920 /* Detect MSDOS file names with drive specifiers. */
921 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
922 && IS_DIRECTORY_SEP (o
[2]))
924 /* Detect Windows file names in UNC format. */
925 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
927 #else /* not DOS_NT */
928 /* Detect Unix absolute file names (/... alone is not absolute on
930 && ! (IS_DIRECTORY_SEP (o
[0]))
931 #endif /* not DOS_NT */
937 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
941 name
= FILE_SYSTEM_CASE (name
);
942 multibyte
= STRING_MULTIBYTE (name
);
943 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
946 default_directory
= string_to_multibyte (default_directory
);
949 name
= string_to_multibyte (name
);
954 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
955 nm
= (unsigned char *) alloca (SBYTES (name
) + 1);
956 bcopy (SDATA (name
), nm
, SBYTES (name
) + 1);
959 /* Note if special escape prefix is present, but remove for now. */
960 if (nm
[0] == '/' && nm
[1] == ':')
966 /* Find and remove drive specifier if present; this makes nm absolute
967 even if the rest of the name appears to be relative. Only look for
968 drive specifier at the beginning. */
969 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
976 /* If we see "c://somedir", we want to strip the first slash after the
977 colon when stripping the drive letter. Otherwise, this expands to
979 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
982 /* Discard any previous drive specifier if nm is now in UNC format. */
983 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
987 #endif /* WINDOWSNT */
990 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
991 none are found, we can probably return right away. We will avoid
992 allocating a new string if name is already fully expanded. */
994 IS_DIRECTORY_SEP (nm
[0])
996 && drive
&& !is_escaped
999 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
1003 /* If it turns out that the filename we want to return is just a
1004 suffix of FILENAME, we don't need to go through and edit
1005 things; we just need to construct a new string using data
1006 starting at the middle of FILENAME. If we set lose to a
1007 non-zero value, that means we've discovered that we can't do
1010 unsigned char *p
= nm
;
1014 /* Since we know the name is absolute, we can assume that each
1015 element starts with a "/". */
1017 /* "." and ".." are hairy. */
1018 if (IS_DIRECTORY_SEP (p
[0])
1020 && (IS_DIRECTORY_SEP (p
[2])
1022 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1025 /* We want to replace multiple `/' in a row with a single
1028 && IS_DIRECTORY_SEP (p
[0])
1029 && IS_DIRECTORY_SEP (p
[1]))
1036 /* Make sure directories are all separated with / or \ as
1037 desired, but avoid allocation of a new string when not
1039 CORRECT_DIR_SEPS (nm
);
1041 if (IS_DIRECTORY_SEP (nm
[1]))
1043 if (strcmp (nm
, SDATA (name
)) != 0)
1044 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1048 /* drive must be set, so this is okay */
1049 if (strcmp (nm
- 2, SDATA (name
)) != 0)
1053 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1054 temp
[0] = DRIVE_LETTER (drive
);
1055 name
= concat2 (build_string (temp
), name
);
1058 #else /* not DOS_NT */
1059 if (strcmp (nm
, SDATA (name
)) == 0)
1061 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1062 #endif /* not DOS_NT */
1066 /* At this point, nm might or might not be an absolute file name. We
1067 need to expand ~ or ~user if present, otherwise prefix nm with
1068 default_directory if nm is not absolute, and finally collapse /./
1069 and /foo/../ sequences.
1071 We set newdir to be the appropriate prefix if one is needed:
1072 - the relevant user directory if nm starts with ~ or ~user
1073 - the specified drive's working dir (DOS/NT only) if nm does not
1075 - the value of default_directory.
1077 Note that these prefixes are not guaranteed to be absolute (except
1078 for the working dir of a drive). Therefore, to ensure we always
1079 return an absolute name, if the final prefix is not absolute we
1080 append it to the current working directory. */
1084 if (nm
[0] == '~') /* prefix ~ */
1086 if (IS_DIRECTORY_SEP (nm
[1])
1087 || nm
[1] == 0) /* ~ by itself */
1091 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1092 newdir
= (unsigned char *) "";
1094 /* egetenv may return a unibyte string, which will bite us since
1095 we expect the directory to be multibyte. */
1096 tem
= build_string (newdir
);
1097 if (!STRING_MULTIBYTE (tem
))
1099 hdir
= DECODE_FILE (tem
);
1100 newdir
= SDATA (hdir
);
1103 collapse_newdir
= 0;
1106 else /* ~user/filename */
1108 unsigned char *o
, *p
;
1109 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1110 o
= alloca (p
- nm
+ 1);
1111 bcopy ((char *) nm
, o
, p
- nm
);
1115 pw
= (struct passwd
*) getpwnam (o
+ 1);
1119 newdir
= (unsigned char *) pw
-> pw_dir
;
1122 collapse_newdir
= 0;
1126 /* If we don't find a user of that name, leave the name
1127 unchanged; don't move nm forward to p. */
1132 /* On DOS and Windows, nm is absolute if a drive name was specified;
1133 use the drive's current directory as the prefix if needed. */
1134 if (!newdir
&& drive
)
1136 /* Get default directory if needed to make nm absolute. */
1137 if (!IS_DIRECTORY_SEP (nm
[0]))
1139 newdir
= alloca (MAXPATHLEN
+ 1);
1140 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1145 /* Either nm starts with /, or drive isn't mounted. */
1146 newdir
= alloca (4);
1147 newdir
[0] = DRIVE_LETTER (drive
);
1155 /* Finally, if no prefix has been specified and nm is not absolute,
1156 then it must be expanded relative to default_directory. */
1160 /* /... alone is not absolute on DOS and Windows. */
1161 && !IS_DIRECTORY_SEP (nm
[0])
1164 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1168 newdir
= SDATA (default_directory
);
1170 /* Note if special escape prefix is present, but remove for now. */
1171 if (newdir
[0] == '/' && newdir
[1] == ':')
1182 /* First ensure newdir is an absolute name. */
1184 /* Detect MSDOS file names with drive specifiers. */
1185 ! (IS_DRIVE (newdir
[0])
1186 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1188 /* Detect Windows file names in UNC format. */
1189 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1193 /* Effectively, let newdir be (expand-file-name newdir cwd).
1194 Because of the admonition against calling expand-file-name
1195 when we have pointers into lisp strings, we accomplish this
1196 indirectly by prepending newdir to nm if necessary, and using
1197 cwd (or the wd of newdir's drive) as the new newdir. */
1199 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1204 if (!IS_DIRECTORY_SEP (nm
[0]))
1206 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1207 file_name_as_directory (tmp
, newdir
);
1211 newdir
= alloca (MAXPATHLEN
+ 1);
1214 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1221 /* Strip off drive name from prefix, if present. */
1222 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1228 /* Keep only a prefix from newdir if nm starts with slash
1229 (//server/share for UNC, nothing otherwise). */
1230 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1233 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1236 newdir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1238 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1240 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1252 /* Get rid of any slash at the end of newdir, unless newdir is
1253 just / or // (an incomplete UNC name). */
1254 length
= strlen (newdir
);
1255 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1257 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1261 unsigned char *temp
= (unsigned char *) alloca (length
);
1262 bcopy (newdir
, temp
, length
- 1);
1263 temp
[length
- 1] = 0;
1271 /* Now concatenate the directory and name to new space in the stack frame */
1272 tlen
+= strlen (nm
) + 1;
1274 /* Reserve space for drive specifier and escape prefix, since either
1275 or both may need to be inserted. (The Microsoft x86 compiler
1276 produces incorrect code if the following two lines are combined.) */
1277 target
= (unsigned char *) alloca (tlen
+ 4);
1279 #else /* not DOS_NT */
1280 target
= (unsigned char *) alloca (tlen
);
1281 #endif /* not DOS_NT */
1286 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1289 /* If newdir is effectively "C:/", then the drive letter will have
1290 been stripped and newdir will be "/". Concatenating with an
1291 absolute directory in nm produces "//", which will then be
1292 incorrectly treated as a network share. Ignore newdir in
1293 this case (keeping the drive letter). */
1294 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1295 && newdir
[1] == '\0'))
1297 strcpy (target
, newdir
);
1300 file_name_as_directory (target
, newdir
);
1303 strcat (target
, nm
);
1305 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1308 unsigned char *p
= target
;
1309 unsigned char *o
= target
;
1313 if (!IS_DIRECTORY_SEP (*p
))
1317 else if (p
[1] == '.'
1318 && (IS_DIRECTORY_SEP (p
[2])
1321 /* If "/." is the entire filename, keep the "/". Otherwise,
1322 just delete the whole "/.". */
1323 if (o
== target
&& p
[2] == '\0')
1327 else if (p
[1] == '.' && p
[2] == '.'
1328 /* `/../' is the "superroot" on certain file systems.
1329 Turned off on DOS_NT systems because they have no
1330 "superroot" and because this causes us to produce
1331 file names like "d:/../foo" which fail file-related
1332 functions of the underlying OS. (To reproduce, try a
1333 long series of "../../" in default_directory, longer
1334 than the number of levels from the root.) */
1338 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1341 unsigned char *prev_o
= o
;
1343 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1346 /* Don't go below server level in UNC filenames. */
1347 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1348 && IS_DIRECTORY_SEP (*target
))
1352 /* Keep initial / only if this is the whole name. */
1353 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1357 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1358 /* Collapse multiple `/' in a row. */
1367 /* At last, set drive name. */
1369 /* Except for network file name. */
1370 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1371 #endif /* WINDOWSNT */
1373 if (!drive
) abort ();
1375 target
[0] = DRIVE_LETTER (drive
);
1378 /* Reinsert the escape prefix if required. */
1385 CORRECT_DIR_SEPS (target
);
1388 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1391 /* Again look to see if the file name has special constructs in it
1392 and perhaps call the corresponding file handler. This is needed
1393 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1394 the ".." component gives us "/user@host:/bar/../baz" which needs
1395 to be expanded again. */
1396 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1397 if (!NILP (handler
))
1398 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1404 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1405 This is the old version of expand-file-name, before it was thoroughly
1406 rewritten for Emacs 10.31. We leave this version here commented-out,
1407 because the code is very complex and likely to have subtle bugs. If
1408 bugs _are_ found, it might be of interest to look at the old code and
1409 see what did it do in the relevant situation.
1411 Don't remove this code: it's true that it will be accessible via CVS,
1412 but a few years from deletion, people will forget it is there. */
1414 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1415 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1416 "Convert FILENAME to absolute, and canonicalize it.\n\
1417 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1418 \(does not start with slash); if DEFAULT is nil or missing,\n\
1419 the current buffer's value of default-directory is used.\n\
1420 Filenames containing `.' or `..' as components are simplified;\n\
1421 initial `~/' expands to your home directory.\n\
1422 See also the function `substitute-in-file-name'.")
1424 Lisp_Object name
, defalt
;
1428 register unsigned char *newdir
, *p
, *o
;
1430 unsigned char *target
;
1434 CHECK_STRING (name
);
1437 /* If nm is absolute, flush ...// and detect /./ and /../.
1438 If no /./ or /../ we can return right away. */
1445 if (p
[0] == '/' && p
[1] == '/'
1448 if (p
[0] == '/' && p
[1] == '~')
1449 nm
= p
+ 1, lose
= 1;
1450 if (p
[0] == '/' && p
[1] == '.'
1451 && (p
[2] == '/' || p
[2] == 0
1452 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1458 if (nm
== SDATA (name
))
1460 return build_string (nm
);
1464 /* Now determine directory to start with and put it in NEWDIR */
1468 if (nm
[0] == '~') /* prefix ~ */
1469 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1471 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1472 newdir
= (unsigned char *) "";
1475 else /* ~user/filename */
1477 /* Get past ~ to user */
1478 unsigned char *user
= nm
+ 1;
1479 /* Find end of name. */
1480 unsigned char *ptr
= (unsigned char *) index (user
, '/');
1481 int len
= ptr
? ptr
- user
: strlen (user
);
1482 /* Copy the user name into temp storage. */
1483 o
= (unsigned char *) alloca (len
+ 1);
1484 bcopy ((char *) user
, o
, len
);
1487 /* Look up the user name. */
1489 pw
= (struct passwd
*) getpwnam (o
+ 1);
1492 error ("\"%s\" isn't a registered user", o
+ 1);
1494 newdir
= (unsigned char *) pw
->pw_dir
;
1496 /* Discard the user name from NM. */
1500 if (nm
[0] != '/' && !newdir
)
1503 defalt
= current_buffer
->directory
;
1504 CHECK_STRING (defalt
);
1505 newdir
= SDATA (defalt
);
1508 /* Now concatenate the directory and name to new space in the stack frame */
1510 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1511 target
= (unsigned char *) alloca (tlen
);
1516 if (nm
[0] == 0 || nm
[0] == '/')
1517 strcpy (target
, newdir
);
1519 file_name_as_directory (target
, newdir
);
1522 strcat (target
, nm
);
1524 /* Now canonicalize by removing /. and /foo/.. if they appear */
1535 else if (!strncmp (p
, "//", 2)
1541 else if (p
[0] == '/' && p
[1] == '.'
1542 && (p
[2] == '/' || p
[2] == 0))
1544 else if (!strncmp (p
, "/..", 3)
1545 /* `/../' is the "superroot" on certain file systems. */
1547 && (p
[3] == '/' || p
[3] == 0))
1549 while (o
!= target
&& *--o
!= '/')
1551 if (o
== target
&& *o
== '/')
1561 return make_string (target
, o
- target
);
1565 /* If /~ or // appears, discard everything through first slash. */
1567 file_name_absolute_p (filename
)
1568 const unsigned char *filename
;
1571 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1573 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1574 && IS_DIRECTORY_SEP (filename
[2]))
1579 static unsigned char *
1580 search_embedded_absfilename (nm
, endp
)
1581 unsigned char *nm
, *endp
;
1583 unsigned char *p
, *s
;
1585 for (p
= nm
+ 1; p
< endp
; p
++)
1588 || IS_DIRECTORY_SEP (p
[-1]))
1589 && file_name_absolute_p (p
)
1590 #if defined (WINDOWSNT) || defined(CYGWIN)
1591 /* // at start of file name is meaningful in Apollo,
1592 WindowsNT and Cygwin systems. */
1593 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1594 #endif /* not (WINDOWSNT || CYGWIN) */
1597 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1598 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
1600 unsigned char *o
= alloca (s
- p
+ 1);
1602 bcopy (p
, o
, s
- p
);
1605 /* If we have ~user and `user' exists, discard
1606 everything up to ~. But if `user' does not exist, leave
1607 ~user alone, it might be a literal file name. */
1609 pw
= getpwnam (o
+ 1);
1621 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1622 Ssubstitute_in_file_name
, 1, 1, 0,
1623 doc
: /* Substitute environment variables referred to in FILENAME.
1624 `$FOO' where FOO is an environment variable name means to substitute
1625 the value of that variable. The variable name should be terminated
1626 with a character not a letter, digit or underscore; otherwise, enclose
1627 the entire variable name in braces.
1629 If `/~' appears, all of FILENAME through that `/' is discarded.
1630 If `//' appears, everything up to and including the first of
1631 those `/' is discarded. */)
1633 Lisp_Object filename
;
1637 register unsigned char *s
, *p
, *o
, *x
, *endp
;
1638 unsigned char *target
= NULL
;
1640 int substituted
= 0;
1643 Lisp_Object handler
;
1645 CHECK_STRING (filename
);
1647 multibyte
= STRING_MULTIBYTE (filename
);
1649 /* If the file name has special constructs in it,
1650 call the corresponding file handler. */
1651 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1652 if (!NILP (handler
))
1653 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
1655 /* Always work on a copy of the string, in case GC happens during
1656 decode of environment variables, causing the original Lisp_String
1657 data to be relocated. */
1658 nm
= (unsigned char *) alloca (SBYTES (filename
) + 1);
1659 bcopy (SDATA (filename
), nm
, SBYTES (filename
) + 1);
1662 CORRECT_DIR_SEPS (nm
);
1663 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1665 endp
= nm
+ SBYTES (filename
);
1667 /* If /~ or // appears, discard everything through first slash. */
1668 p
= search_embedded_absfilename (nm
, endp
);
1670 /* Start over with the new string, so we check the file-name-handler
1671 again. Important with filenames like "/home/foo//:/hello///there"
1672 which whould substitute to "/:/hello///there" rather than "/there". */
1673 return Fsubstitute_in_file_name
1674 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1676 /* See if any variables are substituted into the string
1677 and find the total length of their values in `total' */
1679 for (p
= nm
; p
!= endp
;)
1689 /* "$$" means a single "$" */
1698 while (p
!= endp
&& *p
!= '}') p
++;
1699 if (*p
!= '}') goto missingclose
;
1705 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1709 /* Copy out the variable name */
1710 target
= (unsigned char *) alloca (s
- o
+ 1);
1711 strncpy (target
, o
, s
- o
);
1714 strupr (target
); /* $home == $HOME etc. */
1717 /* Get variable value */
1718 o
= (unsigned char *) egetenv (target
);
1721 /* Don't try to guess a maximum length - UTF8 can use up to
1722 four bytes per character. This code is unlikely to run
1723 in a situation that requires performance, so decoding the
1724 env variables twice should be acceptable. Note that
1725 decoding may cause a garbage collect. */
1726 Lisp_Object orig
, decoded
;
1727 orig
= make_unibyte_string (o
, strlen (o
));
1728 decoded
= DECODE_FILE (orig
);
1729 total
+= SBYTES (decoded
);
1739 /* If substitution required, recopy the string and do it */
1740 /* Make space in stack frame for the new copy */
1741 xnm
= (unsigned char *) alloca (SBYTES (filename
) + total
+ 1);
1744 /* Copy the rest of the name through, replacing $ constructs with values */
1761 while (p
!= endp
&& *p
!= '}') p
++;
1762 if (*p
!= '}') goto missingclose
;
1768 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1772 /* Copy out the variable name */
1773 target
= (unsigned char *) alloca (s
- o
+ 1);
1774 strncpy (target
, o
, s
- o
);
1777 strupr (target
); /* $home == $HOME etc. */
1780 /* Get variable value */
1781 o
= (unsigned char *) egetenv (target
);
1785 strcpy (x
, target
); x
+= strlen (target
);
1789 Lisp_Object orig
, decoded
;
1790 int orig_length
, decoded_length
;
1791 orig_length
= strlen (o
);
1792 orig
= make_unibyte_string (o
, orig_length
);
1793 decoded
= DECODE_FILE (orig
);
1794 decoded_length
= SBYTES (decoded
);
1795 strncpy (x
, SDATA (decoded
), decoded_length
);
1796 x
+= decoded_length
;
1798 /* If environment variable needed decoding, return value
1799 needs to be multibyte. */
1800 if (decoded_length
!= orig_length
1801 || strncmp (SDATA (decoded
), o
, orig_length
))
1808 /* If /~ or // appears, discard everything through first slash. */
1809 while ((p
= search_embedded_absfilename (xnm
, x
)))
1810 /* This time we do not start over because we've already expanded envvars
1811 and replaced $$ with $. Maybe we should start over as well, but we'd
1812 need to quote some $ to $$ first. */
1815 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1818 error ("Bad format environment-variable substitution");
1820 error ("Missing \"}\" in environment-variable substitution");
1822 error ("Substituting nonexistent environment variable \"%s\"", target
);
1828 /* A slightly faster and more convenient way to get
1829 (directory-file-name (expand-file-name FOO)). */
1832 expand_and_dir_to_file (filename
, defdir
)
1833 Lisp_Object filename
, defdir
;
1835 register Lisp_Object absname
;
1837 absname
= Fexpand_file_name (filename
, defdir
);
1839 /* Remove final slash, if any (unless this is the root dir).
1840 stat behaves differently depending! */
1841 if (SCHARS (absname
) > 1
1842 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1843 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
1844 /* We cannot take shortcuts; they might be wrong for magic file names. */
1845 absname
= Fdirectory_file_name (absname
);
1849 /* Signal an error if the file ABSNAME already exists.
1850 If INTERACTIVE is nonzero, ask the user whether to proceed,
1851 and bypass the error if the user says to go ahead.
1852 QUERYSTRING is a name for the action that is being considered
1855 *STATPTR is used to store the stat information if the file exists.
1856 If the file does not exist, STATPTR->st_mode is set to 0.
1857 If STATPTR is null, we don't store into it.
1859 If QUICK is nonzero, we ask for y or n, not yes or no. */
1862 barf_or_query_if_file_exists (absname
, querystring
, interactive
, statptr
, quick
)
1863 Lisp_Object absname
;
1864 unsigned char *querystring
;
1866 struct stat
*statptr
;
1869 register Lisp_Object tem
, encoded_filename
;
1870 struct stat statbuf
;
1871 struct gcpro gcpro1
;
1873 encoded_filename
= ENCODE_FILE (absname
);
1875 /* stat is a good way to tell whether the file exists,
1876 regardless of what access permissions it has. */
1877 if (lstat (SDATA (encoded_filename
), &statbuf
) >= 0)
1880 xsignal2 (Qfile_already_exists
,
1881 build_string ("File already exists"), absname
);
1883 tem
= format2 ("File %s already exists; %s anyway? ",
1884 absname
, build_string (querystring
));
1886 tem
= Fy_or_n_p (tem
);
1888 tem
= do_yes_or_no_p (tem
);
1891 xsignal2 (Qfile_already_exists
,
1892 build_string ("File already exists"), absname
);
1899 statptr
->st_mode
= 0;
1904 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 5,
1905 "fCopy file: \nGCopy %s to file: \np\nP",
1906 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1907 If NEWNAME names a directory, copy FILE there.
1909 This function always sets the file modes of the output file to match
1912 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1913 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1914 signal a `file-already-exists' error without overwriting. If
1915 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1916 about overwriting; this is what happens in interactive use with M-x.
1917 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1920 Fourth arg KEEP-TIME non-nil means give the output file the same
1921 last-modified time as the old one. (This works on only some systems.)
1923 A prefix arg makes KEEP-TIME non-nil.
1925 If PRESERVE-UID-GID is non-nil, we try to transfer the
1926 uid and gid of FILE to NEWNAME. */)
1927 (file
, newname
, ok_if_already_exists
, keep_time
, preserve_uid_gid
)
1928 Lisp_Object file
, newname
, ok_if_already_exists
, keep_time
;
1929 Lisp_Object preserve_uid_gid
;
1932 char buf
[16 * 1024];
1933 struct stat st
, out_st
;
1934 Lisp_Object handler
;
1935 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1936 int count
= SPECPDL_INDEX ();
1937 int input_file_statable_p
;
1938 Lisp_Object encoded_file
, encoded_newname
;
1940 encoded_file
= encoded_newname
= Qnil
;
1941 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1942 CHECK_STRING (file
);
1943 CHECK_STRING (newname
);
1945 if (!NILP (Ffile_directory_p (newname
)))
1946 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1948 newname
= Fexpand_file_name (newname
, Qnil
);
1950 file
= Fexpand_file_name (file
, Qnil
);
1952 /* If the input file name has special constructs in it,
1953 call the corresponding file handler. */
1954 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1955 /* Likewise for output file name. */
1957 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1958 if (!NILP (handler
))
1959 RETURN_UNGCPRO (call6 (handler
, Qcopy_file
, file
, newname
,
1960 ok_if_already_exists
, keep_time
, preserve_uid_gid
));
1962 encoded_file
= ENCODE_FILE (file
);
1963 encoded_newname
= ENCODE_FILE (newname
);
1965 if (NILP (ok_if_already_exists
)
1966 || INTEGERP (ok_if_already_exists
))
1967 barf_or_query_if_file_exists (newname
, "copy to it",
1968 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1969 else if (stat (SDATA (encoded_newname
), &out_st
) < 0)
1973 if (!CopyFile (SDATA (encoded_file
),
1974 SDATA (encoded_newname
),
1976 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1977 /* CopyFile retains the timestamp by default. */
1978 else if (NILP (keep_time
))
1984 EMACS_GET_TIME (now
);
1985 filename
= SDATA (encoded_newname
);
1987 /* Ensure file is writable while its modified time is set. */
1988 attributes
= GetFileAttributes (filename
);
1989 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1990 if (set_file_times (filename
, now
, now
))
1992 /* Restore original attributes. */
1993 SetFileAttributes (filename
, attributes
);
1994 xsignal2 (Qfile_date_error
,
1995 build_string ("Cannot set file date"), newname
);
1997 /* Restore original attributes. */
1998 SetFileAttributes (filename
, attributes
);
2000 #else /* not WINDOWSNT */
2002 ifd
= emacs_open (SDATA (encoded_file
), O_RDONLY
, 0);
2006 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2008 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2010 /* We can only copy regular files and symbolic links. Other files are not
2012 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
2014 #if !defined (MSDOS) || __DJGPP__ > 1
2015 if (out_st
.st_mode
!= 0
2016 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2019 report_file_error ("Input and output files are the same",
2020 Fcons (file
, Fcons (newname
, Qnil
)));
2024 #if defined (S_ISREG) && defined (S_ISLNK)
2025 if (input_file_statable_p
)
2027 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
2029 #if defined (EISDIR)
2030 /* Get a better looking error message. */
2033 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2036 #endif /* S_ISREG && S_ISLNK */
2039 /* System's default file type was set to binary by _fmode in emacs.c. */
2040 ofd
= emacs_open (SDATA (encoded_newname
),
2041 O_WRONLY
| O_TRUNC
| O_CREAT
2042 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2043 S_IREAD
| S_IWRITE
);
2044 #else /* not MSDOS */
2045 ofd
= emacs_open (SDATA (encoded_newname
),
2046 O_WRONLY
| O_TRUNC
| O_CREAT
2047 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2049 #endif /* not MSDOS */
2051 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2053 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2057 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2058 if (emacs_write (ofd
, buf
, n
) != n
)
2059 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2063 /* Preserve the original file modes, and if requested, also its
2065 if (input_file_statable_p
)
2067 if (! NILP (preserve_uid_gid
))
2068 fchown (ofd
, st
.st_uid
, st
.st_gid
);
2069 fchmod (ofd
, st
.st_mode
& 07777);
2071 #endif /* not MSDOS */
2073 /* Closing the output clobbers the file times on some systems. */
2074 if (emacs_close (ofd
) < 0)
2075 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2077 if (input_file_statable_p
)
2079 if (!NILP (keep_time
))
2081 EMACS_TIME atime
, mtime
;
2082 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
2083 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
2084 if (set_file_times (SDATA (encoded_newname
),
2086 xsignal2 (Qfile_date_error
,
2087 build_string ("Cannot set file date"), newname
);
2093 #if defined (__DJGPP__) && __DJGPP__ > 1
2094 if (input_file_statable_p
)
2096 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2097 and if it can't, it tells so. Otherwise, under MSDOS we usually
2098 get only the READ bit, which will make the copied file read-only,
2099 so it's better not to chmod at all. */
2100 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2101 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2103 #endif /* DJGPP version 2 or newer */
2104 #endif /* not WINDOWSNT */
2106 /* Discard the unwind protects. */
2107 specpdl_ptr
= specpdl
+ count
;
2113 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2114 Smake_directory_internal
, 1, 1, 0,
2115 doc
: /* Create a new directory named DIRECTORY. */)
2117 Lisp_Object directory
;
2119 const unsigned char *dir
;
2120 Lisp_Object handler
;
2121 Lisp_Object encoded_dir
;
2123 CHECK_STRING (directory
);
2124 directory
= Fexpand_file_name (directory
, Qnil
);
2126 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2127 if (!NILP (handler
))
2128 return call2 (handler
, Qmake_directory_internal
, directory
);
2130 encoded_dir
= ENCODE_FILE (directory
);
2132 dir
= SDATA (encoded_dir
);
2135 if (mkdir (dir
) != 0)
2137 if (mkdir (dir
, 0777) != 0)
2139 report_file_error ("Creating directory", list1 (directory
));
2144 DEFUN ("delete-directory-internal", Fdelete_directory_internal
,
2145 Sdelete_directory_internal
, 1, 1, 0,
2146 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2148 Lisp_Object directory
;
2150 const unsigned char *dir
;
2151 Lisp_Object handler
;
2152 Lisp_Object encoded_dir
;
2154 CHECK_STRING (directory
);
2155 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2157 if (delete_by_moving_to_trash
)
2158 return call1 (Qmove_file_to_trash
, directory
);
2160 encoded_dir
= ENCODE_FILE (directory
);
2162 dir
= SDATA (encoded_dir
);
2164 if (rmdir (dir
) != 0)
2165 report_file_error ("Removing directory", list1 (directory
));
2170 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 1, "fDelete file: ",
2171 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2172 If file has multiple names, it continues to exist with the other names. */)
2174 Lisp_Object filename
;
2176 Lisp_Object handler
;
2177 Lisp_Object encoded_file
;
2178 struct gcpro gcpro1
;
2181 if (!NILP (Ffile_directory_p (filename
))
2182 && NILP (Ffile_symlink_p (filename
)))
2183 xsignal2 (Qfile_error
,
2184 build_string ("Removing old name: is a directory"),
2187 filename
= Fexpand_file_name (filename
, Qnil
);
2189 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2190 if (!NILP (handler
))
2191 return call2 (handler
, Qdelete_file
, filename
);
2193 if (delete_by_moving_to_trash
)
2194 return call1 (Qmove_file_to_trash
, filename
);
2196 encoded_file
= ENCODE_FILE (filename
);
2198 if (0 > unlink (SDATA (encoded_file
)))
2199 report_file_error ("Removing old name", list1 (filename
));
2204 internal_delete_file_1 (ignore
)
2210 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2213 internal_delete_file (filename
)
2214 Lisp_Object filename
;
2217 tem
= internal_condition_case_1 (Fdelete_file
, filename
,
2218 Qt
, internal_delete_file_1
);
2222 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2223 "fRename file: \nGRename %s to file: \np",
2224 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2225 If file has names other than FILE, it continues to have those names.
2226 Signals a `file-already-exists' error if a file NEWNAME already exists
2227 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2228 A number as third arg means request confirmation if NEWNAME already exists.
2229 This is what happens in interactive use with M-x. */)
2230 (file
, newname
, ok_if_already_exists
)
2231 Lisp_Object file
, newname
, ok_if_already_exists
;
2233 Lisp_Object handler
;
2234 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2235 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2237 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2238 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2239 CHECK_STRING (file
);
2240 CHECK_STRING (newname
);
2241 file
= Fexpand_file_name (file
, Qnil
);
2243 if ((!NILP (Ffile_directory_p (newname
)))
2245 /* If the file names are identical but for the case,
2246 don't attempt to move directory to itself. */
2247 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2251 Lisp_Object fname
= NILP (Ffile_directory_p (file
))
2252 ? file
: Fdirectory_file_name (file
);
2253 newname
= Fexpand_file_name (Ffile_name_nondirectory (fname
), newname
);
2256 newname
= Fexpand_file_name (newname
, Qnil
);
2258 /* If the file name has special constructs in it,
2259 call the corresponding file handler. */
2260 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2262 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2263 if (!NILP (handler
))
2264 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2265 file
, newname
, ok_if_already_exists
));
2267 encoded_file
= ENCODE_FILE (file
);
2268 encoded_newname
= ENCODE_FILE (newname
);
2271 /* If the file names are identical but for the case, don't ask for
2272 confirmation: they simply want to change the letter-case of the
2274 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2276 if (NILP (ok_if_already_exists
)
2277 || INTEGERP (ok_if_already_exists
))
2278 barf_or_query_if_file_exists (newname
, "rename to it",
2279 INTEGERP (ok_if_already_exists
), 0, 0);
2280 if (0 > rename (SDATA (encoded_file
), SDATA (encoded_newname
)))
2286 symlink_target
= Ffile_symlink_p (file
);
2287 if (! NILP (symlink_target
))
2288 Fmake_symbolic_link (symlink_target
, newname
,
2289 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2292 if (!NILP (Ffile_directory_p (file
)))
2293 call4 (Qcopy_directory
, file
, newname
, Qt
, Qnil
);
2295 /* We have already prompted if it was an integer, so don't
2296 have copy-file prompt again. */
2297 Fcopy_file (file
, newname
,
2298 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2301 count
= SPECPDL_INDEX ();
2302 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2304 if (!NILP (Ffile_directory_p (file
))
2306 && NILP (symlink_target
)
2309 call2 (Qdelete_directory
, file
, Qt
);
2311 Fdelete_file (file
);
2312 unbind_to (count
, Qnil
);
2315 report_file_error ("Renaming", list2 (file
, newname
));
2321 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2322 "fAdd name to file: \nGName to add to %s: \np",
2323 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2324 Signals a `file-already-exists' error if a file NEWNAME already exists
2325 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2326 A number as third arg means request confirmation if NEWNAME already exists.
2327 This is what happens in interactive use with M-x. */)
2328 (file
, newname
, ok_if_already_exists
)
2329 Lisp_Object file
, newname
, ok_if_already_exists
;
2331 Lisp_Object handler
;
2332 Lisp_Object encoded_file
, encoded_newname
;
2333 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2335 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2336 encoded_file
= encoded_newname
= Qnil
;
2337 CHECK_STRING (file
);
2338 CHECK_STRING (newname
);
2339 file
= Fexpand_file_name (file
, Qnil
);
2341 if (!NILP (Ffile_directory_p (newname
)))
2342 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2344 newname
= Fexpand_file_name (newname
, Qnil
);
2346 /* If the file name has special constructs in it,
2347 call the corresponding file handler. */
2348 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2349 if (!NILP (handler
))
2350 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2351 newname
, ok_if_already_exists
));
2353 /* If the new name has special constructs in it,
2354 call the corresponding file handler. */
2355 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2356 if (!NILP (handler
))
2357 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2358 newname
, ok_if_already_exists
));
2360 encoded_file
= ENCODE_FILE (file
);
2361 encoded_newname
= ENCODE_FILE (newname
);
2363 if (NILP (ok_if_already_exists
)
2364 || INTEGERP (ok_if_already_exists
))
2365 barf_or_query_if_file_exists (newname
, "make it a new name",
2366 INTEGERP (ok_if_already_exists
), 0, 0);
2368 unlink (SDATA (newname
));
2369 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
)))
2370 report_file_error ("Adding new name", list2 (file
, newname
));
2376 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2377 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2378 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2379 Both args must be strings.
2380 Signals a `file-already-exists' error if a file LINKNAME already exists
2381 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2382 A number as third arg means request confirmation if LINKNAME already exists.
2383 This happens for interactive use with M-x. */)
2384 (filename
, linkname
, ok_if_already_exists
)
2385 Lisp_Object filename
, linkname
, ok_if_already_exists
;
2387 Lisp_Object handler
;
2388 Lisp_Object encoded_filename
, encoded_linkname
;
2389 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2391 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2392 encoded_filename
= encoded_linkname
= Qnil
;
2393 CHECK_STRING (filename
);
2394 CHECK_STRING (linkname
);
2395 /* If the link target has a ~, we must expand it to get
2396 a truly valid file name. Otherwise, do not expand;
2397 we want to permit links to relative file names. */
2398 if (SREF (filename
, 0) == '~')
2399 filename
= Fexpand_file_name (filename
, Qnil
);
2401 if (!NILP (Ffile_directory_p (linkname
)))
2402 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2404 linkname
= Fexpand_file_name (linkname
, Qnil
);
2406 /* If the file name has special constructs in it,
2407 call the corresponding file handler. */
2408 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2409 if (!NILP (handler
))
2410 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2411 linkname
, ok_if_already_exists
));
2413 /* If the new link name has special constructs in it,
2414 call the corresponding file handler. */
2415 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2416 if (!NILP (handler
))
2417 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2418 linkname
, ok_if_already_exists
));
2421 encoded_filename
= ENCODE_FILE (filename
);
2422 encoded_linkname
= ENCODE_FILE (linkname
);
2424 if (NILP (ok_if_already_exists
)
2425 || INTEGERP (ok_if_already_exists
))
2426 barf_or_query_if_file_exists (linkname
, "make it a link",
2427 INTEGERP (ok_if_already_exists
), 0, 0);
2428 if (0 > symlink (SDATA (encoded_filename
),
2429 SDATA (encoded_linkname
)))
2431 /* If we didn't complain already, silently delete existing file. */
2432 if (errno
== EEXIST
)
2434 unlink (SDATA (encoded_linkname
));
2435 if (0 <= symlink (SDATA (encoded_filename
),
2436 SDATA (encoded_linkname
)))
2443 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2450 xsignal1 (Qfile_error
, build_string ("Symbolic links are not supported"));
2452 #endif /* S_IFLNK */
2456 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2458 doc
: /* Return t if file FILENAME specifies an absolute file name.
2459 On Unix, this is a name starting with a `/' or a `~'. */)
2461 Lisp_Object filename
;
2463 CHECK_STRING (filename
);
2464 return file_name_absolute_p (SDATA (filename
)) ? Qt
: Qnil
;
2467 /* Return nonzero if file FILENAME exists and can be executed. */
2470 check_executable (filename
)
2474 int len
= strlen (filename
);
2477 if (stat (filename
, &st
) < 0)
2479 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
2480 return ((st
.st_mode
& S_IEXEC
) != 0);
2482 return (S_ISREG (st
.st_mode
)
2484 && (xstrcasecmp ((suffix
= filename
+ len
-4), ".com") == 0
2485 || xstrcasecmp (suffix
, ".exe") == 0
2486 || xstrcasecmp (suffix
, ".bat") == 0)
2487 || (st
.st_mode
& S_IFMT
) == S_IFDIR
);
2488 #endif /* not WINDOWSNT */
2489 #else /* not DOS_NT */
2490 #ifdef HAVE_EUIDACCESS
2491 return (euidaccess (filename
, 1) >= 0);
2493 /* Access isn't quite right because it uses the real uid
2494 and we really want to test with the effective uid.
2495 But Unix doesn't give us a right way to do it. */
2496 return (access (filename
, 1) >= 0);
2498 #endif /* not DOS_NT */
2501 /* Return nonzero if file FILENAME exists and can be written. */
2504 check_writable (filename
)
2509 if (stat (filename
, &st
) < 0)
2511 return (st
.st_mode
& S_IWRITE
|| (st
.st_mode
& S_IFMT
) == S_IFDIR
);
2512 #else /* not MSDOS */
2513 #ifdef HAVE_EUIDACCESS
2514 return (euidaccess (filename
, 2) >= 0);
2516 /* Access isn't quite right because it uses the real uid
2517 and we really want to test with the effective uid.
2518 But Unix doesn't give us a right way to do it.
2519 Opening with O_WRONLY could work for an ordinary file,
2520 but would lose for directories. */
2521 return (access (filename
, 2) >= 0);
2523 #endif /* not MSDOS */
2526 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2527 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2528 See also `file-readable-p' and `file-attributes'.
2529 This returns nil for a symlink to a nonexistent file.
2530 Use `file-symlink-p' to test for such links. */)
2532 Lisp_Object filename
;
2534 Lisp_Object absname
;
2535 Lisp_Object handler
;
2536 struct stat statbuf
;
2538 CHECK_STRING (filename
);
2539 absname
= Fexpand_file_name (filename
, Qnil
);
2541 /* If the file name has special constructs in it,
2542 call the corresponding file handler. */
2543 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2544 if (!NILP (handler
))
2545 return call2 (handler
, Qfile_exists_p
, absname
);
2547 absname
= ENCODE_FILE (absname
);
2549 return (stat (SDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2552 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2553 doc
: /* Return t if FILENAME can be executed by you.
2554 For a directory, this means you can access files in that directory. */)
2556 Lisp_Object filename
;
2558 Lisp_Object absname
;
2559 Lisp_Object handler
;
2561 CHECK_STRING (filename
);
2562 absname
= Fexpand_file_name (filename
, Qnil
);
2564 /* If the file name has special constructs in it,
2565 call the corresponding file handler. */
2566 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2567 if (!NILP (handler
))
2568 return call2 (handler
, Qfile_executable_p
, absname
);
2570 absname
= ENCODE_FILE (absname
);
2572 return (check_executable (SDATA (absname
)) ? Qt
: Qnil
);
2575 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2576 doc
: /* Return t if file FILENAME exists and you can read it.
2577 See also `file-exists-p' and `file-attributes'. */)
2579 Lisp_Object filename
;
2581 Lisp_Object absname
;
2582 Lisp_Object handler
;
2585 struct stat statbuf
;
2587 CHECK_STRING (filename
);
2588 absname
= Fexpand_file_name (filename
, Qnil
);
2590 /* If the file name has special constructs in it,
2591 call the corresponding file handler. */
2592 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2593 if (!NILP (handler
))
2594 return call2 (handler
, Qfile_readable_p
, absname
);
2596 absname
= ENCODE_FILE (absname
);
2598 #if defined(DOS_NT) || defined(macintosh)
2599 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2601 if (access (SDATA (absname
), 0) == 0)
2604 #else /* not DOS_NT and not macintosh */
2606 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
2607 /* Opening a fifo without O_NONBLOCK can wait.
2608 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2609 except in the case of a fifo, on a system which handles it. */
2610 desc
= stat (SDATA (absname
), &statbuf
);
2613 if (S_ISFIFO (statbuf
.st_mode
))
2614 flags
|= O_NONBLOCK
;
2616 desc
= emacs_open (SDATA (absname
), flags
, 0);
2621 #endif /* not DOS_NT and not macintosh */
2624 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2626 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2627 doc
: /* Return t if file FILENAME can be written or created by you. */)
2629 Lisp_Object filename
;
2631 Lisp_Object absname
, dir
, encoded
;
2632 Lisp_Object handler
;
2633 struct stat statbuf
;
2635 CHECK_STRING (filename
);
2636 absname
= Fexpand_file_name (filename
, Qnil
);
2638 /* If the file name has special constructs in it,
2639 call the corresponding file handler. */
2640 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2641 if (!NILP (handler
))
2642 return call2 (handler
, Qfile_writable_p
, absname
);
2644 encoded
= ENCODE_FILE (absname
);
2645 if (stat (SDATA (encoded
), &statbuf
) >= 0)
2646 return (check_writable (SDATA (encoded
))
2649 dir
= Ffile_name_directory (absname
);
2652 dir
= Fdirectory_file_name (dir
);
2655 dir
= ENCODE_FILE (dir
);
2657 /* The read-only attribute of the parent directory doesn't affect
2658 whether a file or directory can be created within it. Some day we
2659 should check ACLs though, which do affect this. */
2660 if (stat (SDATA (dir
), &statbuf
) < 0)
2662 return (statbuf
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2664 return (check_writable (!NILP (dir
) ? (char *) SDATA (dir
) : "")
2669 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2670 doc
: /* Access file FILENAME, and get an error if that does not work.
2671 The second argument STRING is used in the error message.
2672 If there is no error, returns nil. */)
2674 Lisp_Object filename
, string
;
2676 Lisp_Object handler
, encoded_filename
, absname
;
2679 CHECK_STRING (filename
);
2680 absname
= Fexpand_file_name (filename
, Qnil
);
2682 CHECK_STRING (string
);
2684 /* If the file name has special constructs in it,
2685 call the corresponding file handler. */
2686 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2687 if (!NILP (handler
))
2688 return call3 (handler
, Qaccess_file
, absname
, string
);
2690 encoded_filename
= ENCODE_FILE (absname
);
2692 fd
= emacs_open (SDATA (encoded_filename
), O_RDONLY
, 0);
2694 report_file_error (SDATA (string
), Fcons (filename
, Qnil
));
2700 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2701 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2702 The value is the link target, as a string.
2703 Otherwise it returns nil.
2705 This function returns t when given the name of a symlink that
2706 points to a nonexistent file. */)
2708 Lisp_Object filename
;
2710 Lisp_Object handler
;
2712 CHECK_STRING (filename
);
2713 filename
= Fexpand_file_name (filename
, Qnil
);
2715 /* If the file name has special constructs in it,
2716 call the corresponding file handler. */
2717 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2718 if (!NILP (handler
))
2719 return call2 (handler
, Qfile_symlink_p
, filename
);
2728 filename
= ENCODE_FILE (filename
);
2735 buf
= (char *) xrealloc (buf
, bufsize
);
2736 bzero (buf
, bufsize
);
2739 valsize
= readlink (SDATA (filename
), buf
, bufsize
);
2743 /* HP-UX reports ERANGE if buffer is too small. */
2744 if (errno
== ERANGE
)
2754 while (valsize
>= bufsize
);
2756 val
= make_string (buf
, valsize
);
2757 if (buf
[0] == '/' && index (buf
, ':'))
2758 val
= concat2 (build_string ("/:"), val
);
2760 val
= DECODE_FILE (val
);
2763 #else /* not S_IFLNK */
2765 #endif /* not S_IFLNK */
2768 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2769 doc
: /* Return t if FILENAME names an existing directory.
2770 Symbolic links to directories count as directories.
2771 See `file-symlink-p' to distinguish symlinks. */)
2773 Lisp_Object filename
;
2775 register Lisp_Object absname
;
2777 Lisp_Object handler
;
2779 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2781 /* If the file name has special constructs in it,
2782 call the corresponding file handler. */
2783 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2784 if (!NILP (handler
))
2785 return call2 (handler
, Qfile_directory_p
, absname
);
2787 absname
= ENCODE_FILE (absname
);
2789 if (stat (SDATA (absname
), &st
) < 0)
2791 return (st
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2794 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
2795 doc
: /* Return t if file FILENAME names a directory you can open.
2796 For the value to be t, FILENAME must specify the name of a directory as a file,
2797 and the directory must allow you to open files in it. In order to use a
2798 directory as a buffer's current directory, this predicate must return true.
2799 A directory name spec may be given instead; then the value is t
2800 if the directory so specified exists and really is a readable and
2801 searchable directory. */)
2803 Lisp_Object filename
;
2805 Lisp_Object handler
;
2807 struct gcpro gcpro1
;
2809 /* If the file name has special constructs in it,
2810 call the corresponding file handler. */
2811 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2812 if (!NILP (handler
))
2813 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2816 tem
= (NILP (Ffile_directory_p (filename
))
2817 || NILP (Ffile_executable_p (filename
)));
2819 return tem
? Qnil
: Qt
;
2822 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2823 doc
: /* Return t if FILENAME names a regular file.
2824 This is the sort of file that holds an ordinary stream of data bytes.
2825 Symbolic links to regular files count as regular files.
2826 See `file-symlink-p' to distinguish symlinks. */)
2828 Lisp_Object filename
;
2830 register Lisp_Object absname
;
2832 Lisp_Object handler
;
2834 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2836 /* If the file name has special constructs in it,
2837 call the corresponding file handler. */
2838 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2839 if (!NILP (handler
))
2840 return call2 (handler
, Qfile_regular_p
, absname
);
2842 absname
= ENCODE_FILE (absname
);
2847 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2849 /* Tell stat to use expensive method to get accurate info. */
2850 Vw32_get_true_file_attributes
= Qt
;
2851 result
= stat (SDATA (absname
), &st
);
2852 Vw32_get_true_file_attributes
= tem
;
2856 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2859 if (stat (SDATA (absname
), &st
) < 0)
2861 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2865 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2866 doc
: /* Return mode bits of file named FILENAME, as an integer.
2867 Return nil, if file does not exist or is not accessible. */)
2869 Lisp_Object filename
;
2871 Lisp_Object absname
;
2873 Lisp_Object handler
;
2875 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2877 /* If the file name has special constructs in it,
2878 call the corresponding file handler. */
2879 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2880 if (!NILP (handler
))
2881 return call2 (handler
, Qfile_modes
, absname
);
2883 absname
= ENCODE_FILE (absname
);
2885 if (stat (SDATA (absname
), &st
) < 0)
2887 #if defined (MSDOS) && __DJGPP__ < 2
2888 if (check_executable (SDATA (absname
)))
2889 st
.st_mode
|= S_IEXEC
;
2890 #endif /* MSDOS && __DJGPP__ < 2 */
2892 return make_number (st
.st_mode
& 07777);
2895 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2896 "(let ((file (read-file-name \"File: \"))) \
2897 (list file (read-file-modes nil file)))",
2898 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2899 Only the 12 low bits of MODE are used.
2901 Interactively, mode bits are read by `read-file-modes', which accepts
2902 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2904 Lisp_Object filename
, mode
;
2906 Lisp_Object absname
, encoded_absname
;
2907 Lisp_Object handler
;
2909 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2910 CHECK_NUMBER (mode
);
2912 /* If the file name has special constructs in it,
2913 call the corresponding file handler. */
2914 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2915 if (!NILP (handler
))
2916 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2918 encoded_absname
= ENCODE_FILE (absname
);
2920 if (chmod (SDATA (encoded_absname
), XINT (mode
)) < 0)
2921 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2926 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2927 doc
: /* Set the file permission bits for newly created files.
2928 The argument MODE should be an integer; only the low 9 bits are used.
2929 This setting is inherited by subprocesses. */)
2933 CHECK_NUMBER (mode
);
2935 umask ((~ XINT (mode
)) & 0777);
2940 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
2941 doc
: /* Return the default file protection for created files.
2942 The value is an integer. */)
2948 realmask
= umask (0);
2951 XSETINT (value
, (~ realmask
) & 0777);
2955 extern int lisp_time_argument
P_ ((Lisp_Object
, time_t *, int *));
2957 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
2958 doc
: /* Set times of file FILENAME to TIME.
2959 Set both access and modification times.
2960 Return t on success, else nil.
2961 Use the current time if TIME is nil. TIME is in the format of
2964 Lisp_Object filename
, time
;
2966 Lisp_Object absname
, encoded_absname
;
2967 Lisp_Object handler
;
2971 if (! lisp_time_argument (time
, &sec
, &usec
))
2972 error ("Invalid time specification");
2974 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2976 /* If the file name has special constructs in it,
2977 call the corresponding file handler. */
2978 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
2979 if (!NILP (handler
))
2980 return call3 (handler
, Qset_file_times
, absname
, time
);
2982 encoded_absname
= ENCODE_FILE (absname
);
2987 EMACS_SET_SECS (t
, sec
);
2988 EMACS_SET_USECS (t
, usec
);
2990 if (set_file_times (SDATA (encoded_absname
), t
, t
))
2995 /* Setting times on a directory always fails. */
2996 if (stat (SDATA (encoded_absname
), &st
) == 0
2997 && (st
.st_mode
& S_IFMT
) == S_IFDIR
)
3000 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3009 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3010 doc
: /* Tell Unix to finish all pending disk updates. */)
3017 #endif /* HAVE_SYNC */
3019 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3020 doc
: /* Return t if file FILE1 is newer than file FILE2.
3021 If FILE1 does not exist, the answer is nil;
3022 otherwise, if FILE2 does not exist, the answer is t. */)
3024 Lisp_Object file1
, file2
;
3026 Lisp_Object absname1
, absname2
;
3029 Lisp_Object handler
;
3030 struct gcpro gcpro1
, gcpro2
;
3032 CHECK_STRING (file1
);
3033 CHECK_STRING (file2
);
3036 GCPRO2 (absname1
, file2
);
3037 absname1
= expand_and_dir_to_file (file1
, current_buffer
->directory
);
3038 absname2
= expand_and_dir_to_file (file2
, current_buffer
->directory
);
3041 /* If the file name has special constructs in it,
3042 call the corresponding file handler. */
3043 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3045 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3046 if (!NILP (handler
))
3047 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3049 GCPRO2 (absname1
, absname2
);
3050 absname1
= ENCODE_FILE (absname1
);
3051 absname2
= ENCODE_FILE (absname2
);
3054 if (stat (SDATA (absname1
), &st
) < 0)
3057 mtime1
= st
.st_mtime
;
3059 if (stat (SDATA (absname2
), &st
) < 0)
3062 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3066 Lisp_Object Qfind_buffer_file_type
;
3069 #ifndef READ_BUF_SIZE
3070 #define READ_BUF_SIZE (64 << 10)
3073 /* This function is called after Lisp functions to decide a coding
3074 system are called, or when they cause an error. Before they are
3075 called, the current buffer is set unibyte and it contains only a
3076 newly inserted text (thus the buffer was empty before the
3079 The functions may set markers, overlays, text properties, or even
3080 alter the buffer contents, change the current buffer.
3082 Here, we reset all those changes by:
3083 o set back the current buffer.
3084 o move all markers and overlays to BEG.
3085 o remove all text properties.
3086 o set back the buffer multibyteness. */
3089 decide_coding_unwind (unwind_data
)
3090 Lisp_Object unwind_data
;
3092 Lisp_Object multibyte
, undo_list
, buffer
;
3094 multibyte
= XCAR (unwind_data
);
3095 unwind_data
= XCDR (unwind_data
);
3096 undo_list
= XCAR (unwind_data
);
3097 buffer
= XCDR (unwind_data
);
3099 if (current_buffer
!= XBUFFER (buffer
))
3100 set_buffer_internal (XBUFFER (buffer
));
3101 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3102 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3103 BUF_INTERVALS (current_buffer
) = 0;
3104 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3106 /* Now we are safe to change the buffer's multibyteness directly. */
3107 current_buffer
->enable_multibyte_characters
= multibyte
;
3108 current_buffer
->undo_list
= undo_list
;
3114 /* Used to pass values from insert-file-contents to read_non_regular. */
3116 static int non_regular_fd
;
3117 static EMACS_INT non_regular_inserted
;
3118 static EMACS_INT non_regular_nbytes
;
3121 /* Read from a non-regular file.
3122 Read non_regular_trytry bytes max from non_regular_fd.
3123 Non_regular_inserted specifies where to put the read bytes.
3124 Value is the number of bytes read. */
3133 nbytes
= emacs_read (non_regular_fd
,
3134 BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ non_regular_inserted
,
3135 non_regular_nbytes
);
3137 return make_number (nbytes
);
3141 /* Condition-case handler used when reading from non-regular files
3142 in insert-file-contents. */
3145 read_non_regular_quit ()
3151 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3153 doc
: /* Insert contents of file FILENAME after point.
3154 Returns list of absolute file name and number of characters inserted.
3155 If second argument VISIT is non-nil, the buffer's visited filename and
3156 last save file modtime are set, and it is marked unmodified. If
3157 visiting and the file does not exist, visiting is completed before the
3160 The optional third and fourth arguments BEG and END specify what portion
3161 of the file to insert. These arguments count bytes in the file, not
3162 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3164 If optional fifth argument REPLACE is non-nil, replace the current
3165 buffer contents (in the accessible portion) with the file contents.
3166 This is better than simply deleting and inserting the whole thing
3167 because (1) it preserves some marker positions and (2) it puts less data
3168 in the undo list. When REPLACE is non-nil, the second return value is
3169 the number of characters that replace previous buffer contents.
3171 This function does code conversion according to the value of
3172 `coding-system-for-read' or `file-coding-system-alist', and sets the
3173 variable `last-coding-system-used' to the coding system actually used. */)
3174 (filename
, visit
, beg
, end
, replace
)
3175 Lisp_Object filename
, visit
, beg
, end
, replace
;
3179 EMACS_INT inserted
= 0;
3181 register EMACS_INT how_much
;
3182 register EMACS_INT unprocessed
;
3183 int count
= SPECPDL_INDEX ();
3184 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3185 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3187 EMACS_INT total
= 0;
3188 int not_regular
= 0;
3189 unsigned char read_buf
[READ_BUF_SIZE
];
3190 struct coding_system coding
;
3191 unsigned char buffer
[1 << 14];
3192 int replace_handled
= 0;
3193 int set_coding_system
= 0;
3194 Lisp_Object coding_system
;
3196 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3197 int we_locked_file
= 0;
3198 int deferred_remove_unwind_protect
= 0;
3200 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3201 error ("Cannot do file visiting in an indirect buffer");
3203 if (!NILP (current_buffer
->read_only
))
3204 Fbarf_if_buffer_read_only ();
3208 orig_filename
= Qnil
;
3211 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3213 CHECK_STRING (filename
);
3214 filename
= Fexpand_file_name (filename
, Qnil
);
3216 /* The value Qnil means that the coding system is not yet
3218 coding_system
= Qnil
;
3220 /* If the file name has special constructs in it,
3221 call the corresponding file handler. */
3222 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3223 if (!NILP (handler
))
3225 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3226 visit
, beg
, end
, replace
);
3227 if (CONSP (val
) && CONSP (XCDR (val
)))
3228 inserted
= XINT (XCAR (XCDR (val
)));
3232 orig_filename
= filename
;
3233 filename
= ENCODE_FILE (filename
);
3239 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3241 /* Tell stat to use expensive method to get accurate info. */
3242 Vw32_get_true_file_attributes
= Qt
;
3243 total
= stat (SDATA (filename
), &st
);
3244 Vw32_get_true_file_attributes
= tem
;
3248 if (stat (SDATA (filename
), &st
) < 0)
3249 #endif /* WINDOWSNT */
3251 if (fd
>= 0) emacs_close (fd
);
3254 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3257 if (!NILP (Vcoding_system_for_read
))
3258 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3263 /* This code will need to be changed in order to work on named
3264 pipes, and it's probably just not worth it. So we should at
3265 least signal an error. */
3266 if (!S_ISREG (st
.st_mode
))
3273 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3274 xsignal2 (Qfile_error
,
3275 build_string ("not a regular file"), orig_filename
);
3280 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0)
3283 /* Replacement should preserve point as it preserves markers. */
3284 if (!NILP (replace
))
3285 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3287 record_unwind_protect (close_file_unwind
, make_number (fd
));
3289 /* Can happen on any platform that uses long as type of off_t, but allows
3290 file sizes to exceed 2Gb, so give a suitable message. */
3291 if (! not_regular
&& st
.st_size
< 0)
3292 error ("Maximum buffer size exceeded");
3294 /* Prevent redisplay optimizations. */
3295 current_buffer
->clip_changed
= 1;
3299 if (!NILP (beg
) || !NILP (end
))
3300 error ("Attempt to visit less than an entire file");
3301 if (BEG
< Z
&& NILP (replace
))
3302 error ("Cannot do file visiting in a non-empty buffer");
3308 XSETFASTINT (beg
, 0);
3316 XSETINT (end
, st
.st_size
);
3318 /* Arithmetic overflow can occur if an Emacs integer cannot
3319 represent the file size, or if the calculations below
3320 overflow. The calculations below double the file size
3321 twice, so check that it can be multiplied by 4 safely. */
3322 if (XINT (end
) != st
.st_size
3323 /* Actually, it should test either INT_MAX or LONG_MAX
3324 depending on which one is used for EMACS_INT. But in
3325 any case, in practice, this test is redundant with the
3327 || st.st_size > INT_MAX / 4 */)
3328 error ("Maximum buffer size exceeded");
3330 /* The file size returned from stat may be zero, but data
3331 may be readable nonetheless, for example when this is a
3332 file in the /proc filesystem. */
3333 if (st
.st_size
== 0)
3334 XSETINT (end
, READ_BUF_SIZE
);
3338 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3340 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3341 setup_coding_system (coding_system
, &coding
);
3342 /* Ensure we set Vlast_coding_system_used. */
3343 set_coding_system
= 1;
3347 /* Decide the coding system to use for reading the file now
3348 because we can't use an optimized method for handling
3349 `coding:' tag if the current buffer is not empty. */
3350 if (!NILP (Vcoding_system_for_read
))
3351 coding_system
= Vcoding_system_for_read
;
3354 /* Don't try looking inside a file for a coding system
3355 specification if it is not seekable. */
3356 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3358 /* Find a coding system specified in the heading two
3359 lines or in the tailing several lines of the file.
3360 We assume that the 1K-byte and 3K-byte for heading
3361 and tailing respectively are sufficient for this
3365 if (st
.st_size
<= (1024 * 4))
3366 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3369 nread
= emacs_read (fd
, read_buf
, 1024);
3372 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3373 report_file_error ("Setting file position",
3374 Fcons (orig_filename
, Qnil
));
3375 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3380 error ("IO error reading %s: %s",
3381 SDATA (orig_filename
), emacs_strerror (errno
));
3384 struct buffer
*prev
= current_buffer
;
3388 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3390 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3391 buf
= XBUFFER (buffer
);
3393 delete_all_overlays (buf
);
3394 buf
->directory
= current_buffer
->directory
;
3395 buf
->read_only
= Qnil
;
3396 buf
->filename
= Qnil
;
3397 buf
->undo_list
= Qt
;
3398 eassert (buf
->overlays_before
== NULL
);
3399 eassert (buf
->overlays_after
== NULL
);
3401 set_buffer_internal (buf
);
3403 buf
->enable_multibyte_characters
= Qnil
;
3405 insert_1_both (read_buf
, nread
, nread
, 0, 0, 0);
3406 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3407 coding_system
= call2 (Vset_auto_coding_function
,
3408 filename
, make_number (nread
));
3409 set_buffer_internal (prev
);
3411 /* Discard the unwind protect for recovering the
3415 /* Rewind the file for the actual read done later. */
3416 if (lseek (fd
, 0, 0) < 0)
3417 report_file_error ("Setting file position",
3418 Fcons (orig_filename
, Qnil
));
3422 if (NILP (coding_system
))
3424 /* If we have not yet decided a coding system, check
3425 file-coding-system-alist. */
3426 Lisp_Object args
[6];
3428 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3429 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3430 coding_system
= Ffind_operation_coding_system (6, args
);
3431 if (CONSP (coding_system
))
3432 coding_system
= XCAR (coding_system
);
3436 if (NILP (coding_system
))
3437 coding_system
= Qundecided
;
3439 CHECK_CODING_SYSTEM (coding_system
);
3441 if (NILP (current_buffer
->enable_multibyte_characters
))
3442 /* We must suppress all character code conversion except for
3443 end-of-line conversion. */
3444 coding_system
= raw_text_coding_system (coding_system
);
3446 setup_coding_system (coding_system
, &coding
);
3447 /* Ensure we set Vlast_coding_system_used. */
3448 set_coding_system
= 1;
3451 /* If requested, replace the accessible part of the buffer
3452 with the file contents. Avoid replacing text at the
3453 beginning or end of the buffer that matches the file contents;
3454 that preserves markers pointing to the unchanged parts.
3456 Here we implement this feature in an optimized way
3457 for the case where code conversion is NOT needed.
3458 The following if-statement handles the case of conversion
3459 in a less optimal way.
3461 If the code conversion is "automatic" then we try using this
3462 method and hope for the best.
3463 But if we discover the need for conversion, we give up on this method
3464 and let the following if-statement handle the replace job. */
3467 && (NILP (coding_system
)
3468 || ! CODING_REQUIRE_DECODING (&coding
)))
3470 /* same_at_start and same_at_end count bytes,
3471 because file access counts bytes
3472 and BEG and END count bytes. */
3473 EMACS_INT same_at_start
= BEGV_BYTE
;
3474 EMACS_INT same_at_end
= ZV_BYTE
;
3476 /* There is still a possibility we will find the need to do code
3477 conversion. If that happens, we set this variable to 1 to
3478 give up on handling REPLACE in the optimized way. */
3479 int giveup_match_end
= 0;
3481 if (XINT (beg
) != 0)
3483 if (lseek (fd
, XINT (beg
), 0) < 0)
3484 report_file_error ("Setting file position",
3485 Fcons (orig_filename
, Qnil
));
3490 /* Count how many chars at the start of the file
3491 match the text at the beginning of the buffer. */
3494 EMACS_INT nread
, bufpos
;
3496 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3498 error ("IO error reading %s: %s",
3499 SDATA (orig_filename
), emacs_strerror (errno
));
3500 else if (nread
== 0)
3503 if (CODING_REQUIRE_DETECTION (&coding
))
3505 coding_system
= detect_coding_system (buffer
, nread
, nread
, 1, 0,
3507 setup_coding_system (coding_system
, &coding
);
3510 if (CODING_REQUIRE_DECODING (&coding
))
3511 /* We found that the file should be decoded somehow.
3512 Let's give up here. */
3514 giveup_match_end
= 1;
3519 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3520 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3521 same_at_start
++, bufpos
++;
3522 /* If we found a discrepancy, stop the scan.
3523 Otherwise loop around and scan the next bufferful. */
3524 if (bufpos
!= nread
)
3528 /* If the file matches the buffer completely,
3529 there's no need to replace anything. */
3530 if (same_at_start
- BEGV_BYTE
== XINT (end
))
3534 /* Truncate the buffer to the size of the file. */
3535 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3540 /* Count how many chars at the end of the file
3541 match the text at the end of the buffer. But, if we have
3542 already found that decoding is necessary, don't waste time. */
3543 while (!giveup_match_end
)
3545 EMACS_INT total_read
, nread
, bufpos
, curpos
, trial
;
3547 /* At what file position are we now scanning? */
3548 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
3549 /* If the entire file matches the buffer tail, stop the scan. */
3552 /* How much can we scan in the next step? */
3553 trial
= min (curpos
, sizeof buffer
);
3554 if (lseek (fd
, curpos
- trial
, 0) < 0)
3555 report_file_error ("Setting file position",
3556 Fcons (orig_filename
, Qnil
));
3558 total_read
= nread
= 0;
3559 while (total_read
< trial
)
3561 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3563 error ("IO error reading %s: %s",
3564 SDATA (orig_filename
), emacs_strerror (errno
));
3565 else if (nread
== 0)
3567 total_read
+= nread
;
3570 /* Scan this bufferful from the end, comparing with
3571 the Emacs buffer. */
3572 bufpos
= total_read
;
3574 /* Compare with same_at_start to avoid counting some buffer text
3575 as matching both at the file's beginning and at the end. */
3576 while (bufpos
> 0 && same_at_end
> same_at_start
3577 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3578 same_at_end
--, bufpos
--;
3580 /* If we found a discrepancy, stop the scan.
3581 Otherwise loop around and scan the preceding bufferful. */
3584 /* If this discrepancy is because of code conversion,
3585 we cannot use this method; giveup and try the other. */
3586 if (same_at_end
> same_at_start
3587 && FETCH_BYTE (same_at_end
- 1) >= 0200
3588 && ! NILP (current_buffer
->enable_multibyte_characters
)
3589 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3590 giveup_match_end
= 1;
3599 if (! giveup_match_end
)
3603 /* We win! We can handle REPLACE the optimized way. */
3605 /* Extend the start of non-matching text area to multibyte
3606 character boundary. */
3607 if (! NILP (current_buffer
->enable_multibyte_characters
))
3608 while (same_at_start
> BEGV_BYTE
3609 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3612 /* Extend the end of non-matching text area to multibyte
3613 character boundary. */
3614 if (! NILP (current_buffer
->enable_multibyte_characters
))
3615 while (same_at_end
< ZV_BYTE
3616 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3619 /* Don't try to reuse the same piece of text twice. */
3620 overlap
= (same_at_start
- BEGV_BYTE
3621 - (same_at_end
+ st
.st_size
- ZV
));
3623 same_at_end
+= overlap
;
3625 /* Arrange to read only the nonmatching middle part of the file. */
3626 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
3627 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
3629 del_range_byte (same_at_start
, same_at_end
, 0);
3630 /* Insert from the file at the proper position. */
3631 temp
= BYTE_TO_CHAR (same_at_start
);
3632 SET_PT_BOTH (temp
, same_at_start
);
3634 /* If display currently starts at beginning of line,
3635 keep it that way. */
3636 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3637 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3639 replace_handled
= 1;
3643 /* If requested, replace the accessible part of the buffer
3644 with the file contents. Avoid replacing text at the
3645 beginning or end of the buffer that matches the file contents;
3646 that preserves markers pointing to the unchanged parts.
3648 Here we implement this feature for the case where code conversion
3649 is needed, in a simple way that needs a lot of memory.
3650 The preceding if-statement handles the case of no conversion
3651 in a more optimized way. */
3652 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3654 EMACS_INT same_at_start
= BEGV_BYTE
;
3655 EMACS_INT same_at_end
= ZV_BYTE
;
3656 EMACS_INT same_at_start_charpos
;
3657 EMACS_INT inserted_chars
;
3660 unsigned char *decoded
;
3662 int this_count
= SPECPDL_INDEX ();
3663 int multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
3664 Lisp_Object conversion_buffer
;
3666 conversion_buffer
= code_conversion_save (1, multibyte
);
3668 /* First read the whole file, performing code conversion into
3669 CONVERSION_BUFFER. */
3671 if (lseek (fd
, XINT (beg
), 0) < 0)
3672 report_file_error ("Setting file position",
3673 Fcons (orig_filename
, Qnil
));
3675 total
= st
.st_size
; /* Total bytes in the file. */
3676 how_much
= 0; /* Bytes read from file so far. */
3677 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3678 unprocessed
= 0; /* Bytes not processed in previous loop. */
3680 GCPRO1 (conversion_buffer
);
3681 while (how_much
< total
)
3683 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3684 quitting while reading a huge while. */
3685 /* try is reserved in some compilers (Microsoft C) */
3686 EMACS_INT trytry
= min (total
- how_much
,
3687 READ_BUF_SIZE
- unprocessed
);
3690 /* Allow quitting out of the actual I/O. */
3693 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3705 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3706 BUF_Z (XBUFFER (conversion_buffer
)));
3707 decode_coding_c_string (&coding
, read_buf
, unprocessed
+ this,
3709 unprocessed
= coding
.carryover_bytes
;
3710 if (coding
.carryover_bytes
> 0)
3711 bcopy (coding
.carryover
, read_buf
, unprocessed
);
3716 /* We should remove the unwind_protect calling
3717 close_file_unwind, but other stuff has been added the stack,
3718 so defer the removal till we reach the `handled' label. */
3719 deferred_remove_unwind_protect
= 1;
3721 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3722 if we couldn't read the file. */
3725 error ("IO error reading %s: %s",
3726 SDATA (orig_filename
), emacs_strerror (errno
));
3728 if (unprocessed
> 0)
3730 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3731 decode_coding_c_string (&coding
, read_buf
, unprocessed
,
3733 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3736 coding_system
= CODING_ID_NAME (coding
.id
);
3737 set_coding_system
= 1;
3738 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3739 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3740 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3742 /* Compare the beginning of the converted string with the buffer
3746 while (bufpos
< inserted
&& same_at_start
< same_at_end
3747 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3748 same_at_start
++, bufpos
++;
3750 /* If the file matches the head of buffer completely,
3751 there's no need to replace anything. */
3753 if (bufpos
== inserted
)
3755 /* Truncate the buffer to the size of the file. */
3756 if (same_at_start
== same_at_end
)
3759 del_range_byte (same_at_start
, same_at_end
, 0);
3762 unbind_to (this_count
, Qnil
);
3766 /* Extend the start of non-matching text area to the previous
3767 multibyte character boundary. */
3768 if (! NILP (current_buffer
->enable_multibyte_characters
))
3769 while (same_at_start
> BEGV_BYTE
3770 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3773 /* Scan this bufferful from the end, comparing with
3774 the Emacs buffer. */
3777 /* Compare with same_at_start to avoid counting some buffer text
3778 as matching both at the file's beginning and at the end. */
3779 while (bufpos
> 0 && same_at_end
> same_at_start
3780 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3781 same_at_end
--, bufpos
--;
3783 /* Extend the end of non-matching text area to the next
3784 multibyte character boundary. */
3785 if (! NILP (current_buffer
->enable_multibyte_characters
))
3786 while (same_at_end
< ZV_BYTE
3787 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3790 /* Don't try to reuse the same piece of text twice. */
3791 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3793 same_at_end
+= overlap
;
3795 /* If display currently starts at beginning of line,
3796 keep it that way. */
3797 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3798 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3800 /* Replace the chars that we need to replace,
3801 and update INSERTED to equal the number of bytes
3802 we are taking from the decoded string. */
3803 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3805 if (same_at_end
!= same_at_start
)
3807 del_range_byte (same_at_start
, same_at_end
, 0);
3809 same_at_start
= GPT_BYTE
;
3813 temp
= BYTE_TO_CHAR (same_at_start
);
3815 /* Insert from the file at the proper position. */
3816 SET_PT_BOTH (temp
, same_at_start
);
3817 same_at_start_charpos
3818 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3819 same_at_start
- BEGV_BYTE
3820 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3822 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3823 same_at_start
+ inserted
- BEGV_BYTE
3824 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3825 - same_at_start_charpos
);
3826 /* This binding is to avoid ask-user-about-supersession-threat
3827 being called in insert_from_buffer (via in
3828 prepare_to_modify_buffer). */
3829 specbind (intern ("buffer-file-name"), Qnil
);
3830 insert_from_buffer (XBUFFER (conversion_buffer
),
3831 same_at_start_charpos
, inserted_chars
, 0);
3832 /* Set `inserted' to the number of inserted characters. */
3833 inserted
= PT
- temp
;
3834 /* Set point before the inserted characters. */
3835 SET_PT_BOTH (temp
, same_at_start
);
3837 unbind_to (this_count
, Qnil
);
3844 register Lisp_Object temp
;
3846 total
= XINT (end
) - XINT (beg
);
3848 /* Make sure point-max won't overflow after this insertion. */
3849 XSETINT (temp
, total
);
3850 if (total
!= XINT (temp
))
3851 error ("Maximum buffer size exceeded");
3854 /* For a special file, all we can do is guess. */
3855 total
= READ_BUF_SIZE
;
3857 if (NILP (visit
) && inserted
> 0)
3859 #ifdef CLASH_DETECTION
3860 if (!NILP (current_buffer
->file_truename
)
3861 /* Make binding buffer-file-name to nil effective. */
3862 && !NILP (current_buffer
->filename
)
3863 && SAVE_MODIFF
>= MODIFF
)
3865 #endif /* CLASH_DETECTION */
3866 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3870 if (GAP_SIZE
< total
)
3871 make_gap (total
- GAP_SIZE
);
3873 if (XINT (beg
) != 0 || !NILP (replace
))
3875 if (lseek (fd
, XINT (beg
), 0) < 0)
3876 report_file_error ("Setting file position",
3877 Fcons (orig_filename
, Qnil
));
3880 /* In the following loop, HOW_MUCH contains the total bytes read so
3881 far for a regular file, and not changed for a special file. But,
3882 before exiting the loop, it is set to a negative value if I/O
3886 /* Total bytes inserted. */
3889 /* Here, we don't do code conversion in the loop. It is done by
3890 decode_coding_gap after all data are read into the buffer. */
3892 EMACS_INT gap_size
= GAP_SIZE
;
3894 while (how_much
< total
)
3896 /* try is reserved in some compilers (Microsoft C) */
3897 EMACS_INT trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3904 /* Maybe make more room. */
3905 if (gap_size
< trytry
)
3907 make_gap (total
- gap_size
);
3908 gap_size
= GAP_SIZE
;
3911 /* Read from the file, capturing `quit'. When an
3912 error occurs, end the loop, and arrange for a quit
3913 to be signaled after decoding the text we read. */
3914 non_regular_fd
= fd
;
3915 non_regular_inserted
= inserted
;
3916 non_regular_nbytes
= trytry
;
3917 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
3918 read_non_regular_quit
);
3929 /* Allow quitting out of the actual I/O. We don't make text
3930 part of the buffer until all the reading is done, so a C-g
3931 here doesn't do any harm. */
3934 this = emacs_read (fd
, BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ inserted
, trytry
);
3946 /* For a regular file, where TOTAL is the real size,
3947 count HOW_MUCH to compare with it.
3948 For a special file, where TOTAL is just a buffer size,
3949 so don't bother counting in HOW_MUCH.
3950 (INSERTED is where we count the number of characters inserted.) */
3957 /* Now we have read all the file data into the gap.
3958 If it was empty, undo marking the buffer modified. */
3962 #ifdef CLASH_DETECTION
3964 unlock_file (current_buffer
->file_truename
);
3966 Vdeactivate_mark
= old_Vdeactivate_mark
;
3969 Vdeactivate_mark
= Qt
;
3971 /* Make the text read part of the buffer. */
3972 GAP_SIZE
-= inserted
;
3974 GPT_BYTE
+= inserted
;
3976 ZV_BYTE
+= inserted
;
3981 /* Put an anchor to ensure multi-byte form ends at gap. */
3986 /* Discard the unwind protect for closing the file. */
3990 error ("IO error reading %s: %s",
3991 SDATA (orig_filename
), emacs_strerror (errno
));
3995 if (NILP (coding_system
))
3997 /* The coding system is not yet decided. Decide it by an
3998 optimized method for handling `coding:' tag.
4000 Note that we can get here only if the buffer was empty
4001 before the insertion. */
4003 if (!NILP (Vcoding_system_for_read
))
4004 coding_system
= Vcoding_system_for_read
;
4007 /* Since we are sure that the current buffer was empty
4008 before the insertion, we can toggle
4009 enable-multibyte-characters directly here without taking
4010 care of marker adjustment. By this way, we can run Lisp
4011 program safely before decoding the inserted text. */
4012 Lisp_Object unwind_data
;
4013 int count
= SPECPDL_INDEX ();
4015 unwind_data
= Fcons (current_buffer
->enable_multibyte_characters
,
4016 Fcons (current_buffer
->undo_list
,
4017 Fcurrent_buffer ()));
4018 current_buffer
->enable_multibyte_characters
= Qnil
;
4019 current_buffer
->undo_list
= Qt
;
4020 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4022 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4024 coding_system
= call2 (Vset_auto_coding_function
,
4025 filename
, make_number (inserted
));
4028 if (NILP (coding_system
))
4030 /* If the coding system is not yet decided, check
4031 file-coding-system-alist. */
4032 Lisp_Object args
[6];
4034 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4035 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4036 coding_system
= Ffind_operation_coding_system (6, args
);
4037 if (CONSP (coding_system
))
4038 coding_system
= XCAR (coding_system
);
4040 unbind_to (count
, Qnil
);
4041 inserted
= Z_BYTE
- BEG_BYTE
;
4044 if (NILP (coding_system
))
4045 coding_system
= Qundecided
;
4047 CHECK_CODING_SYSTEM (coding_system
);
4049 if (NILP (current_buffer
->enable_multibyte_characters
))
4050 /* We must suppress all character code conversion except for
4051 end-of-line conversion. */
4052 coding_system
= raw_text_coding_system (coding_system
);
4053 setup_coding_system (coding_system
, &coding
);
4054 /* Ensure we set Vlast_coding_system_used. */
4055 set_coding_system
= 1;
4060 /* When we visit a file by raw-text, we change the buffer to
4062 if (CODING_FOR_UNIBYTE (&coding
)
4063 /* Can't do this if part of the buffer might be preserved. */
4065 /* Visiting a file with these coding system makes the buffer
4067 current_buffer
->enable_multibyte_characters
= Qnil
;
4070 coding
.dst_multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
4071 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4072 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4074 move_gap_both (PT
, PT_BYTE
);
4075 GAP_SIZE
+= inserted
;
4076 ZV_BYTE
-= inserted
;
4080 decode_coding_gap (&coding
, inserted
, inserted
);
4081 inserted
= coding
.produced_char
;
4082 coding_system
= CODING_ID_NAME (coding
.id
);
4084 else if (inserted
> 0)
4085 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4088 /* Now INSERTED is measured in characters. */
4091 /* Use the conversion type to determine buffer-file-type
4092 (find-buffer-file-type is now used to help determine the
4094 if ((VECTORP (CODING_ID_EOL_TYPE (coding
.id
))
4095 || EQ (CODING_ID_EOL_TYPE (coding
.id
), Qunix
))
4096 && ! CODING_REQUIRE_DECODING (&coding
))
4097 current_buffer
->buffer_file_type
= Qt
;
4099 current_buffer
->buffer_file_type
= Qnil
;
4104 if (deferred_remove_unwind_protect
)
4105 /* If requested above, discard the unwind protect for closing the
4111 if (!EQ (current_buffer
->undo_list
, Qt
) && !nochange
)
4112 current_buffer
->undo_list
= Qnil
;
4116 current_buffer
->modtime
= st
.st_mtime
;
4117 current_buffer
->filename
= orig_filename
;
4120 SAVE_MODIFF
= MODIFF
;
4121 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4122 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4123 #ifdef CLASH_DETECTION
4126 if (!NILP (current_buffer
->file_truename
))
4127 unlock_file (current_buffer
->file_truename
);
4128 unlock_file (filename
);
4130 #endif /* CLASH_DETECTION */
4132 xsignal2 (Qfile_error
,
4133 build_string ("not a regular file"), orig_filename
);
4136 if (set_coding_system
)
4137 Vlast_coding_system_used
= coding_system
;
4139 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4141 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4143 if (! NILP (insval
))
4145 CHECK_NUMBER (insval
);
4146 inserted
= XFASTINT (insval
);
4150 /* Decode file format. */
4153 /* Don't run point motion or modification hooks when decoding. */
4154 int count
= SPECPDL_INDEX ();
4155 EMACS_INT old_inserted
= inserted
;
4156 specbind (Qinhibit_point_motion_hooks
, Qt
);
4157 specbind (Qinhibit_modification_hooks
, Qt
);
4159 /* Save old undo list and don't record undo for decoding. */
4160 old_undo
= current_buffer
->undo_list
;
4161 current_buffer
->undo_list
= Qt
;
4165 insval
= call3 (Qformat_decode
,
4166 Qnil
, make_number (inserted
), visit
);
4167 CHECK_NUMBER (insval
);
4168 inserted
= XFASTINT (insval
);
4172 /* If REPLACE is non-nil and we succeeded in not replacing the
4173 beginning or end of the buffer text with the file's contents,
4174 call format-decode with `point' positioned at the beginning
4175 of the buffer and `inserted' equalling the number of
4176 characters in the buffer. Otherwise, format-decode might
4177 fail to correctly analyze the beginning or end of the buffer.
4178 Hence we temporarily save `point' and `inserted' here and
4179 restore `point' iff format-decode did not insert or delete
4180 any text. Otherwise we leave `point' at point-min. */
4181 EMACS_INT opoint
= PT
;
4182 EMACS_INT opoint_byte
= PT_BYTE
;
4183 EMACS_INT oinserted
= ZV
- BEGV
;
4184 int ochars_modiff
= CHARS_MODIFF
;
4186 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4187 insval
= call3 (Qformat_decode
,
4188 Qnil
, make_number (oinserted
), visit
);
4189 CHECK_NUMBER (insval
);
4190 if (ochars_modiff
== CHARS_MODIFF
)
4191 /* format_decode didn't modify buffer's characters => move
4192 point back to position before inserted text and leave
4193 value of inserted alone. */
4194 SET_PT_BOTH (opoint
, opoint_byte
);
4196 /* format_decode modified buffer's characters => consider
4197 entire buffer changed and leave point at point-min. */
4198 inserted
= XFASTINT (insval
);
4201 /* For consistency with format-decode call these now iff inserted > 0
4202 (martin 2007-06-28). */
4203 p
= Vafter_insert_file_functions
;
4208 insval
= call1 (XCAR (p
), make_number (inserted
));
4211 CHECK_NUMBER (insval
);
4212 inserted
= XFASTINT (insval
);
4217 /* For the rationale of this see the comment on
4218 format-decode above. */
4219 EMACS_INT opoint
= PT
;
4220 EMACS_INT opoint_byte
= PT_BYTE
;
4221 EMACS_INT oinserted
= ZV
- BEGV
;
4222 int ochars_modiff
= CHARS_MODIFF
;
4224 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4225 insval
= call1 (XCAR (p
), make_number (oinserted
));
4228 CHECK_NUMBER (insval
);
4229 if (ochars_modiff
== CHARS_MODIFF
)
4230 /* after_insert_file_functions didn't modify
4231 buffer's characters => move point back to
4232 position before inserted text and leave value of
4234 SET_PT_BOTH (opoint
, opoint_byte
);
4236 /* after_insert_file_functions did modify buffer's
4237 characters => consider entire buffer changed and
4238 leave point at point-min. */
4239 inserted
= XFASTINT (insval
);
4249 current_buffer
->undo_list
= old_undo
;
4250 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4252 /* Adjust the last undo record for the size change during
4253 the format conversion. */
4254 Lisp_Object tem
= XCAR (old_undo
);
4255 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4256 && INTEGERP (XCDR (tem
))
4257 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4258 XSETCDR (tem
, make_number (PT
+ inserted
));
4262 /* If undo_list was Qt before, keep it that way.
4263 Otherwise start with an empty undo_list. */
4264 current_buffer
->undo_list
= EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4266 unbind_to (count
, Qnil
);
4269 /* Call after-change hooks for the inserted text, aside from the case
4270 of normal visiting (not with REPLACE), which is done in a new buffer
4271 "before" the buffer is changed. */
4272 if (inserted
> 0 && total
> 0
4273 && (NILP (visit
) || !NILP (replace
)))
4275 signal_after_change (PT
, 0, inserted
);
4276 update_compositions (PT
, PT
, CHECK_BORDER
);
4280 && current_buffer
->modtime
== -1)
4282 /* If visiting nonexistent file, return nil. */
4283 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4287 Fsignal (Qquit
, Qnil
);
4289 /* ??? Retval needs to be dealt with in all cases consistently. */
4291 val
= Fcons (orig_filename
,
4292 Fcons (make_number (inserted
),
4295 RETURN_UNGCPRO (unbind_to (count
, val
));
4298 static Lisp_Object build_annotations
P_ ((Lisp_Object
, Lisp_Object
));
4301 build_annotations_unwind (arg
)
4304 Vwrite_region_annotation_buffers
= arg
;
4308 /* Decide the coding-system to encode the data with. */
4311 choose_write_coding_system (start
, end
, filename
,
4312 append
, visit
, lockname
, coding
)
4313 Lisp_Object start
, end
, filename
, append
, visit
, lockname
;
4314 struct coding_system
*coding
;
4317 Lisp_Object eol_parent
= Qnil
;
4320 && NILP (Fstring_equal (current_buffer
->filename
,
4321 current_buffer
->auto_save_file_name
)))
4326 else if (!NILP (Vcoding_system_for_write
))
4328 val
= Vcoding_system_for_write
;
4329 if (coding_system_require_warning
4330 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4331 /* Confirm that VAL can surely encode the current region. */
4332 val
= call5 (Vselect_safe_coding_system_function
,
4333 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4338 /* If the variable `buffer-file-coding-system' is set locally,
4339 it means that the file was read with some kind of code
4340 conversion or the variable is explicitly set by users. We
4341 had better write it out with the same coding system even if
4342 `enable-multibyte-characters' is nil.
4344 If it is not set locally, we anyway have to convert EOL
4345 format if the default value of `buffer-file-coding-system'
4346 tells that it is not Unix-like (LF only) format. */
4347 int using_default_coding
= 0;
4348 int force_raw_text
= 0;
4350 val
= current_buffer
->buffer_file_coding_system
;
4352 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4355 if (NILP (current_buffer
->enable_multibyte_characters
))
4361 /* Check file-coding-system-alist. */
4362 Lisp_Object args
[7], coding_systems
;
4364 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4365 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4367 coding_systems
= Ffind_operation_coding_system (7, args
);
4368 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4369 val
= XCDR (coding_systems
);
4374 /* If we still have not decided a coding system, use the
4375 default value of buffer-file-coding-system. */
4376 val
= current_buffer
->buffer_file_coding_system
;
4377 using_default_coding
= 1;
4380 if (! NILP (val
) && ! force_raw_text
)
4382 Lisp_Object spec
, attrs
;
4384 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4385 attrs
= AREF (spec
, 0);
4386 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4391 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4392 /* Confirm that VAL can surely encode the current region. */
4393 val
= call5 (Vselect_safe_coding_system_function
,
4394 start
, end
, val
, Qnil
, filename
);
4396 /* If the decided coding-system doesn't specify end-of-line
4397 format, we use that of
4398 `default-buffer-file-coding-system'. */
4399 if (! using_default_coding
4400 && ! NILP (buffer_defaults
.buffer_file_coding_system
))
4401 val
= (coding_inherit_eol_type
4402 (val
, buffer_defaults
.buffer_file_coding_system
));
4404 /* If we decide not to encode text, use `raw-text' or one of its
4407 val
= raw_text_coding_system (val
);
4410 val
= coding_inherit_eol_type (val
, eol_parent
);
4411 setup_coding_system (val
, coding
);
4413 if (!STRINGP (start
) && !NILP (current_buffer
->selective_display
))
4414 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4418 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4419 "r\nFWrite region to file: \ni\ni\ni\np",
4420 doc
: /* Write current region into specified file.
4421 When called from a program, requires three arguments:
4422 START, END and FILENAME. START and END are normally buffer positions
4423 specifying the part of the buffer to write.
4424 If START is nil, that means to use the entire buffer contents.
4425 If START is a string, then output that string to the file
4426 instead of any buffer contents; END is ignored.
4428 Optional fourth argument APPEND if non-nil means
4429 append to existing file contents (if any). If it is an integer,
4430 seek to that offset in the file before writing.
4431 Optional fifth argument VISIT, if t or a string, means
4432 set the last-save-file-modtime of buffer to this file's modtime
4433 and mark buffer not modified.
4434 If VISIT is a string, it is a second file name;
4435 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4436 VISIT is also the file name to lock and unlock for clash detection.
4437 If VISIT is neither t nor nil nor a string,
4438 that means do not display the \"Wrote file\" message.
4439 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4440 use for locking and unlocking, overriding FILENAME and VISIT.
4441 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4442 for an existing file with the same name. If MUSTBENEW is `excl',
4443 that means to get an error if the file already exists; never overwrite.
4444 If MUSTBENEW is neither nil nor `excl', that means ask for
4445 confirmation before overwriting, but do go ahead and overwrite the file
4446 if the user confirms.
4448 This does code conversion according to the value of
4449 `coding-system-for-write', `buffer-file-coding-system', or
4450 `file-coding-system-alist', and sets the variable
4451 `last-coding-system-used' to the coding system actually used.
4453 This calls `write-region-annotate-functions' at the start, and
4454 `write-region-post-annotation-function' at the end. */)
4455 (start
, end
, filename
, append
, visit
, lockname
, mustbenew
)
4456 Lisp_Object start
, end
, filename
, append
, visit
, lockname
, mustbenew
;
4461 const unsigned char *fn
;
4463 int count
= SPECPDL_INDEX ();
4465 Lisp_Object handler
;
4466 Lisp_Object visit_file
;
4467 Lisp_Object annotations
;
4468 Lisp_Object encoded_filename
;
4469 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4470 int quietly
= !NILP (visit
);
4471 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4472 struct buffer
*given_buffer
;
4474 int buffer_file_type
= O_BINARY
;
4476 struct coding_system coding
;
4478 if (current_buffer
->base_buffer
&& visiting
)
4479 error ("Cannot do file visiting in an indirect buffer");
4481 if (!NILP (start
) && !STRINGP (start
))
4482 validate_region (&start
, &end
);
4485 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4487 filename
= Fexpand_file_name (filename
, Qnil
);
4489 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4490 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4492 if (STRINGP (visit
))
4493 visit_file
= Fexpand_file_name (visit
, Qnil
);
4495 visit_file
= filename
;
4497 if (NILP (lockname
))
4498 lockname
= visit_file
;
4502 /* If the file name has special constructs in it,
4503 call the corresponding file handler. */
4504 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4505 /* If FILENAME has no handler, see if VISIT has one. */
4506 if (NILP (handler
) && STRINGP (visit
))
4507 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4509 if (!NILP (handler
))
4512 val
= call6 (handler
, Qwrite_region
, start
, end
,
4513 filename
, append
, visit
);
4517 SAVE_MODIFF
= MODIFF
;
4518 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4519 current_buffer
->filename
= visit_file
;
4525 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4527 /* Special kludge to simplify auto-saving. */
4530 /* Do it later, so write-region-annotate-function can work differently
4531 if we save "the buffer" vs "a region".
4532 This is useful in tar-mode. --Stef
4533 XSETFASTINT (start, BEG);
4534 XSETFASTINT (end, Z); */
4538 record_unwind_protect (build_annotations_unwind
,
4539 Vwrite_region_annotation_buffers
);
4540 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4541 count1
= SPECPDL_INDEX ();
4543 given_buffer
= current_buffer
;
4545 if (!STRINGP (start
))
4547 annotations
= build_annotations (start
, end
);
4549 if (current_buffer
!= given_buffer
)
4551 XSETFASTINT (start
, BEGV
);
4552 XSETFASTINT (end
, ZV
);
4558 XSETFASTINT (start
, BEGV
);
4559 XSETFASTINT (end
, ZV
);
4564 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4566 /* Decide the coding-system to encode the data with.
4567 We used to make this choice before calling build_annotations, but that
4568 leads to problems when a write-annotate-function takes care of
4569 unsavable chars (as was the case with X-Symbol). */
4570 Vlast_coding_system_used
4571 = choose_write_coding_system (start
, end
, filename
,
4572 append
, visit
, lockname
, &coding
);
4574 #ifdef CLASH_DETECTION
4576 lock_file (lockname
);
4577 #endif /* CLASH_DETECTION */
4579 encoded_filename
= ENCODE_FILE (filename
);
4581 fn
= SDATA (encoded_filename
);
4585 desc
= emacs_open (fn
, O_WRONLY
| buffer_file_type
, 0);
4586 #else /* not DOS_NT */
4587 desc
= emacs_open (fn
, O_WRONLY
, 0);
4588 #endif /* not DOS_NT */
4590 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4592 desc
= emacs_open (fn
,
4593 O_WRONLY
| O_CREAT
| buffer_file_type
4594 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4595 S_IREAD
| S_IWRITE
);
4596 #else /* not DOS_NT */
4597 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4598 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4599 auto_saving
? auto_save_mode_bits
: 0666);
4600 #endif /* not DOS_NT */
4604 #ifdef CLASH_DETECTION
4606 if (!auto_saving
) unlock_file (lockname
);
4608 #endif /* CLASH_DETECTION */
4610 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4613 record_unwind_protect (close_file_unwind
, make_number (desc
));
4615 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4619 if (NUMBERP (append
))
4620 ret
= lseek (desc
, XINT (append
), 1);
4622 ret
= lseek (desc
, 0, 2);
4625 #ifdef CLASH_DETECTION
4626 if (!auto_saving
) unlock_file (lockname
);
4627 #endif /* CLASH_DETECTION */
4629 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4638 if (STRINGP (start
))
4640 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4641 &annotations
, &coding
);
4644 else if (XINT (start
) != XINT (end
))
4646 failure
= 0 > a_write (desc
, Qnil
,
4647 XINT (start
), XINT (end
) - XINT (start
),
4648 &annotations
, &coding
);
4653 /* If file was empty, still need to write the annotations */
4654 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4655 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4659 if (CODING_REQUIRE_FLUSHING (&coding
)
4660 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4663 /* We have to flush out a data. */
4664 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4665 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4672 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4673 Disk full in NFS may be reported here. */
4674 /* mib says that closing the file will try to write as fast as NFS can do
4675 it, and that means the fsync here is not crucial for autosave files. */
4676 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4678 /* If fsync fails with EINTR, don't treat that as serious. Also
4679 ignore EINVAL which happens when fsync is not supported on this
4681 if (errno
!= EINTR
&& errno
!= EINVAL
)
4682 failure
= 1, save_errno
= errno
;
4686 /* NFS can report a write failure now. */
4687 if (emacs_close (desc
) < 0)
4688 failure
= 1, save_errno
= errno
;
4692 /* Discard the unwind protect for close_file_unwind. */
4693 specpdl_ptr
= specpdl
+ count1
;
4695 /* Call write-region-post-annotation-function. */
4696 while (CONSP (Vwrite_region_annotation_buffers
))
4698 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4699 if (!NILP (Fbuffer_live_p (buf
)))
4702 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4703 call0 (Vwrite_region_post_annotation_function
);
4705 Vwrite_region_annotation_buffers
4706 = XCDR (Vwrite_region_annotation_buffers
);
4709 unbind_to (count
, Qnil
);
4711 #ifdef CLASH_DETECTION
4713 unlock_file (lockname
);
4714 #endif /* CLASH_DETECTION */
4716 /* Do this before reporting IO error
4717 to avoid a "file has changed on disk" warning on
4718 next attempt to save. */
4720 current_buffer
->modtime
= st
.st_mtime
;
4723 error ("IO error writing %s: %s", SDATA (filename
),
4724 emacs_strerror (save_errno
));
4728 SAVE_MODIFF
= MODIFF
;
4729 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4730 current_buffer
->filename
= visit_file
;
4731 update_mode_lines
++;
4736 && ! NILP (Fstring_equal (current_buffer
->filename
,
4737 current_buffer
->auto_save_file_name
)))
4738 SAVE_MODIFF
= MODIFF
;
4744 message_with_string ((INTEGERP (append
)
4754 Lisp_Object
merge ();
4756 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4757 doc
: /* Return t if (car A) is numerically less than (car B). */)
4761 return Flss (Fcar (a
), Fcar (b
));
4764 /* Build the complete list of annotations appropriate for writing out
4765 the text between START and END, by calling all the functions in
4766 write-region-annotate-functions and merging the lists they return.
4767 If one of these functions switches to a different buffer, we assume
4768 that buffer contains altered text. Therefore, the caller must
4769 make sure to restore the current buffer in all cases,
4770 as save-excursion would do. */
4773 build_annotations (start
, end
)
4774 Lisp_Object start
, end
;
4776 Lisp_Object annotations
;
4778 struct gcpro gcpro1
, gcpro2
;
4779 Lisp_Object original_buffer
;
4780 int i
, used_global
= 0;
4782 XSETBUFFER (original_buffer
, current_buffer
);
4785 p
= Vwrite_region_annotate_functions
;
4786 GCPRO2 (annotations
, p
);
4789 struct buffer
*given_buffer
= current_buffer
;
4790 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4791 { /* Use the global value of the hook. */
4794 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4796 p
= Fappend (2, arg
);
4799 Vwrite_region_annotations_so_far
= annotations
;
4800 res
= call2 (XCAR (p
), start
, end
);
4801 /* If the function makes a different buffer current,
4802 assume that means this buffer contains altered text to be output.
4803 Reset START and END from the buffer bounds
4804 and discard all previous annotations because they should have
4805 been dealt with by this function. */
4806 if (current_buffer
!= given_buffer
)
4808 Vwrite_region_annotation_buffers
4809 = Fcons (Fcurrent_buffer (),
4810 Vwrite_region_annotation_buffers
);
4811 XSETFASTINT (start
, BEGV
);
4812 XSETFASTINT (end
, ZV
);
4815 Flength (res
); /* Check basic validity of return value */
4816 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4820 /* Now do the same for annotation functions implied by the file-format */
4821 if (auto_saving
&& (!EQ (current_buffer
->auto_save_file_format
, Qt
)))
4822 p
= current_buffer
->auto_save_file_format
;
4824 p
= current_buffer
->file_format
;
4825 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4827 struct buffer
*given_buffer
= current_buffer
;
4829 Vwrite_region_annotations_so_far
= annotations
;
4831 /* Value is either a list of annotations or nil if the function
4832 has written annotations to a temporary buffer, which is now
4834 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4835 original_buffer
, make_number (i
));
4836 if (current_buffer
!= given_buffer
)
4838 XSETFASTINT (start
, BEGV
);
4839 XSETFASTINT (end
, ZV
);
4844 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4852 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4853 If STRING is nil, POS is the character position in the current buffer.
4854 Intersperse with them the annotations from *ANNOT
4855 which fall within the range of POS to POS + NCHARS,
4856 each at its appropriate position.
4858 We modify *ANNOT by discarding elements as we use them up.
4860 The return value is negative in case of system call failure. */
4863 a_write (desc
, string
, pos
, nchars
, annot
, coding
)
4866 register int nchars
;
4869 struct coding_system
*coding
;
4873 int lastpos
= pos
+ nchars
;
4875 while (NILP (*annot
) || CONSP (*annot
))
4877 tem
= Fcar_safe (Fcar (*annot
));
4880 nextpos
= XFASTINT (tem
);
4882 /* If there are no more annotations in this range,
4883 output the rest of the range all at once. */
4884 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4885 return e_write (desc
, string
, pos
, lastpos
, coding
);
4887 /* Output buffer text up to the next annotation's position. */
4890 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4894 /* Output the annotation. */
4895 tem
= Fcdr (Fcar (*annot
));
4898 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4901 *annot
= Fcdr (*annot
);
4907 /* Write text in the range START and END into descriptor DESC,
4908 encoding them with coding system CODING. If STRING is nil, START
4909 and END are character positions of the current buffer, else they
4910 are indexes to the string STRING. */
4913 e_write (desc
, string
, start
, end
, coding
)
4917 struct coding_system
*coding
;
4919 if (STRINGP (string
))
4922 end
= SCHARS (string
);
4925 /* We used to have a code for handling selective display here. But,
4926 now it is handled within encode_coding. */
4930 if (STRINGP (string
))
4932 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
4933 if (CODING_REQUIRE_ENCODING (coding
))
4935 encode_coding_object (coding
, string
,
4936 start
, string_char_to_byte (string
, start
),
4937 end
, string_char_to_byte (string
, end
), Qt
);
4941 coding
->dst_object
= string
;
4942 coding
->consumed_char
= SCHARS (string
);
4943 coding
->produced
= SBYTES (string
);
4948 int start_byte
= CHAR_TO_BYTE (start
);
4949 int end_byte
= CHAR_TO_BYTE (end
);
4951 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
4952 if (CODING_REQUIRE_ENCODING (coding
))
4954 encode_coding_object (coding
, Fcurrent_buffer (),
4955 start
, start_byte
, end
, end_byte
, Qt
);
4959 coding
->dst_object
= Qnil
;
4960 coding
->dst_pos_byte
= start_byte
;
4961 if (start
>= GPT
|| end
<= GPT
)
4963 coding
->consumed_char
= end
- start
;
4964 coding
->produced
= end_byte
- start_byte
;
4968 coding
->consumed_char
= GPT
- start
;
4969 coding
->produced
= GPT_BYTE
- start_byte
;
4974 if (coding
->produced
> 0)
4978 STRINGP (coding
->dst_object
)
4979 ? SDATA (coding
->dst_object
)
4980 : BYTE_POS_ADDR (coding
->dst_pos_byte
),
4983 if (coding
->produced
)
4986 start
+= coding
->consumed_char
;
4992 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
4993 Sverify_visited_file_modtime
, 1, 1, 0,
4994 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
4995 This means that the file has not been changed since it was visited or saved.
4996 See Info node `(elisp)Modification Time' for more details. */)
5002 Lisp_Object handler
;
5003 Lisp_Object filename
;
5008 if (!STRINGP (b
->filename
)) return Qt
;
5009 if (b
->modtime
== 0) return Qt
;
5011 /* If the file name has special constructs in it,
5012 call the corresponding file handler. */
5013 handler
= Ffind_file_name_handler (b
->filename
,
5014 Qverify_visited_file_modtime
);
5015 if (!NILP (handler
))
5016 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5018 filename
= ENCODE_FILE (b
->filename
);
5020 if (stat (SDATA (filename
), &st
) < 0)
5022 /* If the file doesn't exist now and didn't exist before,
5023 we say that it isn't modified, provided the error is a tame one. */
5024 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
5029 if (st
.st_mtime
== b
->modtime
5030 /* If both are positive, accept them if they are off by one second. */
5031 || (st
.st_mtime
> 0 && b
->modtime
> 0
5032 && (st
.st_mtime
== b
->modtime
+ 1
5033 || st
.st_mtime
== b
->modtime
- 1)))
5038 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5039 Sclear_visited_file_modtime
, 0, 0, 0,
5040 doc
: /* Clear out records of last mod time of visited file.
5041 Next attempt to save will certainly not complain of a discrepancy. */)
5044 current_buffer
->modtime
= 0;
5048 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5049 Svisited_file_modtime
, 0, 0, 0,
5050 doc
: /* Return the current buffer's recorded visited file modification time.
5051 The value is a list of the form (HIGH LOW), like the time values
5052 that `file-attributes' returns. If the current buffer has no recorded
5053 file modification time, this function returns 0.
5054 See Info node `(elisp)Modification Time' for more details. */)
5057 if (! current_buffer
->modtime
)
5058 return make_number (0);
5059 return make_time ((time_t) current_buffer
->modtime
);
5062 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5063 Sset_visited_file_modtime
, 0, 1, 0,
5064 doc
: /* Update buffer's recorded modification time from the visited file's time.
5065 Useful if the buffer was not read from the file normally
5066 or if the file itself has been changed for some known benign reason.
5067 An argument specifies the modification time value to use
5068 \(instead of that of the visited file), in the form of a list
5069 \(HIGH . LOW) or (HIGH LOW). */)
5071 Lisp_Object time_list
;
5073 if (!NILP (time_list
))
5074 current_buffer
->modtime
= cons_to_long (time_list
);
5077 register Lisp_Object filename
;
5079 Lisp_Object handler
;
5081 filename
= Fexpand_file_name (current_buffer
->filename
, Qnil
);
5083 /* If the file name has special constructs in it,
5084 call the corresponding file handler. */
5085 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5086 if (!NILP (handler
))
5087 /* The handler can find the file name the same way we did. */
5088 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5090 filename
= ENCODE_FILE (filename
);
5092 if (stat (SDATA (filename
), &st
) >= 0)
5093 current_buffer
->modtime
= st
.st_mtime
;
5100 auto_save_error (error
)
5103 Lisp_Object args
[3], msg
;
5105 struct gcpro gcpro1
;
5109 auto_save_error_occurred
= 1;
5111 ring_bell (XFRAME (selected_frame
));
5113 args
[0] = build_string ("Auto-saving %s: %s");
5114 args
[1] = current_buffer
->name
;
5115 args
[2] = Ferror_message_string (error
);
5116 msg
= Fformat (3, args
);
5118 nbytes
= SBYTES (msg
);
5119 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5120 bcopy (SDATA (msg
), msgbuf
, nbytes
);
5122 for (i
= 0; i
< 3; ++i
)
5125 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5127 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5128 Fsleep_for (make_number (1), Qnil
);
5142 auto_save_mode_bits
= 0666;
5144 /* Get visited file's mode to become the auto save file's mode. */
5145 if (! NILP (current_buffer
->filename
))
5147 if (stat (SDATA (current_buffer
->filename
), &st
) >= 0)
5148 /* But make sure we can overwrite it later! */
5149 auto_save_mode_bits
= st
.st_mode
| 0600;
5150 else if ((modes
= Ffile_modes (current_buffer
->filename
),
5152 /* Remote files don't cooperate with stat. */
5153 auto_save_mode_bits
= XINT (modes
) | 0600;
5157 Fwrite_region (Qnil
, Qnil
, current_buffer
->auto_save_file_name
, Qnil
,
5158 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5163 do_auto_save_unwind (arg
) /* used as unwind-protect function */
5166 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5178 do_auto_save_unwind_1 (value
) /* used as unwind-protect function */
5181 minibuffer_auto_raise
= XINT (value
);
5186 do_auto_save_make_dir (dir
)
5191 call2 (Qmake_directory
, dir
, Qt
);
5192 XSETFASTINT (mode
, 0700);
5193 return Fset_file_modes (dir
, mode
);
5197 do_auto_save_eh (ignore
)
5203 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5204 doc
: /* Auto-save all buffers that need it.
5205 This is all buffers that have auto-saving enabled
5206 and are changed since last auto-saved.
5207 Auto-saving writes the buffer into a file
5208 so that your editing is not lost if the system crashes.
5209 This file is not the file you visited; that changes only when you save.
5210 Normally we run the normal hook `auto-save-hook' before saving.
5212 A non-nil NO-MESSAGE argument means do not print any message if successful.
5213 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5214 (no_message
, current_only
)
5215 Lisp_Object no_message
, current_only
;
5217 struct buffer
*old
= current_buffer
, *b
;
5218 Lisp_Object tail
, buf
;
5220 int do_handled_files
;
5222 FILE *stream
= NULL
;
5223 int count
= SPECPDL_INDEX ();
5224 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5225 int old_message_p
= 0;
5226 struct gcpro gcpro1
, gcpro2
;
5228 if (max_specpdl_size
< specpdl_size
+ 40)
5229 max_specpdl_size
= specpdl_size
+ 40;
5234 if (NILP (no_message
))
5236 old_message_p
= push_message ();
5237 record_unwind_protect (pop_message_unwind
, Qnil
);
5240 /* Ordinarily don't quit within this function,
5241 but don't make it impossible to quit (in case we get hung in I/O). */
5245 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5246 point to non-strings reached from Vbuffer_alist. */
5248 if (!NILP (Vrun_hooks
))
5249 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5251 if (STRINGP (Vauto_save_list_file_name
))
5253 Lisp_Object listfile
;
5255 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5257 /* Don't try to create the directory when shutting down Emacs,
5258 because creating the directory might signal an error, and
5259 that would leave Emacs in a strange state. */
5260 if (!NILP (Vrun_hooks
))
5264 GCPRO2 (dir
, listfile
);
5265 dir
= Ffile_name_directory (listfile
);
5266 if (NILP (Ffile_directory_p (dir
)))
5267 internal_condition_case_1 (do_auto_save_make_dir
,
5268 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5273 stream
= fopen (SDATA (listfile
), "w");
5276 record_unwind_protect (do_auto_save_unwind
,
5277 make_save_value (stream
, 0));
5278 record_unwind_protect (do_auto_save_unwind_1
,
5279 make_number (minibuffer_auto_raise
));
5280 minibuffer_auto_raise
= 0;
5282 auto_save_error_occurred
= 0;
5284 /* On first pass, save all files that don't have handlers.
5285 On second pass, save all files that do have handlers.
5287 If Emacs is crashing, the handlers may tweak what is causing
5288 Emacs to crash in the first place, and it would be a shame if
5289 Emacs failed to autosave perfectly ordinary files because it
5290 couldn't handle some ange-ftp'd file. */
5292 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5293 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5295 buf
= XCDR (XCAR (tail
));
5298 /* Record all the buffers that have auto save mode
5299 in the special file that lists them. For each of these buffers,
5300 Record visited name (if any) and auto save name. */
5301 if (STRINGP (b
->auto_save_file_name
)
5302 && stream
!= NULL
&& do_handled_files
== 0)
5305 if (!NILP (b
->filename
))
5307 fwrite (SDATA (b
->filename
), 1,
5308 SBYTES (b
->filename
), stream
);
5310 putc ('\n', stream
);
5311 fwrite (SDATA (b
->auto_save_file_name
), 1,
5312 SBYTES (b
->auto_save_file_name
), stream
);
5313 putc ('\n', stream
);
5317 if (!NILP (current_only
)
5318 && b
!= current_buffer
)
5321 /* Don't auto-save indirect buffers.
5322 The base buffer takes care of it. */
5326 /* Check for auto save enabled
5327 and file changed since last auto save
5328 and file changed since last real save. */
5329 if (STRINGP (b
->auto_save_file_name
)
5330 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5331 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5332 /* -1 means we've turned off autosaving for a while--see below. */
5333 && XINT (b
->save_length
) >= 0
5334 && (do_handled_files
5335 || NILP (Ffind_file_name_handler (b
->auto_save_file_name
,
5338 EMACS_TIME before_time
, after_time
;
5340 EMACS_GET_TIME (before_time
);
5342 /* If we had a failure, don't try again for 20 minutes. */
5343 if (b
->auto_save_failure_time
>= 0
5344 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5347 set_buffer_internal (b
);
5348 if (NILP (Vauto_save_include_big_deletions
)
5349 && (XFASTINT (b
->save_length
) * 10
5350 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5351 /* A short file is likely to change a large fraction;
5352 spare the user annoying messages. */
5353 && XFASTINT (b
->save_length
) > 5000
5354 /* These messages are frequent and annoying for `*mail*'. */
5355 && !EQ (b
->filename
, Qnil
)
5356 && NILP (no_message
))
5358 /* It has shrunk too much; turn off auto-saving here. */
5359 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5360 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5362 minibuffer_auto_raise
= 0;
5363 /* Turn off auto-saving until there's a real save,
5364 and prevent any more warnings. */
5365 XSETINT (b
->save_length
, -1);
5366 Fsleep_for (make_number (1), Qnil
);
5369 if (!auto_saved
&& NILP (no_message
))
5370 message1 ("Auto-saving...");
5371 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5373 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5374 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5375 set_buffer_internal (old
);
5377 EMACS_GET_TIME (after_time
);
5379 /* If auto-save took more than 60 seconds,
5380 assume it was an NFS failure that got a timeout. */
5381 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5382 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5386 /* Prevent another auto save till enough input events come in. */
5387 record_auto_save ();
5389 if (auto_saved
&& NILP (no_message
))
5393 /* If we are going to restore an old message,
5394 give time to read ours. */
5395 sit_for (make_number (1), 0, 0);
5398 else if (!auto_save_error_occurred
)
5399 /* Don't overwrite the error message if an error occurred.
5400 If we displayed a message and then restored a state
5401 with no message, leave a "done" message on the screen. */
5402 message1 ("Auto-saving...done");
5407 /* This restores the message-stack status. */
5408 unbind_to (count
, Qnil
);
5412 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5413 Sset_buffer_auto_saved
, 0, 0, 0,
5414 doc
: /* Mark current buffer as auto-saved with its current text.
5415 No auto-save file will be written until the buffer changes again. */)
5418 /* FIXME: This should not be called in indirect buffers, since
5419 they're not autosaved. */
5420 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5421 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5422 current_buffer
->auto_save_failure_time
= -1;
5426 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5427 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5428 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5431 current_buffer
->auto_save_failure_time
= -1;
5435 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5437 doc
: /* Return t if current buffer has been auto-saved recently.
5438 More precisely, if it has been auto-saved since last read from or saved
5439 in the visited file. If the buffer has no visited file,
5440 then any auto-save counts as "recent". */)
5443 /* FIXME: maybe we should return nil for indirect buffers since
5444 they're never autosaved. */
5445 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5448 /* Reading and completing file names */
5450 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5451 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5452 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5453 The return value is only relevant for a call to `read-file-name' that happens
5454 before any other event (mouse or keypress) is handled. */)
5457 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5458 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5468 Fread_file_name (prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
)
5469 Lisp_Object prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
;
5471 struct gcpro gcpro1
, gcpro2
;
5472 Lisp_Object args
[7];
5474 GCPRO1 (default_filename
);
5475 args
[0] = intern ("read-file-name");
5478 args
[3] = default_filename
;
5479 args
[4] = mustmatch
;
5481 args
[6] = predicate
;
5482 RETURN_UNGCPRO (Ffuncall (7, args
));
5489 Qoperations
= intern_c_string ("operations");
5490 Qexpand_file_name
= intern_c_string ("expand-file-name");
5491 Qsubstitute_in_file_name
= intern_c_string ("substitute-in-file-name");
5492 Qdirectory_file_name
= intern_c_string ("directory-file-name");
5493 Qfile_name_directory
= intern_c_string ("file-name-directory");
5494 Qfile_name_nondirectory
= intern_c_string ("file-name-nondirectory");
5495 Qunhandled_file_name_directory
= intern_c_string ("unhandled-file-name-directory");
5496 Qfile_name_as_directory
= intern_c_string ("file-name-as-directory");
5497 Qcopy_file
= intern_c_string ("copy-file");
5498 Qmake_directory_internal
= intern_c_string ("make-directory-internal");
5499 Qmake_directory
= intern_c_string ("make-directory");
5500 Qdelete_directory_internal
= intern_c_string ("delete-directory-internal");
5501 Qdelete_file
= intern_c_string ("delete-file");
5502 Qrename_file
= intern_c_string ("rename-file");
5503 Qadd_name_to_file
= intern_c_string ("add-name-to-file");
5504 Qmake_symbolic_link
= intern_c_string ("make-symbolic-link");
5505 Qfile_exists_p
= intern_c_string ("file-exists-p");
5506 Qfile_executable_p
= intern_c_string ("file-executable-p");
5507 Qfile_readable_p
= intern_c_string ("file-readable-p");
5508 Qfile_writable_p
= intern_c_string ("file-writable-p");
5509 Qfile_symlink_p
= intern_c_string ("file-symlink-p");
5510 Qaccess_file
= intern_c_string ("access-file");
5511 Qfile_directory_p
= intern_c_string ("file-directory-p");
5512 Qfile_regular_p
= intern_c_string ("file-regular-p");
5513 Qfile_accessible_directory_p
= intern_c_string ("file-accessible-directory-p");
5514 Qfile_modes
= intern_c_string ("file-modes");
5515 Qset_file_modes
= intern_c_string ("set-file-modes");
5516 Qset_file_times
= intern_c_string ("set-file-times");
5517 Qfile_newer_than_file_p
= intern_c_string ("file-newer-than-file-p");
5518 Qinsert_file_contents
= intern_c_string ("insert-file-contents");
5519 Qwrite_region
= intern_c_string ("write-region");
5520 Qverify_visited_file_modtime
= intern_c_string ("verify-visited-file-modtime");
5521 Qset_visited_file_modtime
= intern_c_string ("set-visited-file-modtime");
5522 Qauto_save_coding
= intern_c_string ("auto-save-coding");
5524 staticpro (&Qoperations
);
5525 staticpro (&Qexpand_file_name
);
5526 staticpro (&Qsubstitute_in_file_name
);
5527 staticpro (&Qdirectory_file_name
);
5528 staticpro (&Qfile_name_directory
);
5529 staticpro (&Qfile_name_nondirectory
);
5530 staticpro (&Qunhandled_file_name_directory
);
5531 staticpro (&Qfile_name_as_directory
);
5532 staticpro (&Qcopy_file
);
5533 staticpro (&Qmake_directory_internal
);
5534 staticpro (&Qmake_directory
);
5535 staticpro (&Qdelete_directory_internal
);
5536 staticpro (&Qdelete_file
);
5537 staticpro (&Qrename_file
);
5538 staticpro (&Qadd_name_to_file
);
5539 staticpro (&Qmake_symbolic_link
);
5540 staticpro (&Qfile_exists_p
);
5541 staticpro (&Qfile_executable_p
);
5542 staticpro (&Qfile_readable_p
);
5543 staticpro (&Qfile_writable_p
);
5544 staticpro (&Qaccess_file
);
5545 staticpro (&Qfile_symlink_p
);
5546 staticpro (&Qfile_directory_p
);
5547 staticpro (&Qfile_regular_p
);
5548 staticpro (&Qfile_accessible_directory_p
);
5549 staticpro (&Qfile_modes
);
5550 staticpro (&Qset_file_modes
);
5551 staticpro (&Qset_file_times
);
5552 staticpro (&Qfile_newer_than_file_p
);
5553 staticpro (&Qinsert_file_contents
);
5554 staticpro (&Qwrite_region
);
5555 staticpro (&Qverify_visited_file_modtime
);
5556 staticpro (&Qset_visited_file_modtime
);
5557 staticpro (&Qauto_save_coding
);
5559 Qfile_name_history
= intern_c_string ("file-name-history");
5560 Fset (Qfile_name_history
, Qnil
);
5561 staticpro (&Qfile_name_history
);
5563 Qfile_error
= intern_c_string ("file-error");
5564 staticpro (&Qfile_error
);
5565 Qfile_already_exists
= intern_c_string ("file-already-exists");
5566 staticpro (&Qfile_already_exists
);
5567 Qfile_date_error
= intern_c_string ("file-date-error");
5568 staticpro (&Qfile_date_error
);
5569 Qexcl
= intern_c_string ("excl");
5573 Qfind_buffer_file_type
= intern_c_string ("find-buffer-file-type");
5574 staticpro (&Qfind_buffer_file_type
);
5577 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system
,
5578 doc
: /* *Coding system for encoding file names.
5579 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5580 Vfile_name_coding_system
= Qnil
;
5582 DEFVAR_LISP ("default-file-name-coding-system",
5583 &Vdefault_file_name_coding_system
,
5584 doc
: /* Default coding system for encoding file names.
5585 This variable is used only when `file-name-coding-system' is nil.
5587 This variable is set/changed by the command `set-language-environment'.
5588 User should not set this variable manually,
5589 instead use `file-name-coding-system' to get a constant encoding
5590 of file names regardless of the current language environment. */);
5591 Vdefault_file_name_coding_system
= Qnil
;
5593 Qformat_decode
= intern_c_string ("format-decode");
5594 staticpro (&Qformat_decode
);
5595 Qformat_annotate_function
= intern_c_string ("format-annotate-function");
5596 staticpro (&Qformat_annotate_function
);
5597 Qafter_insert_file_set_coding
= intern_c_string ("after-insert-file-set-coding");
5598 staticpro (&Qafter_insert_file_set_coding
);
5600 Qcar_less_than_car
= intern_c_string ("car-less-than-car");
5601 staticpro (&Qcar_less_than_car
);
5603 Fput (Qfile_error
, Qerror_conditions
,
5604 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5605 Fput (Qfile_error
, Qerror_message
,
5606 make_pure_c_string ("File error"));
5608 Fput (Qfile_already_exists
, Qerror_conditions
,
5609 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5610 Fput (Qfile_already_exists
, Qerror_message
,
5611 make_pure_c_string ("File already exists"));
5613 Fput (Qfile_date_error
, Qerror_conditions
,
5614 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5615 Fput (Qfile_date_error
, Qerror_message
,
5616 make_pure_c_string ("Cannot set file date"));
5618 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char
,
5619 doc
: /* Directory separator character for built-in functions that return file names.
5620 The value is always ?/. Don't use this variable, just use `/'. */);
5621 XSETFASTINT (Vdirectory_sep_char
, '/');
5623 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist
,
5624 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
5625 If a file name matches REGEXP, then all I/O on that file is done by calling
5628 The first argument given to HANDLER is the name of the I/O primitive
5629 to be handled; the remaining arguments are the arguments that were
5630 passed to that primitive. For example, if you do
5631 (file-exists-p FILENAME)
5632 and FILENAME is handled by HANDLER, then HANDLER is called like this:
5633 (funcall HANDLER 'file-exists-p FILENAME)
5634 The function `find-file-name-handler' checks this list for a handler
5635 for its argument. */);
5636 Vfile_name_handler_alist
= Qnil
;
5638 DEFVAR_LISP ("set-auto-coding-function",
5639 &Vset_auto_coding_function
,
5640 doc
: /* If non-nil, a function to call to decide a coding system of file.
5641 Two arguments are passed to this function: the file name
5642 and the length of a file contents following the point.
5643 This function should return a coding system to decode the file contents.
5644 It should check the file name against `auto-coding-alist'.
5645 If no coding system is decided, it should check a coding system
5646 specified in the heading lines with the format:
5647 -*- ... coding: CODING-SYSTEM; ... -*-
5648 or local variable spec of the tailing lines with `coding:' tag. */);
5649 Vset_auto_coding_function
= Qnil
;
5651 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions
,
5652 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5653 Each is passed one argument, the number of characters inserted,
5654 with point at the start of the inserted text. Each function
5655 should leave point the same, and return the new character count.
5656 If `insert-file-contents' is intercepted by a handler from
5657 `file-name-handler-alist', that handler is responsible for calling the
5658 functions in `after-insert-file-functions' if appropriate. */);
5659 Vafter_insert_file_functions
= Qnil
;
5661 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions
,
5662 doc
: /* A list of functions to be called at the start of `write-region'.
5663 Each is passed two arguments, START and END as for `write-region'.
5664 These are usually two numbers but not always; see the documentation
5665 for `write-region'. The function should return a list of pairs
5666 of the form (POSITION . STRING), consisting of strings to be effectively
5667 inserted at the specified positions of the file being written (1 means to
5668 insert before the first byte written). The POSITIONs must be sorted into
5671 If there are several annotation functions, the lists returned by these
5672 functions are merged destructively. As each annotation function runs,
5673 the variable `write-region-annotations-so-far' contains a list of all
5674 annotations returned by previous annotation functions.
5676 An annotation function can return with a different buffer current.
5677 Doing so removes the annotations returned by previous functions, and
5678 resets START and END to `point-min' and `point-max' of the new buffer.
5680 After `write-region' completes, Emacs calls the function stored in
5681 `write-region-post-annotation-function', once for each buffer that was
5682 current when building the annotations (i.e., at least once), with that
5683 buffer current. */);
5684 Vwrite_region_annotate_functions
= Qnil
;
5685 staticpro (&Qwrite_region_annotate_functions
);
5686 Qwrite_region_annotate_functions
5687 = intern_c_string ("write-region-annotate-functions");
5689 DEFVAR_LISP ("write-region-post-annotation-function",
5690 &Vwrite_region_post_annotation_function
,
5691 doc
: /* Function to call after `write-region' completes.
5692 The function is called with no arguments. If one or more of the
5693 annotation functions in `write-region-annotate-functions' changed the
5694 current buffer, the function stored in this variable is called for
5695 each of those additional buffers as well, in addition to the original
5696 buffer. The relevant buffer is current during each function call. */);
5697 Vwrite_region_post_annotation_function
= Qnil
;
5698 staticpro (&Vwrite_region_annotation_buffers
);
5700 DEFVAR_LISP ("write-region-annotations-so-far",
5701 &Vwrite_region_annotations_so_far
,
5702 doc
: /* When an annotation function is called, this holds the previous annotations.
5703 These are the annotations made by other annotation functions
5704 that were already called. See also `write-region-annotate-functions'. */);
5705 Vwrite_region_annotations_so_far
= Qnil
;
5707 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers
,
5708 doc
: /* A list of file name handlers that temporarily should not be used.
5709 This applies only to the operation `inhibit-file-name-operation'. */);
5710 Vinhibit_file_name_handlers
= Qnil
;
5712 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation
,
5713 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5714 Vinhibit_file_name_operation
= Qnil
;
5716 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name
,
5717 doc
: /* File name in which we write a list of all auto save file names.
5718 This variable is initialized automatically from `auto-save-list-file-prefix'
5719 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5720 a non-nil value. */);
5721 Vauto_save_list_file_name
= Qnil
;
5723 DEFVAR_LISP ("auto-save-visited-file-name", &Vauto_save_visited_file_name
,
5724 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5725 Normally auto-save files are written under other names. */);
5726 Vauto_save_visited_file_name
= Qnil
;
5728 DEFVAR_LISP ("auto-save-include-big-deletions", &Vauto_save_include_big_deletions
,
5729 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5730 If nil, deleting a substantial portion of the text disables auto-save
5731 in the buffer; this is the default behavior, because the auto-save
5732 file is usually more useful if it contains the deleted text. */);
5733 Vauto_save_include_big_deletions
= Qnil
;
5736 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync
,
5737 doc
: /* *Non-nil means don't call fsync in `write-region'.
5738 This variable affects calls to `write-region' as well as save commands.
5739 A non-nil value may result in data loss! */);
5740 write_region_inhibit_fsync
= 0;
5743 DEFVAR_BOOL ("delete-by-moving-to-trash", &delete_by_moving_to_trash
,
5744 doc
: /* Specifies whether to use the system's trash can.
5745 When non-nil, the function `move-file-to-trash' will be used by
5746 `delete-file' and `delete-directory'. */);
5747 delete_by_moving_to_trash
= 0;
5748 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5749 Qmove_file_to_trash
= intern_c_string ("move-file-to-trash");
5750 staticpro (&Qmove_file_to_trash
);
5751 Qcopy_directory
= intern_c_string ("copy-directory");
5752 staticpro (&Qcopy_directory
);
5753 Qdelete_directory
= intern_c_string ("delete-directory");
5754 staticpro (&Qdelete_directory
);
5756 defsubr (&Sfind_file_name_handler
);
5757 defsubr (&Sfile_name_directory
);
5758 defsubr (&Sfile_name_nondirectory
);
5759 defsubr (&Sunhandled_file_name_directory
);
5760 defsubr (&Sfile_name_as_directory
);
5761 defsubr (&Sdirectory_file_name
);
5762 defsubr (&Smake_temp_name
);
5763 defsubr (&Sexpand_file_name
);
5764 defsubr (&Ssubstitute_in_file_name
);
5765 defsubr (&Scopy_file
);
5766 defsubr (&Smake_directory_internal
);
5767 defsubr (&Sdelete_directory_internal
);
5768 defsubr (&Sdelete_file
);
5769 defsubr (&Srename_file
);
5770 defsubr (&Sadd_name_to_file
);
5771 defsubr (&Smake_symbolic_link
);
5772 defsubr (&Sfile_name_absolute_p
);
5773 defsubr (&Sfile_exists_p
);
5774 defsubr (&Sfile_executable_p
);
5775 defsubr (&Sfile_readable_p
);
5776 defsubr (&Sfile_writable_p
);
5777 defsubr (&Saccess_file
);
5778 defsubr (&Sfile_symlink_p
);
5779 defsubr (&Sfile_directory_p
);
5780 defsubr (&Sfile_accessible_directory_p
);
5781 defsubr (&Sfile_regular_p
);
5782 defsubr (&Sfile_modes
);
5783 defsubr (&Sset_file_modes
);
5784 defsubr (&Sset_file_times
);
5785 defsubr (&Sset_default_file_modes
);
5786 defsubr (&Sdefault_file_modes
);
5787 defsubr (&Sfile_newer_than_file_p
);
5788 defsubr (&Sinsert_file_contents
);
5789 defsubr (&Swrite_region
);
5790 defsubr (&Scar_less_than_car
);
5791 defsubr (&Sverify_visited_file_modtime
);
5792 defsubr (&Sclear_visited_file_modtime
);
5793 defsubr (&Svisited_file_modtime
);
5794 defsubr (&Sset_visited_file_modtime
);
5795 defsubr (&Sdo_auto_save
);
5796 defsubr (&Sset_buffer_auto_saved
);
5797 defsubr (&Sclear_buffer_auto_save_failure
);
5798 defsubr (&Srecent_auto_save_p
);
5800 defsubr (&Snext_read_file_uses_dialog_p
);
5803 defsubr (&Sunix_sync
);
5807 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
5808 (do not change this comment) */