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., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, 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, 5,
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. */)
2432 (file
, newname
, ok_if_already_exists
, keep_time
, mustbenew
)
2433 Lisp_Object file
, newname
, ok_if_already_exists
, keep_time
, mustbenew
;
2436 char buf
[16 * 1024];
2437 struct stat st
, out_st
;
2438 Lisp_Object handler
;
2439 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2440 int count
= SPECPDL_INDEX ();
2441 int input_file_statable_p
;
2442 Lisp_Object encoded_file
, encoded_newname
;
2444 encoded_file
= encoded_newname
= Qnil
;
2445 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2446 CHECK_STRING (file
);
2447 CHECK_STRING (newname
);
2449 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
2450 barf_or_query_if_file_exists (newname
, "overwrite", 1, 0, 1);
2452 if (!NILP (Ffile_directory_p (newname
)))
2453 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2455 newname
= Fexpand_file_name (newname
, Qnil
);
2457 file
= Fexpand_file_name (file
, Qnil
);
2459 /* If the input file name has special constructs in it,
2460 call the corresponding file handler. */
2461 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
2462 /* Likewise for output file name. */
2464 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
2465 if (!NILP (handler
))
2466 RETURN_UNGCPRO (call5 (handler
, Qcopy_file
, file
, newname
,
2467 ok_if_already_exists
, keep_time
));
2469 encoded_file
= ENCODE_FILE (file
);
2470 encoded_newname
= ENCODE_FILE (newname
);
2472 if (NILP (ok_if_already_exists
)
2473 || INTEGERP (ok_if_already_exists
))
2474 barf_or_query_if_file_exists (encoded_newname
, "copy to it",
2475 INTEGERP (ok_if_already_exists
), &out_st
, 0);
2476 else if (stat (SDATA (encoded_newname
), &out_st
) < 0)
2480 if (!CopyFile (SDATA (encoded_file
),
2481 SDATA (encoded_newname
),
2483 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
2484 /* CopyFile retains the timestamp by default. */
2485 else if (NILP (keep_time
))
2491 EMACS_GET_TIME (now
);
2492 filename
= SDATA (encoded_newname
);
2494 /* Ensure file is writable while its modified time is set. */
2495 attributes
= GetFileAttributes (filename
);
2496 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2497 if (set_file_times (filename
, now
, now
))
2499 /* Restore original attributes. */
2500 SetFileAttributes (filename
, attributes
);
2501 Fsignal (Qfile_date_error
,
2502 Fcons (build_string ("Cannot set file date"),
2503 Fcons (newname
, Qnil
)));
2505 /* Restore original attributes. */
2506 SetFileAttributes (filename
, attributes
);
2508 #else /* not WINDOWSNT */
2510 ifd
= emacs_open (SDATA (encoded_file
), O_RDONLY
, 0);
2514 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2516 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2518 /* We can only copy regular files and symbolic links. Other files are not
2520 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
2522 #if !defined (DOS_NT) || __DJGPP__ > 1
2523 if (out_st
.st_mode
!= 0
2524 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2527 report_file_error ("Input and output files are the same",
2528 Fcons (file
, Fcons (newname
, Qnil
)));
2532 #if defined (S_ISREG) && defined (S_ISLNK)
2533 if (input_file_statable_p
)
2535 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
2537 #if defined (EISDIR)
2538 /* Get a better looking error message. */
2541 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2544 #endif /* S_ISREG && S_ISLNK */
2547 /* Create the copy file with the same record format as the input file */
2548 ofd
= sys_creat (SDATA (encoded_newname
), 0666, ifd
);
2551 /* System's default file type was set to binary by _fmode in emacs.c. */
2552 ofd
= emacs_open (SDATA (encoded_newname
),
2553 O_WRONLY
| O_TRUNC
| O_CREAT
2554 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
2555 S_IREAD
| S_IWRITE
);
2556 #else /* not MSDOS */
2557 ofd
= emacs_open (SDATA (encoded_newname
),
2558 O_WRONLY
| O_TRUNC
| O_CREAT
2559 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
2561 #endif /* not MSDOS */
2564 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2566 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2570 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2571 if (emacs_write (ofd
, buf
, n
) != n
)
2572 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2575 /* Closing the output clobbers the file times on some systems. */
2576 if (emacs_close (ofd
) < 0)
2577 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2579 if (input_file_statable_p
)
2581 if (!NILP (keep_time
))
2583 EMACS_TIME atime
, mtime
;
2584 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
2585 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
2586 if (set_file_times (SDATA (encoded_newname
),
2588 Fsignal (Qfile_date_error
,
2589 Fcons (build_string ("Cannot set file date"),
2590 Fcons (newname
, Qnil
)));
2593 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2595 #if defined (__DJGPP__) && __DJGPP__ > 1
2596 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2597 and if it can't, it tells so. Otherwise, under MSDOS we usually
2598 get only the READ bit, which will make the copied file read-only,
2599 so it's better not to chmod at all. */
2600 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2601 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2602 #endif /* DJGPP version 2 or newer */
2607 #endif /* WINDOWSNT */
2609 /* Discard the unwind protects. */
2610 specpdl_ptr
= specpdl
+ count
;
2616 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2617 Smake_directory_internal
, 1, 1, 0,
2618 doc
: /* Create a new directory named DIRECTORY. */)
2620 Lisp_Object directory
;
2622 const unsigned char *dir
;
2623 Lisp_Object handler
;
2624 Lisp_Object encoded_dir
;
2626 CHECK_STRING (directory
);
2627 directory
= Fexpand_file_name (directory
, Qnil
);
2629 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2630 if (!NILP (handler
))
2631 return call2 (handler
, Qmake_directory_internal
, directory
);
2633 encoded_dir
= ENCODE_FILE (directory
);
2635 dir
= SDATA (encoded_dir
);
2638 if (mkdir (dir
) != 0)
2640 if (mkdir (dir
, 0777) != 0)
2642 report_file_error ("Creating directory", Flist (1, &directory
));
2647 DEFUN ("delete-directory", Fdelete_directory
, Sdelete_directory
, 1, 1, "FDelete directory: ",
2648 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2650 Lisp_Object directory
;
2652 const unsigned char *dir
;
2653 Lisp_Object handler
;
2654 Lisp_Object encoded_dir
;
2656 CHECK_STRING (directory
);
2657 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2659 handler
= Ffind_file_name_handler (directory
, Qdelete_directory
);
2660 if (!NILP (handler
))
2661 return call2 (handler
, Qdelete_directory
, directory
);
2663 encoded_dir
= ENCODE_FILE (directory
);
2665 dir
= SDATA (encoded_dir
);
2667 if (rmdir (dir
) != 0)
2668 report_file_error ("Removing directory", Flist (1, &directory
));
2673 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 1, "fDelete file: ",
2674 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2675 If file has multiple names, it continues to exist with the other names. */)
2677 Lisp_Object filename
;
2679 Lisp_Object handler
;
2680 Lisp_Object encoded_file
;
2681 struct gcpro gcpro1
;
2684 if (!NILP (Ffile_directory_p (filename
))
2685 && NILP (Ffile_symlink_p (filename
)))
2686 Fsignal (Qfile_error
,
2687 Fcons (build_string ("Removing old name: is a directory"),
2688 Fcons (filename
, Qnil
)));
2690 filename
= Fexpand_file_name (filename
, Qnil
);
2692 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2693 if (!NILP (handler
))
2694 return call2 (handler
, Qdelete_file
, filename
);
2696 encoded_file
= ENCODE_FILE (filename
);
2698 if (0 > unlink (SDATA (encoded_file
)))
2699 report_file_error ("Removing old name", Flist (1, &filename
));
2704 internal_delete_file_1 (ignore
)
2710 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2713 internal_delete_file (filename
)
2714 Lisp_Object filename
;
2716 return NILP (internal_condition_case_1 (Fdelete_file
, filename
,
2717 Qt
, internal_delete_file_1
));
2720 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2721 "fRename file: \nGRename %s to file: \np",
2722 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2723 If file has names other than FILE, it continues to have those names.
2724 Signals a `file-already-exists' error if a file NEWNAME already exists
2725 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2726 A number as third arg means request confirmation if NEWNAME already exists.
2727 This is what happens in interactive use with M-x. */)
2728 (file
, newname
, ok_if_already_exists
)
2729 Lisp_Object file
, newname
, ok_if_already_exists
;
2732 Lisp_Object args
[2];
2734 Lisp_Object handler
;
2735 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2736 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2738 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2739 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2740 CHECK_STRING (file
);
2741 CHECK_STRING (newname
);
2742 file
= Fexpand_file_name (file
, Qnil
);
2744 if (!NILP (Ffile_directory_p (newname
)))
2745 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2747 newname
= Fexpand_file_name (newname
, Qnil
);
2749 /* If the file name has special constructs in it,
2750 call the corresponding file handler. */
2751 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2753 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2754 if (!NILP (handler
))
2755 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2756 file
, newname
, ok_if_already_exists
));
2758 encoded_file
= ENCODE_FILE (file
);
2759 encoded_newname
= ENCODE_FILE (newname
);
2762 /* If the file names are identical but for the case, don't ask for
2763 confirmation: they simply want to change the letter-case of the
2765 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2767 if (NILP (ok_if_already_exists
)
2768 || INTEGERP (ok_if_already_exists
))
2769 barf_or_query_if_file_exists (encoded_newname
, "rename to it",
2770 INTEGERP (ok_if_already_exists
), 0, 0);
2772 if (0 > rename (SDATA (encoded_file
), SDATA (encoded_newname
)))
2774 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
))
2775 || 0 > unlink (SDATA (encoded_file
)))
2781 symlink_target
= Ffile_symlink_p (file
);
2782 if (! NILP (symlink_target
))
2783 Fmake_symbolic_link (symlink_target
, newname
,
2784 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2787 Fcopy_file (file
, newname
,
2788 /* We have already prompted if it was an integer,
2789 so don't have copy-file prompt again. */
2790 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2792 Fdelete_file (file
);
2799 report_file_error ("Renaming", Flist (2, args
));
2802 report_file_error ("Renaming", Flist (2, &file
));
2809 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2810 "fAdd name to file: \nGName to add to %s: \np",
2811 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2812 Signals a `file-already-exists' error if a file NEWNAME already exists
2813 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2814 A number as third arg means request confirmation if NEWNAME already exists.
2815 This is what happens in interactive use with M-x. */)
2816 (file
, newname
, ok_if_already_exists
)
2817 Lisp_Object file
, newname
, ok_if_already_exists
;
2820 Lisp_Object args
[2];
2822 Lisp_Object handler
;
2823 Lisp_Object encoded_file
, encoded_newname
;
2824 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2826 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2827 encoded_file
= encoded_newname
= Qnil
;
2828 CHECK_STRING (file
);
2829 CHECK_STRING (newname
);
2830 file
= Fexpand_file_name (file
, Qnil
);
2832 if (!NILP (Ffile_directory_p (newname
)))
2833 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2835 newname
= Fexpand_file_name (newname
, Qnil
);
2837 /* If the file name has special constructs in it,
2838 call the corresponding file handler. */
2839 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2840 if (!NILP (handler
))
2841 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2842 newname
, ok_if_already_exists
));
2844 /* If the new name has special constructs in it,
2845 call the corresponding file handler. */
2846 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2847 if (!NILP (handler
))
2848 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2849 newname
, ok_if_already_exists
));
2851 encoded_file
= ENCODE_FILE (file
);
2852 encoded_newname
= ENCODE_FILE (newname
);
2854 if (NILP (ok_if_already_exists
)
2855 || INTEGERP (ok_if_already_exists
))
2856 barf_or_query_if_file_exists (encoded_newname
, "make it a new name",
2857 INTEGERP (ok_if_already_exists
), 0, 0);
2859 unlink (SDATA (newname
));
2860 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
)))
2865 report_file_error ("Adding new name", Flist (2, args
));
2867 report_file_error ("Adding new name", Flist (2, &file
));
2876 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2877 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2878 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2879 Both args must be strings.
2880 Signals a `file-already-exists' error if a file LINKNAME already exists
2881 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2882 A number as third arg means request confirmation if LINKNAME already exists.
2883 This happens for interactive use with M-x. */)
2884 (filename
, linkname
, ok_if_already_exists
)
2885 Lisp_Object filename
, linkname
, ok_if_already_exists
;
2888 Lisp_Object args
[2];
2890 Lisp_Object handler
;
2891 Lisp_Object encoded_filename
, encoded_linkname
;
2892 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2894 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2895 encoded_filename
= encoded_linkname
= Qnil
;
2896 CHECK_STRING (filename
);
2897 CHECK_STRING (linkname
);
2898 /* If the link target has a ~, we must expand it to get
2899 a truly valid file name. Otherwise, do not expand;
2900 we want to permit links to relative file names. */
2901 if (SREF (filename
, 0) == '~')
2902 filename
= Fexpand_file_name (filename
, Qnil
);
2904 if (!NILP (Ffile_directory_p (linkname
)))
2905 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2907 linkname
= Fexpand_file_name (linkname
, Qnil
);
2909 /* If the file name has special constructs in it,
2910 call the corresponding file handler. */
2911 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2912 if (!NILP (handler
))
2913 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2914 linkname
, ok_if_already_exists
));
2916 /* If the new link name has special constructs in it,
2917 call the corresponding file handler. */
2918 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2919 if (!NILP (handler
))
2920 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2921 linkname
, ok_if_already_exists
));
2923 encoded_filename
= ENCODE_FILE (filename
);
2924 encoded_linkname
= ENCODE_FILE (linkname
);
2926 if (NILP (ok_if_already_exists
)
2927 || INTEGERP (ok_if_already_exists
))
2928 barf_or_query_if_file_exists (encoded_linkname
, "make it a link",
2929 INTEGERP (ok_if_already_exists
), 0, 0);
2930 if (0 > symlink (SDATA (encoded_filename
),
2931 SDATA (encoded_linkname
)))
2933 /* If we didn't complain already, silently delete existing file. */
2934 if (errno
== EEXIST
)
2936 unlink (SDATA (encoded_linkname
));
2937 if (0 <= symlink (SDATA (encoded_filename
),
2938 SDATA (encoded_linkname
)))
2948 report_file_error ("Making symbolic link", Flist (2, args
));
2950 report_file_error ("Making symbolic link", Flist (2, &filename
));
2956 #endif /* S_IFLNK */
2960 DEFUN ("define-logical-name", Fdefine_logical_name
, Sdefine_logical_name
,
2961 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2962 doc
: /* Define the job-wide logical name NAME to have the value STRING.
2963 If STRING is nil or a null string, the logical name NAME is deleted. */)
2968 CHECK_STRING (name
);
2970 delete_logical_name (SDATA (name
));
2973 CHECK_STRING (string
);
2975 if (SCHARS (string
) == 0)
2976 delete_logical_name (SDATA (name
));
2978 define_logical_name (SDATA (name
), SDATA (string
));
2987 DEFUN ("sysnetunam", Fsysnetunam
, Ssysnetunam
, 2, 2, 0,
2988 doc
: /* Open a network connection to PATH using LOGIN as the login string. */)
2990 Lisp_Object path
, login
;
2994 CHECK_STRING (path
);
2995 CHECK_STRING (login
);
2997 netresult
= netunam (SDATA (path
), SDATA (login
));
2999 if (netresult
== -1)
3004 #endif /* HPUX_NET */
3006 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
3008 doc
: /* Return t if file FILENAME specifies an absolute file name.
3009 On Unix, this is a name starting with a `/' or a `~'. */)
3011 Lisp_Object filename
;
3013 CHECK_STRING (filename
);
3014 return file_name_absolute_p (SDATA (filename
)) ? Qt
: Qnil
;
3017 /* Return nonzero if file FILENAME exists and can be executed. */
3020 check_executable (filename
)
3024 int len
= strlen (filename
);
3027 if (stat (filename
, &st
) < 0)
3029 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
3030 return ((st
.st_mode
& S_IEXEC
) != 0);
3032 return (S_ISREG (st
.st_mode
)
3034 && (stricmp ((suffix
= filename
+ len
-4), ".com") == 0
3035 || stricmp (suffix
, ".exe") == 0
3036 || stricmp (suffix
, ".bat") == 0)
3037 || (st
.st_mode
& S_IFMT
) == S_IFDIR
);
3038 #endif /* not WINDOWSNT */
3039 #else /* not DOS_NT */
3040 #ifdef HAVE_EUIDACCESS
3041 return (euidaccess (filename
, 1) >= 0);
3043 /* Access isn't quite right because it uses the real uid
3044 and we really want to test with the effective uid.
3045 But Unix doesn't give us a right way to do it. */
3046 return (access (filename
, 1) >= 0);
3048 #endif /* not DOS_NT */
3051 /* Return nonzero if file FILENAME exists and can be written. */
3054 check_writable (filename
)
3059 if (stat (filename
, &st
) < 0)
3061 return (st
.st_mode
& S_IWRITE
|| (st
.st_mode
& S_IFMT
) == S_IFDIR
);
3062 #else /* not MSDOS */
3063 #ifdef HAVE_EUIDACCESS
3064 return (euidaccess (filename
, 2) >= 0);
3066 /* Access isn't quite right because it uses the real uid
3067 and we really want to test with the effective uid.
3068 But Unix doesn't give us a right way to do it.
3069 Opening with O_WRONLY could work for an ordinary file,
3070 but would lose for directories. */
3071 return (access (filename
, 2) >= 0);
3073 #endif /* not MSDOS */
3076 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
3077 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
3078 See also `file-readable-p' and `file-attributes'.
3079 This returns nil for a symlink to a nonexistent file.
3080 Use `file-symlink-p' to test for such links. */)
3082 Lisp_Object filename
;
3084 Lisp_Object absname
;
3085 Lisp_Object handler
;
3086 struct stat statbuf
;
3088 CHECK_STRING (filename
);
3089 absname
= Fexpand_file_name (filename
, Qnil
);
3091 /* If the file name has special constructs in it,
3092 call the corresponding file handler. */
3093 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
3094 if (!NILP (handler
))
3095 return call2 (handler
, Qfile_exists_p
, absname
);
3097 absname
= ENCODE_FILE (absname
);
3099 return (stat (SDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
3102 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
3103 doc
: /* Return t if FILENAME can be executed by you.
3104 For a directory, this means you can access files in that directory. */)
3106 Lisp_Object filename
;
3108 Lisp_Object absname
;
3109 Lisp_Object handler
;
3111 CHECK_STRING (filename
);
3112 absname
= Fexpand_file_name (filename
, Qnil
);
3114 /* If the file name has special constructs in it,
3115 call the corresponding file handler. */
3116 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
3117 if (!NILP (handler
))
3118 return call2 (handler
, Qfile_executable_p
, absname
);
3120 absname
= ENCODE_FILE (absname
);
3122 return (check_executable (SDATA (absname
)) ? Qt
: Qnil
);
3125 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
3126 doc
: /* Return t if file FILENAME exists and you can read it.
3127 See also `file-exists-p' and `file-attributes'. */)
3129 Lisp_Object filename
;
3131 Lisp_Object absname
;
3132 Lisp_Object handler
;
3135 struct stat statbuf
;
3137 CHECK_STRING (filename
);
3138 absname
= Fexpand_file_name (filename
, Qnil
);
3140 /* If the file name has special constructs in it,
3141 call the corresponding file handler. */
3142 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
3143 if (!NILP (handler
))
3144 return call2 (handler
, Qfile_readable_p
, absname
);
3146 absname
= ENCODE_FILE (absname
);
3148 #if defined(DOS_NT) || defined(macintosh)
3149 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3151 if (access (SDATA (absname
), 0) == 0)
3154 #else /* not DOS_NT and not macintosh */
3156 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3157 /* Opening a fifo without O_NONBLOCK can wait.
3158 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3159 except in the case of a fifo, on a system which handles it. */
3160 desc
= stat (SDATA (absname
), &statbuf
);
3163 if (S_ISFIFO (statbuf
.st_mode
))
3164 flags
|= O_NONBLOCK
;
3166 desc
= emacs_open (SDATA (absname
), flags
, 0);
3171 #endif /* not DOS_NT and not macintosh */
3174 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3176 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
3177 doc
: /* Return t if file FILENAME can be written or created by you. */)
3179 Lisp_Object filename
;
3181 Lisp_Object absname
, dir
, encoded
;
3182 Lisp_Object handler
;
3183 struct stat statbuf
;
3185 CHECK_STRING (filename
);
3186 absname
= Fexpand_file_name (filename
, Qnil
);
3188 /* If the file name has special constructs in it,
3189 call the corresponding file handler. */
3190 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
3191 if (!NILP (handler
))
3192 return call2 (handler
, Qfile_writable_p
, absname
);
3194 encoded
= ENCODE_FILE (absname
);
3195 if (stat (SDATA (encoded
), &statbuf
) >= 0)
3196 return (check_writable (SDATA (encoded
))
3199 dir
= Ffile_name_directory (absname
);
3202 dir
= Fdirectory_file_name (dir
);
3206 dir
= Fdirectory_file_name (dir
);
3209 dir
= ENCODE_FILE (dir
);
3211 /* The read-only attribute of the parent directory doesn't affect
3212 whether a file or directory can be created within it. Some day we
3213 should check ACLs though, which do affect this. */
3214 if (stat (SDATA (dir
), &statbuf
) < 0)
3216 return (statbuf
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
3218 return (check_writable (!NILP (dir
) ? (char *) SDATA (dir
) : "")
3223 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
3224 doc
: /* Access file FILENAME, and get an error if that does not work.
3225 The second argument STRING is used in the error message.
3226 If there is no error, returns nil. */)
3228 Lisp_Object filename
, string
;
3230 Lisp_Object handler
, encoded_filename
, absname
;
3233 CHECK_STRING (filename
);
3234 absname
= Fexpand_file_name (filename
, Qnil
);
3236 CHECK_STRING (string
);
3238 /* If the file name has special constructs in it,
3239 call the corresponding file handler. */
3240 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
3241 if (!NILP (handler
))
3242 return call3 (handler
, Qaccess_file
, absname
, string
);
3244 encoded_filename
= ENCODE_FILE (absname
);
3246 fd
= emacs_open (SDATA (encoded_filename
), O_RDONLY
, 0);
3248 report_file_error (SDATA (string
), Fcons (filename
, Qnil
));
3254 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
3255 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
3256 The value is the link target, as a string.
3257 Otherwise it returns nil.
3259 This function returns t when given the name of a symlink that
3260 points to a nonexistent file. */)
3262 Lisp_Object filename
;
3264 Lisp_Object handler
;
3266 CHECK_STRING (filename
);
3267 filename
= Fexpand_file_name (filename
, Qnil
);
3269 /* If the file name has special constructs in it,
3270 call the corresponding file handler. */
3271 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
3272 if (!NILP (handler
))
3273 return call2 (handler
, Qfile_symlink_p
, filename
);
3282 filename
= ENCODE_FILE (filename
);
3289 buf
= (char *) xrealloc (buf
, bufsize
);
3290 bzero (buf
, bufsize
);
3293 valsize
= readlink (SDATA (filename
), buf
, bufsize
);
3297 /* HP-UX reports ERANGE if buffer is too small. */
3298 if (errno
== ERANGE
)
3308 while (valsize
>= bufsize
);
3310 val
= make_string (buf
, valsize
);
3311 if (buf
[0] == '/' && index (buf
, ':'))
3312 val
= concat2 (build_string ("/:"), val
);
3314 val
= DECODE_FILE (val
);
3317 #else /* not S_IFLNK */
3319 #endif /* not S_IFLNK */
3322 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
3323 doc
: /* Return t if FILENAME names an existing directory.
3324 Symbolic links to directories count as directories.
3325 See `file-symlink-p' to distinguish symlinks. */)
3327 Lisp_Object filename
;
3329 register Lisp_Object absname
;
3331 Lisp_Object handler
;
3333 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3335 /* If the file name has special constructs in it,
3336 call the corresponding file handler. */
3337 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
3338 if (!NILP (handler
))
3339 return call2 (handler
, Qfile_directory_p
, absname
);
3341 absname
= ENCODE_FILE (absname
);
3343 if (stat (SDATA (absname
), &st
) < 0)
3345 return (st
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
3348 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
3349 doc
: /* Return t if file FILENAME names a directory you can open.
3350 For the value to be t, FILENAME must specify the name of a directory as a file,
3351 and the directory must allow you to open files in it. In order to use a
3352 directory as a buffer's current directory, this predicate must return true.
3353 A directory name spec may be given instead; then the value is t
3354 if the directory so specified exists and really is a readable and
3355 searchable directory. */)
3357 Lisp_Object filename
;
3359 Lisp_Object handler
;
3361 struct gcpro gcpro1
;
3363 /* If the file name has special constructs in it,
3364 call the corresponding file handler. */
3365 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
3366 if (!NILP (handler
))
3367 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
3370 tem
= (NILP (Ffile_directory_p (filename
))
3371 || NILP (Ffile_executable_p (filename
)));
3373 return tem
? Qnil
: Qt
;
3376 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
3377 doc
: /* Return t if file FILENAME is the name of a regular file.
3378 This is the sort of file that holds an ordinary stream of data bytes. */)
3380 Lisp_Object filename
;
3382 register Lisp_Object absname
;
3384 Lisp_Object handler
;
3386 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3388 /* If the file name has special constructs in it,
3389 call the corresponding file handler. */
3390 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
3391 if (!NILP (handler
))
3392 return call2 (handler
, Qfile_regular_p
, absname
);
3394 absname
= ENCODE_FILE (absname
);
3399 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3401 /* Tell stat to use expensive method to get accurate info. */
3402 Vw32_get_true_file_attributes
= Qt
;
3403 result
= stat (SDATA (absname
), &st
);
3404 Vw32_get_true_file_attributes
= tem
;
3408 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
3411 if (stat (SDATA (absname
), &st
) < 0)
3413 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
3417 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3418 doc
: /* Return mode bits of file named FILENAME, as an integer.
3419 Return nil, if file does not exist or is not accessible. */)
3421 Lisp_Object filename
;
3423 Lisp_Object absname
;
3425 Lisp_Object handler
;
3427 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3429 /* If the file name has special constructs in it,
3430 call the corresponding file handler. */
3431 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3432 if (!NILP (handler
))
3433 return call2 (handler
, Qfile_modes
, absname
);
3435 absname
= ENCODE_FILE (absname
);
3437 if (stat (SDATA (absname
), &st
) < 0)
3439 #if defined (MSDOS) && __DJGPP__ < 2
3440 if (check_executable (SDATA (absname
)))
3441 st
.st_mode
|= S_IEXEC
;
3442 #endif /* MSDOS && __DJGPP__ < 2 */
3444 return make_number (st
.st_mode
& 07777);
3447 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2, 0,
3448 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3449 Only the 12 low bits of MODE are used. */)
3451 Lisp_Object filename
, mode
;
3453 Lisp_Object absname
, encoded_absname
;
3454 Lisp_Object handler
;
3456 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
3457 CHECK_NUMBER (mode
);
3459 /* If the file name has special constructs in it,
3460 call the corresponding file handler. */
3461 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3462 if (!NILP (handler
))
3463 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3465 encoded_absname
= ENCODE_FILE (absname
);
3467 if (chmod (SDATA (encoded_absname
), XINT (mode
)) < 0)
3468 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3473 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3474 doc
: /* Set the file permission bits for newly created files.
3475 The argument MODE should be an integer; only the low 9 bits are used.
3476 This setting is inherited by subprocesses. */)
3480 CHECK_NUMBER (mode
);
3482 umask ((~ XINT (mode
)) & 0777);
3487 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3488 doc
: /* Return the default file protection for created files.
3489 The value is an integer. */)
3495 realmask
= umask (0);
3498 XSETINT (value
, (~ realmask
) & 0777);
3502 extern int lisp_time_argument
P_ ((Lisp_Object
, time_t *, int *));
3504 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3505 doc
: /* Set times of file FILENAME to TIME.
3506 Set both access and modification times.
3507 Return t on success, else nil.
3508 Use the current time if TIME is nil. TIME is in the format of
3511 Lisp_Object filename
, time
;
3513 Lisp_Object absname
, encoded_absname
;
3514 Lisp_Object handler
;
3518 if (! lisp_time_argument (time
, &sec
, &usec
))
3519 error ("Invalid time specification");
3521 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
3523 /* If the file name has special constructs in it,
3524 call the corresponding file handler. */
3525 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3526 if (!NILP (handler
))
3527 return call3 (handler
, Qset_file_times
, absname
, time
);
3529 encoded_absname
= ENCODE_FILE (absname
);
3534 EMACS_SET_SECS (t
, sec
);
3535 EMACS_SET_USECS (t
, usec
);
3537 if (set_file_times (SDATA (encoded_absname
), t
, t
))
3542 /* Setting times on a directory always fails. */
3543 if (stat (SDATA (encoded_absname
), &st
) == 0
3544 && (st
.st_mode
& S_IFMT
) == S_IFDIR
)
3547 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3560 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3561 doc
: /* Tell Unix to finish all pending disk updates. */)
3570 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3571 doc
: /* Return t if file FILE1 is newer than file FILE2.
3572 If FILE1 does not exist, the answer is nil;
3573 otherwise, if FILE2 does not exist, the answer is t. */)
3575 Lisp_Object file1
, file2
;
3577 Lisp_Object absname1
, absname2
;
3580 Lisp_Object handler
;
3581 struct gcpro gcpro1
, gcpro2
;
3583 CHECK_STRING (file1
);
3584 CHECK_STRING (file2
);
3587 GCPRO2 (absname1
, file2
);
3588 absname1
= expand_and_dir_to_file (file1
, current_buffer
->directory
);
3589 absname2
= expand_and_dir_to_file (file2
, current_buffer
->directory
);
3592 /* If the file name has special constructs in it,
3593 call the corresponding file handler. */
3594 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3596 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3597 if (!NILP (handler
))
3598 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3600 GCPRO2 (absname1
, absname2
);
3601 absname1
= ENCODE_FILE (absname1
);
3602 absname2
= ENCODE_FILE (absname2
);
3605 if (stat (SDATA (absname1
), &st
) < 0)
3608 mtime1
= st
.st_mtime
;
3610 if (stat (SDATA (absname2
), &st
) < 0)
3613 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3617 Lisp_Object Qfind_buffer_file_type
;
3620 #ifndef READ_BUF_SIZE
3621 #define READ_BUF_SIZE (64 << 10)
3624 extern void adjust_markers_for_delete
P_ ((int, int, int, int));
3626 /* This function is called after Lisp functions to decide a coding
3627 system are called, or when they cause an error. Before they are
3628 called, the current buffer is set unibyte and it contains only a
3629 newly inserted text (thus the buffer was empty before the
3632 The functions may set markers, overlays, text properties, or even
3633 alter the buffer contents, change the current buffer.
3635 Here, we reset all those changes by:
3636 o set back the current buffer.
3637 o move all markers and overlays to BEG.
3638 o remove all text properties.
3639 o set back the buffer multibyteness. */
3642 decide_coding_unwind (unwind_data
)
3643 Lisp_Object unwind_data
;
3645 Lisp_Object multibyte
, undo_list
, buffer
;
3647 multibyte
= XCAR (unwind_data
);
3648 unwind_data
= XCDR (unwind_data
);
3649 undo_list
= XCAR (unwind_data
);
3650 buffer
= XCDR (unwind_data
);
3652 if (current_buffer
!= XBUFFER (buffer
))
3653 set_buffer_internal (XBUFFER (buffer
));
3654 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3655 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3656 BUF_INTERVALS (current_buffer
) = 0;
3657 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3659 /* Now we are safe to change the buffer's multibyteness directly. */
3660 current_buffer
->enable_multibyte_characters
= multibyte
;
3661 current_buffer
->undo_list
= undo_list
;
3667 /* Used to pass values from insert-file-contents to read_non_regular. */
3669 static int non_regular_fd
;
3670 static int non_regular_inserted
;
3671 static int non_regular_nbytes
;
3674 /* Read from a non-regular file.
3675 Read non_regular_trytry bytes max from non_regular_fd.
3676 Non_regular_inserted specifies where to put the read bytes.
3677 Value is the number of bytes read. */
3686 nbytes
= emacs_read (non_regular_fd
,
3687 BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ non_regular_inserted
,
3688 non_regular_nbytes
);
3690 return make_number (nbytes
);
3694 /* Condition-case handler used when reading from non-regular files
3695 in insert-file-contents. */
3698 read_non_regular_quit ()
3704 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3706 doc
: /* Insert contents of file FILENAME after point.
3707 Returns list of absolute file name and number of characters inserted.
3708 If second argument VISIT is non-nil, the buffer's visited filename
3709 and last save file modtime are set, and it is marked unmodified.
3710 If visiting and the file does not exist, visiting is completed
3711 before the error is signaled.
3712 The optional third and fourth arguments BEG and END
3713 specify what portion of the file to insert.
3714 These arguments count bytes in the file, not characters in the buffer.
3715 If VISIT is non-nil, BEG and END must be nil.
3717 If optional fifth argument REPLACE is non-nil,
3718 it means replace the current buffer contents (in the accessible portion)
3719 with the file contents. This is better than simply deleting and inserting
3720 the whole thing because (1) it preserves some marker positions
3721 and (2) it puts less data in the undo list.
3722 When REPLACE is non-nil, the value is the number of characters actually read,
3723 which is often less than the number of characters to be read.
3725 This does code conversion according to the value of
3726 `coding-system-for-read' or `file-coding-system-alist',
3727 and sets the variable `last-coding-system-used' to the coding system
3729 (filename
, visit
, beg
, end
, replace
)
3730 Lisp_Object filename
, visit
, beg
, end
, replace
;
3735 register int how_much
;
3736 register int unprocessed
;
3737 int count
= SPECPDL_INDEX ();
3738 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3739 Lisp_Object handler
, val
, insval
, orig_filename
;
3742 int not_regular
= 0;
3743 unsigned char read_buf
[READ_BUF_SIZE
];
3744 struct coding_system coding
;
3745 unsigned char buffer
[1 << 14];
3746 int replace_handled
= 0;
3747 int set_coding_system
= 0;
3748 int coding_system_decided
= 0;
3750 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3751 int we_locked_file
= 0;
3753 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3754 error ("Cannot do file visiting in an indirect buffer");
3756 if (!NILP (current_buffer
->read_only
))
3757 Fbarf_if_buffer_read_only ();
3761 orig_filename
= Qnil
;
3763 GCPRO4 (filename
, val
, p
, orig_filename
);
3765 CHECK_STRING (filename
);
3766 filename
= Fexpand_file_name (filename
, Qnil
);
3768 /* If the file name has special constructs in it,
3769 call the corresponding file handler. */
3770 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3771 if (!NILP (handler
))
3773 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3774 visit
, beg
, end
, replace
);
3775 if (CONSP (val
) && CONSP (XCDR (val
)))
3776 inserted
= XINT (XCAR (XCDR (val
)));
3780 orig_filename
= filename
;
3781 filename
= ENCODE_FILE (filename
);
3787 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3789 /* Tell stat to use expensive method to get accurate info. */
3790 Vw32_get_true_file_attributes
= Qt
;
3791 total
= stat (SDATA (filename
), &st
);
3792 Vw32_get_true_file_attributes
= tem
;
3797 if (stat (SDATA (filename
), &st
) < 0)
3799 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0
3800 || fstat (fd
, &st
) < 0)
3801 #endif /* not APOLLO */
3802 #endif /* WINDOWSNT */
3804 if (fd
>= 0) emacs_close (fd
);
3807 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3810 if (!NILP (Vcoding_system_for_read
))
3811 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3816 /* This code will need to be changed in order to work on named
3817 pipes, and it's probably just not worth it. So we should at
3818 least signal an error. */
3819 if (!S_ISREG (st
.st_mode
))
3826 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3827 Fsignal (Qfile_error
,
3828 Fcons (build_string ("not a regular file"),
3829 Fcons (orig_filename
, Qnil
)));
3834 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0)
3837 /* Replacement should preserve point as it preserves markers. */
3838 if (!NILP (replace
))
3839 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3841 record_unwind_protect (close_file_unwind
, make_number (fd
));
3843 /* Supposedly happens on VMS. */
3844 /* Can happen on any platform that uses long as type of off_t, but allows
3845 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3846 give a message suitable for the latter case. */
3847 if (! not_regular
&& st
.st_size
< 0)
3848 error ("Maximum buffer size exceeded");
3850 /* Prevent redisplay optimizations. */
3851 current_buffer
->clip_changed
= 1;
3855 if (!NILP (beg
) || !NILP (end
))
3856 error ("Attempt to visit less than an entire file");
3857 if (BEG
< Z
&& NILP (replace
))
3858 error ("Cannot do file visiting in a non-empty buffer");
3864 XSETFASTINT (beg
, 0);
3872 XSETINT (end
, st
.st_size
);
3874 /* Arithmetic overflow can occur if an Emacs integer cannot
3875 represent the file size, or if the calculations below
3876 overflow. The calculations below double the file size
3877 twice, so check that it can be multiplied by 4 safely. */
3878 if (XINT (end
) != st
.st_size
3879 || ((int) st
.st_size
* 4) / 4 != st
.st_size
)
3880 error ("Maximum buffer size exceeded");
3882 /* The file size returned from stat may be zero, but data
3883 may be readable nonetheless, for example when this is a
3884 file in the /proc filesystem. */
3885 if (st
.st_size
== 0)
3886 XSETINT (end
, READ_BUF_SIZE
);
3890 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3892 /* We use emacs-mule for auto saving... */
3893 setup_coding_system (Qemacs_mule
, &coding
);
3894 /* ... but with the special flag to indicate to read in a
3895 multibyte sequence for eight-bit-control char as is. */
3897 coding
.src_multibyte
= 0;
3898 coding
.dst_multibyte
3899 = !NILP (current_buffer
->enable_multibyte_characters
);
3900 coding
.eol_type
= CODING_EOL_LF
;
3901 coding_system_decided
= 1;
3905 /* Decide the coding system to use for reading the file now
3906 because we can't use an optimized method for handling
3907 `coding:' tag if the current buffer is not empty. */
3911 if (!NILP (Vcoding_system_for_read
))
3912 val
= Vcoding_system_for_read
;
3915 /* Don't try looking inside a file for a coding system
3916 specification if it is not seekable. */
3917 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3919 /* Find a coding system specified in the heading two
3920 lines or in the tailing several lines of the file.
3921 We assume that the 1K-byte and 3K-byte for heading
3922 and tailing respectively are sufficient for this
3926 if (st
.st_size
<= (1024 * 4))
3927 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3930 nread
= emacs_read (fd
, read_buf
, 1024);
3933 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3934 report_file_error ("Setting file position",
3935 Fcons (orig_filename
, Qnil
));
3936 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3941 error ("IO error reading %s: %s",
3942 SDATA (orig_filename
), emacs_strerror (errno
));
3945 struct buffer
*prev
= current_buffer
;
3949 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3951 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3952 buf
= XBUFFER (buffer
);
3954 delete_all_overlays (buf
);
3955 buf
->directory
= current_buffer
->directory
;
3956 buf
->read_only
= Qnil
;
3957 buf
->filename
= Qnil
;
3958 buf
->undo_list
= Qt
;
3959 eassert (buf
->overlays_before
== NULL
);
3960 eassert (buf
->overlays_after
== NULL
);
3962 set_buffer_internal (buf
);
3964 buf
->enable_multibyte_characters
= Qnil
;
3966 insert_1_both (read_buf
, nread
, nread
, 0, 0, 0);
3967 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3968 val
= call2 (Vset_auto_coding_function
,
3969 filename
, make_number (nread
));
3970 set_buffer_internal (prev
);
3972 /* Discard the unwind protect for recovering the
3976 /* Rewind the file for the actual read done later. */
3977 if (lseek (fd
, 0, 0) < 0)
3978 report_file_error ("Setting file position",
3979 Fcons (orig_filename
, Qnil
));
3985 /* If we have not yet decided a coding system, check
3986 file-coding-system-alist. */
3987 Lisp_Object args
[6], coding_systems
;
3989 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3990 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3991 coding_systems
= Ffind_operation_coding_system (6, args
);
3992 if (CONSP (coding_systems
))
3993 val
= XCAR (coding_systems
);
3997 setup_coding_system (Fcheck_coding_system (val
), &coding
);
3998 /* Ensure we set Vlast_coding_system_used. */
3999 set_coding_system
= 1;
4001 if (NILP (current_buffer
->enable_multibyte_characters
)
4003 /* We must suppress all character code conversion except for
4004 end-of-line conversion. */
4005 setup_raw_text_coding_system (&coding
);
4007 coding
.src_multibyte
= 0;
4008 coding
.dst_multibyte
4009 = !NILP (current_buffer
->enable_multibyte_characters
);
4010 coding_system_decided
= 1;
4013 /* If requested, replace the accessible part of the buffer
4014 with the file contents. Avoid replacing text at the
4015 beginning or end of the buffer that matches the file contents;
4016 that preserves markers pointing to the unchanged parts.
4018 Here we implement this feature in an optimized way
4019 for the case where code conversion is NOT needed.
4020 The following if-statement handles the case of conversion
4021 in a less optimal way.
4023 If the code conversion is "automatic" then we try using this
4024 method and hope for the best.
4025 But if we discover the need for conversion, we give up on this method
4026 and let the following if-statement handle the replace job. */
4029 && !(coding
.common_flags
& CODING_REQUIRE_DECODING_MASK
))
4031 /* same_at_start and same_at_end count bytes,
4032 because file access counts bytes
4033 and BEG and END count bytes. */
4034 int same_at_start
= BEGV_BYTE
;
4035 int same_at_end
= ZV_BYTE
;
4037 /* There is still a possibility we will find the need to do code
4038 conversion. If that happens, we set this variable to 1 to
4039 give up on handling REPLACE in the optimized way. */
4040 int giveup_match_end
= 0;
4042 if (XINT (beg
) != 0)
4044 if (lseek (fd
, XINT (beg
), 0) < 0)
4045 report_file_error ("Setting file position",
4046 Fcons (orig_filename
, Qnil
));
4051 /* Count how many chars at the start of the file
4052 match the text at the beginning of the buffer. */
4057 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
4059 error ("IO error reading %s: %s",
4060 SDATA (orig_filename
), emacs_strerror (errno
));
4061 else if (nread
== 0)
4064 if (coding
.type
== coding_type_undecided
)
4065 detect_coding (&coding
, buffer
, nread
);
4066 if (coding
.common_flags
& CODING_REQUIRE_DECODING_MASK
)
4067 /* We found that the file should be decoded somehow.
4068 Let's give up here. */
4070 giveup_match_end
= 1;
4074 if (coding
.eol_type
== CODING_EOL_UNDECIDED
)
4075 detect_eol (&coding
, buffer
, nread
);
4076 if (coding
.eol_type
!= CODING_EOL_UNDECIDED
4077 && coding
.eol_type
!= CODING_EOL_LF
)
4078 /* We found that the format of eol should be decoded.
4079 Let's give up here. */
4081 giveup_match_end
= 1;
4086 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
4087 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
4088 same_at_start
++, bufpos
++;
4089 /* If we found a discrepancy, stop the scan.
4090 Otherwise loop around and scan the next bufferful. */
4091 if (bufpos
!= nread
)
4095 /* If the file matches the buffer completely,
4096 there's no need to replace anything. */
4097 if (same_at_start
- BEGV_BYTE
== XINT (end
))
4101 /* Truncate the buffer to the size of the file. */
4102 del_range_1 (same_at_start
, same_at_end
, 0, 0);
4107 /* Count how many chars at the end of the file
4108 match the text at the end of the buffer. But, if we have
4109 already found that decoding is necessary, don't waste time. */
4110 while (!giveup_match_end
)
4112 int total_read
, nread
, bufpos
, curpos
, trial
;
4114 /* At what file position are we now scanning? */
4115 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
4116 /* If the entire file matches the buffer tail, stop the scan. */
4119 /* How much can we scan in the next step? */
4120 trial
= min (curpos
, sizeof buffer
);
4121 if (lseek (fd
, curpos
- trial
, 0) < 0)
4122 report_file_error ("Setting file position",
4123 Fcons (orig_filename
, Qnil
));
4125 total_read
= nread
= 0;
4126 while (total_read
< trial
)
4128 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
4130 error ("IO error reading %s: %s",
4131 SDATA (orig_filename
), emacs_strerror (errno
));
4132 else if (nread
== 0)
4134 total_read
+= nread
;
4137 /* Scan this bufferful from the end, comparing with
4138 the Emacs buffer. */
4139 bufpos
= total_read
;
4141 /* Compare with same_at_start to avoid counting some buffer text
4142 as matching both at the file's beginning and at the end. */
4143 while (bufpos
> 0 && same_at_end
> same_at_start
4144 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
4145 same_at_end
--, bufpos
--;
4147 /* If we found a discrepancy, stop the scan.
4148 Otherwise loop around and scan the preceding bufferful. */
4151 /* If this discrepancy is because of code conversion,
4152 we cannot use this method; giveup and try the other. */
4153 if (same_at_end
> same_at_start
4154 && FETCH_BYTE (same_at_end
- 1) >= 0200
4155 && ! NILP (current_buffer
->enable_multibyte_characters
)
4156 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
4157 giveup_match_end
= 1;
4166 if (! giveup_match_end
)
4170 /* We win! We can handle REPLACE the optimized way. */
4172 /* Extend the start of non-matching text area to multibyte
4173 character boundary. */
4174 if (! NILP (current_buffer
->enable_multibyte_characters
))
4175 while (same_at_start
> BEGV_BYTE
4176 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4179 /* Extend the end of non-matching text area to multibyte
4180 character boundary. */
4181 if (! NILP (current_buffer
->enable_multibyte_characters
))
4182 while (same_at_end
< ZV_BYTE
4183 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4186 /* Don't try to reuse the same piece of text twice. */
4187 overlap
= (same_at_start
- BEGV_BYTE
4188 - (same_at_end
+ st
.st_size
- ZV
));
4190 same_at_end
+= overlap
;
4192 /* Arrange to read only the nonmatching middle part of the file. */
4193 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
4194 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
4196 del_range_byte (same_at_start
, same_at_end
, 0);
4197 /* Insert from the file at the proper position. */
4198 temp
= BYTE_TO_CHAR (same_at_start
);
4199 SET_PT_BOTH (temp
, same_at_start
);
4201 /* If display currently starts at beginning of line,
4202 keep it that way. */
4203 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
4204 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
4206 replace_handled
= 1;
4210 /* If requested, replace the accessible part of the buffer
4211 with the file contents. Avoid replacing text at the
4212 beginning or end of the buffer that matches the file contents;
4213 that preserves markers pointing to the unchanged parts.
4215 Here we implement this feature for the case where code conversion
4216 is needed, in a simple way that needs a lot of memory.
4217 The preceding if-statement handles the case of no conversion
4218 in a more optimized way. */
4219 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
4221 int same_at_start
= BEGV_BYTE
;
4222 int same_at_end
= ZV_BYTE
;
4225 /* Make sure that the gap is large enough. */
4226 int bufsize
= 2 * st
.st_size
;
4227 unsigned char *conversion_buffer
= (unsigned char *) xmalloc (bufsize
);
4230 /* First read the whole file, performing code conversion into
4231 CONVERSION_BUFFER. */
4233 if (lseek (fd
, XINT (beg
), 0) < 0)
4235 xfree (conversion_buffer
);
4236 report_file_error ("Setting file position",
4237 Fcons (orig_filename
, Qnil
));
4240 total
= st
.st_size
; /* Total bytes in the file. */
4241 how_much
= 0; /* Bytes read from file so far. */
4242 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
4243 unprocessed
= 0; /* Bytes not processed in previous loop. */
4245 while (how_much
< total
)
4247 /* try is reserved in some compilers (Microsoft C) */
4248 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
4249 unsigned char *destination
= read_buf
+ unprocessed
;
4252 /* Allow quitting out of the actual I/O. */
4255 this = emacs_read (fd
, destination
, trytry
);
4258 if (this < 0 || this + unprocessed
== 0)
4266 if (CODING_MAY_REQUIRE_DECODING (&coding
))
4268 int require
, result
;
4270 this += unprocessed
;
4272 /* If we are using more space than estimated,
4273 make CONVERSION_BUFFER bigger. */
4274 require
= decoding_buffer_size (&coding
, this);
4275 if (inserted
+ require
+ 2 * (total
- how_much
) > bufsize
)
4277 bufsize
= inserted
+ require
+ 2 * (total
- how_much
);
4278 conversion_buffer
= (unsigned char *) xrealloc (conversion_buffer
, bufsize
);
4281 /* Convert this batch with results in CONVERSION_BUFFER. */
4282 if (how_much
>= total
) /* This is the last block. */
4283 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4284 if (coding
.composing
!= COMPOSITION_DISABLED
)
4285 coding_allocate_composition_data (&coding
, BEGV
);
4286 result
= decode_coding (&coding
, read_buf
,
4287 conversion_buffer
+ inserted
,
4288 this, bufsize
- inserted
);
4290 /* Save for next iteration whatever we didn't convert. */
4291 unprocessed
= this - coding
.consumed
;
4292 bcopy (read_buf
+ coding
.consumed
, read_buf
, unprocessed
);
4293 if (!NILP (current_buffer
->enable_multibyte_characters
))
4294 this = coding
.produced
;
4296 this = str_as_unibyte (conversion_buffer
+ inserted
,
4303 /* At this point, INSERTED is how many characters (i.e. bytes)
4304 are present in CONVERSION_BUFFER.
4305 HOW_MUCH should equal TOTAL,
4306 or should be <= 0 if we couldn't read the file. */
4310 xfree (conversion_buffer
);
4311 coding_free_composition_data (&coding
);
4313 error ("IO error reading %s: %s",
4314 SDATA (orig_filename
), emacs_strerror (errno
));
4315 else if (how_much
== -2)
4316 error ("maximum buffer size exceeded");
4319 /* Compare the beginning of the converted file
4320 with the buffer text. */
4323 while (bufpos
< inserted
&& same_at_start
< same_at_end
4324 && FETCH_BYTE (same_at_start
) == conversion_buffer
[bufpos
])
4325 same_at_start
++, bufpos
++;
4327 /* If the file matches the buffer completely,
4328 there's no need to replace anything. */
4330 if (bufpos
== inserted
)
4332 xfree (conversion_buffer
);
4333 coding_free_composition_data (&coding
);
4336 /* Truncate the buffer to the size of the file. */
4337 del_range_byte (same_at_start
, same_at_end
, 0);
4342 /* Extend the start of non-matching text area to multibyte
4343 character boundary. */
4344 if (! NILP (current_buffer
->enable_multibyte_characters
))
4345 while (same_at_start
> BEGV_BYTE
4346 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4349 /* Scan this bufferful from the end, comparing with
4350 the Emacs buffer. */
4353 /* Compare with same_at_start to avoid counting some buffer text
4354 as matching both at the file's beginning and at the end. */
4355 while (bufpos
> 0 && same_at_end
> same_at_start
4356 && FETCH_BYTE (same_at_end
- 1) == conversion_buffer
[bufpos
- 1])
4357 same_at_end
--, bufpos
--;
4359 /* Extend the end of non-matching text area to multibyte
4360 character boundary. */
4361 if (! NILP (current_buffer
->enable_multibyte_characters
))
4362 while (same_at_end
< ZV_BYTE
4363 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4366 /* Don't try to reuse the same piece of text twice. */
4367 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4369 same_at_end
+= overlap
;
4371 /* If display currently starts at beginning of line,
4372 keep it that way. */
4373 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
4374 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
4376 /* Replace the chars that we need to replace,
4377 and update INSERTED to equal the number of bytes
4378 we are taking from the file. */
4379 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4381 if (same_at_end
!= same_at_start
)
4383 del_range_byte (same_at_start
, same_at_end
, 0);
4385 same_at_start
= GPT_BYTE
;
4389 temp
= BYTE_TO_CHAR (same_at_start
);
4391 /* Insert from the file at the proper position. */
4392 SET_PT_BOTH (temp
, same_at_start
);
4393 insert_1 (conversion_buffer
+ same_at_start
- BEGV_BYTE
, inserted
,
4395 if (coding
.cmp_data
&& coding
.cmp_data
->used
)
4396 coding_restore_composition (&coding
, Fcurrent_buffer ());
4397 coding_free_composition_data (&coding
);
4399 /* Set `inserted' to the number of inserted characters. */
4400 inserted
= PT
- temp
;
4402 xfree (conversion_buffer
);
4411 register Lisp_Object temp
;
4413 total
= XINT (end
) - XINT (beg
);
4415 /* Make sure point-max won't overflow after this insertion. */
4416 XSETINT (temp
, total
);
4417 if (total
!= XINT (temp
))
4418 error ("Maximum buffer size exceeded");
4421 /* For a special file, all we can do is guess. */
4422 total
= READ_BUF_SIZE
;
4424 if (NILP (visit
) && inserted
> 0)
4426 #ifdef CLASH_DETECTION
4427 if (!NILP (current_buffer
->file_truename
)
4428 /* Make binding buffer-file-name to nil effective. */
4429 && !NILP (current_buffer
->filename
)
4430 && SAVE_MODIFF
>= MODIFF
)
4432 #endif /* CLASH_DETECTION */
4433 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4437 if (GAP_SIZE
< total
)
4438 make_gap (total
- GAP_SIZE
);
4440 if (XINT (beg
) != 0 || !NILP (replace
))
4442 if (lseek (fd
, XINT (beg
), 0) < 0)
4443 report_file_error ("Setting file position",
4444 Fcons (orig_filename
, Qnil
));
4447 /* In the following loop, HOW_MUCH contains the total bytes read so
4448 far for a regular file, and not changed for a special file. But,
4449 before exiting the loop, it is set to a negative value if I/O
4453 /* Total bytes inserted. */
4456 /* Here, we don't do code conversion in the loop. It is done by
4457 code_convert_region after all data are read into the buffer. */
4459 int gap_size
= GAP_SIZE
;
4461 while (how_much
< total
)
4463 /* try is reserved in some compilers (Microsoft C) */
4464 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4471 /* Maybe make more room. */
4472 if (gap_size
< trytry
)
4474 make_gap (total
- gap_size
);
4475 gap_size
= GAP_SIZE
;
4478 /* Read from the file, capturing `quit'. When an
4479 error occurs, end the loop, and arrange for a quit
4480 to be signaled after decoding the text we read. */
4481 non_regular_fd
= fd
;
4482 non_regular_inserted
= inserted
;
4483 non_regular_nbytes
= trytry
;
4484 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
4485 read_non_regular_quit
);
4496 /* Allow quitting out of the actual I/O. We don't make text
4497 part of the buffer until all the reading is done, so a C-g
4498 here doesn't do any harm. */
4501 this = emacs_read (fd
, BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ inserted
, trytry
);
4513 /* For a regular file, where TOTAL is the real size,
4514 count HOW_MUCH to compare with it.
4515 For a special file, where TOTAL is just a buffer size,
4516 so don't bother counting in HOW_MUCH.
4517 (INSERTED is where we count the number of characters inserted.) */
4524 /* Now we have read all the file data into the gap.
4525 If it was empty, undo marking the buffer modified. */
4529 #ifdef CLASH_DETECTION
4531 unlock_file (current_buffer
->file_truename
);
4533 Vdeactivate_mark
= old_Vdeactivate_mark
;
4536 /* Make the text read part of the buffer. */
4537 GAP_SIZE
-= inserted
;
4539 GPT_BYTE
+= inserted
;
4541 ZV_BYTE
+= inserted
;
4546 /* Put an anchor to ensure multi-byte form ends at gap. */
4551 /* Discard the unwind protect for closing the file. */
4555 error ("IO error reading %s: %s",
4556 SDATA (orig_filename
), emacs_strerror (errno
));
4560 if (! coding_system_decided
)
4562 /* The coding system is not yet decided. Decide it by an
4563 optimized method for handling `coding:' tag.
4565 Note that we can get here only if the buffer was empty
4566 before the insertion. */
4570 if (!NILP (Vcoding_system_for_read
))
4571 val
= Vcoding_system_for_read
;
4574 /* Since we are sure that the current buffer was empty
4575 before the insertion, we can toggle
4576 enable-multibyte-characters directly here without taking
4577 care of marker adjustment and byte combining problem. By
4578 this way, we can run Lisp program safely before decoding
4579 the inserted text. */
4580 Lisp_Object unwind_data
;
4581 int count
= SPECPDL_INDEX ();
4583 unwind_data
= Fcons (current_buffer
->enable_multibyte_characters
,
4584 Fcons (current_buffer
->undo_list
,
4585 Fcurrent_buffer ()));
4586 current_buffer
->enable_multibyte_characters
= Qnil
;
4587 current_buffer
->undo_list
= Qt
;
4588 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4590 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4592 val
= call2 (Vset_auto_coding_function
,
4593 filename
, make_number (inserted
));
4598 /* If the coding system is not yet decided, check
4599 file-coding-system-alist. */
4600 Lisp_Object args
[6], coding_systems
;
4602 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4603 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4604 coding_systems
= Ffind_operation_coding_system (6, args
);
4605 if (CONSP (coding_systems
))
4606 val
= XCAR (coding_systems
);
4608 unbind_to (count
, Qnil
);
4609 inserted
= Z_BYTE
- BEG_BYTE
;
4612 /* The following kludgy code is to avoid some compiler bug.
4614 setup_coding_system (val, &coding);
4617 struct coding_system temp_coding
;
4618 setup_coding_system (Fcheck_coding_system (val
), &temp_coding
);
4619 bcopy (&temp_coding
, &coding
, sizeof coding
);
4621 /* Ensure we set Vlast_coding_system_used. */
4622 set_coding_system
= 1;
4624 if (NILP (current_buffer
->enable_multibyte_characters
)
4626 /* We must suppress all character code conversion except for
4627 end-of-line conversion. */
4628 setup_raw_text_coding_system (&coding
);
4629 coding
.src_multibyte
= 0;
4630 coding
.dst_multibyte
4631 = !NILP (current_buffer
->enable_multibyte_characters
);
4635 /* Can't do this if part of the buffer might be preserved. */
4637 && (coding
.type
== coding_type_no_conversion
4638 || coding
.type
== coding_type_raw_text
))
4640 /* Visiting a file with these coding system makes the buffer
4642 current_buffer
->enable_multibyte_characters
= Qnil
;
4643 coding
.dst_multibyte
= 0;
4646 if (inserted
> 0 || coding
.type
== coding_type_ccl
)
4648 if (CODING_MAY_REQUIRE_DECODING (&coding
))
4650 code_convert_region (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4652 inserted
= coding
.produced_char
;
4655 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4659 /* Now INSERTED is measured in characters. */
4662 /* Use the conversion type to determine buffer-file-type
4663 (find-buffer-file-type is now used to help determine the
4665 if ((coding
.eol_type
== CODING_EOL_UNDECIDED
4666 || coding
.eol_type
== CODING_EOL_LF
)
4667 && ! CODING_REQUIRE_DECODING (&coding
))
4668 current_buffer
->buffer_file_type
= Qt
;
4670 current_buffer
->buffer_file_type
= Qnil
;
4677 if (!EQ (current_buffer
->undo_list
, Qt
))
4678 current_buffer
->undo_list
= Qnil
;
4680 stat (SDATA (filename
), &st
);
4685 current_buffer
->modtime
= st
.st_mtime
;
4686 current_buffer
->filename
= orig_filename
;
4689 SAVE_MODIFF
= MODIFF
;
4690 current_buffer
->auto_save_modified
= MODIFF
;
4691 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4692 #ifdef CLASH_DETECTION
4695 if (!NILP (current_buffer
->file_truename
))
4696 unlock_file (current_buffer
->file_truename
);
4697 unlock_file (filename
);
4699 #endif /* CLASH_DETECTION */
4701 Fsignal (Qfile_error
,
4702 Fcons (build_string ("not a regular file"),
4703 Fcons (orig_filename
, Qnil
)));
4706 if (set_coding_system
)
4707 Vlast_coding_system_used
= coding
.symbol
;
4709 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4711 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4713 if (! NILP (insval
))
4715 CHECK_NUMBER (insval
);
4716 inserted
= XFASTINT (insval
);
4720 /* Decode file format */
4723 int empty_undo_list_p
= 0;
4725 /* If we're anyway going to discard undo information, don't
4726 record it in the first place. The buffer's undo list at this
4727 point is either nil or t when visiting a file. */
4730 empty_undo_list_p
= NILP (current_buffer
->undo_list
);
4731 current_buffer
->undo_list
= Qt
;
4734 insval
= call3 (Qformat_decode
,
4735 Qnil
, make_number (inserted
), visit
);
4736 CHECK_NUMBER (insval
);
4737 inserted
= XFASTINT (insval
);
4740 current_buffer
->undo_list
= empty_undo_list_p
? Qnil
: Qt
;
4743 /* Call after-change hooks for the inserted text, aside from the case
4744 of normal visiting (not with REPLACE), which is done in a new buffer
4745 "before" the buffer is changed. */
4746 if (inserted
> 0 && total
> 0
4747 && (NILP (visit
) || !NILP (replace
)))
4749 signal_after_change (PT
, 0, inserted
);
4750 update_compositions (PT
, PT
, CHECK_BORDER
);
4753 p
= Vafter_insert_file_functions
;
4756 insval
= call1 (XCAR (p
), make_number (inserted
));
4759 CHECK_NUMBER (insval
);
4760 inserted
= XFASTINT (insval
);
4767 && current_buffer
->modtime
== -1)
4769 /* If visiting nonexistent file, return nil. */
4770 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4774 Fsignal (Qquit
, Qnil
);
4776 /* ??? Retval needs to be dealt with in all cases consistently. */
4778 val
= Fcons (orig_filename
,
4779 Fcons (make_number (inserted
),
4782 RETURN_UNGCPRO (unbind_to (count
, val
));
4785 static Lisp_Object build_annotations
P_ ((Lisp_Object
, Lisp_Object
));
4786 static Lisp_Object build_annotations_2
P_ ((Lisp_Object
, Lisp_Object
,
4787 Lisp_Object
, Lisp_Object
));
4789 /* If build_annotations switched buffers, switch back to BUF.
4790 Kill the temporary buffer that was selected in the meantime.
4792 Since this kill only the last temporary buffer, some buffers remain
4793 not killed if build_annotations switched buffers more than once.
4797 build_annotations_unwind (buf
)
4802 if (XBUFFER (buf
) == current_buffer
)
4804 tembuf
= Fcurrent_buffer ();
4806 Fkill_buffer (tembuf
);
4810 /* Decide the coding-system to encode the data with. */
4813 choose_write_coding_system (start
, end
, filename
,
4814 append
, visit
, lockname
, coding
)
4815 Lisp_Object start
, end
, filename
, append
, visit
, lockname
;
4816 struct coding_system
*coding
;
4821 && NILP (Fstring_equal (current_buffer
->filename
,
4822 current_buffer
->auto_save_file_name
)))
4824 /* We use emacs-mule for auto saving... */
4825 setup_coding_system (Qemacs_mule
, coding
);
4826 /* ... but with the special flag to indicate not to strip off
4827 leading code of eight-bit-control chars. */
4829 goto done_setup_coding
;
4831 else if (!NILP (Vcoding_system_for_write
))
4833 val
= Vcoding_system_for_write
;
4834 if (coding_system_require_warning
4835 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4836 /* Confirm that VAL can surely encode the current region. */
4837 val
= call5 (Vselect_safe_coding_system_function
,
4838 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4843 /* If the variable `buffer-file-coding-system' is set locally,
4844 it means that the file was read with some kind of code
4845 conversion or the variable is explicitly set by users. We
4846 had better write it out with the same coding system even if
4847 `enable-multibyte-characters' is nil.
4849 If it is not set locally, we anyway have to convert EOL
4850 format if the default value of `buffer-file-coding-system'
4851 tells that it is not Unix-like (LF only) format. */
4852 int using_default_coding
= 0;
4853 int force_raw_text
= 0;
4855 val
= current_buffer
->buffer_file_coding_system
;
4857 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4860 if (NILP (current_buffer
->enable_multibyte_characters
))
4866 /* Check file-coding-system-alist. */
4867 Lisp_Object args
[7], coding_systems
;
4869 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4870 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4872 coding_systems
= Ffind_operation_coding_system (7, args
);
4873 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4874 val
= XCDR (coding_systems
);
4878 && !NILP (current_buffer
->buffer_file_coding_system
))
4880 /* If we still have not decided a coding system, use the
4881 default value of buffer-file-coding-system. */
4882 val
= current_buffer
->buffer_file_coding_system
;
4883 using_default_coding
= 1;
4887 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4888 /* Confirm that VAL can surely encode the current region. */
4889 val
= call5 (Vselect_safe_coding_system_function
,
4890 start
, end
, val
, Qnil
, filename
);
4892 setup_coding_system (Fcheck_coding_system (val
), coding
);
4893 if (coding
->eol_type
== CODING_EOL_UNDECIDED
4894 && !using_default_coding
)
4896 if (! EQ (default_buffer_file_coding
.symbol
,
4897 buffer_defaults
.buffer_file_coding_system
))
4898 setup_coding_system (buffer_defaults
.buffer_file_coding_system
,
4899 &default_buffer_file_coding
);
4900 if (default_buffer_file_coding
.eol_type
!= CODING_EOL_UNDECIDED
)
4902 Lisp_Object subsidiaries
;
4904 coding
->eol_type
= default_buffer_file_coding
.eol_type
;
4905 subsidiaries
= Fget (coding
->symbol
, Qeol_type
);
4906 if (VECTORP (subsidiaries
)
4907 && XVECTOR (subsidiaries
)->size
== 3)
4909 = XVECTOR (subsidiaries
)->contents
[coding
->eol_type
];
4914 setup_raw_text_coding_system (coding
);
4915 goto done_setup_coding
;
4918 setup_coding_system (Fcheck_coding_system (val
), coding
);
4921 if (!STRINGP (start
) && !NILP (current_buffer
->selective_display
))
4922 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4925 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4926 "r\nFWrite region to file: \ni\ni\ni\np",
4927 doc
: /* Write current region into specified file.
4928 When called from a program, requires three arguments:
4929 START, END and FILENAME. START and END are normally buffer positions
4930 specifying the part of the buffer to write.
4931 If START is nil, that means to use the entire buffer contents.
4932 If START is a string, then output that string to the file
4933 instead of any buffer contents; END is ignored.
4935 Optional fourth argument APPEND if non-nil means
4936 append to existing file contents (if any). If it is an integer,
4937 seek to that offset in the file before writing.
4938 Optional fifth argument VISIT, if t or a string, means
4939 set the last-save-file-modtime of buffer to this file's modtime
4940 and mark buffer not modified.
4941 If VISIT is a string, it is a second file name;
4942 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4943 VISIT is also the file name to lock and unlock for clash detection.
4944 If VISIT is neither t nor nil nor a string,
4945 that means do not display the \"Wrote file\" message.
4946 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4947 use for locking and unlocking, overriding FILENAME and VISIT.
4948 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4949 for an existing file with the same name. If MUSTBENEW is `excl',
4950 that means to get an error if the file already exists; never overwrite.
4951 If MUSTBENEW is neither nil nor `excl', that means ask for
4952 confirmation before overwriting, but do go ahead and overwrite the file
4953 if the user confirms.
4955 This does code conversion according to the value of
4956 `coding-system-for-write', `buffer-file-coding-system', or
4957 `file-coding-system-alist', and sets the variable
4958 `last-coding-system-used' to the coding system actually used. */)
4959 (start
, end
, filename
, append
, visit
, lockname
, mustbenew
)
4960 Lisp_Object start
, end
, filename
, append
, visit
, lockname
, mustbenew
;
4965 const unsigned char *fn
;
4968 int count
= SPECPDL_INDEX ();
4971 unsigned char *fname
= 0; /* If non-0, original filename (must rename) */
4973 Lisp_Object handler
;
4974 Lisp_Object visit_file
;
4975 Lisp_Object annotations
;
4976 Lisp_Object encoded_filename
;
4977 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4978 int quietly
= !NILP (visit
);
4979 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4980 struct buffer
*given_buffer
;
4982 int buffer_file_type
= O_BINARY
;
4984 struct coding_system coding
;
4986 if (current_buffer
->base_buffer
&& visiting
)
4987 error ("Cannot do file visiting in an indirect buffer");
4989 if (!NILP (start
) && !STRINGP (start
))
4990 validate_region (&start
, &end
);
4992 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4994 filename
= Fexpand_file_name (filename
, Qnil
);
4996 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4997 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4999 if (STRINGP (visit
))
5000 visit_file
= Fexpand_file_name (visit
, Qnil
);
5002 visit_file
= filename
;
5004 if (NILP (lockname
))
5005 lockname
= visit_file
;
5009 /* If the file name has special constructs in it,
5010 call the corresponding file handler. */
5011 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
5012 /* If FILENAME has no handler, see if VISIT has one. */
5013 if (NILP (handler
) && STRINGP (visit
))
5014 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
5016 if (!NILP (handler
))
5019 val
= call6 (handler
, Qwrite_region
, start
, end
,
5020 filename
, append
, visit
);
5024 SAVE_MODIFF
= MODIFF
;
5025 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5026 current_buffer
->filename
= visit_file
;
5032 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
5034 /* Special kludge to simplify auto-saving. */
5037 XSETFASTINT (start
, BEG
);
5038 XSETFASTINT (end
, Z
);
5042 record_unwind_protect (build_annotations_unwind
, Fcurrent_buffer ());
5043 count1
= SPECPDL_INDEX ();
5045 given_buffer
= current_buffer
;
5047 if (!STRINGP (start
))
5049 annotations
= build_annotations (start
, end
);
5051 if (current_buffer
!= given_buffer
)
5053 XSETFASTINT (start
, BEGV
);
5054 XSETFASTINT (end
, ZV
);
5060 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
5062 /* Decide the coding-system to encode the data with.
5063 We used to make this choice before calling build_annotations, but that
5064 leads to problems when a write-annotate-function takes care of
5065 unsavable chars (as was the case with X-Symbol). */
5066 choose_write_coding_system (start
, end
, filename
,
5067 append
, visit
, lockname
, &coding
);
5068 Vlast_coding_system_used
= coding
.symbol
;
5070 given_buffer
= current_buffer
;
5071 if (! STRINGP (start
))
5073 annotations
= build_annotations_2 (start
, end
,
5074 coding
.pre_write_conversion
, annotations
);
5075 if (current_buffer
!= given_buffer
)
5077 XSETFASTINT (start
, BEGV
);
5078 XSETFASTINT (end
, ZV
);
5082 #ifdef CLASH_DETECTION
5085 #if 0 /* This causes trouble for GNUS. */
5086 /* If we've locked this file for some other buffer,
5087 query before proceeding. */
5088 if (!visiting
&& EQ (Ffile_locked_p (lockname
), Qt
))
5089 call2 (intern ("ask-user-about-lock"), filename
, Vuser_login_name
);
5092 lock_file (lockname
);
5094 #endif /* CLASH_DETECTION */
5096 encoded_filename
= ENCODE_FILE (filename
);
5098 fn
= SDATA (encoded_filename
);
5102 desc
= emacs_open (fn
, O_WRONLY
| buffer_file_type
, 0);
5103 #else /* not DOS_NT */
5104 desc
= emacs_open (fn
, O_WRONLY
, 0);
5105 #endif /* not DOS_NT */
5107 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
5109 if (auto_saving
) /* Overwrite any previous version of autosave file */
5111 vms_truncate (fn
); /* if fn exists, truncate to zero length */
5112 desc
= emacs_open (fn
, O_RDWR
, 0);
5114 desc
= creat_copy_attrs (STRINGP (current_buffer
->filename
)
5115 ? SDATA (current_buffer
->filename
) : 0,
5118 else /* Write to temporary name and rename if no errors */
5120 Lisp_Object temp_name
;
5121 temp_name
= Ffile_name_directory (filename
);
5123 if (!NILP (temp_name
))
5125 temp_name
= Fmake_temp_name (concat2 (temp_name
,
5126 build_string ("$$SAVE$$")));
5127 fname
= SDATA (filename
);
5128 fn
= SDATA (temp_name
);
5129 desc
= creat_copy_attrs (fname
, fn
);
5132 /* If we can't open the temporary file, try creating a new
5133 version of the original file. VMS "creat" creates a
5134 new version rather than truncating an existing file. */
5137 desc
= creat (fn
, 0666);
5138 #if 0 /* This can clobber an existing file and fail to replace it,
5139 if the user runs out of space. */
5142 /* We can't make a new version;
5143 try to truncate and rewrite existing version if any. */
5145 desc
= emacs_open (fn
, O_RDWR
, 0);
5151 desc
= creat (fn
, 0666);
5155 desc
= emacs_open (fn
,
5156 O_WRONLY
| O_CREAT
| buffer_file_type
5157 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
5158 S_IREAD
| S_IWRITE
);
5159 #else /* not DOS_NT */
5160 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
5161 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
5162 auto_saving
? auto_save_mode_bits
: 0666);
5163 #endif /* not DOS_NT */
5164 #endif /* not VMS */
5168 #ifdef CLASH_DETECTION
5170 if (!auto_saving
) unlock_file (lockname
);
5172 #endif /* CLASH_DETECTION */
5174 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
5177 record_unwind_protect (close_file_unwind
, make_number (desc
));
5179 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
5183 if (NUMBERP (append
))
5184 ret
= lseek (desc
, XINT (append
), 1);
5186 ret
= lseek (desc
, 0, 2);
5189 #ifdef CLASH_DETECTION
5190 if (!auto_saving
) unlock_file (lockname
);
5191 #endif /* CLASH_DETECTION */
5193 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
5201 * Kludge Warning: The VMS C RTL likes to insert carriage returns
5202 * if we do writes that don't end with a carriage return. Furthermore
5203 * it cannot handle writes of more then 16K. The modified
5204 * version of "sys_write" in SYSDEP.C (see comment there) copes with
5205 * this EXCEPT for the last record (iff it doesn't end with a carriage
5206 * return). This implies that if your buffer doesn't end with a carriage
5207 * return, you get one free... tough. However it also means that if
5208 * we make two calls to sys_write (a la the following code) you can
5209 * get one at the gap as well. The easiest way to fix this (honest)
5210 * is to move the gap to the next newline (or the end of the buffer).
5215 if (GPT
> BEG
&& GPT_ADDR
[-1] != '\n')
5216 move_gap (find_next_newline (GPT
, 1));
5218 /* Whether VMS or not, we must move the gap to the next of newline
5219 when we must put designation sequences at beginning of line. */
5220 if (INTEGERP (start
)
5221 && coding
.type
== coding_type_iso2022
5222 && coding
.flags
& CODING_FLAG_ISO_DESIGNATE_AT_BOL
5223 && GPT
> BEG
&& GPT_ADDR
[-1] != '\n')
5225 int opoint
= PT
, opoint_byte
= PT_BYTE
;
5226 scan_newline (PT
, PT_BYTE
, ZV
, ZV_BYTE
, 1, 0);
5227 move_gap_both (PT
, PT_BYTE
);
5228 SET_PT_BOTH (opoint
, opoint_byte
);
5235 if (STRINGP (start
))
5237 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
5238 &annotations
, &coding
);
5241 else if (XINT (start
) != XINT (end
))
5243 tem
= CHAR_TO_BYTE (XINT (start
));
5245 if (XINT (start
) < GPT
)
5247 failure
= 0 > a_write (desc
, Qnil
, XINT (start
),
5248 min (GPT
, XINT (end
)) - XINT (start
),
5249 &annotations
, &coding
);
5253 if (XINT (end
) > GPT
&& !failure
)
5255 tem
= max (XINT (start
), GPT
);
5256 failure
= 0 > a_write (desc
, Qnil
, tem
, XINT (end
) - tem
,
5257 &annotations
, &coding
);
5263 /* If file was empty, still need to write the annotations */
5264 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
5265 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
5269 if (CODING_REQUIRE_FLUSHING (&coding
)
5270 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
5273 /* We have to flush out a data. */
5274 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
5275 failure
= 0 > e_write (desc
, Qnil
, 0, 0, &coding
);
5282 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
5283 Disk full in NFS may be reported here. */
5284 /* mib says that closing the file will try to write as fast as NFS can do
5285 it, and that means the fsync here is not crucial for autosave files. */
5286 if (!auto_saving
&& fsync (desc
) < 0)
5288 /* If fsync fails with EINTR, don't treat that as serious. */
5290 failure
= 1, save_errno
= errno
;
5294 /* Spurious "file has changed on disk" warnings have been
5295 observed on Suns as well.
5296 It seems that `close' can change the modtime, under nfs.
5298 (This has supposedly been fixed in Sunos 4,
5299 but who knows about all the other machines with NFS?) */
5302 /* On VMS and APOLLO, must do the stat after the close
5303 since closing changes the modtime. */
5306 /* Recall that #if defined does not work on VMS. */
5313 /* NFS can report a write failure now. */
5314 if (emacs_close (desc
) < 0)
5315 failure
= 1, save_errno
= errno
;
5318 /* If we wrote to a temporary name and had no errors, rename to real name. */
5322 failure
= (rename (fn
, fname
) != 0), save_errno
= errno
;
5330 /* Discard the unwind protect for close_file_unwind. */
5331 specpdl_ptr
= specpdl
+ count1
;
5332 /* Restore the original current buffer. */
5333 visit_file
= unbind_to (count
, visit_file
);
5335 #ifdef CLASH_DETECTION
5337 unlock_file (lockname
);
5338 #endif /* CLASH_DETECTION */
5340 /* Do this before reporting IO error
5341 to avoid a "file has changed on disk" warning on
5342 next attempt to save. */
5344 current_buffer
->modtime
= st
.st_mtime
;
5347 error ("IO error writing %s: %s", SDATA (filename
),
5348 emacs_strerror (save_errno
));
5352 SAVE_MODIFF
= MODIFF
;
5353 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5354 current_buffer
->filename
= visit_file
;
5355 update_mode_lines
++;
5360 && ! NILP (Fstring_equal (current_buffer
->filename
,
5361 current_buffer
->auto_save_file_name
)))
5362 SAVE_MODIFF
= MODIFF
;
5368 message_with_string ((INTEGERP (append
)
5378 Lisp_Object
merge ();
5380 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5381 doc
: /* Return t if (car A) is numerically less than (car B). */)
5385 return Flss (Fcar (a
), Fcar (b
));
5388 /* Build the complete list of annotations appropriate for writing out
5389 the text between START and END, by calling all the functions in
5390 write-region-annotate-functions and merging the lists they return.
5391 If one of these functions switches to a different buffer, we assume
5392 that buffer contains altered text. Therefore, the caller must
5393 make sure to restore the current buffer in all cases,
5394 as save-excursion would do. */
5397 build_annotations (start
, end
)
5398 Lisp_Object start
, end
;
5400 Lisp_Object annotations
;
5402 struct gcpro gcpro1
, gcpro2
;
5403 Lisp_Object original_buffer
;
5404 int i
, used_global
= 0;
5406 XSETBUFFER (original_buffer
, current_buffer
);
5409 p
= Vwrite_region_annotate_functions
;
5410 GCPRO2 (annotations
, p
);
5413 struct buffer
*given_buffer
= current_buffer
;
5414 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5415 { /* Use the global value of the hook. */
5418 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5420 p
= Fappend (2, arg
);
5423 Vwrite_region_annotations_so_far
= annotations
;
5424 res
= call2 (XCAR (p
), start
, end
);
5425 /* If the function makes a different buffer current,
5426 assume that means this buffer contains altered text to be output.
5427 Reset START and END from the buffer bounds
5428 and discard all previous annotations because they should have
5429 been dealt with by this function. */
5430 if (current_buffer
!= given_buffer
)
5432 XSETFASTINT (start
, BEGV
);
5433 XSETFASTINT (end
, ZV
);
5436 Flength (res
); /* Check basic validity of return value */
5437 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5441 /* Now do the same for annotation functions implied by the file-format */
5442 if (auto_saving
&& (!EQ (current_buffer
->auto_save_file_format
, Qt
)))
5443 p
= current_buffer
->auto_save_file_format
;
5445 p
= current_buffer
->file_format
;
5446 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5448 struct buffer
*given_buffer
= current_buffer
;
5450 Vwrite_region_annotations_so_far
= annotations
;
5452 /* Value is either a list of annotations or nil if the function
5453 has written annotations to a temporary buffer, which is now
5455 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5456 original_buffer
, make_number (i
));
5457 if (current_buffer
!= given_buffer
)
5459 XSETFASTINT (start
, BEGV
);
5460 XSETFASTINT (end
, ZV
);
5465 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5473 build_annotations_2 (start
, end
, pre_write_conversion
, annotations
)
5474 Lisp_Object start
, end
, pre_write_conversion
, annotations
;
5476 struct gcpro gcpro1
;
5479 GCPRO1 (annotations
);
5480 /* At last, do the same for the function PRE_WRITE_CONVERSION
5481 implied by the current coding-system. */
5482 if (!NILP (pre_write_conversion
))
5484 struct buffer
*given_buffer
= current_buffer
;
5485 Vwrite_region_annotations_so_far
= annotations
;
5486 res
= call2 (pre_write_conversion
, start
, end
);
5488 annotations
= (current_buffer
!= given_buffer
5490 : merge (annotations
, res
, Qcar_less_than_car
));
5497 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5498 If STRING is nil, POS is the character position in the current buffer.
5499 Intersperse with them the annotations from *ANNOT
5500 which fall within the range of POS to POS + NCHARS,
5501 each at its appropriate position.
5503 We modify *ANNOT by discarding elements as we use them up.
5505 The return value is negative in case of system call failure. */
5508 a_write (desc
, string
, pos
, nchars
, annot
, coding
)
5511 register int nchars
;
5514 struct coding_system
*coding
;
5518 int lastpos
= pos
+ nchars
;
5520 while (NILP (*annot
) || CONSP (*annot
))
5522 tem
= Fcar_safe (Fcar (*annot
));
5525 nextpos
= XFASTINT (tem
);
5527 /* If there are no more annotations in this range,
5528 output the rest of the range all at once. */
5529 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5530 return e_write (desc
, string
, pos
, lastpos
, coding
);
5532 /* Output buffer text up to the next annotation's position. */
5535 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
5539 /* Output the annotation. */
5540 tem
= Fcdr (Fcar (*annot
));
5543 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5546 *annot
= Fcdr (*annot
);
5551 #ifndef WRITE_BUF_SIZE
5552 #define WRITE_BUF_SIZE (16 * 1024)
5555 /* Write text in the range START and END into descriptor DESC,
5556 encoding them with coding system CODING. If STRING is nil, START
5557 and END are character positions of the current buffer, else they
5558 are indexes to the string STRING. */
5561 e_write (desc
, string
, start
, end
, coding
)
5565 struct coding_system
*coding
;
5567 register char *addr
;
5568 register int nbytes
;
5569 char buf
[WRITE_BUF_SIZE
];
5573 coding
->composing
= COMPOSITION_DISABLED
;
5574 if (coding
->composing
!= COMPOSITION_DISABLED
)
5575 coding_save_composition (coding
, start
, end
, string
);
5577 if (STRINGP (string
))
5579 addr
= SDATA (string
);
5580 nbytes
= SBYTES (string
);
5581 coding
->src_multibyte
= STRING_MULTIBYTE (string
);
5583 else if (start
< end
)
5585 /* It is assured that the gap is not in the range START and END-1. */
5586 addr
= CHAR_POS_ADDR (start
);
5587 nbytes
= CHAR_TO_BYTE (end
) - CHAR_TO_BYTE (start
);
5588 coding
->src_multibyte
5589 = !NILP (current_buffer
->enable_multibyte_characters
);
5595 coding
->src_multibyte
= 1;
5598 /* We used to have a code for handling selective display here. But,
5599 now it is handled within encode_coding. */
5604 result
= encode_coding (coding
, addr
, buf
, nbytes
, WRITE_BUF_SIZE
);
5605 if (coding
->produced
> 0)
5607 coding
->produced
-= emacs_write (desc
, buf
, coding
->produced
);
5608 if (coding
->produced
)
5614 nbytes
-= coding
->consumed
;
5615 addr
+= coding
->consumed
;
5616 if (result
== CODING_FINISH_INSUFFICIENT_SRC
5619 /* The source text ends by an incomplete multibyte form.
5620 There's no way other than write it out as is. */
5621 nbytes
-= emacs_write (desc
, addr
, nbytes
);
5630 start
+= coding
->consumed_char
;
5631 if (coding
->cmp_data
)
5632 coding_adjust_composition_offset (coding
, start
);
5635 if (coding
->cmp_data
)
5636 coding_free_composition_data (coding
);
5641 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5642 Sverify_visited_file_modtime
, 1, 1, 0,
5643 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5644 This means that the file has not been changed since it was visited or saved.
5645 See Info node `(elisp)Modification Time' for more details. */)
5651 Lisp_Object handler
;
5652 Lisp_Object filename
;
5657 if (!STRINGP (b
->filename
)) return Qt
;
5658 if (b
->modtime
== 0) return Qt
;
5660 /* If the file name has special constructs in it,
5661 call the corresponding file handler. */
5662 handler
= Ffind_file_name_handler (b
->filename
,
5663 Qverify_visited_file_modtime
);
5664 if (!NILP (handler
))
5665 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5667 filename
= ENCODE_FILE (b
->filename
);
5669 if (stat (SDATA (filename
), &st
) < 0)
5671 /* If the file doesn't exist now and didn't exist before,
5672 we say that it isn't modified, provided the error is a tame one. */
5673 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
5678 if (st
.st_mtime
== b
->modtime
5679 /* If both are positive, accept them if they are off by one second. */
5680 || (st
.st_mtime
> 0 && b
->modtime
> 0
5681 && (st
.st_mtime
== b
->modtime
+ 1
5682 || st
.st_mtime
== b
->modtime
- 1)))
5687 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5688 Sclear_visited_file_modtime
, 0, 0, 0,
5689 doc
: /* Clear out records of last mod time of visited file.
5690 Next attempt to save will certainly not complain of a discrepancy. */)
5693 current_buffer
->modtime
= 0;
5697 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5698 Svisited_file_modtime
, 0, 0, 0,
5699 doc
: /* Return the current buffer's recorded visited file modification time.
5700 The value is a list of the form (HIGH LOW), like the time values
5701 that `file-attributes' returns. If the current buffer has no recorded
5702 file modification time, this function returns 0.
5703 See Info node `(elisp)Modification Time' for more details. */)
5707 tcons
= long_to_cons ((unsigned long) current_buffer
->modtime
);
5709 return list2 (XCAR (tcons
), XCDR (tcons
));
5713 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5714 Sset_visited_file_modtime
, 0, 1, 0,
5715 doc
: /* Update buffer's recorded modification time from the visited file's time.
5716 Useful if the buffer was not read from the file normally
5717 or if the file itself has been changed for some known benign reason.
5718 An argument specifies the modification time value to use
5719 \(instead of that of the visited file), in the form of a list
5720 \(HIGH . LOW) or (HIGH LOW). */)
5722 Lisp_Object time_list
;
5724 if (!NILP (time_list
))
5725 current_buffer
->modtime
= cons_to_long (time_list
);
5728 register Lisp_Object filename
;
5730 Lisp_Object handler
;
5732 filename
= Fexpand_file_name (current_buffer
->filename
, Qnil
);
5734 /* If the file name has special constructs in it,
5735 call the corresponding file handler. */
5736 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5737 if (!NILP (handler
))
5738 /* The handler can find the file name the same way we did. */
5739 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5741 filename
= ENCODE_FILE (filename
);
5743 if (stat (SDATA (filename
), &st
) >= 0)
5744 current_buffer
->modtime
= st
.st_mtime
;
5751 auto_save_error (error
)
5754 Lisp_Object args
[3], msg
;
5756 struct gcpro gcpro1
;
5758 ring_bell (XFRAME (selected_frame
));
5760 args
[0] = build_string ("Auto-saving %s: %s");
5761 args
[1] = current_buffer
->name
;
5762 args
[2] = Ferror_message_string (error
);
5763 msg
= Fformat (3, args
);
5765 nbytes
= SBYTES (msg
);
5767 for (i
= 0; i
< 3; ++i
)
5770 message2 (SDATA (msg
), nbytes
, STRING_MULTIBYTE (msg
));
5772 message2_nolog (SDATA (msg
), nbytes
, STRING_MULTIBYTE (msg
));
5773 Fsleep_for (make_number (1), Qnil
);
5786 auto_save_mode_bits
= 0666;
5788 /* Get visited file's mode to become the auto save file's mode. */
5789 if (! NILP (current_buffer
->filename
))
5791 if (stat (SDATA (current_buffer
->filename
), &st
) >= 0)
5792 /* But make sure we can overwrite it later! */
5793 auto_save_mode_bits
= st
.st_mode
| 0600;
5794 else if ((modes
= Ffile_modes (current_buffer
->filename
),
5796 /* Remote files don't cooperate with stat. */
5797 auto_save_mode_bits
= XINT (modes
) | 0600;
5801 Fwrite_region (Qnil
, Qnil
,
5802 current_buffer
->auto_save_file_name
,
5803 Qnil
, Qlambda
, Qnil
, Qnil
);
5807 do_auto_save_unwind (stream
) /* used as unwind-protect function */
5812 fclose ((FILE *) (XFASTINT (XCAR (stream
)) << 16
5813 | XFASTINT (XCDR (stream
))));
5818 do_auto_save_unwind_1 (value
) /* used as unwind-protect function */
5821 minibuffer_auto_raise
= XINT (value
);
5826 do_auto_save_make_dir (dir
)
5829 return call2 (Qmake_directory
, dir
, Qt
);
5833 do_auto_save_eh (ignore
)
5839 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5840 doc
: /* Auto-save all buffers that need it.
5841 This is all buffers that have auto-saving enabled
5842 and are changed since last auto-saved.
5843 Auto-saving writes the buffer into a file
5844 so that your editing is not lost if the system crashes.
5845 This file is not the file you visited; that changes only when you save.
5846 Normally we run the normal hook `auto-save-hook' before saving.
5848 A non-nil NO-MESSAGE argument means do not print any message if successful.
5849 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5850 (no_message
, current_only
)
5851 Lisp_Object no_message
, current_only
;
5853 struct buffer
*old
= current_buffer
, *b
;
5854 Lisp_Object tail
, buf
;
5856 int do_handled_files
;
5859 Lisp_Object lispstream
;
5860 int count
= SPECPDL_INDEX ();
5861 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5862 int old_message_p
= 0;
5863 struct gcpro gcpro1
, gcpro2
;
5865 if (max_specpdl_size
< specpdl_size
+ 40)
5866 max_specpdl_size
= specpdl_size
+ 40;
5871 if (NILP (no_message
))
5873 old_message_p
= push_message ();
5874 record_unwind_protect (pop_message_unwind
, Qnil
);
5877 /* Ordinarily don't quit within this function,
5878 but don't make it impossible to quit (in case we get hung in I/O). */
5882 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5883 point to non-strings reached from Vbuffer_alist. */
5885 if (!NILP (Vrun_hooks
))
5886 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5888 if (STRINGP (Vauto_save_list_file_name
))
5890 Lisp_Object listfile
;
5892 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5894 /* Don't try to create the directory when shutting down Emacs,
5895 because creating the directory might signal an error, and
5896 that would leave Emacs in a strange state. */
5897 if (!NILP (Vrun_hooks
))
5901 GCPRO2 (dir
, listfile
);
5902 dir
= Ffile_name_directory (listfile
);
5903 if (NILP (Ffile_directory_p (dir
)))
5904 internal_condition_case_1 (do_auto_save_make_dir
,
5905 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5910 stream
= fopen (SDATA (listfile
), "w");
5913 /* Arrange to close that file whether or not we get an error.
5914 Also reset auto_saving to 0. */
5915 lispstream
= Fcons (Qnil
, Qnil
);
5916 XSETCARFASTINT (lispstream
, (EMACS_UINT
)stream
>> 16);
5917 XSETCDRFASTINT (lispstream
, (EMACS_UINT
)stream
& 0xffff);
5928 record_unwind_protect (do_auto_save_unwind
, lispstream
);
5929 record_unwind_protect (do_auto_save_unwind_1
,
5930 make_number (minibuffer_auto_raise
));
5931 minibuffer_auto_raise
= 0;
5934 /* On first pass, save all files that don't have handlers.
5935 On second pass, save all files that do have handlers.
5937 If Emacs is crashing, the handlers may tweak what is causing
5938 Emacs to crash in the first place, and it would be a shame if
5939 Emacs failed to autosave perfectly ordinary files because it
5940 couldn't handle some ange-ftp'd file. */
5942 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5943 for (tail
= Vbuffer_alist
; GC_CONSP (tail
); tail
= XCDR (tail
))
5945 buf
= XCDR (XCAR (tail
));
5948 /* Record all the buffers that have auto save mode
5949 in the special file that lists them. For each of these buffers,
5950 Record visited name (if any) and auto save name. */
5951 if (STRINGP (b
->auto_save_file_name
)
5952 && stream
!= NULL
&& do_handled_files
== 0)
5954 if (!NILP (b
->filename
))
5956 fwrite (SDATA (b
->filename
), 1,
5957 SBYTES (b
->filename
), stream
);
5959 putc ('\n', stream
);
5960 fwrite (SDATA (b
->auto_save_file_name
), 1,
5961 SBYTES (b
->auto_save_file_name
), stream
);
5962 putc ('\n', stream
);
5965 if (!NILP (current_only
)
5966 && b
!= current_buffer
)
5969 /* Don't auto-save indirect buffers.
5970 The base buffer takes care of it. */
5974 /* Check for auto save enabled
5975 and file changed since last auto save
5976 and file changed since last real save. */
5977 if (STRINGP (b
->auto_save_file_name
)
5978 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5979 && b
->auto_save_modified
< BUF_MODIFF (b
)
5980 /* -1 means we've turned off autosaving for a while--see below. */
5981 && XINT (b
->save_length
) >= 0
5982 && (do_handled_files
5983 || NILP (Ffind_file_name_handler (b
->auto_save_file_name
,
5986 EMACS_TIME before_time
, after_time
;
5988 EMACS_GET_TIME (before_time
);
5990 /* If we had a failure, don't try again for 20 minutes. */
5991 if (b
->auto_save_failure_time
>= 0
5992 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5995 if ((XFASTINT (b
->save_length
) * 10
5996 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5997 /* A short file is likely to change a large fraction;
5998 spare the user annoying messages. */
5999 && XFASTINT (b
->save_length
) > 5000
6000 /* These messages are frequent and annoying for `*mail*'. */
6001 && !EQ (b
->filename
, Qnil
)
6002 && NILP (no_message
))
6004 /* It has shrunk too much; turn off auto-saving here. */
6005 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
6006 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
6008 minibuffer_auto_raise
= 0;
6009 /* Turn off auto-saving until there's a real save,
6010 and prevent any more warnings. */
6011 XSETINT (b
->save_length
, -1);
6012 Fsleep_for (make_number (1), Qnil
);
6015 set_buffer_internal (b
);
6016 if (!auto_saved
&& NILP (no_message
))
6017 message1 ("Auto-saving...");
6018 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
6020 b
->auto_save_modified
= BUF_MODIFF (b
);
6021 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
6022 set_buffer_internal (old
);
6024 EMACS_GET_TIME (after_time
);
6026 /* If auto-save took more than 60 seconds,
6027 assume it was an NFS failure that got a timeout. */
6028 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
6029 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
6033 /* Prevent another auto save till enough input events come in. */
6034 record_auto_save ();
6036 if (auto_saved
&& NILP (no_message
))
6040 /* If we are going to restore an old message,
6041 give time to read ours. */
6042 sit_for (1, 0, 0, 0, 0);
6046 /* If we displayed a message and then restored a state
6047 with no message, leave a "done" message on the screen. */
6048 message1 ("Auto-saving...done");
6053 /* This restores the message-stack status. */
6054 unbind_to (count
, Qnil
);
6058 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
6059 Sset_buffer_auto_saved
, 0, 0, 0,
6060 doc
: /* Mark current buffer as auto-saved with its current text.
6061 No auto-save file will be written until the buffer changes again. */)
6064 current_buffer
->auto_save_modified
= MODIFF
;
6065 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
6066 current_buffer
->auto_save_failure_time
= -1;
6070 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
6071 Sclear_buffer_auto_save_failure
, 0, 0, 0,
6072 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
6075 current_buffer
->auto_save_failure_time
= -1;
6079 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
6081 doc
: /* Return t if current buffer has been auto-saved recently.
6082 More precisely, if it has been auto-saved since last read from or saved
6083 in the visited file. If the buffer has no visited file,
6084 then any auto-save counts as "recent". */)
6087 return (SAVE_MODIFF
< current_buffer
->auto_save_modified
) ? Qt
: Qnil
;
6090 /* Reading and completing file names */
6091 extern Lisp_Object
Ffile_name_completion (), Ffile_name_all_completions ();
6093 /* In the string VAL, change each $ to $$ and return the result. */
6096 double_dollars (val
)
6099 register const unsigned char *old
;
6100 register unsigned char *new;
6104 osize
= SBYTES (val
);
6106 /* Count the number of $ characters. */
6107 for (n
= osize
, count
= 0, old
= SDATA (val
); n
> 0; n
--)
6108 if (*old
++ == '$') count
++;
6112 val
= make_uninit_multibyte_string (SCHARS (val
) + count
,
6115 for (n
= osize
; n
> 0; n
--)
6129 read_file_name_cleanup (arg
)
6132 return (current_buffer
->directory
= arg
);
6135 DEFUN ("read-file-name-internal", Fread_file_name_internal
, Sread_file_name_internal
,
6137 doc
: /* Internal subroutine for read-file-name. Do not call this. */)
6138 (string
, dir
, action
)
6139 Lisp_Object string
, dir
, action
;
6140 /* action is nil for complete, t for return list of completions,
6141 lambda for verify final value */
6143 Lisp_Object name
, specdir
, realdir
, val
, orig_string
;
6145 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
6147 CHECK_STRING (string
);
6154 /* No need to protect ACTION--we only compare it with t and nil. */
6155 GCPRO5 (string
, realdir
, name
, specdir
, orig_string
);
6157 if (SCHARS (string
) == 0)
6159 if (EQ (action
, Qlambda
))
6167 orig_string
= string
;
6168 string
= Fsubstitute_in_file_name (string
);
6169 changed
= NILP (Fstring_equal (string
, orig_string
));
6170 name
= Ffile_name_nondirectory (string
);
6171 val
= Ffile_name_directory (string
);
6173 realdir
= Fexpand_file_name (val
, realdir
);
6178 specdir
= Ffile_name_directory (string
);
6179 val
= Ffile_name_completion (name
, realdir
);
6184 return double_dollars (string
);
6188 if (!NILP (specdir
))
6189 val
= concat2 (specdir
, val
);
6191 return double_dollars (val
);
6194 #endif /* not VMS */
6198 if (EQ (action
, Qt
))
6200 Lisp_Object all
= Ffile_name_all_completions (name
, realdir
);
6204 if (NILP (Vread_file_name_predicate
)
6205 || EQ (Vread_file_name_predicate
, Qfile_exists_p
))
6209 if (EQ (Vread_file_name_predicate
, Qfile_directory_p
))
6211 /* Brute-force speed up for directory checking:
6212 Discard strings which don't end in a slash. */
6213 for (comp
= Qnil
; CONSP (all
); all
= XCDR (all
))
6215 Lisp_Object tem
= XCAR (all
);
6217 if (STRINGP (tem
) &&
6218 (len
= SCHARS (tem
), len
> 0) &&
6219 IS_DIRECTORY_SEP (SREF (tem
, len
-1)))
6220 comp
= Fcons (tem
, comp
);
6226 /* Must do it the hard (and slow) way. */
6227 GCPRO3 (all
, comp
, specdir
);
6228 count
= SPECPDL_INDEX ();
6229 record_unwind_protect (read_file_name_cleanup
, current_buffer
->directory
);
6230 current_buffer
->directory
= realdir
;
6231 for (comp
= Qnil
; CONSP (all
); all
= XCDR (all
))
6232 if (!NILP (call1 (Vread_file_name_predicate
, XCAR (all
))))
6233 comp
= Fcons (XCAR (all
), comp
);
6234 unbind_to (count
, Qnil
);
6237 return Fnreverse (comp
);
6240 /* Only other case actually used is ACTION = lambda */
6242 /* Supposedly this helps commands such as `cd' that read directory names,
6243 but can someone explain how it helps them? -- RMS */
6244 if (SCHARS (name
) == 0)
6247 string
= Fexpand_file_name (string
, dir
);
6248 if (!NILP (Vread_file_name_predicate
))
6249 return call1 (Vread_file_name_predicate
, string
);
6250 return Ffile_exists_p (string
);
6253 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
6254 Snext_read_file_uses_dialog_p
, 0, 0, 0,
6255 doc
: /* Return t if a call to `read-file-name' will use a dialog.
6256 The return value is only relevant for a call to `read-file-name' that happens
6257 before any other event (mouse or keypress) is handeled. */)
6260 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6261 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
6270 DEFUN ("read-file-name", Fread_file_name
, Sread_file_name
, 1, 6, 0,
6271 doc
: /* Read file name, prompting with PROMPT and completing in directory DIR.
6272 Value is not expanded---you must call `expand-file-name' yourself.
6273 Default name to DEFAULT-FILENAME if user exits the minibuffer with
6274 the same non-empty string that was inserted by this function.
6275 (If DEFAULT-FILENAME is omitted, the visited file name is used,
6276 except that if INITIAL is specified, that combined with DIR is used.)
6277 If the user exits with an empty minibuffer, this function returns
6278 an empty string. (This can only happen if the user erased the
6279 pre-inserted contents or if `insert-default-directory' is nil.)
6280 Fourth arg MUSTMATCH non-nil means require existing file's name.
6281 Non-nil and non-t means also require confirmation after completion.
6282 Fifth arg INITIAL specifies text to start with.
6283 If optional sixth arg PREDICATE is non-nil, possible completions and
6284 the resulting file name must satisfy (funcall PREDICATE NAME).
6285 DIR should be an absolute directory name. It defaults to the value of
6286 `default-directory'.
6288 If this command was invoked with the mouse, use a file dialog box if
6289 `use-dialog-box' is non-nil, and the window system or X toolkit in use
6290 provides a file dialog box.
6292 See also `read-file-name-completion-ignore-case'
6293 and `read-file-name-function'. */)
6294 (prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
)
6295 Lisp_Object prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
;
6297 Lisp_Object val
, insdef
, tem
;
6298 struct gcpro gcpro1
, gcpro2
;
6299 register char *homedir
;
6300 Lisp_Object decoded_homedir
;
6301 int replace_in_history
= 0;
6302 int add_to_history
= 0;
6306 dir
= current_buffer
->directory
;
6307 if (NILP (Ffile_name_absolute_p (dir
)))
6308 dir
= Fexpand_file_name (dir
, Qnil
);
6309 if (NILP (default_filename
))
6312 ? Fexpand_file_name (initial
, dir
)
6313 : current_buffer
->filename
);
6315 /* If dir starts with user's homedir, change that to ~. */
6316 homedir
= (char *) egetenv ("HOME");
6318 /* homedir can be NULL in temacs, since Vprocess_environment is not
6319 yet set up. We shouldn't crash in that case. */
6322 homedir
= strcpy (alloca (strlen (homedir
) + 1), homedir
);
6323 CORRECT_DIR_SEPS (homedir
);
6328 = DECODE_FILE (make_unibyte_string (homedir
, strlen (homedir
)));
6331 && !strncmp (SDATA (decoded_homedir
), SDATA (dir
),
6332 SBYTES (decoded_homedir
))
6333 && IS_DIRECTORY_SEP (SREF (dir
, SBYTES (decoded_homedir
))))
6335 dir
= Fsubstring (dir
, make_number (SCHARS (decoded_homedir
)), Qnil
);
6336 dir
= concat2 (build_string ("~"), dir
);
6338 /* Likewise for default_filename. */
6340 && STRINGP (default_filename
)
6341 && !strncmp (SDATA (decoded_homedir
), SDATA (default_filename
),
6342 SBYTES (decoded_homedir
))
6343 && IS_DIRECTORY_SEP (SREF (default_filename
, SBYTES (decoded_homedir
))))
6346 = Fsubstring (default_filename
,
6347 make_number (SCHARS (decoded_homedir
)), Qnil
);
6348 default_filename
= concat2 (build_string ("~"), default_filename
);
6350 if (!NILP (default_filename
))
6352 CHECK_STRING (default_filename
);
6353 default_filename
= double_dollars (default_filename
);
6356 if (insert_default_directory
&& STRINGP (dir
))
6359 if (!NILP (initial
))
6361 Lisp_Object args
[2], pos
;
6365 insdef
= Fconcat (2, args
);
6366 pos
= make_number (SCHARS (double_dollars (dir
)));
6367 insdef
= Fcons (double_dollars (insdef
), pos
);
6370 insdef
= double_dollars (insdef
);
6372 else if (STRINGP (initial
))
6373 insdef
= Fcons (double_dollars (initial
), make_number (0));
6377 if (!NILP (Vread_file_name_function
))
6379 Lisp_Object args
[7];
6381 GCPRO2 (insdef
, default_filename
);
6382 args
[0] = Vread_file_name_function
;
6385 args
[3] = default_filename
;
6386 args
[4] = mustmatch
;
6388 args
[6] = predicate
;
6389 RETURN_UNGCPRO (Ffuncall (7, args
));
6392 count
= SPECPDL_INDEX ();
6393 specbind (intern ("completion-ignore-case"),
6394 read_file_name_completion_ignore_case
? Qt
: Qnil
);
6395 specbind (intern ("minibuffer-completing-file-name"), Qt
);
6396 specbind (intern ("read-file-name-predicate"),
6397 (NILP (predicate
) ? Qfile_exists_p
: predicate
));
6399 GCPRO2 (insdef
, default_filename
);
6401 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6402 if (! NILP (Fnext_read_file_uses_dialog_p ()))
6404 /* If DIR contains a file name, split it. */
6406 file
= Ffile_name_nondirectory (dir
);
6407 if (SCHARS (file
) && NILP (default_filename
))
6409 default_filename
= file
;
6410 dir
= Ffile_name_directory (dir
);
6412 if (!NILP(default_filename
))
6413 default_filename
= Fexpand_file_name (default_filename
, dir
);
6414 val
= Fx_file_dialog (prompt
, dir
, default_filename
, mustmatch
,
6415 EQ (predicate
, Qfile_directory_p
) ? Qt
: Qnil
);
6420 val
= Fcompleting_read (prompt
, intern ("read-file-name-internal"),
6421 dir
, mustmatch
, insdef
,
6422 Qfile_name_history
, default_filename
, Qnil
);
6424 tem
= Fsymbol_value (Qfile_name_history
);
6425 if (CONSP (tem
) && EQ (XCAR (tem
), val
))
6426 replace_in_history
= 1;
6428 /* If Fcompleting_read returned the inserted default string itself
6429 (rather than a new string with the same contents),
6430 it has to mean that the user typed RET with the minibuffer empty.
6431 In that case, we really want to return ""
6432 so that commands such as set-visited-file-name can distinguish. */
6433 if (EQ (val
, default_filename
))
6435 /* In this case, Fcompleting_read has not added an element
6436 to the history. Maybe we should. */
6437 if (! replace_in_history
)
6443 unbind_to (count
, Qnil
);
6446 error ("No file name specified");
6448 tem
= Fstring_equal (val
, CONSP (insdef
) ? XCAR (insdef
) : insdef
);
6450 if (!NILP (tem
) && !NILP (default_filename
))
6451 val
= default_filename
;
6452 val
= Fsubstitute_in_file_name (val
);
6454 if (replace_in_history
)
6455 /* Replace what Fcompleting_read added to the history
6456 with what we will actually return. */
6458 Lisp_Object val1
= double_dollars (val
);
6459 tem
= Fsymbol_value (Qfile_name_history
);
6460 if (history_delete_duplicates
)
6461 XSETCDR (tem
, Fdelete (val1
, XCDR(tem
)));
6462 XSETCAR (tem
, val1
);
6464 else if (add_to_history
)
6466 /* Add the value to the history--but not if it matches
6467 the last value already there. */
6468 Lisp_Object val1
= double_dollars (val
);
6469 tem
= Fsymbol_value (Qfile_name_history
);
6470 if (! CONSP (tem
) || NILP (Fequal (XCAR (tem
), val1
)))
6472 if (history_delete_duplicates
) tem
= Fdelete (val1
, tem
);
6473 Fset (Qfile_name_history
, Fcons (val1
, tem
));
6484 /* Must be set before any path manipulation is performed. */
6485 XSETFASTINT (Vdirectory_sep_char
, '/');
6492 Qoperations
= intern ("operations");
6493 Qexpand_file_name
= intern ("expand-file-name");
6494 Qsubstitute_in_file_name
= intern ("substitute-in-file-name");
6495 Qdirectory_file_name
= intern ("directory-file-name");
6496 Qfile_name_directory
= intern ("file-name-directory");
6497 Qfile_name_nondirectory
= intern ("file-name-nondirectory");
6498 Qunhandled_file_name_directory
= intern ("unhandled-file-name-directory");
6499 Qfile_name_as_directory
= intern ("file-name-as-directory");
6500 Qcopy_file
= intern ("copy-file");
6501 Qmake_directory_internal
= intern ("make-directory-internal");
6502 Qmake_directory
= intern ("make-directory");
6503 Qdelete_directory
= intern ("delete-directory");
6504 Qdelete_file
= intern ("delete-file");
6505 Qrename_file
= intern ("rename-file");
6506 Qadd_name_to_file
= intern ("add-name-to-file");
6507 Qmake_symbolic_link
= intern ("make-symbolic-link");
6508 Qfile_exists_p
= intern ("file-exists-p");
6509 Qfile_executable_p
= intern ("file-executable-p");
6510 Qfile_readable_p
= intern ("file-readable-p");
6511 Qfile_writable_p
= intern ("file-writable-p");
6512 Qfile_symlink_p
= intern ("file-symlink-p");
6513 Qaccess_file
= intern ("access-file");
6514 Qfile_directory_p
= intern ("file-directory-p");
6515 Qfile_regular_p
= intern ("file-regular-p");
6516 Qfile_accessible_directory_p
= intern ("file-accessible-directory-p");
6517 Qfile_modes
= intern ("file-modes");
6518 Qset_file_modes
= intern ("set-file-modes");
6519 Qset_file_times
= intern ("set-file-times");
6520 Qfile_newer_than_file_p
= intern ("file-newer-than-file-p");
6521 Qinsert_file_contents
= intern ("insert-file-contents");
6522 Qwrite_region
= intern ("write-region");
6523 Qverify_visited_file_modtime
= intern ("verify-visited-file-modtime");
6524 Qset_visited_file_modtime
= intern ("set-visited-file-modtime");
6525 Qauto_save_coding
= intern ("auto-save-coding");
6527 staticpro (&Qoperations
);
6528 staticpro (&Qexpand_file_name
);
6529 staticpro (&Qsubstitute_in_file_name
);
6530 staticpro (&Qdirectory_file_name
);
6531 staticpro (&Qfile_name_directory
);
6532 staticpro (&Qfile_name_nondirectory
);
6533 staticpro (&Qunhandled_file_name_directory
);
6534 staticpro (&Qfile_name_as_directory
);
6535 staticpro (&Qcopy_file
);
6536 staticpro (&Qmake_directory_internal
);
6537 staticpro (&Qmake_directory
);
6538 staticpro (&Qdelete_directory
);
6539 staticpro (&Qdelete_file
);
6540 staticpro (&Qrename_file
);
6541 staticpro (&Qadd_name_to_file
);
6542 staticpro (&Qmake_symbolic_link
);
6543 staticpro (&Qfile_exists_p
);
6544 staticpro (&Qfile_executable_p
);
6545 staticpro (&Qfile_readable_p
);
6546 staticpro (&Qfile_writable_p
);
6547 staticpro (&Qaccess_file
);
6548 staticpro (&Qfile_symlink_p
);
6549 staticpro (&Qfile_directory_p
);
6550 staticpro (&Qfile_regular_p
);
6551 staticpro (&Qfile_accessible_directory_p
);
6552 staticpro (&Qfile_modes
);
6553 staticpro (&Qset_file_modes
);
6554 staticpro (&Qset_file_times
);
6555 staticpro (&Qfile_newer_than_file_p
);
6556 staticpro (&Qinsert_file_contents
);
6557 staticpro (&Qwrite_region
);
6558 staticpro (&Qverify_visited_file_modtime
);
6559 staticpro (&Qset_visited_file_modtime
);
6560 staticpro (&Qauto_save_coding
);
6562 Qfile_name_history
= intern ("file-name-history");
6563 Fset (Qfile_name_history
, Qnil
);
6564 staticpro (&Qfile_name_history
);
6566 Qfile_error
= intern ("file-error");
6567 staticpro (&Qfile_error
);
6568 Qfile_already_exists
= intern ("file-already-exists");
6569 staticpro (&Qfile_already_exists
);
6570 Qfile_date_error
= intern ("file-date-error");
6571 staticpro (&Qfile_date_error
);
6572 Qexcl
= intern ("excl");
6576 Qfind_buffer_file_type
= intern ("find-buffer-file-type");
6577 staticpro (&Qfind_buffer_file_type
);
6580 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system
,
6581 doc
: /* *Coding system for encoding file names.
6582 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6583 Vfile_name_coding_system
= Qnil
;
6585 DEFVAR_LISP ("default-file-name-coding-system",
6586 &Vdefault_file_name_coding_system
,
6587 doc
: /* Default coding system for encoding file names.
6588 This variable is used only when `file-name-coding-system' is nil.
6590 This variable is set/changed by the command `set-language-environment'.
6591 User should not set this variable manually,
6592 instead use `file-name-coding-system' to get a constant encoding
6593 of file names regardless of the current language environment. */);
6594 Vdefault_file_name_coding_system
= Qnil
;
6596 Qformat_decode
= intern ("format-decode");
6597 staticpro (&Qformat_decode
);
6598 Qformat_annotate_function
= intern ("format-annotate-function");
6599 staticpro (&Qformat_annotate_function
);
6600 Qafter_insert_file_set_coding
= intern ("after-insert-file-set-coding");
6601 staticpro (&Qafter_insert_file_set_coding
);
6603 Qcar_less_than_car
= intern ("car-less-than-car");
6604 staticpro (&Qcar_less_than_car
);
6606 Fput (Qfile_error
, Qerror_conditions
,
6607 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
)));
6608 Fput (Qfile_error
, Qerror_message
,
6609 build_string ("File error"));
6611 Fput (Qfile_already_exists
, Qerror_conditions
,
6612 Fcons (Qfile_already_exists
,
6613 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
))));
6614 Fput (Qfile_already_exists
, Qerror_message
,
6615 build_string ("File already exists"));
6617 Fput (Qfile_date_error
, Qerror_conditions
,
6618 Fcons (Qfile_date_error
,
6619 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
))));
6620 Fput (Qfile_date_error
, Qerror_message
,
6621 build_string ("Cannot set file date"));
6623 DEFVAR_LISP ("read-file-name-function", &Vread_file_name_function
,
6624 doc
: /* If this is non-nil, `read-file-name' does its work by calling this function. */);
6625 Vread_file_name_function
= Qnil
;
6627 DEFVAR_LISP ("read-file-name-predicate", &Vread_file_name_predicate
,
6628 doc
: /* Current predicate used by `read-file-name-internal'. */);
6629 Vread_file_name_predicate
= Qnil
;
6631 DEFVAR_BOOL ("read-file-name-completion-ignore-case", &read_file_name_completion_ignore_case
,
6632 doc
: /* *Non-nil means when reading a file name completion ignores case. */);
6633 #if defined VMS || defined DOS_NT || defined MAC_OS
6634 read_file_name_completion_ignore_case
= 1;
6636 read_file_name_completion_ignore_case
= 0;
6639 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory
,
6640 doc
: /* *Non-nil means when reading a filename start with default dir in minibuffer.
6641 If the initial minibuffer contents are non-empty, you can usually
6642 request a default filename by typing RETURN without editing. For some
6643 commands, exiting with an empty minibuffer has a special meaning,
6644 such as making the current buffer visit no file in the case of
6645 `set-visited-file-name'.
6646 If this variable is non-nil, the minibuffer contents are always
6647 initially non-empty and typing RETURN without editing will fetch the
6648 default name, if one is provided. Note however that this default name
6649 is not necessarily the name originally inserted in the minibuffer, if
6650 that is just the default directory.
6651 If this variable is nil, the minibuffer often starts out empty. In
6652 that case you may have to explicitly fetch the next history element to
6653 request the default name. */);
6654 insert_default_directory
= 1;
6656 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm
,
6657 doc
: /* *Non-nil means write new files with record format `stmlf'.
6658 nil means use format `var'. This variable is meaningful only on VMS. */);
6659 vms_stmlf_recfm
= 0;
6661 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char
,
6662 doc
: /* Directory separator character for built-in functions that return file names.
6663 The value is always ?/. Don't use this variable, just use `/'. */);
6665 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist
,
6666 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6667 If a file name matches REGEXP, then all I/O on that file is done by calling
6670 The first argument given to HANDLER is the name of the I/O primitive
6671 to be handled; the remaining arguments are the arguments that were
6672 passed to that primitive. For example, if you do
6673 (file-exists-p FILENAME)
6674 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6675 (funcall HANDLER 'file-exists-p FILENAME)
6676 The function `find-file-name-handler' checks this list for a handler
6677 for its argument. */);
6678 Vfile_name_handler_alist
= Qnil
;
6680 DEFVAR_LISP ("set-auto-coding-function",
6681 &Vset_auto_coding_function
,
6682 doc
: /* If non-nil, a function to call to decide a coding system of file.
6683 Two arguments are passed to this function: the file name
6684 and the length of a file contents following the point.
6685 This function should return a coding system to decode the file contents.
6686 It should check the file name against `auto-coding-alist'.
6687 If no coding system is decided, it should check a coding system
6688 specified in the heading lines with the format:
6689 -*- ... coding: CODING-SYSTEM; ... -*-
6690 or local variable spec of the tailing lines with `coding:' tag. */);
6691 Vset_auto_coding_function
= Qnil
;
6693 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions
,
6694 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
6695 Each is passed one argument, the number of characters inserted.
6696 It should return the new character count, and leave point the same.
6697 If `insert-file-contents' is intercepted by a handler from
6698 `file-name-handler-alist', that handler is responsible for calling the
6699 functions in `after-insert-file-functions' if appropriate. */);
6700 Vafter_insert_file_functions
= Qnil
;
6702 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions
,
6703 doc
: /* A list of functions to be called at the start of `write-region'.
6704 Each is passed two arguments, START and END as for `write-region'.
6705 These are usually two numbers but not always; see the documentation
6706 for `write-region'. The function should return a list of pairs
6707 of the form (POSITION . STRING), consisting of strings to be effectively
6708 inserted at the specified positions of the file being written (1 means to
6709 insert before the first byte written). The POSITIONs must be sorted into
6710 increasing order. If there are several functions in the list, the several
6711 lists are merged destructively. Alternatively, the function can return
6712 with a different buffer current; in that case it should pay attention
6713 to the annotations returned by previous functions and listed in
6714 `write-region-annotations-so-far'.*/);
6715 Vwrite_region_annotate_functions
= Qnil
;
6716 staticpro (&Qwrite_region_annotate_functions
);
6717 Qwrite_region_annotate_functions
6718 = intern ("write-region-annotate-functions");
6720 DEFVAR_LISP ("write-region-annotations-so-far",
6721 &Vwrite_region_annotations_so_far
,
6722 doc
: /* When an annotation function is called, this holds the previous annotations.
6723 These are the annotations made by other annotation functions
6724 that were already called. See also `write-region-annotate-functions'. */);
6725 Vwrite_region_annotations_so_far
= Qnil
;
6727 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers
,
6728 doc
: /* A list of file name handlers that temporarily should not be used.
6729 This applies only to the operation `inhibit-file-name-operation'. */);
6730 Vinhibit_file_name_handlers
= Qnil
;
6732 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation
,
6733 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6734 Vinhibit_file_name_operation
= Qnil
;
6736 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name
,
6737 doc
: /* File name in which we write a list of all auto save file names.
6738 This variable is initialized automatically from `auto-save-list-file-prefix'
6739 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6740 a non-nil value. */);
6741 Vauto_save_list_file_name
= Qnil
;
6743 defsubr (&Sfind_file_name_handler
);
6744 defsubr (&Sfile_name_directory
);
6745 defsubr (&Sfile_name_nondirectory
);
6746 defsubr (&Sunhandled_file_name_directory
);
6747 defsubr (&Sfile_name_as_directory
);
6748 defsubr (&Sdirectory_file_name
);
6749 defsubr (&Smake_temp_name
);
6750 defsubr (&Sexpand_file_name
);
6751 defsubr (&Ssubstitute_in_file_name
);
6752 defsubr (&Scopy_file
);
6753 defsubr (&Smake_directory_internal
);
6754 defsubr (&Sdelete_directory
);
6755 defsubr (&Sdelete_file
);
6756 defsubr (&Srename_file
);
6757 defsubr (&Sadd_name_to_file
);
6759 defsubr (&Smake_symbolic_link
);
6760 #endif /* S_IFLNK */
6762 defsubr (&Sdefine_logical_name
);
6765 defsubr (&Ssysnetunam
);
6766 #endif /* HPUX_NET */
6767 defsubr (&Sfile_name_absolute_p
);
6768 defsubr (&Sfile_exists_p
);
6769 defsubr (&Sfile_executable_p
);
6770 defsubr (&Sfile_readable_p
);
6771 defsubr (&Sfile_writable_p
);
6772 defsubr (&Saccess_file
);
6773 defsubr (&Sfile_symlink_p
);
6774 defsubr (&Sfile_directory_p
);
6775 defsubr (&Sfile_accessible_directory_p
);
6776 defsubr (&Sfile_regular_p
);
6777 defsubr (&Sfile_modes
);
6778 defsubr (&Sset_file_modes
);
6779 defsubr (&Sset_file_times
);
6780 defsubr (&Sset_default_file_modes
);
6781 defsubr (&Sdefault_file_modes
);
6782 defsubr (&Sfile_newer_than_file_p
);
6783 defsubr (&Sinsert_file_contents
);
6784 defsubr (&Swrite_region
);
6785 defsubr (&Scar_less_than_car
);
6786 defsubr (&Sverify_visited_file_modtime
);
6787 defsubr (&Sclear_visited_file_modtime
);
6788 defsubr (&Svisited_file_modtime
);
6789 defsubr (&Sset_visited_file_modtime
);
6790 defsubr (&Sdo_auto_save
);
6791 defsubr (&Sset_buffer_auto_saved
);
6792 defsubr (&Sclear_buffer_auto_save_failure
);
6793 defsubr (&Srecent_auto_save_p
);
6795 defsubr (&Sread_file_name_internal
);
6796 defsubr (&Sread_file_name
);
6797 defsubr (&Snext_read_file_uses_dialog_p
);
6800 defsubr (&Sunix_sync
);
6804 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
6805 (do not change this comment) */