1 /* File IO for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 #include <sys/types.h>
36 #if !defined (S_ISLNK) && defined (S_IFLNK)
37 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
40 #if !defined (S_ISFIFO) && defined (S_IFIFO)
41 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
44 #if !defined (S_ISREG) && defined (S_IFREG)
45 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
62 #include "intervals.h"
64 #include "character.h"
67 #include "blockinput.h"
69 #include "dispextern.h"
76 #endif /* not WINDOWSNT */
80 #include <sys/param.h>
88 #define CORRECT_DIR_SEPS(s) \
89 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
90 else unixtodos_filename (s); \
92 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
93 redirector allows the six letters between 'Z' and 'a' as well. */
95 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
98 #define IS_DRIVE(x) isalpha (x)
100 /* Need to lower-case the drive letter, or else expanded
101 filenames will sometimes compare inequal, because
102 `expand-file-name' doesn't always down-case the drive letter. */
103 #define DRIVE_LETTER(x) (tolower (x))
112 #include "commands.h"
113 extern int use_dialog_box
;
114 extern int use_file_dialog
;
128 #ifndef FILE_SYSTEM_CASE
129 #define FILE_SYSTEM_CASE(filename) (filename)
132 /* Nonzero during writing of auto-save files */
135 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
136 a new file with the same mode as the original */
137 int auto_save_mode_bits
;
139 /* Set by auto_save_1 if an error occurred during the last auto-save. */
140 int auto_save_error_occurred
;
142 /* The symbol bound to coding-system-for-read when
143 insert-file-contents is called for recovering a file. This is not
144 an actual coding system name, but just an indicator to tell
145 insert-file-contents to use `emacs-mule' with a special flag for
146 auto saving and recovering a file. */
147 Lisp_Object Qauto_save_coding
;
149 /* Coding system for file names, or nil if none. */
150 Lisp_Object Vfile_name_coding_system
;
152 /* Coding system for file names used only when
153 Vfile_name_coding_system is nil. */
154 Lisp_Object Vdefault_file_name_coding_system
;
156 /* Alist of elements (REGEXP . HANDLER) for file names
157 whose I/O is done with a special handler. */
158 Lisp_Object Vfile_name_handler_alist
;
160 /* Property name of a file name handler,
161 which gives a list of operations it handles.. */
162 Lisp_Object Qoperations
;
164 /* Lisp functions for translating file formats */
165 Lisp_Object Qformat_decode
, Qformat_annotate_function
;
167 /* Function to be called to decide a coding system of a reading file. */
168 Lisp_Object Vset_auto_coding_function
;
170 /* Functions to be called to process text properties in inserted file. */
171 Lisp_Object Vafter_insert_file_functions
;
173 /* Lisp function for setting buffer-file-coding-system and the
174 multibyteness of the current buffer after inserting a file. */
175 Lisp_Object Qafter_insert_file_set_coding
;
177 /* Functions to be called to create text property annotations for file. */
178 Lisp_Object Vwrite_region_annotate_functions
;
179 Lisp_Object Qwrite_region_annotate_functions
;
180 Lisp_Object Vwrite_region_post_annotation_function
;
182 /* During build_annotations, each time an annotation function is called,
183 this holds the annotations made by the previous functions. */
184 Lisp_Object Vwrite_region_annotations_so_far
;
186 /* Each time an annotation function changes the buffer, the new buffer
188 Lisp_Object Vwrite_region_annotation_buffers
;
190 /* File name in which we write a list of all our auto save files. */
191 Lisp_Object Vauto_save_list_file_name
;
193 /* Whether or not files are auto-saved into themselves. */
194 Lisp_Object Vauto_save_visited_file_name
;
196 /* On NT, specifies the directory separator character, used (eg.) when
197 expanding file names. This can be bound to / or \. */
198 Lisp_Object Vdirectory_sep_char
;
201 /* Nonzero means skip the call to fsync in Fwrite-region. */
202 int write_region_inhibit_fsync
;
205 /* Non-zero means call move-file-to-trash in Fdelete_file or
206 Fdelete_directory. */
207 int delete_by_moving_to_trash
;
209 Lisp_Object Qdelete_by_moving_to_trash
;
211 /* Lisp function for moving files to trash. */
212 Lisp_Object Qmove_file_to_trash
;
214 extern Lisp_Object Vuser_login_name
;
217 extern Lisp_Object Vw32_get_true_file_attributes
;
220 extern int minibuf_level
;
222 extern int minibuffer_auto_raise
;
224 extern int history_delete_duplicates
;
226 /* These variables describe handlers that have "already" had a chance
227 to handle the current operation.
229 Vinhibit_file_name_handlers is a list of file name handlers.
230 Vinhibit_file_name_operation is the operation being handled.
231 If we try to handle that operation, we ignore those handlers. */
233 static Lisp_Object Vinhibit_file_name_handlers
;
234 static Lisp_Object Vinhibit_file_name_operation
;
236 Lisp_Object Qfile_error
, Qfile_already_exists
, Qfile_date_error
;
238 Lisp_Object Qfile_name_history
;
240 Lisp_Object Qcar_less_than_car
;
242 static int a_write
P_ ((int, Lisp_Object
, int, int,
243 Lisp_Object
*, struct coding_system
*));
244 static int e_write
P_ ((int, Lisp_Object
, int, int, struct coding_system
*));
248 report_file_error (string
, data
)
252 Lisp_Object errstring
;
256 synchronize_system_messages_locale ();
257 str
= strerror (errorno
);
258 errstring
= code_convert_string_norecord (make_unibyte_string (str
,
260 Vlocale_coding_system
, 0);
266 xsignal (Qfile_already_exists
, Fcons (errstring
, data
));
269 /* System error messages are capitalized. Downcase the initial
270 unless it is followed by a slash. (The slash case caters to
271 error messages that begin with "I/O" or, in German, "E/A".) */
272 if (STRING_MULTIBYTE (errstring
)
273 && ! EQ (Faref (errstring
, make_number (1)), make_number ('/')))
277 str
= (char *) SDATA (errstring
);
278 c
= STRING_CHAR (str
, 0);
279 Faset (errstring
, make_number (0), make_number (DOWNCASE (c
)));
282 xsignal (Qfile_error
,
283 Fcons (build_string (string
), Fcons (errstring
, data
)));
288 close_file_unwind (fd
)
291 emacs_close (XFASTINT (fd
));
295 /* Restore point, having saved it as a marker. */
298 restore_point_unwind (location
)
299 Lisp_Object location
;
301 Fgoto_char (location
);
302 Fset_marker (location
, Qnil
, Qnil
);
307 Lisp_Object Qexpand_file_name
;
308 Lisp_Object Qsubstitute_in_file_name
;
309 Lisp_Object Qdirectory_file_name
;
310 Lisp_Object Qfile_name_directory
;
311 Lisp_Object Qfile_name_nondirectory
;
312 Lisp_Object Qunhandled_file_name_directory
;
313 Lisp_Object Qfile_name_as_directory
;
314 Lisp_Object Qcopy_file
;
315 Lisp_Object Qmake_directory_internal
;
316 Lisp_Object Qmake_directory
;
317 Lisp_Object Qdelete_directory
;
318 Lisp_Object Qdelete_file
;
319 Lisp_Object Qrename_file
;
320 Lisp_Object Qadd_name_to_file
;
321 Lisp_Object Qmake_symbolic_link
;
322 Lisp_Object Qfile_exists_p
;
323 Lisp_Object Qfile_executable_p
;
324 Lisp_Object Qfile_readable_p
;
325 Lisp_Object Qfile_writable_p
;
326 Lisp_Object Qfile_symlink_p
;
327 Lisp_Object Qaccess_file
;
328 Lisp_Object Qfile_directory_p
;
329 Lisp_Object Qfile_regular_p
;
330 Lisp_Object Qfile_accessible_directory_p
;
331 Lisp_Object Qfile_modes
;
332 Lisp_Object Qset_file_modes
;
333 Lisp_Object Qset_file_times
;
334 Lisp_Object Qfile_newer_than_file_p
;
335 Lisp_Object Qinsert_file_contents
;
336 Lisp_Object Qwrite_region
;
337 Lisp_Object Qverify_visited_file_modtime
;
338 Lisp_Object Qset_visited_file_modtime
;
340 DEFUN ("find-file-name-handler", Ffind_file_name_handler
, Sfind_file_name_handler
, 2, 2, 0,
341 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
342 Otherwise, return nil.
343 A file name is handled if one of the regular expressions in
344 `file-name-handler-alist' matches it.
346 If OPERATION equals `inhibit-file-name-operation', then we ignore
347 any handlers that are members of `inhibit-file-name-handlers',
348 but we still do run any other handlers. This lets handlers
349 use the standard functions without calling themselves recursively. */)
350 (filename
, operation
)
351 Lisp_Object filename
, operation
;
353 /* This function must not munge the match data. */
354 Lisp_Object chain
, inhibited_handlers
, result
;
358 CHECK_STRING (filename
);
360 if (EQ (operation
, Vinhibit_file_name_operation
))
361 inhibited_handlers
= Vinhibit_file_name_handlers
;
363 inhibited_handlers
= Qnil
;
365 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
366 chain
= XCDR (chain
))
372 Lisp_Object string
= XCAR (elt
);
374 Lisp_Object handler
= XCDR (elt
);
375 Lisp_Object operations
= Qnil
;
377 if (SYMBOLP (handler
))
378 operations
= Fget (handler
, Qoperations
);
381 && (match_pos
= fast_string_match (string
, filename
)) > pos
382 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
386 handler
= XCDR (elt
);
387 tem
= Fmemq (handler
, inhibited_handlers
);
401 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
403 doc
: /* Return the directory component in file name FILENAME.
404 Return nil if FILENAME does not include a directory.
405 Otherwise return a directory name.
406 Given a Unix syntax file name, returns a string ending in slash. */)
408 Lisp_Object filename
;
411 register const unsigned char *beg
;
413 register unsigned char *beg
;
415 register const unsigned char *p
;
418 CHECK_STRING (filename
);
420 /* If the file name has special constructs in it,
421 call the corresponding file handler. */
422 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
424 return call2 (handler
, Qfile_name_directory
, filename
);
426 filename
= FILE_SYSTEM_CASE (filename
);
427 beg
= SDATA (filename
);
429 beg
= strcpy (alloca (strlen (beg
) + 1), beg
);
431 p
= beg
+ SBYTES (filename
);
433 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
435 /* only recognise drive specifier at the beginning */
437 /* handle the "/:d:foo" and "/:foo" cases correctly */
438 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
439 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
446 /* Expansion of "c:" to drive and default directory. */
449 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
450 unsigned char *res
= alloca (MAXPATHLEN
+ 1);
451 unsigned char *r
= res
;
453 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
455 strncpy (res
, beg
, 2);
460 if (getdefdir (toupper (*beg
) - 'A' + 1, r
))
462 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
465 p
= beg
+ strlen (beg
);
468 CORRECT_DIR_SEPS (beg
);
471 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
474 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
475 Sfile_name_nondirectory
, 1, 1, 0,
476 doc
: /* Return file name FILENAME sans its directory.
477 For example, in a Unix-syntax file name,
478 this is everything after the last slash,
479 or the entire name if it contains no slash. */)
481 Lisp_Object filename
;
483 register const unsigned char *beg
, *p
, *end
;
486 CHECK_STRING (filename
);
488 /* If the file name has special constructs in it,
489 call the corresponding file handler. */
490 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
492 return call2 (handler
, Qfile_name_nondirectory
, filename
);
494 beg
= SDATA (filename
);
495 end
= p
= beg
+ SBYTES (filename
);
497 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
499 /* only recognise drive specifier at beginning */
501 /* handle the "/:d:foo" case correctly */
502 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
507 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
510 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
511 Sunhandled_file_name_directory
, 1, 1, 0,
512 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
513 A `directly usable' directory name is one that may be used without the
514 intervention of any file handler.
515 If FILENAME is a directly usable file itself, return
516 \(file-name-directory FILENAME).
517 If FILENAME refers to a file which is not accessible from a local process,
518 then this should return nil.
519 The `call-process' and `start-process' functions use this function to
520 get a current directory to run processes in. */)
522 Lisp_Object filename
;
526 /* If the file name has special constructs in it,
527 call the corresponding file handler. */
528 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
530 return call2 (handler
, Qunhandled_file_name_directory
, filename
);
532 return Ffile_name_directory (filename
);
537 file_name_as_directory (out
, in
)
540 int size
= strlen (in
) - 1;
552 /* For Unix syntax, Append a slash if necessary */
553 if (!IS_DIRECTORY_SEP (out
[size
]))
555 /* Cannot use DIRECTORY_SEP, which could have any value */
557 out
[size
+ 2] = '\0';
560 CORRECT_DIR_SEPS (out
);
565 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
566 Sfile_name_as_directory
, 1, 1, 0,
567 doc
: /* Return a string representing the file name FILE interpreted as a directory.
568 This operation exists because a directory is also a file, but its name as
569 a directory is different from its name as a file.
570 The result can be used as the value of `default-directory'
571 or passed as second argument to `expand-file-name'.
572 For a Unix-syntax file name, just appends a slash. */)
583 /* If the file name has special constructs in it,
584 call the corresponding file handler. */
585 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
587 return call2 (handler
, Qfile_name_as_directory
, file
);
589 buf
= (char *) alloca (SBYTES (file
) + 10);
590 file_name_as_directory (buf
, SDATA (file
));
591 return make_specified_string (buf
, -1, strlen (buf
),
592 STRING_MULTIBYTE (file
));
596 * Convert from directory name to filename.
597 * On UNIX, it's simple: just make sure there isn't a terminating /
599 * Value is nonzero if the string output is different from the input.
603 directory_file_name (src
, dst
)
610 /* Process as Unix format: just remove any final slash.
611 But leave "/" unchanged; do not change it to "". */
614 && IS_DIRECTORY_SEP (dst
[slen
- 1])
616 && !IS_ANY_SEP (dst
[slen
- 2])
621 CORRECT_DIR_SEPS (dst
);
626 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
628 doc
: /* Returns the file name of the directory named DIRECTORY.
629 This is the name of the file that holds the data for the directory DIRECTORY.
630 This operation exists because a directory is also a file, but its name as
631 a directory is different from its name as a file.
632 In Unix-syntax, this function just removes the final slash. */)
634 Lisp_Object directory
;
639 CHECK_STRING (directory
);
641 if (NILP (directory
))
644 /* If the file name has special constructs in it,
645 call the corresponding file handler. */
646 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
648 return call2 (handler
, Qdirectory_file_name
, directory
);
650 buf
= (char *) alloca (SBYTES (directory
) + 20);
651 directory_file_name (SDATA (directory
), buf
);
652 return make_specified_string (buf
, -1, strlen (buf
),
653 STRING_MULTIBYTE (directory
));
656 static char make_temp_name_tbl
[64] =
658 'A','B','C','D','E','F','G','H',
659 'I','J','K','L','M','N','O','P',
660 'Q','R','S','T','U','V','W','X',
661 'Y','Z','a','b','c','d','e','f',
662 'g','h','i','j','k','l','m','n',
663 'o','p','q','r','s','t','u','v',
664 'w','x','y','z','0','1','2','3',
665 '4','5','6','7','8','9','-','_'
668 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
670 /* Value is a temporary file name starting with PREFIX, a string.
672 The Emacs process number forms part of the result, so there is
673 no danger of generating a name being used by another process.
674 In addition, this function makes an attempt to choose a name
675 which has no existing file. To make this work, PREFIX should be
676 an absolute file name.
678 BASE64_P non-zero means add the pid as 3 characters in base64
679 encoding. In this case, 6 characters will be added to PREFIX to
680 form the file name. Otherwise, if Emacs is running on a system
681 with long file names, add the pid as a decimal number.
683 This function signals an error if no unique file name could be
687 make_temp_name (prefix
, base64_p
)
694 unsigned char *p
, *data
;
698 CHECK_STRING (prefix
);
700 /* VAL is created by adding 6 characters to PREFIX. The first
701 three are the PID of this process, in base 64, and the second
702 three are incremented if the file already exists. This ensures
703 262144 unique file names per PID per PREFIX. */
705 pid
= (int) getpid ();
709 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
710 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
711 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
716 #ifdef HAVE_LONG_FILE_NAMES
717 sprintf (pidbuf
, "%d", pid
);
718 pidlen
= strlen (pidbuf
);
720 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
721 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
722 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
727 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
728 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
729 if (!STRING_MULTIBYTE (prefix
))
730 STRING_SET_UNIBYTE (val
);
732 bcopy(SDATA (prefix
), data
, len
);
735 bcopy (pidbuf
, p
, pidlen
);
738 /* Here we try to minimize useless stat'ing when this function is
739 invoked many times successively with the same PREFIX. We achieve
740 this by initializing count to a random value, and incrementing it
743 We don't want make-temp-name to be called while dumping,
744 because then make_temp_name_count_initialized_p would get set
745 and then make_temp_name_count would not be set when Emacs starts. */
747 if (!make_temp_name_count_initialized_p
)
749 make_temp_name_count
= (unsigned) time (NULL
);
750 make_temp_name_count_initialized_p
= 1;
756 unsigned num
= make_temp_name_count
;
758 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
759 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
760 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
762 /* Poor man's congruential RN generator. Replace with
763 ++make_temp_name_count for debugging. */
764 make_temp_name_count
+= 25229;
765 make_temp_name_count
%= 225307;
767 if (stat (data
, &ignored
) < 0)
769 /* We want to return only if errno is ENOENT. */
773 /* The error here is dubious, but there is little else we
774 can do. The alternatives are to return nil, which is
775 as bad as (and in many cases worse than) throwing the
776 error, or to ignore the error, which will likely result
777 in looping through 225307 stat's, which is not only
778 dog-slow, but also useless since it will fallback to
779 the errow below, anyway. */
780 report_file_error ("Cannot create temporary name for prefix",
781 Fcons (prefix
, Qnil
));
786 error ("Cannot create temporary name for prefix `%s'",
792 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
793 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
794 The Emacs process number forms part of the result,
795 so there is no danger of generating a name being used by another process.
797 In addition, this function makes an attempt to choose a name
798 which has no existing file. To make this work,
799 PREFIX should be an absolute file name.
801 There is a race condition between calling `make-temp-name' and creating the
802 file which opens all kinds of security holes. For that reason, you should
803 probably use `make-temp-file' instead, except in three circumstances:
805 * If you are creating the file in the user's home directory.
806 * If you are creating a directory rather than an ordinary file.
807 * If you are taking special precautions as `make-temp-file' does. */)
811 return make_temp_name (prefix
, 0);
816 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
817 doc
: /* Convert filename NAME to absolute, and canonicalize it.
818 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
819 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
820 the current buffer's value of `default-directory' is used.
821 File name components that are `.' are removed, and
822 so are file name components followed by `..', along with the `..' itself;
823 note that these simplifications are done without checking the resulting
824 file names in the file system.
825 An initial `~/' expands to your home directory.
826 An initial `~USER/' expands to USER's home directory.
827 See also the function `substitute-in-file-name'.
829 For technical reasons, this function can return correct but
830 non-intuitive results for the root directory; for instance,
831 \(expand-file-name ".." "/") returns "/..". For this reason, use
832 (directory-file-name (file-name-directory dirname)) to traverse a
833 filesystem tree, not (expand-file-name ".." dirname). */)
834 (name
, default_directory
)
835 Lisp_Object name
, default_directory
;
837 /* These point to SDATA and need to be careful with string-relocation
838 during GC (via DECODE_FILE). */
839 unsigned char *nm
, *newdir
;
840 /* This should only point to alloca'd data. */
841 unsigned char *target
;
847 int collapse_newdir
= 1;
851 Lisp_Object handler
, result
;
857 /* If the file name has special constructs in it,
858 call the corresponding file handler. */
859 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
861 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
863 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
864 if (NILP (default_directory
))
865 default_directory
= current_buffer
->directory
;
866 if (! STRINGP (default_directory
))
869 /* "/" is not considered a root directory on DOS_NT, so using "/"
870 here causes an infinite recursion in, e.g., the following:
872 (let (default-directory)
873 (expand-file-name "a"))
875 To avoid this, we set default_directory to the root of the
877 extern char *emacs_root_dir (void);
879 default_directory
= build_string (emacs_root_dir ());
881 default_directory
= build_string ("/");
885 if (!NILP (default_directory
))
887 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
889 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
893 unsigned char *o
= SDATA (default_directory
);
895 /* Make sure DEFAULT_DIRECTORY is properly expanded.
896 It would be better to do this down below where we actually use
897 default_directory. Unfortunately, calling Fexpand_file_name recursively
898 could invoke GC, and the strings might be relocated. This would
899 be annoying because we have pointers into strings lying around
900 that would need adjusting, and people would add new pointers to
901 the code and forget to adjust them, resulting in intermittent bugs.
902 Putting this call here avoids all that crud.
904 The EQ test avoids infinite recursion. */
905 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
906 /* Save time in some common cases - as long as default_directory
907 is not relative, it can be canonicalized with name below (if it
908 is needed at all) without requiring it to be expanded now. */
910 /* Detect MSDOS file names with drive specifiers. */
911 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1])
912 && IS_DIRECTORY_SEP (o
[2]))
914 /* Detect Windows file names in UNC format. */
915 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
917 #else /* not DOS_NT */
918 /* Detect Unix absolute file names (/... alone is not absolute on
920 && ! (IS_DIRECTORY_SEP (o
[0]))
921 #endif /* not DOS_NT */
927 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
931 name
= FILE_SYSTEM_CASE (name
);
932 multibyte
= STRING_MULTIBYTE (name
);
933 if (multibyte
!= STRING_MULTIBYTE (default_directory
))
936 default_directory
= string_to_multibyte (default_directory
);
939 name
= string_to_multibyte (name
);
946 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
947 nm
= strcpy (alloca (strlen (nm
) + 1), nm
);
950 /* Note if special escape prefix is present, but remove for now. */
951 if (nm
[0] == '/' && nm
[1] == ':')
957 /* Find and remove drive specifier if present; this makes nm absolute
958 even if the rest of the name appears to be relative. Only look for
959 drive specifier at the beginning. */
960 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
967 /* If we see "c://somedir", we want to strip the first slash after the
968 colon when stripping the drive letter. Otherwise, this expands to
970 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
973 /* Discard any previous drive specifier if nm is now in UNC format. */
974 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
978 #endif /* WINDOWSNT */
981 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
982 none are found, we can probably return right away. We will avoid
983 allocating a new string if name is already fully expanded. */
985 IS_DIRECTORY_SEP (nm
[0])
987 && drive
&& !is_escaped
990 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
994 /* If it turns out that the filename we want to return is just a
995 suffix of FILENAME, we don't need to go through and edit
996 things; we just need to construct a new string using data
997 starting at the middle of FILENAME. If we set lose to a
998 non-zero value, that means we've discovered that we can't do
1001 unsigned char *p
= nm
;
1005 /* Since we know the name is absolute, we can assume that each
1006 element starts with a "/". */
1008 /* "." and ".." are hairy. */
1009 if (IS_DIRECTORY_SEP (p
[0])
1011 && (IS_DIRECTORY_SEP (p
[2])
1013 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1016 /* We want to replace multiple `/' in a row with a single
1019 && IS_DIRECTORY_SEP (p
[0])
1020 && IS_DIRECTORY_SEP (p
[1]))
1027 /* Make sure directories are all separated with / or \ as
1028 desired, but avoid allocation of a new string when not
1030 CORRECT_DIR_SEPS (nm
);
1032 if (IS_DIRECTORY_SEP (nm
[1]))
1034 if (strcmp (nm
, SDATA (name
)) != 0)
1035 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1039 /* drive must be set, so this is okay */
1040 if (strcmp (nm
- 2, SDATA (name
)) != 0)
1044 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1045 temp
[0] = DRIVE_LETTER (drive
);
1046 name
= concat2 (build_string (temp
), name
);
1049 #else /* not DOS_NT */
1050 if (strcmp (nm
, SDATA (name
)) == 0)
1052 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1053 #endif /* not DOS_NT */
1057 /* At this point, nm might or might not be an absolute file name. We
1058 need to expand ~ or ~user if present, otherwise prefix nm with
1059 default_directory if nm is not absolute, and finally collapse /./
1060 and /foo/../ sequences.
1062 We set newdir to be the appropriate prefix if one is needed:
1063 - the relevant user directory if nm starts with ~ or ~user
1064 - the specified drive's working dir (DOS/NT only) if nm does not
1066 - the value of default_directory.
1068 Note that these prefixes are not guaranteed to be absolute (except
1069 for the working dir of a drive). Therefore, to ensure we always
1070 return an absolute name, if the final prefix is not absolute we
1071 append it to the current working directory. */
1075 if (nm
[0] == '~') /* prefix ~ */
1077 if (IS_DIRECTORY_SEP (nm
[1])
1078 || nm
[1] == 0) /* ~ by itself */
1082 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1083 newdir
= (unsigned char *) "";
1085 /* egetenv may return a unibyte string, which will bite us since
1086 we expect the directory to be multibyte. */
1087 tem
= build_string (newdir
);
1088 if (!STRING_MULTIBYTE (tem
))
1090 hdir
= DECODE_FILE (tem
);
1091 newdir
= SDATA (hdir
);
1094 collapse_newdir
= 0;
1097 else /* ~user/filename */
1099 unsigned char *o
, *p
;
1100 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)); p
++);
1101 o
= alloca (p
- nm
+ 1);
1102 bcopy ((char *) nm
, o
, p
- nm
);
1106 pw
= (struct passwd
*) getpwnam (o
+ 1);
1110 newdir
= (unsigned char *) pw
-> pw_dir
;
1113 collapse_newdir
= 0;
1117 /* If we don't find a user of that name, leave the name
1118 unchanged; don't move nm forward to p. */
1123 /* On DOS and Windows, nm is absolute if a drive name was specified;
1124 use the drive's current directory as the prefix if needed. */
1125 if (!newdir
&& drive
)
1127 /* Get default directory if needed to make nm absolute. */
1128 if (!IS_DIRECTORY_SEP (nm
[0]))
1130 newdir
= alloca (MAXPATHLEN
+ 1);
1131 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1136 /* Either nm starts with /, or drive isn't mounted. */
1137 newdir
= alloca (4);
1138 newdir
[0] = DRIVE_LETTER (drive
);
1146 /* Finally, if no prefix has been specified and nm is not absolute,
1147 then it must be expanded relative to default_directory. */
1151 /* /... alone is not absolute on DOS and Windows. */
1152 && !IS_DIRECTORY_SEP (nm
[0])
1155 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1159 newdir
= SDATA (default_directory
);
1161 /* Note if special escape prefix is present, but remove for now. */
1162 if (newdir
[0] == '/' && newdir
[1] == ':')
1173 /* First ensure newdir is an absolute name. */
1175 /* Detect MSDOS file names with drive specifiers. */
1176 ! (IS_DRIVE (newdir
[0])
1177 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1179 /* Detect Windows file names in UNC format. */
1180 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1184 /* Effectively, let newdir be (expand-file-name newdir cwd).
1185 Because of the admonition against calling expand-file-name
1186 when we have pointers into lisp strings, we accomplish this
1187 indirectly by prepending newdir to nm if necessary, and using
1188 cwd (or the wd of newdir's drive) as the new newdir. */
1190 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1195 if (!IS_DIRECTORY_SEP (nm
[0]))
1197 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1198 file_name_as_directory (tmp
, newdir
);
1202 newdir
= alloca (MAXPATHLEN
+ 1);
1205 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1212 /* Strip off drive name from prefix, if present. */
1213 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1219 /* Keep only a prefix from newdir if nm starts with slash
1220 (//server/share for UNC, nothing otherwise). */
1221 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1224 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1227 newdir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1229 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1231 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1243 /* Get rid of any slash at the end of newdir, unless newdir is
1244 just / or // (an incomplete UNC name). */
1245 length
= strlen (newdir
);
1246 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1248 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1252 unsigned char *temp
= (unsigned char *) alloca (length
);
1253 bcopy (newdir
, temp
, length
- 1);
1254 temp
[length
- 1] = 0;
1262 /* Now concatenate the directory and name to new space in the stack frame */
1263 tlen
+= strlen (nm
) + 1;
1265 /* Reserve space for drive specifier and escape prefix, since either
1266 or both may need to be inserted. (The Microsoft x86 compiler
1267 produces incorrect code if the following two lines are combined.) */
1268 target
= (unsigned char *) alloca (tlen
+ 4);
1270 #else /* not DOS_NT */
1271 target
= (unsigned char *) alloca (tlen
);
1272 #endif /* not DOS_NT */
1277 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1280 /* If newdir is effectively "C:/", then the drive letter will have
1281 been stripped and newdir will be "/". Concatenating with an
1282 absolute directory in nm produces "//", which will then be
1283 incorrectly treated as a network share. Ignore newdir in
1284 this case (keeping the drive letter). */
1285 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1286 && newdir
[1] == '\0'))
1288 strcpy (target
, newdir
);
1291 file_name_as_directory (target
, newdir
);
1294 strcat (target
, nm
);
1296 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1299 unsigned char *p
= target
;
1300 unsigned char *o
= target
;
1304 if (!IS_DIRECTORY_SEP (*p
))
1308 else if (p
[1] == '.'
1309 && (IS_DIRECTORY_SEP (p
[2])
1312 /* If "/." is the entire filename, keep the "/". Otherwise,
1313 just delete the whole "/.". */
1314 if (o
== target
&& p
[2] == '\0')
1318 else if (p
[1] == '.' && p
[2] == '.'
1319 /* `/../' is the "superroot" on certain file systems.
1320 Turned off on DOS_NT systems because they have no
1321 "superroot" and because this causes us to produce
1322 file names like "d:/../foo" which fail file-related
1323 functions of the underlying OS. (To reproduce, try a
1324 long series of "../../" in default_directory, longer
1325 than the number of levels from the root.) */
1329 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1332 unsigned char *prev_o
= o
;
1334 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1337 /* Don't go below server level in UNC filenames. */
1338 if (o
== target
+ 1 && IS_DIRECTORY_SEP (*o
)
1339 && IS_DIRECTORY_SEP (*target
))
1343 /* Keep initial / only if this is the whole name. */
1344 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1348 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1349 /* Collapse multiple `/' in a row. */
1358 /* At last, set drive name. */
1360 /* Except for network file name. */
1361 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1362 #endif /* WINDOWSNT */
1364 if (!drive
) abort ();
1366 target
[0] = DRIVE_LETTER (drive
);
1369 /* Reinsert the escape prefix if required. */
1376 CORRECT_DIR_SEPS (target
);
1379 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1382 /* Again look to see if the file name has special constructs in it
1383 and perhaps call the corresponding file handler. This is needed
1384 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1385 the ".." component gives us "/user@host:/bar/../baz" which needs
1386 to be expanded again. */
1387 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1388 if (!NILP (handler
))
1389 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1395 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1396 This is the old version of expand-file-name, before it was thoroughly
1397 rewritten for Emacs 10.31. We leave this version here commented-out,
1398 because the code is very complex and likely to have subtle bugs. If
1399 bugs _are_ found, it might be of interest to look at the old code and
1400 see what did it do in the relevant situation.
1402 Don't remove this code: it's true that it will be accessible via CVS,
1403 but a few years from deletion, people will forget it is there. */
1405 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1406 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1407 "Convert FILENAME to absolute, and canonicalize it.\n\
1408 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1409 \(does not start with slash); if DEFAULT is nil or missing,\n\
1410 the current buffer's value of default-directory is used.\n\
1411 Filenames containing `.' or `..' as components are simplified;\n\
1412 initial `~/' expands to your home directory.\n\
1413 See also the function `substitute-in-file-name'.")
1415 Lisp_Object name
, defalt
;
1419 register unsigned char *newdir
, *p
, *o
;
1421 unsigned char *target
;
1425 CHECK_STRING (name
);
1428 /* If nm is absolute, flush ...// and detect /./ and /../.
1429 If no /./ or /../ we can return right away. */
1436 if (p
[0] == '/' && p
[1] == '/'
1439 if (p
[0] == '/' && p
[1] == '~')
1440 nm
= p
+ 1, lose
= 1;
1441 if (p
[0] == '/' && p
[1] == '.'
1442 && (p
[2] == '/' || p
[2] == 0
1443 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1449 if (nm
== SDATA (name
))
1451 return build_string (nm
);
1455 /* Now determine directory to start with and put it in NEWDIR */
1459 if (nm
[0] == '~') /* prefix ~ */
1460 if (nm
[1] == '/' || nm
[1] == 0)/* ~/filename */
1462 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1463 newdir
= (unsigned char *) "";
1466 else /* ~user/filename */
1468 /* Get past ~ to user */
1469 unsigned char *user
= nm
+ 1;
1470 /* Find end of name. */
1471 unsigned char *ptr
= (unsigned char *) index (user
, '/');
1472 int len
= ptr
? ptr
- user
: strlen (user
);
1473 /* Copy the user name into temp storage. */
1474 o
= (unsigned char *) alloca (len
+ 1);
1475 bcopy ((char *) user
, o
, len
);
1478 /* Look up the user name. */
1480 pw
= (struct passwd
*) getpwnam (o
+ 1);
1483 error ("\"%s\" isn't a registered user", o
+ 1);
1485 newdir
= (unsigned char *) pw
->pw_dir
;
1487 /* Discard the user name from NM. */
1491 if (nm
[0] != '/' && !newdir
)
1494 defalt
= current_buffer
->directory
;
1495 CHECK_STRING (defalt
);
1496 newdir
= SDATA (defalt
);
1499 /* Now concatenate the directory and name to new space in the stack frame */
1501 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1502 target
= (unsigned char *) alloca (tlen
);
1507 if (nm
[0] == 0 || nm
[0] == '/')
1508 strcpy (target
, newdir
);
1510 file_name_as_directory (target
, newdir
);
1513 strcat (target
, nm
);
1515 /* Now canonicalize by removing /. and /foo/.. if they appear */
1526 else if (!strncmp (p
, "//", 2)
1532 else if (p
[0] == '/' && p
[1] == '.'
1533 && (p
[2] == '/' || p
[2] == 0))
1535 else if (!strncmp (p
, "/..", 3)
1536 /* `/../' is the "superroot" on certain file systems. */
1538 && (p
[3] == '/' || p
[3] == 0))
1540 while (o
!= target
&& *--o
!= '/')
1542 if (o
== target
&& *o
== '/')
1552 return make_string (target
, o
- target
);
1556 /* If /~ or // appears, discard everything through first slash. */
1558 file_name_absolute_p (filename
)
1559 const unsigned char *filename
;
1562 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
1564 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
1565 && IS_DIRECTORY_SEP (filename
[2]))
1570 static unsigned char *
1571 search_embedded_absfilename (nm
, endp
)
1572 unsigned char *nm
, *endp
;
1574 unsigned char *p
, *s
;
1576 for (p
= nm
+ 1; p
< endp
; p
++)
1579 || IS_DIRECTORY_SEP (p
[-1]))
1580 && file_name_absolute_p (p
)
1581 #if defined (WINDOWSNT) || defined(CYGWIN)
1582 /* // at start of file name is meaningful in Apollo,
1583 WindowsNT and Cygwin systems. */
1584 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
1585 #endif /* not (WINDOWSNT || CYGWIN) */
1588 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)); s
++);
1589 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
1591 unsigned char *o
= alloca (s
- p
+ 1);
1593 bcopy (p
, o
, s
- p
);
1596 /* If we have ~user and `user' exists, discard
1597 everything up to ~. But if `user' does not exist, leave
1598 ~user alone, it might be a literal file name. */
1600 pw
= getpwnam (o
+ 1);
1612 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
1613 Ssubstitute_in_file_name
, 1, 1, 0,
1614 doc
: /* Substitute environment variables referred to in FILENAME.
1615 `$FOO' where FOO is an environment variable name means to substitute
1616 the value of that variable. The variable name should be terminated
1617 with a character not a letter, digit or underscore; otherwise, enclose
1618 the entire variable name in braces.
1620 If `/~' appears, all of FILENAME through that `/' is discarded.
1621 If `//' appears, everything up to and including the first of
1622 those `/' is discarded. */)
1624 Lisp_Object filename
;
1628 register unsigned char *s
, *p
, *o
, *x
, *endp
;
1629 unsigned char *target
= NULL
;
1631 int substituted
= 0;
1633 Lisp_Object handler
;
1635 CHECK_STRING (filename
);
1637 /* If the file name has special constructs in it,
1638 call the corresponding file handler. */
1639 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1640 if (!NILP (handler
))
1641 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
1643 nm
= SDATA (filename
);
1645 nm
= strcpy (alloca (strlen (nm
) + 1), nm
);
1646 CORRECT_DIR_SEPS (nm
);
1647 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1649 endp
= nm
+ SBYTES (filename
);
1651 /* If /~ or // appears, discard everything through first slash. */
1652 p
= search_embedded_absfilename (nm
, endp
);
1654 /* Start over with the new string, so we check the file-name-handler
1655 again. Important with filenames like "/home/foo//:/hello///there"
1656 which whould substitute to "/:/hello///there" rather than "/there". */
1657 return Fsubstitute_in_file_name
1658 (make_specified_string (p
, -1, endp
- p
,
1659 STRING_MULTIBYTE (filename
)));
1662 /* See if any variables are substituted into the string
1663 and find the total length of their values in `total' */
1665 for (p
= nm
; p
!= endp
;)
1675 /* "$$" means a single "$" */
1684 while (p
!= endp
&& *p
!= '}') p
++;
1685 if (*p
!= '}') goto missingclose
;
1691 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1695 /* Copy out the variable name */
1696 target
= (unsigned char *) alloca (s
- o
+ 1);
1697 strncpy (target
, o
, s
- o
);
1700 strupr (target
); /* $home == $HOME etc. */
1703 /* Get variable value */
1704 o
= (unsigned char *) egetenv (target
);
1706 { /* Eight-bit chars occupy upto 2 bytes in multibyte. */
1707 total
+= strlen (o
) * (STRING_MULTIBYTE (filename
) ? 2 : 1);
1717 /* If substitution required, recopy the string and do it */
1718 /* Make space in stack frame for the new copy */
1719 xnm
= (unsigned char *) alloca (SBYTES (filename
) + total
+ 1);
1722 /* Copy the rest of the name through, replacing $ constructs with values */
1739 while (p
!= endp
&& *p
!= '}') p
++;
1740 if (*p
!= '}') goto missingclose
;
1746 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1750 /* Copy out the variable name */
1751 target
= (unsigned char *) alloca (s
- o
+ 1);
1752 strncpy (target
, o
, s
- o
);
1755 strupr (target
); /* $home == $HOME etc. */
1758 /* Get variable value */
1759 o
= (unsigned char *) egetenv (target
);
1763 strcpy (x
, target
); x
+= strlen (target
);
1765 else if (STRING_MULTIBYTE (filename
))
1767 /* If the original string is multibyte,
1768 convert what we substitute into multibyte. */
1772 c
= unibyte_char_to_multibyte (c
);
1773 x
+= CHAR_STRING (c
, x
);
1785 /* If /~ or // appears, discard everything through first slash. */
1786 while ((p
= search_embedded_absfilename (xnm
, x
)))
1787 /* This time we do not start over because we've already expanded envvars
1788 and replaced $$ with $. Maybe we should start over as well, but we'd
1789 need to quote some $ to $$ first. */
1792 return make_specified_string (xnm
, -1, x
- xnm
, STRING_MULTIBYTE (filename
));
1795 error ("Bad format environment-variable substitution");
1797 error ("Missing \"}\" in environment-variable substitution");
1799 error ("Substituting nonexistent environment variable \"%s\"", target
);
1805 /* A slightly faster and more convenient way to get
1806 (directory-file-name (expand-file-name FOO)). */
1809 expand_and_dir_to_file (filename
, defdir
)
1810 Lisp_Object filename
, defdir
;
1812 register Lisp_Object absname
;
1814 absname
= Fexpand_file_name (filename
, defdir
);
1816 /* Remove final slash, if any (unless this is the root dir).
1817 stat behaves differently depending! */
1818 if (SCHARS (absname
) > 1
1819 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1820 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
1821 /* We cannot take shortcuts; they might be wrong for magic file names. */
1822 absname
= Fdirectory_file_name (absname
);
1826 /* Signal an error if the file ABSNAME already exists.
1827 If INTERACTIVE is nonzero, ask the user whether to proceed,
1828 and bypass the error if the user says to go ahead.
1829 QUERYSTRING is a name for the action that is being considered
1832 *STATPTR is used to store the stat information if the file exists.
1833 If the file does not exist, STATPTR->st_mode is set to 0.
1834 If STATPTR is null, we don't store into it.
1836 If QUICK is nonzero, we ask for y or n, not yes or no. */
1839 barf_or_query_if_file_exists (absname
, querystring
, interactive
, statptr
, quick
)
1840 Lisp_Object absname
;
1841 unsigned char *querystring
;
1843 struct stat
*statptr
;
1846 register Lisp_Object tem
, encoded_filename
;
1847 struct stat statbuf
;
1848 struct gcpro gcpro1
;
1850 encoded_filename
= ENCODE_FILE (absname
);
1852 /* stat is a good way to tell whether the file exists,
1853 regardless of what access permissions it has. */
1854 if (lstat (SDATA (encoded_filename
), &statbuf
) >= 0)
1857 xsignal2 (Qfile_already_exists
,
1858 build_string ("File already exists"), absname
);
1860 tem
= format2 ("File %s already exists; %s anyway? ",
1861 absname
, build_string (querystring
));
1863 tem
= Fy_or_n_p (tem
);
1865 tem
= do_yes_or_no_p (tem
);
1868 xsignal2 (Qfile_already_exists
,
1869 build_string ("File already exists"), absname
);
1876 statptr
->st_mode
= 0;
1881 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 5,
1882 "fCopy file: \nGCopy %s to file: \np\nP",
1883 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1884 If NEWNAME names a directory, copy FILE there.
1886 This function always sets the file modes of the output file to match
1889 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1890 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1891 signal a `file-already-exists' error without overwriting. If
1892 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1893 about overwriting; this is what happens in interactive use with M-x.
1894 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1897 Fourth arg KEEP-TIME non-nil means give the output file the same
1898 last-modified time as the old one. (This works on only some systems.)
1900 A prefix arg makes KEEP-TIME non-nil.
1902 If PRESERVE-UID-GID is non-nil, we try to transfer the
1903 uid and gid of FILE to NEWNAME. */)
1904 (file
, newname
, ok_if_already_exists
, keep_time
, preserve_uid_gid
)
1905 Lisp_Object file
, newname
, ok_if_already_exists
, keep_time
;
1906 Lisp_Object preserve_uid_gid
;
1909 char buf
[16 * 1024];
1910 struct stat st
, out_st
;
1911 Lisp_Object handler
;
1912 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1913 int count
= SPECPDL_INDEX ();
1914 int input_file_statable_p
;
1915 Lisp_Object encoded_file
, encoded_newname
;
1917 encoded_file
= encoded_newname
= Qnil
;
1918 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1919 CHECK_STRING (file
);
1920 CHECK_STRING (newname
);
1922 if (!NILP (Ffile_directory_p (newname
)))
1923 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1925 newname
= Fexpand_file_name (newname
, Qnil
);
1927 file
= Fexpand_file_name (file
, Qnil
);
1929 /* If the input file name has special constructs in it,
1930 call the corresponding file handler. */
1931 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1932 /* Likewise for output file name. */
1934 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1935 if (!NILP (handler
))
1936 RETURN_UNGCPRO (call6 (handler
, Qcopy_file
, file
, newname
,
1937 ok_if_already_exists
, keep_time
, preserve_uid_gid
));
1939 encoded_file
= ENCODE_FILE (file
);
1940 encoded_newname
= ENCODE_FILE (newname
);
1942 if (NILP (ok_if_already_exists
)
1943 || INTEGERP (ok_if_already_exists
))
1944 barf_or_query_if_file_exists (newname
, "copy to it",
1945 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1946 else if (stat (SDATA (encoded_newname
), &out_st
) < 0)
1950 if (!CopyFile (SDATA (encoded_file
),
1951 SDATA (encoded_newname
),
1953 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1954 /* CopyFile retains the timestamp by default. */
1955 else if (NILP (keep_time
))
1961 EMACS_GET_TIME (now
);
1962 filename
= SDATA (encoded_newname
);
1964 /* Ensure file is writable while its modified time is set. */
1965 attributes
= GetFileAttributes (filename
);
1966 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1967 if (set_file_times (filename
, now
, now
))
1969 /* Restore original attributes. */
1970 SetFileAttributes (filename
, attributes
);
1971 xsignal2 (Qfile_date_error
,
1972 build_string ("Cannot set file date"), newname
);
1974 /* Restore original attributes. */
1975 SetFileAttributes (filename
, attributes
);
1977 #else /* not WINDOWSNT */
1979 ifd
= emacs_open (SDATA (encoded_file
), O_RDONLY
, 0);
1983 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1985 record_unwind_protect (close_file_unwind
, make_number (ifd
));
1987 /* We can only copy regular files and symbolic links. Other files are not
1989 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
1991 #if !defined (MSDOS) || __DJGPP__ > 1
1992 if (out_st
.st_mode
!= 0
1993 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
1996 report_file_error ("Input and output files are the same",
1997 Fcons (file
, Fcons (newname
, Qnil
)));
2001 #if defined (S_ISREG) && defined (S_ISLNK)
2002 if (input_file_statable_p
)
2004 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
2006 #if defined (EISDIR)
2007 /* Get a better looking error message. */
2010 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2013 #endif /* S_ISREG && S_ISLNK */
2016 /* System's default file type was set to binary by _fmode in emacs.c. */
2017 ofd
= emacs_open (SDATA (encoded_newname
),
2018 O_WRONLY
| O_TRUNC
| O_CREAT
2019 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2020 S_IREAD
| S_IWRITE
);
2021 #else /* not MSDOS */
2022 ofd
= emacs_open (SDATA (encoded_newname
),
2023 O_WRONLY
| O_TRUNC
| O_CREAT
2024 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2026 #endif /* not MSDOS */
2028 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2030 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2034 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2035 if (emacs_write (ofd
, buf
, n
) != n
)
2036 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2040 /* Preserve the original file modes, and if requested, also its
2042 if (input_file_statable_p
)
2044 if (! NILP (preserve_uid_gid
))
2045 fchown (ofd
, st
.st_uid
, st
.st_gid
);
2046 fchmod (ofd
, st
.st_mode
& 07777);
2048 #endif /* not MSDOS */
2050 /* Closing the output clobbers the file times on some systems. */
2051 if (emacs_close (ofd
) < 0)
2052 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2054 if (input_file_statable_p
)
2056 if (!NILP (keep_time
))
2058 EMACS_TIME atime
, mtime
;
2059 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
2060 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
2061 if (set_file_times (SDATA (encoded_newname
),
2063 xsignal2 (Qfile_date_error
,
2064 build_string ("Cannot set file date"), newname
);
2070 #if defined (__DJGPP__) && __DJGPP__ > 1
2071 if (input_file_statable_p
)
2073 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2074 and if it can't, it tells so. Otherwise, under MSDOS we usually
2075 get only the READ bit, which will make the copied file read-only,
2076 so it's better not to chmod at all. */
2077 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2078 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2080 #endif /* DJGPP version 2 or newer */
2081 #endif /* not WINDOWSNT */
2083 /* Discard the unwind protects. */
2084 specpdl_ptr
= specpdl
+ count
;
2090 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2091 Smake_directory_internal
, 1, 1, 0,
2092 doc
: /* Create a new directory named DIRECTORY. */)
2094 Lisp_Object directory
;
2096 const unsigned char *dir
;
2097 Lisp_Object handler
;
2098 Lisp_Object encoded_dir
;
2100 CHECK_STRING (directory
);
2101 directory
= Fexpand_file_name (directory
, Qnil
);
2103 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2104 if (!NILP (handler
))
2105 return call2 (handler
, Qmake_directory_internal
, directory
);
2107 encoded_dir
= ENCODE_FILE (directory
);
2109 dir
= SDATA (encoded_dir
);
2112 if (mkdir (dir
) != 0)
2114 if (mkdir (dir
, 0777) != 0)
2116 report_file_error ("Creating directory", list1 (directory
));
2121 DEFUN ("delete-directory", Fdelete_directory
, Sdelete_directory
, 1, 1, "FDelete directory: ",
2122 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2124 Lisp_Object directory
;
2126 const unsigned char *dir
;
2127 Lisp_Object handler
;
2128 Lisp_Object encoded_dir
;
2130 CHECK_STRING (directory
);
2131 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2133 handler
= Ffind_file_name_handler (directory
, Qdelete_directory
);
2134 if (!NILP (handler
))
2135 return call2 (handler
, Qdelete_directory
, directory
);
2137 if (delete_by_moving_to_trash
)
2138 return call1 (Qmove_file_to_trash
, directory
);
2140 encoded_dir
= ENCODE_FILE (directory
);
2142 dir
= SDATA (encoded_dir
);
2144 if (rmdir (dir
) != 0)
2145 report_file_error ("Removing directory", list1 (directory
));
2150 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 1, "fDelete file: ",
2151 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2152 If file has multiple names, it continues to exist with the other names. */)
2154 Lisp_Object filename
;
2156 Lisp_Object handler
;
2157 Lisp_Object encoded_file
;
2158 struct gcpro gcpro1
;
2161 if (!NILP (Ffile_directory_p (filename
))
2162 && NILP (Ffile_symlink_p (filename
)))
2163 xsignal2 (Qfile_error
,
2164 build_string ("Removing old name: is a directory"),
2167 filename
= Fexpand_file_name (filename
, Qnil
);
2169 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2170 if (!NILP (handler
))
2171 return call2 (handler
, Qdelete_file
, filename
);
2173 if (delete_by_moving_to_trash
)
2174 return call1 (Qmove_file_to_trash
, filename
);
2176 encoded_file
= ENCODE_FILE (filename
);
2178 if (0 > unlink (SDATA (encoded_file
)))
2179 report_file_error ("Removing old name", list1 (filename
));
2184 internal_delete_file_1 (ignore
)
2190 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2193 internal_delete_file (filename
)
2194 Lisp_Object filename
;
2197 tem
= internal_condition_case_1 (Fdelete_file
, filename
,
2198 Qt
, internal_delete_file_1
);
2202 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2203 "fRename file: \nGRename %s to file: \np",
2204 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2205 If file has names other than FILE, it continues to have those names.
2206 Signals a `file-already-exists' error if a file NEWNAME already exists
2207 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2208 A number as third arg means request confirmation if NEWNAME already exists.
2209 This is what happens in interactive use with M-x. */)
2210 (file
, newname
, ok_if_already_exists
)
2211 Lisp_Object file
, newname
, ok_if_already_exists
;
2213 Lisp_Object handler
;
2214 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2215 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2217 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2218 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2219 CHECK_STRING (file
);
2220 CHECK_STRING (newname
);
2221 file
= Fexpand_file_name (file
, Qnil
);
2223 if ((!NILP (Ffile_directory_p (newname
)))
2225 /* If the file names are identical but for the case,
2226 don't attempt to move directory to itself. */
2227 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2230 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2232 newname
= Fexpand_file_name (newname
, Qnil
);
2234 /* If the file name has special constructs in it,
2235 call the corresponding file handler. */
2236 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2238 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2239 if (!NILP (handler
))
2240 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2241 file
, newname
, ok_if_already_exists
));
2243 encoded_file
= ENCODE_FILE (file
);
2244 encoded_newname
= ENCODE_FILE (newname
);
2247 /* If the file names are identical but for the case, don't ask for
2248 confirmation: they simply want to change the letter-case of the
2250 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2252 if (NILP (ok_if_already_exists
)
2253 || INTEGERP (ok_if_already_exists
))
2254 barf_or_query_if_file_exists (newname
, "rename to it",
2255 INTEGERP (ok_if_already_exists
), 0, 0);
2256 if (0 > rename (SDATA (encoded_file
), SDATA (encoded_newname
)))
2262 symlink_target
= Ffile_symlink_p (file
);
2263 if (! NILP (symlink_target
))
2264 Fmake_symbolic_link (symlink_target
, newname
,
2265 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2268 Fcopy_file (file
, newname
,
2269 /* We have already prompted if it was an integer,
2270 so don't have copy-file prompt again. */
2271 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2274 count
= SPECPDL_INDEX ();
2275 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2276 Fdelete_file (file
);
2277 unbind_to (count
, Qnil
);
2280 report_file_error ("Renaming", list2 (file
, newname
));
2286 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2287 "fAdd name to file: \nGName to add to %s: \np",
2288 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2289 Signals a `file-already-exists' error if a file NEWNAME already exists
2290 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2291 A number as third arg means request confirmation if NEWNAME already exists.
2292 This is what happens in interactive use with M-x. */)
2293 (file
, newname
, ok_if_already_exists
)
2294 Lisp_Object file
, newname
, ok_if_already_exists
;
2296 Lisp_Object handler
;
2297 Lisp_Object encoded_file
, encoded_newname
;
2298 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2300 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2301 encoded_file
= encoded_newname
= Qnil
;
2302 CHECK_STRING (file
);
2303 CHECK_STRING (newname
);
2304 file
= Fexpand_file_name (file
, Qnil
);
2306 if (!NILP (Ffile_directory_p (newname
)))
2307 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2309 newname
= Fexpand_file_name (newname
, Qnil
);
2311 /* If the file name has special constructs in it,
2312 call the corresponding file handler. */
2313 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2314 if (!NILP (handler
))
2315 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2316 newname
, ok_if_already_exists
));
2318 /* If the new name has special constructs in it,
2319 call the corresponding file handler. */
2320 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2321 if (!NILP (handler
))
2322 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2323 newname
, ok_if_already_exists
));
2325 encoded_file
= ENCODE_FILE (file
);
2326 encoded_newname
= ENCODE_FILE (newname
);
2328 if (NILP (ok_if_already_exists
)
2329 || INTEGERP (ok_if_already_exists
))
2330 barf_or_query_if_file_exists (newname
, "make it a new name",
2331 INTEGERP (ok_if_already_exists
), 0, 0);
2333 unlink (SDATA (newname
));
2334 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
)))
2335 report_file_error ("Adding new name", list2 (file
, newname
));
2341 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2342 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2343 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2344 Both args must be strings.
2345 Signals a `file-already-exists' error if a file LINKNAME already exists
2346 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2347 A number as third arg means request confirmation if LINKNAME already exists.
2348 This happens for interactive use with M-x. */)
2349 (filename
, linkname
, ok_if_already_exists
)
2350 Lisp_Object filename
, linkname
, ok_if_already_exists
;
2352 Lisp_Object handler
;
2353 Lisp_Object encoded_filename
, encoded_linkname
;
2354 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2356 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2357 encoded_filename
= encoded_linkname
= Qnil
;
2358 CHECK_STRING (filename
);
2359 CHECK_STRING (linkname
);
2360 /* If the link target has a ~, we must expand it to get
2361 a truly valid file name. Otherwise, do not expand;
2362 we want to permit links to relative file names. */
2363 if (SREF (filename
, 0) == '~')
2364 filename
= Fexpand_file_name (filename
, Qnil
);
2366 if (!NILP (Ffile_directory_p (linkname
)))
2367 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2369 linkname
= Fexpand_file_name (linkname
, Qnil
);
2371 /* If the file name has special constructs in it,
2372 call the corresponding file handler. */
2373 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2374 if (!NILP (handler
))
2375 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2376 linkname
, ok_if_already_exists
));
2378 /* If the new link name has special constructs in it,
2379 call the corresponding file handler. */
2380 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2381 if (!NILP (handler
))
2382 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2383 linkname
, ok_if_already_exists
));
2386 encoded_filename
= ENCODE_FILE (filename
);
2387 encoded_linkname
= ENCODE_FILE (linkname
);
2389 if (NILP (ok_if_already_exists
)
2390 || INTEGERP (ok_if_already_exists
))
2391 barf_or_query_if_file_exists (linkname
, "make it a link",
2392 INTEGERP (ok_if_already_exists
), 0, 0);
2393 if (0 > symlink (SDATA (encoded_filename
),
2394 SDATA (encoded_linkname
)))
2396 /* If we didn't complain already, silently delete existing file. */
2397 if (errno
== EEXIST
)
2399 unlink (SDATA (encoded_linkname
));
2400 if (0 <= symlink (SDATA (encoded_filename
),
2401 SDATA (encoded_linkname
)))
2408 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2415 xsignal1 (Qfile_error
, build_string ("Symbolic links are not supported"));
2417 #endif /* S_IFLNK */
2421 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2423 doc
: /* Return t if file FILENAME specifies an absolute file name.
2424 On Unix, this is a name starting with a `/' or a `~'. */)
2426 Lisp_Object filename
;
2428 CHECK_STRING (filename
);
2429 return file_name_absolute_p (SDATA (filename
)) ? Qt
: Qnil
;
2432 /* Return nonzero if file FILENAME exists and can be executed. */
2435 check_executable (filename
)
2439 int len
= strlen (filename
);
2442 if (stat (filename
, &st
) < 0)
2444 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
2445 return ((st
.st_mode
& S_IEXEC
) != 0);
2447 return (S_ISREG (st
.st_mode
)
2449 && (xstrcasecmp ((suffix
= filename
+ len
-4), ".com") == 0
2450 || xstrcasecmp (suffix
, ".exe") == 0
2451 || xstrcasecmp (suffix
, ".bat") == 0)
2452 || (st
.st_mode
& S_IFMT
) == S_IFDIR
);
2453 #endif /* not WINDOWSNT */
2454 #else /* not DOS_NT */
2455 #ifdef HAVE_EUIDACCESS
2456 return (euidaccess (filename
, 1) >= 0);
2458 /* Access isn't quite right because it uses the real uid
2459 and we really want to test with the effective uid.
2460 But Unix doesn't give us a right way to do it. */
2461 return (access (filename
, 1) >= 0);
2463 #endif /* not DOS_NT */
2466 /* Return nonzero if file FILENAME exists and can be written. */
2469 check_writable (filename
)
2474 if (stat (filename
, &st
) < 0)
2476 return (st
.st_mode
& S_IWRITE
|| (st
.st_mode
& S_IFMT
) == S_IFDIR
);
2477 #else /* not MSDOS */
2478 #ifdef HAVE_EUIDACCESS
2479 return (euidaccess (filename
, 2) >= 0);
2481 /* Access isn't quite right because it uses the real uid
2482 and we really want to test with the effective uid.
2483 But Unix doesn't give us a right way to do it.
2484 Opening with O_WRONLY could work for an ordinary file,
2485 but would lose for directories. */
2486 return (access (filename
, 2) >= 0);
2488 #endif /* not MSDOS */
2491 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2492 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2493 See also `file-readable-p' and `file-attributes'.
2494 This returns nil for a symlink to a nonexistent file.
2495 Use `file-symlink-p' to test for such links. */)
2497 Lisp_Object filename
;
2499 Lisp_Object absname
;
2500 Lisp_Object handler
;
2501 struct stat statbuf
;
2503 CHECK_STRING (filename
);
2504 absname
= Fexpand_file_name (filename
, Qnil
);
2506 /* If the file name has special constructs in it,
2507 call the corresponding file handler. */
2508 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2509 if (!NILP (handler
))
2510 return call2 (handler
, Qfile_exists_p
, absname
);
2512 absname
= ENCODE_FILE (absname
);
2514 return (stat (SDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2517 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2518 doc
: /* Return t if FILENAME can be executed by you.
2519 For a directory, this means you can access files in that directory. */)
2521 Lisp_Object filename
;
2523 Lisp_Object absname
;
2524 Lisp_Object handler
;
2526 CHECK_STRING (filename
);
2527 absname
= Fexpand_file_name (filename
, Qnil
);
2529 /* If the file name has special constructs in it,
2530 call the corresponding file handler. */
2531 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2532 if (!NILP (handler
))
2533 return call2 (handler
, Qfile_executable_p
, absname
);
2535 absname
= ENCODE_FILE (absname
);
2537 return (check_executable (SDATA (absname
)) ? Qt
: Qnil
);
2540 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2541 doc
: /* Return t if file FILENAME exists and you can read it.
2542 See also `file-exists-p' and `file-attributes'. */)
2544 Lisp_Object filename
;
2546 Lisp_Object absname
;
2547 Lisp_Object handler
;
2550 struct stat statbuf
;
2552 CHECK_STRING (filename
);
2553 absname
= Fexpand_file_name (filename
, Qnil
);
2555 /* If the file name has special constructs in it,
2556 call the corresponding file handler. */
2557 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2558 if (!NILP (handler
))
2559 return call2 (handler
, Qfile_readable_p
, absname
);
2561 absname
= ENCODE_FILE (absname
);
2563 #if defined(DOS_NT) || defined(macintosh)
2564 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2566 if (access (SDATA (absname
), 0) == 0)
2569 #else /* not DOS_NT and not macintosh */
2571 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
2572 /* Opening a fifo without O_NONBLOCK can wait.
2573 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2574 except in the case of a fifo, on a system which handles it. */
2575 desc
= stat (SDATA (absname
), &statbuf
);
2578 if (S_ISFIFO (statbuf
.st_mode
))
2579 flags
|= O_NONBLOCK
;
2581 desc
= emacs_open (SDATA (absname
), flags
, 0);
2586 #endif /* not DOS_NT and not macintosh */
2589 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2591 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2592 doc
: /* Return t if file FILENAME can be written or created by you. */)
2594 Lisp_Object filename
;
2596 Lisp_Object absname
, dir
, encoded
;
2597 Lisp_Object handler
;
2598 struct stat statbuf
;
2600 CHECK_STRING (filename
);
2601 absname
= Fexpand_file_name (filename
, Qnil
);
2603 /* If the file name has special constructs in it,
2604 call the corresponding file handler. */
2605 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2606 if (!NILP (handler
))
2607 return call2 (handler
, Qfile_writable_p
, absname
);
2609 encoded
= ENCODE_FILE (absname
);
2610 if (stat (SDATA (encoded
), &statbuf
) >= 0)
2611 return (check_writable (SDATA (encoded
))
2614 dir
= Ffile_name_directory (absname
);
2617 dir
= Fdirectory_file_name (dir
);
2620 dir
= ENCODE_FILE (dir
);
2622 /* The read-only attribute of the parent directory doesn't affect
2623 whether a file or directory can be created within it. Some day we
2624 should check ACLs though, which do affect this. */
2625 if (stat (SDATA (dir
), &statbuf
) < 0)
2627 return (statbuf
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2629 return (check_writable (!NILP (dir
) ? (char *) SDATA (dir
) : "")
2634 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2635 doc
: /* Access file FILENAME, and get an error if that does not work.
2636 The second argument STRING is used in the error message.
2637 If there is no error, returns nil. */)
2639 Lisp_Object filename
, string
;
2641 Lisp_Object handler
, encoded_filename
, absname
;
2644 CHECK_STRING (filename
);
2645 absname
= Fexpand_file_name (filename
, Qnil
);
2647 CHECK_STRING (string
);
2649 /* If the file name has special constructs in it,
2650 call the corresponding file handler. */
2651 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2652 if (!NILP (handler
))
2653 return call3 (handler
, Qaccess_file
, absname
, string
);
2655 encoded_filename
= ENCODE_FILE (absname
);
2657 fd
= emacs_open (SDATA (encoded_filename
), O_RDONLY
, 0);
2659 report_file_error (SDATA (string
), Fcons (filename
, Qnil
));
2665 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2666 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2667 The value is the link target, as a string.
2668 Otherwise it returns nil.
2670 This function returns t when given the name of a symlink that
2671 points to a nonexistent file. */)
2673 Lisp_Object filename
;
2675 Lisp_Object handler
;
2677 CHECK_STRING (filename
);
2678 filename
= Fexpand_file_name (filename
, Qnil
);
2680 /* If the file name has special constructs in it,
2681 call the corresponding file handler. */
2682 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2683 if (!NILP (handler
))
2684 return call2 (handler
, Qfile_symlink_p
, filename
);
2693 filename
= ENCODE_FILE (filename
);
2700 buf
= (char *) xrealloc (buf
, bufsize
);
2701 bzero (buf
, bufsize
);
2704 valsize
= readlink (SDATA (filename
), buf
, bufsize
);
2708 /* HP-UX reports ERANGE if buffer is too small. */
2709 if (errno
== ERANGE
)
2719 while (valsize
>= bufsize
);
2721 val
= make_string (buf
, valsize
);
2722 if (buf
[0] == '/' && index (buf
, ':'))
2723 val
= concat2 (build_string ("/:"), val
);
2725 val
= DECODE_FILE (val
);
2728 #else /* not S_IFLNK */
2730 #endif /* not S_IFLNK */
2733 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2734 doc
: /* Return t if FILENAME names an existing directory.
2735 Symbolic links to directories count as directories.
2736 See `file-symlink-p' to distinguish symlinks. */)
2738 Lisp_Object filename
;
2740 register Lisp_Object absname
;
2742 Lisp_Object handler
;
2744 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2746 /* If the file name has special constructs in it,
2747 call the corresponding file handler. */
2748 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2749 if (!NILP (handler
))
2750 return call2 (handler
, Qfile_directory_p
, absname
);
2752 absname
= ENCODE_FILE (absname
);
2754 if (stat (SDATA (absname
), &st
) < 0)
2756 return (st
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2759 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
2760 doc
: /* Return t if file FILENAME names a directory you can open.
2761 For the value to be t, FILENAME must specify the name of a directory as a file,
2762 and the directory must allow you to open files in it. In order to use a
2763 directory as a buffer's current directory, this predicate must return true.
2764 A directory name spec may be given instead; then the value is t
2765 if the directory so specified exists and really is a readable and
2766 searchable directory. */)
2768 Lisp_Object filename
;
2770 Lisp_Object handler
;
2772 struct gcpro gcpro1
;
2774 /* If the file name has special constructs in it,
2775 call the corresponding file handler. */
2776 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2777 if (!NILP (handler
))
2778 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2781 tem
= (NILP (Ffile_directory_p (filename
))
2782 || NILP (Ffile_executable_p (filename
)));
2784 return tem
? Qnil
: Qt
;
2787 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2788 doc
: /* Return t if FILENAME names a regular file.
2789 This is the sort of file that holds an ordinary stream of data bytes.
2790 Symbolic links to regular files count as regular files.
2791 See `file-symlink-p' to distinguish symlinks. */)
2793 Lisp_Object filename
;
2795 register Lisp_Object absname
;
2797 Lisp_Object handler
;
2799 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2801 /* If the file name has special constructs in it,
2802 call the corresponding file handler. */
2803 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2804 if (!NILP (handler
))
2805 return call2 (handler
, Qfile_regular_p
, absname
);
2807 absname
= ENCODE_FILE (absname
);
2812 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2814 /* Tell stat to use expensive method to get accurate info. */
2815 Vw32_get_true_file_attributes
= Qt
;
2816 result
= stat (SDATA (absname
), &st
);
2817 Vw32_get_true_file_attributes
= tem
;
2821 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2824 if (stat (SDATA (absname
), &st
) < 0)
2826 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2830 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2831 doc
: /* Return mode bits of file named FILENAME, as an integer.
2832 Return nil, if file does not exist or is not accessible. */)
2834 Lisp_Object filename
;
2836 Lisp_Object absname
;
2838 Lisp_Object handler
;
2840 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2842 /* If the file name has special constructs in it,
2843 call the corresponding file handler. */
2844 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2845 if (!NILP (handler
))
2846 return call2 (handler
, Qfile_modes
, absname
);
2848 absname
= ENCODE_FILE (absname
);
2850 if (stat (SDATA (absname
), &st
) < 0)
2852 #if defined (MSDOS) && __DJGPP__ < 2
2853 if (check_executable (SDATA (absname
)))
2854 st
.st_mode
|= S_IEXEC
;
2855 #endif /* MSDOS && __DJGPP__ < 2 */
2857 return make_number (st
.st_mode
& 07777);
2860 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2861 "(let ((file (read-file-name \"File: \"))) \
2862 (list file (read-file-modes nil file)))",
2863 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2864 Only the 12 low bits of MODE are used.
2866 Interactively, mode bits are read by `read-file-modes', which accepts
2867 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2869 Lisp_Object filename
, mode
;
2871 Lisp_Object absname
, encoded_absname
;
2872 Lisp_Object handler
;
2874 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2875 CHECK_NUMBER (mode
);
2877 /* If the file name has special constructs in it,
2878 call the corresponding file handler. */
2879 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2880 if (!NILP (handler
))
2881 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2883 encoded_absname
= ENCODE_FILE (absname
);
2885 if (chmod (SDATA (encoded_absname
), XINT (mode
)) < 0)
2886 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2891 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2892 doc
: /* Set the file permission bits for newly created files.
2893 The argument MODE should be an integer; only the low 9 bits are used.
2894 This setting is inherited by subprocesses. */)
2898 CHECK_NUMBER (mode
);
2900 umask ((~ XINT (mode
)) & 0777);
2905 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
2906 doc
: /* Return the default file protection for created files.
2907 The value is an integer. */)
2913 realmask
= umask (0);
2916 XSETINT (value
, (~ realmask
) & 0777);
2920 extern int lisp_time_argument
P_ ((Lisp_Object
, time_t *, int *));
2922 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
2923 doc
: /* Set times of file FILENAME to TIME.
2924 Set both access and modification times.
2925 Return t on success, else nil.
2926 Use the current time if TIME is nil. TIME is in the format of
2929 Lisp_Object filename
, time
;
2931 Lisp_Object absname
, encoded_absname
;
2932 Lisp_Object handler
;
2936 if (! lisp_time_argument (time
, &sec
, &usec
))
2937 error ("Invalid time specification");
2939 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2941 /* If the file name has special constructs in it,
2942 call the corresponding file handler. */
2943 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
2944 if (!NILP (handler
))
2945 return call3 (handler
, Qset_file_times
, absname
, time
);
2947 encoded_absname
= ENCODE_FILE (absname
);
2952 EMACS_SET_SECS (t
, sec
);
2953 EMACS_SET_USECS (t
, usec
);
2955 if (set_file_times (SDATA (encoded_absname
), t
, t
))
2960 /* Setting times on a directory always fails. */
2961 if (stat (SDATA (encoded_absname
), &st
) == 0
2962 && (st
.st_mode
& S_IFMT
) == S_IFDIR
)
2965 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
2974 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
2975 doc
: /* Tell Unix to finish all pending disk updates. */)
2982 #endif /* HAVE_SYNC */
2984 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
2985 doc
: /* Return t if file FILE1 is newer than file FILE2.
2986 If FILE1 does not exist, the answer is nil;
2987 otherwise, if FILE2 does not exist, the answer is t. */)
2989 Lisp_Object file1
, file2
;
2991 Lisp_Object absname1
, absname2
;
2994 Lisp_Object handler
;
2995 struct gcpro gcpro1
, gcpro2
;
2997 CHECK_STRING (file1
);
2998 CHECK_STRING (file2
);
3001 GCPRO2 (absname1
, file2
);
3002 absname1
= expand_and_dir_to_file (file1
, current_buffer
->directory
);
3003 absname2
= expand_and_dir_to_file (file2
, current_buffer
->directory
);
3006 /* If the file name has special constructs in it,
3007 call the corresponding file handler. */
3008 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3010 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3011 if (!NILP (handler
))
3012 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3014 GCPRO2 (absname1
, absname2
);
3015 absname1
= ENCODE_FILE (absname1
);
3016 absname2
= ENCODE_FILE (absname2
);
3019 if (stat (SDATA (absname1
), &st
) < 0)
3022 mtime1
= st
.st_mtime
;
3024 if (stat (SDATA (absname2
), &st
) < 0)
3027 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3031 Lisp_Object Qfind_buffer_file_type
;
3034 #ifndef READ_BUF_SIZE
3035 #define READ_BUF_SIZE (64 << 10)
3038 extern void adjust_markers_for_delete
P_ ((int, int, int, int));
3040 /* This function is called after Lisp functions to decide a coding
3041 system are called, or when they cause an error. Before they are
3042 called, the current buffer is set unibyte and it contains only a
3043 newly inserted text (thus the buffer was empty before the
3046 The functions may set markers, overlays, text properties, or even
3047 alter the buffer contents, change the current buffer.
3049 Here, we reset all those changes by:
3050 o set back the current buffer.
3051 o move all markers and overlays to BEG.
3052 o remove all text properties.
3053 o set back the buffer multibyteness. */
3056 decide_coding_unwind (unwind_data
)
3057 Lisp_Object unwind_data
;
3059 Lisp_Object multibyte
, undo_list
, buffer
;
3061 multibyte
= XCAR (unwind_data
);
3062 unwind_data
= XCDR (unwind_data
);
3063 undo_list
= XCAR (unwind_data
);
3064 buffer
= XCDR (unwind_data
);
3066 if (current_buffer
!= XBUFFER (buffer
))
3067 set_buffer_internal (XBUFFER (buffer
));
3068 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3069 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3070 BUF_INTERVALS (current_buffer
) = 0;
3071 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3073 /* Now we are safe to change the buffer's multibyteness directly. */
3074 current_buffer
->enable_multibyte_characters
= multibyte
;
3075 current_buffer
->undo_list
= undo_list
;
3081 /* Used to pass values from insert-file-contents to read_non_regular. */
3083 static int non_regular_fd
;
3084 static int non_regular_inserted
;
3085 static int non_regular_nbytes
;
3088 /* Read from a non-regular file.
3089 Read non_regular_trytry bytes max from non_regular_fd.
3090 Non_regular_inserted specifies where to put the read bytes.
3091 Value is the number of bytes read. */
3100 nbytes
= emacs_read (non_regular_fd
,
3101 BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ non_regular_inserted
,
3102 non_regular_nbytes
);
3104 return make_number (nbytes
);
3108 /* Condition-case handler used when reading from non-regular files
3109 in insert-file-contents. */
3112 read_non_regular_quit ()
3118 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3120 doc
: /* Insert contents of file FILENAME after point.
3121 Returns list of absolute file name and number of characters inserted.
3122 If second argument VISIT is non-nil, the buffer's visited filename and
3123 last save file modtime are set, and it is marked unmodified. If
3124 visiting and the file does not exist, visiting is completed before the
3127 The optional third and fourth arguments BEG and END specify what portion
3128 of the file to insert. These arguments count bytes in the file, not
3129 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3131 If optional fifth argument REPLACE is non-nil, replace the current
3132 buffer contents (in the accessible portion) with the file contents.
3133 This is better than simply deleting and inserting the whole thing
3134 because (1) it preserves some marker positions and (2) it puts less data
3135 in the undo list. When REPLACE is non-nil, the second return value is
3136 the number of characters that replace previous buffer contents.
3138 This function does code conversion according to the value of
3139 `coding-system-for-read' or `file-coding-system-alist', and sets the
3140 variable `last-coding-system-used' to the coding system actually used. */)
3141 (filename
, visit
, beg
, end
, replace
)
3142 Lisp_Object filename
, visit
, beg
, end
, replace
;
3148 register int how_much
;
3149 register int unprocessed
;
3150 int count
= SPECPDL_INDEX ();
3151 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3152 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3155 int not_regular
= 0;
3156 unsigned char read_buf
[READ_BUF_SIZE
];
3157 struct coding_system coding
;
3158 unsigned char buffer
[1 << 14];
3159 int replace_handled
= 0;
3160 int set_coding_system
= 0;
3161 Lisp_Object coding_system
;
3163 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3164 int we_locked_file
= 0;
3165 int deferred_remove_unwind_protect
= 0;
3167 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3168 error ("Cannot do file visiting in an indirect buffer");
3170 if (!NILP (current_buffer
->read_only
))
3171 Fbarf_if_buffer_read_only ();
3175 orig_filename
= Qnil
;
3178 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3180 CHECK_STRING (filename
);
3181 filename
= Fexpand_file_name (filename
, Qnil
);
3183 /* The value Qnil means that the coding system is not yet
3185 coding_system
= Qnil
;
3187 /* If the file name has special constructs in it,
3188 call the corresponding file handler. */
3189 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3190 if (!NILP (handler
))
3192 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3193 visit
, beg
, end
, replace
);
3194 if (CONSP (val
) && CONSP (XCDR (val
)))
3195 inserted
= XINT (XCAR (XCDR (val
)));
3199 orig_filename
= filename
;
3200 filename
= ENCODE_FILE (filename
);
3206 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3208 /* Tell stat to use expensive method to get accurate info. */
3209 Vw32_get_true_file_attributes
= Qt
;
3210 total
= stat (SDATA (filename
), &st
);
3211 Vw32_get_true_file_attributes
= tem
;
3215 if (stat (SDATA (filename
), &st
) < 0)
3216 #endif /* WINDOWSNT */
3218 if (fd
>= 0) emacs_close (fd
);
3221 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3224 if (!NILP (Vcoding_system_for_read
))
3225 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3230 /* This code will need to be changed in order to work on named
3231 pipes, and it's probably just not worth it. So we should at
3232 least signal an error. */
3233 if (!S_ISREG (st
.st_mode
))
3240 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3241 xsignal2 (Qfile_error
,
3242 build_string ("not a regular file"), orig_filename
);
3247 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0)
3250 /* Replacement should preserve point as it preserves markers. */
3251 if (!NILP (replace
))
3252 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3254 record_unwind_protect (close_file_unwind
, make_number (fd
));
3256 /* Can happen on any platform that uses long as type of off_t, but allows
3257 file sizes to exceed 2Gb, so give a suitable message. */
3258 if (! not_regular
&& st
.st_size
< 0)
3259 error ("Maximum buffer size exceeded");
3261 /* Prevent redisplay optimizations. */
3262 current_buffer
->clip_changed
= 1;
3266 if (!NILP (beg
) || !NILP (end
))
3267 error ("Attempt to visit less than an entire file");
3268 if (BEG
< Z
&& NILP (replace
))
3269 error ("Cannot do file visiting in a non-empty buffer");
3275 XSETFASTINT (beg
, 0);
3283 XSETINT (end
, st
.st_size
);
3285 /* Arithmetic overflow can occur if an Emacs integer cannot
3286 represent the file size, or if the calculations below
3287 overflow. The calculations below double the file size
3288 twice, so check that it can be multiplied by 4 safely. */
3289 if (XINT (end
) != st
.st_size
3290 || st
.st_size
> INT_MAX
/ 4)
3291 error ("Maximum buffer size exceeded");
3293 /* The file size returned from stat may be zero, but data
3294 may be readable nonetheless, for example when this is a
3295 file in the /proc filesystem. */
3296 if (st
.st_size
== 0)
3297 XSETINT (end
, READ_BUF_SIZE
);
3301 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3303 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3304 setup_coding_system (coding_system
, &coding
);
3305 /* Ensure we set Vlast_coding_system_used. */
3306 set_coding_system
= 1;
3310 /* Decide the coding system to use for reading the file now
3311 because we can't use an optimized method for handling
3312 `coding:' tag if the current buffer is not empty. */
3313 if (!NILP (Vcoding_system_for_read
))
3314 coding_system
= Vcoding_system_for_read
;
3317 /* Don't try looking inside a file for a coding system
3318 specification if it is not seekable. */
3319 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3321 /* Find a coding system specified in the heading two
3322 lines or in the tailing several lines of the file.
3323 We assume that the 1K-byte and 3K-byte for heading
3324 and tailing respectively are sufficient for this
3328 if (st
.st_size
<= (1024 * 4))
3329 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3332 nread
= emacs_read (fd
, read_buf
, 1024);
3335 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3336 report_file_error ("Setting file position",
3337 Fcons (orig_filename
, Qnil
));
3338 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3343 error ("IO error reading %s: %s",
3344 SDATA (orig_filename
), emacs_strerror (errno
));
3347 struct buffer
*prev
= current_buffer
;
3351 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3353 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3354 buf
= XBUFFER (buffer
);
3356 delete_all_overlays (buf
);
3357 buf
->directory
= current_buffer
->directory
;
3358 buf
->read_only
= Qnil
;
3359 buf
->filename
= Qnil
;
3360 buf
->undo_list
= Qt
;
3361 eassert (buf
->overlays_before
== NULL
);
3362 eassert (buf
->overlays_after
== NULL
);
3364 set_buffer_internal (buf
);
3366 buf
->enable_multibyte_characters
= Qnil
;
3368 insert_1_both (read_buf
, nread
, nread
, 0, 0, 0);
3369 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3370 coding_system
= call2 (Vset_auto_coding_function
,
3371 filename
, make_number (nread
));
3372 set_buffer_internal (prev
);
3374 /* Discard the unwind protect for recovering the
3378 /* Rewind the file for the actual read done later. */
3379 if (lseek (fd
, 0, 0) < 0)
3380 report_file_error ("Setting file position",
3381 Fcons (orig_filename
, Qnil
));
3385 if (NILP (coding_system
))
3387 /* If we have not yet decided a coding system, check
3388 file-coding-system-alist. */
3389 Lisp_Object args
[6];
3391 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3392 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3393 coding_system
= Ffind_operation_coding_system (6, args
);
3394 if (CONSP (coding_system
))
3395 coding_system
= XCAR (coding_system
);
3399 if (NILP (coding_system
))
3400 coding_system
= Qundecided
;
3402 CHECK_CODING_SYSTEM (coding_system
);
3404 if (NILP (current_buffer
->enable_multibyte_characters
))
3405 /* We must suppress all character code conversion except for
3406 end-of-line conversion. */
3407 coding_system
= raw_text_coding_system (coding_system
);
3409 setup_coding_system (coding_system
, &coding
);
3410 /* Ensure we set Vlast_coding_system_used. */
3411 set_coding_system
= 1;
3414 /* If requested, replace the accessible part of the buffer
3415 with the file contents. Avoid replacing text at the
3416 beginning or end of the buffer that matches the file contents;
3417 that preserves markers pointing to the unchanged parts.
3419 Here we implement this feature in an optimized way
3420 for the case where code conversion is NOT needed.
3421 The following if-statement handles the case of conversion
3422 in a less optimal way.
3424 If the code conversion is "automatic" then we try using this
3425 method and hope for the best.
3426 But if we discover the need for conversion, we give up on this method
3427 and let the following if-statement handle the replace job. */
3430 && (NILP (coding_system
)
3431 || ! CODING_REQUIRE_DECODING (&coding
)))
3433 /* same_at_start and same_at_end count bytes,
3434 because file access counts bytes
3435 and BEG and END count bytes. */
3436 int same_at_start
= BEGV_BYTE
;
3437 int same_at_end
= ZV_BYTE
;
3439 /* There is still a possibility we will find the need to do code
3440 conversion. If that happens, we set this variable to 1 to
3441 give up on handling REPLACE in the optimized way. */
3442 int giveup_match_end
= 0;
3444 if (XINT (beg
) != 0)
3446 if (lseek (fd
, XINT (beg
), 0) < 0)
3447 report_file_error ("Setting file position",
3448 Fcons (orig_filename
, Qnil
));
3453 /* Count how many chars at the start of the file
3454 match the text at the beginning of the buffer. */
3459 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3461 error ("IO error reading %s: %s",
3462 SDATA (orig_filename
), emacs_strerror (errno
));
3463 else if (nread
== 0)
3466 if (CODING_REQUIRE_DETECTION (&coding
))
3468 coding_system
= detect_coding_system (buffer
, nread
, nread
, 1, 0,
3470 setup_coding_system (coding_system
, &coding
);
3473 if (CODING_REQUIRE_DECODING (&coding
))
3474 /* We found that the file should be decoded somehow.
3475 Let's give up here. */
3477 giveup_match_end
= 1;
3482 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3483 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3484 same_at_start
++, bufpos
++;
3485 /* If we found a discrepancy, stop the scan.
3486 Otherwise loop around and scan the next bufferful. */
3487 if (bufpos
!= nread
)
3491 /* If the file matches the buffer completely,
3492 there's no need to replace anything. */
3493 if (same_at_start
- BEGV_BYTE
== XINT (end
))
3497 /* Truncate the buffer to the size of the file. */
3498 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3503 /* Count how many chars at the end of the file
3504 match the text at the end of the buffer. But, if we have
3505 already found that decoding is necessary, don't waste time. */
3506 while (!giveup_match_end
)
3508 int total_read
, nread
, bufpos
, curpos
, trial
;
3510 /* At what file position are we now scanning? */
3511 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
3512 /* If the entire file matches the buffer tail, stop the scan. */
3515 /* How much can we scan in the next step? */
3516 trial
= min (curpos
, sizeof buffer
);
3517 if (lseek (fd
, curpos
- trial
, 0) < 0)
3518 report_file_error ("Setting file position",
3519 Fcons (orig_filename
, Qnil
));
3521 total_read
= nread
= 0;
3522 while (total_read
< trial
)
3524 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3526 error ("IO error reading %s: %s",
3527 SDATA (orig_filename
), emacs_strerror (errno
));
3528 else if (nread
== 0)
3530 total_read
+= nread
;
3533 /* Scan this bufferful from the end, comparing with
3534 the Emacs buffer. */
3535 bufpos
= total_read
;
3537 /* Compare with same_at_start to avoid counting some buffer text
3538 as matching both at the file's beginning and at the end. */
3539 while (bufpos
> 0 && same_at_end
> same_at_start
3540 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3541 same_at_end
--, bufpos
--;
3543 /* If we found a discrepancy, stop the scan.
3544 Otherwise loop around and scan the preceding bufferful. */
3547 /* If this discrepancy is because of code conversion,
3548 we cannot use this method; giveup and try the other. */
3549 if (same_at_end
> same_at_start
3550 && FETCH_BYTE (same_at_end
- 1) >= 0200
3551 && ! NILP (current_buffer
->enable_multibyte_characters
)
3552 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3553 giveup_match_end
= 1;
3562 if (! giveup_match_end
)
3566 /* We win! We can handle REPLACE the optimized way. */
3568 /* Extend the start of non-matching text area to multibyte
3569 character boundary. */
3570 if (! NILP (current_buffer
->enable_multibyte_characters
))
3571 while (same_at_start
> BEGV_BYTE
3572 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3575 /* Extend the end of non-matching text area to multibyte
3576 character boundary. */
3577 if (! NILP (current_buffer
->enable_multibyte_characters
))
3578 while (same_at_end
< ZV_BYTE
3579 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3582 /* Don't try to reuse the same piece of text twice. */
3583 overlap
= (same_at_start
- BEGV_BYTE
3584 - (same_at_end
+ st
.st_size
- ZV
));
3586 same_at_end
+= overlap
;
3588 /* Arrange to read only the nonmatching middle part of the file. */
3589 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
3590 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
3592 del_range_byte (same_at_start
, same_at_end
, 0);
3593 /* Insert from the file at the proper position. */
3594 temp
= BYTE_TO_CHAR (same_at_start
);
3595 SET_PT_BOTH (temp
, same_at_start
);
3597 /* If display currently starts at beginning of line,
3598 keep it that way. */
3599 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3600 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3602 replace_handled
= 1;
3606 /* If requested, replace the accessible part of the buffer
3607 with the file contents. Avoid replacing text at the
3608 beginning or end of the buffer that matches the file contents;
3609 that preserves markers pointing to the unchanged parts.
3611 Here we implement this feature for the case where code conversion
3612 is needed, in a simple way that needs a lot of memory.
3613 The preceding if-statement handles the case of no conversion
3614 in a more optimized way. */
3615 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3617 EMACS_INT same_at_start
= BEGV_BYTE
;
3618 EMACS_INT same_at_end
= ZV_BYTE
;
3619 EMACS_INT same_at_start_charpos
;
3620 EMACS_INT inserted_chars
;
3623 unsigned char *decoded
;
3625 int this_count
= SPECPDL_INDEX ();
3626 int multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
3627 Lisp_Object conversion_buffer
;
3629 conversion_buffer
= code_conversion_save (1, multibyte
);
3631 /* First read the whole file, performing code conversion into
3632 CONVERSION_BUFFER. */
3634 if (lseek (fd
, XINT (beg
), 0) < 0)
3635 report_file_error ("Setting file position",
3636 Fcons (orig_filename
, Qnil
));
3638 total
= st
.st_size
; /* Total bytes in the file. */
3639 how_much
= 0; /* Bytes read from file so far. */
3640 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3641 unprocessed
= 0; /* Bytes not processed in previous loop. */
3643 GCPRO1 (conversion_buffer
);
3644 while (how_much
< total
)
3646 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3647 quitting while reading a huge while. */
3648 /* try is reserved in some compilers (Microsoft C) */
3649 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
3652 /* Allow quitting out of the actual I/O. */
3655 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3667 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3668 BUF_Z (XBUFFER (conversion_buffer
)));
3669 decode_coding_c_string (&coding
, read_buf
, unprocessed
+ this,
3671 unprocessed
= coding
.carryover_bytes
;
3672 if (coding
.carryover_bytes
> 0)
3673 bcopy (coding
.carryover
, read_buf
, unprocessed
);
3678 /* We should remove the unwind_protect calling
3679 close_file_unwind, but other stuff has been added the stack,
3680 so defer the removal till we reach the `handled' label. */
3681 deferred_remove_unwind_protect
= 1;
3683 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3684 if we couldn't read the file. */
3687 error ("IO error reading %s: %s",
3688 SDATA (orig_filename
), emacs_strerror (errno
));
3690 if (unprocessed
> 0)
3692 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3693 decode_coding_c_string (&coding
, read_buf
, unprocessed
,
3695 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3698 coding_system
= CODING_ID_NAME (coding
.id
);
3699 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3700 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3701 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3703 /* Compare the beginning of the converted string with the buffer
3707 while (bufpos
< inserted
&& same_at_start
< same_at_end
3708 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3709 same_at_start
++, bufpos
++;
3711 /* If the file matches the head of buffer completely,
3712 there's no need to replace anything. */
3714 if (bufpos
== inserted
)
3716 /* Truncate the buffer to the size of the file. */
3717 if (same_at_start
== same_at_end
)
3720 del_range_byte (same_at_start
, same_at_end
, 0);
3723 unbind_to (this_count
, Qnil
);
3727 /* Extend the start of non-matching text area to the previous
3728 multibyte character boundary. */
3729 if (! NILP (current_buffer
->enable_multibyte_characters
))
3730 while (same_at_start
> BEGV_BYTE
3731 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3734 /* Scan this bufferful from the end, comparing with
3735 the Emacs buffer. */
3738 /* Compare with same_at_start to avoid counting some buffer text
3739 as matching both at the file's beginning and at the end. */
3740 while (bufpos
> 0 && same_at_end
> same_at_start
3741 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3742 same_at_end
--, bufpos
--;
3744 /* Extend the end of non-matching text area to the next
3745 multibyte character boundary. */
3746 if (! NILP (current_buffer
->enable_multibyte_characters
))
3747 while (same_at_end
< ZV_BYTE
3748 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3751 /* Don't try to reuse the same piece of text twice. */
3752 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3754 same_at_end
+= overlap
;
3756 /* If display currently starts at beginning of line,
3757 keep it that way. */
3758 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3759 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3761 /* Replace the chars that we need to replace,
3762 and update INSERTED to equal the number of bytes
3763 we are taking from the decoded string. */
3764 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3766 if (same_at_end
!= same_at_start
)
3768 del_range_byte (same_at_start
, same_at_end
, 0);
3770 same_at_start
= GPT_BYTE
;
3774 temp
= BYTE_TO_CHAR (same_at_start
);
3776 /* Insert from the file at the proper position. */
3777 SET_PT_BOTH (temp
, same_at_start
);
3778 same_at_start_charpos
3779 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3780 same_at_start
- BEGV_BYTE
3781 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3783 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3784 same_at_start
+ inserted
- BEGV_BYTE
3785 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3786 - same_at_start_charpos
);
3787 /* This binding is to avoid ask-user-about-supersession-threat
3788 being called in insert_from_buffer (via in
3789 prepare_to_modify_buffer). */
3790 specbind (intern ("buffer-file-name"), Qnil
);
3791 insert_from_buffer (XBUFFER (conversion_buffer
),
3792 same_at_start_charpos
, inserted_chars
, 0);
3793 /* Set `inserted' to the number of inserted characters. */
3794 inserted
= PT
- temp
;
3795 /* Set point before the inserted characters. */
3796 SET_PT_BOTH (temp
, same_at_start
);
3798 unbind_to (this_count
, Qnil
);
3805 register Lisp_Object temp
;
3807 total
= XINT (end
) - XINT (beg
);
3809 /* Make sure point-max won't overflow after this insertion. */
3810 XSETINT (temp
, total
);
3811 if (total
!= XINT (temp
))
3812 error ("Maximum buffer size exceeded");
3815 /* For a special file, all we can do is guess. */
3816 total
= READ_BUF_SIZE
;
3818 if (NILP (visit
) && inserted
> 0)
3820 #ifdef CLASH_DETECTION
3821 if (!NILP (current_buffer
->file_truename
)
3822 /* Make binding buffer-file-name to nil effective. */
3823 && !NILP (current_buffer
->filename
)
3824 && SAVE_MODIFF
>= MODIFF
)
3826 #endif /* CLASH_DETECTION */
3827 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3831 if (GAP_SIZE
< total
)
3832 make_gap (total
- GAP_SIZE
);
3834 if (XINT (beg
) != 0 || !NILP (replace
))
3836 if (lseek (fd
, XINT (beg
), 0) < 0)
3837 report_file_error ("Setting file position",
3838 Fcons (orig_filename
, Qnil
));
3841 /* In the following loop, HOW_MUCH contains the total bytes read so
3842 far for a regular file, and not changed for a special file. But,
3843 before exiting the loop, it is set to a negative value if I/O
3847 /* Total bytes inserted. */
3850 /* Here, we don't do code conversion in the loop. It is done by
3851 decode_coding_gap after all data are read into the buffer. */
3853 int gap_size
= GAP_SIZE
;
3855 while (how_much
< total
)
3857 /* try is reserved in some compilers (Microsoft C) */
3858 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3865 /* Maybe make more room. */
3866 if (gap_size
< trytry
)
3868 make_gap (total
- gap_size
);
3869 gap_size
= GAP_SIZE
;
3872 /* Read from the file, capturing `quit'. When an
3873 error occurs, end the loop, and arrange for a quit
3874 to be signaled after decoding the text we read. */
3875 non_regular_fd
= fd
;
3876 non_regular_inserted
= inserted
;
3877 non_regular_nbytes
= trytry
;
3878 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
3879 read_non_regular_quit
);
3890 /* Allow quitting out of the actual I/O. We don't make text
3891 part of the buffer until all the reading is done, so a C-g
3892 here doesn't do any harm. */
3895 this = emacs_read (fd
, BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ inserted
, trytry
);
3907 /* For a regular file, where TOTAL is the real size,
3908 count HOW_MUCH to compare with it.
3909 For a special file, where TOTAL is just a buffer size,
3910 so don't bother counting in HOW_MUCH.
3911 (INSERTED is where we count the number of characters inserted.) */
3918 /* Now we have read all the file data into the gap.
3919 If it was empty, undo marking the buffer modified. */
3923 #ifdef CLASH_DETECTION
3925 unlock_file (current_buffer
->file_truename
);
3927 Vdeactivate_mark
= old_Vdeactivate_mark
;
3930 Vdeactivate_mark
= Qt
;
3932 /* Make the text read part of the buffer. */
3933 GAP_SIZE
-= inserted
;
3935 GPT_BYTE
+= inserted
;
3937 ZV_BYTE
+= inserted
;
3942 /* Put an anchor to ensure multi-byte form ends at gap. */
3947 /* Discard the unwind protect for closing the file. */
3951 error ("IO error reading %s: %s",
3952 SDATA (orig_filename
), emacs_strerror (errno
));
3956 if (NILP (coding_system
))
3958 /* The coding system is not yet decided. Decide it by an
3959 optimized method for handling `coding:' tag.
3961 Note that we can get here only if the buffer was empty
3962 before the insertion. */
3964 if (!NILP (Vcoding_system_for_read
))
3965 coding_system
= Vcoding_system_for_read
;
3968 /* Since we are sure that the current buffer was empty
3969 before the insertion, we can toggle
3970 enable-multibyte-characters directly here without taking
3971 care of marker adjustment. By this way, we can run Lisp
3972 program safely before decoding the inserted text. */
3973 Lisp_Object unwind_data
;
3974 int count
= SPECPDL_INDEX ();
3976 unwind_data
= Fcons (current_buffer
->enable_multibyte_characters
,
3977 Fcons (current_buffer
->undo_list
,
3978 Fcurrent_buffer ()));
3979 current_buffer
->enable_multibyte_characters
= Qnil
;
3980 current_buffer
->undo_list
= Qt
;
3981 record_unwind_protect (decide_coding_unwind
, unwind_data
);
3983 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
3985 coding_system
= call2 (Vset_auto_coding_function
,
3986 filename
, make_number (inserted
));
3989 if (NILP (coding_system
))
3991 /* If the coding system is not yet decided, check
3992 file-coding-system-alist. */
3993 Lisp_Object args
[6];
3995 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3996 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
3997 coding_system
= Ffind_operation_coding_system (6, args
);
3998 if (CONSP (coding_system
))
3999 coding_system
= XCAR (coding_system
);
4001 unbind_to (count
, Qnil
);
4002 inserted
= Z_BYTE
- BEG_BYTE
;
4005 if (NILP (coding_system
))
4006 coding_system
= Qundecided
;
4008 CHECK_CODING_SYSTEM (coding_system
);
4010 if (NILP (current_buffer
->enable_multibyte_characters
))
4011 /* We must suppress all character code conversion except for
4012 end-of-line conversion. */
4013 coding_system
= raw_text_coding_system (coding_system
);
4014 setup_coding_system (coding_system
, &coding
);
4015 /* Ensure we set Vlast_coding_system_used. */
4016 set_coding_system
= 1;
4021 /* When we visit a file by raw-text, we change the buffer to
4023 if (CODING_FOR_UNIBYTE (&coding
)
4024 /* Can't do this if part of the buffer might be preserved. */
4026 /* Visiting a file with these coding system makes the buffer
4028 current_buffer
->enable_multibyte_characters
= Qnil
;
4031 coding
.dst_multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
4032 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4033 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4035 move_gap_both (PT
, PT_BYTE
);
4036 GAP_SIZE
+= inserted
;
4037 ZV_BYTE
-= inserted
;
4041 decode_coding_gap (&coding
, inserted
, inserted
);
4042 inserted
= coding
.produced_char
;
4043 coding_system
= CODING_ID_NAME (coding
.id
);
4045 else if (inserted
> 0)
4046 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4049 /* Now INSERTED is measured in characters. */
4052 /* Use the conversion type to determine buffer-file-type
4053 (find-buffer-file-type is now used to help determine the
4055 if ((VECTORP (CODING_ID_EOL_TYPE (coding
.id
))
4056 || EQ (CODING_ID_EOL_TYPE (coding
.id
), Qunix
))
4057 && ! CODING_REQUIRE_DECODING (&coding
))
4058 current_buffer
->buffer_file_type
= Qt
;
4060 current_buffer
->buffer_file_type
= Qnil
;
4065 if (deferred_remove_unwind_protect
)
4066 /* If requested above, discard the unwind protect for closing the
4072 if (!EQ (current_buffer
->undo_list
, Qt
) && !nochange
)
4073 current_buffer
->undo_list
= Qnil
;
4077 current_buffer
->modtime
= st
.st_mtime
;
4078 current_buffer
->filename
= orig_filename
;
4081 SAVE_MODIFF
= MODIFF
;
4082 current_buffer
->auto_save_modified
= MODIFF
;
4083 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4084 #ifdef CLASH_DETECTION
4087 if (!NILP (current_buffer
->file_truename
))
4088 unlock_file (current_buffer
->file_truename
);
4089 unlock_file (filename
);
4091 #endif /* CLASH_DETECTION */
4093 xsignal2 (Qfile_error
,
4094 build_string ("not a regular file"), orig_filename
);
4097 if (set_coding_system
)
4098 Vlast_coding_system_used
= coding_system
;
4100 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4102 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4104 if (! NILP (insval
))
4106 CHECK_NUMBER (insval
);
4107 inserted
= XFASTINT (insval
);
4111 /* Decode file format. */
4114 /* Don't run point motion or modification hooks when decoding. */
4115 int count
= SPECPDL_INDEX ();
4116 int old_inserted
= inserted
;
4117 specbind (Qinhibit_point_motion_hooks
, Qt
);
4118 specbind (Qinhibit_modification_hooks
, Qt
);
4120 /* Save old undo list and don't record undo for decoding. */
4121 old_undo
= current_buffer
->undo_list
;
4122 current_buffer
->undo_list
= Qt
;
4126 insval
= call3 (Qformat_decode
,
4127 Qnil
, make_number (inserted
), visit
);
4128 CHECK_NUMBER (insval
);
4129 inserted
= XFASTINT (insval
);
4133 /* If REPLACE is non-nil and we succeeded in not replacing the
4134 beginning or end of the buffer text with the file's contents,
4135 call format-decode with `point' positioned at the beginning
4136 of the buffer and `inserted' equalling the number of
4137 characters in the buffer. Otherwise, format-decode might
4138 fail to correctly analyze the beginning or end of the buffer.
4139 Hence we temporarily save `point' and `inserted' here and
4140 restore `point' iff format-decode did not insert or delete
4141 any text. Otherwise we leave `point' at point-min. */
4143 int opoint_byte
= PT_BYTE
;
4144 int oinserted
= ZV
- BEGV
;
4145 int ochars_modiff
= CHARS_MODIFF
;
4147 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4148 insval
= call3 (Qformat_decode
,
4149 Qnil
, make_number (oinserted
), visit
);
4150 CHECK_NUMBER (insval
);
4151 if (ochars_modiff
== CHARS_MODIFF
)
4152 /* format_decode didn't modify buffer's characters => move
4153 point back to position before inserted text and leave
4154 value of inserted alone. */
4155 SET_PT_BOTH (opoint
, opoint_byte
);
4157 /* format_decode modified buffer's characters => consider
4158 entire buffer changed and leave point at point-min. */
4159 inserted
= XFASTINT (insval
);
4162 /* For consistency with format-decode call these now iff inserted > 0
4163 (martin 2007-06-28). */
4164 p
= Vafter_insert_file_functions
;
4169 insval
= call1 (XCAR (p
), make_number (inserted
));
4172 CHECK_NUMBER (insval
);
4173 inserted
= XFASTINT (insval
);
4178 /* For the rationale of this see the comment on
4179 format-decode above. */
4181 int opoint_byte
= PT_BYTE
;
4182 int oinserted
= ZV
- BEGV
;
4183 int ochars_modiff
= CHARS_MODIFF
;
4185 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4186 insval
= call1 (XCAR (p
), make_number (oinserted
));
4189 CHECK_NUMBER (insval
);
4190 if (ochars_modiff
== CHARS_MODIFF
)
4191 /* after_insert_file_functions didn't modify
4192 buffer's characters => move point back to
4193 position before inserted text and leave value of
4195 SET_PT_BOTH (opoint
, opoint_byte
);
4197 /* after_insert_file_functions did modify buffer's
4198 characters => consider entire buffer changed and
4199 leave point at point-min. */
4200 inserted
= XFASTINT (insval
);
4210 current_buffer
->undo_list
= old_undo
;
4211 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4213 /* Adjust the last undo record for the size change during
4214 the format conversion. */
4215 Lisp_Object tem
= XCAR (old_undo
);
4216 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4217 && INTEGERP (XCDR (tem
))
4218 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4219 XSETCDR (tem
, make_number (PT
+ inserted
));
4223 /* If undo_list was Qt before, keep it that way.
4224 Otherwise start with an empty undo_list. */
4225 current_buffer
->undo_list
= EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4227 unbind_to (count
, Qnil
);
4230 /* Call after-change hooks for the inserted text, aside from the case
4231 of normal visiting (not with REPLACE), which is done in a new buffer
4232 "before" the buffer is changed. */
4233 if (inserted
> 0 && total
> 0
4234 && (NILP (visit
) || !NILP (replace
)))
4236 signal_after_change (PT
, 0, inserted
);
4237 update_compositions (PT
, PT
, CHECK_BORDER
);
4241 && current_buffer
->modtime
== -1)
4243 /* If visiting nonexistent file, return nil. */
4244 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4248 Fsignal (Qquit
, Qnil
);
4250 /* ??? Retval needs to be dealt with in all cases consistently. */
4252 val
= Fcons (orig_filename
,
4253 Fcons (make_number (inserted
),
4256 RETURN_UNGCPRO (unbind_to (count
, val
));
4259 static Lisp_Object build_annotations
P_ ((Lisp_Object
, Lisp_Object
));
4262 build_annotations_unwind (arg
)
4265 Vwrite_region_annotation_buffers
= arg
;
4269 /* Decide the coding-system to encode the data with. */
4272 choose_write_coding_system (start
, end
, filename
,
4273 append
, visit
, lockname
, coding
)
4274 Lisp_Object start
, end
, filename
, append
, visit
, lockname
;
4275 struct coding_system
*coding
;
4278 Lisp_Object eol_parent
= Qnil
;
4281 && NILP (Fstring_equal (current_buffer
->filename
,
4282 current_buffer
->auto_save_file_name
)))
4287 else if (!NILP (Vcoding_system_for_write
))
4289 val
= Vcoding_system_for_write
;
4290 if (coding_system_require_warning
4291 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4292 /* Confirm that VAL can surely encode the current region. */
4293 val
= call5 (Vselect_safe_coding_system_function
,
4294 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4299 /* If the variable `buffer-file-coding-system' is set locally,
4300 it means that the file was read with some kind of code
4301 conversion or the variable is explicitly set by users. We
4302 had better write it out with the same coding system even if
4303 `enable-multibyte-characters' is nil.
4305 If it is not set locally, we anyway have to convert EOL
4306 format if the default value of `buffer-file-coding-system'
4307 tells that it is not Unix-like (LF only) format. */
4308 int using_default_coding
= 0;
4309 int force_raw_text
= 0;
4311 val
= current_buffer
->buffer_file_coding_system
;
4313 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4316 if (NILP (current_buffer
->enable_multibyte_characters
))
4322 /* Check file-coding-system-alist. */
4323 Lisp_Object args
[7], coding_systems
;
4325 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4326 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4328 coding_systems
= Ffind_operation_coding_system (7, args
);
4329 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4330 val
= XCDR (coding_systems
);
4335 /* If we still have not decided a coding system, use the
4336 default value of buffer-file-coding-system. */
4337 val
= current_buffer
->buffer_file_coding_system
;
4338 using_default_coding
= 1;
4341 if (! NILP (val
) && ! force_raw_text
)
4343 Lisp_Object spec
, attrs
;
4345 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4346 attrs
= AREF (spec
, 0);
4347 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4352 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4353 /* Confirm that VAL can surely encode the current region. */
4354 val
= call5 (Vselect_safe_coding_system_function
,
4355 start
, end
, val
, Qnil
, filename
);
4357 /* If the decided coding-system doesn't specify end-of-line
4358 format, we use that of
4359 `default-buffer-file-coding-system'. */
4360 if (! using_default_coding
4361 && ! NILP (buffer_defaults
.buffer_file_coding_system
))
4362 val
= (coding_inherit_eol_type
4363 (val
, buffer_defaults
.buffer_file_coding_system
));
4365 /* If we decide not to encode text, use `raw-text' or one of its
4368 val
= raw_text_coding_system (val
);
4371 val
= coding_inherit_eol_type (val
, eol_parent
);
4372 setup_coding_system (val
, coding
);
4374 if (!STRINGP (start
) && !NILP (current_buffer
->selective_display
))
4375 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4379 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4380 "r\nFWrite region to file: \ni\ni\ni\np",
4381 doc
: /* Write current region into specified file.
4382 When called from a program, requires three arguments:
4383 START, END and FILENAME. START and END are normally buffer positions
4384 specifying the part of the buffer to write.
4385 If START is nil, that means to use the entire buffer contents.
4386 If START is a string, then output that string to the file
4387 instead of any buffer contents; END is ignored.
4389 Optional fourth argument APPEND if non-nil means
4390 append to existing file contents (if any). If it is an integer,
4391 seek to that offset in the file before writing.
4392 Optional fifth argument VISIT, if t or a string, means
4393 set the last-save-file-modtime of buffer to this file's modtime
4394 and mark buffer not modified.
4395 If VISIT is a string, it is a second file name;
4396 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4397 VISIT is also the file name to lock and unlock for clash detection.
4398 If VISIT is neither t nor nil nor a string,
4399 that means do not display the \"Wrote file\" message.
4400 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4401 use for locking and unlocking, overriding FILENAME and VISIT.
4402 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4403 for an existing file with the same name. If MUSTBENEW is `excl',
4404 that means to get an error if the file already exists; never overwrite.
4405 If MUSTBENEW is neither nil nor `excl', that means ask for
4406 confirmation before overwriting, but do go ahead and overwrite the file
4407 if the user confirms.
4409 This does code conversion according to the value of
4410 `coding-system-for-write', `buffer-file-coding-system', or
4411 `file-coding-system-alist', and sets the variable
4412 `last-coding-system-used' to the coding system actually used.
4414 This calls `write-region-annotate-functions' at the start, and
4415 `write-region-post-annotation-function' at the end. */)
4416 (start
, end
, filename
, append
, visit
, lockname
, mustbenew
)
4417 Lisp_Object start
, end
, filename
, append
, visit
, lockname
, mustbenew
;
4422 const unsigned char *fn
;
4424 int count
= SPECPDL_INDEX ();
4426 Lisp_Object handler
;
4427 Lisp_Object visit_file
;
4428 Lisp_Object annotations
;
4429 Lisp_Object encoded_filename
;
4430 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4431 int quietly
= !NILP (visit
);
4432 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4433 struct buffer
*given_buffer
;
4435 int buffer_file_type
= O_BINARY
;
4437 struct coding_system coding
;
4439 if (current_buffer
->base_buffer
&& visiting
)
4440 error ("Cannot do file visiting in an indirect buffer");
4442 if (!NILP (start
) && !STRINGP (start
))
4443 validate_region (&start
, &end
);
4446 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4448 filename
= Fexpand_file_name (filename
, Qnil
);
4450 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4451 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4453 if (STRINGP (visit
))
4454 visit_file
= Fexpand_file_name (visit
, Qnil
);
4456 visit_file
= filename
;
4458 if (NILP (lockname
))
4459 lockname
= visit_file
;
4463 /* If the file name has special constructs in it,
4464 call the corresponding file handler. */
4465 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4466 /* If FILENAME has no handler, see if VISIT has one. */
4467 if (NILP (handler
) && STRINGP (visit
))
4468 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4470 if (!NILP (handler
))
4473 val
= call6 (handler
, Qwrite_region
, start
, end
,
4474 filename
, append
, visit
);
4478 SAVE_MODIFF
= MODIFF
;
4479 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4480 current_buffer
->filename
= visit_file
;
4486 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4488 /* Special kludge to simplify auto-saving. */
4491 /* Do it later, so write-region-annotate-function can work differently
4492 if we save "the buffer" vs "a region".
4493 This is useful in tar-mode. --Stef
4494 XSETFASTINT (start, BEG);
4495 XSETFASTINT (end, Z); */
4499 record_unwind_protect (build_annotations_unwind
,
4500 Vwrite_region_annotation_buffers
);
4501 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4502 count1
= SPECPDL_INDEX ();
4504 given_buffer
= current_buffer
;
4506 if (!STRINGP (start
))
4508 annotations
= build_annotations (start
, end
);
4510 if (current_buffer
!= given_buffer
)
4512 XSETFASTINT (start
, BEGV
);
4513 XSETFASTINT (end
, ZV
);
4519 XSETFASTINT (start
, BEGV
);
4520 XSETFASTINT (end
, ZV
);
4525 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4527 /* Decide the coding-system to encode the data with.
4528 We used to make this choice before calling build_annotations, but that
4529 leads to problems when a write-annotate-function takes care of
4530 unsavable chars (as was the case with X-Symbol). */
4531 Vlast_coding_system_used
4532 = choose_write_coding_system (start
, end
, filename
,
4533 append
, visit
, lockname
, &coding
);
4535 #ifdef CLASH_DETECTION
4537 lock_file (lockname
);
4538 #endif /* CLASH_DETECTION */
4540 encoded_filename
= ENCODE_FILE (filename
);
4542 fn
= SDATA (encoded_filename
);
4546 desc
= emacs_open (fn
, O_WRONLY
| buffer_file_type
, 0);
4547 #else /* not DOS_NT */
4548 desc
= emacs_open (fn
, O_WRONLY
, 0);
4549 #endif /* not DOS_NT */
4551 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4553 desc
= emacs_open (fn
,
4554 O_WRONLY
| O_CREAT
| buffer_file_type
4555 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4556 S_IREAD
| S_IWRITE
);
4557 #else /* not DOS_NT */
4558 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4559 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4560 auto_saving
? auto_save_mode_bits
: 0666);
4561 #endif /* not DOS_NT */
4565 #ifdef CLASH_DETECTION
4567 if (!auto_saving
) unlock_file (lockname
);
4569 #endif /* CLASH_DETECTION */
4571 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4574 record_unwind_protect (close_file_unwind
, make_number (desc
));
4576 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4580 if (NUMBERP (append
))
4581 ret
= lseek (desc
, XINT (append
), 1);
4583 ret
= lseek (desc
, 0, 2);
4586 #ifdef CLASH_DETECTION
4587 if (!auto_saving
) unlock_file (lockname
);
4588 #endif /* CLASH_DETECTION */
4590 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4599 if (STRINGP (start
))
4601 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4602 &annotations
, &coding
);
4605 else if (XINT (start
) != XINT (end
))
4607 failure
= 0 > a_write (desc
, Qnil
,
4608 XINT (start
), XINT (end
) - XINT (start
),
4609 &annotations
, &coding
);
4614 /* If file was empty, still need to write the annotations */
4615 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4616 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4620 if (CODING_REQUIRE_FLUSHING (&coding
)
4621 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4624 /* We have to flush out a data. */
4625 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4626 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4633 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4634 Disk full in NFS may be reported here. */
4635 /* mib says that closing the file will try to write as fast as NFS can do
4636 it, and that means the fsync here is not crucial for autosave files. */
4637 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4639 /* If fsync fails with EINTR, don't treat that as serious. Also
4640 ignore EINVAL which happens when fsync is not supported on this
4642 if (errno
!= EINTR
&& errno
!= EINVAL
)
4643 failure
= 1, save_errno
= errno
;
4647 /* NFS can report a write failure now. */
4648 if (emacs_close (desc
) < 0)
4649 failure
= 1, save_errno
= errno
;
4653 /* Discard the unwind protect for close_file_unwind. */
4654 specpdl_ptr
= specpdl
+ count1
;
4656 /* Call write-region-post-annotation-function. */
4657 while (CONSP (Vwrite_region_annotation_buffers
))
4659 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4660 if (!NILP (Fbuffer_live_p (buf
)))
4663 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4664 call0 (Vwrite_region_post_annotation_function
);
4666 Vwrite_region_annotation_buffers
4667 = XCDR (Vwrite_region_annotation_buffers
);
4670 unbind_to (count
, Qnil
);
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 Vwrite_region_annotation_buffers
4770 = Fcons (Fcurrent_buffer (),
4771 Vwrite_region_annotation_buffers
);
4772 XSETFASTINT (start
, BEGV
);
4773 XSETFASTINT (end
, ZV
);
4776 Flength (res
); /* Check basic validity of return value */
4777 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4781 /* Now do the same for annotation functions implied by the file-format */
4782 if (auto_saving
&& (!EQ (current_buffer
->auto_save_file_format
, Qt
)))
4783 p
= current_buffer
->auto_save_file_format
;
4785 p
= current_buffer
->file_format
;
4786 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4788 struct buffer
*given_buffer
= current_buffer
;
4790 Vwrite_region_annotations_so_far
= annotations
;
4792 /* Value is either a list of annotations or nil if the function
4793 has written annotations to a temporary buffer, which is now
4795 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4796 original_buffer
, make_number (i
));
4797 if (current_buffer
!= given_buffer
)
4799 XSETFASTINT (start
, BEGV
);
4800 XSETFASTINT (end
, ZV
);
4805 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4813 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4814 If STRING is nil, POS is the character position in the current buffer.
4815 Intersperse with them the annotations from *ANNOT
4816 which fall within the range of POS to POS + NCHARS,
4817 each at its appropriate position.
4819 We modify *ANNOT by discarding elements as we use them up.
4821 The return value is negative in case of system call failure. */
4824 a_write (desc
, string
, pos
, nchars
, annot
, coding
)
4827 register int nchars
;
4830 struct coding_system
*coding
;
4834 int lastpos
= pos
+ nchars
;
4836 while (NILP (*annot
) || CONSP (*annot
))
4838 tem
= Fcar_safe (Fcar (*annot
));
4841 nextpos
= XFASTINT (tem
);
4843 /* If there are no more annotations in this range,
4844 output the rest of the range all at once. */
4845 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4846 return e_write (desc
, string
, pos
, lastpos
, coding
);
4848 /* Output buffer text up to the next annotation's position. */
4851 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4855 /* Output the annotation. */
4856 tem
= Fcdr (Fcar (*annot
));
4859 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4862 *annot
= Fcdr (*annot
);
4868 /* Write text in the range START and END into descriptor DESC,
4869 encoding them with coding system CODING. If STRING is nil, START
4870 and END are character positions of the current buffer, else they
4871 are indexes to the string STRING. */
4874 e_write (desc
, string
, start
, end
, coding
)
4878 struct coding_system
*coding
;
4880 if (STRINGP (string
))
4883 end
= SCHARS (string
);
4886 /* We used to have a code for handling selective display here. But,
4887 now it is handled within encode_coding. */
4891 if (STRINGP (string
))
4893 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
4894 if (CODING_REQUIRE_ENCODING (coding
))
4896 encode_coding_object (coding
, string
,
4897 start
, string_char_to_byte (string
, start
),
4898 end
, string_char_to_byte (string
, end
), Qt
);
4902 coding
->dst_object
= string
;
4903 coding
->consumed_char
= SCHARS (string
);
4904 coding
->produced
= SBYTES (string
);
4909 int start_byte
= CHAR_TO_BYTE (start
);
4910 int end_byte
= CHAR_TO_BYTE (end
);
4912 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
4913 if (CODING_REQUIRE_ENCODING (coding
))
4915 encode_coding_object (coding
, Fcurrent_buffer (),
4916 start
, start_byte
, end
, end_byte
, Qt
);
4920 coding
->dst_object
= Qnil
;
4921 coding
->dst_pos_byte
= start_byte
;
4922 if (start
>= GPT
|| end
<= GPT
)
4924 coding
->consumed_char
= end
- start
;
4925 coding
->produced
= end_byte
- start_byte
;
4929 coding
->consumed_char
= GPT
- start
;
4930 coding
->produced
= GPT_BYTE
- start_byte
;
4935 if (coding
->produced
> 0)
4939 STRINGP (coding
->dst_object
)
4940 ? SDATA (coding
->dst_object
)
4941 : BYTE_POS_ADDR (coding
->dst_pos_byte
),
4944 if (coding
->produced
)
4947 start
+= coding
->consumed_char
;
4953 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
4954 Sverify_visited_file_modtime
, 1, 1, 0,
4955 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
4956 This means that the file has not been changed since it was visited or saved.
4957 See Info node `(elisp)Modification Time' for more details. */)
4963 Lisp_Object handler
;
4964 Lisp_Object filename
;
4969 if (!STRINGP (b
->filename
)) return Qt
;
4970 if (b
->modtime
== 0) return Qt
;
4972 /* If the file name has special constructs in it,
4973 call the corresponding file handler. */
4974 handler
= Ffind_file_name_handler (b
->filename
,
4975 Qverify_visited_file_modtime
);
4976 if (!NILP (handler
))
4977 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
4979 filename
= ENCODE_FILE (b
->filename
);
4981 if (stat (SDATA (filename
), &st
) < 0)
4983 /* If the file doesn't exist now and didn't exist before,
4984 we say that it isn't modified, provided the error is a tame one. */
4985 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
4990 if (st
.st_mtime
== b
->modtime
4991 /* If both are positive, accept them if they are off by one second. */
4992 || (st
.st_mtime
> 0 && b
->modtime
> 0
4993 && (st
.st_mtime
== b
->modtime
+ 1
4994 || st
.st_mtime
== b
->modtime
- 1)))
4999 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5000 Sclear_visited_file_modtime
, 0, 0, 0,
5001 doc
: /* Clear out records of last mod time of visited file.
5002 Next attempt to save will certainly not complain of a discrepancy. */)
5005 current_buffer
->modtime
= 0;
5009 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5010 Svisited_file_modtime
, 0, 0, 0,
5011 doc
: /* Return the current buffer's recorded visited file modification time.
5012 The value is a list of the form (HIGH LOW), like the time values
5013 that `file-attributes' returns. If the current buffer has no recorded
5014 file modification time, this function returns 0.
5015 See Info node `(elisp)Modification Time' for more details. */)
5018 if (! current_buffer
->modtime
)
5019 return make_number (0);
5020 return make_time ((time_t) current_buffer
->modtime
);
5023 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5024 Sset_visited_file_modtime
, 0, 1, 0,
5025 doc
: /* Update buffer's recorded modification time from the visited file's time.
5026 Useful if the buffer was not read from the file normally
5027 or if the file itself has been changed for some known benign reason.
5028 An argument specifies the modification time value to use
5029 \(instead of that of the visited file), in the form of a list
5030 \(HIGH . LOW) or (HIGH LOW). */)
5032 Lisp_Object time_list
;
5034 if (!NILP (time_list
))
5035 current_buffer
->modtime
= cons_to_long (time_list
);
5038 register Lisp_Object filename
;
5040 Lisp_Object handler
;
5042 filename
= Fexpand_file_name (current_buffer
->filename
, Qnil
);
5044 /* If the file name has special constructs in it,
5045 call the corresponding file handler. */
5046 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5047 if (!NILP (handler
))
5048 /* The handler can find the file name the same way we did. */
5049 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5051 filename
= ENCODE_FILE (filename
);
5053 if (stat (SDATA (filename
), &st
) >= 0)
5054 current_buffer
->modtime
= st
.st_mtime
;
5061 auto_save_error (error
)
5064 Lisp_Object args
[3], msg
;
5066 struct gcpro gcpro1
;
5070 auto_save_error_occurred
= 1;
5072 ring_bell (XFRAME (selected_frame
));
5074 args
[0] = build_string ("Auto-saving %s: %s");
5075 args
[1] = current_buffer
->name
;
5076 args
[2] = Ferror_message_string (error
);
5077 msg
= Fformat (3, args
);
5079 nbytes
= SBYTES (msg
);
5080 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5081 bcopy (SDATA (msg
), msgbuf
, nbytes
);
5083 for (i
= 0; i
< 3; ++i
)
5086 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5088 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5089 Fsleep_for (make_number (1), Qnil
);
5103 auto_save_mode_bits
= 0666;
5105 /* Get visited file's mode to become the auto save file's mode. */
5106 if (! NILP (current_buffer
->filename
))
5108 if (stat (SDATA (current_buffer
->filename
), &st
) >= 0)
5109 /* But make sure we can overwrite it later! */
5110 auto_save_mode_bits
= st
.st_mode
| 0600;
5111 else if ((modes
= Ffile_modes (current_buffer
->filename
),
5113 /* Remote files don't cooperate with stat. */
5114 auto_save_mode_bits
= XINT (modes
) | 0600;
5118 Fwrite_region (Qnil
, Qnil
, current_buffer
->auto_save_file_name
, Qnil
,
5119 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5124 do_auto_save_unwind (arg
) /* used as unwind-protect function */
5127 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5139 do_auto_save_unwind_1 (value
) /* used as unwind-protect function */
5142 minibuffer_auto_raise
= XINT (value
);
5147 do_auto_save_make_dir (dir
)
5152 call2 (Qmake_directory
, dir
, Qt
);
5153 XSETFASTINT (mode
, 0700);
5154 return Fset_file_modes (dir
, mode
);
5158 do_auto_save_eh (ignore
)
5164 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5165 doc
: /* Auto-save all buffers that need it.
5166 This is all buffers that have auto-saving enabled
5167 and are changed since last auto-saved.
5168 Auto-saving writes the buffer into a file
5169 so that your editing is not lost if the system crashes.
5170 This file is not the file you visited; that changes only when you save.
5171 Normally we run the normal hook `auto-save-hook' before saving.
5173 A non-nil NO-MESSAGE argument means do not print any message if successful.
5174 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5175 (no_message
, current_only
)
5176 Lisp_Object no_message
, current_only
;
5178 struct buffer
*old
= current_buffer
, *b
;
5179 Lisp_Object tail
, buf
;
5181 int do_handled_files
;
5183 FILE *stream
= NULL
;
5184 int count
= SPECPDL_INDEX ();
5185 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5186 int old_message_p
= 0;
5187 struct gcpro gcpro1
, gcpro2
;
5189 if (max_specpdl_size
< specpdl_size
+ 40)
5190 max_specpdl_size
= specpdl_size
+ 40;
5195 if (NILP (no_message
))
5197 old_message_p
= push_message ();
5198 record_unwind_protect (pop_message_unwind
, Qnil
);
5201 /* Ordinarily don't quit within this function,
5202 but don't make it impossible to quit (in case we get hung in I/O). */
5206 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5207 point to non-strings reached from Vbuffer_alist. */
5209 if (!NILP (Vrun_hooks
))
5210 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5212 if (STRINGP (Vauto_save_list_file_name
))
5214 Lisp_Object listfile
;
5216 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5218 /* Don't try to create the directory when shutting down Emacs,
5219 because creating the directory might signal an error, and
5220 that would leave Emacs in a strange state. */
5221 if (!NILP (Vrun_hooks
))
5225 GCPRO2 (dir
, listfile
);
5226 dir
= Ffile_name_directory (listfile
);
5227 if (NILP (Ffile_directory_p (dir
)))
5228 internal_condition_case_1 (do_auto_save_make_dir
,
5229 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5234 stream
= fopen (SDATA (listfile
), "w");
5237 record_unwind_protect (do_auto_save_unwind
,
5238 make_save_value (stream
, 0));
5239 record_unwind_protect (do_auto_save_unwind_1
,
5240 make_number (minibuffer_auto_raise
));
5241 minibuffer_auto_raise
= 0;
5243 auto_save_error_occurred
= 0;
5245 /* On first pass, save all files that don't have handlers.
5246 On second pass, save all files that do have handlers.
5248 If Emacs is crashing, the handlers may tweak what is causing
5249 Emacs to crash in the first place, and it would be a shame if
5250 Emacs failed to autosave perfectly ordinary files because it
5251 couldn't handle some ange-ftp'd file. */
5253 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5254 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5256 buf
= XCDR (XCAR (tail
));
5259 /* Record all the buffers that have auto save mode
5260 in the special file that lists them. For each of these buffers,
5261 Record visited name (if any) and auto save name. */
5262 if (STRINGP (b
->auto_save_file_name
)
5263 && stream
!= NULL
&& do_handled_files
== 0)
5266 if (!NILP (b
->filename
))
5268 fwrite (SDATA (b
->filename
), 1,
5269 SBYTES (b
->filename
), stream
);
5271 putc ('\n', stream
);
5272 fwrite (SDATA (b
->auto_save_file_name
), 1,
5273 SBYTES (b
->auto_save_file_name
), stream
);
5274 putc ('\n', stream
);
5278 if (!NILP (current_only
)
5279 && b
!= current_buffer
)
5282 /* Don't auto-save indirect buffers.
5283 The base buffer takes care of it. */
5287 /* Check for auto save enabled
5288 and file changed since last auto save
5289 and file changed since last real save. */
5290 if (STRINGP (b
->auto_save_file_name
)
5291 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5292 && b
->auto_save_modified
< BUF_MODIFF (b
)
5293 /* -1 means we've turned off autosaving for a while--see below. */
5294 && XINT (b
->save_length
) >= 0
5295 && (do_handled_files
5296 || NILP (Ffind_file_name_handler (b
->auto_save_file_name
,
5299 EMACS_TIME before_time
, after_time
;
5301 EMACS_GET_TIME (before_time
);
5303 /* If we had a failure, don't try again for 20 minutes. */
5304 if (b
->auto_save_failure_time
>= 0
5305 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5308 if ((XFASTINT (b
->save_length
) * 10
5309 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5310 /* A short file is likely to change a large fraction;
5311 spare the user annoying messages. */
5312 && XFASTINT (b
->save_length
) > 5000
5313 /* These messages are frequent and annoying for `*mail*'. */
5314 && !EQ (b
->filename
, Qnil
)
5315 && NILP (no_message
))
5317 /* It has shrunk too much; turn off auto-saving here. */
5318 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5319 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5321 minibuffer_auto_raise
= 0;
5322 /* Turn off auto-saving until there's a real save,
5323 and prevent any more warnings. */
5324 XSETINT (b
->save_length
, -1);
5325 Fsleep_for (make_number (1), Qnil
);
5328 set_buffer_internal (b
);
5329 if (!auto_saved
&& NILP (no_message
))
5330 message1 ("Auto-saving...");
5331 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5333 b
->auto_save_modified
= BUF_MODIFF (b
);
5334 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5335 set_buffer_internal (old
);
5337 EMACS_GET_TIME (after_time
);
5339 /* If auto-save took more than 60 seconds,
5340 assume it was an NFS failure that got a timeout. */
5341 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5342 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5346 /* Prevent another auto save till enough input events come in. */
5347 record_auto_save ();
5349 if (auto_saved
&& NILP (no_message
))
5353 /* If we are going to restore an old message,
5354 give time to read ours. */
5355 sit_for (make_number (1), 0, 0);
5358 else if (!auto_save_error_occurred
)
5359 /* Don't overwrite the error message if an error occurred.
5360 If we displayed a message and then restored a state
5361 with no message, leave a "done" message on the screen. */
5362 message1 ("Auto-saving...done");
5367 /* This restores the message-stack status. */
5368 unbind_to (count
, Qnil
);
5372 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5373 Sset_buffer_auto_saved
, 0, 0, 0,
5374 doc
: /* Mark current buffer as auto-saved with its current text.
5375 No auto-save file will be written until the buffer changes again. */)
5378 current_buffer
->auto_save_modified
= MODIFF
;
5379 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5380 current_buffer
->auto_save_failure_time
= -1;
5384 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5385 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5386 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5389 current_buffer
->auto_save_failure_time
= -1;
5393 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5395 doc
: /* Return t if current buffer has been auto-saved recently.
5396 More precisely, if it has been auto-saved since last read from or saved
5397 in the visited file. If the buffer has no visited file,
5398 then any auto-save counts as "recent". */)
5401 return (SAVE_MODIFF
< current_buffer
->auto_save_modified
) ? Qt
: Qnil
;
5404 /* Reading and completing file names */
5406 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5407 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5408 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5409 The return value is only relevant for a call to `read-file-name' that happens
5410 before any other event (mouse or keypress) is handled. */)
5413 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5414 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5424 Fread_file_name (prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
)
5425 Lisp_Object prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
;
5427 struct gcpro gcpro1
, gcpro2
;
5428 Lisp_Object args
[7];
5430 GCPRO1 (default_filename
);
5431 args
[0] = intern ("read-file-name");
5434 args
[3] = default_filename
;
5435 args
[4] = mustmatch
;
5437 args
[6] = predicate
;
5438 RETURN_UNGCPRO (Ffuncall (7, args
));
5445 /* Must be set before any path manipulation is performed. */
5446 XSETFASTINT (Vdirectory_sep_char
, '/');
5453 Qoperations
= intern ("operations");
5454 Qexpand_file_name
= intern ("expand-file-name");
5455 Qsubstitute_in_file_name
= intern ("substitute-in-file-name");
5456 Qdirectory_file_name
= intern ("directory-file-name");
5457 Qfile_name_directory
= intern ("file-name-directory");
5458 Qfile_name_nondirectory
= intern ("file-name-nondirectory");
5459 Qunhandled_file_name_directory
= intern ("unhandled-file-name-directory");
5460 Qfile_name_as_directory
= intern ("file-name-as-directory");
5461 Qcopy_file
= intern ("copy-file");
5462 Qmake_directory_internal
= intern ("make-directory-internal");
5463 Qmake_directory
= intern ("make-directory");
5464 Qdelete_directory
= intern ("delete-directory");
5465 Qdelete_file
= intern ("delete-file");
5466 Qrename_file
= intern ("rename-file");
5467 Qadd_name_to_file
= intern ("add-name-to-file");
5468 Qmake_symbolic_link
= intern ("make-symbolic-link");
5469 Qfile_exists_p
= intern ("file-exists-p");
5470 Qfile_executable_p
= intern ("file-executable-p");
5471 Qfile_readable_p
= intern ("file-readable-p");
5472 Qfile_writable_p
= intern ("file-writable-p");
5473 Qfile_symlink_p
= intern ("file-symlink-p");
5474 Qaccess_file
= intern ("access-file");
5475 Qfile_directory_p
= intern ("file-directory-p");
5476 Qfile_regular_p
= intern ("file-regular-p");
5477 Qfile_accessible_directory_p
= intern ("file-accessible-directory-p");
5478 Qfile_modes
= intern ("file-modes");
5479 Qset_file_modes
= intern ("set-file-modes");
5480 Qset_file_times
= intern ("set-file-times");
5481 Qfile_newer_than_file_p
= intern ("file-newer-than-file-p");
5482 Qinsert_file_contents
= intern ("insert-file-contents");
5483 Qwrite_region
= intern ("write-region");
5484 Qverify_visited_file_modtime
= intern ("verify-visited-file-modtime");
5485 Qset_visited_file_modtime
= intern ("set-visited-file-modtime");
5486 Qauto_save_coding
= intern ("auto-save-coding");
5488 staticpro (&Qoperations
);
5489 staticpro (&Qexpand_file_name
);
5490 staticpro (&Qsubstitute_in_file_name
);
5491 staticpro (&Qdirectory_file_name
);
5492 staticpro (&Qfile_name_directory
);
5493 staticpro (&Qfile_name_nondirectory
);
5494 staticpro (&Qunhandled_file_name_directory
);
5495 staticpro (&Qfile_name_as_directory
);
5496 staticpro (&Qcopy_file
);
5497 staticpro (&Qmake_directory_internal
);
5498 staticpro (&Qmake_directory
);
5499 staticpro (&Qdelete_directory
);
5500 staticpro (&Qdelete_file
);
5501 staticpro (&Qrename_file
);
5502 staticpro (&Qadd_name_to_file
);
5503 staticpro (&Qmake_symbolic_link
);
5504 staticpro (&Qfile_exists_p
);
5505 staticpro (&Qfile_executable_p
);
5506 staticpro (&Qfile_readable_p
);
5507 staticpro (&Qfile_writable_p
);
5508 staticpro (&Qaccess_file
);
5509 staticpro (&Qfile_symlink_p
);
5510 staticpro (&Qfile_directory_p
);
5511 staticpro (&Qfile_regular_p
);
5512 staticpro (&Qfile_accessible_directory_p
);
5513 staticpro (&Qfile_modes
);
5514 staticpro (&Qset_file_modes
);
5515 staticpro (&Qset_file_times
);
5516 staticpro (&Qfile_newer_than_file_p
);
5517 staticpro (&Qinsert_file_contents
);
5518 staticpro (&Qwrite_region
);
5519 staticpro (&Qverify_visited_file_modtime
);
5520 staticpro (&Qset_visited_file_modtime
);
5521 staticpro (&Qauto_save_coding
);
5523 Qfile_name_history
= intern ("file-name-history");
5524 Fset (Qfile_name_history
, Qnil
);
5525 staticpro (&Qfile_name_history
);
5527 Qfile_error
= intern ("file-error");
5528 staticpro (&Qfile_error
);
5529 Qfile_already_exists
= intern ("file-already-exists");
5530 staticpro (&Qfile_already_exists
);
5531 Qfile_date_error
= intern ("file-date-error");
5532 staticpro (&Qfile_date_error
);
5533 Qexcl
= intern ("excl");
5537 Qfind_buffer_file_type
= intern ("find-buffer-file-type");
5538 staticpro (&Qfind_buffer_file_type
);
5541 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system
,
5542 doc
: /* *Coding system for encoding file names.
5543 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5544 Vfile_name_coding_system
= Qnil
;
5546 DEFVAR_LISP ("default-file-name-coding-system",
5547 &Vdefault_file_name_coding_system
,
5548 doc
: /* Default coding system for encoding file names.
5549 This variable is used only when `file-name-coding-system' is nil.
5551 This variable is set/changed by the command `set-language-environment'.
5552 User should not set this variable manually,
5553 instead use `file-name-coding-system' to get a constant encoding
5554 of file names regardless of the current language environment. */);
5555 Vdefault_file_name_coding_system
= Qnil
;
5557 Qformat_decode
= intern ("format-decode");
5558 staticpro (&Qformat_decode
);
5559 Qformat_annotate_function
= intern ("format-annotate-function");
5560 staticpro (&Qformat_annotate_function
);
5561 Qafter_insert_file_set_coding
= intern ("after-insert-file-set-coding");
5562 staticpro (&Qafter_insert_file_set_coding
);
5564 Qcar_less_than_car
= intern ("car-less-than-car");
5565 staticpro (&Qcar_less_than_car
);
5567 Fput (Qfile_error
, Qerror_conditions
,
5568 list2 (Qfile_error
, Qerror
));
5569 Fput (Qfile_error
, Qerror_message
,
5570 build_string ("File error"));
5572 Fput (Qfile_already_exists
, Qerror_conditions
,
5573 list3 (Qfile_already_exists
, Qfile_error
, Qerror
));
5574 Fput (Qfile_already_exists
, Qerror_message
,
5575 build_string ("File already exists"));
5577 Fput (Qfile_date_error
, Qerror_conditions
,
5578 list3 (Qfile_date_error
, Qfile_error
, Qerror
));
5579 Fput (Qfile_date_error
, Qerror_message
,
5580 build_string ("Cannot set file date"));
5582 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char
,
5583 doc
: /* Directory separator character for built-in functions that return file names.
5584 The value is always ?/. Don't use this variable, just use `/'. */);
5586 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist
,
5587 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
5588 If a file name matches REGEXP, then all I/O on that file is done by calling
5591 The first argument given to HANDLER is the name of the I/O primitive
5592 to be handled; the remaining arguments are the arguments that were
5593 passed to that primitive. For example, if you do
5594 (file-exists-p FILENAME)
5595 and FILENAME is handled by HANDLER, then HANDLER is called like this:
5596 (funcall HANDLER 'file-exists-p FILENAME)
5597 The function `find-file-name-handler' checks this list for a handler
5598 for its argument. */);
5599 Vfile_name_handler_alist
= Qnil
;
5601 DEFVAR_LISP ("set-auto-coding-function",
5602 &Vset_auto_coding_function
,
5603 doc
: /* If non-nil, a function to call to decide a coding system of file.
5604 Two arguments are passed to this function: the file name
5605 and the length of a file contents following the point.
5606 This function should return a coding system to decode the file contents.
5607 It should check the file name against `auto-coding-alist'.
5608 If no coding system is decided, it should check a coding system
5609 specified in the heading lines with the format:
5610 -*- ... coding: CODING-SYSTEM; ... -*-
5611 or local variable spec of the tailing lines with `coding:' tag. */);
5612 Vset_auto_coding_function
= Qnil
;
5614 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions
,
5615 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5616 Each is passed one argument, the number of characters inserted,
5617 with point at the start of the inserted text. Each function
5618 should leave point the same, and return the new character count.
5619 If `insert-file-contents' is intercepted by a handler from
5620 `file-name-handler-alist', that handler is responsible for calling the
5621 functions in `after-insert-file-functions' if appropriate. */);
5622 Vafter_insert_file_functions
= Qnil
;
5624 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions
,
5625 doc
: /* A list of functions to be called at the start of `write-region'.
5626 Each is passed two arguments, START and END as for `write-region'.
5627 These are usually two numbers but not always; see the documentation
5628 for `write-region'. The function should return a list of pairs
5629 of the form (POSITION . STRING), consisting of strings to be effectively
5630 inserted at the specified positions of the file being written (1 means to
5631 insert before the first byte written). The POSITIONs must be sorted into
5634 If there are several annotation functions, the lists returned by these
5635 functions are merged destructively. As each annotation function runs,
5636 the variable `write-region-annotations-so-far' contains a list of all
5637 annotations returned by previous annotation functions.
5639 An annotation function can return with a different buffer current.
5640 Doing so removes the annotations returned by previous functions, and
5641 resets START and END to `point-min' and `point-max' of the new buffer.
5643 After `write-region' completes, Emacs calls the function stored in
5644 `write-region-post-annotation-function', once for each buffer that was
5645 current when building the annotations (i.e., at least once), with that
5646 buffer current. */);
5647 Vwrite_region_annotate_functions
= Qnil
;
5648 staticpro (&Qwrite_region_annotate_functions
);
5649 Qwrite_region_annotate_functions
5650 = intern ("write-region-annotate-functions");
5652 DEFVAR_LISP ("write-region-post-annotation-function",
5653 &Vwrite_region_post_annotation_function
,
5654 doc
: /* Function to call after `write-region' completes.
5655 The function is called with no arguments. If one or more of the
5656 annotation functions in `write-region-annotate-functions' changed the
5657 current buffer, the function stored in this variable is called for
5658 each of those additional buffers as well, in addition to the original
5659 buffer. The relevant buffer is current during each function call. */);
5660 Vwrite_region_post_annotation_function
= Qnil
;
5661 staticpro (&Vwrite_region_annotation_buffers
);
5663 DEFVAR_LISP ("write-region-annotations-so-far",
5664 &Vwrite_region_annotations_so_far
,
5665 doc
: /* When an annotation function is called, this holds the previous annotations.
5666 These are the annotations made by other annotation functions
5667 that were already called. See also `write-region-annotate-functions'. */);
5668 Vwrite_region_annotations_so_far
= Qnil
;
5670 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers
,
5671 doc
: /* A list of file name handlers that temporarily should not be used.
5672 This applies only to the operation `inhibit-file-name-operation'. */);
5673 Vinhibit_file_name_handlers
= Qnil
;
5675 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation
,
5676 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5677 Vinhibit_file_name_operation
= Qnil
;
5679 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name
,
5680 doc
: /* File name in which we write a list of all auto save file names.
5681 This variable is initialized automatically from `auto-save-list-file-prefix'
5682 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5683 a non-nil value. */);
5684 Vauto_save_list_file_name
= Qnil
;
5686 DEFVAR_LISP ("auto-save-visited-file-name", &Vauto_save_visited_file_name
,
5687 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5688 Normally auto-save files are written under other names. */);
5689 Vauto_save_visited_file_name
= Qnil
;
5692 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync
,
5693 doc
: /* *Non-nil means don't call fsync in `write-region'.
5694 This variable affects calls to `write-region' as well as save commands.
5695 A non-nil value may result in data loss! */);
5696 write_region_inhibit_fsync
= 0;
5699 DEFVAR_BOOL ("delete-by-moving-to-trash", &delete_by_moving_to_trash
,
5700 doc
: /* Specifies whether to use the system's trash can.
5701 When non-nil, the function `move-file-to-trash' will be used by
5702 `delete-file' and `delete-directory'. */);
5703 delete_by_moving_to_trash
= 0;
5704 Qdelete_by_moving_to_trash
= intern ("delete-by-moving-to-trash");
5705 Qmove_file_to_trash
= intern ("move-file-to-trash");
5706 staticpro (&Qmove_file_to_trash
);
5708 defsubr (&Sfind_file_name_handler
);
5709 defsubr (&Sfile_name_directory
);
5710 defsubr (&Sfile_name_nondirectory
);
5711 defsubr (&Sunhandled_file_name_directory
);
5712 defsubr (&Sfile_name_as_directory
);
5713 defsubr (&Sdirectory_file_name
);
5714 defsubr (&Smake_temp_name
);
5715 defsubr (&Sexpand_file_name
);
5716 defsubr (&Ssubstitute_in_file_name
);
5717 defsubr (&Scopy_file
);
5718 defsubr (&Smake_directory_internal
);
5719 defsubr (&Sdelete_directory
);
5720 defsubr (&Sdelete_file
);
5721 defsubr (&Srename_file
);
5722 defsubr (&Sadd_name_to_file
);
5723 defsubr (&Smake_symbolic_link
);
5724 defsubr (&Sfile_name_absolute_p
);
5725 defsubr (&Sfile_exists_p
);
5726 defsubr (&Sfile_executable_p
);
5727 defsubr (&Sfile_readable_p
);
5728 defsubr (&Sfile_writable_p
);
5729 defsubr (&Saccess_file
);
5730 defsubr (&Sfile_symlink_p
);
5731 defsubr (&Sfile_directory_p
);
5732 defsubr (&Sfile_accessible_directory_p
);
5733 defsubr (&Sfile_regular_p
);
5734 defsubr (&Sfile_modes
);
5735 defsubr (&Sset_file_modes
);
5736 defsubr (&Sset_file_times
);
5737 defsubr (&Sset_default_file_modes
);
5738 defsubr (&Sdefault_file_modes
);
5739 defsubr (&Sfile_newer_than_file_p
);
5740 defsubr (&Sinsert_file_contents
);
5741 defsubr (&Swrite_region
);
5742 defsubr (&Scar_less_than_car
);
5743 defsubr (&Sverify_visited_file_modtime
);
5744 defsubr (&Sclear_visited_file_modtime
);
5745 defsubr (&Svisited_file_modtime
);
5746 defsubr (&Sset_visited_file_modtime
);
5747 defsubr (&Sdo_auto_save
);
5748 defsubr (&Sset_buffer_auto_saved
);
5749 defsubr (&Sclear_buffer_auto_save_failure
);
5750 defsubr (&Srecent_auto_save_p
);
5752 defsubr (&Snext_read_file_uses_dialog_p
);
5755 defsubr (&Sunix_sync
);
5759 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
5760 (do not change this comment) */