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 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 #include <sys/types.h>
36 #if !defined (S_ISLNK) && defined (S_IFLNK)
37 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
40 #if !defined (S_ISFIFO) && defined (S_IFIFO)
41 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
44 #if !defined (S_ISREG) && defined (S_IFREG)
45 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
62 #include "intervals.h"
64 #include "character.h"
67 #include "blockinput.h"
69 #include "dispextern.h"
76 #endif /* not WINDOWSNT */
80 #include <sys/param.h>
88 #define CORRECT_DIR_SEPS(s) \
89 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
90 else unixtodos_filename (s); \
92 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
93 redirector allows the six letters between 'Z' and 'a' as well. */
95 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
98 #define IS_DRIVE(x) isalpha (x)
100 /* Need to lower-case the drive letter, or else expanded
101 filenames will sometimes compare inequal, because
102 `expand-file-name' doesn't always down-case the drive letter. */
103 #define DRIVE_LETTER(x) (tolower (x))
112 #include "commands.h"
113 extern int use_dialog_box
;
114 extern int use_file_dialog
;
128 #ifndef FILE_SYSTEM_CASE
129 #define FILE_SYSTEM_CASE(filename) (filename)
132 /* Nonzero during writing of auto-save files */
135 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
136 a new file with the same mode as the original */
137 int auto_save_mode_bits
;
139 /* Set by auto_save_1 if an error occurred during the last auto-save. */
140 int auto_save_error_occurred
;
142 /* The symbol bound to coding-system-for-read when
143 insert-file-contents is called for recovering a file. This is not
144 an actual coding system name, but just an indicator to tell
145 insert-file-contents to use `emacs-mule' with a special flag for
146 auto saving and recovering a file. */
147 Lisp_Object Qauto_save_coding
;
149 /* Coding system for file names, or nil if none. */
150 Lisp_Object Vfile_name_coding_system
;
152 /* Coding system for file names used only when
153 Vfile_name_coding_system is nil. */
154 Lisp_Object Vdefault_file_name_coding_system
;
156 /* Alist of elements (REGEXP . HANDLER) for file names
157 whose I/O is done with a special handler. */
158 Lisp_Object Vfile_name_handler_alist
;
160 /* Property name of a file name handler,
161 which gives a list of operations it handles.. */
162 Lisp_Object Qoperations
;
164 /* Lisp functions for translating file formats */
165 Lisp_Object Qformat_decode
, Qformat_annotate_function
;
167 /* Function to be called to decide a coding system of a reading file. */
168 Lisp_Object Vset_auto_coding_function
;
170 /* Functions to be called to process text properties in inserted file. */
171 Lisp_Object Vafter_insert_file_functions
;
173 /* Lisp function for setting buffer-file-coding-system and the
174 multibyteness of the current buffer after inserting a file. */
175 Lisp_Object Qafter_insert_file_set_coding
;
177 /* Functions to be called to create text property annotations for file. */
178 Lisp_Object Vwrite_region_annotate_functions
;
179 Lisp_Object Qwrite_region_annotate_functions
;
181 /* During build_annotations, each time an annotation function is called,
182 this holds the annotations made by the previous functions. */
183 Lisp_Object Vwrite_region_annotations_so_far
;
185 /* File name in which we write a list of all our auto save files. */
186 Lisp_Object Vauto_save_list_file_name
;
188 /* Whether or not files are auto-saved into themselves. */
189 Lisp_Object Vauto_save_visited_file_name
;
191 /* On NT, specifies the directory separator character, used (eg.) when
192 expanding file names. This can be bound to / or \. */
193 Lisp_Object Vdirectory_sep_char
;
196 /* Nonzero means skip the call to fsync in Fwrite-region. */
197 int write_region_inhibit_fsync
;
200 /* Non-zero means call move-file-to-trash in Fdelete_file or
201 Fdelete_directory. */
202 int delete_by_moving_to_trash
;
204 Lisp_Object Qdelete_by_moving_to_trash
;
206 /* Lisp function for moving files to trash. */
207 Lisp_Object Qmove_file_to_trash
;
209 extern Lisp_Object Vuser_login_name
;
212 extern Lisp_Object Vw32_get_true_file_attributes
;
215 extern int minibuf_level
;
217 extern int minibuffer_auto_raise
;
219 extern int history_delete_duplicates
;
221 /* These variables describe handlers that have "already" had a chance
222 to handle the current operation.
224 Vinhibit_file_name_handlers is a list of file name handlers.
225 Vinhibit_file_name_operation is the operation being handled.
226 If we try to handle that operation, we ignore those handlers. */
228 static Lisp_Object Vinhibit_file_name_handlers
;
229 static Lisp_Object Vinhibit_file_name_operation
;
231 Lisp_Object Qfile_error
, Qfile_already_exists
, Qfile_date_error
;
233 Lisp_Object Qfile_name_history
;
235 Lisp_Object Qcar_less_than_car
;
237 static int a_write
P_ ((int, Lisp_Object
, int, int,
238 Lisp_Object
*, struct coding_system
*));
239 static int e_write
P_ ((int, Lisp_Object
, int, int, struct coding_system
*));
243 report_file_error (string
, data
)
247 Lisp_Object errstring
;
251 synchronize_system_messages_locale ();
252 str
= strerror (errorno
);
253 errstring
= code_convert_string_norecord (make_unibyte_string (str
,
255 Vlocale_coding_system
, 0);
261 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
264 /* System error messages are capitalized. Downcase the initial
265 unless it is followed by a slash. (The slash case caters to
266 error messages that begin with "I/O" or, in German, "E/A".) */
267 if (STRING_MULTIBYTE (errstring
)
268 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
272 str
= (char *) SDATA (errstring
);
273 c
= STRING_CHAR (str
, 0);
274 Faset (errstring
, make_number (0), make_number (DOWNCASE (c
)));
277 xsignal (Qfile_error
,
278 Fcons (build_string (string
), Fcons (errstring
, data
)));
283 close_file_unwind (fd
)
286 emacs_close (XFASTINT (fd
));
290 /* Restore point, having saved it as a marker. */
293 restore_point_unwind (location
)
294 Lisp_Object location
;
296 Fgoto_char (location
);
297 Fset_marker (location
, Qnil
, Qnil
);
302 Lisp_Object Qexpand_file_name
;
303 Lisp_Object Qsubstitute_in_file_name
;
304 Lisp_Object Qdirectory_file_name
;
305 Lisp_Object Qfile_name_directory
;
306 Lisp_Object Qfile_name_nondirectory
;
307 Lisp_Object Qunhandled_file_name_directory
;
308 Lisp_Object Qfile_name_as_directory
;
309 Lisp_Object Qcopy_file
;
310 Lisp_Object Qmake_directory_internal
;
311 Lisp_Object Qmake_directory
;
312 Lisp_Object Qdelete_directory
;
313 Lisp_Object Qdelete_file
;
314 Lisp_Object Qrename_file
;
315 Lisp_Object Qadd_name_to_file
;
316 Lisp_Object Qmake_symbolic_link
;
317 Lisp_Object Qfile_exists_p
;
318 Lisp_Object Qfile_executable_p
;
319 Lisp_Object Qfile_readable_p
;
320 Lisp_Object Qfile_writable_p
;
321 Lisp_Object Qfile_symlink_p
;
322 Lisp_Object Qaccess_file
;
323 Lisp_Object Qfile_directory_p
;
324 Lisp_Object Qfile_regular_p
;
325 Lisp_Object Qfile_accessible_directory_p
;
326 Lisp_Object Qfile_modes
;
327 Lisp_Object Qset_file_modes
;
328 Lisp_Object Qset_file_times
;
329 Lisp_Object Qfile_newer_than_file_p
;
330 Lisp_Object Qinsert_file_contents
;
331 Lisp_Object Qwrite_region
;
332 Lisp_Object Qverify_visited_file_modtime
;
333 Lisp_Object Qset_visited_file_modtime
;
335 DEFUN ("find-file-name-handler", Ffind_file_name_handler
, Sfind_file_name_handler
, 2, 2, 0,
336 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
337 Otherwise, return nil.
338 A file name is handled if one of the regular expressions in
339 `file-name-handler-alist' matches it.
341 If OPERATION equals `inhibit-file-name-operation', then we ignore
342 any handlers that are members of `inhibit-file-name-handlers',
343 but we still do run any other handlers. This lets handlers
344 use the standard functions without calling themselves recursively. */)
345 (filename
, operation
)
346 Lisp_Object filename
, operation
;
348 /* This function must not munge the match data. */
349 Lisp_Object chain
, inhibited_handlers
, result
;
353 CHECK_STRING (filename
);
355 if (EQ (operation
, Vinhibit_file_name_operation
))
356 inhibited_handlers
= Vinhibit_file_name_handlers
;
358 inhibited_handlers
= Qnil
;
360 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
361 chain
= XCDR (chain
))
367 Lisp_Object string
= XCAR (elt
);
369 Lisp_Object handler
= XCDR (elt
);
370 Lisp_Object operations
= Qnil
;
372 if (SYMBOLP (handler
))
373 operations
= Fget (handler
, Qoperations
);
376 && (match_pos
= fast_string_match (string
, filename
)) > pos
377 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
381 handler
= XCDR (elt
);
382 tem
= Fmemq (handler
, inhibited_handlers
);
396 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
398 doc
: /* Return the directory component in file name FILENAME.
399 Return nil if FILENAME does not include a directory.
400 Otherwise return a directory name.
401 Given a Unix syntax file name, returns a string ending in slash. */)
403 Lisp_Object filename
;
406 register const unsigned char *beg
;
408 register unsigned char *beg
;
410 register const unsigned char *p
;
413 CHECK_STRING (filename
);
415 /* If the file name has special constructs in it,
416 call the corresponding file handler. */
417 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
419 return call2 (handler
, Qfile_name_directory
, filename
);
421 filename
= FILE_SYSTEM_CASE (filename
);
422 beg
= SDATA (filename
);
424 beg
= strcpy (alloca (strlen (beg
) + 1), beg
);
426 p
= beg
+ SBYTES (filename
);
428 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
430 /* only recognise drive specifier at the beginning */
432 /* handle the "/:d:foo" and "/:foo" cases correctly */
433 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
434 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
441 /* Expansion of "c:" to drive and default directory. */
444 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
445 unsigned char *res
= alloca (MAXPATHLEN
+ 1);
446 unsigned char *r
= res
;
448 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
450 strncpy (res
, beg
, 2);
455 if (getdefdir (toupper (*beg
) - 'A' + 1, r
))
457 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
460 p
= beg
+ strlen (beg
);
463 CORRECT_DIR_SEPS (beg
);
466 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
469 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
470 Sfile_name_nondirectory
, 1, 1, 0,
471 doc
: /* Return file name FILENAME sans its directory.
472 For example, in a Unix-syntax file name,
473 this is everything after the last slash,
474 or the entire name if it contains no slash. */)
476 Lisp_Object filename
;
478 register const unsigned char *beg
, *p
, *end
;
481 CHECK_STRING (filename
);
483 /* If the file name has special constructs in it,
484 call the corresponding file handler. */
485 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
487 return call2 (handler
, Qfile_name_nondirectory
, filename
);
489 beg
= SDATA (filename
);
490 end
= p
= beg
+ SBYTES (filename
);
492 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
494 /* only recognise drive specifier at beginning */
496 /* handle the "/:d:foo" case correctly */
497 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
502 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
505 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
506 Sunhandled_file_name_directory
, 1, 1, 0,
507 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
508 A `directly usable' directory name is one that may be used without the
509 intervention of any file handler.
510 If FILENAME is a directly usable file itself, return
511 \(file-name-directory FILENAME).
512 If FILENAME refers to a file which is not accessible from a local process,
513 then this should return nil.
514 The `call-process' and `start-process' functions use this function to
515 get a current directory to run processes in. */)
517 Lisp_Object filename
;
521 /* If the file name has special constructs in it,
522 call the corresponding file handler. */
523 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
525 return call2 (handler
, Qunhandled_file_name_directory
, filename
);
527 return Ffile_name_directory (filename
);
532 file_name_as_directory (out
, in
)
535 int size
= strlen (in
) - 1;
547 /* For Unix syntax, Append a slash if necessary */
548 if (!IS_DIRECTORY_SEP (out
[size
]))
550 /* Cannot use DIRECTORY_SEP, which could have any value */
552 out
[size
+ 2] = '\0';
555 CORRECT_DIR_SEPS (out
);
560 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
561 Sfile_name_as_directory
, 1, 1, 0,
562 doc
: /* Return a string representing the file name FILE interpreted as a directory.
563 This operation exists because a directory is also a file, but its name as
564 a directory is different from its name as a file.
565 The result can be used as the value of `default-directory'
566 or passed as second argument to `expand-file-name'.
567 For a Unix-syntax file name, just appends a slash. */)
578 /* If the file name has special constructs in it,
579 call the corresponding file handler. */
580 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
582 return call2 (handler
, Qfile_name_as_directory
, file
);
584 buf
= (char *) alloca (SBYTES (file
) + 10);
585 file_name_as_directory (buf
, SDATA (file
));
586 return make_specified_string (buf
, -1, strlen (buf
),
587 STRING_MULTIBYTE (file
));
591 * Convert from directory name to filename.
592 * On UNIX, it's simple: just make sure there isn't a terminating /
594 * Value is nonzero if the string output is different from the input.
598 directory_file_name (src
, dst
)
605 /* Process as Unix format: just remove any final slash.
606 But leave "/" unchanged; do not change it to "". */
609 && IS_DIRECTORY_SEP (dst
[slen
- 1])
611 && !IS_ANY_SEP (dst
[slen
- 2])
616 CORRECT_DIR_SEPS (dst
);
621 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
623 doc
: /* Returns the file name of the directory named DIRECTORY.
624 This is the name of the file that holds the data for the directory DIRECTORY.
625 This operation exists because a directory is also a file, but its name as
626 a directory is different from its name as a file.
627 In Unix-syntax, this function just removes the final slash. */)
629 Lisp_Object directory
;
634 CHECK_STRING (directory
);
636 if (NILP (directory
))
639 /* If the file name has special constructs in it,
640 call the corresponding file handler. */
641 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
643 return call2 (handler
, Qdirectory_file_name
, directory
);
645 buf
= (char *) alloca (SBYTES (directory
) + 20);
646 directory_file_name (SDATA (directory
), buf
);
647 return make_specified_string (buf
, -1, strlen (buf
),
648 STRING_MULTIBYTE (directory
));
651 static char make_temp_name_tbl
[64] =
653 'A','B','C','D','E','F','G','H',
654 'I','J','K','L','M','N','O','P',
655 'Q','R','S','T','U','V','W','X',
656 'Y','Z','a','b','c','d','e','f',
657 'g','h','i','j','k','l','m','n',
658 'o','p','q','r','s','t','u','v',
659 'w','x','y','z','0','1','2','3',
660 '4','5','6','7','8','9','-','_'
663 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
665 /* Value is a temporary file name starting with PREFIX, a string.
667 The Emacs process number forms part of the result, so there is
668 no danger of generating a name being used by another process.
669 In addition, this function makes an attempt to choose a name
670 which has no existing file. To make this work, PREFIX should be
671 an absolute file name.
673 BASE64_P non-zero means add the pid as 3 characters in base64
674 encoding. In this case, 6 characters will be added to PREFIX to
675 form the file name. Otherwise, if Emacs is running on a system
676 with long file names, add the pid as a decimal number.
678 This function signals an error if no unique file name could be
682 make_temp_name (prefix
, base64_p
)
689 unsigned char *p
, *data
;
693 CHECK_STRING (prefix
);
695 /* VAL is created by adding 6 characters to PREFIX. The first
696 three are the PID of this process, in base 64, and the second
697 three are incremented if the file already exists. This ensures
698 262144 unique file names per PID per PREFIX. */
700 pid
= (int) getpid ();
704 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
705 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
706 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
711 #ifdef HAVE_LONG_FILE_NAMES
712 sprintf (pidbuf
, "%d", pid
);
713 pidlen
= strlen (pidbuf
);
715 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
716 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
717 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
722 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
723 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
724 if (!STRING_MULTIBYTE (prefix
))
725 STRING_SET_UNIBYTE (val
);
727 bcopy(SDATA (prefix
), data
, len
);
730 bcopy (pidbuf
, p
, pidlen
);
733 /* Here we try to minimize useless stat'ing when this function is
734 invoked many times successively with the same PREFIX. We achieve
735 this by initializing count to a random value, and incrementing it
738 We don't want make-temp-name to be called while dumping,
739 because then make_temp_name_count_initialized_p would get set
740 and then make_temp_name_count would not be set when Emacs starts. */
742 if (!make_temp_name_count_initialized_p
)
744 make_temp_name_count
= (unsigned) time (NULL
);
745 make_temp_name_count_initialized_p
= 1;
751 unsigned num
= make_temp_name_count
;
753 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
754 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
755 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
757 /* Poor man's congruential RN generator. Replace with
758 ++make_temp_name_count for debugging. */
759 make_temp_name_count
+= 25229;
760 make_temp_name_count
%= 225307;
762 if (stat (data
, &ignored
) < 0)
764 /* We want to return only if errno is ENOENT. */
768 /* The error here is dubious, but there is little else we
769 can do. The alternatives are to return nil, which is
770 as bad as (and in many cases worse than) throwing the
771 error, or to ignore the error, which will likely result
772 in looping through 225307 stat's, which is not only
773 dog-slow, but also useless since it will fallback to
774 the errow below, anyway. */
775 report_file_error ("Cannot create temporary name for prefix",
776 Fcons (prefix
, Qnil
));
781 error ("Cannot create temporary name for prefix `%s'",
787 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
788 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
789 The Emacs process number forms part of the result,
790 so there is no danger of generating a name being used by another process.
792 In addition, this function makes an attempt to choose a name
793 which has no existing file. To make this work,
794 PREFIX should be an absolute file name.
796 There is a race condition between calling `make-temp-name' and creating the
797 file which opens all kinds of security holes. For that reason, you should
798 probably use `make-temp-file' instead, except in three circumstances:
800 * If you are creating the file in the user's home directory.
801 * If you are creating a directory rather than an ordinary file.
802 * If you are taking special precautions as `make-temp-file' does. */)
806 return make_temp_name (prefix
, 0);
811 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
812 doc
: /* Convert filename NAME to absolute, and canonicalize it.
813 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
814 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
815 the current buffer's value of `default-directory' is used.
816 File name components that are `.' are removed, and
817 so are file name components followed by `..', along with the `..' itself;
818 note that these simplifications are done without checking the resulting
819 file names in the file system.
820 An initial `~/' expands to your home directory.
821 An initial `~USER/' expands to USER's home directory.
822 See also the function `substitute-in-file-name'.
824 For technical reasons, this function can return correct but
825 non-intuitive results for the root directory; for instance,
826 \(expand-file-name ".." "/") returns "/..". For this reason, use
827 (directory-file-name (file-name-directory dirname)) to traverse a
828 filesystem tree, not (expand-file-name ".." dirname). */)
829 (name
, default_directory
)
830 Lisp_Object name
, default_directory
;
832 /* These point to SDATA and need to be careful with string-relocation
833 during GC (via DECODE_FILE). */
834 unsigned char *nm
, *newdir
;
835 /* This should only point to alloca'd data. */
836 unsigned char *target
;
842 int collapse_newdir
= 1;
846 Lisp_Object handler
, result
;
852 /* If the file name has special constructs in it,
853 call the corresponding file handler. */
854 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
856 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
858 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
859 if (NILP (default_directory
))
860 default_directory
= current_buffer
->directory
;
861 if (! STRINGP (default_directory
))
864 /* "/" is not considered a root directory on DOS_NT, so using "/"
865 here causes an infinite recursion in, e.g., the following:
867 (let (default-directory)
868 (expand-file-name "a"))
870 To avoid this, we set default_directory to the root of the
872 extern char *emacs_root_dir (void);
874 default_directory
= build_string (emacs_root_dir ());
876 default_directory
= build_string ("/");
880 if (!NILP (default_directory
))
882 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
884 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
888 unsigned char *o
= SDATA (default_directory
);
890 /* Make sure DEFAULT_DIRECTORY is properly expanded.
891 It would be better to do this down below where we actually use
892 default_directory. Unfortunately, calling Fexpand_file_name recursively
893 could invoke GC, and the strings might be relocated. This would
894 be annoying because we have pointers into strings lying around
895 that would need adjusting, and people would add new pointers to
896 the code and forget to adjust them, resulting in intermittent bugs.
897 Putting this call here avoids all that crud.
899 The EQ test avoids infinite recursion. */
900 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
901 /* Save time in some common cases - as long as default_directory
902 is not relative, it can be canonicalized with name below (if it
903 is needed at all) without requiring it to be expanded now. */
905 /* Detect MSDOS file names with drive specifiers. */
906 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
907 && IS_DIRECTORY_SEP (o
[2]))
909 /* Detect Windows file names in UNC format. */
910 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
912 #else /* not DOS_NT */
913 /* Detect Unix absolute file names (/... alone is not absolute on
915 && ! (IS_DIRECTORY_SEP (o
[0]))
916 #endif /* not DOS_NT */
922 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
926 name
= FILE_SYSTEM_CASE (name
);
927 multibyte
= STRING_MULTIBYTE (name
);
928 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
931 default_directory
= string_to_multibyte (default_directory
);
934 name
= string_to_multibyte (name
);
941 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
942 nm
= strcpy (alloca (strlen (nm
) + 1), nm
);
945 /* Note if special escape prefix is present, but remove for now. */
946 if (nm
[0] == '/' && nm
[1] == ':')
952 /* Find and remove drive specifier if present; this makes nm absolute
953 even if the rest of the name appears to be relative. Only look for
954 drive specifier at the beginning. */
955 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
962 /* If we see "c://somedir", we want to strip the first slash after the
963 colon when stripping the drive letter. Otherwise, this expands to
965 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
968 /* Discard any previous drive specifier if nm is now in UNC format. */
969 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
973 #endif /* WINDOWSNT */
976 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
977 none are found, we can probably return right away. We will avoid
978 allocating a new string if name is already fully expanded. */
980 IS_DIRECTORY_SEP (nm
[0])
982 && drive
&& !is_escaped
985 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
989 /* If it turns out that the filename we want to return is just a
990 suffix of FILENAME, we don't need to go through and edit
991 things; we just need to construct a new string using data
992 starting at the middle of FILENAME. If we set lose to a
993 non-zero value, that means we've discovered that we can't do
996 unsigned char *p
= nm
;
1000 /* Since we know the name is absolute, we can assume that each
1001 element starts with a "/". */
1003 /* "." and ".." are hairy. */
1004 if (IS_DIRECTORY_SEP (p
[0])
1006 && (IS_DIRECTORY_SEP (p
[2])
1008 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1011 /* We want to replace multiple `/' in a row with a single
1014 && IS_DIRECTORY_SEP (p
[0])
1015 && IS_DIRECTORY_SEP (p
[1]))
1022 /* Make sure directories are all separated with / or \ as
1023 desired, but avoid allocation of a new string when not
1025 CORRECT_DIR_SEPS (nm
);
1027 if (IS_DIRECTORY_SEP (nm
[1]))
1029 if (strcmp (nm
, SDATA (name
)) != 0)
1030 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1034 /* drive must be set, so this is okay */
1035 if (strcmp (nm
- 2, SDATA (name
)) != 0)
1039 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1040 temp
[0] = DRIVE_LETTER (drive
);
1041 name
= concat2 (build_string (temp
), name
);
1044 #else /* not DOS_NT */
1045 if (strcmp (nm
, SDATA (name
)) == 0)
1047 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1048 #endif /* not DOS_NT */
1052 /* At this point, nm might or might not be an absolute file name. We
1053 need to expand ~ or ~user if present, otherwise prefix nm with
1054 default_directory if nm is not absolute, and finally collapse /./
1055 and /foo/../ sequences.
1057 We set newdir to be the appropriate prefix if one is needed:
1058 - the relevant user directory if nm starts with ~ or ~user
1059 - the specified drive's working dir (DOS/NT only) if nm does not
1061 - the value of default_directory.
1063 Note that these prefixes are not guaranteed to be absolute (except
1064 for the working dir of a drive). Therefore, to ensure we always
1065 return an absolute name, if the final prefix is not absolute we
1066 append it to the current working directory. */
1070 if (nm
[0] == '~') /* prefix ~ */
1072 if (IS_DIRECTORY_SEP (nm
[1])
1073 || nm
[1] == 0) /* ~ by itself */
1077 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1078 newdir
= (unsigned char *) "";
1080 /* egetenv may return a unibyte string, which will bite us since
1081 we expect the directory to be multibyte. */
1082 tem
= build_string (newdir
);
1083 if (!STRING_MULTIBYTE (tem
))
1085 hdir
= DECODE_FILE (tem
);
1086 newdir
= SDATA (hdir
);
1089 collapse_newdir
= 0;
1092 else /* ~user/filename */
1094 unsigned char *o
, *p
;
1095 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1096 o
= alloca (p
- nm
+ 1);
1097 bcopy ((char *) nm
, o
, p
- nm
);
1101 pw
= (struct passwd
*) getpwnam (o
+ 1);
1105 newdir
= (unsigned char *) pw
-> pw_dir
;
1108 collapse_newdir
= 0;
1112 /* If we don't find a user of that name, leave the name
1113 unchanged; don't move nm forward to p. */
1118 /* On DOS and Windows, nm is absolute if a drive name was specified;
1119 use the drive's current directory as the prefix if needed. */
1120 if (!newdir
&& drive
)
1122 /* Get default directory if needed to make nm absolute. */
1123 if (!IS_DIRECTORY_SEP (nm
[0]))
1125 newdir
= alloca (MAXPATHLEN
+ 1);
1126 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1131 /* Either nm starts with /, or drive isn't mounted. */
1132 newdir
= alloca (4);
1133 newdir
[0] = DRIVE_LETTER (drive
);
1141 /* Finally, if no prefix has been specified and nm is not absolute,
1142 then it must be expanded relative to default_directory. */
1146 /* /... alone is not absolute on DOS and Windows. */
1147 && !IS_DIRECTORY_SEP (nm
[0])
1150 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1154 newdir
= SDATA (default_directory
);
1156 /* Note if special escape prefix is present, but remove for now. */
1157 if (newdir
[0] == '/' && newdir
[1] == ':')
1168 /* First ensure newdir is an absolute name. */
1170 /* Detect MSDOS file names with drive specifiers. */
1171 ! (IS_DRIVE (newdir
[0])
1172 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1174 /* Detect Windows file names in UNC format. */
1175 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1179 /* Effectively, let newdir be (expand-file-name newdir cwd).
1180 Because of the admonition against calling expand-file-name
1181 when we have pointers into lisp strings, we accomplish this
1182 indirectly by prepending newdir to nm if necessary, and using
1183 cwd (or the wd of newdir's drive) as the new newdir. */
1185 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1190 if (!IS_DIRECTORY_SEP (nm
[0]))
1192 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1193 file_name_as_directory (tmp
, newdir
);
1197 newdir
= alloca (MAXPATHLEN
+ 1);
1200 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1207 /* Strip off drive name from prefix, if present. */
1208 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1214 /* Keep only a prefix from newdir if nm starts with slash
1215 (//server/share for UNC, nothing otherwise). */
1216 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1219 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1222 newdir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1224 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1226 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1238 /* Get rid of any slash at the end of newdir, unless newdir is
1239 just / or // (an incomplete UNC name). */
1240 length
= strlen (newdir
);
1241 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1243 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1247 unsigned char *temp
= (unsigned char *) alloca (length
);
1248 bcopy (newdir
, temp
, length
- 1);
1249 temp
[length
- 1] = 0;
1257 /* Now concatenate the directory and name to new space in the stack frame */
1258 tlen
+= strlen (nm
) + 1;
1260 /* Reserve space for drive specifier and escape prefix, since either
1261 or both may need to be inserted. (The Microsoft x86 compiler
1262 produces incorrect code if the following two lines are combined.) */
1263 target
= (unsigned char *) alloca (tlen
+ 4);
1265 #else /* not DOS_NT */
1266 target
= (unsigned char *) alloca (tlen
);
1267 #endif /* not DOS_NT */
1272 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1275 /* If newdir is effectively "C:/", then the drive letter will have
1276 been stripped and newdir will be "/". Concatenating with an
1277 absolute directory in nm produces "//", which will then be
1278 incorrectly treated as a network share. Ignore newdir in
1279 this case (keeping the drive letter). */
1280 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1281 && newdir
[1] == '\0'))
1283 strcpy (target
, newdir
);
1286 file_name_as_directory (target
, newdir
);
1289 strcat (target
, nm
);
1291 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1294 unsigned char *p
= target
;
1295 unsigned char *o
= target
;
1299 if (!IS_DIRECTORY_SEP (*p
))
1303 else if (p
[1] == '.'
1304 && (IS_DIRECTORY_SEP (p
[2])
1307 /* If "/." is the entire filename, keep the "/". Otherwise,
1308 just delete the whole "/.". */
1309 if (o
== target
&& p
[2] == '\0')
1313 else if (p
[1] == '.' && p
[2] == '.'
1314 /* `/../' is the "superroot" on certain file systems.
1315 Turned off on DOS_NT systems because they have no
1316 "superroot" and because this causes us to produce
1317 file names like "d:/../foo" which fail file-related
1318 functions of the underlying OS. (To reproduce, try a
1319 long series of "../../" in default_directory, longer
1320 than the number of levels from the root.) */
1324 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1326 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1328 /* Keep initial / only if this is the whole name. */
1329 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1333 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1334 /* Collapse multiple `/' in a row. */
1343 /* At last, set drive name. */
1345 /* Except for network file name. */
1346 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1347 #endif /* WINDOWSNT */
1349 if (!drive
) abort ();
1351 target
[0] = DRIVE_LETTER (drive
);
1354 /* Reinsert the escape prefix if required. */
1361 CORRECT_DIR_SEPS (target
);
1364 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1367 /* Again look to see if the file name has special constructs in it
1368 and perhaps call the corresponding file handler. This is needed
1369 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1370 the ".." component gives us "/user@host:/bar/../baz" which needs
1371 to be expanded again. */
1372 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1373 if (!NILP (handler
))
1374 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1380 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1381 This is the old version of expand-file-name, before it was thoroughly
1382 rewritten for Emacs 10.31. We leave this version here commented-out,
1383 because the code is very complex and likely to have subtle bugs. If
1384 bugs _are_ found, it might be of interest to look at the old code and
1385 see what did it do in the relevant situation.
1387 Don't remove this code: it's true that it will be accessible via CVS,
1388 but a few years from deletion, people will forget it is there. */
1390 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1391 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1392 "Convert FILENAME to absolute, and canonicalize it.\n\
1393 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1394 \(does not start with slash); if DEFAULT is nil or missing,\n\
1395 the current buffer's value of default-directory is used.\n\
1396 Filenames containing `.' or `..' as components are simplified;\n\
1397 initial `~/' expands to your home directory.\n\
1398 See also the function `substitute-in-file-name'.")
1400 Lisp_Object name
, defalt
;
1404 register unsigned char *newdir
, *p
, *o
;
1406 unsigned char *target
;
1410 CHECK_STRING (name
);
1413 /* If nm is absolute, flush ...// and detect /./ and /../.
1414 If no /./ or /../ we can return right away. */
1421 if (p
[0] == '/' && p
[1] == '/'
1424 if (p
[0] == '/' && p
[1] == '~')
1425 nm
= p
+ 1, lose
= 1;
1426 if (p
[0] == '/' && p
[1] == '.'
1427 && (p
[2] == '/' || p
[2] == 0
1428 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1434 if (nm
== SDATA (name
))
1436 return build_string (nm
);
1440 /* Now determine directory to start with and put it in NEWDIR */
1444 if (nm
[0] == '~') /* prefix ~ */
1445 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1447 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1448 newdir
= (unsigned char *) "";
1451 else /* ~user/filename */
1453 /* Get past ~ to user */
1454 unsigned char *user
= nm
+ 1;
1455 /* Find end of name. */
1456 unsigned char *ptr
= (unsigned char *) index (user
, '/');
1457 int len
= ptr
? ptr
- user
: strlen (user
);
1458 /* Copy the user name into temp storage. */
1459 o
= (unsigned char *) alloca (len
+ 1);
1460 bcopy ((char *) user
, o
, len
);
1463 /* Look up the user name. */
1465 pw
= (struct passwd
*) getpwnam (o
+ 1);
1468 error ("\"%s\" isn't a registered user", o
+ 1);
1470 newdir
= (unsigned char *) pw
->pw_dir
;
1472 /* Discard the user name from NM. */
1476 if (nm
[0] != '/' && !newdir
)
1479 defalt
= current_buffer
->directory
;
1480 CHECK_STRING (defalt
);
1481 newdir
= SDATA (defalt
);
1484 /* Now concatenate the directory and name to new space in the stack frame */
1486 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1487 target
= (unsigned char *) alloca (tlen
);
1492 if (nm
[0] == 0 || nm
[0] == '/')
1493 strcpy (target
, newdir
);
1495 file_name_as_directory (target
, newdir
);
1498 strcat (target
, nm
);
1500 /* Now canonicalize by removing /. and /foo/.. if they appear */
1511 else if (!strncmp (p
, "//", 2)
1517 else if (p
[0] == '/' && p
[1] == '.'
1518 && (p
[2] == '/' || p
[2] == 0))
1520 else if (!strncmp (p
, "/..", 3)
1521 /* `/../' is the "superroot" on certain file systems. */
1523 && (p
[3] == '/' || p
[3] == 0))
1525 while (o
!= target
&& *--o
!= '/')
1527 if (o
== target
&& *o
== '/')
1537 return make_string (target
, o
- target
);
1541 /* If /~ or // appears, discard everything through first slash. */
1543 file_name_absolute_p (filename
)
1544 const unsigned char *filename
;
1547 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1549 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1550 && IS_DIRECTORY_SEP (filename
[2]))
1555 static unsigned char *
1556 search_embedded_absfilename (nm
, endp
)
1557 unsigned char *nm
, *endp
;
1559 unsigned char *p
, *s
;
1561 for (p
= nm
+ 1; p
< endp
; p
++)
1564 || IS_DIRECTORY_SEP (p
[-1]))
1565 && file_name_absolute_p (p
)
1566 #if defined (WINDOWSNT) || defined(CYGWIN)
1567 /* // at start of file name is meaningful in Apollo,
1568 WindowsNT and Cygwin systems. */
1569 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1570 #endif /* not (WINDOWSNT || CYGWIN) */
1573 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1574 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
1576 unsigned char *o
= alloca (s
- p
+ 1);
1578 bcopy (p
, o
, s
- p
);
1581 /* If we have ~user and `user' exists, discard
1582 everything up to ~. But if `user' does not exist, leave
1583 ~user alone, it might be a literal file name. */
1585 pw
= getpwnam (o
+ 1);
1597 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1598 Ssubstitute_in_file_name
, 1, 1, 0,
1599 doc
: /* Substitute environment variables referred to in FILENAME.
1600 `$FOO' where FOO is an environment variable name means to substitute
1601 the value of that variable. The variable name should be terminated
1602 with a character not a letter, digit or underscore; otherwise, enclose
1603 the entire variable name in braces.
1604 If `/~' appears, all of FILENAME through that `/' is discarded. */)
1606 Lisp_Object filename
;
1610 register unsigned char *s
, *p
, *o
, *x
, *endp
;
1611 unsigned char *target
= NULL
;
1613 int substituted
= 0;
1615 Lisp_Object handler
;
1617 CHECK_STRING (filename
);
1619 /* If the file name has special constructs in it,
1620 call the corresponding file handler. */
1621 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1622 if (!NILP (handler
))
1623 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
1625 nm
= SDATA (filename
);
1627 nm
= strcpy (alloca (strlen (nm
) + 1), nm
);
1628 CORRECT_DIR_SEPS (nm
);
1629 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1631 endp
= nm
+ SBYTES (filename
);
1633 /* If /~ or // appears, discard everything through first slash. */
1634 p
= search_embedded_absfilename (nm
, endp
);
1636 /* Start over with the new string, so we check the file-name-handler
1637 again. Important with filenames like "/home/foo//:/hello///there"
1638 which whould substitute to "/:/hello///there" rather than "/there". */
1639 return Fsubstitute_in_file_name
1640 (make_specified_string (p
, -1, endp
- p
,
1641 STRING_MULTIBYTE (filename
)));
1644 /* See if any variables are substituted into the string
1645 and find the total length of their values in `total' */
1647 for (p
= nm
; p
!= endp
;)
1657 /* "$$" means a single "$" */
1666 while (p
!= endp
&& *p
!= '}') p
++;
1667 if (*p
!= '}') goto missingclose
;
1673 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1677 /* Copy out the variable name */
1678 target
= (unsigned char *) alloca (s
- o
+ 1);
1679 strncpy (target
, o
, s
- o
);
1682 strupr (target
); /* $home == $HOME etc. */
1685 /* Get variable value */
1686 o
= (unsigned char *) egetenv (target
);
1688 { /* Eight-bit chars occupy upto 2 bytes in multibyte. */
1689 total
+= strlen (o
) * (STRING_MULTIBYTE (filename
) ? 2 : 1);
1699 /* If substitution required, recopy the string and do it */
1700 /* Make space in stack frame for the new copy */
1701 xnm
= (unsigned char *) alloca (SBYTES (filename
) + total
+ 1);
1704 /* Copy the rest of the name through, replacing $ constructs with values */
1721 while (p
!= endp
&& *p
!= '}') p
++;
1722 if (*p
!= '}') goto missingclose
;
1728 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1732 /* Copy out the variable name */
1733 target
= (unsigned char *) alloca (s
- o
+ 1);
1734 strncpy (target
, o
, s
- o
);
1737 strupr (target
); /* $home == $HOME etc. */
1740 /* Get variable value */
1741 o
= (unsigned char *) egetenv (target
);
1745 strcpy (x
, target
); x
+= strlen (target
);
1747 else if (STRING_MULTIBYTE (filename
))
1749 /* If the original string is multibyte,
1750 convert what we substitute into multibyte. */
1754 c
= unibyte_char_to_multibyte (c
);
1755 x
+= CHAR_STRING (c
, x
);
1767 /* If /~ or // appears, discard everything through first slash. */
1768 while ((p
= search_embedded_absfilename (xnm
, x
)))
1769 /* This time we do not start over because we've already expanded envvars
1770 and replaced $$ with $. Maybe we should start over as well, but we'd
1771 need to quote some $ to $$ first. */
1774 return make_specified_string (xnm
, -1, x
- xnm
, STRING_MULTIBYTE (filename
));
1777 error ("Bad format environment-variable substitution");
1779 error ("Missing \"}\" in environment-variable substitution");
1781 error ("Substituting nonexistent environment variable \"%s\"", target
);
1787 /* A slightly faster and more convenient way to get
1788 (directory-file-name (expand-file-name FOO)). */
1791 expand_and_dir_to_file (filename
, defdir
)
1792 Lisp_Object filename
, defdir
;
1794 register Lisp_Object absname
;
1796 absname
= Fexpand_file_name (filename
, defdir
);
1798 /* Remove final slash, if any (unless this is the root dir).
1799 stat behaves differently depending! */
1800 if (SCHARS (absname
) > 1
1801 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1802 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
1803 /* We cannot take shortcuts; they might be wrong for magic file names. */
1804 absname
= Fdirectory_file_name (absname
);
1808 /* Signal an error if the file ABSNAME already exists.
1809 If INTERACTIVE is nonzero, ask the user whether to proceed,
1810 and bypass the error if the user says to go ahead.
1811 QUERYSTRING is a name for the action that is being considered
1814 *STATPTR is used to store the stat information if the file exists.
1815 If the file does not exist, STATPTR->st_mode is set to 0.
1816 If STATPTR is null, we don't store into it.
1818 If QUICK is nonzero, we ask for y or n, not yes or no. */
1821 barf_or_query_if_file_exists (absname
, querystring
, interactive
, statptr
, quick
)
1822 Lisp_Object absname
;
1823 unsigned char *querystring
;
1825 struct stat
*statptr
;
1828 register Lisp_Object tem
, encoded_filename
;
1829 struct stat statbuf
;
1830 struct gcpro gcpro1
;
1832 encoded_filename
= ENCODE_FILE (absname
);
1834 /* stat is a good way to tell whether the file exists,
1835 regardless of what access permissions it has. */
1836 if (lstat (SDATA (encoded_filename
), &statbuf
) >= 0)
1839 xsignal2 (Qfile_already_exists
,
1840 build_string ("File already exists"), absname
);
1842 tem
= format2 ("File %s already exists; %s anyway? ",
1843 absname
, build_string (querystring
));
1845 tem
= Fy_or_n_p (tem
);
1847 tem
= do_yes_or_no_p (tem
);
1850 xsignal2 (Qfile_already_exists
,
1851 build_string ("File already exists"), absname
);
1858 statptr
->st_mode
= 0;
1863 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 5,
1864 "fCopy file: \nGCopy %s to file: \np\nP",
1865 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1866 If NEWNAME names a directory, copy FILE there.
1868 This function always sets the file modes of the output file to match
1871 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1872 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1873 signal a `file-already-exists' error without overwriting. If
1874 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1875 about overwriting; this is what happens in interactive use with M-x.
1876 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1879 Fourth arg KEEP-TIME non-nil means give the output file the same
1880 last-modified time as the old one. (This works on only some systems.)
1882 A prefix arg makes KEEP-TIME non-nil.
1884 If PRESERVE-UID-GID is non-nil, we try to transfer the
1885 uid and gid of FILE to NEWNAME. */)
1886 (file
, newname
, ok_if_already_exists
, keep_time
, preserve_uid_gid
)
1887 Lisp_Object file
, newname
, ok_if_already_exists
, keep_time
;
1888 Lisp_Object preserve_uid_gid
;
1891 char buf
[16 * 1024];
1892 struct stat st
, out_st
;
1893 Lisp_Object handler
;
1894 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1895 int count
= SPECPDL_INDEX ();
1896 int input_file_statable_p
;
1897 Lisp_Object encoded_file
, encoded_newname
;
1899 encoded_file
= encoded_newname
= Qnil
;
1900 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1901 CHECK_STRING (file
);
1902 CHECK_STRING (newname
);
1904 if (!NILP (Ffile_directory_p (newname
)))
1905 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1907 newname
= Fexpand_file_name (newname
, Qnil
);
1909 file
= Fexpand_file_name (file
, Qnil
);
1911 /* If the input file name has special constructs in it,
1912 call the corresponding file handler. */
1913 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1914 /* Likewise for output file name. */
1916 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1917 if (!NILP (handler
))
1918 RETURN_UNGCPRO (call6 (handler
, Qcopy_file
, file
, newname
,
1919 ok_if_already_exists
, keep_time
, preserve_uid_gid
));
1921 encoded_file
= ENCODE_FILE (file
);
1922 encoded_newname
= ENCODE_FILE (newname
);
1924 if (NILP (ok_if_already_exists
)
1925 || INTEGERP (ok_if_already_exists
))
1926 barf_or_query_if_file_exists (newname
, "copy to it",
1927 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1928 else if (stat (SDATA (encoded_newname
), &out_st
) < 0)
1932 if (!CopyFile (SDATA (encoded_file
),
1933 SDATA (encoded_newname
),
1935 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1936 /* CopyFile retains the timestamp by default. */
1937 else if (NILP (keep_time
))
1943 EMACS_GET_TIME (now
);
1944 filename
= SDATA (encoded_newname
);
1946 /* Ensure file is writable while its modified time is set. */
1947 attributes
= GetFileAttributes (filename
);
1948 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1949 if (set_file_times (filename
, now
, now
))
1951 /* Restore original attributes. */
1952 SetFileAttributes (filename
, attributes
);
1953 xsignal2 (Qfile_date_error
,
1954 build_string ("Cannot set file date"), newname
);
1956 /* Restore original attributes. */
1957 SetFileAttributes (filename
, attributes
);
1959 #else /* not WINDOWSNT */
1961 ifd
= emacs_open (SDATA (encoded_file
), O_RDONLY
, 0);
1965 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1967 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1969 /* We can only copy regular files and symbolic links. Other files are not
1971 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
1973 #if !defined (MSDOS) || __DJGPP__ > 1
1974 if (out_st
.st_mode
!= 0
1975 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
1978 report_file_error ("Input and output files are the same",
1979 Fcons (file
, Fcons (newname
, Qnil
)));
1983 #if defined (S_ISREG) && defined (S_ISLNK)
1984 if (input_file_statable_p
)
1986 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
1988 #if defined (EISDIR)
1989 /* Get a better looking error message. */
1992 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
1995 #endif /* S_ISREG && S_ISLNK */
1998 /* System's default file type was set to binary by _fmode in emacs.c. */
1999 ofd
= emacs_open (SDATA (encoded_newname
),
2000 O_WRONLY
| O_TRUNC
| O_CREAT
2001 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2002 S_IREAD
| S_IWRITE
);
2003 #else /* not MSDOS */
2004 ofd
= emacs_open (SDATA (encoded_newname
),
2005 O_WRONLY
| O_TRUNC
| O_CREAT
2006 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2008 #endif /* not MSDOS */
2010 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2012 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2016 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2017 if (emacs_write (ofd
, buf
, n
) != n
)
2018 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2022 /* Preserve the original file modes, and if requested, also its
2024 if (input_file_statable_p
)
2026 if (! NILP (preserve_uid_gid
))
2027 fchown (ofd
, st
.st_uid
, st
.st_gid
);
2028 fchmod (ofd
, st
.st_mode
& 07777);
2030 #endif /* not MSDOS */
2032 /* Closing the output clobbers the file times on some systems. */
2033 if (emacs_close (ofd
) < 0)
2034 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2036 if (input_file_statable_p
)
2038 if (!NILP (keep_time
))
2040 EMACS_TIME atime
, mtime
;
2041 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
2042 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
2043 if (set_file_times (SDATA (encoded_newname
),
2045 xsignal2 (Qfile_date_error
,
2046 build_string ("Cannot set file date"), newname
);
2052 #if defined (__DJGPP__) && __DJGPP__ > 1
2053 if (input_file_statable_p
)
2055 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2056 and if it can't, it tells so. Otherwise, under MSDOS we usually
2057 get only the READ bit, which will make the copied file read-only,
2058 so it's better not to chmod at all. */
2059 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2060 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2062 #endif /* DJGPP version 2 or newer */
2063 #endif /* not WINDOWSNT */
2065 /* Discard the unwind protects. */
2066 specpdl_ptr
= specpdl
+ count
;
2072 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2073 Smake_directory_internal
, 1, 1, 0,
2074 doc
: /* Create a new directory named DIRECTORY. */)
2076 Lisp_Object directory
;
2078 const unsigned char *dir
;
2079 Lisp_Object handler
;
2080 Lisp_Object encoded_dir
;
2082 CHECK_STRING (directory
);
2083 directory
= Fexpand_file_name (directory
, Qnil
);
2085 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2086 if (!NILP (handler
))
2087 return call2 (handler
, Qmake_directory_internal
, directory
);
2089 encoded_dir
= ENCODE_FILE (directory
);
2091 dir
= SDATA (encoded_dir
);
2094 if (mkdir (dir
) != 0)
2096 if (mkdir (dir
, 0777) != 0)
2098 report_file_error ("Creating directory", list1 (directory
));
2103 DEFUN ("delete-directory", Fdelete_directory
, Sdelete_directory
, 1, 1, "FDelete directory: ",
2104 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2106 Lisp_Object directory
;
2108 const unsigned char *dir
;
2109 Lisp_Object handler
;
2110 Lisp_Object encoded_dir
;
2112 CHECK_STRING (directory
);
2113 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2115 handler
= Ffind_file_name_handler (directory
, Qdelete_directory
);
2116 if (!NILP (handler
))
2117 return call2 (handler
, Qdelete_directory
, directory
);
2119 if (delete_by_moving_to_trash
)
2120 return call1 (Qmove_file_to_trash
, directory
);
2122 encoded_dir
= ENCODE_FILE (directory
);
2124 dir
= SDATA (encoded_dir
);
2126 if (rmdir (dir
) != 0)
2127 report_file_error ("Removing directory", list1 (directory
));
2132 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 1, "fDelete file: ",
2133 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2134 If file has multiple names, it continues to exist with the other names. */)
2136 Lisp_Object filename
;
2138 Lisp_Object handler
;
2139 Lisp_Object encoded_file
;
2140 struct gcpro gcpro1
;
2143 if (!NILP (Ffile_directory_p (filename
))
2144 && NILP (Ffile_symlink_p (filename
)))
2145 xsignal2 (Qfile_error
,
2146 build_string ("Removing old name: is a directory"),
2149 filename
= Fexpand_file_name (filename
, Qnil
);
2151 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2152 if (!NILP (handler
))
2153 return call2 (handler
, Qdelete_file
, filename
);
2155 if (delete_by_moving_to_trash
)
2156 return call1 (Qmove_file_to_trash
, filename
);
2158 encoded_file
= ENCODE_FILE (filename
);
2160 if (0 > unlink (SDATA (encoded_file
)))
2161 report_file_error ("Removing old name", list1 (filename
));
2166 internal_delete_file_1 (ignore
)
2172 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2175 internal_delete_file (filename
)
2176 Lisp_Object filename
;
2179 tem
= internal_condition_case_1 (Fdelete_file
, filename
,
2180 Qt
, internal_delete_file_1
);
2184 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2185 "fRename file: \nGRename %s to file: \np",
2186 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2187 If file has names other than FILE, it continues to have those names.
2188 Signals a `file-already-exists' error if a file NEWNAME already exists
2189 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2190 A number as third arg means request confirmation if NEWNAME already exists.
2191 This is what happens in interactive use with M-x. */)
2192 (file
, newname
, ok_if_already_exists
)
2193 Lisp_Object file
, newname
, ok_if_already_exists
;
2195 Lisp_Object handler
;
2196 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2197 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2199 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2200 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2201 CHECK_STRING (file
);
2202 CHECK_STRING (newname
);
2203 file
= Fexpand_file_name (file
, Qnil
);
2205 if ((!NILP (Ffile_directory_p (newname
)))
2207 /* If the file names are identical but for the case,
2208 don't attempt to move directory to itself. */
2209 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2212 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2214 newname
= Fexpand_file_name (newname
, Qnil
);
2216 /* If the file name has special constructs in it,
2217 call the corresponding file handler. */
2218 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2220 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2221 if (!NILP (handler
))
2222 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2223 file
, newname
, ok_if_already_exists
));
2225 encoded_file
= ENCODE_FILE (file
);
2226 encoded_newname
= ENCODE_FILE (newname
);
2229 /* If the file names are identical but for the case, don't ask for
2230 confirmation: they simply want to change the letter-case of the
2232 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2234 if (NILP (ok_if_already_exists
)
2235 || INTEGERP (ok_if_already_exists
))
2236 barf_or_query_if_file_exists (newname
, "rename to it",
2237 INTEGERP (ok_if_already_exists
), 0, 0);
2238 if (0 > rename (SDATA (encoded_file
), SDATA (encoded_newname
)))
2244 symlink_target
= Ffile_symlink_p (file
);
2245 if (! NILP (symlink_target
))
2246 Fmake_symbolic_link (symlink_target
, newname
,
2247 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2250 Fcopy_file (file
, newname
,
2251 /* We have already prompted if it was an integer,
2252 so don't have copy-file prompt again. */
2253 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2256 count
= SPECPDL_INDEX ();
2257 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2258 Fdelete_file (file
);
2259 unbind_to (count
, Qnil
);
2262 report_file_error ("Renaming", list2 (file
, newname
));
2268 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2269 "fAdd name to file: \nGName to add to %s: \np",
2270 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2271 Signals a `file-already-exists' error if a file NEWNAME already exists
2272 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2273 A number as third arg means request confirmation if NEWNAME already exists.
2274 This is what happens in interactive use with M-x. */)
2275 (file
, newname
, ok_if_already_exists
)
2276 Lisp_Object file
, newname
, ok_if_already_exists
;
2278 Lisp_Object handler
;
2279 Lisp_Object encoded_file
, encoded_newname
;
2280 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2282 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2283 encoded_file
= encoded_newname
= Qnil
;
2284 CHECK_STRING (file
);
2285 CHECK_STRING (newname
);
2286 file
= Fexpand_file_name (file
, Qnil
);
2288 if (!NILP (Ffile_directory_p (newname
)))
2289 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2291 newname
= Fexpand_file_name (newname
, Qnil
);
2293 /* If the file name has special constructs in it,
2294 call the corresponding file handler. */
2295 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2296 if (!NILP (handler
))
2297 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2298 newname
, ok_if_already_exists
));
2300 /* If the new name has special constructs in it,
2301 call the corresponding file handler. */
2302 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2303 if (!NILP (handler
))
2304 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2305 newname
, ok_if_already_exists
));
2307 encoded_file
= ENCODE_FILE (file
);
2308 encoded_newname
= ENCODE_FILE (newname
);
2310 if (NILP (ok_if_already_exists
)
2311 || INTEGERP (ok_if_already_exists
))
2312 barf_or_query_if_file_exists (newname
, "make it a new name",
2313 INTEGERP (ok_if_already_exists
), 0, 0);
2315 unlink (SDATA (newname
));
2316 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
)))
2317 report_file_error ("Adding new name", list2 (file
, newname
));
2323 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2324 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2325 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2326 Both args must be strings.
2327 Signals a `file-already-exists' error if a file LINKNAME already exists
2328 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2329 A number as third arg means request confirmation if LINKNAME already exists.
2330 This happens for interactive use with M-x. */)
2331 (filename
, linkname
, ok_if_already_exists
)
2332 Lisp_Object filename
, linkname
, ok_if_already_exists
;
2334 Lisp_Object handler
;
2335 Lisp_Object encoded_filename
, encoded_linkname
;
2336 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2338 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2339 encoded_filename
= encoded_linkname
= Qnil
;
2340 CHECK_STRING (filename
);
2341 CHECK_STRING (linkname
);
2342 /* If the link target has a ~, we must expand it to get
2343 a truly valid file name. Otherwise, do not expand;
2344 we want to permit links to relative file names. */
2345 if (SREF (filename
, 0) == '~')
2346 filename
= Fexpand_file_name (filename
, Qnil
);
2348 if (!NILP (Ffile_directory_p (linkname
)))
2349 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2351 linkname
= Fexpand_file_name (linkname
, Qnil
);
2353 /* If the file name has special constructs in it,
2354 call the corresponding file handler. */
2355 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2356 if (!NILP (handler
))
2357 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2358 linkname
, ok_if_already_exists
));
2360 /* If the new link name has special constructs in it,
2361 call the corresponding file handler. */
2362 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2363 if (!NILP (handler
))
2364 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2365 linkname
, ok_if_already_exists
));
2368 encoded_filename
= ENCODE_FILE (filename
);
2369 encoded_linkname
= ENCODE_FILE (linkname
);
2371 if (NILP (ok_if_already_exists
)
2372 || INTEGERP (ok_if_already_exists
))
2373 barf_or_query_if_file_exists (linkname
, "make it a link",
2374 INTEGERP (ok_if_already_exists
), 0, 0);
2375 if (0 > symlink (SDATA (encoded_filename
),
2376 SDATA (encoded_linkname
)))
2378 /* If we didn't complain already, silently delete existing file. */
2379 if (errno
== EEXIST
)
2381 unlink (SDATA (encoded_linkname
));
2382 if (0 <= symlink (SDATA (encoded_filename
),
2383 SDATA (encoded_linkname
)))
2390 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2397 xsignal1 (Qfile_error
, build_string ("Symbolic links are not supported"));
2399 #endif /* S_IFLNK */
2403 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2405 doc
: /* Return t if file FILENAME specifies an absolute file name.
2406 On Unix, this is a name starting with a `/' or a `~'. */)
2408 Lisp_Object filename
;
2410 CHECK_STRING (filename
);
2411 return file_name_absolute_p (SDATA (filename
)) ? Qt
: Qnil
;
2414 /* Return nonzero if file FILENAME exists and can be executed. */
2417 check_executable (filename
)
2421 int len
= strlen (filename
);
2424 if (stat (filename
, &st
) < 0)
2426 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
2427 return ((st
.st_mode
& S_IEXEC
) != 0);
2429 return (S_ISREG (st
.st_mode
)
2431 && (xstrcasecmp ((suffix
= filename
+ len
-4), ".com") == 0
2432 || xstrcasecmp (suffix
, ".exe") == 0
2433 || xstrcasecmp (suffix
, ".bat") == 0)
2434 || (st
.st_mode
& S_IFMT
) == S_IFDIR
);
2435 #endif /* not WINDOWSNT */
2436 #else /* not DOS_NT */
2437 #ifdef HAVE_EUIDACCESS
2438 return (euidaccess (filename
, 1) >= 0);
2440 /* Access isn't quite right because it uses the real uid
2441 and we really want to test with the effective uid.
2442 But Unix doesn't give us a right way to do it. */
2443 return (access (filename
, 1) >= 0);
2445 #endif /* not DOS_NT */
2448 /* Return nonzero if file FILENAME exists and can be written. */
2451 check_writable (filename
)
2456 if (stat (filename
, &st
) < 0)
2458 return (st
.st_mode
& S_IWRITE
|| (st
.st_mode
& S_IFMT
) == S_IFDIR
);
2459 #else /* not MSDOS */
2460 #ifdef HAVE_EUIDACCESS
2461 return (euidaccess (filename
, 2) >= 0);
2463 /* Access isn't quite right because it uses the real uid
2464 and we really want to test with the effective uid.
2465 But Unix doesn't give us a right way to do it.
2466 Opening with O_WRONLY could work for an ordinary file,
2467 but would lose for directories. */
2468 return (access (filename
, 2) >= 0);
2470 #endif /* not MSDOS */
2473 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2474 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2475 See also `file-readable-p' and `file-attributes'.
2476 This returns nil for a symlink to a nonexistent file.
2477 Use `file-symlink-p' to test for such links. */)
2479 Lisp_Object filename
;
2481 Lisp_Object absname
;
2482 Lisp_Object handler
;
2483 struct stat statbuf
;
2485 CHECK_STRING (filename
);
2486 absname
= Fexpand_file_name (filename
, Qnil
);
2488 /* If the file name has special constructs in it,
2489 call the corresponding file handler. */
2490 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2491 if (!NILP (handler
))
2492 return call2 (handler
, Qfile_exists_p
, absname
);
2494 absname
= ENCODE_FILE (absname
);
2496 return (stat (SDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2499 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2500 doc
: /* Return t if FILENAME can be executed by you.
2501 For a directory, this means you can access files in that directory. */)
2503 Lisp_Object filename
;
2505 Lisp_Object absname
;
2506 Lisp_Object handler
;
2508 CHECK_STRING (filename
);
2509 absname
= Fexpand_file_name (filename
, Qnil
);
2511 /* If the file name has special constructs in it,
2512 call the corresponding file handler. */
2513 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2514 if (!NILP (handler
))
2515 return call2 (handler
, Qfile_executable_p
, absname
);
2517 absname
= ENCODE_FILE (absname
);
2519 return (check_executable (SDATA (absname
)) ? Qt
: Qnil
);
2522 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2523 doc
: /* Return t if file FILENAME exists and you can read it.
2524 See also `file-exists-p' and `file-attributes'. */)
2526 Lisp_Object filename
;
2528 Lisp_Object absname
;
2529 Lisp_Object handler
;
2532 struct stat statbuf
;
2534 CHECK_STRING (filename
);
2535 absname
= Fexpand_file_name (filename
, Qnil
);
2537 /* If the file name has special constructs in it,
2538 call the corresponding file handler. */
2539 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2540 if (!NILP (handler
))
2541 return call2 (handler
, Qfile_readable_p
, absname
);
2543 absname
= ENCODE_FILE (absname
);
2545 #if defined(DOS_NT) || defined(macintosh)
2546 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2548 if (access (SDATA (absname
), 0) == 0)
2551 #else /* not DOS_NT and not macintosh */
2553 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
2554 /* Opening a fifo without O_NONBLOCK can wait.
2555 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2556 except in the case of a fifo, on a system which handles it. */
2557 desc
= stat (SDATA (absname
), &statbuf
);
2560 if (S_ISFIFO (statbuf
.st_mode
))
2561 flags
|= O_NONBLOCK
;
2563 desc
= emacs_open (SDATA (absname
), flags
, 0);
2568 #endif /* not DOS_NT and not macintosh */
2571 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2573 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2574 doc
: /* Return t if file FILENAME can be written or created by you. */)
2576 Lisp_Object filename
;
2578 Lisp_Object absname
, dir
, encoded
;
2579 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_writable_p
);
2588 if (!NILP (handler
))
2589 return call2 (handler
, Qfile_writable_p
, absname
);
2591 encoded
= ENCODE_FILE (absname
);
2592 if (stat (SDATA (encoded
), &statbuf
) >= 0)
2593 return (check_writable (SDATA (encoded
))
2596 dir
= Ffile_name_directory (absname
);
2599 dir
= Fdirectory_file_name (dir
);
2602 dir
= ENCODE_FILE (dir
);
2604 /* The read-only attribute of the parent directory doesn't affect
2605 whether a file or directory can be created within it. Some day we
2606 should check ACLs though, which do affect this. */
2607 if (stat (SDATA (dir
), &statbuf
) < 0)
2609 return (statbuf
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2611 return (check_writable (!NILP (dir
) ? (char *) SDATA (dir
) : "")
2616 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2617 doc
: /* Access file FILENAME, and get an error if that does not work.
2618 The second argument STRING is used in the error message.
2619 If there is no error, returns nil. */)
2621 Lisp_Object filename
, string
;
2623 Lisp_Object handler
, encoded_filename
, absname
;
2626 CHECK_STRING (filename
);
2627 absname
= Fexpand_file_name (filename
, Qnil
);
2629 CHECK_STRING (string
);
2631 /* If the file name has special constructs in it,
2632 call the corresponding file handler. */
2633 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2634 if (!NILP (handler
))
2635 return call3 (handler
, Qaccess_file
, absname
, string
);
2637 encoded_filename
= ENCODE_FILE (absname
);
2639 fd
= emacs_open (SDATA (encoded_filename
), O_RDONLY
, 0);
2641 report_file_error (SDATA (string
), Fcons (filename
, Qnil
));
2647 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2648 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2649 The value is the link target, as a string.
2650 Otherwise it returns nil.
2652 This function returns t when given the name of a symlink that
2653 points to a nonexistent file. */)
2655 Lisp_Object filename
;
2657 Lisp_Object handler
;
2659 CHECK_STRING (filename
);
2660 filename
= Fexpand_file_name (filename
, Qnil
);
2662 /* If the file name has special constructs in it,
2663 call the corresponding file handler. */
2664 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2665 if (!NILP (handler
))
2666 return call2 (handler
, Qfile_symlink_p
, filename
);
2675 filename
= ENCODE_FILE (filename
);
2682 buf
= (char *) xrealloc (buf
, bufsize
);
2683 bzero (buf
, bufsize
);
2686 valsize
= readlink (SDATA (filename
), buf
, bufsize
);
2690 /* HP-UX reports ERANGE if buffer is too small. */
2691 if (errno
== ERANGE
)
2701 while (valsize
>= bufsize
);
2703 val
= make_string (buf
, valsize
);
2704 if (buf
[0] == '/' && index (buf
, ':'))
2705 val
= concat2 (build_string ("/:"), val
);
2707 val
= DECODE_FILE (val
);
2710 #else /* not S_IFLNK */
2712 #endif /* not S_IFLNK */
2715 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2716 doc
: /* Return t if FILENAME names an existing directory.
2717 Symbolic links to directories count as directories.
2718 See `file-symlink-p' to distinguish symlinks. */)
2720 Lisp_Object filename
;
2722 register Lisp_Object absname
;
2724 Lisp_Object handler
;
2726 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2728 /* If the file name has special constructs in it,
2729 call the corresponding file handler. */
2730 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2731 if (!NILP (handler
))
2732 return call2 (handler
, Qfile_directory_p
, absname
);
2734 absname
= ENCODE_FILE (absname
);
2736 if (stat (SDATA (absname
), &st
) < 0)
2738 return (st
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2741 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
2742 doc
: /* Return t if file FILENAME names a directory you can open.
2743 For the value to be t, FILENAME must specify the name of a directory as a file,
2744 and the directory must allow you to open files in it. In order to use a
2745 directory as a buffer's current directory, this predicate must return true.
2746 A directory name spec may be given instead; then the value is t
2747 if the directory so specified exists and really is a readable and
2748 searchable directory. */)
2750 Lisp_Object filename
;
2752 Lisp_Object handler
;
2754 struct gcpro gcpro1
;
2756 /* If the file name has special constructs in it,
2757 call the corresponding file handler. */
2758 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2759 if (!NILP (handler
))
2760 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2763 tem
= (NILP (Ffile_directory_p (filename
))
2764 || NILP (Ffile_executable_p (filename
)));
2766 return tem
? Qnil
: Qt
;
2769 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2770 doc
: /* Return t if FILENAME names a regular file.
2771 This is the sort of file that holds an ordinary stream of data bytes.
2772 Symbolic links to regular files count as regular files.
2773 See `file-symlink-p' to distinguish symlinks. */)
2775 Lisp_Object filename
;
2777 register Lisp_Object absname
;
2779 Lisp_Object handler
;
2781 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2783 /* If the file name has special constructs in it,
2784 call the corresponding file handler. */
2785 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2786 if (!NILP (handler
))
2787 return call2 (handler
, Qfile_regular_p
, absname
);
2789 absname
= ENCODE_FILE (absname
);
2794 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2796 /* Tell stat to use expensive method to get accurate info. */
2797 Vw32_get_true_file_attributes
= Qt
;
2798 result
= stat (SDATA (absname
), &st
);
2799 Vw32_get_true_file_attributes
= tem
;
2803 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2806 if (stat (SDATA (absname
), &st
) < 0)
2808 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2812 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2813 doc
: /* Return mode bits of file named FILENAME, as an integer.
2814 Return nil, if file does not exist or is not accessible. */)
2816 Lisp_Object filename
;
2818 Lisp_Object absname
;
2820 Lisp_Object handler
;
2822 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2824 /* If the file name has special constructs in it,
2825 call the corresponding file handler. */
2826 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2827 if (!NILP (handler
))
2828 return call2 (handler
, Qfile_modes
, absname
);
2830 absname
= ENCODE_FILE (absname
);
2832 if (stat (SDATA (absname
), &st
) < 0)
2834 #if defined (MSDOS) && __DJGPP__ < 2
2835 if (check_executable (SDATA (absname
)))
2836 st
.st_mode
|= S_IEXEC
;
2837 #endif /* MSDOS && __DJGPP__ < 2 */
2839 return make_number (st
.st_mode
& 07777);
2842 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2843 "(let ((file (read-file-name \"File: \"))) \
2844 (list file (read-file-modes nil file)))",
2845 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2846 Only the 12 low bits of MODE are used. */)
2848 Lisp_Object filename
, mode
;
2850 Lisp_Object absname
, encoded_absname
;
2851 Lisp_Object handler
;
2853 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2854 CHECK_NUMBER (mode
);
2856 /* If the file name has special constructs in it,
2857 call the corresponding file handler. */
2858 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2859 if (!NILP (handler
))
2860 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2862 encoded_absname
= ENCODE_FILE (absname
);
2864 if (chmod (SDATA (encoded_absname
), XINT (mode
)) < 0)
2865 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2870 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2871 doc
: /* Set the file permission bits for newly created files.
2872 The argument MODE should be an integer; only the low 9 bits are used.
2873 This setting is inherited by subprocesses. */)
2877 CHECK_NUMBER (mode
);
2879 umask ((~ XINT (mode
)) & 0777);
2884 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
2885 doc
: /* Return the default file protection for created files.
2886 The value is an integer. */)
2892 realmask
= umask (0);
2895 XSETINT (value
, (~ realmask
) & 0777);
2899 extern int lisp_time_argument
P_ ((Lisp_Object
, time_t *, int *));
2901 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
2902 doc
: /* Set times of file FILENAME to TIME.
2903 Set both access and modification times.
2904 Return t on success, else nil.
2905 Use the current time if TIME is nil. TIME is in the format of
2908 Lisp_Object filename
, time
;
2910 Lisp_Object absname
, encoded_absname
;
2911 Lisp_Object handler
;
2915 if (! lisp_time_argument (time
, &sec
, &usec
))
2916 error ("Invalid time specification");
2918 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2920 /* If the file name has special constructs in it,
2921 call the corresponding file handler. */
2922 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
2923 if (!NILP (handler
))
2924 return call3 (handler
, Qset_file_times
, absname
, time
);
2926 encoded_absname
= ENCODE_FILE (absname
);
2931 EMACS_SET_SECS (t
, sec
);
2932 EMACS_SET_USECS (t
, usec
);
2934 if (set_file_times (SDATA (encoded_absname
), t
, t
))
2939 /* Setting times on a directory always fails. */
2940 if (stat (SDATA (encoded_absname
), &st
) == 0
2941 && (st
.st_mode
& S_IFMT
) == S_IFDIR
)
2944 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
2953 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
2954 doc
: /* Tell Unix to finish all pending disk updates. */)
2961 #endif /* HAVE_SYNC */
2963 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
2964 doc
: /* Return t if file FILE1 is newer than file FILE2.
2965 If FILE1 does not exist, the answer is nil;
2966 otherwise, if FILE2 does not exist, the answer is t. */)
2968 Lisp_Object file1
, file2
;
2970 Lisp_Object absname1
, absname2
;
2973 Lisp_Object handler
;
2974 struct gcpro gcpro1
, gcpro2
;
2976 CHECK_STRING (file1
);
2977 CHECK_STRING (file2
);
2980 GCPRO2 (absname1
, file2
);
2981 absname1
= expand_and_dir_to_file (file1
, current_buffer
->directory
);
2982 absname2
= expand_and_dir_to_file (file2
, current_buffer
->directory
);
2985 /* If the file name has special constructs in it,
2986 call the corresponding file handler. */
2987 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
2989 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
2990 if (!NILP (handler
))
2991 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
2993 GCPRO2 (absname1
, absname2
);
2994 absname1
= ENCODE_FILE (absname1
);
2995 absname2
= ENCODE_FILE (absname2
);
2998 if (stat (SDATA (absname1
), &st
) < 0)
3001 mtime1
= st
.st_mtime
;
3003 if (stat (SDATA (absname2
), &st
) < 0)
3006 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3010 Lisp_Object Qfind_buffer_file_type
;
3013 #ifndef READ_BUF_SIZE
3014 #define READ_BUF_SIZE (64 << 10)
3017 extern void adjust_markers_for_delete
P_ ((int, int, int, int));
3019 /* This function is called after Lisp functions to decide a coding
3020 system are called, or when they cause an error. Before they are
3021 called, the current buffer is set unibyte and it contains only a
3022 newly inserted text (thus the buffer was empty before the
3025 The functions may set markers, overlays, text properties, or even
3026 alter the buffer contents, change the current buffer.
3028 Here, we reset all those changes by:
3029 o set back the current buffer.
3030 o move all markers and overlays to BEG.
3031 o remove all text properties.
3032 o set back the buffer multibyteness. */
3035 decide_coding_unwind (unwind_data
)
3036 Lisp_Object unwind_data
;
3038 Lisp_Object multibyte
, undo_list
, buffer
;
3040 multibyte
= XCAR (unwind_data
);
3041 unwind_data
= XCDR (unwind_data
);
3042 undo_list
= XCAR (unwind_data
);
3043 buffer
= XCDR (unwind_data
);
3045 if (current_buffer
!= XBUFFER (buffer
))
3046 set_buffer_internal (XBUFFER (buffer
));
3047 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3048 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3049 BUF_INTERVALS (current_buffer
) = 0;
3050 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3052 /* Now we are safe to change the buffer's multibyteness directly. */
3053 current_buffer
->enable_multibyte_characters
= multibyte
;
3054 current_buffer
->undo_list
= undo_list
;
3060 /* Used to pass values from insert-file-contents to read_non_regular. */
3062 static int non_regular_fd
;
3063 static int non_regular_inserted
;
3064 static int non_regular_nbytes
;
3067 /* Read from a non-regular file.
3068 Read non_regular_trytry bytes max from non_regular_fd.
3069 Non_regular_inserted specifies where to put the read bytes.
3070 Value is the number of bytes read. */
3079 nbytes
= emacs_read (non_regular_fd
,
3080 BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ non_regular_inserted
,
3081 non_regular_nbytes
);
3083 return make_number (nbytes
);
3087 /* Condition-case handler used when reading from non-regular files
3088 in insert-file-contents. */
3091 read_non_regular_quit ()
3097 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3099 doc
: /* Insert contents of file FILENAME after point.
3100 Returns list of absolute file name and number of characters inserted.
3101 If second argument VISIT is non-nil, the buffer's visited filename and
3102 last save file modtime are set, and it is marked unmodified. If
3103 visiting and the file does not exist, visiting is completed before the
3106 The optional third and fourth arguments BEG and END specify what portion
3107 of the file to insert. These arguments count bytes in the file, not
3108 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3110 If optional fifth argument REPLACE is non-nil, replace the current
3111 buffer contents (in the accessible portion) with the file contents.
3112 This is better than simply deleting and inserting the whole thing
3113 because (1) it preserves some marker positions and (2) it puts less data
3114 in the undo list. When REPLACE is non-nil, the second return value is
3115 the number of characters that replace previous buffer contents.
3117 This function does code conversion according to the value of
3118 `coding-system-for-read' or `file-coding-system-alist', and sets the
3119 variable `last-coding-system-used' to the coding system actually used. */)
3120 (filename
, visit
, beg
, end
, replace
)
3121 Lisp_Object filename
, visit
, beg
, end
, replace
;
3127 register int how_much
;
3128 register int unprocessed
;
3129 int count
= SPECPDL_INDEX ();
3130 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3131 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3134 int not_regular
= 0;
3135 unsigned char read_buf
[READ_BUF_SIZE
];
3136 struct coding_system coding
;
3137 unsigned char buffer
[1 << 14];
3138 int replace_handled
= 0;
3139 int set_coding_system
= 0;
3140 Lisp_Object coding_system
;
3142 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3143 int we_locked_file
= 0;
3145 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3146 error ("Cannot do file visiting in an indirect buffer");
3148 if (!NILP (current_buffer
->read_only
))
3149 Fbarf_if_buffer_read_only ();
3153 orig_filename
= Qnil
;
3156 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3158 CHECK_STRING (filename
);
3159 filename
= Fexpand_file_name (filename
, Qnil
);
3161 /* The value Qnil means that the coding system is not yet
3163 coding_system
= Qnil
;
3165 /* If the file name has special constructs in it,
3166 call the corresponding file handler. */
3167 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3168 if (!NILP (handler
))
3170 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3171 visit
, beg
, end
, replace
);
3172 if (CONSP (val
) && CONSP (XCDR (val
)))
3173 inserted
= XINT (XCAR (XCDR (val
)));
3177 orig_filename
= filename
;
3178 filename
= ENCODE_FILE (filename
);
3184 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3186 /* Tell stat to use expensive method to get accurate info. */
3187 Vw32_get_true_file_attributes
= Qt
;
3188 total
= stat (SDATA (filename
), &st
);
3189 Vw32_get_true_file_attributes
= tem
;
3193 if (stat (SDATA (filename
), &st
) < 0)
3194 #endif /* WINDOWSNT */
3196 if (fd
>= 0) emacs_close (fd
);
3199 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3202 if (!NILP (Vcoding_system_for_read
))
3203 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3208 /* This code will need to be changed in order to work on named
3209 pipes, and it's probably just not worth it. So we should at
3210 least signal an error. */
3211 if (!S_ISREG (st
.st_mode
))
3218 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3219 xsignal2 (Qfile_error
,
3220 build_string ("not a regular file"), orig_filename
);
3225 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0)
3228 /* Replacement should preserve point as it preserves markers. */
3229 if (!NILP (replace
))
3230 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3232 record_unwind_protect (close_file_unwind
, make_number (fd
));
3234 /* Can happen on any platform that uses long as type of off_t, but allows
3235 file sizes to exceed 2Gb, so give a suitable message. */
3236 if (! not_regular
&& st
.st_size
< 0)
3237 error ("Maximum buffer size exceeded");
3239 /* Prevent redisplay optimizations. */
3240 current_buffer
->clip_changed
= 1;
3244 if (!NILP (beg
) || !NILP (end
))
3245 error ("Attempt to visit less than an entire file");
3246 if (BEG
< Z
&& NILP (replace
))
3247 error ("Cannot do file visiting in a non-empty buffer");
3253 XSETFASTINT (beg
, 0);
3261 XSETINT (end
, st
.st_size
);
3263 /* Arithmetic overflow can occur if an Emacs integer cannot
3264 represent the file size, or if the calculations below
3265 overflow. The calculations below double the file size
3266 twice, so check that it can be multiplied by 4 safely. */
3267 if (XINT (end
) != st
.st_size
3268 || st
.st_size
> INT_MAX
/ 4)
3269 error ("Maximum buffer size exceeded");
3271 /* The file size returned from stat may be zero, but data
3272 may be readable nonetheless, for example when this is a
3273 file in the /proc filesystem. */
3274 if (st
.st_size
== 0)
3275 XSETINT (end
, READ_BUF_SIZE
);
3279 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3281 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3282 setup_coding_system (coding_system
, &coding
);
3283 /* Ensure we set Vlast_coding_system_used. */
3284 set_coding_system
= 1;
3288 /* Decide the coding system to use for reading the file now
3289 because we can't use an optimized method for handling
3290 `coding:' tag if the current buffer is not empty. */
3291 if (!NILP (Vcoding_system_for_read
))
3292 coding_system
= Vcoding_system_for_read
;
3295 /* Don't try looking inside a file for a coding system
3296 specification if it is not seekable. */
3297 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3299 /* Find a coding system specified in the heading two
3300 lines or in the tailing several lines of the file.
3301 We assume that the 1K-byte and 3K-byte for heading
3302 and tailing respectively are sufficient for this
3306 if (st
.st_size
<= (1024 * 4))
3307 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3310 nread
= emacs_read (fd
, read_buf
, 1024);
3313 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3314 report_file_error ("Setting file position",
3315 Fcons (orig_filename
, Qnil
));
3316 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3321 error ("IO error reading %s: %s",
3322 SDATA (orig_filename
), emacs_strerror (errno
));
3325 struct buffer
*prev
= current_buffer
;
3329 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3331 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3332 buf
= XBUFFER (buffer
);
3334 delete_all_overlays (buf
);
3335 buf
->directory
= current_buffer
->directory
;
3336 buf
->read_only
= Qnil
;
3337 buf
->filename
= Qnil
;
3338 buf
->undo_list
= Qt
;
3339 eassert (buf
->overlays_before
== NULL
);
3340 eassert (buf
->overlays_after
== NULL
);
3342 set_buffer_internal (buf
);
3344 buf
->enable_multibyte_characters
= Qnil
;
3346 insert_1_both (read_buf
, nread
, nread
, 0, 0, 0);
3347 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3348 coding_system
= call2 (Vset_auto_coding_function
,
3349 filename
, make_number (nread
));
3350 set_buffer_internal (prev
);
3352 /* Discard the unwind protect for recovering the
3356 /* Rewind the file for the actual read done later. */
3357 if (lseek (fd
, 0, 0) < 0)
3358 report_file_error ("Setting file position",
3359 Fcons (orig_filename
, Qnil
));
3363 if (NILP (coding_system
))
3365 /* If we have not yet decided a coding system, check
3366 file-coding-system-alist. */
3367 Lisp_Object args
[6];
3369 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3370 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3371 coding_system
= Ffind_operation_coding_system (6, args
);
3372 if (CONSP (coding_system
))
3373 coding_system
= XCAR (coding_system
);
3377 if (NILP (coding_system
))
3378 coding_system
= Qundecided
;
3380 CHECK_CODING_SYSTEM (coding_system
);
3382 if (NILP (current_buffer
->enable_multibyte_characters
))
3383 /* We must suppress all character code conversion except for
3384 end-of-line conversion. */
3385 coding_system
= raw_text_coding_system (coding_system
);
3387 setup_coding_system (coding_system
, &coding
);
3388 /* Ensure we set Vlast_coding_system_used. */
3389 set_coding_system
= 1;
3392 /* If requested, replace the accessible part of the buffer
3393 with the file contents. Avoid replacing text at the
3394 beginning or end of the buffer that matches the file contents;
3395 that preserves markers pointing to the unchanged parts.
3397 Here we implement this feature in an optimized way
3398 for the case where code conversion is NOT needed.
3399 The following if-statement handles the case of conversion
3400 in a less optimal way.
3402 If the code conversion is "automatic" then we try using this
3403 method and hope for the best.
3404 But if we discover the need for conversion, we give up on this method
3405 and let the following if-statement handle the replace job. */
3408 && (NILP (coding_system
)
3409 || ! CODING_REQUIRE_DECODING (&coding
)))
3411 /* same_at_start and same_at_end count bytes,
3412 because file access counts bytes
3413 and BEG and END count bytes. */
3414 int same_at_start
= BEGV_BYTE
;
3415 int same_at_end
= ZV_BYTE
;
3417 /* There is still a possibility we will find the need to do code
3418 conversion. If that happens, we set this variable to 1 to
3419 give up on handling REPLACE in the optimized way. */
3420 int giveup_match_end
= 0;
3422 if (XINT (beg
) != 0)
3424 if (lseek (fd
, XINT (beg
), 0) < 0)
3425 report_file_error ("Setting file position",
3426 Fcons (orig_filename
, Qnil
));
3431 /* Count how many chars at the start of the file
3432 match the text at the beginning of the buffer. */
3437 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3439 error ("IO error reading %s: %s",
3440 SDATA (orig_filename
), emacs_strerror (errno
));
3441 else if (nread
== 0)
3444 if (CODING_REQUIRE_DETECTION (&coding
))
3446 coding_system
= detect_coding_system (buffer
, nread
, nread
, 1, 0,
3448 setup_coding_system (coding_system
, &coding
);
3451 if (CODING_REQUIRE_DECODING (&coding
))
3452 /* We found that the file should be decoded somehow.
3453 Let's give up here. */
3455 giveup_match_end
= 1;
3460 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3461 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3462 same_at_start
++, bufpos
++;
3463 /* If we found a discrepancy, stop the scan.
3464 Otherwise loop around and scan the next bufferful. */
3465 if (bufpos
!= nread
)
3469 /* If the file matches the buffer completely,
3470 there's no need to replace anything. */
3471 if (same_at_start
- BEGV_BYTE
== XINT (end
))
3475 /* Truncate the buffer to the size of the file. */
3476 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3481 /* Count how many chars at the end of the file
3482 match the text at the end of the buffer. But, if we have
3483 already found that decoding is necessary, don't waste time. */
3484 while (!giveup_match_end
)
3486 int total_read
, nread
, bufpos
, curpos
, trial
;
3488 /* At what file position are we now scanning? */
3489 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
3490 /* If the entire file matches the buffer tail, stop the scan. */
3493 /* How much can we scan in the next step? */
3494 trial
= min (curpos
, sizeof buffer
);
3495 if (lseek (fd
, curpos
- trial
, 0) < 0)
3496 report_file_error ("Setting file position",
3497 Fcons (orig_filename
, Qnil
));
3499 total_read
= nread
= 0;
3500 while (total_read
< trial
)
3502 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3504 error ("IO error reading %s: %s",
3505 SDATA (orig_filename
), emacs_strerror (errno
));
3506 else if (nread
== 0)
3508 total_read
+= nread
;
3511 /* Scan this bufferful from the end, comparing with
3512 the Emacs buffer. */
3513 bufpos
= total_read
;
3515 /* Compare with same_at_start to avoid counting some buffer text
3516 as matching both at the file's beginning and at the end. */
3517 while (bufpos
> 0 && same_at_end
> same_at_start
3518 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3519 same_at_end
--, bufpos
--;
3521 /* If we found a discrepancy, stop the scan.
3522 Otherwise loop around and scan the preceding bufferful. */
3525 /* If this discrepancy is because of code conversion,
3526 we cannot use this method; giveup and try the other. */
3527 if (same_at_end
> same_at_start
3528 && FETCH_BYTE (same_at_end
- 1) >= 0200
3529 && ! NILP (current_buffer
->enable_multibyte_characters
)
3530 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3531 giveup_match_end
= 1;
3540 if (! giveup_match_end
)
3544 /* We win! We can handle REPLACE the optimized way. */
3546 /* Extend the start of non-matching text area to multibyte
3547 character boundary. */
3548 if (! NILP (current_buffer
->enable_multibyte_characters
))
3549 while (same_at_start
> BEGV_BYTE
3550 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3553 /* Extend the end of non-matching text area to multibyte
3554 character boundary. */
3555 if (! NILP (current_buffer
->enable_multibyte_characters
))
3556 while (same_at_end
< ZV_BYTE
3557 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3560 /* Don't try to reuse the same piece of text twice. */
3561 overlap
= (same_at_start
- BEGV_BYTE
3562 - (same_at_end
+ st
.st_size
- ZV
));
3564 same_at_end
+= overlap
;
3566 /* Arrange to read only the nonmatching middle part of the file. */
3567 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
3568 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
3570 del_range_byte (same_at_start
, same_at_end
, 0);
3571 /* Insert from the file at the proper position. */
3572 temp
= BYTE_TO_CHAR (same_at_start
);
3573 SET_PT_BOTH (temp
, same_at_start
);
3575 /* If display currently starts at beginning of line,
3576 keep it that way. */
3577 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3578 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3580 replace_handled
= 1;
3584 /* If requested, replace the accessible part of the buffer
3585 with the file contents. Avoid replacing text at the
3586 beginning or end of the buffer that matches the file contents;
3587 that preserves markers pointing to the unchanged parts.
3589 Here we implement this feature for the case where code conversion
3590 is needed, in a simple way that needs a lot of memory.
3591 The preceding if-statement handles the case of no conversion
3592 in a more optimized way. */
3593 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3595 EMACS_INT same_at_start
= BEGV_BYTE
;
3596 EMACS_INT same_at_end
= ZV_BYTE
;
3597 EMACS_INT same_at_start_charpos
;
3598 EMACS_INT inserted_chars
;
3601 unsigned char *decoded
;
3603 int this_count
= SPECPDL_INDEX ();
3604 int multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
3605 Lisp_Object conversion_buffer
;
3607 conversion_buffer
= code_conversion_save (1, multibyte
);
3609 /* First read the whole file, performing code conversion into
3610 CONVERSION_BUFFER. */
3612 if (lseek (fd
, XINT (beg
), 0) < 0)
3613 report_file_error ("Setting file position",
3614 Fcons (orig_filename
, Qnil
));
3616 total
= st
.st_size
; /* Total bytes in the file. */
3617 how_much
= 0; /* Bytes read from file so far. */
3618 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3619 unprocessed
= 0; /* Bytes not processed in previous loop. */
3621 GCPRO1 (conversion_buffer
);
3622 while (how_much
< total
)
3624 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3625 quitting while reading a huge while. */
3626 /* try is reserved in some compilers (Microsoft C) */
3627 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
3630 /* Allow quitting out of the actual I/O. */
3633 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3645 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3646 BUF_Z (XBUFFER (conversion_buffer
)));
3647 decode_coding_c_string (&coding
, read_buf
, unprocessed
+ this,
3649 unprocessed
= coding
.carryover_bytes
;
3650 if (coding
.carryover_bytes
> 0)
3651 bcopy (coding
.carryover
, read_buf
, unprocessed
);
3656 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3657 if we couldn't read the file. */
3660 error ("IO error reading %s: %s",
3661 SDATA (orig_filename
), emacs_strerror (errno
));
3663 if (unprocessed
> 0)
3665 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3666 decode_coding_c_string (&coding
, read_buf
, unprocessed
,
3668 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3671 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3672 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3673 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3675 /* Compare the beginning of the converted string with the buffer
3679 while (bufpos
< inserted
&& same_at_start
< same_at_end
3680 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3681 same_at_start
++, bufpos
++;
3683 /* If the file matches the head of buffer completely,
3684 there's no need to replace anything. */
3686 if (bufpos
== inserted
)
3688 /* Truncate the buffer to the size of the file. */
3689 if (same_at_start
== same_at_end
)
3692 del_range_byte (same_at_start
, same_at_end
, 0);
3695 unbind_to (this_count
, Qnil
);
3699 /* Extend the start of non-matching text area to the previous
3700 multibyte character boundary. */
3701 if (! NILP (current_buffer
->enable_multibyte_characters
))
3702 while (same_at_start
> BEGV_BYTE
3703 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3706 /* Scan this bufferful from the end, comparing with
3707 the Emacs buffer. */
3710 /* Compare with same_at_start to avoid counting some buffer text
3711 as matching both at the file's beginning and at the end. */
3712 while (bufpos
> 0 && same_at_end
> same_at_start
3713 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3714 same_at_end
--, bufpos
--;
3716 /* Extend the end of non-matching text area to the next
3717 multibyte character boundary. */
3718 if (! NILP (current_buffer
->enable_multibyte_characters
))
3719 while (same_at_end
< ZV_BYTE
3720 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3723 /* Don't try to reuse the same piece of text twice. */
3724 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3726 same_at_end
+= overlap
;
3728 /* If display currently starts at beginning of line,
3729 keep it that way. */
3730 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3731 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3733 /* Replace the chars that we need to replace,
3734 and update INSERTED to equal the number of bytes
3735 we are taking from the decoded string. */
3736 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3738 if (same_at_end
!= same_at_start
)
3740 del_range_byte (same_at_start
, same_at_end
, 0);
3742 same_at_start
= GPT_BYTE
;
3746 temp
= BYTE_TO_CHAR (same_at_start
);
3748 /* Insert from the file at the proper position. */
3749 SET_PT_BOTH (temp
, same_at_start
);
3750 same_at_start_charpos
3751 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3752 same_at_start
- BEGV_BYTE
3753 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3755 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3756 same_at_start
+ inserted
- BEGV_BYTE
3757 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3758 - same_at_start_charpos
);
3759 /* This binding is to avoid ask-user-about-supersession-threat
3760 being called in insert_from_buffer (via in
3761 prepare_to_modify_buffer). */
3762 specbind (intern ("buffer-file-name"), Qnil
);
3763 insert_from_buffer (XBUFFER (conversion_buffer
),
3764 same_at_start_charpos
, inserted_chars
, 0);
3765 /* Set `inserted' to the number of inserted characters. */
3766 inserted
= PT
- temp
;
3767 /* Set point before the inserted characters. */
3768 SET_PT_BOTH (temp
, same_at_start
);
3770 unbind_to (this_count
, Qnil
);
3777 register Lisp_Object temp
;
3779 total
= XINT (end
) - XINT (beg
);
3781 /* Make sure point-max won't overflow after this insertion. */
3782 XSETINT (temp
, total
);
3783 if (total
!= XINT (temp
))
3784 error ("Maximum buffer size exceeded");
3787 /* For a special file, all we can do is guess. */
3788 total
= READ_BUF_SIZE
;
3790 if (NILP (visit
) && inserted
> 0)
3792 #ifdef CLASH_DETECTION
3793 if (!NILP (current_buffer
->file_truename
)
3794 /* Make binding buffer-file-name to nil effective. */
3795 && !NILP (current_buffer
->filename
)
3796 && SAVE_MODIFF
>= MODIFF
)
3798 #endif /* CLASH_DETECTION */
3799 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3803 if (GAP_SIZE
< total
)
3804 make_gap (total
- GAP_SIZE
);
3806 if (XINT (beg
) != 0 || !NILP (replace
))
3808 if (lseek (fd
, XINT (beg
), 0) < 0)
3809 report_file_error ("Setting file position",
3810 Fcons (orig_filename
, Qnil
));
3813 /* In the following loop, HOW_MUCH contains the total bytes read so
3814 far for a regular file, and not changed for a special file. But,
3815 before exiting the loop, it is set to a negative value if I/O
3819 /* Total bytes inserted. */
3822 /* Here, we don't do code conversion in the loop. It is done by
3823 decode_coding_gap after all data are read into the buffer. */
3825 int gap_size
= GAP_SIZE
;
3827 while (how_much
< total
)
3829 /* try is reserved in some compilers (Microsoft C) */
3830 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3837 /* Maybe make more room. */
3838 if (gap_size
< trytry
)
3840 make_gap (total
- gap_size
);
3841 gap_size
= GAP_SIZE
;
3844 /* Read from the file, capturing `quit'. When an
3845 error occurs, end the loop, and arrange for a quit
3846 to be signaled after decoding the text we read. */
3847 non_regular_fd
= fd
;
3848 non_regular_inserted
= inserted
;
3849 non_regular_nbytes
= trytry
;
3850 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
3851 read_non_regular_quit
);
3862 /* Allow quitting out of the actual I/O. We don't make text
3863 part of the buffer until all the reading is done, so a C-g
3864 here doesn't do any harm. */
3867 this = emacs_read (fd
, BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ inserted
, trytry
);
3879 /* For a regular file, where TOTAL is the real size,
3880 count HOW_MUCH to compare with it.
3881 For a special file, where TOTAL is just a buffer size,
3882 so don't bother counting in HOW_MUCH.
3883 (INSERTED is where we count the number of characters inserted.) */
3890 /* Now we have read all the file data into the gap.
3891 If it was empty, undo marking the buffer modified. */
3895 #ifdef CLASH_DETECTION
3897 unlock_file (current_buffer
->file_truename
);
3899 Vdeactivate_mark
= old_Vdeactivate_mark
;
3902 Vdeactivate_mark
= Qt
;
3904 /* Make the text read part of the buffer. */
3905 GAP_SIZE
-= inserted
;
3907 GPT_BYTE
+= inserted
;
3909 ZV_BYTE
+= inserted
;
3914 /* Put an anchor to ensure multi-byte form ends at gap. */
3919 /* Discard the unwind protect for closing the file. */
3923 error ("IO error reading %s: %s",
3924 SDATA (orig_filename
), emacs_strerror (errno
));
3928 if (NILP (coding_system
))
3930 /* The coding system is not yet decided. Decide it by an
3931 optimized method for handling `coding:' tag.
3933 Note that we can get here only if the buffer was empty
3934 before the insertion. */
3936 if (!NILP (Vcoding_system_for_read
))
3937 coding_system
= Vcoding_system_for_read
;
3940 /* Since we are sure that the current buffer was empty
3941 before the insertion, we can toggle
3942 enable-multibyte-characters directly here without taking
3943 care of marker adjustment. By this way, we can run Lisp
3944 program safely before decoding the inserted text. */
3945 Lisp_Object unwind_data
;
3946 int count
= SPECPDL_INDEX ();
3948 unwind_data
= Fcons (current_buffer
->enable_multibyte_characters
,
3949 Fcons (current_buffer
->undo_list
,
3950 Fcurrent_buffer ()));
3951 current_buffer
->enable_multibyte_characters
= Qnil
;
3952 current_buffer
->undo_list
= Qt
;
3953 record_unwind_protect (decide_coding_unwind
, unwind_data
);
3955 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
3957 coding_system
= call2 (Vset_auto_coding_function
,
3958 filename
, make_number (inserted
));
3961 if (NILP (coding_system
))
3963 /* If the coding system is not yet decided, check
3964 file-coding-system-alist. */
3965 Lisp_Object args
[6];
3967 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3968 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
3969 coding_system
= Ffind_operation_coding_system (6, args
);
3970 if (CONSP (coding_system
))
3971 coding_system
= XCAR (coding_system
);
3973 unbind_to (count
, Qnil
);
3974 inserted
= Z_BYTE
- BEG_BYTE
;
3977 if (NILP (coding_system
))
3978 coding_system
= Qundecided
;
3980 CHECK_CODING_SYSTEM (coding_system
);
3982 if (NILP (current_buffer
->enable_multibyte_characters
))
3983 /* We must suppress all character code conversion except for
3984 end-of-line conversion. */
3985 coding_system
= raw_text_coding_system (coding_system
);
3986 setup_coding_system (coding_system
, &coding
);
3987 /* Ensure we set Vlast_coding_system_used. */
3988 set_coding_system
= 1;
3993 /* When we visit a file by raw-text, we change the buffer to
3995 if (CODING_FOR_UNIBYTE (&coding
)
3996 /* Can't do this if part of the buffer might be preserved. */
3998 /* Visiting a file with these coding system makes the buffer
4000 current_buffer
->enable_multibyte_characters
= Qnil
;
4003 coding
.dst_multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
4004 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4005 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4007 move_gap_both (PT
, PT_BYTE
);
4008 GAP_SIZE
+= inserted
;
4009 ZV_BYTE
-= inserted
;
4013 decode_coding_gap (&coding
, inserted
, inserted
);
4014 inserted
= coding
.produced_char
;
4015 coding_system
= CODING_ID_NAME (coding
.id
);
4017 else if (inserted
> 0)
4018 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4021 /* Now INSERTED is measured in characters. */
4024 /* Use the conversion type to determine buffer-file-type
4025 (find-buffer-file-type is now used to help determine the
4027 if ((VECTORP (CODING_ID_EOL_TYPE (coding
.id
))
4028 || EQ (CODING_ID_EOL_TYPE (coding
.id
), Qunix
))
4029 && ! CODING_REQUIRE_DECODING (&coding
))
4030 current_buffer
->buffer_file_type
= Qt
;
4032 current_buffer
->buffer_file_type
= Qnil
;
4039 if (!EQ (current_buffer
->undo_list
, Qt
) && !nochange
)
4040 current_buffer
->undo_list
= Qnil
;
4044 current_buffer
->modtime
= st
.st_mtime
;
4045 current_buffer
->filename
= orig_filename
;
4048 SAVE_MODIFF
= MODIFF
;
4049 current_buffer
->auto_save_modified
= MODIFF
;
4050 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4051 #ifdef CLASH_DETECTION
4054 if (!NILP (current_buffer
->file_truename
))
4055 unlock_file (current_buffer
->file_truename
);
4056 unlock_file (filename
);
4058 #endif /* CLASH_DETECTION */
4060 xsignal2 (Qfile_error
,
4061 build_string ("not a regular file"), orig_filename
);
4064 if (set_coding_system
)
4065 Vlast_coding_system_used
= coding_system
;
4067 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4069 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4071 if (! NILP (insval
))
4073 CHECK_NUMBER (insval
);
4074 inserted
= XFASTINT (insval
);
4078 /* Decode file format. */
4081 /* Don't run point motion or modification hooks when decoding. */
4082 int count
= SPECPDL_INDEX ();
4083 int old_inserted
= inserted
;
4084 specbind (Qinhibit_point_motion_hooks
, Qt
);
4085 specbind (Qinhibit_modification_hooks
, Qt
);
4087 /* Save old undo list and don't record undo for decoding. */
4088 old_undo
= current_buffer
->undo_list
;
4089 current_buffer
->undo_list
= Qt
;
4093 insval
= call3 (Qformat_decode
,
4094 Qnil
, make_number (inserted
), visit
);
4095 CHECK_NUMBER (insval
);
4096 inserted
= XFASTINT (insval
);
4100 /* If REPLACE is non-nil and we succeeded in not replacing the
4101 beginning or end of the buffer text with the file's contents,
4102 call format-decode with `point' positioned at the beginning
4103 of the buffer and `inserted' equalling the number of
4104 characters in the buffer. Otherwise, format-decode might
4105 fail to correctly analyze the beginning or end of the buffer.
4106 Hence we temporarily save `point' and `inserted' here and
4107 restore `point' iff format-decode did not insert or delete
4108 any text. Otherwise we leave `point' at point-min. */
4110 int opoint_byte
= PT_BYTE
;
4111 int oinserted
= ZV
- BEGV
;
4112 int ochars_modiff
= CHARS_MODIFF
;
4114 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4115 insval
= call3 (Qformat_decode
,
4116 Qnil
, make_number (oinserted
), visit
);
4117 CHECK_NUMBER (insval
);
4118 if (ochars_modiff
== CHARS_MODIFF
)
4119 /* format_decode didn't modify buffer's characters => move
4120 point back to position before inserted text and leave
4121 value of inserted alone. */
4122 SET_PT_BOTH (opoint
, opoint_byte
);
4124 /* format_decode modified buffer's characters => consider
4125 entire buffer changed and leave point at point-min. */
4126 inserted
= XFASTINT (insval
);
4129 /* For consistency with format-decode call these now iff inserted > 0
4130 (martin 2007-06-28). */
4131 p
= Vafter_insert_file_functions
;
4136 insval
= call1 (XCAR (p
), make_number (inserted
));
4139 CHECK_NUMBER (insval
);
4140 inserted
= XFASTINT (insval
);
4145 /* For the rationale of this see the comment on
4146 format-decode above. */
4148 int opoint_byte
= PT_BYTE
;
4149 int oinserted
= ZV
- BEGV
;
4150 int ochars_modiff
= CHARS_MODIFF
;
4152 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4153 insval
= call1 (XCAR (p
), make_number (oinserted
));
4156 CHECK_NUMBER (insval
);
4157 if (ochars_modiff
== CHARS_MODIFF
)
4158 /* after_insert_file_functions didn't modify
4159 buffer's characters => move point back to
4160 position before inserted text and leave value of
4162 SET_PT_BOTH (opoint
, opoint_byte
);
4164 /* after_insert_file_functions did modify buffer's
4165 characters => consider entire buffer changed and
4166 leave point at point-min. */
4167 inserted
= XFASTINT (insval
);
4177 current_buffer
->undo_list
= old_undo
;
4178 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4180 /* Adjust the last undo record for the size change during
4181 the format conversion. */
4182 Lisp_Object tem
= XCAR (old_undo
);
4183 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4184 && INTEGERP (XCDR (tem
))
4185 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4186 XSETCDR (tem
, make_number (PT
+ inserted
));
4190 /* If undo_list was Qt before, keep it that way.
4191 Otherwise start with an empty undo_list. */
4192 current_buffer
->undo_list
= EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4194 unbind_to (count
, Qnil
);
4197 /* Call after-change hooks for the inserted text, aside from the case
4198 of normal visiting (not with REPLACE), which is done in a new buffer
4199 "before" the buffer is changed. */
4200 if (inserted
> 0 && total
> 0
4201 && (NILP (visit
) || !NILP (replace
)))
4203 signal_after_change (PT
, 0, inserted
);
4204 update_compositions (PT
, PT
, CHECK_BORDER
);
4208 && current_buffer
->modtime
== -1)
4210 /* If visiting nonexistent file, return nil. */
4211 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4215 Fsignal (Qquit
, Qnil
);
4217 /* ??? Retval needs to be dealt with in all cases consistently. */
4219 val
= Fcons (orig_filename
,
4220 Fcons (make_number (inserted
),
4223 RETURN_UNGCPRO (unbind_to (count
, val
));
4226 static Lisp_Object build_annotations
P_ ((Lisp_Object
, Lisp_Object
));
4228 /* If build_annotations switched buffers, switch back to BUF.
4229 Kill the temporary buffer that was selected in the meantime.
4231 Since this kill only the last temporary buffer, some buffers remain
4232 not killed if build_annotations switched buffers more than once.
4236 build_annotations_unwind (buf
)
4241 if (XBUFFER (buf
) == current_buffer
)
4243 tembuf
= Fcurrent_buffer ();
4245 Fkill_buffer (tembuf
);
4249 /* Decide the coding-system to encode the data with. */
4252 choose_write_coding_system (start
, end
, filename
,
4253 append
, visit
, lockname
, coding
)
4254 Lisp_Object start
, end
, filename
, append
, visit
, lockname
;
4255 struct coding_system
*coding
;
4258 Lisp_Object eol_parent
= Qnil
;
4261 && NILP (Fstring_equal (current_buffer
->filename
,
4262 current_buffer
->auto_save_file_name
)))
4267 else if (!NILP (Vcoding_system_for_write
))
4269 val
= Vcoding_system_for_write
;
4270 if (coding_system_require_warning
4271 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4272 /* Confirm that VAL can surely encode the current region. */
4273 val
= call5 (Vselect_safe_coding_system_function
,
4274 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4279 /* If the variable `buffer-file-coding-system' is set locally,
4280 it means that the file was read with some kind of code
4281 conversion or the variable is explicitly set by users. We
4282 had better write it out with the same coding system even if
4283 `enable-multibyte-characters' is nil.
4285 If it is not set locally, we anyway have to convert EOL
4286 format if the default value of `buffer-file-coding-system'
4287 tells that it is not Unix-like (LF only) format. */
4288 int using_default_coding
= 0;
4289 int force_raw_text
= 0;
4291 val
= current_buffer
->buffer_file_coding_system
;
4293 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4296 if (NILP (current_buffer
->enable_multibyte_characters
))
4302 /* Check file-coding-system-alist. */
4303 Lisp_Object args
[7], coding_systems
;
4305 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4306 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4308 coding_systems
= Ffind_operation_coding_system (7, args
);
4309 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4310 val
= XCDR (coding_systems
);
4315 /* If we still have not decided a coding system, use the
4316 default value of buffer-file-coding-system. */
4317 val
= current_buffer
->buffer_file_coding_system
;
4318 using_default_coding
= 1;
4321 if (! NILP (val
) && ! force_raw_text
)
4323 Lisp_Object spec
, attrs
;
4325 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4326 attrs
= AREF (spec
, 0);
4327 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4332 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4333 /* Confirm that VAL can surely encode the current region. */
4334 val
= call5 (Vselect_safe_coding_system_function
,
4335 start
, end
, val
, Qnil
, filename
);
4337 /* If the decided coding-system doesn't specify end-of-line
4338 format, we use that of
4339 `default-buffer-file-coding-system'. */
4340 if (! using_default_coding
4341 && ! NILP (buffer_defaults
.buffer_file_coding_system
))
4342 val
= (coding_inherit_eol_type
4343 (val
, buffer_defaults
.buffer_file_coding_system
));
4345 /* If we decide not to encode text, use `raw-text' or one of its
4348 val
= raw_text_coding_system (val
);
4351 val
= coding_inherit_eol_type (val
, eol_parent
);
4352 setup_coding_system (val
, coding
);
4354 if (!STRINGP (start
) && !NILP (current_buffer
->selective_display
))
4355 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4359 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4360 "r\nFWrite region to file: \ni\ni\ni\np",
4361 doc
: /* Write current region into specified file.
4362 When called from a program, requires three arguments:
4363 START, END and FILENAME. START and END are normally buffer positions
4364 specifying the part of the buffer to write.
4365 If START is nil, that means to use the entire buffer contents.
4366 If START is a string, then output that string to the file
4367 instead of any buffer contents; END is ignored.
4369 Optional fourth argument APPEND if non-nil means
4370 append to existing file contents (if any). If it is an integer,
4371 seek to that offset in the file before writing.
4372 Optional fifth argument VISIT, if t or a string, means
4373 set the last-save-file-modtime of buffer to this file's modtime
4374 and mark buffer not modified.
4375 If VISIT is a string, it is a second file name;
4376 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4377 VISIT is also the file name to lock and unlock for clash detection.
4378 If VISIT is neither t nor nil nor a string,
4379 that means do not display the \"Wrote file\" message.
4380 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4381 use for locking and unlocking, overriding FILENAME and VISIT.
4382 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4383 for an existing file with the same name. If MUSTBENEW is `excl',
4384 that means to get an error if the file already exists; never overwrite.
4385 If MUSTBENEW is neither nil nor `excl', that means ask for
4386 confirmation before overwriting, but do go ahead and overwrite the file
4387 if the user confirms.
4389 This does code conversion according to the value of
4390 `coding-system-for-write', `buffer-file-coding-system', or
4391 `file-coding-system-alist', and sets the variable
4392 `last-coding-system-used' to the coding system actually used. */)
4393 (start
, end
, filename
, append
, visit
, lockname
, mustbenew
)
4394 Lisp_Object start
, end
, filename
, append
, visit
, lockname
, mustbenew
;
4399 const unsigned char *fn
;
4401 int count
= SPECPDL_INDEX ();
4403 Lisp_Object handler
;
4404 Lisp_Object visit_file
;
4405 Lisp_Object annotations
;
4406 Lisp_Object encoded_filename
;
4407 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4408 int quietly
= !NILP (visit
);
4409 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4410 struct buffer
*given_buffer
;
4412 int buffer_file_type
= O_BINARY
;
4414 struct coding_system coding
;
4416 if (current_buffer
->base_buffer
&& visiting
)
4417 error ("Cannot do file visiting in an indirect buffer");
4419 if (!NILP (start
) && !STRINGP (start
))
4420 validate_region (&start
, &end
);
4423 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4425 filename
= Fexpand_file_name (filename
, Qnil
);
4427 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4428 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4430 if (STRINGP (visit
))
4431 visit_file
= Fexpand_file_name (visit
, Qnil
);
4433 visit_file
= filename
;
4435 if (NILP (lockname
))
4436 lockname
= visit_file
;
4440 /* If the file name has special constructs in it,
4441 call the corresponding file handler. */
4442 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4443 /* If FILENAME has no handler, see if VISIT has one. */
4444 if (NILP (handler
) && STRINGP (visit
))
4445 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4447 if (!NILP (handler
))
4450 val
= call6 (handler
, Qwrite_region
, start
, end
,
4451 filename
, append
, visit
);
4455 SAVE_MODIFF
= MODIFF
;
4456 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4457 current_buffer
->filename
= visit_file
;
4463 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4465 /* Special kludge to simplify auto-saving. */
4468 /* Do it later, so write-region-annotate-function can work differently
4469 if we save "the buffer" vs "a region".
4470 This is useful in tar-mode. --Stef
4471 XSETFASTINT (start, BEG);
4472 XSETFASTINT (end, Z); */
4476 record_unwind_protect (build_annotations_unwind
, Fcurrent_buffer ());
4477 count1
= SPECPDL_INDEX ();
4479 given_buffer
= current_buffer
;
4481 if (!STRINGP (start
))
4483 annotations
= build_annotations (start
, end
);
4485 if (current_buffer
!= given_buffer
)
4487 XSETFASTINT (start
, BEGV
);
4488 XSETFASTINT (end
, ZV
);
4494 XSETFASTINT (start
, BEGV
);
4495 XSETFASTINT (end
, ZV
);
4500 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4502 /* Decide the coding-system to encode the data with.
4503 We used to make this choice before calling build_annotations, but that
4504 leads to problems when a write-annotate-function takes care of
4505 unsavable chars (as was the case with X-Symbol). */
4506 Vlast_coding_system_used
4507 = choose_write_coding_system (start
, end
, filename
,
4508 append
, visit
, lockname
, &coding
);
4510 #ifdef CLASH_DETECTION
4513 #if 0 /* This causes trouble for GNUS. */
4514 /* If we've locked this file for some other buffer,
4515 query before proceeding. */
4516 if (!visiting
&& EQ (Ffile_locked_p (lockname
), Qt
))
4517 call2 (intern ("ask-user-about-lock"), filename
, Vuser_login_name
);
4520 lock_file (lockname
);
4522 #endif /* CLASH_DETECTION */
4524 encoded_filename
= ENCODE_FILE (filename
);
4526 fn
= SDATA (encoded_filename
);
4530 desc
= emacs_open (fn
, O_WRONLY
| buffer_file_type
, 0);
4531 #else /* not DOS_NT */
4532 desc
= emacs_open (fn
, O_WRONLY
, 0);
4533 #endif /* not DOS_NT */
4535 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4537 desc
= emacs_open (fn
,
4538 O_WRONLY
| O_CREAT
| buffer_file_type
4539 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4540 S_IREAD
| S_IWRITE
);
4541 #else /* not DOS_NT */
4542 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4543 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4544 auto_saving
? auto_save_mode_bits
: 0666);
4545 #endif /* not DOS_NT */
4549 #ifdef CLASH_DETECTION
4551 if (!auto_saving
) unlock_file (lockname
);
4553 #endif /* CLASH_DETECTION */
4555 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4558 record_unwind_protect (close_file_unwind
, make_number (desc
));
4560 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4564 if (NUMBERP (append
))
4565 ret
= lseek (desc
, XINT (append
), 1);
4567 ret
= lseek (desc
, 0, 2);
4570 #ifdef CLASH_DETECTION
4571 if (!auto_saving
) unlock_file (lockname
);
4572 #endif /* CLASH_DETECTION */
4574 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4581 /* The new encoding routine doesn't require the following. */
4583 /* Whether VMS or not, we must move the gap to the next of newline
4584 when we must put designation sequences at beginning of line. */
4585 if (INTEGERP (start
)
4586 && coding
.type
== coding_type_iso2022
4587 && coding
.flags
& CODING_FLAG_ISO_DESIGNATE_AT_BOL
4588 && GPT
> BEG
&& GPT_ADDR
[-1] != '\n')
4590 int opoint
= PT
, opoint_byte
= PT_BYTE
;
4591 scan_newline (PT
, PT_BYTE
, ZV
, ZV_BYTE
, 1, 0);
4592 move_gap_both (PT
, PT_BYTE
);
4593 SET_PT_BOTH (opoint
, opoint_byte
);
4600 if (STRINGP (start
))
4602 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4603 &annotations
, &coding
);
4606 else if (XINT (start
) != XINT (end
))
4608 failure
= 0 > a_write (desc
, Qnil
,
4609 XINT (start
), XINT (end
) - XINT (start
),
4610 &annotations
, &coding
);
4615 /* If file was empty, still need to write the annotations */
4616 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4617 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4621 if (CODING_REQUIRE_FLUSHING (&coding
)
4622 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4625 /* We have to flush out a data. */
4626 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4627 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4634 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4635 Disk full in NFS may be reported here. */
4636 /* mib says that closing the file will try to write as fast as NFS can do
4637 it, and that means the fsync here is not crucial for autosave files. */
4638 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4640 /* If fsync fails with EINTR, don't treat that as serious. Also
4641 ignore EINVAL which happens when fsync is not supported on this
4643 if (errno
!= EINTR
&& errno
!= EINVAL
)
4644 failure
= 1, save_errno
= errno
;
4648 /* Spurious "file has changed on disk" warnings have been
4649 observed on Suns as well.
4650 It seems that `close' can change the modtime, under nfs.
4652 (This has supposedly been fixed in Sunos 4,
4653 but who knows about all the other machines with NFS?) */
4660 /* NFS can report a write failure now. */
4661 if (emacs_close (desc
) < 0)
4662 failure
= 1, save_errno
= errno
;
4667 /* Discard the unwind protect for close_file_unwind. */
4668 specpdl_ptr
= specpdl
+ count1
;
4669 /* Restore the original current buffer. */
4670 visit_file
= unbind_to (count
, visit_file
);
4672 #ifdef CLASH_DETECTION
4674 unlock_file (lockname
);
4675 #endif /* CLASH_DETECTION */
4677 /* Do this before reporting IO error
4678 to avoid a "file has changed on disk" warning on
4679 next attempt to save. */
4681 current_buffer
->modtime
= st
.st_mtime
;
4684 error ("IO error writing %s: %s", SDATA (filename
),
4685 emacs_strerror (save_errno
));
4689 SAVE_MODIFF
= MODIFF
;
4690 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4691 current_buffer
->filename
= visit_file
;
4692 update_mode_lines
++;
4697 && ! NILP (Fstring_equal (current_buffer
->filename
,
4698 current_buffer
->auto_save_file_name
)))
4699 SAVE_MODIFF
= MODIFF
;
4705 message_with_string ((INTEGERP (append
)
4715 Lisp_Object
merge ();
4717 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4718 doc
: /* Return t if (car A) is numerically less than (car B). */)
4722 return Flss (Fcar (a
), Fcar (b
));
4725 /* Build the complete list of annotations appropriate for writing out
4726 the text between START and END, by calling all the functions in
4727 write-region-annotate-functions and merging the lists they return.
4728 If one of these functions switches to a different buffer, we assume
4729 that buffer contains altered text. Therefore, the caller must
4730 make sure to restore the current buffer in all cases,
4731 as save-excursion would do. */
4734 build_annotations (start
, end
)
4735 Lisp_Object start
, end
;
4737 Lisp_Object annotations
;
4739 struct gcpro gcpro1
, gcpro2
;
4740 Lisp_Object original_buffer
;
4741 int i
, used_global
= 0;
4743 XSETBUFFER (original_buffer
, current_buffer
);
4746 p
= Vwrite_region_annotate_functions
;
4747 GCPRO2 (annotations
, p
);
4750 struct buffer
*given_buffer
= current_buffer
;
4751 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4752 { /* Use the global value of the hook. */
4755 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4757 p
= Fappend (2, arg
);
4760 Vwrite_region_annotations_so_far
= annotations
;
4761 res
= call2 (XCAR (p
), start
, end
);
4762 /* If the function makes a different buffer current,
4763 assume that means this buffer contains altered text to be output.
4764 Reset START and END from the buffer bounds
4765 and discard all previous annotations because they should have
4766 been dealt with by this function. */
4767 if (current_buffer
!= given_buffer
)
4769 XSETFASTINT (start
, BEGV
);
4770 XSETFASTINT (end
, ZV
);
4773 Flength (res
); /* Check basic validity of return value */
4774 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4778 /* Now do the same for annotation functions implied by the file-format */
4779 if (auto_saving
&& (!EQ (current_buffer
->auto_save_file_format
, Qt
)))
4780 p
= current_buffer
->auto_save_file_format
;
4782 p
= current_buffer
->file_format
;
4783 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4785 struct buffer
*given_buffer
= current_buffer
;
4787 Vwrite_region_annotations_so_far
= annotations
;
4789 /* Value is either a list of annotations or nil if the function
4790 has written annotations to a temporary buffer, which is now
4792 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4793 original_buffer
, make_number (i
));
4794 if (current_buffer
!= given_buffer
)
4796 XSETFASTINT (start
, BEGV
);
4797 XSETFASTINT (end
, ZV
);
4802 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4810 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4811 If STRING is nil, POS is the character position in the current buffer.
4812 Intersperse with them the annotations from *ANNOT
4813 which fall within the range of POS to POS + NCHARS,
4814 each at its appropriate position.
4816 We modify *ANNOT by discarding elements as we use them up.
4818 The return value is negative in case of system call failure. */
4821 a_write (desc
, string
, pos
, nchars
, annot
, coding
)
4824 register int nchars
;
4827 struct coding_system
*coding
;
4831 int lastpos
= pos
+ nchars
;
4833 while (NILP (*annot
) || CONSP (*annot
))
4835 tem
= Fcar_safe (Fcar (*annot
));
4838 nextpos
= XFASTINT (tem
);
4840 /* If there are no more annotations in this range,
4841 output the rest of the range all at once. */
4842 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4843 return e_write (desc
, string
, pos
, lastpos
, coding
);
4845 /* Output buffer text up to the next annotation's position. */
4848 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4852 /* Output the annotation. */
4853 tem
= Fcdr (Fcar (*annot
));
4856 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4859 *annot
= Fcdr (*annot
);
4865 /* Write text in the range START and END into descriptor DESC,
4866 encoding them with coding system CODING. If STRING is nil, START
4867 and END are character positions of the current buffer, else they
4868 are indexes to the string STRING. */
4871 e_write (desc
, string
, start
, end
, coding
)
4875 struct coding_system
*coding
;
4877 if (STRINGP (string
))
4880 end
= SCHARS (string
);
4883 /* We used to have a code for handling selective display here. But,
4884 now it is handled within encode_coding. */
4888 if (STRINGP (string
))
4890 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
4891 if (CODING_REQUIRE_ENCODING (coding
))
4893 encode_coding_object (coding
, string
,
4894 start
, string_char_to_byte (string
, start
),
4895 end
, string_char_to_byte (string
, end
), Qt
);
4899 coding
->dst_object
= string
;
4900 coding
->consumed_char
= SCHARS (string
);
4901 coding
->produced
= SBYTES (string
);
4906 int start_byte
= CHAR_TO_BYTE (start
);
4907 int end_byte
= CHAR_TO_BYTE (end
);
4909 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
4910 if (CODING_REQUIRE_ENCODING (coding
))
4912 encode_coding_object (coding
, Fcurrent_buffer (),
4913 start
, start_byte
, end
, end_byte
, Qt
);
4917 coding
->dst_object
= Qnil
;
4918 coding
->dst_pos_byte
= start_byte
;
4919 if (start
>= GPT
|| end
<= GPT
)
4921 coding
->consumed_char
= end
- start
;
4922 coding
->produced
= end_byte
- start_byte
;
4926 coding
->consumed_char
= GPT
- start
;
4927 coding
->produced
= GPT_BYTE
- start_byte
;
4932 if (coding
->produced
> 0)
4936 STRINGP (coding
->dst_object
)
4937 ? SDATA (coding
->dst_object
)
4938 : BYTE_POS_ADDR (coding
->dst_pos_byte
),
4941 if (coding
->produced
)
4944 start
+= coding
->consumed_char
;
4950 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
4951 Sverify_visited_file_modtime
, 1, 1, 0,
4952 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
4953 This means that the file has not been changed since it was visited or saved.
4954 See Info node `(elisp)Modification Time' for more details. */)
4960 Lisp_Object handler
;
4961 Lisp_Object filename
;
4966 if (!STRINGP (b
->filename
)) return Qt
;
4967 if (b
->modtime
== 0) return Qt
;
4969 /* If the file name has special constructs in it,
4970 call the corresponding file handler. */
4971 handler
= Ffind_file_name_handler (b
->filename
,
4972 Qverify_visited_file_modtime
);
4973 if (!NILP (handler
))
4974 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
4976 filename
= ENCODE_FILE (b
->filename
);
4978 if (stat (SDATA (filename
), &st
) < 0)
4980 /* If the file doesn't exist now and didn't exist before,
4981 we say that it isn't modified, provided the error is a tame one. */
4982 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
4987 if (st
.st_mtime
== b
->modtime
4988 /* If both are positive, accept them if they are off by one second. */
4989 || (st
.st_mtime
> 0 && b
->modtime
> 0
4990 && (st
.st_mtime
== b
->modtime
+ 1
4991 || st
.st_mtime
== b
->modtime
- 1)))
4996 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
4997 Sclear_visited_file_modtime
, 0, 0, 0,
4998 doc
: /* Clear out records of last mod time of visited file.
4999 Next attempt to save will certainly not complain of a discrepancy. */)
5002 current_buffer
->modtime
= 0;
5006 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5007 Svisited_file_modtime
, 0, 0, 0,
5008 doc
: /* Return the current buffer's recorded visited file modification time.
5009 The value is a list of the form (HIGH LOW), like the time values
5010 that `file-attributes' returns. If the current buffer has no recorded
5011 file modification time, this function returns 0.
5012 See Info node `(elisp)Modification Time' for more details. */)
5015 if (! current_buffer
->modtime
)
5016 return make_number (0);
5017 return make_time ((time_t) current_buffer
->modtime
);
5020 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5021 Sset_visited_file_modtime
, 0, 1, 0,
5022 doc
: /* Update buffer's recorded modification time from the visited file's time.
5023 Useful if the buffer was not read from the file normally
5024 or if the file itself has been changed for some known benign reason.
5025 An argument specifies the modification time value to use
5026 \(instead of that of the visited file), in the form of a list
5027 \(HIGH . LOW) or (HIGH LOW). */)
5029 Lisp_Object time_list
;
5031 if (!NILP (time_list
))
5032 current_buffer
->modtime
= cons_to_long (time_list
);
5035 register Lisp_Object filename
;
5037 Lisp_Object handler
;
5039 filename
= Fexpand_file_name (current_buffer
->filename
, Qnil
);
5041 /* If the file name has special constructs in it,
5042 call the corresponding file handler. */
5043 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5044 if (!NILP (handler
))
5045 /* The handler can find the file name the same way we did. */
5046 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5048 filename
= ENCODE_FILE (filename
);
5050 if (stat (SDATA (filename
), &st
) >= 0)
5051 current_buffer
->modtime
= st
.st_mtime
;
5058 auto_save_error (error
)
5061 Lisp_Object args
[3], msg
;
5063 struct gcpro gcpro1
;
5067 auto_save_error_occurred
= 1;
5069 ring_bell (XFRAME (selected_frame
));
5071 args
[0] = build_string ("Auto-saving %s: %s");
5072 args
[1] = current_buffer
->name
;
5073 args
[2] = Ferror_message_string (error
);
5074 msg
= Fformat (3, args
);
5076 nbytes
= SBYTES (msg
);
5077 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5078 bcopy (SDATA (msg
), msgbuf
, nbytes
);
5080 for (i
= 0; i
< 3; ++i
)
5083 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5085 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5086 Fsleep_for (make_number (1), Qnil
);
5100 auto_save_mode_bits
= 0666;
5102 /* Get visited file's mode to become the auto save file's mode. */
5103 if (! NILP (current_buffer
->filename
))
5105 if (stat (SDATA (current_buffer
->filename
), &st
) >= 0)
5106 /* But make sure we can overwrite it later! */
5107 auto_save_mode_bits
= st
.st_mode
| 0600;
5108 else if ((modes
= Ffile_modes (current_buffer
->filename
),
5110 /* Remote files don't cooperate with stat. */
5111 auto_save_mode_bits
= XINT (modes
) | 0600;
5115 Fwrite_region (Qnil
, Qnil
, current_buffer
->auto_save_file_name
, Qnil
,
5116 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5121 do_auto_save_unwind (arg
) /* used as unwind-protect function */
5124 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5136 do_auto_save_unwind_1 (value
) /* used as unwind-protect function */
5139 minibuffer_auto_raise
= XINT (value
);
5144 do_auto_save_make_dir (dir
)
5149 call2 (Qmake_directory
, dir
, Qt
);
5150 XSETFASTINT (mode
, 0700);
5151 return Fset_file_modes (dir
, mode
);
5155 do_auto_save_eh (ignore
)
5161 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5162 doc
: /* Auto-save all buffers that need it.
5163 This is all buffers that have auto-saving enabled
5164 and are changed since last auto-saved.
5165 Auto-saving writes the buffer into a file
5166 so that your editing is not lost if the system crashes.
5167 This file is not the file you visited; that changes only when you save.
5168 Normally we run the normal hook `auto-save-hook' before saving.
5170 A non-nil NO-MESSAGE argument means do not print any message if successful.
5171 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5172 (no_message
, current_only
)
5173 Lisp_Object no_message
, current_only
;
5175 struct buffer
*old
= current_buffer
, *b
;
5176 Lisp_Object tail
, buf
;
5178 int do_handled_files
;
5180 FILE *stream
= NULL
;
5181 int count
= SPECPDL_INDEX ();
5182 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5183 int old_message_p
= 0;
5184 struct gcpro gcpro1
, gcpro2
;
5186 if (max_specpdl_size
< specpdl_size
+ 40)
5187 max_specpdl_size
= specpdl_size
+ 40;
5192 if (NILP (no_message
))
5194 old_message_p
= push_message ();
5195 record_unwind_protect (pop_message_unwind
, Qnil
);
5198 /* Ordinarily don't quit within this function,
5199 but don't make it impossible to quit (in case we get hung in I/O). */
5203 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5204 point to non-strings reached from Vbuffer_alist. */
5206 if (!NILP (Vrun_hooks
))
5207 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5209 if (STRINGP (Vauto_save_list_file_name
))
5211 Lisp_Object listfile
;
5213 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5215 /* Don't try to create the directory when shutting down Emacs,
5216 because creating the directory might signal an error, and
5217 that would leave Emacs in a strange state. */
5218 if (!NILP (Vrun_hooks
))
5222 GCPRO2 (dir
, listfile
);
5223 dir
= Ffile_name_directory (listfile
);
5224 if (NILP (Ffile_directory_p (dir
)))
5225 internal_condition_case_1 (do_auto_save_make_dir
,
5226 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5231 stream
= fopen (SDATA (listfile
), "w");
5234 record_unwind_protect (do_auto_save_unwind
,
5235 make_save_value (stream
, 0));
5236 record_unwind_protect (do_auto_save_unwind_1
,
5237 make_number (minibuffer_auto_raise
));
5238 minibuffer_auto_raise
= 0;
5240 auto_save_error_occurred
= 0;
5242 /* On first pass, save all files that don't have handlers.
5243 On second pass, save all files that do have handlers.
5245 If Emacs is crashing, the handlers may tweak what is causing
5246 Emacs to crash in the first place, and it would be a shame if
5247 Emacs failed to autosave perfectly ordinary files because it
5248 couldn't handle some ange-ftp'd file. */
5250 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5251 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5253 buf
= XCDR (XCAR (tail
));
5256 /* Record all the buffers that have auto save mode
5257 in the special file that lists them. For each of these buffers,
5258 Record visited name (if any) and auto save name. */
5259 if (STRINGP (b
->auto_save_file_name
)
5260 && stream
!= NULL
&& do_handled_files
== 0)
5263 if (!NILP (b
->filename
))
5265 fwrite (SDATA (b
->filename
), 1,
5266 SBYTES (b
->filename
), stream
);
5268 putc ('\n', stream
);
5269 fwrite (SDATA (b
->auto_save_file_name
), 1,
5270 SBYTES (b
->auto_save_file_name
), stream
);
5271 putc ('\n', stream
);
5275 if (!NILP (current_only
)
5276 && b
!= current_buffer
)
5279 /* Don't auto-save indirect buffers.
5280 The base buffer takes care of it. */
5284 /* Check for auto save enabled
5285 and file changed since last auto save
5286 and file changed since last real save. */
5287 if (STRINGP (b
->auto_save_file_name
)
5288 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5289 && b
->auto_save_modified
< BUF_MODIFF (b
)
5290 /* -1 means we've turned off autosaving for a while--see below. */
5291 && XINT (b
->save_length
) >= 0
5292 && (do_handled_files
5293 || NILP (Ffind_file_name_handler (b
->auto_save_file_name
,
5296 EMACS_TIME before_time
, after_time
;
5298 EMACS_GET_TIME (before_time
);
5300 /* If we had a failure, don't try again for 20 minutes. */
5301 if (b
->auto_save_failure_time
>= 0
5302 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5305 if ((XFASTINT (b
->save_length
) * 10
5306 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5307 /* A short file is likely to change a large fraction;
5308 spare the user annoying messages. */
5309 && XFASTINT (b
->save_length
) > 5000
5310 /* These messages are frequent and annoying for `*mail*'. */
5311 && !EQ (b
->filename
, Qnil
)
5312 && NILP (no_message
))
5314 /* It has shrunk too much; turn off auto-saving here. */
5315 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5316 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5318 minibuffer_auto_raise
= 0;
5319 /* Turn off auto-saving until there's a real save,
5320 and prevent any more warnings. */
5321 XSETINT (b
->save_length
, -1);
5322 Fsleep_for (make_number (1), Qnil
);
5325 set_buffer_internal (b
);
5326 if (!auto_saved
&& NILP (no_message
))
5327 message1 ("Auto-saving...");
5328 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5330 b
->auto_save_modified
= BUF_MODIFF (b
);
5331 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5332 set_buffer_internal (old
);
5334 EMACS_GET_TIME (after_time
);
5336 /* If auto-save took more than 60 seconds,
5337 assume it was an NFS failure that got a timeout. */
5338 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5339 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5343 /* Prevent another auto save till enough input events come in. */
5344 record_auto_save ();
5346 if (auto_saved
&& NILP (no_message
))
5350 /* If we are going to restore an old message,
5351 give time to read ours. */
5352 sit_for (make_number (1), 0, 0);
5355 else if (!auto_save_error_occurred
)
5356 /* Don't overwrite the error message if an error occurred.
5357 If we displayed a message and then restored a state
5358 with no message, leave a "done" message on the screen. */
5359 message1 ("Auto-saving...done");
5364 /* This restores the message-stack status. */
5365 unbind_to (count
, Qnil
);
5369 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5370 Sset_buffer_auto_saved
, 0, 0, 0,
5371 doc
: /* Mark current buffer as auto-saved with its current text.
5372 No auto-save file will be written until the buffer changes again. */)
5375 current_buffer
->auto_save_modified
= MODIFF
;
5376 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5377 current_buffer
->auto_save_failure_time
= -1;
5381 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5382 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5383 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5386 current_buffer
->auto_save_failure_time
= -1;
5390 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5392 doc
: /* Return t if current buffer has been auto-saved recently.
5393 More precisely, if it has been auto-saved since last read from or saved
5394 in the visited file. If the buffer has no visited file,
5395 then any auto-save counts as "recent". */)
5398 return (SAVE_MODIFF
< current_buffer
->auto_save_modified
) ? Qt
: Qnil
;
5401 /* Reading and completing file names */
5403 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5404 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5405 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5406 The return value is only relevant for a call to `read-file-name' that happens
5407 before any other event (mouse or keypress) is handeled. */)
5410 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5411 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5421 Fread_file_name (prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
)
5422 Lisp_Object prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
;
5424 struct gcpro gcpro1
, gcpro2
;
5425 Lisp_Object args
[7];
5427 GCPRO1 (default_filename
);
5428 args
[0] = intern ("read-file-name");
5431 args
[3] = default_filename
;
5432 args
[4] = mustmatch
;
5434 args
[6] = predicate
;
5435 RETURN_UNGCPRO (Ffuncall (7, args
));
5442 /* Must be set before any path manipulation is performed. */
5443 XSETFASTINT (Vdirectory_sep_char
, '/');
5450 Qoperations
= intern ("operations");
5451 Qexpand_file_name
= intern ("expand-file-name");
5452 Qsubstitute_in_file_name
= intern ("substitute-in-file-name");
5453 Qdirectory_file_name
= intern ("directory-file-name");
5454 Qfile_name_directory
= intern ("file-name-directory");
5455 Qfile_name_nondirectory
= intern ("file-name-nondirectory");
5456 Qunhandled_file_name_directory
= intern ("unhandled-file-name-directory");
5457 Qfile_name_as_directory
= intern ("file-name-as-directory");
5458 Qcopy_file
= intern ("copy-file");
5459 Qmake_directory_internal
= intern ("make-directory-internal");
5460 Qmake_directory
= intern ("make-directory");
5461 Qdelete_directory
= intern ("delete-directory");
5462 Qdelete_file
= intern ("delete-file");
5463 Qrename_file
= intern ("rename-file");
5464 Qadd_name_to_file
= intern ("add-name-to-file");
5465 Qmake_symbolic_link
= intern ("make-symbolic-link");
5466 Qfile_exists_p
= intern ("file-exists-p");
5467 Qfile_executable_p
= intern ("file-executable-p");
5468 Qfile_readable_p
= intern ("file-readable-p");
5469 Qfile_writable_p
= intern ("file-writable-p");
5470 Qfile_symlink_p
= intern ("file-symlink-p");
5471 Qaccess_file
= intern ("access-file");
5472 Qfile_directory_p
= intern ("file-directory-p");
5473 Qfile_regular_p
= intern ("file-regular-p");
5474 Qfile_accessible_directory_p
= intern ("file-accessible-directory-p");
5475 Qfile_modes
= intern ("file-modes");
5476 Qset_file_modes
= intern ("set-file-modes");
5477 Qset_file_times
= intern ("set-file-times");
5478 Qfile_newer_than_file_p
= intern ("file-newer-than-file-p");
5479 Qinsert_file_contents
= intern ("insert-file-contents");
5480 Qwrite_region
= intern ("write-region");
5481 Qverify_visited_file_modtime
= intern ("verify-visited-file-modtime");
5482 Qset_visited_file_modtime
= intern ("set-visited-file-modtime");
5483 Qauto_save_coding
= intern ("auto-save-coding");
5485 staticpro (&Qoperations
);
5486 staticpro (&Qexpand_file_name
);
5487 staticpro (&Qsubstitute_in_file_name
);
5488 staticpro (&Qdirectory_file_name
);
5489 staticpro (&Qfile_name_directory
);
5490 staticpro (&Qfile_name_nondirectory
);
5491 staticpro (&Qunhandled_file_name_directory
);
5492 staticpro (&Qfile_name_as_directory
);
5493 staticpro (&Qcopy_file
);
5494 staticpro (&Qmake_directory_internal
);
5495 staticpro (&Qmake_directory
);
5496 staticpro (&Qdelete_directory
);
5497 staticpro (&Qdelete_file
);
5498 staticpro (&Qrename_file
);
5499 staticpro (&Qadd_name_to_file
);
5500 staticpro (&Qmake_symbolic_link
);
5501 staticpro (&Qfile_exists_p
);
5502 staticpro (&Qfile_executable_p
);
5503 staticpro (&Qfile_readable_p
);
5504 staticpro (&Qfile_writable_p
);
5505 staticpro (&Qaccess_file
);
5506 staticpro (&Qfile_symlink_p
);
5507 staticpro (&Qfile_directory_p
);
5508 staticpro (&Qfile_regular_p
);
5509 staticpro (&Qfile_accessible_directory_p
);
5510 staticpro (&Qfile_modes
);
5511 staticpro (&Qset_file_modes
);
5512 staticpro (&Qset_file_times
);
5513 staticpro (&Qfile_newer_than_file_p
);
5514 staticpro (&Qinsert_file_contents
);
5515 staticpro (&Qwrite_region
);
5516 staticpro (&Qverify_visited_file_modtime
);
5517 staticpro (&Qset_visited_file_modtime
);
5518 staticpro (&Qauto_save_coding
);
5520 Qfile_name_history
= intern ("file-name-history");
5521 Fset (Qfile_name_history
, Qnil
);
5522 staticpro (&Qfile_name_history
);
5524 Qfile_error
= intern ("file-error");
5525 staticpro (&Qfile_error
);
5526 Qfile_already_exists
= intern ("file-already-exists");
5527 staticpro (&Qfile_already_exists
);
5528 Qfile_date_error
= intern ("file-date-error");
5529 staticpro (&Qfile_date_error
);
5530 Qexcl
= intern ("excl");
5534 Qfind_buffer_file_type
= intern ("find-buffer-file-type");
5535 staticpro (&Qfind_buffer_file_type
);
5538 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system
,
5539 doc
: /* *Coding system for encoding file names.
5540 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5541 Vfile_name_coding_system
= Qnil
;
5543 DEFVAR_LISP ("default-file-name-coding-system",
5544 &Vdefault_file_name_coding_system
,
5545 doc
: /* Default coding system for encoding file names.
5546 This variable is used only when `file-name-coding-system' is nil.
5548 This variable is set/changed by the command `set-language-environment'.
5549 User should not set this variable manually,
5550 instead use `file-name-coding-system' to get a constant encoding
5551 of file names regardless of the current language environment. */);
5552 Vdefault_file_name_coding_system
= Qnil
;
5554 Qformat_decode
= intern ("format-decode");
5555 staticpro (&Qformat_decode
);
5556 Qformat_annotate_function
= intern ("format-annotate-function");
5557 staticpro (&Qformat_annotate_function
);
5558 Qafter_insert_file_set_coding
= intern ("after-insert-file-set-coding");
5559 staticpro (&Qafter_insert_file_set_coding
);
5561 Qcar_less_than_car
= intern ("car-less-than-car");
5562 staticpro (&Qcar_less_than_car
);
5564 Fput (Qfile_error
, Qerror_conditions
,
5565 list2 (Qfile_error
, Qerror
));
5566 Fput (Qfile_error
, Qerror_message
,
5567 build_string ("File error"));
5569 Fput (Qfile_already_exists
, Qerror_conditions
,
5570 list3 (Qfile_already_exists
, Qfile_error
, Qerror
));
5571 Fput (Qfile_already_exists
, Qerror_message
,
5572 build_string ("File already exists"));
5574 Fput (Qfile_date_error
, Qerror_conditions
,
5575 list3 (Qfile_date_error
, Qfile_error
, Qerror
));
5576 Fput (Qfile_date_error
, Qerror_message
,
5577 build_string ("Cannot set file date"));
5579 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char
,
5580 doc
: /* Directory separator character for built-in functions that return file names.
5581 The value is always ?/. Don't use this variable, just use `/'. */);
5583 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist
,
5584 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
5585 If a file name matches REGEXP, then all I/O on that file is done by calling
5588 The first argument given to HANDLER is the name of the I/O primitive
5589 to be handled; the remaining arguments are the arguments that were
5590 passed to that primitive. For example, if you do
5591 (file-exists-p FILENAME)
5592 and FILENAME is handled by HANDLER, then HANDLER is called like this:
5593 (funcall HANDLER 'file-exists-p FILENAME)
5594 The function `find-file-name-handler' checks this list for a handler
5595 for its argument. */);
5596 Vfile_name_handler_alist
= Qnil
;
5598 DEFVAR_LISP ("set-auto-coding-function",
5599 &Vset_auto_coding_function
,
5600 doc
: /* If non-nil, a function to call to decide a coding system of file.
5601 Two arguments are passed to this function: the file name
5602 and the length of a file contents following the point.
5603 This function should return a coding system to decode the file contents.
5604 It should check the file name against `auto-coding-alist'.
5605 If no coding system is decided, it should check a coding system
5606 specified in the heading lines with the format:
5607 -*- ... coding: CODING-SYSTEM; ... -*-
5608 or local variable spec of the tailing lines with `coding:' tag. */);
5609 Vset_auto_coding_function
= Qnil
;
5611 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions
,
5612 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5613 Each is passed one argument, the number of characters inserted,
5614 with point at the start of the inserted text. Each function
5615 should leave point the same, and return the new character count.
5616 If `insert-file-contents' is intercepted by a handler from
5617 `file-name-handler-alist', that handler is responsible for calling the
5618 functions in `after-insert-file-functions' if appropriate. */);
5619 Vafter_insert_file_functions
= Qnil
;
5621 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions
,
5622 doc
: /* A list of functions to be called at the start of `write-region'.
5623 Each is passed two arguments, START and END as for `write-region'.
5624 These are usually two numbers but not always; see the documentation
5625 for `write-region'. The function should return a list of pairs
5626 of the form (POSITION . STRING), consisting of strings to be effectively
5627 inserted at the specified positions of the file being written (1 means to
5628 insert before the first byte written). The POSITIONs must be sorted into
5629 increasing order. If there are several functions in the list, the several
5630 lists are merged destructively. Alternatively, the function can return
5631 with a different buffer current; in that case it should pay attention
5632 to the annotations returned by previous functions and listed in
5633 `write-region-annotations-so-far'.*/);
5634 Vwrite_region_annotate_functions
= Qnil
;
5635 staticpro (&Qwrite_region_annotate_functions
);
5636 Qwrite_region_annotate_functions
5637 = intern ("write-region-annotate-functions");
5639 DEFVAR_LISP ("write-region-annotations-so-far",
5640 &Vwrite_region_annotations_so_far
,
5641 doc
: /* When an annotation function is called, this holds the previous annotations.
5642 These are the annotations made by other annotation functions
5643 that were already called. See also `write-region-annotate-functions'. */);
5644 Vwrite_region_annotations_so_far
= Qnil
;
5646 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers
,
5647 doc
: /* A list of file name handlers that temporarily should not be used.
5648 This applies only to the operation `inhibit-file-name-operation'. */);
5649 Vinhibit_file_name_handlers
= Qnil
;
5651 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation
,
5652 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5653 Vinhibit_file_name_operation
= Qnil
;
5655 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name
,
5656 doc
: /* File name in which we write a list of all auto save file names.
5657 This variable is initialized automatically from `auto-save-list-file-prefix'
5658 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5659 a non-nil value. */);
5660 Vauto_save_list_file_name
= Qnil
;
5662 DEFVAR_LISP ("auto-save-visited-file-name", &Vauto_save_visited_file_name
,
5663 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5664 Normally auto-save files are written under other names. */);
5665 Vauto_save_visited_file_name
= Qnil
;
5668 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync
,
5669 doc
: /* *Non-nil means don't call fsync in `write-region'.
5670 This variable affects calls to `write-region' as well as save commands.
5671 A non-nil value may result in data loss! */);
5672 write_region_inhibit_fsync
= 0;
5675 DEFVAR_BOOL ("delete-by-moving-to-trash", &delete_by_moving_to_trash
,
5676 doc
: /* Specifies whether to use the system's trash can.
5677 When non-nil, the function `move-file-to-trash' will be used by
5678 `delete-file' and `delete-directory'. */);
5679 delete_by_moving_to_trash
= 0;
5680 Qdelete_by_moving_to_trash
= intern ("delete-by-moving-to-trash");
5681 Qmove_file_to_trash
= intern ("move-file-to-trash");
5682 staticpro (&Qmove_file_to_trash
);
5684 defsubr (&Sfind_file_name_handler
);
5685 defsubr (&Sfile_name_directory
);
5686 defsubr (&Sfile_name_nondirectory
);
5687 defsubr (&Sunhandled_file_name_directory
);
5688 defsubr (&Sfile_name_as_directory
);
5689 defsubr (&Sdirectory_file_name
);
5690 defsubr (&Smake_temp_name
);
5691 defsubr (&Sexpand_file_name
);
5692 defsubr (&Ssubstitute_in_file_name
);
5693 defsubr (&Scopy_file
);
5694 defsubr (&Smake_directory_internal
);
5695 defsubr (&Sdelete_directory
);
5696 defsubr (&Sdelete_file
);
5697 defsubr (&Srename_file
);
5698 defsubr (&Sadd_name_to_file
);
5699 defsubr (&Smake_symbolic_link
);
5700 defsubr (&Sfile_name_absolute_p
);
5701 defsubr (&Sfile_exists_p
);
5702 defsubr (&Sfile_executable_p
);
5703 defsubr (&Sfile_readable_p
);
5704 defsubr (&Sfile_writable_p
);
5705 defsubr (&Saccess_file
);
5706 defsubr (&Sfile_symlink_p
);
5707 defsubr (&Sfile_directory_p
);
5708 defsubr (&Sfile_accessible_directory_p
);
5709 defsubr (&Sfile_regular_p
);
5710 defsubr (&Sfile_modes
);
5711 defsubr (&Sset_file_modes
);
5712 defsubr (&Sset_file_times
);
5713 defsubr (&Sset_default_file_modes
);
5714 defsubr (&Sdefault_file_modes
);
5715 defsubr (&Sfile_newer_than_file_p
);
5716 defsubr (&Sinsert_file_contents
);
5717 defsubr (&Swrite_region
);
5718 defsubr (&Scar_less_than_car
);
5719 defsubr (&Sverify_visited_file_modtime
);
5720 defsubr (&Sclear_visited_file_modtime
);
5721 defsubr (&Svisited_file_modtime
);
5722 defsubr (&Sset_visited_file_modtime
);
5723 defsubr (&Sdo_auto_save
);
5724 defsubr (&Sset_buffer_auto_saved
);
5725 defsubr (&Sclear_buffer_auto_save_failure
);
5726 defsubr (&Srecent_auto_save_p
);
5728 defsubr (&Snext_read_file_uses_dialog_p
);
5731 defsubr (&Sunix_sync
);
5735 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
5736 (do not change this comment) */