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
);
2303 if (!NILP (Ffile_directory_p (file
)))
2304 call2 (Qdelete_directory
, file
, Qt
);
2306 Fdelete_file (file
);
2307 unbind_to (count
, Qnil
);
2310 report_file_error ("Renaming", list2 (file
, newname
));
2316 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2317 "fAdd name to file: \nGName to add to %s: \np",
2318 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2319 Signals a `file-already-exists' error if a file NEWNAME already exists
2320 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2321 A number as third arg means request confirmation if NEWNAME already exists.
2322 This is what happens in interactive use with M-x. */)
2323 (file
, newname
, ok_if_already_exists
)
2324 Lisp_Object file
, newname
, ok_if_already_exists
;
2326 Lisp_Object handler
;
2327 Lisp_Object encoded_file
, encoded_newname
;
2328 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2330 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2331 encoded_file
= encoded_newname
= Qnil
;
2332 CHECK_STRING (file
);
2333 CHECK_STRING (newname
);
2334 file
= Fexpand_file_name (file
, Qnil
);
2336 if (!NILP (Ffile_directory_p (newname
)))
2337 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2339 newname
= Fexpand_file_name (newname
, Qnil
);
2341 /* If the file name has special constructs in it,
2342 call the corresponding file handler. */
2343 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2344 if (!NILP (handler
))
2345 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2346 newname
, ok_if_already_exists
));
2348 /* If the new name has special constructs in it,
2349 call the corresponding file handler. */
2350 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2351 if (!NILP (handler
))
2352 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2353 newname
, ok_if_already_exists
));
2355 encoded_file
= ENCODE_FILE (file
);
2356 encoded_newname
= ENCODE_FILE (newname
);
2358 if (NILP (ok_if_already_exists
)
2359 || INTEGERP (ok_if_already_exists
))
2360 barf_or_query_if_file_exists (newname
, "make it a new name",
2361 INTEGERP (ok_if_already_exists
), 0, 0);
2363 unlink (SDATA (newname
));
2364 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
)))
2365 report_file_error ("Adding new name", list2 (file
, newname
));
2371 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2372 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2373 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2374 Both args must be strings.
2375 Signals a `file-already-exists' error if a file LINKNAME already exists
2376 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2377 A number as third arg means request confirmation if LINKNAME already exists.
2378 This happens for interactive use with M-x. */)
2379 (filename
, linkname
, ok_if_already_exists
)
2380 Lisp_Object filename
, linkname
, ok_if_already_exists
;
2382 Lisp_Object handler
;
2383 Lisp_Object encoded_filename
, encoded_linkname
;
2384 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2386 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2387 encoded_filename
= encoded_linkname
= Qnil
;
2388 CHECK_STRING (filename
);
2389 CHECK_STRING (linkname
);
2390 /* If the link target has a ~, we must expand it to get
2391 a truly valid file name. Otherwise, do not expand;
2392 we want to permit links to relative file names. */
2393 if (SREF (filename
, 0) == '~')
2394 filename
= Fexpand_file_name (filename
, Qnil
);
2396 if (!NILP (Ffile_directory_p (linkname
)))
2397 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2399 linkname
= Fexpand_file_name (linkname
, Qnil
);
2401 /* If the file name has special constructs in it,
2402 call the corresponding file handler. */
2403 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2404 if (!NILP (handler
))
2405 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2406 linkname
, ok_if_already_exists
));
2408 /* If the new link name has special constructs in it,
2409 call the corresponding file handler. */
2410 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2411 if (!NILP (handler
))
2412 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2413 linkname
, ok_if_already_exists
));
2416 encoded_filename
= ENCODE_FILE (filename
);
2417 encoded_linkname
= ENCODE_FILE (linkname
);
2419 if (NILP (ok_if_already_exists
)
2420 || INTEGERP (ok_if_already_exists
))
2421 barf_or_query_if_file_exists (linkname
, "make it a link",
2422 INTEGERP (ok_if_already_exists
), 0, 0);
2423 if (0 > symlink (SDATA (encoded_filename
),
2424 SDATA (encoded_linkname
)))
2426 /* If we didn't complain already, silently delete existing file. */
2427 if (errno
== EEXIST
)
2429 unlink (SDATA (encoded_linkname
));
2430 if (0 <= symlink (SDATA (encoded_filename
),
2431 SDATA (encoded_linkname
)))
2438 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2445 xsignal1 (Qfile_error
, build_string ("Symbolic links are not supported"));
2447 #endif /* S_IFLNK */
2451 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2453 doc
: /* Return t if file FILENAME specifies an absolute file name.
2454 On Unix, this is a name starting with a `/' or a `~'. */)
2456 Lisp_Object filename
;
2458 CHECK_STRING (filename
);
2459 return file_name_absolute_p (SDATA (filename
)) ? Qt
: Qnil
;
2462 /* Return nonzero if file FILENAME exists and can be executed. */
2465 check_executable (filename
)
2469 int len
= strlen (filename
);
2472 if (stat (filename
, &st
) < 0)
2474 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
2475 return ((st
.st_mode
& S_IEXEC
) != 0);
2477 return (S_ISREG (st
.st_mode
)
2479 && (xstrcasecmp ((suffix
= filename
+ len
-4), ".com") == 0
2480 || xstrcasecmp (suffix
, ".exe") == 0
2481 || xstrcasecmp (suffix
, ".bat") == 0)
2482 || (st
.st_mode
& S_IFMT
) == S_IFDIR
);
2483 #endif /* not WINDOWSNT */
2484 #else /* not DOS_NT */
2485 #ifdef HAVE_EUIDACCESS
2486 return (euidaccess (filename
, 1) >= 0);
2488 /* Access isn't quite right because it uses the real uid
2489 and we really want to test with the effective uid.
2490 But Unix doesn't give us a right way to do it. */
2491 return (access (filename
, 1) >= 0);
2493 #endif /* not DOS_NT */
2496 /* Return nonzero if file FILENAME exists and can be written. */
2499 check_writable (filename
)
2504 if (stat (filename
, &st
) < 0)
2506 return (st
.st_mode
& S_IWRITE
|| (st
.st_mode
& S_IFMT
) == S_IFDIR
);
2507 #else /* not MSDOS */
2508 #ifdef HAVE_EUIDACCESS
2509 return (euidaccess (filename
, 2) >= 0);
2511 /* Access isn't quite right because it uses the real uid
2512 and we really want to test with the effective uid.
2513 But Unix doesn't give us a right way to do it.
2514 Opening with O_WRONLY could work for an ordinary file,
2515 but would lose for directories. */
2516 return (access (filename
, 2) >= 0);
2518 #endif /* not MSDOS */
2521 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2522 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2523 See also `file-readable-p' and `file-attributes'.
2524 This returns nil for a symlink to a nonexistent file.
2525 Use `file-symlink-p' to test for such links. */)
2527 Lisp_Object filename
;
2529 Lisp_Object absname
;
2530 Lisp_Object handler
;
2531 struct stat statbuf
;
2533 CHECK_STRING (filename
);
2534 absname
= Fexpand_file_name (filename
, Qnil
);
2536 /* If the file name has special constructs in it,
2537 call the corresponding file handler. */
2538 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2539 if (!NILP (handler
))
2540 return call2 (handler
, Qfile_exists_p
, absname
);
2542 absname
= ENCODE_FILE (absname
);
2544 return (stat (SDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2547 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2548 doc
: /* Return t if FILENAME can be executed by you.
2549 For a directory, this means you can access files in that directory. */)
2551 Lisp_Object filename
;
2553 Lisp_Object absname
;
2554 Lisp_Object handler
;
2556 CHECK_STRING (filename
);
2557 absname
= Fexpand_file_name (filename
, Qnil
);
2559 /* If the file name has special constructs in it,
2560 call the corresponding file handler. */
2561 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2562 if (!NILP (handler
))
2563 return call2 (handler
, Qfile_executable_p
, absname
);
2565 absname
= ENCODE_FILE (absname
);
2567 return (check_executable (SDATA (absname
)) ? Qt
: Qnil
);
2570 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2571 doc
: /* Return t if file FILENAME exists and you can read it.
2572 See also `file-exists-p' and `file-attributes'. */)
2574 Lisp_Object filename
;
2576 Lisp_Object absname
;
2577 Lisp_Object handler
;
2580 struct stat statbuf
;
2582 CHECK_STRING (filename
);
2583 absname
= Fexpand_file_name (filename
, Qnil
);
2585 /* If the file name has special constructs in it,
2586 call the corresponding file handler. */
2587 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2588 if (!NILP (handler
))
2589 return call2 (handler
, Qfile_readable_p
, absname
);
2591 absname
= ENCODE_FILE (absname
);
2593 #if defined(DOS_NT) || defined(macintosh)
2594 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2596 if (access (SDATA (absname
), 0) == 0)
2599 #else /* not DOS_NT and not macintosh */
2601 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
2602 /* Opening a fifo without O_NONBLOCK can wait.
2603 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2604 except in the case of a fifo, on a system which handles it. */
2605 desc
= stat (SDATA (absname
), &statbuf
);
2608 if (S_ISFIFO (statbuf
.st_mode
))
2609 flags
|= O_NONBLOCK
;
2611 desc
= emacs_open (SDATA (absname
), flags
, 0);
2616 #endif /* not DOS_NT and not macintosh */
2619 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2621 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2622 doc
: /* Return t if file FILENAME can be written or created by you. */)
2624 Lisp_Object filename
;
2626 Lisp_Object absname
, dir
, encoded
;
2627 Lisp_Object handler
;
2628 struct stat statbuf
;
2630 CHECK_STRING (filename
);
2631 absname
= Fexpand_file_name (filename
, Qnil
);
2633 /* If the file name has special constructs in it,
2634 call the corresponding file handler. */
2635 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2636 if (!NILP (handler
))
2637 return call2 (handler
, Qfile_writable_p
, absname
);
2639 encoded
= ENCODE_FILE (absname
);
2640 if (stat (SDATA (encoded
), &statbuf
) >= 0)
2641 return (check_writable (SDATA (encoded
))
2644 dir
= Ffile_name_directory (absname
);
2647 dir
= Fdirectory_file_name (dir
);
2650 dir
= ENCODE_FILE (dir
);
2652 /* The read-only attribute of the parent directory doesn't affect
2653 whether a file or directory can be created within it. Some day we
2654 should check ACLs though, which do affect this. */
2655 if (stat (SDATA (dir
), &statbuf
) < 0)
2657 return (statbuf
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2659 return (check_writable (!NILP (dir
) ? (char *) SDATA (dir
) : "")
2664 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2665 doc
: /* Access file FILENAME, and get an error if that does not work.
2666 The second argument STRING is used in the error message.
2667 If there is no error, returns nil. */)
2669 Lisp_Object filename
, string
;
2671 Lisp_Object handler
, encoded_filename
, absname
;
2674 CHECK_STRING (filename
);
2675 absname
= Fexpand_file_name (filename
, Qnil
);
2677 CHECK_STRING (string
);
2679 /* If the file name has special constructs in it,
2680 call the corresponding file handler. */
2681 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2682 if (!NILP (handler
))
2683 return call3 (handler
, Qaccess_file
, absname
, string
);
2685 encoded_filename
= ENCODE_FILE (absname
);
2687 fd
= emacs_open (SDATA (encoded_filename
), O_RDONLY
, 0);
2689 report_file_error (SDATA (string
), Fcons (filename
, Qnil
));
2695 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2696 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2697 The value is the link target, as a string.
2698 Otherwise it returns nil.
2700 This function returns t when given the name of a symlink that
2701 points to a nonexistent file. */)
2703 Lisp_Object filename
;
2705 Lisp_Object handler
;
2707 CHECK_STRING (filename
);
2708 filename
= Fexpand_file_name (filename
, Qnil
);
2710 /* If the file name has special constructs in it,
2711 call the corresponding file handler. */
2712 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2713 if (!NILP (handler
))
2714 return call2 (handler
, Qfile_symlink_p
, filename
);
2723 filename
= ENCODE_FILE (filename
);
2730 buf
= (char *) xrealloc (buf
, bufsize
);
2731 bzero (buf
, bufsize
);
2734 valsize
= readlink (SDATA (filename
), buf
, bufsize
);
2738 /* HP-UX reports ERANGE if buffer is too small. */
2739 if (errno
== ERANGE
)
2749 while (valsize
>= bufsize
);
2751 val
= make_string (buf
, valsize
);
2752 if (buf
[0] == '/' && index (buf
, ':'))
2753 val
= concat2 (build_string ("/:"), val
);
2755 val
= DECODE_FILE (val
);
2758 #else /* not S_IFLNK */
2760 #endif /* not S_IFLNK */
2763 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2764 doc
: /* Return t if FILENAME names an existing directory.
2765 Symbolic links to directories count as directories.
2766 See `file-symlink-p' to distinguish symlinks. */)
2768 Lisp_Object filename
;
2770 register Lisp_Object absname
;
2772 Lisp_Object handler
;
2774 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2776 /* If the file name has special constructs in it,
2777 call the corresponding file handler. */
2778 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2779 if (!NILP (handler
))
2780 return call2 (handler
, Qfile_directory_p
, absname
);
2782 absname
= ENCODE_FILE (absname
);
2784 if (stat (SDATA (absname
), &st
) < 0)
2786 return (st
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2789 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
2790 doc
: /* Return t if file FILENAME names a directory you can open.
2791 For the value to be t, FILENAME must specify the name of a directory as a file,
2792 and the directory must allow you to open files in it. In order to use a
2793 directory as a buffer's current directory, this predicate must return true.
2794 A directory name spec may be given instead; then the value is t
2795 if the directory so specified exists and really is a readable and
2796 searchable directory. */)
2798 Lisp_Object filename
;
2800 Lisp_Object handler
;
2802 struct gcpro gcpro1
;
2804 /* If the file name has special constructs in it,
2805 call the corresponding file handler. */
2806 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2807 if (!NILP (handler
))
2808 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2811 tem
= (NILP (Ffile_directory_p (filename
))
2812 || NILP (Ffile_executable_p (filename
)));
2814 return tem
? Qnil
: Qt
;
2817 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2818 doc
: /* Return t if FILENAME names a regular file.
2819 This is the sort of file that holds an ordinary stream of data bytes.
2820 Symbolic links to regular files count as regular files.
2821 See `file-symlink-p' to distinguish symlinks. */)
2823 Lisp_Object filename
;
2825 register Lisp_Object absname
;
2827 Lisp_Object handler
;
2829 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2831 /* If the file name has special constructs in it,
2832 call the corresponding file handler. */
2833 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2834 if (!NILP (handler
))
2835 return call2 (handler
, Qfile_regular_p
, absname
);
2837 absname
= ENCODE_FILE (absname
);
2842 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2844 /* Tell stat to use expensive method to get accurate info. */
2845 Vw32_get_true_file_attributes
= Qt
;
2846 result
= stat (SDATA (absname
), &st
);
2847 Vw32_get_true_file_attributes
= tem
;
2851 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2854 if (stat (SDATA (absname
), &st
) < 0)
2856 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2860 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2861 doc
: /* Return mode bits of file named FILENAME, as an integer.
2862 Return nil, if file does not exist or is not accessible. */)
2864 Lisp_Object filename
;
2866 Lisp_Object absname
;
2868 Lisp_Object handler
;
2870 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2872 /* If the file name has special constructs in it,
2873 call the corresponding file handler. */
2874 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2875 if (!NILP (handler
))
2876 return call2 (handler
, Qfile_modes
, absname
);
2878 absname
= ENCODE_FILE (absname
);
2880 if (stat (SDATA (absname
), &st
) < 0)
2882 #if defined (MSDOS) && __DJGPP__ < 2
2883 if (check_executable (SDATA (absname
)))
2884 st
.st_mode
|= S_IEXEC
;
2885 #endif /* MSDOS && __DJGPP__ < 2 */
2887 return make_number (st
.st_mode
& 07777);
2890 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2891 "(let ((file (read-file-name \"File: \"))) \
2892 (list file (read-file-modes nil file)))",
2893 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2894 Only the 12 low bits of MODE are used.
2896 Interactively, mode bits are read by `read-file-modes', which accepts
2897 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2899 Lisp_Object filename
, mode
;
2901 Lisp_Object absname
, encoded_absname
;
2902 Lisp_Object handler
;
2904 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2905 CHECK_NUMBER (mode
);
2907 /* If the file name has special constructs in it,
2908 call the corresponding file handler. */
2909 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2910 if (!NILP (handler
))
2911 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2913 encoded_absname
= ENCODE_FILE (absname
);
2915 if (chmod (SDATA (encoded_absname
), XINT (mode
)) < 0)
2916 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2921 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2922 doc
: /* Set the file permission bits for newly created files.
2923 The argument MODE should be an integer; only the low 9 bits are used.
2924 This setting is inherited by subprocesses. */)
2928 CHECK_NUMBER (mode
);
2930 umask ((~ XINT (mode
)) & 0777);
2935 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
2936 doc
: /* Return the default file protection for created files.
2937 The value is an integer. */)
2943 realmask
= umask (0);
2946 XSETINT (value
, (~ realmask
) & 0777);
2950 extern int lisp_time_argument
P_ ((Lisp_Object
, time_t *, int *));
2952 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
2953 doc
: /* Set times of file FILENAME to TIME.
2954 Set both access and modification times.
2955 Return t on success, else nil.
2956 Use the current time if TIME is nil. TIME is in the format of
2959 Lisp_Object filename
, time
;
2961 Lisp_Object absname
, encoded_absname
;
2962 Lisp_Object handler
;
2966 if (! lisp_time_argument (time
, &sec
, &usec
))
2967 error ("Invalid time specification");
2969 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2971 /* If the file name has special constructs in it,
2972 call the corresponding file handler. */
2973 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
2974 if (!NILP (handler
))
2975 return call3 (handler
, Qset_file_times
, absname
, time
);
2977 encoded_absname
= ENCODE_FILE (absname
);
2982 EMACS_SET_SECS (t
, sec
);
2983 EMACS_SET_USECS (t
, usec
);
2985 if (set_file_times (SDATA (encoded_absname
), t
, t
))
2990 /* Setting times on a directory always fails. */
2991 if (stat (SDATA (encoded_absname
), &st
) == 0
2992 && (st
.st_mode
& S_IFMT
) == S_IFDIR
)
2995 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3004 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3005 doc
: /* Tell Unix to finish all pending disk updates. */)
3012 #endif /* HAVE_SYNC */
3014 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3015 doc
: /* Return t if file FILE1 is newer than file FILE2.
3016 If FILE1 does not exist, the answer is nil;
3017 otherwise, if FILE2 does not exist, the answer is t. */)
3019 Lisp_Object file1
, file2
;
3021 Lisp_Object absname1
, absname2
;
3024 Lisp_Object handler
;
3025 struct gcpro gcpro1
, gcpro2
;
3027 CHECK_STRING (file1
);
3028 CHECK_STRING (file2
);
3031 GCPRO2 (absname1
, file2
);
3032 absname1
= expand_and_dir_to_file (file1
, current_buffer
->directory
);
3033 absname2
= expand_and_dir_to_file (file2
, current_buffer
->directory
);
3036 /* If the file name has special constructs in it,
3037 call the corresponding file handler. */
3038 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3040 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3041 if (!NILP (handler
))
3042 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3044 GCPRO2 (absname1
, absname2
);
3045 absname1
= ENCODE_FILE (absname1
);
3046 absname2
= ENCODE_FILE (absname2
);
3049 if (stat (SDATA (absname1
), &st
) < 0)
3052 mtime1
= st
.st_mtime
;
3054 if (stat (SDATA (absname2
), &st
) < 0)
3057 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3061 Lisp_Object Qfind_buffer_file_type
;
3064 #ifndef READ_BUF_SIZE
3065 #define READ_BUF_SIZE (64 << 10)
3068 /* This function is called after Lisp functions to decide a coding
3069 system are called, or when they cause an error. Before they are
3070 called, the current buffer is set unibyte and it contains only a
3071 newly inserted text (thus the buffer was empty before the
3074 The functions may set markers, overlays, text properties, or even
3075 alter the buffer contents, change the current buffer.
3077 Here, we reset all those changes by:
3078 o set back the current buffer.
3079 o move all markers and overlays to BEG.
3080 o remove all text properties.
3081 o set back the buffer multibyteness. */
3084 decide_coding_unwind (unwind_data
)
3085 Lisp_Object unwind_data
;
3087 Lisp_Object multibyte
, undo_list
, buffer
;
3089 multibyte
= XCAR (unwind_data
);
3090 unwind_data
= XCDR (unwind_data
);
3091 undo_list
= XCAR (unwind_data
);
3092 buffer
= XCDR (unwind_data
);
3094 if (current_buffer
!= XBUFFER (buffer
))
3095 set_buffer_internal (XBUFFER (buffer
));
3096 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3097 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3098 BUF_INTERVALS (current_buffer
) = 0;
3099 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3101 /* Now we are safe to change the buffer's multibyteness directly. */
3102 current_buffer
->enable_multibyte_characters
= multibyte
;
3103 current_buffer
->undo_list
= undo_list
;
3109 /* Used to pass values from insert-file-contents to read_non_regular. */
3111 static int non_regular_fd
;
3112 static EMACS_INT non_regular_inserted
;
3113 static EMACS_INT non_regular_nbytes
;
3116 /* Read from a non-regular file.
3117 Read non_regular_trytry bytes max from non_regular_fd.
3118 Non_regular_inserted specifies where to put the read bytes.
3119 Value is the number of bytes read. */
3128 nbytes
= emacs_read (non_regular_fd
,
3129 BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ non_regular_inserted
,
3130 non_regular_nbytes
);
3132 return make_number (nbytes
);
3136 /* Condition-case handler used when reading from non-regular files
3137 in insert-file-contents. */
3140 read_non_regular_quit ()
3146 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3148 doc
: /* Insert contents of file FILENAME after point.
3149 Returns list of absolute file name and number of characters inserted.
3150 If second argument VISIT is non-nil, the buffer's visited filename and
3151 last save file modtime are set, and it is marked unmodified. If
3152 visiting and the file does not exist, visiting is completed before the
3155 The optional third and fourth arguments BEG and END specify what portion
3156 of the file to insert. These arguments count bytes in the file, not
3157 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3159 If optional fifth argument REPLACE is non-nil, replace the current
3160 buffer contents (in the accessible portion) with the file contents.
3161 This is better than simply deleting and inserting the whole thing
3162 because (1) it preserves some marker positions and (2) it puts less data
3163 in the undo list. When REPLACE is non-nil, the second return value is
3164 the number of characters that replace previous buffer contents.
3166 This function does code conversion according to the value of
3167 `coding-system-for-read' or `file-coding-system-alist', and sets the
3168 variable `last-coding-system-used' to the coding system actually used. */)
3169 (filename
, visit
, beg
, end
, replace
)
3170 Lisp_Object filename
, visit
, beg
, end
, replace
;
3174 EMACS_INT inserted
= 0;
3176 register EMACS_INT how_much
;
3177 register EMACS_INT unprocessed
;
3178 int count
= SPECPDL_INDEX ();
3179 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3180 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3182 EMACS_INT total
= 0;
3183 int not_regular
= 0;
3184 unsigned char read_buf
[READ_BUF_SIZE
];
3185 struct coding_system coding
;
3186 unsigned char buffer
[1 << 14];
3187 int replace_handled
= 0;
3188 int set_coding_system
= 0;
3189 Lisp_Object coding_system
;
3191 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3192 int we_locked_file
= 0;
3193 int deferred_remove_unwind_protect
= 0;
3195 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3196 error ("Cannot do file visiting in an indirect buffer");
3198 if (!NILP (current_buffer
->read_only
))
3199 Fbarf_if_buffer_read_only ();
3203 orig_filename
= Qnil
;
3206 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3208 CHECK_STRING (filename
);
3209 filename
= Fexpand_file_name (filename
, Qnil
);
3211 /* The value Qnil means that the coding system is not yet
3213 coding_system
= Qnil
;
3215 /* If the file name has special constructs in it,
3216 call the corresponding file handler. */
3217 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3218 if (!NILP (handler
))
3220 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3221 visit
, beg
, end
, replace
);
3222 if (CONSP (val
) && CONSP (XCDR (val
)))
3223 inserted
= XINT (XCAR (XCDR (val
)));
3227 orig_filename
= filename
;
3228 filename
= ENCODE_FILE (filename
);
3234 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3236 /* Tell stat to use expensive method to get accurate info. */
3237 Vw32_get_true_file_attributes
= Qt
;
3238 total
= stat (SDATA (filename
), &st
);
3239 Vw32_get_true_file_attributes
= tem
;
3243 if (stat (SDATA (filename
), &st
) < 0)
3244 #endif /* WINDOWSNT */
3246 if (fd
>= 0) emacs_close (fd
);
3249 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3252 if (!NILP (Vcoding_system_for_read
))
3253 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3258 /* This code will need to be changed in order to work on named
3259 pipes, and it's probably just not worth it. So we should at
3260 least signal an error. */
3261 if (!S_ISREG (st
.st_mode
))
3268 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3269 xsignal2 (Qfile_error
,
3270 build_string ("not a regular file"), orig_filename
);
3275 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0)
3278 /* Replacement should preserve point as it preserves markers. */
3279 if (!NILP (replace
))
3280 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3282 record_unwind_protect (close_file_unwind
, make_number (fd
));
3284 /* Can happen on any platform that uses long as type of off_t, but allows
3285 file sizes to exceed 2Gb, so give a suitable message. */
3286 if (! not_regular
&& st
.st_size
< 0)
3287 error ("Maximum buffer size exceeded");
3289 /* Prevent redisplay optimizations. */
3290 current_buffer
->clip_changed
= 1;
3294 if (!NILP (beg
) || !NILP (end
))
3295 error ("Attempt to visit less than an entire file");
3296 if (BEG
< Z
&& NILP (replace
))
3297 error ("Cannot do file visiting in a non-empty buffer");
3303 XSETFASTINT (beg
, 0);
3311 XSETINT (end
, st
.st_size
);
3313 /* Arithmetic overflow can occur if an Emacs integer cannot
3314 represent the file size, or if the calculations below
3315 overflow. The calculations below double the file size
3316 twice, so check that it can be multiplied by 4 safely. */
3317 if (XINT (end
) != st
.st_size
3318 /* Actually, it should test either INT_MAX or LONG_MAX
3319 depending on which one is used for EMACS_INT. But in
3320 any case, in practice, this test is redundant with the
3322 || st.st_size > INT_MAX / 4 */)
3323 error ("Maximum buffer size exceeded");
3325 /* The file size returned from stat may be zero, but data
3326 may be readable nonetheless, for example when this is a
3327 file in the /proc filesystem. */
3328 if (st
.st_size
== 0)
3329 XSETINT (end
, READ_BUF_SIZE
);
3333 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3335 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3336 setup_coding_system (coding_system
, &coding
);
3337 /* Ensure we set Vlast_coding_system_used. */
3338 set_coding_system
= 1;
3342 /* Decide the coding system to use for reading the file now
3343 because we can't use an optimized method for handling
3344 `coding:' tag if the current buffer is not empty. */
3345 if (!NILP (Vcoding_system_for_read
))
3346 coding_system
= Vcoding_system_for_read
;
3349 /* Don't try looking inside a file for a coding system
3350 specification if it is not seekable. */
3351 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3353 /* Find a coding system specified in the heading two
3354 lines or in the tailing several lines of the file.
3355 We assume that the 1K-byte and 3K-byte for heading
3356 and tailing respectively are sufficient for this
3360 if (st
.st_size
<= (1024 * 4))
3361 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3364 nread
= emacs_read (fd
, read_buf
, 1024);
3367 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3368 report_file_error ("Setting file position",
3369 Fcons (orig_filename
, Qnil
));
3370 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3375 error ("IO error reading %s: %s",
3376 SDATA (orig_filename
), emacs_strerror (errno
));
3379 struct buffer
*prev
= current_buffer
;
3383 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3385 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3386 buf
= XBUFFER (buffer
);
3388 delete_all_overlays (buf
);
3389 buf
->directory
= current_buffer
->directory
;
3390 buf
->read_only
= Qnil
;
3391 buf
->filename
= Qnil
;
3392 buf
->undo_list
= Qt
;
3393 eassert (buf
->overlays_before
== NULL
);
3394 eassert (buf
->overlays_after
== NULL
);
3396 set_buffer_internal (buf
);
3398 buf
->enable_multibyte_characters
= Qnil
;
3400 insert_1_both (read_buf
, nread
, nread
, 0, 0, 0);
3401 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3402 coding_system
= call2 (Vset_auto_coding_function
,
3403 filename
, make_number (nread
));
3404 set_buffer_internal (prev
);
3406 /* Discard the unwind protect for recovering the
3410 /* Rewind the file for the actual read done later. */
3411 if (lseek (fd
, 0, 0) < 0)
3412 report_file_error ("Setting file position",
3413 Fcons (orig_filename
, Qnil
));
3417 if (NILP (coding_system
))
3419 /* If we have not yet decided a coding system, check
3420 file-coding-system-alist. */
3421 Lisp_Object args
[6];
3423 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3424 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3425 coding_system
= Ffind_operation_coding_system (6, args
);
3426 if (CONSP (coding_system
))
3427 coding_system
= XCAR (coding_system
);
3431 if (NILP (coding_system
))
3432 coding_system
= Qundecided
;
3434 CHECK_CODING_SYSTEM (coding_system
);
3436 if (NILP (current_buffer
->enable_multibyte_characters
))
3437 /* We must suppress all character code conversion except for
3438 end-of-line conversion. */
3439 coding_system
= raw_text_coding_system (coding_system
);
3441 setup_coding_system (coding_system
, &coding
);
3442 /* Ensure we set Vlast_coding_system_used. */
3443 set_coding_system
= 1;
3446 /* If requested, replace the accessible part of the buffer
3447 with the file contents. Avoid replacing text at the
3448 beginning or end of the buffer that matches the file contents;
3449 that preserves markers pointing to the unchanged parts.
3451 Here we implement this feature in an optimized way
3452 for the case where code conversion is NOT needed.
3453 The following if-statement handles the case of conversion
3454 in a less optimal way.
3456 If the code conversion is "automatic" then we try using this
3457 method and hope for the best.
3458 But if we discover the need for conversion, we give up on this method
3459 and let the following if-statement handle the replace job. */
3462 && (NILP (coding_system
)
3463 || ! CODING_REQUIRE_DECODING (&coding
)))
3465 /* same_at_start and same_at_end count bytes,
3466 because file access counts bytes
3467 and BEG and END count bytes. */
3468 EMACS_INT same_at_start
= BEGV_BYTE
;
3469 EMACS_INT same_at_end
= ZV_BYTE
;
3471 /* There is still a possibility we will find the need to do code
3472 conversion. If that happens, we set this variable to 1 to
3473 give up on handling REPLACE in the optimized way. */
3474 int giveup_match_end
= 0;
3476 if (XINT (beg
) != 0)
3478 if (lseek (fd
, XINT (beg
), 0) < 0)
3479 report_file_error ("Setting file position",
3480 Fcons (orig_filename
, Qnil
));
3485 /* Count how many chars at the start of the file
3486 match the text at the beginning of the buffer. */
3489 EMACS_INT nread
, bufpos
;
3491 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3493 error ("IO error reading %s: %s",
3494 SDATA (orig_filename
), emacs_strerror (errno
));
3495 else if (nread
== 0)
3498 if (CODING_REQUIRE_DETECTION (&coding
))
3500 coding_system
= detect_coding_system (buffer
, nread
, nread
, 1, 0,
3502 setup_coding_system (coding_system
, &coding
);
3505 if (CODING_REQUIRE_DECODING (&coding
))
3506 /* We found that the file should be decoded somehow.
3507 Let's give up here. */
3509 giveup_match_end
= 1;
3514 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3515 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3516 same_at_start
++, bufpos
++;
3517 /* If we found a discrepancy, stop the scan.
3518 Otherwise loop around and scan the next bufferful. */
3519 if (bufpos
!= nread
)
3523 /* If the file matches the buffer completely,
3524 there's no need to replace anything. */
3525 if (same_at_start
- BEGV_BYTE
== XINT (end
))
3529 /* Truncate the buffer to the size of the file. */
3530 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3535 /* Count how many chars at the end of the file
3536 match the text at the end of the buffer. But, if we have
3537 already found that decoding is necessary, don't waste time. */
3538 while (!giveup_match_end
)
3540 EMACS_INT total_read
, nread
, bufpos
, curpos
, trial
;
3542 /* At what file position are we now scanning? */
3543 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
3544 /* If the entire file matches the buffer tail, stop the scan. */
3547 /* How much can we scan in the next step? */
3548 trial
= min (curpos
, sizeof buffer
);
3549 if (lseek (fd
, curpos
- trial
, 0) < 0)
3550 report_file_error ("Setting file position",
3551 Fcons (orig_filename
, Qnil
));
3553 total_read
= nread
= 0;
3554 while (total_read
< trial
)
3556 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3558 error ("IO error reading %s: %s",
3559 SDATA (orig_filename
), emacs_strerror (errno
));
3560 else if (nread
== 0)
3562 total_read
+= nread
;
3565 /* Scan this bufferful from the end, comparing with
3566 the Emacs buffer. */
3567 bufpos
= total_read
;
3569 /* Compare with same_at_start to avoid counting some buffer text
3570 as matching both at the file's beginning and at the end. */
3571 while (bufpos
> 0 && same_at_end
> same_at_start
3572 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3573 same_at_end
--, bufpos
--;
3575 /* If we found a discrepancy, stop the scan.
3576 Otherwise loop around and scan the preceding bufferful. */
3579 /* If this discrepancy is because of code conversion,
3580 we cannot use this method; giveup and try the other. */
3581 if (same_at_end
> same_at_start
3582 && FETCH_BYTE (same_at_end
- 1) >= 0200
3583 && ! NILP (current_buffer
->enable_multibyte_characters
)
3584 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3585 giveup_match_end
= 1;
3594 if (! giveup_match_end
)
3598 /* We win! We can handle REPLACE the optimized way. */
3600 /* Extend the start of non-matching text area to multibyte
3601 character boundary. */
3602 if (! NILP (current_buffer
->enable_multibyte_characters
))
3603 while (same_at_start
> BEGV_BYTE
3604 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3607 /* Extend the end of non-matching text area to multibyte
3608 character boundary. */
3609 if (! NILP (current_buffer
->enable_multibyte_characters
))
3610 while (same_at_end
< ZV_BYTE
3611 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3614 /* Don't try to reuse the same piece of text twice. */
3615 overlap
= (same_at_start
- BEGV_BYTE
3616 - (same_at_end
+ st
.st_size
- ZV
));
3618 same_at_end
+= overlap
;
3620 /* Arrange to read only the nonmatching middle part of the file. */
3621 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
3622 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
3624 del_range_byte (same_at_start
, same_at_end
, 0);
3625 /* Insert from the file at the proper position. */
3626 temp
= BYTE_TO_CHAR (same_at_start
);
3627 SET_PT_BOTH (temp
, same_at_start
);
3629 /* If display currently starts at beginning of line,
3630 keep it that way. */
3631 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3632 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3634 replace_handled
= 1;
3638 /* If requested, replace the accessible part of the buffer
3639 with the file contents. Avoid replacing text at the
3640 beginning or end of the buffer that matches the file contents;
3641 that preserves markers pointing to the unchanged parts.
3643 Here we implement this feature for the case where code conversion
3644 is needed, in a simple way that needs a lot of memory.
3645 The preceding if-statement handles the case of no conversion
3646 in a more optimized way. */
3647 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3649 EMACS_INT same_at_start
= BEGV_BYTE
;
3650 EMACS_INT same_at_end
= ZV_BYTE
;
3651 EMACS_INT same_at_start_charpos
;
3652 EMACS_INT inserted_chars
;
3655 unsigned char *decoded
;
3657 int this_count
= SPECPDL_INDEX ();
3658 int multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
3659 Lisp_Object conversion_buffer
;
3661 conversion_buffer
= code_conversion_save (1, multibyte
);
3663 /* First read the whole file, performing code conversion into
3664 CONVERSION_BUFFER. */
3666 if (lseek (fd
, XINT (beg
), 0) < 0)
3667 report_file_error ("Setting file position",
3668 Fcons (orig_filename
, Qnil
));
3670 total
= st
.st_size
; /* Total bytes in the file. */
3671 how_much
= 0; /* Bytes read from file so far. */
3672 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3673 unprocessed
= 0; /* Bytes not processed in previous loop. */
3675 GCPRO1 (conversion_buffer
);
3676 while (how_much
< total
)
3678 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3679 quitting while reading a huge while. */
3680 /* try is reserved in some compilers (Microsoft C) */
3681 EMACS_INT trytry
= min (total
- how_much
,
3682 READ_BUF_SIZE
- unprocessed
);
3685 /* Allow quitting out of the actual I/O. */
3688 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3700 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3701 BUF_Z (XBUFFER (conversion_buffer
)));
3702 decode_coding_c_string (&coding
, read_buf
, unprocessed
+ this,
3704 unprocessed
= coding
.carryover_bytes
;
3705 if (coding
.carryover_bytes
> 0)
3706 bcopy (coding
.carryover
, read_buf
, unprocessed
);
3711 /* We should remove the unwind_protect calling
3712 close_file_unwind, but other stuff has been added the stack,
3713 so defer the removal till we reach the `handled' label. */
3714 deferred_remove_unwind_protect
= 1;
3716 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3717 if we couldn't read the file. */
3720 error ("IO error reading %s: %s",
3721 SDATA (orig_filename
), emacs_strerror (errno
));
3723 if (unprocessed
> 0)
3725 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3726 decode_coding_c_string (&coding
, read_buf
, unprocessed
,
3728 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3731 coding_system
= CODING_ID_NAME (coding
.id
);
3732 set_coding_system
= 1;
3733 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3734 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3735 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3737 /* Compare the beginning of the converted string with the buffer
3741 while (bufpos
< inserted
&& same_at_start
< same_at_end
3742 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3743 same_at_start
++, bufpos
++;
3745 /* If the file matches the head of buffer completely,
3746 there's no need to replace anything. */
3748 if (bufpos
== inserted
)
3750 /* Truncate the buffer to the size of the file. */
3751 if (same_at_start
== same_at_end
)
3754 del_range_byte (same_at_start
, same_at_end
, 0);
3757 unbind_to (this_count
, Qnil
);
3761 /* Extend the start of non-matching text area to the previous
3762 multibyte character boundary. */
3763 if (! NILP (current_buffer
->enable_multibyte_characters
))
3764 while (same_at_start
> BEGV_BYTE
3765 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3768 /* Scan this bufferful from the end, comparing with
3769 the Emacs buffer. */
3772 /* Compare with same_at_start to avoid counting some buffer text
3773 as matching both at the file's beginning and at the end. */
3774 while (bufpos
> 0 && same_at_end
> same_at_start
3775 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3776 same_at_end
--, bufpos
--;
3778 /* Extend the end of non-matching text area to the next
3779 multibyte character boundary. */
3780 if (! NILP (current_buffer
->enable_multibyte_characters
))
3781 while (same_at_end
< ZV_BYTE
3782 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3785 /* Don't try to reuse the same piece of text twice. */
3786 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3788 same_at_end
+= overlap
;
3790 /* If display currently starts at beginning of line,
3791 keep it that way. */
3792 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3793 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3795 /* Replace the chars that we need to replace,
3796 and update INSERTED to equal the number of bytes
3797 we are taking from the decoded string. */
3798 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3800 if (same_at_end
!= same_at_start
)
3802 del_range_byte (same_at_start
, same_at_end
, 0);
3804 same_at_start
= GPT_BYTE
;
3808 temp
= BYTE_TO_CHAR (same_at_start
);
3810 /* Insert from the file at the proper position. */
3811 SET_PT_BOTH (temp
, same_at_start
);
3812 same_at_start_charpos
3813 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3814 same_at_start
- BEGV_BYTE
3815 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3817 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3818 same_at_start
+ inserted
- BEGV_BYTE
3819 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3820 - same_at_start_charpos
);
3821 /* This binding is to avoid ask-user-about-supersession-threat
3822 being called in insert_from_buffer (via in
3823 prepare_to_modify_buffer). */
3824 specbind (intern ("buffer-file-name"), Qnil
);
3825 insert_from_buffer (XBUFFER (conversion_buffer
),
3826 same_at_start_charpos
, inserted_chars
, 0);
3827 /* Set `inserted' to the number of inserted characters. */
3828 inserted
= PT
- temp
;
3829 /* Set point before the inserted characters. */
3830 SET_PT_BOTH (temp
, same_at_start
);
3832 unbind_to (this_count
, Qnil
);
3839 register Lisp_Object temp
;
3841 total
= XINT (end
) - XINT (beg
);
3843 /* Make sure point-max won't overflow after this insertion. */
3844 XSETINT (temp
, total
);
3845 if (total
!= XINT (temp
))
3846 error ("Maximum buffer size exceeded");
3849 /* For a special file, all we can do is guess. */
3850 total
= READ_BUF_SIZE
;
3852 if (NILP (visit
) && inserted
> 0)
3854 #ifdef CLASH_DETECTION
3855 if (!NILP (current_buffer
->file_truename
)
3856 /* Make binding buffer-file-name to nil effective. */
3857 && !NILP (current_buffer
->filename
)
3858 && SAVE_MODIFF
>= MODIFF
)
3860 #endif /* CLASH_DETECTION */
3861 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3865 if (GAP_SIZE
< total
)
3866 make_gap (total
- GAP_SIZE
);
3868 if (XINT (beg
) != 0 || !NILP (replace
))
3870 if (lseek (fd
, XINT (beg
), 0) < 0)
3871 report_file_error ("Setting file position",
3872 Fcons (orig_filename
, Qnil
));
3875 /* In the following loop, HOW_MUCH contains the total bytes read so
3876 far for a regular file, and not changed for a special file. But,
3877 before exiting the loop, it is set to a negative value if I/O
3881 /* Total bytes inserted. */
3884 /* Here, we don't do code conversion in the loop. It is done by
3885 decode_coding_gap after all data are read into the buffer. */
3887 EMACS_INT gap_size
= GAP_SIZE
;
3889 while (how_much
< total
)
3891 /* try is reserved in some compilers (Microsoft C) */
3892 EMACS_INT trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3899 /* Maybe make more room. */
3900 if (gap_size
< trytry
)
3902 make_gap (total
- gap_size
);
3903 gap_size
= GAP_SIZE
;
3906 /* Read from the file, capturing `quit'. When an
3907 error occurs, end the loop, and arrange for a quit
3908 to be signaled after decoding the text we read. */
3909 non_regular_fd
= fd
;
3910 non_regular_inserted
= inserted
;
3911 non_regular_nbytes
= trytry
;
3912 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
3913 read_non_regular_quit
);
3924 /* Allow quitting out of the actual I/O. We don't make text
3925 part of the buffer until all the reading is done, so a C-g
3926 here doesn't do any harm. */
3929 this = emacs_read (fd
, BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ inserted
, trytry
);
3941 /* For a regular file, where TOTAL is the real size,
3942 count HOW_MUCH to compare with it.
3943 For a special file, where TOTAL is just a buffer size,
3944 so don't bother counting in HOW_MUCH.
3945 (INSERTED is where we count the number of characters inserted.) */
3952 /* Now we have read all the file data into the gap.
3953 If it was empty, undo marking the buffer modified. */
3957 #ifdef CLASH_DETECTION
3959 unlock_file (current_buffer
->file_truename
);
3961 Vdeactivate_mark
= old_Vdeactivate_mark
;
3964 Vdeactivate_mark
= Qt
;
3966 /* Make the text read part of the buffer. */
3967 GAP_SIZE
-= inserted
;
3969 GPT_BYTE
+= inserted
;
3971 ZV_BYTE
+= inserted
;
3976 /* Put an anchor to ensure multi-byte form ends at gap. */
3981 /* Discard the unwind protect for closing the file. */
3985 error ("IO error reading %s: %s",
3986 SDATA (orig_filename
), emacs_strerror (errno
));
3990 if (NILP (coding_system
))
3992 /* The coding system is not yet decided. Decide it by an
3993 optimized method for handling `coding:' tag.
3995 Note that we can get here only if the buffer was empty
3996 before the insertion. */
3998 if (!NILP (Vcoding_system_for_read
))
3999 coding_system
= Vcoding_system_for_read
;
4002 /* Since we are sure that the current buffer was empty
4003 before the insertion, we can toggle
4004 enable-multibyte-characters directly here without taking
4005 care of marker adjustment. By this way, we can run Lisp
4006 program safely before decoding the inserted text. */
4007 Lisp_Object unwind_data
;
4008 int count
= SPECPDL_INDEX ();
4010 unwind_data
= Fcons (current_buffer
->enable_multibyte_characters
,
4011 Fcons (current_buffer
->undo_list
,
4012 Fcurrent_buffer ()));
4013 current_buffer
->enable_multibyte_characters
= Qnil
;
4014 current_buffer
->undo_list
= Qt
;
4015 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4017 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4019 coding_system
= call2 (Vset_auto_coding_function
,
4020 filename
, make_number (inserted
));
4023 if (NILP (coding_system
))
4025 /* If the coding system is not yet decided, check
4026 file-coding-system-alist. */
4027 Lisp_Object args
[6];
4029 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4030 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4031 coding_system
= Ffind_operation_coding_system (6, args
);
4032 if (CONSP (coding_system
))
4033 coding_system
= XCAR (coding_system
);
4035 unbind_to (count
, Qnil
);
4036 inserted
= Z_BYTE
- BEG_BYTE
;
4039 if (NILP (coding_system
))
4040 coding_system
= Qundecided
;
4042 CHECK_CODING_SYSTEM (coding_system
);
4044 if (NILP (current_buffer
->enable_multibyte_characters
))
4045 /* We must suppress all character code conversion except for
4046 end-of-line conversion. */
4047 coding_system
= raw_text_coding_system (coding_system
);
4048 setup_coding_system (coding_system
, &coding
);
4049 /* Ensure we set Vlast_coding_system_used. */
4050 set_coding_system
= 1;
4055 /* When we visit a file by raw-text, we change the buffer to
4057 if (CODING_FOR_UNIBYTE (&coding
)
4058 /* Can't do this if part of the buffer might be preserved. */
4060 /* Visiting a file with these coding system makes the buffer
4062 current_buffer
->enable_multibyte_characters
= Qnil
;
4065 coding
.dst_multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
4066 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4067 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4069 move_gap_both (PT
, PT_BYTE
);
4070 GAP_SIZE
+= inserted
;
4071 ZV_BYTE
-= inserted
;
4075 decode_coding_gap (&coding
, inserted
, inserted
);
4076 inserted
= coding
.produced_char
;
4077 coding_system
= CODING_ID_NAME (coding
.id
);
4079 else if (inserted
> 0)
4080 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4083 /* Now INSERTED is measured in characters. */
4086 /* Use the conversion type to determine buffer-file-type
4087 (find-buffer-file-type is now used to help determine the
4089 if ((VECTORP (CODING_ID_EOL_TYPE (coding
.id
))
4090 || EQ (CODING_ID_EOL_TYPE (coding
.id
), Qunix
))
4091 && ! CODING_REQUIRE_DECODING (&coding
))
4092 current_buffer
->buffer_file_type
= Qt
;
4094 current_buffer
->buffer_file_type
= Qnil
;
4099 if (deferred_remove_unwind_protect
)
4100 /* If requested above, discard the unwind protect for closing the
4106 if (!EQ (current_buffer
->undo_list
, Qt
) && !nochange
)
4107 current_buffer
->undo_list
= Qnil
;
4111 current_buffer
->modtime
= st
.st_mtime
;
4112 current_buffer
->filename
= orig_filename
;
4115 SAVE_MODIFF
= MODIFF
;
4116 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
4117 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4118 #ifdef CLASH_DETECTION
4121 if (!NILP (current_buffer
->file_truename
))
4122 unlock_file (current_buffer
->file_truename
);
4123 unlock_file (filename
);
4125 #endif /* CLASH_DETECTION */
4127 xsignal2 (Qfile_error
,
4128 build_string ("not a regular file"), orig_filename
);
4131 if (set_coding_system
)
4132 Vlast_coding_system_used
= coding_system
;
4134 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4136 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4138 if (! NILP (insval
))
4140 CHECK_NUMBER (insval
);
4141 inserted
= XFASTINT (insval
);
4145 /* Decode file format. */
4148 /* Don't run point motion or modification hooks when decoding. */
4149 int count
= SPECPDL_INDEX ();
4150 EMACS_INT old_inserted
= inserted
;
4151 specbind (Qinhibit_point_motion_hooks
, Qt
);
4152 specbind (Qinhibit_modification_hooks
, Qt
);
4154 /* Save old undo list and don't record undo for decoding. */
4155 old_undo
= current_buffer
->undo_list
;
4156 current_buffer
->undo_list
= Qt
;
4160 insval
= call3 (Qformat_decode
,
4161 Qnil
, make_number (inserted
), visit
);
4162 CHECK_NUMBER (insval
);
4163 inserted
= XFASTINT (insval
);
4167 /* If REPLACE is non-nil and we succeeded in not replacing the
4168 beginning or end of the buffer text with the file's contents,
4169 call format-decode with `point' positioned at the beginning
4170 of the buffer and `inserted' equalling the number of
4171 characters in the buffer. Otherwise, format-decode might
4172 fail to correctly analyze the beginning or end of the buffer.
4173 Hence we temporarily save `point' and `inserted' here and
4174 restore `point' iff format-decode did not insert or delete
4175 any text. Otherwise we leave `point' at point-min. */
4176 EMACS_INT opoint
= PT
;
4177 EMACS_INT opoint_byte
= PT_BYTE
;
4178 EMACS_INT oinserted
= ZV
- BEGV
;
4179 int ochars_modiff
= CHARS_MODIFF
;
4181 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4182 insval
= call3 (Qformat_decode
,
4183 Qnil
, make_number (oinserted
), visit
);
4184 CHECK_NUMBER (insval
);
4185 if (ochars_modiff
== CHARS_MODIFF
)
4186 /* format_decode didn't modify buffer's characters => move
4187 point back to position before inserted text and leave
4188 value of inserted alone. */
4189 SET_PT_BOTH (opoint
, opoint_byte
);
4191 /* format_decode modified buffer's characters => consider
4192 entire buffer changed and leave point at point-min. */
4193 inserted
= XFASTINT (insval
);
4196 /* For consistency with format-decode call these now iff inserted > 0
4197 (martin 2007-06-28). */
4198 p
= Vafter_insert_file_functions
;
4203 insval
= call1 (XCAR (p
), make_number (inserted
));
4206 CHECK_NUMBER (insval
);
4207 inserted
= XFASTINT (insval
);
4212 /* For the rationale of this see the comment on
4213 format-decode above. */
4214 EMACS_INT opoint
= PT
;
4215 EMACS_INT opoint_byte
= PT_BYTE
;
4216 EMACS_INT oinserted
= ZV
- BEGV
;
4217 int ochars_modiff
= CHARS_MODIFF
;
4219 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4220 insval
= call1 (XCAR (p
), make_number (oinserted
));
4223 CHECK_NUMBER (insval
);
4224 if (ochars_modiff
== CHARS_MODIFF
)
4225 /* after_insert_file_functions didn't modify
4226 buffer's characters => move point back to
4227 position before inserted text and leave value of
4229 SET_PT_BOTH (opoint
, opoint_byte
);
4231 /* after_insert_file_functions did modify buffer's
4232 characters => consider entire buffer changed and
4233 leave point at point-min. */
4234 inserted
= XFASTINT (insval
);
4244 current_buffer
->undo_list
= old_undo
;
4245 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4247 /* Adjust the last undo record for the size change during
4248 the format conversion. */
4249 Lisp_Object tem
= XCAR (old_undo
);
4250 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4251 && INTEGERP (XCDR (tem
))
4252 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4253 XSETCDR (tem
, make_number (PT
+ inserted
));
4257 /* If undo_list was Qt before, keep it that way.
4258 Otherwise start with an empty undo_list. */
4259 current_buffer
->undo_list
= EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4261 unbind_to (count
, Qnil
);
4264 /* Call after-change hooks for the inserted text, aside from the case
4265 of normal visiting (not with REPLACE), which is done in a new buffer
4266 "before" the buffer is changed. */
4267 if (inserted
> 0 && total
> 0
4268 && (NILP (visit
) || !NILP (replace
)))
4270 signal_after_change (PT
, 0, inserted
);
4271 update_compositions (PT
, PT
, CHECK_BORDER
);
4275 && current_buffer
->modtime
== -1)
4277 /* If visiting nonexistent file, return nil. */
4278 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4282 Fsignal (Qquit
, Qnil
);
4284 /* ??? Retval needs to be dealt with in all cases consistently. */
4286 val
= Fcons (orig_filename
,
4287 Fcons (make_number (inserted
),
4290 RETURN_UNGCPRO (unbind_to (count
, val
));
4293 static Lisp_Object build_annotations
P_ ((Lisp_Object
, Lisp_Object
));
4296 build_annotations_unwind (arg
)
4299 Vwrite_region_annotation_buffers
= arg
;
4303 /* Decide the coding-system to encode the data with. */
4306 choose_write_coding_system (start
, end
, filename
,
4307 append
, visit
, lockname
, coding
)
4308 Lisp_Object start
, end
, filename
, append
, visit
, lockname
;
4309 struct coding_system
*coding
;
4312 Lisp_Object eol_parent
= Qnil
;
4315 && NILP (Fstring_equal (current_buffer
->filename
,
4316 current_buffer
->auto_save_file_name
)))
4321 else if (!NILP (Vcoding_system_for_write
))
4323 val
= Vcoding_system_for_write
;
4324 if (coding_system_require_warning
4325 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4326 /* Confirm that VAL can surely encode the current region. */
4327 val
= call5 (Vselect_safe_coding_system_function
,
4328 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4333 /* If the variable `buffer-file-coding-system' is set locally,
4334 it means that the file was read with some kind of code
4335 conversion or the variable is explicitly set by users. We
4336 had better write it out with the same coding system even if
4337 `enable-multibyte-characters' is nil.
4339 If it is not set locally, we anyway have to convert EOL
4340 format if the default value of `buffer-file-coding-system'
4341 tells that it is not Unix-like (LF only) format. */
4342 int using_default_coding
= 0;
4343 int force_raw_text
= 0;
4345 val
= current_buffer
->buffer_file_coding_system
;
4347 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4350 if (NILP (current_buffer
->enable_multibyte_characters
))
4356 /* Check file-coding-system-alist. */
4357 Lisp_Object args
[7], coding_systems
;
4359 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4360 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4362 coding_systems
= Ffind_operation_coding_system (7, args
);
4363 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4364 val
= XCDR (coding_systems
);
4369 /* If we still have not decided a coding system, use the
4370 default value of buffer-file-coding-system. */
4371 val
= current_buffer
->buffer_file_coding_system
;
4372 using_default_coding
= 1;
4375 if (! NILP (val
) && ! force_raw_text
)
4377 Lisp_Object spec
, attrs
;
4379 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4380 attrs
= AREF (spec
, 0);
4381 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4386 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4387 /* Confirm that VAL can surely encode the current region. */
4388 val
= call5 (Vselect_safe_coding_system_function
,
4389 start
, end
, val
, Qnil
, filename
);
4391 /* If the decided coding-system doesn't specify end-of-line
4392 format, we use that of
4393 `default-buffer-file-coding-system'. */
4394 if (! using_default_coding
4395 && ! NILP (buffer_defaults
.buffer_file_coding_system
))
4396 val
= (coding_inherit_eol_type
4397 (val
, buffer_defaults
.buffer_file_coding_system
));
4399 /* If we decide not to encode text, use `raw-text' or one of its
4402 val
= raw_text_coding_system (val
);
4405 val
= coding_inherit_eol_type (val
, eol_parent
);
4406 setup_coding_system (val
, coding
);
4408 if (!STRINGP (start
) && !NILP (current_buffer
->selective_display
))
4409 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4413 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4414 "r\nFWrite region to file: \ni\ni\ni\np",
4415 doc
: /* Write current region into specified file.
4416 When called from a program, requires three arguments:
4417 START, END and FILENAME. START and END are normally buffer positions
4418 specifying the part of the buffer to write.
4419 If START is nil, that means to use the entire buffer contents.
4420 If START is a string, then output that string to the file
4421 instead of any buffer contents; END is ignored.
4423 Optional fourth argument APPEND if non-nil means
4424 append to existing file contents (if any). If it is an integer,
4425 seek to that offset in the file before writing.
4426 Optional fifth argument VISIT, if t or a string, means
4427 set the last-save-file-modtime of buffer to this file's modtime
4428 and mark buffer not modified.
4429 If VISIT is a string, it is a second file name;
4430 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4431 VISIT is also the file name to lock and unlock for clash detection.
4432 If VISIT is neither t nor nil nor a string,
4433 that means do not display the \"Wrote file\" message.
4434 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4435 use for locking and unlocking, overriding FILENAME and VISIT.
4436 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4437 for an existing file with the same name. If MUSTBENEW is `excl',
4438 that means to get an error if the file already exists; never overwrite.
4439 If MUSTBENEW is neither nil nor `excl', that means ask for
4440 confirmation before overwriting, but do go ahead and overwrite the file
4441 if the user confirms.
4443 This does code conversion according to the value of
4444 `coding-system-for-write', `buffer-file-coding-system', or
4445 `file-coding-system-alist', and sets the variable
4446 `last-coding-system-used' to the coding system actually used.
4448 This calls `write-region-annotate-functions' at the start, and
4449 `write-region-post-annotation-function' at the end. */)
4450 (start
, end
, filename
, append
, visit
, lockname
, mustbenew
)
4451 Lisp_Object start
, end
, filename
, append
, visit
, lockname
, mustbenew
;
4456 const unsigned char *fn
;
4458 int count
= SPECPDL_INDEX ();
4460 Lisp_Object handler
;
4461 Lisp_Object visit_file
;
4462 Lisp_Object annotations
;
4463 Lisp_Object encoded_filename
;
4464 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4465 int quietly
= !NILP (visit
);
4466 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4467 struct buffer
*given_buffer
;
4469 int buffer_file_type
= O_BINARY
;
4471 struct coding_system coding
;
4473 if (current_buffer
->base_buffer
&& visiting
)
4474 error ("Cannot do file visiting in an indirect buffer");
4476 if (!NILP (start
) && !STRINGP (start
))
4477 validate_region (&start
, &end
);
4480 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4482 filename
= Fexpand_file_name (filename
, Qnil
);
4484 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4485 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4487 if (STRINGP (visit
))
4488 visit_file
= Fexpand_file_name (visit
, Qnil
);
4490 visit_file
= filename
;
4492 if (NILP (lockname
))
4493 lockname
= visit_file
;
4497 /* If the file name has special constructs in it,
4498 call the corresponding file handler. */
4499 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4500 /* If FILENAME has no handler, see if VISIT has one. */
4501 if (NILP (handler
) && STRINGP (visit
))
4502 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4504 if (!NILP (handler
))
4507 val
= call6 (handler
, Qwrite_region
, start
, end
,
4508 filename
, append
, visit
);
4512 SAVE_MODIFF
= MODIFF
;
4513 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4514 current_buffer
->filename
= visit_file
;
4520 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4522 /* Special kludge to simplify auto-saving. */
4525 /* Do it later, so write-region-annotate-function can work differently
4526 if we save "the buffer" vs "a region".
4527 This is useful in tar-mode. --Stef
4528 XSETFASTINT (start, BEG);
4529 XSETFASTINT (end, Z); */
4533 record_unwind_protect (build_annotations_unwind
,
4534 Vwrite_region_annotation_buffers
);
4535 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4536 count1
= SPECPDL_INDEX ();
4538 given_buffer
= current_buffer
;
4540 if (!STRINGP (start
))
4542 annotations
= build_annotations (start
, end
);
4544 if (current_buffer
!= given_buffer
)
4546 XSETFASTINT (start
, BEGV
);
4547 XSETFASTINT (end
, ZV
);
4553 XSETFASTINT (start
, BEGV
);
4554 XSETFASTINT (end
, ZV
);
4559 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4561 /* Decide the coding-system to encode the data with.
4562 We used to make this choice before calling build_annotations, but that
4563 leads to problems when a write-annotate-function takes care of
4564 unsavable chars (as was the case with X-Symbol). */
4565 Vlast_coding_system_used
4566 = choose_write_coding_system (start
, end
, filename
,
4567 append
, visit
, lockname
, &coding
);
4569 #ifdef CLASH_DETECTION
4571 lock_file (lockname
);
4572 #endif /* CLASH_DETECTION */
4574 encoded_filename
= ENCODE_FILE (filename
);
4576 fn
= SDATA (encoded_filename
);
4580 desc
= emacs_open (fn
, O_WRONLY
| buffer_file_type
, 0);
4581 #else /* not DOS_NT */
4582 desc
= emacs_open (fn
, O_WRONLY
, 0);
4583 #endif /* not DOS_NT */
4585 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4587 desc
= emacs_open (fn
,
4588 O_WRONLY
| O_CREAT
| buffer_file_type
4589 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4590 S_IREAD
| S_IWRITE
);
4591 #else /* not DOS_NT */
4592 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4593 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4594 auto_saving
? auto_save_mode_bits
: 0666);
4595 #endif /* not DOS_NT */
4599 #ifdef CLASH_DETECTION
4601 if (!auto_saving
) unlock_file (lockname
);
4603 #endif /* CLASH_DETECTION */
4605 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4608 record_unwind_protect (close_file_unwind
, make_number (desc
));
4610 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4614 if (NUMBERP (append
))
4615 ret
= lseek (desc
, XINT (append
), 1);
4617 ret
= lseek (desc
, 0, 2);
4620 #ifdef CLASH_DETECTION
4621 if (!auto_saving
) unlock_file (lockname
);
4622 #endif /* CLASH_DETECTION */
4624 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4633 if (STRINGP (start
))
4635 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4636 &annotations
, &coding
);
4639 else if (XINT (start
) != XINT (end
))
4641 failure
= 0 > a_write (desc
, Qnil
,
4642 XINT (start
), XINT (end
) - XINT (start
),
4643 &annotations
, &coding
);
4648 /* If file was empty, still need to write the annotations */
4649 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4650 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4654 if (CODING_REQUIRE_FLUSHING (&coding
)
4655 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4658 /* We have to flush out a data. */
4659 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4660 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4667 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4668 Disk full in NFS may be reported here. */
4669 /* mib says that closing the file will try to write as fast as NFS can do
4670 it, and that means the fsync here is not crucial for autosave files. */
4671 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4673 /* If fsync fails with EINTR, don't treat that as serious. Also
4674 ignore EINVAL which happens when fsync is not supported on this
4676 if (errno
!= EINTR
&& errno
!= EINVAL
)
4677 failure
= 1, save_errno
= errno
;
4681 /* NFS can report a write failure now. */
4682 if (emacs_close (desc
) < 0)
4683 failure
= 1, save_errno
= errno
;
4687 /* Discard the unwind protect for close_file_unwind. */
4688 specpdl_ptr
= specpdl
+ count1
;
4690 /* Call write-region-post-annotation-function. */
4691 while (CONSP (Vwrite_region_annotation_buffers
))
4693 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4694 if (!NILP (Fbuffer_live_p (buf
)))
4697 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4698 call0 (Vwrite_region_post_annotation_function
);
4700 Vwrite_region_annotation_buffers
4701 = XCDR (Vwrite_region_annotation_buffers
);
4704 unbind_to (count
, Qnil
);
4706 #ifdef CLASH_DETECTION
4708 unlock_file (lockname
);
4709 #endif /* CLASH_DETECTION */
4711 /* Do this before reporting IO error
4712 to avoid a "file has changed on disk" warning on
4713 next attempt to save. */
4715 current_buffer
->modtime
= st
.st_mtime
;
4718 error ("IO error writing %s: %s", SDATA (filename
),
4719 emacs_strerror (save_errno
));
4723 SAVE_MODIFF
= MODIFF
;
4724 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4725 current_buffer
->filename
= visit_file
;
4726 update_mode_lines
++;
4731 && ! NILP (Fstring_equal (current_buffer
->filename
,
4732 current_buffer
->auto_save_file_name
)))
4733 SAVE_MODIFF
= MODIFF
;
4739 message_with_string ((INTEGERP (append
)
4749 Lisp_Object
merge ();
4751 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4752 doc
: /* Return t if (car A) is numerically less than (car B). */)
4756 return Flss (Fcar (a
), Fcar (b
));
4759 /* Build the complete list of annotations appropriate for writing out
4760 the text between START and END, by calling all the functions in
4761 write-region-annotate-functions and merging the lists they return.
4762 If one of these functions switches to a different buffer, we assume
4763 that buffer contains altered text. Therefore, the caller must
4764 make sure to restore the current buffer in all cases,
4765 as save-excursion would do. */
4768 build_annotations (start
, end
)
4769 Lisp_Object start
, end
;
4771 Lisp_Object annotations
;
4773 struct gcpro gcpro1
, gcpro2
;
4774 Lisp_Object original_buffer
;
4775 int i
, used_global
= 0;
4777 XSETBUFFER (original_buffer
, current_buffer
);
4780 p
= Vwrite_region_annotate_functions
;
4781 GCPRO2 (annotations
, p
);
4784 struct buffer
*given_buffer
= current_buffer
;
4785 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4786 { /* Use the global value of the hook. */
4789 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4791 p
= Fappend (2, arg
);
4794 Vwrite_region_annotations_so_far
= annotations
;
4795 res
= call2 (XCAR (p
), start
, end
);
4796 /* If the function makes a different buffer current,
4797 assume that means this buffer contains altered text to be output.
4798 Reset START and END from the buffer bounds
4799 and discard all previous annotations because they should have
4800 been dealt with by this function. */
4801 if (current_buffer
!= given_buffer
)
4803 Vwrite_region_annotation_buffers
4804 = Fcons (Fcurrent_buffer (),
4805 Vwrite_region_annotation_buffers
);
4806 XSETFASTINT (start
, BEGV
);
4807 XSETFASTINT (end
, ZV
);
4810 Flength (res
); /* Check basic validity of return value */
4811 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4815 /* Now do the same for annotation functions implied by the file-format */
4816 if (auto_saving
&& (!EQ (current_buffer
->auto_save_file_format
, Qt
)))
4817 p
= current_buffer
->auto_save_file_format
;
4819 p
= current_buffer
->file_format
;
4820 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4822 struct buffer
*given_buffer
= current_buffer
;
4824 Vwrite_region_annotations_so_far
= annotations
;
4826 /* Value is either a list of annotations or nil if the function
4827 has written annotations to a temporary buffer, which is now
4829 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4830 original_buffer
, make_number (i
));
4831 if (current_buffer
!= given_buffer
)
4833 XSETFASTINT (start
, BEGV
);
4834 XSETFASTINT (end
, ZV
);
4839 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4847 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4848 If STRING is nil, POS is the character position in the current buffer.
4849 Intersperse with them the annotations from *ANNOT
4850 which fall within the range of POS to POS + NCHARS,
4851 each at its appropriate position.
4853 We modify *ANNOT by discarding elements as we use them up.
4855 The return value is negative in case of system call failure. */
4858 a_write (desc
, string
, pos
, nchars
, annot
, coding
)
4861 register int nchars
;
4864 struct coding_system
*coding
;
4868 int lastpos
= pos
+ nchars
;
4870 while (NILP (*annot
) || CONSP (*annot
))
4872 tem
= Fcar_safe (Fcar (*annot
));
4875 nextpos
= XFASTINT (tem
);
4877 /* If there are no more annotations in this range,
4878 output the rest of the range all at once. */
4879 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4880 return e_write (desc
, string
, pos
, lastpos
, coding
);
4882 /* Output buffer text up to the next annotation's position. */
4885 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4889 /* Output the annotation. */
4890 tem
= Fcdr (Fcar (*annot
));
4893 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4896 *annot
= Fcdr (*annot
);
4902 /* Write text in the range START and END into descriptor DESC,
4903 encoding them with coding system CODING. If STRING is nil, START
4904 and END are character positions of the current buffer, else they
4905 are indexes to the string STRING. */
4908 e_write (desc
, string
, start
, end
, coding
)
4912 struct coding_system
*coding
;
4914 if (STRINGP (string
))
4917 end
= SCHARS (string
);
4920 /* We used to have a code for handling selective display here. But,
4921 now it is handled within encode_coding. */
4925 if (STRINGP (string
))
4927 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
4928 if (CODING_REQUIRE_ENCODING (coding
))
4930 encode_coding_object (coding
, string
,
4931 start
, string_char_to_byte (string
, start
),
4932 end
, string_char_to_byte (string
, end
), Qt
);
4936 coding
->dst_object
= string
;
4937 coding
->consumed_char
= SCHARS (string
);
4938 coding
->produced
= SBYTES (string
);
4943 int start_byte
= CHAR_TO_BYTE (start
);
4944 int end_byte
= CHAR_TO_BYTE (end
);
4946 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
4947 if (CODING_REQUIRE_ENCODING (coding
))
4949 encode_coding_object (coding
, Fcurrent_buffer (),
4950 start
, start_byte
, end
, end_byte
, Qt
);
4954 coding
->dst_object
= Qnil
;
4955 coding
->dst_pos_byte
= start_byte
;
4956 if (start
>= GPT
|| end
<= GPT
)
4958 coding
->consumed_char
= end
- start
;
4959 coding
->produced
= end_byte
- start_byte
;
4963 coding
->consumed_char
= GPT
- start
;
4964 coding
->produced
= GPT_BYTE
- start_byte
;
4969 if (coding
->produced
> 0)
4973 STRINGP (coding
->dst_object
)
4974 ? SDATA (coding
->dst_object
)
4975 : BYTE_POS_ADDR (coding
->dst_pos_byte
),
4978 if (coding
->produced
)
4981 start
+= coding
->consumed_char
;
4987 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
4988 Sverify_visited_file_modtime
, 1, 1, 0,
4989 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
4990 This means that the file has not been changed since it was visited or saved.
4991 See Info node `(elisp)Modification Time' for more details. */)
4997 Lisp_Object handler
;
4998 Lisp_Object filename
;
5003 if (!STRINGP (b
->filename
)) return Qt
;
5004 if (b
->modtime
== 0) return Qt
;
5006 /* If the file name has special constructs in it,
5007 call the corresponding file handler. */
5008 handler
= Ffind_file_name_handler (b
->filename
,
5009 Qverify_visited_file_modtime
);
5010 if (!NILP (handler
))
5011 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5013 filename
= ENCODE_FILE (b
->filename
);
5015 if (stat (SDATA (filename
), &st
) < 0)
5017 /* If the file doesn't exist now and didn't exist before,
5018 we say that it isn't modified, provided the error is a tame one. */
5019 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
5024 if (st
.st_mtime
== b
->modtime
5025 /* If both are positive, accept them if they are off by one second. */
5026 || (st
.st_mtime
> 0 && b
->modtime
> 0
5027 && (st
.st_mtime
== b
->modtime
+ 1
5028 || st
.st_mtime
== b
->modtime
- 1)))
5033 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5034 Sclear_visited_file_modtime
, 0, 0, 0,
5035 doc
: /* Clear out records of last mod time of visited file.
5036 Next attempt to save will certainly not complain of a discrepancy. */)
5039 current_buffer
->modtime
= 0;
5043 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5044 Svisited_file_modtime
, 0, 0, 0,
5045 doc
: /* Return the current buffer's recorded visited file modification time.
5046 The value is a list of the form (HIGH LOW), like the time values
5047 that `file-attributes' returns. If the current buffer has no recorded
5048 file modification time, this function returns 0.
5049 See Info node `(elisp)Modification Time' for more details. */)
5052 if (! current_buffer
->modtime
)
5053 return make_number (0);
5054 return make_time ((time_t) current_buffer
->modtime
);
5057 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5058 Sset_visited_file_modtime
, 0, 1, 0,
5059 doc
: /* Update buffer's recorded modification time from the visited file's time.
5060 Useful if the buffer was not read from the file normally
5061 or if the file itself has been changed for some known benign reason.
5062 An argument specifies the modification time value to use
5063 \(instead of that of the visited file), in the form of a list
5064 \(HIGH . LOW) or (HIGH LOW). */)
5066 Lisp_Object time_list
;
5068 if (!NILP (time_list
))
5069 current_buffer
->modtime
= cons_to_long (time_list
);
5072 register Lisp_Object filename
;
5074 Lisp_Object handler
;
5076 filename
= Fexpand_file_name (current_buffer
->filename
, Qnil
);
5078 /* If the file name has special constructs in it,
5079 call the corresponding file handler. */
5080 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5081 if (!NILP (handler
))
5082 /* The handler can find the file name the same way we did. */
5083 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5085 filename
= ENCODE_FILE (filename
);
5087 if (stat (SDATA (filename
), &st
) >= 0)
5088 current_buffer
->modtime
= st
.st_mtime
;
5095 auto_save_error (error
)
5098 Lisp_Object args
[3], msg
;
5100 struct gcpro gcpro1
;
5104 auto_save_error_occurred
= 1;
5106 ring_bell (XFRAME (selected_frame
));
5108 args
[0] = build_string ("Auto-saving %s: %s");
5109 args
[1] = current_buffer
->name
;
5110 args
[2] = Ferror_message_string (error
);
5111 msg
= Fformat (3, args
);
5113 nbytes
= SBYTES (msg
);
5114 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5115 bcopy (SDATA (msg
), msgbuf
, nbytes
);
5117 for (i
= 0; i
< 3; ++i
)
5120 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5122 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5123 Fsleep_for (make_number (1), Qnil
);
5137 auto_save_mode_bits
= 0666;
5139 /* Get visited file's mode to become the auto save file's mode. */
5140 if (! NILP (current_buffer
->filename
))
5142 if (stat (SDATA (current_buffer
->filename
), &st
) >= 0)
5143 /* But make sure we can overwrite it later! */
5144 auto_save_mode_bits
= st
.st_mode
| 0600;
5145 else if ((modes
= Ffile_modes (current_buffer
->filename
),
5147 /* Remote files don't cooperate with stat. */
5148 auto_save_mode_bits
= XINT (modes
) | 0600;
5152 Fwrite_region (Qnil
, Qnil
, current_buffer
->auto_save_file_name
, Qnil
,
5153 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5158 do_auto_save_unwind (arg
) /* used as unwind-protect function */
5161 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5173 do_auto_save_unwind_1 (value
) /* used as unwind-protect function */
5176 minibuffer_auto_raise
= XINT (value
);
5181 do_auto_save_make_dir (dir
)
5186 call2 (Qmake_directory
, dir
, Qt
);
5187 XSETFASTINT (mode
, 0700);
5188 return Fset_file_modes (dir
, mode
);
5192 do_auto_save_eh (ignore
)
5198 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5199 doc
: /* Auto-save all buffers that need it.
5200 This is all buffers that have auto-saving enabled
5201 and are changed since last auto-saved.
5202 Auto-saving writes the buffer into a file
5203 so that your editing is not lost if the system crashes.
5204 This file is not the file you visited; that changes only when you save.
5205 Normally we run the normal hook `auto-save-hook' before saving.
5207 A non-nil NO-MESSAGE argument means do not print any message if successful.
5208 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5209 (no_message
, current_only
)
5210 Lisp_Object no_message
, current_only
;
5212 struct buffer
*old
= current_buffer
, *b
;
5213 Lisp_Object tail
, buf
;
5215 int do_handled_files
;
5217 FILE *stream
= NULL
;
5218 int count
= SPECPDL_INDEX ();
5219 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5220 int old_message_p
= 0;
5221 struct gcpro gcpro1
, gcpro2
;
5223 if (max_specpdl_size
< specpdl_size
+ 40)
5224 max_specpdl_size
= specpdl_size
+ 40;
5229 if (NILP (no_message
))
5231 old_message_p
= push_message ();
5232 record_unwind_protect (pop_message_unwind
, Qnil
);
5235 /* Ordinarily don't quit within this function,
5236 but don't make it impossible to quit (in case we get hung in I/O). */
5240 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5241 point to non-strings reached from Vbuffer_alist. */
5243 if (!NILP (Vrun_hooks
))
5244 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5246 if (STRINGP (Vauto_save_list_file_name
))
5248 Lisp_Object listfile
;
5250 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5252 /* Don't try to create the directory when shutting down Emacs,
5253 because creating the directory might signal an error, and
5254 that would leave Emacs in a strange state. */
5255 if (!NILP (Vrun_hooks
))
5259 GCPRO2 (dir
, listfile
);
5260 dir
= Ffile_name_directory (listfile
);
5261 if (NILP (Ffile_directory_p (dir
)))
5262 internal_condition_case_1 (do_auto_save_make_dir
,
5263 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5268 stream
= fopen (SDATA (listfile
), "w");
5271 record_unwind_protect (do_auto_save_unwind
,
5272 make_save_value (stream
, 0));
5273 record_unwind_protect (do_auto_save_unwind_1
,
5274 make_number (minibuffer_auto_raise
));
5275 minibuffer_auto_raise
= 0;
5277 auto_save_error_occurred
= 0;
5279 /* On first pass, save all files that don't have handlers.
5280 On second pass, save all files that do have handlers.
5282 If Emacs is crashing, the handlers may tweak what is causing
5283 Emacs to crash in the first place, and it would be a shame if
5284 Emacs failed to autosave perfectly ordinary files because it
5285 couldn't handle some ange-ftp'd file. */
5287 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5288 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5290 buf
= XCDR (XCAR (tail
));
5293 /* Record all the buffers that have auto save mode
5294 in the special file that lists them. For each of these buffers,
5295 Record visited name (if any) and auto save name. */
5296 if (STRINGP (b
->auto_save_file_name
)
5297 && stream
!= NULL
&& do_handled_files
== 0)
5300 if (!NILP (b
->filename
))
5302 fwrite (SDATA (b
->filename
), 1,
5303 SBYTES (b
->filename
), stream
);
5305 putc ('\n', stream
);
5306 fwrite (SDATA (b
->auto_save_file_name
), 1,
5307 SBYTES (b
->auto_save_file_name
), stream
);
5308 putc ('\n', stream
);
5312 if (!NILP (current_only
)
5313 && b
!= current_buffer
)
5316 /* Don't auto-save indirect buffers.
5317 The base buffer takes care of it. */
5321 /* Check for auto save enabled
5322 and file changed since last auto save
5323 and file changed since last real save. */
5324 if (STRINGP (b
->auto_save_file_name
)
5325 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5326 && BUF_AUTOSAVE_MODIFF (b
) < BUF_MODIFF (b
)
5327 /* -1 means we've turned off autosaving for a while--see below. */
5328 && XINT (b
->save_length
) >= 0
5329 && (do_handled_files
5330 || NILP (Ffind_file_name_handler (b
->auto_save_file_name
,
5333 EMACS_TIME before_time
, after_time
;
5335 EMACS_GET_TIME (before_time
);
5337 /* If we had a failure, don't try again for 20 minutes. */
5338 if (b
->auto_save_failure_time
>= 0
5339 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5342 set_buffer_internal (b
);
5343 if (NILP (Vauto_save_include_big_deletions
)
5344 && (XFASTINT (b
->save_length
) * 10
5345 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5346 /* A short file is likely to change a large fraction;
5347 spare the user annoying messages. */
5348 && XFASTINT (b
->save_length
) > 5000
5349 /* These messages are frequent and annoying for `*mail*'. */
5350 && !EQ (b
->filename
, Qnil
)
5351 && NILP (no_message
))
5353 /* It has shrunk too much; turn off auto-saving here. */
5354 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5355 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5357 minibuffer_auto_raise
= 0;
5358 /* Turn off auto-saving until there's a real save,
5359 and prevent any more warnings. */
5360 XSETINT (b
->save_length
, -1);
5361 Fsleep_for (make_number (1), Qnil
);
5364 if (!auto_saved
&& NILP (no_message
))
5365 message1 ("Auto-saving...");
5366 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5368 BUF_AUTOSAVE_MODIFF (b
) = BUF_MODIFF (b
);
5369 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5370 set_buffer_internal (old
);
5372 EMACS_GET_TIME (after_time
);
5374 /* If auto-save took more than 60 seconds,
5375 assume it was an NFS failure that got a timeout. */
5376 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5377 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5381 /* Prevent another auto save till enough input events come in. */
5382 record_auto_save ();
5384 if (auto_saved
&& NILP (no_message
))
5388 /* If we are going to restore an old message,
5389 give time to read ours. */
5390 sit_for (make_number (1), 0, 0);
5393 else if (!auto_save_error_occurred
)
5394 /* Don't overwrite the error message if an error occurred.
5395 If we displayed a message and then restored a state
5396 with no message, leave a "done" message on the screen. */
5397 message1 ("Auto-saving...done");
5402 /* This restores the message-stack status. */
5403 unbind_to (count
, Qnil
);
5407 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5408 Sset_buffer_auto_saved
, 0, 0, 0,
5409 doc
: /* Mark current buffer as auto-saved with its current text.
5410 No auto-save file will be written until the buffer changes again. */)
5413 /* FIXME: This should not be called in indirect buffers, since
5414 they're not autosaved. */
5415 BUF_AUTOSAVE_MODIFF (current_buffer
) = MODIFF
;
5416 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5417 current_buffer
->auto_save_failure_time
= -1;
5421 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5422 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5423 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5426 current_buffer
->auto_save_failure_time
= -1;
5430 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5432 doc
: /* Return t if current buffer has been auto-saved recently.
5433 More precisely, if it has been auto-saved since last read from or saved
5434 in the visited file. If the buffer has no visited file,
5435 then any auto-save counts as "recent". */)
5438 /* FIXME: maybe we should return nil for indirect buffers since
5439 they're never autosaved. */
5440 return (SAVE_MODIFF
< BUF_AUTOSAVE_MODIFF (current_buffer
) ? Qt
: Qnil
);
5443 /* Reading and completing file names */
5445 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5446 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5447 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5448 The return value is only relevant for a call to `read-file-name' that happens
5449 before any other event (mouse or keypress) is handled. */)
5452 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5453 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5463 Fread_file_name (prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
)
5464 Lisp_Object prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
;
5466 struct gcpro gcpro1
, gcpro2
;
5467 Lisp_Object args
[7];
5469 GCPRO1 (default_filename
);
5470 args
[0] = intern ("read-file-name");
5473 args
[3] = default_filename
;
5474 args
[4] = mustmatch
;
5476 args
[6] = predicate
;
5477 RETURN_UNGCPRO (Ffuncall (7, args
));
5484 Qoperations
= intern_c_string ("operations");
5485 Qexpand_file_name
= intern_c_string ("expand-file-name");
5486 Qsubstitute_in_file_name
= intern_c_string ("substitute-in-file-name");
5487 Qdirectory_file_name
= intern_c_string ("directory-file-name");
5488 Qfile_name_directory
= intern_c_string ("file-name-directory");
5489 Qfile_name_nondirectory
= intern_c_string ("file-name-nondirectory");
5490 Qunhandled_file_name_directory
= intern_c_string ("unhandled-file-name-directory");
5491 Qfile_name_as_directory
= intern_c_string ("file-name-as-directory");
5492 Qcopy_file
= intern_c_string ("copy-file");
5493 Qmake_directory_internal
= intern_c_string ("make-directory-internal");
5494 Qmake_directory
= intern_c_string ("make-directory");
5495 Qdelete_directory_internal
= intern_c_string ("delete-directory-internal");
5496 Qdelete_file
= intern_c_string ("delete-file");
5497 Qrename_file
= intern_c_string ("rename-file");
5498 Qadd_name_to_file
= intern_c_string ("add-name-to-file");
5499 Qmake_symbolic_link
= intern_c_string ("make-symbolic-link");
5500 Qfile_exists_p
= intern_c_string ("file-exists-p");
5501 Qfile_executable_p
= intern_c_string ("file-executable-p");
5502 Qfile_readable_p
= intern_c_string ("file-readable-p");
5503 Qfile_writable_p
= intern_c_string ("file-writable-p");
5504 Qfile_symlink_p
= intern_c_string ("file-symlink-p");
5505 Qaccess_file
= intern_c_string ("access-file");
5506 Qfile_directory_p
= intern_c_string ("file-directory-p");
5507 Qfile_regular_p
= intern_c_string ("file-regular-p");
5508 Qfile_accessible_directory_p
= intern_c_string ("file-accessible-directory-p");
5509 Qfile_modes
= intern_c_string ("file-modes");
5510 Qset_file_modes
= intern_c_string ("set-file-modes");
5511 Qset_file_times
= intern_c_string ("set-file-times");
5512 Qfile_newer_than_file_p
= intern_c_string ("file-newer-than-file-p");
5513 Qinsert_file_contents
= intern_c_string ("insert-file-contents");
5514 Qwrite_region
= intern_c_string ("write-region");
5515 Qverify_visited_file_modtime
= intern_c_string ("verify-visited-file-modtime");
5516 Qset_visited_file_modtime
= intern_c_string ("set-visited-file-modtime");
5517 Qauto_save_coding
= intern_c_string ("auto-save-coding");
5519 staticpro (&Qoperations
);
5520 staticpro (&Qexpand_file_name
);
5521 staticpro (&Qsubstitute_in_file_name
);
5522 staticpro (&Qdirectory_file_name
);
5523 staticpro (&Qfile_name_directory
);
5524 staticpro (&Qfile_name_nondirectory
);
5525 staticpro (&Qunhandled_file_name_directory
);
5526 staticpro (&Qfile_name_as_directory
);
5527 staticpro (&Qcopy_file
);
5528 staticpro (&Qmake_directory_internal
);
5529 staticpro (&Qmake_directory
);
5530 staticpro (&Qdelete_directory_internal
);
5531 staticpro (&Qdelete_file
);
5532 staticpro (&Qrename_file
);
5533 staticpro (&Qadd_name_to_file
);
5534 staticpro (&Qmake_symbolic_link
);
5535 staticpro (&Qfile_exists_p
);
5536 staticpro (&Qfile_executable_p
);
5537 staticpro (&Qfile_readable_p
);
5538 staticpro (&Qfile_writable_p
);
5539 staticpro (&Qaccess_file
);
5540 staticpro (&Qfile_symlink_p
);
5541 staticpro (&Qfile_directory_p
);
5542 staticpro (&Qfile_regular_p
);
5543 staticpro (&Qfile_accessible_directory_p
);
5544 staticpro (&Qfile_modes
);
5545 staticpro (&Qset_file_modes
);
5546 staticpro (&Qset_file_times
);
5547 staticpro (&Qfile_newer_than_file_p
);
5548 staticpro (&Qinsert_file_contents
);
5549 staticpro (&Qwrite_region
);
5550 staticpro (&Qverify_visited_file_modtime
);
5551 staticpro (&Qset_visited_file_modtime
);
5552 staticpro (&Qauto_save_coding
);
5554 Qfile_name_history
= intern_c_string ("file-name-history");
5555 Fset (Qfile_name_history
, Qnil
);
5556 staticpro (&Qfile_name_history
);
5558 Qfile_error
= intern_c_string ("file-error");
5559 staticpro (&Qfile_error
);
5560 Qfile_already_exists
= intern_c_string ("file-already-exists");
5561 staticpro (&Qfile_already_exists
);
5562 Qfile_date_error
= intern_c_string ("file-date-error");
5563 staticpro (&Qfile_date_error
);
5564 Qexcl
= intern_c_string ("excl");
5568 Qfind_buffer_file_type
= intern_c_string ("find-buffer-file-type");
5569 staticpro (&Qfind_buffer_file_type
);
5572 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system
,
5573 doc
: /* *Coding system for encoding file names.
5574 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5575 Vfile_name_coding_system
= Qnil
;
5577 DEFVAR_LISP ("default-file-name-coding-system",
5578 &Vdefault_file_name_coding_system
,
5579 doc
: /* Default coding system for encoding file names.
5580 This variable is used only when `file-name-coding-system' is nil.
5582 This variable is set/changed by the command `set-language-environment'.
5583 User should not set this variable manually,
5584 instead use `file-name-coding-system' to get a constant encoding
5585 of file names regardless of the current language environment. */);
5586 Vdefault_file_name_coding_system
= Qnil
;
5588 Qformat_decode
= intern_c_string ("format-decode");
5589 staticpro (&Qformat_decode
);
5590 Qformat_annotate_function
= intern_c_string ("format-annotate-function");
5591 staticpro (&Qformat_annotate_function
);
5592 Qafter_insert_file_set_coding
= intern_c_string ("after-insert-file-set-coding");
5593 staticpro (&Qafter_insert_file_set_coding
);
5595 Qcar_less_than_car
= intern_c_string ("car-less-than-car");
5596 staticpro (&Qcar_less_than_car
);
5598 Fput (Qfile_error
, Qerror_conditions
,
5599 Fpurecopy (list2 (Qfile_error
, Qerror
)));
5600 Fput (Qfile_error
, Qerror_message
,
5601 make_pure_c_string ("File error"));
5603 Fput (Qfile_already_exists
, Qerror_conditions
,
5604 Fpurecopy (list3 (Qfile_already_exists
, Qfile_error
, Qerror
)));
5605 Fput (Qfile_already_exists
, Qerror_message
,
5606 make_pure_c_string ("File already exists"));
5608 Fput (Qfile_date_error
, Qerror_conditions
,
5609 Fpurecopy (list3 (Qfile_date_error
, Qfile_error
, Qerror
)));
5610 Fput (Qfile_date_error
, Qerror_message
,
5611 make_pure_c_string ("Cannot set file date"));
5613 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char
,
5614 doc
: /* Directory separator character for built-in functions that return file names.
5615 The value is always ?/. Don't use this variable, just use `/'. */);
5616 XSETFASTINT (Vdirectory_sep_char
, '/');
5618 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist
,
5619 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
5620 If a file name matches REGEXP, then all I/O on that file is done by calling
5623 The first argument given to HANDLER is the name of the I/O primitive
5624 to be handled; the remaining arguments are the arguments that were
5625 passed to that primitive. For example, if you do
5626 (file-exists-p FILENAME)
5627 and FILENAME is handled by HANDLER, then HANDLER is called like this:
5628 (funcall HANDLER 'file-exists-p FILENAME)
5629 The function `find-file-name-handler' checks this list for a handler
5630 for its argument. */);
5631 Vfile_name_handler_alist
= Qnil
;
5633 DEFVAR_LISP ("set-auto-coding-function",
5634 &Vset_auto_coding_function
,
5635 doc
: /* If non-nil, a function to call to decide a coding system of file.
5636 Two arguments are passed to this function: the file name
5637 and the length of a file contents following the point.
5638 This function should return a coding system to decode the file contents.
5639 It should check the file name against `auto-coding-alist'.
5640 If no coding system is decided, it should check a coding system
5641 specified in the heading lines with the format:
5642 -*- ... coding: CODING-SYSTEM; ... -*-
5643 or local variable spec of the tailing lines with `coding:' tag. */);
5644 Vset_auto_coding_function
= Qnil
;
5646 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions
,
5647 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5648 Each is passed one argument, the number of characters inserted,
5649 with point at the start of the inserted text. Each function
5650 should leave point the same, and return the new character count.
5651 If `insert-file-contents' is intercepted by a handler from
5652 `file-name-handler-alist', that handler is responsible for calling the
5653 functions in `after-insert-file-functions' if appropriate. */);
5654 Vafter_insert_file_functions
= Qnil
;
5656 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions
,
5657 doc
: /* A list of functions to be called at the start of `write-region'.
5658 Each is passed two arguments, START and END as for `write-region'.
5659 These are usually two numbers but not always; see the documentation
5660 for `write-region'. The function should return a list of pairs
5661 of the form (POSITION . STRING), consisting of strings to be effectively
5662 inserted at the specified positions of the file being written (1 means to
5663 insert before the first byte written). The POSITIONs must be sorted into
5666 If there are several annotation functions, the lists returned by these
5667 functions are merged destructively. As each annotation function runs,
5668 the variable `write-region-annotations-so-far' contains a list of all
5669 annotations returned by previous annotation functions.
5671 An annotation function can return with a different buffer current.
5672 Doing so removes the annotations returned by previous functions, and
5673 resets START and END to `point-min' and `point-max' of the new buffer.
5675 After `write-region' completes, Emacs calls the function stored in
5676 `write-region-post-annotation-function', once for each buffer that was
5677 current when building the annotations (i.e., at least once), with that
5678 buffer current. */);
5679 Vwrite_region_annotate_functions
= Qnil
;
5680 staticpro (&Qwrite_region_annotate_functions
);
5681 Qwrite_region_annotate_functions
5682 = intern_c_string ("write-region-annotate-functions");
5684 DEFVAR_LISP ("write-region-post-annotation-function",
5685 &Vwrite_region_post_annotation_function
,
5686 doc
: /* Function to call after `write-region' completes.
5687 The function is called with no arguments. If one or more of the
5688 annotation functions in `write-region-annotate-functions' changed the
5689 current buffer, the function stored in this variable is called for
5690 each of those additional buffers as well, in addition to the original
5691 buffer. The relevant buffer is current during each function call. */);
5692 Vwrite_region_post_annotation_function
= Qnil
;
5693 staticpro (&Vwrite_region_annotation_buffers
);
5695 DEFVAR_LISP ("write-region-annotations-so-far",
5696 &Vwrite_region_annotations_so_far
,
5697 doc
: /* When an annotation function is called, this holds the previous annotations.
5698 These are the annotations made by other annotation functions
5699 that were already called. See also `write-region-annotate-functions'. */);
5700 Vwrite_region_annotations_so_far
= Qnil
;
5702 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers
,
5703 doc
: /* A list of file name handlers that temporarily should not be used.
5704 This applies only to the operation `inhibit-file-name-operation'. */);
5705 Vinhibit_file_name_handlers
= Qnil
;
5707 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation
,
5708 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5709 Vinhibit_file_name_operation
= Qnil
;
5711 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name
,
5712 doc
: /* File name in which we write a list of all auto save file names.
5713 This variable is initialized automatically from `auto-save-list-file-prefix'
5714 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5715 a non-nil value. */);
5716 Vauto_save_list_file_name
= Qnil
;
5718 DEFVAR_LISP ("auto-save-visited-file-name", &Vauto_save_visited_file_name
,
5719 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5720 Normally auto-save files are written under other names. */);
5721 Vauto_save_visited_file_name
= Qnil
;
5723 DEFVAR_LISP ("auto-save-include-big-deletions", &Vauto_save_include_big_deletions
,
5724 doc
: /* If non-nil, auto-save even if a large part of the text is deleted.
5725 If nil, deleting a substantial portion of the text disables auto-save
5726 in the buffer; this is the default behavior, because the auto-save
5727 file is usually more useful if it contains the deleted text. */);
5728 Vauto_save_include_big_deletions
= Qnil
;
5731 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync
,
5732 doc
: /* *Non-nil means don't call fsync in `write-region'.
5733 This variable affects calls to `write-region' as well as save commands.
5734 A non-nil value may result in data loss! */);
5735 write_region_inhibit_fsync
= 0;
5738 DEFVAR_BOOL ("delete-by-moving-to-trash", &delete_by_moving_to_trash
,
5739 doc
: /* Specifies whether to use the system's trash can.
5740 When non-nil, the function `move-file-to-trash' will be used by
5741 `delete-file' and `delete-directory'. */);
5742 delete_by_moving_to_trash
= 0;
5743 Qdelete_by_moving_to_trash
= intern_c_string ("delete-by-moving-to-trash");
5744 Qmove_file_to_trash
= intern_c_string ("move-file-to-trash");
5745 staticpro (&Qmove_file_to_trash
);
5746 Qcopy_directory
= intern_c_string ("copy-directory");
5747 staticpro (&Qcopy_directory
);
5748 Qdelete_directory
= intern_c_string ("delete-directory");
5749 staticpro (&Qdelete_directory
);
5751 defsubr (&Sfind_file_name_handler
);
5752 defsubr (&Sfile_name_directory
);
5753 defsubr (&Sfile_name_nondirectory
);
5754 defsubr (&Sunhandled_file_name_directory
);
5755 defsubr (&Sfile_name_as_directory
);
5756 defsubr (&Sdirectory_file_name
);
5757 defsubr (&Smake_temp_name
);
5758 defsubr (&Sexpand_file_name
);
5759 defsubr (&Ssubstitute_in_file_name
);
5760 defsubr (&Scopy_file
);
5761 defsubr (&Smake_directory_internal
);
5762 defsubr (&Sdelete_directory_internal
);
5763 defsubr (&Sdelete_file
);
5764 defsubr (&Srename_file
);
5765 defsubr (&Sadd_name_to_file
);
5766 defsubr (&Smake_symbolic_link
);
5767 defsubr (&Sfile_name_absolute_p
);
5768 defsubr (&Sfile_exists_p
);
5769 defsubr (&Sfile_executable_p
);
5770 defsubr (&Sfile_readable_p
);
5771 defsubr (&Sfile_writable_p
);
5772 defsubr (&Saccess_file
);
5773 defsubr (&Sfile_symlink_p
);
5774 defsubr (&Sfile_directory_p
);
5775 defsubr (&Sfile_accessible_directory_p
);
5776 defsubr (&Sfile_regular_p
);
5777 defsubr (&Sfile_modes
);
5778 defsubr (&Sset_file_modes
);
5779 defsubr (&Sset_file_times
);
5780 defsubr (&Sset_default_file_modes
);
5781 defsubr (&Sdefault_file_modes
);
5782 defsubr (&Sfile_newer_than_file_p
);
5783 defsubr (&Sinsert_file_contents
);
5784 defsubr (&Swrite_region
);
5785 defsubr (&Scar_less_than_car
);
5786 defsubr (&Sverify_visited_file_modtime
);
5787 defsubr (&Sclear_visited_file_modtime
);
5788 defsubr (&Svisited_file_modtime
);
5789 defsubr (&Sset_visited_file_modtime
);
5790 defsubr (&Sdo_auto_save
);
5791 defsubr (&Sset_buffer_auto_saved
);
5792 defsubr (&Sclear_buffer_auto_save_failure
);
5793 defsubr (&Srecent_auto_save_p
);
5795 defsubr (&Snext_read_file_uses_dialog_p
);
5798 defsubr (&Sunix_sync
);
5802 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
5803 (do not change this comment) */