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 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)
76 #include "intervals.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 /* Nonzero during writing of auto-save files */
154 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
155 a new file with the same mode as the original */
156 int auto_save_mode_bits
;
158 /* The symbol bound to coding-system-for-read when
159 insert-file-contents is called for recovering a file. This is not
160 an actual coding system name, but just an indicator to tell
161 insert-file-contents to use `emacs-mule' with a special flag for
162 auto saving and recovering a file. */
163 Lisp_Object Qauto_save_coding
;
165 /* Coding system for file names, or nil if none. */
166 Lisp_Object Vfile_name_coding_system
;
168 /* Coding system for file names used only when
169 Vfile_name_coding_system is nil. */
170 Lisp_Object Vdefault_file_name_coding_system
;
172 /* Alist of elements (REGEXP . HANDLER) for file names
173 whose I/O is done with a special handler. */
174 Lisp_Object Vfile_name_handler_alist
;
176 /* Lisp functions for translating file formats */
177 Lisp_Object Qformat_decode
, Qformat_annotate_function
;
179 /* Function to be called to decide a coding system of a reading file. */
180 Lisp_Object Vset_auto_coding_function
;
182 /* Functions to be called to process text properties in inserted file. */
183 Lisp_Object Vafter_insert_file_functions
;
185 /* Lisp function for setting buffer-file-coding-system and the
186 multibyteness of the current buffer after inserting a file. */
187 Lisp_Object Qafter_insert_file_set_coding
;
189 /* Functions to be called to create text property annotations for file. */
190 Lisp_Object Vwrite_region_annotate_functions
;
191 Lisp_Object Qwrite_region_annotate_functions
;
193 /* During build_annotations, each time an annotation function is called,
194 this holds the annotations made by the previous functions. */
195 Lisp_Object Vwrite_region_annotations_so_far
;
197 /* File name in which we write a list of all our auto save files. */
198 Lisp_Object Vauto_save_list_file_name
;
200 /* Function to call to read a file name. */
201 Lisp_Object Vread_file_name_function
;
203 /* Current predicate used by read_file_name_internal. */
204 Lisp_Object Vread_file_name_predicate
;
206 /* Nonzero means completion ignores case when reading file name. */
207 int read_file_name_completion_ignore_case
;
209 /* Nonzero means, when reading a filename in the minibuffer,
210 start out by inserting the default directory into the minibuffer. */
211 int insert_default_directory
;
213 /* On VMS, nonzero means write new files with record format stmlf.
214 Zero means use var format. */
217 /* On NT, specifies the directory separator character, used (eg.) when
218 expanding file names. This can be bound to / or \. */
219 Lisp_Object Vdirectory_sep_char
;
221 extern Lisp_Object Vuser_login_name
;
224 extern Lisp_Object Vw32_get_true_file_attributes
;
227 extern int minibuf_level
;
229 extern int minibuffer_auto_raise
;
231 extern int history_delete_duplicates
;
233 /* These variables describe handlers that have "already" had a chance
234 to handle the current operation.
236 Vinhibit_file_name_handlers is a list of file name handlers.
237 Vinhibit_file_name_operation is the operation being handled.
238 If we try to handle that operation, we ignore those handlers. */
240 static Lisp_Object Vinhibit_file_name_handlers
;
241 static Lisp_Object Vinhibit_file_name_operation
;
243 Lisp_Object Qfile_error
, Qfile_already_exists
, Qfile_date_error
;
245 Lisp_Object Qfile_name_history
;
247 Lisp_Object Qcar_less_than_car
;
249 static int a_write
P_ ((int, Lisp_Object
, int, int,
250 Lisp_Object
*, struct coding_system
*));
251 static int e_write
P_ ((int, Lisp_Object
, int, int, struct coding_system
*));
255 report_file_error (string
, data
)
259 Lisp_Object errstring
;
262 synchronize_system_messages_locale ();
263 errstring
= code_convert_string_norecord (build_string (strerror (errorno
)),
264 Vlocale_coding_system
, 0);
270 Fsignal (Qfile_already_exists
, Fcons (errstring
, data
));
273 /* System error messages are capitalized. Downcase the initial
274 unless it is followed by a slash. */
275 if (SREF (errstring
, 1) != '/')
276 SSET (errstring
, 0, DOWNCASE (SREF (errstring
, 0)));
278 Fsignal (Qfile_error
,
279 Fcons (build_string (string
), Fcons (errstring
, data
)));
284 close_file_unwind (fd
)
287 emacs_close (XFASTINT (fd
));
291 /* Restore point, having saved it as a marker. */
294 restore_point_unwind (location
)
295 Lisp_Object location
;
297 Fgoto_char (location
);
298 Fset_marker (location
, Qnil
, Qnil
);
302 Lisp_Object Qexpand_file_name
;
303 Lisp_Object Qsubstitute_in_file_name
;
304 Lisp_Object Qdirectory_file_name
;
305 Lisp_Object Qfile_name_directory
;
306 Lisp_Object Qfile_name_nondirectory
;
307 Lisp_Object Qunhandled_file_name_directory
;
308 Lisp_Object Qfile_name_as_directory
;
309 Lisp_Object Qcopy_file
;
310 Lisp_Object Qmake_directory_internal
;
311 Lisp_Object Qmake_directory
;
312 Lisp_Object Qdelete_directory
;
313 Lisp_Object Qdelete_file
;
314 Lisp_Object Qrename_file
;
315 Lisp_Object Qadd_name_to_file
;
316 Lisp_Object Qmake_symbolic_link
;
317 Lisp_Object Qfile_exists_p
;
318 Lisp_Object Qfile_executable_p
;
319 Lisp_Object Qfile_readable_p
;
320 Lisp_Object Qfile_writable_p
;
321 Lisp_Object Qfile_symlink_p
;
322 Lisp_Object Qaccess_file
;
323 Lisp_Object Qfile_directory_p
;
324 Lisp_Object Qfile_regular_p
;
325 Lisp_Object Qfile_accessible_directory_p
;
326 Lisp_Object Qfile_modes
;
327 Lisp_Object Qset_file_modes
;
328 Lisp_Object Qset_file_times
;
329 Lisp_Object Qfile_newer_than_file_p
;
330 Lisp_Object Qinsert_file_contents
;
331 Lisp_Object Qwrite_region
;
332 Lisp_Object Qverify_visited_file_modtime
;
333 Lisp_Object Qset_visited_file_modtime
;
335 DEFUN ("find-file-name-handler", Ffind_file_name_handler
, Sfind_file_name_handler
, 2, 2, 0,
336 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
337 Otherwise, return nil.
338 A file name is handled if one of the regular expressions in
339 `file-name-handler-alist' matches it.
341 If OPERATION equals `inhibit-file-name-operation', then we ignore
342 any handlers that are members of `inhibit-file-name-handlers',
343 but we still do run any other handlers. This lets handlers
344 use the standard functions without calling themselves recursively. */)
345 (filename
, operation
)
346 Lisp_Object filename
, operation
;
348 /* This function must not munge the match data. */
349 Lisp_Object chain
, inhibited_handlers
, result
;
353 CHECK_STRING (filename
);
355 if (EQ (operation
, Vinhibit_file_name_operation
))
356 inhibited_handlers
= Vinhibit_file_name_handlers
;
358 inhibited_handlers
= Qnil
;
360 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
361 chain
= XCDR (chain
))
371 && (match_pos
= fast_string_match (string
, filename
)) > pos
)
373 Lisp_Object handler
, tem
;
375 handler
= XCDR (elt
);
376 tem
= Fmemq (handler
, inhibited_handlers
);
390 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
392 doc
: /* Return the directory component in file name FILENAME.
393 Return nil if FILENAME does not include a directory.
394 Otherwise return a directory spec.
395 Given a Unix syntax file name, returns a string ending in slash;
396 on VMS, perhaps instead a string ending in `:', `]' or `>'. */)
398 Lisp_Object filename
;
401 register const unsigned char *beg
;
403 register unsigned char *beg
;
405 register const unsigned char *p
;
408 CHECK_STRING (filename
);
410 /* If the file name has special constructs in it,
411 call the corresponding file handler. */
412 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
414 return call2 (handler
, Qfile_name_directory
, filename
);
416 #ifdef FILE_SYSTEM_CASE
417 filename
= FILE_SYSTEM_CASE (filename
);
419 beg
= SDATA (filename
);
421 beg
= strcpy (alloca (strlen (beg
) + 1), beg
);
423 p
= beg
+ SBYTES (filename
);
425 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
427 && p
[-1] != ':' && p
[-1] != ']' && p
[-1] != '>'
430 /* only recognise drive specifier at the beginning */
432 /* handle the "/:d:foo" and "/:foo" cases correctly */
433 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
434 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
441 /* Expansion of "c:" to drive and default directory. */
444 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
445 unsigned char *res
= alloca (MAXPATHLEN
+ 1);
446 unsigned char *r
= res
;
448 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
450 strncpy (res
, beg
, 2);
455 if (getdefdir (toupper (*beg
) - 'A' + 1, r
))
457 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
460 p
= beg
+ strlen (beg
);
463 CORRECT_DIR_SEPS (beg
);
466 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
469 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
470 Sfile_name_nondirectory
, 1, 1, 0,
471 doc
: /* Return file name FILENAME sans its directory.
472 For example, in a Unix-syntax file name,
473 this is everything after the last slash,
474 or the entire name if it contains no slash. */)
476 Lisp_Object filename
;
478 register const unsigned char *beg
, *p
, *end
;
481 CHECK_STRING (filename
);
483 /* If the file name has special constructs in it,
484 call the corresponding file handler. */
485 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
487 return call2 (handler
, Qfile_name_nondirectory
, filename
);
489 beg
= SDATA (filename
);
490 end
= p
= beg
+ SBYTES (filename
);
492 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
494 && p
[-1] != ':' && p
[-1] != ']' && p
[-1] != '>'
497 /* only recognise drive specifier at beginning */
499 /* handle the "/:d:foo" case correctly */
500 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
505 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
508 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
509 Sunhandled_file_name_directory
, 1, 1, 0,
510 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
511 A `directly usable' directory name is one that may be used without the
512 intervention of any file handler.
513 If FILENAME is a directly usable file itself, return
514 \(file-name-directory FILENAME).
515 The `call-process' and `start-process' functions use this function to
516 get a current directory to run processes in. */)
518 Lisp_Object filename
;
522 /* If the file name has special constructs in it,
523 call the corresponding file handler. */
524 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
526 return call2 (handler
, Qunhandled_file_name_directory
, filename
);
528 return Ffile_name_directory (filename
);
533 file_name_as_directory (out
, in
)
536 int size
= strlen (in
) - 1;
549 /* Is it already a directory string? */
550 if (in
[size
] == ':' || in
[size
] == ']' || in
[size
] == '>')
552 /* Is it a VMS directory file name? If so, hack VMS syntax. */
553 else if (! index (in
, '/')
554 && ((size
> 3 && ! strcmp (&in
[size
- 3], ".DIR"))
555 || (size
> 3 && ! strcmp (&in
[size
- 3], ".dir"))
556 || (size
> 5 && (! strncmp (&in
[size
- 5], ".DIR", 4)
557 || ! strncmp (&in
[size
- 5], ".dir", 4))
558 && (in
[size
- 1] == '.' || in
[size
- 1] == ';')
559 && in
[size
] == '1')))
561 register char *p
, *dot
;
565 dir:x.dir --> dir:[x]
566 dir:[x]y.dir --> dir:[x.y] */
568 while (p
!= in
&& *p
!= ':' && *p
!= '>' && *p
!= ']') p
--;
571 strncpy (out
, in
, p
- in
);
590 dot
= index (p
, '.');
593 /* blindly remove any extension */
594 size
= strlen (out
) + (dot
- p
);
595 strncat (out
, p
, dot
- p
);
606 /* For Unix syntax, Append a slash if necessary */
607 if (!IS_DIRECTORY_SEP (out
[size
]))
609 /* Cannot use DIRECTORY_SEP, which could have any value */
611 out
[size
+ 2] = '\0';
614 CORRECT_DIR_SEPS (out
);
620 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
621 Sfile_name_as_directory
, 1, 1, 0,
622 doc
: /* Return a string representing the file name FILE interpreted as a directory.
623 This operation exists because a directory is also a file, but its name as
624 a directory is different from its name as a file.
625 The result can be used as the value of `default-directory'
626 or passed as second argument to `expand-file-name'.
627 For a Unix-syntax file name, just appends a slash.
628 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc. */)
639 /* If the file name has special constructs in it,
640 call the corresponding file handler. */
641 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
643 return call2 (handler
, Qfile_name_as_directory
, file
);
645 buf
= (char *) alloca (SBYTES (file
) + 10);
646 file_name_as_directory (buf
, SDATA (file
));
647 return make_specified_string (buf
, -1, strlen (buf
),
648 STRING_MULTIBYTE (file
));
652 * Convert from directory name to filename.
654 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
655 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
656 * On UNIX, it's simple: just make sure there isn't a terminating /
658 * Value is nonzero if the string output is different from the input.
662 directory_file_name (src
, dst
)
670 struct FAB fab
= cc$rms_fab
;
671 struct NAM nam
= cc$rms_nam
;
672 char esa
[NAM$C_MAXRSS
];
677 if (! index (src
, '/')
678 && (src
[slen
- 1] == ']'
679 || src
[slen
- 1] == ':'
680 || src
[slen
- 1] == '>'))
682 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
684 fab
.fab$b_fns
= slen
;
685 fab
.fab$l_nam
= &nam
;
686 fab
.fab$l_fop
= FAB$M_NAM
;
689 nam
.nam$b_ess
= sizeof esa
;
690 nam
.nam$b_nop
|= NAM$M_SYNCHK
;
692 /* We call SYS$PARSE to handle such things as [--] for us. */
693 if (SYS$
PARSE (&fab
, 0, 0) == RMS$_NORMAL
)
695 slen
= nam
.nam$b_esl
;
696 if (esa
[slen
- 1] == ';' && esa
[slen
- 2] == '.')
701 if (src
[slen
- 1] != ']' && src
[slen
- 1] != '>')
703 /* what about when we have logical_name:???? */
704 if (src
[slen
- 1] == ':')
705 { /* Xlate logical name and see what we get */
706 ptr
= strcpy (dst
, src
); /* upper case for getenv */
709 if ('a' <= *ptr
&& *ptr
<= 'z')
713 dst
[slen
- 1] = 0; /* remove colon */
714 if (!(src
= egetenv (dst
)))
716 /* should we jump to the beginning of this procedure?
717 Good points: allows us to use logical names that xlate
719 Bad points: can be a problem if we just translated to a device
721 For now, I'll punt and always expect VMS names, and hope for
724 if (src
[slen
- 1] != ']' && src
[slen
- 1] != '>')
725 { /* no recursion here! */
731 { /* not a directory spec */
736 bracket
= src
[slen
- 1];
738 /* If bracket is ']' or '>', bracket - 2 is the corresponding
740 ptr
= index (src
, bracket
- 2);
742 { /* no opening bracket */
746 if (!(rptr
= rindex (src
, '.')))
749 strncpy (dst
, src
, slen
);
753 dst
[slen
++] = bracket
;
758 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
759 then translate the device and recurse. */
760 if (dst
[slen
- 1] == ':'
761 && dst
[slen
- 2] != ':' /* skip decnet nodes */
762 && strcmp (src
+ slen
, "[000000]") == 0)
764 dst
[slen
- 1] = '\0';
765 if ((ptr
= egetenv (dst
))
766 && (rlen
= strlen (ptr
) - 1) > 0
767 && (ptr
[rlen
] == ']' || ptr
[rlen
] == '>')
768 && ptr
[rlen
- 1] == '.')
770 char * buf
= (char *) alloca (strlen (ptr
) + 1);
774 return directory_file_name (buf
, dst
);
779 strcat (dst
, "[000000]");
783 rlen
= strlen (rptr
) - 1;
784 strncat (dst
, rptr
, rlen
);
785 dst
[slen
+ rlen
] = '\0';
786 strcat (dst
, ".DIR.1");
790 /* Process as Unix format: just remove any final slash.
791 But leave "/" unchanged; do not change it to "". */
794 /* Handle // as root for apollo's. */
795 if ((slen
> 2 && dst
[slen
- 1] == '/')
796 || (slen
> 1 && dst
[0] != '/' && dst
[slen
- 1] == '/'))
800 && IS_DIRECTORY_SEP (dst
[slen
- 1])
802 && !IS_ANY_SEP (dst
[slen
- 2])
808 CORRECT_DIR_SEPS (dst
);
813 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
815 doc
: /* Returns the file name of the directory named DIRECTORY.
816 This is the name of the file that holds the data for the directory DIRECTORY.
817 This operation exists because a directory is also a file, but its name as
818 a directory is different from its name as a file.
819 In Unix-syntax, this function just removes the final slash.
820 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
821 it returns a file name such as \"[X]Y.DIR.1\". */)
823 Lisp_Object directory
;
828 CHECK_STRING (directory
);
830 if (NILP (directory
))
833 /* If the file name has special constructs in it,
834 call the corresponding file handler. */
835 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
837 return call2 (handler
, Qdirectory_file_name
, directory
);
840 /* 20 extra chars is insufficient for VMS, since we might perform a
841 logical name translation. an equivalence string can be up to 255
842 chars long, so grab that much extra space... - sss */
843 buf
= (char *) alloca (SBYTES (directory
) + 20 + 255);
845 buf
= (char *) alloca (SBYTES (directory
) + 20);
847 directory_file_name (SDATA (directory
), buf
);
848 return make_specified_string (buf
, -1, strlen (buf
),
849 STRING_MULTIBYTE (directory
));
852 static char make_temp_name_tbl
[64] =
854 'A','B','C','D','E','F','G','H',
855 'I','J','K','L','M','N','O','P',
856 'Q','R','S','T','U','V','W','X',
857 'Y','Z','a','b','c','d','e','f',
858 'g','h','i','j','k','l','m','n',
859 'o','p','q','r','s','t','u','v',
860 'w','x','y','z','0','1','2','3',
861 '4','5','6','7','8','9','-','_'
864 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
866 /* Value is a temporary file name starting with PREFIX, a string.
868 The Emacs process number forms part of the result, so there is
869 no danger of generating a name being used by another process.
870 In addition, this function makes an attempt to choose a name
871 which has no existing file. To make this work, PREFIX should be
872 an absolute file name.
874 BASE64_P non-zero means add the pid as 3 characters in base64
875 encoding. In this case, 6 characters will be added to PREFIX to
876 form the file name. Otherwise, if Emacs is running on a system
877 with long file names, add the pid as a decimal number.
879 This function signals an error if no unique file name could be
883 make_temp_name (prefix
, base64_p
)
890 unsigned char *p
, *data
;
894 CHECK_STRING (prefix
);
896 /* VAL is created by adding 6 characters to PREFIX. The first
897 three are the PID of this process, in base 64, and the second
898 three are incremented if the file already exists. This ensures
899 262144 unique file names per PID per PREFIX. */
901 pid
= (int) getpid ();
905 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
906 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
907 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
912 #ifdef HAVE_LONG_FILE_NAMES
913 sprintf (pidbuf
, "%d", pid
);
914 pidlen
= strlen (pidbuf
);
916 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
917 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
918 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
923 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
924 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
925 if (!STRING_MULTIBYTE (prefix
))
926 STRING_SET_UNIBYTE (val
);
928 bcopy(SDATA (prefix
), data
, len
);
931 bcopy (pidbuf
, p
, pidlen
);
934 /* Here we try to minimize useless stat'ing when this function is
935 invoked many times successively with the same PREFIX. We achieve
936 this by initializing count to a random value, and incrementing it
939 We don't want make-temp-name to be called while dumping,
940 because then make_temp_name_count_initialized_p would get set
941 and then make_temp_name_count would not be set when Emacs starts. */
943 if (!make_temp_name_count_initialized_p
)
945 make_temp_name_count
= (unsigned) time (NULL
);
946 make_temp_name_count_initialized_p
= 1;
952 unsigned num
= make_temp_name_count
;
954 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
955 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
956 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
958 /* Poor man's congruential RN generator. Replace with
959 ++make_temp_name_count for debugging. */
960 make_temp_name_count
+= 25229;
961 make_temp_name_count
%= 225307;
963 if (stat (data
, &ignored
) < 0)
965 /* We want to return only if errno is ENOENT. */
969 /* The error here is dubious, but there is little else we
970 can do. The alternatives are to return nil, which is
971 as bad as (and in many cases worse than) throwing the
972 error, or to ignore the error, which will likely result
973 in looping through 225307 stat's, which is not only
974 dog-slow, but also useless since it will fallback to
975 the errow below, anyway. */
976 report_file_error ("Cannot create temporary name for prefix",
977 Fcons (prefix
, Qnil
));
982 error ("Cannot create temporary name for prefix `%s'",
988 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
989 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
990 The Emacs process number forms part of the result,
991 so there is no danger of generating a name being used by another process.
993 In addition, this function makes an attempt to choose a name
994 which has no existing file. To make this work,
995 PREFIX should be an absolute file name.
997 There is a race condition between calling `make-temp-name' and creating the
998 file which opens all kinds of security holes. For that reason, you should
999 probably use `make-temp-file' instead, except in three circumstances:
1001 * If you are creating the file in the user's home directory.
1002 * If you are creating a directory rather than an ordinary file.
1003 * If you are taking special precautions as `make-temp-file' does. */)
1007 return make_temp_name (prefix
, 0);
1012 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1013 doc
: /* Convert filename NAME to absolute, and canonicalize it.
1014 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1015 (does not start with slash); if DEFAULT-DIRECTORY is nil or missing,
1016 the current buffer's value of default-directory is used.
1017 File name components that are `.' are removed, and
1018 so are file name components followed by `..', along with the `..' itself;
1019 note that these simplifications are done without checking the resulting
1020 file names in the file system.
1021 An initial `~/' expands to your home directory.
1022 An initial `~USER/' expands to USER's home directory.
1023 See also the function `substitute-in-file-name'. */)
1024 (name
, default_directory
)
1025 Lisp_Object name
, default_directory
;
1029 register unsigned char *newdir
, *p
, *o
;
1031 unsigned char *target
;
1034 unsigned char * colon
= 0;
1035 unsigned char * close
= 0;
1036 unsigned char * slash
= 0;
1037 unsigned char * brack
= 0;
1038 int lbrack
= 0, rbrack
= 0;
1043 int collapse_newdir
= 1;
1047 Lisp_Object handler
, result
;
1049 CHECK_STRING (name
);
1051 /* If the file name has special constructs in it,
1052 call the corresponding file handler. */
1053 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
1054 if (!NILP (handler
))
1055 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
1057 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
1058 if (NILP (default_directory
))
1059 default_directory
= current_buffer
->directory
;
1060 if (! STRINGP (default_directory
))
1063 /* "/" is not considered a root directory on DOS_NT, so using "/"
1064 here causes an infinite recursion in, e.g., the following:
1066 (let (default-directory)
1067 (expand-file-name "a"))
1069 To avoid this, we set default_directory to the root of the
1071 extern char *emacs_root_dir (void);
1073 default_directory
= build_string (emacs_root_dir ());
1075 default_directory
= build_string ("/");
1079 if (!NILP (default_directory
))
1081 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
1082 if (!NILP (handler
))
1083 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
1086 o
= SDATA (default_directory
);
1088 /* Make sure DEFAULT_DIRECTORY is properly expanded.
1089 It would be better to do this down below where we actually use
1090 default_directory. Unfortunately, calling Fexpand_file_name recursively
1091 could invoke GC, and the strings might be relocated. This would
1092 be annoying because we have pointers into strings lying around
1093 that would need adjusting, and people would add new pointers to
1094 the code and forget to adjust them, resulting in intermittent bugs.
1095 Putting this call here avoids all that crud.
1097 The EQ test avoids infinite recursion. */
1098 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
1099 /* Save time in some common cases - as long as default_directory
1100 is not relative, it can be canonicalized with name below (if it
1101 is needed at all) without requiring it to be expanded now. */
1103 /* Detect MSDOS file names with drive specifiers. */
1104 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1]) && IS_DIRECTORY_SEP (o
[2]))
1106 /* Detect Windows file names in UNC format. */
1107 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
1109 #else /* not DOS_NT */
1110 /* Detect Unix absolute file names (/... alone is not absolute on
1112 && ! (IS_DIRECTORY_SEP (o
[0]))
1113 #endif /* not DOS_NT */
1116 struct gcpro gcpro1
;
1119 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
1124 /* Filenames on VMS are always upper case. */
1125 name
= Fupcase (name
);
1127 #ifdef FILE_SYSTEM_CASE
1128 name
= FILE_SYSTEM_CASE (name
);
1134 /* We will force directory separators to be either all \ or /, so make
1135 a local copy to modify, even if there ends up being no change. */
1136 nm
= strcpy (alloca (strlen (nm
) + 1), nm
);
1138 /* Note if special escape prefix is present, but remove for now. */
1139 if (nm
[0] == '/' && nm
[1] == ':')
1145 /* Find and remove drive specifier if present; this makes nm absolute
1146 even if the rest of the name appears to be relative. Only look for
1147 drive specifier at the beginning. */
1148 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
1155 /* If we see "c://somedir", we want to strip the first slash after the
1156 colon when stripping the drive letter. Otherwise, this expands to
1158 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1160 #endif /* WINDOWSNT */
1164 /* Discard any previous drive specifier if nm is now in UNC format. */
1165 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1171 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1172 none are found, we can probably return right away. We will avoid
1173 allocating a new string if name is already fully expanded. */
1175 IS_DIRECTORY_SEP (nm
[0])
1177 && drive
&& !is_escaped
1180 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
1187 /* If it turns out that the filename we want to return is just a
1188 suffix of FILENAME, we don't need to go through and edit
1189 things; we just need to construct a new string using data
1190 starting at the middle of FILENAME. If we set lose to a
1191 non-zero value, that means we've discovered that we can't do
1198 /* Since we know the name is absolute, we can assume that each
1199 element starts with a "/". */
1201 /* "." and ".." are hairy. */
1202 if (IS_DIRECTORY_SEP (p
[0])
1204 && (IS_DIRECTORY_SEP (p
[2])
1206 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1209 /* We want to replace multiple `/' in a row with a single
1212 && IS_DIRECTORY_SEP (p
[0])
1213 && IS_DIRECTORY_SEP (p
[1]))
1220 /* if dev:[dir]/, move nm to / */
1221 if (!slash
&& p
> nm
&& (brack
|| colon
)) {
1222 nm
= (brack
? brack
+ 1 : colon
+ 1);
1223 lbrack
= rbrack
= 0;
1231 /* VMS pre V4.4,convert '-'s in filenames. */
1232 if (lbrack
== rbrack
)
1234 if (dots
< 2) /* this is to allow negative version numbers */
1239 if (lbrack
> rbrack
&&
1240 ((p
[-1] == '.' || p
[-1] == '[' || p
[-1] == '<') &&
1241 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>')))
1247 /* count open brackets, reset close bracket pointer */
1248 if (p
[0] == '[' || p
[0] == '<')
1249 lbrack
++, brack
= 0;
1250 /* count close brackets, set close bracket pointer */
1251 if (p
[0] == ']' || p
[0] == '>')
1252 rbrack
++, brack
= p
;
1253 /* detect ][ or >< */
1254 if ((p
[0] == ']' || p
[0] == '>') && (p
[1] == '[' || p
[1] == '<'))
1256 if ((p
[0] == ':' || p
[0] == ']' || p
[0] == '>') && p
[1] == '~')
1257 nm
= p
+ 1, lose
= 1;
1258 if (p
[0] == ':' && (colon
|| slash
))
1259 /* if dev1:[dir]dev2:, move nm to dev2: */
1265 /* if /name/dev:, move nm to dev: */
1268 /* if node::dev:, move colon following dev */
1269 else if (colon
&& colon
[-1] == ':')
1271 /* if dev1:dev2:, move nm to dev2: */
1272 else if (colon
&& colon
[-1] != ':')
1277 if (p
[0] == ':' && !colon
)
1283 if (lbrack
== rbrack
)
1286 else if (p
[0] == '.')
1294 if (index (nm
, '/'))
1296 nm
= sys_translate_unix (nm
);
1297 return make_specified_string (nm
, -1, strlen (nm
),
1298 STRING_MULTIBYTE (name
));
1302 /* Make sure directories are all separated with / or \ as
1303 desired, but avoid allocation of a new string when not
1305 CORRECT_DIR_SEPS (nm
);
1307 if (IS_DIRECTORY_SEP (nm
[1]))
1309 if (strcmp (nm
, SDATA (name
)) != 0)
1310 name
= make_specified_string (nm
, -1, strlen (nm
),
1311 STRING_MULTIBYTE (name
));
1315 /* drive must be set, so this is okay */
1316 if (strcmp (nm
- 2, SDATA (name
)) != 0)
1320 name
= make_specified_string (nm
, -1, p
- nm
,
1321 STRING_MULTIBYTE (name
));
1322 temp
[0] = DRIVE_LETTER (drive
);
1323 name
= concat2 (build_string (temp
), name
);
1326 #else /* not DOS_NT */
1327 if (nm
== SDATA (name
))
1329 return make_specified_string (nm
, -1, strlen (nm
),
1330 STRING_MULTIBYTE (name
));
1331 #endif /* not DOS_NT */
1335 /* At this point, nm might or might not be an absolute file name. We
1336 need to expand ~ or ~user if present, otherwise prefix nm with
1337 default_directory if nm is not absolute, and finally collapse /./
1338 and /foo/../ sequences.
1340 We set newdir to be the appropriate prefix if one is needed:
1341 - the relevant user directory if nm starts with ~ or ~user
1342 - the specified drive's working dir (DOS/NT only) if nm does not
1344 - the value of default_directory.
1346 Note that these prefixes are not guaranteed to be absolute (except
1347 for the working dir of a drive). Therefore, to ensure we always
1348 return an absolute name, if the final prefix is not absolute we
1349 append it to the current working directory. */
1353 if (nm
[0] == '~') /* prefix ~ */
1355 if (IS_DIRECTORY_SEP (nm
[1])
1359 || nm
[1] == 0) /* ~ by itself */
1361 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1362 newdir
= (unsigned char *) "";
1365 collapse_newdir
= 0;
1368 nm
++; /* Don't leave the slash in nm. */
1371 else /* ~user/filename */
1373 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)
1378 o
= (unsigned char *) alloca (p
- nm
+ 1);
1379 bcopy ((char *) nm
, o
, p
- nm
);
1382 pw
= (struct passwd
*) getpwnam (o
+ 1);
1385 newdir
= (unsigned char *) pw
-> pw_dir
;
1387 nm
= p
+ 1; /* skip the terminator */
1391 collapse_newdir
= 0;
1396 /* If we don't find a user of that name, leave the name
1397 unchanged; don't move nm forward to p. */
1402 /* On DOS and Windows, nm is absolute if a drive name was specified;
1403 use the drive's current directory as the prefix if needed. */
1404 if (!newdir
&& drive
)
1406 /* Get default directory if needed to make nm absolute. */
1407 if (!IS_DIRECTORY_SEP (nm
[0]))
1409 newdir
= alloca (MAXPATHLEN
+ 1);
1410 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1415 /* Either nm starts with /, or drive isn't mounted. */
1416 newdir
= alloca (4);
1417 newdir
[0] = DRIVE_LETTER (drive
);
1425 /* Finally, if no prefix has been specified and nm is not absolute,
1426 then it must be expanded relative to default_directory. */
1430 /* /... alone is not absolute on DOS and Windows. */
1431 && !IS_DIRECTORY_SEP (nm
[0])
1434 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1441 newdir
= SDATA (default_directory
);
1443 /* Note if special escape prefix is present, but remove for now. */
1444 if (newdir
[0] == '/' && newdir
[1] == ':')
1455 /* First ensure newdir is an absolute name. */
1457 /* Detect MSDOS file names with drive specifiers. */
1458 ! (IS_DRIVE (newdir
[0])
1459 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1461 /* Detect Windows file names in UNC format. */
1462 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1466 /* Effectively, let newdir be (expand-file-name newdir cwd).
1467 Because of the admonition against calling expand-file-name
1468 when we have pointers into lisp strings, we accomplish this
1469 indirectly by prepending newdir to nm if necessary, and using
1470 cwd (or the wd of newdir's drive) as the new newdir. */
1472 if (IS_DRIVE (newdir
[0]) && newdir
[1] == ':')
1477 if (!IS_DIRECTORY_SEP (nm
[0]))
1479 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1480 file_name_as_directory (tmp
, newdir
);
1484 newdir
= alloca (MAXPATHLEN
+ 1);
1487 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1494 /* Strip off drive name from prefix, if present. */
1495 if (IS_DRIVE (newdir
[0]) && newdir
[1] == ':')
1501 /* Keep only a prefix from newdir if nm starts with slash
1502 (//server/share for UNC, nothing otherwise). */
1503 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1506 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1508 newdir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1510 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1512 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1524 /* Get rid of any slash at the end of newdir, unless newdir is
1525 just / or // (an incomplete UNC name). */
1526 length
= strlen (newdir
);
1527 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1529 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1533 unsigned char *temp
= (unsigned char *) alloca (length
);
1534 bcopy (newdir
, temp
, length
- 1);
1535 temp
[length
- 1] = 0;
1543 /* Now concatenate the directory and name to new space in the stack frame */
1544 tlen
+= strlen (nm
) + 1;
1546 /* Reserve space for drive specifier and escape prefix, since either
1547 or both may need to be inserted. (The Microsoft x86 compiler
1548 produces incorrect code if the following two lines are combined.) */
1549 target
= (unsigned char *) alloca (tlen
+ 4);
1551 #else /* not DOS_NT */
1552 target
= (unsigned char *) alloca (tlen
);
1553 #endif /* not DOS_NT */
1559 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1562 /* If newdir is effectively "C:/", then the drive letter will have
1563 been stripped and newdir will be "/". Concatenating with an
1564 absolute directory in nm produces "//", which will then be
1565 incorrectly treated as a network share. Ignore newdir in
1566 this case (keeping the drive letter). */
1567 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1568 && newdir
[1] == '\0'))
1570 strcpy (target
, newdir
);
1574 file_name_as_directory (target
, newdir
);
1577 strcat (target
, nm
);
1579 if (index (target
, '/'))
1580 strcpy (target
, sys_translate_unix (target
));
1583 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1585 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1594 if (*p
!= ']' && *p
!= '>' && *p
!= '-')
1600 else if ((p
[0] == ']' || p
[0] == '>') && p
[0] == p
[1] + 2)
1601 /* brackets are offset from each other by 2 */
1604 if (*p
!= '.' && *p
!= '-' && o
[-1] != '.')
1605 /* convert [foo][bar] to [bar] */
1606 while (o
[-1] != '[' && o
[-1] != '<')
1608 else if (*p
== '-' && *o
!= '.')
1611 else if (p
[0] == '-' && o
[-1] == '.' &&
1612 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>'))
1613 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1617 while (o
[-1] != '.' && o
[-1] != '[' && o
[-1] != '<');
1618 if (p
[1] == '.') /* foo.-.bar ==> bar. */
1620 else if (o
[-1] == '.') /* '.foo.-]' ==> ']' */
1622 /* else [foo.-] ==> [-] */
1628 o
[-1] != '[' && o
[-1] != '<' && o
[-1] != '.' &&
1629 p
[1] != ']' && p
[1] != '>' && p
[1] != '.')
1635 if (!IS_DIRECTORY_SEP (*p
))
1639 else if (IS_DIRECTORY_SEP (p
[0])
1641 && (IS_DIRECTORY_SEP (p
[2])
1644 /* If "/." is the entire filename, keep the "/". Otherwise,
1645 just delete the whole "/.". */
1646 if (o
== target
&& p
[2] == '\0')
1650 else if (IS_DIRECTORY_SEP (p
[0]) && p
[1] == '.' && p
[2] == '.'
1651 /* `/../' is the "superroot" on certain file systems. */
1653 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1655 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1657 /* Keep initial / only if this is the whole name. */
1658 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1663 && IS_DIRECTORY_SEP (p
[0]) && IS_DIRECTORY_SEP (p
[1]))
1665 /* Collapse multiple `/' in a row. */
1667 while (IS_DIRECTORY_SEP (*p
))
1674 #endif /* not VMS */
1678 /* At last, set drive name. */
1680 /* Except for network file name. */
1681 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1682 #endif /* WINDOWSNT */
1684 if (!drive
) abort ();
1686 target
[0] = DRIVE_LETTER (drive
);
1689 /* Reinsert the escape prefix if required. */
1696 CORRECT_DIR_SEPS (target
);
1699 result
= make_specified_string (target
, -1, o
- target
,
1700 STRING_MULTIBYTE (name
));
1702 /* Again look to see if the file name has special constructs in it
1703 and perhaps call the corresponding file handler. This is needed
1704 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1705 the ".." component gives us "/user@host:/bar/../baz" which needs
1706 to be expanded again. */
1707 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1708 if (!NILP (handler
))
1709 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1715 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1716 This is the old version of expand-file-name, before it was thoroughly
1717 rewritten for Emacs 10.31. We leave this version here commented-out,
1718 because the code is very complex and likely to have subtle bugs. If
1719 bugs _are_ found, it might be of interest to look at the old code and
1720 see what did it do in the relevant situation.
1722 Don't remove this code: it's true that it will be accessible via CVS,
1723 but a few years from deletion, people will forget it is there. */
1725 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1726 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1727 "Convert FILENAME to absolute, and canonicalize it.\n\
1728 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1729 (does not start with slash); if DEFAULT is nil or missing,\n\
1730 the current buffer's value of default-directory is used.\n\
1731 Filenames containing `.' or `..' as components are simplified;\n\
1732 initial `~/' expands to your home directory.\n\
1733 See also the function `substitute-in-file-name'.")
1735 Lisp_Object name
, defalt
;
1739 register unsigned char *newdir
, *p
, *o
;
1741 unsigned char *target
;
1745 unsigned char * colon
= 0;
1746 unsigned char * close
= 0;
1747 unsigned char * slash
= 0;
1748 unsigned char * brack
= 0;
1749 int lbrack
= 0, rbrack
= 0;
1753 CHECK_STRING (name
);
1756 /* Filenames on VMS are always upper case. */
1757 name
= Fupcase (name
);
1762 /* If nm is absolute, flush ...// and detect /./ and /../.
1763 If no /./ or /../ we can return right away. */
1775 if (p
[0] == '/' && p
[1] == '/'
1777 /* // at start of filename is meaningful on Apollo system. */
1782 if (p
[0] == '/' && p
[1] == '~')
1783 nm
= p
+ 1, lose
= 1;
1784 if (p
[0] == '/' && p
[1] == '.'
1785 && (p
[2] == '/' || p
[2] == 0
1786 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1792 /* if dev:[dir]/, move nm to / */
1793 if (!slash
&& p
> nm
&& (brack
|| colon
)) {
1794 nm
= (brack
? brack
+ 1 : colon
+ 1);
1795 lbrack
= rbrack
= 0;
1803 /* VMS pre V4.4,convert '-'s in filenames. */
1804 if (lbrack
== rbrack
)
1806 if (dots
< 2) /* this is to allow negative version numbers */
1811 if (lbrack
> rbrack
&&
1812 ((p
[-1] == '.' || p
[-1] == '[' || p
[-1] == '<') &&
1813 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>')))
1819 /* count open brackets, reset close bracket pointer */
1820 if (p
[0] == '[' || p
[0] == '<')
1821 lbrack
++, brack
= 0;
1822 /* count close brackets, set close bracket pointer */
1823 if (p
[0] == ']' || p
[0] == '>')
1824 rbrack
++, brack
= p
;
1825 /* detect ][ or >< */
1826 if ((p
[0] == ']' || p
[0] == '>') && (p
[1] == '[' || p
[1] == '<'))
1828 if ((p
[0] == ':' || p
[0] == ']' || p
[0] == '>') && p
[1] == '~')
1829 nm
= p
+ 1, lose
= 1;
1830 if (p
[0] == ':' && (colon
|| slash
))
1831 /* if dev1:[dir]dev2:, move nm to dev2: */
1837 /* If /name/dev:, move nm to dev: */
1840 /* If node::dev:, move colon following dev */
1841 else if (colon
&& colon
[-1] == ':')
1843 /* If dev1:dev2:, move nm to dev2: */
1844 else if (colon
&& colon
[-1] != ':')
1849 if (p
[0] == ':' && !colon
)
1855 if (lbrack
== rbrack
)
1858 else if (p
[0] == '.')
1866 if (index (nm
, '/'))
1867 return build_string (sys_translate_unix (nm
));
1869 if (nm
== SDATA (name
))
1871 return build_string (nm
);
1875 /* Now determine directory to start with and put it in NEWDIR */
1879 if (nm
[0] == '~') /* prefix ~ */
1884 || nm
[1] == 0)/* ~/filename */
1886 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1887 newdir
= (unsigned char *) "";
1890 nm
++; /* Don't leave the slash in nm. */
1893 else /* ~user/filename */
1895 /* Get past ~ to user */
1896 unsigned char *user
= nm
+ 1;
1897 /* Find end of name. */
1898 unsigned char *ptr
= (unsigned char *) index (user
, '/');
1899 int len
= ptr
? ptr
- user
: strlen (user
);
1901 unsigned char *ptr1
= index (user
, ':');
1902 if (ptr1
!= 0 && ptr1
- user
< len
)
1905 /* Copy the user name into temp storage. */
1906 o
= (unsigned char *) alloca (len
+ 1);
1907 bcopy ((char *) user
, o
, len
);
1910 /* Look up the user name. */
1911 pw
= (struct passwd
*) getpwnam (o
+ 1);
1913 error ("\"%s\" isn't a registered user", o
+ 1);
1915 newdir
= (unsigned char *) pw
->pw_dir
;
1917 /* Discard the user name from NM. */
1924 #endif /* not VMS */
1928 defalt
= current_buffer
->directory
;
1929 CHECK_STRING (defalt
);
1930 newdir
= SDATA (defalt
);
1933 /* Now concatenate the directory and name to new space in the stack frame */
1935 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1936 target
= (unsigned char *) alloca (tlen
);
1942 if (nm
[0] == 0 || nm
[0] == '/')
1943 strcpy (target
, newdir
);
1946 file_name_as_directory (target
, newdir
);
1949 strcat (target
, nm
);
1951 if (index (target
, '/'))
1952 strcpy (target
, sys_translate_unix (target
));
1955 /* Now canonicalize by removing /. and /foo/.. if they appear */
1963 if (*p
!= ']' && *p
!= '>' && *p
!= '-')
1969 else if ((p
[0] == ']' || p
[0] == '>') && p
[0] == p
[1] + 2)
1970 /* brackets are offset from each other by 2 */
1973 if (*p
!= '.' && *p
!= '-' && o
[-1] != '.')
1974 /* convert [foo][bar] to [bar] */
1975 while (o
[-1] != '[' && o
[-1] != '<')
1977 else if (*p
== '-' && *o
!= '.')
1980 else if (p
[0] == '-' && o
[-1] == '.' &&
1981 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>'))
1982 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1986 while (o
[-1] != '.' && o
[-1] != '[' && o
[-1] != '<');
1987 if (p
[1] == '.') /* foo.-.bar ==> bar. */
1989 else if (o
[-1] == '.') /* '.foo.-]' ==> ']' */
1991 /* else [foo.-] ==> [-] */
1997 o
[-1] != '[' && o
[-1] != '<' && o
[-1] != '.' &&
1998 p
[1] != ']' && p
[1] != '>' && p
[1] != '.')
2008 else if (!strncmp (p
, "//", 2)
2010 /* // at start of filename is meaningful in Apollo system. */
2018 else if (p
[0] == '/' && p
[1] == '.' &&
2019 (p
[2] == '/' || p
[2] == 0))
2021 else if (!strncmp (p
, "/..", 3)
2022 /* `/../' is the "superroot" on certain file systems. */
2024 && (p
[3] == '/' || p
[3] == 0))
2026 while (o
!= target
&& *--o
!= '/')
2029 if (o
== target
+ 1 && o
[-1] == '/' && o
[0] == '/')
2033 if (o
== target
&& *o
== '/')
2041 #endif /* not VMS */
2044 return make_string (target
, o
- target
);
2048 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
2049 Ssubstitute_in_file_name
, 1, 1, 0,
2050 doc
: /* Substitute environment variables referred to in FILENAME.
2051 `$FOO' where FOO is an environment variable name means to substitute
2052 the value of that variable. The variable name should be terminated
2053 with a character not a letter, digit or underscore; otherwise, enclose
2054 the entire variable name in braces.
2055 If `/~' appears, all of FILENAME through that `/' is discarded.
2057 On VMS, `$' substitution is not done; this function does little and only
2058 duplicates what `expand-file-name' does. */)
2060 Lisp_Object filename
;
2064 register unsigned char *s
, *p
, *o
, *x
, *endp
;
2065 unsigned char *target
= NULL
;
2067 int substituted
= 0;
2070 Lisp_Object handler
;
2072 CHECK_STRING (filename
);
2074 /* If the file name has special constructs in it,
2075 call the corresponding file handler. */
2076 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
2077 if (!NILP (handler
))
2078 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
2080 nm
= SDATA (filename
);
2082 nm
= strcpy (alloca (strlen (nm
) + 1), nm
);
2083 CORRECT_DIR_SEPS (nm
);
2084 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
2086 endp
= nm
+ SBYTES (filename
);
2088 /* If /~ or // appears, discard everything through first slash. */
2090 for (p
= nm
; p
!= endp
; p
++)
2093 #if defined (APOLLO) || defined (WINDOWSNT) || defined(CYGWIN)
2094 /* // at start of file name is meaningful in Apollo,
2095 WindowsNT and Cygwin systems. */
2096 || (IS_DIRECTORY_SEP (p
[0]) && p
- 1 != nm
)
2097 #else /* not (APOLLO || WINDOWSNT || CYGWIN) */
2098 || IS_DIRECTORY_SEP (p
[0])
2099 #endif /* not (APOLLO || WINDOWSNT || CYGWIN) */
2104 || p
[-1] == ':' || p
[-1] == ']' || p
[-1] == '>'
2106 || IS_DIRECTORY_SEP (p
[-1])))
2108 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)
2113 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
2115 o
= (unsigned char *) alloca (s
- p
+ 1);
2116 bcopy ((char *) p
, o
, s
- p
);
2119 pw
= (struct passwd
*) getpwnam (o
+ 1);
2121 /* If we have ~/ or ~user and `user' exists, discard
2122 everything up to ~. But if `user' does not exist, leave
2123 ~user alone, it might be a literal file name. */
2124 if (IS_DIRECTORY_SEP (p
[0]) || s
== p
+ 1 || pw
)
2131 /* see comment in expand-file-name about drive specifiers */
2132 else if (IS_DRIVE (p
[0]) && p
[1] == ':'
2133 && p
> nm
&& IS_DIRECTORY_SEP (p
[-1]))
2142 return make_specified_string (nm
, -1, strlen (nm
),
2143 STRING_MULTIBYTE (filename
));
2146 /* See if any variables are substituted into the string
2147 and find the total length of their values in `total' */
2149 for (p
= nm
; p
!= endp
;)
2159 /* "$$" means a single "$" */
2168 while (p
!= endp
&& *p
!= '}') p
++;
2169 if (*p
!= '}') goto missingclose
;
2175 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
2179 /* Copy out the variable name */
2180 target
= (unsigned char *) alloca (s
- o
+ 1);
2181 strncpy (target
, o
, s
- o
);
2184 strupr (target
); /* $home == $HOME etc. */
2187 /* Get variable value */
2188 o
= (unsigned char *) egetenv (target
);
2191 total
+= strlen (o
);
2201 /* If substitution required, recopy the string and do it */
2202 /* Make space in stack frame for the new copy */
2203 xnm
= (unsigned char *) alloca (SBYTES (filename
) + total
+ 1);
2206 /* Copy the rest of the name through, replacing $ constructs with values */
2223 while (p
!= endp
&& *p
!= '}') p
++;
2224 if (*p
!= '}') goto missingclose
;
2230 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
2234 /* Copy out the variable name */
2235 target
= (unsigned char *) alloca (s
- o
+ 1);
2236 strncpy (target
, o
, s
- o
);
2239 strupr (target
); /* $home == $HOME etc. */
2242 /* Get variable value */
2243 o
= (unsigned char *) egetenv (target
);
2247 strcpy (x
, target
); x
+= strlen (target
);
2249 else if (STRING_MULTIBYTE (filename
))
2251 /* If the original string is multibyte,
2252 convert what we substitute into multibyte. */
2255 int c
= unibyte_char_to_multibyte (*o
++);
2256 x
+= CHAR_STRING (c
, x
);
2268 /* If /~ or // appears, discard everything through first slash. */
2270 for (p
= xnm
; p
!= x
; p
++)
2272 #if defined (APOLLO) || defined (WINDOWSNT) || defined(CYGWIN)
2273 || (IS_DIRECTORY_SEP (p
[0]) && p
- 1 != xnm
)
2274 #else /* not (APOLLO || WINDOWSNT || CYGWIN) */
2275 || IS_DIRECTORY_SEP (p
[0])
2276 #endif /* not (APOLLO || WINDOWSNT || CYGWIN) */
2278 && p
!= xnm
&& IS_DIRECTORY_SEP (p
[-1]))
2281 else if (IS_DRIVE (p
[0]) && p
[1] == ':'
2282 && p
> xnm
&& IS_DIRECTORY_SEP (p
[-1]))
2286 return make_specified_string (xnm
, -1, x
- xnm
, STRING_MULTIBYTE (filename
));
2289 error ("Bad format environment-variable substitution");
2291 error ("Missing \"}\" in environment-variable substitution");
2293 error ("Substituting nonexistent environment variable \"%s\"", target
);
2296 #endif /* not VMS */
2300 /* A slightly faster and more convenient way to get
2301 (directory-file-name (expand-file-name FOO)). */
2304 expand_and_dir_to_file (filename
, defdir
)
2305 Lisp_Object filename
, defdir
;
2307 register Lisp_Object absname
;
2309 absname
= Fexpand_file_name (filename
, defdir
);
2312 register int c
= SREF (absname
, SBYTES (absname
) - 1);
2313 if (c
== ':' || c
== ']' || c
== '>')
2314 absname
= Fdirectory_file_name (absname
);
2317 /* Remove final slash, if any (unless this is the root dir).
2318 stat behaves differently depending! */
2319 if (SCHARS (absname
) > 1
2320 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
2321 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
2322 /* We cannot take shortcuts; they might be wrong for magic file names. */
2323 absname
= Fdirectory_file_name (absname
);
2328 /* Signal an error if the file ABSNAME already exists.
2329 If INTERACTIVE is nonzero, ask the user whether to proceed,
2330 and bypass the error if the user says to go ahead.
2331 QUERYSTRING is a name for the action that is being considered
2334 *STATPTR is used to store the stat information if the file exists.
2335 If the file does not exist, STATPTR->st_mode is set to 0.
2336 If STATPTR is null, we don't store into it.
2338 If QUICK is nonzero, we ask for y or n, not yes or no. */
2341 barf_or_query_if_file_exists (absname
, querystring
, interactive
, statptr
, quick
)
2342 Lisp_Object absname
;
2343 unsigned char *querystring
;
2345 struct stat
*statptr
;
2348 register Lisp_Object tem
, encoded_filename
;
2349 struct stat statbuf
;
2350 struct gcpro gcpro1
;
2352 encoded_filename
= ENCODE_FILE (absname
);
2354 /* stat is a good way to tell whether the file exists,
2355 regardless of what access permissions it has. */
2356 if (lstat (SDATA (encoded_filename
), &statbuf
) >= 0)
2359 Fsignal (Qfile_already_exists
,
2360 Fcons (build_string ("File already exists"),
2361 Fcons (absname
, Qnil
)));
2363 tem
= format2 ("File %s already exists; %s anyway? ",
2364 absname
, build_string (querystring
));
2366 tem
= Fy_or_n_p (tem
);
2368 tem
= do_yes_or_no_p (tem
);
2371 Fsignal (Qfile_already_exists
,
2372 Fcons (build_string ("File already exists"),
2373 Fcons (absname
, Qnil
)));
2380 statptr
->st_mode
= 0;
2385 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 4,
2386 "fCopy file: \nFCopy %s to file: \np\nP",
2387 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
2388 If NEWNAME names a directory, copy FILE there.
2389 Signals a `file-already-exists' error if file NEWNAME already exists,
2390 unless a third argument OK-IF-ALREADY-EXISTS is supplied and non-nil.
2391 A number as third arg means request confirmation if NEWNAME already exists.
2392 This is what happens in interactive use with M-x.
2393 Fourth arg KEEP-TIME non-nil means give the new file the same
2394 last-modified time as the old one. (This works on only some systems.)
2395 A prefix arg makes KEEP-TIME non-nil.
2396 Also set the file modes of the target file to match the source file. */)
2397 (file
, newname
, ok_if_already_exists
, keep_time
)
2398 Lisp_Object file
, newname
, ok_if_already_exists
, keep_time
;
2401 char buf
[16 * 1024];
2402 struct stat st
, out_st
;
2403 Lisp_Object handler
;
2404 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2405 int count
= SPECPDL_INDEX ();
2406 int input_file_statable_p
;
2407 Lisp_Object encoded_file
, encoded_newname
;
2409 encoded_file
= encoded_newname
= Qnil
;
2410 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2411 CHECK_STRING (file
);
2412 CHECK_STRING (newname
);
2414 if (!NILP (Ffile_directory_p (newname
)))
2415 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2417 newname
= Fexpand_file_name (newname
, Qnil
);
2419 file
= Fexpand_file_name (file
, Qnil
);
2421 /* If the input file name has special constructs in it,
2422 call the corresponding file handler. */
2423 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
2424 /* Likewise for output file name. */
2426 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
2427 if (!NILP (handler
))
2428 RETURN_UNGCPRO (call5 (handler
, Qcopy_file
, file
, newname
,
2429 ok_if_already_exists
, keep_time
));
2431 encoded_file
= ENCODE_FILE (file
);
2432 encoded_newname
= ENCODE_FILE (newname
);
2434 if (NILP (ok_if_already_exists
)
2435 || INTEGERP (ok_if_already_exists
))
2436 barf_or_query_if_file_exists (encoded_newname
, "copy to it",
2437 INTEGERP (ok_if_already_exists
), &out_st
, 0);
2438 else if (stat (SDATA (encoded_newname
), &out_st
) < 0)
2442 if (!CopyFile (SDATA (encoded_file
),
2443 SDATA (encoded_newname
),
2445 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
2446 /* CopyFile retains the timestamp by default. */
2447 else if (NILP (keep_time
))
2453 EMACS_GET_TIME (now
);
2454 filename
= SDATA (encoded_newname
);
2456 /* Ensure file is writable while its modified time is set. */
2457 attributes
= GetFileAttributes (filename
);
2458 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2459 if (set_file_times (filename
, now
, now
))
2461 /* Restore original attributes. */
2462 SetFileAttributes (filename
, attributes
);
2463 Fsignal (Qfile_date_error
,
2464 Fcons (build_string ("Cannot set file date"),
2465 Fcons (newname
, Qnil
)));
2467 /* Restore original attributes. */
2468 SetFileAttributes (filename
, attributes
);
2470 #else /* not WINDOWSNT */
2472 ifd
= emacs_open (SDATA (encoded_file
), O_RDONLY
, 0);
2476 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2478 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2480 /* We can only copy regular files and symbolic links. Other files are not
2482 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
2484 #if !defined (DOS_NT) || __DJGPP__ > 1
2485 if (out_st
.st_mode
!= 0
2486 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2489 report_file_error ("Input and output files are the same",
2490 Fcons (file
, Fcons (newname
, Qnil
)));
2494 #if defined (S_ISREG) && defined (S_ISLNK)
2495 if (input_file_statable_p
)
2497 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
2499 #if defined (EISDIR)
2500 /* Get a better looking error message. */
2503 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2506 #endif /* S_ISREG && S_ISLNK */
2509 /* Create the copy file with the same record format as the input file */
2510 ofd
= sys_creat (SDATA (encoded_newname
), 0666, ifd
);
2513 /* System's default file type was set to binary by _fmode in emacs.c. */
2514 ofd
= creat (SDATA (encoded_newname
), S_IREAD
| S_IWRITE
);
2515 #else /* not MSDOS */
2516 ofd
= creat (SDATA (encoded_newname
), 0666);
2517 #endif /* not MSDOS */
2520 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2522 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2526 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2527 if (emacs_write (ofd
, buf
, n
) != n
)
2528 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2531 /* Closing the output clobbers the file times on some systems. */
2532 if (emacs_close (ofd
) < 0)
2533 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2535 if (input_file_statable_p
)
2537 if (!NILP (keep_time
))
2539 EMACS_TIME atime
, mtime
;
2540 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
2541 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
2542 if (set_file_times (SDATA (encoded_newname
),
2544 Fsignal (Qfile_date_error
,
2545 Fcons (build_string ("Cannot set file date"),
2546 Fcons (newname
, Qnil
)));
2549 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2551 #if defined (__DJGPP__) && __DJGPP__ > 1
2552 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2553 and if it can't, it tells so. Otherwise, under MSDOS we usually
2554 get only the READ bit, which will make the copied file read-only,
2555 so it's better not to chmod at all. */
2556 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2557 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2558 #endif /* DJGPP version 2 or newer */
2563 #endif /* WINDOWSNT */
2565 /* Discard the unwind protects. */
2566 specpdl_ptr
= specpdl
+ count
;
2572 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2573 Smake_directory_internal
, 1, 1, 0,
2574 doc
: /* Create a new directory named DIRECTORY. */)
2576 Lisp_Object directory
;
2578 const unsigned char *dir
;
2579 Lisp_Object handler
;
2580 Lisp_Object encoded_dir
;
2582 CHECK_STRING (directory
);
2583 directory
= Fexpand_file_name (directory
, Qnil
);
2585 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2586 if (!NILP (handler
))
2587 return call2 (handler
, Qmake_directory_internal
, directory
);
2589 encoded_dir
= ENCODE_FILE (directory
);
2591 dir
= SDATA (encoded_dir
);
2594 if (mkdir (dir
) != 0)
2596 if (mkdir (dir
, 0777) != 0)
2598 report_file_error ("Creating directory", Flist (1, &directory
));
2603 DEFUN ("delete-directory", Fdelete_directory
, Sdelete_directory
, 1, 1, "FDelete directory: ",
2604 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2606 Lisp_Object directory
;
2608 const unsigned char *dir
;
2609 Lisp_Object handler
;
2610 Lisp_Object encoded_dir
;
2612 CHECK_STRING (directory
);
2613 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2615 handler
= Ffind_file_name_handler (directory
, Qdelete_directory
);
2616 if (!NILP (handler
))
2617 return call2 (handler
, Qdelete_directory
, directory
);
2619 encoded_dir
= ENCODE_FILE (directory
);
2621 dir
= SDATA (encoded_dir
);
2623 if (rmdir (dir
) != 0)
2624 report_file_error ("Removing directory", Flist (1, &directory
));
2629 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 1, "fDelete file: ",
2630 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2631 If file has multiple names, it continues to exist with the other names. */)
2633 Lisp_Object filename
;
2635 Lisp_Object handler
;
2636 Lisp_Object encoded_file
;
2637 struct gcpro gcpro1
;
2640 if (!NILP (Ffile_directory_p (filename
))
2641 && NILP (Ffile_symlink_p (filename
)))
2642 Fsignal (Qfile_error
,
2643 Fcons (build_string ("Removing old name: is a directory"),
2644 Fcons (filename
, Qnil
)));
2646 filename
= Fexpand_file_name (filename
, Qnil
);
2648 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2649 if (!NILP (handler
))
2650 return call2 (handler
, Qdelete_file
, filename
);
2652 encoded_file
= ENCODE_FILE (filename
);
2654 if (0 > unlink (SDATA (encoded_file
)))
2655 report_file_error ("Removing old name", Flist (1, &filename
));
2660 internal_delete_file_1 (ignore
)
2666 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2669 internal_delete_file (filename
)
2670 Lisp_Object filename
;
2672 return NILP (internal_condition_case_1 (Fdelete_file
, filename
,
2673 Qt
, internal_delete_file_1
));
2676 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2677 "fRename file: \nFRename %s to file: \np",
2678 doc
: /* Rename FILE as NEWNAME. Both args strings.
2679 If file has names other than FILE, it continues to have those names.
2680 Signals a `file-already-exists' error if a file NEWNAME already exists
2681 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2682 A number as third arg means request confirmation if NEWNAME already exists.
2683 This is what happens in interactive use with M-x. */)
2684 (file
, newname
, ok_if_already_exists
)
2685 Lisp_Object file
, newname
, ok_if_already_exists
;
2688 Lisp_Object args
[2];
2690 Lisp_Object handler
;
2691 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2692 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2694 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2695 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2696 CHECK_STRING (file
);
2697 CHECK_STRING (newname
);
2698 file
= Fexpand_file_name (file
, Qnil
);
2699 newname
= Fexpand_file_name (newname
, Qnil
);
2701 /* If the file name has special constructs in it,
2702 call the corresponding file handler. */
2703 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2705 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2706 if (!NILP (handler
))
2707 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2708 file
, newname
, ok_if_already_exists
));
2710 encoded_file
= ENCODE_FILE (file
);
2711 encoded_newname
= ENCODE_FILE (newname
);
2714 /* If the file names are identical but for the case, don't ask for
2715 confirmation: they simply want to change the letter-case of the
2717 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2719 if (NILP (ok_if_already_exists
)
2720 || INTEGERP (ok_if_already_exists
))
2721 barf_or_query_if_file_exists (encoded_newname
, "rename to it",
2722 INTEGERP (ok_if_already_exists
), 0, 0);
2724 if (0 > rename (SDATA (encoded_file
), SDATA (encoded_newname
)))
2726 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
))
2727 || 0 > unlink (SDATA (encoded_file
)))
2733 symlink_target
= Ffile_symlink_p (file
);
2734 if (! NILP (symlink_target
))
2735 Fmake_symbolic_link (symlink_target
, newname
,
2736 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2739 Fcopy_file (file
, newname
,
2740 /* We have already prompted if it was an integer,
2741 so don't have copy-file prompt again. */
2742 NILP (ok_if_already_exists
) ? Qnil
: Qt
, Qt
);
2743 Fdelete_file (file
);
2750 report_file_error ("Renaming", Flist (2, args
));
2753 report_file_error ("Renaming", Flist (2, &file
));
2760 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2761 "fAdd name to file: \nFName to add to %s: \np",
2762 doc
: /* Give FILE additional name NEWNAME. Both args strings.
2763 Signals a `file-already-exists' error if a file NEWNAME already exists
2764 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2765 A number as third arg means request confirmation if NEWNAME already exists.
2766 This is what happens in interactive use with M-x. */)
2767 (file
, newname
, ok_if_already_exists
)
2768 Lisp_Object file
, newname
, ok_if_already_exists
;
2771 Lisp_Object args
[2];
2773 Lisp_Object handler
;
2774 Lisp_Object encoded_file
, encoded_newname
;
2775 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2777 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2778 encoded_file
= encoded_newname
= Qnil
;
2779 CHECK_STRING (file
);
2780 CHECK_STRING (newname
);
2781 file
= Fexpand_file_name (file
, Qnil
);
2782 newname
= Fexpand_file_name (newname
, Qnil
);
2784 /* If the file name has special constructs in it,
2785 call the corresponding file handler. */
2786 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2787 if (!NILP (handler
))
2788 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2789 newname
, ok_if_already_exists
));
2791 /* If the new name has special constructs in it,
2792 call the corresponding file handler. */
2793 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2794 if (!NILP (handler
))
2795 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2796 newname
, ok_if_already_exists
));
2798 encoded_file
= ENCODE_FILE (file
);
2799 encoded_newname
= ENCODE_FILE (newname
);
2801 if (NILP (ok_if_already_exists
)
2802 || INTEGERP (ok_if_already_exists
))
2803 barf_or_query_if_file_exists (encoded_newname
, "make it a new name",
2804 INTEGERP (ok_if_already_exists
), 0, 0);
2806 unlink (SDATA (newname
));
2807 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
)))
2812 report_file_error ("Adding new name", Flist (2, args
));
2814 report_file_error ("Adding new name", Flist (2, &file
));
2823 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2824 "FMake symbolic link to file: \nFMake symbolic link to file %s: \np",
2825 doc
: /* Make a symbolic link to FILENAME, named LINKNAME. Both args strings.
2826 Signals a `file-already-exists' error if a file LINKNAME already exists
2827 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2828 A number as third arg means request confirmation if LINKNAME already exists.
2829 This happens for interactive use with M-x. */)
2830 (filename
, linkname
, ok_if_already_exists
)
2831 Lisp_Object filename
, linkname
, ok_if_already_exists
;
2834 Lisp_Object args
[2];
2836 Lisp_Object handler
;
2837 Lisp_Object encoded_filename
, encoded_linkname
;
2838 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2840 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2841 encoded_filename
= encoded_linkname
= Qnil
;
2842 CHECK_STRING (filename
);
2843 CHECK_STRING (linkname
);
2844 /* If the link target has a ~, we must expand it to get
2845 a truly valid file name. Otherwise, do not expand;
2846 we want to permit links to relative file names. */
2847 if (SREF (filename
, 0) == '~')
2848 filename
= Fexpand_file_name (filename
, Qnil
);
2849 linkname
= Fexpand_file_name (linkname
, Qnil
);
2851 /* If the file name has special constructs in it,
2852 call the corresponding file handler. */
2853 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2854 if (!NILP (handler
))
2855 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2856 linkname
, ok_if_already_exists
));
2858 /* If the new link name has special constructs in it,
2859 call the corresponding file handler. */
2860 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2861 if (!NILP (handler
))
2862 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2863 linkname
, ok_if_already_exists
));
2865 encoded_filename
= ENCODE_FILE (filename
);
2866 encoded_linkname
= ENCODE_FILE (linkname
);
2868 if (NILP (ok_if_already_exists
)
2869 || INTEGERP (ok_if_already_exists
))
2870 barf_or_query_if_file_exists (encoded_linkname
, "make it a link",
2871 INTEGERP (ok_if_already_exists
), 0, 0);
2872 if (0 > symlink (SDATA (encoded_filename
),
2873 SDATA (encoded_linkname
)))
2875 /* If we didn't complain already, silently delete existing file. */
2876 if (errno
== EEXIST
)
2878 unlink (SDATA (encoded_linkname
));
2879 if (0 <= symlink (SDATA (encoded_filename
),
2880 SDATA (encoded_linkname
)))
2890 report_file_error ("Making symbolic link", Flist (2, args
));
2892 report_file_error ("Making symbolic link", Flist (2, &filename
));
2898 #endif /* S_IFLNK */
2902 DEFUN ("define-logical-name", Fdefine_logical_name
, Sdefine_logical_name
,
2903 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2904 doc
: /* Define the job-wide logical name NAME to have the value STRING.
2905 If STRING is nil or a null string, the logical name NAME is deleted. */)
2910 CHECK_STRING (name
);
2912 delete_logical_name (SDATA (name
));
2915 CHECK_STRING (string
);
2917 if (SCHARS (string
) == 0)
2918 delete_logical_name (SDATA (name
));
2920 define_logical_name (SDATA (name
), SDATA (string
));
2929 DEFUN ("sysnetunam", Fsysnetunam
, Ssysnetunam
, 2, 2, 0,
2930 doc
: /* Open a network connection to PATH using LOGIN as the login string. */)
2932 Lisp_Object path
, login
;
2936 CHECK_STRING (path
);
2937 CHECK_STRING (login
);
2939 netresult
= netunam (SDATA (path
), SDATA (login
));
2941 if (netresult
== -1)
2946 #endif /* HPUX_NET */
2948 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
2950 doc
: /* Return t if file FILENAME specifies an absolute file name.
2951 On Unix, this is a name starting with a `/' or a `~'. */)
2953 Lisp_Object filename
;
2955 const unsigned char *ptr
;
2957 CHECK_STRING (filename
);
2958 ptr
= SDATA (filename
);
2959 if (IS_DIRECTORY_SEP (*ptr
) || *ptr
== '~'
2961 /* ??? This criterion is probably wrong for '<'. */
2962 || index (ptr
, ':') || index (ptr
, '<')
2963 || (*ptr
== '[' && (ptr
[1] != '-' || (ptr
[2] != '.' && ptr
[2] != ']'))
2967 || (IS_DRIVE (*ptr
) && ptr
[1] == ':' && IS_DIRECTORY_SEP (ptr
[2]))
2975 /* Return nonzero if file FILENAME exists and can be executed. */
2978 check_executable (filename
)
2982 int len
= strlen (filename
);
2985 if (stat (filename
, &st
) < 0)
2987 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
2988 return ((st
.st_mode
& S_IEXEC
) != 0);
2990 return (S_ISREG (st
.st_mode
)
2992 && (stricmp ((suffix
= filename
+ len
-4), ".com") == 0
2993 || stricmp (suffix
, ".exe") == 0
2994 || stricmp (suffix
, ".bat") == 0)
2995 || (st
.st_mode
& S_IFMT
) == S_IFDIR
);
2996 #endif /* not WINDOWSNT */
2997 #else /* not DOS_NT */
2998 #ifdef HAVE_EUIDACCESS
2999 return (euidaccess (filename
, 1) >= 0);
3001 /* Access isn't quite right because it uses the real uid
3002 and we really want to test with the effective uid.
3003 But Unix doesn't give us a right way to do it. */
3004 return (access (filename
, 1) >= 0);
3006 #endif /* not DOS_NT */
3009 /* Return nonzero if file FILENAME exists and can be written. */
3012 check_writable (filename
)
3017 if (stat (filename
, &st
) < 0)
3019 return (st
.st_mode
& S_IWRITE
|| (st
.st_mode
& S_IFMT
) == S_IFDIR
);
3020 #else /* not MSDOS */
3021 #ifdef HAVE_EUIDACCESS
3022 return (euidaccess (filename
, 2) >= 0);
3024 /* Access isn't quite right because it uses the real uid
3025 and we really want to test with the effective uid.
3026 But Unix doesn't give us a right way to do it.
3027 Opening with O_WRONLY could work for an ordinary file,
3028 but would lose for directories. */
3029 return (access (filename
, 2) >= 0);
3031 #endif /* not MSDOS */
3034 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
3035 doc
: /* Return t if file FILENAME exists. (This does not mean you can read it.)
3036 See also `file-readable-p' and `file-attributes'. */)
3038 Lisp_Object filename
;
3040 Lisp_Object absname
;
3041 Lisp_Object handler
;
3042 struct stat statbuf
;
3044 CHECK_STRING (filename
);
3045 absname
= Fexpand_file_name (filename
, Qnil
);
3047 /* If the file name has special constructs in it,
3048 call the corresponding file handler. */
3049 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
3050 if (!NILP (handler
))
3051 return call2 (handler
, Qfile_exists_p
, absname
);
3053 absname
= ENCODE_FILE (absname
);
3055 return (stat (SDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
3058 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
3059 doc
: /* Return t if FILENAME can be executed by you.
3060 For a directory, this means you can access files in that directory. */)
3062 Lisp_Object filename
;
3064 Lisp_Object absname
;
3065 Lisp_Object handler
;
3067 CHECK_STRING (filename
);
3068 absname
= Fexpand_file_name (filename
, Qnil
);
3070 /* If the file name has special constructs in it,
3071 call the corresponding file handler. */
3072 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
3073 if (!NILP (handler
))
3074 return call2 (handler
, Qfile_executable_p
, absname
);
3076 absname
= ENCODE_FILE (absname
);
3078 return (check_executable (SDATA (absname
)) ? Qt
: Qnil
);
3081 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
3082 doc
: /* Return t if file FILENAME exists and you can read it.
3083 See also `file-exists-p' and `file-attributes'. */)
3085 Lisp_Object filename
;
3087 Lisp_Object absname
;
3088 Lisp_Object handler
;
3091 struct stat statbuf
;
3093 CHECK_STRING (filename
);
3094 absname
= Fexpand_file_name (filename
, Qnil
);
3096 /* If the file name has special constructs in it,
3097 call the corresponding file handler. */
3098 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
3099 if (!NILP (handler
))
3100 return call2 (handler
, Qfile_readable_p
, absname
);
3102 absname
= ENCODE_FILE (absname
);
3104 #if defined(DOS_NT) || defined(macintosh)
3105 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3107 if (access (SDATA (absname
), 0) == 0)
3110 #else /* not DOS_NT and not macintosh */
3112 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3113 /* Opening a fifo without O_NONBLOCK can wait.
3114 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3115 except in the case of a fifo, on a system which handles it. */
3116 desc
= stat (SDATA (absname
), &statbuf
);
3119 if (S_ISFIFO (statbuf
.st_mode
))
3120 flags
|= O_NONBLOCK
;
3122 desc
= emacs_open (SDATA (absname
), flags
, 0);
3127 #endif /* not DOS_NT and not macintosh */
3130 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3132 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
3133 doc
: /* Return t if file FILENAME can be written or created by you. */)
3135 Lisp_Object filename
;
3137 Lisp_Object absname
, dir
, encoded
;
3138 Lisp_Object handler
;
3139 struct stat statbuf
;
3141 CHECK_STRING (filename
);
3142 absname
= Fexpand_file_name (filename
, Qnil
);
3144 /* If the file name has special constructs in it,
3145 call the corresponding file handler. */
3146 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
3147 if (!NILP (handler
))
3148 return call2 (handler
, Qfile_writable_p
, absname
);
3150 encoded
= ENCODE_FILE (absname
);
3151 if (stat (SDATA (encoded
), &statbuf
) >= 0)
3152 return (check_writable (SDATA (encoded
))
3155 dir
= Ffile_name_directory (absname
);
3158 dir
= Fdirectory_file_name (dir
);
3162 dir
= Fdirectory_file_name (dir
);
3165 dir
= ENCODE_FILE (dir
);
3167 /* The read-only attribute of the parent directory doesn't affect
3168 whether a file or directory can be created within it. Some day we
3169 should check ACLs though, which do affect this. */
3170 if (stat (SDATA (dir
), &statbuf
) < 0)
3172 return (statbuf
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
3174 return (check_writable (!NILP (dir
) ? (char *) SDATA (dir
) : "")
3179 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
3180 doc
: /* Access file FILENAME, and get an error if that does not work.
3181 The second argument STRING is used in the error message.
3182 If there is no error, we return nil. */)
3184 Lisp_Object filename
, string
;
3186 Lisp_Object handler
, encoded_filename
, absname
;
3189 CHECK_STRING (filename
);
3190 absname
= Fexpand_file_name (filename
, Qnil
);
3192 CHECK_STRING (string
);
3194 /* If the file name has special constructs in it,
3195 call the corresponding file handler. */
3196 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
3197 if (!NILP (handler
))
3198 return call3 (handler
, Qaccess_file
, absname
, string
);
3200 encoded_filename
= ENCODE_FILE (absname
);
3202 fd
= emacs_open (SDATA (encoded_filename
), O_RDONLY
, 0);
3204 report_file_error (SDATA (string
), Fcons (filename
, Qnil
));
3210 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
3211 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
3212 The value is the link target, as a string.
3213 Otherwise returns nil. */)
3215 Lisp_Object filename
;
3217 Lisp_Object handler
;
3219 CHECK_STRING (filename
);
3220 filename
= Fexpand_file_name (filename
, Qnil
);
3222 /* If the file name has special constructs in it,
3223 call the corresponding file handler. */
3224 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
3225 if (!NILP (handler
))
3226 return call2 (handler
, Qfile_symlink_p
, filename
);
3235 filename
= ENCODE_FILE (filename
);
3242 buf
= (char *) xrealloc (buf
, bufsize
);
3243 bzero (buf
, bufsize
);
3246 valsize
= readlink (SDATA (filename
), buf
, bufsize
);
3250 /* HP-UX reports ERANGE if buffer is too small. */
3251 if (errno
== ERANGE
)
3261 while (valsize
>= bufsize
);
3263 val
= make_string (buf
, valsize
);
3264 if (buf
[0] == '/' && index (buf
, ':'))
3265 val
= concat2 (build_string ("/:"), val
);
3267 val
= DECODE_FILE (val
);
3270 #else /* not S_IFLNK */
3272 #endif /* not S_IFLNK */
3275 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
3276 doc
: /* Return t if FILENAME names an existing directory.
3277 Symbolic links to directories count as directories.
3278 See `file-symlink-p' to distinguish symlinks. */)
3280 Lisp_Object filename
;
3282 register Lisp_Object absname
;
3284 Lisp_Object handler
;
3286 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3288 /* If the file name has special constructs in it,
3289 call the corresponding file handler. */
3290 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
3291 if (!NILP (handler
))
3292 return call2 (handler
, Qfile_directory_p
, absname
);
3294 absname
= ENCODE_FILE (absname
);
3296 if (stat (SDATA (absname
), &st
) < 0)
3298 return (st
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
3301 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
3302 doc
: /* Return t if file FILENAME names a directory you can open.
3303 For the value to be t, FILENAME must specify the name of a directory as a file,
3304 and the directory must allow you to open files in it. In order to use a
3305 directory as a buffer's current directory, this predicate must return true.
3306 A directory name spec may be given instead; then the value is t
3307 if the directory so specified exists and really is a readable and
3308 searchable directory. */)
3310 Lisp_Object filename
;
3312 Lisp_Object handler
;
3314 struct gcpro gcpro1
;
3316 /* If the file name has special constructs in it,
3317 call the corresponding file handler. */
3318 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
3319 if (!NILP (handler
))
3320 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
3323 tem
= (NILP (Ffile_directory_p (filename
))
3324 || NILP (Ffile_executable_p (filename
)));
3326 return tem
? Qnil
: Qt
;
3329 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
3330 doc
: /* Return t if file FILENAME is the name of a regular file.
3331 This is the sort of file that holds an ordinary stream of data bytes. */)
3333 Lisp_Object filename
;
3335 register Lisp_Object absname
;
3337 Lisp_Object handler
;
3339 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3341 /* If the file name has special constructs in it,
3342 call the corresponding file handler. */
3343 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
3344 if (!NILP (handler
))
3345 return call2 (handler
, Qfile_regular_p
, absname
);
3347 absname
= ENCODE_FILE (absname
);
3352 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3354 /* Tell stat to use expensive method to get accurate info. */
3355 Vw32_get_true_file_attributes
= Qt
;
3356 result
= stat (SDATA (absname
), &st
);
3357 Vw32_get_true_file_attributes
= tem
;
3361 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
3364 if (stat (SDATA (absname
), &st
) < 0)
3366 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
3370 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3371 doc
: /* Return mode bits of file named FILENAME, as an integer.
3372 Return nil, if file does not exist or is not accessible. */)
3374 Lisp_Object filename
;
3376 Lisp_Object absname
;
3378 Lisp_Object handler
;
3380 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3382 /* If the file name has special constructs in it,
3383 call the corresponding file handler. */
3384 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3385 if (!NILP (handler
))
3386 return call2 (handler
, Qfile_modes
, absname
);
3388 absname
= ENCODE_FILE (absname
);
3390 if (stat (SDATA (absname
), &st
) < 0)
3392 #if defined (MSDOS) && __DJGPP__ < 2
3393 if (check_executable (SDATA (absname
)))
3394 st
.st_mode
|= S_IEXEC
;
3395 #endif /* MSDOS && __DJGPP__ < 2 */
3397 return make_number (st
.st_mode
& 07777);
3400 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2, 0,
3401 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3402 Only the 12 low bits of MODE are used. */)
3404 Lisp_Object filename
, mode
;
3406 Lisp_Object absname
, encoded_absname
;
3407 Lisp_Object handler
;
3409 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
3410 CHECK_NUMBER (mode
);
3412 /* If the file name has special constructs in it,
3413 call the corresponding file handler. */
3414 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3415 if (!NILP (handler
))
3416 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3418 encoded_absname
= ENCODE_FILE (absname
);
3420 if (chmod (SDATA (encoded_absname
), XINT (mode
)) < 0)
3421 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3426 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3427 doc
: /* Set the file permission bits for newly created files.
3428 The argument MODE should be an integer; only the low 9 bits are used.
3429 This setting is inherited by subprocesses. */)
3433 CHECK_NUMBER (mode
);
3435 umask ((~ XINT (mode
)) & 0777);
3440 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3441 doc
: /* Return the default file protection for created files.
3442 The value is an integer. */)
3448 realmask
= umask (0);
3451 XSETINT (value
, (~ realmask
) & 0777);
3455 extern int lisp_time_argument
P_ ((Lisp_Object
, time_t *, int *));
3457 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3458 doc
: /* Set times of file FILENAME to TIME.
3459 Set both access and modification times.
3460 Return t on success, else nil.
3461 Use the current time if TIME is nil. TIME is in the format of
3464 Lisp_Object filename
, time
;
3466 Lisp_Object absname
, encoded_absname
;
3467 Lisp_Object handler
;
3471 if (! lisp_time_argument (time
, &sec
, &usec
))
3472 error ("Invalid time specification");
3474 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
3476 /* If the file name has special constructs in it,
3477 call the corresponding file handler. */
3478 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3479 if (!NILP (handler
))
3480 return call3 (handler
, Qset_file_times
, absname
, time
);
3482 encoded_absname
= ENCODE_FILE (absname
);
3487 EMACS_SET_SECS (t
, sec
);
3488 EMACS_SET_USECS (t
, usec
);
3490 if (set_file_times (SDATA (encoded_absname
), t
, t
))
3495 /* Setting times on a directory always fails. */
3496 if (stat (SDATA (encoded_absname
), &st
) == 0
3497 && (st
.st_mode
& S_IFMT
) == S_IFDIR
)
3500 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3513 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3514 doc
: /* Tell Unix to finish all pending disk updates. */)
3523 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3524 doc
: /* Return t if file FILE1 is newer than file FILE2.
3525 If FILE1 does not exist, the answer is nil;
3526 otherwise, if FILE2 does not exist, the answer is t. */)
3528 Lisp_Object file1
, file2
;
3530 Lisp_Object absname1
, absname2
;
3533 Lisp_Object handler
;
3534 struct gcpro gcpro1
, gcpro2
;
3536 CHECK_STRING (file1
);
3537 CHECK_STRING (file2
);
3540 GCPRO2 (absname1
, file2
);
3541 absname1
= expand_and_dir_to_file (file1
, current_buffer
->directory
);
3542 absname2
= expand_and_dir_to_file (file2
, current_buffer
->directory
);
3545 /* If the file name has special constructs in it,
3546 call the corresponding file handler. */
3547 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3549 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3550 if (!NILP (handler
))
3551 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3553 GCPRO2 (absname1
, absname2
);
3554 absname1
= ENCODE_FILE (absname1
);
3555 absname2
= ENCODE_FILE (absname2
);
3558 if (stat (SDATA (absname1
), &st
) < 0)
3561 mtime1
= st
.st_mtime
;
3563 if (stat (SDATA (absname2
), &st
) < 0)
3566 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3570 Lisp_Object Qfind_buffer_file_type
;
3573 #ifndef READ_BUF_SIZE
3574 #define READ_BUF_SIZE (64 << 10)
3577 extern void adjust_markers_for_delete
P_ ((int, int, int, int));
3579 /* This function is called after Lisp functions to decide a coding
3580 system are called, or when they cause an error. Before they are
3581 called, the current buffer is set unibyte and it contains only a
3582 newly inserted text (thus the buffer was empty before the
3585 The functions may set markers, overlays, text properties, or even
3586 alter the buffer contents, change the current buffer.
3588 Here, we reset all those changes by:
3589 o set back the current buffer.
3590 o move all markers and overlays to BEG.
3591 o remove all text properties.
3592 o set back the buffer multibyteness. */
3595 decide_coding_unwind (unwind_data
)
3596 Lisp_Object unwind_data
;
3598 Lisp_Object multibyte
, undo_list
, buffer
;
3600 multibyte
= XCAR (unwind_data
);
3601 unwind_data
= XCDR (unwind_data
);
3602 undo_list
= XCAR (unwind_data
);
3603 buffer
= XCDR (unwind_data
);
3605 if (current_buffer
!= XBUFFER (buffer
))
3606 set_buffer_internal (XBUFFER (buffer
));
3607 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3608 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3609 BUF_INTERVALS (current_buffer
) = 0;
3610 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3612 /* Now we are safe to change the buffer's multibyteness directly. */
3613 current_buffer
->enable_multibyte_characters
= multibyte
;
3614 current_buffer
->undo_list
= undo_list
;
3620 /* Used to pass values from insert-file-contents to read_non_regular. */
3622 static int non_regular_fd
;
3623 static int non_regular_inserted
;
3624 static int non_regular_nbytes
;
3627 /* Read from a non-regular file.
3628 Read non_regular_trytry bytes max from non_regular_fd.
3629 Non_regular_inserted specifies where to put the read bytes.
3630 Value is the number of bytes read. */
3639 nbytes
= emacs_read (non_regular_fd
,
3640 BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ non_regular_inserted
,
3641 non_regular_nbytes
);
3643 return make_number (nbytes
);
3647 /* Condition-case handler used when reading from non-regular files
3648 in insert-file-contents. */
3651 read_non_regular_quit ()
3657 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3659 doc
: /* Insert contents of file FILENAME after point.
3660 Returns list of absolute file name and number of characters inserted.
3661 If second argument VISIT is non-nil, the buffer's visited filename
3662 and last save file modtime are set, and it is marked unmodified.
3663 If visiting and the file does not exist, visiting is completed
3664 before the error is signaled.
3665 The optional third and fourth arguments BEG and END
3666 specify what portion of the file to insert.
3667 These arguments count bytes in the file, not characters in the buffer.
3668 If VISIT is non-nil, BEG and END must be nil.
3670 If optional fifth argument REPLACE is non-nil,
3671 it means replace the current buffer contents (in the accessible portion)
3672 with the file contents. This is better than simply deleting and inserting
3673 the whole thing because (1) it preserves some marker positions
3674 and (2) it puts less data in the undo list.
3675 When REPLACE is non-nil, the value is the number of characters actually read,
3676 which is often less than the number of characters to be read.
3678 This does code conversion according to the value of
3679 `coding-system-for-read' or `file-coding-system-alist',
3680 and sets the variable `last-coding-system-used' to the coding system
3682 (filename
, visit
, beg
, end
, replace
)
3683 Lisp_Object filename
, visit
, beg
, end
, replace
;
3688 register int how_much
;
3689 register int unprocessed
;
3690 int count
= SPECPDL_INDEX ();
3691 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3692 Lisp_Object handler
, val
, insval
, orig_filename
;
3695 int not_regular
= 0;
3696 unsigned char read_buf
[READ_BUF_SIZE
];
3697 struct coding_system coding
;
3698 unsigned char buffer
[1 << 14];
3699 int replace_handled
= 0;
3700 int set_coding_system
= 0;
3701 int coding_system_decided
= 0;
3704 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3705 error ("Cannot do file visiting in an indirect buffer");
3707 if (!NILP (current_buffer
->read_only
))
3708 Fbarf_if_buffer_read_only ();
3712 orig_filename
= Qnil
;
3714 GCPRO4 (filename
, val
, p
, orig_filename
);
3716 CHECK_STRING (filename
);
3717 filename
= Fexpand_file_name (filename
, Qnil
);
3719 /* If the file name has special constructs in it,
3720 call the corresponding file handler. */
3721 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3722 if (!NILP (handler
))
3724 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3725 visit
, beg
, end
, replace
);
3726 if (CONSP (val
) && CONSP (XCDR (val
)))
3727 inserted
= XINT (XCAR (XCDR (val
)));
3731 orig_filename
= filename
;
3732 filename
= ENCODE_FILE (filename
);
3738 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3740 /* Tell stat to use expensive method to get accurate info. */
3741 Vw32_get_true_file_attributes
= Qt
;
3742 total
= stat (SDATA (filename
), &st
);
3743 Vw32_get_true_file_attributes
= tem
;
3748 if (stat (SDATA (filename
), &st
) < 0)
3750 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0
3751 || fstat (fd
, &st
) < 0)
3752 #endif /* not APOLLO */
3753 #endif /* WINDOWSNT */
3755 if (fd
>= 0) emacs_close (fd
);
3758 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3761 if (!NILP (Vcoding_system_for_read
))
3762 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3767 /* This code will need to be changed in order to work on named
3768 pipes, and it's probably just not worth it. So we should at
3769 least signal an error. */
3770 if (!S_ISREG (st
.st_mode
))
3777 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3778 Fsignal (Qfile_error
,
3779 Fcons (build_string ("not a regular file"),
3780 Fcons (orig_filename
, Qnil
)));
3785 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0)
3788 /* Replacement should preserve point as it preserves markers. */
3789 if (!NILP (replace
))
3790 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3792 record_unwind_protect (close_file_unwind
, make_number (fd
));
3794 /* Supposedly happens on VMS. */
3795 /* Can happen on any platform that uses long as type of off_t, but allows
3796 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3797 give a message suitable for the latter case. */
3798 if (! not_regular
&& st
.st_size
< 0)
3799 error ("Maximum buffer size exceeded");
3801 /* Prevent redisplay optimizations. */
3802 current_buffer
->clip_changed
= 1;
3806 if (!NILP (beg
) || !NILP (end
))
3807 error ("Attempt to visit less than an entire file");
3808 if (BEG
< Z
&& NILP (replace
))
3809 error ("Cannot do file visiting in a non-empty buffer");
3815 XSETFASTINT (beg
, 0);
3823 XSETINT (end
, st
.st_size
);
3825 /* Arithmetic overflow can occur if an Emacs integer cannot
3826 represent the file size, or if the calculations below
3827 overflow. The calculations below double the file size
3828 twice, so check that it can be multiplied by 4 safely. */
3829 if (XINT (end
) != st
.st_size
3830 || ((int) st
.st_size
* 4) / 4 != st
.st_size
)
3831 error ("Maximum buffer size exceeded");
3833 /* The file size returned from stat may be zero, but data
3834 may be readable nonetheless, for example when this is a
3835 file in the /proc filesystem. */
3836 if (st
.st_size
== 0)
3837 XSETINT (end
, READ_BUF_SIZE
);
3841 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3843 /* We use emacs-mule for auto saving... */
3844 setup_coding_system (Qemacs_mule
, &coding
);
3845 /* ... but with the special flag to indicate to read in a
3846 multibyte sequence for eight-bit-control char as is. */
3848 coding
.src_multibyte
= 0;
3849 coding
.dst_multibyte
3850 = !NILP (current_buffer
->enable_multibyte_characters
);
3851 coding
.eol_type
= CODING_EOL_LF
;
3852 coding_system_decided
= 1;
3856 /* Decide the coding system to use for reading the file now
3857 because we can't use an optimized method for handling
3858 `coding:' tag if the current buffer is not empty. */
3862 if (!NILP (Vcoding_system_for_read
))
3863 val
= Vcoding_system_for_read
;
3864 else if (! NILP (replace
))
3865 /* In REPLACE mode, we can use the same coding system
3866 that was used to visit the file. */
3867 val
= current_buffer
->buffer_file_coding_system
;
3870 /* Don't try looking inside a file for a coding system
3871 specification if it is not seekable. */
3872 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3874 /* Find a coding system specified in the heading two
3875 lines or in the tailing several lines of the file.
3876 We assume that the 1K-byte and 3K-byte for heading
3877 and tailing respectively are sufficient for this
3881 if (st
.st_size
<= (1024 * 4))
3882 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3885 nread
= emacs_read (fd
, read_buf
, 1024);
3888 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3889 report_file_error ("Setting file position",
3890 Fcons (orig_filename
, Qnil
));
3891 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3896 error ("IO error reading %s: %s",
3897 SDATA (orig_filename
), emacs_strerror (errno
));
3900 struct buffer
*prev
= current_buffer
;
3904 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3906 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3907 buf
= XBUFFER (buffer
);
3909 delete_all_overlays (buf
);
3910 buf
->directory
= current_buffer
->directory
;
3911 buf
->read_only
= Qnil
;
3912 buf
->filename
= Qnil
;
3913 buf
->undo_list
= Qt
;
3914 eassert (buf
->overlays_before
== NULL
);
3915 eassert (buf
->overlays_after
== NULL
);
3917 set_buffer_internal (buf
);
3919 buf
->enable_multibyte_characters
= Qnil
;
3921 insert_1_both (read_buf
, nread
, nread
, 0, 0, 0);
3922 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3923 val
= call2 (Vset_auto_coding_function
,
3924 filename
, make_number (nread
));
3925 set_buffer_internal (prev
);
3927 /* Discard the unwind protect for recovering the
3931 /* Rewind the file for the actual read done later. */
3932 if (lseek (fd
, 0, 0) < 0)
3933 report_file_error ("Setting file position",
3934 Fcons (orig_filename
, Qnil
));
3940 /* If we have not yet decided a coding system, check
3941 file-coding-system-alist. */
3942 Lisp_Object args
[6], coding_systems
;
3944 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
3945 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
3946 coding_systems
= Ffind_operation_coding_system (6, args
);
3947 if (CONSP (coding_systems
))
3948 val
= XCAR (coding_systems
);
3952 setup_coding_system (Fcheck_coding_system (val
), &coding
);
3953 /* Ensure we set Vlast_coding_system_used. */
3954 set_coding_system
= 1;
3956 if (NILP (current_buffer
->enable_multibyte_characters
)
3958 /* We must suppress all character code conversion except for
3959 end-of-line conversion. */
3960 setup_raw_text_coding_system (&coding
);
3962 coding
.src_multibyte
= 0;
3963 coding
.dst_multibyte
3964 = !NILP (current_buffer
->enable_multibyte_characters
);
3965 coding_system_decided
= 1;
3968 /* If requested, replace the accessible part of the buffer
3969 with the file contents. Avoid replacing text at the
3970 beginning or end of the buffer that matches the file contents;
3971 that preserves markers pointing to the unchanged parts.
3973 Here we implement this feature in an optimized way
3974 for the case where code conversion is NOT needed.
3975 The following if-statement handles the case of conversion
3976 in a less optimal way.
3978 If the code conversion is "automatic" then we try using this
3979 method and hope for the best.
3980 But if we discover the need for conversion, we give up on this method
3981 and let the following if-statement handle the replace job. */
3984 && !(coding
.common_flags
& CODING_REQUIRE_DECODING_MASK
))
3986 /* same_at_start and same_at_end count bytes,
3987 because file access counts bytes
3988 and BEG and END count bytes. */
3989 int same_at_start
= BEGV_BYTE
;
3990 int same_at_end
= ZV_BYTE
;
3992 /* There is still a possibility we will find the need to do code
3993 conversion. If that happens, we set this variable to 1 to
3994 give up on handling REPLACE in the optimized way. */
3995 int giveup_match_end
= 0;
3997 if (XINT (beg
) != 0)
3999 if (lseek (fd
, XINT (beg
), 0) < 0)
4000 report_file_error ("Setting file position",
4001 Fcons (orig_filename
, Qnil
));
4006 /* Count how many chars at the start of the file
4007 match the text at the beginning of the buffer. */
4012 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
4014 error ("IO error reading %s: %s",
4015 SDATA (orig_filename
), emacs_strerror (errno
));
4016 else if (nread
== 0)
4019 if (coding
.type
== coding_type_undecided
)
4020 detect_coding (&coding
, buffer
, nread
);
4021 if (coding
.common_flags
& CODING_REQUIRE_DECODING_MASK
)
4022 /* We found that the file should be decoded somehow.
4023 Let's give up here. */
4025 giveup_match_end
= 1;
4029 if (coding
.eol_type
== CODING_EOL_UNDECIDED
)
4030 detect_eol (&coding
, buffer
, nread
);
4031 if (coding
.eol_type
!= CODING_EOL_UNDECIDED
4032 && coding
.eol_type
!= CODING_EOL_LF
)
4033 /* We found that the format of eol should be decoded.
4034 Let's give up here. */
4036 giveup_match_end
= 1;
4041 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
4042 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
4043 same_at_start
++, bufpos
++;
4044 /* If we found a discrepancy, stop the scan.
4045 Otherwise loop around and scan the next bufferful. */
4046 if (bufpos
!= nread
)
4050 /* If the file matches the buffer completely,
4051 there's no need to replace anything. */
4052 if (same_at_start
- BEGV_BYTE
== XINT (end
))
4056 /* Truncate the buffer to the size of the file. */
4057 del_range_1 (same_at_start
, same_at_end
, 0, 0);
4062 /* Count how many chars at the end of the file
4063 match the text at the end of the buffer. But, if we have
4064 already found that decoding is necessary, don't waste time. */
4065 while (!giveup_match_end
)
4067 int total_read
, nread
, bufpos
, curpos
, trial
;
4069 /* At what file position are we now scanning? */
4070 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
4071 /* If the entire file matches the buffer tail, stop the scan. */
4074 /* How much can we scan in the next step? */
4075 trial
= min (curpos
, sizeof buffer
);
4076 if (lseek (fd
, curpos
- trial
, 0) < 0)
4077 report_file_error ("Setting file position",
4078 Fcons (orig_filename
, Qnil
));
4080 total_read
= nread
= 0;
4081 while (total_read
< trial
)
4083 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
4085 error ("IO error reading %s: %s",
4086 SDATA (orig_filename
), emacs_strerror (errno
));
4087 else if (nread
== 0)
4089 total_read
+= nread
;
4092 /* Scan this bufferful from the end, comparing with
4093 the Emacs buffer. */
4094 bufpos
= total_read
;
4096 /* Compare with same_at_start to avoid counting some buffer text
4097 as matching both at the file's beginning and at the end. */
4098 while (bufpos
> 0 && same_at_end
> same_at_start
4099 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
4100 same_at_end
--, bufpos
--;
4102 /* If we found a discrepancy, stop the scan.
4103 Otherwise loop around and scan the preceding bufferful. */
4106 /* If this discrepancy is because of code conversion,
4107 we cannot use this method; giveup and try the other. */
4108 if (same_at_end
> same_at_start
4109 && FETCH_BYTE (same_at_end
- 1) >= 0200
4110 && ! NILP (current_buffer
->enable_multibyte_characters
)
4111 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
4112 giveup_match_end
= 1;
4121 if (! giveup_match_end
)
4125 /* We win! We can handle REPLACE the optimized way. */
4127 /* Extend the start of non-matching text area to multibyte
4128 character boundary. */
4129 if (! NILP (current_buffer
->enable_multibyte_characters
))
4130 while (same_at_start
> BEGV_BYTE
4131 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4134 /* Extend the end of non-matching text area to multibyte
4135 character boundary. */
4136 if (! NILP (current_buffer
->enable_multibyte_characters
))
4137 while (same_at_end
< ZV_BYTE
4138 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4141 /* Don't try to reuse the same piece of text twice. */
4142 overlap
= (same_at_start
- BEGV_BYTE
4143 - (same_at_end
+ st
.st_size
- ZV
));
4145 same_at_end
+= overlap
;
4147 /* Arrange to read only the nonmatching middle part of the file. */
4148 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
4149 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
4151 del_range_byte (same_at_start
, same_at_end
, 0);
4152 /* Insert from the file at the proper position. */
4153 temp
= BYTE_TO_CHAR (same_at_start
);
4154 SET_PT_BOTH (temp
, same_at_start
);
4156 /* If display currently starts at beginning of line,
4157 keep it that way. */
4158 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
4159 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
4161 replace_handled
= 1;
4165 /* If requested, replace the accessible part of the buffer
4166 with the file contents. Avoid replacing text at the
4167 beginning or end of the buffer that matches the file contents;
4168 that preserves markers pointing to the unchanged parts.
4170 Here we implement this feature for the case where code conversion
4171 is needed, in a simple way that needs a lot of memory.
4172 The preceding if-statement handles the case of no conversion
4173 in a more optimized way. */
4174 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
4176 int same_at_start
= BEGV_BYTE
;
4177 int same_at_end
= ZV_BYTE
;
4180 /* Make sure that the gap is large enough. */
4181 int bufsize
= 2 * st
.st_size
;
4182 unsigned char *conversion_buffer
= (unsigned char *) xmalloc (bufsize
);
4185 /* First read the whole file, performing code conversion into
4186 CONVERSION_BUFFER. */
4188 if (lseek (fd
, XINT (beg
), 0) < 0)
4190 xfree (conversion_buffer
);
4191 report_file_error ("Setting file position",
4192 Fcons (orig_filename
, Qnil
));
4195 total
= st
.st_size
; /* Total bytes in the file. */
4196 how_much
= 0; /* Bytes read from file so far. */
4197 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
4198 unprocessed
= 0; /* Bytes not processed in previous loop. */
4200 while (how_much
< total
)
4202 /* try is reserved in some compilers (Microsoft C) */
4203 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
4204 unsigned char *destination
= read_buf
+ unprocessed
;
4207 /* Allow quitting out of the actual I/O. */
4210 this = emacs_read (fd
, destination
, trytry
);
4213 if (this < 0 || this + unprocessed
== 0)
4221 if (CODING_MAY_REQUIRE_DECODING (&coding
))
4223 int require
, result
;
4225 this += unprocessed
;
4227 /* If we are using more space than estimated,
4228 make CONVERSION_BUFFER bigger. */
4229 require
= decoding_buffer_size (&coding
, this);
4230 if (inserted
+ require
+ 2 * (total
- how_much
) > bufsize
)
4232 bufsize
= inserted
+ require
+ 2 * (total
- how_much
);
4233 conversion_buffer
= (unsigned char *) xrealloc (conversion_buffer
, bufsize
);
4236 /* Convert this batch with results in CONVERSION_BUFFER. */
4237 if (how_much
>= total
) /* This is the last block. */
4238 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4239 if (coding
.composing
!= COMPOSITION_DISABLED
)
4240 coding_allocate_composition_data (&coding
, BEGV
);
4241 result
= decode_coding (&coding
, read_buf
,
4242 conversion_buffer
+ inserted
,
4243 this, bufsize
- inserted
);
4245 /* Save for next iteration whatever we didn't convert. */
4246 unprocessed
= this - coding
.consumed
;
4247 bcopy (read_buf
+ coding
.consumed
, read_buf
, unprocessed
);
4248 if (!NILP (current_buffer
->enable_multibyte_characters
))
4249 this = coding
.produced
;
4251 this = str_as_unibyte (conversion_buffer
+ inserted
,
4258 /* At this point, INSERTED is how many characters (i.e. bytes)
4259 are present in CONVERSION_BUFFER.
4260 HOW_MUCH should equal TOTAL,
4261 or should be <= 0 if we couldn't read the file. */
4265 xfree (conversion_buffer
);
4266 coding_free_composition_data (&coding
);
4268 error ("IO error reading %s: %s",
4269 SDATA (orig_filename
), emacs_strerror (errno
));
4270 else if (how_much
== -2)
4271 error ("maximum buffer size exceeded");
4274 /* Compare the beginning of the converted file
4275 with the buffer text. */
4278 while (bufpos
< inserted
&& same_at_start
< same_at_end
4279 && FETCH_BYTE (same_at_start
) == conversion_buffer
[bufpos
])
4280 same_at_start
++, bufpos
++;
4282 /* If the file matches the buffer completely,
4283 there's no need to replace anything. */
4285 if (bufpos
== inserted
)
4287 xfree (conversion_buffer
);
4288 coding_free_composition_data (&coding
);
4291 /* Truncate the buffer to the size of the file. */
4292 del_range_byte (same_at_start
, same_at_end
, 0);
4297 /* Extend the start of non-matching text area to multibyte
4298 character boundary. */
4299 if (! NILP (current_buffer
->enable_multibyte_characters
))
4300 while (same_at_start
> BEGV_BYTE
4301 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4304 /* Scan this bufferful from the end, comparing with
4305 the Emacs buffer. */
4308 /* Compare with same_at_start to avoid counting some buffer text
4309 as matching both at the file's beginning and at the end. */
4310 while (bufpos
> 0 && same_at_end
> same_at_start
4311 && FETCH_BYTE (same_at_end
- 1) == conversion_buffer
[bufpos
- 1])
4312 same_at_end
--, bufpos
--;
4314 /* Extend the end of non-matching text area to multibyte
4315 character boundary. */
4316 if (! NILP (current_buffer
->enable_multibyte_characters
))
4317 while (same_at_end
< ZV_BYTE
4318 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4321 /* Don't try to reuse the same piece of text twice. */
4322 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4324 same_at_end
+= overlap
;
4326 /* If display currently starts at beginning of line,
4327 keep it that way. */
4328 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
4329 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
4331 /* Replace the chars that we need to replace,
4332 and update INSERTED to equal the number of bytes
4333 we are taking from the file. */
4334 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4336 if (same_at_end
!= same_at_start
)
4338 del_range_byte (same_at_start
, same_at_end
, 0);
4340 same_at_start
= GPT_BYTE
;
4344 temp
= BYTE_TO_CHAR (same_at_start
);
4346 /* Insert from the file at the proper position. */
4347 SET_PT_BOTH (temp
, same_at_start
);
4348 insert_1 (conversion_buffer
+ same_at_start
- BEGV_BYTE
, inserted
,
4350 if (coding
.cmp_data
&& coding
.cmp_data
->used
)
4351 coding_restore_composition (&coding
, Fcurrent_buffer ());
4352 coding_free_composition_data (&coding
);
4354 /* Set `inserted' to the number of inserted characters. */
4355 inserted
= PT
- temp
;
4357 xfree (conversion_buffer
);
4366 register Lisp_Object temp
;
4368 total
= XINT (end
) - XINT (beg
);
4370 /* Make sure point-max won't overflow after this insertion. */
4371 XSETINT (temp
, total
);
4372 if (total
!= XINT (temp
))
4373 error ("Maximum buffer size exceeded");
4376 /* For a special file, all we can do is guess. */
4377 total
= READ_BUF_SIZE
;
4379 if (NILP (visit
) && total
> 0)
4380 prepare_to_modify_buffer (PT
, PT
, NULL
);
4383 if (GAP_SIZE
< total
)
4384 make_gap (total
- GAP_SIZE
);
4386 if (XINT (beg
) != 0 || !NILP (replace
))
4388 if (lseek (fd
, XINT (beg
), 0) < 0)
4389 report_file_error ("Setting file position",
4390 Fcons (orig_filename
, Qnil
));
4393 /* In the following loop, HOW_MUCH contains the total bytes read so
4394 far for a regular file, and not changed for a special file. But,
4395 before exiting the loop, it is set to a negative value if I/O
4399 /* Total bytes inserted. */
4402 /* Here, we don't do code conversion in the loop. It is done by
4403 code_convert_region after all data are read into the buffer. */
4405 int gap_size
= GAP_SIZE
;
4407 while (how_much
< total
)
4409 /* try is reserved in some compilers (Microsoft C) */
4410 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4417 /* Maybe make more room. */
4418 if (gap_size
< trytry
)
4420 make_gap (total
- gap_size
);
4421 gap_size
= GAP_SIZE
;
4424 /* Read from the file, capturing `quit'. When an
4425 error occurs, end the loop, and arrange for a quit
4426 to be signaled after decoding the text we read. */
4427 non_regular_fd
= fd
;
4428 non_regular_inserted
= inserted
;
4429 non_regular_nbytes
= trytry
;
4430 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
4431 read_non_regular_quit
);
4442 /* Allow quitting out of the actual I/O. We don't make text
4443 part of the buffer until all the reading is done, so a C-g
4444 here doesn't do any harm. */
4447 this = emacs_read (fd
, BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ inserted
, trytry
);
4459 /* For a regular file, where TOTAL is the real size,
4460 count HOW_MUCH to compare with it.
4461 For a special file, where TOTAL is just a buffer size,
4462 so don't bother counting in HOW_MUCH.
4463 (INSERTED is where we count the number of characters inserted.) */
4470 /* Make the text read part of the buffer. */
4471 GAP_SIZE
-= inserted
;
4473 GPT_BYTE
+= inserted
;
4475 ZV_BYTE
+= inserted
;
4480 /* Put an anchor to ensure multi-byte form ends at gap. */
4485 /* Discard the unwind protect for closing the file. */
4489 error ("IO error reading %s: %s",
4490 SDATA (orig_filename
), emacs_strerror (errno
));
4494 if (! coding_system_decided
)
4496 /* The coding system is not yet decided. Decide it by an
4497 optimized method for handling `coding:' tag.
4499 Note that we can get here only if the buffer was empty
4500 before the insertion. */
4504 if (!NILP (Vcoding_system_for_read
))
4505 val
= Vcoding_system_for_read
;
4508 /* Since we are sure that the current buffer was empty
4509 before the insertion, we can toggle
4510 enable-multibyte-characters directly here without taking
4511 care of marker adjustment and byte combining problem. By
4512 this way, we can run Lisp program safely before decoding
4513 the inserted text. */
4514 Lisp_Object unwind_data
;
4515 int count
= SPECPDL_INDEX ();
4517 unwind_data
= Fcons (current_buffer
->enable_multibyte_characters
,
4518 Fcons (current_buffer
->undo_list
,
4519 Fcurrent_buffer ()));
4520 current_buffer
->enable_multibyte_characters
= Qnil
;
4521 current_buffer
->undo_list
= Qt
;
4522 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4524 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4526 val
= call2 (Vset_auto_coding_function
,
4527 filename
, make_number (inserted
));
4532 /* If the coding system is not yet decided, check
4533 file-coding-system-alist. */
4534 Lisp_Object args
[6], coding_systems
;
4536 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4537 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4538 coding_systems
= Ffind_operation_coding_system (6, args
);
4539 if (CONSP (coding_systems
))
4540 val
= XCAR (coding_systems
);
4543 unbind_to (count
, Qnil
);
4544 inserted
= Z_BYTE
- BEG_BYTE
;
4547 /* The following kludgy code is to avoid some compiler bug.
4549 setup_coding_system (val, &coding);
4552 struct coding_system temp_coding
;
4553 setup_coding_system (val
, &temp_coding
);
4554 bcopy (&temp_coding
, &coding
, sizeof coding
);
4556 /* Ensure we set Vlast_coding_system_used. */
4557 set_coding_system
= 1;
4559 if (NILP (current_buffer
->enable_multibyte_characters
)
4561 /* We must suppress all character code conversion except for
4562 end-of-line conversion. */
4563 setup_raw_text_coding_system (&coding
);
4564 coding
.src_multibyte
= 0;
4565 coding
.dst_multibyte
4566 = !NILP (current_buffer
->enable_multibyte_characters
);
4570 /* Can't do this if part of the buffer might be preserved. */
4572 && (coding
.type
== coding_type_no_conversion
4573 || coding
.type
== coding_type_raw_text
))
4575 /* Visiting a file with these coding system makes the buffer
4577 current_buffer
->enable_multibyte_characters
= Qnil
;
4578 coding
.dst_multibyte
= 0;
4581 if (inserted
> 0 || coding
.type
== coding_type_ccl
)
4583 if (CODING_MAY_REQUIRE_DECODING (&coding
))
4585 code_convert_region (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4587 inserted
= coding
.produced_char
;
4590 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4594 /* Now INSERTED is measured in characters. */
4597 /* Use the conversion type to determine buffer-file-type
4598 (find-buffer-file-type is now used to help determine the
4600 if ((coding
.eol_type
== CODING_EOL_UNDECIDED
4601 || coding
.eol_type
== CODING_EOL_LF
)
4602 && ! CODING_REQUIRE_DECODING (&coding
))
4603 current_buffer
->buffer_file_type
= Qt
;
4605 current_buffer
->buffer_file_type
= Qnil
;
4612 if (!EQ (current_buffer
->undo_list
, Qt
))
4613 current_buffer
->undo_list
= Qnil
;
4615 stat (SDATA (filename
), &st
);
4620 current_buffer
->modtime
= st
.st_mtime
;
4621 current_buffer
->filename
= orig_filename
;
4624 SAVE_MODIFF
= MODIFF
;
4625 current_buffer
->auto_save_modified
= MODIFF
;
4626 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4627 #ifdef CLASH_DETECTION
4630 if (!NILP (current_buffer
->file_truename
))
4631 unlock_file (current_buffer
->file_truename
);
4632 unlock_file (filename
);
4634 #endif /* CLASH_DETECTION */
4636 Fsignal (Qfile_error
,
4637 Fcons (build_string ("not a regular file"),
4638 Fcons (orig_filename
, Qnil
)));
4641 if (set_coding_system
)
4642 Vlast_coding_system_used
= coding
.symbol
;
4644 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4646 insval
= call1 (Qafter_insert_file_set_coding
, make_number (inserted
));
4647 if (! NILP (insval
))
4649 CHECK_NUMBER (insval
);
4650 inserted
= XFASTINT (insval
);
4654 /* Decode file format */
4657 int empty_undo_list_p
= 0;
4659 /* If we're anyway going to discard undo information, don't
4660 record it in the first place. The buffer's undo list at this
4661 point is either nil or t when visiting a file. */
4664 empty_undo_list_p
= NILP (current_buffer
->undo_list
);
4665 current_buffer
->undo_list
= Qt
;
4668 insval
= call3 (Qformat_decode
,
4669 Qnil
, make_number (inserted
), visit
);
4670 CHECK_NUMBER (insval
);
4671 inserted
= XFASTINT (insval
);
4674 current_buffer
->undo_list
= empty_undo_list_p
? Qnil
: Qt
;
4677 /* Call after-change hooks for the inserted text, aside from the case
4678 of normal visiting (not with REPLACE), which is done in a new buffer
4679 "before" the buffer is changed. */
4680 if (inserted
> 0 && total
> 0
4681 && (NILP (visit
) || !NILP (replace
)))
4683 signal_after_change (PT
, 0, inserted
);
4684 update_compositions (PT
, PT
, CHECK_BORDER
);
4687 p
= Vafter_insert_file_functions
;
4690 insval
= call1 (XCAR (p
), make_number (inserted
));
4693 CHECK_NUMBER (insval
);
4694 inserted
= XFASTINT (insval
);
4701 && current_buffer
->modtime
== -1)
4703 /* If visiting nonexistent file, return nil. */
4704 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4708 Fsignal (Qquit
, Qnil
);
4710 /* ??? Retval needs to be dealt with in all cases consistently. */
4712 val
= Fcons (orig_filename
,
4713 Fcons (make_number (inserted
),
4716 RETURN_UNGCPRO (unbind_to (count
, val
));
4719 static Lisp_Object build_annotations
P_ ((Lisp_Object
, Lisp_Object
));
4720 static Lisp_Object build_annotations_2
P_ ((Lisp_Object
, Lisp_Object
,
4721 Lisp_Object
, Lisp_Object
));
4723 /* If build_annotations switched buffers, switch back to BUF.
4724 Kill the temporary buffer that was selected in the meantime.
4726 Since this kill only the last temporary buffer, some buffers remain
4727 not killed if build_annotations switched buffers more than once.
4731 build_annotations_unwind (buf
)
4736 if (XBUFFER (buf
) == current_buffer
)
4738 tembuf
= Fcurrent_buffer ();
4740 Fkill_buffer (tembuf
);
4744 /* Decide the coding-system to encode the data with. */
4747 choose_write_coding_system (start
, end
, filename
,
4748 append
, visit
, lockname
, coding
)
4749 Lisp_Object start
, end
, filename
, append
, visit
, lockname
;
4750 struct coding_system
*coding
;
4755 && NILP (Fstring_equal (current_buffer
->filename
,
4756 current_buffer
->auto_save_file_name
)))
4758 /* We use emacs-mule for auto saving... */
4759 setup_coding_system (Qemacs_mule
, coding
);
4760 /* ... but with the special flag to indicate not to strip off
4761 leading code of eight-bit-control chars. */
4763 goto done_setup_coding
;
4765 else if (!NILP (Vcoding_system_for_write
))
4767 val
= Vcoding_system_for_write
;
4768 if (coding_system_require_warning
4769 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4770 /* Confirm that VAL can surely encode the current region. */
4771 val
= call5 (Vselect_safe_coding_system_function
,
4772 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4777 /* If the variable `buffer-file-coding-system' is set locally,
4778 it means that the file was read with some kind of code
4779 conversion or the variable is explicitly set by users. We
4780 had better write it out with the same coding system even if
4781 `enable-multibyte-characters' is nil.
4783 If it is not set locally, we anyway have to convert EOL
4784 format if the default value of `buffer-file-coding-system'
4785 tells that it is not Unix-like (LF only) format. */
4786 int using_default_coding
= 0;
4787 int force_raw_text
= 0;
4789 val
= current_buffer
->buffer_file_coding_system
;
4791 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4794 if (NILP (current_buffer
->enable_multibyte_characters
))
4800 /* Check file-coding-system-alist. */
4801 Lisp_Object args
[7], coding_systems
;
4803 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4804 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4806 coding_systems
= Ffind_operation_coding_system (7, args
);
4807 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4808 val
= XCDR (coding_systems
);
4812 && !NILP (current_buffer
->buffer_file_coding_system
))
4814 /* If we still have not decided a coding system, use the
4815 default value of buffer-file-coding-system. */
4816 val
= current_buffer
->buffer_file_coding_system
;
4817 using_default_coding
= 1;
4821 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4822 /* Confirm that VAL can surely encode the current region. */
4823 val
= call5 (Vselect_safe_coding_system_function
,
4824 start
, end
, val
, Qnil
, filename
);
4826 setup_coding_system (Fcheck_coding_system (val
), coding
);
4827 if (coding
->eol_type
== CODING_EOL_UNDECIDED
4828 && !using_default_coding
)
4830 if (! EQ (default_buffer_file_coding
.symbol
,
4831 buffer_defaults
.buffer_file_coding_system
))
4832 setup_coding_system (buffer_defaults
.buffer_file_coding_system
,
4833 &default_buffer_file_coding
);
4834 if (default_buffer_file_coding
.eol_type
!= CODING_EOL_UNDECIDED
)
4836 Lisp_Object subsidiaries
;
4838 coding
->eol_type
= default_buffer_file_coding
.eol_type
;
4839 subsidiaries
= Fget (coding
->symbol
, Qeol_type
);
4840 if (VECTORP (subsidiaries
)
4841 && XVECTOR (subsidiaries
)->size
== 3)
4843 = XVECTOR (subsidiaries
)->contents
[coding
->eol_type
];
4848 setup_raw_text_coding_system (coding
);
4849 goto done_setup_coding
;
4852 setup_coding_system (Fcheck_coding_system (val
), coding
);
4855 if (!STRINGP (start
) && !NILP (current_buffer
->selective_display
))
4856 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4859 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4860 "r\nFWrite region to file: \ni\ni\ni\np",
4861 doc
: /* Write current region into specified file.
4862 When called from a program, requires three arguments:
4863 START, END and FILENAME. START and END are normally buffer positions
4864 specifying the part of the buffer to write.
4865 If START is nil, that means to use the entire buffer contents.
4866 If START is a string, then output that string to the file
4867 instead of any buffer contents; END is ignored.
4869 Optional fourth argument APPEND if non-nil means
4870 append to existing file contents (if any). If it is an integer,
4871 seek to that offset in the file before writing.
4872 Optional fifth argument VISIT, if t or a string, means
4873 set the last-save-file-modtime of buffer to this file's modtime
4874 and mark buffer not modified.
4875 If VISIT is a string, it is a second file name;
4876 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4877 VISIT is also the file name to lock and unlock for clash detection.
4878 If VISIT is neither t nor nil nor a string,
4879 that means do not display the \"Wrote file\" message.
4880 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4881 use for locking and unlocking, overriding FILENAME and VISIT.
4882 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4883 for an existing file with the same name. If MUSTBENEW is `excl',
4884 that means to get an error if the file already exists; never overwrite.
4885 If MUSTBENEW is neither nil nor `excl', that means ask for
4886 confirmation before overwriting, but do go ahead and overwrite the file
4887 if the user confirms.
4889 This does code conversion according to the value of
4890 `coding-system-for-write', `buffer-file-coding-system', or
4891 `file-coding-system-alist', and sets the variable
4892 `last-coding-system-used' to the coding system actually used. */)
4893 (start
, end
, filename
, append
, visit
, lockname
, mustbenew
)
4894 Lisp_Object start
, end
, filename
, append
, visit
, lockname
, mustbenew
;
4899 const unsigned char *fn
;
4902 int count
= SPECPDL_INDEX ();
4905 unsigned char *fname
= 0; /* If non-0, original filename (must rename) */
4907 Lisp_Object handler
;
4908 Lisp_Object visit_file
;
4909 Lisp_Object annotations
;
4910 Lisp_Object encoded_filename
;
4911 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4912 int quietly
= !NILP (visit
);
4913 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4914 struct buffer
*given_buffer
;
4916 int buffer_file_type
= O_BINARY
;
4918 struct coding_system coding
;
4920 if (current_buffer
->base_buffer
&& visiting
)
4921 error ("Cannot do file visiting in an indirect buffer");
4923 if (!NILP (start
) && !STRINGP (start
))
4924 validate_region (&start
, &end
);
4926 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
4928 filename
= Fexpand_file_name (filename
, Qnil
);
4930 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
4931 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
4933 if (STRINGP (visit
))
4934 visit_file
= Fexpand_file_name (visit
, Qnil
);
4936 visit_file
= filename
;
4938 if (NILP (lockname
))
4939 lockname
= visit_file
;
4943 /* If the file name has special constructs in it,
4944 call the corresponding file handler. */
4945 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
4946 /* If FILENAME has no handler, see if VISIT has one. */
4947 if (NILP (handler
) && STRINGP (visit
))
4948 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
4950 if (!NILP (handler
))
4953 val
= call6 (handler
, Qwrite_region
, start
, end
,
4954 filename
, append
, visit
);
4958 SAVE_MODIFF
= MODIFF
;
4959 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4960 current_buffer
->filename
= visit_file
;
4966 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
4968 /* Special kludge to simplify auto-saving. */
4971 XSETFASTINT (start
, BEG
);
4972 XSETFASTINT (end
, Z
);
4976 record_unwind_protect (build_annotations_unwind
, Fcurrent_buffer ());
4977 count1
= SPECPDL_INDEX ();
4979 given_buffer
= current_buffer
;
4981 if (!STRINGP (start
))
4983 annotations
= build_annotations (start
, end
);
4985 if (current_buffer
!= given_buffer
)
4987 XSETFASTINT (start
, BEGV
);
4988 XSETFASTINT (end
, ZV
);
4994 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
4996 /* Decide the coding-system to encode the data with.
4997 We used to make this choice before calling build_annotations, but that
4998 leads to problems when a write-annotate-function takes care of
4999 unsavable chars (as was the case with X-Symbol). */
5000 choose_write_coding_system (start
, end
, filename
,
5001 append
, visit
, lockname
, &coding
);
5002 Vlast_coding_system_used
= coding
.symbol
;
5004 given_buffer
= current_buffer
;
5005 if (! STRINGP (start
))
5007 annotations
= build_annotations_2 (start
, end
,
5008 coding
.pre_write_conversion
, annotations
);
5009 if (current_buffer
!= given_buffer
)
5011 XSETFASTINT (start
, BEGV
);
5012 XSETFASTINT (end
, ZV
);
5016 #ifdef CLASH_DETECTION
5019 #if 0 /* This causes trouble for GNUS. */
5020 /* If we've locked this file for some other buffer,
5021 query before proceeding. */
5022 if (!visiting
&& EQ (Ffile_locked_p (lockname
), Qt
))
5023 call2 (intern ("ask-user-about-lock"), filename
, Vuser_login_name
);
5026 lock_file (lockname
);
5028 #endif /* CLASH_DETECTION */
5030 encoded_filename
= ENCODE_FILE (filename
);
5032 fn
= SDATA (encoded_filename
);
5036 desc
= emacs_open (fn
, O_WRONLY
| buffer_file_type
, 0);
5037 #else /* not DOS_NT */
5038 desc
= emacs_open (fn
, O_WRONLY
, 0);
5039 #endif /* not DOS_NT */
5041 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
5043 if (auto_saving
) /* Overwrite any previous version of autosave file */
5045 vms_truncate (fn
); /* if fn exists, truncate to zero length */
5046 desc
= emacs_open (fn
, O_RDWR
, 0);
5048 desc
= creat_copy_attrs (STRINGP (current_buffer
->filename
)
5049 ? SDATA (current_buffer
->filename
) : 0,
5052 else /* Write to temporary name and rename if no errors */
5054 Lisp_Object temp_name
;
5055 temp_name
= Ffile_name_directory (filename
);
5057 if (!NILP (temp_name
))
5059 temp_name
= Fmake_temp_name (concat2 (temp_name
,
5060 build_string ("$$SAVE$$")));
5061 fname
= SDATA (filename
);
5062 fn
= SDATA (temp_name
);
5063 desc
= creat_copy_attrs (fname
, fn
);
5066 /* If we can't open the temporary file, try creating a new
5067 version of the original file. VMS "creat" creates a
5068 new version rather than truncating an existing file. */
5071 desc
= creat (fn
, 0666);
5072 #if 0 /* This can clobber an existing file and fail to replace it,
5073 if the user runs out of space. */
5076 /* We can't make a new version;
5077 try to truncate and rewrite existing version if any. */
5079 desc
= emacs_open (fn
, O_RDWR
, 0);
5085 desc
= creat (fn
, 0666);
5089 desc
= emacs_open (fn
,
5090 O_WRONLY
| O_CREAT
| buffer_file_type
5091 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
5092 S_IREAD
| S_IWRITE
);
5093 #else /* not DOS_NT */
5094 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
5095 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
5096 auto_saving
? auto_save_mode_bits
: 0666);
5097 #endif /* not DOS_NT */
5098 #endif /* not VMS */
5102 #ifdef CLASH_DETECTION
5104 if (!auto_saving
) unlock_file (lockname
);
5106 #endif /* CLASH_DETECTION */
5108 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
5111 record_unwind_protect (close_file_unwind
, make_number (desc
));
5113 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
5117 if (NUMBERP (append
))
5118 ret
= lseek (desc
, XINT (append
), 1);
5120 ret
= lseek (desc
, 0, 2);
5123 #ifdef CLASH_DETECTION
5124 if (!auto_saving
) unlock_file (lockname
);
5125 #endif /* CLASH_DETECTION */
5127 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
5135 * Kludge Warning: The VMS C RTL likes to insert carriage returns
5136 * if we do writes that don't end with a carriage return. Furthermore
5137 * it cannot handle writes of more then 16K. The modified
5138 * version of "sys_write" in SYSDEP.C (see comment there) copes with
5139 * this EXCEPT for the last record (iff it doesn't end with a carriage
5140 * return). This implies that if your buffer doesn't end with a carriage
5141 * return, you get one free... tough. However it also means that if
5142 * we make two calls to sys_write (a la the following code) you can
5143 * get one at the gap as well. The easiest way to fix this (honest)
5144 * is to move the gap to the next newline (or the end of the buffer).
5149 if (GPT
> BEG
&& GPT_ADDR
[-1] != '\n')
5150 move_gap (find_next_newline (GPT
, 1));
5152 /* Whether VMS or not, we must move the gap to the next of newline
5153 when we must put designation sequences at beginning of line. */
5154 if (INTEGERP (start
)
5155 && coding
.type
== coding_type_iso2022
5156 && coding
.flags
& CODING_FLAG_ISO_DESIGNATE_AT_BOL
5157 && GPT
> BEG
&& GPT_ADDR
[-1] != '\n')
5159 int opoint
= PT
, opoint_byte
= PT_BYTE
;
5160 scan_newline (PT
, PT_BYTE
, ZV
, ZV_BYTE
, 1, 0);
5161 move_gap_both (PT
, PT_BYTE
);
5162 SET_PT_BOTH (opoint
, opoint_byte
);
5169 if (STRINGP (start
))
5171 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
5172 &annotations
, &coding
);
5175 else if (XINT (start
) != XINT (end
))
5177 tem
= CHAR_TO_BYTE (XINT (start
));
5179 if (XINT (start
) < GPT
)
5181 failure
= 0 > a_write (desc
, Qnil
, XINT (start
),
5182 min (GPT
, XINT (end
)) - XINT (start
),
5183 &annotations
, &coding
);
5187 if (XINT (end
) > GPT
&& !failure
)
5189 tem
= max (XINT (start
), GPT
);
5190 failure
= 0 > a_write (desc
, Qnil
, tem
, XINT (end
) - tem
,
5191 &annotations
, &coding
);
5197 /* If file was empty, still need to write the annotations */
5198 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
5199 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
5203 if (CODING_REQUIRE_FLUSHING (&coding
)
5204 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
5207 /* We have to flush out a data. */
5208 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
5209 failure
= 0 > e_write (desc
, Qnil
, 0, 0, &coding
);
5216 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
5217 Disk full in NFS may be reported here. */
5218 /* mib says that closing the file will try to write as fast as NFS can do
5219 it, and that means the fsync here is not crucial for autosave files. */
5220 if (!auto_saving
&& fsync (desc
) < 0)
5222 /* If fsync fails with EINTR, don't treat that as serious. */
5224 failure
= 1, save_errno
= errno
;
5228 /* Spurious "file has changed on disk" warnings have been
5229 observed on Suns as well.
5230 It seems that `close' can change the modtime, under nfs.
5232 (This has supposedly been fixed in Sunos 4,
5233 but who knows about all the other machines with NFS?) */
5236 /* On VMS and APOLLO, must do the stat after the close
5237 since closing changes the modtime. */
5240 /* Recall that #if defined does not work on VMS. */
5247 /* NFS can report a write failure now. */
5248 if (emacs_close (desc
) < 0)
5249 failure
= 1, save_errno
= errno
;
5252 /* If we wrote to a temporary name and had no errors, rename to real name. */
5256 failure
= (rename (fn
, fname
) != 0), save_errno
= errno
;
5264 /* Discard the unwind protect for close_file_unwind. */
5265 specpdl_ptr
= specpdl
+ count1
;
5266 /* Restore the original current buffer. */
5267 visit_file
= unbind_to (count
, visit_file
);
5269 #ifdef CLASH_DETECTION
5271 unlock_file (lockname
);
5272 #endif /* CLASH_DETECTION */
5274 /* Do this before reporting IO error
5275 to avoid a "file has changed on disk" warning on
5276 next attempt to save. */
5278 current_buffer
->modtime
= st
.st_mtime
;
5281 error ("IO error writing %s: %s", SDATA (filename
),
5282 emacs_strerror (save_errno
));
5286 SAVE_MODIFF
= MODIFF
;
5287 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5288 current_buffer
->filename
= visit_file
;
5289 update_mode_lines
++;
5294 && ! NILP (Fstring_equal (current_buffer
->filename
,
5295 current_buffer
->auto_save_file_name
)))
5296 SAVE_MODIFF
= MODIFF
;
5302 message_with_string ((INTEGERP (append
)
5312 Lisp_Object
merge ();
5314 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5315 doc
: /* Return t if (car A) is numerically less than (car B). */)
5319 return Flss (Fcar (a
), Fcar (b
));
5322 /* Build the complete list of annotations appropriate for writing out
5323 the text between START and END, by calling all the functions in
5324 write-region-annotate-functions and merging the lists they return.
5325 If one of these functions switches to a different buffer, we assume
5326 that buffer contains altered text. Therefore, the caller must
5327 make sure to restore the current buffer in all cases,
5328 as save-excursion would do. */
5331 build_annotations (start
, end
)
5332 Lisp_Object start
, end
;
5334 Lisp_Object annotations
;
5336 struct gcpro gcpro1
, gcpro2
;
5337 Lisp_Object original_buffer
;
5338 int i
, used_global
= 0;
5340 XSETBUFFER (original_buffer
, current_buffer
);
5343 p
= Vwrite_region_annotate_functions
;
5344 GCPRO2 (annotations
, p
);
5347 struct buffer
*given_buffer
= current_buffer
;
5348 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5349 { /* Use the global value of the hook. */
5352 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5354 p
= Fappend (2, arg
);
5357 Vwrite_region_annotations_so_far
= annotations
;
5358 res
= call2 (XCAR (p
), start
, end
);
5359 /* If the function makes a different buffer current,
5360 assume that means this buffer contains altered text to be output.
5361 Reset START and END from the buffer bounds
5362 and discard all previous annotations because they should have
5363 been dealt with by this function. */
5364 if (current_buffer
!= given_buffer
)
5366 XSETFASTINT (start
, BEGV
);
5367 XSETFASTINT (end
, ZV
);
5370 Flength (res
); /* Check basic validity of return value */
5371 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5375 /* Now do the same for annotation functions implied by the file-format */
5376 if (auto_saving
&& (!EQ (current_buffer
->auto_save_file_format
, Qt
)))
5377 p
= current_buffer
->auto_save_file_format
;
5379 p
= current_buffer
->file_format
;
5380 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5382 struct buffer
*given_buffer
= current_buffer
;
5384 Vwrite_region_annotations_so_far
= annotations
;
5386 /* Value is either a list of annotations or nil if the function
5387 has written annotations to a temporary buffer, which is now
5389 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5390 original_buffer
, make_number (i
));
5391 if (current_buffer
!= given_buffer
)
5393 XSETFASTINT (start
, BEGV
);
5394 XSETFASTINT (end
, ZV
);
5399 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5407 build_annotations_2 (start
, end
, pre_write_conversion
, annotations
)
5408 Lisp_Object start
, end
, pre_write_conversion
, annotations
;
5410 struct gcpro gcpro1
;
5413 GCPRO1 (annotations
);
5414 /* At last, do the same for the function PRE_WRITE_CONVERSION
5415 implied by the current coding-system. */
5416 if (!NILP (pre_write_conversion
))
5418 struct buffer
*given_buffer
= current_buffer
;
5419 Vwrite_region_annotations_so_far
= annotations
;
5420 res
= call2 (pre_write_conversion
, start
, end
);
5422 annotations
= (current_buffer
!= given_buffer
5424 : merge (annotations
, res
, Qcar_less_than_car
));
5431 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5432 If STRING is nil, POS is the character position in the current buffer.
5433 Intersperse with them the annotations from *ANNOT
5434 which fall within the range of POS to POS + NCHARS,
5435 each at its appropriate position.
5437 We modify *ANNOT by discarding elements as we use them up.
5439 The return value is negative in case of system call failure. */
5442 a_write (desc
, string
, pos
, nchars
, annot
, coding
)
5445 register int nchars
;
5448 struct coding_system
*coding
;
5452 int lastpos
= pos
+ nchars
;
5454 while (NILP (*annot
) || CONSP (*annot
))
5456 tem
= Fcar_safe (Fcar (*annot
));
5459 nextpos
= XFASTINT (tem
);
5461 /* If there are no more annotations in this range,
5462 output the rest of the range all at once. */
5463 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5464 return e_write (desc
, string
, pos
, lastpos
, coding
);
5466 /* Output buffer text up to the next annotation's position. */
5469 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
5473 /* Output the annotation. */
5474 tem
= Fcdr (Fcar (*annot
));
5477 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5480 *annot
= Fcdr (*annot
);
5485 #ifndef WRITE_BUF_SIZE
5486 #define WRITE_BUF_SIZE (16 * 1024)
5489 /* Write text in the range START and END into descriptor DESC,
5490 encoding them with coding system CODING. If STRING is nil, START
5491 and END are character positions of the current buffer, else they
5492 are indexes to the string STRING. */
5495 e_write (desc
, string
, start
, end
, coding
)
5499 struct coding_system
*coding
;
5501 register char *addr
;
5502 register int nbytes
;
5503 char buf
[WRITE_BUF_SIZE
];
5507 coding
->composing
= COMPOSITION_DISABLED
;
5508 if (coding
->composing
!= COMPOSITION_DISABLED
)
5509 coding_save_composition (coding
, start
, end
, string
);
5511 if (STRINGP (string
))
5513 addr
= SDATA (string
);
5514 nbytes
= SBYTES (string
);
5515 coding
->src_multibyte
= STRING_MULTIBYTE (string
);
5517 else if (start
< end
)
5519 /* It is assured that the gap is not in the range START and END-1. */
5520 addr
= CHAR_POS_ADDR (start
);
5521 nbytes
= CHAR_TO_BYTE (end
) - CHAR_TO_BYTE (start
);
5522 coding
->src_multibyte
5523 = !NILP (current_buffer
->enable_multibyte_characters
);
5529 coding
->src_multibyte
= 1;
5532 /* We used to have a code for handling selective display here. But,
5533 now it is handled within encode_coding. */
5538 result
= encode_coding (coding
, addr
, buf
, nbytes
, WRITE_BUF_SIZE
);
5539 if (coding
->produced
> 0)
5541 coding
->produced
-= emacs_write (desc
, buf
, coding
->produced
);
5542 if (coding
->produced
)
5548 nbytes
-= coding
->consumed
;
5549 addr
+= coding
->consumed
;
5550 if (result
== CODING_FINISH_INSUFFICIENT_SRC
5553 /* The source text ends by an incomplete multibyte form.
5554 There's no way other than write it out as is. */
5555 nbytes
-= emacs_write (desc
, addr
, nbytes
);
5564 start
+= coding
->consumed_char
;
5565 if (coding
->cmp_data
)
5566 coding_adjust_composition_offset (coding
, start
);
5569 if (coding
->cmp_data
)
5570 coding_free_composition_data (coding
);
5575 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5576 Sverify_visited_file_modtime
, 1, 1, 0,
5577 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5578 This means that the file has not been changed since it was visited or saved.
5579 See Info node `(elisp)Modification Time' for more details. */)
5585 Lisp_Object handler
;
5586 Lisp_Object filename
;
5591 if (!STRINGP (b
->filename
)) return Qt
;
5592 if (b
->modtime
== 0) return Qt
;
5594 /* If the file name has special constructs in it,
5595 call the corresponding file handler. */
5596 handler
= Ffind_file_name_handler (b
->filename
,
5597 Qverify_visited_file_modtime
);
5598 if (!NILP (handler
))
5599 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5601 filename
= ENCODE_FILE (b
->filename
);
5603 if (stat (SDATA (filename
), &st
) < 0)
5605 /* If the file doesn't exist now and didn't exist before,
5606 we say that it isn't modified, provided the error is a tame one. */
5607 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
5612 if (st
.st_mtime
== b
->modtime
5613 /* If both are positive, accept them if they are off by one second. */
5614 || (st
.st_mtime
> 0 && b
->modtime
> 0
5615 && (st
.st_mtime
== b
->modtime
+ 1
5616 || st
.st_mtime
== b
->modtime
- 1)))
5621 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5622 Sclear_visited_file_modtime
, 0, 0, 0,
5623 doc
: /* Clear out records of last mod time of visited file.
5624 Next attempt to save will certainly not complain of a discrepancy. */)
5627 current_buffer
->modtime
= 0;
5631 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5632 Svisited_file_modtime
, 0, 0, 0,
5633 doc
: /* Return the current buffer's recorded visited file modification time.
5634 The value is a list of the form (HIGH LOW), like the time values
5635 that `file-attributes' returns. If the current buffer has no recorded
5636 file modification time, this function returns 0.
5637 See Info node `(elisp)Modification Time' for more details. */)
5641 tcons
= long_to_cons ((unsigned long) current_buffer
->modtime
);
5643 return list2 (XCAR (tcons
), XCDR (tcons
));
5647 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5648 Sset_visited_file_modtime
, 0, 1, 0,
5649 doc
: /* Update buffer's recorded modification time from the visited file's time.
5650 Useful if the buffer was not read from the file normally
5651 or if the file itself has been changed for some known benign reason.
5652 An argument specifies the modification time value to use
5653 \(instead of that of the visited file), in the form of a list
5654 \(HIGH . LOW) or (HIGH LOW). */)
5656 Lisp_Object time_list
;
5658 if (!NILP (time_list
))
5659 current_buffer
->modtime
= cons_to_long (time_list
);
5662 register Lisp_Object filename
;
5664 Lisp_Object handler
;
5666 filename
= Fexpand_file_name (current_buffer
->filename
, Qnil
);
5668 /* If the file name has special constructs in it,
5669 call the corresponding file handler. */
5670 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5671 if (!NILP (handler
))
5672 /* The handler can find the file name the same way we did. */
5673 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5675 filename
= ENCODE_FILE (filename
);
5677 if (stat (SDATA (filename
), &st
) >= 0)
5678 current_buffer
->modtime
= st
.st_mtime
;
5685 auto_save_error (error
)
5688 Lisp_Object args
[3], msg
;
5690 struct gcpro gcpro1
;
5694 args
[0] = build_string ("Auto-saving %s: %s");
5695 args
[1] = current_buffer
->name
;
5696 args
[2] = Ferror_message_string (error
);
5697 msg
= Fformat (3, args
);
5699 nbytes
= SBYTES (msg
);
5701 for (i
= 0; i
< 3; ++i
)
5704 message2 (SDATA (msg
), nbytes
, STRING_MULTIBYTE (msg
));
5706 message2_nolog (SDATA (msg
), nbytes
, STRING_MULTIBYTE (msg
));
5707 Fsleep_for (make_number (1), Qnil
);
5720 auto_save_mode_bits
= 0666;
5722 /* Get visited file's mode to become the auto save file's mode. */
5723 if (! NILP (current_buffer
->filename
))
5725 if (stat (SDATA (current_buffer
->filename
), &st
) >= 0)
5726 /* But make sure we can overwrite it later! */
5727 auto_save_mode_bits
= st
.st_mode
| 0600;
5728 else if ((modes
= Ffile_modes (current_buffer
->filename
),
5730 /* Remote files don't cooperate with stat. */
5731 auto_save_mode_bits
= XINT (modes
) | 0600;
5735 Fwrite_region (Qnil
, Qnil
,
5736 current_buffer
->auto_save_file_name
,
5737 Qnil
, Qlambda
, Qnil
, Qnil
);
5741 do_auto_save_unwind (stream
) /* used as unwind-protect function */
5746 fclose ((FILE *) (XFASTINT (XCAR (stream
)) << 16
5747 | XFASTINT (XCDR (stream
))));
5752 do_auto_save_unwind_1 (value
) /* used as unwind-protect function */
5755 minibuffer_auto_raise
= XINT (value
);
5760 do_auto_save_make_dir (dir
)
5763 return call2 (Qmake_directory
, dir
, Qt
);
5767 do_auto_save_eh (ignore
)
5773 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5774 doc
: /* Auto-save all buffers that need it.
5775 This is all buffers that have auto-saving enabled
5776 and are changed since last auto-saved.
5777 Auto-saving writes the buffer into a file
5778 so that your editing is not lost if the system crashes.
5779 This file is not the file you visited; that changes only when you save.
5780 Normally we run the normal hook `auto-save-hook' before saving.
5782 A non-nil NO-MESSAGE argument means do not print any message if successful.
5783 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5784 (no_message
, current_only
)
5785 Lisp_Object no_message
, current_only
;
5787 struct buffer
*old
= current_buffer
, *b
;
5788 Lisp_Object tail
, buf
;
5790 int do_handled_files
;
5793 Lisp_Object lispstream
;
5794 int count
= SPECPDL_INDEX ();
5795 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5796 int old_message_p
= 0;
5797 struct gcpro gcpro1
, gcpro2
;
5799 if (max_specpdl_size
< specpdl_size
+ 40)
5800 max_specpdl_size
= specpdl_size
+ 40;
5805 if (NILP (no_message
))
5807 old_message_p
= push_message ();
5808 record_unwind_protect (pop_message_unwind
, Qnil
);
5811 /* Ordinarily don't quit within this function,
5812 but don't make it impossible to quit (in case we get hung in I/O). */
5816 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5817 point to non-strings reached from Vbuffer_alist. */
5819 if (!NILP (Vrun_hooks
))
5820 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5822 if (STRINGP (Vauto_save_list_file_name
))
5824 Lisp_Object listfile
;
5826 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5828 /* Don't try to create the directory when shutting down Emacs,
5829 because creating the directory might signal an error, and
5830 that would leave Emacs in a strange state. */
5831 if (!NILP (Vrun_hooks
))
5835 GCPRO2 (dir
, listfile
);
5836 dir
= Ffile_name_directory (listfile
);
5837 if (NILP (Ffile_directory_p (dir
)))
5838 internal_condition_case_1 (do_auto_save_make_dir
,
5839 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5844 stream
= fopen (SDATA (listfile
), "w");
5847 /* Arrange to close that file whether or not we get an error.
5848 Also reset auto_saving to 0. */
5849 lispstream
= Fcons (Qnil
, Qnil
);
5850 XSETCARFASTINT (lispstream
, (EMACS_UINT
)stream
>> 16);
5851 XSETCDRFASTINT (lispstream
, (EMACS_UINT
)stream
& 0xffff);
5862 record_unwind_protect (do_auto_save_unwind
, lispstream
);
5863 record_unwind_protect (do_auto_save_unwind_1
,
5864 make_number (minibuffer_auto_raise
));
5865 minibuffer_auto_raise
= 0;
5868 /* On first pass, save all files that don't have handlers.
5869 On second pass, save all files that do have handlers.
5871 If Emacs is crashing, the handlers may tweak what is causing
5872 Emacs to crash in the first place, and it would be a shame if
5873 Emacs failed to autosave perfectly ordinary files because it
5874 couldn't handle some ange-ftp'd file. */
5876 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5877 for (tail
= Vbuffer_alist
; GC_CONSP (tail
); tail
= XCDR (tail
))
5879 buf
= XCDR (XCAR (tail
));
5882 /* Record all the buffers that have auto save mode
5883 in the special file that lists them. For each of these buffers,
5884 Record visited name (if any) and auto save name. */
5885 if (STRINGP (b
->auto_save_file_name
)
5886 && stream
!= NULL
&& do_handled_files
== 0)
5888 if (!NILP (b
->filename
))
5890 fwrite (SDATA (b
->filename
), 1,
5891 SBYTES (b
->filename
), stream
);
5893 putc ('\n', stream
);
5894 fwrite (SDATA (b
->auto_save_file_name
), 1,
5895 SBYTES (b
->auto_save_file_name
), stream
);
5896 putc ('\n', stream
);
5899 if (!NILP (current_only
)
5900 && b
!= current_buffer
)
5903 /* Don't auto-save indirect buffers.
5904 The base buffer takes care of it. */
5908 /* Check for auto save enabled
5909 and file changed since last auto save
5910 and file changed since last real save. */
5911 if (STRINGP (b
->auto_save_file_name
)
5912 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5913 && b
->auto_save_modified
< BUF_MODIFF (b
)
5914 /* -1 means we've turned off autosaving for a while--see below. */
5915 && XINT (b
->save_length
) >= 0
5916 && (do_handled_files
5917 || NILP (Ffind_file_name_handler (b
->auto_save_file_name
,
5920 EMACS_TIME before_time
, after_time
;
5922 EMACS_GET_TIME (before_time
);
5924 /* If we had a failure, don't try again for 20 minutes. */
5925 if (b
->auto_save_failure_time
>= 0
5926 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
5929 if ((XFASTINT (b
->save_length
) * 10
5930 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
5931 /* A short file is likely to change a large fraction;
5932 spare the user annoying messages. */
5933 && XFASTINT (b
->save_length
) > 5000
5934 /* These messages are frequent and annoying for `*mail*'. */
5935 && !EQ (b
->filename
, Qnil
)
5936 && NILP (no_message
))
5938 /* It has shrunk too much; turn off auto-saving here. */
5939 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
5940 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5942 minibuffer_auto_raise
= 0;
5943 /* Turn off auto-saving until there's a real save,
5944 and prevent any more warnings. */
5945 XSETINT (b
->save_length
, -1);
5946 Fsleep_for (make_number (1), Qnil
);
5949 set_buffer_internal (b
);
5950 if (!auto_saved
&& NILP (no_message
))
5951 message1 ("Auto-saving...");
5952 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
5954 b
->auto_save_modified
= BUF_MODIFF (b
);
5955 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5956 set_buffer_internal (old
);
5958 EMACS_GET_TIME (after_time
);
5960 /* If auto-save took more than 60 seconds,
5961 assume it was an NFS failure that got a timeout. */
5962 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
5963 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
5967 /* Prevent another auto save till enough input events come in. */
5968 record_auto_save ();
5970 if (auto_saved
&& NILP (no_message
))
5974 /* If we are going to restore an old message,
5975 give time to read ours. */
5976 sit_for (1, 0, 0, 0, 0);
5980 /* If we displayed a message and then restored a state
5981 with no message, leave a "done" message on the screen. */
5982 message1 ("Auto-saving...done");
5987 /* This restores the message-stack status. */
5988 unbind_to (count
, Qnil
);
5992 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
5993 Sset_buffer_auto_saved
, 0, 0, 0,
5994 doc
: /* Mark current buffer as auto-saved with its current text.
5995 No auto-save file will be written until the buffer changes again. */)
5998 current_buffer
->auto_save_modified
= MODIFF
;
5999 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
6000 current_buffer
->auto_save_failure_time
= -1;
6004 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
6005 Sclear_buffer_auto_save_failure
, 0, 0, 0,
6006 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
6009 current_buffer
->auto_save_failure_time
= -1;
6013 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
6015 doc
: /* Return t if buffer has been auto-saved since last read in or saved. */)
6018 return (SAVE_MODIFF
< current_buffer
->auto_save_modified
) ? Qt
: Qnil
;
6021 /* Reading and completing file names */
6022 extern Lisp_Object
Ffile_name_completion (), Ffile_name_all_completions ();
6024 /* In the string VAL, change each $ to $$ and return the result. */
6027 double_dollars (val
)
6030 register const unsigned char *old
;
6031 register unsigned char *new;
6035 osize
= SBYTES (val
);
6037 /* Count the number of $ characters. */
6038 for (n
= osize
, count
= 0, old
= SDATA (val
); n
> 0; n
--)
6039 if (*old
++ == '$') count
++;
6043 val
= make_uninit_multibyte_string (SCHARS (val
) + count
,
6046 for (n
= osize
; n
> 0; n
--)
6060 read_file_name_cleanup (arg
)
6063 return (current_buffer
->directory
= arg
);
6066 DEFUN ("read-file-name-internal", Fread_file_name_internal
, Sread_file_name_internal
,
6068 doc
: /* Internal subroutine for read-file-name. Do not call this. */)
6069 (string
, dir
, action
)
6070 Lisp_Object string
, dir
, action
;
6071 /* action is nil for complete, t for return list of completions,
6072 lambda for verify final value */
6074 Lisp_Object name
, specdir
, realdir
, val
, orig_string
;
6076 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
6078 CHECK_STRING (string
);
6085 /* No need to protect ACTION--we only compare it with t and nil. */
6086 GCPRO5 (string
, realdir
, name
, specdir
, orig_string
);
6088 if (SCHARS (string
) == 0)
6090 if (EQ (action
, Qlambda
))
6098 orig_string
= string
;
6099 string
= Fsubstitute_in_file_name (string
);
6100 changed
= NILP (Fstring_equal (string
, orig_string
));
6101 name
= Ffile_name_nondirectory (string
);
6102 val
= Ffile_name_directory (string
);
6104 realdir
= Fexpand_file_name (val
, realdir
);
6109 specdir
= Ffile_name_directory (string
);
6110 val
= Ffile_name_completion (name
, realdir
);
6115 return double_dollars (string
);
6119 if (!NILP (specdir
))
6120 val
= concat2 (specdir
, val
);
6122 return double_dollars (val
);
6125 #endif /* not VMS */
6129 if (EQ (action
, Qt
))
6131 Lisp_Object all
= Ffile_name_all_completions (name
, realdir
);
6135 if (NILP (Vread_file_name_predicate
)
6136 || EQ (Vread_file_name_predicate
, Qfile_exists_p
))
6140 if (EQ (Vread_file_name_predicate
, Qfile_directory_p
))
6142 /* Brute-force speed up for directory checking:
6143 Discard strings which don't end in a slash. */
6144 for (comp
= Qnil
; CONSP (all
); all
= XCDR (all
))
6146 Lisp_Object tem
= XCAR (all
);
6148 if (STRINGP (tem
) &&
6149 (len
= SCHARS (tem
), len
> 0) &&
6150 IS_DIRECTORY_SEP (SREF (tem
, len
-1)))
6151 comp
= Fcons (tem
, comp
);
6157 /* Must do it the hard (and slow) way. */
6158 GCPRO3 (all
, comp
, specdir
);
6159 count
= SPECPDL_INDEX ();
6160 record_unwind_protect (read_file_name_cleanup
, current_buffer
->directory
);
6161 current_buffer
->directory
= realdir
;
6162 for (comp
= Qnil
; CONSP (all
); all
= XCDR (all
))
6163 if (!NILP (call1 (Vread_file_name_predicate
, XCAR (all
))))
6164 comp
= Fcons (XCAR (all
), comp
);
6165 unbind_to (count
, Qnil
);
6168 return Fnreverse (comp
);
6171 /* Only other case actually used is ACTION = lambda */
6173 /* Supposedly this helps commands such as `cd' that read directory names,
6174 but can someone explain how it helps them? -- RMS */
6175 if (SCHARS (name
) == 0)
6178 string
= Fexpand_file_name (string
, dir
);
6179 if (!NILP (Vread_file_name_predicate
))
6180 return call1 (Vread_file_name_predicate
, string
);
6181 return Ffile_exists_p (string
);
6184 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
6185 Snext_read_file_uses_dialog_p
, 0, 0, 0,
6186 doc
: /* Return t if a call to `read-file-name' will use a dialog.
6187 The return value is only relevant for a call to `read-file-name' that happens
6188 before any other event (mouse or keypress) is handeled. */)
6191 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6192 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
6201 DEFUN ("read-file-name", Fread_file_name
, Sread_file_name
, 1, 6, 0,
6202 doc
: /* Read file name, prompting with PROMPT and completing in directory DIR.
6203 Value is not expanded---you must call `expand-file-name' yourself.
6204 Default name to DEFAULT-FILENAME if user exits the minibuffer with
6205 the same non-empty string that was inserted by this function.
6206 (If DEFAULT-FILENAME is omitted, the visited file name is used,
6207 except that if INITIAL is specified, that combined with DIR is used.)
6208 If the user exits with an empty minibuffer, this function returns
6209 an empty string. (This can only happen if the user erased the
6210 pre-inserted contents or if `insert-default-directory' is nil.)
6211 Fourth arg MUSTMATCH non-nil means require existing file's name.
6212 Non-nil and non-t means also require confirmation after completion.
6213 Fifth arg INITIAL specifies text to start with.
6214 If optional sixth arg PREDICATE is non-nil, possible completions and
6215 the resulting file name must satisfy (funcall PREDICATE NAME).
6216 DIR should be an absolute directory name. It defaults to the value of
6217 `default-directory'.
6219 If this command was invoked with the mouse, use a file dialog box if
6220 `use-dialog-box' is non-nil, and the window system or X toolkit in use
6221 provides a file dialog box.
6223 See also `read-file-name-completion-ignore-case'
6224 and `read-file-name-function'. */)
6225 (prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
)
6226 Lisp_Object prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
;
6228 Lisp_Object val
, insdef
, tem
;
6229 struct gcpro gcpro1
, gcpro2
;
6230 register char *homedir
;
6231 Lisp_Object decoded_homedir
;
6232 int replace_in_history
= 0;
6233 int add_to_history
= 0;
6237 dir
= current_buffer
->directory
;
6238 if (NILP (Ffile_name_absolute_p (dir
)))
6239 dir
= Fexpand_file_name (dir
, Qnil
);
6240 if (NILP (default_filename
))
6243 ? Fexpand_file_name (initial
, dir
)
6244 : current_buffer
->filename
);
6246 /* If dir starts with user's homedir, change that to ~. */
6247 homedir
= (char *) egetenv ("HOME");
6249 /* homedir can be NULL in temacs, since Vprocess_environment is not
6250 yet set up. We shouldn't crash in that case. */
6253 homedir
= strcpy (alloca (strlen (homedir
) + 1), homedir
);
6254 CORRECT_DIR_SEPS (homedir
);
6259 = DECODE_FILE (make_unibyte_string (homedir
, strlen (homedir
)));
6262 && !strncmp (SDATA (decoded_homedir
), SDATA (dir
),
6263 SBYTES (decoded_homedir
))
6264 && IS_DIRECTORY_SEP (SREF (dir
, SBYTES (decoded_homedir
))))
6266 dir
= Fsubstring (dir
, make_number (SCHARS (decoded_homedir
)), Qnil
);
6267 dir
= concat2 (build_string ("~"), dir
);
6269 /* Likewise for default_filename. */
6271 && STRINGP (default_filename
)
6272 && !strncmp (SDATA (decoded_homedir
), SDATA (default_filename
),
6273 SBYTES (decoded_homedir
))
6274 && IS_DIRECTORY_SEP (SREF (default_filename
, SBYTES (decoded_homedir
))))
6277 = Fsubstring (default_filename
,
6278 make_number (SCHARS (decoded_homedir
)), Qnil
);
6279 default_filename
= concat2 (build_string ("~"), default_filename
);
6281 if (!NILP (default_filename
))
6283 CHECK_STRING (default_filename
);
6284 default_filename
= double_dollars (default_filename
);
6287 if (insert_default_directory
&& STRINGP (dir
))
6290 if (!NILP (initial
))
6292 Lisp_Object args
[2], pos
;
6296 insdef
= Fconcat (2, args
);
6297 pos
= make_number (SCHARS (double_dollars (dir
)));
6298 insdef
= Fcons (double_dollars (insdef
), pos
);
6301 insdef
= double_dollars (insdef
);
6303 else if (STRINGP (initial
))
6304 insdef
= Fcons (double_dollars (initial
), make_number (0));
6308 if (!NILP (Vread_file_name_function
))
6310 Lisp_Object args
[7];
6312 GCPRO2 (insdef
, default_filename
);
6313 args
[0] = Vread_file_name_function
;
6316 args
[3] = default_filename
;
6317 args
[4] = mustmatch
;
6319 args
[6] = predicate
;
6320 RETURN_UNGCPRO (Ffuncall (7, args
));
6323 count
= SPECPDL_INDEX ();
6324 specbind (intern ("completion-ignore-case"),
6325 read_file_name_completion_ignore_case
? Qt
: Qnil
);
6326 specbind (intern ("minibuffer-completing-file-name"), Qt
);
6327 specbind (intern ("read-file-name-predicate"),
6328 (NILP (predicate
) ? Qfile_exists_p
: predicate
));
6330 GCPRO2 (insdef
, default_filename
);
6332 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6333 if (! NILP (Fnext_read_file_uses_dialog_p ()))
6335 /* If DIR contains a file name, split it. */
6337 file
= Ffile_name_nondirectory (dir
);
6338 if (SCHARS (file
) && NILP (default_filename
))
6340 default_filename
= file
;
6341 dir
= Ffile_name_directory (dir
);
6343 if (!NILP(default_filename
))
6344 default_filename
= Fexpand_file_name (default_filename
, dir
);
6345 val
= Fx_file_dialog (prompt
, dir
, default_filename
, mustmatch
,
6346 EQ (predicate
, Qfile_directory_p
) ? Qt
: Qnil
);
6351 val
= Fcompleting_read (prompt
, intern ("read-file-name-internal"),
6352 dir
, mustmatch
, insdef
,
6353 Qfile_name_history
, default_filename
, Qnil
);
6355 tem
= Fsymbol_value (Qfile_name_history
);
6356 if (CONSP (tem
) && EQ (XCAR (tem
), val
))
6357 replace_in_history
= 1;
6359 /* If Fcompleting_read returned the inserted default string itself
6360 (rather than a new string with the same contents),
6361 it has to mean that the user typed RET with the minibuffer empty.
6362 In that case, we really want to return ""
6363 so that commands such as set-visited-file-name can distinguish. */
6364 if (EQ (val
, default_filename
))
6366 /* In this case, Fcompleting_read has not added an element
6367 to the history. Maybe we should. */
6368 if (! replace_in_history
)
6374 unbind_to (count
, Qnil
);
6377 error ("No file name specified");
6379 tem
= Fstring_equal (val
, CONSP (insdef
) ? XCAR (insdef
) : insdef
);
6381 if (!NILP (tem
) && !NILP (default_filename
))
6382 val
= default_filename
;
6383 val
= Fsubstitute_in_file_name (val
);
6385 if (replace_in_history
)
6386 /* Replace what Fcompleting_read added to the history
6387 with what we will actually return. */
6389 Lisp_Object val1
= double_dollars (val
);
6390 tem
= Fsymbol_value (Qfile_name_history
);
6391 if (history_delete_duplicates
)
6392 XSETCDR (tem
, Fdelete (val1
, XCDR(tem
)));
6393 XSETCAR (tem
, val1
);
6395 else if (add_to_history
)
6397 /* Add the value to the history--but not if it matches
6398 the last value already there. */
6399 Lisp_Object val1
= double_dollars (val
);
6400 tem
= Fsymbol_value (Qfile_name_history
);
6401 if (! CONSP (tem
) || NILP (Fequal (XCAR (tem
), val1
)))
6403 if (history_delete_duplicates
) tem
= Fdelete (val1
, tem
);
6404 Fset (Qfile_name_history
, Fcons (val1
, tem
));
6415 /* Must be set before any path manipulation is performed. */
6416 XSETFASTINT (Vdirectory_sep_char
, '/');
6423 Qexpand_file_name
= intern ("expand-file-name");
6424 Qsubstitute_in_file_name
= intern ("substitute-in-file-name");
6425 Qdirectory_file_name
= intern ("directory-file-name");
6426 Qfile_name_directory
= intern ("file-name-directory");
6427 Qfile_name_nondirectory
= intern ("file-name-nondirectory");
6428 Qunhandled_file_name_directory
= intern ("unhandled-file-name-directory");
6429 Qfile_name_as_directory
= intern ("file-name-as-directory");
6430 Qcopy_file
= intern ("copy-file");
6431 Qmake_directory_internal
= intern ("make-directory-internal");
6432 Qmake_directory
= intern ("make-directory");
6433 Qdelete_directory
= intern ("delete-directory");
6434 Qdelete_file
= intern ("delete-file");
6435 Qrename_file
= intern ("rename-file");
6436 Qadd_name_to_file
= intern ("add-name-to-file");
6437 Qmake_symbolic_link
= intern ("make-symbolic-link");
6438 Qfile_exists_p
= intern ("file-exists-p");
6439 Qfile_executable_p
= intern ("file-executable-p");
6440 Qfile_readable_p
= intern ("file-readable-p");
6441 Qfile_writable_p
= intern ("file-writable-p");
6442 Qfile_symlink_p
= intern ("file-symlink-p");
6443 Qaccess_file
= intern ("access-file");
6444 Qfile_directory_p
= intern ("file-directory-p");
6445 Qfile_regular_p
= intern ("file-regular-p");
6446 Qfile_accessible_directory_p
= intern ("file-accessible-directory-p");
6447 Qfile_modes
= intern ("file-modes");
6448 Qset_file_modes
= intern ("set-file-modes");
6449 Qset_file_times
= intern ("set-file-times");
6450 Qfile_newer_than_file_p
= intern ("file-newer-than-file-p");
6451 Qinsert_file_contents
= intern ("insert-file-contents");
6452 Qwrite_region
= intern ("write-region");
6453 Qverify_visited_file_modtime
= intern ("verify-visited-file-modtime");
6454 Qset_visited_file_modtime
= intern ("set-visited-file-modtime");
6455 Qauto_save_coding
= intern ("auto-save-coding");
6457 staticpro (&Qexpand_file_name
);
6458 staticpro (&Qsubstitute_in_file_name
);
6459 staticpro (&Qdirectory_file_name
);
6460 staticpro (&Qfile_name_directory
);
6461 staticpro (&Qfile_name_nondirectory
);
6462 staticpro (&Qunhandled_file_name_directory
);
6463 staticpro (&Qfile_name_as_directory
);
6464 staticpro (&Qcopy_file
);
6465 staticpro (&Qmake_directory_internal
);
6466 staticpro (&Qmake_directory
);
6467 staticpro (&Qdelete_directory
);
6468 staticpro (&Qdelete_file
);
6469 staticpro (&Qrename_file
);
6470 staticpro (&Qadd_name_to_file
);
6471 staticpro (&Qmake_symbolic_link
);
6472 staticpro (&Qfile_exists_p
);
6473 staticpro (&Qfile_executable_p
);
6474 staticpro (&Qfile_readable_p
);
6475 staticpro (&Qfile_writable_p
);
6476 staticpro (&Qaccess_file
);
6477 staticpro (&Qfile_symlink_p
);
6478 staticpro (&Qfile_directory_p
);
6479 staticpro (&Qfile_regular_p
);
6480 staticpro (&Qfile_accessible_directory_p
);
6481 staticpro (&Qfile_modes
);
6482 staticpro (&Qset_file_modes
);
6483 staticpro (&Qset_file_times
);
6484 staticpro (&Qfile_newer_than_file_p
);
6485 staticpro (&Qinsert_file_contents
);
6486 staticpro (&Qwrite_region
);
6487 staticpro (&Qverify_visited_file_modtime
);
6488 staticpro (&Qset_visited_file_modtime
);
6489 staticpro (&Qauto_save_coding
);
6491 Qfile_name_history
= intern ("file-name-history");
6492 Fset (Qfile_name_history
, Qnil
);
6493 staticpro (&Qfile_name_history
);
6495 Qfile_error
= intern ("file-error");
6496 staticpro (&Qfile_error
);
6497 Qfile_already_exists
= intern ("file-already-exists");
6498 staticpro (&Qfile_already_exists
);
6499 Qfile_date_error
= intern ("file-date-error");
6500 staticpro (&Qfile_date_error
);
6501 Qexcl
= intern ("excl");
6505 Qfind_buffer_file_type
= intern ("find-buffer-file-type");
6506 staticpro (&Qfind_buffer_file_type
);
6509 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system
,
6510 doc
: /* *Coding system for encoding file names.
6511 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6512 Vfile_name_coding_system
= Qnil
;
6514 DEFVAR_LISP ("default-file-name-coding-system",
6515 &Vdefault_file_name_coding_system
,
6516 doc
: /* Default coding system for encoding file names.
6517 This variable is used only when `file-name-coding-system' is nil.
6519 This variable is set/changed by the command `set-language-environment'.
6520 User should not set this variable manually,
6521 instead use `file-name-coding-system' to get a constant encoding
6522 of file names regardless of the current language environment. */);
6523 Vdefault_file_name_coding_system
= Qnil
;
6525 Qformat_decode
= intern ("format-decode");
6526 staticpro (&Qformat_decode
);
6527 Qformat_annotate_function
= intern ("format-annotate-function");
6528 staticpro (&Qformat_annotate_function
);
6529 Qafter_insert_file_set_coding
= intern ("after-insert-file-set-coding");
6530 staticpro (&Qafter_insert_file_set_coding
);
6532 Qcar_less_than_car
= intern ("car-less-than-car");
6533 staticpro (&Qcar_less_than_car
);
6535 Fput (Qfile_error
, Qerror_conditions
,
6536 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
)));
6537 Fput (Qfile_error
, Qerror_message
,
6538 build_string ("File error"));
6540 Fput (Qfile_already_exists
, Qerror_conditions
,
6541 Fcons (Qfile_already_exists
,
6542 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
))));
6543 Fput (Qfile_already_exists
, Qerror_message
,
6544 build_string ("File already exists"));
6546 Fput (Qfile_date_error
, Qerror_conditions
,
6547 Fcons (Qfile_date_error
,
6548 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
))));
6549 Fput (Qfile_date_error
, Qerror_message
,
6550 build_string ("Cannot set file date"));
6552 DEFVAR_LISP ("read-file-name-function", &Vread_file_name_function
,
6553 doc
: /* If this is non-nil, `read-file-name' does its work by calling this function. */);
6554 Vread_file_name_function
= Qnil
;
6556 DEFVAR_LISP ("read-file-name-predicate", &Vread_file_name_predicate
,
6557 doc
: /* Current predicate used by `read-file-name-internal'. */);
6558 Vread_file_name_predicate
= Qnil
;
6560 DEFVAR_BOOL ("read-file-name-completion-ignore-case", &read_file_name_completion_ignore_case
,
6561 doc
: /* *Non-nil means when reading a file name completion ignores case. */);
6562 #if defined VMS || defined DOS_NT || defined MAC_OS
6563 read_file_name_completion_ignore_case
= 1;
6565 read_file_name_completion_ignore_case
= 0;
6568 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory
,
6569 doc
: /* *Non-nil means when reading a filename start with default dir in minibuffer.
6570 If the initial minibuffer contents are non-empty, you can usually
6571 request a default filename by typing RETURN without editing. For some
6572 commands, exiting with an empty minibuffer has a special meaning,
6573 such as making the current buffer visit no file in the case of
6574 `set-visited-file-name'.
6575 If this variable is non-nil, the minibuffer contents are always
6576 initially non-empty and typing RETURN without editing will fetch the
6577 default name, if one is provided. Note however that this default name
6578 is not necessarily the name originally inserted in the minibuffer, if
6579 that is just the default directory.
6580 If this variable is nil, the minibuffer often starts out empty. In
6581 that case you may have to explicitly fetch the next history element to
6582 request the default name. */);
6583 insert_default_directory
= 1;
6585 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm
,
6586 doc
: /* *Non-nil means write new files with record format `stmlf'.
6587 nil means use format `var'. This variable is meaningful only on VMS. */);
6588 vms_stmlf_recfm
= 0;
6590 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char
,
6591 doc
: /* Directory separator character for built-in functions that return file names.
6592 The value is always ?/. Don't use this variable, just use `/'. */);
6594 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist
,
6595 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6596 If a file name matches REGEXP, then all I/O on that file is done by calling
6599 The first argument given to HANDLER is the name of the I/O primitive
6600 to be handled; the remaining arguments are the arguments that were
6601 passed to that primitive. For example, if you do
6602 (file-exists-p FILENAME)
6603 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6604 (funcall HANDLER 'file-exists-p FILENAME)
6605 The function `find-file-name-handler' checks this list for a handler
6606 for its argument. */);
6607 Vfile_name_handler_alist
= Qnil
;
6609 DEFVAR_LISP ("set-auto-coding-function",
6610 &Vset_auto_coding_function
,
6611 doc
: /* If non-nil, a function to call to decide a coding system of file.
6612 Two arguments are passed to this function: the file name
6613 and the length of a file contents following the point.
6614 This function should return a coding system to decode the file contents.
6615 It should check the file name against `auto-coding-alist'.
6616 If no coding system is decided, it should check a coding system
6617 specified in the heading lines with the format:
6618 -*- ... coding: CODING-SYSTEM; ... -*-
6619 or local variable spec of the tailing lines with `coding:' tag. */);
6620 Vset_auto_coding_function
= Qnil
;
6622 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions
,
6623 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
6624 Each is passed one argument, the number of characters inserted.
6625 It should return the new character count, and leave point the same.
6626 If `insert-file-contents' is intercepted by a handler from
6627 `file-name-handler-alist', that handler is responsible for calling the
6628 functions in `after-insert-file-functions' if appropriate. */);
6629 Vafter_insert_file_functions
= Qnil
;
6631 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions
,
6632 doc
: /* A list of functions to be called at the start of `write-region'.
6633 Each is passed two arguments, START and END as for `write-region'.
6634 These are usually two numbers but not always; see the documentation
6635 for `write-region'. The function should return a list of pairs
6636 of the form (POSITION . STRING), consisting of strings to be effectively
6637 inserted at the specified positions of the file being written (1 means to
6638 insert before the first byte written). The POSITIONs must be sorted into
6639 increasing order. If there are several functions in the list, the several
6640 lists are merged destructively. Alternatively, the function can return
6641 with a different buffer current; in that case it should pay attention
6642 to the annotations returned by previous functions and listed in
6643 `write-region-annotations-so-far'.*/);
6644 Vwrite_region_annotate_functions
= Qnil
;
6645 staticpro (&Qwrite_region_annotate_functions
);
6646 Qwrite_region_annotate_functions
6647 = intern ("write-region-annotate-functions");
6649 DEFVAR_LISP ("write-region-annotations-so-far",
6650 &Vwrite_region_annotations_so_far
,
6651 doc
: /* When an annotation function is called, this holds the previous annotations.
6652 These are the annotations made by other annotation functions
6653 that were already called. See also `write-region-annotate-functions'. */);
6654 Vwrite_region_annotations_so_far
= Qnil
;
6656 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers
,
6657 doc
: /* A list of file name handlers that temporarily should not be used.
6658 This applies only to the operation `inhibit-file-name-operation'. */);
6659 Vinhibit_file_name_handlers
= Qnil
;
6661 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation
,
6662 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6663 Vinhibit_file_name_operation
= Qnil
;
6665 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name
,
6666 doc
: /* File name in which we write a list of all auto save file names.
6667 This variable is initialized automatically from `auto-save-list-file-prefix'
6668 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6669 a non-nil value. */);
6670 Vauto_save_list_file_name
= Qnil
;
6672 defsubr (&Sfind_file_name_handler
);
6673 defsubr (&Sfile_name_directory
);
6674 defsubr (&Sfile_name_nondirectory
);
6675 defsubr (&Sunhandled_file_name_directory
);
6676 defsubr (&Sfile_name_as_directory
);
6677 defsubr (&Sdirectory_file_name
);
6678 defsubr (&Smake_temp_name
);
6679 defsubr (&Sexpand_file_name
);
6680 defsubr (&Ssubstitute_in_file_name
);
6681 defsubr (&Scopy_file
);
6682 defsubr (&Smake_directory_internal
);
6683 defsubr (&Sdelete_directory
);
6684 defsubr (&Sdelete_file
);
6685 defsubr (&Srename_file
);
6686 defsubr (&Sadd_name_to_file
);
6688 defsubr (&Smake_symbolic_link
);
6689 #endif /* S_IFLNK */
6691 defsubr (&Sdefine_logical_name
);
6694 defsubr (&Ssysnetunam
);
6695 #endif /* HPUX_NET */
6696 defsubr (&Sfile_name_absolute_p
);
6697 defsubr (&Sfile_exists_p
);
6698 defsubr (&Sfile_executable_p
);
6699 defsubr (&Sfile_readable_p
);
6700 defsubr (&Sfile_writable_p
);
6701 defsubr (&Saccess_file
);
6702 defsubr (&Sfile_symlink_p
);
6703 defsubr (&Sfile_directory_p
);
6704 defsubr (&Sfile_accessible_directory_p
);
6705 defsubr (&Sfile_regular_p
);
6706 defsubr (&Sfile_modes
);
6707 defsubr (&Sset_file_modes
);
6708 defsubr (&Sset_file_times
);
6709 defsubr (&Sset_default_file_modes
);
6710 defsubr (&Sdefault_file_modes
);
6711 defsubr (&Sfile_newer_than_file_p
);
6712 defsubr (&Sinsert_file_contents
);
6713 defsubr (&Swrite_region
);
6714 defsubr (&Scar_less_than_car
);
6715 defsubr (&Sverify_visited_file_modtime
);
6716 defsubr (&Sclear_visited_file_modtime
);
6717 defsubr (&Svisited_file_modtime
);
6718 defsubr (&Sset_visited_file_modtime
);
6719 defsubr (&Sdo_auto_save
);
6720 defsubr (&Sset_buffer_auto_saved
);
6721 defsubr (&Sclear_buffer_auto_save_failure
);
6722 defsubr (&Srecent_auto_save_p
);
6724 defsubr (&Sread_file_name_internal
);
6725 defsubr (&Sread_file_name
);
6726 defsubr (&Snext_read_file_uses_dialog_p
);
6729 defsubr (&Sunix_sync
);
6733 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
6734 (do not change this comment) */