1 /* File IO for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2001, 2003, 2004, 2005 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
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)
74 #include "intervals.h"
80 #include "dispextern.h"
87 #endif /* not WINDOWSNT */
91 #include <sys/param.h>
99 #define CORRECT_DIR_SEPS(s) \
100 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
101 else unixtodos_filename (s); \
103 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
104 redirector allows the six letters between 'Z' and 'a' as well. */
106 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
109 #define IS_DRIVE(x) isalpha (x)
111 /* Need to lower-case the drive letter, or else expanded
112 filenames will sometimes compare inequal, because
113 `expand-file-name' doesn't always down-case the drive letter. */
114 #define DRIVE_LETTER(x) (tolower (x))
135 #include "commands.h"
136 extern int use_dialog_box
;
137 extern int use_file_dialog
;
151 #ifndef FILE_SYSTEM_CASE
152 #define FILE_SYSTEM_CASE(filename) (filename)
155 /* Nonzero during writing of auto-save files */
158 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
159 a new file with the same mode as the original */
160 int auto_save_mode_bits
;
162 /* The symbol bound to coding-system-for-read when
163 insert-file-contents is called for recovering a file. This is not
164 an actual coding system name, but just an indicator to tell
165 insert-file-contents to use `emacs-mule' with a special flag for
166 auto saving and recovering a file. */
167 Lisp_Object Qauto_save_coding
;
169 /* Coding system for file names, or nil if none. */
170 Lisp_Object Vfile_name_coding_system
;
172 /* Coding system for file names used only when
173 Vfile_name_coding_system is nil. */
174 Lisp_Object Vdefault_file_name_coding_system
;
176 /* Alist of elements (REGEXP . HANDLER) for file names
177 whose I/O is done with a special handler. */
178 Lisp_Object Vfile_name_handler_alist
;
180 /* Property name of a file name handler,
181 which gives a list of operations it handles.. */
182 Lisp_Object Qoperations
;
184 /* Lisp functions for translating file formats */
185 Lisp_Object Qformat_decode
, Qformat_annotate_function
;
187 /* Function to be called to decide a coding system of a reading file. */
188 Lisp_Object Vset_auto_coding_function
;
190 /* Functions to be called to process text properties in inserted file. */
191 Lisp_Object Vafter_insert_file_functions
;
193 /* Lisp function for setting buffer-file-coding-system and the
194 multibyteness of the current buffer after inserting a file. */
195 Lisp_Object Qafter_insert_file_set_coding
;
197 /* Functions to be called to create text property annotations for file. */
198 Lisp_Object Vwrite_region_annotate_functions
;
199 Lisp_Object Qwrite_region_annotate_functions
;
201 /* During build_annotations, each time an annotation function is called,
202 this holds the annotations made by the previous functions. */
203 Lisp_Object Vwrite_region_annotations_so_far
;
205 /* File name in which we write a list of all our auto save files. */
206 Lisp_Object Vauto_save_list_file_name
;
208 /* Function to call to read a file name. */
209 Lisp_Object Vread_file_name_function
;
211 /* Current predicate used by read_file_name_internal. */
212 Lisp_Object Vread_file_name_predicate
;
214 /* Nonzero means completion ignores case when reading file name. */
215 int read_file_name_completion_ignore_case
;
217 /* Nonzero means, when reading a filename in the minibuffer,
218 start out by inserting the default directory into the minibuffer. */
219 int insert_default_directory
;
221 /* On VMS, nonzero means write new files with record format stmlf.
222 Zero means use var format. */
225 /* On NT, specifies the directory separator character, used (eg.) when
226 expanding file names. This can be bound to / or \. */
227 Lisp_Object Vdirectory_sep_char
;
229 extern Lisp_Object Vuser_login_name
;
232 extern Lisp_Object Vw32_get_true_file_attributes
;
235 extern int minibuf_level
;
237 extern int minibuffer_auto_raise
;
239 extern int history_delete_duplicates
;
241 /* These variables describe handlers that have "already" had a chance
242 to handle the current operation.
244 Vinhibit_file_name_handlers is a list of file name handlers.
245 Vinhibit_file_name_operation is the operation being handled.
246 If we try to handle that operation, we ignore those handlers. */
248 static Lisp_Object Vinhibit_file_name_handlers
;
249 static Lisp_Object Vinhibit_file_name_operation
;
251 Lisp_Object Qfile_error
, Qfile_already_exists
, Qfile_date_error
;
253 Lisp_Object Qfile_name_history
;
255 Lisp_Object Qcar_less_than_car
;
257 static int a_write
P_ ((int, Lisp_Object
, int, int,
258 Lisp_Object
*, struct coding_system
*));
259 static int e_write
P_ ((int, Lisp_Object
, int, int, struct coding_system
*));
263 report_file_error (string
, data
)
267 Lisp_Object errstring
;
270 synchronize_system_messages_locale ();
271 errstring
= code_convert_string_norecord (build_string (strerror (errorno
)),
272 Vlocale_coding_system
, 0);
278 Fsignal (Qfile_already_exists
, Fcons (errstring
, data
));
281 /* System error messages are capitalized. Downcase the initial
282 unless it is followed by a slash. */
283 if (SREF (errstring
, 1) != '/')
284 SSET (errstring
, 0, DOWNCASE (SREF (errstring
, 0)));
286 Fsignal (Qfile_error
,
287 Fcons (build_string (string
), Fcons (errstring
, data
)));
292 close_file_unwind (fd
)
295 emacs_close (XFASTINT (fd
));
299 /* Restore point, having saved it as a marker. */
302 restore_point_unwind (location
)
303 Lisp_Object location
;
305 Fgoto_char (location
);
306 Fset_marker (location
, Qnil
, Qnil
);
310 Lisp_Object Qexpand_file_name
;
311 Lisp_Object Qsubstitute_in_file_name
;
312 Lisp_Object Qdirectory_file_name
;
313 Lisp_Object Qfile_name_directory
;
314 Lisp_Object Qfile_name_nondirectory
;
315 Lisp_Object Qunhandled_file_name_directory
;
316 Lisp_Object Qfile_name_as_directory
;
317 Lisp_Object Qcopy_file
;
318 Lisp_Object Qmake_directory_internal
;
319 Lisp_Object Qmake_directory
;
320 Lisp_Object Qdelete_directory
;
321 Lisp_Object Qdelete_file
;
322 Lisp_Object Qrename_file
;
323 Lisp_Object Qadd_name_to_file
;
324 Lisp_Object Qmake_symbolic_link
;
325 Lisp_Object Qfile_exists_p
;
326 Lisp_Object Qfile_executable_p
;
327 Lisp_Object Qfile_readable_p
;
328 Lisp_Object Qfile_writable_p
;
329 Lisp_Object Qfile_symlink_p
;
330 Lisp_Object Qaccess_file
;
331 Lisp_Object Qfile_directory_p
;
332 Lisp_Object Qfile_regular_p
;
333 Lisp_Object Qfile_accessible_directory_p
;
334 Lisp_Object Qfile_modes
;
335 Lisp_Object Qset_file_modes
;
336 Lisp_Object Qset_file_times
;
337 Lisp_Object Qfile_newer_than_file_p
;
338 Lisp_Object Qinsert_file_contents
;
339 Lisp_Object Qwrite_region
;
340 Lisp_Object Qverify_visited_file_modtime
;
341 Lisp_Object Qset_visited_file_modtime
;
343 DEFUN ("find-file-name-handler", Ffind_file_name_handler
, Sfind_file_name_handler
, 2, 2, 0,
344 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
345 Otherwise, return nil.
346 A file name is handled if one of the regular expressions in
347 `file-name-handler-alist' matches it.
349 If OPERATION equals `inhibit-file-name-operation', then we ignore
350 any handlers that are members of `inhibit-file-name-handlers',
351 but we still do run any other handlers. This lets handlers
352 use the standard functions without calling themselves recursively. */)
353 (filename
, operation
)
354 Lisp_Object filename
, operation
;
356 /* This function must not munge the match data. */
357 Lisp_Object chain
, inhibited_handlers
, result
;
361 CHECK_STRING (filename
);
363 if (EQ (operation
, Vinhibit_file_name_operation
))
364 inhibited_handlers
= Vinhibit_file_name_handlers
;
366 inhibited_handlers
= Qnil
;
368 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
369 chain
= XCDR (chain
))
375 Lisp_Object string
= XCAR (elt
);
377 Lisp_Object handler
= XCDR (elt
);
378 Lisp_Object operations
= Qnil
;
380 if (SYMBOLP (handler
))
381 operations
= Fget (handler
, Qoperations
);
384 && (match_pos
= fast_string_match (string
, filename
)) > pos
385 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
389 handler
= XCDR (elt
);
390 tem
= Fmemq (handler
, inhibited_handlers
);
404 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
406 doc
: /* Return the directory component in file name FILENAME.
407 Return nil if FILENAME does not include a directory.
408 Otherwise return a directory spec.
409 Given a Unix syntax file name, returns a string ending in slash;
410 on VMS, perhaps instead a string ending in `:', `]' or `>'. */)
412 Lisp_Object filename
;
415 register const unsigned char *beg
;
417 register unsigned char *beg
;
419 register const unsigned char *p
;
422 CHECK_STRING (filename
);
424 /* If the file name has special constructs in it,
425 call the corresponding file handler. */
426 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
428 return call2 (handler
, Qfile_name_directory
, filename
);
430 filename
= FILE_SYSTEM_CASE (filename
);
431 beg
= SDATA (filename
);
433 beg
= strcpy (alloca (strlen (beg
) + 1), beg
);
435 p
= beg
+ SBYTES (filename
);
437 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
439 && p
[-1] != ':' && p
[-1] != ']' && p
[-1] != '>'
442 /* only recognise drive specifier at the beginning */
444 /* handle the "/:d:foo" and "/:foo" cases correctly */
445 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
446 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
453 /* Expansion of "c:" to drive and default directory. */
456 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
457 unsigned char *res
= alloca (MAXPATHLEN
+ 1);
458 unsigned char *r
= res
;
460 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
462 strncpy (res
, beg
, 2);
467 if (getdefdir (toupper (*beg
) - 'A' + 1, r
))
469 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
472 p
= beg
+ strlen (beg
);
475 CORRECT_DIR_SEPS (beg
);
478 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
481 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
482 Sfile_name_nondirectory
, 1, 1, 0,
483 doc
: /* Return file name FILENAME sans its directory.
484 For example, in a Unix-syntax file name,
485 this is everything after the last slash,
486 or the entire name if it contains no slash. */)
488 Lisp_Object filename
;
490 register const unsigned char *beg
, *p
, *end
;
493 CHECK_STRING (filename
);
495 /* If the file name has special constructs in it,
496 call the corresponding file handler. */
497 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
499 return call2 (handler
, Qfile_name_nondirectory
, filename
);
501 beg
= SDATA (filename
);
502 end
= p
= beg
+ SBYTES (filename
);
504 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
506 && p
[-1] != ':' && p
[-1] != ']' && p
[-1] != '>'
509 /* only recognise drive specifier at beginning */
511 /* handle the "/:d:foo" case correctly */
512 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
517 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
520 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
521 Sunhandled_file_name_directory
, 1, 1, 0,
522 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
523 A `directly usable' directory name is one that may be used without the
524 intervention of any file handler.
525 If FILENAME is a directly usable file itself, return
526 \(file-name-directory FILENAME).
527 The `call-process' and `start-process' functions use this function to
528 get a current directory to run processes in. */)
530 Lisp_Object filename
;
534 /* If the file name has special constructs in it,
535 call the corresponding file handler. */
536 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
538 return call2 (handler
, Qunhandled_file_name_directory
, filename
);
540 return Ffile_name_directory (filename
);
545 file_name_as_directory (out
, in
)
548 int size
= strlen (in
) - 1;
561 /* Is it already a directory string? */
562 if (in
[size
] == ':' || in
[size
] == ']' || in
[size
] == '>')
564 /* Is it a VMS directory file name? If so, hack VMS syntax. */
565 else if (! index (in
, '/')
566 && ((size
> 3 && ! strcmp (&in
[size
- 3], ".DIR"))
567 || (size
> 3 && ! strcmp (&in
[size
- 3], ".dir"))
568 || (size
> 5 && (! strncmp (&in
[size
- 5], ".DIR", 4)
569 || ! strncmp (&in
[size
- 5], ".dir", 4))
570 && (in
[size
- 1] == '.' || in
[size
- 1] == ';')
571 && in
[size
] == '1')))
573 register char *p
, *dot
;
577 dir:x.dir --> dir:[x]
578 dir:[x]y.dir --> dir:[x.y] */
580 while (p
!= in
&& *p
!= ':' && *p
!= '>' && *p
!= ']') p
--;
583 strncpy (out
, in
, p
- in
);
602 dot
= index (p
, '.');
605 /* blindly remove any extension */
606 size
= strlen (out
) + (dot
- p
);
607 strncat (out
, p
, dot
- p
);
618 /* For Unix syntax, Append a slash if necessary */
619 if (!IS_DIRECTORY_SEP (out
[size
]))
621 /* Cannot use DIRECTORY_SEP, which could have any value */
623 out
[size
+ 2] = '\0';
626 CORRECT_DIR_SEPS (out
);
632 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
633 Sfile_name_as_directory
, 1, 1, 0,
634 doc
: /* Return a string representing the file name FILE interpreted as a directory.
635 This operation exists because a directory is also a file, but its name as
636 a directory is different from its name as a file.
637 The result can be used as the value of `default-directory'
638 or passed as second argument to `expand-file-name'.
639 For a Unix-syntax file name, just appends a slash.
640 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc. */)
651 /* If the file name has special constructs in it,
652 call the corresponding file handler. */
653 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
655 return call2 (handler
, Qfile_name_as_directory
, file
);
657 buf
= (char *) alloca (SBYTES (file
) + 10);
658 file_name_as_directory (buf
, SDATA (file
));
659 return make_specified_string (buf
, -1, strlen (buf
),
660 STRING_MULTIBYTE (file
));
664 * Convert from directory name to filename.
666 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
667 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
668 * On UNIX, it's simple: just make sure there isn't a terminating /
670 * Value is nonzero if the string output is different from the input.
674 directory_file_name (src
, dst
)
682 struct FAB fab
= cc$rms_fab
;
683 struct NAM nam
= cc$rms_nam
;
684 char esa
[NAM$C_MAXRSS
];
689 if (! index (src
, '/')
690 && (src
[slen
- 1] == ']'
691 || src
[slen
- 1] == ':'
692 || src
[slen
- 1] == '>'))
694 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
696 fab
.fab$b_fns
= slen
;
697 fab
.fab$l_nam
= &nam
;
698 fab
.fab$l_fop
= FAB$M_NAM
;
701 nam
.nam$b_ess
= sizeof esa
;
702 nam
.nam$b_nop
|= NAM$M_SYNCHK
;
704 /* We call SYS$PARSE to handle such things as [--] for us. */
705 if (SYS$
PARSE (&fab
, 0, 0) == RMS$_NORMAL
)
707 slen
= nam
.nam$b_esl
;
708 if (esa
[slen
- 1] == ';' && esa
[slen
- 2] == '.')
713 if (src
[slen
- 1] != ']' && src
[slen
- 1] != '>')
715 /* what about when we have logical_name:???? */
716 if (src
[slen
- 1] == ':')
717 { /* Xlate logical name and see what we get */
718 ptr
= strcpy (dst
, src
); /* upper case for getenv */
721 if ('a' <= *ptr
&& *ptr
<= 'z')
725 dst
[slen
- 1] = 0; /* remove colon */
726 if (!(src
= egetenv (dst
)))
728 /* should we jump to the beginning of this procedure?
729 Good points: allows us to use logical names that xlate
731 Bad points: can be a problem if we just translated to a device
733 For now, I'll punt and always expect VMS names, and hope for
736 if (src
[slen
- 1] != ']' && src
[slen
- 1] != '>')
737 { /* no recursion here! */
743 { /* not a directory spec */
748 bracket
= src
[slen
- 1];
750 /* If bracket is ']' or '>', bracket - 2 is the corresponding
752 ptr
= index (src
, bracket
- 2);
754 { /* no opening bracket */
758 if (!(rptr
= rindex (src
, '.')))
761 strncpy (dst
, src
, slen
);
765 dst
[slen
++] = bracket
;
770 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
771 then translate the device and recurse. */
772 if (dst
[slen
- 1] == ':'
773 && dst
[slen
- 2] != ':' /* skip decnet nodes */
774 && strcmp (src
+ slen
, "[000000]") == 0)
776 dst
[slen
- 1] = '\0';
777 if ((ptr
= egetenv (dst
))
778 && (rlen
= strlen (ptr
) - 1) > 0
779 && (ptr
[rlen
] == ']' || ptr
[rlen
] == '>')
780 && ptr
[rlen
- 1] == '.')
782 char * buf
= (char *) alloca (strlen (ptr
) + 1);
786 return directory_file_name (buf
, dst
);
791 strcat (dst
, "[000000]");
795 rlen
= strlen (rptr
) - 1;
796 strncat (dst
, rptr
, rlen
);
797 dst
[slen
+ rlen
] = '\0';
798 strcat (dst
, ".DIR.1");
802 /* Process as Unix format: just remove any final slash.
803 But leave "/" unchanged; do not change it to "". */
806 /* Handle // as root for apollo's. */
807 if ((slen
> 2 && dst
[slen
- 1] == '/')
808 || (slen
> 1 && dst
[0] != '/' && dst
[slen
- 1] == '/'))
812 && IS_DIRECTORY_SEP (dst
[slen
- 1])
814 && !IS_ANY_SEP (dst
[slen
- 2])
820 CORRECT_DIR_SEPS (dst
);
825 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
827 doc
: /* Returns the file name of the directory named DIRECTORY.
828 This is the name of the file that holds the data for the directory DIRECTORY.
829 This operation exists because a directory is also a file, but its name as
830 a directory is different from its name as a file.
831 In Unix-syntax, this function just removes the final slash.
832 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
833 it returns a file name such as \"[X]Y.DIR.1\". */)
835 Lisp_Object directory
;
840 CHECK_STRING (directory
);
842 if (NILP (directory
))
845 /* If the file name has special constructs in it,
846 call the corresponding file handler. */
847 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
849 return call2 (handler
, Qdirectory_file_name
, directory
);
852 /* 20 extra chars is insufficient for VMS, since we might perform a
853 logical name translation. an equivalence string can be up to 255
854 chars long, so grab that much extra space... - sss */
855 buf
= (char *) alloca (SBYTES (directory
) + 20 + 255);
857 buf
= (char *) alloca (SBYTES (directory
) + 20);
859 directory_file_name (SDATA (directory
), buf
);
860 return make_specified_string (buf
, -1, strlen (buf
),
861 STRING_MULTIBYTE (directory
));
864 static char make_temp_name_tbl
[64] =
866 'A','B','C','D','E','F','G','H',
867 'I','J','K','L','M','N','O','P',
868 'Q','R','S','T','U','V','W','X',
869 'Y','Z','a','b','c','d','e','f',
870 'g','h','i','j','k','l','m','n',
871 'o','p','q','r','s','t','u','v',
872 'w','x','y','z','0','1','2','3',
873 '4','5','6','7','8','9','-','_'
876 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
878 /* Value is a temporary file name starting with PREFIX, a string.
880 The Emacs process number forms part of the result, so there is
881 no danger of generating a name being used by another process.
882 In addition, this function makes an attempt to choose a name
883 which has no existing file. To make this work, PREFIX should be
884 an absolute file name.
886 BASE64_P non-zero means add the pid as 3 characters in base64
887 encoding. In this case, 6 characters will be added to PREFIX to
888 form the file name. Otherwise, if Emacs is running on a system
889 with long file names, add the pid as a decimal number.
891 This function signals an error if no unique file name could be
895 make_temp_name (prefix
, base64_p
)
902 unsigned char *p
, *data
;
906 CHECK_STRING (prefix
);
908 /* VAL is created by adding 6 characters to PREFIX. The first
909 three are the PID of this process, in base 64, and the second
910 three are incremented if the file already exists. This ensures
911 262144 unique file names per PID per PREFIX. */
913 pid
= (int) getpid ();
917 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
918 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
919 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
924 #ifdef HAVE_LONG_FILE_NAMES
925 sprintf (pidbuf
, "%d", pid
);
926 pidlen
= strlen (pidbuf
);
928 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
929 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
930 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
935 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
936 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
937 if (!STRING_MULTIBYTE (prefix
))
938 STRING_SET_UNIBYTE (val
);
940 bcopy(SDATA (prefix
), data
, len
);
943 bcopy (pidbuf
, p
, pidlen
);
946 /* Here we try to minimize useless stat'ing when this function is
947 invoked many times successively with the same PREFIX. We achieve
948 this by initializing count to a random value, and incrementing it
951 We don't want make-temp-name to be called while dumping,
952 because then make_temp_name_count_initialized_p would get set
953 and then make_temp_name_count would not be set when Emacs starts. */
955 if (!make_temp_name_count_initialized_p
)
957 make_temp_name_count
= (unsigned) time (NULL
);
958 make_temp_name_count_initialized_p
= 1;
964 unsigned num
= make_temp_name_count
;
966 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
967 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
968 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
970 /* Poor man's congruential RN generator. Replace with
971 ++make_temp_name_count for debugging. */
972 make_temp_name_count
+= 25229;
973 make_temp_name_count
%= 225307;
975 if (stat (data
, &ignored
) < 0)
977 /* We want to return only if errno is ENOENT. */
981 /* The error here is dubious, but there is little else we
982 can do. The alternatives are to return nil, which is
983 as bad as (and in many cases worse than) throwing the
984 error, or to ignore the error, which will likely result
985 in looping through 225307 stat's, which is not only
986 dog-slow, but also useless since it will fallback to
987 the errow below, anyway. */
988 report_file_error ("Cannot create temporary name for prefix",
989 Fcons (prefix
, Qnil
));
994 error ("Cannot create temporary name for prefix `%s'",
1000 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
1001 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
1002 The Emacs process number forms part of the result,
1003 so there is no danger of generating a name being used by another process.
1005 In addition, this function makes an attempt to choose a name
1006 which has no existing file. To make this work,
1007 PREFIX should be an absolute file name.
1009 There is a race condition between calling `make-temp-name' and creating the
1010 file which opens all kinds of security holes. For that reason, you should
1011 probably use `make-temp-file' instead, except in three circumstances:
1013 * If you are creating the file in the user's home directory.
1014 * If you are creating a directory rather than an ordinary file.
1015 * If you are taking special precautions as `make-temp-file' does. */)
1019 return make_temp_name (prefix
, 0);
1024 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1025 doc
: /* Convert filename NAME to absolute, and canonicalize it.
1026 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1027 \(does not start with slash); if DEFAULT-DIRECTORY is nil or missing,
1028 the current buffer's value of `default-directory' is used.
1029 File name components that are `.' are removed, and
1030 so are file name components followed by `..', along with the `..' itself;
1031 note that these simplifications are done without checking the resulting
1032 file names in the file system.
1033 An initial `~/' expands to your home directory.
1034 An initial `~USER/' expands to USER's home directory.
1035 See also the function `substitute-in-file-name'. */)
1036 (name
, default_directory
)
1037 Lisp_Object name
, default_directory
;
1041 register unsigned char *newdir
, *p
, *o
;
1043 unsigned char *target
;
1046 unsigned char * colon
= 0;
1047 unsigned char * close
= 0;
1048 unsigned char * slash
= 0;
1049 unsigned char * brack
= 0;
1050 int lbrack
= 0, rbrack
= 0;
1055 int collapse_newdir
= 1;
1059 Lisp_Object handler
, result
;
1061 CHECK_STRING (name
);
1063 /* If the file name has special constructs in it,
1064 call the corresponding file handler. */
1065 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
1066 if (!NILP (handler
))
1067 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
1069 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
1070 if (NILP (default_directory
))
1071 default_directory
= current_buffer
->directory
;
1072 if (! STRINGP (default_directory
))
1075 /* "/" is not considered a root directory on DOS_NT, so using "/"
1076 here causes an infinite recursion in, e.g., the following:
1078 (let (default-directory)
1079 (expand-file-name "a"))
1081 To avoid this, we set default_directory to the root of the
1083 extern char *emacs_root_dir (void);
1085 default_directory
= build_string (emacs_root_dir ());
1087 default_directory
= build_string ("/");
1091 if (!NILP (default_directory
))
1093 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
1094 if (!NILP (handler
))
1095 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
1098 o
= SDATA (default_directory
);
1100 /* Make sure DEFAULT_DIRECTORY is properly expanded.
1101 It would be better to do this down below where we actually use
1102 default_directory. Unfortunately, calling Fexpand_file_name recursively
1103 could invoke GC, and the strings might be relocated. This would
1104 be annoying because we have pointers into strings lying around
1105 that would need adjusting, and people would add new pointers to
1106 the code and forget to adjust them, resulting in intermittent bugs.
1107 Putting this call here avoids all that crud.
1109 The EQ test avoids infinite recursion. */
1110 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
1111 /* Save time in some common cases - as long as default_directory
1112 is not relative, it can be canonicalized with name below (if it
1113 is needed at all) without requiring it to be expanded now. */
1115 /* Detect MSDOS file names with drive specifiers. */
1116 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1]) && IS_DIRECTORY_SEP (o
[2]))
1118 /* Detect Windows file names in UNC format. */
1119 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
1121 #else /* not DOS_NT */
1122 /* Detect Unix absolute file names (/... alone is not absolute on
1124 && ! (IS_DIRECTORY_SEP (o
[0]))
1125 #endif /* not DOS_NT */
1128 struct gcpro gcpro1
;
1131 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
1135 name
= FILE_SYSTEM_CASE (name
);
1139 /* We will force directory separators to be either all \ or /, so make
1140 a local copy to modify, even if there ends up being no change. */
1141 nm
= strcpy (alloca (strlen (nm
) + 1), nm
);
1143 /* Note if special escape prefix is present, but remove for now. */
1144 if (nm
[0] == '/' && nm
[1] == ':')
1150 /* Find and remove drive specifier if present; this makes nm absolute
1151 even if the rest of the name appears to be relative. Only look for
1152 drive specifier at the beginning. */
1153 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
1160 /* If we see "c://somedir", we want to strip the first slash after the
1161 colon when stripping the drive letter. Otherwise, this expands to
1163 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1165 #endif /* WINDOWSNT */
1169 /* Discard any previous drive specifier if nm is now in UNC format. */
1170 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1176 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1177 none are found, we can probably return right away. We will avoid
1178 allocating a new string if name is already fully expanded. */
1180 IS_DIRECTORY_SEP (nm
[0])
1182 && drive
&& !is_escaped
1185 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
1192 /* If it turns out that the filename we want to return is just a
1193 suffix of FILENAME, we don't need to go through and edit
1194 things; we just need to construct a new string using data
1195 starting at the middle of FILENAME. If we set lose to a
1196 non-zero value, that means we've discovered that we can't do
1203 /* Since we know the name is absolute, we can assume that each
1204 element starts with a "/". */
1206 /* "." and ".." are hairy. */
1207 if (IS_DIRECTORY_SEP (p
[0])
1209 && (IS_DIRECTORY_SEP (p
[2])
1211 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1214 /* We want to replace multiple `/' in a row with a single
1217 && IS_DIRECTORY_SEP (p
[0])
1218 && IS_DIRECTORY_SEP (p
[1]))
1225 /* if dev:[dir]/, move nm to / */
1226 if (!slash
&& p
> nm
&& (brack
|| colon
)) {
1227 nm
= (brack
? brack
+ 1 : colon
+ 1);
1228 lbrack
= rbrack
= 0;
1235 #ifdef NO_HYPHENS_IN_FILENAMES
1236 if (lbrack
== rbrack
)
1238 /* Avoid clobbering negative version numbers. */
1243 #endif /* NO_HYPHENS_IN_FILENAMES */
1244 if (lbrack
> rbrack
&&
1245 ((p
[-1] == '.' || p
[-1] == '[' || p
[-1] == '<') &&
1246 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>')))
1248 #ifdef NO_HYPHENS_IN_FILENAMES
1251 #endif /* NO_HYPHENS_IN_FILENAMES */
1252 /* count open brackets, reset close bracket pointer */
1253 if (p
[0] == '[' || p
[0] == '<')
1254 lbrack
++, brack
= 0;
1255 /* count close brackets, set close bracket pointer */
1256 if (p
[0] == ']' || p
[0] == '>')
1257 rbrack
++, brack
= p
;
1258 /* detect ][ or >< */
1259 if ((p
[0] == ']' || p
[0] == '>') && (p
[1] == '[' || p
[1] == '<'))
1261 if ((p
[0] == ':' || p
[0] == ']' || p
[0] == '>') && p
[1] == '~')
1262 nm
= p
+ 1, lose
= 1;
1263 if (p
[0] == ':' && (colon
|| slash
))
1264 /* if dev1:[dir]dev2:, move nm to dev2: */
1270 /* if /name/dev:, move nm to dev: */
1273 /* if node::dev:, move colon following dev */
1274 else if (colon
&& colon
[-1] == ':')
1276 /* if dev1:dev2:, move nm to dev2: */
1277 else if (colon
&& colon
[-1] != ':')
1282 if (p
[0] == ':' && !colon
)
1288 if (lbrack
== rbrack
)
1291 else if (p
[0] == '.')
1299 if (index (nm
, '/'))
1301 nm
= sys_translate_unix (nm
);
1302 return make_specified_string (nm
, -1, strlen (nm
),
1303 STRING_MULTIBYTE (name
));
1307 /* Make sure directories are all separated with / or \ as
1308 desired, but avoid allocation of a new string when not
1310 CORRECT_DIR_SEPS (nm
);
1312 if (IS_DIRECTORY_SEP (nm
[1]))
1314 if (strcmp (nm
, SDATA (name
)) != 0)
1315 name
= make_specified_string (nm
, -1, strlen (nm
),
1316 STRING_MULTIBYTE (name
));
1320 /* drive must be set, so this is okay */
1321 if (strcmp (nm
- 2, SDATA (name
)) != 0)
1325 name
= make_specified_string (nm
, -1, p
- nm
,
1326 STRING_MULTIBYTE (name
));
1327 temp
[0] = DRIVE_LETTER (drive
);
1328 name
= concat2 (build_string (temp
), name
);
1331 #else /* not DOS_NT */
1332 if (nm
== SDATA (name
))
1334 return make_specified_string (nm
, -1, strlen (nm
),
1335 STRING_MULTIBYTE (name
));
1336 #endif /* not DOS_NT */
1340 /* At this point, nm might or might not be an absolute file name. We
1341 need to expand ~ or ~user if present, otherwise prefix nm with
1342 default_directory if nm is not absolute, and finally collapse /./
1343 and /foo/../ sequences.
1345 We set newdir to be the appropriate prefix if one is needed:
1346 - the relevant user directory if nm starts with ~ or ~user
1347 - the specified drive's working dir (DOS/NT only) if nm does not
1349 - the value of default_directory.
1351 Note that these prefixes are not guaranteed to be absolute (except
1352 for the working dir of a drive). Therefore, to ensure we always
1353 return an absolute name, if the final prefix is not absolute we
1354 append it to the current working directory. */
1358 if (nm
[0] == '~') /* prefix ~ */
1360 if (IS_DIRECTORY_SEP (nm
[1])
1364 || nm
[1] == 0) /* ~ by itself */
1366 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1367 newdir
= (unsigned char *) "";
1370 collapse_newdir
= 0;
1373 nm
++; /* Don't leave the slash in nm. */
1376 else /* ~user/filename */
1378 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)
1383 o
= (unsigned char *) alloca (p
- nm
+ 1);
1384 bcopy ((char *) nm
, o
, p
- nm
);
1387 pw
= (struct passwd
*) getpwnam (o
+ 1);
1390 newdir
= (unsigned char *) pw
-> pw_dir
;
1392 nm
= p
+ 1; /* skip the terminator */
1396 collapse_newdir
= 0;
1401 /* If we don't find a user of that name, leave the name
1402 unchanged; don't move nm forward to p. */
1407 /* On DOS and Windows, nm is absolute if a drive name was specified;
1408 use the drive's current directory as the prefix if needed. */
1409 if (!newdir
&& drive
)
1411 /* Get default directory if needed to make nm absolute. */
1412 if (!IS_DIRECTORY_SEP (nm
[0]))
1414 newdir
= alloca (MAXPATHLEN
+ 1);
1415 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1420 /* Either nm starts with /, or drive isn't mounted. */
1421 newdir
= alloca (4);
1422 newdir
[0] = DRIVE_LETTER (drive
);
1430 /* Finally, if no prefix has been specified and nm is not absolute,
1431 then it must be expanded relative to default_directory. */
1435 /* /... alone is not absolute on DOS and Windows. */
1436 && !IS_DIRECTORY_SEP (nm
[0])
1439 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1446 newdir
= SDATA (default_directory
);
1448 /* Note if special escape prefix is present, but remove for now. */
1449 if (newdir
[0] == '/' && newdir
[1] == ':')
1460 /* First ensure newdir is an absolute name. */
1462 /* Detect MSDOS file names with drive specifiers. */
1463 ! (IS_DRIVE (newdir
[0])
1464 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1466 /* Detect Windows file names in UNC format. */
1467 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1471 /* Effectively, let newdir be (expand-file-name newdir cwd).
1472 Because of the admonition against calling expand-file-name
1473 when we have pointers into lisp strings, we accomplish this
1474 indirectly by prepending newdir to nm if necessary, and using
1475 cwd (or the wd of newdir's drive) as the new newdir. */
1477 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1482 if (!IS_DIRECTORY_SEP (nm
[0]))
1484 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1485 file_name_as_directory (tmp
, newdir
);
1489 newdir
= alloca (MAXPATHLEN
+ 1);
1492 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1499 /* Strip off drive name from prefix, if present. */
1500 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1506 /* Keep only a prefix from newdir if nm starts with slash
1507 (//server/share for UNC, nothing otherwise). */
1508 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1511 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1513 newdir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1515 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1517 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1529 /* Get rid of any slash at the end of newdir, unless newdir is
1530 just / or // (an incomplete UNC name). */
1531 length
= strlen (newdir
);
1532 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1534 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1538 unsigned char *temp
= (unsigned char *) alloca (length
);
1539 bcopy (newdir
, temp
, length
- 1);
1540 temp
[length
- 1] = 0;
1548 /* Now concatenate the directory and name to new space in the stack frame */
1549 tlen
+= strlen (nm
) + 1;
1551 /* Reserve space for drive specifier and escape prefix, since either
1552 or both may need to be inserted. (The Microsoft x86 compiler
1553 produces incorrect code if the following two lines are combined.) */
1554 target
= (unsigned char *) alloca (tlen
+ 4);
1556 #else /* not DOS_NT */
1557 target
= (unsigned char *) alloca (tlen
);
1558 #endif /* not DOS_NT */
1564 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1567 /* If newdir is effectively "C:/", then the drive letter will have
1568 been stripped and newdir will be "/". Concatenating with an
1569 absolute directory in nm produces "//", which will then be
1570 incorrectly treated as a network share. Ignore newdir in
1571 this case (keeping the drive letter). */
1572 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1573 && newdir
[1] == '\0'))
1575 strcpy (target
, newdir
);
1579 file_name_as_directory (target
, newdir
);
1582 strcat (target
, nm
);
1584 if (index (target
, '/'))
1585 strcpy (target
, sys_translate_unix (target
));
1588 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1590 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1599 if (*p
!= ']' && *p
!= '>' && *p
!= '-')
1605 else if ((p
[0] == ']' || p
[0] == '>') && p
[0] == p
[1] + 2)
1606 /* brackets are offset from each other by 2 */
1609 if (*p
!= '.' && *p
!= '-' && o
[-1] != '.')
1610 /* convert [foo][bar] to [bar] */
1611 while (o
[-1] != '[' && o
[-1] != '<')
1613 else if (*p
== '-' && *o
!= '.')
1616 else if (p
[0] == '-' && o
[-1] == '.' &&
1617 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>'))
1618 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1622 while (o
[-1] != '.' && o
[-1] != '[' && o
[-1] != '<');
1623 if (p
[1] == '.') /* foo.-.bar ==> bar. */
1625 else if (o
[-1] == '.') /* '.foo.-]' ==> ']' */
1627 /* else [foo.-] ==> [-] */
1631 #ifdef NO_HYPHENS_IN_FILENAMES
1633 o
[-1] != '[' && o
[-1] != '<' && o
[-1] != '.' &&
1634 p
[1] != ']' && p
[1] != '>' && p
[1] != '.')
1636 #endif /* NO_HYPHENS_IN_FILENAMES */
1640 if (!IS_DIRECTORY_SEP (*p
))
1644 else if (IS_DIRECTORY_SEP (p
[0])
1646 && (IS_DIRECTORY_SEP (p
[2])
1649 /* If "/." is the entire filename, keep the "/". Otherwise,
1650 just delete the whole "/.". */
1651 if (o
== target
&& p
[2] == '\0')
1655 else if (IS_DIRECTORY_SEP (p
[0]) && p
[1] == '.' && p
[2] == '.'
1656 /* `/../' is the "superroot" on certain file systems.
1657 Turned off on DOS_NT systems because they have no
1658 "superroot" and because this causes us to produce
1659 file names like "d:/../foo" which fail file-related
1660 functions of the underlying OS. (To reproduce, try a
1661 long series of "../../" in default_directory, longer
1662 than the number of levels from the root.) */
1666 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1668 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1670 /* Keep initial / only if this is the whole name. */
1671 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1676 && IS_DIRECTORY_SEP (p
[0]) && IS_DIRECTORY_SEP (p
[1]))
1678 /* Collapse multiple `/' in a row. */
1680 while (IS_DIRECTORY_SEP (*p
))
1687 #endif /* not VMS */
1691 /* At last, set drive name. */
1693 /* Except for network file name. */
1694 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1695 #endif /* WINDOWSNT */
1697 if (!drive
) abort ();
1699 target
[0] = DRIVE_LETTER (drive
);
1702 /* Reinsert the escape prefix if required. */
1709 CORRECT_DIR_SEPS (target
);
1712 result
= make_specified_string (target
, -1, o
- target
,
1713 STRING_MULTIBYTE (name
));
1715 /* Again look to see if the file name has special constructs in it
1716 and perhaps call the corresponding file handler. This is needed
1717 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1718 the ".." component gives us "/user@host:/bar/../baz" which needs
1719 to be expanded again. */
1720 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1721 if (!NILP (handler
))
1722 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1728 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1729 This is the old version of expand-file-name, before it was thoroughly
1730 rewritten for Emacs 10.31. We leave this version here commented-out,
1731 because the code is very complex and likely to have subtle bugs. If
1732 bugs _are_ found, it might be of interest to look at the old code and
1733 see what did it do in the relevant situation.
1735 Don't remove this code: it's true that it will be accessible via CVS,
1736 but a few years from deletion, people will forget it is there. */
1738 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1739 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1740 "Convert FILENAME to absolute, and canonicalize it.\n\
1741 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1742 \(does not start with slash); if DEFAULT is nil or missing,\n\
1743 the current buffer's value of default-directory is used.\n\
1744 Filenames containing `.' or `..' as components are simplified;\n\
1745 initial `~/' expands to your home directory.\n\
1746 See also the function `substitute-in-file-name'.")
1748 Lisp_Object name
, defalt
;
1752 register unsigned char *newdir
, *p
, *o
;
1754 unsigned char *target
;
1758 unsigned char * colon
= 0;
1759 unsigned char * close
= 0;
1760 unsigned char * slash
= 0;
1761 unsigned char * brack
= 0;
1762 int lbrack
= 0, rbrack
= 0;
1766 CHECK_STRING (name
);
1769 /* Filenames on VMS are always upper case. */
1770 name
= Fupcase (name
);
1775 /* If nm is absolute, flush ...// and detect /./ and /../.
1776 If no /./ or /../ we can return right away. */
1788 if (p
[0] == '/' && p
[1] == '/'
1790 /* // at start of filename is meaningful on Apollo system. */
1795 if (p
[0] == '/' && p
[1] == '~')
1796 nm
= p
+ 1, lose
= 1;
1797 if (p
[0] == '/' && p
[1] == '.'
1798 && (p
[2] == '/' || p
[2] == 0
1799 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1805 /* if dev:[dir]/, move nm to / */
1806 if (!slash
&& p
> nm
&& (brack
|| colon
)) {
1807 nm
= (brack
? brack
+ 1 : colon
+ 1);
1808 lbrack
= rbrack
= 0;
1816 /* VMS pre V4.4,convert '-'s in filenames. */
1817 if (lbrack
== rbrack
)
1819 if (dots
< 2) /* this is to allow negative version numbers */
1824 if (lbrack
> rbrack
&&
1825 ((p
[-1] == '.' || p
[-1] == '[' || p
[-1] == '<') &&
1826 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>')))
1832 /* count open brackets, reset close bracket pointer */
1833 if (p
[0] == '[' || p
[0] == '<')
1834 lbrack
++, brack
= 0;
1835 /* count close brackets, set close bracket pointer */
1836 if (p
[0] == ']' || p
[0] == '>')
1837 rbrack
++, brack
= p
;
1838 /* detect ][ or >< */
1839 if ((p
[0] == ']' || p
[0] == '>') && (p
[1] == '[' || p
[1] == '<'))
1841 if ((p
[0] == ':' || p
[0] == ']' || p
[0] == '>') && p
[1] == '~')
1842 nm
= p
+ 1, lose
= 1;
1843 if (p
[0] == ':' && (colon
|| slash
))
1844 /* if dev1:[dir]dev2:, move nm to dev2: */
1850 /* If /name/dev:, move nm to dev: */
1853 /* If node::dev:, move colon following dev */
1854 else if (colon
&& colon
[-1] == ':')
1856 /* If dev1:dev2:, move nm to dev2: */
1857 else if (colon
&& colon
[-1] != ':')
1862 if (p
[0] == ':' && !colon
)
1868 if (lbrack
== rbrack
)
1871 else if (p
[0] == '.')
1879 if (index (nm
, '/'))
1880 return build_string (sys_translate_unix (nm
));
1882 if (nm
== SDATA (name
))
1884 return build_string (nm
);
1888 /* Now determine directory to start with and put it in NEWDIR */
1892 if (nm
[0] == '~') /* prefix ~ */
1897 || nm
[1] == 0)/* ~/filename */
1899 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1900 newdir
= (unsigned char *) "";
1903 nm
++; /* Don't leave the slash in nm. */
1906 else /* ~user/filename */
1908 /* Get past ~ to user */
1909 unsigned char *user
= nm
+ 1;
1910 /* Find end of name. */
1911 unsigned char *ptr
= (unsigned char *) index (user
, '/');
1912 int len
= ptr
? ptr
- user
: strlen (user
);
1914 unsigned char *ptr1
= index (user
, ':');
1915 if (ptr1
!= 0 && ptr1
- user
< len
)
1918 /* Copy the user name into temp storage. */
1919 o
= (unsigned char *) alloca (len
+ 1);
1920 bcopy ((char *) user
, o
, len
);
1923 /* Look up the user name. */
1924 pw
= (struct passwd
*) getpwnam (o
+ 1);
1926 error ("\"%s\" isn't a registered user", o
+ 1);
1928 newdir
= (unsigned char *) pw
->pw_dir
;
1930 /* Discard the user name from NM. */
1937 #endif /* not VMS */
1941 defalt
= current_buffer
->directory
;
1942 CHECK_STRING (defalt
);
1943 newdir
= SDATA (defalt
);
1946 /* Now concatenate the directory and name to new space in the stack frame */
1948 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1949 target
= (unsigned char *) alloca (tlen
);
1955 if (nm
[0] == 0 || nm
[0] == '/')
1956 strcpy (target
, newdir
);
1959 file_name_as_directory (target
, newdir
);
1962 strcat (target
, nm
);
1964 if (index (target
, '/'))
1965 strcpy (target
, sys_translate_unix (target
));
1968 /* Now canonicalize by removing /. and /foo/.. if they appear */
1976 if (*p
!= ']' && *p
!= '>' && *p
!= '-')
1982 else if ((p
[0] == ']' || p
[0] == '>') && p
[0] == p
[1] + 2)
1983 /* brackets are offset from each other by 2 */
1986 if (*p
!= '.' && *p
!= '-' && o
[-1] != '.')
1987 /* convert [foo][bar] to [bar] */
1988 while (o
[-1] != '[' && o
[-1] != '<')
1990 else if (*p
== '-' && *o
!= '.')
1993 else if (p
[0] == '-' && o
[-1] == '.' &&
1994 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>'))
1995 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1999 while (o
[-1] != '.' && o
[-1] != '[' && o
[-1] != '<');
2000 if (p
[1] == '.') /* foo.-.bar ==> bar. */
2002 else if (o
[-1] == '.') /* '.foo.-]' ==> ']' */
2004 /* else [foo.-] ==> [-] */
2010 o
[-1] != '[' && o
[-1] != '<' && o
[-1] != '.' &&
2011 p
[1] != ']' && p
[1] != '>' && p
[1] != '.')
2021 else if (!strncmp (p
, "//", 2)
2023 /* // at start of filename is meaningful in Apollo system. */
2031 else if (p
[0] == '/' && p
[1] == '.' &&
2032 (p
[2] == '/' || p
[2] == 0))
2034 else if (!strncmp (p
, "/..", 3)
2035 /* `/../' is the "superroot" on certain file systems. */
2037 && (p
[3] == '/' || p
[3] == 0))
2039 while (o
!= target
&& *--o
!= '/')
2042 if (o
== target
+ 1 && o
[-1] == '/' && o
[0] == '/')
2046 if (o
== target
&& *o
== '/')
2054 #endif /* not VMS */
2057 return make_string (target
, o
- target
);
2061 /* If /~ or // appears, discard everything through first slash. */
2063 file_name_absolute_p (filename
)
2064 const unsigned char *filename
;
2067 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
2069 /* ??? This criterion is probably wrong for '<'. */
2070 || index (filename
, ':') || index (filename
, '<')
2071 || (*filename
== '[' && (filename
[1] != '-'
2072 || (filename
[2] != '.' && filename
[2] != ']'))
2073 && filename
[1] != '.')
2076 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
2077 && IS_DIRECTORY_SEP (filename
[2]))
2082 static unsigned char *
2083 search_embedded_absfilename (nm
, endp
)
2084 unsigned char *nm
, *endp
;
2086 unsigned char *p
, *s
;
2088 for (p
= nm
+ 1; p
< endp
; p
++)
2092 || p
[-1] == ':' || p
[-1] == ']' || p
[-1] == '>'
2094 || IS_DIRECTORY_SEP (p
[-1]))
2095 && file_name_absolute_p (p
)
2096 #if defined (APOLLO) || defined (WINDOWSNT) || defined(CYGWIN)
2097 /* // at start of file name is meaningful in Apollo,
2098 WindowsNT and Cygwin systems. */
2099 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
2100 #endif /* not (APOLLO || WINDOWSNT || CYGWIN) */
2103 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)
2108 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
2110 unsigned char *o
= alloca (s
- p
+ 1);
2112 bcopy (p
, o
, s
- p
);
2115 /* If we have ~user and `user' exists, discard
2116 everything up to ~. But if `user' does not exist, leave
2117 ~user alone, it might be a literal file name. */
2118 if ((pw
= getpwnam (o
+ 1)))
2130 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
2131 Ssubstitute_in_file_name
, 1, 1, 0,
2132 doc
: /* Substitute environment variables referred to in FILENAME.
2133 `$FOO' where FOO is an environment variable name means to substitute
2134 the value of that variable. The variable name should be terminated
2135 with a character not a letter, digit or underscore; otherwise, enclose
2136 the entire variable name in braces.
2137 If `/~' appears, all of FILENAME through that `/' is discarded.
2139 On VMS, `$' substitution is not done; this function does little and only
2140 duplicates what `expand-file-name' does. */)
2142 Lisp_Object filename
;
2146 register unsigned char *s
, *p
, *o
, *x
, *endp
;
2147 unsigned char *target
= NULL
;
2149 int substituted
= 0;
2151 Lisp_Object handler
;
2153 CHECK_STRING (filename
);
2155 /* If the file name has special constructs in it,
2156 call the corresponding file handler. */
2157 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
2158 if (!NILP (handler
))
2159 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
2161 nm
= SDATA (filename
);
2163 nm
= strcpy (alloca (strlen (nm
) + 1), nm
);
2164 CORRECT_DIR_SEPS (nm
);
2165 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
2167 endp
= nm
+ SBYTES (filename
);
2169 /* If /~ or // appears, discard everything through first slash. */
2170 p
= search_embedded_absfilename (nm
, endp
);
2172 /* Start over with the new string, so we check the file-name-handler
2173 again. Important with filenames like "/home/foo//:/hello///there"
2174 which whould substitute to "/:/hello///there" rather than "/there". */
2175 return Fsubstitute_in_file_name
2176 (make_specified_string (p
, -1, endp
- p
,
2177 STRING_MULTIBYTE (filename
)));
2183 /* See if any variables are substituted into the string
2184 and find the total length of their values in `total' */
2186 for (p
= nm
; p
!= endp
;)
2196 /* "$$" means a single "$" */
2205 while (p
!= endp
&& *p
!= '}') p
++;
2206 if (*p
!= '}') goto missingclose
;
2212 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
2216 /* Copy out the variable name */
2217 target
= (unsigned char *) alloca (s
- o
+ 1);
2218 strncpy (target
, o
, s
- o
);
2221 strupr (target
); /* $home == $HOME etc. */
2224 /* Get variable value */
2225 o
= (unsigned char *) egetenv (target
);
2228 total
+= strlen (o
);
2238 /* If substitution required, recopy the string and do it */
2239 /* Make space in stack frame for the new copy */
2240 xnm
= (unsigned char *) alloca (SBYTES (filename
) + total
+ 1);
2243 /* Copy the rest of the name through, replacing $ constructs with values */
2260 while (p
!= endp
&& *p
!= '}') p
++;
2261 if (*p
!= '}') goto missingclose
;
2267 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
2271 /* Copy out the variable name */
2272 target
= (unsigned char *) alloca (s
- o
+ 1);
2273 strncpy (target
, o
, s
- o
);
2276 strupr (target
); /* $home == $HOME etc. */
2279 /* Get variable value */
2280 o
= (unsigned char *) egetenv (target
);
2284 strcpy (x
, target
); x
+= strlen (target
);
2286 else if (STRING_MULTIBYTE (filename
))
2288 /* If the original string is multibyte,
2289 convert what we substitute into multibyte. */
2292 int c
= unibyte_char_to_multibyte (*o
++);
2293 x
+= CHAR_STRING (c
, x
);
2305 /* If /~ or // appears, discard everything through first slash. */
2306 while ((p
= search_embedded_absfilename (xnm
, x
)))
2307 /* This time we do not start over because we've already expanded envvars
2308 and replaced $$ with $. Maybe we should start over as well, but we'd
2309 need to quote some $ to $$ first. */
2312 return make_specified_string (xnm
, -1, x
- xnm
, STRING_MULTIBYTE (filename
));
2315 error ("Bad format environment-variable substitution");
2317 error ("Missing \"}\" in environment-variable substitution");
2319 error ("Substituting nonexistent environment variable \"%s\"", target
);
2322 #endif /* not VMS */
2326 /* A slightly faster and more convenient way to get
2327 (directory-file-name (expand-file-name FOO)). */
2330 expand_and_dir_to_file (filename
, defdir
)
2331 Lisp_Object filename
, defdir
;
2333 register Lisp_Object absname
;
2335 absname
= Fexpand_file_name (filename
, defdir
);
2338 register int c
= SREF (absname
, SBYTES (absname
) - 1);
2339 if (c
== ':' || c
== ']' || c
== '>')
2340 absname
= Fdirectory_file_name (absname
);
2343 /* Remove final slash, if any (unless this is the root dir).
2344 stat behaves differently depending! */
2345 if (SCHARS (absname
) > 1
2346 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
2347 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
2348 /* We cannot take shortcuts; they might be wrong for magic file names. */
2349 absname
= Fdirectory_file_name (absname
);
2354 /* Signal an error if the file ABSNAME already exists.
2355 If INTERACTIVE is nonzero, ask the user whether to proceed,
2356 and bypass the error if the user says to go ahead.
2357 QUERYSTRING is a name for the action that is being considered
2360 *STATPTR is used to store the stat information if the file exists.
2361 If the file does not exist, STATPTR->st_mode is set to 0.
2362 If STATPTR is null, we don't store into it.
2364 If QUICK is nonzero, we ask for y or n, not yes or no. */
2367 barf_or_query_if_file_exists (absname
, querystring
, interactive
, statptr
, quick
)
2368 Lisp_Object absname
;
2369 unsigned char *querystring
;
2371 struct stat
*statptr
;
2374 register Lisp_Object tem
, encoded_filename
;
2375 struct stat statbuf
;
2376 struct gcpro gcpro1
;
2378 encoded_filename
= ENCODE_FILE (absname
);
2380 /* stat is a good way to tell whether the file exists,
2381 regardless of what access permissions it has. */
2382 if (lstat (SDATA (encoded_filename
), &statbuf
) >= 0)
2385 Fsignal (Qfile_already_exists
,
2386 Fcons (build_string ("File already exists"),
2387 Fcons (absname
, Qnil
)));
2389 tem
= format2 ("File %s already exists; %s anyway? ",
2390 absname
, build_string (querystring
));
2392 tem
= Fy_or_n_p (tem
);
2394 tem
= do_yes_or_no_p (tem
);
2397 Fsignal (Qfile_already_exists
,
2398 Fcons (build_string ("File already exists"),
2399 Fcons (absname
, Qnil
)));
2406 statptr
->st_mode
= 0;
2411 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
2412 "fCopy file: \nGCopy %s to file: \np\nP",
2413 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
2414 If NEWNAME names a directory, copy FILE there.
2415 Signals a `file-already-exists' error if file NEWNAME already exists,
2416 unless a third argument OK-IF-ALREADY-EXISTS is supplied and non-nil.
2417 A number as third arg means request confirmation if NEWNAME already exists.
2418 This is what happens in interactive use with M-x.
2419 Always sets the file modes of the output file to match the input file.
2421 Fourth arg KEEP-TIME non-nil means give the output file the same
2422 last-modified time as the old one. (This works on only some systems.)
2424 A prefix arg makes KEEP-TIME non-nil.
2426 The optional fifth arg MUSTBENEW, if non-nil, insists on a check
2427 for an existing file with the same name. If MUSTBENEW is `excl',
2428 that means to get an error if the file already exists; never overwrite.
2429 If MUSTBENEW is neither nil nor `excl', that means ask for
2430 confirmation before overwriting, but do go ahead and overwrite the file
2431 if the user confirms.
2433 If PRESERVE-UID-GID is non-nil, we try to transfer the
2434 uid and gid of FILE to NEWNAME. */)
2435 (file
, newname
, ok_if_already_exists
, keep_time
, mustbenew
, preserve_uid_gid
)
2436 Lisp_Object file
, newname
, ok_if_already_exists
, keep_time
, mustbenew
;
2437 Lisp_Object preserve_uid_gid
;
2440 char buf
[16 * 1024];
2441 struct stat st
, out_st
;
2442 Lisp_Object handler
;
2443 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2444 int count
= SPECPDL_INDEX ();
2445 int input_file_statable_p
;
2446 Lisp_Object encoded_file
, encoded_newname
;
2448 encoded_file
= encoded_newname
= Qnil
;
2449 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2450 CHECK_STRING (file
);
2451 CHECK_STRING (newname
);
2453 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
2454 barf_or_query_if_file_exists (newname
, "overwrite", 1, 0, 1);
2456 if (!NILP (Ffile_directory_p (newname
)))
2457 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2459 newname
= Fexpand_file_name (newname
, Qnil
);
2461 file
= Fexpand_file_name (file
, Qnil
);
2463 /* If the input file name has special constructs in it,
2464 call the corresponding file handler. */
2465 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
2466 /* Likewise for output file name. */
2468 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
2469 if (!NILP (handler
))
2470 RETURN_UNGCPRO (call5 (handler
, Qcopy_file
, file
, newname
,
2471 ok_if_already_exists
, keep_time
));
2473 encoded_file
= ENCODE_FILE (file
);
2474 encoded_newname
= ENCODE_FILE (newname
);
2476 if (NILP (ok_if_already_exists
)
2477 || INTEGERP (ok_if_already_exists
))
2478 barf_or_query_if_file_exists (encoded_newname
, "copy to it",
2479 INTEGERP (ok_if_already_exists
), &out_st
, 0);
2480 else if (stat (SDATA (encoded_newname
), &out_st
) < 0)
2484 if (!CopyFile (SDATA (encoded_file
),
2485 SDATA (encoded_newname
),
2487 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
2488 /* CopyFile retains the timestamp by default. */
2489 else if (NILP (keep_time
))
2495 EMACS_GET_TIME (now
);
2496 filename
= SDATA (encoded_newname
);
2498 /* Ensure file is writable while its modified time is set. */
2499 attributes
= GetFileAttributes (filename
);
2500 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2501 if (set_file_times (filename
, now
, now
))
2503 /* Restore original attributes. */
2504 SetFileAttributes (filename
, attributes
);
2505 Fsignal (Qfile_date_error
,
2506 Fcons (build_string ("Cannot set file date"),
2507 Fcons (newname
, Qnil
)));
2509 /* Restore original attributes. */
2510 SetFileAttributes (filename
, attributes
);
2512 #else /* not WINDOWSNT */
2514 ifd
= emacs_open (SDATA (encoded_file
), O_RDONLY
, 0);
2518 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2520 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2522 /* We can only copy regular files and symbolic links. Other files are not
2524 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
2526 #if !defined (MSDOS) || __DJGPP__ > 1
2527 if (out_st
.st_mode
!= 0
2528 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2531 report_file_error ("Input and output files are the same",
2532 Fcons (file
, Fcons (newname
, Qnil
)));
2536 #if defined (S_ISREG) && defined (S_ISLNK)
2537 if (input_file_statable_p
)
2539 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
2541 #if defined (EISDIR)
2542 /* Get a better looking error message. */
2545 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2548 #endif /* S_ISREG && S_ISLNK */
2551 /* Create the copy file with the same record format as the input file */
2552 ofd
= sys_creat (SDATA (encoded_newname
), 0666, ifd
);
2555 /* System's default file type was set to binary by _fmode in emacs.c. */
2556 ofd
= emacs_open (SDATA (encoded_newname
),
2557 O_WRONLY
| O_TRUNC
| O_CREAT
2558 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
2559 S_IREAD
| S_IWRITE
);
2560 #else /* not MSDOS */
2561 ofd
= emacs_open (SDATA (encoded_newname
),
2562 O_WRONLY
| O_TRUNC
| O_CREAT
2563 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
2565 #endif /* not MSDOS */
2568 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2570 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2574 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2575 if (emacs_write (ofd
, buf
, n
) != n
)
2576 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2580 /* Preserve the original file modes, and if requested, also its
2582 if (input_file_statable_p
)
2584 if (! NILP (preserve_uid_gid
))
2585 fchown (ofd
, st
.st_uid
, st
.st_gid
);
2586 fchmod (ofd
, st
.st_mode
& 07777);
2588 #endif /* not MSDOS */
2590 /* Closing the output clobbers the file times on some systems. */
2591 if (emacs_close (ofd
) < 0)
2592 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2594 if (input_file_statable_p
)
2596 if (!NILP (keep_time
))
2598 EMACS_TIME atime
, mtime
;
2599 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
2600 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
2601 if (set_file_times (SDATA (encoded_newname
),
2603 Fsignal (Qfile_date_error
,
2604 Fcons (build_string ("Cannot set file date"),
2605 Fcons (newname
, Qnil
)));
2611 #if defined (__DJGPP__) && __DJGPP__ > 1
2612 if (input_file_statable_p
)
2614 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2615 and if it can't, it tells so. Otherwise, under MSDOS we usually
2616 get only the READ bit, which will make the copied file read-only,
2617 so it's better not to chmod at all. */
2618 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2619 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2621 #endif /* DJGPP version 2 or newer */
2622 #endif /* not WINDOWSNT */
2624 /* Discard the unwind protects. */
2625 specpdl_ptr
= specpdl
+ count
;
2631 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2632 Smake_directory_internal
, 1, 1, 0,
2633 doc
: /* Create a new directory named DIRECTORY. */)
2635 Lisp_Object directory
;
2637 const unsigned char *dir
;
2638 Lisp_Object handler
;
2639 Lisp_Object encoded_dir
;
2641 CHECK_STRING (directory
);
2642 directory
= Fexpand_file_name (directory
, Qnil
);
2644 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2645 if (!NILP (handler
))
2646 return call2 (handler
, Qmake_directory_internal
, directory
);
2648 encoded_dir
= ENCODE_FILE (directory
);
2650 dir
= SDATA (encoded_dir
);
2653 if (mkdir (dir
) != 0)
2655 if (mkdir (dir
, 0777) != 0)
2657 report_file_error ("Creating directory", Flist (1, &directory
));
2662 DEFUN ("delete-directory", Fdelete_directory
, Sdelete_directory
, 1, 1, "FDelete directory: ",
2663 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2665 Lisp_Object directory
;
2667 const unsigned char *dir
;
2668 Lisp_Object handler
;
2669 Lisp_Object encoded_dir
;
2671 CHECK_STRING (directory
);
2672 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2674 handler
= Ffind_file_name_handler (directory
, Qdelete_directory
);
2675 if (!NILP (handler
))
2676 return call2 (handler
, Qdelete_directory
, directory
);
2678 encoded_dir
= ENCODE_FILE (directory
);
2680 dir
= SDATA (encoded_dir
);
2682 if (rmdir (dir
) != 0)
2683 report_file_error ("Removing directory", Flist (1, &directory
));
2688 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 1, "fDelete file: ",
2689 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2690 If file has multiple names, it continues to exist with the other names. */)
2692 Lisp_Object filename
;
2694 Lisp_Object handler
;
2695 Lisp_Object encoded_file
;
2696 struct gcpro gcpro1
;
2699 if (!NILP (Ffile_directory_p (filename
))
2700 && NILP (Ffile_symlink_p (filename
)))
2701 Fsignal (Qfile_error
,
2702 Fcons (build_string ("Removing old name: is a directory"),
2703 Fcons (filename
, Qnil
)));
2705 filename
= Fexpand_file_name (filename
, Qnil
);
2707 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2708 if (!NILP (handler
))
2709 return call2 (handler
, Qdelete_file
, filename
);
2711 encoded_file
= ENCODE_FILE (filename
);
2713 if (0 > unlink (SDATA (encoded_file
)))
2714 report_file_error ("Removing old name", Flist (1, &filename
));
2719 internal_delete_file_1 (ignore
)
2725 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2728 internal_delete_file (filename
)
2729 Lisp_Object filename
;
2731 return NILP (internal_condition_case_1 (Fdelete_file
, filename
,
2732 Qt
, internal_delete_file_1
));
2735 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2736 "fRename file: \nGRename %s to file: \np",
2737 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2738 If file has names other than FILE, it continues to have those names.
2739 Signals a `file-already-exists' error if a file NEWNAME already exists
2740 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2741 A number as third arg means request confirmation if NEWNAME already exists.
2742 This is what happens in interactive use with M-x. */)
2743 (file
, newname
, ok_if_already_exists
)
2744 Lisp_Object file
, newname
, ok_if_already_exists
;
2747 Lisp_Object args
[2];
2749 Lisp_Object handler
;
2750 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2751 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2753 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2754 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2755 CHECK_STRING (file
);
2756 CHECK_STRING (newname
);
2757 file
= Fexpand_file_name (file
, Qnil
);
2759 if (!NILP (Ffile_directory_p (newname
)))
2760 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2762 newname
= Fexpand_file_name (newname
, Qnil
);
2764 /* If the file name has special constructs in it,
2765 call the corresponding file handler. */
2766 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2768 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2769 if (!NILP (handler
))
2770 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2771 file
, newname
, ok_if_already_exists
));
2773 encoded_file
= ENCODE_FILE (file
);
2774 encoded_newname
= ENCODE_FILE (newname
);
2777 /* If the file names are identical but for the case, don't ask for
2778 confirmation: they simply want to change the letter-case of the
2780 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2782 if (NILP (ok_if_already_exists
)
2783 || INTEGERP (ok_if_already_exists
))
2784 barf_or_query_if_file_exists (encoded_newname
, "rename to it",
2785 INTEGERP (ok_if_already_exists
), 0, 0);
2787 if (0 > rename (SDATA (encoded_file
), SDATA (encoded_newname
)))
2789 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
))
2790 || 0 > unlink (SDATA (encoded_file
)))
2796 symlink_target
= Ffile_symlink_p (file
);
2797 if (! NILP (symlink_target
))
2798 Fmake_symbolic_link (symlink_target
, newname
,
2799 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2802 Fcopy_file (file
, newname
,
2803 /* We have already prompted if it was an integer,
2804 so don't have copy-file prompt again. */
2805 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2808 Fdelete_file (file
);
2815 report_file_error ("Renaming", Flist (2, args
));
2818 report_file_error ("Renaming", Flist (2, &file
));
2825 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2826 "fAdd name to file: \nGName to add to %s: \np",
2827 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2828 Signals a `file-already-exists' error if a file NEWNAME already exists
2829 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2830 A number as third arg means request confirmation if NEWNAME already exists.
2831 This is what happens in interactive use with M-x. */)
2832 (file
, newname
, ok_if_already_exists
)
2833 Lisp_Object file
, newname
, ok_if_already_exists
;
2836 Lisp_Object args
[2];
2838 Lisp_Object handler
;
2839 Lisp_Object encoded_file
, encoded_newname
;
2840 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2842 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2843 encoded_file
= encoded_newname
= Qnil
;
2844 CHECK_STRING (file
);
2845 CHECK_STRING (newname
);
2846 file
= Fexpand_file_name (file
, Qnil
);
2848 if (!NILP (Ffile_directory_p (newname
)))
2849 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2851 newname
= Fexpand_file_name (newname
, Qnil
);
2853 /* If the file name has special constructs in it,
2854 call the corresponding file handler. */
2855 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2856 if (!NILP (handler
))
2857 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2858 newname
, ok_if_already_exists
));
2860 /* If the new name has special constructs in it,
2861 call the corresponding file handler. */
2862 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2863 if (!NILP (handler
))
2864 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2865 newname
, ok_if_already_exists
));
2867 encoded_file
= ENCODE_FILE (file
);
2868 encoded_newname
= ENCODE_FILE (newname
);
2870 if (NILP (ok_if_already_exists
)
2871 || INTEGERP (ok_if_already_exists
))
2872 barf_or_query_if_file_exists (encoded_newname
, "make it a new name",
2873 INTEGERP (ok_if_already_exists
), 0, 0);
2875 unlink (SDATA (newname
));
2876 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
)))
2881 report_file_error ("Adding new name", Flist (2, args
));
2883 report_file_error ("Adding new name", Flist (2, &file
));
2892 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2893 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2894 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2895 Both args must be strings.
2896 Signals a `file-already-exists' error if a file LINKNAME already exists
2897 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2898 A number as third arg means request confirmation if LINKNAME already exists.
2899 This happens for interactive use with M-x. */)
2900 (filename
, linkname
, ok_if_already_exists
)
2901 Lisp_Object filename
, linkname
, ok_if_already_exists
;
2904 Lisp_Object args
[2];
2906 Lisp_Object handler
;
2907 Lisp_Object encoded_filename
, encoded_linkname
;
2908 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2910 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2911 encoded_filename
= encoded_linkname
= Qnil
;
2912 CHECK_STRING (filename
);
2913 CHECK_STRING (linkname
);
2914 /* If the link target has a ~, we must expand it to get
2915 a truly valid file name. Otherwise, do not expand;
2916 we want to permit links to relative file names. */
2917 if (SREF (filename
, 0) == '~')
2918 filename
= Fexpand_file_name (filename
, Qnil
);
2920 if (!NILP (Ffile_directory_p (linkname
)))
2921 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2923 linkname
= Fexpand_file_name (linkname
, Qnil
);
2925 /* If the file name has special constructs in it,
2926 call the corresponding file handler. */
2927 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2928 if (!NILP (handler
))
2929 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2930 linkname
, ok_if_already_exists
));
2932 /* If the new link name has special constructs in it,
2933 call the corresponding file handler. */
2934 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2935 if (!NILP (handler
))
2936 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2937 linkname
, ok_if_already_exists
));
2939 encoded_filename
= ENCODE_FILE (filename
);
2940 encoded_linkname
= ENCODE_FILE (linkname
);
2942 if (NILP (ok_if_already_exists
)
2943 || INTEGERP (ok_if_already_exists
))
2944 barf_or_query_if_file_exists (encoded_linkname
, "make it a link",
2945 INTEGERP (ok_if_already_exists
), 0, 0);
2946 if (0 > symlink (SDATA (encoded_filename
),
2947 SDATA (encoded_linkname
)))
2949 /* If we didn't complain already, silently delete existing file. */
2950 if (errno
== EEXIST
)
2952 unlink (SDATA (encoded_linkname
));
2953 if (0 <= symlink (SDATA (encoded_filename
),
2954 SDATA (encoded_linkname
)))
2964 report_file_error ("Making symbolic link", Flist (2, args
));
2966 report_file_error ("Making symbolic link", Flist (2, &filename
));
2972 #endif /* S_IFLNK */
2976 DEFUN ("define-logical-name", Fdefine_logical_name
, Sdefine_logical_name
,
2977 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2978 doc
: /* Define the job-wide logical name NAME to have the value STRING.
2979 If STRING is nil or a null string, the logical name NAME is deleted. */)
2984 CHECK_STRING (name
);
2986 delete_logical_name (SDATA (name
));
2989 CHECK_STRING (string
);
2991 if (SCHARS (string
) == 0)
2992 delete_logical_name (SDATA (name
));
2994 define_logical_name (SDATA (name
), SDATA (string
));
3003 DEFUN ("sysnetunam", Fsysnetunam
, Ssysnetunam
, 2, 2, 0,
3004 doc
: /* Open a network connection to PATH using LOGIN as the login string. */)
3006 Lisp_Object path
, login
;
3010 CHECK_STRING (path
);
3011 CHECK_STRING (login
);
3013 netresult
= netunam (SDATA (path
), SDATA (login
));
3015 if (netresult
== -1)
3020 #endif /* HPUX_NET */
3022 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
3024 doc
: /* Return t if file FILENAME specifies an absolute file name.
3025 On Unix, this is a name starting with a `/' or a `~'. */)
3027 Lisp_Object filename
;
3029 CHECK_STRING (filename
);
3030 return file_name_absolute_p (SDATA (filename
)) ? Qt
: Qnil
;
3033 /* Return nonzero if file FILENAME exists and can be executed. */
3036 check_executable (filename
)
3040 int len
= strlen (filename
);
3043 if (stat (filename
, &st
) < 0)
3045 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
3046 return ((st
.st_mode
& S_IEXEC
) != 0);
3048 return (S_ISREG (st
.st_mode
)
3050 && (stricmp ((suffix
= filename
+ len
-4), ".com") == 0
3051 || stricmp (suffix
, ".exe") == 0
3052 || stricmp (suffix
, ".bat") == 0)
3053 || (st
.st_mode
& S_IFMT
) == S_IFDIR
);
3054 #endif /* not WINDOWSNT */
3055 #else /* not DOS_NT */
3056 #ifdef HAVE_EUIDACCESS
3057 return (euidaccess (filename
, 1) >= 0);
3059 /* Access isn't quite right because it uses the real uid
3060 and we really want to test with the effective uid.
3061 But Unix doesn't give us a right way to do it. */
3062 return (access (filename
, 1) >= 0);
3064 #endif /* not DOS_NT */
3067 /* Return nonzero if file FILENAME exists and can be written. */
3070 check_writable (filename
)
3075 if (stat (filename
, &st
) < 0)
3077 return (st
.st_mode
& S_IWRITE
|| (st
.st_mode
& S_IFMT
) == S_IFDIR
);
3078 #else /* not MSDOS */
3079 #ifdef HAVE_EUIDACCESS
3080 return (euidaccess (filename
, 2) >= 0);
3082 /* Access isn't quite right because it uses the real uid
3083 and we really want to test with the effective uid.
3084 But Unix doesn't give us a right way to do it.
3085 Opening with O_WRONLY could work for an ordinary file,
3086 but would lose for directories. */
3087 return (access (filename
, 2) >= 0);
3089 #endif /* not MSDOS */
3092 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
3093 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
3094 See also `file-readable-p' and `file-attributes'.
3095 This returns nil for a symlink to a nonexistent file.
3096 Use `file-symlink-p' to test for such links. */)
3098 Lisp_Object filename
;
3100 Lisp_Object absname
;
3101 Lisp_Object handler
;
3102 struct stat statbuf
;
3104 CHECK_STRING (filename
);
3105 absname
= Fexpand_file_name (filename
, Qnil
);
3107 /* If the file name has special constructs in it,
3108 call the corresponding file handler. */
3109 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
3110 if (!NILP (handler
))
3111 return call2 (handler
, Qfile_exists_p
, absname
);
3113 absname
= ENCODE_FILE (absname
);
3115 return (stat (SDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
3118 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
3119 doc
: /* Return t if FILENAME can be executed by you.
3120 For a directory, this means you can access files in that directory. */)
3122 Lisp_Object filename
;
3124 Lisp_Object absname
;
3125 Lisp_Object handler
;
3127 CHECK_STRING (filename
);
3128 absname
= Fexpand_file_name (filename
, Qnil
);
3130 /* If the file name has special constructs in it,
3131 call the corresponding file handler. */
3132 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
3133 if (!NILP (handler
))
3134 return call2 (handler
, Qfile_executable_p
, absname
);
3136 absname
= ENCODE_FILE (absname
);
3138 return (check_executable (SDATA (absname
)) ? Qt
: Qnil
);
3141 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
3142 doc
: /* Return t if file FILENAME exists and you can read it.
3143 See also `file-exists-p' and `file-attributes'. */)
3145 Lisp_Object filename
;
3147 Lisp_Object absname
;
3148 Lisp_Object handler
;
3151 struct stat statbuf
;
3153 CHECK_STRING (filename
);
3154 absname
= Fexpand_file_name (filename
, Qnil
);
3156 /* If the file name has special constructs in it,
3157 call the corresponding file handler. */
3158 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
3159 if (!NILP (handler
))
3160 return call2 (handler
, Qfile_readable_p
, absname
);
3162 absname
= ENCODE_FILE (absname
);
3164 #if defined(DOS_NT) || defined(macintosh)
3165 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3167 if (access (SDATA (absname
), 0) == 0)
3170 #else /* not DOS_NT and not macintosh */
3172 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3173 /* Opening a fifo without O_NONBLOCK can wait.
3174 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3175 except in the case of a fifo, on a system which handles it. */
3176 desc
= stat (SDATA (absname
), &statbuf
);
3179 if (S_ISFIFO (statbuf
.st_mode
))
3180 flags
|= O_NONBLOCK
;
3182 desc
= emacs_open (SDATA (absname
), flags
, 0);
3187 #endif /* not DOS_NT and not macintosh */
3190 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3192 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
3193 doc
: /* Return t if file FILENAME can be written or created by you. */)
3195 Lisp_Object filename
;
3197 Lisp_Object absname
, dir
, encoded
;
3198 Lisp_Object handler
;
3199 struct stat statbuf
;
3201 CHECK_STRING (filename
);
3202 absname
= Fexpand_file_name (filename
, Qnil
);
3204 /* If the file name has special constructs in it,
3205 call the corresponding file handler. */
3206 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
3207 if (!NILP (handler
))
3208 return call2 (handler
, Qfile_writable_p
, absname
);
3210 encoded
= ENCODE_FILE (absname
);
3211 if (stat (SDATA (encoded
), &statbuf
) >= 0)
3212 return (check_writable (SDATA (encoded
))
3215 dir
= Ffile_name_directory (absname
);
3218 dir
= Fdirectory_file_name (dir
);
3222 dir
= Fdirectory_file_name (dir
);
3225 dir
= ENCODE_FILE (dir
);
3227 /* The read-only attribute of the parent directory doesn't affect
3228 whether a file or directory can be created within it. Some day we
3229 should check ACLs though, which do affect this. */
3230 if (stat (SDATA (dir
), &statbuf
) < 0)
3232 return (statbuf
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
3234 return (check_writable (!NILP (dir
) ? (char *) SDATA (dir
) : "")
3239 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
3240 doc
: /* Access file FILENAME, and get an error if that does not work.
3241 The second argument STRING is used in the error message.
3242 If there is no error, returns nil. */)
3244 Lisp_Object filename
, string
;
3246 Lisp_Object handler
, encoded_filename
, absname
;
3249 CHECK_STRING (filename
);
3250 absname
= Fexpand_file_name (filename
, Qnil
);
3252 CHECK_STRING (string
);
3254 /* If the file name has special constructs in it,
3255 call the corresponding file handler. */
3256 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
3257 if (!NILP (handler
))
3258 return call3 (handler
, Qaccess_file
, absname
, string
);
3260 encoded_filename
= ENCODE_FILE (absname
);
3262 fd
= emacs_open (SDATA (encoded_filename
), O_RDONLY
, 0);
3264 report_file_error (SDATA (string
), Fcons (filename
, Qnil
));
3270 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
3271 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
3272 The value is the link target, as a string.
3273 Otherwise it returns nil.
3275 This function returns t when given the name of a symlink that
3276 points to a nonexistent file. */)
3278 Lisp_Object filename
;
3280 Lisp_Object handler
;
3282 CHECK_STRING (filename
);
3283 filename
= Fexpand_file_name (filename
, Qnil
);
3285 /* If the file name has special constructs in it,
3286 call the corresponding file handler. */
3287 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
3288 if (!NILP (handler
))
3289 return call2 (handler
, Qfile_symlink_p
, filename
);
3298 filename
= ENCODE_FILE (filename
);
3305 buf
= (char *) xrealloc (buf
, bufsize
);
3306 bzero (buf
, bufsize
);
3309 valsize
= readlink (SDATA (filename
), buf
, bufsize
);
3313 /* HP-UX reports ERANGE if buffer is too small. */
3314 if (errno
== ERANGE
)
3324 while (valsize
>= bufsize
);
3326 val
= make_string (buf
, valsize
);
3327 if (buf
[0] == '/' && index (buf
, ':'))
3328 val
= concat2 (build_string ("/:"), val
);
3330 val
= DECODE_FILE (val
);
3333 #else /* not S_IFLNK */
3335 #endif /* not S_IFLNK */
3338 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
3339 doc
: /* Return t if FILENAME names an existing directory.
3340 Symbolic links to directories count as directories.
3341 See `file-symlink-p' to distinguish symlinks. */)
3343 Lisp_Object filename
;
3345 register Lisp_Object absname
;
3347 Lisp_Object handler
;
3349 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3351 /* If the file name has special constructs in it,
3352 call the corresponding file handler. */
3353 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
3354 if (!NILP (handler
))
3355 return call2 (handler
, Qfile_directory_p
, absname
);
3357 absname
= ENCODE_FILE (absname
);
3359 if (stat (SDATA (absname
), &st
) < 0)
3361 return (st
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
3364 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
3365 doc
: /* Return t if file FILENAME names a directory you can open.
3366 For the value to be t, FILENAME must specify the name of a directory as a file,
3367 and the directory must allow you to open files in it. In order to use a
3368 directory as a buffer's current directory, this predicate must return true.
3369 A directory name spec may be given instead; then the value is t
3370 if the directory so specified exists and really is a readable and
3371 searchable directory. */)
3373 Lisp_Object filename
;
3375 Lisp_Object handler
;
3377 struct gcpro gcpro1
;
3379 /* If the file name has special constructs in it,
3380 call the corresponding file handler. */
3381 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
3382 if (!NILP (handler
))
3383 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
3386 tem
= (NILP (Ffile_directory_p (filename
))
3387 || NILP (Ffile_executable_p (filename
)));
3389 return tem
? Qnil
: Qt
;
3392 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
3393 doc
: /* Return t if file FILENAME is the name of a regular file.
3394 This is the sort of file that holds an ordinary stream of data bytes. */)
3396 Lisp_Object filename
;
3398 register Lisp_Object absname
;
3400 Lisp_Object handler
;
3402 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3404 /* If the file name has special constructs in it,
3405 call the corresponding file handler. */
3406 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
3407 if (!NILP (handler
))
3408 return call2 (handler
, Qfile_regular_p
, absname
);
3410 absname
= ENCODE_FILE (absname
);
3415 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3417 /* Tell stat to use expensive method to get accurate info. */
3418 Vw32_get_true_file_attributes
= Qt
;
3419 result
= stat (SDATA (absname
), &st
);
3420 Vw32_get_true_file_attributes
= tem
;
3424 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
3427 if (stat (SDATA (absname
), &st
) < 0)
3429 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
3433 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3434 doc
: /* Return mode bits of file named FILENAME, as an integer.
3435 Return nil, if file does not exist or is not accessible. */)
3437 Lisp_Object filename
;
3439 Lisp_Object absname
;
3441 Lisp_Object handler
;
3443 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3445 /* If the file name has special constructs in it,
3446 call the corresponding file handler. */
3447 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3448 if (!NILP (handler
))
3449 return call2 (handler
, Qfile_modes
, absname
);
3451 absname
= ENCODE_FILE (absname
);
3453 if (stat (SDATA (absname
), &st
) < 0)
3455 #if defined (MSDOS) && __DJGPP__ < 2
3456 if (check_executable (SDATA (absname
)))
3457 st
.st_mode
|= S_IEXEC
;
3458 #endif /* MSDOS && __DJGPP__ < 2 */
3460 return make_number (st
.st_mode
& 07777);
3463 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2, 0,
3464 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3465 Only the 12 low bits of MODE are used. */)
3467 Lisp_Object filename
, mode
;
3469 Lisp_Object absname
, encoded_absname
;
3470 Lisp_Object handler
;
3472 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
3473 CHECK_NUMBER (mode
);
3475 /* If the file name has special constructs in it,
3476 call the corresponding file handler. */
3477 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3478 if (!NILP (handler
))
3479 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3481 encoded_absname
= ENCODE_FILE (absname
);
3483 if (chmod (SDATA (encoded_absname
), XINT (mode
)) < 0)
3484 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3489 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3490 doc
: /* Set the file permission bits for newly created files.
3491 The argument MODE should be an integer; only the low 9 bits are used.
3492 This setting is inherited by subprocesses. */)
3496 CHECK_NUMBER (mode
);
3498 umask ((~ XINT (mode
)) & 0777);
3503 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3504 doc
: /* Return the default file protection for created files.
3505 The value is an integer. */)
3511 realmask
= umask (0);
3514 XSETINT (value
, (~ realmask
) & 0777);
3518 extern int lisp_time_argument
P_ ((Lisp_Object
, time_t *, int *));
3520 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3521 doc
: /* Set times of file FILENAME to TIME.
3522 Set both access and modification times.
3523 Return t on success, else nil.
3524 Use the current time if TIME is nil. TIME is in the format of
3527 Lisp_Object filename
, time
;
3529 Lisp_Object absname
, encoded_absname
;
3530 Lisp_Object handler
;
3534 if (! lisp_time_argument (time
, &sec
, &usec
))
3535 error ("Invalid time specification");
3537 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
3539 /* If the file name has special constructs in it,
3540 call the corresponding file handler. */
3541 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3542 if (!NILP (handler
))
3543 return call3 (handler
, Qset_file_times
, absname
, time
);
3545 encoded_absname
= ENCODE_FILE (absname
);
3550 EMACS_SET_SECS (t
, sec
);
3551 EMACS_SET_USECS (t
, usec
);
3553 if (set_file_times (SDATA (encoded_absname
), t
, t
))
3558 /* Setting times on a directory always fails. */
3559 if (stat (SDATA (encoded_absname
), &st
) == 0
3560 && (st
.st_mode
& S_IFMT
) == S_IFDIR
)
3563 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3576 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3577 doc
: /* Tell Unix to finish all pending disk updates. */)
3586 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3587 doc
: /* Return t if file FILE1 is newer than file FILE2.
3588 If FILE1 does not exist, the answer is nil;
3589 otherwise, if FILE2 does not exist, the answer is t. */)
3591 Lisp_Object file1
, file2
;
3593 Lisp_Object absname1
, absname2
;
3596 Lisp_Object handler
;
3597 struct gcpro gcpro1
, gcpro2
;
3599 CHECK_STRING (file1
);
3600 CHECK_STRING (file2
);
3603 GCPRO2 (absname1
, file2
);
3604 absname1
= expand_and_dir_to_file (file1
, current_buffer
->directory
);
3605 absname2
= expand_and_dir_to_file (file2
, current_buffer
->directory
);
3608 /* If the file name has special constructs in it,
3609 call the corresponding file handler. */
3610 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3612 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3613 if (!NILP (handler
))
3614 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3616 GCPRO2 (absname1
, absname2
);
3617 absname1
= ENCODE_FILE (absname1
);
3618 absname2
= ENCODE_FILE (absname2
);
3621 if (stat (SDATA (absname1
), &st
) < 0)
3624 mtime1
= st
.st_mtime
;
3626 if (stat (SDATA (absname2
), &st
) < 0)
3629 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3633 Lisp_Object Qfind_buffer_file_type
;
3636 #ifndef READ_BUF_SIZE
3637 #define READ_BUF_SIZE (64 << 10)
3640 extern void adjust_markers_for_delete
P_ ((int, int, int, int));
3642 /* This function is called after Lisp functions to decide a coding
3643 system are called, or when they cause an error. Before they are
3644 called, the current buffer is set unibyte and it contains only a
3645 newly inserted text (thus the buffer was empty before the
3648 The functions may set markers, overlays, text properties, or even
3649 alter the buffer contents, change the current buffer.
3651 Here, we reset all those changes by:
3652 o set back the current buffer.
3653 o move all markers and overlays to BEG.
3654 o remove all text properties.
3655 o set back the buffer multibyteness. */
3658 decide_coding_unwind (unwind_data
)
3659 Lisp_Object unwind_data
;
3661 Lisp_Object multibyte
, undo_list
, buffer
;
3663 multibyte
= XCAR (unwind_data
);
3664 unwind_data
= XCDR (unwind_data
);
3665 undo_list
= XCAR (unwind_data
);
3666 buffer
= XCDR (unwind_data
);
3668 if (current_buffer
!= XBUFFER (buffer
))
3669 set_buffer_internal (XBUFFER (buffer
));
3670 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3671 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3672 BUF_INTERVALS (current_buffer
) = 0;
3673 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3675 /* Now we are safe to change the buffer's multibyteness directly. */
3676 current_buffer
->enable_multibyte_characters
= multibyte
;
3677 current_buffer
->undo_list
= undo_list
;
3683 /* Used to pass values from insert-file-contents to read_non_regular. */
3685 static int non_regular_fd
;
3686 static int non_regular_inserted
;
3687 static int non_regular_nbytes
;
3690 /* Read from a non-regular file.
3691 Read non_regular_trytry bytes max from non_regular_fd.
3692 Non_regular_inserted specifies where to put the read bytes.
3693 Value is the number of bytes read. */
3702 nbytes
= emacs_read (non_regular_fd
,
3703 BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ non_regular_inserted
,
3704 non_regular_nbytes
);
3706 return make_number (nbytes
);
3710 /* Condition-case handler used when reading from non-regular files
3711 in insert-file-contents. */
3714 read_non_regular_quit ()
3720 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3722 doc
: /* Insert contents of file FILENAME after point.
3723 Returns list of absolute file name and number of characters inserted.
3724 If second argument VISIT is non-nil, the buffer's visited filename
3725 and last save file modtime are set, and it is marked unmodified.
3726 If visiting and the file does not exist, visiting is completed
3727 before the error is signaled.
3728 The optional third and fourth arguments BEG and END
3729 specify what portion of the file to insert.
3730 These arguments count bytes in the file, not characters in the buffer.
3731 If VISIT is non-nil, BEG and END must be nil.
3733 If optional fifth argument REPLACE is non-nil,
3734 it means replace the current buffer contents (in the accessible portion)
3735 with the file contents. This is better than simply deleting and inserting
3736 the whole thing because (1) it preserves some marker positions
3737 and (2) it puts less data in the undo list.
3738 When REPLACE is non-nil, the value is the number of characters actually read,
3739 which is often less than the number of characters to be read.
3741 This does code conversion according to the value of
3742 `coding-system-for-read' or `file-coding-system-alist',
3743 and sets the variable `last-coding-system-used' to the coding system
3745 (filename
, visit
, beg
, end
, replace
)
3746 Lisp_Object filename
, visit
, beg
, end
, replace
;
3751 register int how_much
;
3752 register int unprocessed
;
3753 int count
= SPECPDL_INDEX ();
3754 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3755 Lisp_Object handler
, val
, insval
, orig_filename
;
3758 int not_regular
= 0;
3759 unsigned char read_buf
[READ_BUF_SIZE
];
3760 struct coding_system coding
;
3761 unsigned char buffer
[1 << 14];
3762 int replace_handled
= 0;
3763 int set_coding_system
= 0;
3764 int coding_system_decided
= 0;
3766 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3767 int we_locked_file
= 0;
3769 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3770 error ("Cannot do file visiting in an indirect buffer");
3772 if (!NILP (current_buffer
->read_only
))
3773 Fbarf_if_buffer_read_only ();
3777 orig_filename
= Qnil
;
3779 GCPRO4 (filename
, val
, p
, orig_filename
);
3781 CHECK_STRING (filename
);
3782 filename
= Fexpand_file_name (filename
, Qnil
);
3784 /* If the file name has special constructs in it,
3785 call the corresponding file handler. */
3786 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3787 if (!NILP (handler
))
3789 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3790 visit
, beg
, end
, replace
);
3791 if (CONSP (val
) && CONSP (XCDR (val
)))
3792 inserted
= XINT (XCAR (XCDR (val
)));
3796 orig_filename
= filename
;
3797 filename
= ENCODE_FILE (filename
);
3803 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3805 /* Tell stat to use expensive method to get accurate info. */
3806 Vw32_get_true_file_attributes
= Qt
;
3807 total
= stat (SDATA (filename
), &st
);
3808 Vw32_get_true_file_attributes
= tem
;
3813 if (stat (SDATA (filename
), &st
) < 0)
3815 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0
3816 || fstat (fd
, &st
) < 0)
3817 #endif /* not APOLLO */
3818 #endif /* WINDOWSNT */
3820 if (fd
>= 0) emacs_close (fd
);
3823 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3826 if (!NILP (Vcoding_system_for_read
))
3827 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3832 /* This code will need to be changed in order to work on named
3833 pipes, and it's probably just not worth it. So we should at
3834 least signal an error. */
3835 if (!S_ISREG (st
.st_mode
))
3842 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3843 Fsignal (Qfile_error
,
3844 Fcons (build_string ("not a regular file"),
3845 Fcons (orig_filename
, Qnil
)));
3850 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0)
3853 /* Replacement should preserve point as it preserves markers. */
3854 if (!NILP (replace
))
3855 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3857 record_unwind_protect (close_file_unwind
, make_number (fd
));
3859 /* Supposedly happens on VMS. */
3860 /* Can happen on any platform that uses long as type of off_t, but allows
3861 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3862 give a message suitable for the latter case. */
3863 if (! not_regular
&& st
.st_size
< 0)
3864 error ("Maximum buffer size exceeded");
3866 /* Prevent redisplay optimizations. */
3867 current_buffer
->clip_changed
= 1;
3871 if (!NILP (beg
) || !NILP (end
))
3872 error ("Attempt to visit less than an entire file");
3873 if (BEG
< Z
&& NILP (replace
))
3874 error ("Cannot do file visiting in a non-empty buffer");
3880 XSETFASTINT (beg
, 0);
3888 XSETINT (end
, st
.st_size
);
3890 /* Arithmetic overflow can occur if an Emacs integer cannot
3891 represent the file size, or if the calculations below
3892 overflow. The calculations below double the file size
3893 twice, so check that it can be multiplied by 4 safely. */
3894 if (XINT (end
) != st
.st_size
3895 || ((int) st
.st_size
* 4) / 4 != st
.st_size
)
3896 error ("Maximum buffer size exceeded");
3898 /* The file size returned from stat may be zero, but data
3899 may be readable nonetheless, for example when this is a
3900 file in the /proc filesystem. */
3901 if (st
.st_size
== 0)
3902 XSETINT (end
, READ_BUF_SIZE
);
3906 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3908 /* We use emacs-mule for auto saving... */
3909 setup_coding_system (Qemacs_mule
, &coding
);
3910 /* ... but with the special flag to indicate to read in a
3911 multibyte sequence for eight-bit-control char as is. */
3913 coding
.src_multibyte
= 0;
3914 coding
.dst_multibyte
3915 = !NILP (current_buffer
->enable_multibyte_characters
);
3916 coding
.eol_type
= CODING_EOL_LF
;
3917 coding_system_decided
= 1;
3921 /* Decide the coding system to use for reading the file now
3922 because we can't use an optimized method for handling
3923 `coding:' tag if the current buffer is not empty. */
3927 if (!NILP (Vcoding_system_for_read
))
3928 val
= Vcoding_system_for_read
;
3931 /* Don't try looking inside a file for a coding system
3932 specification if it is not seekable. */
3933 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3935 /* Find a coding system specified in the heading two
3936 lines or in the tailing several lines of the file.
3937 We assume that the 1K-byte and 3K-byte for heading
3938 and tailing respectively are sufficient for this
3942 if (st
.st_size
<= (1024 * 4))
3943 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3946 nread
= emacs_read (fd
, read_buf
, 1024);
3949 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3950 report_file_error ("Setting file position",
3951 Fcons (orig_filename
, Qnil
));
3952 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3957 error ("IO error reading %s: %s",
3958 SDATA (orig_filename
), emacs_strerror (errno
));
3961 struct buffer
*prev
= current_buffer
;
3965 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3967 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3968 buf
= XBUFFER (buffer
);
3970 delete_all_overlays (buf
);
3971 buf
->directory
= current_buffer
->directory
;
3972 buf
->read_only
= Qnil
;
3973 buf
->filename
= Qnil
;
3974 buf
->undo_list
= Qt
;
3975 eassert (buf
->overlays_before
== NULL
);
3976 eassert (buf
->overlays_after
== NULL
);
3978 set_buffer_internal (buf
);
3980 buf
->enable_multibyte_characters
= Qnil
;
3982 insert_1_both (read_buf
, nread
, nread
, 0, 0, 0);
3983 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3984 val
= call2 (Vset_auto_coding_function
,
3985 filename
, make_number (nread
));
3986 set_buffer_internal (prev
);
3988 /* Discard the unwind protect for recovering the
3992 /* Rewind the file for the actual read done later. */
3993 if (lseek (fd
, 0, 0) < 0)
3994 report_file_error ("Setting file position",
3995 Fcons (orig_filename
, Qnil
));
4001 /* If we have not yet decided a coding system, check
4002 file-coding-system-alist. */
4003 Lisp_Object args
[6], coding_systems
;
4005 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4006 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
4007 coding_systems
= Ffind_operation_coding_system (6, args
);
4008 if (CONSP (coding_systems
))
4009 val
= XCAR (coding_systems
);
4013 setup_coding_system (Fcheck_coding_system (val
), &coding
);
4014 /* Ensure we set Vlast_coding_system_used. */
4015 set_coding_system
= 1;
4017 if (NILP (current_buffer
->enable_multibyte_characters
)
4019 /* We must suppress all character code conversion except for
4020 end-of-line conversion. */
4021 setup_raw_text_coding_system (&coding
);
4023 coding
.src_multibyte
= 0;
4024 coding
.dst_multibyte
4025 = !NILP (current_buffer
->enable_multibyte_characters
);
4026 coding_system_decided
= 1;
4029 /* If requested, replace the accessible part of the buffer
4030 with the file contents. Avoid replacing text at the
4031 beginning or end of the buffer that matches the file contents;
4032 that preserves markers pointing to the unchanged parts.
4034 Here we implement this feature in an optimized way
4035 for the case where code conversion is NOT needed.
4036 The following if-statement handles the case of conversion
4037 in a less optimal way.
4039 If the code conversion is "automatic" then we try using this
4040 method and hope for the best.
4041 But if we discover the need for conversion, we give up on this method
4042 and let the following if-statement handle the replace job. */
4045 && !(coding
.common_flags
& CODING_REQUIRE_DECODING_MASK
))
4047 /* same_at_start and same_at_end count bytes,
4048 because file access counts bytes
4049 and BEG and END count bytes. */
4050 int same_at_start
= BEGV_BYTE
;
4051 int same_at_end
= ZV_BYTE
;
4053 /* There is still a possibility we will find the need to do code
4054 conversion. If that happens, we set this variable to 1 to
4055 give up on handling REPLACE in the optimized way. */
4056 int giveup_match_end
= 0;
4058 if (XINT (beg
) != 0)
4060 if (lseek (fd
, XINT (beg
), 0) < 0)
4061 report_file_error ("Setting file position",
4062 Fcons (orig_filename
, Qnil
));
4067 /* Count how many chars at the start of the file
4068 match the text at the beginning of the buffer. */
4073 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
4075 error ("IO error reading %s: %s",
4076 SDATA (orig_filename
), emacs_strerror (errno
));
4077 else if (nread
== 0)
4080 if (coding
.type
== coding_type_undecided
)
4081 detect_coding (&coding
, buffer
, nread
);
4082 if (coding
.common_flags
& CODING_REQUIRE_DECODING_MASK
)
4083 /* We found that the file should be decoded somehow.
4084 Let's give up here. */
4086 giveup_match_end
= 1;
4090 if (coding
.eol_type
== CODING_EOL_UNDECIDED
)
4091 detect_eol (&coding
, buffer
, nread
);
4092 if (coding
.eol_type
!= CODING_EOL_UNDECIDED
4093 && coding
.eol_type
!= CODING_EOL_LF
)
4094 /* We found that the format of eol should be decoded.
4095 Let's give up here. */
4097 giveup_match_end
= 1;
4102 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
4103 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
4104 same_at_start
++, bufpos
++;
4105 /* If we found a discrepancy, stop the scan.
4106 Otherwise loop around and scan the next bufferful. */
4107 if (bufpos
!= nread
)
4111 /* If the file matches the buffer completely,
4112 there's no need to replace anything. */
4113 if (same_at_start
- BEGV_BYTE
== XINT (end
))
4117 /* Truncate the buffer to the size of the file. */
4118 del_range_1 (same_at_start
, same_at_end
, 0, 0);
4123 /* Count how many chars at the end of the file
4124 match the text at the end of the buffer. But, if we have
4125 already found that decoding is necessary, don't waste time. */
4126 while (!giveup_match_end
)
4128 int total_read
, nread
, bufpos
, curpos
, trial
;
4130 /* At what file position are we now scanning? */
4131 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
4132 /* If the entire file matches the buffer tail, stop the scan. */
4135 /* How much can we scan in the next step? */
4136 trial
= min (curpos
, sizeof buffer
);
4137 if (lseek (fd
, curpos
- trial
, 0) < 0)
4138 report_file_error ("Setting file position",
4139 Fcons (orig_filename
, Qnil
));
4141 total_read
= nread
= 0;
4142 while (total_read
< trial
)
4144 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
4146 error ("IO error reading %s: %s",
4147 SDATA (orig_filename
), emacs_strerror (errno
));
4148 else if (nread
== 0)
4150 total_read
+= nread
;
4153 /* Scan this bufferful from the end, comparing with
4154 the Emacs buffer. */
4155 bufpos
= total_read
;
4157 /* Compare with same_at_start to avoid counting some buffer text
4158 as matching both at the file's beginning and at the end. */
4159 while (bufpos
> 0 && same_at_end
> same_at_start
4160 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
4161 same_at_end
--, bufpos
--;
4163 /* If we found a discrepancy, stop the scan.
4164 Otherwise loop around and scan the preceding bufferful. */
4167 /* If this discrepancy is because of code conversion,
4168 we cannot use this method; giveup and try the other. */
4169 if (same_at_end
> same_at_start
4170 && FETCH_BYTE (same_at_end
- 1) >= 0200
4171 && ! NILP (current_buffer
->enable_multibyte_characters
)
4172 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
4173 giveup_match_end
= 1;
4182 if (! giveup_match_end
)
4186 /* We win! We can handle REPLACE the optimized way. */
4188 /* Extend the start of non-matching text area to multibyte
4189 character boundary. */
4190 if (! NILP (current_buffer
->enable_multibyte_characters
))
4191 while (same_at_start
> BEGV_BYTE
4192 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4195 /* Extend the end of non-matching text area to multibyte
4196 character boundary. */
4197 if (! NILP (current_buffer
->enable_multibyte_characters
))
4198 while (same_at_end
< ZV_BYTE
4199 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4202 /* Don't try to reuse the same piece of text twice. */
4203 overlap
= (same_at_start
- BEGV_BYTE
4204 - (same_at_end
+ st
.st_size
- ZV
));
4206 same_at_end
+= overlap
;
4208 /* Arrange to read only the nonmatching middle part of the file. */
4209 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
4210 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
4212 del_range_byte (same_at_start
, same_at_end
, 0);
4213 /* Insert from the file at the proper position. */
4214 temp
= BYTE_TO_CHAR (same_at_start
);
4215 SET_PT_BOTH (temp
, same_at_start
);
4217 /* If display currently starts at beginning of line,
4218 keep it that way. */
4219 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
4220 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
4222 replace_handled
= 1;
4226 /* If requested, replace the accessible part of the buffer
4227 with the file contents. Avoid replacing text at the
4228 beginning or end of the buffer that matches the file contents;
4229 that preserves markers pointing to the unchanged parts.
4231 Here we implement this feature for the case where code conversion
4232 is needed, in a simple way that needs a lot of memory.
4233 The preceding if-statement handles the case of no conversion
4234 in a more optimized way. */
4235 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
4237 int same_at_start
= BEGV_BYTE
;
4238 int same_at_end
= ZV_BYTE
;
4241 /* Make sure that the gap is large enough. */
4242 int bufsize
= 2 * st
.st_size
;
4243 unsigned char *conversion_buffer
= (unsigned char *) xmalloc (bufsize
);
4246 /* First read the whole file, performing code conversion into
4247 CONVERSION_BUFFER. */
4249 if (lseek (fd
, XINT (beg
), 0) < 0)
4251 xfree (conversion_buffer
);
4252 report_file_error ("Setting file position",
4253 Fcons (orig_filename
, Qnil
));
4256 total
= st
.st_size
; /* Total bytes in the file. */
4257 how_much
= 0; /* Bytes read from file so far. */
4258 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
4259 unprocessed
= 0; /* Bytes not processed in previous loop. */
4261 while (how_much
< total
)
4263 /* try is reserved in some compilers (Microsoft C) */
4264 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
4265 unsigned char *destination
= read_buf
+ unprocessed
;
4268 /* Allow quitting out of the actual I/O. */
4271 this = emacs_read (fd
, destination
, trytry
);
4274 if (this < 0 || this + unprocessed
== 0)
4282 if (CODING_MAY_REQUIRE_DECODING (&coding
))
4284 int require
, result
;
4286 this += unprocessed
;
4288 /* If we are using more space than estimated,
4289 make CONVERSION_BUFFER bigger. */
4290 require
= decoding_buffer_size (&coding
, this);
4291 if (inserted
+ require
+ 2 * (total
- how_much
) > bufsize
)
4293 bufsize
= inserted
+ require
+ 2 * (total
- how_much
);
4294 conversion_buffer
= (unsigned char *) xrealloc (conversion_buffer
, bufsize
);
4297 /* Convert this batch with results in CONVERSION_BUFFER. */
4298 if (how_much
>= total
) /* This is the last block. */
4299 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4300 if (coding
.composing
!= COMPOSITION_DISABLED
)
4301 coding_allocate_composition_data (&coding
, BEGV
);
4302 result
= decode_coding (&coding
, read_buf
,
4303 conversion_buffer
+ inserted
,
4304 this, bufsize
- inserted
);
4306 /* Save for next iteration whatever we didn't convert. */
4307 unprocessed
= this - coding
.consumed
;
4308 bcopy (read_buf
+ coding
.consumed
, read_buf
, unprocessed
);
4309 if (!NILP (current_buffer
->enable_multibyte_characters
))
4310 this = coding
.produced
;
4312 this = str_as_unibyte (conversion_buffer
+ inserted
,
4319 /* At this point, INSERTED is how many characters (i.e. bytes)
4320 are present in CONVERSION_BUFFER.
4321 HOW_MUCH should equal TOTAL,
4322 or should be <= 0 if we couldn't read the file. */
4326 xfree (conversion_buffer
);
4327 coding_free_composition_data (&coding
);
4329 error ("IO error reading %s: %s",
4330 SDATA (orig_filename
), emacs_strerror (errno
));
4331 else if (how_much
== -2)
4332 error ("maximum buffer size exceeded");
4335 /* Compare the beginning of the converted file
4336 with the buffer text. */
4339 while (bufpos
< inserted
&& same_at_start
< same_at_end
4340 && FETCH_BYTE (same_at_start
) == conversion_buffer
[bufpos
])
4341 same_at_start
++, bufpos
++;
4343 /* If the file matches the buffer completely,
4344 there's no need to replace anything. */
4346 if (bufpos
== inserted
)
4348 xfree (conversion_buffer
);
4349 coding_free_composition_data (&coding
);
4352 /* Truncate the buffer to the size of the file. */
4353 del_range_byte (same_at_start
, same_at_end
, 0);
4358 /* Extend the start of non-matching text area to multibyte
4359 character boundary. */
4360 if (! NILP (current_buffer
->enable_multibyte_characters
))
4361 while (same_at_start
> BEGV_BYTE
4362 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4365 /* Scan this bufferful from the end, comparing with
4366 the Emacs buffer. */
4369 /* Compare with same_at_start to avoid counting some buffer text
4370 as matching both at the file's beginning and at the end. */
4371 while (bufpos
> 0 && same_at_end
> same_at_start
4372 && FETCH_BYTE (same_at_end
- 1) == conversion_buffer
[bufpos
- 1])
4373 same_at_end
--, bufpos
--;
4375 /* Extend the end of non-matching text area to multibyte
4376 character boundary. */
4377 if (! NILP (current_buffer
->enable_multibyte_characters
))
4378 while (same_at_end
< ZV_BYTE
4379 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4382 /* Don't try to reuse the same piece of text twice. */
4383 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4385 same_at_end
+= overlap
;
4387 /* If display currently starts at beginning of line,
4388 keep it that way. */
4389 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
4390 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
4392 /* Replace the chars that we need to replace,
4393 and update INSERTED to equal the number of bytes
4394 we are taking from the file. */
4395 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4397 if (same_at_end
!= same_at_start
)
4399 del_range_byte (same_at_start
, same_at_end
, 0);
4401 same_at_start
= GPT_BYTE
;
4405 temp
= BYTE_TO_CHAR (same_at_start
);
4407 /* Insert from the file at the proper position. */
4408 SET_PT_BOTH (temp
, same_at_start
);
4409 insert_1 (conversion_buffer
+ same_at_start
- BEGV_BYTE
, inserted
,
4411 if (coding
.cmp_data
&& coding
.cmp_data
->used
)
4412 coding_restore_composition (&coding
, Fcurrent_buffer ());
4413 coding_free_composition_data (&coding
);
4415 /* Set `inserted' to the number of inserted characters. */
4416 inserted
= PT
- temp
;
4418 xfree (conversion_buffer
);
4427 register Lisp_Object temp
;
4429 total
= XINT (end
) - XINT (beg
);
4431 /* Make sure point-max won't overflow after this insertion. */
4432 XSETINT (temp
, total
);
4433 if (total
!= XINT (temp
))
4434 error ("Maximum buffer size exceeded");
4437 /* For a special file, all we can do is guess. */
4438 total
= READ_BUF_SIZE
;
4440 if (NILP (visit
) && inserted
> 0)
4442 #ifdef CLASH_DETECTION
4443 if (!NILP (current_buffer
->file_truename
)
4444 /* Make binding buffer-file-name to nil effective. */
4445 && !NILP (current_buffer
->filename
)
4446 && SAVE_MODIFF
>= MODIFF
)
4448 #endif /* CLASH_DETECTION */
4449 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4453 if (GAP_SIZE
< total
)
4454 make_gap (total
- GAP_SIZE
);
4456 if (XINT (beg
) != 0 || !NILP (replace
))
4458 if (lseek (fd
, XINT (beg
), 0) < 0)
4459 report_file_error ("Setting file position",
4460 Fcons (orig_filename
, Qnil
));
4463 /* In the following loop, HOW_MUCH contains the total bytes read so
4464 far for a regular file, and not changed for a special file. But,
4465 before exiting the loop, it is set to a negative value if I/O
4469 /* Total bytes inserted. */
4472 /* Here, we don't do code conversion in the loop. It is done by
4473 code_convert_region after all data are read into the buffer. */
4475 int gap_size
= GAP_SIZE
;
4477 while (how_much
< total
)
4479 /* try is reserved in some compilers (Microsoft C) */
4480 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4487 /* Maybe make more room. */
4488 if (gap_size
< trytry
)
4490 make_gap (total
- gap_size
);
4491 gap_size
= GAP_SIZE
;
4494 /* Read from the file, capturing `quit'. When an
4495 error occurs, end the loop, and arrange for a quit
4496 to be signaled after decoding the text we read. */
4497 non_regular_fd
= fd
;
4498 non_regular_inserted
= inserted
;
4499 non_regular_nbytes
= trytry
;
4500 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
4501 read_non_regular_quit
);
4512 /* Allow quitting out of the actual I/O. We don't make text
4513 part of the buffer until all the reading is done, so a C-g
4514 here doesn't do any harm. */
4517 this = emacs_read (fd
, BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ inserted
, trytry
);
4529 /* For a regular file, where TOTAL is the real size,
4530 count HOW_MUCH to compare with it.
4531 For a special file, where TOTAL is just a buffer size,
4532 so don't bother counting in HOW_MUCH.
4533 (INSERTED is where we count the number of characters inserted.) */
4540 /* Now we have read all the file data into the gap.
4541 If it was empty, undo marking the buffer modified. */
4545 #ifdef CLASH_DETECTION
4547 unlock_file (current_buffer
->file_truename
);
4549 Vdeactivate_mark
= old_Vdeactivate_mark
;
4552 /* Make the text read part of the buffer. */
4553 GAP_SIZE
-= inserted
;
4555 GPT_BYTE
+= inserted
;
4557 ZV_BYTE
+= inserted
;
4562 /* Put an anchor to ensure multi-byte form ends at gap. */
4567 /* Discard the unwind protect for closing the file. */
4571 error ("IO error reading %s: %s",
4572 SDATA (orig_filename
), emacs_strerror (errno
));
4576 if (! coding_system_decided
)
4578 /* The coding system is not yet decided. Decide it by an
4579 optimized method for handling `coding:' tag.
4581 Note that we can get here only if the buffer was empty
4582 before the insertion. */
4586 if (!NILP (Vcoding_system_for_read
))
4587 val
= Vcoding_system_for_read
;
4590 /* Since we are sure that the current buffer was empty
4591 before the insertion, we can toggle
4592 enable-multibyte-characters directly here without taking
4593 care of marker adjustment and byte combining problem. By
4594 this way, we can run Lisp program safely before decoding
4595 the inserted text. */
4596 Lisp_Object unwind_data
;
4597 int count
= SPECPDL_INDEX ();
4599 unwind_data
= Fcons (current_buffer
->enable_multibyte_characters
,
4600 Fcons (current_buffer
->undo_list
,
4601 Fcurrent_buffer ()));
4602 current_buffer
->enable_multibyte_characters
= Qnil
;
4603 current_buffer
->undo_list
= Qt
;
4604 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4606 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4608 val
= call2 (Vset_auto_coding_function
,
4609 filename
, make_number (inserted
));
4614 /* If the coding system is not yet decided, check
4615 file-coding-system-alist. */
4616 Lisp_Object args
[6], coding_systems
;
4618 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4619 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4620 coding_systems
= Ffind_operation_coding_system (6, args
);
4621 if (CONSP (coding_systems
))
4622 val
= XCAR (coding_systems
);
4624 unbind_to (count
, Qnil
);
4625 inserted
= Z_BYTE
- BEG_BYTE
;
4628 /* The following kludgy code is to avoid some compiler bug.
4630 setup_coding_system (val, &coding);
4633 struct coding_system temp_coding
;
4634 setup_coding_system (Fcheck_coding_system (val
), &temp_coding
);
4635 bcopy (&temp_coding
, &coding
, sizeof coding
);
4637 /* Ensure we set Vlast_coding_system_used. */
4638 set_coding_system
= 1;
4640 if (NILP (current_buffer
->enable_multibyte_characters
)
4642 /* We must suppress all character code conversion except for
4643 end-of-line conversion. */
4644 setup_raw_text_coding_system (&coding
);
4645 coding
.src_multibyte
= 0;
4646 coding
.dst_multibyte
4647 = !NILP (current_buffer
->enable_multibyte_characters
);
4651 /* Can't do this if part of the buffer might be preserved. */
4653 && (coding
.type
== coding_type_no_conversion
4654 || coding
.type
== coding_type_raw_text
))
4656 /* Visiting a file with these coding system makes the buffer
4658 current_buffer
->enable_multibyte_characters
= Qnil
;
4659 coding
.dst_multibyte
= 0;
4662 if (inserted
> 0 || coding
.type
== coding_type_ccl
)
4664 if (CODING_MAY_REQUIRE_DECODING (&coding
))
4666 code_convert_region (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4668 inserted
= coding
.produced_char
;
4671 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4675 /* Now INSERTED is measured in characters. */
4678 /* Use the conversion type to determine buffer-file-type
4679 (find-buffer-file-type is now used to help determine the
4681 if ((coding
.eol_type
== CODING_EOL_UNDECIDED
4682 || coding
.eol_type
== CODING_EOL_LF
)
4683 && ! CODING_REQUIRE_DECODING (&coding
))
4684 current_buffer
->buffer_file_type
= Qt
;
4686 current_buffer
->buffer_file_type
= Qnil
;
4693 if (!EQ (current_buffer
->undo_list
, Qt
))
4694 current_buffer
->undo_list
= Qnil
;
4696 stat (SDATA (filename
), &st
);
4701 current_buffer
->modtime
= st
.st_mtime
;
4702 current_buffer
->filename
= orig_filename
;
4705 SAVE_MODIFF
= MODIFF
;
4706 current_buffer
->auto_save_modified
= MODIFF
;
4707 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4708 #ifdef CLASH_DETECTION
4711 if (!NILP (current_buffer
->file_truename
))
4712 unlock_file (current_buffer
->file_truename
);
4713 unlock_file (filename
);
4715 #endif /* CLASH_DETECTION */
4717 Fsignal (Qfile_error
,
4718 Fcons (build_string ("not a regular file"),
4719 Fcons (orig_filename
, Qnil
)));
4722 if (set_coding_system
)
4723 Vlast_coding_system_used
= coding
.symbol
;
4725 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4727 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4729 if (! NILP (insval
))
4731 CHECK_NUMBER (insval
);
4732 inserted
= XFASTINT (insval
);
4736 /* Decode file format */
4739 int empty_undo_list_p
= 0;
4741 /* If we're anyway going to discard undo information, don't
4742 record it in the first place. The buffer's undo list at this
4743 point is either nil or t when visiting a file. */
4746 empty_undo_list_p
= NILP (current_buffer
->undo_list
);
4747 current_buffer
->undo_list
= Qt
;
4750 insval
= call3 (Qformat_decode
,
4751 Qnil
, make_number (inserted
), visit
);
4752 CHECK_NUMBER (insval
);
4753 inserted
= XFASTINT (insval
);
4756 current_buffer
->undo_list
= empty_undo_list_p
? Qnil
: Qt
;
4759 /* Call after-change hooks for the inserted text, aside from the case
4760 of normal visiting (not with REPLACE), which is done in a new buffer
4761 "before" the buffer is changed. */
4762 if (inserted
> 0 && total
> 0
4763 && (NILP (visit
) || !NILP (replace
)))
4765 signal_after_change (PT
, 0, inserted
);
4766 update_compositions (PT
, PT
, CHECK_BORDER
);
4769 p
= Vafter_insert_file_functions
;
4772 insval
= call1 (XCAR (p
), make_number (inserted
));
4775 CHECK_NUMBER (insval
);
4776 inserted
= XFASTINT (insval
);
4783 && current_buffer
->modtime
== -1)
4785 /* If visiting nonexistent file, return nil. */
4786 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4790 Fsignal (Qquit
, Qnil
);
4792 /* ??? Retval needs to be dealt with in all cases consistently. */
4794 val
= Fcons (orig_filename
,
4795 Fcons (make_number (inserted
),
4798 RETURN_UNGCPRO (unbind_to (count
, val
));
4801 static Lisp_Object build_annotations
P_ ((Lisp_Object
, Lisp_Object
));
4802 static Lisp_Object build_annotations_2
P_ ((Lisp_Object
, Lisp_Object
,
4803 Lisp_Object
, Lisp_Object
));
4805 /* If build_annotations switched buffers, switch back to BUF.
4806 Kill the temporary buffer that was selected in the meantime.
4808 Since this kill only the last temporary buffer, some buffers remain
4809 not killed if build_annotations switched buffers more than once.
4813 build_annotations_unwind (buf
)
4818 if (XBUFFER (buf
) == current_buffer
)
4820 tembuf
= Fcurrent_buffer ();
4822 Fkill_buffer (tembuf
);
4826 /* Decide the coding-system to encode the data with. */
4829 choose_write_coding_system (start
, end
, filename
,
4830 append
, visit
, lockname
, coding
)
4831 Lisp_Object start
, end
, filename
, append
, visit
, lockname
;
4832 struct coding_system
*coding
;
4837 && NILP (Fstring_equal (current_buffer
->filename
,
4838 current_buffer
->auto_save_file_name
)))
4840 /* We use emacs-mule for auto saving... */
4841 setup_coding_system (Qemacs_mule
, coding
);
4842 /* ... but with the special flag to indicate not to strip off
4843 leading code of eight-bit-control chars. */
4845 goto done_setup_coding
;
4847 else if (!NILP (Vcoding_system_for_write
))
4849 val
= Vcoding_system_for_write
;
4850 if (coding_system_require_warning
4851 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4852 /* Confirm that VAL can surely encode the current region. */
4853 val
= call5 (Vselect_safe_coding_system_function
,
4854 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4859 /* If the variable `buffer-file-coding-system' is set locally,
4860 it means that the file was read with some kind of code
4861 conversion or the variable is explicitly set by users. We
4862 had better write it out with the same coding system even if
4863 `enable-multibyte-characters' is nil.
4865 If it is not set locally, we anyway have to convert EOL
4866 format if the default value of `buffer-file-coding-system'
4867 tells that it is not Unix-like (LF only) format. */
4868 int using_default_coding
= 0;
4869 int force_raw_text
= 0;
4871 val
= current_buffer
->buffer_file_coding_system
;
4873 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4876 if (NILP (current_buffer
->enable_multibyte_characters
))
4882 /* Check file-coding-system-alist. */
4883 Lisp_Object args
[7], coding_systems
;
4885 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4886 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4888 coding_systems
= Ffind_operation_coding_system (7, args
);
4889 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4890 val
= XCDR (coding_systems
);
4894 && !NILP (current_buffer
->buffer_file_coding_system
))
4896 /* If we still have not decided a coding system, use the
4897 default value of buffer-file-coding-system. */
4898 val
= current_buffer
->buffer_file_coding_system
;
4899 using_default_coding
= 1;
4903 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4904 /* Confirm that VAL can surely encode the current region. */
4905 val
= call5 (Vselect_safe_coding_system_function
,
4906 start
, end
, val
, Qnil
, filename
);
4908 setup_coding_system (Fcheck_coding_system (val
), coding
);
4909 if (coding
->eol_type
== CODING_EOL_UNDECIDED
4910 && !using_default_coding
)
4912 if (! EQ (default_buffer_file_coding
.symbol
,
4913 buffer_defaults
.buffer_file_coding_system
))
4914 setup_coding_system (buffer_defaults
.buffer_file_coding_system
,
4915 &default_buffer_file_coding
);
4916 if (default_buffer_file_coding
.eol_type
!= CODING_EOL_UNDECIDED
)
4918 Lisp_Object subsidiaries
;
4920 coding
->eol_type
= default_buffer_file_coding
.eol_type
;
4921 subsidiaries
= Fget (coding
->symbol
, Qeol_type
);
4922 if (VECTORP (subsidiaries
)
4923 && XVECTOR (subsidiaries
)->size
== 3)
4925 = XVECTOR (subsidiaries
)->contents
[coding
->eol_type
];
4930 setup_raw_text_coding_system (coding
);
4931 goto done_setup_coding
;
4934 setup_coding_system (Fcheck_coding_system (val
), coding
);
4937 if (!STRINGP (start
) && !NILP (current_buffer
->selective_display
))
4938 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4941 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4942 "r\nFWrite region to file: \ni\ni\ni\np",
4943 doc
: /* Write current region into specified file.
4944 When called from a program, requires three arguments:
4945 START, END and FILENAME. START and END are normally buffer positions
4946 specifying the part of the buffer to write.
4947 If START is nil, that means to use the entire buffer contents.
4948 If START is a string, then output that string to the file
4949 instead of any buffer contents; END is ignored.
4951 Optional fourth argument APPEND if non-nil means
4952 append to existing file contents (if any). If it is an integer,
4953 seek to that offset in the file before writing.
4954 Optional fifth argument VISIT, if t or a string, means
4955 set the last-save-file-modtime of buffer to this file's modtime
4956 and mark buffer not modified.
4957 If VISIT is a string, it is a second file name;
4958 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4959 VISIT is also the file name to lock and unlock for clash detection.
4960 If VISIT is neither t nor nil nor a string,
4961 that means do not display the \"Wrote file\" message.
4962 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4963 use for locking and unlocking, overriding FILENAME and VISIT.
4964 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4965 for an existing file with the same name. If MUSTBENEW is `excl',
4966 that means to get an error if the file already exists; never overwrite.
4967 If MUSTBENEW is neither nil nor `excl', that means ask for
4968 confirmation before overwriting, but do go ahead and overwrite the file
4969 if the user confirms.
4971 This does code conversion according to the value of
4972 `coding-system-for-write', `buffer-file-coding-system', or
4973 `file-coding-system-alist', and sets the variable
4974 `last-coding-system-used' to the coding system actually used. */)
4975 (start
, end
, filename
, append
, visit
, lockname
, mustbenew
)
4976 Lisp_Object start
, end
, filename
, append
, visit
, lockname
, mustbenew
;
4981 const unsigned char *fn
;
4984 int count
= SPECPDL_INDEX ();
4987 unsigned char *fname
= 0; /* If non-0, original filename (must rename) */
4989 Lisp_Object handler
;
4990 Lisp_Object visit_file
;
4991 Lisp_Object annotations
;
4992 Lisp_Object encoded_filename
;
4993 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4994 int quietly
= !NILP (visit
);
4995 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4996 struct buffer
*given_buffer
;
4998 int buffer_file_type
= O_BINARY
;
5000 struct coding_system coding
;
5002 if (current_buffer
->base_buffer
&& visiting
)
5003 error ("Cannot do file visiting in an indirect buffer");
5005 if (!NILP (start
) && !STRINGP (start
))
5006 validate_region (&start
, &end
);
5008 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
5010 filename
= Fexpand_file_name (filename
, Qnil
);
5012 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
5013 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
5015 if (STRINGP (visit
))
5016 visit_file
= Fexpand_file_name (visit
, Qnil
);
5018 visit_file
= filename
;
5020 if (NILP (lockname
))
5021 lockname
= visit_file
;
5025 /* If the file name has special constructs in it,
5026 call the corresponding file handler. */
5027 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
5028 /* If FILENAME has no handler, see if VISIT has one. */
5029 if (NILP (handler
) && STRINGP (visit
))
5030 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
5032 if (!NILP (handler
))
5035 val
= call6 (handler
, Qwrite_region
, start
, end
,
5036 filename
, append
, visit
);
5040 SAVE_MODIFF
= MODIFF
;
5041 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5042 current_buffer
->filename
= visit_file
;
5048 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
5050 /* Special kludge to simplify auto-saving. */
5053 XSETFASTINT (start
, BEG
);
5054 XSETFASTINT (end
, Z
);
5058 record_unwind_protect (build_annotations_unwind
, Fcurrent_buffer ());
5059 count1
= SPECPDL_INDEX ();
5061 given_buffer
= current_buffer
;
5063 if (!STRINGP (start
))
5065 annotations
= build_annotations (start
, end
);
5067 if (current_buffer
!= given_buffer
)
5069 XSETFASTINT (start
, BEGV
);
5070 XSETFASTINT (end
, ZV
);
5076 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
5078 /* Decide the coding-system to encode the data with.
5079 We used to make this choice before calling build_annotations, but that
5080 leads to problems when a write-annotate-function takes care of
5081 unsavable chars (as was the case with X-Symbol). */
5082 choose_write_coding_system (start
, end
, filename
,
5083 append
, visit
, lockname
, &coding
);
5084 Vlast_coding_system_used
= coding
.symbol
;
5086 given_buffer
= current_buffer
;
5087 if (! STRINGP (start
))
5089 annotations
= build_annotations_2 (start
, end
,
5090 coding
.pre_write_conversion
, annotations
);
5091 if (current_buffer
!= given_buffer
)
5093 XSETFASTINT (start
, BEGV
);
5094 XSETFASTINT (end
, ZV
);
5098 #ifdef CLASH_DETECTION
5101 #if 0 /* This causes trouble for GNUS. */
5102 /* If we've locked this file for some other buffer,
5103 query before proceeding. */
5104 if (!visiting
&& EQ (Ffile_locked_p (lockname
), Qt
))
5105 call2 (intern ("ask-user-about-lock"), filename
, Vuser_login_name
);
5108 lock_file (lockname
);
5110 #endif /* CLASH_DETECTION */
5112 encoded_filename
= ENCODE_FILE (filename
);
5114 fn
= SDATA (encoded_filename
);
5118 desc
= emacs_open (fn
, O_WRONLY
| buffer_file_type
, 0);
5119 #else /* not DOS_NT */
5120 desc
= emacs_open (fn
, O_WRONLY
, 0);
5121 #endif /* not DOS_NT */
5123 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
5125 if (auto_saving
) /* Overwrite any previous version of autosave file */
5127 vms_truncate (fn
); /* if fn exists, truncate to zero length */
5128 desc
= emacs_open (fn
, O_RDWR
, 0);
5130 desc
= creat_copy_attrs (STRINGP (current_buffer
->filename
)
5131 ? SDATA (current_buffer
->filename
) : 0,
5134 else /* Write to temporary name and rename if no errors */
5136 Lisp_Object temp_name
;
5137 temp_name
= Ffile_name_directory (filename
);
5139 if (!NILP (temp_name
))
5141 temp_name
= Fmake_temp_name (concat2 (temp_name
,
5142 build_string ("$$SAVE$$")));
5143 fname
= SDATA (filename
);
5144 fn
= SDATA (temp_name
);
5145 desc
= creat_copy_attrs (fname
, fn
);
5148 /* If we can't open the temporary file, try creating a new
5149 version of the original file. VMS "creat" creates a
5150 new version rather than truncating an existing file. */
5153 desc
= creat (fn
, 0666);
5154 #if 0 /* This can clobber an existing file and fail to replace it,
5155 if the user runs out of space. */
5158 /* We can't make a new version;
5159 try to truncate and rewrite existing version if any. */
5161 desc
= emacs_open (fn
, O_RDWR
, 0);
5167 desc
= creat (fn
, 0666);
5171 desc
= emacs_open (fn
,
5172 O_WRONLY
| O_CREAT
| buffer_file_type
5173 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
5174 S_IREAD
| S_IWRITE
);
5175 #else /* not DOS_NT */
5176 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
5177 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
5178 auto_saving
? auto_save_mode_bits
: 0666);
5179 #endif /* not DOS_NT */
5180 #endif /* not VMS */
5184 #ifdef CLASH_DETECTION
5186 if (!auto_saving
) unlock_file (lockname
);
5188 #endif /* CLASH_DETECTION */
5190 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
5193 record_unwind_protect (close_file_unwind
, make_number (desc
));
5195 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
5199 if (NUMBERP (append
))
5200 ret
= lseek (desc
, XINT (append
), 1);
5202 ret
= lseek (desc
, 0, 2);
5205 #ifdef CLASH_DETECTION
5206 if (!auto_saving
) unlock_file (lockname
);
5207 #endif /* CLASH_DETECTION */
5209 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
5217 * Kludge Warning: The VMS C RTL likes to insert carriage returns
5218 * if we do writes that don't end with a carriage return. Furthermore
5219 * it cannot handle writes of more then 16K. The modified
5220 * version of "sys_write" in SYSDEP.C (see comment there) copes with
5221 * this EXCEPT for the last record (iff it doesn't end with a carriage
5222 * return). This implies that if your buffer doesn't end with a carriage
5223 * return, you get one free... tough. However it also means that if
5224 * we make two calls to sys_write (a la the following code) you can
5225 * get one at the gap as well. The easiest way to fix this (honest)
5226 * is to move the gap to the next newline (or the end of the buffer).
5231 if (GPT
> BEG
&& GPT_ADDR
[-1] != '\n')
5232 move_gap (find_next_newline (GPT
, 1));
5234 /* Whether VMS or not, we must move the gap to the next of newline
5235 when we must put designation sequences at beginning of line. */
5236 if (INTEGERP (start
)
5237 && coding
.type
== coding_type_iso2022
5238 && coding
.flags
& CODING_FLAG_ISO_DESIGNATE_AT_BOL
5239 && GPT
> BEG
&& GPT_ADDR
[-1] != '\n')
5241 int opoint
= PT
, opoint_byte
= PT_BYTE
;
5242 scan_newline (PT
, PT_BYTE
, ZV
, ZV_BYTE
, 1, 0);
5243 move_gap_both (PT
, PT_BYTE
);
5244 SET_PT_BOTH (opoint
, opoint_byte
);
5251 if (STRINGP (start
))
5253 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
5254 &annotations
, &coding
);
5257 else if (XINT (start
) != XINT (end
))
5259 tem
= CHAR_TO_BYTE (XINT (start
));
5261 if (XINT (start
) < GPT
)
5263 failure
= 0 > a_write (desc
, Qnil
, XINT (start
),
5264 min (GPT
, XINT (end
)) - XINT (start
),
5265 &annotations
, &coding
);
5269 if (XINT (end
) > GPT
&& !failure
)
5271 tem
= max (XINT (start
), GPT
);
5272 failure
= 0 > a_write (desc
, Qnil
, tem
, XINT (end
) - tem
,
5273 &annotations
, &coding
);
5279 /* If file was empty, still need to write the annotations */
5280 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
5281 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
5285 if (CODING_REQUIRE_FLUSHING (&coding
)
5286 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
5289 /* We have to flush out a data. */
5290 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
5291 failure
= 0 > e_write (desc
, Qnil
, 0, 0, &coding
);
5298 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
5299 Disk full in NFS may be reported here. */
5300 /* mib says that closing the file will try to write as fast as NFS can do
5301 it, and that means the fsync here is not crucial for autosave files. */
5302 if (!auto_saving
&& fsync (desc
) < 0)
5304 /* If fsync fails with EINTR, don't treat that as serious. */
5306 failure
= 1, save_errno
= errno
;
5310 /* Spurious "file has changed on disk" warnings have been
5311 observed on Suns as well.
5312 It seems that `close' can change the modtime, under nfs.
5314 (This has supposedly been fixed in Sunos 4,
5315 but who knows about all the other machines with NFS?) */
5318 /* On VMS and APOLLO, must do the stat after the close
5319 since closing changes the modtime. */
5322 /* Recall that #if defined does not work on VMS. */
5329 /* NFS can report a write failure now. */
5330 if (emacs_close (desc
) < 0)
5331 failure
= 1, save_errno
= errno
;
5334 /* If we wrote to a temporary name and had no errors, rename to real name. */
5338 failure
= (rename (fn
, fname
) != 0), save_errno
= errno
;
5346 /* Discard the unwind protect for close_file_unwind. */
5347 specpdl_ptr
= specpdl
+ count1
;
5348 /* Restore the original current buffer. */
5349 visit_file
= unbind_to (count
, visit_file
);
5351 #ifdef CLASH_DETECTION
5353 unlock_file (lockname
);
5354 #endif /* CLASH_DETECTION */
5356 /* Do this before reporting IO error
5357 to avoid a "file has changed on disk" warning on
5358 next attempt to save. */
5360 current_buffer
->modtime
= st
.st_mtime
;
5363 error ("IO error writing %s: %s", SDATA (filename
),
5364 emacs_strerror (save_errno
));
5368 SAVE_MODIFF
= MODIFF
;
5369 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5370 current_buffer
->filename
= visit_file
;
5371 update_mode_lines
++;
5376 && ! NILP (Fstring_equal (current_buffer
->filename
,
5377 current_buffer
->auto_save_file_name
)))
5378 SAVE_MODIFF
= MODIFF
;
5384 message_with_string ((INTEGERP (append
)
5394 Lisp_Object
merge ();
5396 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5397 doc
: /* Return t if (car A) is numerically less than (car B). */)
5401 return Flss (Fcar (a
), Fcar (b
));
5404 /* Build the complete list of annotations appropriate for writing out
5405 the text between START and END, by calling all the functions in
5406 write-region-annotate-functions and merging the lists they return.
5407 If one of these functions switches to a different buffer, we assume
5408 that buffer contains altered text. Therefore, the caller must
5409 make sure to restore the current buffer in all cases,
5410 as save-excursion would do. */
5413 build_annotations (start
, end
)
5414 Lisp_Object start
, end
;
5416 Lisp_Object annotations
;
5418 struct gcpro gcpro1
, gcpro2
;
5419 Lisp_Object original_buffer
;
5420 int i
, used_global
= 0;
5422 XSETBUFFER (original_buffer
, current_buffer
);
5425 p
= Vwrite_region_annotate_functions
;
5426 GCPRO2 (annotations
, p
);
5429 struct buffer
*given_buffer
= current_buffer
;
5430 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5431 { /* Use the global value of the hook. */
5434 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5436 p
= Fappend (2, arg
);
5439 Vwrite_region_annotations_so_far
= annotations
;
5440 res
= call2 (XCAR (p
), start
, end
);
5441 /* If the function makes a different buffer current,
5442 assume that means this buffer contains altered text to be output.
5443 Reset START and END from the buffer bounds
5444 and discard all previous annotations because they should have
5445 been dealt with by this function. */
5446 if (current_buffer
!= given_buffer
)
5448 XSETFASTINT (start
, BEGV
);
5449 XSETFASTINT (end
, ZV
);
5452 Flength (res
); /* Check basic validity of return value */
5453 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5457 /* Now do the same for annotation functions implied by the file-format */
5458 if (auto_saving
&& (!EQ (current_buffer
->auto_save_file_format
, Qt
)))
5459 p
= current_buffer
->auto_save_file_format
;
5461 p
= current_buffer
->file_format
;
5462 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5464 struct buffer
*given_buffer
= current_buffer
;
5466 Vwrite_region_annotations_so_far
= annotations
;
5468 /* Value is either a list of annotations or nil if the function
5469 has written annotations to a temporary buffer, which is now
5471 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5472 original_buffer
, make_number (i
));
5473 if (current_buffer
!= given_buffer
)
5475 XSETFASTINT (start
, BEGV
);
5476 XSETFASTINT (end
, ZV
);
5481 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5489 build_annotations_2 (start
, end
, pre_write_conversion
, annotations
)
5490 Lisp_Object start
, end
, pre_write_conversion
, annotations
;
5492 struct gcpro gcpro1
;
5495 GCPRO1 (annotations
);
5496 /* At last, do the same for the function PRE_WRITE_CONVERSION
5497 implied by the current coding-system. */
5498 if (!NILP (pre_write_conversion
))
5500 struct buffer
*given_buffer
= current_buffer
;
5501 Vwrite_region_annotations_so_far
= annotations
;
5502 res
= call2 (pre_write_conversion
, start
, end
);
5504 annotations
= (current_buffer
!= given_buffer
5506 : merge (annotations
, res
, Qcar_less_than_car
));
5513 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5514 If STRING is nil, POS is the character position in the current buffer.
5515 Intersperse with them the annotations from *ANNOT
5516 which fall within the range of POS to POS + NCHARS,
5517 each at its appropriate position.
5519 We modify *ANNOT by discarding elements as we use them up.
5521 The return value is negative in case of system call failure. */
5524 a_write (desc
, string
, pos
, nchars
, annot
, coding
)
5527 register int nchars
;
5530 struct coding_system
*coding
;
5534 int lastpos
= pos
+ nchars
;
5536 while (NILP (*annot
) || CONSP (*annot
))
5538 tem
= Fcar_safe (Fcar (*annot
));
5541 nextpos
= XFASTINT (tem
);
5543 /* If there are no more annotations in this range,
5544 output the rest of the range all at once. */
5545 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5546 return e_write (desc
, string
, pos
, lastpos
, coding
);
5548 /* Output buffer text up to the next annotation's position. */
5551 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
5555 /* Output the annotation. */
5556 tem
= Fcdr (Fcar (*annot
));
5559 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5562 *annot
= Fcdr (*annot
);
5567 #ifndef WRITE_BUF_SIZE
5568 #define WRITE_BUF_SIZE (16 * 1024)
5571 /* Write text in the range START and END into descriptor DESC,
5572 encoding them with coding system CODING. If STRING is nil, START
5573 and END are character positions of the current buffer, else they
5574 are indexes to the string STRING. */
5577 e_write (desc
, string
, start
, end
, coding
)
5581 struct coding_system
*coding
;
5583 register char *addr
;
5584 register int nbytes
;
5585 char buf
[WRITE_BUF_SIZE
];
5589 coding
->composing
= COMPOSITION_DISABLED
;
5590 if (coding
->composing
!= COMPOSITION_DISABLED
)
5591 coding_save_composition (coding
, start
, end
, string
);
5593 if (STRINGP (string
))
5595 addr
= SDATA (string
);
5596 nbytes
= SBYTES (string
);
5597 coding
->src_multibyte
= STRING_MULTIBYTE (string
);
5599 else if (start
< end
)
5601 /* It is assured that the gap is not in the range START and END-1. */
5602 addr
= CHAR_POS_ADDR (start
);
5603 nbytes
= CHAR_TO_BYTE (end
) - CHAR_TO_BYTE (start
);
5604 coding
->src_multibyte
5605 = !NILP (current_buffer
->enable_multibyte_characters
);
5611 coding
->src_multibyte
= 1;
5614 /* We used to have a code for handling selective display here. But,
5615 now it is handled within encode_coding. */
5620 result
= encode_coding (coding
, addr
, buf
, nbytes
, WRITE_BUF_SIZE
);
5621 if (coding
->produced
> 0)
5623 coding
->produced
-= emacs_write (desc
, buf
, coding
->produced
);
5624 if (coding
->produced
)
5630 nbytes
-= coding
->consumed
;
5631 addr
+= coding
->consumed
;
5632 if (result
== CODING_FINISH_INSUFFICIENT_SRC
5635 /* The source text ends by an incomplete multibyte form.
5636 There's no way other than write it out as is. */
5637 nbytes
-= emacs_write (desc
, addr
, nbytes
);
5646 start
+= coding
->consumed_char
;
5647 if (coding
->cmp_data
)
5648 coding_adjust_composition_offset (coding
, start
);
5651 if (coding
->cmp_data
)
5652 coding_free_composition_data (coding
);
5657 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5658 Sverify_visited_file_modtime
, 1, 1, 0,
5659 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5660 This means that the file has not been changed since it was visited or saved.
5661 See Info node `(elisp)Modification Time' for more details. */)
5667 Lisp_Object handler
;
5668 Lisp_Object filename
;
5673 if (!STRINGP (b
->filename
)) return Qt
;
5674 if (b
->modtime
== 0) return Qt
;
5676 /* If the file name has special constructs in it,
5677 call the corresponding file handler. */
5678 handler
= Ffind_file_name_handler (b
->filename
,
5679 Qverify_visited_file_modtime
);
5680 if (!NILP (handler
))
5681 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5683 filename
= ENCODE_FILE (b
->filename
);
5685 if (stat (SDATA (filename
), &st
) < 0)
5687 /* If the file doesn't exist now and didn't exist before,
5688 we say that it isn't modified, provided the error is a tame one. */
5689 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
5694 if (st
.st_mtime
== b
->modtime
5695 /* If both are positive, accept them if they are off by one second. */
5696 || (st
.st_mtime
> 0 && b
->modtime
> 0
5697 && (st
.st_mtime
== b
->modtime
+ 1
5698 || st
.st_mtime
== b
->modtime
- 1)))
5703 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5704 Sclear_visited_file_modtime
, 0, 0, 0,
5705 doc
: /* Clear out records of last mod time of visited file.
5706 Next attempt to save will certainly not complain of a discrepancy. */)
5709 current_buffer
->modtime
= 0;
5713 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5714 Svisited_file_modtime
, 0, 0, 0,
5715 doc
: /* Return the current buffer's recorded visited file modification time.
5716 The value is a list of the form (HIGH LOW), like the time values
5717 that `file-attributes' returns. If the current buffer has no recorded
5718 file modification time, this function returns 0.
5719 See Info node `(elisp)Modification Time' for more details. */)
5723 tcons
= long_to_cons ((unsigned long) current_buffer
->modtime
);
5725 return list2 (XCAR (tcons
), XCDR (tcons
));
5729 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5730 Sset_visited_file_modtime
, 0, 1, 0,
5731 doc
: /* Update buffer's recorded modification time from the visited file's time.
5732 Useful if the buffer was not read from the file normally
5733 or if the file itself has been changed for some known benign reason.
5734 An argument specifies the modification time value to use
5735 \(instead of that of the visited file), in the form of a list
5736 \(HIGH . LOW) or (HIGH LOW). */)
5738 Lisp_Object time_list
;
5740 if (!NILP (time_list
))
5741 current_buffer
->modtime
= cons_to_long (time_list
);
5744 register Lisp_Object filename
;
5746 Lisp_Object handler
;
5748 filename
= Fexpand_file_name (current_buffer
->filename
, Qnil
);
5750 /* If the file name has special constructs in it,
5751 call the corresponding file handler. */
5752 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5753 if (!NILP (handler
))
5754 /* The handler can find the file name the same way we did. */
5755 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5757 filename
= ENCODE_FILE (filename
);
5759 if (stat (SDATA (filename
), &st
) >= 0)
5760 current_buffer
->modtime
= st
.st_mtime
;
5767 auto_save_error (error
)
5770 Lisp_Object args
[3], msg
;
5772 struct gcpro gcpro1
;
5774 ring_bell (XFRAME (selected_frame
));
5776 args
[0] = build_string ("Auto-saving %s: %s");
5777 args
[1] = current_buffer
->name
;
5778 args
[2] = Ferror_message_string (error
);
5779 msg
= Fformat (3, args
);
5781 nbytes
= SBYTES (msg
);
5783 for (i
= 0; i
< 3; ++i
)
5786 message2 (SDATA (msg
), nbytes
, STRING_MULTIBYTE (msg
));
5788 message2_nolog (SDATA (msg
), nbytes
, STRING_MULTIBYTE (msg
));
5789 Fsleep_for (make_number (1), Qnil
);
5802 auto_save_mode_bits
= 0666;
5804 /* Get visited file's mode to become the auto save file's mode. */
5805 if (! NILP (current_buffer
->filename
))
5807 if (stat (SDATA (current_buffer
->filename
), &st
) >= 0)
5808 /* But make sure we can overwrite it later! */
5809 auto_save_mode_bits
= st
.st_mode
| 0600;
5810 else if ((modes
= Ffile_modes (current_buffer
->filename
),
5812 /* Remote files don't cooperate with stat. */
5813 auto_save_mode_bits
= XINT (modes
) | 0600;
5817 Fwrite_region (Qnil
, Qnil
,
5818 current_buffer
->auto_save_file_name
,
5819 Qnil
, Qlambda
, Qnil
, Qnil
);
5823 do_auto_save_unwind (stream
) /* used as unwind-protect function */
5828 fclose ((FILE *) (XFASTINT (XCAR (stream
)) << 16
5829 | XFASTINT (XCDR (stream
))));
5834 do_auto_save_unwind_1 (value
) /* used as unwind-protect function */
5837 minibuffer_auto_raise
= XINT (value
);
5842 do_auto_save_make_dir (dir
)
5845 return call2 (Qmake_directory
, dir
, Qt
);
5849 do_auto_save_eh (ignore
)
5855 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5856 doc
: /* Auto-save all buffers that need it.
5857 This is all buffers that have auto-saving enabled
5858 and are changed since last auto-saved.
5859 Auto-saving writes the buffer into a file
5860 so that your editing is not lost if the system crashes.
5861 This file is not the file you visited; that changes only when you save.
5862 Normally we run the normal hook `auto-save-hook' before saving.
5864 A non-nil NO-MESSAGE argument means do not print any message if successful.
5865 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5866 (no_message
, current_only
)
5867 Lisp_Object no_message
, current_only
;
5869 struct buffer
*old
= current_buffer
, *b
;
5870 Lisp_Object tail
, buf
;
5872 int do_handled_files
;
5875 Lisp_Object lispstream
;
5876 int count
= SPECPDL_INDEX ();
5877 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5878 int old_message_p
= 0;
5879 struct gcpro gcpro1
, gcpro2
;
5881 if (max_specpdl_size
< specpdl_size
+ 40)
5882 max_specpdl_size
= specpdl_size
+ 40;
5887 if (NILP (no_message
))
5889 old_message_p
= push_message ();
5890 record_unwind_protect (pop_message_unwind
, Qnil
);
5893 /* Ordinarily don't quit within this function,
5894 but don't make it impossible to quit (in case we get hung in I/O). */
5898 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5899 point to non-strings reached from Vbuffer_alist. */
5901 if (!NILP (Vrun_hooks
))
5902 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5904 if (STRINGP (Vauto_save_list_file_name
))
5906 Lisp_Object listfile
;
5908 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5910 /* Don't try to create the directory when shutting down Emacs,
5911 because creating the directory might signal an error, and
5912 that would leave Emacs in a strange state. */
5913 if (!NILP (Vrun_hooks
))
5917 GCPRO2 (dir
, listfile
);
5918 dir
= Ffile_name_directory (listfile
);
5919 if (NILP (Ffile_directory_p (dir
)))
5920 internal_condition_case_1 (do_auto_save_make_dir
,
5921 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5926 stream
= fopen (SDATA (listfile
), "w");
5929 /* Arrange to close that file whether or not we get an error.
5930 Also reset auto_saving to 0. */
5931 lispstream
= Fcons (Qnil
, Qnil
);
5932 XSETCARFASTINT (lispstream
, (EMACS_UINT
)stream
>> 16);
5933 XSETCDRFASTINT (lispstream
, (EMACS_UINT
)stream
& 0xffff);
5944 record_unwind_protect (do_auto_save_unwind
, lispstream
);
5945 record_unwind_protect (do_auto_save_unwind_1
,
5946 make_number (minibuffer_auto_raise
));
5947 minibuffer_auto_raise
= 0;
5950 /* On first pass, save all files that don't have handlers.
5951 On second pass, save all files that do have handlers.
5953 If Emacs is crashing, the handlers may tweak what is causing
5954 Emacs to crash in the first place, and it would be a shame if
5955 Emacs failed to autosave perfectly ordinary files because it
5956 couldn't handle some ange-ftp'd file. */
5958 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5959 for (tail
= Vbuffer_alist
; GC_CONSP (tail
); tail
= XCDR (tail
))
5961 buf
= XCDR (XCAR (tail
));
5964 /* Record all the buffers that have auto save mode
5965 in the special file that lists them. For each of these buffers,
5966 Record visited name (if any) and auto save name. */
5967 if (STRINGP (b
->auto_save_file_name
)
5968 && stream
!= NULL
&& do_handled_files
== 0)
5970 if (!NILP (b
->filename
))
5972 fwrite (SDATA (b
->filename
), 1,
5973 SBYTES (b
->filename
), stream
);
5975 putc ('\n', stream
);
5976 fwrite (SDATA (b
->auto_save_file_name
), 1,
5977 SBYTES (b
->auto_save_file_name
), stream
);
5978 putc ('\n', stream
);
5981 if (!NILP (current_only
)
5982 && b
!= current_buffer
)
5985 /* Don't auto-save indirect buffers.
5986 The base buffer takes care of it. */
5990 /* Check for auto save enabled
5991 and file changed since last auto save
5992 and file changed since last real save. */
5993 if (STRINGP (b
->auto_save_file_name
)
5994 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5995 && b
->auto_save_modified
< BUF_MODIFF (b
)
5996 /* -1 means we've turned off autosaving for a while--see below. */
5997 && XINT (b
->save_length
) >= 0
5998 && (do_handled_files
5999 || NILP (Ffind_file_name_handler (b
->auto_save_file_name
,
6002 EMACS_TIME before_time
, after_time
;
6004 EMACS_GET_TIME (before_time
);
6006 /* If we had a failure, don't try again for 20 minutes. */
6007 if (b
->auto_save_failure_time
>= 0
6008 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
6011 if ((XFASTINT (b
->save_length
) * 10
6012 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
6013 /* A short file is likely to change a large fraction;
6014 spare the user annoying messages. */
6015 && XFASTINT (b
->save_length
) > 5000
6016 /* These messages are frequent and annoying for `*mail*'. */
6017 && !EQ (b
->filename
, Qnil
)
6018 && NILP (no_message
))
6020 /* It has shrunk too much; turn off auto-saving here. */
6021 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
6022 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
6024 minibuffer_auto_raise
= 0;
6025 /* Turn off auto-saving until there's a real save,
6026 and prevent any more warnings. */
6027 XSETINT (b
->save_length
, -1);
6028 Fsleep_for (make_number (1), Qnil
);
6031 set_buffer_internal (b
);
6032 if (!auto_saved
&& NILP (no_message
))
6033 message1 ("Auto-saving...");
6034 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
6036 b
->auto_save_modified
= BUF_MODIFF (b
);
6037 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
6038 set_buffer_internal (old
);
6040 EMACS_GET_TIME (after_time
);
6042 /* If auto-save took more than 60 seconds,
6043 assume it was an NFS failure that got a timeout. */
6044 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
6045 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
6049 /* Prevent another auto save till enough input events come in. */
6050 record_auto_save ();
6052 if (auto_saved
&& NILP (no_message
))
6056 /* If we are going to restore an old message,
6057 give time to read ours. */
6058 sit_for (1, 0, 0, 0, 0);
6062 /* If we displayed a message and then restored a state
6063 with no message, leave a "done" message on the screen. */
6064 message1 ("Auto-saving...done");
6069 /* This restores the message-stack status. */
6070 unbind_to (count
, Qnil
);
6074 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
6075 Sset_buffer_auto_saved
, 0, 0, 0,
6076 doc
: /* Mark current buffer as auto-saved with its current text.
6077 No auto-save file will be written until the buffer changes again. */)
6080 current_buffer
->auto_save_modified
= MODIFF
;
6081 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
6082 current_buffer
->auto_save_failure_time
= -1;
6086 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
6087 Sclear_buffer_auto_save_failure
, 0, 0, 0,
6088 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
6091 current_buffer
->auto_save_failure_time
= -1;
6095 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
6097 doc
: /* Return t if current buffer has been auto-saved recently.
6098 More precisely, if it has been auto-saved since last read from or saved
6099 in the visited file. If the buffer has no visited file,
6100 then any auto-save counts as "recent". */)
6103 return (SAVE_MODIFF
< current_buffer
->auto_save_modified
) ? Qt
: Qnil
;
6106 /* Reading and completing file names */
6107 extern Lisp_Object
Ffile_name_completion (), Ffile_name_all_completions ();
6109 /* In the string VAL, change each $ to $$ and return the result. */
6112 double_dollars (val
)
6115 register const unsigned char *old
;
6116 register unsigned char *new;
6120 osize
= SBYTES (val
);
6122 /* Count the number of $ characters. */
6123 for (n
= osize
, count
= 0, old
= SDATA (val
); n
> 0; n
--)
6124 if (*old
++ == '$') count
++;
6128 val
= make_uninit_multibyte_string (SCHARS (val
) + count
,
6131 for (n
= osize
; n
> 0; n
--)
6145 read_file_name_cleanup (arg
)
6148 return (current_buffer
->directory
= arg
);
6151 DEFUN ("read-file-name-internal", Fread_file_name_internal
, Sread_file_name_internal
,
6153 doc
: /* Internal subroutine for read-file-name. Do not call this. */)
6154 (string
, dir
, action
)
6155 Lisp_Object string
, dir
, action
;
6156 /* action is nil for complete, t for return list of completions,
6157 lambda for verify final value */
6159 Lisp_Object name
, specdir
, realdir
, val
, orig_string
;
6161 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
6163 CHECK_STRING (string
);
6170 /* No need to protect ACTION--we only compare it with t and nil. */
6171 GCPRO5 (string
, realdir
, name
, specdir
, orig_string
);
6173 if (SCHARS (string
) == 0)
6175 if (EQ (action
, Qlambda
))
6183 orig_string
= string
;
6184 string
= Fsubstitute_in_file_name (string
);
6185 changed
= NILP (Fstring_equal (string
, orig_string
));
6186 name
= Ffile_name_nondirectory (string
);
6187 val
= Ffile_name_directory (string
);
6189 realdir
= Fexpand_file_name (val
, realdir
);
6194 specdir
= Ffile_name_directory (string
);
6195 val
= Ffile_name_completion (name
, realdir
);
6200 return double_dollars (string
);
6204 if (!NILP (specdir
))
6205 val
= concat2 (specdir
, val
);
6207 return double_dollars (val
);
6210 #endif /* not VMS */
6214 if (EQ (action
, Qt
))
6216 Lisp_Object all
= Ffile_name_all_completions (name
, realdir
);
6220 if (NILP (Vread_file_name_predicate
)
6221 || EQ (Vread_file_name_predicate
, Qfile_exists_p
))
6225 if (EQ (Vread_file_name_predicate
, Qfile_directory_p
))
6227 /* Brute-force speed up for directory checking:
6228 Discard strings which don't end in a slash. */
6229 for (comp
= Qnil
; CONSP (all
); all
= XCDR (all
))
6231 Lisp_Object tem
= XCAR (all
);
6233 if (STRINGP (tem
) &&
6234 (len
= SCHARS (tem
), len
> 0) &&
6235 IS_DIRECTORY_SEP (SREF (tem
, len
-1)))
6236 comp
= Fcons (tem
, comp
);
6242 /* Must do it the hard (and slow) way. */
6243 GCPRO3 (all
, comp
, specdir
);
6244 count
= SPECPDL_INDEX ();
6245 record_unwind_protect (read_file_name_cleanup
, current_buffer
->directory
);
6246 current_buffer
->directory
= realdir
;
6247 for (comp
= Qnil
; CONSP (all
); all
= XCDR (all
))
6248 if (!NILP (call1 (Vread_file_name_predicate
, XCAR (all
))))
6249 comp
= Fcons (XCAR (all
), comp
);
6250 unbind_to (count
, Qnil
);
6253 return Fnreverse (comp
);
6256 /* Only other case actually used is ACTION = lambda */
6258 /* Supposedly this helps commands such as `cd' that read directory names,
6259 but can someone explain how it helps them? -- RMS */
6260 if (SCHARS (name
) == 0)
6263 string
= Fexpand_file_name (string
, dir
);
6264 if (!NILP (Vread_file_name_predicate
))
6265 return call1 (Vread_file_name_predicate
, string
);
6266 return Ffile_exists_p (string
);
6269 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
6270 Snext_read_file_uses_dialog_p
, 0, 0, 0,
6271 doc
: /* Return t if a call to `read-file-name' will use a dialog.
6272 The return value is only relevant for a call to `read-file-name' that happens
6273 before any other event (mouse or keypress) is handeled. */)
6276 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6277 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
6286 DEFUN ("read-file-name", Fread_file_name
, Sread_file_name
, 1, 6, 0,
6287 doc
: /* Read file name, prompting with PROMPT and completing in directory DIR.
6288 Value is not expanded---you must call `expand-file-name' yourself.
6289 Default name to DEFAULT-FILENAME if user exits the minibuffer with
6290 the same non-empty string that was inserted by this function.
6291 (If DEFAULT-FILENAME is omitted, the visited file name is used,
6292 except that if INITIAL is specified, that combined with DIR is used.)
6293 If the user exits with an empty minibuffer, this function returns
6294 an empty string. (This can only happen if the user erased the
6295 pre-inserted contents or if `insert-default-directory' is nil.)
6296 Fourth arg MUSTMATCH non-nil means require existing file's name.
6297 Non-nil and non-t means also require confirmation after completion.
6298 Fifth arg INITIAL specifies text to start with.
6299 If optional sixth arg PREDICATE is non-nil, possible completions and
6300 the resulting file name must satisfy (funcall PREDICATE NAME).
6301 DIR should be an absolute directory name. It defaults to the value of
6302 `default-directory'.
6304 If this command was invoked with the mouse, use a file dialog box if
6305 `use-dialog-box' is non-nil, and the window system or X toolkit in use
6306 provides a file dialog box.
6308 See also `read-file-name-completion-ignore-case'
6309 and `read-file-name-function'. */)
6310 (prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
)
6311 Lisp_Object prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
;
6313 Lisp_Object val
, insdef
, tem
;
6314 struct gcpro gcpro1
, gcpro2
;
6315 register char *homedir
;
6316 Lisp_Object decoded_homedir
;
6317 int replace_in_history
= 0;
6318 int add_to_history
= 0;
6322 dir
= current_buffer
->directory
;
6323 if (NILP (Ffile_name_absolute_p (dir
)))
6324 dir
= Fexpand_file_name (dir
, Qnil
);
6325 if (NILP (default_filename
))
6328 ? Fexpand_file_name (initial
, dir
)
6329 : current_buffer
->filename
);
6331 /* If dir starts with user's homedir, change that to ~. */
6332 homedir
= (char *) egetenv ("HOME");
6334 /* homedir can be NULL in temacs, since Vprocess_environment is not
6335 yet set up. We shouldn't crash in that case. */
6338 homedir
= strcpy (alloca (strlen (homedir
) + 1), homedir
);
6339 CORRECT_DIR_SEPS (homedir
);
6344 = DECODE_FILE (make_unibyte_string (homedir
, strlen (homedir
)));
6347 && !strncmp (SDATA (decoded_homedir
), SDATA (dir
),
6348 SBYTES (decoded_homedir
))
6349 && IS_DIRECTORY_SEP (SREF (dir
, SBYTES (decoded_homedir
))))
6351 dir
= Fsubstring (dir
, make_number (SCHARS (decoded_homedir
)), Qnil
);
6352 dir
= concat2 (build_string ("~"), dir
);
6354 /* Likewise for default_filename. */
6356 && STRINGP (default_filename
)
6357 && !strncmp (SDATA (decoded_homedir
), SDATA (default_filename
),
6358 SBYTES (decoded_homedir
))
6359 && IS_DIRECTORY_SEP (SREF (default_filename
, SBYTES (decoded_homedir
))))
6362 = Fsubstring (default_filename
,
6363 make_number (SCHARS (decoded_homedir
)), Qnil
);
6364 default_filename
= concat2 (build_string ("~"), default_filename
);
6366 if (!NILP (default_filename
))
6368 CHECK_STRING (default_filename
);
6369 default_filename
= double_dollars (default_filename
);
6372 if (insert_default_directory
&& STRINGP (dir
))
6375 if (!NILP (initial
))
6377 Lisp_Object args
[2], pos
;
6381 insdef
= Fconcat (2, args
);
6382 pos
= make_number (SCHARS (double_dollars (dir
)));
6383 insdef
= Fcons (double_dollars (insdef
), pos
);
6386 insdef
= double_dollars (insdef
);
6388 else if (STRINGP (initial
))
6389 insdef
= Fcons (double_dollars (initial
), make_number (0));
6393 if (!NILP (Vread_file_name_function
))
6395 Lisp_Object args
[7];
6397 GCPRO2 (insdef
, default_filename
);
6398 args
[0] = Vread_file_name_function
;
6401 args
[3] = default_filename
;
6402 args
[4] = mustmatch
;
6404 args
[6] = predicate
;
6405 RETURN_UNGCPRO (Ffuncall (7, args
));
6408 count
= SPECPDL_INDEX ();
6409 specbind (intern ("completion-ignore-case"),
6410 read_file_name_completion_ignore_case
? Qt
: Qnil
);
6411 specbind (intern ("minibuffer-completing-file-name"), Qt
);
6412 specbind (intern ("read-file-name-predicate"),
6413 (NILP (predicate
) ? Qfile_exists_p
: predicate
));
6415 GCPRO2 (insdef
, default_filename
);
6417 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6418 if (! NILP (Fnext_read_file_uses_dialog_p ()))
6420 /* If DIR contains a file name, split it. */
6422 file
= Ffile_name_nondirectory (dir
);
6423 if (SCHARS (file
) && NILP (default_filename
))
6425 default_filename
= file
;
6426 dir
= Ffile_name_directory (dir
);
6428 if (!NILP(default_filename
))
6429 default_filename
= Fexpand_file_name (default_filename
, dir
);
6430 val
= Fx_file_dialog (prompt
, dir
, default_filename
, mustmatch
,
6431 EQ (predicate
, Qfile_directory_p
) ? Qt
: Qnil
);
6436 val
= Fcompleting_read (prompt
, intern ("read-file-name-internal"),
6437 dir
, mustmatch
, insdef
,
6438 Qfile_name_history
, default_filename
, Qnil
);
6440 tem
= Fsymbol_value (Qfile_name_history
);
6441 if (CONSP (tem
) && EQ (XCAR (tem
), val
))
6442 replace_in_history
= 1;
6444 /* If Fcompleting_read returned the inserted default string itself
6445 (rather than a new string with the same contents),
6446 it has to mean that the user typed RET with the minibuffer empty.
6447 In that case, we really want to return ""
6448 so that commands such as set-visited-file-name can distinguish. */
6449 if (EQ (val
, default_filename
))
6451 /* In this case, Fcompleting_read has not added an element
6452 to the history. Maybe we should. */
6453 if (! replace_in_history
)
6459 unbind_to (count
, Qnil
);
6462 error ("No file name specified");
6464 tem
= Fstring_equal (val
, CONSP (insdef
) ? XCAR (insdef
) : insdef
);
6466 if (!NILP (tem
) && !NILP (default_filename
))
6467 val
= default_filename
;
6468 val
= Fsubstitute_in_file_name (val
);
6470 if (replace_in_history
)
6471 /* Replace what Fcompleting_read added to the history
6472 with what we will actually return. */
6474 Lisp_Object val1
= double_dollars (val
);
6475 tem
= Fsymbol_value (Qfile_name_history
);
6476 if (history_delete_duplicates
)
6477 XSETCDR (tem
, Fdelete (val1
, XCDR(tem
)));
6478 XSETCAR (tem
, val1
);
6480 else if (add_to_history
)
6482 /* Add the value to the history--but not if it matches
6483 the last value already there. */
6484 Lisp_Object val1
= double_dollars (val
);
6485 tem
= Fsymbol_value (Qfile_name_history
);
6486 if (! CONSP (tem
) || NILP (Fequal (XCAR (tem
), val1
)))
6488 if (history_delete_duplicates
) tem
= Fdelete (val1
, tem
);
6489 Fset (Qfile_name_history
, Fcons (val1
, tem
));
6500 /* Must be set before any path manipulation is performed. */
6501 XSETFASTINT (Vdirectory_sep_char
, '/');
6508 Qoperations
= intern ("operations");
6509 Qexpand_file_name
= intern ("expand-file-name");
6510 Qsubstitute_in_file_name
= intern ("substitute-in-file-name");
6511 Qdirectory_file_name
= intern ("directory-file-name");
6512 Qfile_name_directory
= intern ("file-name-directory");
6513 Qfile_name_nondirectory
= intern ("file-name-nondirectory");
6514 Qunhandled_file_name_directory
= intern ("unhandled-file-name-directory");
6515 Qfile_name_as_directory
= intern ("file-name-as-directory");
6516 Qcopy_file
= intern ("copy-file");
6517 Qmake_directory_internal
= intern ("make-directory-internal");
6518 Qmake_directory
= intern ("make-directory");
6519 Qdelete_directory
= intern ("delete-directory");
6520 Qdelete_file
= intern ("delete-file");
6521 Qrename_file
= intern ("rename-file");
6522 Qadd_name_to_file
= intern ("add-name-to-file");
6523 Qmake_symbolic_link
= intern ("make-symbolic-link");
6524 Qfile_exists_p
= intern ("file-exists-p");
6525 Qfile_executable_p
= intern ("file-executable-p");
6526 Qfile_readable_p
= intern ("file-readable-p");
6527 Qfile_writable_p
= intern ("file-writable-p");
6528 Qfile_symlink_p
= intern ("file-symlink-p");
6529 Qaccess_file
= intern ("access-file");
6530 Qfile_directory_p
= intern ("file-directory-p");
6531 Qfile_regular_p
= intern ("file-regular-p");
6532 Qfile_accessible_directory_p
= intern ("file-accessible-directory-p");
6533 Qfile_modes
= intern ("file-modes");
6534 Qset_file_modes
= intern ("set-file-modes");
6535 Qset_file_times
= intern ("set-file-times");
6536 Qfile_newer_than_file_p
= intern ("file-newer-than-file-p");
6537 Qinsert_file_contents
= intern ("insert-file-contents");
6538 Qwrite_region
= intern ("write-region");
6539 Qverify_visited_file_modtime
= intern ("verify-visited-file-modtime");
6540 Qset_visited_file_modtime
= intern ("set-visited-file-modtime");
6541 Qauto_save_coding
= intern ("auto-save-coding");
6543 staticpro (&Qoperations
);
6544 staticpro (&Qexpand_file_name
);
6545 staticpro (&Qsubstitute_in_file_name
);
6546 staticpro (&Qdirectory_file_name
);
6547 staticpro (&Qfile_name_directory
);
6548 staticpro (&Qfile_name_nondirectory
);
6549 staticpro (&Qunhandled_file_name_directory
);
6550 staticpro (&Qfile_name_as_directory
);
6551 staticpro (&Qcopy_file
);
6552 staticpro (&Qmake_directory_internal
);
6553 staticpro (&Qmake_directory
);
6554 staticpro (&Qdelete_directory
);
6555 staticpro (&Qdelete_file
);
6556 staticpro (&Qrename_file
);
6557 staticpro (&Qadd_name_to_file
);
6558 staticpro (&Qmake_symbolic_link
);
6559 staticpro (&Qfile_exists_p
);
6560 staticpro (&Qfile_executable_p
);
6561 staticpro (&Qfile_readable_p
);
6562 staticpro (&Qfile_writable_p
);
6563 staticpro (&Qaccess_file
);
6564 staticpro (&Qfile_symlink_p
);
6565 staticpro (&Qfile_directory_p
);
6566 staticpro (&Qfile_regular_p
);
6567 staticpro (&Qfile_accessible_directory_p
);
6568 staticpro (&Qfile_modes
);
6569 staticpro (&Qset_file_modes
);
6570 staticpro (&Qset_file_times
);
6571 staticpro (&Qfile_newer_than_file_p
);
6572 staticpro (&Qinsert_file_contents
);
6573 staticpro (&Qwrite_region
);
6574 staticpro (&Qverify_visited_file_modtime
);
6575 staticpro (&Qset_visited_file_modtime
);
6576 staticpro (&Qauto_save_coding
);
6578 Qfile_name_history
= intern ("file-name-history");
6579 Fset (Qfile_name_history
, Qnil
);
6580 staticpro (&Qfile_name_history
);
6582 Qfile_error
= intern ("file-error");
6583 staticpro (&Qfile_error
);
6584 Qfile_already_exists
= intern ("file-already-exists");
6585 staticpro (&Qfile_already_exists
);
6586 Qfile_date_error
= intern ("file-date-error");
6587 staticpro (&Qfile_date_error
);
6588 Qexcl
= intern ("excl");
6592 Qfind_buffer_file_type
= intern ("find-buffer-file-type");
6593 staticpro (&Qfind_buffer_file_type
);
6596 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system
,
6597 doc
: /* *Coding system for encoding file names.
6598 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6599 Vfile_name_coding_system
= Qnil
;
6601 DEFVAR_LISP ("default-file-name-coding-system",
6602 &Vdefault_file_name_coding_system
,
6603 doc
: /* Default coding system for encoding file names.
6604 This variable is used only when `file-name-coding-system' is nil.
6606 This variable is set/changed by the command `set-language-environment'.
6607 User should not set this variable manually,
6608 instead use `file-name-coding-system' to get a constant encoding
6609 of file names regardless of the current language environment. */);
6610 Vdefault_file_name_coding_system
= Qnil
;
6612 Qformat_decode
= intern ("format-decode");
6613 staticpro (&Qformat_decode
);
6614 Qformat_annotate_function
= intern ("format-annotate-function");
6615 staticpro (&Qformat_annotate_function
);
6616 Qafter_insert_file_set_coding
= intern ("after-insert-file-set-coding");
6617 staticpro (&Qafter_insert_file_set_coding
);
6619 Qcar_less_than_car
= intern ("car-less-than-car");
6620 staticpro (&Qcar_less_than_car
);
6622 Fput (Qfile_error
, Qerror_conditions
,
6623 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
)));
6624 Fput (Qfile_error
, Qerror_message
,
6625 build_string ("File error"));
6627 Fput (Qfile_already_exists
, Qerror_conditions
,
6628 Fcons (Qfile_already_exists
,
6629 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
))));
6630 Fput (Qfile_already_exists
, Qerror_message
,
6631 build_string ("File already exists"));
6633 Fput (Qfile_date_error
, Qerror_conditions
,
6634 Fcons (Qfile_date_error
,
6635 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
))));
6636 Fput (Qfile_date_error
, Qerror_message
,
6637 build_string ("Cannot set file date"));
6639 DEFVAR_LISP ("read-file-name-function", &Vread_file_name_function
,
6640 doc
: /* If this is non-nil, `read-file-name' does its work by calling this function. */);
6641 Vread_file_name_function
= Qnil
;
6643 DEFVAR_LISP ("read-file-name-predicate", &Vread_file_name_predicate
,
6644 doc
: /* Current predicate used by `read-file-name-internal'. */);
6645 Vread_file_name_predicate
= Qnil
;
6647 DEFVAR_BOOL ("read-file-name-completion-ignore-case", &read_file_name_completion_ignore_case
,
6648 doc
: /* *Non-nil means when reading a file name completion ignores case. */);
6649 #if defined VMS || defined DOS_NT || defined MAC_OS
6650 read_file_name_completion_ignore_case
= 1;
6652 read_file_name_completion_ignore_case
= 0;
6655 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory
,
6656 doc
: /* *Non-nil means when reading a filename start with default dir in minibuffer.
6657 If the initial minibuffer contents are non-empty, you can usually
6658 request a default filename by typing RETURN without editing. For some
6659 commands, exiting with an empty minibuffer has a special meaning,
6660 such as making the current buffer visit no file in the case of
6661 `set-visited-file-name'.
6662 If this variable is non-nil, the minibuffer contents are always
6663 initially non-empty and typing RETURN without editing will fetch the
6664 default name, if one is provided. Note however that this default name
6665 is not necessarily the name originally inserted in the minibuffer, if
6666 that is just the default directory.
6667 If this variable is nil, the minibuffer often starts out empty. In
6668 that case you may have to explicitly fetch the next history element to
6669 request the default name. */);
6670 insert_default_directory
= 1;
6672 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm
,
6673 doc
: /* *Non-nil means write new files with record format `stmlf'.
6674 nil means use format `var'. This variable is meaningful only on VMS. */);
6675 vms_stmlf_recfm
= 0;
6677 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char
,
6678 doc
: /* Directory separator character for built-in functions that return file names.
6679 The value is always ?/. Don't use this variable, just use `/'. */);
6681 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist
,
6682 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6683 If a file name matches REGEXP, then all I/O on that file is done by calling
6686 The first argument given to HANDLER is the name of the I/O primitive
6687 to be handled; the remaining arguments are the arguments that were
6688 passed to that primitive. For example, if you do
6689 (file-exists-p FILENAME)
6690 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6691 (funcall HANDLER 'file-exists-p FILENAME)
6692 The function `find-file-name-handler' checks this list for a handler
6693 for its argument. */);
6694 Vfile_name_handler_alist
= Qnil
;
6696 DEFVAR_LISP ("set-auto-coding-function",
6697 &Vset_auto_coding_function
,
6698 doc
: /* If non-nil, a function to call to decide a coding system of file.
6699 Two arguments are passed to this function: the file name
6700 and the length of a file contents following the point.
6701 This function should return a coding system to decode the file contents.
6702 It should check the file name against `auto-coding-alist'.
6703 If no coding system is decided, it should check a coding system
6704 specified in the heading lines with the format:
6705 -*- ... coding: CODING-SYSTEM; ... -*-
6706 or local variable spec of the tailing lines with `coding:' tag. */);
6707 Vset_auto_coding_function
= Qnil
;
6709 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions
,
6710 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
6711 Each is passed one argument, the number of characters inserted.
6712 It should return the new character count, and leave point the same.
6713 If `insert-file-contents' is intercepted by a handler from
6714 `file-name-handler-alist', that handler is responsible for calling the
6715 functions in `after-insert-file-functions' if appropriate. */);
6716 Vafter_insert_file_functions
= Qnil
;
6718 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions
,
6719 doc
: /* A list of functions to be called at the start of `write-region'.
6720 Each is passed two arguments, START and END as for `write-region'.
6721 These are usually two numbers but not always; see the documentation
6722 for `write-region'. The function should return a list of pairs
6723 of the form (POSITION . STRING), consisting of strings to be effectively
6724 inserted at the specified positions of the file being written (1 means to
6725 insert before the first byte written). The POSITIONs must be sorted into
6726 increasing order. If there are several functions in the list, the several
6727 lists are merged destructively. Alternatively, the function can return
6728 with a different buffer current; in that case it should pay attention
6729 to the annotations returned by previous functions and listed in
6730 `write-region-annotations-so-far'.*/);
6731 Vwrite_region_annotate_functions
= Qnil
;
6732 staticpro (&Qwrite_region_annotate_functions
);
6733 Qwrite_region_annotate_functions
6734 = intern ("write-region-annotate-functions");
6736 DEFVAR_LISP ("write-region-annotations-so-far",
6737 &Vwrite_region_annotations_so_far
,
6738 doc
: /* When an annotation function is called, this holds the previous annotations.
6739 These are the annotations made by other annotation functions
6740 that were already called. See also `write-region-annotate-functions'. */);
6741 Vwrite_region_annotations_so_far
= Qnil
;
6743 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers
,
6744 doc
: /* A list of file name handlers that temporarily should not be used.
6745 This applies only to the operation `inhibit-file-name-operation'. */);
6746 Vinhibit_file_name_handlers
= Qnil
;
6748 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation
,
6749 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6750 Vinhibit_file_name_operation
= Qnil
;
6752 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name
,
6753 doc
: /* File name in which we write a list of all auto save file names.
6754 This variable is initialized automatically from `auto-save-list-file-prefix'
6755 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6756 a non-nil value. */);
6757 Vauto_save_list_file_name
= Qnil
;
6759 defsubr (&Sfind_file_name_handler
);
6760 defsubr (&Sfile_name_directory
);
6761 defsubr (&Sfile_name_nondirectory
);
6762 defsubr (&Sunhandled_file_name_directory
);
6763 defsubr (&Sfile_name_as_directory
);
6764 defsubr (&Sdirectory_file_name
);
6765 defsubr (&Smake_temp_name
);
6766 defsubr (&Sexpand_file_name
);
6767 defsubr (&Ssubstitute_in_file_name
);
6768 defsubr (&Scopy_file
);
6769 defsubr (&Smake_directory_internal
);
6770 defsubr (&Sdelete_directory
);
6771 defsubr (&Sdelete_file
);
6772 defsubr (&Srename_file
);
6773 defsubr (&Sadd_name_to_file
);
6775 defsubr (&Smake_symbolic_link
);
6776 #endif /* S_IFLNK */
6778 defsubr (&Sdefine_logical_name
);
6781 defsubr (&Ssysnetunam
);
6782 #endif /* HPUX_NET */
6783 defsubr (&Sfile_name_absolute_p
);
6784 defsubr (&Sfile_exists_p
);
6785 defsubr (&Sfile_executable_p
);
6786 defsubr (&Sfile_readable_p
);
6787 defsubr (&Sfile_writable_p
);
6788 defsubr (&Saccess_file
);
6789 defsubr (&Sfile_symlink_p
);
6790 defsubr (&Sfile_directory_p
);
6791 defsubr (&Sfile_accessible_directory_p
);
6792 defsubr (&Sfile_regular_p
);
6793 defsubr (&Sfile_modes
);
6794 defsubr (&Sset_file_modes
);
6795 defsubr (&Sset_file_times
);
6796 defsubr (&Sset_default_file_modes
);
6797 defsubr (&Sdefault_file_modes
);
6798 defsubr (&Sfile_newer_than_file_p
);
6799 defsubr (&Sinsert_file_contents
);
6800 defsubr (&Swrite_region
);
6801 defsubr (&Scar_less_than_car
);
6802 defsubr (&Sverify_visited_file_modtime
);
6803 defsubr (&Sclear_visited_file_modtime
);
6804 defsubr (&Svisited_file_modtime
);
6805 defsubr (&Sset_visited_file_modtime
);
6806 defsubr (&Sdo_auto_save
);
6807 defsubr (&Sset_buffer_auto_saved
);
6808 defsubr (&Sclear_buffer_auto_save_failure
);
6809 defsubr (&Srecent_auto_save_p
);
6811 defsubr (&Sread_file_name_internal
);
6812 defsubr (&Sread_file_name
);
6813 defsubr (&Snext_read_file_uses_dialog_p
);
6816 defsubr (&Sunix_sync
);
6820 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
6821 (do not change this comment) */