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;
1634 Lisp_Object handler
;
1636 CHECK_STRING (filename
);
1638 multibyte
= STRING_MULTIBYTE (filename
);
1640 /* If the file name has special constructs in it,
1641 call the corresponding file handler. */
1642 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
1643 if (!NILP (handler
))
1644 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
1646 nm
= SDATA (filename
);
1647 /* Always work on a copy of the string, in case GC happens during
1648 decode of environment variables, causing the original Lisp_String
1649 data to be relocated. */
1650 nm
= strcpy (alloca (strlen (nm
) + 1), nm
);
1652 CORRECT_DIR_SEPS (nm
);
1653 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
1655 endp
= nm
+ SBYTES (filename
);
1657 /* If /~ or // appears, discard everything through first slash. */
1658 p
= search_embedded_absfilename (nm
, endp
);
1660 /* Start over with the new string, so we check the file-name-handler
1661 again. Important with filenames like "/home/foo//:/hello///there"
1662 which whould substitute to "/:/hello///there" rather than "/there". */
1663 return Fsubstitute_in_file_name
1664 (make_specified_string (p
, -1, endp
- p
, multibyte
));
1666 /* See if any variables are substituted into the string
1667 and find the total length of their values in `total' */
1669 for (p
= nm
; p
!= endp
;)
1679 /* "$$" means a single "$" */
1688 while (p
!= endp
&& *p
!= '}') p
++;
1689 if (*p
!= '}') goto missingclose
;
1695 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1699 /* Copy out the variable name */
1700 target
= (unsigned char *) alloca (s
- o
+ 1);
1701 strncpy (target
, o
, s
- o
);
1704 strupr (target
); /* $home == $HOME etc. */
1707 /* Get variable value */
1708 o
= (unsigned char *) egetenv (target
);
1711 /* Don't try to guess a maximum length - UTF8 can use up to
1712 four bytes per character. This code is unlikely to run
1713 in a situation that requires performance, so decoding the
1714 env variables twice should be acceptable. Note that
1715 decoding may cause a garbage collect. */
1716 Lisp_Object orig
, decoded
;
1717 orig
= make_unibyte_string (o
, strlen (o
));
1718 decoded
= DECODE_FILE (orig
);
1719 total
+= SBYTES (decoded
);
1729 /* If substitution required, recopy the string and do it */
1730 /* Make space in stack frame for the new copy */
1731 xnm
= (unsigned char *) alloca (SBYTES (filename
) + total
+ 1);
1734 /* Copy the rest of the name through, replacing $ constructs with values */
1751 while (p
!= endp
&& *p
!= '}') p
++;
1752 if (*p
!= '}') goto missingclose
;
1758 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
1762 /* Copy out the variable name */
1763 target
= (unsigned char *) alloca (s
- o
+ 1);
1764 strncpy (target
, o
, s
- o
);
1767 strupr (target
); /* $home == $HOME etc. */
1770 /* Get variable value */
1771 o
= (unsigned char *) egetenv (target
);
1775 strcpy (x
, target
); x
+= strlen (target
);
1779 Lisp_Object orig
, decoded
;
1780 int orig_length
, decoded_length
;
1781 orig_length
= strlen (o
);
1782 orig
= make_unibyte_string (o
, orig_length
);
1783 decoded
= DECODE_FILE (orig
);
1784 decoded_length
= SBYTES (decoded
);
1785 strncpy (x
, SDATA (decoded
), decoded_length
);
1786 x
+= decoded_length
;
1788 /* If environment variable needed decoding, return value
1789 needs to be multibyte. */
1790 if (decoded_length
!= orig_length
1791 || strncmp (SDATA (decoded
), o
, orig_length
))
1798 /* If /~ or // appears, discard everything through first slash. */
1799 while ((p
= search_embedded_absfilename (xnm
, x
)))
1800 /* This time we do not start over because we've already expanded envvars
1801 and replaced $$ with $. Maybe we should start over as well, but we'd
1802 need to quote some $ to $$ first. */
1805 return make_specified_string (xnm
, -1, x
- xnm
, multibyte
);
1808 error ("Bad format environment-variable substitution");
1810 error ("Missing \"}\" in environment-variable substitution");
1812 error ("Substituting nonexistent environment variable \"%s\"", target
);
1818 /* A slightly faster and more convenient way to get
1819 (directory-file-name (expand-file-name FOO)). */
1822 expand_and_dir_to_file (filename
, defdir
)
1823 Lisp_Object filename
, defdir
;
1825 register Lisp_Object absname
;
1827 absname
= Fexpand_file_name (filename
, defdir
);
1829 /* Remove final slash, if any (unless this is the root dir).
1830 stat behaves differently depending! */
1831 if (SCHARS (absname
) > 1
1832 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
1833 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
1834 /* We cannot take shortcuts; they might be wrong for magic file names. */
1835 absname
= Fdirectory_file_name (absname
);
1839 /* Signal an error if the file ABSNAME already exists.
1840 If INTERACTIVE is nonzero, ask the user whether to proceed,
1841 and bypass the error if the user says to go ahead.
1842 QUERYSTRING is a name for the action that is being considered
1845 *STATPTR is used to store the stat information if the file exists.
1846 If the file does not exist, STATPTR->st_mode is set to 0.
1847 If STATPTR is null, we don't store into it.
1849 If QUICK is nonzero, we ask for y or n, not yes or no. */
1852 barf_or_query_if_file_exists (absname
, querystring
, interactive
, statptr
, quick
)
1853 Lisp_Object absname
;
1854 unsigned char *querystring
;
1856 struct stat
*statptr
;
1859 register Lisp_Object tem
, encoded_filename
;
1860 struct stat statbuf
;
1861 struct gcpro gcpro1
;
1863 encoded_filename
= ENCODE_FILE (absname
);
1865 /* stat is a good way to tell whether the file exists,
1866 regardless of what access permissions it has. */
1867 if (lstat (SDATA (encoded_filename
), &statbuf
) >= 0)
1870 xsignal2 (Qfile_already_exists
,
1871 build_string ("File already exists"), absname
);
1873 tem
= format2 ("File %s already exists; %s anyway? ",
1874 absname
, build_string (querystring
));
1876 tem
= Fy_or_n_p (tem
);
1878 tem
= do_yes_or_no_p (tem
);
1881 xsignal2 (Qfile_already_exists
,
1882 build_string ("File already exists"), absname
);
1889 statptr
->st_mode
= 0;
1894 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 5,
1895 "fCopy file: \nGCopy %s to file: \np\nP",
1896 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
1897 If NEWNAME names a directory, copy FILE there.
1899 This function always sets the file modes of the output file to match
1902 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1903 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1904 signal a `file-already-exists' error without overwriting. If
1905 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1906 about overwriting; this is what happens in interactive use with M-x.
1907 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1910 Fourth arg KEEP-TIME non-nil means give the output file the same
1911 last-modified time as the old one. (This works on only some systems.)
1913 A prefix arg makes KEEP-TIME non-nil.
1915 If PRESERVE-UID-GID is non-nil, we try to transfer the
1916 uid and gid of FILE to NEWNAME. */)
1917 (file
, newname
, ok_if_already_exists
, keep_time
, preserve_uid_gid
)
1918 Lisp_Object file
, newname
, ok_if_already_exists
, keep_time
;
1919 Lisp_Object preserve_uid_gid
;
1922 char buf
[16 * 1024];
1923 struct stat st
, out_st
;
1924 Lisp_Object handler
;
1925 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1926 int count
= SPECPDL_INDEX ();
1927 int input_file_statable_p
;
1928 Lisp_Object encoded_file
, encoded_newname
;
1930 encoded_file
= encoded_newname
= Qnil
;
1931 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
1932 CHECK_STRING (file
);
1933 CHECK_STRING (newname
);
1935 if (!NILP (Ffile_directory_p (newname
)))
1936 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
1938 newname
= Fexpand_file_name (newname
, Qnil
);
1940 file
= Fexpand_file_name (file
, Qnil
);
1942 /* If the input file name has special constructs in it,
1943 call the corresponding file handler. */
1944 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
1945 /* Likewise for output file name. */
1947 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
1948 if (!NILP (handler
))
1949 RETURN_UNGCPRO (call6 (handler
, Qcopy_file
, file
, newname
,
1950 ok_if_already_exists
, keep_time
, preserve_uid_gid
));
1952 encoded_file
= ENCODE_FILE (file
);
1953 encoded_newname
= ENCODE_FILE (newname
);
1955 if (NILP (ok_if_already_exists
)
1956 || INTEGERP (ok_if_already_exists
))
1957 barf_or_query_if_file_exists (newname
, "copy to it",
1958 INTEGERP (ok_if_already_exists
), &out_st
, 0);
1959 else if (stat (SDATA (encoded_newname
), &out_st
) < 0)
1963 if (!CopyFile (SDATA (encoded_file
),
1964 SDATA (encoded_newname
),
1966 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
1967 /* CopyFile retains the timestamp by default. */
1968 else if (NILP (keep_time
))
1974 EMACS_GET_TIME (now
);
1975 filename
= SDATA (encoded_newname
);
1977 /* Ensure file is writable while its modified time is set. */
1978 attributes
= GetFileAttributes (filename
);
1979 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
1980 if (set_file_times (filename
, now
, now
))
1982 /* Restore original attributes. */
1983 SetFileAttributes (filename
, attributes
);
1984 xsignal2 (Qfile_date_error
,
1985 build_string ("Cannot set file date"), newname
);
1987 /* Restore original attributes. */
1988 SetFileAttributes (filename
, attributes
);
1990 #else /* not WINDOWSNT */
1992 ifd
= emacs_open (SDATA (encoded_file
), O_RDONLY
, 0);
1996 report_file_error ("Opening input file", Fcons (file
, Qnil
));
1998 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2000 /* We can only copy regular files and symbolic links. Other files are not
2002 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
2004 #if !defined (MSDOS) || __DJGPP__ > 1
2005 if (out_st
.st_mode
!= 0
2006 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2009 report_file_error ("Input and output files are the same",
2010 Fcons (file
, Fcons (newname
, Qnil
)));
2014 #if defined (S_ISREG) && defined (S_ISLNK)
2015 if (input_file_statable_p
)
2017 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
2019 #if defined (EISDIR)
2020 /* Get a better looking error message. */
2023 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2026 #endif /* S_ISREG && S_ISLNK */
2029 /* System's default file type was set to binary by _fmode in emacs.c. */
2030 ofd
= emacs_open (SDATA (encoded_newname
),
2031 O_WRONLY
| O_TRUNC
| O_CREAT
2032 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2033 S_IREAD
| S_IWRITE
);
2034 #else /* not MSDOS */
2035 ofd
= emacs_open (SDATA (encoded_newname
),
2036 O_WRONLY
| O_TRUNC
| O_CREAT
2037 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2039 #endif /* not MSDOS */
2041 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2043 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2047 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2048 if (emacs_write (ofd
, buf
, n
) != n
)
2049 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2053 /* Preserve the original file modes, and if requested, also its
2055 if (input_file_statable_p
)
2057 if (! NILP (preserve_uid_gid
))
2058 fchown (ofd
, st
.st_uid
, st
.st_gid
);
2059 fchmod (ofd
, st
.st_mode
& 07777);
2061 #endif /* not MSDOS */
2063 /* Closing the output clobbers the file times on some systems. */
2064 if (emacs_close (ofd
) < 0)
2065 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2067 if (input_file_statable_p
)
2069 if (!NILP (keep_time
))
2071 EMACS_TIME atime
, mtime
;
2072 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
2073 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
2074 if (set_file_times (SDATA (encoded_newname
),
2076 xsignal2 (Qfile_date_error
,
2077 build_string ("Cannot set file date"), newname
);
2083 #if defined (__DJGPP__) && __DJGPP__ > 1
2084 if (input_file_statable_p
)
2086 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2087 and if it can't, it tells so. Otherwise, under MSDOS we usually
2088 get only the READ bit, which will make the copied file read-only,
2089 so it's better not to chmod at all. */
2090 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2091 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2093 #endif /* DJGPP version 2 or newer */
2094 #endif /* not WINDOWSNT */
2096 /* Discard the unwind protects. */
2097 specpdl_ptr
= specpdl
+ count
;
2103 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2104 Smake_directory_internal
, 1, 1, 0,
2105 doc
: /* Create a new directory named DIRECTORY. */)
2107 Lisp_Object directory
;
2109 const unsigned char *dir
;
2110 Lisp_Object handler
;
2111 Lisp_Object encoded_dir
;
2113 CHECK_STRING (directory
);
2114 directory
= Fexpand_file_name (directory
, Qnil
);
2116 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2117 if (!NILP (handler
))
2118 return call2 (handler
, Qmake_directory_internal
, directory
);
2120 encoded_dir
= ENCODE_FILE (directory
);
2122 dir
= SDATA (encoded_dir
);
2125 if (mkdir (dir
) != 0)
2127 if (mkdir (dir
, 0777) != 0)
2129 report_file_error ("Creating directory", list1 (directory
));
2134 DEFUN ("delete-directory", Fdelete_directory
, Sdelete_directory
, 1, 1, "FDelete directory: ",
2135 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2137 Lisp_Object directory
;
2139 const unsigned char *dir
;
2140 Lisp_Object handler
;
2141 Lisp_Object encoded_dir
;
2143 CHECK_STRING (directory
);
2144 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2146 handler
= Ffind_file_name_handler (directory
, Qdelete_directory
);
2147 if (!NILP (handler
))
2148 return call2 (handler
, Qdelete_directory
, directory
);
2150 if (delete_by_moving_to_trash
)
2151 return call1 (Qmove_file_to_trash
, directory
);
2153 encoded_dir
= ENCODE_FILE (directory
);
2155 dir
= SDATA (encoded_dir
);
2157 if (rmdir (dir
) != 0)
2158 report_file_error ("Removing directory", list1 (directory
));
2163 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 1, "fDelete file: ",
2164 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2165 If file has multiple names, it continues to exist with the other names. */)
2167 Lisp_Object filename
;
2169 Lisp_Object handler
;
2170 Lisp_Object encoded_file
;
2171 struct gcpro gcpro1
;
2174 if (!NILP (Ffile_directory_p (filename
))
2175 && NILP (Ffile_symlink_p (filename
)))
2176 xsignal2 (Qfile_error
,
2177 build_string ("Removing old name: is a directory"),
2180 filename
= Fexpand_file_name (filename
, Qnil
);
2182 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2183 if (!NILP (handler
))
2184 return call2 (handler
, Qdelete_file
, filename
);
2186 if (delete_by_moving_to_trash
)
2187 return call1 (Qmove_file_to_trash
, filename
);
2189 encoded_file
= ENCODE_FILE (filename
);
2191 if (0 > unlink (SDATA (encoded_file
)))
2192 report_file_error ("Removing old name", list1 (filename
));
2197 internal_delete_file_1 (ignore
)
2203 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2206 internal_delete_file (filename
)
2207 Lisp_Object filename
;
2210 tem
= internal_condition_case_1 (Fdelete_file
, filename
,
2211 Qt
, internal_delete_file_1
);
2215 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2216 "fRename file: \nGRename %s to file: \np",
2217 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2218 If file has names other than FILE, it continues to have those names.
2219 Signals a `file-already-exists' error if a file NEWNAME already exists
2220 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2221 A number as third arg means request confirmation if NEWNAME already exists.
2222 This is what happens in interactive use with M-x. */)
2223 (file
, newname
, ok_if_already_exists
)
2224 Lisp_Object file
, newname
, ok_if_already_exists
;
2226 Lisp_Object handler
;
2227 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2228 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2230 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2231 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2232 CHECK_STRING (file
);
2233 CHECK_STRING (newname
);
2234 file
= Fexpand_file_name (file
, Qnil
);
2236 if ((!NILP (Ffile_directory_p (newname
)))
2238 /* If the file names are identical but for the case,
2239 don't attempt to move directory to itself. */
2240 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2243 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2245 newname
= Fexpand_file_name (newname
, Qnil
);
2247 /* If the file name has special constructs in it,
2248 call the corresponding file handler. */
2249 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2251 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2252 if (!NILP (handler
))
2253 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2254 file
, newname
, ok_if_already_exists
));
2256 encoded_file
= ENCODE_FILE (file
);
2257 encoded_newname
= ENCODE_FILE (newname
);
2260 /* If the file names are identical but for the case, don't ask for
2261 confirmation: they simply want to change the letter-case of the
2263 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2265 if (NILP (ok_if_already_exists
)
2266 || INTEGERP (ok_if_already_exists
))
2267 barf_or_query_if_file_exists (newname
, "rename to it",
2268 INTEGERP (ok_if_already_exists
), 0, 0);
2269 if (0 > rename (SDATA (encoded_file
), SDATA (encoded_newname
)))
2275 symlink_target
= Ffile_symlink_p (file
);
2276 if (! NILP (symlink_target
))
2277 Fmake_symbolic_link (symlink_target
, newname
,
2278 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2281 Fcopy_file (file
, newname
,
2282 /* We have already prompted if it was an integer,
2283 so don't have copy-file prompt again. */
2284 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2287 count
= SPECPDL_INDEX ();
2288 specbind (Qdelete_by_moving_to_trash
, Qnil
);
2289 Fdelete_file (file
);
2290 unbind_to (count
, Qnil
);
2293 report_file_error ("Renaming", list2 (file
, newname
));
2299 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2300 "fAdd name to file: \nGName to add to %s: \np",
2301 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2302 Signals a `file-already-exists' error if a file NEWNAME already exists
2303 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2304 A number as third arg means request confirmation if NEWNAME already exists.
2305 This is what happens in interactive use with M-x. */)
2306 (file
, newname
, ok_if_already_exists
)
2307 Lisp_Object file
, newname
, ok_if_already_exists
;
2309 Lisp_Object handler
;
2310 Lisp_Object encoded_file
, encoded_newname
;
2311 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2313 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2314 encoded_file
= encoded_newname
= Qnil
;
2315 CHECK_STRING (file
);
2316 CHECK_STRING (newname
);
2317 file
= Fexpand_file_name (file
, Qnil
);
2319 if (!NILP (Ffile_directory_p (newname
)))
2320 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2322 newname
= Fexpand_file_name (newname
, Qnil
);
2324 /* If the file name has special constructs in it,
2325 call the corresponding file handler. */
2326 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2327 if (!NILP (handler
))
2328 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2329 newname
, ok_if_already_exists
));
2331 /* If the new name has special constructs in it,
2332 call the corresponding file handler. */
2333 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2334 if (!NILP (handler
))
2335 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2336 newname
, ok_if_already_exists
));
2338 encoded_file
= ENCODE_FILE (file
);
2339 encoded_newname
= ENCODE_FILE (newname
);
2341 if (NILP (ok_if_already_exists
)
2342 || INTEGERP (ok_if_already_exists
))
2343 barf_or_query_if_file_exists (newname
, "make it a new name",
2344 INTEGERP (ok_if_already_exists
), 0, 0);
2346 unlink (SDATA (newname
));
2347 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
)))
2348 report_file_error ("Adding new name", list2 (file
, newname
));
2354 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2355 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2356 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2357 Both args must be strings.
2358 Signals a `file-already-exists' error if a file LINKNAME already exists
2359 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2360 A number as third arg means request confirmation if LINKNAME already exists.
2361 This happens for interactive use with M-x. */)
2362 (filename
, linkname
, ok_if_already_exists
)
2363 Lisp_Object filename
, linkname
, ok_if_already_exists
;
2365 Lisp_Object handler
;
2366 Lisp_Object encoded_filename
, encoded_linkname
;
2367 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2369 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2370 encoded_filename
= encoded_linkname
= Qnil
;
2371 CHECK_STRING (filename
);
2372 CHECK_STRING (linkname
);
2373 /* If the link target has a ~, we must expand it to get
2374 a truly valid file name. Otherwise, do not expand;
2375 we want to permit links to relative file names. */
2376 if (SREF (filename
, 0) == '~')
2377 filename
= Fexpand_file_name (filename
, Qnil
);
2379 if (!NILP (Ffile_directory_p (linkname
)))
2380 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2382 linkname
= Fexpand_file_name (linkname
, Qnil
);
2384 /* If the file name has special constructs in it,
2385 call the corresponding file handler. */
2386 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2387 if (!NILP (handler
))
2388 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2389 linkname
, ok_if_already_exists
));
2391 /* If the new link name has special constructs in it,
2392 call the corresponding file handler. */
2393 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2394 if (!NILP (handler
))
2395 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2396 linkname
, ok_if_already_exists
));
2399 encoded_filename
= ENCODE_FILE (filename
);
2400 encoded_linkname
= ENCODE_FILE (linkname
);
2402 if (NILP (ok_if_already_exists
)
2403 || INTEGERP (ok_if_already_exists
))
2404 barf_or_query_if_file_exists (linkname
, "make it a link",
2405 INTEGERP (ok_if_already_exists
), 0, 0);
2406 if (0 > symlink (SDATA (encoded_filename
),
2407 SDATA (encoded_linkname
)))
2409 /* If we didn't complain already, silently delete existing file. */
2410 if (errno
== EEXIST
)
2412 unlink (SDATA (encoded_linkname
));
2413 if (0 <= symlink (SDATA (encoded_filename
),
2414 SDATA (encoded_linkname
)))
2421 report_file_error ("Making symbolic link", list2 (filename
, linkname
));
2428 xsignal1 (Qfile_error
, build_string ("Symbolic links are not supported"));
2430 #endif /* S_IFLNK */
2434 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2436 doc
: /* Return t if file FILENAME specifies an absolute file name.
2437 On Unix, this is a name starting with a `/' or a `~'. */)
2439 Lisp_Object filename
;
2441 CHECK_STRING (filename
);
2442 return file_name_absolute_p (SDATA (filename
)) ? Qt
: Qnil
;
2445 /* Return nonzero if file FILENAME exists and can be executed. */
2448 check_executable (filename
)
2452 int len
= strlen (filename
);
2455 if (stat (filename
, &st
) < 0)
2457 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
2458 return ((st
.st_mode
& S_IEXEC
) != 0);
2460 return (S_ISREG (st
.st_mode
)
2462 && (xstrcasecmp ((suffix
= filename
+ len
-4), ".com") == 0
2463 || xstrcasecmp (suffix
, ".exe") == 0
2464 || xstrcasecmp (suffix
, ".bat") == 0)
2465 || (st
.st_mode
& S_IFMT
) == S_IFDIR
);
2466 #endif /* not WINDOWSNT */
2467 #else /* not DOS_NT */
2468 #ifdef HAVE_EUIDACCESS
2469 return (euidaccess (filename
, 1) >= 0);
2471 /* Access isn't quite right because it uses the real uid
2472 and we really want to test with the effective uid.
2473 But Unix doesn't give us a right way to do it. */
2474 return (access (filename
, 1) >= 0);
2476 #endif /* not DOS_NT */
2479 /* Return nonzero if file FILENAME exists and can be written. */
2482 check_writable (filename
)
2487 if (stat (filename
, &st
) < 0)
2489 return (st
.st_mode
& S_IWRITE
|| (st
.st_mode
& S_IFMT
) == S_IFDIR
);
2490 #else /* not MSDOS */
2491 #ifdef HAVE_EUIDACCESS
2492 return (euidaccess (filename
, 2) >= 0);
2494 /* Access isn't quite right because it uses the real uid
2495 and we really want to test with the effective uid.
2496 But Unix doesn't give us a right way to do it.
2497 Opening with O_WRONLY could work for an ordinary file,
2498 but would lose for directories. */
2499 return (access (filename
, 2) >= 0);
2501 #endif /* not MSDOS */
2504 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
2505 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
2506 See also `file-readable-p' and `file-attributes'.
2507 This returns nil for a symlink to a nonexistent file.
2508 Use `file-symlink-p' to test for such links. */)
2510 Lisp_Object filename
;
2512 Lisp_Object absname
;
2513 Lisp_Object handler
;
2514 struct stat statbuf
;
2516 CHECK_STRING (filename
);
2517 absname
= Fexpand_file_name (filename
, Qnil
);
2519 /* If the file name has special constructs in it,
2520 call the corresponding file handler. */
2521 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
2522 if (!NILP (handler
))
2523 return call2 (handler
, Qfile_exists_p
, absname
);
2525 absname
= ENCODE_FILE (absname
);
2527 return (stat (SDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
2530 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
2531 doc
: /* Return t if FILENAME can be executed by you.
2532 For a directory, this means you can access files in that directory. */)
2534 Lisp_Object filename
;
2536 Lisp_Object absname
;
2537 Lisp_Object handler
;
2539 CHECK_STRING (filename
);
2540 absname
= Fexpand_file_name (filename
, Qnil
);
2542 /* If the file name has special constructs in it,
2543 call the corresponding file handler. */
2544 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
2545 if (!NILP (handler
))
2546 return call2 (handler
, Qfile_executable_p
, absname
);
2548 absname
= ENCODE_FILE (absname
);
2550 return (check_executable (SDATA (absname
)) ? Qt
: Qnil
);
2553 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
2554 doc
: /* Return t if file FILENAME exists and you can read it.
2555 See also `file-exists-p' and `file-attributes'. */)
2557 Lisp_Object filename
;
2559 Lisp_Object absname
;
2560 Lisp_Object handler
;
2563 struct stat statbuf
;
2565 CHECK_STRING (filename
);
2566 absname
= Fexpand_file_name (filename
, Qnil
);
2568 /* If the file name has special constructs in it,
2569 call the corresponding file handler. */
2570 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
2571 if (!NILP (handler
))
2572 return call2 (handler
, Qfile_readable_p
, absname
);
2574 absname
= ENCODE_FILE (absname
);
2576 #if defined(DOS_NT) || defined(macintosh)
2577 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2579 if (access (SDATA (absname
), 0) == 0)
2582 #else /* not DOS_NT and not macintosh */
2584 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
2585 /* Opening a fifo without O_NONBLOCK can wait.
2586 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2587 except in the case of a fifo, on a system which handles it. */
2588 desc
= stat (SDATA (absname
), &statbuf
);
2591 if (S_ISFIFO (statbuf
.st_mode
))
2592 flags
|= O_NONBLOCK
;
2594 desc
= emacs_open (SDATA (absname
), flags
, 0);
2599 #endif /* not DOS_NT and not macintosh */
2602 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2604 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
2605 doc
: /* Return t if file FILENAME can be written or created by you. */)
2607 Lisp_Object filename
;
2609 Lisp_Object absname
, dir
, encoded
;
2610 Lisp_Object handler
;
2611 struct stat statbuf
;
2613 CHECK_STRING (filename
);
2614 absname
= Fexpand_file_name (filename
, Qnil
);
2616 /* If the file name has special constructs in it,
2617 call the corresponding file handler. */
2618 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
2619 if (!NILP (handler
))
2620 return call2 (handler
, Qfile_writable_p
, absname
);
2622 encoded
= ENCODE_FILE (absname
);
2623 if (stat (SDATA (encoded
), &statbuf
) >= 0)
2624 return (check_writable (SDATA (encoded
))
2627 dir
= Ffile_name_directory (absname
);
2630 dir
= Fdirectory_file_name (dir
);
2633 dir
= ENCODE_FILE (dir
);
2635 /* The read-only attribute of the parent directory doesn't affect
2636 whether a file or directory can be created within it. Some day we
2637 should check ACLs though, which do affect this. */
2638 if (stat (SDATA (dir
), &statbuf
) < 0)
2640 return (statbuf
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2642 return (check_writable (!NILP (dir
) ? (char *) SDATA (dir
) : "")
2647 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
2648 doc
: /* Access file FILENAME, and get an error if that does not work.
2649 The second argument STRING is used in the error message.
2650 If there is no error, returns nil. */)
2652 Lisp_Object filename
, string
;
2654 Lisp_Object handler
, encoded_filename
, absname
;
2657 CHECK_STRING (filename
);
2658 absname
= Fexpand_file_name (filename
, Qnil
);
2660 CHECK_STRING (string
);
2662 /* If the file name has special constructs in it,
2663 call the corresponding file handler. */
2664 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
2665 if (!NILP (handler
))
2666 return call3 (handler
, Qaccess_file
, absname
, string
);
2668 encoded_filename
= ENCODE_FILE (absname
);
2670 fd
= emacs_open (SDATA (encoded_filename
), O_RDONLY
, 0);
2672 report_file_error (SDATA (string
), Fcons (filename
, Qnil
));
2678 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
2679 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
2680 The value is the link target, as a string.
2681 Otherwise it returns nil.
2683 This function returns t when given the name of a symlink that
2684 points to a nonexistent file. */)
2686 Lisp_Object filename
;
2688 Lisp_Object handler
;
2690 CHECK_STRING (filename
);
2691 filename
= Fexpand_file_name (filename
, Qnil
);
2693 /* If the file name has special constructs in it,
2694 call the corresponding file handler. */
2695 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
2696 if (!NILP (handler
))
2697 return call2 (handler
, Qfile_symlink_p
, filename
);
2706 filename
= ENCODE_FILE (filename
);
2713 buf
= (char *) xrealloc (buf
, bufsize
);
2714 bzero (buf
, bufsize
);
2717 valsize
= readlink (SDATA (filename
), buf
, bufsize
);
2721 /* HP-UX reports ERANGE if buffer is too small. */
2722 if (errno
== ERANGE
)
2732 while (valsize
>= bufsize
);
2734 val
= make_string (buf
, valsize
);
2735 if (buf
[0] == '/' && index (buf
, ':'))
2736 val
= concat2 (build_string ("/:"), val
);
2738 val
= DECODE_FILE (val
);
2741 #else /* not S_IFLNK */
2743 #endif /* not S_IFLNK */
2746 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
2747 doc
: /* Return t if FILENAME names an existing directory.
2748 Symbolic links to directories count as directories.
2749 See `file-symlink-p' to distinguish symlinks. */)
2751 Lisp_Object filename
;
2753 register Lisp_Object absname
;
2755 Lisp_Object handler
;
2757 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2759 /* If the file name has special constructs in it,
2760 call the corresponding file handler. */
2761 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
2762 if (!NILP (handler
))
2763 return call2 (handler
, Qfile_directory_p
, absname
);
2765 absname
= ENCODE_FILE (absname
);
2767 if (stat (SDATA (absname
), &st
) < 0)
2769 return (st
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
2772 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
2773 doc
: /* Return t if file FILENAME names a directory you can open.
2774 For the value to be t, FILENAME must specify the name of a directory as a file,
2775 and the directory must allow you to open files in it. In order to use a
2776 directory as a buffer's current directory, this predicate must return true.
2777 A directory name spec may be given instead; then the value is t
2778 if the directory so specified exists and really is a readable and
2779 searchable directory. */)
2781 Lisp_Object filename
;
2783 Lisp_Object handler
;
2785 struct gcpro gcpro1
;
2787 /* If the file name has special constructs in it,
2788 call the corresponding file handler. */
2789 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
2790 if (!NILP (handler
))
2791 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
2794 tem
= (NILP (Ffile_directory_p (filename
))
2795 || NILP (Ffile_executable_p (filename
)));
2797 return tem
? Qnil
: Qt
;
2800 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
2801 doc
: /* Return t if FILENAME names a regular file.
2802 This is the sort of file that holds an ordinary stream of data bytes.
2803 Symbolic links to regular files count as regular files.
2804 See `file-symlink-p' to distinguish symlinks. */)
2806 Lisp_Object filename
;
2808 register Lisp_Object absname
;
2810 Lisp_Object handler
;
2812 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2814 /* If the file name has special constructs in it,
2815 call the corresponding file handler. */
2816 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
2817 if (!NILP (handler
))
2818 return call2 (handler
, Qfile_regular_p
, absname
);
2820 absname
= ENCODE_FILE (absname
);
2825 Lisp_Object tem
= Vw32_get_true_file_attributes
;
2827 /* Tell stat to use expensive method to get accurate info. */
2828 Vw32_get_true_file_attributes
= Qt
;
2829 result
= stat (SDATA (absname
), &st
);
2830 Vw32_get_true_file_attributes
= tem
;
2834 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2837 if (stat (SDATA (absname
), &st
) < 0)
2839 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
2843 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
2844 doc
: /* Return mode bits of file named FILENAME, as an integer.
2845 Return nil, if file does not exist or is not accessible. */)
2847 Lisp_Object filename
;
2849 Lisp_Object absname
;
2851 Lisp_Object handler
;
2853 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
2855 /* If the file name has special constructs in it,
2856 call the corresponding file handler. */
2857 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
2858 if (!NILP (handler
))
2859 return call2 (handler
, Qfile_modes
, absname
);
2861 absname
= ENCODE_FILE (absname
);
2863 if (stat (SDATA (absname
), &st
) < 0)
2865 #if defined (MSDOS) && __DJGPP__ < 2
2866 if (check_executable (SDATA (absname
)))
2867 st
.st_mode
|= S_IEXEC
;
2868 #endif /* MSDOS && __DJGPP__ < 2 */
2870 return make_number (st
.st_mode
& 07777);
2873 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2,
2874 "(let ((file (read-file-name \"File: \"))) \
2875 (list file (read-file-modes nil file)))",
2876 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
2877 Only the 12 low bits of MODE are used.
2879 Interactively, mode bits are read by `read-file-modes', which accepts
2880 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2882 Lisp_Object filename
, mode
;
2884 Lisp_Object absname
, encoded_absname
;
2885 Lisp_Object handler
;
2887 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2888 CHECK_NUMBER (mode
);
2890 /* If the file name has special constructs in it,
2891 call the corresponding file handler. */
2892 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
2893 if (!NILP (handler
))
2894 return call3 (handler
, Qset_file_modes
, absname
, mode
);
2896 encoded_absname
= ENCODE_FILE (absname
);
2898 if (chmod (SDATA (encoded_absname
), XINT (mode
)) < 0)
2899 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
2904 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
2905 doc
: /* Set the file permission bits for newly created files.
2906 The argument MODE should be an integer; only the low 9 bits are used.
2907 This setting is inherited by subprocesses. */)
2911 CHECK_NUMBER (mode
);
2913 umask ((~ XINT (mode
)) & 0777);
2918 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
2919 doc
: /* Return the default file protection for created files.
2920 The value is an integer. */)
2926 realmask
= umask (0);
2929 XSETINT (value
, (~ realmask
) & 0777);
2933 extern int lisp_time_argument
P_ ((Lisp_Object
, time_t *, int *));
2935 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
2936 doc
: /* Set times of file FILENAME to TIME.
2937 Set both access and modification times.
2938 Return t on success, else nil.
2939 Use the current time if TIME is nil. TIME is in the format of
2942 Lisp_Object filename
, time
;
2944 Lisp_Object absname
, encoded_absname
;
2945 Lisp_Object handler
;
2949 if (! lisp_time_argument (time
, &sec
, &usec
))
2950 error ("Invalid time specification");
2952 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
2954 /* If the file name has special constructs in it,
2955 call the corresponding file handler. */
2956 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
2957 if (!NILP (handler
))
2958 return call3 (handler
, Qset_file_times
, absname
, time
);
2960 encoded_absname
= ENCODE_FILE (absname
);
2965 EMACS_SET_SECS (t
, sec
);
2966 EMACS_SET_USECS (t
, usec
);
2968 if (set_file_times (SDATA (encoded_absname
), t
, t
))
2973 /* Setting times on a directory always fails. */
2974 if (stat (SDATA (encoded_absname
), &st
) == 0
2975 && (st
.st_mode
& S_IFMT
) == S_IFDIR
)
2978 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
2987 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
2988 doc
: /* Tell Unix to finish all pending disk updates. */)
2995 #endif /* HAVE_SYNC */
2997 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
2998 doc
: /* Return t if file FILE1 is newer than file FILE2.
2999 If FILE1 does not exist, the answer is nil;
3000 otherwise, if FILE2 does not exist, the answer is t. */)
3002 Lisp_Object file1
, file2
;
3004 Lisp_Object absname1
, absname2
;
3007 Lisp_Object handler
;
3008 struct gcpro gcpro1
, gcpro2
;
3010 CHECK_STRING (file1
);
3011 CHECK_STRING (file2
);
3014 GCPRO2 (absname1
, file2
);
3015 absname1
= expand_and_dir_to_file (file1
, current_buffer
->directory
);
3016 absname2
= expand_and_dir_to_file (file2
, current_buffer
->directory
);
3019 /* If the file name has special constructs in it,
3020 call the corresponding file handler. */
3021 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3023 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3024 if (!NILP (handler
))
3025 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3027 GCPRO2 (absname1
, absname2
);
3028 absname1
= ENCODE_FILE (absname1
);
3029 absname2
= ENCODE_FILE (absname2
);
3032 if (stat (SDATA (absname1
), &st
) < 0)
3035 mtime1
= st
.st_mtime
;
3037 if (stat (SDATA (absname2
), &st
) < 0)
3040 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3044 Lisp_Object Qfind_buffer_file_type
;
3047 #ifndef READ_BUF_SIZE
3048 #define READ_BUF_SIZE (64 << 10)
3051 extern void adjust_markers_for_delete
P_ ((int, int, int, int));
3053 /* This function is called after Lisp functions to decide a coding
3054 system are called, or when they cause an error. Before they are
3055 called, the current buffer is set unibyte and it contains only a
3056 newly inserted text (thus the buffer was empty before the
3059 The functions may set markers, overlays, text properties, or even
3060 alter the buffer contents, change the current buffer.
3062 Here, we reset all those changes by:
3063 o set back the current buffer.
3064 o move all markers and overlays to BEG.
3065 o remove all text properties.
3066 o set back the buffer multibyteness. */
3069 decide_coding_unwind (unwind_data
)
3070 Lisp_Object unwind_data
;
3072 Lisp_Object multibyte
, undo_list
, buffer
;
3074 multibyte
= XCAR (unwind_data
);
3075 unwind_data
= XCDR (unwind_data
);
3076 undo_list
= XCAR (unwind_data
);
3077 buffer
= XCDR (unwind_data
);
3079 if (current_buffer
!= XBUFFER (buffer
))
3080 set_buffer_internal (XBUFFER (buffer
));
3081 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3082 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3083 BUF_INTERVALS (current_buffer
) = 0;
3084 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3086 /* Now we are safe to change the buffer's multibyteness directly. */
3087 current_buffer
->enable_multibyte_characters
= multibyte
;
3088 current_buffer
->undo_list
= undo_list
;
3094 /* Used to pass values from insert-file-contents to read_non_regular. */
3096 static int non_regular_fd
;
3097 static int non_regular_inserted
;
3098 static int non_regular_nbytes
;
3101 /* Read from a non-regular file.
3102 Read non_regular_trytry bytes max from non_regular_fd.
3103 Non_regular_inserted specifies where to put the read bytes.
3104 Value is the number of bytes read. */
3113 nbytes
= emacs_read (non_regular_fd
,
3114 BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ non_regular_inserted
,
3115 non_regular_nbytes
);
3117 return make_number (nbytes
);
3121 /* Condition-case handler used when reading from non-regular files
3122 in insert-file-contents. */
3125 read_non_regular_quit ()
3131 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3133 doc
: /* Insert contents of file FILENAME after point.
3134 Returns list of absolute file name and number of characters inserted.
3135 If second argument VISIT is non-nil, the buffer's visited filename and
3136 last save file modtime are set, and it is marked unmodified. If
3137 visiting and the file does not exist, visiting is completed before the
3140 The optional third and fourth arguments BEG and END specify what portion
3141 of the file to insert. These arguments count bytes in the file, not
3142 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3144 If optional fifth argument REPLACE is non-nil, replace the current
3145 buffer contents (in the accessible portion) with the file contents.
3146 This is better than simply deleting and inserting the whole thing
3147 because (1) it preserves some marker positions and (2) it puts less data
3148 in the undo list. When REPLACE is non-nil, the second return value is
3149 the number of characters that replace previous buffer contents.
3151 This function does code conversion according to the value of
3152 `coding-system-for-read' or `file-coding-system-alist', and sets the
3153 variable `last-coding-system-used' to the coding system actually used. */)
3154 (filename
, visit
, beg
, end
, replace
)
3155 Lisp_Object filename
, visit
, beg
, end
, replace
;
3161 register int how_much
;
3162 register int unprocessed
;
3163 int count
= SPECPDL_INDEX ();
3164 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
3165 Lisp_Object handler
, val
, insval
, orig_filename
, old_undo
;
3168 int not_regular
= 0;
3169 unsigned char read_buf
[READ_BUF_SIZE
];
3170 struct coding_system coding
;
3171 unsigned char buffer
[1 << 14];
3172 int replace_handled
= 0;
3173 int set_coding_system
= 0;
3174 Lisp_Object coding_system
;
3176 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3177 int we_locked_file
= 0;
3178 int deferred_remove_unwind_protect
= 0;
3180 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3181 error ("Cannot do file visiting in an indirect buffer");
3183 if (!NILP (current_buffer
->read_only
))
3184 Fbarf_if_buffer_read_only ();
3188 orig_filename
= Qnil
;
3191 GCPRO5 (filename
, val
, p
, orig_filename
, old_undo
);
3193 CHECK_STRING (filename
);
3194 filename
= Fexpand_file_name (filename
, Qnil
);
3196 /* The value Qnil means that the coding system is not yet
3198 coding_system
= Qnil
;
3200 /* If the file name has special constructs in it,
3201 call the corresponding file handler. */
3202 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3203 if (!NILP (handler
))
3205 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3206 visit
, beg
, end
, replace
);
3207 if (CONSP (val
) && CONSP (XCDR (val
)))
3208 inserted
= XINT (XCAR (XCDR (val
)));
3212 orig_filename
= filename
;
3213 filename
= ENCODE_FILE (filename
);
3219 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3221 /* Tell stat to use expensive method to get accurate info. */
3222 Vw32_get_true_file_attributes
= Qt
;
3223 total
= stat (SDATA (filename
), &st
);
3224 Vw32_get_true_file_attributes
= tem
;
3228 if (stat (SDATA (filename
), &st
) < 0)
3229 #endif /* WINDOWSNT */
3231 if (fd
>= 0) emacs_close (fd
);
3234 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3237 if (!NILP (Vcoding_system_for_read
))
3238 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3243 /* This code will need to be changed in order to work on named
3244 pipes, and it's probably just not worth it. So we should at
3245 least signal an error. */
3246 if (!S_ISREG (st
.st_mode
))
3253 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3254 xsignal2 (Qfile_error
,
3255 build_string ("not a regular file"), orig_filename
);
3260 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0)
3263 /* Replacement should preserve point as it preserves markers. */
3264 if (!NILP (replace
))
3265 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3267 record_unwind_protect (close_file_unwind
, make_number (fd
));
3269 /* Can happen on any platform that uses long as type of off_t, but allows
3270 file sizes to exceed 2Gb, so give a suitable message. */
3271 if (! not_regular
&& st
.st_size
< 0)
3272 error ("Maximum buffer size exceeded");
3274 /* Prevent redisplay optimizations. */
3275 current_buffer
->clip_changed
= 1;
3279 if (!NILP (beg
) || !NILP (end
))
3280 error ("Attempt to visit less than an entire file");
3281 if (BEG
< Z
&& NILP (replace
))
3282 error ("Cannot do file visiting in a non-empty buffer");
3288 XSETFASTINT (beg
, 0);
3296 XSETINT (end
, st
.st_size
);
3298 /* Arithmetic overflow can occur if an Emacs integer cannot
3299 represent the file size, or if the calculations below
3300 overflow. The calculations below double the file size
3301 twice, so check that it can be multiplied by 4 safely. */
3302 if (XINT (end
) != st
.st_size
3303 /* Actually, it should test either INT_MAX or LONG_MAX
3304 depending on which one is used for EMACS_INT. But in
3305 any case, in practice, this test is redundant with the
3307 || st.st_size > INT_MAX / 4 */)
3308 error ("Maximum buffer size exceeded");
3310 /* The file size returned from stat may be zero, but data
3311 may be readable nonetheless, for example when this is a
3312 file in the /proc filesystem. */
3313 if (st
.st_size
== 0)
3314 XSETINT (end
, READ_BUF_SIZE
);
3318 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3320 coding_system
= coding_inherit_eol_type (Qutf_8_emacs
, Qunix
);
3321 setup_coding_system (coding_system
, &coding
);
3322 /* Ensure we set Vlast_coding_system_used. */
3323 set_coding_system
= 1;
3327 /* Decide the coding system to use for reading the file now
3328 because we can't use an optimized method for handling
3329 `coding:' tag if the current buffer is not empty. */
3330 if (!NILP (Vcoding_system_for_read
))
3331 coding_system
= Vcoding_system_for_read
;
3334 /* Don't try looking inside a file for a coding system
3335 specification if it is not seekable. */
3336 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3338 /* Find a coding system specified in the heading two
3339 lines or in the tailing several lines of the file.
3340 We assume that the 1K-byte and 3K-byte for heading
3341 and tailing respectively are sufficient for this
3345 if (st
.st_size
<= (1024 * 4))
3346 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3349 nread
= emacs_read (fd
, read_buf
, 1024);
3352 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3353 report_file_error ("Setting file position",
3354 Fcons (orig_filename
, Qnil
));
3355 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3360 error ("IO error reading %s: %s",
3361 SDATA (orig_filename
), emacs_strerror (errno
));
3364 struct buffer
*prev
= current_buffer
;
3368 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3370 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3371 buf
= XBUFFER (buffer
);
3373 delete_all_overlays (buf
);
3374 buf
->directory
= current_buffer
->directory
;
3375 buf
->read_only
= Qnil
;
3376 buf
->filename
= Qnil
;
3377 buf
->undo_list
= Qt
;
3378 eassert (buf
->overlays_before
== NULL
);
3379 eassert (buf
->overlays_after
== NULL
);
3381 set_buffer_internal (buf
);
3383 buf
->enable_multibyte_characters
= Qnil
;
3385 insert_1_both (read_buf
, nread
, nread
, 0, 0, 0);
3386 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3387 coding_system
= call2 (Vset_auto_coding_function
,
3388 filename
, make_number (nread
));
3389 set_buffer_internal (prev
);
3391 /* Discard the unwind protect for recovering the
3395 /* Rewind the file for the actual read done later. */
3396 if (lseek (fd
, 0, 0) < 0)
3397 report_file_error ("Setting file position",
3398 Fcons (orig_filename
, Qnil
));
3402 if (NILP (coding_system
))
3404 /* If we have not yet decided a coding system, check
3405 file-coding-system-alist. */
3406 Lisp_Object args
[6];
3408 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3409 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3410 coding_system
= Ffind_operation_coding_system (6, args
);
3411 if (CONSP (coding_system
))
3412 coding_system
= XCAR (coding_system
);
3416 if (NILP (coding_system
))
3417 coding_system
= Qundecided
;
3419 CHECK_CODING_SYSTEM (coding_system
);
3421 if (NILP (current_buffer
->enable_multibyte_characters
))
3422 /* We must suppress all character code conversion except for
3423 end-of-line conversion. */
3424 coding_system
= raw_text_coding_system (coding_system
);
3426 setup_coding_system (coding_system
, &coding
);
3427 /* Ensure we set Vlast_coding_system_used. */
3428 set_coding_system
= 1;
3431 /* If requested, replace the accessible part of the buffer
3432 with the file contents. Avoid replacing text at the
3433 beginning or end of the buffer that matches the file contents;
3434 that preserves markers pointing to the unchanged parts.
3436 Here we implement this feature in an optimized way
3437 for the case where code conversion is NOT needed.
3438 The following if-statement handles the case of conversion
3439 in a less optimal way.
3441 If the code conversion is "automatic" then we try using this
3442 method and hope for the best.
3443 But if we discover the need for conversion, we give up on this method
3444 and let the following if-statement handle the replace job. */
3447 && (NILP (coding_system
)
3448 || ! CODING_REQUIRE_DECODING (&coding
)))
3450 /* same_at_start and same_at_end count bytes,
3451 because file access counts bytes
3452 and BEG and END count bytes. */
3453 int same_at_start
= BEGV_BYTE
;
3454 int same_at_end
= ZV_BYTE
;
3456 /* There is still a possibility we will find the need to do code
3457 conversion. If that happens, we set this variable to 1 to
3458 give up on handling REPLACE in the optimized way. */
3459 int giveup_match_end
= 0;
3461 if (XINT (beg
) != 0)
3463 if (lseek (fd
, XINT (beg
), 0) < 0)
3464 report_file_error ("Setting file position",
3465 Fcons (orig_filename
, Qnil
));
3470 /* Count how many chars at the start of the file
3471 match the text at the beginning of the buffer. */
3476 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
3478 error ("IO error reading %s: %s",
3479 SDATA (orig_filename
), emacs_strerror (errno
));
3480 else if (nread
== 0)
3483 if (CODING_REQUIRE_DETECTION (&coding
))
3485 coding_system
= detect_coding_system (buffer
, nread
, nread
, 1, 0,
3487 setup_coding_system (coding_system
, &coding
);
3490 if (CODING_REQUIRE_DECODING (&coding
))
3491 /* We found that the file should be decoded somehow.
3492 Let's give up here. */
3494 giveup_match_end
= 1;
3499 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
3500 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
3501 same_at_start
++, bufpos
++;
3502 /* If we found a discrepancy, stop the scan.
3503 Otherwise loop around and scan the next bufferful. */
3504 if (bufpos
!= nread
)
3508 /* If the file matches the buffer completely,
3509 there's no need to replace anything. */
3510 if (same_at_start
- BEGV_BYTE
== XINT (end
))
3514 /* Truncate the buffer to the size of the file. */
3515 del_range_1 (same_at_start
, same_at_end
, 0, 0);
3520 /* Count how many chars at the end of the file
3521 match the text at the end of the buffer. But, if we have
3522 already found that decoding is necessary, don't waste time. */
3523 while (!giveup_match_end
)
3525 int total_read
, nread
, bufpos
, curpos
, trial
;
3527 /* At what file position are we now scanning? */
3528 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
3529 /* If the entire file matches the buffer tail, stop the scan. */
3532 /* How much can we scan in the next step? */
3533 trial
= min (curpos
, sizeof buffer
);
3534 if (lseek (fd
, curpos
- trial
, 0) < 0)
3535 report_file_error ("Setting file position",
3536 Fcons (orig_filename
, Qnil
));
3538 total_read
= nread
= 0;
3539 while (total_read
< trial
)
3541 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
3543 error ("IO error reading %s: %s",
3544 SDATA (orig_filename
), emacs_strerror (errno
));
3545 else if (nread
== 0)
3547 total_read
+= nread
;
3550 /* Scan this bufferful from the end, comparing with
3551 the Emacs buffer. */
3552 bufpos
= total_read
;
3554 /* Compare with same_at_start to avoid counting some buffer text
3555 as matching both at the file's beginning and at the end. */
3556 while (bufpos
> 0 && same_at_end
> same_at_start
3557 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
3558 same_at_end
--, bufpos
--;
3560 /* If we found a discrepancy, stop the scan.
3561 Otherwise loop around and scan the preceding bufferful. */
3564 /* If this discrepancy is because of code conversion,
3565 we cannot use this method; giveup and try the other. */
3566 if (same_at_end
> same_at_start
3567 && FETCH_BYTE (same_at_end
- 1) >= 0200
3568 && ! NILP (current_buffer
->enable_multibyte_characters
)
3569 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
3570 giveup_match_end
= 1;
3579 if (! giveup_match_end
)
3583 /* We win! We can handle REPLACE the optimized way. */
3585 /* Extend the start of non-matching text area to multibyte
3586 character boundary. */
3587 if (! NILP (current_buffer
->enable_multibyte_characters
))
3588 while (same_at_start
> BEGV_BYTE
3589 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3592 /* Extend the end of non-matching text area to multibyte
3593 character boundary. */
3594 if (! NILP (current_buffer
->enable_multibyte_characters
))
3595 while (same_at_end
< ZV_BYTE
3596 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3599 /* Don't try to reuse the same piece of text twice. */
3600 overlap
= (same_at_start
- BEGV_BYTE
3601 - (same_at_end
+ st
.st_size
- ZV
));
3603 same_at_end
+= overlap
;
3605 /* Arrange to read only the nonmatching middle part of the file. */
3606 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
3607 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
3609 del_range_byte (same_at_start
, same_at_end
, 0);
3610 /* Insert from the file at the proper position. */
3611 temp
= BYTE_TO_CHAR (same_at_start
);
3612 SET_PT_BOTH (temp
, same_at_start
);
3614 /* If display currently starts at beginning of line,
3615 keep it that way. */
3616 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3617 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3619 replace_handled
= 1;
3623 /* If requested, replace the accessible part of the buffer
3624 with the file contents. Avoid replacing text at the
3625 beginning or end of the buffer that matches the file contents;
3626 that preserves markers pointing to the unchanged parts.
3628 Here we implement this feature for the case where code conversion
3629 is needed, in a simple way that needs a lot of memory.
3630 The preceding if-statement handles the case of no conversion
3631 in a more optimized way. */
3632 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
3634 EMACS_INT same_at_start
= BEGV_BYTE
;
3635 EMACS_INT same_at_end
= ZV_BYTE
;
3636 EMACS_INT same_at_start_charpos
;
3637 EMACS_INT inserted_chars
;
3640 unsigned char *decoded
;
3642 int this_count
= SPECPDL_INDEX ();
3643 int multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
3644 Lisp_Object conversion_buffer
;
3646 conversion_buffer
= code_conversion_save (1, multibyte
);
3648 /* First read the whole file, performing code conversion into
3649 CONVERSION_BUFFER. */
3651 if (lseek (fd
, XINT (beg
), 0) < 0)
3652 report_file_error ("Setting file position",
3653 Fcons (orig_filename
, Qnil
));
3655 total
= st
.st_size
; /* Total bytes in the file. */
3656 how_much
= 0; /* Bytes read from file so far. */
3657 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
3658 unprocessed
= 0; /* Bytes not processed in previous loop. */
3660 GCPRO1 (conversion_buffer
);
3661 while (how_much
< total
)
3663 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3664 quitting while reading a huge while. */
3665 /* try is reserved in some compilers (Microsoft C) */
3666 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
3669 /* Allow quitting out of the actual I/O. */
3672 this = emacs_read (fd
, read_buf
+ unprocessed
, trytry
);
3684 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer
),
3685 BUF_Z (XBUFFER (conversion_buffer
)));
3686 decode_coding_c_string (&coding
, read_buf
, unprocessed
+ this,
3688 unprocessed
= coding
.carryover_bytes
;
3689 if (coding
.carryover_bytes
> 0)
3690 bcopy (coding
.carryover
, read_buf
, unprocessed
);
3695 /* We should remove the unwind_protect calling
3696 close_file_unwind, but other stuff has been added the stack,
3697 so defer the removal till we reach the `handled' label. */
3698 deferred_remove_unwind_protect
= 1;
3700 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3701 if we couldn't read the file. */
3704 error ("IO error reading %s: %s",
3705 SDATA (orig_filename
), emacs_strerror (errno
));
3707 if (unprocessed
> 0)
3709 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
3710 decode_coding_c_string (&coding
, read_buf
, unprocessed
,
3712 coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
3715 coding_system
= CODING_ID_NAME (coding
.id
);
3716 decoded
= BUF_BEG_ADDR (XBUFFER (conversion_buffer
));
3717 inserted
= (BUF_Z_BYTE (XBUFFER (conversion_buffer
))
3718 - BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3720 /* Compare the beginning of the converted string with the buffer
3724 while (bufpos
< inserted
&& same_at_start
< same_at_end
3725 && FETCH_BYTE (same_at_start
) == decoded
[bufpos
])
3726 same_at_start
++, bufpos
++;
3728 /* If the file matches the head of buffer completely,
3729 there's no need to replace anything. */
3731 if (bufpos
== inserted
)
3733 /* Truncate the buffer to the size of the file. */
3734 if (same_at_start
== same_at_end
)
3737 del_range_byte (same_at_start
, same_at_end
, 0);
3740 unbind_to (this_count
, Qnil
);
3744 /* Extend the start of non-matching text area to the previous
3745 multibyte character boundary. */
3746 if (! NILP (current_buffer
->enable_multibyte_characters
))
3747 while (same_at_start
> BEGV_BYTE
3748 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
3751 /* Scan this bufferful from the end, comparing with
3752 the Emacs buffer. */
3755 /* Compare with same_at_start to avoid counting some buffer text
3756 as matching both at the file's beginning and at the end. */
3757 while (bufpos
> 0 && same_at_end
> same_at_start
3758 && FETCH_BYTE (same_at_end
- 1) == decoded
[bufpos
- 1])
3759 same_at_end
--, bufpos
--;
3761 /* Extend the end of non-matching text area to the next
3762 multibyte character boundary. */
3763 if (! NILP (current_buffer
->enable_multibyte_characters
))
3764 while (same_at_end
< ZV_BYTE
3765 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
3768 /* Don't try to reuse the same piece of text twice. */
3769 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
3771 same_at_end
+= overlap
;
3773 /* If display currently starts at beginning of line,
3774 keep it that way. */
3775 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
3776 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
3778 /* Replace the chars that we need to replace,
3779 and update INSERTED to equal the number of bytes
3780 we are taking from the decoded string. */
3781 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
3783 if (same_at_end
!= same_at_start
)
3785 del_range_byte (same_at_start
, same_at_end
, 0);
3787 same_at_start
= GPT_BYTE
;
3791 temp
= BYTE_TO_CHAR (same_at_start
);
3793 /* Insert from the file at the proper position. */
3794 SET_PT_BOTH (temp
, same_at_start
);
3795 same_at_start_charpos
3796 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3797 same_at_start
- BEGV_BYTE
3798 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)));
3800 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer
),
3801 same_at_start
+ inserted
- BEGV_BYTE
3802 + BUF_BEG_BYTE (XBUFFER (conversion_buffer
)))
3803 - same_at_start_charpos
);
3804 /* This binding is to avoid ask-user-about-supersession-threat
3805 being called in insert_from_buffer (via in
3806 prepare_to_modify_buffer). */
3807 specbind (intern ("buffer-file-name"), Qnil
);
3808 insert_from_buffer (XBUFFER (conversion_buffer
),
3809 same_at_start_charpos
, inserted_chars
, 0);
3810 /* Set `inserted' to the number of inserted characters. */
3811 inserted
= PT
- temp
;
3812 /* Set point before the inserted characters. */
3813 SET_PT_BOTH (temp
, same_at_start
);
3815 unbind_to (this_count
, Qnil
);
3822 register Lisp_Object temp
;
3824 total
= XINT (end
) - XINT (beg
);
3826 /* Make sure point-max won't overflow after this insertion. */
3827 XSETINT (temp
, total
);
3828 if (total
!= XINT (temp
))
3829 error ("Maximum buffer size exceeded");
3832 /* For a special file, all we can do is guess. */
3833 total
= READ_BUF_SIZE
;
3835 if (NILP (visit
) && inserted
> 0)
3837 #ifdef CLASH_DETECTION
3838 if (!NILP (current_buffer
->file_truename
)
3839 /* Make binding buffer-file-name to nil effective. */
3840 && !NILP (current_buffer
->filename
)
3841 && SAVE_MODIFF
>= MODIFF
)
3843 #endif /* CLASH_DETECTION */
3844 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
3848 if (GAP_SIZE
< total
)
3849 make_gap (total
- GAP_SIZE
);
3851 if (XINT (beg
) != 0 || !NILP (replace
))
3853 if (lseek (fd
, XINT (beg
), 0) < 0)
3854 report_file_error ("Setting file position",
3855 Fcons (orig_filename
, Qnil
));
3858 /* In the following loop, HOW_MUCH contains the total bytes read so
3859 far for a regular file, and not changed for a special file. But,
3860 before exiting the loop, it is set to a negative value if I/O
3864 /* Total bytes inserted. */
3867 /* Here, we don't do code conversion in the loop. It is done by
3868 decode_coding_gap after all data are read into the buffer. */
3870 int gap_size
= GAP_SIZE
;
3872 while (how_much
< total
)
3874 /* try is reserved in some compilers (Microsoft C) */
3875 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
3882 /* Maybe make more room. */
3883 if (gap_size
< trytry
)
3885 make_gap (total
- gap_size
);
3886 gap_size
= GAP_SIZE
;
3889 /* Read from the file, capturing `quit'. When an
3890 error occurs, end the loop, and arrange for a quit
3891 to be signaled after decoding the text we read. */
3892 non_regular_fd
= fd
;
3893 non_regular_inserted
= inserted
;
3894 non_regular_nbytes
= trytry
;
3895 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
3896 read_non_regular_quit
);
3907 /* Allow quitting out of the actual I/O. We don't make text
3908 part of the buffer until all the reading is done, so a C-g
3909 here doesn't do any harm. */
3912 this = emacs_read (fd
, BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ inserted
, trytry
);
3924 /* For a regular file, where TOTAL is the real size,
3925 count HOW_MUCH to compare with it.
3926 For a special file, where TOTAL is just a buffer size,
3927 so don't bother counting in HOW_MUCH.
3928 (INSERTED is where we count the number of characters inserted.) */
3935 /* Now we have read all the file data into the gap.
3936 If it was empty, undo marking the buffer modified. */
3940 #ifdef CLASH_DETECTION
3942 unlock_file (current_buffer
->file_truename
);
3944 Vdeactivate_mark
= old_Vdeactivate_mark
;
3947 Vdeactivate_mark
= Qt
;
3949 /* Make the text read part of the buffer. */
3950 GAP_SIZE
-= inserted
;
3952 GPT_BYTE
+= inserted
;
3954 ZV_BYTE
+= inserted
;
3959 /* Put an anchor to ensure multi-byte form ends at gap. */
3964 /* Discard the unwind protect for closing the file. */
3968 error ("IO error reading %s: %s",
3969 SDATA (orig_filename
), emacs_strerror (errno
));
3973 if (NILP (coding_system
))
3975 /* The coding system is not yet decided. Decide it by an
3976 optimized method for handling `coding:' tag.
3978 Note that we can get here only if the buffer was empty
3979 before the insertion. */
3981 if (!NILP (Vcoding_system_for_read
))
3982 coding_system
= Vcoding_system_for_read
;
3985 /* Since we are sure that the current buffer was empty
3986 before the insertion, we can toggle
3987 enable-multibyte-characters directly here without taking
3988 care of marker adjustment. By this way, we can run Lisp
3989 program safely before decoding the inserted text. */
3990 Lisp_Object unwind_data
;
3991 int count
= SPECPDL_INDEX ();
3993 unwind_data
= Fcons (current_buffer
->enable_multibyte_characters
,
3994 Fcons (current_buffer
->undo_list
,
3995 Fcurrent_buffer ()));
3996 current_buffer
->enable_multibyte_characters
= Qnil
;
3997 current_buffer
->undo_list
= Qt
;
3998 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4000 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4002 coding_system
= call2 (Vset_auto_coding_function
,
4003 filename
, make_number (inserted
));
4006 if (NILP (coding_system
))
4008 /* If the coding system is not yet decided, check
4009 file-coding-system-alist. */
4010 Lisp_Object args
[6];
4012 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4013 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4014 coding_system
= Ffind_operation_coding_system (6, args
);
4015 if (CONSP (coding_system
))
4016 coding_system
= XCAR (coding_system
);
4018 unbind_to (count
, Qnil
);
4019 inserted
= Z_BYTE
- BEG_BYTE
;
4022 if (NILP (coding_system
))
4023 coding_system
= Qundecided
;
4025 CHECK_CODING_SYSTEM (coding_system
);
4027 if (NILP (current_buffer
->enable_multibyte_characters
))
4028 /* We must suppress all character code conversion except for
4029 end-of-line conversion. */
4030 coding_system
= raw_text_coding_system (coding_system
);
4031 setup_coding_system (coding_system
, &coding
);
4032 /* Ensure we set Vlast_coding_system_used. */
4033 set_coding_system
= 1;
4038 /* When we visit a file by raw-text, we change the buffer to
4040 if (CODING_FOR_UNIBYTE (&coding
)
4041 /* Can't do this if part of the buffer might be preserved. */
4043 /* Visiting a file with these coding system makes the buffer
4045 current_buffer
->enable_multibyte_characters
= Qnil
;
4048 coding
.dst_multibyte
= ! NILP (current_buffer
->enable_multibyte_characters
);
4049 if (CODING_MAY_REQUIRE_DECODING (&coding
)
4050 && (inserted
> 0 || CODING_REQUIRE_FLUSHING (&coding
)))
4052 move_gap_both (PT
, PT_BYTE
);
4053 GAP_SIZE
+= inserted
;
4054 ZV_BYTE
-= inserted
;
4058 decode_coding_gap (&coding
, inserted
, inserted
);
4059 inserted
= coding
.produced_char
;
4060 coding_system
= CODING_ID_NAME (coding
.id
);
4062 else if (inserted
> 0)
4063 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4066 /* Now INSERTED is measured in characters. */
4069 /* Use the conversion type to determine buffer-file-type
4070 (find-buffer-file-type is now used to help determine the
4072 if ((VECTORP (CODING_ID_EOL_TYPE (coding
.id
))
4073 || EQ (CODING_ID_EOL_TYPE (coding
.id
), Qunix
))
4074 && ! CODING_REQUIRE_DECODING (&coding
))
4075 current_buffer
->buffer_file_type
= Qt
;
4077 current_buffer
->buffer_file_type
= Qnil
;
4082 if (deferred_remove_unwind_protect
)
4083 /* If requested above, discard the unwind protect for closing the
4089 if (!EQ (current_buffer
->undo_list
, Qt
) && !nochange
)
4090 current_buffer
->undo_list
= Qnil
;
4094 current_buffer
->modtime
= st
.st_mtime
;
4095 current_buffer
->filename
= orig_filename
;
4098 SAVE_MODIFF
= MODIFF
;
4099 current_buffer
->auto_save_modified
= MODIFF
;
4100 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4101 #ifdef CLASH_DETECTION
4104 if (!NILP (current_buffer
->file_truename
))
4105 unlock_file (current_buffer
->file_truename
);
4106 unlock_file (filename
);
4108 #endif /* CLASH_DETECTION */
4110 xsignal2 (Qfile_error
,
4111 build_string ("not a regular file"), orig_filename
);
4114 if (set_coding_system
)
4115 Vlast_coding_system_used
= coding_system
;
4117 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4119 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4121 if (! NILP (insval
))
4123 CHECK_NUMBER (insval
);
4124 inserted
= XFASTINT (insval
);
4128 /* Decode file format. */
4131 /* Don't run point motion or modification hooks when decoding. */
4132 int count
= SPECPDL_INDEX ();
4133 int old_inserted
= inserted
;
4134 specbind (Qinhibit_point_motion_hooks
, Qt
);
4135 specbind (Qinhibit_modification_hooks
, Qt
);
4137 /* Save old undo list and don't record undo for decoding. */
4138 old_undo
= current_buffer
->undo_list
;
4139 current_buffer
->undo_list
= Qt
;
4143 insval
= call3 (Qformat_decode
,
4144 Qnil
, make_number (inserted
), visit
);
4145 CHECK_NUMBER (insval
);
4146 inserted
= XFASTINT (insval
);
4150 /* If REPLACE is non-nil and we succeeded in not replacing the
4151 beginning or end of the buffer text with the file's contents,
4152 call format-decode with `point' positioned at the beginning
4153 of the buffer and `inserted' equalling the number of
4154 characters in the buffer. Otherwise, format-decode might
4155 fail to correctly analyze the beginning or end of the buffer.
4156 Hence we temporarily save `point' and `inserted' here and
4157 restore `point' iff format-decode did not insert or delete
4158 any text. Otherwise we leave `point' at point-min. */
4160 int opoint_byte
= PT_BYTE
;
4161 int oinserted
= ZV
- BEGV
;
4162 int ochars_modiff
= CHARS_MODIFF
;
4164 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4165 insval
= call3 (Qformat_decode
,
4166 Qnil
, make_number (oinserted
), visit
);
4167 CHECK_NUMBER (insval
);
4168 if (ochars_modiff
== CHARS_MODIFF
)
4169 /* format_decode didn't modify buffer's characters => move
4170 point back to position before inserted text and leave
4171 value of inserted alone. */
4172 SET_PT_BOTH (opoint
, opoint_byte
);
4174 /* format_decode modified buffer's characters => consider
4175 entire buffer changed and leave point at point-min. */
4176 inserted
= XFASTINT (insval
);
4179 /* For consistency with format-decode call these now iff inserted > 0
4180 (martin 2007-06-28). */
4181 p
= Vafter_insert_file_functions
;
4186 insval
= call1 (XCAR (p
), make_number (inserted
));
4189 CHECK_NUMBER (insval
);
4190 inserted
= XFASTINT (insval
);
4195 /* For the rationale of this see the comment on
4196 format-decode above. */
4198 int opoint_byte
= PT_BYTE
;
4199 int oinserted
= ZV
- BEGV
;
4200 int ochars_modiff
= CHARS_MODIFF
;
4202 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
4203 insval
= call1 (XCAR (p
), make_number (oinserted
));
4206 CHECK_NUMBER (insval
);
4207 if (ochars_modiff
== CHARS_MODIFF
)
4208 /* after_insert_file_functions didn't modify
4209 buffer's characters => move point back to
4210 position before inserted text and leave value of
4212 SET_PT_BOTH (opoint
, opoint_byte
);
4214 /* after_insert_file_functions did modify buffer's
4215 characters => consider entire buffer changed and
4216 leave point at point-min. */
4217 inserted
= XFASTINT (insval
);
4227 current_buffer
->undo_list
= old_undo
;
4228 if (CONSP (old_undo
) && inserted
!= old_inserted
)
4230 /* Adjust the last undo record for the size change during
4231 the format conversion. */
4232 Lisp_Object tem
= XCAR (old_undo
);
4233 if (CONSP (tem
) && INTEGERP (XCAR (tem
))
4234 && INTEGERP (XCDR (tem
))
4235 && XFASTINT (XCDR (tem
)) == PT
+ old_inserted
)
4236 XSETCDR (tem
, make_number (PT
+ inserted
));
4240 /* If undo_list was Qt before, keep it that way.
4241 Otherwise start with an empty undo_list. */
4242 current_buffer
->undo_list
= EQ (old_undo
, Qt
) ? Qt
: Qnil
;
4244 unbind_to (count
, Qnil
);
4247 /* Call after-change hooks for the inserted text, aside from the case
4248 of normal visiting (not with REPLACE), which is done in a new buffer
4249 "before" the buffer is changed. */
4250 if (inserted
> 0 && total
> 0
4251 && (NILP (visit
) || !NILP (replace
)))
4253 signal_after_change (PT
, 0, inserted
);
4254 update_compositions (PT
, PT
, CHECK_BORDER
);
4258 && current_buffer
->modtime
== -1)
4260 /* If visiting nonexistent file, return nil. */
4261 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4265 Fsignal (Qquit
, Qnil
);
4267 /* ??? Retval needs to be dealt with in all cases consistently. */
4269 val
= Fcons (orig_filename
,
4270 Fcons (make_number (inserted
),
4273 RETURN_UNGCPRO (unbind_to (count
, val
));
4276 static Lisp_Object build_annotations
P_ ((Lisp_Object
, Lisp_Object
));
4279 build_annotations_unwind (arg
)
4282 Vwrite_region_annotation_buffers
= arg
;
4286 /* Decide the coding-system to encode the data with. */
4289 choose_write_coding_system (start
, end
, filename
,
4290 append
, visit
, lockname
, coding
)
4291 Lisp_Object start
, end
, filename
, append
, visit
, lockname
;
4292 struct coding_system
*coding
;
4295 Lisp_Object eol_parent
= Qnil
;
4298 && NILP (Fstring_equal (current_buffer
->filename
,
4299 current_buffer
->auto_save_file_name
)))
4304 else if (!NILP (Vcoding_system_for_write
))
4306 val
= Vcoding_system_for_write
;
4307 if (coding_system_require_warning
4308 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4309 /* Confirm that VAL can surely encode the current region. */
4310 val
= call5 (Vselect_safe_coding_system_function
,
4311 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4316 /* If the variable `buffer-file-coding-system' is set locally,
4317 it means that the file was read with some kind of code
4318 conversion or the variable is explicitly set by users. We
4319 had better write it out with the same coding system even if
4320 `enable-multibyte-characters' is nil.
4322 If it is not set locally, we anyway have to convert EOL
4323 format if the default value of `buffer-file-coding-system'
4324 tells that it is not Unix-like (LF only) format. */
4325 int using_default_coding
= 0;
4326 int force_raw_text
= 0;
4328 val
= current_buffer
->buffer_file_coding_system
;
4330 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4333 if (NILP (current_buffer
->enable_multibyte_characters
))
4339 /* Check file-coding-system-alist. */
4340 Lisp_Object args
[7], coding_systems
;
4342 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4343 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4345 coding_systems
= Ffind_operation_coding_system (7, args
);
4346 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4347 val
= XCDR (coding_systems
);
4352 /* If we still have not decided a coding system, use the
4353 default value of buffer-file-coding-system. */
4354 val
= current_buffer
->buffer_file_coding_system
;
4355 using_default_coding
= 1;
4358 if (! NILP (val
) && ! force_raw_text
)
4360 Lisp_Object spec
, attrs
;
4362 CHECK_CODING_SYSTEM_GET_SPEC (val
, spec
);
4363 attrs
= AREF (spec
, 0);
4364 if (EQ (CODING_ATTR_TYPE (attrs
), Qraw_text
))
4369 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4370 /* Confirm that VAL can surely encode the current region. */
4371 val
= call5 (Vselect_safe_coding_system_function
,
4372 start
, end
, val
, Qnil
, filename
);
4374 /* If the decided coding-system doesn't specify end-of-line
4375 format, we use that of
4376 `default-buffer-file-coding-system'. */
4377 if (! using_default_coding
4378 && ! NILP (buffer_defaults
.buffer_file_coding_system
))
4379 val
= (coding_inherit_eol_type
4380 (val
, buffer_defaults
.buffer_file_coding_system
));
4382 /* If we decide not to encode text, use `raw-text' or one of its
4385 val
= raw_text_coding_system (val
);
4388 val
= coding_inherit_eol_type (val
, eol_parent
);
4389 setup_coding_system (val
, coding
);
4391 if (!STRINGP (start
) && !NILP (current_buffer
->selective_display
))
4392 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4396 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4397 "r\nFWrite region to file: \ni\ni\ni\np",
4398 doc
: /* Write current region into specified file.
4399 When called from a program, requires three arguments:
4400 START, END and FILENAME. START and END are normally buffer positions
4401 specifying the part of the buffer to write.
4402 If START is nil, that means to use the entire buffer contents.
4403 If START is a string, then output that string to the file
4404 instead of any buffer contents; END is ignored.
4406 Optional fourth argument APPEND if non-nil means
4407 append to existing file contents (if any). If it is an integer,
4408 seek to that offset in the file before writing.
4409 Optional fifth argument VISIT, if t or a string, means
4410 set the last-save-file-modtime of buffer to this file's modtime
4411 and mark buffer not modified.
4412 If VISIT is a string, it is a second file name;
4413 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4414 VISIT is also the file name to lock and unlock for clash detection.
4415 If VISIT is neither t nor nil nor a string,
4416 that means do not display the \"Wrote file\" message.
4417 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4418 use for locking and unlocking, overriding FILENAME and VISIT.
4419 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4420 for an existing file with the same name. If MUSTBENEW is `excl',
4421 that means to get an error if the file already exists; never overwrite.
4422 If MUSTBENEW is neither nil nor `excl', that means ask for
4423 confirmation before overwriting, but do go ahead and overwrite the file
4424 if the user confirms.
4426 This does code conversion according to the value of
4427 `coding-system-for-write', `buffer-file-coding-system', or
4428 `file-coding-system-alist', and sets the variable
4429 `last-coding-system-used' to the coding system actually used.
4431 This calls `write-region-annotate-functions' at the start, and
4432 `write-region-post-annotation-function' at the end. */)
4433 (start
, end
, filename
, append
, visit
, lockname
, mustbenew
)
4434 Lisp_Object start
, end
, filename
, append
, visit
, lockname
, mustbenew
;
4439 const unsigned char *fn
;
4441 int count
= SPECPDL_INDEX ();
4443 Lisp_Object handler
;
4444 Lisp_Object visit_file
;
4445 Lisp_Object annotations
;
4446 Lisp_Object encoded_filename
;
4447 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4448 int quietly
= !NILP (visit
);
4449 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4450 struct buffer
*given_buffer
;
4452 int buffer_file_type
= O_BINARY
;
4454 struct coding_system coding
;
4456 if (current_buffer
->base_buffer
&& visiting
)
4457 error ("Cannot do file visiting in an indirect buffer");
4459 if (!NILP (start
) && !STRINGP (start
))
4460 validate_region (&start
, &end
);
4463 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4465 filename
= Fexpand_file_name (filename
, Qnil
);
4467 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4468 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4470 if (STRINGP (visit
))
4471 visit_file
= Fexpand_file_name (visit
, Qnil
);
4473 visit_file
= filename
;
4475 if (NILP (lockname
))
4476 lockname
= visit_file
;
4480 /* If the file name has special constructs in it,
4481 call the corresponding file handler. */
4482 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4483 /* If FILENAME has no handler, see if VISIT has one. */
4484 if (NILP (handler
) && STRINGP (visit
))
4485 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4487 if (!NILP (handler
))
4490 val
= call6 (handler
, Qwrite_region
, start
, end
,
4491 filename
, append
, visit
);
4495 SAVE_MODIFF
= MODIFF
;
4496 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4497 current_buffer
->filename
= visit_file
;
4503 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4505 /* Special kludge to simplify auto-saving. */
4508 /* Do it later, so write-region-annotate-function can work differently
4509 if we save "the buffer" vs "a region".
4510 This is useful in tar-mode. --Stef
4511 XSETFASTINT (start, BEG);
4512 XSETFASTINT (end, Z); */
4516 record_unwind_protect (build_annotations_unwind
,
4517 Vwrite_region_annotation_buffers
);
4518 Vwrite_region_annotation_buffers
= Fcons (Fcurrent_buffer (), Qnil
);
4519 count1
= SPECPDL_INDEX ();
4521 given_buffer
= current_buffer
;
4523 if (!STRINGP (start
))
4525 annotations
= build_annotations (start
, end
);
4527 if (current_buffer
!= given_buffer
)
4529 XSETFASTINT (start
, BEGV
);
4530 XSETFASTINT (end
, ZV
);
4536 XSETFASTINT (start
, BEGV
);
4537 XSETFASTINT (end
, ZV
);
4542 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4544 /* Decide the coding-system to encode the data with.
4545 We used to make this choice before calling build_annotations, but that
4546 leads to problems when a write-annotate-function takes care of
4547 unsavable chars (as was the case with X-Symbol). */
4548 Vlast_coding_system_used
4549 = choose_write_coding_system (start
, end
, filename
,
4550 append
, visit
, lockname
, &coding
);
4552 #ifdef CLASH_DETECTION
4554 lock_file (lockname
);
4555 #endif /* CLASH_DETECTION */
4557 encoded_filename
= ENCODE_FILE (filename
);
4559 fn
= SDATA (encoded_filename
);
4563 desc
= emacs_open (fn
, O_WRONLY
| buffer_file_type
, 0);
4564 #else /* not DOS_NT */
4565 desc
= emacs_open (fn
, O_WRONLY
, 0);
4566 #endif /* not DOS_NT */
4568 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
4570 desc
= emacs_open (fn
,
4571 O_WRONLY
| O_CREAT
| buffer_file_type
4572 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
4573 S_IREAD
| S_IWRITE
);
4574 #else /* not DOS_NT */
4575 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
4576 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
4577 auto_saving
? auto_save_mode_bits
: 0666);
4578 #endif /* not DOS_NT */
4582 #ifdef CLASH_DETECTION
4584 if (!auto_saving
) unlock_file (lockname
);
4586 #endif /* CLASH_DETECTION */
4588 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
4591 record_unwind_protect (close_file_unwind
, make_number (desc
));
4593 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
4597 if (NUMBERP (append
))
4598 ret
= lseek (desc
, XINT (append
), 1);
4600 ret
= lseek (desc
, 0, 2);
4603 #ifdef CLASH_DETECTION
4604 if (!auto_saving
) unlock_file (lockname
);
4605 #endif /* CLASH_DETECTION */
4607 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
4616 if (STRINGP (start
))
4618 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
4619 &annotations
, &coding
);
4622 else if (XINT (start
) != XINT (end
))
4624 failure
= 0 > a_write (desc
, Qnil
,
4625 XINT (start
), XINT (end
) - XINT (start
),
4626 &annotations
, &coding
);
4631 /* If file was empty, still need to write the annotations */
4632 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4633 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
4637 if (CODING_REQUIRE_FLUSHING (&coding
)
4638 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
4641 /* We have to flush out a data. */
4642 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4643 failure
= 0 > e_write (desc
, Qnil
, 1, 1, &coding
);
4650 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4651 Disk full in NFS may be reported here. */
4652 /* mib says that closing the file will try to write as fast as NFS can do
4653 it, and that means the fsync here is not crucial for autosave files. */
4654 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
4656 /* If fsync fails with EINTR, don't treat that as serious. Also
4657 ignore EINVAL which happens when fsync is not supported on this
4659 if (errno
!= EINTR
&& errno
!= EINVAL
)
4660 failure
= 1, save_errno
= errno
;
4664 /* NFS can report a write failure now. */
4665 if (emacs_close (desc
) < 0)
4666 failure
= 1, save_errno
= errno
;
4670 /* Discard the unwind protect for close_file_unwind. */
4671 specpdl_ptr
= specpdl
+ count1
;
4673 /* Call write-region-post-annotation-function. */
4674 while (CONSP (Vwrite_region_annotation_buffers
))
4676 Lisp_Object buf
= XCAR (Vwrite_region_annotation_buffers
);
4677 if (!NILP (Fbuffer_live_p (buf
)))
4680 if (FUNCTIONP (Vwrite_region_post_annotation_function
))
4681 call0 (Vwrite_region_post_annotation_function
);
4683 Vwrite_region_annotation_buffers
4684 = XCDR (Vwrite_region_annotation_buffers
);
4687 unbind_to (count
, Qnil
);
4689 #ifdef CLASH_DETECTION
4691 unlock_file (lockname
);
4692 #endif /* CLASH_DETECTION */
4694 /* Do this before reporting IO error
4695 to avoid a "file has changed on disk" warning on
4696 next attempt to save. */
4698 current_buffer
->modtime
= st
.st_mtime
;
4701 error ("IO error writing %s: %s", SDATA (filename
),
4702 emacs_strerror (save_errno
));
4706 SAVE_MODIFF
= MODIFF
;
4707 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4708 current_buffer
->filename
= visit_file
;
4709 update_mode_lines
++;
4714 && ! NILP (Fstring_equal (current_buffer
->filename
,
4715 current_buffer
->auto_save_file_name
)))
4716 SAVE_MODIFF
= MODIFF
;
4722 message_with_string ((INTEGERP (append
)
4732 Lisp_Object
merge ();
4734 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
4735 doc
: /* Return t if (car A) is numerically less than (car B). */)
4739 return Flss (Fcar (a
), Fcar (b
));
4742 /* Build the complete list of annotations appropriate for writing out
4743 the text between START and END, by calling all the functions in
4744 write-region-annotate-functions and merging the lists they return.
4745 If one of these functions switches to a different buffer, we assume
4746 that buffer contains altered text. Therefore, the caller must
4747 make sure to restore the current buffer in all cases,
4748 as save-excursion would do. */
4751 build_annotations (start
, end
)
4752 Lisp_Object start
, end
;
4754 Lisp_Object annotations
;
4756 struct gcpro gcpro1
, gcpro2
;
4757 Lisp_Object original_buffer
;
4758 int i
, used_global
= 0;
4760 XSETBUFFER (original_buffer
, current_buffer
);
4763 p
= Vwrite_region_annotate_functions
;
4764 GCPRO2 (annotations
, p
);
4767 struct buffer
*given_buffer
= current_buffer
;
4768 if (EQ (Qt
, XCAR (p
)) && !used_global
)
4769 { /* Use the global value of the hook. */
4772 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
4774 p
= Fappend (2, arg
);
4777 Vwrite_region_annotations_so_far
= annotations
;
4778 res
= call2 (XCAR (p
), start
, end
);
4779 /* If the function makes a different buffer current,
4780 assume that means this buffer contains altered text to be output.
4781 Reset START and END from the buffer bounds
4782 and discard all previous annotations because they should have
4783 been dealt with by this function. */
4784 if (current_buffer
!= given_buffer
)
4786 Vwrite_region_annotation_buffers
4787 = Fcons (Fcurrent_buffer (),
4788 Vwrite_region_annotation_buffers
);
4789 XSETFASTINT (start
, BEGV
);
4790 XSETFASTINT (end
, ZV
);
4793 Flength (res
); /* Check basic validity of return value */
4794 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4798 /* Now do the same for annotation functions implied by the file-format */
4799 if (auto_saving
&& (!EQ (current_buffer
->auto_save_file_format
, Qt
)))
4800 p
= current_buffer
->auto_save_file_format
;
4802 p
= current_buffer
->file_format
;
4803 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
4805 struct buffer
*given_buffer
= current_buffer
;
4807 Vwrite_region_annotations_so_far
= annotations
;
4809 /* Value is either a list of annotations or nil if the function
4810 has written annotations to a temporary buffer, which is now
4812 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
4813 original_buffer
, make_number (i
));
4814 if (current_buffer
!= given_buffer
)
4816 XSETFASTINT (start
, BEGV
);
4817 XSETFASTINT (end
, ZV
);
4822 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
4830 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4831 If STRING is nil, POS is the character position in the current buffer.
4832 Intersperse with them the annotations from *ANNOT
4833 which fall within the range of POS to POS + NCHARS,
4834 each at its appropriate position.
4836 We modify *ANNOT by discarding elements as we use them up.
4838 The return value is negative in case of system call failure. */
4841 a_write (desc
, string
, pos
, nchars
, annot
, coding
)
4844 register int nchars
;
4847 struct coding_system
*coding
;
4851 int lastpos
= pos
+ nchars
;
4853 while (NILP (*annot
) || CONSP (*annot
))
4855 tem
= Fcar_safe (Fcar (*annot
));
4858 nextpos
= XFASTINT (tem
);
4860 /* If there are no more annotations in this range,
4861 output the rest of the range all at once. */
4862 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
4863 return e_write (desc
, string
, pos
, lastpos
, coding
);
4865 /* Output buffer text up to the next annotation's position. */
4868 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
4872 /* Output the annotation. */
4873 tem
= Fcdr (Fcar (*annot
));
4876 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
4879 *annot
= Fcdr (*annot
);
4885 /* Write text in the range START and END into descriptor DESC,
4886 encoding them with coding system CODING. If STRING is nil, START
4887 and END are character positions of the current buffer, else they
4888 are indexes to the string STRING. */
4891 e_write (desc
, string
, start
, end
, coding
)
4895 struct coding_system
*coding
;
4897 if (STRINGP (string
))
4900 end
= SCHARS (string
);
4903 /* We used to have a code for handling selective display here. But,
4904 now it is handled within encode_coding. */
4908 if (STRINGP (string
))
4910 coding
->src_multibyte
= SCHARS (string
) < SBYTES (string
);
4911 if (CODING_REQUIRE_ENCODING (coding
))
4913 encode_coding_object (coding
, string
,
4914 start
, string_char_to_byte (string
, start
),
4915 end
, string_char_to_byte (string
, end
), Qt
);
4919 coding
->dst_object
= string
;
4920 coding
->consumed_char
= SCHARS (string
);
4921 coding
->produced
= SBYTES (string
);
4926 int start_byte
= CHAR_TO_BYTE (start
);
4927 int end_byte
= CHAR_TO_BYTE (end
);
4929 coding
->src_multibyte
= (end
- start
) < (end_byte
- start_byte
);
4930 if (CODING_REQUIRE_ENCODING (coding
))
4932 encode_coding_object (coding
, Fcurrent_buffer (),
4933 start
, start_byte
, end
, end_byte
, Qt
);
4937 coding
->dst_object
= Qnil
;
4938 coding
->dst_pos_byte
= start_byte
;
4939 if (start
>= GPT
|| end
<= GPT
)
4941 coding
->consumed_char
= end
- start
;
4942 coding
->produced
= end_byte
- start_byte
;
4946 coding
->consumed_char
= GPT
- start
;
4947 coding
->produced
= GPT_BYTE
- start_byte
;
4952 if (coding
->produced
> 0)
4956 STRINGP (coding
->dst_object
)
4957 ? SDATA (coding
->dst_object
)
4958 : BYTE_POS_ADDR (coding
->dst_pos_byte
),
4961 if (coding
->produced
)
4964 start
+= coding
->consumed_char
;
4970 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
4971 Sverify_visited_file_modtime
, 1, 1, 0,
4972 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
4973 This means that the file has not been changed since it was visited or saved.
4974 See Info node `(elisp)Modification Time' for more details. */)
4980 Lisp_Object handler
;
4981 Lisp_Object filename
;
4986 if (!STRINGP (b
->filename
)) return Qt
;
4987 if (b
->modtime
== 0) return Qt
;
4989 /* If the file name has special constructs in it,
4990 call the corresponding file handler. */
4991 handler
= Ffind_file_name_handler (b
->filename
,
4992 Qverify_visited_file_modtime
);
4993 if (!NILP (handler
))
4994 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
4996 filename
= ENCODE_FILE (b
->filename
);
4998 if (stat (SDATA (filename
), &st
) < 0)
5000 /* If the file doesn't exist now and didn't exist before,
5001 we say that it isn't modified, provided the error is a tame one. */
5002 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
5007 if (st
.st_mtime
== b
->modtime
5008 /* If both are positive, accept them if they are off by one second. */
5009 || (st
.st_mtime
> 0 && b
->modtime
> 0
5010 && (st
.st_mtime
== b
->modtime
+ 1
5011 || st
.st_mtime
== b
->modtime
- 1)))
5016 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5017 Sclear_visited_file_modtime
, 0, 0, 0,
5018 doc
: /* Clear out records of last mod time of visited file.
5019 Next attempt to save will certainly not complain of a discrepancy. */)
5022 current_buffer
->modtime
= 0;
5026 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5027 Svisited_file_modtime
, 0, 0, 0,
5028 doc
: /* Return the current buffer's recorded visited file modification time.
5029 The value is a list of the form (HIGH LOW), like the time values
5030 that `file-attributes' returns. If the current buffer has no recorded
5031 file modification time, this function returns 0.
5032 See Info node `(elisp)Modification Time' for more details. */)
5035 if (! current_buffer
->modtime
)
5036 return make_number (0);
5037 return make_time ((time_t) current_buffer
->modtime
);
5040 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5041 Sset_visited_file_modtime
, 0, 1, 0,
5042 doc
: /* Update buffer's recorded modification time from the visited file's time.
5043 Useful if the buffer was not read from the file normally
5044 or if the file itself has been changed for some known benign reason.
5045 An argument specifies the modification time value to use
5046 \(instead of that of the visited file), in the form of a list
5047 \(HIGH . LOW) or (HIGH LOW). */)
5049 Lisp_Object time_list
;
5051 if (!NILP (time_list
))
5052 current_buffer
->modtime
= cons_to_long (time_list
);
5055 register Lisp_Object filename
;
5057 Lisp_Object handler
;
5059 filename
= Fexpand_file_name (current_buffer
->filename
, Qnil
);
5061 /* If the file name has special constructs in it,
5062 call the corresponding file handler. */
5063 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5064 if (!NILP (handler
))
5065 /* The handler can find the file name the same way we did. */
5066 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5068 filename
= ENCODE_FILE (filename
);
5070 if (stat (SDATA (filename
), &st
) >= 0)
5071 current_buffer
->modtime
= st
.st_mtime
;
5078 auto_save_error (error
)
5081 Lisp_Object args
[3], msg
;
5083 struct gcpro gcpro1
;
5087 auto_save_error_occurred
= 1;
5089 ring_bell (XFRAME (selected_frame
));
5091 args
[0] = build_string ("Auto-saving %s: %s");
5092 args
[1] = current_buffer
->name
;
5093 args
[2] = Ferror_message_string (error
);
5094 msg
= Fformat (3, args
);
5096 nbytes
= SBYTES (msg
);
5097 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5098 bcopy (SDATA (msg
), msgbuf
, nbytes
);
5100 for (i
= 0; i
< 3; ++i
)
5103 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5105 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5106 Fsleep_for (make_number (1), Qnil
);
5120 auto_save_mode_bits
= 0666;
5122 /* Get visited file's mode to become the auto save file's mode. */
5123 if (! NILP (current_buffer
->filename
))
5125 if (stat (SDATA (current_buffer
->filename
), &st
) >= 0)
5126 /* But make sure we can overwrite it later! */
5127 auto_save_mode_bits
= st
.st_mode
| 0600;
5128 else if ((modes
= Ffile_modes (current_buffer
->filename
),
5130 /* Remote files don't cooperate with stat. */
5131 auto_save_mode_bits
= XINT (modes
) | 0600;
5135 Fwrite_region (Qnil
, Qnil
, current_buffer
->auto_save_file_name
, Qnil
,
5136 NILP (Vauto_save_visited_file_name
) ? Qlambda
: Qt
,
5141 do_auto_save_unwind (arg
) /* used as unwind-protect function */
5144 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5156 do_auto_save_unwind_1 (value
) /* used as unwind-protect function */
5159 minibuffer_auto_raise
= XINT (value
);
5164 do_auto_save_make_dir (dir
)
5169 call2 (Qmake_directory
, dir
, Qt
);
5170 XSETFASTINT (mode
, 0700);
5171 return Fset_file_modes (dir
, mode
);
5175 do_auto_save_eh (ignore
)
5181 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5182 doc
: /* Auto-save all buffers that need it.
5183 This is all buffers that have auto-saving enabled
5184 and are changed since last auto-saved.
5185 Auto-saving writes the buffer into a file
5186 so that your editing is not lost if the system crashes.
5187 This file is not the file you visited; that changes only when you save.
5188 Normally we run the normal hook `auto-save-hook' before saving.
5190 A non-nil NO-MESSAGE argument means do not print any message if successful.
5191 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5192 (no_message
, current_only
)
5193 Lisp_Object no_message
, current_only
;
5195 struct buffer
*old
= current_buffer
, *b
;
5196 Lisp_Object tail
, buf
;
5198 int do_handled_files
;
5200 FILE *stream
= NULL
;
5201 int count
= SPECPDL_INDEX ();
5202 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5203 int old_message_p
= 0;
5204 struct gcpro gcpro1
, gcpro2
;
5206 if (max_specpdl_size
< specpdl_size
+ 40)
5207 max_specpdl_size
= specpdl_size
+ 40;
5212 if (NILP (no_message
))
5214 old_message_p
= push_message ();
5215 record_unwind_protect (pop_message_unwind
, Qnil
);
5218 /* Ordinarily don't quit within this function,
5219 but don't make it impossible to quit (in case we get hung in I/O). */
5223 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5224 point to non-strings reached from Vbuffer_alist. */
5226 if (!NILP (Vrun_hooks
))
5227 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5229 if (STRINGP (Vauto_save_list_file_name
))
5231 Lisp_Object listfile
;
5233 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5235 /* Don't try to create the directory when shutting down Emacs,
5236 because creating the directory might signal an error, and
5237 that would leave Emacs in a strange state. */
5238 if (!NILP (Vrun_hooks
))
5242 GCPRO2 (dir
, listfile
);
5243 dir
= Ffile_name_directory (listfile
);
5244 if (NILP (Ffile_directory_p (dir
)))
5245 internal_condition_case_1 (do_auto_save_make_dir
,
5246 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5251 stream
= fopen (SDATA (listfile
), "w");
5254 record_unwind_protect (do_auto_save_unwind
,
5255 make_save_value (stream
, 0));
5256 record_unwind_protect (do_auto_save_unwind_1
,
5257 make_number (minibuffer_auto_raise
));
5258 minibuffer_auto_raise
= 0;
5260 auto_save_error_occurred
= 0;
5262 /* On first pass, save all files that don't have handlers.
5263 On second pass, save all files that do have handlers.
5265 If Emacs is crashing, the handlers may tweak what is causing
5266 Emacs to crash in the first place, and it would be a shame if
5267 Emacs failed to autosave perfectly ordinary files because it
5268 couldn't handle some ange-ftp'd file. */
5270 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5271 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
5273 buf
= XCDR (XCAR (tail
));
5276 /* Record all the buffers that have auto save mode
5277 in the special file that lists them. For each of these buffers,
5278 Record visited name (if any) and auto save name. */
5279 if (STRINGP (b
->auto_save_file_name
)
5280 && stream
!= NULL
&& do_handled_files
== 0)
5283 if (!NILP (b
->filename
))
5285 fwrite (SDATA (b
->filename
), 1,
5286 SBYTES (b
->filename
), stream
);
5288 putc ('\n', stream
);
5289 fwrite (SDATA (b
->auto_save_file_name
), 1,
5290 SBYTES (b
->auto_save_file_name
), stream
);
5291 putc ('\n', stream
);
5295 if (!NILP (current_only
)
5296 && b
!= current_buffer
)
5299 /* Don't auto-save indirect buffers.
5300 The base buffer takes care of it. */
5304 /* Check for auto save enabled
5305 and file changed since last auto save
5306 and file changed since last real save. */
5307 if (STRINGP (b
->auto_save_file_name
)
5308 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5309 && b
->auto_save_modified
< BUF_MODIFF (b
)
5310 /* -1 means we've turned off autosaving for a while--see below. */
5311 && XINT (b
->save_length
) >= 0
5312 && (do_handled_files
5313 || NILP (Ffind_file_name_handler (b
->auto_save_file_name
,
5316 EMACS_TIME before_time
, after_time
;
5318 EMACS_GET_TIME (before_time
);
5320 /* If we had a failure, don't try again for 20 minutes. */
5321 if (b
->auto_save_failure_time
>= 0
5322 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5325 if ((XFASTINT (b
->save_length
) * 10
5326 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5327 /* A short file is likely to change a large fraction;
5328 spare the user annoying messages. */
5329 && XFASTINT (b
->save_length
) > 5000
5330 /* These messages are frequent and annoying for `*mail*'. */
5331 && !EQ (b
->filename
, Qnil
)
5332 && NILP (no_message
))
5334 /* It has shrunk too much; turn off auto-saving here. */
5335 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5336 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5338 minibuffer_auto_raise
= 0;
5339 /* Turn off auto-saving until there's a real save,
5340 and prevent any more warnings. */
5341 XSETINT (b
->save_length
, -1);
5342 Fsleep_for (make_number (1), Qnil
);
5345 set_buffer_internal (b
);
5346 if (!auto_saved
&& NILP (no_message
))
5347 message1 ("Auto-saving...");
5348 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5350 b
->auto_save_modified
= BUF_MODIFF (b
);
5351 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5352 set_buffer_internal (old
);
5354 EMACS_GET_TIME (after_time
);
5356 /* If auto-save took more than 60 seconds,
5357 assume it was an NFS failure that got a timeout. */
5358 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5359 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5363 /* Prevent another auto save till enough input events come in. */
5364 record_auto_save ();
5366 if (auto_saved
&& NILP (no_message
))
5370 /* If we are going to restore an old message,
5371 give time to read ours. */
5372 sit_for (make_number (1), 0, 0);
5375 else if (!auto_save_error_occurred
)
5376 /* Don't overwrite the error message if an error occurred.
5377 If we displayed a message and then restored a state
5378 with no message, leave a "done" message on the screen. */
5379 message1 ("Auto-saving...done");
5384 /* This restores the message-stack status. */
5385 unbind_to (count
, Qnil
);
5389 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5390 Sset_buffer_auto_saved
, 0, 0, 0,
5391 doc
: /* Mark current buffer as auto-saved with its current text.
5392 No auto-save file will be written until the buffer changes again. */)
5395 current_buffer
->auto_save_modified
= MODIFF
;
5396 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5397 current_buffer
->auto_save_failure_time
= -1;
5401 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
5402 Sclear_buffer_auto_save_failure
, 0, 0, 0,
5403 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
5406 current_buffer
->auto_save_failure_time
= -1;
5410 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
5412 doc
: /* Return t if current buffer has been auto-saved recently.
5413 More precisely, if it has been auto-saved since last read from or saved
5414 in the visited file. If the buffer has no visited file,
5415 then any auto-save counts as "recent". */)
5418 return (SAVE_MODIFF
< current_buffer
->auto_save_modified
) ? Qt
: Qnil
;
5421 /* Reading and completing file names */
5423 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
5424 Snext_read_file_uses_dialog_p
, 0, 0, 0,
5425 doc
: /* Return t if a call to `read-file-name' will use a dialog.
5426 The return value is only relevant for a call to `read-file-name' that happens
5427 before any other event (mouse or keypress) is handled. */)
5430 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5431 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
5441 Fread_file_name (prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
)
5442 Lisp_Object prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
;
5444 struct gcpro gcpro1
, gcpro2
;
5445 Lisp_Object args
[7];
5447 GCPRO1 (default_filename
);
5448 args
[0] = intern ("read-file-name");
5451 args
[3] = default_filename
;
5452 args
[4] = mustmatch
;
5454 args
[6] = predicate
;
5455 RETURN_UNGCPRO (Ffuncall (7, args
));
5462 /* Must be set before any path manipulation is performed. */
5463 XSETFASTINT (Vdirectory_sep_char
, '/');
5470 Qoperations
= intern ("operations");
5471 Qexpand_file_name
= intern ("expand-file-name");
5472 Qsubstitute_in_file_name
= intern ("substitute-in-file-name");
5473 Qdirectory_file_name
= intern ("directory-file-name");
5474 Qfile_name_directory
= intern ("file-name-directory");
5475 Qfile_name_nondirectory
= intern ("file-name-nondirectory");
5476 Qunhandled_file_name_directory
= intern ("unhandled-file-name-directory");
5477 Qfile_name_as_directory
= intern ("file-name-as-directory");
5478 Qcopy_file
= intern ("copy-file");
5479 Qmake_directory_internal
= intern ("make-directory-internal");
5480 Qmake_directory
= intern ("make-directory");
5481 Qdelete_directory
= intern ("delete-directory");
5482 Qdelete_file
= intern ("delete-file");
5483 Qrename_file
= intern ("rename-file");
5484 Qadd_name_to_file
= intern ("add-name-to-file");
5485 Qmake_symbolic_link
= intern ("make-symbolic-link");
5486 Qfile_exists_p
= intern ("file-exists-p");
5487 Qfile_executable_p
= intern ("file-executable-p");
5488 Qfile_readable_p
= intern ("file-readable-p");
5489 Qfile_writable_p
= intern ("file-writable-p");
5490 Qfile_symlink_p
= intern ("file-symlink-p");
5491 Qaccess_file
= intern ("access-file");
5492 Qfile_directory_p
= intern ("file-directory-p");
5493 Qfile_regular_p
= intern ("file-regular-p");
5494 Qfile_accessible_directory_p
= intern ("file-accessible-directory-p");
5495 Qfile_modes
= intern ("file-modes");
5496 Qset_file_modes
= intern ("set-file-modes");
5497 Qset_file_times
= intern ("set-file-times");
5498 Qfile_newer_than_file_p
= intern ("file-newer-than-file-p");
5499 Qinsert_file_contents
= intern ("insert-file-contents");
5500 Qwrite_region
= intern ("write-region");
5501 Qverify_visited_file_modtime
= intern ("verify-visited-file-modtime");
5502 Qset_visited_file_modtime
= intern ("set-visited-file-modtime");
5503 Qauto_save_coding
= intern ("auto-save-coding");
5505 staticpro (&Qoperations
);
5506 staticpro (&Qexpand_file_name
);
5507 staticpro (&Qsubstitute_in_file_name
);
5508 staticpro (&Qdirectory_file_name
);
5509 staticpro (&Qfile_name_directory
);
5510 staticpro (&Qfile_name_nondirectory
);
5511 staticpro (&Qunhandled_file_name_directory
);
5512 staticpro (&Qfile_name_as_directory
);
5513 staticpro (&Qcopy_file
);
5514 staticpro (&Qmake_directory_internal
);
5515 staticpro (&Qmake_directory
);
5516 staticpro (&Qdelete_directory
);
5517 staticpro (&Qdelete_file
);
5518 staticpro (&Qrename_file
);
5519 staticpro (&Qadd_name_to_file
);
5520 staticpro (&Qmake_symbolic_link
);
5521 staticpro (&Qfile_exists_p
);
5522 staticpro (&Qfile_executable_p
);
5523 staticpro (&Qfile_readable_p
);
5524 staticpro (&Qfile_writable_p
);
5525 staticpro (&Qaccess_file
);
5526 staticpro (&Qfile_symlink_p
);
5527 staticpro (&Qfile_directory_p
);
5528 staticpro (&Qfile_regular_p
);
5529 staticpro (&Qfile_accessible_directory_p
);
5530 staticpro (&Qfile_modes
);
5531 staticpro (&Qset_file_modes
);
5532 staticpro (&Qset_file_times
);
5533 staticpro (&Qfile_newer_than_file_p
);
5534 staticpro (&Qinsert_file_contents
);
5535 staticpro (&Qwrite_region
);
5536 staticpro (&Qverify_visited_file_modtime
);
5537 staticpro (&Qset_visited_file_modtime
);
5538 staticpro (&Qauto_save_coding
);
5540 Qfile_name_history
= intern ("file-name-history");
5541 Fset (Qfile_name_history
, Qnil
);
5542 staticpro (&Qfile_name_history
);
5544 Qfile_error
= intern ("file-error");
5545 staticpro (&Qfile_error
);
5546 Qfile_already_exists
= intern ("file-already-exists");
5547 staticpro (&Qfile_already_exists
);
5548 Qfile_date_error
= intern ("file-date-error");
5549 staticpro (&Qfile_date_error
);
5550 Qexcl
= intern ("excl");
5554 Qfind_buffer_file_type
= intern ("find-buffer-file-type");
5555 staticpro (&Qfind_buffer_file_type
);
5558 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system
,
5559 doc
: /* *Coding system for encoding file names.
5560 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5561 Vfile_name_coding_system
= Qnil
;
5563 DEFVAR_LISP ("default-file-name-coding-system",
5564 &Vdefault_file_name_coding_system
,
5565 doc
: /* Default coding system for encoding file names.
5566 This variable is used only when `file-name-coding-system' is nil.
5568 This variable is set/changed by the command `set-language-environment'.
5569 User should not set this variable manually,
5570 instead use `file-name-coding-system' to get a constant encoding
5571 of file names regardless of the current language environment. */);
5572 Vdefault_file_name_coding_system
= Qnil
;
5574 Qformat_decode
= intern ("format-decode");
5575 staticpro (&Qformat_decode
);
5576 Qformat_annotate_function
= intern ("format-annotate-function");
5577 staticpro (&Qformat_annotate_function
);
5578 Qafter_insert_file_set_coding
= intern ("after-insert-file-set-coding");
5579 staticpro (&Qafter_insert_file_set_coding
);
5581 Qcar_less_than_car
= intern ("car-less-than-car");
5582 staticpro (&Qcar_less_than_car
);
5584 Fput (Qfile_error
, Qerror_conditions
,
5585 list2 (Qfile_error
, Qerror
));
5586 Fput (Qfile_error
, Qerror_message
,
5587 build_string ("File error"));
5589 Fput (Qfile_already_exists
, Qerror_conditions
,
5590 list3 (Qfile_already_exists
, Qfile_error
, Qerror
));
5591 Fput (Qfile_already_exists
, Qerror_message
,
5592 build_string ("File already exists"));
5594 Fput (Qfile_date_error
, Qerror_conditions
,
5595 list3 (Qfile_date_error
, Qfile_error
, Qerror
));
5596 Fput (Qfile_date_error
, Qerror_message
,
5597 build_string ("Cannot set file date"));
5599 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char
,
5600 doc
: /* Directory separator character for built-in functions that return file names.
5601 The value is always ?/. Don't use this variable, just use `/'. */);
5603 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist
,
5604 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
5605 If a file name matches REGEXP, then all I/O on that file is done by calling
5608 The first argument given to HANDLER is the name of the I/O primitive
5609 to be handled; the remaining arguments are the arguments that were
5610 passed to that primitive. For example, if you do
5611 (file-exists-p FILENAME)
5612 and FILENAME is handled by HANDLER, then HANDLER is called like this:
5613 (funcall HANDLER 'file-exists-p FILENAME)
5614 The function `find-file-name-handler' checks this list for a handler
5615 for its argument. */);
5616 Vfile_name_handler_alist
= Qnil
;
5618 DEFVAR_LISP ("set-auto-coding-function",
5619 &Vset_auto_coding_function
,
5620 doc
: /* If non-nil, a function to call to decide a coding system of file.
5621 Two arguments are passed to this function: the file name
5622 and the length of a file contents following the point.
5623 This function should return a coding system to decode the file contents.
5624 It should check the file name against `auto-coding-alist'.
5625 If no coding system is decided, it should check a coding system
5626 specified in the heading lines with the format:
5627 -*- ... coding: CODING-SYSTEM; ... -*-
5628 or local variable spec of the tailing lines with `coding:' tag. */);
5629 Vset_auto_coding_function
= Qnil
;
5631 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions
,
5632 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
5633 Each is passed one argument, the number of characters inserted,
5634 with point at the start of the inserted text. Each function
5635 should leave point the same, and return the new character count.
5636 If `insert-file-contents' is intercepted by a handler from
5637 `file-name-handler-alist', that handler is responsible for calling the
5638 functions in `after-insert-file-functions' if appropriate. */);
5639 Vafter_insert_file_functions
= Qnil
;
5641 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions
,
5642 doc
: /* A list of functions to be called at the start of `write-region'.
5643 Each is passed two arguments, START and END as for `write-region'.
5644 These are usually two numbers but not always; see the documentation
5645 for `write-region'. The function should return a list of pairs
5646 of the form (POSITION . STRING), consisting of strings to be effectively
5647 inserted at the specified positions of the file being written (1 means to
5648 insert before the first byte written). The POSITIONs must be sorted into
5651 If there are several annotation functions, the lists returned by these
5652 functions are merged destructively. As each annotation function runs,
5653 the variable `write-region-annotations-so-far' contains a list of all
5654 annotations returned by previous annotation functions.
5656 An annotation function can return with a different buffer current.
5657 Doing so removes the annotations returned by previous functions, and
5658 resets START and END to `point-min' and `point-max' of the new buffer.
5660 After `write-region' completes, Emacs calls the function stored in
5661 `write-region-post-annotation-function', once for each buffer that was
5662 current when building the annotations (i.e., at least once), with that
5663 buffer current. */);
5664 Vwrite_region_annotate_functions
= Qnil
;
5665 staticpro (&Qwrite_region_annotate_functions
);
5666 Qwrite_region_annotate_functions
5667 = intern ("write-region-annotate-functions");
5669 DEFVAR_LISP ("write-region-post-annotation-function",
5670 &Vwrite_region_post_annotation_function
,
5671 doc
: /* Function to call after `write-region' completes.
5672 The function is called with no arguments. If one or more of the
5673 annotation functions in `write-region-annotate-functions' changed the
5674 current buffer, the function stored in this variable is called for
5675 each of those additional buffers as well, in addition to the original
5676 buffer. The relevant buffer is current during each function call. */);
5677 Vwrite_region_post_annotation_function
= Qnil
;
5678 staticpro (&Vwrite_region_annotation_buffers
);
5680 DEFVAR_LISP ("write-region-annotations-so-far",
5681 &Vwrite_region_annotations_so_far
,
5682 doc
: /* When an annotation function is called, this holds the previous annotations.
5683 These are the annotations made by other annotation functions
5684 that were already called. See also `write-region-annotate-functions'. */);
5685 Vwrite_region_annotations_so_far
= Qnil
;
5687 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers
,
5688 doc
: /* A list of file name handlers that temporarily should not be used.
5689 This applies only to the operation `inhibit-file-name-operation'. */);
5690 Vinhibit_file_name_handlers
= Qnil
;
5692 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation
,
5693 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5694 Vinhibit_file_name_operation
= Qnil
;
5696 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name
,
5697 doc
: /* File name in which we write a list of all auto save file names.
5698 This variable is initialized automatically from `auto-save-list-file-prefix'
5699 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5700 a non-nil value. */);
5701 Vauto_save_list_file_name
= Qnil
;
5703 DEFVAR_LISP ("auto-save-visited-file-name", &Vauto_save_visited_file_name
,
5704 doc
: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5705 Normally auto-save files are written under other names. */);
5706 Vauto_save_visited_file_name
= Qnil
;
5709 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync
,
5710 doc
: /* *Non-nil means don't call fsync in `write-region'.
5711 This variable affects calls to `write-region' as well as save commands.
5712 A non-nil value may result in data loss! */);
5713 write_region_inhibit_fsync
= 0;
5716 DEFVAR_BOOL ("delete-by-moving-to-trash", &delete_by_moving_to_trash
,
5717 doc
: /* Specifies whether to use the system's trash can.
5718 When non-nil, the function `move-file-to-trash' will be used by
5719 `delete-file' and `delete-directory'. */);
5720 delete_by_moving_to_trash
= 0;
5721 Qdelete_by_moving_to_trash
= intern ("delete-by-moving-to-trash");
5722 Qmove_file_to_trash
= intern ("move-file-to-trash");
5723 staticpro (&Qmove_file_to_trash
);
5725 defsubr (&Sfind_file_name_handler
);
5726 defsubr (&Sfile_name_directory
);
5727 defsubr (&Sfile_name_nondirectory
);
5728 defsubr (&Sunhandled_file_name_directory
);
5729 defsubr (&Sfile_name_as_directory
);
5730 defsubr (&Sdirectory_file_name
);
5731 defsubr (&Smake_temp_name
);
5732 defsubr (&Sexpand_file_name
);
5733 defsubr (&Ssubstitute_in_file_name
);
5734 defsubr (&Scopy_file
);
5735 defsubr (&Smake_directory_internal
);
5736 defsubr (&Sdelete_directory
);
5737 defsubr (&Sdelete_file
);
5738 defsubr (&Srename_file
);
5739 defsubr (&Sadd_name_to_file
);
5740 defsubr (&Smake_symbolic_link
);
5741 defsubr (&Sfile_name_absolute_p
);
5742 defsubr (&Sfile_exists_p
);
5743 defsubr (&Sfile_executable_p
);
5744 defsubr (&Sfile_readable_p
);
5745 defsubr (&Sfile_writable_p
);
5746 defsubr (&Saccess_file
);
5747 defsubr (&Sfile_symlink_p
);
5748 defsubr (&Sfile_directory_p
);
5749 defsubr (&Sfile_accessible_directory_p
);
5750 defsubr (&Sfile_regular_p
);
5751 defsubr (&Sfile_modes
);
5752 defsubr (&Sset_file_modes
);
5753 defsubr (&Sset_file_times
);
5754 defsubr (&Sset_default_file_modes
);
5755 defsubr (&Sdefault_file_modes
);
5756 defsubr (&Sfile_newer_than_file_p
);
5757 defsubr (&Sinsert_file_contents
);
5758 defsubr (&Swrite_region
);
5759 defsubr (&Scar_less_than_car
);
5760 defsubr (&Sverify_visited_file_modtime
);
5761 defsubr (&Sclear_visited_file_modtime
);
5762 defsubr (&Svisited_file_modtime
);
5763 defsubr (&Sset_visited_file_modtime
);
5764 defsubr (&Sdo_auto_save
);
5765 defsubr (&Sset_buffer_auto_saved
);
5766 defsubr (&Sclear_buffer_auto_save_failure
);
5767 defsubr (&Srecent_auto_save_p
);
5769 defsubr (&Snext_read_file_uses_dialog_p
);
5772 defsubr (&Sunix_sync
);
5776 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
5777 (do not change this comment) */