1 /* File IO for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2001, 2003, 2004, 2005 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
29 #include <sys/types.h>
36 #if !defined (S_ISLNK) && defined (S_IFLNK)
37 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
40 #if !defined (S_ISFIFO) && defined (S_IFIFO)
41 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
44 #if !defined (S_ISREG) && defined (S_IFREG)
45 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
74 #include "intervals.h"
85 #endif /* not WINDOWSNT */
89 #include <sys/param.h>
97 #define CORRECT_DIR_SEPS(s) \
98 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
99 else unixtodos_filename (s); \
101 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
102 redirector allows the six letters between 'Z' and 'a' as well. */
104 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
107 #define IS_DRIVE(x) isalpha (x)
109 /* Need to lower-case the drive letter, or else expanded
110 filenames will sometimes compare inequal, because
111 `expand-file-name' doesn't always down-case the drive letter. */
112 #define DRIVE_LETTER(x) (tolower (x))
133 #include "commands.h"
134 extern int use_dialog_box
;
135 extern int use_file_dialog
;
149 #ifndef FILE_SYSTEM_CASE
150 #define FILE_SYSTEM_CASE(filename) (filename)
153 /* Nonzero during writing of auto-save files */
156 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
157 a new file with the same mode as the original */
158 int auto_save_mode_bits
;
160 /* The symbol bound to coding-system-for-read when
161 insert-file-contents is called for recovering a file. This is not
162 an actual coding system name, but just an indicator to tell
163 insert-file-contents to use `emacs-mule' with a special flag for
164 auto saving and recovering a file. */
165 Lisp_Object Qauto_save_coding
;
167 /* Coding system for file names, or nil if none. */
168 Lisp_Object Vfile_name_coding_system
;
170 /* Coding system for file names used only when
171 Vfile_name_coding_system is nil. */
172 Lisp_Object Vdefault_file_name_coding_system
;
174 /* Alist of elements (REGEXP . HANDLER) for file names
175 whose I/O is done with a special handler. */
176 Lisp_Object Vfile_name_handler_alist
;
178 /* Property name of a file name handler,
179 which gives a list of operations it handles.. */
180 Lisp_Object Qoperations
;
182 /* Lisp functions for translating file formats */
183 Lisp_Object Qformat_decode
, Qformat_annotate_function
;
185 /* Function to be called to decide a coding system of a reading file. */
186 Lisp_Object Vset_auto_coding_function
;
188 /* Functions to be called to process text properties in inserted file. */
189 Lisp_Object Vafter_insert_file_functions
;
191 /* Lisp function for setting buffer-file-coding-system and the
192 multibyteness of the current buffer after inserting a file. */
193 Lisp_Object Qafter_insert_file_set_coding
;
195 /* Functions to be called to create text property annotations for file. */
196 Lisp_Object Vwrite_region_annotate_functions
;
197 Lisp_Object Qwrite_region_annotate_functions
;
199 /* During build_annotations, each time an annotation function is called,
200 this holds the annotations made by the previous functions. */
201 Lisp_Object Vwrite_region_annotations_so_far
;
203 /* File name in which we write a list of all our auto save files. */
204 Lisp_Object Vauto_save_list_file_name
;
206 /* Function to call to read a file name. */
207 Lisp_Object Vread_file_name_function
;
209 /* Current predicate used by read_file_name_internal. */
210 Lisp_Object Vread_file_name_predicate
;
212 /* Nonzero means completion ignores case when reading file name. */
213 int read_file_name_completion_ignore_case
;
215 /* Nonzero means, when reading a filename in the minibuffer,
216 start out by inserting the default directory into the minibuffer. */
217 int insert_default_directory
;
219 /* On VMS, nonzero means write new files with record format stmlf.
220 Zero means use var format. */
223 /* On NT, specifies the directory separator character, used (eg.) when
224 expanding file names. This can be bound to / or \. */
225 Lisp_Object Vdirectory_sep_char
;
227 extern Lisp_Object Vuser_login_name
;
230 extern Lisp_Object Vw32_get_true_file_attributes
;
233 extern int minibuf_level
;
235 extern int minibuffer_auto_raise
;
237 extern int history_delete_duplicates
;
239 /* These variables describe handlers that have "already" had a chance
240 to handle the current operation.
242 Vinhibit_file_name_handlers is a list of file name handlers.
243 Vinhibit_file_name_operation is the operation being handled.
244 If we try to handle that operation, we ignore those handlers. */
246 static Lisp_Object Vinhibit_file_name_handlers
;
247 static Lisp_Object Vinhibit_file_name_operation
;
249 Lisp_Object Qfile_error
, Qfile_already_exists
, Qfile_date_error
;
251 Lisp_Object Qfile_name_history
;
253 Lisp_Object Qcar_less_than_car
;
255 static int a_write
P_ ((int, Lisp_Object
, int, int,
256 Lisp_Object
*, struct coding_system
*));
257 static int e_write
P_ ((int, Lisp_Object
, int, int, struct coding_system
*));
261 report_file_error (string
, data
)
265 Lisp_Object errstring
;
268 synchronize_system_messages_locale ();
269 errstring
= code_convert_string_norecord (build_string (strerror (errorno
)),
270 Vlocale_coding_system
, 0);
276 Fsignal (Qfile_already_exists
, Fcons (errstring
, data
));
279 /* System error messages are capitalized. Downcase the initial
280 unless it is followed by a slash. */
281 if (SREF (errstring
, 1) != '/')
282 SSET (errstring
, 0, DOWNCASE (SREF (errstring
, 0)));
284 Fsignal (Qfile_error
,
285 Fcons (build_string (string
), Fcons (errstring
, data
)));
290 close_file_unwind (fd
)
293 emacs_close (XFASTINT (fd
));
297 /* Restore point, having saved it as a marker. */
300 restore_point_unwind (location
)
301 Lisp_Object location
;
303 Fgoto_char (location
);
304 Fset_marker (location
, Qnil
, Qnil
);
308 Lisp_Object Qexpand_file_name
;
309 Lisp_Object Qsubstitute_in_file_name
;
310 Lisp_Object Qdirectory_file_name
;
311 Lisp_Object Qfile_name_directory
;
312 Lisp_Object Qfile_name_nondirectory
;
313 Lisp_Object Qunhandled_file_name_directory
;
314 Lisp_Object Qfile_name_as_directory
;
315 Lisp_Object Qcopy_file
;
316 Lisp_Object Qmake_directory_internal
;
317 Lisp_Object Qmake_directory
;
318 Lisp_Object Qdelete_directory
;
319 Lisp_Object Qdelete_file
;
320 Lisp_Object Qrename_file
;
321 Lisp_Object Qadd_name_to_file
;
322 Lisp_Object Qmake_symbolic_link
;
323 Lisp_Object Qfile_exists_p
;
324 Lisp_Object Qfile_executable_p
;
325 Lisp_Object Qfile_readable_p
;
326 Lisp_Object Qfile_writable_p
;
327 Lisp_Object Qfile_symlink_p
;
328 Lisp_Object Qaccess_file
;
329 Lisp_Object Qfile_directory_p
;
330 Lisp_Object Qfile_regular_p
;
331 Lisp_Object Qfile_accessible_directory_p
;
332 Lisp_Object Qfile_modes
;
333 Lisp_Object Qset_file_modes
;
334 Lisp_Object Qset_file_times
;
335 Lisp_Object Qfile_newer_than_file_p
;
336 Lisp_Object Qinsert_file_contents
;
337 Lisp_Object Qwrite_region
;
338 Lisp_Object Qverify_visited_file_modtime
;
339 Lisp_Object Qset_visited_file_modtime
;
341 DEFUN ("find-file-name-handler", Ffind_file_name_handler
, Sfind_file_name_handler
, 2, 2, 0,
342 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
343 Otherwise, return nil.
344 A file name is handled if one of the regular expressions in
345 `file-name-handler-alist' matches it.
347 If OPERATION equals `inhibit-file-name-operation', then we ignore
348 any handlers that are members of `inhibit-file-name-handlers',
349 but we still do run any other handlers. This lets handlers
350 use the standard functions without calling themselves recursively. */)
351 (filename
, operation
)
352 Lisp_Object filename
, operation
;
354 /* This function must not munge the match data. */
355 Lisp_Object chain
, inhibited_handlers
, result
;
359 CHECK_STRING (filename
);
361 if (EQ (operation
, Vinhibit_file_name_operation
))
362 inhibited_handlers
= Vinhibit_file_name_handlers
;
364 inhibited_handlers
= Qnil
;
366 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
367 chain
= XCDR (chain
))
373 Lisp_Object string
= XCAR (elt
);
375 Lisp_Object handler
= XCDR (elt
);
376 Lisp_Object operations
= Qnil
;
378 if (SYMBOLP (handler
))
379 operations
= Fget (handler
, Qoperations
);
382 && (match_pos
= fast_string_match (string
, filename
)) > pos
383 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
387 handler
= XCDR (elt
);
388 tem
= Fmemq (handler
, inhibited_handlers
);
402 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
404 doc
: /* Return the directory component in file name FILENAME.
405 Return nil if FILENAME does not include a directory.
406 Otherwise return a directory spec.
407 Given a Unix syntax file name, returns a string ending in slash;
408 on VMS, perhaps instead a string ending in `:', `]' or `>'. */)
410 Lisp_Object filename
;
413 register const unsigned char *beg
;
415 register unsigned char *beg
;
417 register const unsigned char *p
;
420 CHECK_STRING (filename
);
422 /* If the file name has special constructs in it,
423 call the corresponding file handler. */
424 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
426 return call2 (handler
, Qfile_name_directory
, filename
);
428 filename
= FILE_SYSTEM_CASE (filename
);
429 beg
= SDATA (filename
);
431 beg
= strcpy (alloca (strlen (beg
) + 1), beg
);
433 p
= beg
+ SBYTES (filename
);
435 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
437 && p
[-1] != ':' && p
[-1] != ']' && p
[-1] != '>'
440 /* only recognise drive specifier at the beginning */
442 /* handle the "/:d:foo" and "/:foo" cases correctly */
443 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
444 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
451 /* Expansion of "c:" to drive and default directory. */
454 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
455 unsigned char *res
= alloca (MAXPATHLEN
+ 1);
456 unsigned char *r
= res
;
458 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
460 strncpy (res
, beg
, 2);
465 if (getdefdir (toupper (*beg
) - 'A' + 1, r
))
467 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
470 p
= beg
+ strlen (beg
);
473 CORRECT_DIR_SEPS (beg
);
476 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
479 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
480 Sfile_name_nondirectory
, 1, 1, 0,
481 doc
: /* Return file name FILENAME sans its directory.
482 For example, in a Unix-syntax file name,
483 this is everything after the last slash,
484 or the entire name if it contains no slash. */)
486 Lisp_Object filename
;
488 register const unsigned char *beg
, *p
, *end
;
491 CHECK_STRING (filename
);
493 /* If the file name has special constructs in it,
494 call the corresponding file handler. */
495 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
497 return call2 (handler
, Qfile_name_nondirectory
, filename
);
499 beg
= SDATA (filename
);
500 end
= p
= beg
+ SBYTES (filename
);
502 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
504 && p
[-1] != ':' && p
[-1] != ']' && p
[-1] != '>'
507 /* only recognise drive specifier at beginning */
509 /* handle the "/:d:foo" case correctly */
510 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
515 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
518 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
519 Sunhandled_file_name_directory
, 1, 1, 0,
520 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
521 A `directly usable' directory name is one that may be used without the
522 intervention of any file handler.
523 If FILENAME is a directly usable file itself, return
524 \(file-name-directory FILENAME).
525 The `call-process' and `start-process' functions use this function to
526 get a current directory to run processes in. */)
528 Lisp_Object filename
;
532 /* If the file name has special constructs in it,
533 call the corresponding file handler. */
534 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
536 return call2 (handler
, Qunhandled_file_name_directory
, filename
);
538 return Ffile_name_directory (filename
);
543 file_name_as_directory (out
, in
)
546 int size
= strlen (in
) - 1;
559 /* Is it already a directory string? */
560 if (in
[size
] == ':' || in
[size
] == ']' || in
[size
] == '>')
562 /* Is it a VMS directory file name? If so, hack VMS syntax. */
563 else if (! index (in
, '/')
564 && ((size
> 3 && ! strcmp (&in
[size
- 3], ".DIR"))
565 || (size
> 3 && ! strcmp (&in
[size
- 3], ".dir"))
566 || (size
> 5 && (! strncmp (&in
[size
- 5], ".DIR", 4)
567 || ! strncmp (&in
[size
- 5], ".dir", 4))
568 && (in
[size
- 1] == '.' || in
[size
- 1] == ';')
569 && in
[size
] == '1')))
571 register char *p
, *dot
;
575 dir:x.dir --> dir:[x]
576 dir:[x]y.dir --> dir:[x.y] */
578 while (p
!= in
&& *p
!= ':' && *p
!= '>' && *p
!= ']') p
--;
581 strncpy (out
, in
, p
- in
);
600 dot
= index (p
, '.');
603 /* blindly remove any extension */
604 size
= strlen (out
) + (dot
- p
);
605 strncat (out
, p
, dot
- p
);
616 /* For Unix syntax, Append a slash if necessary */
617 if (!IS_DIRECTORY_SEP (out
[size
]))
619 /* Cannot use DIRECTORY_SEP, which could have any value */
621 out
[size
+ 2] = '\0';
624 CORRECT_DIR_SEPS (out
);
630 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
631 Sfile_name_as_directory
, 1, 1, 0,
632 doc
: /* Return a string representing the file name FILE interpreted as a directory.
633 This operation exists because a directory is also a file, but its name as
634 a directory is different from its name as a file.
635 The result can be used as the value of `default-directory'
636 or passed as second argument to `expand-file-name'.
637 For a Unix-syntax file name, just appends a slash.
638 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc. */)
649 /* If the file name has special constructs in it,
650 call the corresponding file handler. */
651 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
653 return call2 (handler
, Qfile_name_as_directory
, file
);
655 buf
= (char *) alloca (SBYTES (file
) + 10);
656 file_name_as_directory (buf
, SDATA (file
));
657 return make_specified_string (buf
, -1, strlen (buf
),
658 STRING_MULTIBYTE (file
));
662 * Convert from directory name to filename.
664 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
665 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
666 * On UNIX, it's simple: just make sure there isn't a terminating /
668 * Value is nonzero if the string output is different from the input.
672 directory_file_name (src
, dst
)
680 struct FAB fab
= cc$rms_fab
;
681 struct NAM nam
= cc$rms_nam
;
682 char esa
[NAM$C_MAXRSS
];
687 if (! index (src
, '/')
688 && (src
[slen
- 1] == ']'
689 || src
[slen
- 1] == ':'
690 || src
[slen
- 1] == '>'))
692 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
694 fab
.fab$b_fns
= slen
;
695 fab
.fab$l_nam
= &nam
;
696 fab
.fab$l_fop
= FAB$M_NAM
;
699 nam
.nam$b_ess
= sizeof esa
;
700 nam
.nam$b_nop
|= NAM$M_SYNCHK
;
702 /* We call SYS$PARSE to handle such things as [--] for us. */
703 if (SYS$
PARSE (&fab
, 0, 0) == RMS$_NORMAL
)
705 slen
= nam
.nam$b_esl
;
706 if (esa
[slen
- 1] == ';' && esa
[slen
- 2] == '.')
711 if (src
[slen
- 1] != ']' && src
[slen
- 1] != '>')
713 /* what about when we have logical_name:???? */
714 if (src
[slen
- 1] == ':')
715 { /* Xlate logical name and see what we get */
716 ptr
= strcpy (dst
, src
); /* upper case for getenv */
719 if ('a' <= *ptr
&& *ptr
<= 'z')
723 dst
[slen
- 1] = 0; /* remove colon */
724 if (!(src
= egetenv (dst
)))
726 /* should we jump to the beginning of this procedure?
727 Good points: allows us to use logical names that xlate
729 Bad points: can be a problem if we just translated to a device
731 For now, I'll punt and always expect VMS names, and hope for
734 if (src
[slen
- 1] != ']' && src
[slen
- 1] != '>')
735 { /* no recursion here! */
741 { /* not a directory spec */
746 bracket
= src
[slen
- 1];
748 /* If bracket is ']' or '>', bracket - 2 is the corresponding
750 ptr
= index (src
, bracket
- 2);
752 { /* no opening bracket */
756 if (!(rptr
= rindex (src
, '.')))
759 strncpy (dst
, src
, slen
);
763 dst
[slen
++] = bracket
;
768 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
769 then translate the device and recurse. */
770 if (dst
[slen
- 1] == ':'
771 && dst
[slen
- 2] != ':' /* skip decnet nodes */
772 && strcmp (src
+ slen
, "[000000]") == 0)
774 dst
[slen
- 1] = '\0';
775 if ((ptr
= egetenv (dst
))
776 && (rlen
= strlen (ptr
) - 1) > 0
777 && (ptr
[rlen
] == ']' || ptr
[rlen
] == '>')
778 && ptr
[rlen
- 1] == '.')
780 char * buf
= (char *) alloca (strlen (ptr
) + 1);
784 return directory_file_name (buf
, dst
);
789 strcat (dst
, "[000000]");
793 rlen
= strlen (rptr
) - 1;
794 strncat (dst
, rptr
, rlen
);
795 dst
[slen
+ rlen
] = '\0';
796 strcat (dst
, ".DIR.1");
800 /* Process as Unix format: just remove any final slash.
801 But leave "/" unchanged; do not change it to "". */
804 /* Handle // as root for apollo's. */
805 if ((slen
> 2 && dst
[slen
- 1] == '/')
806 || (slen
> 1 && dst
[0] != '/' && dst
[slen
- 1] == '/'))
810 && IS_DIRECTORY_SEP (dst
[slen
- 1])
812 && !IS_ANY_SEP (dst
[slen
- 2])
818 CORRECT_DIR_SEPS (dst
);
823 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
825 doc
: /* Returns the file name of the directory named DIRECTORY.
826 This is the name of the file that holds the data for the directory DIRECTORY.
827 This operation exists because a directory is also a file, but its name as
828 a directory is different from its name as a file.
829 In Unix-syntax, this function just removes the final slash.
830 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
831 it returns a file name such as \"[X]Y.DIR.1\". */)
833 Lisp_Object directory
;
838 CHECK_STRING (directory
);
840 if (NILP (directory
))
843 /* If the file name has special constructs in it,
844 call the corresponding file handler. */
845 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
847 return call2 (handler
, Qdirectory_file_name
, directory
);
850 /* 20 extra chars is insufficient for VMS, since we might perform a
851 logical name translation. an equivalence string can be up to 255
852 chars long, so grab that much extra space... - sss */
853 buf
= (char *) alloca (SBYTES (directory
) + 20 + 255);
855 buf
= (char *) alloca (SBYTES (directory
) + 20);
857 directory_file_name (SDATA (directory
), buf
);
858 return make_specified_string (buf
, -1, strlen (buf
),
859 STRING_MULTIBYTE (directory
));
862 static char make_temp_name_tbl
[64] =
864 'A','B','C','D','E','F','G','H',
865 'I','J','K','L','M','N','O','P',
866 'Q','R','S','T','U','V','W','X',
867 'Y','Z','a','b','c','d','e','f',
868 'g','h','i','j','k','l','m','n',
869 'o','p','q','r','s','t','u','v',
870 'w','x','y','z','0','1','2','3',
871 '4','5','6','7','8','9','-','_'
874 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
876 /* Value is a temporary file name starting with PREFIX, a string.
878 The Emacs process number forms part of the result, so there is
879 no danger of generating a name being used by another process.
880 In addition, this function makes an attempt to choose a name
881 which has no existing file. To make this work, PREFIX should be
882 an absolute file name.
884 BASE64_P non-zero means add the pid as 3 characters in base64
885 encoding. In this case, 6 characters will be added to PREFIX to
886 form the file name. Otherwise, if Emacs is running on a system
887 with long file names, add the pid as a decimal number.
889 This function signals an error if no unique file name could be
893 make_temp_name (prefix
, base64_p
)
900 unsigned char *p
, *data
;
904 CHECK_STRING (prefix
);
906 /* VAL is created by adding 6 characters to PREFIX. The first
907 three are the PID of this process, in base 64, and the second
908 three are incremented if the file already exists. This ensures
909 262144 unique file names per PID per PREFIX. */
911 pid
= (int) getpid ();
915 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
916 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
917 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
922 #ifdef HAVE_LONG_FILE_NAMES
923 sprintf (pidbuf
, "%d", pid
);
924 pidlen
= strlen (pidbuf
);
926 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
927 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
928 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
933 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
934 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
935 if (!STRING_MULTIBYTE (prefix
))
936 STRING_SET_UNIBYTE (val
);
938 bcopy(SDATA (prefix
), data
, len
);
941 bcopy (pidbuf
, p
, pidlen
);
944 /* Here we try to minimize useless stat'ing when this function is
945 invoked many times successively with the same PREFIX. We achieve
946 this by initializing count to a random value, and incrementing it
949 We don't want make-temp-name to be called while dumping,
950 because then make_temp_name_count_initialized_p would get set
951 and then make_temp_name_count would not be set when Emacs starts. */
953 if (!make_temp_name_count_initialized_p
)
955 make_temp_name_count
= (unsigned) time (NULL
);
956 make_temp_name_count_initialized_p
= 1;
962 unsigned num
= make_temp_name_count
;
964 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
965 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
966 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
968 /* Poor man's congruential RN generator. Replace with
969 ++make_temp_name_count for debugging. */
970 make_temp_name_count
+= 25229;
971 make_temp_name_count
%= 225307;
973 if (stat (data
, &ignored
) < 0)
975 /* We want to return only if errno is ENOENT. */
979 /* The error here is dubious, but there is little else we
980 can do. The alternatives are to return nil, which is
981 as bad as (and in many cases worse than) throwing the
982 error, or to ignore the error, which will likely result
983 in looping through 225307 stat's, which is not only
984 dog-slow, but also useless since it will fallback to
985 the errow below, anyway. */
986 report_file_error ("Cannot create temporary name for prefix",
987 Fcons (prefix
, Qnil
));
992 error ("Cannot create temporary name for prefix `%s'",
998 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
999 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
1000 The Emacs process number forms part of the result,
1001 so there is no danger of generating a name being used by another process.
1003 In addition, this function makes an attempt to choose a name
1004 which has no existing file. To make this work,
1005 PREFIX should be an absolute file name.
1007 There is a race condition between calling `make-temp-name' and creating the
1008 file which opens all kinds of security holes. For that reason, you should
1009 probably use `make-temp-file' instead, except in three circumstances:
1011 * If you are creating the file in the user's home directory.
1012 * If you are creating a directory rather than an ordinary file.
1013 * If you are taking special precautions as `make-temp-file' does. */)
1017 return make_temp_name (prefix
, 0);
1022 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1023 doc
: /* Convert filename NAME to absolute, and canonicalize it.
1024 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1025 \(does not start with slash); if DEFAULT-DIRECTORY is nil or missing,
1026 the current buffer's value of `default-directory' is used.
1027 File name components that are `.' are removed, and
1028 so are file name components followed by `..', along with the `..' itself;
1029 note that these simplifications are done without checking the resulting
1030 file names in the file system.
1031 An initial `~/' expands to your home directory.
1032 An initial `~USER/' expands to USER's home directory.
1033 See also the function `substitute-in-file-name'. */)
1034 (name
, default_directory
)
1035 Lisp_Object name
, default_directory
;
1039 register unsigned char *newdir
, *p
, *o
;
1041 unsigned char *target
;
1044 unsigned char * colon
= 0;
1045 unsigned char * close
= 0;
1046 unsigned char * slash
= 0;
1047 unsigned char * brack
= 0;
1048 int lbrack
= 0, rbrack
= 0;
1053 int collapse_newdir
= 1;
1057 Lisp_Object handler
, result
;
1059 CHECK_STRING (name
);
1061 /* If the file name has special constructs in it,
1062 call the corresponding file handler. */
1063 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
1064 if (!NILP (handler
))
1065 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
1067 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
1068 if (NILP (default_directory
))
1069 default_directory
= current_buffer
->directory
;
1070 if (! STRINGP (default_directory
))
1073 /* "/" is not considered a root directory on DOS_NT, so using "/"
1074 here causes an infinite recursion in, e.g., the following:
1076 (let (default-directory)
1077 (expand-file-name "a"))
1079 To avoid this, we set default_directory to the root of the
1081 extern char *emacs_root_dir (void);
1083 default_directory
= build_string (emacs_root_dir ());
1085 default_directory
= build_string ("/");
1089 if (!NILP (default_directory
))
1091 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
1092 if (!NILP (handler
))
1093 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
1096 o
= SDATA (default_directory
);
1098 /* Make sure DEFAULT_DIRECTORY is properly expanded.
1099 It would be better to do this down below where we actually use
1100 default_directory. Unfortunately, calling Fexpand_file_name recursively
1101 could invoke GC, and the strings might be relocated. This would
1102 be annoying because we have pointers into strings lying around
1103 that would need adjusting, and people would add new pointers to
1104 the code and forget to adjust them, resulting in intermittent bugs.
1105 Putting this call here avoids all that crud.
1107 The EQ test avoids infinite recursion. */
1108 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
1109 /* Save time in some common cases - as long as default_directory
1110 is not relative, it can be canonicalized with name below (if it
1111 is needed at all) without requiring it to be expanded now. */
1113 /* Detect MSDOS file names with drive specifiers. */
1114 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1]) && IS_DIRECTORY_SEP (o
[2]))
1116 /* Detect Windows file names in UNC format. */
1117 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
1119 #else /* not DOS_NT */
1120 /* Detect Unix absolute file names (/... alone is not absolute on
1122 && ! (IS_DIRECTORY_SEP (o
[0]))
1123 #endif /* not DOS_NT */
1126 struct gcpro gcpro1
;
1129 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
1133 name
= FILE_SYSTEM_CASE (name
);
1137 /* We will force directory separators to be either all \ or /, so make
1138 a local copy to modify, even if there ends up being no change. */
1139 nm
= strcpy (alloca (strlen (nm
) + 1), nm
);
1141 /* Note if special escape prefix is present, but remove for now. */
1142 if (nm
[0] == '/' && nm
[1] == ':')
1148 /* Find and remove drive specifier if present; this makes nm absolute
1149 even if the rest of the name appears to be relative. Only look for
1150 drive specifier at the beginning. */
1151 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
1158 /* If we see "c://somedir", we want to strip the first slash after the
1159 colon when stripping the drive letter. Otherwise, this expands to
1161 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1163 #endif /* WINDOWSNT */
1167 /* Discard any previous drive specifier if nm is now in UNC format. */
1168 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1174 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1175 none are found, we can probably return right away. We will avoid
1176 allocating a new string if name is already fully expanded. */
1178 IS_DIRECTORY_SEP (nm
[0])
1180 && drive
&& !is_escaped
1183 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
1190 /* If it turns out that the filename we want to return is just a
1191 suffix of FILENAME, we don't need to go through and edit
1192 things; we just need to construct a new string using data
1193 starting at the middle of FILENAME. If we set lose to a
1194 non-zero value, that means we've discovered that we can't do
1201 /* Since we know the name is absolute, we can assume that each
1202 element starts with a "/". */
1204 /* "." and ".." are hairy. */
1205 if (IS_DIRECTORY_SEP (p
[0])
1207 && (IS_DIRECTORY_SEP (p
[2])
1209 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1212 /* We want to replace multiple `/' in a row with a single
1215 && IS_DIRECTORY_SEP (p
[0])
1216 && IS_DIRECTORY_SEP (p
[1]))
1223 /* if dev:[dir]/, move nm to / */
1224 if (!slash
&& p
> nm
&& (brack
|| colon
)) {
1225 nm
= (brack
? brack
+ 1 : colon
+ 1);
1226 lbrack
= rbrack
= 0;
1233 #ifdef NO_HYPHENS_IN_FILENAMES
1234 if (lbrack
== rbrack
)
1236 /* Avoid clobbering negative version numbers. */
1241 #endif /* NO_HYPHENS_IN_FILENAMES */
1242 if (lbrack
> rbrack
&&
1243 ((p
[-1] == '.' || p
[-1] == '[' || p
[-1] == '<') &&
1244 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>')))
1246 #ifdef NO_HYPHENS_IN_FILENAMES
1249 #endif /* NO_HYPHENS_IN_FILENAMES */
1250 /* count open brackets, reset close bracket pointer */
1251 if (p
[0] == '[' || p
[0] == '<')
1252 lbrack
++, brack
= 0;
1253 /* count close brackets, set close bracket pointer */
1254 if (p
[0] == ']' || p
[0] == '>')
1255 rbrack
++, brack
= p
;
1256 /* detect ][ or >< */
1257 if ((p
[0] == ']' || p
[0] == '>') && (p
[1] == '[' || p
[1] == '<'))
1259 if ((p
[0] == ':' || p
[0] == ']' || p
[0] == '>') && p
[1] == '~')
1260 nm
= p
+ 1, lose
= 1;
1261 if (p
[0] == ':' && (colon
|| slash
))
1262 /* if dev1:[dir]dev2:, move nm to dev2: */
1268 /* if /name/dev:, move nm to dev: */
1271 /* if node::dev:, move colon following dev */
1272 else if (colon
&& colon
[-1] == ':')
1274 /* if dev1:dev2:, move nm to dev2: */
1275 else if (colon
&& colon
[-1] != ':')
1280 if (p
[0] == ':' && !colon
)
1286 if (lbrack
== rbrack
)
1289 else if (p
[0] == '.')
1297 if (index (nm
, '/'))
1299 nm
= sys_translate_unix (nm
);
1300 return make_specified_string (nm
, -1, strlen (nm
),
1301 STRING_MULTIBYTE (name
));
1305 /* Make sure directories are all separated with / or \ as
1306 desired, but avoid allocation of a new string when not
1308 CORRECT_DIR_SEPS (nm
);
1310 if (IS_DIRECTORY_SEP (nm
[1]))
1312 if (strcmp (nm
, SDATA (name
)) != 0)
1313 name
= make_specified_string (nm
, -1, strlen (nm
),
1314 STRING_MULTIBYTE (name
));
1318 /* drive must be set, so this is okay */
1319 if (strcmp (nm
- 2, SDATA (name
)) != 0)
1323 name
= make_specified_string (nm
, -1, p
- nm
,
1324 STRING_MULTIBYTE (name
));
1325 temp
[0] = DRIVE_LETTER (drive
);
1326 name
= concat2 (build_string (temp
), name
);
1329 #else /* not DOS_NT */
1330 if (nm
== SDATA (name
))
1332 return make_specified_string (nm
, -1, strlen (nm
),
1333 STRING_MULTIBYTE (name
));
1334 #endif /* not DOS_NT */
1338 /* At this point, nm might or might not be an absolute file name. We
1339 need to expand ~ or ~user if present, otherwise prefix nm with
1340 default_directory if nm is not absolute, and finally collapse /./
1341 and /foo/../ sequences.
1343 We set newdir to be the appropriate prefix if one is needed:
1344 - the relevant user directory if nm starts with ~ or ~user
1345 - the specified drive's working dir (DOS/NT only) if nm does not
1347 - the value of default_directory.
1349 Note that these prefixes are not guaranteed to be absolute (except
1350 for the working dir of a drive). Therefore, to ensure we always
1351 return an absolute name, if the final prefix is not absolute we
1352 append it to the current working directory. */
1356 if (nm
[0] == '~') /* prefix ~ */
1358 if (IS_DIRECTORY_SEP (nm
[1])
1362 || nm
[1] == 0) /* ~ by itself */
1364 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1365 newdir
= (unsigned char *) "";
1368 collapse_newdir
= 0;
1371 nm
++; /* Don't leave the slash in nm. */
1374 else /* ~user/filename */
1376 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)
1381 o
= (unsigned char *) alloca (p
- nm
+ 1);
1382 bcopy ((char *) nm
, o
, p
- nm
);
1385 pw
= (struct passwd
*) getpwnam (o
+ 1);
1388 newdir
= (unsigned char *) pw
-> pw_dir
;
1390 nm
= p
+ 1; /* skip the terminator */
1394 collapse_newdir
= 0;
1399 /* If we don't find a user of that name, leave the name
1400 unchanged; don't move nm forward to p. */
1405 /* On DOS and Windows, nm is absolute if a drive name was specified;
1406 use the drive's current directory as the prefix if needed. */
1407 if (!newdir
&& drive
)
1409 /* Get default directory if needed to make nm absolute. */
1410 if (!IS_DIRECTORY_SEP (nm
[0]))
1412 newdir
= alloca (MAXPATHLEN
+ 1);
1413 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1418 /* Either nm starts with /, or drive isn't mounted. */
1419 newdir
= alloca (4);
1420 newdir
[0] = DRIVE_LETTER (drive
);
1428 /* Finally, if no prefix has been specified and nm is not absolute,
1429 then it must be expanded relative to default_directory. */
1433 /* /... alone is not absolute on DOS and Windows. */
1434 && !IS_DIRECTORY_SEP (nm
[0])
1437 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1444 newdir
= SDATA (default_directory
);
1446 /* Note if special escape prefix is present, but remove for now. */
1447 if (newdir
[0] == '/' && newdir
[1] == ':')
1458 /* First ensure newdir is an absolute name. */
1460 /* Detect MSDOS file names with drive specifiers. */
1461 ! (IS_DRIVE (newdir
[0])
1462 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1464 /* Detect Windows file names in UNC format. */
1465 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1469 /* Effectively, let newdir be (expand-file-name newdir cwd).
1470 Because of the admonition against calling expand-file-name
1471 when we have pointers into lisp strings, we accomplish this
1472 indirectly by prepending newdir to nm if necessary, and using
1473 cwd (or the wd of newdir's drive) as the new newdir. */
1475 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1480 if (!IS_DIRECTORY_SEP (nm
[0]))
1482 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1483 file_name_as_directory (tmp
, newdir
);
1487 newdir
= alloca (MAXPATHLEN
+ 1);
1490 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1497 /* Strip off drive name from prefix, if present. */
1498 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1504 /* Keep only a prefix from newdir if nm starts with slash
1505 (//server/share for UNC, nothing otherwise). */
1506 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1509 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1511 newdir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1513 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1515 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1527 /* Get rid of any slash at the end of newdir, unless newdir is
1528 just / or // (an incomplete UNC name). */
1529 length
= strlen (newdir
);
1530 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1532 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1536 unsigned char *temp
= (unsigned char *) alloca (length
);
1537 bcopy (newdir
, temp
, length
- 1);
1538 temp
[length
- 1] = 0;
1546 /* Now concatenate the directory and name to new space in the stack frame */
1547 tlen
+= strlen (nm
) + 1;
1549 /* Reserve space for drive specifier and escape prefix, since either
1550 or both may need to be inserted. (The Microsoft x86 compiler
1551 produces incorrect code if the following two lines are combined.) */
1552 target
= (unsigned char *) alloca (tlen
+ 4);
1554 #else /* not DOS_NT */
1555 target
= (unsigned char *) alloca (tlen
);
1556 #endif /* not DOS_NT */
1562 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1565 /* If newdir is effectively "C:/", then the drive letter will have
1566 been stripped and newdir will be "/". Concatenating with an
1567 absolute directory in nm produces "//", which will then be
1568 incorrectly treated as a network share. Ignore newdir in
1569 this case (keeping the drive letter). */
1570 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1571 && newdir
[1] == '\0'))
1573 strcpy (target
, newdir
);
1577 file_name_as_directory (target
, newdir
);
1580 strcat (target
, nm
);
1582 if (index (target
, '/'))
1583 strcpy (target
, sys_translate_unix (target
));
1586 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1588 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1597 if (*p
!= ']' && *p
!= '>' && *p
!= '-')
1603 else if ((p
[0] == ']' || p
[0] == '>') && p
[0] == p
[1] + 2)
1604 /* brackets are offset from each other by 2 */
1607 if (*p
!= '.' && *p
!= '-' && o
[-1] != '.')
1608 /* convert [foo][bar] to [bar] */
1609 while (o
[-1] != '[' && o
[-1] != '<')
1611 else if (*p
== '-' && *o
!= '.')
1614 else if (p
[0] == '-' && o
[-1] == '.' &&
1615 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>'))
1616 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1620 while (o
[-1] != '.' && o
[-1] != '[' && o
[-1] != '<');
1621 if (p
[1] == '.') /* foo.-.bar ==> bar. */
1623 else if (o
[-1] == '.') /* '.foo.-]' ==> ']' */
1625 /* else [foo.-] ==> [-] */
1629 #ifdef NO_HYPHENS_IN_FILENAMES
1631 o
[-1] != '[' && o
[-1] != '<' && o
[-1] != '.' &&
1632 p
[1] != ']' && p
[1] != '>' && p
[1] != '.')
1634 #endif /* NO_HYPHENS_IN_FILENAMES */
1638 if (!IS_DIRECTORY_SEP (*p
))
1642 else if (IS_DIRECTORY_SEP (p
[0])
1644 && (IS_DIRECTORY_SEP (p
[2])
1647 /* If "/." is the entire filename, keep the "/". Otherwise,
1648 just delete the whole "/.". */
1649 if (o
== target
&& p
[2] == '\0')
1653 else if (IS_DIRECTORY_SEP (p
[0]) && p
[1] == '.' && p
[2] == '.'
1654 /* `/../' is the "superroot" on certain file systems.
1655 Turned off on DOS_NT systems because they have no
1656 "superroot" and because this causes us to produce
1657 file names like "d:/../foo" which fail file-related
1658 functions of the underlying OS. (To reproduce, try a
1659 long series of "../../" in default_directory, longer
1660 than the number of levels from the root.) */
1664 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1666 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1668 /* Keep initial / only if this is the whole name. */
1669 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1674 && IS_DIRECTORY_SEP (p
[0]) && IS_DIRECTORY_SEP (p
[1]))
1676 /* Collapse multiple `/' in a row. */
1678 while (IS_DIRECTORY_SEP (*p
))
1685 #endif /* not VMS */
1689 /* At last, set drive name. */
1691 /* Except for network file name. */
1692 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1693 #endif /* WINDOWSNT */
1695 if (!drive
) abort ();
1697 target
[0] = DRIVE_LETTER (drive
);
1700 /* Reinsert the escape prefix if required. */
1707 CORRECT_DIR_SEPS (target
);
1710 result
= make_specified_string (target
, -1, o
- target
,
1711 STRING_MULTIBYTE (name
));
1713 /* Again look to see if the file name has special constructs in it
1714 and perhaps call the corresponding file handler. This is needed
1715 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1716 the ".." component gives us "/user@host:/bar/../baz" which needs
1717 to be expanded again. */
1718 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1719 if (!NILP (handler
))
1720 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1726 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1727 This is the old version of expand-file-name, before it was thoroughly
1728 rewritten for Emacs 10.31. We leave this version here commented-out,
1729 because the code is very complex and likely to have subtle bugs. If
1730 bugs _are_ found, it might be of interest to look at the old code and
1731 see what did it do in the relevant situation.
1733 Don't remove this code: it's true that it will be accessible via CVS,
1734 but a few years from deletion, people will forget it is there. */
1736 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1737 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1738 "Convert FILENAME to absolute, and canonicalize it.\n\
1739 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1740 \(does not start with slash); if DEFAULT is nil or missing,\n\
1741 the current buffer's value of default-directory is used.\n\
1742 Filenames containing `.' or `..' as components are simplified;\n\
1743 initial `~/' expands to your home directory.\n\
1744 See also the function `substitute-in-file-name'.")
1746 Lisp_Object name
, defalt
;
1750 register unsigned char *newdir
, *p
, *o
;
1752 unsigned char *target
;
1756 unsigned char * colon
= 0;
1757 unsigned char * close
= 0;
1758 unsigned char * slash
= 0;
1759 unsigned char * brack
= 0;
1760 int lbrack
= 0, rbrack
= 0;
1764 CHECK_STRING (name
);
1767 /* Filenames on VMS are always upper case. */
1768 name
= Fupcase (name
);
1773 /* If nm is absolute, flush ...// and detect /./ and /../.
1774 If no /./ or /../ we can return right away. */
1786 if (p
[0] == '/' && p
[1] == '/'
1788 /* // at start of filename is meaningful on Apollo system. */
1793 if (p
[0] == '/' && p
[1] == '~')
1794 nm
= p
+ 1, lose
= 1;
1795 if (p
[0] == '/' && p
[1] == '.'
1796 && (p
[2] == '/' || p
[2] == 0
1797 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1803 /* if dev:[dir]/, move nm to / */
1804 if (!slash
&& p
> nm
&& (brack
|| colon
)) {
1805 nm
= (brack
? brack
+ 1 : colon
+ 1);
1806 lbrack
= rbrack
= 0;
1814 /* VMS pre V4.4,convert '-'s in filenames. */
1815 if (lbrack
== rbrack
)
1817 if (dots
< 2) /* this is to allow negative version numbers */
1822 if (lbrack
> rbrack
&&
1823 ((p
[-1] == '.' || p
[-1] == '[' || p
[-1] == '<') &&
1824 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>')))
1830 /* count open brackets, reset close bracket pointer */
1831 if (p
[0] == '[' || p
[0] == '<')
1832 lbrack
++, brack
= 0;
1833 /* count close brackets, set close bracket pointer */
1834 if (p
[0] == ']' || p
[0] == '>')
1835 rbrack
++, brack
= p
;
1836 /* detect ][ or >< */
1837 if ((p
[0] == ']' || p
[0] == '>') && (p
[1] == '[' || p
[1] == '<'))
1839 if ((p
[0] == ':' || p
[0] == ']' || p
[0] == '>') && p
[1] == '~')
1840 nm
= p
+ 1, lose
= 1;
1841 if (p
[0] == ':' && (colon
|| slash
))
1842 /* if dev1:[dir]dev2:, move nm to dev2: */
1848 /* If /name/dev:, move nm to dev: */
1851 /* If node::dev:, move colon following dev */
1852 else if (colon
&& colon
[-1] == ':')
1854 /* If dev1:dev2:, move nm to dev2: */
1855 else if (colon
&& colon
[-1] != ':')
1860 if (p
[0] == ':' && !colon
)
1866 if (lbrack
== rbrack
)
1869 else if (p
[0] == '.')
1877 if (index (nm
, '/'))
1878 return build_string (sys_translate_unix (nm
));
1880 if (nm
== SDATA (name
))
1882 return build_string (nm
);
1886 /* Now determine directory to start with and put it in NEWDIR */
1890 if (nm
[0] == '~') /* prefix ~ */
1895 || nm
[1] == 0)/* ~/filename */
1897 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1898 newdir
= (unsigned char *) "";
1901 nm
++; /* Don't leave the slash in nm. */
1904 else /* ~user/filename */
1906 /* Get past ~ to user */
1907 unsigned char *user
= nm
+ 1;
1908 /* Find end of name. */
1909 unsigned char *ptr
= (unsigned char *) index (user
, '/');
1910 int len
= ptr
? ptr
- user
: strlen (user
);
1912 unsigned char *ptr1
= index (user
, ':');
1913 if (ptr1
!= 0 && ptr1
- user
< len
)
1916 /* Copy the user name into temp storage. */
1917 o
= (unsigned char *) alloca (len
+ 1);
1918 bcopy ((char *) user
, o
, len
);
1921 /* Look up the user name. */
1922 pw
= (struct passwd
*) getpwnam (o
+ 1);
1924 error ("\"%s\" isn't a registered user", o
+ 1);
1926 newdir
= (unsigned char *) pw
->pw_dir
;
1928 /* Discard the user name from NM. */
1935 #endif /* not VMS */
1939 defalt
= current_buffer
->directory
;
1940 CHECK_STRING (defalt
);
1941 newdir
= SDATA (defalt
);
1944 /* Now concatenate the directory and name to new space in the stack frame */
1946 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1947 target
= (unsigned char *) alloca (tlen
);
1953 if (nm
[0] == 0 || nm
[0] == '/')
1954 strcpy (target
, newdir
);
1957 file_name_as_directory (target
, newdir
);
1960 strcat (target
, nm
);
1962 if (index (target
, '/'))
1963 strcpy (target
, sys_translate_unix (target
));
1966 /* Now canonicalize by removing /. and /foo/.. if they appear */
1974 if (*p
!= ']' && *p
!= '>' && *p
!= '-')
1980 else if ((p
[0] == ']' || p
[0] == '>') && p
[0] == p
[1] + 2)
1981 /* brackets are offset from each other by 2 */
1984 if (*p
!= '.' && *p
!= '-' && o
[-1] != '.')
1985 /* convert [foo][bar] to [bar] */
1986 while (o
[-1] != '[' && o
[-1] != '<')
1988 else if (*p
== '-' && *o
!= '.')
1991 else if (p
[0] == '-' && o
[-1] == '.' &&
1992 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>'))
1993 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1997 while (o
[-1] != '.' && o
[-1] != '[' && o
[-1] != '<');
1998 if (p
[1] == '.') /* foo.-.bar ==> bar. */
2000 else if (o
[-1] == '.') /* '.foo.-]' ==> ']' */
2002 /* else [foo.-] ==> [-] */
2008 o
[-1] != '[' && o
[-1] != '<' && o
[-1] != '.' &&
2009 p
[1] != ']' && p
[1] != '>' && p
[1] != '.')
2019 else if (!strncmp (p
, "//", 2)
2021 /* // at start of filename is meaningful in Apollo system. */
2029 else if (p
[0] == '/' && p
[1] == '.' &&
2030 (p
[2] == '/' || p
[2] == 0))
2032 else if (!strncmp (p
, "/..", 3)
2033 /* `/../' is the "superroot" on certain file systems. */
2035 && (p
[3] == '/' || p
[3] == 0))
2037 while (o
!= target
&& *--o
!= '/')
2040 if (o
== target
+ 1 && o
[-1] == '/' && o
[0] == '/')
2044 if (o
== target
&& *o
== '/')
2052 #endif /* not VMS */
2055 return make_string (target
, o
- target
);
2059 /* If /~ or // appears, discard everything through first slash. */
2061 file_name_absolute_p (filename
)
2062 const unsigned char *filename
;
2065 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
2067 /* ??? This criterion is probably wrong for '<'. */
2068 || index (filename
, ':') || index (filename
, '<')
2069 || (*filename
== '[' && (filename
[1] != '-'
2070 || (filename
[2] != '.' && filename
[2] != ']'))
2071 && filename
[1] != '.')
2074 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
2075 && IS_DIRECTORY_SEP (filename
[2]))
2080 static unsigned char *
2081 search_embedded_absfilename (nm
, endp
)
2082 unsigned char *nm
, *endp
;
2084 unsigned char *p
, *s
;
2086 for (p
= nm
+ 1; p
< endp
; p
++)
2090 || p
[-1] == ':' || p
[-1] == ']' || p
[-1] == '>'
2092 || IS_DIRECTORY_SEP (p
[-1]))
2093 && file_name_absolute_p (p
)
2094 #if defined (APOLLO) || defined (WINDOWSNT) || defined(CYGWIN)
2095 /* // at start of file name is meaningful in Apollo,
2096 WindowsNT and Cygwin systems. */
2097 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
2098 #endif /* not (APOLLO || WINDOWSNT || CYGWIN) */
2101 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)
2106 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
2108 unsigned char *o
= alloca (s
- p
+ 1);
2110 bcopy (p
, o
, s
- p
);
2113 /* If we have ~user and `user' exists, discard
2114 everything up to ~. But if `user' does not exist, leave
2115 ~user alone, it might be a literal file name. */
2116 if ((pw
= getpwnam (o
+ 1)))
2128 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
2129 Ssubstitute_in_file_name
, 1, 1, 0,
2130 doc
: /* Substitute environment variables referred to in FILENAME.
2131 `$FOO' where FOO is an environment variable name means to substitute
2132 the value of that variable. The variable name should be terminated
2133 with a character not a letter, digit or underscore; otherwise, enclose
2134 the entire variable name in braces.
2135 If `/~' appears, all of FILENAME through that `/' is discarded.
2137 On VMS, `$' substitution is not done; this function does little and only
2138 duplicates what `expand-file-name' does. */)
2140 Lisp_Object filename
;
2144 register unsigned char *s
, *p
, *o
, *x
, *endp
;
2145 unsigned char *target
= NULL
;
2147 int substituted
= 0;
2149 Lisp_Object handler
;
2151 CHECK_STRING (filename
);
2153 /* If the file name has special constructs in it,
2154 call the corresponding file handler. */
2155 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
2156 if (!NILP (handler
))
2157 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
2159 nm
= SDATA (filename
);
2161 nm
= strcpy (alloca (strlen (nm
) + 1), nm
);
2162 CORRECT_DIR_SEPS (nm
);
2163 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
2165 endp
= nm
+ SBYTES (filename
);
2167 /* If /~ or // appears, discard everything through first slash. */
2168 p
= search_embedded_absfilename (nm
, endp
);
2170 /* Start over with the new string, so we check the file-name-handler
2171 again. Important with filenames like "/home/foo//:/hello///there"
2172 which whould substitute to "/:/hello///there" rather than "/there". */
2173 return Fsubstitute_in_file_name
2174 (make_specified_string (p
, -1, endp
- p
,
2175 STRING_MULTIBYTE (filename
)));
2181 /* See if any variables are substituted into the string
2182 and find the total length of their values in `total' */
2184 for (p
= nm
; p
!= endp
;)
2194 /* "$$" means a single "$" */
2203 while (p
!= endp
&& *p
!= '}') p
++;
2204 if (*p
!= '}') goto missingclose
;
2210 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
2214 /* Copy out the variable name */
2215 target
= (unsigned char *) alloca (s
- o
+ 1);
2216 strncpy (target
, o
, s
- o
);
2219 strupr (target
); /* $home == $HOME etc. */
2222 /* Get variable value */
2223 o
= (unsigned char *) egetenv (target
);
2226 total
+= strlen (o
);
2236 /* If substitution required, recopy the string and do it */
2237 /* Make space in stack frame for the new copy */
2238 xnm
= (unsigned char *) alloca (SBYTES (filename
) + total
+ 1);
2241 /* Copy the rest of the name through, replacing $ constructs with values */
2258 while (p
!= endp
&& *p
!= '}') p
++;
2259 if (*p
!= '}') goto missingclose
;
2265 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
2269 /* Copy out the variable name */
2270 target
= (unsigned char *) alloca (s
- o
+ 1);
2271 strncpy (target
, o
, s
- o
);
2274 strupr (target
); /* $home == $HOME etc. */
2277 /* Get variable value */
2278 o
= (unsigned char *) egetenv (target
);
2282 strcpy (x
, target
); x
+= strlen (target
);
2284 else if (STRING_MULTIBYTE (filename
))
2286 /* If the original string is multibyte,
2287 convert what we substitute into multibyte. */
2290 int c
= unibyte_char_to_multibyte (*o
++);
2291 x
+= CHAR_STRING (c
, x
);
2303 /* If /~ or // appears, discard everything through first slash. */
2304 while ((p
= search_embedded_absfilename (xnm
, x
)))
2305 /* This time we do not start over because we've already expanded envvars
2306 and replaced $$ with $. Maybe we should start over as well, but we'd
2307 need to quote some $ to $$ first. */
2310 return make_specified_string (xnm
, -1, x
- xnm
, STRING_MULTIBYTE (filename
));
2313 error ("Bad format environment-variable substitution");
2315 error ("Missing \"}\" in environment-variable substitution");
2317 error ("Substituting nonexistent environment variable \"%s\"", target
);
2320 #endif /* not VMS */
2324 /* A slightly faster and more convenient way to get
2325 (directory-file-name (expand-file-name FOO)). */
2328 expand_and_dir_to_file (filename
, defdir
)
2329 Lisp_Object filename
, defdir
;
2331 register Lisp_Object absname
;
2333 absname
= Fexpand_file_name (filename
, defdir
);
2336 register int c
= SREF (absname
, SBYTES (absname
) - 1);
2337 if (c
== ':' || c
== ']' || c
== '>')
2338 absname
= Fdirectory_file_name (absname
);
2341 /* Remove final slash, if any (unless this is the root dir).
2342 stat behaves differently depending! */
2343 if (SCHARS (absname
) > 1
2344 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
2345 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
2346 /* We cannot take shortcuts; they might be wrong for magic file names. */
2347 absname
= Fdirectory_file_name (absname
);
2352 /* Signal an error if the file ABSNAME already exists.
2353 If INTERACTIVE is nonzero, ask the user whether to proceed,
2354 and bypass the error if the user says to go ahead.
2355 QUERYSTRING is a name for the action that is being considered
2358 *STATPTR is used to store the stat information if the file exists.
2359 If the file does not exist, STATPTR->st_mode is set to 0.
2360 If STATPTR is null, we don't store into it.
2362 If QUICK is nonzero, we ask for y or n, not yes or no. */
2365 barf_or_query_if_file_exists (absname
, querystring
, interactive
, statptr
, quick
)
2366 Lisp_Object absname
;
2367 unsigned char *querystring
;
2369 struct stat
*statptr
;
2372 register Lisp_Object tem
, encoded_filename
;
2373 struct stat statbuf
;
2374 struct gcpro gcpro1
;
2376 encoded_filename
= ENCODE_FILE (absname
);
2378 /* stat is a good way to tell whether the file exists,
2379 regardless of what access permissions it has. */
2380 if (lstat (SDATA (encoded_filename
), &statbuf
) >= 0)
2383 Fsignal (Qfile_already_exists
,
2384 Fcons (build_string ("File already exists"),
2385 Fcons (absname
, Qnil
)));
2387 tem
= format2 ("File %s already exists; %s anyway? ",
2388 absname
, build_string (querystring
));
2390 tem
= Fy_or_n_p (tem
);
2392 tem
= do_yes_or_no_p (tem
);
2395 Fsignal (Qfile_already_exists
,
2396 Fcons (build_string ("File already exists"),
2397 Fcons (absname
, Qnil
)));
2404 statptr
->st_mode
= 0;
2409 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
2410 "fCopy file: \nGCopy %s to file: \np\nP",
2411 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
2412 If NEWNAME names a directory, copy FILE there.
2413 Signals a `file-already-exists' error if file NEWNAME already exists,
2414 unless a third argument OK-IF-ALREADY-EXISTS is supplied and non-nil.
2415 A number as third arg means request confirmation if NEWNAME already exists.
2416 This is what happens in interactive use with M-x.
2417 Always sets the file modes of the output file to match the input file.
2419 Fourth arg KEEP-TIME non-nil means give the output file the same
2420 last-modified time as the old one. (This works on only some systems.)
2422 A prefix arg makes KEEP-TIME non-nil.
2424 The optional fifth arg MUSTBENEW, if non-nil, insists on a check
2425 for an existing file with the same name. If MUSTBENEW is `excl',
2426 that means to get an error if the file already exists; never overwrite.
2427 If MUSTBENEW is neither nil nor `excl', that means ask for
2428 confirmation before overwriting, but do go ahead and overwrite the file
2429 if the user confirms.
2431 If PRESERVE-UID-GID is non-nil, we try to transfer the
2432 uid and gid of FILE to NEWNAME. */)
2433 (file
, newname
, ok_if_already_exists
, keep_time
, mustbenew
, preserve_uid_gid
)
2434 Lisp_Object file
, newname
, ok_if_already_exists
, keep_time
, mustbenew
;
2435 Lisp_Object preserve_uid_gid
;
2438 char buf
[16 * 1024];
2439 struct stat st
, out_st
;
2440 Lisp_Object handler
;
2441 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2442 int count
= SPECPDL_INDEX ();
2443 int input_file_statable_p
;
2444 Lisp_Object encoded_file
, encoded_newname
;
2446 encoded_file
= encoded_newname
= Qnil
;
2447 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2448 CHECK_STRING (file
);
2449 CHECK_STRING (newname
);
2451 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
2452 barf_or_query_if_file_exists (newname
, "overwrite", 1, 0, 1);
2454 if (!NILP (Ffile_directory_p (newname
)))
2455 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2457 newname
= Fexpand_file_name (newname
, Qnil
);
2459 file
= Fexpand_file_name (file
, Qnil
);
2461 /* If the input file name has special constructs in it,
2462 call the corresponding file handler. */
2463 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
2464 /* Likewise for output file name. */
2466 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
2467 if (!NILP (handler
))
2468 RETURN_UNGCPRO (call5 (handler
, Qcopy_file
, file
, newname
,
2469 ok_if_already_exists
, keep_time
));
2471 encoded_file
= ENCODE_FILE (file
);
2472 encoded_newname
= ENCODE_FILE (newname
);
2474 if (NILP (ok_if_already_exists
)
2475 || INTEGERP (ok_if_already_exists
))
2476 barf_or_query_if_file_exists (encoded_newname
, "copy to it",
2477 INTEGERP (ok_if_already_exists
), &out_st
, 0);
2478 else if (stat (SDATA (encoded_newname
), &out_st
) < 0)
2482 if (!CopyFile (SDATA (encoded_file
),
2483 SDATA (encoded_newname
),
2485 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
2486 /* CopyFile retains the timestamp by default. */
2487 else if (NILP (keep_time
))
2493 EMACS_GET_TIME (now
);
2494 filename
= SDATA (encoded_newname
);
2496 /* Ensure file is writable while its modified time is set. */
2497 attributes
= GetFileAttributes (filename
);
2498 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2499 if (set_file_times (filename
, now
, now
))
2501 /* Restore original attributes. */
2502 SetFileAttributes (filename
, attributes
);
2503 Fsignal (Qfile_date_error
,
2504 Fcons (build_string ("Cannot set file date"),
2505 Fcons (newname
, Qnil
)));
2507 /* Restore original attributes. */
2508 SetFileAttributes (filename
, attributes
);
2510 #else /* not WINDOWSNT */
2512 ifd
= emacs_open (SDATA (encoded_file
), O_RDONLY
, 0);
2516 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2518 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2520 /* We can only copy regular files and symbolic links. Other files are not
2522 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
2524 #if !defined (MSDOS) || __DJGPP__ > 1
2525 if (out_st
.st_mode
!= 0
2526 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2529 report_file_error ("Input and output files are the same",
2530 Fcons (file
, Fcons (newname
, Qnil
)));
2534 #if defined (S_ISREG) && defined (S_ISLNK)
2535 if (input_file_statable_p
)
2537 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
2539 #if defined (EISDIR)
2540 /* Get a better looking error message. */
2543 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2546 #endif /* S_ISREG && S_ISLNK */
2549 /* Create the copy file with the same record format as the input file */
2550 ofd
= sys_creat (SDATA (encoded_newname
), 0666, ifd
);
2553 /* System's default file type was set to binary by _fmode in emacs.c. */
2554 ofd
= emacs_open (SDATA (encoded_newname
),
2555 O_WRONLY
| O_TRUNC
| O_CREAT
2556 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
2557 S_IREAD
| S_IWRITE
);
2558 #else /* not MSDOS */
2559 ofd
= emacs_open (SDATA (encoded_newname
),
2560 O_WRONLY
| O_TRUNC
| O_CREAT
2561 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
2563 #endif /* not MSDOS */
2566 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2568 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2572 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2573 if (emacs_write (ofd
, buf
, n
) != n
)
2574 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2578 /* Preserve the original file modes, and if requested, also its
2580 if (input_file_statable_p
)
2582 if (! NILP (preserve_uid_gid
))
2583 fchown (ofd
, st
.st_uid
, st
.st_gid
);
2584 fchmod (ofd
, st
.st_mode
& 07777);
2586 #endif /* not MSDOS */
2588 /* Closing the output clobbers the file times on some systems. */
2589 if (emacs_close (ofd
) < 0)
2590 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2592 if (input_file_statable_p
)
2594 if (!NILP (keep_time
))
2596 EMACS_TIME atime
, mtime
;
2597 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
2598 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
2599 if (set_file_times (SDATA (encoded_newname
),
2601 Fsignal (Qfile_date_error
,
2602 Fcons (build_string ("Cannot set file date"),
2603 Fcons (newname
, Qnil
)));
2609 #if defined (__DJGPP__) && __DJGPP__ > 1
2610 if (input_file_statable_p
)
2612 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2613 and if it can't, it tells so. Otherwise, under MSDOS we usually
2614 get only the READ bit, which will make the copied file read-only,
2615 so it's better not to chmod at all. */
2616 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2617 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2619 #endif /* DJGPP version 2 or newer */
2620 #endif /* not WINDOWSNT */
2622 /* Discard the unwind protects. */
2623 specpdl_ptr
= specpdl
+ count
;
2629 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2630 Smake_directory_internal
, 1, 1, 0,
2631 doc
: /* Create a new directory named DIRECTORY. */)
2633 Lisp_Object directory
;
2635 const unsigned char *dir
;
2636 Lisp_Object handler
;
2637 Lisp_Object encoded_dir
;
2639 CHECK_STRING (directory
);
2640 directory
= Fexpand_file_name (directory
, Qnil
);
2642 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2643 if (!NILP (handler
))
2644 return call2 (handler
, Qmake_directory_internal
, directory
);
2646 encoded_dir
= ENCODE_FILE (directory
);
2648 dir
= SDATA (encoded_dir
);
2651 if (mkdir (dir
) != 0)
2653 if (mkdir (dir
, 0777) != 0)
2655 report_file_error ("Creating directory", Flist (1, &directory
));
2660 DEFUN ("delete-directory", Fdelete_directory
, Sdelete_directory
, 1, 1, "FDelete directory: ",
2661 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2663 Lisp_Object directory
;
2665 const unsigned char *dir
;
2666 Lisp_Object handler
;
2667 Lisp_Object encoded_dir
;
2669 CHECK_STRING (directory
);
2670 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2672 handler
= Ffind_file_name_handler (directory
, Qdelete_directory
);
2673 if (!NILP (handler
))
2674 return call2 (handler
, Qdelete_directory
, directory
);
2676 encoded_dir
= ENCODE_FILE (directory
);
2678 dir
= SDATA (encoded_dir
);
2680 if (rmdir (dir
) != 0)
2681 report_file_error ("Removing directory", Flist (1, &directory
));
2686 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 1, "fDelete file: ",
2687 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2688 If file has multiple names, it continues to exist with the other names. */)
2690 Lisp_Object filename
;
2692 Lisp_Object handler
;
2693 Lisp_Object encoded_file
;
2694 struct gcpro gcpro1
;
2697 if (!NILP (Ffile_directory_p (filename
))
2698 && NILP (Ffile_symlink_p (filename
)))
2699 Fsignal (Qfile_error
,
2700 Fcons (build_string ("Removing old name: is a directory"),
2701 Fcons (filename
, Qnil
)));
2703 filename
= Fexpand_file_name (filename
, Qnil
);
2705 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2706 if (!NILP (handler
))
2707 return call2 (handler
, Qdelete_file
, filename
);
2709 encoded_file
= ENCODE_FILE (filename
);
2711 if (0 > unlink (SDATA (encoded_file
)))
2712 report_file_error ("Removing old name", Flist (1, &filename
));
2717 internal_delete_file_1 (ignore
)
2723 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2726 internal_delete_file (filename
)
2727 Lisp_Object filename
;
2729 return NILP (internal_condition_case_1 (Fdelete_file
, filename
,
2730 Qt
, internal_delete_file_1
));
2733 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2734 "fRename file: \nGRename %s to file: \np",
2735 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2736 If file has names other than FILE, it continues to have those names.
2737 Signals a `file-already-exists' error if a file NEWNAME already exists
2738 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2739 A number as third arg means request confirmation if NEWNAME already exists.
2740 This is what happens in interactive use with M-x. */)
2741 (file
, newname
, ok_if_already_exists
)
2742 Lisp_Object file
, newname
, ok_if_already_exists
;
2745 Lisp_Object args
[2];
2747 Lisp_Object handler
;
2748 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2749 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2751 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2752 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2753 CHECK_STRING (file
);
2754 CHECK_STRING (newname
);
2755 file
= Fexpand_file_name (file
, Qnil
);
2757 if (!NILP (Ffile_directory_p (newname
)))
2758 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2760 newname
= Fexpand_file_name (newname
, Qnil
);
2762 /* If the file name has special constructs in it,
2763 call the corresponding file handler. */
2764 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2766 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2767 if (!NILP (handler
))
2768 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2769 file
, newname
, ok_if_already_exists
));
2771 encoded_file
= ENCODE_FILE (file
);
2772 encoded_newname
= ENCODE_FILE (newname
);
2775 /* If the file names are identical but for the case, don't ask for
2776 confirmation: they simply want to change the letter-case of the
2778 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2780 if (NILP (ok_if_already_exists
)
2781 || INTEGERP (ok_if_already_exists
))
2782 barf_or_query_if_file_exists (encoded_newname
, "rename to it",
2783 INTEGERP (ok_if_already_exists
), 0, 0);
2785 if (0 > rename (SDATA (encoded_file
), SDATA (encoded_newname
)))
2787 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
))
2788 || 0 > unlink (SDATA (encoded_file
)))
2794 symlink_target
= Ffile_symlink_p (file
);
2795 if (! NILP (symlink_target
))
2796 Fmake_symbolic_link (symlink_target
, newname
,
2797 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2800 Fcopy_file (file
, newname
,
2801 /* We have already prompted if it was an integer,
2802 so don't have copy-file prompt again. */
2803 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2806 Fdelete_file (file
);
2813 report_file_error ("Renaming", Flist (2, args
));
2816 report_file_error ("Renaming", Flist (2, &file
));
2823 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2824 "fAdd name to file: \nGName to add to %s: \np",
2825 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2826 Signals a `file-already-exists' error if a file NEWNAME already exists
2827 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2828 A number as third arg means request confirmation if NEWNAME already exists.
2829 This is what happens in interactive use with M-x. */)
2830 (file
, newname
, ok_if_already_exists
)
2831 Lisp_Object file
, newname
, ok_if_already_exists
;
2834 Lisp_Object args
[2];
2836 Lisp_Object handler
;
2837 Lisp_Object encoded_file
, encoded_newname
;
2838 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2840 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2841 encoded_file
= encoded_newname
= Qnil
;
2842 CHECK_STRING (file
);
2843 CHECK_STRING (newname
);
2844 file
= Fexpand_file_name (file
, Qnil
);
2846 if (!NILP (Ffile_directory_p (newname
)))
2847 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2849 newname
= Fexpand_file_name (newname
, Qnil
);
2851 /* If the file name has special constructs in it,
2852 call the corresponding file handler. */
2853 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2854 if (!NILP (handler
))
2855 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2856 newname
, ok_if_already_exists
));
2858 /* If the new name has special constructs in it,
2859 call the corresponding file handler. */
2860 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2861 if (!NILP (handler
))
2862 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2863 newname
, ok_if_already_exists
));
2865 encoded_file
= ENCODE_FILE (file
);
2866 encoded_newname
= ENCODE_FILE (newname
);
2868 if (NILP (ok_if_already_exists
)
2869 || INTEGERP (ok_if_already_exists
))
2870 barf_or_query_if_file_exists (encoded_newname
, "make it a new name",
2871 INTEGERP (ok_if_already_exists
), 0, 0);
2873 unlink (SDATA (newname
));
2874 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
)))
2879 report_file_error ("Adding new name", Flist (2, args
));
2881 report_file_error ("Adding new name", Flist (2, &file
));
2890 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2891 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2892 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2893 Both args must be strings.
2894 Signals a `file-already-exists' error if a file LINKNAME already exists
2895 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2896 A number as third arg means request confirmation if LINKNAME already exists.
2897 This happens for interactive use with M-x. */)
2898 (filename
, linkname
, ok_if_already_exists
)
2899 Lisp_Object filename
, linkname
, ok_if_already_exists
;
2902 Lisp_Object args
[2];
2904 Lisp_Object handler
;
2905 Lisp_Object encoded_filename
, encoded_linkname
;
2906 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2908 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2909 encoded_filename
= encoded_linkname
= Qnil
;
2910 CHECK_STRING (filename
);
2911 CHECK_STRING (linkname
);
2912 /* If the link target has a ~, we must expand it to get
2913 a truly valid file name. Otherwise, do not expand;
2914 we want to permit links to relative file names. */
2915 if (SREF (filename
, 0) == '~')
2916 filename
= Fexpand_file_name (filename
, Qnil
);
2918 if (!NILP (Ffile_directory_p (linkname
)))
2919 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2921 linkname
= Fexpand_file_name (linkname
, Qnil
);
2923 /* If the file name has special constructs in it,
2924 call the corresponding file handler. */
2925 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2926 if (!NILP (handler
))
2927 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2928 linkname
, ok_if_already_exists
));
2930 /* If the new link name has special constructs in it,
2931 call the corresponding file handler. */
2932 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2933 if (!NILP (handler
))
2934 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2935 linkname
, ok_if_already_exists
));
2937 encoded_filename
= ENCODE_FILE (filename
);
2938 encoded_linkname
= ENCODE_FILE (linkname
);
2940 if (NILP (ok_if_already_exists
)
2941 || INTEGERP (ok_if_already_exists
))
2942 barf_or_query_if_file_exists (encoded_linkname
, "make it a link",
2943 INTEGERP (ok_if_already_exists
), 0, 0);
2944 if (0 > symlink (SDATA (encoded_filename
),
2945 SDATA (encoded_linkname
)))
2947 /* If we didn't complain already, silently delete existing file. */
2948 if (errno
== EEXIST
)
2950 unlink (SDATA (encoded_linkname
));
2951 if (0 <= symlink (SDATA (encoded_filename
),
2952 SDATA (encoded_linkname
)))
2962 report_file_error ("Making symbolic link", Flist (2, args
));
2964 report_file_error ("Making symbolic link", Flist (2, &filename
));
2970 #endif /* S_IFLNK */
2974 DEFUN ("define-logical-name", Fdefine_logical_name
, Sdefine_logical_name
,
2975 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2976 doc
: /* Define the job-wide logical name NAME to have the value STRING.
2977 If STRING is nil or a null string, the logical name NAME is deleted. */)
2982 CHECK_STRING (name
);
2984 delete_logical_name (SDATA (name
));
2987 CHECK_STRING (string
);
2989 if (SCHARS (string
) == 0)
2990 delete_logical_name (SDATA (name
));
2992 define_logical_name (SDATA (name
), SDATA (string
));
3001 DEFUN ("sysnetunam", Fsysnetunam
, Ssysnetunam
, 2, 2, 0,
3002 doc
: /* Open a network connection to PATH using LOGIN as the login string. */)
3004 Lisp_Object path
, login
;
3008 CHECK_STRING (path
);
3009 CHECK_STRING (login
);
3011 netresult
= netunam (SDATA (path
), SDATA (login
));
3013 if (netresult
== -1)
3018 #endif /* HPUX_NET */
3020 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
3022 doc
: /* Return t if file FILENAME specifies an absolute file name.
3023 On Unix, this is a name starting with a `/' or a `~'. */)
3025 Lisp_Object filename
;
3027 CHECK_STRING (filename
);
3028 return file_name_absolute_p (SDATA (filename
)) ? Qt
: Qnil
;
3031 /* Return nonzero if file FILENAME exists and can be executed. */
3034 check_executable (filename
)
3038 int len
= strlen (filename
);
3041 if (stat (filename
, &st
) < 0)
3043 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
3044 return ((st
.st_mode
& S_IEXEC
) != 0);
3046 return (S_ISREG (st
.st_mode
)
3048 && (stricmp ((suffix
= filename
+ len
-4), ".com") == 0
3049 || stricmp (suffix
, ".exe") == 0
3050 || stricmp (suffix
, ".bat") == 0)
3051 || (st
.st_mode
& S_IFMT
) == S_IFDIR
);
3052 #endif /* not WINDOWSNT */
3053 #else /* not DOS_NT */
3054 #ifdef HAVE_EUIDACCESS
3055 return (euidaccess (filename
, 1) >= 0);
3057 /* Access isn't quite right because it uses the real uid
3058 and we really want to test with the effective uid.
3059 But Unix doesn't give us a right way to do it. */
3060 return (access (filename
, 1) >= 0);
3062 #endif /* not DOS_NT */
3065 /* Return nonzero if file FILENAME exists and can be written. */
3068 check_writable (filename
)
3073 if (stat (filename
, &st
) < 0)
3075 return (st
.st_mode
& S_IWRITE
|| (st
.st_mode
& S_IFMT
) == S_IFDIR
);
3076 #else /* not MSDOS */
3077 #ifdef HAVE_EUIDACCESS
3078 return (euidaccess (filename
, 2) >= 0);
3080 /* Access isn't quite right because it uses the real uid
3081 and we really want to test with the effective uid.
3082 But Unix doesn't give us a right way to do it.
3083 Opening with O_WRONLY could work for an ordinary file,
3084 but would lose for directories. */
3085 return (access (filename
, 2) >= 0);
3087 #endif /* not MSDOS */
3090 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
3091 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
3092 See also `file-readable-p' and `file-attributes'.
3093 This returns nil for a symlink to a nonexistent file.
3094 Use `file-symlink-p' to test for such links. */)
3096 Lisp_Object filename
;
3098 Lisp_Object absname
;
3099 Lisp_Object handler
;
3100 struct stat statbuf
;
3102 CHECK_STRING (filename
);
3103 absname
= Fexpand_file_name (filename
, Qnil
);
3105 /* If the file name has special constructs in it,
3106 call the corresponding file handler. */
3107 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
3108 if (!NILP (handler
))
3109 return call2 (handler
, Qfile_exists_p
, absname
);
3111 absname
= ENCODE_FILE (absname
);
3113 return (stat (SDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
3116 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
3117 doc
: /* Return t if FILENAME can be executed by you.
3118 For a directory, this means you can access files in that directory. */)
3120 Lisp_Object filename
;
3122 Lisp_Object absname
;
3123 Lisp_Object handler
;
3125 CHECK_STRING (filename
);
3126 absname
= Fexpand_file_name (filename
, Qnil
);
3128 /* If the file name has special constructs in it,
3129 call the corresponding file handler. */
3130 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
3131 if (!NILP (handler
))
3132 return call2 (handler
, Qfile_executable_p
, absname
);
3134 absname
= ENCODE_FILE (absname
);
3136 return (check_executable (SDATA (absname
)) ? Qt
: Qnil
);
3139 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
3140 doc
: /* Return t if file FILENAME exists and you can read it.
3141 See also `file-exists-p' and `file-attributes'. */)
3143 Lisp_Object filename
;
3145 Lisp_Object absname
;
3146 Lisp_Object handler
;
3149 struct stat statbuf
;
3151 CHECK_STRING (filename
);
3152 absname
= Fexpand_file_name (filename
, Qnil
);
3154 /* If the file name has special constructs in it,
3155 call the corresponding file handler. */
3156 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
3157 if (!NILP (handler
))
3158 return call2 (handler
, Qfile_readable_p
, absname
);
3160 absname
= ENCODE_FILE (absname
);
3162 #if defined(DOS_NT) || defined(macintosh)
3163 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3165 if (access (SDATA (absname
), 0) == 0)
3168 #else /* not DOS_NT and not macintosh */
3170 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3171 /* Opening a fifo without O_NONBLOCK can wait.
3172 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3173 except in the case of a fifo, on a system which handles it. */
3174 desc
= stat (SDATA (absname
), &statbuf
);
3177 if (S_ISFIFO (statbuf
.st_mode
))
3178 flags
|= O_NONBLOCK
;
3180 desc
= emacs_open (SDATA (absname
), flags
, 0);
3185 #endif /* not DOS_NT and not macintosh */
3188 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3190 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
3191 doc
: /* Return t if file FILENAME can be written or created by you. */)
3193 Lisp_Object filename
;
3195 Lisp_Object absname
, dir
, encoded
;
3196 Lisp_Object handler
;
3197 struct stat statbuf
;
3199 CHECK_STRING (filename
);
3200 absname
= Fexpand_file_name (filename
, Qnil
);
3202 /* If the file name has special constructs in it,
3203 call the corresponding file handler. */
3204 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
3205 if (!NILP (handler
))
3206 return call2 (handler
, Qfile_writable_p
, absname
);
3208 encoded
= ENCODE_FILE (absname
);
3209 if (stat (SDATA (encoded
), &statbuf
) >= 0)
3210 return (check_writable (SDATA (encoded
))
3213 dir
= Ffile_name_directory (absname
);
3216 dir
= Fdirectory_file_name (dir
);
3220 dir
= Fdirectory_file_name (dir
);
3223 dir
= ENCODE_FILE (dir
);
3225 /* The read-only attribute of the parent directory doesn't affect
3226 whether a file or directory can be created within it. Some day we
3227 should check ACLs though, which do affect this. */
3228 if (stat (SDATA (dir
), &statbuf
) < 0)
3230 return (statbuf
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
3232 return (check_writable (!NILP (dir
) ? (char *) SDATA (dir
) : "")
3237 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
3238 doc
: /* Access file FILENAME, and get an error if that does not work.
3239 The second argument STRING is used in the error message.
3240 If there is no error, returns nil. */)
3242 Lisp_Object filename
, string
;
3244 Lisp_Object handler
, encoded_filename
, absname
;
3247 CHECK_STRING (filename
);
3248 absname
= Fexpand_file_name (filename
, Qnil
);
3250 CHECK_STRING (string
);
3252 /* If the file name has special constructs in it,
3253 call the corresponding file handler. */
3254 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
3255 if (!NILP (handler
))
3256 return call3 (handler
, Qaccess_file
, absname
, string
);
3258 encoded_filename
= ENCODE_FILE (absname
);
3260 fd
= emacs_open (SDATA (encoded_filename
), O_RDONLY
, 0);
3262 report_file_error (SDATA (string
), Fcons (filename
, Qnil
));
3268 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
3269 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
3270 The value is the link target, as a string.
3271 Otherwise it returns nil.
3273 This function returns t when given the name of a symlink that
3274 points to a nonexistent file. */)
3276 Lisp_Object filename
;
3278 Lisp_Object handler
;
3280 CHECK_STRING (filename
);
3281 filename
= Fexpand_file_name (filename
, Qnil
);
3283 /* If the file name has special constructs in it,
3284 call the corresponding file handler. */
3285 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
3286 if (!NILP (handler
))
3287 return call2 (handler
, Qfile_symlink_p
, filename
);
3296 filename
= ENCODE_FILE (filename
);
3303 buf
= (char *) xrealloc (buf
, bufsize
);
3304 bzero (buf
, bufsize
);
3307 valsize
= readlink (SDATA (filename
), buf
, bufsize
);
3311 /* HP-UX reports ERANGE if buffer is too small. */
3312 if (errno
== ERANGE
)
3322 while (valsize
>= bufsize
);
3324 val
= make_string (buf
, valsize
);
3325 if (buf
[0] == '/' && index (buf
, ':'))
3326 val
= concat2 (build_string ("/:"), val
);
3328 val
= DECODE_FILE (val
);
3331 #else /* not S_IFLNK */
3333 #endif /* not S_IFLNK */
3336 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
3337 doc
: /* Return t if FILENAME names an existing directory.
3338 Symbolic links to directories count as directories.
3339 See `file-symlink-p' to distinguish symlinks. */)
3341 Lisp_Object filename
;
3343 register Lisp_Object absname
;
3345 Lisp_Object handler
;
3347 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3349 /* If the file name has special constructs in it,
3350 call the corresponding file handler. */
3351 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
3352 if (!NILP (handler
))
3353 return call2 (handler
, Qfile_directory_p
, absname
);
3355 absname
= ENCODE_FILE (absname
);
3357 if (stat (SDATA (absname
), &st
) < 0)
3359 return (st
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
3362 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
3363 doc
: /* Return t if file FILENAME names a directory you can open.
3364 For the value to be t, FILENAME must specify the name of a directory as a file,
3365 and the directory must allow you to open files in it. In order to use a
3366 directory as a buffer's current directory, this predicate must return true.
3367 A directory name spec may be given instead; then the value is t
3368 if the directory so specified exists and really is a readable and
3369 searchable directory. */)
3371 Lisp_Object filename
;
3373 Lisp_Object handler
;
3375 struct gcpro gcpro1
;
3377 /* If the file name has special constructs in it,
3378 call the corresponding file handler. */
3379 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
3380 if (!NILP (handler
))
3381 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
3384 tem
= (NILP (Ffile_directory_p (filename
))
3385 || NILP (Ffile_executable_p (filename
)));
3387 return tem
? Qnil
: Qt
;
3390 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
3391 doc
: /* Return t if file FILENAME is the name of a regular file.
3392 This is the sort of file that holds an ordinary stream of data bytes. */)
3394 Lisp_Object filename
;
3396 register Lisp_Object absname
;
3398 Lisp_Object handler
;
3400 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3402 /* If the file name has special constructs in it,
3403 call the corresponding file handler. */
3404 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
3405 if (!NILP (handler
))
3406 return call2 (handler
, Qfile_regular_p
, absname
);
3408 absname
= ENCODE_FILE (absname
);
3413 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3415 /* Tell stat to use expensive method to get accurate info. */
3416 Vw32_get_true_file_attributes
= Qt
;
3417 result
= stat (SDATA (absname
), &st
);
3418 Vw32_get_true_file_attributes
= tem
;
3422 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
3425 if (stat (SDATA (absname
), &st
) < 0)
3427 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
3431 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3432 doc
: /* Return mode bits of file named FILENAME, as an integer.
3433 Return nil, if file does not exist or is not accessible. */)
3435 Lisp_Object filename
;
3437 Lisp_Object absname
;
3439 Lisp_Object handler
;
3441 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3443 /* If the file name has special constructs in it,
3444 call the corresponding file handler. */
3445 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3446 if (!NILP (handler
))
3447 return call2 (handler
, Qfile_modes
, absname
);
3449 absname
= ENCODE_FILE (absname
);
3451 if (stat (SDATA (absname
), &st
) < 0)
3453 #if defined (MSDOS) && __DJGPP__ < 2
3454 if (check_executable (SDATA (absname
)))
3455 st
.st_mode
|= S_IEXEC
;
3456 #endif /* MSDOS && __DJGPP__ < 2 */
3458 return make_number (st
.st_mode
& 07777);
3461 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2, 0,
3462 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3463 Only the 12 low bits of MODE are used. */)
3465 Lisp_Object filename
, mode
;
3467 Lisp_Object absname
, encoded_absname
;
3468 Lisp_Object handler
;
3470 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
3471 CHECK_NUMBER (mode
);
3473 /* If the file name has special constructs in it,
3474 call the corresponding file handler. */
3475 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3476 if (!NILP (handler
))
3477 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3479 encoded_absname
= ENCODE_FILE (absname
);
3481 if (chmod (SDATA (encoded_absname
), XINT (mode
)) < 0)
3482 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3487 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3488 doc
: /* Set the file permission bits for newly created files.
3489 The argument MODE should be an integer; only the low 9 bits are used.
3490 This setting is inherited by subprocesses. */)
3494 CHECK_NUMBER (mode
);
3496 umask ((~ XINT (mode
)) & 0777);
3501 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3502 doc
: /* Return the default file protection for created files.
3503 The value is an integer. */)
3509 realmask
= umask (0);
3512 XSETINT (value
, (~ realmask
) & 0777);
3516 extern int lisp_time_argument
P_ ((Lisp_Object
, time_t *, int *));
3518 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3519 doc
: /* Set times of file FILENAME to TIME.
3520 Set both access and modification times.
3521 Return t on success, else nil.
3522 Use the current time if TIME is nil. TIME is in the format of
3525 Lisp_Object filename
, time
;
3527 Lisp_Object absname
, encoded_absname
;
3528 Lisp_Object handler
;
3532 if (! lisp_time_argument (time
, &sec
, &usec
))
3533 error ("Invalid time specification");
3535 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
3537 /* If the file name has special constructs in it,
3538 call the corresponding file handler. */
3539 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3540 if (!NILP (handler
))
3541 return call3 (handler
, Qset_file_times
, absname
, time
);
3543 encoded_absname
= ENCODE_FILE (absname
);
3548 EMACS_SET_SECS (t
, sec
);
3549 EMACS_SET_USECS (t
, usec
);
3551 if (set_file_times (SDATA (encoded_absname
), t
, t
))
3556 /* Setting times on a directory always fails. */
3557 if (stat (SDATA (encoded_absname
), &st
) == 0
3558 && (st
.st_mode
& S_IFMT
) == S_IFDIR
)
3561 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3574 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3575 doc
: /* Tell Unix to finish all pending disk updates. */)
3584 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3585 doc
: /* Return t if file FILE1 is newer than file FILE2.
3586 If FILE1 does not exist, the answer is nil;
3587 otherwise, if FILE2 does not exist, the answer is t. */)
3589 Lisp_Object file1
, file2
;
3591 Lisp_Object absname1
, absname2
;
3594 Lisp_Object handler
;
3595 struct gcpro gcpro1
, gcpro2
;
3597 CHECK_STRING (file1
);
3598 CHECK_STRING (file2
);
3601 GCPRO2 (absname1
, file2
);
3602 absname1
= expand_and_dir_to_file (file1
, current_buffer
->directory
);
3603 absname2
= expand_and_dir_to_file (file2
, current_buffer
->directory
);
3606 /* If the file name has special constructs in it,
3607 call the corresponding file handler. */
3608 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3610 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3611 if (!NILP (handler
))
3612 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3614 GCPRO2 (absname1
, absname2
);
3615 absname1
= ENCODE_FILE (absname1
);
3616 absname2
= ENCODE_FILE (absname2
);
3619 if (stat (SDATA (absname1
), &st
) < 0)
3622 mtime1
= st
.st_mtime
;
3624 if (stat (SDATA (absname2
), &st
) < 0)
3627 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3631 Lisp_Object Qfind_buffer_file_type
;
3634 #ifndef READ_BUF_SIZE
3635 #define READ_BUF_SIZE (64 << 10)
3638 extern void adjust_markers_for_delete
P_ ((int, int, int, int));
3640 /* This function is called after Lisp functions to decide a coding
3641 system are called, or when they cause an error. Before they are
3642 called, the current buffer is set unibyte and it contains only a
3643 newly inserted text (thus the buffer was empty before the
3646 The functions may set markers, overlays, text properties, or even
3647 alter the buffer contents, change the current buffer.
3649 Here, we reset all those changes by:
3650 o set back the current buffer.
3651 o move all markers and overlays to BEG.
3652 o remove all text properties.
3653 o set back the buffer multibyteness. */
3656 decide_coding_unwind (unwind_data
)
3657 Lisp_Object unwind_data
;
3659 Lisp_Object multibyte
, undo_list
, buffer
;
3661 multibyte
= XCAR (unwind_data
);
3662 unwind_data
= XCDR (unwind_data
);
3663 undo_list
= XCAR (unwind_data
);
3664 buffer
= XCDR (unwind_data
);
3666 if (current_buffer
!= XBUFFER (buffer
))
3667 set_buffer_internal (XBUFFER (buffer
));
3668 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3669 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3670 BUF_INTERVALS (current_buffer
) = 0;
3671 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3673 /* Now we are safe to change the buffer's multibyteness directly. */
3674 current_buffer
->enable_multibyte_characters
= multibyte
;
3675 current_buffer
->undo_list
= undo_list
;
3681 /* Used to pass values from insert-file-contents to read_non_regular. */
3683 static int non_regular_fd
;
3684 static int non_regular_inserted
;
3685 static int non_regular_nbytes
;
3688 /* Read from a non-regular file.
3689 Read non_regular_trytry bytes max from non_regular_fd.
3690 Non_regular_inserted specifies where to put the read bytes.
3691 Value is the number of bytes read. */
3700 nbytes
= emacs_read (non_regular_fd
,
3701 BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ non_regular_inserted
,
3702 non_regular_nbytes
);
3704 return make_number (nbytes
);
3708 /* Condition-case handler used when reading from non-regular files
3709 in insert-file-contents. */
3712 read_non_regular_quit ()
3718 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3720 doc
: /* Insert contents of file FILENAME after point.
3721 Returns list of absolute file name and number of characters inserted.
3722 If second argument VISIT is non-nil, the buffer's visited filename
3723 and last save file modtime are set, and it is marked unmodified.
3724 If visiting and the file does not exist, visiting is completed
3725 before the error is signaled.
3726 The optional third and fourth arguments BEG and END
3727 specify what portion of the file to insert.
3728 These arguments count bytes in the file, not characters in the buffer.
3729 If VISIT is non-nil, BEG and END must be nil.
3731 If optional fifth argument REPLACE is non-nil,
3732 it means replace the current buffer contents (in the accessible portion)
3733 with the file contents. This is better than simply deleting and inserting
3734 the whole thing because (1) it preserves some marker positions
3735 and (2) it puts less data in the undo list.
3736 When REPLACE is non-nil, the value is the number of characters actually read,
3737 which is often less than the number of characters to be read.
3739 This does code conversion according to the value of
3740 `coding-system-for-read' or `file-coding-system-alist',
3741 and sets the variable `last-coding-system-used' to the coding system
3743 (filename
, visit
, beg
, end
, replace
)
3744 Lisp_Object filename
, visit
, beg
, end
, replace
;
3749 register int how_much
;
3750 register int unprocessed
;
3751 int count
= SPECPDL_INDEX ();
3752 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3753 Lisp_Object handler
, val
, insval
, orig_filename
;
3756 int not_regular
= 0;
3757 unsigned char read_buf
[READ_BUF_SIZE
];
3758 struct coding_system coding
;
3759 unsigned char buffer
[1 << 14];
3760 int replace_handled
= 0;
3761 int set_coding_system
= 0;
3762 int coding_system_decided
= 0;
3764 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3765 int we_locked_file
= 0;
3767 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3768 error ("Cannot do file visiting in an indirect buffer");
3770 if (!NILP (current_buffer
->read_only
))
3771 Fbarf_if_buffer_read_only ();
3775 orig_filename
= Qnil
;
3777 GCPRO4 (filename
, val
, p
, orig_filename
);
3779 CHECK_STRING (filename
);
3780 filename
= Fexpand_file_name (filename
, Qnil
);
3782 /* If the file name has special constructs in it,
3783 call the corresponding file handler. */
3784 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3785 if (!NILP (handler
))
3787 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3788 visit
, beg
, end
, replace
);
3789 if (CONSP (val
) && CONSP (XCDR (val
)))
3790 inserted
= XINT (XCAR (XCDR (val
)));
3794 orig_filename
= filename
;
3795 filename
= ENCODE_FILE (filename
);
3801 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3803 /* Tell stat to use expensive method to get accurate info. */
3804 Vw32_get_true_file_attributes
= Qt
;
3805 total
= stat (SDATA (filename
), &st
);
3806 Vw32_get_true_file_attributes
= tem
;
3811 if (stat (SDATA (filename
), &st
) < 0)
3813 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0
3814 || fstat (fd
, &st
) < 0)
3815 #endif /* not APOLLO */
3816 #endif /* WINDOWSNT */
3818 if (fd
>= 0) emacs_close (fd
);
3821 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3824 if (!NILP (Vcoding_system_for_read
))
3825 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3830 /* This code will need to be changed in order to work on named
3831 pipes, and it's probably just not worth it. So we should at
3832 least signal an error. */
3833 if (!S_ISREG (st
.st_mode
))
3840 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3841 Fsignal (Qfile_error
,
3842 Fcons (build_string ("not a regular file"),
3843 Fcons (orig_filename
, Qnil
)));
3848 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0)
3851 /* Replacement should preserve point as it preserves markers. */
3852 if (!NILP (replace
))
3853 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3855 record_unwind_protect (close_file_unwind
, make_number (fd
));
3857 /* Supposedly happens on VMS. */
3858 /* Can happen on any platform that uses long as type of off_t, but allows
3859 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3860 give a message suitable for the latter case. */
3861 if (! not_regular
&& st
.st_size
< 0)
3862 error ("Maximum buffer size exceeded");
3864 /* Prevent redisplay optimizations. */
3865 current_buffer
->clip_changed
= 1;
3869 if (!NILP (beg
) || !NILP (end
))
3870 error ("Attempt to visit less than an entire file");
3871 if (BEG
< Z
&& NILP (replace
))
3872 error ("Cannot do file visiting in a non-empty buffer");
3878 XSETFASTINT (beg
, 0);
3886 XSETINT (end
, st
.st_size
);
3888 /* Arithmetic overflow can occur if an Emacs integer cannot
3889 represent the file size, or if the calculations below
3890 overflow. The calculations below double the file size
3891 twice, so check that it can be multiplied by 4 safely. */
3892 if (XINT (end
) != st
.st_size
3893 || ((int) st
.st_size
* 4) / 4 != st
.st_size
)
3894 error ("Maximum buffer size exceeded");
3896 /* The file size returned from stat may be zero, but data
3897 may be readable nonetheless, for example when this is a
3898 file in the /proc filesystem. */
3899 if (st
.st_size
== 0)
3900 XSETINT (end
, READ_BUF_SIZE
);
3904 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3906 /* We use emacs-mule for auto saving... */
3907 setup_coding_system (Qemacs_mule
, &coding
);
3908 /* ... but with the special flag to indicate to read in a
3909 multibyte sequence for eight-bit-control char as is. */
3911 coding
.src_multibyte
= 0;
3912 coding
.dst_multibyte
3913 = !NILP (current_buffer
->enable_multibyte_characters
);
3914 coding
.eol_type
= CODING_EOL_LF
;
3915 coding_system_decided
= 1;
3919 /* Decide the coding system to use for reading the file now
3920 because we can't use an optimized method for handling
3921 `coding:' tag if the current buffer is not empty. */
3925 if (!NILP (Vcoding_system_for_read
))
3926 val
= Vcoding_system_for_read
;
3929 /* Don't try looking inside a file for a coding system
3930 specification if it is not seekable. */
3931 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3933 /* Find a coding system specified in the heading two
3934 lines or in the tailing several lines of the file.
3935 We assume that the 1K-byte and 3K-byte for heading
3936 and tailing respectively are sufficient for this
3940 if (st
.st_size
<= (1024 * 4))
3941 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3944 nread
= emacs_read (fd
, read_buf
, 1024);
3947 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3948 report_file_error ("Setting file position",
3949 Fcons (orig_filename
, Qnil
));
3950 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3955 error ("IO error reading %s: %s",
3956 SDATA (orig_filename
), emacs_strerror (errno
));
3959 struct buffer
*prev
= current_buffer
;
3963 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3965 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3966 buf
= XBUFFER (buffer
);
3968 delete_all_overlays (buf
);
3969 buf
->directory
= current_buffer
->directory
;
3970 buf
->read_only
= Qnil
;
3971 buf
->filename
= Qnil
;
3972 buf
->undo_list
= Qt
;
3973 eassert (buf
->overlays_before
== NULL
);
3974 eassert (buf
->overlays_after
== NULL
);
3976 set_buffer_internal (buf
);
3978 buf
->enable_multibyte_characters
= Qnil
;
3980 insert_1_both (read_buf
, nread
, nread
, 0, 0, 0);
3981 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3982 val
= call2 (Vset_auto_coding_function
,
3983 filename
, make_number (nread
));
3984 set_buffer_internal (prev
);
3986 /* Discard the unwind protect for recovering the
3990 /* Rewind the file for the actual read done later. */
3991 if (lseek (fd
, 0, 0) < 0)
3992 report_file_error ("Setting file position",
3993 Fcons (orig_filename
, Qnil
));
3999 /* If we have not yet decided a coding system, check
4000 file-coding-system-alist. */
4001 Lisp_Object args
[6], coding_systems
;
4003 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4004 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
4005 coding_systems
= Ffind_operation_coding_system (6, args
);
4006 if (CONSP (coding_systems
))
4007 val
= XCAR (coding_systems
);
4011 setup_coding_system (Fcheck_coding_system (val
), &coding
);
4012 /* Ensure we set Vlast_coding_system_used. */
4013 set_coding_system
= 1;
4015 if (NILP (current_buffer
->enable_multibyte_characters
)
4017 /* We must suppress all character code conversion except for
4018 end-of-line conversion. */
4019 setup_raw_text_coding_system (&coding
);
4021 coding
.src_multibyte
= 0;
4022 coding
.dst_multibyte
4023 = !NILP (current_buffer
->enable_multibyte_characters
);
4024 coding_system_decided
= 1;
4027 /* If requested, replace the accessible part of the buffer
4028 with the file contents. Avoid replacing text at the
4029 beginning or end of the buffer that matches the file contents;
4030 that preserves markers pointing to the unchanged parts.
4032 Here we implement this feature in an optimized way
4033 for the case where code conversion is NOT needed.
4034 The following if-statement handles the case of conversion
4035 in a less optimal way.
4037 If the code conversion is "automatic" then we try using this
4038 method and hope for the best.
4039 But if we discover the need for conversion, we give up on this method
4040 and let the following if-statement handle the replace job. */
4043 && !(coding
.common_flags
& CODING_REQUIRE_DECODING_MASK
))
4045 /* same_at_start and same_at_end count bytes,
4046 because file access counts bytes
4047 and BEG and END count bytes. */
4048 int same_at_start
= BEGV_BYTE
;
4049 int same_at_end
= ZV_BYTE
;
4051 /* There is still a possibility we will find the need to do code
4052 conversion. If that happens, we set this variable to 1 to
4053 give up on handling REPLACE in the optimized way. */
4054 int giveup_match_end
= 0;
4056 if (XINT (beg
) != 0)
4058 if (lseek (fd
, XINT (beg
), 0) < 0)
4059 report_file_error ("Setting file position",
4060 Fcons (orig_filename
, Qnil
));
4065 /* Count how many chars at the start of the file
4066 match the text at the beginning of the buffer. */
4071 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
4073 error ("IO error reading %s: %s",
4074 SDATA (orig_filename
), emacs_strerror (errno
));
4075 else if (nread
== 0)
4078 if (coding
.type
== coding_type_undecided
)
4079 detect_coding (&coding
, buffer
, nread
);
4080 if (coding
.common_flags
& CODING_REQUIRE_DECODING_MASK
)
4081 /* We found that the file should be decoded somehow.
4082 Let's give up here. */
4084 giveup_match_end
= 1;
4088 if (coding
.eol_type
== CODING_EOL_UNDECIDED
)
4089 detect_eol (&coding
, buffer
, nread
);
4090 if (coding
.eol_type
!= CODING_EOL_UNDECIDED
4091 && coding
.eol_type
!= CODING_EOL_LF
)
4092 /* We found that the format of eol should be decoded.
4093 Let's give up here. */
4095 giveup_match_end
= 1;
4100 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
4101 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
4102 same_at_start
++, bufpos
++;
4103 /* If we found a discrepancy, stop the scan.
4104 Otherwise loop around and scan the next bufferful. */
4105 if (bufpos
!= nread
)
4109 /* If the file matches the buffer completely,
4110 there's no need to replace anything. */
4111 if (same_at_start
- BEGV_BYTE
== XINT (end
))
4115 /* Truncate the buffer to the size of the file. */
4116 del_range_1 (same_at_start
, same_at_end
, 0, 0);
4121 /* Count how many chars at the end of the file
4122 match the text at the end of the buffer. But, if we have
4123 already found that decoding is necessary, don't waste time. */
4124 while (!giveup_match_end
)
4126 int total_read
, nread
, bufpos
, curpos
, trial
;
4128 /* At what file position are we now scanning? */
4129 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
4130 /* If the entire file matches the buffer tail, stop the scan. */
4133 /* How much can we scan in the next step? */
4134 trial
= min (curpos
, sizeof buffer
);
4135 if (lseek (fd
, curpos
- trial
, 0) < 0)
4136 report_file_error ("Setting file position",
4137 Fcons (orig_filename
, Qnil
));
4139 total_read
= nread
= 0;
4140 while (total_read
< trial
)
4142 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
4144 error ("IO error reading %s: %s",
4145 SDATA (orig_filename
), emacs_strerror (errno
));
4146 else if (nread
== 0)
4148 total_read
+= nread
;
4151 /* Scan this bufferful from the end, comparing with
4152 the Emacs buffer. */
4153 bufpos
= total_read
;
4155 /* Compare with same_at_start to avoid counting some buffer text
4156 as matching both at the file's beginning and at the end. */
4157 while (bufpos
> 0 && same_at_end
> same_at_start
4158 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
4159 same_at_end
--, bufpos
--;
4161 /* If we found a discrepancy, stop the scan.
4162 Otherwise loop around and scan the preceding bufferful. */
4165 /* If this discrepancy is because of code conversion,
4166 we cannot use this method; giveup and try the other. */
4167 if (same_at_end
> same_at_start
4168 && FETCH_BYTE (same_at_end
- 1) >= 0200
4169 && ! NILP (current_buffer
->enable_multibyte_characters
)
4170 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
4171 giveup_match_end
= 1;
4180 if (! giveup_match_end
)
4184 /* We win! We can handle REPLACE the optimized way. */
4186 /* Extend the start of non-matching text area to multibyte
4187 character boundary. */
4188 if (! NILP (current_buffer
->enable_multibyte_characters
))
4189 while (same_at_start
> BEGV_BYTE
4190 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4193 /* Extend the end of non-matching text area to multibyte
4194 character boundary. */
4195 if (! NILP (current_buffer
->enable_multibyte_characters
))
4196 while (same_at_end
< ZV_BYTE
4197 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4200 /* Don't try to reuse the same piece of text twice. */
4201 overlap
= (same_at_start
- BEGV_BYTE
4202 - (same_at_end
+ st
.st_size
- ZV
));
4204 same_at_end
+= overlap
;
4206 /* Arrange to read only the nonmatching middle part of the file. */
4207 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
4208 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
4210 del_range_byte (same_at_start
, same_at_end
, 0);
4211 /* Insert from the file at the proper position. */
4212 temp
= BYTE_TO_CHAR (same_at_start
);
4213 SET_PT_BOTH (temp
, same_at_start
);
4215 /* If display currently starts at beginning of line,
4216 keep it that way. */
4217 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
4218 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
4220 replace_handled
= 1;
4224 /* If requested, replace the accessible part of the buffer
4225 with the file contents. Avoid replacing text at the
4226 beginning or end of the buffer that matches the file contents;
4227 that preserves markers pointing to the unchanged parts.
4229 Here we implement this feature for the case where code conversion
4230 is needed, in a simple way that needs a lot of memory.
4231 The preceding if-statement handles the case of no conversion
4232 in a more optimized way. */
4233 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
4235 int same_at_start
= BEGV_BYTE
;
4236 int same_at_end
= ZV_BYTE
;
4239 /* Make sure that the gap is large enough. */
4240 int bufsize
= 2 * st
.st_size
;
4241 unsigned char *conversion_buffer
= (unsigned char *) xmalloc (bufsize
);
4244 /* First read the whole file, performing code conversion into
4245 CONVERSION_BUFFER. */
4247 if (lseek (fd
, XINT (beg
), 0) < 0)
4249 xfree (conversion_buffer
);
4250 report_file_error ("Setting file position",
4251 Fcons (orig_filename
, Qnil
));
4254 total
= st
.st_size
; /* Total bytes in the file. */
4255 how_much
= 0; /* Bytes read from file so far. */
4256 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
4257 unprocessed
= 0; /* Bytes not processed in previous loop. */
4259 while (how_much
< total
)
4261 /* try is reserved in some compilers (Microsoft C) */
4262 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
4263 unsigned char *destination
= read_buf
+ unprocessed
;
4266 /* Allow quitting out of the actual I/O. */
4269 this = emacs_read (fd
, destination
, trytry
);
4272 if (this < 0 || this + unprocessed
== 0)
4280 if (CODING_MAY_REQUIRE_DECODING (&coding
))
4282 int require
, result
;
4284 this += unprocessed
;
4286 /* If we are using more space than estimated,
4287 make CONVERSION_BUFFER bigger. */
4288 require
= decoding_buffer_size (&coding
, this);
4289 if (inserted
+ require
+ 2 * (total
- how_much
) > bufsize
)
4291 bufsize
= inserted
+ require
+ 2 * (total
- how_much
);
4292 conversion_buffer
= (unsigned char *) xrealloc (conversion_buffer
, bufsize
);
4295 /* Convert this batch with results in CONVERSION_BUFFER. */
4296 if (how_much
>= total
) /* This is the last block. */
4297 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4298 if (coding
.composing
!= COMPOSITION_DISABLED
)
4299 coding_allocate_composition_data (&coding
, BEGV
);
4300 result
= decode_coding (&coding
, read_buf
,
4301 conversion_buffer
+ inserted
,
4302 this, bufsize
- inserted
);
4304 /* Save for next iteration whatever we didn't convert. */
4305 unprocessed
= this - coding
.consumed
;
4306 bcopy (read_buf
+ coding
.consumed
, read_buf
, unprocessed
);
4307 if (!NILP (current_buffer
->enable_multibyte_characters
))
4308 this = coding
.produced
;
4310 this = str_as_unibyte (conversion_buffer
+ inserted
,
4317 /* At this point, INSERTED is how many characters (i.e. bytes)
4318 are present in CONVERSION_BUFFER.
4319 HOW_MUCH should equal TOTAL,
4320 or should be <= 0 if we couldn't read the file. */
4324 xfree (conversion_buffer
);
4325 coding_free_composition_data (&coding
);
4327 error ("IO error reading %s: %s",
4328 SDATA (orig_filename
), emacs_strerror (errno
));
4329 else if (how_much
== -2)
4330 error ("maximum buffer size exceeded");
4333 /* Compare the beginning of the converted file
4334 with the buffer text. */
4337 while (bufpos
< inserted
&& same_at_start
< same_at_end
4338 && FETCH_BYTE (same_at_start
) == conversion_buffer
[bufpos
])
4339 same_at_start
++, bufpos
++;
4341 /* If the file matches the buffer completely,
4342 there's no need to replace anything. */
4344 if (bufpos
== inserted
)
4346 xfree (conversion_buffer
);
4347 coding_free_composition_data (&coding
);
4350 /* Truncate the buffer to the size of the file. */
4351 del_range_byte (same_at_start
, same_at_end
, 0);
4356 /* Extend the start of non-matching text area to multibyte
4357 character boundary. */
4358 if (! NILP (current_buffer
->enable_multibyte_characters
))
4359 while (same_at_start
> BEGV_BYTE
4360 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4363 /* Scan this bufferful from the end, comparing with
4364 the Emacs buffer. */
4367 /* Compare with same_at_start to avoid counting some buffer text
4368 as matching both at the file's beginning and at the end. */
4369 while (bufpos
> 0 && same_at_end
> same_at_start
4370 && FETCH_BYTE (same_at_end
- 1) == conversion_buffer
[bufpos
- 1])
4371 same_at_end
--, bufpos
--;
4373 /* Extend the end of non-matching text area to multibyte
4374 character boundary. */
4375 if (! NILP (current_buffer
->enable_multibyte_characters
))
4376 while (same_at_end
< ZV_BYTE
4377 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4380 /* Don't try to reuse the same piece of text twice. */
4381 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4383 same_at_end
+= overlap
;
4385 /* If display currently starts at beginning of line,
4386 keep it that way. */
4387 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
4388 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
4390 /* Replace the chars that we need to replace,
4391 and update INSERTED to equal the number of bytes
4392 we are taking from the file. */
4393 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4395 if (same_at_end
!= same_at_start
)
4397 del_range_byte (same_at_start
, same_at_end
, 0);
4399 same_at_start
= GPT_BYTE
;
4403 temp
= BYTE_TO_CHAR (same_at_start
);
4405 /* Insert from the file at the proper position. */
4406 SET_PT_BOTH (temp
, same_at_start
);
4407 insert_1 (conversion_buffer
+ same_at_start
- BEGV_BYTE
, inserted
,
4409 if (coding
.cmp_data
&& coding
.cmp_data
->used
)
4410 coding_restore_composition (&coding
, Fcurrent_buffer ());
4411 coding_free_composition_data (&coding
);
4413 /* Set `inserted' to the number of inserted characters. */
4414 inserted
= PT
- temp
;
4416 xfree (conversion_buffer
);
4425 register Lisp_Object temp
;
4427 total
= XINT (end
) - XINT (beg
);
4429 /* Make sure point-max won't overflow after this insertion. */
4430 XSETINT (temp
, total
);
4431 if (total
!= XINT (temp
))
4432 error ("Maximum buffer size exceeded");
4435 /* For a special file, all we can do is guess. */
4436 total
= READ_BUF_SIZE
;
4438 if (NILP (visit
) && inserted
> 0)
4440 #ifdef CLASH_DETECTION
4441 if (!NILP (current_buffer
->file_truename
)
4442 /* Make binding buffer-file-name to nil effective. */
4443 && !NILP (current_buffer
->filename
)
4444 && SAVE_MODIFF
>= MODIFF
)
4446 #endif /* CLASH_DETECTION */
4447 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4451 if (GAP_SIZE
< total
)
4452 make_gap (total
- GAP_SIZE
);
4454 if (XINT (beg
) != 0 || !NILP (replace
))
4456 if (lseek (fd
, XINT (beg
), 0) < 0)
4457 report_file_error ("Setting file position",
4458 Fcons (orig_filename
, Qnil
));
4461 /* In the following loop, HOW_MUCH contains the total bytes read so
4462 far for a regular file, and not changed for a special file. But,
4463 before exiting the loop, it is set to a negative value if I/O
4467 /* Total bytes inserted. */
4470 /* Here, we don't do code conversion in the loop. It is done by
4471 code_convert_region after all data are read into the buffer. */
4473 int gap_size
= GAP_SIZE
;
4475 while (how_much
< total
)
4477 /* try is reserved in some compilers (Microsoft C) */
4478 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4485 /* Maybe make more room. */
4486 if (gap_size
< trytry
)
4488 make_gap (total
- gap_size
);
4489 gap_size
= GAP_SIZE
;
4492 /* Read from the file, capturing `quit'. When an
4493 error occurs, end the loop, and arrange for a quit
4494 to be signaled after decoding the text we read. */
4495 non_regular_fd
= fd
;
4496 non_regular_inserted
= inserted
;
4497 non_regular_nbytes
= trytry
;
4498 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
4499 read_non_regular_quit
);
4510 /* Allow quitting out of the actual I/O. We don't make text
4511 part of the buffer until all the reading is done, so a C-g
4512 here doesn't do any harm. */
4515 this = emacs_read (fd
, BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ inserted
, trytry
);
4527 /* For a regular file, where TOTAL is the real size,
4528 count HOW_MUCH to compare with it.
4529 For a special file, where TOTAL is just a buffer size,
4530 so don't bother counting in HOW_MUCH.
4531 (INSERTED is where we count the number of characters inserted.) */
4538 /* Now we have read all the file data into the gap.
4539 If it was empty, undo marking the buffer modified. */
4543 #ifdef CLASH_DETECTION
4545 unlock_file (current_buffer
->file_truename
);
4547 Vdeactivate_mark
= old_Vdeactivate_mark
;
4550 /* Make the text read part of the buffer. */
4551 GAP_SIZE
-= inserted
;
4553 GPT_BYTE
+= inserted
;
4555 ZV_BYTE
+= inserted
;
4560 /* Put an anchor to ensure multi-byte form ends at gap. */
4565 /* Discard the unwind protect for closing the file. */
4569 error ("IO error reading %s: %s",
4570 SDATA (orig_filename
), emacs_strerror (errno
));
4574 if (! coding_system_decided
)
4576 /* The coding system is not yet decided. Decide it by an
4577 optimized method for handling `coding:' tag.
4579 Note that we can get here only if the buffer was empty
4580 before the insertion. */
4584 if (!NILP (Vcoding_system_for_read
))
4585 val
= Vcoding_system_for_read
;
4588 /* Since we are sure that the current buffer was empty
4589 before the insertion, we can toggle
4590 enable-multibyte-characters directly here without taking
4591 care of marker adjustment and byte combining problem. By
4592 this way, we can run Lisp program safely before decoding
4593 the inserted text. */
4594 Lisp_Object unwind_data
;
4595 int count
= SPECPDL_INDEX ();
4597 unwind_data
= Fcons (current_buffer
->enable_multibyte_characters
,
4598 Fcons (current_buffer
->undo_list
,
4599 Fcurrent_buffer ()));
4600 current_buffer
->enable_multibyte_characters
= Qnil
;
4601 current_buffer
->undo_list
= Qt
;
4602 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4604 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4606 val
= call2 (Vset_auto_coding_function
,
4607 filename
, make_number (inserted
));
4612 /* If the coding system is not yet decided, check
4613 file-coding-system-alist. */
4614 Lisp_Object args
[6], coding_systems
;
4616 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4617 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4618 coding_systems
= Ffind_operation_coding_system (6, args
);
4619 if (CONSP (coding_systems
))
4620 val
= XCAR (coding_systems
);
4622 unbind_to (count
, Qnil
);
4623 inserted
= Z_BYTE
- BEG_BYTE
;
4626 /* The following kludgy code is to avoid some compiler bug.
4628 setup_coding_system (val, &coding);
4631 struct coding_system temp_coding
;
4632 setup_coding_system (Fcheck_coding_system (val
), &temp_coding
);
4633 bcopy (&temp_coding
, &coding
, sizeof coding
);
4635 /* Ensure we set Vlast_coding_system_used. */
4636 set_coding_system
= 1;
4638 if (NILP (current_buffer
->enable_multibyte_characters
)
4640 /* We must suppress all character code conversion except for
4641 end-of-line conversion. */
4642 setup_raw_text_coding_system (&coding
);
4643 coding
.src_multibyte
= 0;
4644 coding
.dst_multibyte
4645 = !NILP (current_buffer
->enable_multibyte_characters
);
4649 /* Can't do this if part of the buffer might be preserved. */
4651 && (coding
.type
== coding_type_no_conversion
4652 || coding
.type
== coding_type_raw_text
))
4654 /* Visiting a file with these coding system makes the buffer
4656 current_buffer
->enable_multibyte_characters
= Qnil
;
4657 coding
.dst_multibyte
= 0;
4660 if (inserted
> 0 || coding
.type
== coding_type_ccl
)
4662 if (CODING_MAY_REQUIRE_DECODING (&coding
))
4664 code_convert_region (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4666 inserted
= coding
.produced_char
;
4669 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4673 /* Now INSERTED is measured in characters. */
4676 /* Use the conversion type to determine buffer-file-type
4677 (find-buffer-file-type is now used to help determine the
4679 if ((coding
.eol_type
== CODING_EOL_UNDECIDED
4680 || coding
.eol_type
== CODING_EOL_LF
)
4681 && ! CODING_REQUIRE_DECODING (&coding
))
4682 current_buffer
->buffer_file_type
= Qt
;
4684 current_buffer
->buffer_file_type
= Qnil
;
4691 if (!EQ (current_buffer
->undo_list
, Qt
))
4692 current_buffer
->undo_list
= Qnil
;
4694 stat (SDATA (filename
), &st
);
4699 current_buffer
->modtime
= st
.st_mtime
;
4700 current_buffer
->filename
= orig_filename
;
4703 SAVE_MODIFF
= MODIFF
;
4704 current_buffer
->auto_save_modified
= MODIFF
;
4705 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4706 #ifdef CLASH_DETECTION
4709 if (!NILP (current_buffer
->file_truename
))
4710 unlock_file (current_buffer
->file_truename
);
4711 unlock_file (filename
);
4713 #endif /* CLASH_DETECTION */
4715 Fsignal (Qfile_error
,
4716 Fcons (build_string ("not a regular file"),
4717 Fcons (orig_filename
, Qnil
)));
4720 if (set_coding_system
)
4721 Vlast_coding_system_used
= coding
.symbol
;
4723 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4725 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4727 if (! NILP (insval
))
4729 CHECK_NUMBER (insval
);
4730 inserted
= XFASTINT (insval
);
4734 /* Decode file format */
4737 int empty_undo_list_p
= 0;
4739 /* If we're anyway going to discard undo information, don't
4740 record it in the first place. The buffer's undo list at this
4741 point is either nil or t when visiting a file. */
4744 empty_undo_list_p
= NILP (current_buffer
->undo_list
);
4745 current_buffer
->undo_list
= Qt
;
4748 insval
= call3 (Qformat_decode
,
4749 Qnil
, make_number (inserted
), visit
);
4750 CHECK_NUMBER (insval
);
4751 inserted
= XFASTINT (insval
);
4754 current_buffer
->undo_list
= empty_undo_list_p
? Qnil
: Qt
;
4757 /* Call after-change hooks for the inserted text, aside from the case
4758 of normal visiting (not with REPLACE), which is done in a new buffer
4759 "before" the buffer is changed. */
4760 if (inserted
> 0 && total
> 0
4761 && (NILP (visit
) || !NILP (replace
)))
4763 signal_after_change (PT
, 0, inserted
);
4764 update_compositions (PT
, PT
, CHECK_BORDER
);
4767 p
= Vafter_insert_file_functions
;
4770 insval
= call1 (XCAR (p
), make_number (inserted
));
4773 CHECK_NUMBER (insval
);
4774 inserted
= XFASTINT (insval
);
4781 && current_buffer
->modtime
== -1)
4783 /* If visiting nonexistent file, return nil. */
4784 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4788 Fsignal (Qquit
, Qnil
);
4790 /* ??? Retval needs to be dealt with in all cases consistently. */
4792 val
= Fcons (orig_filename
,
4793 Fcons (make_number (inserted
),
4796 RETURN_UNGCPRO (unbind_to (count
, val
));
4799 static Lisp_Object build_annotations
P_ ((Lisp_Object
, Lisp_Object
));
4800 static Lisp_Object build_annotations_2
P_ ((Lisp_Object
, Lisp_Object
,
4801 Lisp_Object
, Lisp_Object
));
4803 /* If build_annotations switched buffers, switch back to BUF.
4804 Kill the temporary buffer that was selected in the meantime.
4806 Since this kill only the last temporary buffer, some buffers remain
4807 not killed if build_annotations switched buffers more than once.
4811 build_annotations_unwind (buf
)
4816 if (XBUFFER (buf
) == current_buffer
)
4818 tembuf
= Fcurrent_buffer ();
4820 Fkill_buffer (tembuf
);
4824 /* Decide the coding-system to encode the data with. */
4827 choose_write_coding_system (start
, end
, filename
,
4828 append
, visit
, lockname
, coding
)
4829 Lisp_Object start
, end
, filename
, append
, visit
, lockname
;
4830 struct coding_system
*coding
;
4835 && NILP (Fstring_equal (current_buffer
->filename
,
4836 current_buffer
->auto_save_file_name
)))
4838 /* We use emacs-mule for auto saving... */
4839 setup_coding_system (Qemacs_mule
, coding
);
4840 /* ... but with the special flag to indicate not to strip off
4841 leading code of eight-bit-control chars. */
4843 goto done_setup_coding
;
4845 else if (!NILP (Vcoding_system_for_write
))
4847 val
= Vcoding_system_for_write
;
4848 if (coding_system_require_warning
4849 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4850 /* Confirm that VAL can surely encode the current region. */
4851 val
= call5 (Vselect_safe_coding_system_function
,
4852 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4857 /* If the variable `buffer-file-coding-system' is set locally,
4858 it means that the file was read with some kind of code
4859 conversion or the variable is explicitly set by users. We
4860 had better write it out with the same coding system even if
4861 `enable-multibyte-characters' is nil.
4863 If it is not set locally, we anyway have to convert EOL
4864 format if the default value of `buffer-file-coding-system'
4865 tells that it is not Unix-like (LF only) format. */
4866 int using_default_coding
= 0;
4867 int force_raw_text
= 0;
4869 val
= current_buffer
->buffer_file_coding_system
;
4871 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4874 if (NILP (current_buffer
->enable_multibyte_characters
))
4880 /* Check file-coding-system-alist. */
4881 Lisp_Object args
[7], coding_systems
;
4883 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4884 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4886 coding_systems
= Ffind_operation_coding_system (7, args
);
4887 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4888 val
= XCDR (coding_systems
);
4892 && !NILP (current_buffer
->buffer_file_coding_system
))
4894 /* If we still have not decided a coding system, use the
4895 default value of buffer-file-coding-system. */
4896 val
= current_buffer
->buffer_file_coding_system
;
4897 using_default_coding
= 1;
4901 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4902 /* Confirm that VAL can surely encode the current region. */
4903 val
= call5 (Vselect_safe_coding_system_function
,
4904 start
, end
, val
, Qnil
, filename
);
4906 setup_coding_system (Fcheck_coding_system (val
), coding
);
4907 if (coding
->eol_type
== CODING_EOL_UNDECIDED
4908 && !using_default_coding
)
4910 if (! EQ (default_buffer_file_coding
.symbol
,
4911 buffer_defaults
.buffer_file_coding_system
))
4912 setup_coding_system (buffer_defaults
.buffer_file_coding_system
,
4913 &default_buffer_file_coding
);
4914 if (default_buffer_file_coding
.eol_type
!= CODING_EOL_UNDECIDED
)
4916 Lisp_Object subsidiaries
;
4918 coding
->eol_type
= default_buffer_file_coding
.eol_type
;
4919 subsidiaries
= Fget (coding
->symbol
, Qeol_type
);
4920 if (VECTORP (subsidiaries
)
4921 && XVECTOR (subsidiaries
)->size
== 3)
4923 = XVECTOR (subsidiaries
)->contents
[coding
->eol_type
];
4928 setup_raw_text_coding_system (coding
);
4929 goto done_setup_coding
;
4932 setup_coding_system (Fcheck_coding_system (val
), coding
);
4935 if (!STRINGP (start
) && !NILP (current_buffer
->selective_display
))
4936 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4939 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4940 "r\nFWrite region to file: \ni\ni\ni\np",
4941 doc
: /* Write current region into specified file.
4942 When called from a program, requires three arguments:
4943 START, END and FILENAME. START and END are normally buffer positions
4944 specifying the part of the buffer to write.
4945 If START is nil, that means to use the entire buffer contents.
4946 If START is a string, then output that string to the file
4947 instead of any buffer contents; END is ignored.
4949 Optional fourth argument APPEND if non-nil means
4950 append to existing file contents (if any). If it is an integer,
4951 seek to that offset in the file before writing.
4952 Optional fifth argument VISIT, if t or a string, means
4953 set the last-save-file-modtime of buffer to this file's modtime
4954 and mark buffer not modified.
4955 If VISIT is a string, it is a second file name;
4956 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4957 VISIT is also the file name to lock and unlock for clash detection.
4958 If VISIT is neither t nor nil nor a string,
4959 that means do not display the \"Wrote file\" message.
4960 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4961 use for locking and unlocking, overriding FILENAME and VISIT.
4962 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4963 for an existing file with the same name. If MUSTBENEW is `excl',
4964 that means to get an error if the file already exists; never overwrite.
4965 If MUSTBENEW is neither nil nor `excl', that means ask for
4966 confirmation before overwriting, but do go ahead and overwrite the file
4967 if the user confirms.
4969 This does code conversion according to the value of
4970 `coding-system-for-write', `buffer-file-coding-system', or
4971 `file-coding-system-alist', and sets the variable
4972 `last-coding-system-used' to the coding system actually used. */)
4973 (start
, end
, filename
, append
, visit
, lockname
, mustbenew
)
4974 Lisp_Object start
, end
, filename
, append
, visit
, lockname
, mustbenew
;
4979 const unsigned char *fn
;
4982 int count
= SPECPDL_INDEX ();
4985 unsigned char *fname
= 0; /* If non-0, original filename (must rename) */
4987 Lisp_Object handler
;
4988 Lisp_Object visit_file
;
4989 Lisp_Object annotations
;
4990 Lisp_Object encoded_filename
;
4991 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4992 int quietly
= !NILP (visit
);
4993 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
4994 struct buffer
*given_buffer
;
4996 int buffer_file_type
= O_BINARY
;
4998 struct coding_system coding
;
5000 if (current_buffer
->base_buffer
&& visiting
)
5001 error ("Cannot do file visiting in an indirect buffer");
5003 if (!NILP (start
) && !STRINGP (start
))
5004 validate_region (&start
, &end
);
5006 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
5008 filename
= Fexpand_file_name (filename
, Qnil
);
5010 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
5011 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
5013 if (STRINGP (visit
))
5014 visit_file
= Fexpand_file_name (visit
, Qnil
);
5016 visit_file
= filename
;
5018 if (NILP (lockname
))
5019 lockname
= visit_file
;
5023 /* If the file name has special constructs in it,
5024 call the corresponding file handler. */
5025 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
5026 /* If FILENAME has no handler, see if VISIT has one. */
5027 if (NILP (handler
) && STRINGP (visit
))
5028 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
5030 if (!NILP (handler
))
5033 val
= call6 (handler
, Qwrite_region
, start
, end
,
5034 filename
, append
, visit
);
5038 SAVE_MODIFF
= MODIFF
;
5039 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5040 current_buffer
->filename
= visit_file
;
5046 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
5048 /* Special kludge to simplify auto-saving. */
5051 XSETFASTINT (start
, BEG
);
5052 XSETFASTINT (end
, Z
);
5056 record_unwind_protect (build_annotations_unwind
, Fcurrent_buffer ());
5057 count1
= SPECPDL_INDEX ();
5059 given_buffer
= current_buffer
;
5061 if (!STRINGP (start
))
5063 annotations
= build_annotations (start
, end
);
5065 if (current_buffer
!= given_buffer
)
5067 XSETFASTINT (start
, BEGV
);
5068 XSETFASTINT (end
, ZV
);
5074 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
5076 /* Decide the coding-system to encode the data with.
5077 We used to make this choice before calling build_annotations, but that
5078 leads to problems when a write-annotate-function takes care of
5079 unsavable chars (as was the case with X-Symbol). */
5080 choose_write_coding_system (start
, end
, filename
,
5081 append
, visit
, lockname
, &coding
);
5082 Vlast_coding_system_used
= coding
.symbol
;
5084 given_buffer
= current_buffer
;
5085 if (! STRINGP (start
))
5087 annotations
= build_annotations_2 (start
, end
,
5088 coding
.pre_write_conversion
, annotations
);
5089 if (current_buffer
!= given_buffer
)
5091 XSETFASTINT (start
, BEGV
);
5092 XSETFASTINT (end
, ZV
);
5096 #ifdef CLASH_DETECTION
5099 #if 0 /* This causes trouble for GNUS. */
5100 /* If we've locked this file for some other buffer,
5101 query before proceeding. */
5102 if (!visiting
&& EQ (Ffile_locked_p (lockname
), Qt
))
5103 call2 (intern ("ask-user-about-lock"), filename
, Vuser_login_name
);
5106 lock_file (lockname
);
5108 #endif /* CLASH_DETECTION */
5110 encoded_filename
= ENCODE_FILE (filename
);
5112 fn
= SDATA (encoded_filename
);
5116 desc
= emacs_open (fn
, O_WRONLY
| buffer_file_type
, 0);
5117 #else /* not DOS_NT */
5118 desc
= emacs_open (fn
, O_WRONLY
, 0);
5119 #endif /* not DOS_NT */
5121 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
5123 if (auto_saving
) /* Overwrite any previous version of autosave file */
5125 vms_truncate (fn
); /* if fn exists, truncate to zero length */
5126 desc
= emacs_open (fn
, O_RDWR
, 0);
5128 desc
= creat_copy_attrs (STRINGP (current_buffer
->filename
)
5129 ? SDATA (current_buffer
->filename
) : 0,
5132 else /* Write to temporary name and rename if no errors */
5134 Lisp_Object temp_name
;
5135 temp_name
= Ffile_name_directory (filename
);
5137 if (!NILP (temp_name
))
5139 temp_name
= Fmake_temp_name (concat2 (temp_name
,
5140 build_string ("$$SAVE$$")));
5141 fname
= SDATA (filename
);
5142 fn
= SDATA (temp_name
);
5143 desc
= creat_copy_attrs (fname
, fn
);
5146 /* If we can't open the temporary file, try creating a new
5147 version of the original file. VMS "creat" creates a
5148 new version rather than truncating an existing file. */
5151 desc
= creat (fn
, 0666);
5152 #if 0 /* This can clobber an existing file and fail to replace it,
5153 if the user runs out of space. */
5156 /* We can't make a new version;
5157 try to truncate and rewrite existing version if any. */
5159 desc
= emacs_open (fn
, O_RDWR
, 0);
5165 desc
= creat (fn
, 0666);
5169 desc
= emacs_open (fn
,
5170 O_WRONLY
| O_CREAT
| buffer_file_type
5171 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
5172 S_IREAD
| S_IWRITE
);
5173 #else /* not DOS_NT */
5174 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
5175 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
5176 auto_saving
? auto_save_mode_bits
: 0666);
5177 #endif /* not DOS_NT */
5178 #endif /* not VMS */
5182 #ifdef CLASH_DETECTION
5184 if (!auto_saving
) unlock_file (lockname
);
5186 #endif /* CLASH_DETECTION */
5188 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
5191 record_unwind_protect (close_file_unwind
, make_number (desc
));
5193 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
5197 if (NUMBERP (append
))
5198 ret
= lseek (desc
, XINT (append
), 1);
5200 ret
= lseek (desc
, 0, 2);
5203 #ifdef CLASH_DETECTION
5204 if (!auto_saving
) unlock_file (lockname
);
5205 #endif /* CLASH_DETECTION */
5207 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
5215 * Kludge Warning: The VMS C RTL likes to insert carriage returns
5216 * if we do writes that don't end with a carriage return. Furthermore
5217 * it cannot handle writes of more then 16K. The modified
5218 * version of "sys_write" in SYSDEP.C (see comment there) copes with
5219 * this EXCEPT for the last record (iff it doesn't end with a carriage
5220 * return). This implies that if your buffer doesn't end with a carriage
5221 * return, you get one free... tough. However it also means that if
5222 * we make two calls to sys_write (a la the following code) you can
5223 * get one at the gap as well. The easiest way to fix this (honest)
5224 * is to move the gap to the next newline (or the end of the buffer).
5229 if (GPT
> BEG
&& GPT_ADDR
[-1] != '\n')
5230 move_gap (find_next_newline (GPT
, 1));
5232 /* Whether VMS or not, we must move the gap to the next of newline
5233 when we must put designation sequences at beginning of line. */
5234 if (INTEGERP (start
)
5235 && coding
.type
== coding_type_iso2022
5236 && coding
.flags
& CODING_FLAG_ISO_DESIGNATE_AT_BOL
5237 && GPT
> BEG
&& GPT_ADDR
[-1] != '\n')
5239 int opoint
= PT
, opoint_byte
= PT_BYTE
;
5240 scan_newline (PT
, PT_BYTE
, ZV
, ZV_BYTE
, 1, 0);
5241 move_gap_both (PT
, PT_BYTE
);
5242 SET_PT_BOTH (opoint
, opoint_byte
);
5249 if (STRINGP (start
))
5251 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
5252 &annotations
, &coding
);
5255 else if (XINT (start
) != XINT (end
))
5257 tem
= CHAR_TO_BYTE (XINT (start
));
5259 if (XINT (start
) < GPT
)
5261 failure
= 0 > a_write (desc
, Qnil
, XINT (start
),
5262 min (GPT
, XINT (end
)) - XINT (start
),
5263 &annotations
, &coding
);
5267 if (XINT (end
) > GPT
&& !failure
)
5269 tem
= max (XINT (start
), GPT
);
5270 failure
= 0 > a_write (desc
, Qnil
, tem
, XINT (end
) - tem
,
5271 &annotations
, &coding
);
5277 /* If file was empty, still need to write the annotations */
5278 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
5279 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
5283 if (CODING_REQUIRE_FLUSHING (&coding
)
5284 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
5287 /* We have to flush out a data. */
5288 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
5289 failure
= 0 > e_write (desc
, Qnil
, 0, 0, &coding
);
5296 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
5297 Disk full in NFS may be reported here. */
5298 /* mib says that closing the file will try to write as fast as NFS can do
5299 it, and that means the fsync here is not crucial for autosave files. */
5300 if (!auto_saving
&& fsync (desc
) < 0)
5302 /* If fsync fails with EINTR, don't treat that as serious. */
5304 failure
= 1, save_errno
= errno
;
5308 /* Spurious "file has changed on disk" warnings have been
5309 observed on Suns as well.
5310 It seems that `close' can change the modtime, under nfs.
5312 (This has supposedly been fixed in Sunos 4,
5313 but who knows about all the other machines with NFS?) */
5316 /* On VMS and APOLLO, must do the stat after the close
5317 since closing changes the modtime. */
5320 /* Recall that #if defined does not work on VMS. */
5327 /* NFS can report a write failure now. */
5328 if (emacs_close (desc
) < 0)
5329 failure
= 1, save_errno
= errno
;
5332 /* If we wrote to a temporary name and had no errors, rename to real name. */
5336 failure
= (rename (fn
, fname
) != 0), save_errno
= errno
;
5344 /* Discard the unwind protect for close_file_unwind. */
5345 specpdl_ptr
= specpdl
+ count1
;
5346 /* Restore the original current buffer. */
5347 visit_file
= unbind_to (count
, visit_file
);
5349 #ifdef CLASH_DETECTION
5351 unlock_file (lockname
);
5352 #endif /* CLASH_DETECTION */
5354 /* Do this before reporting IO error
5355 to avoid a "file has changed on disk" warning on
5356 next attempt to save. */
5358 current_buffer
->modtime
= st
.st_mtime
;
5361 error ("IO error writing %s: %s", SDATA (filename
),
5362 emacs_strerror (save_errno
));
5366 SAVE_MODIFF
= MODIFF
;
5367 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5368 current_buffer
->filename
= visit_file
;
5369 update_mode_lines
++;
5374 && ! NILP (Fstring_equal (current_buffer
->filename
,
5375 current_buffer
->auto_save_file_name
)))
5376 SAVE_MODIFF
= MODIFF
;
5382 message_with_string ((INTEGERP (append
)
5392 Lisp_Object
merge ();
5394 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5395 doc
: /* Return t if (car A) is numerically less than (car B). */)
5399 return Flss (Fcar (a
), Fcar (b
));
5402 /* Build the complete list of annotations appropriate for writing out
5403 the text between START and END, by calling all the functions in
5404 write-region-annotate-functions and merging the lists they return.
5405 If one of these functions switches to a different buffer, we assume
5406 that buffer contains altered text. Therefore, the caller must
5407 make sure to restore the current buffer in all cases,
5408 as save-excursion would do. */
5411 build_annotations (start
, end
)
5412 Lisp_Object start
, end
;
5414 Lisp_Object annotations
;
5416 struct gcpro gcpro1
, gcpro2
;
5417 Lisp_Object original_buffer
;
5418 int i
, used_global
= 0;
5420 XSETBUFFER (original_buffer
, current_buffer
);
5423 p
= Vwrite_region_annotate_functions
;
5424 GCPRO2 (annotations
, p
);
5427 struct buffer
*given_buffer
= current_buffer
;
5428 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5429 { /* Use the global value of the hook. */
5432 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5434 p
= Fappend (2, arg
);
5437 Vwrite_region_annotations_so_far
= annotations
;
5438 res
= call2 (XCAR (p
), start
, end
);
5439 /* If the function makes a different buffer current,
5440 assume that means this buffer contains altered text to be output.
5441 Reset START and END from the buffer bounds
5442 and discard all previous annotations because they should have
5443 been dealt with by this function. */
5444 if (current_buffer
!= given_buffer
)
5446 XSETFASTINT (start
, BEGV
);
5447 XSETFASTINT (end
, ZV
);
5450 Flength (res
); /* Check basic validity of return value */
5451 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5455 /* Now do the same for annotation functions implied by the file-format */
5456 if (auto_saving
&& (!EQ (current_buffer
->auto_save_file_format
, Qt
)))
5457 p
= current_buffer
->auto_save_file_format
;
5459 p
= current_buffer
->file_format
;
5460 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5462 struct buffer
*given_buffer
= current_buffer
;
5464 Vwrite_region_annotations_so_far
= annotations
;
5466 /* Value is either a list of annotations or nil if the function
5467 has written annotations to a temporary buffer, which is now
5469 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5470 original_buffer
, make_number (i
));
5471 if (current_buffer
!= given_buffer
)
5473 XSETFASTINT (start
, BEGV
);
5474 XSETFASTINT (end
, ZV
);
5479 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5487 build_annotations_2 (start
, end
, pre_write_conversion
, annotations
)
5488 Lisp_Object start
, end
, pre_write_conversion
, annotations
;
5490 struct gcpro gcpro1
;
5493 GCPRO1 (annotations
);
5494 /* At last, do the same for the function PRE_WRITE_CONVERSION
5495 implied by the current coding-system. */
5496 if (!NILP (pre_write_conversion
))
5498 struct buffer
*given_buffer
= current_buffer
;
5499 Vwrite_region_annotations_so_far
= annotations
;
5500 res
= call2 (pre_write_conversion
, start
, end
);
5502 annotations
= (current_buffer
!= given_buffer
5504 : merge (annotations
, res
, Qcar_less_than_car
));
5511 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5512 If STRING is nil, POS is the character position in the current buffer.
5513 Intersperse with them the annotations from *ANNOT
5514 which fall within the range of POS to POS + NCHARS,
5515 each at its appropriate position.
5517 We modify *ANNOT by discarding elements as we use them up.
5519 The return value is negative in case of system call failure. */
5522 a_write (desc
, string
, pos
, nchars
, annot
, coding
)
5525 register int nchars
;
5528 struct coding_system
*coding
;
5532 int lastpos
= pos
+ nchars
;
5534 while (NILP (*annot
) || CONSP (*annot
))
5536 tem
= Fcar_safe (Fcar (*annot
));
5539 nextpos
= XFASTINT (tem
);
5541 /* If there are no more annotations in this range,
5542 output the rest of the range all at once. */
5543 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5544 return e_write (desc
, string
, pos
, lastpos
, coding
);
5546 /* Output buffer text up to the next annotation's position. */
5549 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
5553 /* Output the annotation. */
5554 tem
= Fcdr (Fcar (*annot
));
5557 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5560 *annot
= Fcdr (*annot
);
5565 #ifndef WRITE_BUF_SIZE
5566 #define WRITE_BUF_SIZE (16 * 1024)
5569 /* Write text in the range START and END into descriptor DESC,
5570 encoding them with coding system CODING. If STRING is nil, START
5571 and END are character positions of the current buffer, else they
5572 are indexes to the string STRING. */
5575 e_write (desc
, string
, start
, end
, coding
)
5579 struct coding_system
*coding
;
5581 register char *addr
;
5582 register int nbytes
;
5583 char buf
[WRITE_BUF_SIZE
];
5587 coding
->composing
= COMPOSITION_DISABLED
;
5588 if (coding
->composing
!= COMPOSITION_DISABLED
)
5589 coding_save_composition (coding
, start
, end
, string
);
5591 if (STRINGP (string
))
5593 addr
= SDATA (string
);
5594 nbytes
= SBYTES (string
);
5595 coding
->src_multibyte
= STRING_MULTIBYTE (string
);
5597 else if (start
< end
)
5599 /* It is assured that the gap is not in the range START and END-1. */
5600 addr
= CHAR_POS_ADDR (start
);
5601 nbytes
= CHAR_TO_BYTE (end
) - CHAR_TO_BYTE (start
);
5602 coding
->src_multibyte
5603 = !NILP (current_buffer
->enable_multibyte_characters
);
5609 coding
->src_multibyte
= 1;
5612 /* We used to have a code for handling selective display here. But,
5613 now it is handled within encode_coding. */
5618 result
= encode_coding (coding
, addr
, buf
, nbytes
, WRITE_BUF_SIZE
);
5619 if (coding
->produced
> 0)
5621 coding
->produced
-= emacs_write (desc
, buf
, coding
->produced
);
5622 if (coding
->produced
)
5628 nbytes
-= coding
->consumed
;
5629 addr
+= coding
->consumed
;
5630 if (result
== CODING_FINISH_INSUFFICIENT_SRC
5633 /* The source text ends by an incomplete multibyte form.
5634 There's no way other than write it out as is. */
5635 nbytes
-= emacs_write (desc
, addr
, nbytes
);
5644 start
+= coding
->consumed_char
;
5645 if (coding
->cmp_data
)
5646 coding_adjust_composition_offset (coding
, start
);
5649 if (coding
->cmp_data
)
5650 coding_free_composition_data (coding
);
5655 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5656 Sverify_visited_file_modtime
, 1, 1, 0,
5657 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5658 This means that the file has not been changed since it was visited or saved.
5659 See Info node `(elisp)Modification Time' for more details. */)
5665 Lisp_Object handler
;
5666 Lisp_Object filename
;
5671 if (!STRINGP (b
->filename
)) return Qt
;
5672 if (b
->modtime
== 0) return Qt
;
5674 /* If the file name has special constructs in it,
5675 call the corresponding file handler. */
5676 handler
= Ffind_file_name_handler (b
->filename
,
5677 Qverify_visited_file_modtime
);
5678 if (!NILP (handler
))
5679 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5681 filename
= ENCODE_FILE (b
->filename
);
5683 if (stat (SDATA (filename
), &st
) < 0)
5685 /* If the file doesn't exist now and didn't exist before,
5686 we say that it isn't modified, provided the error is a tame one. */
5687 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
5692 if (st
.st_mtime
== b
->modtime
5693 /* If both are positive, accept them if they are off by one second. */
5694 || (st
.st_mtime
> 0 && b
->modtime
> 0
5695 && (st
.st_mtime
== b
->modtime
+ 1
5696 || st
.st_mtime
== b
->modtime
- 1)))
5701 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5702 Sclear_visited_file_modtime
, 0, 0, 0,
5703 doc
: /* Clear out records of last mod time of visited file.
5704 Next attempt to save will certainly not complain of a discrepancy. */)
5707 current_buffer
->modtime
= 0;
5711 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5712 Svisited_file_modtime
, 0, 0, 0,
5713 doc
: /* Return the current buffer's recorded visited file modification time.
5714 The value is a list of the form (HIGH LOW), like the time values
5715 that `file-attributes' returns. If the current buffer has no recorded
5716 file modification time, this function returns 0.
5717 See Info node `(elisp)Modification Time' for more details. */)
5721 tcons
= long_to_cons ((unsigned long) current_buffer
->modtime
);
5723 return list2 (XCAR (tcons
), XCDR (tcons
));
5727 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5728 Sset_visited_file_modtime
, 0, 1, 0,
5729 doc
: /* Update buffer's recorded modification time from the visited file's time.
5730 Useful if the buffer was not read from the file normally
5731 or if the file itself has been changed for some known benign reason.
5732 An argument specifies the modification time value to use
5733 \(instead of that of the visited file), in the form of a list
5734 \(HIGH . LOW) or (HIGH LOW). */)
5736 Lisp_Object time_list
;
5738 if (!NILP (time_list
))
5739 current_buffer
->modtime
= cons_to_long (time_list
);
5742 register Lisp_Object filename
;
5744 Lisp_Object handler
;
5746 filename
= Fexpand_file_name (current_buffer
->filename
, Qnil
);
5748 /* If the file name has special constructs in it,
5749 call the corresponding file handler. */
5750 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5751 if (!NILP (handler
))
5752 /* The handler can find the file name the same way we did. */
5753 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5755 filename
= ENCODE_FILE (filename
);
5757 if (stat (SDATA (filename
), &st
) >= 0)
5758 current_buffer
->modtime
= st
.st_mtime
;
5765 auto_save_error (error
)
5768 Lisp_Object args
[3], msg
;
5770 struct gcpro gcpro1
;
5774 args
[0] = build_string ("Auto-saving %s: %s");
5775 args
[1] = current_buffer
->name
;
5776 args
[2] = Ferror_message_string (error
);
5777 msg
= Fformat (3, args
);
5779 nbytes
= SBYTES (msg
);
5781 for (i
= 0; i
< 3; ++i
)
5784 message2 (SDATA (msg
), nbytes
, STRING_MULTIBYTE (msg
));
5786 message2_nolog (SDATA (msg
), nbytes
, STRING_MULTIBYTE (msg
));
5787 Fsleep_for (make_number (1), Qnil
);
5800 auto_save_mode_bits
= 0666;
5802 /* Get visited file's mode to become the auto save file's mode. */
5803 if (! NILP (current_buffer
->filename
))
5805 if (stat (SDATA (current_buffer
->filename
), &st
) >= 0)
5806 /* But make sure we can overwrite it later! */
5807 auto_save_mode_bits
= st
.st_mode
| 0600;
5808 else if ((modes
= Ffile_modes (current_buffer
->filename
),
5810 /* Remote files don't cooperate with stat. */
5811 auto_save_mode_bits
= XINT (modes
) | 0600;
5815 Fwrite_region (Qnil
, Qnil
,
5816 current_buffer
->auto_save_file_name
,
5817 Qnil
, Qlambda
, Qnil
, Qnil
);
5821 do_auto_save_unwind (stream
) /* used as unwind-protect function */
5826 fclose ((FILE *) (XFASTINT (XCAR (stream
)) << 16
5827 | XFASTINT (XCDR (stream
))));
5832 do_auto_save_unwind_1 (value
) /* used as unwind-protect function */
5835 minibuffer_auto_raise
= XINT (value
);
5840 do_auto_save_make_dir (dir
)
5843 return call2 (Qmake_directory
, dir
, Qt
);
5847 do_auto_save_eh (ignore
)
5853 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5854 doc
: /* Auto-save all buffers that need it.
5855 This is all buffers that have auto-saving enabled
5856 and are changed since last auto-saved.
5857 Auto-saving writes the buffer into a file
5858 so that your editing is not lost if the system crashes.
5859 This file is not the file you visited; that changes only when you save.
5860 Normally we run the normal hook `auto-save-hook' before saving.
5862 A non-nil NO-MESSAGE argument means do not print any message if successful.
5863 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5864 (no_message
, current_only
)
5865 Lisp_Object no_message
, current_only
;
5867 struct buffer
*old
= current_buffer
, *b
;
5868 Lisp_Object tail
, buf
;
5870 int do_handled_files
;
5873 Lisp_Object lispstream
;
5874 int count
= SPECPDL_INDEX ();
5875 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5876 int old_message_p
= 0;
5877 struct gcpro gcpro1
, gcpro2
;
5879 if (max_specpdl_size
< specpdl_size
+ 40)
5880 max_specpdl_size
= specpdl_size
+ 40;
5885 if (NILP (no_message
))
5887 old_message_p
= push_message ();
5888 record_unwind_protect (pop_message_unwind
, Qnil
);
5891 /* Ordinarily don't quit within this function,
5892 but don't make it impossible to quit (in case we get hung in I/O). */
5896 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5897 point to non-strings reached from Vbuffer_alist. */
5899 if (!NILP (Vrun_hooks
))
5900 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5902 if (STRINGP (Vauto_save_list_file_name
))
5904 Lisp_Object listfile
;
5906 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5908 /* Don't try to create the directory when shutting down Emacs,
5909 because creating the directory might signal an error, and
5910 that would leave Emacs in a strange state. */
5911 if (!NILP (Vrun_hooks
))
5915 GCPRO2 (dir
, listfile
);
5916 dir
= Ffile_name_directory (listfile
);
5917 if (NILP (Ffile_directory_p (dir
)))
5918 internal_condition_case_1 (do_auto_save_make_dir
,
5919 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5924 stream
= fopen (SDATA (listfile
), "w");
5927 /* Arrange to close that file whether or not we get an error.
5928 Also reset auto_saving to 0. */
5929 lispstream
= Fcons (Qnil
, Qnil
);
5930 XSETCARFASTINT (lispstream
, (EMACS_UINT
)stream
>> 16);
5931 XSETCDRFASTINT (lispstream
, (EMACS_UINT
)stream
& 0xffff);
5942 record_unwind_protect (do_auto_save_unwind
, lispstream
);
5943 record_unwind_protect (do_auto_save_unwind_1
,
5944 make_number (minibuffer_auto_raise
));
5945 minibuffer_auto_raise
= 0;
5948 /* On first pass, save all files that don't have handlers.
5949 On second pass, save all files that do have handlers.
5951 If Emacs is crashing, the handlers may tweak what is causing
5952 Emacs to crash in the first place, and it would be a shame if
5953 Emacs failed to autosave perfectly ordinary files because it
5954 couldn't handle some ange-ftp'd file. */
5956 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5957 for (tail
= Vbuffer_alist
; GC_CONSP (tail
); tail
= XCDR (tail
))
5959 buf
= XCDR (XCAR (tail
));
5962 /* Record all the buffers that have auto save mode
5963 in the special file that lists them. For each of these buffers,
5964 Record visited name (if any) and auto save name. */
5965 if (STRINGP (b
->auto_save_file_name
)
5966 && stream
!= NULL
&& do_handled_files
== 0)
5968 if (!NILP (b
->filename
))
5970 fwrite (SDATA (b
->filename
), 1,
5971 SBYTES (b
->filename
), stream
);
5973 putc ('\n', stream
);
5974 fwrite (SDATA (b
->auto_save_file_name
), 1,
5975 SBYTES (b
->auto_save_file_name
), stream
);
5976 putc ('\n', stream
);
5979 if (!NILP (current_only
)
5980 && b
!= current_buffer
)
5983 /* Don't auto-save indirect buffers.
5984 The base buffer takes care of it. */
5988 /* Check for auto save enabled
5989 and file changed since last auto save
5990 and file changed since last real save. */
5991 if (STRINGP (b
->auto_save_file_name
)
5992 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5993 && b
->auto_save_modified
< BUF_MODIFF (b
)
5994 /* -1 means we've turned off autosaving for a while--see below. */
5995 && XINT (b
->save_length
) >= 0
5996 && (do_handled_files
5997 || NILP (Ffind_file_name_handler (b
->auto_save_file_name
,
6000 EMACS_TIME before_time
, after_time
;
6002 EMACS_GET_TIME (before_time
);
6004 /* If we had a failure, don't try again for 20 minutes. */
6005 if (b
->auto_save_failure_time
>= 0
6006 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
6009 if ((XFASTINT (b
->save_length
) * 10
6010 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
6011 /* A short file is likely to change a large fraction;
6012 spare the user annoying messages. */
6013 && XFASTINT (b
->save_length
) > 5000
6014 /* These messages are frequent and annoying for `*mail*'. */
6015 && !EQ (b
->filename
, Qnil
)
6016 && NILP (no_message
))
6018 /* It has shrunk too much; turn off auto-saving here. */
6019 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
6020 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
6022 minibuffer_auto_raise
= 0;
6023 /* Turn off auto-saving until there's a real save,
6024 and prevent any more warnings. */
6025 XSETINT (b
->save_length
, -1);
6026 Fsleep_for (make_number (1), Qnil
);
6029 set_buffer_internal (b
);
6030 if (!auto_saved
&& NILP (no_message
))
6031 message1 ("Auto-saving...");
6032 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
6034 b
->auto_save_modified
= BUF_MODIFF (b
);
6035 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
6036 set_buffer_internal (old
);
6038 EMACS_GET_TIME (after_time
);
6040 /* If auto-save took more than 60 seconds,
6041 assume it was an NFS failure that got a timeout. */
6042 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
6043 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
6047 /* Prevent another auto save till enough input events come in. */
6048 record_auto_save ();
6050 if (auto_saved
&& NILP (no_message
))
6054 /* If we are going to restore an old message,
6055 give time to read ours. */
6056 sit_for (1, 0, 0, 0, 0);
6060 /* If we displayed a message and then restored a state
6061 with no message, leave a "done" message on the screen. */
6062 message1 ("Auto-saving...done");
6067 /* This restores the message-stack status. */
6068 unbind_to (count
, Qnil
);
6072 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
6073 Sset_buffer_auto_saved
, 0, 0, 0,
6074 doc
: /* Mark current buffer as auto-saved with its current text.
6075 No auto-save file will be written until the buffer changes again. */)
6078 current_buffer
->auto_save_modified
= MODIFF
;
6079 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
6080 current_buffer
->auto_save_failure_time
= -1;
6084 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
6085 Sclear_buffer_auto_save_failure
, 0, 0, 0,
6086 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
6089 current_buffer
->auto_save_failure_time
= -1;
6093 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
6095 doc
: /* Return t if current buffer has been auto-saved recently.
6096 More precisely, if it has been auto-saved since last read from or saved
6097 in the visited file. If the buffer has no visited file,
6098 then any auto-save counts as "recent". */)
6101 return (SAVE_MODIFF
< current_buffer
->auto_save_modified
) ? Qt
: Qnil
;
6104 /* Reading and completing file names */
6105 extern Lisp_Object
Ffile_name_completion (), Ffile_name_all_completions ();
6107 /* In the string VAL, change each $ to $$ and return the result. */
6110 double_dollars (val
)
6113 register const unsigned char *old
;
6114 register unsigned char *new;
6118 osize
= SBYTES (val
);
6120 /* Count the number of $ characters. */
6121 for (n
= osize
, count
= 0, old
= SDATA (val
); n
> 0; n
--)
6122 if (*old
++ == '$') count
++;
6126 val
= make_uninit_multibyte_string (SCHARS (val
) + count
,
6129 for (n
= osize
; n
> 0; n
--)
6143 read_file_name_cleanup (arg
)
6146 return (current_buffer
->directory
= arg
);
6149 DEFUN ("read-file-name-internal", Fread_file_name_internal
, Sread_file_name_internal
,
6151 doc
: /* Internal subroutine for read-file-name. Do not call this. */)
6152 (string
, dir
, action
)
6153 Lisp_Object string
, dir
, action
;
6154 /* action is nil for complete, t for return list of completions,
6155 lambda for verify final value */
6157 Lisp_Object name
, specdir
, realdir
, val
, orig_string
;
6159 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
6161 CHECK_STRING (string
);
6168 /* No need to protect ACTION--we only compare it with t and nil. */
6169 GCPRO5 (string
, realdir
, name
, specdir
, orig_string
);
6171 if (SCHARS (string
) == 0)
6173 if (EQ (action
, Qlambda
))
6181 orig_string
= string
;
6182 string
= Fsubstitute_in_file_name (string
);
6183 changed
= NILP (Fstring_equal (string
, orig_string
));
6184 name
= Ffile_name_nondirectory (string
);
6185 val
= Ffile_name_directory (string
);
6187 realdir
= Fexpand_file_name (val
, realdir
);
6192 specdir
= Ffile_name_directory (string
);
6193 val
= Ffile_name_completion (name
, realdir
);
6198 return double_dollars (string
);
6202 if (!NILP (specdir
))
6203 val
= concat2 (specdir
, val
);
6205 return double_dollars (val
);
6208 #endif /* not VMS */
6212 if (EQ (action
, Qt
))
6214 Lisp_Object all
= Ffile_name_all_completions (name
, realdir
);
6218 if (NILP (Vread_file_name_predicate
)
6219 || EQ (Vread_file_name_predicate
, Qfile_exists_p
))
6223 if (EQ (Vread_file_name_predicate
, Qfile_directory_p
))
6225 /* Brute-force speed up for directory checking:
6226 Discard strings which don't end in a slash. */
6227 for (comp
= Qnil
; CONSP (all
); all
= XCDR (all
))
6229 Lisp_Object tem
= XCAR (all
);
6231 if (STRINGP (tem
) &&
6232 (len
= SCHARS (tem
), len
> 0) &&
6233 IS_DIRECTORY_SEP (SREF (tem
, len
-1)))
6234 comp
= Fcons (tem
, comp
);
6240 /* Must do it the hard (and slow) way. */
6241 GCPRO3 (all
, comp
, specdir
);
6242 count
= SPECPDL_INDEX ();
6243 record_unwind_protect (read_file_name_cleanup
, current_buffer
->directory
);
6244 current_buffer
->directory
= realdir
;
6245 for (comp
= Qnil
; CONSP (all
); all
= XCDR (all
))
6246 if (!NILP (call1 (Vread_file_name_predicate
, XCAR (all
))))
6247 comp
= Fcons (XCAR (all
), comp
);
6248 unbind_to (count
, Qnil
);
6251 return Fnreverse (comp
);
6254 /* Only other case actually used is ACTION = lambda */
6256 /* Supposedly this helps commands such as `cd' that read directory names,
6257 but can someone explain how it helps them? -- RMS */
6258 if (SCHARS (name
) == 0)
6261 string
= Fexpand_file_name (string
, dir
);
6262 if (!NILP (Vread_file_name_predicate
))
6263 return call1 (Vread_file_name_predicate
, string
);
6264 return Ffile_exists_p (string
);
6267 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
6268 Snext_read_file_uses_dialog_p
, 0, 0, 0,
6269 doc
: /* Return t if a call to `read-file-name' will use a dialog.
6270 The return value is only relevant for a call to `read-file-name' that happens
6271 before any other event (mouse or keypress) is handeled. */)
6274 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6275 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
6284 DEFUN ("read-file-name", Fread_file_name
, Sread_file_name
, 1, 6, 0,
6285 doc
: /* Read file name, prompting with PROMPT and completing in directory DIR.
6286 Value is not expanded---you must call `expand-file-name' yourself.
6287 Default name to DEFAULT-FILENAME if user exits the minibuffer with
6288 the same non-empty string that was inserted by this function.
6289 (If DEFAULT-FILENAME is omitted, the visited file name is used,
6290 except that if INITIAL is specified, that combined with DIR is used.)
6291 If the user exits with an empty minibuffer, this function returns
6292 an empty string. (This can only happen if the user erased the
6293 pre-inserted contents or if `insert-default-directory' is nil.)
6294 Fourth arg MUSTMATCH non-nil means require existing file's name.
6295 Non-nil and non-t means also require confirmation after completion.
6296 Fifth arg INITIAL specifies text to start with.
6297 If optional sixth arg PREDICATE is non-nil, possible completions and
6298 the resulting file name must satisfy (funcall PREDICATE NAME).
6299 DIR should be an absolute directory name. It defaults to the value of
6300 `default-directory'.
6302 If this command was invoked with the mouse, use a file dialog box if
6303 `use-dialog-box' is non-nil, and the window system or X toolkit in use
6304 provides a file dialog box.
6306 See also `read-file-name-completion-ignore-case'
6307 and `read-file-name-function'. */)
6308 (prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
)
6309 Lisp_Object prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
;
6311 Lisp_Object val
, insdef
, tem
;
6312 struct gcpro gcpro1
, gcpro2
;
6313 register char *homedir
;
6314 Lisp_Object decoded_homedir
;
6315 int replace_in_history
= 0;
6316 int add_to_history
= 0;
6320 dir
= current_buffer
->directory
;
6321 if (NILP (Ffile_name_absolute_p (dir
)))
6322 dir
= Fexpand_file_name (dir
, Qnil
);
6323 if (NILP (default_filename
))
6326 ? Fexpand_file_name (initial
, dir
)
6327 : current_buffer
->filename
);
6329 /* If dir starts with user's homedir, change that to ~. */
6330 homedir
= (char *) egetenv ("HOME");
6332 /* homedir can be NULL in temacs, since Vprocess_environment is not
6333 yet set up. We shouldn't crash in that case. */
6336 homedir
= strcpy (alloca (strlen (homedir
) + 1), homedir
);
6337 CORRECT_DIR_SEPS (homedir
);
6342 = DECODE_FILE (make_unibyte_string (homedir
, strlen (homedir
)));
6345 && !strncmp (SDATA (decoded_homedir
), SDATA (dir
),
6346 SBYTES (decoded_homedir
))
6347 && IS_DIRECTORY_SEP (SREF (dir
, SBYTES (decoded_homedir
))))
6349 dir
= Fsubstring (dir
, make_number (SCHARS (decoded_homedir
)), Qnil
);
6350 dir
= concat2 (build_string ("~"), dir
);
6352 /* Likewise for default_filename. */
6354 && STRINGP (default_filename
)
6355 && !strncmp (SDATA (decoded_homedir
), SDATA (default_filename
),
6356 SBYTES (decoded_homedir
))
6357 && IS_DIRECTORY_SEP (SREF (default_filename
, SBYTES (decoded_homedir
))))
6360 = Fsubstring (default_filename
,
6361 make_number (SCHARS (decoded_homedir
)), Qnil
);
6362 default_filename
= concat2 (build_string ("~"), default_filename
);
6364 if (!NILP (default_filename
))
6366 CHECK_STRING (default_filename
);
6367 default_filename
= double_dollars (default_filename
);
6370 if (insert_default_directory
&& STRINGP (dir
))
6373 if (!NILP (initial
))
6375 Lisp_Object args
[2], pos
;
6379 insdef
= Fconcat (2, args
);
6380 pos
= make_number (SCHARS (double_dollars (dir
)));
6381 insdef
= Fcons (double_dollars (insdef
), pos
);
6384 insdef
= double_dollars (insdef
);
6386 else if (STRINGP (initial
))
6387 insdef
= Fcons (double_dollars (initial
), make_number (0));
6391 if (!NILP (Vread_file_name_function
))
6393 Lisp_Object args
[7];
6395 GCPRO2 (insdef
, default_filename
);
6396 args
[0] = Vread_file_name_function
;
6399 args
[3] = default_filename
;
6400 args
[4] = mustmatch
;
6402 args
[6] = predicate
;
6403 RETURN_UNGCPRO (Ffuncall (7, args
));
6406 count
= SPECPDL_INDEX ();
6407 specbind (intern ("completion-ignore-case"),
6408 read_file_name_completion_ignore_case
? Qt
: Qnil
);
6409 specbind (intern ("minibuffer-completing-file-name"), Qt
);
6410 specbind (intern ("read-file-name-predicate"),
6411 (NILP (predicate
) ? Qfile_exists_p
: predicate
));
6413 GCPRO2 (insdef
, default_filename
);
6415 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6416 if (! NILP (Fnext_read_file_uses_dialog_p ()))
6418 /* If DIR contains a file name, split it. */
6420 file
= Ffile_name_nondirectory (dir
);
6421 if (SCHARS (file
) && NILP (default_filename
))
6423 default_filename
= file
;
6424 dir
= Ffile_name_directory (dir
);
6426 if (!NILP(default_filename
))
6427 default_filename
= Fexpand_file_name (default_filename
, dir
);
6428 val
= Fx_file_dialog (prompt
, dir
, default_filename
, mustmatch
,
6429 EQ (predicate
, Qfile_directory_p
) ? Qt
: Qnil
);
6434 val
= Fcompleting_read (prompt
, intern ("read-file-name-internal"),
6435 dir
, mustmatch
, insdef
,
6436 Qfile_name_history
, default_filename
, Qnil
);
6438 tem
= Fsymbol_value (Qfile_name_history
);
6439 if (CONSP (tem
) && EQ (XCAR (tem
), val
))
6440 replace_in_history
= 1;
6442 /* If Fcompleting_read returned the inserted default string itself
6443 (rather than a new string with the same contents),
6444 it has to mean that the user typed RET with the minibuffer empty.
6445 In that case, we really want to return ""
6446 so that commands such as set-visited-file-name can distinguish. */
6447 if (EQ (val
, default_filename
))
6449 /* In this case, Fcompleting_read has not added an element
6450 to the history. Maybe we should. */
6451 if (! replace_in_history
)
6457 unbind_to (count
, Qnil
);
6460 error ("No file name specified");
6462 tem
= Fstring_equal (val
, CONSP (insdef
) ? XCAR (insdef
) : insdef
);
6464 if (!NILP (tem
) && !NILP (default_filename
))
6465 val
= default_filename
;
6466 val
= Fsubstitute_in_file_name (val
);
6468 if (replace_in_history
)
6469 /* Replace what Fcompleting_read added to the history
6470 with what we will actually return. */
6472 Lisp_Object val1
= double_dollars (val
);
6473 tem
= Fsymbol_value (Qfile_name_history
);
6474 if (history_delete_duplicates
)
6475 XSETCDR (tem
, Fdelete (val1
, XCDR(tem
)));
6476 XSETCAR (tem
, val1
);
6478 else if (add_to_history
)
6480 /* Add the value to the history--but not if it matches
6481 the last value already there. */
6482 Lisp_Object val1
= double_dollars (val
);
6483 tem
= Fsymbol_value (Qfile_name_history
);
6484 if (! CONSP (tem
) || NILP (Fequal (XCAR (tem
), val1
)))
6486 if (history_delete_duplicates
) tem
= Fdelete (val1
, tem
);
6487 Fset (Qfile_name_history
, Fcons (val1
, tem
));
6498 /* Must be set before any path manipulation is performed. */
6499 XSETFASTINT (Vdirectory_sep_char
, '/');
6506 Qoperations
= intern ("operations");
6507 Qexpand_file_name
= intern ("expand-file-name");
6508 Qsubstitute_in_file_name
= intern ("substitute-in-file-name");
6509 Qdirectory_file_name
= intern ("directory-file-name");
6510 Qfile_name_directory
= intern ("file-name-directory");
6511 Qfile_name_nondirectory
= intern ("file-name-nondirectory");
6512 Qunhandled_file_name_directory
= intern ("unhandled-file-name-directory");
6513 Qfile_name_as_directory
= intern ("file-name-as-directory");
6514 Qcopy_file
= intern ("copy-file");
6515 Qmake_directory_internal
= intern ("make-directory-internal");
6516 Qmake_directory
= intern ("make-directory");
6517 Qdelete_directory
= intern ("delete-directory");
6518 Qdelete_file
= intern ("delete-file");
6519 Qrename_file
= intern ("rename-file");
6520 Qadd_name_to_file
= intern ("add-name-to-file");
6521 Qmake_symbolic_link
= intern ("make-symbolic-link");
6522 Qfile_exists_p
= intern ("file-exists-p");
6523 Qfile_executable_p
= intern ("file-executable-p");
6524 Qfile_readable_p
= intern ("file-readable-p");
6525 Qfile_writable_p
= intern ("file-writable-p");
6526 Qfile_symlink_p
= intern ("file-symlink-p");
6527 Qaccess_file
= intern ("access-file");
6528 Qfile_directory_p
= intern ("file-directory-p");
6529 Qfile_regular_p
= intern ("file-regular-p");
6530 Qfile_accessible_directory_p
= intern ("file-accessible-directory-p");
6531 Qfile_modes
= intern ("file-modes");
6532 Qset_file_modes
= intern ("set-file-modes");
6533 Qset_file_times
= intern ("set-file-times");
6534 Qfile_newer_than_file_p
= intern ("file-newer-than-file-p");
6535 Qinsert_file_contents
= intern ("insert-file-contents");
6536 Qwrite_region
= intern ("write-region");
6537 Qverify_visited_file_modtime
= intern ("verify-visited-file-modtime");
6538 Qset_visited_file_modtime
= intern ("set-visited-file-modtime");
6539 Qauto_save_coding
= intern ("auto-save-coding");
6541 staticpro (&Qoperations
);
6542 staticpro (&Qexpand_file_name
);
6543 staticpro (&Qsubstitute_in_file_name
);
6544 staticpro (&Qdirectory_file_name
);
6545 staticpro (&Qfile_name_directory
);
6546 staticpro (&Qfile_name_nondirectory
);
6547 staticpro (&Qunhandled_file_name_directory
);
6548 staticpro (&Qfile_name_as_directory
);
6549 staticpro (&Qcopy_file
);
6550 staticpro (&Qmake_directory_internal
);
6551 staticpro (&Qmake_directory
);
6552 staticpro (&Qdelete_directory
);
6553 staticpro (&Qdelete_file
);
6554 staticpro (&Qrename_file
);
6555 staticpro (&Qadd_name_to_file
);
6556 staticpro (&Qmake_symbolic_link
);
6557 staticpro (&Qfile_exists_p
);
6558 staticpro (&Qfile_executable_p
);
6559 staticpro (&Qfile_readable_p
);
6560 staticpro (&Qfile_writable_p
);
6561 staticpro (&Qaccess_file
);
6562 staticpro (&Qfile_symlink_p
);
6563 staticpro (&Qfile_directory_p
);
6564 staticpro (&Qfile_regular_p
);
6565 staticpro (&Qfile_accessible_directory_p
);
6566 staticpro (&Qfile_modes
);
6567 staticpro (&Qset_file_modes
);
6568 staticpro (&Qset_file_times
);
6569 staticpro (&Qfile_newer_than_file_p
);
6570 staticpro (&Qinsert_file_contents
);
6571 staticpro (&Qwrite_region
);
6572 staticpro (&Qverify_visited_file_modtime
);
6573 staticpro (&Qset_visited_file_modtime
);
6574 staticpro (&Qauto_save_coding
);
6576 Qfile_name_history
= intern ("file-name-history");
6577 Fset (Qfile_name_history
, Qnil
);
6578 staticpro (&Qfile_name_history
);
6580 Qfile_error
= intern ("file-error");
6581 staticpro (&Qfile_error
);
6582 Qfile_already_exists
= intern ("file-already-exists");
6583 staticpro (&Qfile_already_exists
);
6584 Qfile_date_error
= intern ("file-date-error");
6585 staticpro (&Qfile_date_error
);
6586 Qexcl
= intern ("excl");
6590 Qfind_buffer_file_type
= intern ("find-buffer-file-type");
6591 staticpro (&Qfind_buffer_file_type
);
6594 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system
,
6595 doc
: /* *Coding system for encoding file names.
6596 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6597 Vfile_name_coding_system
= Qnil
;
6599 DEFVAR_LISP ("default-file-name-coding-system",
6600 &Vdefault_file_name_coding_system
,
6601 doc
: /* Default coding system for encoding file names.
6602 This variable is used only when `file-name-coding-system' is nil.
6604 This variable is set/changed by the command `set-language-environment'.
6605 User should not set this variable manually,
6606 instead use `file-name-coding-system' to get a constant encoding
6607 of file names regardless of the current language environment. */);
6608 Vdefault_file_name_coding_system
= Qnil
;
6610 Qformat_decode
= intern ("format-decode");
6611 staticpro (&Qformat_decode
);
6612 Qformat_annotate_function
= intern ("format-annotate-function");
6613 staticpro (&Qformat_annotate_function
);
6614 Qafter_insert_file_set_coding
= intern ("after-insert-file-set-coding");
6615 staticpro (&Qafter_insert_file_set_coding
);
6617 Qcar_less_than_car
= intern ("car-less-than-car");
6618 staticpro (&Qcar_less_than_car
);
6620 Fput (Qfile_error
, Qerror_conditions
,
6621 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
)));
6622 Fput (Qfile_error
, Qerror_message
,
6623 build_string ("File error"));
6625 Fput (Qfile_already_exists
, Qerror_conditions
,
6626 Fcons (Qfile_already_exists
,
6627 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
))));
6628 Fput (Qfile_already_exists
, Qerror_message
,
6629 build_string ("File already exists"));
6631 Fput (Qfile_date_error
, Qerror_conditions
,
6632 Fcons (Qfile_date_error
,
6633 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
))));
6634 Fput (Qfile_date_error
, Qerror_message
,
6635 build_string ("Cannot set file date"));
6637 DEFVAR_LISP ("read-file-name-function", &Vread_file_name_function
,
6638 doc
: /* If this is non-nil, `read-file-name' does its work by calling this function. */);
6639 Vread_file_name_function
= Qnil
;
6641 DEFVAR_LISP ("read-file-name-predicate", &Vread_file_name_predicate
,
6642 doc
: /* Current predicate used by `read-file-name-internal'. */);
6643 Vread_file_name_predicate
= Qnil
;
6645 DEFVAR_BOOL ("read-file-name-completion-ignore-case", &read_file_name_completion_ignore_case
,
6646 doc
: /* *Non-nil means when reading a file name completion ignores case. */);
6647 #if defined VMS || defined DOS_NT || defined MAC_OS
6648 read_file_name_completion_ignore_case
= 1;
6650 read_file_name_completion_ignore_case
= 0;
6653 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory
,
6654 doc
: /* *Non-nil means when reading a filename start with default dir in minibuffer.
6655 If the initial minibuffer contents are non-empty, you can usually
6656 request a default filename by typing RETURN without editing. For some
6657 commands, exiting with an empty minibuffer has a special meaning,
6658 such as making the current buffer visit no file in the case of
6659 `set-visited-file-name'.
6660 If this variable is non-nil, the minibuffer contents are always
6661 initially non-empty and typing RETURN without editing will fetch the
6662 default name, if one is provided. Note however that this default name
6663 is not necessarily the name originally inserted in the minibuffer, if
6664 that is just the default directory.
6665 If this variable is nil, the minibuffer often starts out empty. In
6666 that case you may have to explicitly fetch the next history element to
6667 request the default name. */);
6668 insert_default_directory
= 1;
6670 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm
,
6671 doc
: /* *Non-nil means write new files with record format `stmlf'.
6672 nil means use format `var'. This variable is meaningful only on VMS. */);
6673 vms_stmlf_recfm
= 0;
6675 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char
,
6676 doc
: /* Directory separator character for built-in functions that return file names.
6677 The value is always ?/. Don't use this variable, just use `/'. */);
6679 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist
,
6680 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6681 If a file name matches REGEXP, then all I/O on that file is done by calling
6684 The first argument given to HANDLER is the name of the I/O primitive
6685 to be handled; the remaining arguments are the arguments that were
6686 passed to that primitive. For example, if you do
6687 (file-exists-p FILENAME)
6688 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6689 (funcall HANDLER 'file-exists-p FILENAME)
6690 The function `find-file-name-handler' checks this list for a handler
6691 for its argument. */);
6692 Vfile_name_handler_alist
= Qnil
;
6694 DEFVAR_LISP ("set-auto-coding-function",
6695 &Vset_auto_coding_function
,
6696 doc
: /* If non-nil, a function to call to decide a coding system of file.
6697 Two arguments are passed to this function: the file name
6698 and the length of a file contents following the point.
6699 This function should return a coding system to decode the file contents.
6700 It should check the file name against `auto-coding-alist'.
6701 If no coding system is decided, it should check a coding system
6702 specified in the heading lines with the format:
6703 -*- ... coding: CODING-SYSTEM; ... -*-
6704 or local variable spec of the tailing lines with `coding:' tag. */);
6705 Vset_auto_coding_function
= Qnil
;
6707 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions
,
6708 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
6709 Each is passed one argument, the number of characters inserted.
6710 It should return the new character count, and leave point the same.
6711 If `insert-file-contents' is intercepted by a handler from
6712 `file-name-handler-alist', that handler is responsible for calling the
6713 functions in `after-insert-file-functions' if appropriate. */);
6714 Vafter_insert_file_functions
= Qnil
;
6716 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions
,
6717 doc
: /* A list of functions to be called at the start of `write-region'.
6718 Each is passed two arguments, START and END as for `write-region'.
6719 These are usually two numbers but not always; see the documentation
6720 for `write-region'. The function should return a list of pairs
6721 of the form (POSITION . STRING), consisting of strings to be effectively
6722 inserted at the specified positions of the file being written (1 means to
6723 insert before the first byte written). The POSITIONs must be sorted into
6724 increasing order. If there are several functions in the list, the several
6725 lists are merged destructively. Alternatively, the function can return
6726 with a different buffer current; in that case it should pay attention
6727 to the annotations returned by previous functions and listed in
6728 `write-region-annotations-so-far'.*/);
6729 Vwrite_region_annotate_functions
= Qnil
;
6730 staticpro (&Qwrite_region_annotate_functions
);
6731 Qwrite_region_annotate_functions
6732 = intern ("write-region-annotate-functions");
6734 DEFVAR_LISP ("write-region-annotations-so-far",
6735 &Vwrite_region_annotations_so_far
,
6736 doc
: /* When an annotation function is called, this holds the previous annotations.
6737 These are the annotations made by other annotation functions
6738 that were already called. See also `write-region-annotate-functions'. */);
6739 Vwrite_region_annotations_so_far
= Qnil
;
6741 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers
,
6742 doc
: /* A list of file name handlers that temporarily should not be used.
6743 This applies only to the operation `inhibit-file-name-operation'. */);
6744 Vinhibit_file_name_handlers
= Qnil
;
6746 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation
,
6747 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6748 Vinhibit_file_name_operation
= Qnil
;
6750 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name
,
6751 doc
: /* File name in which we write a list of all auto save file names.
6752 This variable is initialized automatically from `auto-save-list-file-prefix'
6753 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6754 a non-nil value. */);
6755 Vauto_save_list_file_name
= Qnil
;
6757 defsubr (&Sfind_file_name_handler
);
6758 defsubr (&Sfile_name_directory
);
6759 defsubr (&Sfile_name_nondirectory
);
6760 defsubr (&Sunhandled_file_name_directory
);
6761 defsubr (&Sfile_name_as_directory
);
6762 defsubr (&Sdirectory_file_name
);
6763 defsubr (&Smake_temp_name
);
6764 defsubr (&Sexpand_file_name
);
6765 defsubr (&Ssubstitute_in_file_name
);
6766 defsubr (&Scopy_file
);
6767 defsubr (&Smake_directory_internal
);
6768 defsubr (&Sdelete_directory
);
6769 defsubr (&Sdelete_file
);
6770 defsubr (&Srename_file
);
6771 defsubr (&Sadd_name_to_file
);
6773 defsubr (&Smake_symbolic_link
);
6774 #endif /* S_IFLNK */
6776 defsubr (&Sdefine_logical_name
);
6779 defsubr (&Ssysnetunam
);
6780 #endif /* HPUX_NET */
6781 defsubr (&Sfile_name_absolute_p
);
6782 defsubr (&Sfile_exists_p
);
6783 defsubr (&Sfile_executable_p
);
6784 defsubr (&Sfile_readable_p
);
6785 defsubr (&Sfile_writable_p
);
6786 defsubr (&Saccess_file
);
6787 defsubr (&Sfile_symlink_p
);
6788 defsubr (&Sfile_directory_p
);
6789 defsubr (&Sfile_accessible_directory_p
);
6790 defsubr (&Sfile_regular_p
);
6791 defsubr (&Sfile_modes
);
6792 defsubr (&Sset_file_modes
);
6793 defsubr (&Sset_file_times
);
6794 defsubr (&Sset_default_file_modes
);
6795 defsubr (&Sdefault_file_modes
);
6796 defsubr (&Sfile_newer_than_file_p
);
6797 defsubr (&Sinsert_file_contents
);
6798 defsubr (&Swrite_region
);
6799 defsubr (&Scar_less_than_car
);
6800 defsubr (&Sverify_visited_file_modtime
);
6801 defsubr (&Sclear_visited_file_modtime
);
6802 defsubr (&Svisited_file_modtime
);
6803 defsubr (&Sset_visited_file_modtime
);
6804 defsubr (&Sdo_auto_save
);
6805 defsubr (&Sset_buffer_auto_saved
);
6806 defsubr (&Sclear_buffer_auto_save_failure
);
6807 defsubr (&Srecent_auto_save_p
);
6809 defsubr (&Sread_file_name_internal
);
6810 defsubr (&Sread_file_name
);
6811 defsubr (&Snext_read_file_uses_dialog_p
);
6814 defsubr (&Sunix_sync
);
6818 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
6819 (do not change this comment) */