1 /* File IO for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
30 #include <sys/types.h>
37 #if !defined (S_ISLNK) && defined (S_IFLNK)
38 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
41 #if !defined (S_ISFIFO) && defined (S_IFIFO)
42 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
45 #if !defined (S_ISREG) && defined (S_IFREG)
46 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
75 #include "intervals.h"
81 #include "dispextern.h"
88 #endif /* not WINDOWSNT */
92 #include <sys/param.h>
100 #define CORRECT_DIR_SEPS(s) \
101 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
102 else unixtodos_filename (s); \
104 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
105 redirector allows the six letters between 'Z' and 'a' as well. */
107 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
110 #define IS_DRIVE(x) isalpha (x)
112 /* Need to lower-case the drive letter, or else expanded
113 filenames will sometimes compare inequal, because
114 `expand-file-name' doesn't always down-case the drive letter. */
115 #define DRIVE_LETTER(x) (tolower (x))
136 #include "commands.h"
137 extern int use_dialog_box
;
138 extern int use_file_dialog
;
152 #ifndef FILE_SYSTEM_CASE
153 #define FILE_SYSTEM_CASE(filename) (filename)
156 /* Nonzero during writing of auto-save files */
159 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
160 a new file with the same mode as the original */
161 int auto_save_mode_bits
;
163 /* The symbol bound to coding-system-for-read when
164 insert-file-contents is called for recovering a file. This is not
165 an actual coding system name, but just an indicator to tell
166 insert-file-contents to use `emacs-mule' with a special flag for
167 auto saving and recovering a file. */
168 Lisp_Object Qauto_save_coding
;
170 /* Coding system for file names, or nil if none. */
171 Lisp_Object Vfile_name_coding_system
;
173 /* Coding system for file names used only when
174 Vfile_name_coding_system is nil. */
175 Lisp_Object Vdefault_file_name_coding_system
;
177 /* Alist of elements (REGEXP . HANDLER) for file names
178 whose I/O is done with a special handler. */
179 Lisp_Object Vfile_name_handler_alist
;
181 /* Property name of a file name handler,
182 which gives a list of operations it handles.. */
183 Lisp_Object Qoperations
;
185 /* Lisp functions for translating file formats */
186 Lisp_Object Qformat_decode
, Qformat_annotate_function
;
188 /* Function to be called to decide a coding system of a reading file. */
189 Lisp_Object Vset_auto_coding_function
;
191 /* Functions to be called to process text properties in inserted file. */
192 Lisp_Object Vafter_insert_file_functions
;
194 /* Lisp function for setting buffer-file-coding-system and the
195 multibyteness of the current buffer after inserting a file. */
196 Lisp_Object Qafter_insert_file_set_coding
;
198 /* Functions to be called to create text property annotations for file. */
199 Lisp_Object Vwrite_region_annotate_functions
;
200 Lisp_Object Qwrite_region_annotate_functions
;
202 /* During build_annotations, each time an annotation function is called,
203 this holds the annotations made by the previous functions. */
204 Lisp_Object Vwrite_region_annotations_so_far
;
206 /* File name in which we write a list of all our auto save files. */
207 Lisp_Object Vauto_save_list_file_name
;
209 /* Function to call to read a file name. */
210 Lisp_Object Vread_file_name_function
;
212 /* Current predicate used by read_file_name_internal. */
213 Lisp_Object Vread_file_name_predicate
;
215 /* Nonzero means completion ignores case when reading file name. */
216 int read_file_name_completion_ignore_case
;
218 /* Nonzero means, when reading a filename in the minibuffer,
219 start out by inserting the default directory into the minibuffer. */
220 int insert_default_directory
;
222 /* On VMS, nonzero means write new files with record format stmlf.
223 Zero means use var format. */
226 /* On NT, specifies the directory separator character, used (eg.) when
227 expanding file names. This can be bound to / or \. */
228 Lisp_Object Vdirectory_sep_char
;
231 /* Nonzero means skip the call to fsync in Fwrite-region. */
232 int write_region_inhibit_fsync
;
235 extern Lisp_Object Vuser_login_name
;
238 extern Lisp_Object Vw32_get_true_file_attributes
;
241 extern int minibuf_level
;
243 extern int minibuffer_auto_raise
;
245 extern int history_delete_duplicates
;
247 /* These variables describe handlers that have "already" had a chance
248 to handle the current operation.
250 Vinhibit_file_name_handlers is a list of file name handlers.
251 Vinhibit_file_name_operation is the operation being handled.
252 If we try to handle that operation, we ignore those handlers. */
254 static Lisp_Object Vinhibit_file_name_handlers
;
255 static Lisp_Object Vinhibit_file_name_operation
;
257 Lisp_Object Qfile_error
, Qfile_already_exists
, Qfile_date_error
;
259 Lisp_Object Qfile_name_history
;
261 Lisp_Object Qcar_less_than_car
;
263 static int a_write
P_ ((int, Lisp_Object
, int, int,
264 Lisp_Object
*, struct coding_system
*));
265 static int e_write
P_ ((int, Lisp_Object
, int, int, struct coding_system
*));
269 report_file_error (string
, data
)
273 Lisp_Object errstring
;
276 synchronize_system_messages_locale ();
277 errstring
= code_convert_string_norecord (build_string (strerror (errorno
)),
278 Vlocale_coding_system
, 0);
284 Fsignal (Qfile_already_exists
, Fcons (errstring
, data
));
287 /* System error messages are capitalized. Downcase the initial
288 unless it is followed by a slash. */
289 if (SREF (errstring
, 1) != '/')
290 SSET (errstring
, 0, DOWNCASE (SREF (errstring
, 0)));
292 Fsignal (Qfile_error
,
293 Fcons (build_string (string
), Fcons (errstring
, data
)));
298 close_file_unwind (fd
)
301 emacs_close (XFASTINT (fd
));
305 /* Restore point, having saved it as a marker. */
308 restore_point_unwind (location
)
309 Lisp_Object location
;
311 Fgoto_char (location
);
312 Fset_marker (location
, Qnil
, Qnil
);
316 Lisp_Object Qexpand_file_name
;
317 Lisp_Object Qsubstitute_in_file_name
;
318 Lisp_Object Qdirectory_file_name
;
319 Lisp_Object Qfile_name_directory
;
320 Lisp_Object Qfile_name_nondirectory
;
321 Lisp_Object Qunhandled_file_name_directory
;
322 Lisp_Object Qfile_name_as_directory
;
323 Lisp_Object Qcopy_file
;
324 Lisp_Object Qmake_directory_internal
;
325 Lisp_Object Qmake_directory
;
326 Lisp_Object Qdelete_directory
;
327 Lisp_Object Qdelete_file
;
328 Lisp_Object Qrename_file
;
329 Lisp_Object Qadd_name_to_file
;
330 Lisp_Object Qmake_symbolic_link
;
331 Lisp_Object Qfile_exists_p
;
332 Lisp_Object Qfile_executable_p
;
333 Lisp_Object Qfile_readable_p
;
334 Lisp_Object Qfile_writable_p
;
335 Lisp_Object Qfile_symlink_p
;
336 Lisp_Object Qaccess_file
;
337 Lisp_Object Qfile_directory_p
;
338 Lisp_Object Qfile_regular_p
;
339 Lisp_Object Qfile_accessible_directory_p
;
340 Lisp_Object Qfile_modes
;
341 Lisp_Object Qset_file_modes
;
342 Lisp_Object Qset_file_times
;
343 Lisp_Object Qfile_newer_than_file_p
;
344 Lisp_Object Qinsert_file_contents
;
345 Lisp_Object Qwrite_region
;
346 Lisp_Object Qverify_visited_file_modtime
;
347 Lisp_Object Qset_visited_file_modtime
;
349 DEFUN ("find-file-name-handler", Ffind_file_name_handler
, Sfind_file_name_handler
, 2, 2, 0,
350 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
351 Otherwise, return nil.
352 A file name is handled if one of the regular expressions in
353 `file-name-handler-alist' matches it.
355 If OPERATION equals `inhibit-file-name-operation', then we ignore
356 any handlers that are members of `inhibit-file-name-handlers',
357 but we still do run any other handlers. This lets handlers
358 use the standard functions without calling themselves recursively. */)
359 (filename
, operation
)
360 Lisp_Object filename
, operation
;
362 /* This function must not munge the match data. */
363 Lisp_Object chain
, inhibited_handlers
, result
;
367 CHECK_STRING (filename
);
369 if (EQ (operation
, Vinhibit_file_name_operation
))
370 inhibited_handlers
= Vinhibit_file_name_handlers
;
372 inhibited_handlers
= Qnil
;
374 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
375 chain
= XCDR (chain
))
381 Lisp_Object string
= XCAR (elt
);
383 Lisp_Object handler
= XCDR (elt
);
384 Lisp_Object operations
= Qnil
;
386 if (SYMBOLP (handler
))
387 operations
= Fget (handler
, Qoperations
);
390 && (match_pos
= fast_string_match (string
, filename
)) > pos
391 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
395 handler
= XCDR (elt
);
396 tem
= Fmemq (handler
, inhibited_handlers
);
410 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
412 doc
: /* Return the directory component in file name FILENAME.
413 Return nil if FILENAME does not include a directory.
414 Otherwise return a directory spec.
415 Given a Unix syntax file name, returns a string ending in slash;
416 on VMS, perhaps instead a string ending in `:', `]' or `>'. */)
418 Lisp_Object filename
;
421 register const unsigned char *beg
;
423 register unsigned char *beg
;
425 register const unsigned char *p
;
428 CHECK_STRING (filename
);
430 /* If the file name has special constructs in it,
431 call the corresponding file handler. */
432 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
434 return call2 (handler
, Qfile_name_directory
, filename
);
436 filename
= FILE_SYSTEM_CASE (filename
);
437 beg
= SDATA (filename
);
439 beg
= strcpy (alloca (strlen (beg
) + 1), beg
);
441 p
= beg
+ SBYTES (filename
);
443 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
445 && p
[-1] != ':' && p
[-1] != ']' && p
[-1] != '>'
448 /* only recognise drive specifier at the beginning */
450 /* handle the "/:d:foo" and "/:foo" cases correctly */
451 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
452 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
459 /* Expansion of "c:" to drive and default directory. */
462 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
463 unsigned char *res
= alloca (MAXPATHLEN
+ 1);
464 unsigned char *r
= res
;
466 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
468 strncpy (res
, beg
, 2);
473 if (getdefdir (toupper (*beg
) - 'A' + 1, r
))
475 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
478 p
= beg
+ strlen (beg
);
481 CORRECT_DIR_SEPS (beg
);
484 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
487 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
488 Sfile_name_nondirectory
, 1, 1, 0,
489 doc
: /* Return file name FILENAME sans its directory.
490 For example, in a Unix-syntax file name,
491 this is everything after the last slash,
492 or the entire name if it contains no slash. */)
494 Lisp_Object filename
;
496 register const unsigned char *beg
, *p
, *end
;
499 CHECK_STRING (filename
);
501 /* If the file name has special constructs in it,
502 call the corresponding file handler. */
503 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
505 return call2 (handler
, Qfile_name_nondirectory
, filename
);
507 beg
= SDATA (filename
);
508 end
= p
= beg
+ SBYTES (filename
);
510 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
512 && p
[-1] != ':' && p
[-1] != ']' && p
[-1] != '>'
515 /* only recognise drive specifier at beginning */
517 /* handle the "/:d:foo" case correctly */
518 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
523 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
526 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
527 Sunhandled_file_name_directory
, 1, 1, 0,
528 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
529 A `directly usable' directory name is one that may be used without the
530 intervention of any file handler.
531 If FILENAME is a directly usable file itself, return
532 \(file-name-directory FILENAME).
533 The `call-process' and `start-process' functions use this function to
534 get a current directory to run processes in. */)
536 Lisp_Object filename
;
540 /* If the file name has special constructs in it,
541 call the corresponding file handler. */
542 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
544 return call2 (handler
, Qunhandled_file_name_directory
, filename
);
546 return Ffile_name_directory (filename
);
551 file_name_as_directory (out
, in
)
554 int size
= strlen (in
) - 1;
567 /* Is it already a directory string? */
568 if (in
[size
] == ':' || in
[size
] == ']' || in
[size
] == '>')
570 /* Is it a VMS directory file name? If so, hack VMS syntax. */
571 else if (! index (in
, '/')
572 && ((size
> 3 && ! strcmp (&in
[size
- 3], ".DIR"))
573 || (size
> 3 && ! strcmp (&in
[size
- 3], ".dir"))
574 || (size
> 5 && (! strncmp (&in
[size
- 5], ".DIR", 4)
575 || ! strncmp (&in
[size
- 5], ".dir", 4))
576 && (in
[size
- 1] == '.' || in
[size
- 1] == ';')
577 && in
[size
] == '1')))
579 register char *p
, *dot
;
583 dir:x.dir --> dir:[x]
584 dir:[x]y.dir --> dir:[x.y] */
586 while (p
!= in
&& *p
!= ':' && *p
!= '>' && *p
!= ']') p
--;
589 strncpy (out
, in
, p
- in
);
608 dot
= index (p
, '.');
611 /* blindly remove any extension */
612 size
= strlen (out
) + (dot
- p
);
613 strncat (out
, p
, dot
- p
);
624 /* For Unix syntax, Append a slash if necessary */
625 if (!IS_DIRECTORY_SEP (out
[size
]))
627 /* Cannot use DIRECTORY_SEP, which could have any value */
629 out
[size
+ 2] = '\0';
632 CORRECT_DIR_SEPS (out
);
638 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
639 Sfile_name_as_directory
, 1, 1, 0,
640 doc
: /* Return a string representing the file name FILE interpreted as a directory.
641 This operation exists because a directory is also a file, but its name as
642 a directory is different from its name as a file.
643 The result can be used as the value of `default-directory'
644 or passed as second argument to `expand-file-name'.
645 For a Unix-syntax file name, just appends a slash.
646 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc. */)
657 /* If the file name has special constructs in it,
658 call the corresponding file handler. */
659 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
661 return call2 (handler
, Qfile_name_as_directory
, file
);
663 buf
= (char *) alloca (SBYTES (file
) + 10);
664 file_name_as_directory (buf
, SDATA (file
));
665 return make_specified_string (buf
, -1, strlen (buf
),
666 STRING_MULTIBYTE (file
));
670 * Convert from directory name to filename.
672 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
673 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
674 * On UNIX, it's simple: just make sure there isn't a terminating /
676 * Value is nonzero if the string output is different from the input.
680 directory_file_name (src
, dst
)
688 struct FAB fab
= cc$rms_fab
;
689 struct NAM nam
= cc$rms_nam
;
690 char esa
[NAM$C_MAXRSS
];
695 if (! index (src
, '/')
696 && (src
[slen
- 1] == ']'
697 || src
[slen
- 1] == ':'
698 || src
[slen
- 1] == '>'))
700 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
702 fab
.fab$b_fns
= slen
;
703 fab
.fab$l_nam
= &nam
;
704 fab
.fab$l_fop
= FAB$M_NAM
;
707 nam
.nam$b_ess
= sizeof esa
;
708 nam
.nam$b_nop
|= NAM$M_SYNCHK
;
710 /* We call SYS$PARSE to handle such things as [--] for us. */
711 if (SYS$
PARSE (&fab
, 0, 0) == RMS$_NORMAL
)
713 slen
= nam
.nam$b_esl
;
714 if (esa
[slen
- 1] == ';' && esa
[slen
- 2] == '.')
719 if (src
[slen
- 1] != ']' && src
[slen
- 1] != '>')
721 /* what about when we have logical_name:???? */
722 if (src
[slen
- 1] == ':')
723 { /* Xlate logical name and see what we get */
724 ptr
= strcpy (dst
, src
); /* upper case for getenv */
727 if ('a' <= *ptr
&& *ptr
<= 'z')
731 dst
[slen
- 1] = 0; /* remove colon */
732 if (!(src
= egetenv (dst
)))
734 /* should we jump to the beginning of this procedure?
735 Good points: allows us to use logical names that xlate
737 Bad points: can be a problem if we just translated to a device
739 For now, I'll punt and always expect VMS names, and hope for
742 if (src
[slen
- 1] != ']' && src
[slen
- 1] != '>')
743 { /* no recursion here! */
749 { /* not a directory spec */
754 bracket
= src
[slen
- 1];
756 /* If bracket is ']' or '>', bracket - 2 is the corresponding
758 ptr
= index (src
, bracket
- 2);
760 { /* no opening bracket */
764 if (!(rptr
= rindex (src
, '.')))
767 strncpy (dst
, src
, slen
);
771 dst
[slen
++] = bracket
;
776 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
777 then translate the device and recurse. */
778 if (dst
[slen
- 1] == ':'
779 && dst
[slen
- 2] != ':' /* skip decnet nodes */
780 && strcmp (src
+ slen
, "[000000]") == 0)
782 dst
[slen
- 1] = '\0';
783 if ((ptr
= egetenv (dst
))
784 && (rlen
= strlen (ptr
) - 1) > 0
785 && (ptr
[rlen
] == ']' || ptr
[rlen
] == '>')
786 && ptr
[rlen
- 1] == '.')
788 char * buf
= (char *) alloca (strlen (ptr
) + 1);
792 return directory_file_name (buf
, dst
);
797 strcat (dst
, "[000000]");
801 rlen
= strlen (rptr
) - 1;
802 strncat (dst
, rptr
, rlen
);
803 dst
[slen
+ rlen
] = '\0';
804 strcat (dst
, ".DIR.1");
808 /* Process as Unix format: just remove any final slash.
809 But leave "/" unchanged; do not change it to "". */
812 /* Handle // as root for apollo's. */
813 if ((slen
> 2 && dst
[slen
- 1] == '/')
814 || (slen
> 1 && dst
[0] != '/' && dst
[slen
- 1] == '/'))
818 && IS_DIRECTORY_SEP (dst
[slen
- 1])
820 && !IS_ANY_SEP (dst
[slen
- 2])
826 CORRECT_DIR_SEPS (dst
);
831 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
833 doc
: /* Returns the file name of the directory named DIRECTORY.
834 This is the name of the file that holds the data for the directory DIRECTORY.
835 This operation exists because a directory is also a file, but its name as
836 a directory is different from its name as a file.
837 In Unix-syntax, this function just removes the final slash.
838 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
839 it returns a file name such as \"[X]Y.DIR.1\". */)
841 Lisp_Object directory
;
846 CHECK_STRING (directory
);
848 if (NILP (directory
))
851 /* If the file name has special constructs in it,
852 call the corresponding file handler. */
853 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
855 return call2 (handler
, Qdirectory_file_name
, directory
);
858 /* 20 extra chars is insufficient for VMS, since we might perform a
859 logical name translation. an equivalence string can be up to 255
860 chars long, so grab that much extra space... - sss */
861 buf
= (char *) alloca (SBYTES (directory
) + 20 + 255);
863 buf
= (char *) alloca (SBYTES (directory
) + 20);
865 directory_file_name (SDATA (directory
), buf
);
866 return make_specified_string (buf
, -1, strlen (buf
),
867 STRING_MULTIBYTE (directory
));
870 static char make_temp_name_tbl
[64] =
872 'A','B','C','D','E','F','G','H',
873 'I','J','K','L','M','N','O','P',
874 'Q','R','S','T','U','V','W','X',
875 'Y','Z','a','b','c','d','e','f',
876 'g','h','i','j','k','l','m','n',
877 'o','p','q','r','s','t','u','v',
878 'w','x','y','z','0','1','2','3',
879 '4','5','6','7','8','9','-','_'
882 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
884 /* Value is a temporary file name starting with PREFIX, a string.
886 The Emacs process number forms part of the result, so there is
887 no danger of generating a name being used by another process.
888 In addition, this function makes an attempt to choose a name
889 which has no existing file. To make this work, PREFIX should be
890 an absolute file name.
892 BASE64_P non-zero means add the pid as 3 characters in base64
893 encoding. In this case, 6 characters will be added to PREFIX to
894 form the file name. Otherwise, if Emacs is running on a system
895 with long file names, add the pid as a decimal number.
897 This function signals an error if no unique file name could be
901 make_temp_name (prefix
, base64_p
)
908 unsigned char *p
, *data
;
912 CHECK_STRING (prefix
);
914 /* VAL is created by adding 6 characters to PREFIX. The first
915 three are the PID of this process, in base 64, and the second
916 three are incremented if the file already exists. This ensures
917 262144 unique file names per PID per PREFIX. */
919 pid
= (int) getpid ();
923 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
924 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
925 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
930 #ifdef HAVE_LONG_FILE_NAMES
931 sprintf (pidbuf
, "%d", pid
);
932 pidlen
= strlen (pidbuf
);
934 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
935 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
936 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
941 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
942 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
943 if (!STRING_MULTIBYTE (prefix
))
944 STRING_SET_UNIBYTE (val
);
946 bcopy(SDATA (prefix
), data
, len
);
949 bcopy (pidbuf
, p
, pidlen
);
952 /* Here we try to minimize useless stat'ing when this function is
953 invoked many times successively with the same PREFIX. We achieve
954 this by initializing count to a random value, and incrementing it
957 We don't want make-temp-name to be called while dumping,
958 because then make_temp_name_count_initialized_p would get set
959 and then make_temp_name_count would not be set when Emacs starts. */
961 if (!make_temp_name_count_initialized_p
)
963 make_temp_name_count
= (unsigned) time (NULL
);
964 make_temp_name_count_initialized_p
= 1;
970 unsigned num
= make_temp_name_count
;
972 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
973 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
974 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
976 /* Poor man's congruential RN generator. Replace with
977 ++make_temp_name_count for debugging. */
978 make_temp_name_count
+= 25229;
979 make_temp_name_count
%= 225307;
981 if (stat (data
, &ignored
) < 0)
983 /* We want to return only if errno is ENOENT. */
987 /* The error here is dubious, but there is little else we
988 can do. The alternatives are to return nil, which is
989 as bad as (and in many cases worse than) throwing the
990 error, or to ignore the error, which will likely result
991 in looping through 225307 stat's, which is not only
992 dog-slow, but also useless since it will fallback to
993 the errow below, anyway. */
994 report_file_error ("Cannot create temporary name for prefix",
995 Fcons (prefix
, Qnil
));
1000 error ("Cannot create temporary name for prefix `%s'",
1006 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
1007 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
1008 The Emacs process number forms part of the result,
1009 so there is no danger of generating a name being used by another process.
1011 In addition, this function makes an attempt to choose a name
1012 which has no existing file. To make this work,
1013 PREFIX should be an absolute file name.
1015 There is a race condition between calling `make-temp-name' and creating the
1016 file which opens all kinds of security holes. For that reason, you should
1017 probably use `make-temp-file' instead, except in three circumstances:
1019 * If you are creating the file in the user's home directory.
1020 * If you are creating a directory rather than an ordinary file.
1021 * If you are taking special precautions as `make-temp-file' does. */)
1025 return make_temp_name (prefix
, 0);
1030 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1031 doc
: /* Convert filename NAME to absolute, and canonicalize it.
1032 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1033 \(does not start with slash); if DEFAULT-DIRECTORY is nil or missing,
1034 the current buffer's value of `default-directory' is used.
1035 File name components that are `.' are removed, and
1036 so are file name components followed by `..', along with the `..' itself;
1037 note that these simplifications are done without checking the resulting
1038 file names in the file system.
1039 An initial `~/' expands to your home directory.
1040 An initial `~USER/' expands to USER's home directory.
1041 See also the function `substitute-in-file-name'. */)
1042 (name
, default_directory
)
1043 Lisp_Object name
, default_directory
;
1047 register unsigned char *newdir
, *p
, *o
;
1049 unsigned char *target
;
1052 unsigned char * colon
= 0;
1053 unsigned char * close
= 0;
1054 unsigned char * slash
= 0;
1055 unsigned char * brack
= 0;
1056 int lbrack
= 0, rbrack
= 0;
1061 int collapse_newdir
= 1;
1065 Lisp_Object handler
, result
;
1068 CHECK_STRING (name
);
1070 /* If the file name has special constructs in it,
1071 call the corresponding file handler. */
1072 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
1073 if (!NILP (handler
))
1074 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
1076 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
1077 if (NILP (default_directory
))
1078 default_directory
= current_buffer
->directory
;
1079 if (! STRINGP (default_directory
))
1082 /* "/" is not considered a root directory on DOS_NT, so using "/"
1083 here causes an infinite recursion in, e.g., the following:
1085 (let (default-directory)
1086 (expand-file-name "a"))
1088 To avoid this, we set default_directory to the root of the
1090 extern char *emacs_root_dir (void);
1092 default_directory
= build_string (emacs_root_dir ());
1094 default_directory
= build_string ("/");
1098 if (!NILP (default_directory
))
1100 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
1101 if (!NILP (handler
))
1102 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
1105 o
= SDATA (default_directory
);
1107 /* Make sure DEFAULT_DIRECTORY is properly expanded.
1108 It would be better to do this down below where we actually use
1109 default_directory. Unfortunately, calling Fexpand_file_name recursively
1110 could invoke GC, and the strings might be relocated. This would
1111 be annoying because we have pointers into strings lying around
1112 that would need adjusting, and people would add new pointers to
1113 the code and forget to adjust them, resulting in intermittent bugs.
1114 Putting this call here avoids all that crud.
1116 The EQ test avoids infinite recursion. */
1117 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
1118 /* Save time in some common cases - as long as default_directory
1119 is not relative, it can be canonicalized with name below (if it
1120 is needed at all) without requiring it to be expanded now. */
1122 /* Detect MSDOS file names with drive specifiers. */
1123 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1]) && IS_DIRECTORY_SEP (o
[2]))
1125 /* Detect Windows file names in UNC format. */
1126 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
1128 #else /* not DOS_NT */
1129 /* Detect Unix absolute file names (/... alone is not absolute on
1131 && ! (IS_DIRECTORY_SEP (o
[0]))
1132 #endif /* not DOS_NT */
1135 struct gcpro gcpro1
;
1138 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
1142 name
= FILE_SYSTEM_CASE (name
);
1144 multibyte
= STRING_MULTIBYTE (name
);
1147 /* We will force directory separators to be either all \ or /, so make
1148 a local copy to modify, even if there ends up being no change. */
1149 nm
= strcpy (alloca (strlen (nm
) + 1), nm
);
1151 /* Note if special escape prefix is present, but remove for now. */
1152 if (nm
[0] == '/' && nm
[1] == ':')
1158 /* Find and remove drive specifier if present; this makes nm absolute
1159 even if the rest of the name appears to be relative. Only look for
1160 drive specifier at the beginning. */
1161 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
1168 /* If we see "c://somedir", we want to strip the first slash after the
1169 colon when stripping the drive letter. Otherwise, this expands to
1171 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1173 #endif /* WINDOWSNT */
1177 /* Discard any previous drive specifier if nm is now in UNC format. */
1178 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1184 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1185 none are found, we can probably return right away. We will avoid
1186 allocating a new string if name is already fully expanded. */
1188 IS_DIRECTORY_SEP (nm
[0])
1190 && drive
&& !is_escaped
1193 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
1200 /* If it turns out that the filename we want to return is just a
1201 suffix of FILENAME, we don't need to go through and edit
1202 things; we just need to construct a new string using data
1203 starting at the middle of FILENAME. If we set lose to a
1204 non-zero value, that means we've discovered that we can't do
1211 /* Since we know the name is absolute, we can assume that each
1212 element starts with a "/". */
1214 /* "." and ".." are hairy. */
1215 if (IS_DIRECTORY_SEP (p
[0])
1217 && (IS_DIRECTORY_SEP (p
[2])
1219 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1222 /* We want to replace multiple `/' in a row with a single
1225 && IS_DIRECTORY_SEP (p
[0])
1226 && IS_DIRECTORY_SEP (p
[1]))
1233 /* if dev:[dir]/, move nm to / */
1234 if (!slash
&& p
> nm
&& (brack
|| colon
)) {
1235 nm
= (brack
? brack
+ 1 : colon
+ 1);
1236 lbrack
= rbrack
= 0;
1243 #ifdef NO_HYPHENS_IN_FILENAMES
1244 if (lbrack
== rbrack
)
1246 /* Avoid clobbering negative version numbers. */
1251 #endif /* NO_HYPHENS_IN_FILENAMES */
1252 if (lbrack
> rbrack
&&
1253 ((p
[-1] == '.' || p
[-1] == '[' || p
[-1] == '<') &&
1254 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>')))
1256 #ifdef NO_HYPHENS_IN_FILENAMES
1259 #endif /* NO_HYPHENS_IN_FILENAMES */
1260 /* count open brackets, reset close bracket pointer */
1261 if (p
[0] == '[' || p
[0] == '<')
1262 lbrack
++, brack
= 0;
1263 /* count close brackets, set close bracket pointer */
1264 if (p
[0] == ']' || p
[0] == '>')
1265 rbrack
++, brack
= p
;
1266 /* detect ][ or >< */
1267 if ((p
[0] == ']' || p
[0] == '>') && (p
[1] == '[' || p
[1] == '<'))
1269 if ((p
[0] == ':' || p
[0] == ']' || p
[0] == '>') && p
[1] == '~')
1270 nm
= p
+ 1, lose
= 1;
1271 if (p
[0] == ':' && (colon
|| slash
))
1272 /* if dev1:[dir]dev2:, move nm to dev2: */
1278 /* if /name/dev:, move nm to dev: */
1281 /* if node::dev:, move colon following dev */
1282 else if (colon
&& colon
[-1] == ':')
1284 /* if dev1:dev2:, move nm to dev2: */
1285 else if (colon
&& colon
[-1] != ':')
1290 if (p
[0] == ':' && !colon
)
1296 if (lbrack
== rbrack
)
1299 else if (p
[0] == '.')
1307 if (index (nm
, '/'))
1309 nm
= sys_translate_unix (nm
);
1310 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1314 /* Make sure directories are all separated with / or \ as
1315 desired, but avoid allocation of a new string when not
1317 CORRECT_DIR_SEPS (nm
);
1319 if (IS_DIRECTORY_SEP (nm
[1]))
1321 if (strcmp (nm
, SDATA (name
)) != 0)
1322 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1326 /* drive must be set, so this is okay */
1327 if (strcmp (nm
- 2, SDATA (name
)) != 0)
1331 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1332 temp
[0] = DRIVE_LETTER (drive
);
1333 name
= concat2 (build_string (temp
), name
);
1336 #else /* not DOS_NT */
1337 if (nm
== SDATA (name
))
1339 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1340 #endif /* not DOS_NT */
1344 /* At this point, nm might or might not be an absolute file name. We
1345 need to expand ~ or ~user if present, otherwise prefix nm with
1346 default_directory if nm is not absolute, and finally collapse /./
1347 and /foo/../ sequences.
1349 We set newdir to be the appropriate prefix if one is needed:
1350 - the relevant user directory if nm starts with ~ or ~user
1351 - the specified drive's working dir (DOS/NT only) if nm does not
1353 - the value of default_directory.
1355 Note that these prefixes are not guaranteed to be absolute (except
1356 for the working dir of a drive). Therefore, to ensure we always
1357 return an absolute name, if the final prefix is not absolute we
1358 append it to the current working directory. */
1362 if (nm
[0] == '~') /* prefix ~ */
1364 if (IS_DIRECTORY_SEP (nm
[1])
1368 || nm
[1] == 0) /* ~ by itself */
1370 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1371 newdir
= (unsigned char *) "";
1374 collapse_newdir
= 0;
1377 nm
++; /* Don't leave the slash in nm. */
1380 else /* ~user/filename */
1382 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)
1387 o
= (unsigned char *) alloca (p
- nm
+ 1);
1388 bcopy ((char *) nm
, o
, p
- nm
);
1391 pw
= (struct passwd
*) getpwnam (o
+ 1);
1394 newdir
= (unsigned char *) pw
-> pw_dir
;
1396 nm
= p
+ 1; /* skip the terminator */
1400 collapse_newdir
= 0;
1405 /* If we don't find a user of that name, leave the name
1406 unchanged; don't move nm forward to p. */
1411 /* On DOS and Windows, nm is absolute if a drive name was specified;
1412 use the drive's current directory as the prefix if needed. */
1413 if (!newdir
&& drive
)
1415 /* Get default directory if needed to make nm absolute. */
1416 if (!IS_DIRECTORY_SEP (nm
[0]))
1418 newdir
= alloca (MAXPATHLEN
+ 1);
1419 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1424 /* Either nm starts with /, or drive isn't mounted. */
1425 newdir
= alloca (4);
1426 newdir
[0] = DRIVE_LETTER (drive
);
1434 /* Finally, if no prefix has been specified and nm is not absolute,
1435 then it must be expanded relative to default_directory. */
1439 /* /... alone is not absolute on DOS and Windows. */
1440 && !IS_DIRECTORY_SEP (nm
[0])
1443 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1450 newdir
= SDATA (default_directory
);
1451 multibyte
|= STRING_MULTIBYTE (default_directory
);
1453 /* Note if special escape prefix is present, but remove for now. */
1454 if (newdir
[0] == '/' && newdir
[1] == ':')
1465 /* First ensure newdir is an absolute name. */
1467 /* Detect MSDOS file names with drive specifiers. */
1468 ! (IS_DRIVE (newdir
[0])
1469 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1471 /* Detect Windows file names in UNC format. */
1472 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1476 /* Effectively, let newdir be (expand-file-name newdir cwd).
1477 Because of the admonition against calling expand-file-name
1478 when we have pointers into lisp strings, we accomplish this
1479 indirectly by prepending newdir to nm if necessary, and using
1480 cwd (or the wd of newdir's drive) as the new newdir. */
1482 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1487 if (!IS_DIRECTORY_SEP (nm
[0]))
1489 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1490 file_name_as_directory (tmp
, newdir
);
1494 newdir
= alloca (MAXPATHLEN
+ 1);
1497 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1504 /* Strip off drive name from prefix, if present. */
1505 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1511 /* Keep only a prefix from newdir if nm starts with slash
1512 (//server/share for UNC, nothing otherwise). */
1513 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1516 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1518 newdir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1520 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1522 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1534 /* Get rid of any slash at the end of newdir, unless newdir is
1535 just / or // (an incomplete UNC name). */
1536 length
= strlen (newdir
);
1537 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1539 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1543 unsigned char *temp
= (unsigned char *) alloca (length
);
1544 bcopy (newdir
, temp
, length
- 1);
1545 temp
[length
- 1] = 0;
1553 /* Now concatenate the directory and name to new space in the stack frame */
1554 tlen
+= strlen (nm
) + 1;
1556 /* Reserve space for drive specifier and escape prefix, since either
1557 or both may need to be inserted. (The Microsoft x86 compiler
1558 produces incorrect code if the following two lines are combined.) */
1559 target
= (unsigned char *) alloca (tlen
+ 4);
1561 #else /* not DOS_NT */
1562 target
= (unsigned char *) alloca (tlen
);
1563 #endif /* not DOS_NT */
1569 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1572 /* If newdir is effectively "C:/", then the drive letter will have
1573 been stripped and newdir will be "/". Concatenating with an
1574 absolute directory in nm produces "//", which will then be
1575 incorrectly treated as a network share. Ignore newdir in
1576 this case (keeping the drive letter). */
1577 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1578 && newdir
[1] == '\0'))
1580 strcpy (target
, newdir
);
1584 file_name_as_directory (target
, newdir
);
1587 strcat (target
, nm
);
1589 if (index (target
, '/'))
1590 strcpy (target
, sys_translate_unix (target
));
1593 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1595 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1604 if (*p
!= ']' && *p
!= '>' && *p
!= '-')
1610 else if ((p
[0] == ']' || p
[0] == '>') && p
[0] == p
[1] + 2)
1611 /* brackets are offset from each other by 2 */
1614 if (*p
!= '.' && *p
!= '-' && o
[-1] != '.')
1615 /* convert [foo][bar] to [bar] */
1616 while (o
[-1] != '[' && o
[-1] != '<')
1618 else if (*p
== '-' && *o
!= '.')
1621 else if (p
[0] == '-' && o
[-1] == '.' &&
1622 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>'))
1623 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1627 while (o
[-1] != '.' && o
[-1] != '[' && o
[-1] != '<');
1628 if (p
[1] == '.') /* foo.-.bar ==> bar. */
1630 else if (o
[-1] == '.') /* '.foo.-]' ==> ']' */
1632 /* else [foo.-] ==> [-] */
1636 #ifdef NO_HYPHENS_IN_FILENAMES
1638 o
[-1] != '[' && o
[-1] != '<' && o
[-1] != '.' &&
1639 p
[1] != ']' && p
[1] != '>' && p
[1] != '.')
1641 #endif /* NO_HYPHENS_IN_FILENAMES */
1645 if (!IS_DIRECTORY_SEP (*p
))
1649 else if (IS_DIRECTORY_SEP (p
[0])
1651 && (IS_DIRECTORY_SEP (p
[2])
1654 /* If "/." is the entire filename, keep the "/". Otherwise,
1655 just delete the whole "/.". */
1656 if (o
== target
&& p
[2] == '\0')
1660 else if (IS_DIRECTORY_SEP (p
[0]) && p
[1] == '.' && p
[2] == '.'
1661 /* `/../' is the "superroot" on certain file systems.
1662 Turned off on DOS_NT systems because they have no
1663 "superroot" and because this causes us to produce
1664 file names like "d:/../foo" which fail file-related
1665 functions of the underlying OS. (To reproduce, try a
1666 long series of "../../" in default_directory, longer
1667 than the number of levels from the root.) */
1671 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1673 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1675 /* Keep initial / only if this is the whole name. */
1676 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1681 && IS_DIRECTORY_SEP (p
[0]) && IS_DIRECTORY_SEP (p
[1]))
1683 /* Collapse multiple `/' in a row. */
1685 while (IS_DIRECTORY_SEP (*p
))
1692 #endif /* not VMS */
1696 /* At last, set drive name. */
1698 /* Except for network file name. */
1699 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1700 #endif /* WINDOWSNT */
1702 if (!drive
) abort ();
1704 target
[0] = DRIVE_LETTER (drive
);
1707 /* Reinsert the escape prefix if required. */
1714 CORRECT_DIR_SEPS (target
);
1717 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1719 /* Again look to see if the file name has special constructs in it
1720 and perhaps call the corresponding file handler. This is needed
1721 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1722 the ".." component gives us "/user@host:/bar/../baz" which needs
1723 to be expanded again. */
1724 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1725 if (!NILP (handler
))
1726 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1732 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1733 This is the old version of expand-file-name, before it was thoroughly
1734 rewritten for Emacs 10.31. We leave this version here commented-out,
1735 because the code is very complex and likely to have subtle bugs. If
1736 bugs _are_ found, it might be of interest to look at the old code and
1737 see what did it do in the relevant situation.
1739 Don't remove this code: it's true that it will be accessible via CVS,
1740 but a few years from deletion, people will forget it is there. */
1742 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1743 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1744 "Convert FILENAME to absolute, and canonicalize it.\n\
1745 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1746 \(does not start with slash); if DEFAULT is nil or missing,\n\
1747 the current buffer's value of default-directory is used.\n\
1748 Filenames containing `.' or `..' as components are simplified;\n\
1749 initial `~/' expands to your home directory.\n\
1750 See also the function `substitute-in-file-name'.")
1752 Lisp_Object name
, defalt
;
1756 register unsigned char *newdir
, *p
, *o
;
1758 unsigned char *target
;
1762 unsigned char * colon
= 0;
1763 unsigned char * close
= 0;
1764 unsigned char * slash
= 0;
1765 unsigned char * brack
= 0;
1766 int lbrack
= 0, rbrack
= 0;
1770 CHECK_STRING (name
);
1773 /* Filenames on VMS are always upper case. */
1774 name
= Fupcase (name
);
1779 /* If nm is absolute, flush ...// and detect /./ and /../.
1780 If no /./ or /../ we can return right away. */
1792 if (p
[0] == '/' && p
[1] == '/'
1794 /* // at start of filename is meaningful on Apollo system. */
1799 if (p
[0] == '/' && p
[1] == '~')
1800 nm
= p
+ 1, lose
= 1;
1801 if (p
[0] == '/' && p
[1] == '.'
1802 && (p
[2] == '/' || p
[2] == 0
1803 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1809 /* if dev:[dir]/, move nm to / */
1810 if (!slash
&& p
> nm
&& (brack
|| colon
)) {
1811 nm
= (brack
? brack
+ 1 : colon
+ 1);
1812 lbrack
= rbrack
= 0;
1820 /* VMS pre V4.4,convert '-'s in filenames. */
1821 if (lbrack
== rbrack
)
1823 if (dots
< 2) /* this is to allow negative version numbers */
1828 if (lbrack
> rbrack
&&
1829 ((p
[-1] == '.' || p
[-1] == '[' || p
[-1] == '<') &&
1830 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>')))
1836 /* count open brackets, reset close bracket pointer */
1837 if (p
[0] == '[' || p
[0] == '<')
1838 lbrack
++, brack
= 0;
1839 /* count close brackets, set close bracket pointer */
1840 if (p
[0] == ']' || p
[0] == '>')
1841 rbrack
++, brack
= p
;
1842 /* detect ][ or >< */
1843 if ((p
[0] == ']' || p
[0] == '>') && (p
[1] == '[' || p
[1] == '<'))
1845 if ((p
[0] == ':' || p
[0] == ']' || p
[0] == '>') && p
[1] == '~')
1846 nm
= p
+ 1, lose
= 1;
1847 if (p
[0] == ':' && (colon
|| slash
))
1848 /* if dev1:[dir]dev2:, move nm to dev2: */
1854 /* If /name/dev:, move nm to dev: */
1857 /* If node::dev:, move colon following dev */
1858 else if (colon
&& colon
[-1] == ':')
1860 /* If dev1:dev2:, move nm to dev2: */
1861 else if (colon
&& colon
[-1] != ':')
1866 if (p
[0] == ':' && !colon
)
1872 if (lbrack
== rbrack
)
1875 else if (p
[0] == '.')
1883 if (index (nm
, '/'))
1884 return build_string (sys_translate_unix (nm
));
1886 if (nm
== SDATA (name
))
1888 return build_string (nm
);
1892 /* Now determine directory to start with and put it in NEWDIR */
1896 if (nm
[0] == '~') /* prefix ~ */
1901 || nm
[1] == 0)/* ~/filename */
1903 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1904 newdir
= (unsigned char *) "";
1907 nm
++; /* Don't leave the slash in nm. */
1910 else /* ~user/filename */
1912 /* Get past ~ to user */
1913 unsigned char *user
= nm
+ 1;
1914 /* Find end of name. */
1915 unsigned char *ptr
= (unsigned char *) index (user
, '/');
1916 int len
= ptr
? ptr
- user
: strlen (user
);
1918 unsigned char *ptr1
= index (user
, ':');
1919 if (ptr1
!= 0 && ptr1
- user
< len
)
1922 /* Copy the user name into temp storage. */
1923 o
= (unsigned char *) alloca (len
+ 1);
1924 bcopy ((char *) user
, o
, len
);
1927 /* Look up the user name. */
1928 pw
= (struct passwd
*) getpwnam (o
+ 1);
1930 error ("\"%s\" isn't a registered user", o
+ 1);
1932 newdir
= (unsigned char *) pw
->pw_dir
;
1934 /* Discard the user name from NM. */
1941 #endif /* not VMS */
1945 defalt
= current_buffer
->directory
;
1946 CHECK_STRING (defalt
);
1947 newdir
= SDATA (defalt
);
1950 /* Now concatenate the directory and name to new space in the stack frame */
1952 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1953 target
= (unsigned char *) alloca (tlen
);
1959 if (nm
[0] == 0 || nm
[0] == '/')
1960 strcpy (target
, newdir
);
1963 file_name_as_directory (target
, newdir
);
1966 strcat (target
, nm
);
1968 if (index (target
, '/'))
1969 strcpy (target
, sys_translate_unix (target
));
1972 /* Now canonicalize by removing /. and /foo/.. if they appear */
1980 if (*p
!= ']' && *p
!= '>' && *p
!= '-')
1986 else if ((p
[0] == ']' || p
[0] == '>') && p
[0] == p
[1] + 2)
1987 /* brackets are offset from each other by 2 */
1990 if (*p
!= '.' && *p
!= '-' && o
[-1] != '.')
1991 /* convert [foo][bar] to [bar] */
1992 while (o
[-1] != '[' && o
[-1] != '<')
1994 else if (*p
== '-' && *o
!= '.')
1997 else if (p
[0] == '-' && o
[-1] == '.' &&
1998 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>'))
1999 /* flush .foo.- ; leave - if stopped by '[' or '<' */
2003 while (o
[-1] != '.' && o
[-1] != '[' && o
[-1] != '<');
2004 if (p
[1] == '.') /* foo.-.bar ==> bar. */
2006 else if (o
[-1] == '.') /* '.foo.-]' ==> ']' */
2008 /* else [foo.-] ==> [-] */
2014 o
[-1] != '[' && o
[-1] != '<' && o
[-1] != '.' &&
2015 p
[1] != ']' && p
[1] != '>' && p
[1] != '.')
2025 else if (!strncmp (p
, "//", 2)
2027 /* // at start of filename is meaningful in Apollo system. */
2035 else if (p
[0] == '/' && p
[1] == '.' &&
2036 (p
[2] == '/' || p
[2] == 0))
2038 else if (!strncmp (p
, "/..", 3)
2039 /* `/../' is the "superroot" on certain file systems. */
2041 && (p
[3] == '/' || p
[3] == 0))
2043 while (o
!= target
&& *--o
!= '/')
2046 if (o
== target
+ 1 && o
[-1] == '/' && o
[0] == '/')
2050 if (o
== target
&& *o
== '/')
2058 #endif /* not VMS */
2061 return make_string (target
, o
- target
);
2065 /* If /~ or // appears, discard everything through first slash. */
2067 file_name_absolute_p (filename
)
2068 const unsigned char *filename
;
2071 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
2073 /* ??? This criterion is probably wrong for '<'. */
2074 || index (filename
, ':') || index (filename
, '<')
2075 || (*filename
== '[' && (filename
[1] != '-'
2076 || (filename
[2] != '.' && filename
[2] != ']'))
2077 && filename
[1] != '.')
2080 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
2081 && IS_DIRECTORY_SEP (filename
[2]))
2086 static unsigned char *
2087 search_embedded_absfilename (nm
, endp
)
2088 unsigned char *nm
, *endp
;
2090 unsigned char *p
, *s
;
2092 for (p
= nm
+ 1; p
< endp
; p
++)
2096 || p
[-1] == ':' || p
[-1] == ']' || p
[-1] == '>'
2098 || IS_DIRECTORY_SEP (p
[-1]))
2099 && file_name_absolute_p (p
)
2100 #if defined (APOLLO) || defined (WINDOWSNT) || defined(CYGWIN)
2101 /* // at start of file name is meaningful in Apollo,
2102 WindowsNT and Cygwin systems. */
2103 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
2104 #endif /* not (APOLLO || WINDOWSNT || CYGWIN) */
2107 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)
2112 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
2114 unsigned char *o
= alloca (s
- p
+ 1);
2116 bcopy (p
, o
, s
- p
);
2119 /* If we have ~user and `user' exists, discard
2120 everything up to ~. But if `user' does not exist, leave
2121 ~user alone, it might be a literal file name. */
2122 if ((pw
= getpwnam (o
+ 1)))
2134 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
2135 Ssubstitute_in_file_name
, 1, 1, 0,
2136 doc
: /* Substitute environment variables referred to in FILENAME.
2137 `$FOO' where FOO is an environment variable name means to substitute
2138 the value of that variable. The variable name should be terminated
2139 with a character not a letter, digit or underscore; otherwise, enclose
2140 the entire variable name in braces.
2141 If `/~' appears, all of FILENAME through that `/' is discarded.
2143 On VMS, `$' substitution is not done; this function does little and only
2144 duplicates what `expand-file-name' does. */)
2146 Lisp_Object filename
;
2150 register unsigned char *s
, *p
, *o
, *x
, *endp
;
2151 unsigned char *target
= NULL
;
2153 int substituted
= 0;
2155 Lisp_Object handler
;
2157 CHECK_STRING (filename
);
2159 /* If the file name has special constructs in it,
2160 call the corresponding file handler. */
2161 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
2162 if (!NILP (handler
))
2163 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
2165 nm
= SDATA (filename
);
2167 nm
= strcpy (alloca (strlen (nm
) + 1), nm
);
2168 CORRECT_DIR_SEPS (nm
);
2169 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
2171 endp
= nm
+ SBYTES (filename
);
2173 /* If /~ or // appears, discard everything through first slash. */
2174 p
= search_embedded_absfilename (nm
, endp
);
2176 /* Start over with the new string, so we check the file-name-handler
2177 again. Important with filenames like "/home/foo//:/hello///there"
2178 which whould substitute to "/:/hello///there" rather than "/there". */
2179 return Fsubstitute_in_file_name
2180 (make_specified_string (p
, -1, endp
- p
,
2181 STRING_MULTIBYTE (filename
)));
2187 /* See if any variables are substituted into the string
2188 and find the total length of their values in `total' */
2190 for (p
= nm
; p
!= endp
;)
2200 /* "$$" means a single "$" */
2209 while (p
!= endp
&& *p
!= '}') p
++;
2210 if (*p
!= '}') goto missingclose
;
2216 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
2220 /* Copy out the variable name */
2221 target
= (unsigned char *) alloca (s
- o
+ 1);
2222 strncpy (target
, o
, s
- o
);
2225 strupr (target
); /* $home == $HOME etc. */
2228 /* Get variable value */
2229 o
= (unsigned char *) egetenv (target
);
2232 total
+= strlen (o
);
2242 /* If substitution required, recopy the string and do it */
2243 /* Make space in stack frame for the new copy */
2244 xnm
= (unsigned char *) alloca (SBYTES (filename
) + total
+ 1);
2247 /* Copy the rest of the name through, replacing $ constructs with values */
2264 while (p
!= endp
&& *p
!= '}') p
++;
2265 if (*p
!= '}') goto missingclose
;
2271 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
2275 /* Copy out the variable name */
2276 target
= (unsigned char *) alloca (s
- o
+ 1);
2277 strncpy (target
, o
, s
- o
);
2280 strupr (target
); /* $home == $HOME etc. */
2283 /* Get variable value */
2284 o
= (unsigned char *) egetenv (target
);
2288 strcpy (x
, target
); x
+= strlen (target
);
2290 else if (STRING_MULTIBYTE (filename
))
2292 /* If the original string is multibyte,
2293 convert what we substitute into multibyte. */
2296 int c
= unibyte_char_to_multibyte (*o
++);
2297 x
+= CHAR_STRING (c
, x
);
2309 /* If /~ or // appears, discard everything through first slash. */
2310 while ((p
= search_embedded_absfilename (xnm
, x
)))
2311 /* This time we do not start over because we've already expanded envvars
2312 and replaced $$ with $. Maybe we should start over as well, but we'd
2313 need to quote some $ to $$ first. */
2316 return make_specified_string (xnm
, -1, x
- xnm
, STRING_MULTIBYTE (filename
));
2319 error ("Bad format environment-variable substitution");
2321 error ("Missing \"}\" in environment-variable substitution");
2323 error ("Substituting nonexistent environment variable \"%s\"", target
);
2326 #endif /* not VMS */
2330 /* A slightly faster and more convenient way to get
2331 (directory-file-name (expand-file-name FOO)). */
2334 expand_and_dir_to_file (filename
, defdir
)
2335 Lisp_Object filename
, defdir
;
2337 register Lisp_Object absname
;
2339 absname
= Fexpand_file_name (filename
, defdir
);
2342 register int c
= SREF (absname
, SBYTES (absname
) - 1);
2343 if (c
== ':' || c
== ']' || c
== '>')
2344 absname
= Fdirectory_file_name (absname
);
2347 /* Remove final slash, if any (unless this is the root dir).
2348 stat behaves differently depending! */
2349 if (SCHARS (absname
) > 1
2350 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
2351 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
2352 /* We cannot take shortcuts; they might be wrong for magic file names. */
2353 absname
= Fdirectory_file_name (absname
);
2358 /* Signal an error if the file ABSNAME already exists.
2359 If INTERACTIVE is nonzero, ask the user whether to proceed,
2360 and bypass the error if the user says to go ahead.
2361 QUERYSTRING is a name for the action that is being considered
2364 *STATPTR is used to store the stat information if the file exists.
2365 If the file does not exist, STATPTR->st_mode is set to 0.
2366 If STATPTR is null, we don't store into it.
2368 If QUICK is nonzero, we ask for y or n, not yes or no. */
2371 barf_or_query_if_file_exists (absname
, querystring
, interactive
, statptr
, quick
)
2372 Lisp_Object absname
;
2373 unsigned char *querystring
;
2375 struct stat
*statptr
;
2378 register Lisp_Object tem
, encoded_filename
;
2379 struct stat statbuf
;
2380 struct gcpro gcpro1
;
2382 encoded_filename
= ENCODE_FILE (absname
);
2384 /* stat is a good way to tell whether the file exists,
2385 regardless of what access permissions it has. */
2386 if (lstat (SDATA (encoded_filename
), &statbuf
) >= 0)
2389 Fsignal (Qfile_already_exists
,
2390 Fcons (build_string ("File already exists"),
2391 Fcons (absname
, Qnil
)));
2393 tem
= format2 ("File %s already exists; %s anyway? ",
2394 absname
, build_string (querystring
));
2396 tem
= Fy_or_n_p (tem
);
2398 tem
= do_yes_or_no_p (tem
);
2401 Fsignal (Qfile_already_exists
,
2402 Fcons (build_string ("File already exists"),
2403 Fcons (absname
, Qnil
)));
2410 statptr
->st_mode
= 0;
2415 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 6,
2416 "fCopy file: \nGCopy %s to file: \np\nP",
2417 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
2418 If NEWNAME names a directory, copy FILE there.
2419 Signals a `file-already-exists' error if file NEWNAME already exists,
2420 unless a third argument OK-IF-ALREADY-EXISTS is supplied and non-nil.
2421 A number as third arg means request confirmation if NEWNAME already exists.
2422 This is what happens in interactive use with M-x.
2423 Always sets the file modes of the output file to match the input file.
2425 Fourth arg KEEP-TIME non-nil means give the output file the same
2426 last-modified time as the old one. (This works on only some systems.)
2428 A prefix arg makes KEEP-TIME non-nil.
2430 The optional fifth arg MUSTBENEW, if non-nil, insists on a check
2431 for an existing file with the same name. If MUSTBENEW is `excl',
2432 that means to get an error if the file already exists; never overwrite.
2433 If MUSTBENEW is neither nil nor `excl', that means ask for
2434 confirmation before overwriting, but do go ahead and overwrite the file
2435 if the user confirms.
2437 If PRESERVE-UID-GID is non-nil, we try to transfer the
2438 uid and gid of FILE to NEWNAME. */)
2439 (file
, newname
, ok_if_already_exists
, keep_time
, mustbenew
, preserve_uid_gid
)
2440 Lisp_Object file
, newname
, ok_if_already_exists
, keep_time
, mustbenew
;
2441 Lisp_Object preserve_uid_gid
;
2444 char buf
[16 * 1024];
2445 struct stat st
, out_st
;
2446 Lisp_Object handler
;
2447 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2448 int count
= SPECPDL_INDEX ();
2449 int input_file_statable_p
;
2450 Lisp_Object encoded_file
, encoded_newname
;
2452 encoded_file
= encoded_newname
= Qnil
;
2453 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2454 CHECK_STRING (file
);
2455 CHECK_STRING (newname
);
2457 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
2458 barf_or_query_if_file_exists (newname
, "overwrite", 1, 0, 1);
2460 if (!NILP (Ffile_directory_p (newname
)))
2461 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2463 newname
= Fexpand_file_name (newname
, Qnil
);
2465 file
= Fexpand_file_name (file
, Qnil
);
2467 /* If the input file name has special constructs in it,
2468 call the corresponding file handler. */
2469 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
2470 /* Likewise for output file name. */
2472 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
2473 if (!NILP (handler
))
2474 RETURN_UNGCPRO (call5 (handler
, Qcopy_file
, file
, newname
,
2475 ok_if_already_exists
, keep_time
));
2477 encoded_file
= ENCODE_FILE (file
);
2478 encoded_newname
= ENCODE_FILE (newname
);
2480 if (NILP (ok_if_already_exists
)
2481 || INTEGERP (ok_if_already_exists
))
2482 barf_or_query_if_file_exists (encoded_newname
, "copy to it",
2483 INTEGERP (ok_if_already_exists
), &out_st
, 0);
2484 else if (stat (SDATA (encoded_newname
), &out_st
) < 0)
2488 if (!CopyFile (SDATA (encoded_file
),
2489 SDATA (encoded_newname
),
2491 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
2492 /* CopyFile retains the timestamp by default. */
2493 else if (NILP (keep_time
))
2499 EMACS_GET_TIME (now
);
2500 filename
= SDATA (encoded_newname
);
2502 /* Ensure file is writable while its modified time is set. */
2503 attributes
= GetFileAttributes (filename
);
2504 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2505 if (set_file_times (filename
, now
, now
))
2507 /* Restore original attributes. */
2508 SetFileAttributes (filename
, attributes
);
2509 Fsignal (Qfile_date_error
,
2510 Fcons (build_string ("Cannot set file date"),
2511 Fcons (newname
, Qnil
)));
2513 /* Restore original attributes. */
2514 SetFileAttributes (filename
, attributes
);
2516 #else /* not WINDOWSNT */
2518 ifd
= emacs_open (SDATA (encoded_file
), O_RDONLY
, 0);
2522 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2524 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2526 /* We can only copy regular files and symbolic links. Other files are not
2528 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
2530 #if !defined (MSDOS) || __DJGPP__ > 1
2531 if (out_st
.st_mode
!= 0
2532 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2535 report_file_error ("Input and output files are the same",
2536 Fcons (file
, Fcons (newname
, Qnil
)));
2540 #if defined (S_ISREG) && defined (S_ISLNK)
2541 if (input_file_statable_p
)
2543 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
2545 #if defined (EISDIR)
2546 /* Get a better looking error message. */
2549 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2552 #endif /* S_ISREG && S_ISLNK */
2555 /* Create the copy file with the same record format as the input file */
2556 ofd
= sys_creat (SDATA (encoded_newname
), 0666, ifd
);
2559 /* System's default file type was set to binary by _fmode in emacs.c. */
2560 ofd
= emacs_open (SDATA (encoded_newname
),
2561 O_WRONLY
| O_TRUNC
| O_CREAT
2562 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
2563 S_IREAD
| S_IWRITE
);
2564 #else /* not MSDOS */
2565 ofd
= emacs_open (SDATA (encoded_newname
),
2566 O_WRONLY
| O_TRUNC
| O_CREAT
2567 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
2569 #endif /* not MSDOS */
2572 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2574 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2578 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2579 if (emacs_write (ofd
, buf
, n
) != n
)
2580 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2584 /* Preserve the original file modes, and if requested, also its
2586 if (input_file_statable_p
)
2588 if (! NILP (preserve_uid_gid
))
2589 fchown (ofd
, st
.st_uid
, st
.st_gid
);
2590 fchmod (ofd
, st
.st_mode
& 07777);
2592 #endif /* not MSDOS */
2594 /* Closing the output clobbers the file times on some systems. */
2595 if (emacs_close (ofd
) < 0)
2596 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2598 if (input_file_statable_p
)
2600 if (!NILP (keep_time
))
2602 EMACS_TIME atime
, mtime
;
2603 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
2604 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
2605 if (set_file_times (SDATA (encoded_newname
),
2607 Fsignal (Qfile_date_error
,
2608 Fcons (build_string ("Cannot set file date"),
2609 Fcons (newname
, Qnil
)));
2615 #if defined (__DJGPP__) && __DJGPP__ > 1
2616 if (input_file_statable_p
)
2618 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2619 and if it can't, it tells so. Otherwise, under MSDOS we usually
2620 get only the READ bit, which will make the copied file read-only,
2621 so it's better not to chmod at all. */
2622 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2623 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2625 #endif /* DJGPP version 2 or newer */
2626 #endif /* not WINDOWSNT */
2628 /* Discard the unwind protects. */
2629 specpdl_ptr
= specpdl
+ count
;
2635 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2636 Smake_directory_internal
, 1, 1, 0,
2637 doc
: /* Create a new directory named DIRECTORY. */)
2639 Lisp_Object directory
;
2641 const unsigned char *dir
;
2642 Lisp_Object handler
;
2643 Lisp_Object encoded_dir
;
2645 CHECK_STRING (directory
);
2646 directory
= Fexpand_file_name (directory
, Qnil
);
2648 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2649 if (!NILP (handler
))
2650 return call2 (handler
, Qmake_directory_internal
, directory
);
2652 encoded_dir
= ENCODE_FILE (directory
);
2654 dir
= SDATA (encoded_dir
);
2657 if (mkdir (dir
) != 0)
2659 if (mkdir (dir
, 0777) != 0)
2661 report_file_error ("Creating directory", Flist (1, &directory
));
2666 DEFUN ("delete-directory", Fdelete_directory
, Sdelete_directory
, 1, 1, "FDelete directory: ",
2667 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2669 Lisp_Object directory
;
2671 const unsigned char *dir
;
2672 Lisp_Object handler
;
2673 Lisp_Object encoded_dir
;
2675 CHECK_STRING (directory
);
2676 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2678 handler
= Ffind_file_name_handler (directory
, Qdelete_directory
);
2679 if (!NILP (handler
))
2680 return call2 (handler
, Qdelete_directory
, directory
);
2682 encoded_dir
= ENCODE_FILE (directory
);
2684 dir
= SDATA (encoded_dir
);
2686 if (rmdir (dir
) != 0)
2687 report_file_error ("Removing directory", Flist (1, &directory
));
2692 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 1, "fDelete file: ",
2693 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2694 If file has multiple names, it continues to exist with the other names. */)
2696 Lisp_Object filename
;
2698 Lisp_Object handler
;
2699 Lisp_Object encoded_file
;
2700 struct gcpro gcpro1
;
2703 if (!NILP (Ffile_directory_p (filename
))
2704 && NILP (Ffile_symlink_p (filename
)))
2705 Fsignal (Qfile_error
,
2706 Fcons (build_string ("Removing old name: is a directory"),
2707 Fcons (filename
, Qnil
)));
2709 filename
= Fexpand_file_name (filename
, Qnil
);
2711 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2712 if (!NILP (handler
))
2713 return call2 (handler
, Qdelete_file
, filename
);
2715 encoded_file
= ENCODE_FILE (filename
);
2717 if (0 > unlink (SDATA (encoded_file
)))
2718 report_file_error ("Removing old name", Flist (1, &filename
));
2723 internal_delete_file_1 (ignore
)
2729 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2732 internal_delete_file (filename
)
2733 Lisp_Object filename
;
2736 tem
= internal_condition_case_1 (Fdelete_file
, filename
,
2737 Qt
, internal_delete_file_1
);
2741 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2742 "fRename file: \nGRename %s to file: \np",
2743 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2744 If file has names other than FILE, it continues to have those names.
2745 Signals a `file-already-exists' error if a file NEWNAME already exists
2746 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2747 A number as third arg means request confirmation if NEWNAME already exists.
2748 This is what happens in interactive use with M-x. */)
2749 (file
, newname
, ok_if_already_exists
)
2750 Lisp_Object file
, newname
, ok_if_already_exists
;
2753 Lisp_Object args
[2];
2755 Lisp_Object handler
;
2756 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2757 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2759 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2760 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2761 CHECK_STRING (file
);
2762 CHECK_STRING (newname
);
2763 file
= Fexpand_file_name (file
, Qnil
);
2765 if (!NILP (Ffile_directory_p (newname
)))
2766 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2768 newname
= Fexpand_file_name (newname
, Qnil
);
2770 /* If the file name has special constructs in it,
2771 call the corresponding file handler. */
2772 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2774 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2775 if (!NILP (handler
))
2776 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2777 file
, newname
, ok_if_already_exists
));
2779 encoded_file
= ENCODE_FILE (file
);
2780 encoded_newname
= ENCODE_FILE (newname
);
2783 /* If the file names are identical but for the case, don't ask for
2784 confirmation: they simply want to change the letter-case of the
2786 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2788 if (NILP (ok_if_already_exists
)
2789 || INTEGERP (ok_if_already_exists
))
2790 barf_or_query_if_file_exists (encoded_newname
, "rename to it",
2791 INTEGERP (ok_if_already_exists
), 0, 0);
2793 if (0 > rename (SDATA (encoded_file
), SDATA (encoded_newname
)))
2795 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
))
2796 || 0 > unlink (SDATA (encoded_file
)))
2802 symlink_target
= Ffile_symlink_p (file
);
2803 if (! NILP (symlink_target
))
2804 Fmake_symbolic_link (symlink_target
, newname
,
2805 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2808 Fcopy_file (file
, newname
,
2809 /* We have already prompted if it was an integer,
2810 so don't have copy-file prompt again. */
2811 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2814 Fdelete_file (file
);
2821 report_file_error ("Renaming", Flist (2, args
));
2824 report_file_error ("Renaming", Flist (2, &file
));
2831 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2832 "fAdd name to file: \nGName to add to %s: \np",
2833 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2834 Signals a `file-already-exists' error if a file NEWNAME already exists
2835 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2836 A number as third arg means request confirmation if NEWNAME already exists.
2837 This is what happens in interactive use with M-x. */)
2838 (file
, newname
, ok_if_already_exists
)
2839 Lisp_Object file
, newname
, ok_if_already_exists
;
2842 Lisp_Object args
[2];
2844 Lisp_Object handler
;
2845 Lisp_Object encoded_file
, encoded_newname
;
2846 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2848 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2849 encoded_file
= encoded_newname
= Qnil
;
2850 CHECK_STRING (file
);
2851 CHECK_STRING (newname
);
2852 file
= Fexpand_file_name (file
, Qnil
);
2854 if (!NILP (Ffile_directory_p (newname
)))
2855 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2857 newname
= Fexpand_file_name (newname
, Qnil
);
2859 /* If the file name has special constructs in it,
2860 call the corresponding file handler. */
2861 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2862 if (!NILP (handler
))
2863 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2864 newname
, ok_if_already_exists
));
2866 /* If the new name has special constructs in it,
2867 call the corresponding file handler. */
2868 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2869 if (!NILP (handler
))
2870 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2871 newname
, ok_if_already_exists
));
2873 encoded_file
= ENCODE_FILE (file
);
2874 encoded_newname
= ENCODE_FILE (newname
);
2876 if (NILP (ok_if_already_exists
)
2877 || INTEGERP (ok_if_already_exists
))
2878 barf_or_query_if_file_exists (encoded_newname
, "make it a new name",
2879 INTEGERP (ok_if_already_exists
), 0, 0);
2881 unlink (SDATA (newname
));
2882 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
)))
2887 report_file_error ("Adding new name", Flist (2, args
));
2889 report_file_error ("Adding new name", Flist (2, &file
));
2898 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2899 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2900 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2901 Both args must be strings.
2902 Signals a `file-already-exists' error if a file LINKNAME already exists
2903 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2904 A number as third arg means request confirmation if LINKNAME already exists.
2905 This happens for interactive use with M-x. */)
2906 (filename
, linkname
, ok_if_already_exists
)
2907 Lisp_Object filename
, linkname
, ok_if_already_exists
;
2910 Lisp_Object args
[2];
2912 Lisp_Object handler
;
2913 Lisp_Object encoded_filename
, encoded_linkname
;
2914 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2916 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2917 encoded_filename
= encoded_linkname
= Qnil
;
2918 CHECK_STRING (filename
);
2919 CHECK_STRING (linkname
);
2920 /* If the link target has a ~, we must expand it to get
2921 a truly valid file name. Otherwise, do not expand;
2922 we want to permit links to relative file names. */
2923 if (SREF (filename
, 0) == '~')
2924 filename
= Fexpand_file_name (filename
, Qnil
);
2926 if (!NILP (Ffile_directory_p (linkname
)))
2927 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2929 linkname
= Fexpand_file_name (linkname
, Qnil
);
2931 /* If the file name has special constructs in it,
2932 call the corresponding file handler. */
2933 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2934 if (!NILP (handler
))
2935 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2936 linkname
, ok_if_already_exists
));
2938 /* If the new link name has special constructs in it,
2939 call the corresponding file handler. */
2940 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2941 if (!NILP (handler
))
2942 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2943 linkname
, ok_if_already_exists
));
2945 encoded_filename
= ENCODE_FILE (filename
);
2946 encoded_linkname
= ENCODE_FILE (linkname
);
2948 if (NILP (ok_if_already_exists
)
2949 || INTEGERP (ok_if_already_exists
))
2950 barf_or_query_if_file_exists (encoded_linkname
, "make it a link",
2951 INTEGERP (ok_if_already_exists
), 0, 0);
2952 if (0 > symlink (SDATA (encoded_filename
),
2953 SDATA (encoded_linkname
)))
2955 /* If we didn't complain already, silently delete existing file. */
2956 if (errno
== EEXIST
)
2958 unlink (SDATA (encoded_linkname
));
2959 if (0 <= symlink (SDATA (encoded_filename
),
2960 SDATA (encoded_linkname
)))
2970 report_file_error ("Making symbolic link", Flist (2, args
));
2972 report_file_error ("Making symbolic link", Flist (2, &filename
));
2978 #endif /* S_IFLNK */
2982 DEFUN ("define-logical-name", Fdefine_logical_name
, Sdefine_logical_name
,
2983 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2984 doc
: /* Define the job-wide logical name NAME to have the value STRING.
2985 If STRING is nil or a null string, the logical name NAME is deleted. */)
2990 CHECK_STRING (name
);
2992 delete_logical_name (SDATA (name
));
2995 CHECK_STRING (string
);
2997 if (SCHARS (string
) == 0)
2998 delete_logical_name (SDATA (name
));
3000 define_logical_name (SDATA (name
), SDATA (string
));
3009 DEFUN ("sysnetunam", Fsysnetunam
, Ssysnetunam
, 2, 2, 0,
3010 doc
: /* Open a network connection to PATH using LOGIN as the login string. */)
3012 Lisp_Object path
, login
;
3016 CHECK_STRING (path
);
3017 CHECK_STRING (login
);
3019 netresult
= netunam (SDATA (path
), SDATA (login
));
3021 if (netresult
== -1)
3026 #endif /* HPUX_NET */
3028 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
3030 doc
: /* Return t if file FILENAME specifies an absolute file name.
3031 On Unix, this is a name starting with a `/' or a `~'. */)
3033 Lisp_Object filename
;
3035 CHECK_STRING (filename
);
3036 return file_name_absolute_p (SDATA (filename
)) ? Qt
: Qnil
;
3039 /* Return nonzero if file FILENAME exists and can be executed. */
3042 check_executable (filename
)
3046 int len
= strlen (filename
);
3049 if (stat (filename
, &st
) < 0)
3051 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
3052 return ((st
.st_mode
& S_IEXEC
) != 0);
3054 return (S_ISREG (st
.st_mode
)
3056 && (stricmp ((suffix
= filename
+ len
-4), ".com") == 0
3057 || stricmp (suffix
, ".exe") == 0
3058 || stricmp (suffix
, ".bat") == 0)
3059 || (st
.st_mode
& S_IFMT
) == S_IFDIR
);
3060 #endif /* not WINDOWSNT */
3061 #else /* not DOS_NT */
3062 #ifdef HAVE_EUIDACCESS
3063 return (euidaccess (filename
, 1) >= 0);
3065 /* Access isn't quite right because it uses the real uid
3066 and we really want to test with the effective uid.
3067 But Unix doesn't give us a right way to do it. */
3068 return (access (filename
, 1) >= 0);
3070 #endif /* not DOS_NT */
3073 /* Return nonzero if file FILENAME exists and can be written. */
3076 check_writable (filename
)
3081 if (stat (filename
, &st
) < 0)
3083 return (st
.st_mode
& S_IWRITE
|| (st
.st_mode
& S_IFMT
) == S_IFDIR
);
3084 #else /* not MSDOS */
3085 #ifdef HAVE_EUIDACCESS
3086 return (euidaccess (filename
, 2) >= 0);
3088 /* Access isn't quite right because it uses the real uid
3089 and we really want to test with the effective uid.
3090 But Unix doesn't give us a right way to do it.
3091 Opening with O_WRONLY could work for an ordinary file,
3092 but would lose for directories. */
3093 return (access (filename
, 2) >= 0);
3095 #endif /* not MSDOS */
3098 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
3099 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
3100 See also `file-readable-p' and `file-attributes'.
3101 This returns nil for a symlink to a nonexistent file.
3102 Use `file-symlink-p' to test for such links. */)
3104 Lisp_Object filename
;
3106 Lisp_Object absname
;
3107 Lisp_Object handler
;
3108 struct stat statbuf
;
3110 CHECK_STRING (filename
);
3111 absname
= Fexpand_file_name (filename
, Qnil
);
3113 /* If the file name has special constructs in it,
3114 call the corresponding file handler. */
3115 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
3116 if (!NILP (handler
))
3117 return call2 (handler
, Qfile_exists_p
, absname
);
3119 absname
= ENCODE_FILE (absname
);
3121 return (stat (SDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
3124 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
3125 doc
: /* Return t if FILENAME can be executed by you.
3126 For a directory, this means you can access files in that directory. */)
3128 Lisp_Object filename
;
3130 Lisp_Object absname
;
3131 Lisp_Object handler
;
3133 CHECK_STRING (filename
);
3134 absname
= Fexpand_file_name (filename
, Qnil
);
3136 /* If the file name has special constructs in it,
3137 call the corresponding file handler. */
3138 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
3139 if (!NILP (handler
))
3140 return call2 (handler
, Qfile_executable_p
, absname
);
3142 absname
= ENCODE_FILE (absname
);
3144 return (check_executable (SDATA (absname
)) ? Qt
: Qnil
);
3147 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
3148 doc
: /* Return t if file FILENAME exists and you can read it.
3149 See also `file-exists-p' and `file-attributes'. */)
3151 Lisp_Object filename
;
3153 Lisp_Object absname
;
3154 Lisp_Object handler
;
3157 struct stat statbuf
;
3159 CHECK_STRING (filename
);
3160 absname
= Fexpand_file_name (filename
, Qnil
);
3162 /* If the file name has special constructs in it,
3163 call the corresponding file handler. */
3164 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
3165 if (!NILP (handler
))
3166 return call2 (handler
, Qfile_readable_p
, absname
);
3168 absname
= ENCODE_FILE (absname
);
3170 #if defined(DOS_NT) || defined(macintosh)
3171 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3173 if (access (SDATA (absname
), 0) == 0)
3176 #else /* not DOS_NT and not macintosh */
3178 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3179 /* Opening a fifo without O_NONBLOCK can wait.
3180 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3181 except in the case of a fifo, on a system which handles it. */
3182 desc
= stat (SDATA (absname
), &statbuf
);
3185 if (S_ISFIFO (statbuf
.st_mode
))
3186 flags
|= O_NONBLOCK
;
3188 desc
= emacs_open (SDATA (absname
), flags
, 0);
3193 #endif /* not DOS_NT and not macintosh */
3196 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3198 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
3199 doc
: /* Return t if file FILENAME can be written or created by you. */)
3201 Lisp_Object filename
;
3203 Lisp_Object absname
, dir
, encoded
;
3204 Lisp_Object handler
;
3205 struct stat statbuf
;
3207 CHECK_STRING (filename
);
3208 absname
= Fexpand_file_name (filename
, Qnil
);
3210 /* If the file name has special constructs in it,
3211 call the corresponding file handler. */
3212 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
3213 if (!NILP (handler
))
3214 return call2 (handler
, Qfile_writable_p
, absname
);
3216 encoded
= ENCODE_FILE (absname
);
3217 if (stat (SDATA (encoded
), &statbuf
) >= 0)
3218 return (check_writable (SDATA (encoded
))
3221 dir
= Ffile_name_directory (absname
);
3224 dir
= Fdirectory_file_name (dir
);
3228 dir
= Fdirectory_file_name (dir
);
3231 dir
= ENCODE_FILE (dir
);
3233 /* The read-only attribute of the parent directory doesn't affect
3234 whether a file or directory can be created within it. Some day we
3235 should check ACLs though, which do affect this. */
3236 if (stat (SDATA (dir
), &statbuf
) < 0)
3238 return (statbuf
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
3240 return (check_writable (!NILP (dir
) ? (char *) SDATA (dir
) : "")
3245 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
3246 doc
: /* Access file FILENAME, and get an error if that does not work.
3247 The second argument STRING is used in the error message.
3248 If there is no error, returns nil. */)
3250 Lisp_Object filename
, string
;
3252 Lisp_Object handler
, encoded_filename
, absname
;
3255 CHECK_STRING (filename
);
3256 absname
= Fexpand_file_name (filename
, Qnil
);
3258 CHECK_STRING (string
);
3260 /* If the file name has special constructs in it,
3261 call the corresponding file handler. */
3262 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
3263 if (!NILP (handler
))
3264 return call3 (handler
, Qaccess_file
, absname
, string
);
3266 encoded_filename
= ENCODE_FILE (absname
);
3268 fd
= emacs_open (SDATA (encoded_filename
), O_RDONLY
, 0);
3270 report_file_error (SDATA (string
), Fcons (filename
, Qnil
));
3276 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
3277 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
3278 The value is the link target, as a string.
3279 Otherwise it returns nil.
3281 This function returns t when given the name of a symlink that
3282 points to a nonexistent file. */)
3284 Lisp_Object filename
;
3286 Lisp_Object handler
;
3288 CHECK_STRING (filename
);
3289 filename
= Fexpand_file_name (filename
, Qnil
);
3291 /* If the file name has special constructs in it,
3292 call the corresponding file handler. */
3293 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
3294 if (!NILP (handler
))
3295 return call2 (handler
, Qfile_symlink_p
, filename
);
3304 filename
= ENCODE_FILE (filename
);
3311 buf
= (char *) xrealloc (buf
, bufsize
);
3312 bzero (buf
, bufsize
);
3315 valsize
= readlink (SDATA (filename
), buf
, bufsize
);
3319 /* HP-UX reports ERANGE if buffer is too small. */
3320 if (errno
== ERANGE
)
3330 while (valsize
>= bufsize
);
3332 val
= make_string (buf
, valsize
);
3333 if (buf
[0] == '/' && index (buf
, ':'))
3334 val
= concat2 (build_string ("/:"), val
);
3336 val
= DECODE_FILE (val
);
3339 #else /* not S_IFLNK */
3341 #endif /* not S_IFLNK */
3344 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
3345 doc
: /* Return t if FILENAME names an existing directory.
3346 Symbolic links to directories count as directories.
3347 See `file-symlink-p' to distinguish symlinks. */)
3349 Lisp_Object filename
;
3351 register Lisp_Object absname
;
3353 Lisp_Object handler
;
3355 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3357 /* If the file name has special constructs in it,
3358 call the corresponding file handler. */
3359 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
3360 if (!NILP (handler
))
3361 return call2 (handler
, Qfile_directory_p
, absname
);
3363 absname
= ENCODE_FILE (absname
);
3365 if (stat (SDATA (absname
), &st
) < 0)
3367 return (st
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
3370 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
3371 doc
: /* Return t if file FILENAME names a directory you can open.
3372 For the value to be t, FILENAME must specify the name of a directory as a file,
3373 and the directory must allow you to open files in it. In order to use a
3374 directory as a buffer's current directory, this predicate must return true.
3375 A directory name spec may be given instead; then the value is t
3376 if the directory so specified exists and really is a readable and
3377 searchable directory. */)
3379 Lisp_Object filename
;
3381 Lisp_Object handler
;
3383 struct gcpro gcpro1
;
3385 /* If the file name has special constructs in it,
3386 call the corresponding file handler. */
3387 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
3388 if (!NILP (handler
))
3389 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
3392 tem
= (NILP (Ffile_directory_p (filename
))
3393 || NILP (Ffile_executable_p (filename
)));
3395 return tem
? Qnil
: Qt
;
3398 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
3399 doc
: /* Return t if FILENAME names a regular file.
3400 This is the sort of file that holds an ordinary stream of data bytes.
3401 Symbolic links to regular files count as regular files.
3402 See `file-symlink-p' to distinguish symlinks. */)
3404 Lisp_Object filename
;
3406 register Lisp_Object absname
;
3408 Lisp_Object handler
;
3410 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3412 /* If the file name has special constructs in it,
3413 call the corresponding file handler. */
3414 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
3415 if (!NILP (handler
))
3416 return call2 (handler
, Qfile_regular_p
, absname
);
3418 absname
= ENCODE_FILE (absname
);
3423 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3425 /* Tell stat to use expensive method to get accurate info. */
3426 Vw32_get_true_file_attributes
= Qt
;
3427 result
= stat (SDATA (absname
), &st
);
3428 Vw32_get_true_file_attributes
= tem
;
3432 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
3435 if (stat (SDATA (absname
), &st
) < 0)
3437 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
3441 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3442 doc
: /* Return mode bits of file named FILENAME, as an integer.
3443 Return nil, if file does not exist or is not accessible. */)
3445 Lisp_Object filename
;
3447 Lisp_Object absname
;
3449 Lisp_Object handler
;
3451 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3453 /* If the file name has special constructs in it,
3454 call the corresponding file handler. */
3455 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3456 if (!NILP (handler
))
3457 return call2 (handler
, Qfile_modes
, absname
);
3459 absname
= ENCODE_FILE (absname
);
3461 if (stat (SDATA (absname
), &st
) < 0)
3463 #if defined (MSDOS) && __DJGPP__ < 2
3464 if (check_executable (SDATA (absname
)))
3465 st
.st_mode
|= S_IEXEC
;
3466 #endif /* MSDOS && __DJGPP__ < 2 */
3468 return make_number (st
.st_mode
& 07777);
3471 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2, 0,
3472 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3473 Only the 12 low bits of MODE are used. */)
3475 Lisp_Object filename
, mode
;
3477 Lisp_Object absname
, encoded_absname
;
3478 Lisp_Object handler
;
3480 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
3481 CHECK_NUMBER (mode
);
3483 /* If the file name has special constructs in it,
3484 call the corresponding file handler. */
3485 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3486 if (!NILP (handler
))
3487 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3489 encoded_absname
= ENCODE_FILE (absname
);
3491 if (chmod (SDATA (encoded_absname
), XINT (mode
)) < 0)
3492 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3497 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3498 doc
: /* Set the file permission bits for newly created files.
3499 The argument MODE should be an integer; only the low 9 bits are used.
3500 This setting is inherited by subprocesses. */)
3504 CHECK_NUMBER (mode
);
3506 umask ((~ XINT (mode
)) & 0777);
3511 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3512 doc
: /* Return the default file protection for created files.
3513 The value is an integer. */)
3519 realmask
= umask (0);
3522 XSETINT (value
, (~ realmask
) & 0777);
3526 extern int lisp_time_argument
P_ ((Lisp_Object
, time_t *, int *));
3528 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3529 doc
: /* Set times of file FILENAME to TIME.
3530 Set both access and modification times.
3531 Return t on success, else nil.
3532 Use the current time if TIME is nil. TIME is in the format of
3535 Lisp_Object filename
, time
;
3537 Lisp_Object absname
, encoded_absname
;
3538 Lisp_Object handler
;
3542 if (! lisp_time_argument (time
, &sec
, &usec
))
3543 error ("Invalid time specification");
3545 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
3547 /* If the file name has special constructs in it,
3548 call the corresponding file handler. */
3549 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3550 if (!NILP (handler
))
3551 return call3 (handler
, Qset_file_times
, absname
, time
);
3553 encoded_absname
= ENCODE_FILE (absname
);
3558 EMACS_SET_SECS (t
, sec
);
3559 EMACS_SET_USECS (t
, usec
);
3561 if (set_file_times (SDATA (encoded_absname
), t
, t
))
3566 /* Setting times on a directory always fails. */
3567 if (stat (SDATA (encoded_absname
), &st
) == 0
3568 && (st
.st_mode
& S_IFMT
) == S_IFDIR
)
3571 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3584 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3585 doc
: /* Tell Unix to finish all pending disk updates. */)
3594 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3595 doc
: /* Return t if file FILE1 is newer than file FILE2.
3596 If FILE1 does not exist, the answer is nil;
3597 otherwise, if FILE2 does not exist, the answer is t. */)
3599 Lisp_Object file1
, file2
;
3601 Lisp_Object absname1
, absname2
;
3604 Lisp_Object handler
;
3605 struct gcpro gcpro1
, gcpro2
;
3607 CHECK_STRING (file1
);
3608 CHECK_STRING (file2
);
3611 GCPRO2 (absname1
, file2
);
3612 absname1
= expand_and_dir_to_file (file1
, current_buffer
->directory
);
3613 absname2
= expand_and_dir_to_file (file2
, current_buffer
->directory
);
3616 /* If the file name has special constructs in it,
3617 call the corresponding file handler. */
3618 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3620 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3621 if (!NILP (handler
))
3622 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3624 GCPRO2 (absname1
, absname2
);
3625 absname1
= ENCODE_FILE (absname1
);
3626 absname2
= ENCODE_FILE (absname2
);
3629 if (stat (SDATA (absname1
), &st
) < 0)
3632 mtime1
= st
.st_mtime
;
3634 if (stat (SDATA (absname2
), &st
) < 0)
3637 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3641 Lisp_Object Qfind_buffer_file_type
;
3644 #ifndef READ_BUF_SIZE
3645 #define READ_BUF_SIZE (64 << 10)
3648 extern void adjust_markers_for_delete
P_ ((int, int, int, int));
3650 /* This function is called after Lisp functions to decide a coding
3651 system are called, or when they cause an error. Before they are
3652 called, the current buffer is set unibyte and it contains only a
3653 newly inserted text (thus the buffer was empty before the
3656 The functions may set markers, overlays, text properties, or even
3657 alter the buffer contents, change the current buffer.
3659 Here, we reset all those changes by:
3660 o set back the current buffer.
3661 o move all markers and overlays to BEG.
3662 o remove all text properties.
3663 o set back the buffer multibyteness. */
3666 decide_coding_unwind (unwind_data
)
3667 Lisp_Object unwind_data
;
3669 Lisp_Object multibyte
, undo_list
, buffer
;
3671 multibyte
= XCAR (unwind_data
);
3672 unwind_data
= XCDR (unwind_data
);
3673 undo_list
= XCAR (unwind_data
);
3674 buffer
= XCDR (unwind_data
);
3676 if (current_buffer
!= XBUFFER (buffer
))
3677 set_buffer_internal (XBUFFER (buffer
));
3678 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3679 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3680 BUF_INTERVALS (current_buffer
) = 0;
3681 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3683 /* Now we are safe to change the buffer's multibyteness directly. */
3684 current_buffer
->enable_multibyte_characters
= multibyte
;
3685 current_buffer
->undo_list
= undo_list
;
3691 /* Used to pass values from insert-file-contents to read_non_regular. */
3693 static int non_regular_fd
;
3694 static int non_regular_inserted
;
3695 static int non_regular_nbytes
;
3698 /* Read from a non-regular file.
3699 Read non_regular_trytry bytes max from non_regular_fd.
3700 Non_regular_inserted specifies where to put the read bytes.
3701 Value is the number of bytes read. */
3710 nbytes
= emacs_read (non_regular_fd
,
3711 BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ non_regular_inserted
,
3712 non_regular_nbytes
);
3714 return make_number (nbytes
);
3718 /* Condition-case handler used when reading from non-regular files
3719 in insert-file-contents. */
3722 read_non_regular_quit ()
3728 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3730 doc
: /* Insert contents of file FILENAME after point.
3731 Returns list of absolute file name and number of characters inserted.
3732 If second argument VISIT is non-nil, the buffer's visited filename
3733 and last save file modtime are set, and it is marked unmodified.
3734 If visiting and the file does not exist, visiting is completed
3735 before the error is signaled.
3736 The optional third and fourth arguments BEG and END
3737 specify what portion of the file to insert.
3738 These arguments count bytes in the file, not characters in the buffer.
3739 If VISIT is non-nil, BEG and END must be nil.
3741 If optional fifth argument REPLACE is non-nil,
3742 it means replace the current buffer contents (in the accessible portion)
3743 with the file contents. This is better than simply deleting and inserting
3744 the whole thing because (1) it preserves some marker positions
3745 and (2) it puts less data in the undo list.
3746 When REPLACE is non-nil, the value is the number of characters actually read,
3747 which is often less than the number of characters to be read.
3749 This does code conversion according to the value of
3750 `coding-system-for-read' or `file-coding-system-alist',
3751 and sets the variable `last-coding-system-used' to the coding system
3753 (filename
, visit
, beg
, end
, replace
)
3754 Lisp_Object filename
, visit
, beg
, end
, replace
;
3759 register int how_much
;
3760 register int unprocessed
;
3761 int count
= SPECPDL_INDEX ();
3762 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3763 Lisp_Object handler
, val
, insval
, orig_filename
;
3766 int not_regular
= 0;
3767 unsigned char read_buf
[READ_BUF_SIZE
];
3768 struct coding_system coding
;
3769 unsigned char buffer
[1 << 14];
3770 int replace_handled
= 0;
3771 int set_coding_system
= 0;
3772 int coding_system_decided
= 0;
3774 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3775 int we_locked_file
= 0;
3777 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3778 error ("Cannot do file visiting in an indirect buffer");
3780 if (!NILP (current_buffer
->read_only
))
3781 Fbarf_if_buffer_read_only ();
3785 orig_filename
= Qnil
;
3787 GCPRO4 (filename
, val
, p
, orig_filename
);
3789 CHECK_STRING (filename
);
3790 filename
= Fexpand_file_name (filename
, Qnil
);
3792 /* If the file name has special constructs in it,
3793 call the corresponding file handler. */
3794 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3795 if (!NILP (handler
))
3797 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3798 visit
, beg
, end
, replace
);
3799 if (CONSP (val
) && CONSP (XCDR (val
)))
3800 inserted
= XINT (XCAR (XCDR (val
)));
3804 orig_filename
= filename
;
3805 filename
= ENCODE_FILE (filename
);
3811 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3813 /* Tell stat to use expensive method to get accurate info. */
3814 Vw32_get_true_file_attributes
= Qt
;
3815 total
= stat (SDATA (filename
), &st
);
3816 Vw32_get_true_file_attributes
= tem
;
3821 if (stat (SDATA (filename
), &st
) < 0)
3823 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0
3824 || fstat (fd
, &st
) < 0)
3825 #endif /* not APOLLO */
3826 #endif /* WINDOWSNT */
3828 if (fd
>= 0) emacs_close (fd
);
3831 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3834 if (!NILP (Vcoding_system_for_read
))
3835 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3840 /* This code will need to be changed in order to work on named
3841 pipes, and it's probably just not worth it. So we should at
3842 least signal an error. */
3843 if (!S_ISREG (st
.st_mode
))
3850 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3851 Fsignal (Qfile_error
,
3852 Fcons (build_string ("not a regular file"),
3853 Fcons (orig_filename
, Qnil
)));
3858 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0)
3861 /* Replacement should preserve point as it preserves markers. */
3862 if (!NILP (replace
))
3863 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3865 record_unwind_protect (close_file_unwind
, make_number (fd
));
3867 /* Supposedly happens on VMS. */
3868 /* Can happen on any platform that uses long as type of off_t, but allows
3869 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3870 give a message suitable for the latter case. */
3871 if (! not_regular
&& st
.st_size
< 0)
3872 error ("Maximum buffer size exceeded");
3874 /* Prevent redisplay optimizations. */
3875 current_buffer
->clip_changed
= 1;
3879 if (!NILP (beg
) || !NILP (end
))
3880 error ("Attempt to visit less than an entire file");
3881 if (BEG
< Z
&& NILP (replace
))
3882 error ("Cannot do file visiting in a non-empty buffer");
3888 XSETFASTINT (beg
, 0);
3896 XSETINT (end
, st
.st_size
);
3898 /* Arithmetic overflow can occur if an Emacs integer cannot
3899 represent the file size, or if the calculations below
3900 overflow. The calculations below double the file size
3901 twice, so check that it can be multiplied by 4 safely. */
3902 if (XINT (end
) != st
.st_size
3903 || ((int) st
.st_size
* 4) / 4 != st
.st_size
)
3904 error ("Maximum buffer size exceeded");
3906 /* The file size returned from stat may be zero, but data
3907 may be readable nonetheless, for example when this is a
3908 file in the /proc filesystem. */
3909 if (st
.st_size
== 0)
3910 XSETINT (end
, READ_BUF_SIZE
);
3914 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3916 /* We use emacs-mule for auto saving... */
3917 setup_coding_system (Qemacs_mule
, &coding
);
3918 /* ... but with the special flag to indicate to read in a
3919 multibyte sequence for eight-bit-control char as is. */
3921 coding
.src_multibyte
= 0;
3922 coding
.dst_multibyte
3923 = !NILP (current_buffer
->enable_multibyte_characters
);
3924 coding
.eol_type
= CODING_EOL_LF
;
3925 coding_system_decided
= 1;
3929 /* Decide the coding system to use for reading the file now
3930 because we can't use an optimized method for handling
3931 `coding:' tag if the current buffer is not empty. */
3935 if (!NILP (Vcoding_system_for_read
))
3936 val
= Vcoding_system_for_read
;
3939 /* Don't try looking inside a file for a coding system
3940 specification if it is not seekable. */
3941 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3943 /* Find a coding system specified in the heading two
3944 lines or in the tailing several lines of the file.
3945 We assume that the 1K-byte and 3K-byte for heading
3946 and tailing respectively are sufficient for this
3950 if (st
.st_size
<= (1024 * 4))
3951 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3954 nread
= emacs_read (fd
, read_buf
, 1024);
3957 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3958 report_file_error ("Setting file position",
3959 Fcons (orig_filename
, Qnil
));
3960 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3965 error ("IO error reading %s: %s",
3966 SDATA (orig_filename
), emacs_strerror (errno
));
3969 struct buffer
*prev
= current_buffer
;
3973 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3975 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3976 buf
= XBUFFER (buffer
);
3978 delete_all_overlays (buf
);
3979 buf
->directory
= current_buffer
->directory
;
3980 buf
->read_only
= Qnil
;
3981 buf
->filename
= Qnil
;
3982 buf
->undo_list
= Qt
;
3983 eassert (buf
->overlays_before
== NULL
);
3984 eassert (buf
->overlays_after
== NULL
);
3986 set_buffer_internal (buf
);
3988 buf
->enable_multibyte_characters
= Qnil
;
3990 insert_1_both (read_buf
, nread
, nread
, 0, 0, 0);
3991 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3992 val
= call2 (Vset_auto_coding_function
,
3993 filename
, make_number (nread
));
3994 set_buffer_internal (prev
);
3996 /* Discard the unwind protect for recovering the
4000 /* Rewind the file for the actual read done later. */
4001 if (lseek (fd
, 0, 0) < 0)
4002 report_file_error ("Setting file position",
4003 Fcons (orig_filename
, Qnil
));
4009 /* If we have not yet decided a coding system, check
4010 file-coding-system-alist. */
4011 Lisp_Object args
[6], coding_systems
;
4013 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4014 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
4015 coding_systems
= Ffind_operation_coding_system (6, args
);
4016 if (CONSP (coding_systems
))
4017 val
= XCAR (coding_systems
);
4021 setup_coding_system (Fcheck_coding_system (val
), &coding
);
4022 /* Ensure we set Vlast_coding_system_used. */
4023 set_coding_system
= 1;
4025 if (NILP (current_buffer
->enable_multibyte_characters
)
4027 /* We must suppress all character code conversion except for
4028 end-of-line conversion. */
4029 setup_raw_text_coding_system (&coding
);
4031 coding
.src_multibyte
= 0;
4032 coding
.dst_multibyte
4033 = !NILP (current_buffer
->enable_multibyte_characters
);
4034 coding_system_decided
= 1;
4037 /* If requested, replace the accessible part of the buffer
4038 with the file contents. Avoid replacing text at the
4039 beginning or end of the buffer that matches the file contents;
4040 that preserves markers pointing to the unchanged parts.
4042 Here we implement this feature in an optimized way
4043 for the case where code conversion is NOT needed.
4044 The following if-statement handles the case of conversion
4045 in a less optimal way.
4047 If the code conversion is "automatic" then we try using this
4048 method and hope for the best.
4049 But if we discover the need for conversion, we give up on this method
4050 and let the following if-statement handle the replace job. */
4053 && !(coding
.common_flags
& CODING_REQUIRE_DECODING_MASK
))
4055 /* same_at_start and same_at_end count bytes,
4056 because file access counts bytes
4057 and BEG and END count bytes. */
4058 int same_at_start
= BEGV_BYTE
;
4059 int same_at_end
= ZV_BYTE
;
4061 /* There is still a possibility we will find the need to do code
4062 conversion. If that happens, we set this variable to 1 to
4063 give up on handling REPLACE in the optimized way. */
4064 int giveup_match_end
= 0;
4066 if (XINT (beg
) != 0)
4068 if (lseek (fd
, XINT (beg
), 0) < 0)
4069 report_file_error ("Setting file position",
4070 Fcons (orig_filename
, Qnil
));
4075 /* Count how many chars at the start of the file
4076 match the text at the beginning of the buffer. */
4081 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
4083 error ("IO error reading %s: %s",
4084 SDATA (orig_filename
), emacs_strerror (errno
));
4085 else if (nread
== 0)
4088 if (coding
.type
== coding_type_undecided
)
4089 detect_coding (&coding
, buffer
, nread
);
4090 if (coding
.common_flags
& CODING_REQUIRE_DECODING_MASK
)
4091 /* We found that the file should be decoded somehow.
4092 Let's give up here. */
4094 giveup_match_end
= 1;
4098 if (coding
.eol_type
== CODING_EOL_UNDECIDED
)
4099 detect_eol (&coding
, buffer
, nread
);
4100 if (coding
.eol_type
!= CODING_EOL_UNDECIDED
4101 && coding
.eol_type
!= CODING_EOL_LF
)
4102 /* We found that the format of eol should be decoded.
4103 Let's give up here. */
4105 giveup_match_end
= 1;
4110 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
4111 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
4112 same_at_start
++, bufpos
++;
4113 /* If we found a discrepancy, stop the scan.
4114 Otherwise loop around and scan the next bufferful. */
4115 if (bufpos
!= nread
)
4119 /* If the file matches the buffer completely,
4120 there's no need to replace anything. */
4121 if (same_at_start
- BEGV_BYTE
== XINT (end
))
4125 /* Truncate the buffer to the size of the file. */
4126 del_range_1 (same_at_start
, same_at_end
, 0, 0);
4131 /* Count how many chars at the end of the file
4132 match the text at the end of the buffer. But, if we have
4133 already found that decoding is necessary, don't waste time. */
4134 while (!giveup_match_end
)
4136 int total_read
, nread
, bufpos
, curpos
, trial
;
4138 /* At what file position are we now scanning? */
4139 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
4140 /* If the entire file matches the buffer tail, stop the scan. */
4143 /* How much can we scan in the next step? */
4144 trial
= min (curpos
, sizeof buffer
);
4145 if (lseek (fd
, curpos
- trial
, 0) < 0)
4146 report_file_error ("Setting file position",
4147 Fcons (orig_filename
, Qnil
));
4149 total_read
= nread
= 0;
4150 while (total_read
< trial
)
4152 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
4154 error ("IO error reading %s: %s",
4155 SDATA (orig_filename
), emacs_strerror (errno
));
4156 else if (nread
== 0)
4158 total_read
+= nread
;
4161 /* Scan this bufferful from the end, comparing with
4162 the Emacs buffer. */
4163 bufpos
= total_read
;
4165 /* Compare with same_at_start to avoid counting some buffer text
4166 as matching both at the file's beginning and at the end. */
4167 while (bufpos
> 0 && same_at_end
> same_at_start
4168 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
4169 same_at_end
--, bufpos
--;
4171 /* If we found a discrepancy, stop the scan.
4172 Otherwise loop around and scan the preceding bufferful. */
4175 /* If this discrepancy is because of code conversion,
4176 we cannot use this method; giveup and try the other. */
4177 if (same_at_end
> same_at_start
4178 && FETCH_BYTE (same_at_end
- 1) >= 0200
4179 && ! NILP (current_buffer
->enable_multibyte_characters
)
4180 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
4181 giveup_match_end
= 1;
4190 if (! giveup_match_end
)
4194 /* We win! We can handle REPLACE the optimized way. */
4196 /* Extend the start of non-matching text area to multibyte
4197 character boundary. */
4198 if (! NILP (current_buffer
->enable_multibyte_characters
))
4199 while (same_at_start
> BEGV_BYTE
4200 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4203 /* Extend the end of non-matching text area to multibyte
4204 character boundary. */
4205 if (! NILP (current_buffer
->enable_multibyte_characters
))
4206 while (same_at_end
< ZV_BYTE
4207 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4210 /* Don't try to reuse the same piece of text twice. */
4211 overlap
= (same_at_start
- BEGV_BYTE
4212 - (same_at_end
+ st
.st_size
- ZV
));
4214 same_at_end
+= overlap
;
4216 /* Arrange to read only the nonmatching middle part of the file. */
4217 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
4218 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
4220 del_range_byte (same_at_start
, same_at_end
, 0);
4221 /* Insert from the file at the proper position. */
4222 temp
= BYTE_TO_CHAR (same_at_start
);
4223 SET_PT_BOTH (temp
, same_at_start
);
4225 /* If display currently starts at beginning of line,
4226 keep it that way. */
4227 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
4228 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
4230 replace_handled
= 1;
4234 /* If requested, replace the accessible part of the buffer
4235 with the file contents. Avoid replacing text at the
4236 beginning or end of the buffer that matches the file contents;
4237 that preserves markers pointing to the unchanged parts.
4239 Here we implement this feature for the case where code conversion
4240 is needed, in a simple way that needs a lot of memory.
4241 The preceding if-statement handles the case of no conversion
4242 in a more optimized way. */
4243 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
4245 int same_at_start
= BEGV_BYTE
;
4246 int same_at_end
= ZV_BYTE
;
4249 /* Make sure that the gap is large enough. */
4250 int bufsize
= 2 * st
.st_size
;
4251 unsigned char *conversion_buffer
= (unsigned char *) xmalloc (bufsize
);
4254 /* First read the whole file, performing code conversion into
4255 CONVERSION_BUFFER. */
4257 if (lseek (fd
, XINT (beg
), 0) < 0)
4259 xfree (conversion_buffer
);
4260 report_file_error ("Setting file position",
4261 Fcons (orig_filename
, Qnil
));
4264 total
= st
.st_size
; /* Total bytes in the file. */
4265 how_much
= 0; /* Bytes read from file so far. */
4266 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
4267 unprocessed
= 0; /* Bytes not processed in previous loop. */
4269 while (how_much
< total
)
4271 /* try is reserved in some compilers (Microsoft C) */
4272 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
4273 unsigned char *destination
= read_buf
+ unprocessed
;
4276 /* Allow quitting out of the actual I/O. */
4279 this = emacs_read (fd
, destination
, trytry
);
4282 if (this < 0 || this + unprocessed
== 0)
4290 if (CODING_MAY_REQUIRE_DECODING (&coding
))
4292 int require
, result
;
4294 this += unprocessed
;
4296 /* If we are using more space than estimated,
4297 make CONVERSION_BUFFER bigger. */
4298 require
= decoding_buffer_size (&coding
, this);
4299 if (inserted
+ require
+ 2 * (total
- how_much
) > bufsize
)
4301 bufsize
= inserted
+ require
+ 2 * (total
- how_much
);
4302 conversion_buffer
= (unsigned char *) xrealloc (conversion_buffer
, bufsize
);
4305 /* Convert this batch with results in CONVERSION_BUFFER. */
4306 if (how_much
>= total
) /* This is the last block. */
4307 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4308 if (coding
.composing
!= COMPOSITION_DISABLED
)
4309 coding_allocate_composition_data (&coding
, BEGV
);
4310 result
= decode_coding (&coding
, read_buf
,
4311 conversion_buffer
+ inserted
,
4312 this, bufsize
- inserted
);
4314 /* Save for next iteration whatever we didn't convert. */
4315 unprocessed
= this - coding
.consumed
;
4316 bcopy (read_buf
+ coding
.consumed
, read_buf
, unprocessed
);
4317 if (!NILP (current_buffer
->enable_multibyte_characters
))
4318 this = coding
.produced
;
4320 this = str_as_unibyte (conversion_buffer
+ inserted
,
4327 /* At this point, INSERTED is how many characters (i.e. bytes)
4328 are present in CONVERSION_BUFFER.
4329 HOW_MUCH should equal TOTAL,
4330 or should be <= 0 if we couldn't read the file. */
4334 xfree (conversion_buffer
);
4335 coding_free_composition_data (&coding
);
4337 error ("IO error reading %s: %s",
4338 SDATA (orig_filename
), emacs_strerror (errno
));
4339 else if (how_much
== -2)
4340 error ("maximum buffer size exceeded");
4343 /* Compare the beginning of the converted file
4344 with the buffer text. */
4347 while (bufpos
< inserted
&& same_at_start
< same_at_end
4348 && FETCH_BYTE (same_at_start
) == conversion_buffer
[bufpos
])
4349 same_at_start
++, bufpos
++;
4351 /* If the file matches the buffer completely,
4352 there's no need to replace anything. */
4354 if (bufpos
== inserted
)
4356 xfree (conversion_buffer
);
4357 coding_free_composition_data (&coding
);
4360 /* Truncate the buffer to the size of the file. */
4361 del_range_byte (same_at_start
, same_at_end
, 0);
4366 /* Extend the start of non-matching text area to multibyte
4367 character boundary. */
4368 if (! NILP (current_buffer
->enable_multibyte_characters
))
4369 while (same_at_start
> BEGV_BYTE
4370 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4373 /* Scan this bufferful from the end, comparing with
4374 the Emacs buffer. */
4377 /* Compare with same_at_start to avoid counting some buffer text
4378 as matching both at the file's beginning and at the end. */
4379 while (bufpos
> 0 && same_at_end
> same_at_start
4380 && FETCH_BYTE (same_at_end
- 1) == conversion_buffer
[bufpos
- 1])
4381 same_at_end
--, bufpos
--;
4383 /* Extend the end of non-matching text area to multibyte
4384 character boundary. */
4385 if (! NILP (current_buffer
->enable_multibyte_characters
))
4386 while (same_at_end
< ZV_BYTE
4387 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4390 /* Don't try to reuse the same piece of text twice. */
4391 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4393 same_at_end
+= overlap
;
4395 /* If display currently starts at beginning of line,
4396 keep it that way. */
4397 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
4398 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
4400 /* Replace the chars that we need to replace,
4401 and update INSERTED to equal the number of bytes
4402 we are taking from the file. */
4403 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4405 if (same_at_end
!= same_at_start
)
4407 del_range_byte (same_at_start
, same_at_end
, 0);
4409 same_at_start
= GPT_BYTE
;
4413 temp
= BYTE_TO_CHAR (same_at_start
);
4415 /* Insert from the file at the proper position. */
4416 SET_PT_BOTH (temp
, same_at_start
);
4417 insert_1 (conversion_buffer
+ same_at_start
- BEGV_BYTE
, inserted
,
4419 if (coding
.cmp_data
&& coding
.cmp_data
->used
)
4420 coding_restore_composition (&coding
, Fcurrent_buffer ());
4421 coding_free_composition_data (&coding
);
4423 /* Set `inserted' to the number of inserted characters. */
4424 inserted
= PT
- temp
;
4426 xfree (conversion_buffer
);
4435 register Lisp_Object temp
;
4437 total
= XINT (end
) - XINT (beg
);
4439 /* Make sure point-max won't overflow after this insertion. */
4440 XSETINT (temp
, total
);
4441 if (total
!= XINT (temp
))
4442 error ("Maximum buffer size exceeded");
4445 /* For a special file, all we can do is guess. */
4446 total
= READ_BUF_SIZE
;
4448 if (NILP (visit
) && inserted
> 0)
4450 #ifdef CLASH_DETECTION
4451 if (!NILP (current_buffer
->file_truename
)
4452 /* Make binding buffer-file-name to nil effective. */
4453 && !NILP (current_buffer
->filename
)
4454 && SAVE_MODIFF
>= MODIFF
)
4456 #endif /* CLASH_DETECTION */
4457 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4461 if (GAP_SIZE
< total
)
4462 make_gap (total
- GAP_SIZE
);
4464 if (XINT (beg
) != 0 || !NILP (replace
))
4466 if (lseek (fd
, XINT (beg
), 0) < 0)
4467 report_file_error ("Setting file position",
4468 Fcons (orig_filename
, Qnil
));
4471 /* In the following loop, HOW_MUCH contains the total bytes read so
4472 far for a regular file, and not changed for a special file. But,
4473 before exiting the loop, it is set to a negative value if I/O
4477 /* Total bytes inserted. */
4480 /* Here, we don't do code conversion in the loop. It is done by
4481 code_convert_region after all data are read into the buffer. */
4483 int gap_size
= GAP_SIZE
;
4485 while (how_much
< total
)
4487 /* try is reserved in some compilers (Microsoft C) */
4488 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4495 /* Maybe make more room. */
4496 if (gap_size
< trytry
)
4498 make_gap (total
- gap_size
);
4499 gap_size
= GAP_SIZE
;
4502 /* Read from the file, capturing `quit'. When an
4503 error occurs, end the loop, and arrange for a quit
4504 to be signaled after decoding the text we read. */
4505 non_regular_fd
= fd
;
4506 non_regular_inserted
= inserted
;
4507 non_regular_nbytes
= trytry
;
4508 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
4509 read_non_regular_quit
);
4520 /* Allow quitting out of the actual I/O. We don't make text
4521 part of the buffer until all the reading is done, so a C-g
4522 here doesn't do any harm. */
4525 this = emacs_read (fd
, BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ inserted
, trytry
);
4537 /* For a regular file, where TOTAL is the real size,
4538 count HOW_MUCH to compare with it.
4539 For a special file, where TOTAL is just a buffer size,
4540 so don't bother counting in HOW_MUCH.
4541 (INSERTED is where we count the number of characters inserted.) */
4548 /* Now we have read all the file data into the gap.
4549 If it was empty, undo marking the buffer modified. */
4553 #ifdef CLASH_DETECTION
4555 unlock_file (current_buffer
->file_truename
);
4557 Vdeactivate_mark
= old_Vdeactivate_mark
;
4560 Vdeactivate_mark
= Qt
;
4562 /* Make the text read part of the buffer. */
4563 GAP_SIZE
-= inserted
;
4565 GPT_BYTE
+= inserted
;
4567 ZV_BYTE
+= inserted
;
4572 /* Put an anchor to ensure multi-byte form ends at gap. */
4577 /* Discard the unwind protect for closing the file. */
4581 error ("IO error reading %s: %s",
4582 SDATA (orig_filename
), emacs_strerror (errno
));
4586 if (! coding_system_decided
)
4588 /* The coding system is not yet decided. Decide it by an
4589 optimized method for handling `coding:' tag.
4591 Note that we can get here only if the buffer was empty
4592 before the insertion. */
4596 if (!NILP (Vcoding_system_for_read
))
4597 val
= Vcoding_system_for_read
;
4600 /* Since we are sure that the current buffer was empty
4601 before the insertion, we can toggle
4602 enable-multibyte-characters directly here without taking
4603 care of marker adjustment and byte combining problem. By
4604 this way, we can run Lisp program safely before decoding
4605 the inserted text. */
4606 Lisp_Object unwind_data
;
4607 int count
= SPECPDL_INDEX ();
4609 unwind_data
= Fcons (current_buffer
->enable_multibyte_characters
,
4610 Fcons (current_buffer
->undo_list
,
4611 Fcurrent_buffer ()));
4612 current_buffer
->enable_multibyte_characters
= Qnil
;
4613 current_buffer
->undo_list
= Qt
;
4614 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4616 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4618 val
= call2 (Vset_auto_coding_function
,
4619 filename
, make_number (inserted
));
4624 /* If the coding system is not yet decided, check
4625 file-coding-system-alist. */
4626 Lisp_Object args
[6], coding_systems
;
4628 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4629 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4630 coding_systems
= Ffind_operation_coding_system (6, args
);
4631 if (CONSP (coding_systems
))
4632 val
= XCAR (coding_systems
);
4634 unbind_to (count
, Qnil
);
4635 inserted
= Z_BYTE
- BEG_BYTE
;
4638 /* The following kludgy code is to avoid some compiler bug.
4640 setup_coding_system (val, &coding);
4643 struct coding_system temp_coding
;
4644 setup_coding_system (Fcheck_coding_system (val
), &temp_coding
);
4645 bcopy (&temp_coding
, &coding
, sizeof coding
);
4647 /* Ensure we set Vlast_coding_system_used. */
4648 set_coding_system
= 1;
4650 if (NILP (current_buffer
->enable_multibyte_characters
)
4652 /* We must suppress all character code conversion except for
4653 end-of-line conversion. */
4654 setup_raw_text_coding_system (&coding
);
4655 coding
.src_multibyte
= 0;
4656 coding
.dst_multibyte
4657 = !NILP (current_buffer
->enable_multibyte_characters
);
4661 /* Can't do this if part of the buffer might be preserved. */
4663 && (coding
.type
== coding_type_no_conversion
4664 || coding
.type
== coding_type_raw_text
))
4666 /* Visiting a file with these coding system makes the buffer
4668 current_buffer
->enable_multibyte_characters
= Qnil
;
4669 coding
.dst_multibyte
= 0;
4672 if (inserted
> 0 || coding
.type
== coding_type_ccl
)
4674 if (CODING_MAY_REQUIRE_DECODING (&coding
))
4676 code_convert_region (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4678 inserted
= coding
.produced_char
;
4681 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4685 /* Now INSERTED is measured in characters. */
4688 /* Use the conversion type to determine buffer-file-type
4689 (find-buffer-file-type is now used to help determine the
4691 if ((coding
.eol_type
== CODING_EOL_UNDECIDED
4692 || coding
.eol_type
== CODING_EOL_LF
)
4693 && ! CODING_REQUIRE_DECODING (&coding
))
4694 current_buffer
->buffer_file_type
= Qt
;
4696 current_buffer
->buffer_file_type
= Qnil
;
4703 if (!EQ (current_buffer
->undo_list
, Qt
))
4704 current_buffer
->undo_list
= Qnil
;
4706 stat (SDATA (filename
), &st
);
4711 current_buffer
->modtime
= st
.st_mtime
;
4712 current_buffer
->filename
= orig_filename
;
4715 SAVE_MODIFF
= MODIFF
;
4716 current_buffer
->auto_save_modified
= MODIFF
;
4717 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4718 #ifdef CLASH_DETECTION
4721 if (!NILP (current_buffer
->file_truename
))
4722 unlock_file (current_buffer
->file_truename
);
4723 unlock_file (filename
);
4725 #endif /* CLASH_DETECTION */
4727 Fsignal (Qfile_error
,
4728 Fcons (build_string ("not a regular file"),
4729 Fcons (orig_filename
, Qnil
)));
4732 if (set_coding_system
)
4733 Vlast_coding_system_used
= coding
.symbol
;
4735 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4737 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4739 if (! NILP (insval
))
4741 CHECK_NUMBER (insval
);
4742 inserted
= XFASTINT (insval
);
4746 /* Decode file format */
4749 int empty_undo_list_p
= 0;
4751 /* If we're anyway going to discard undo information, don't
4752 record it in the first place. The buffer's undo list at this
4753 point is either nil or t when visiting a file. */
4756 empty_undo_list_p
= NILP (current_buffer
->undo_list
);
4757 current_buffer
->undo_list
= Qt
;
4760 insval
= call3 (Qformat_decode
,
4761 Qnil
, make_number (inserted
), visit
);
4762 CHECK_NUMBER (insval
);
4763 inserted
= XFASTINT (insval
);
4766 current_buffer
->undo_list
= empty_undo_list_p
? Qnil
: Qt
;
4769 /* Call after-change hooks for the inserted text, aside from the case
4770 of normal visiting (not with REPLACE), which is done in a new buffer
4771 "before" the buffer is changed. */
4772 if (inserted
> 0 && total
> 0
4773 && (NILP (visit
) || !NILP (replace
)))
4775 signal_after_change (PT
, 0, inserted
);
4776 update_compositions (PT
, PT
, CHECK_BORDER
);
4779 p
= Vafter_insert_file_functions
;
4782 insval
= call1 (XCAR (p
), make_number (inserted
));
4785 CHECK_NUMBER (insval
);
4786 inserted
= XFASTINT (insval
);
4793 && current_buffer
->modtime
== -1)
4795 /* If visiting nonexistent file, return nil. */
4796 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4800 Fsignal (Qquit
, Qnil
);
4802 /* ??? Retval needs to be dealt with in all cases consistently. */
4804 val
= Fcons (orig_filename
,
4805 Fcons (make_number (inserted
),
4808 RETURN_UNGCPRO (unbind_to (count
, val
));
4811 static Lisp_Object build_annotations
P_ ((Lisp_Object
, Lisp_Object
));
4812 static Lisp_Object build_annotations_2
P_ ((Lisp_Object
, Lisp_Object
,
4813 Lisp_Object
, Lisp_Object
));
4815 /* If build_annotations switched buffers, switch back to BUF.
4816 Kill the temporary buffer that was selected in the meantime.
4818 Since this kill only the last temporary buffer, some buffers remain
4819 not killed if build_annotations switched buffers more than once.
4823 build_annotations_unwind (buf
)
4828 if (XBUFFER (buf
) == current_buffer
)
4830 tembuf
= Fcurrent_buffer ();
4832 Fkill_buffer (tembuf
);
4836 /* Decide the coding-system to encode the data with. */
4839 choose_write_coding_system (start
, end
, filename
,
4840 append
, visit
, lockname
, coding
)
4841 Lisp_Object start
, end
, filename
, append
, visit
, lockname
;
4842 struct coding_system
*coding
;
4847 && NILP (Fstring_equal (current_buffer
->filename
,
4848 current_buffer
->auto_save_file_name
)))
4850 /* We use emacs-mule for auto saving... */
4851 setup_coding_system (Qemacs_mule
, coding
);
4852 /* ... but with the special flag to indicate not to strip off
4853 leading code of eight-bit-control chars. */
4855 goto done_setup_coding
;
4857 else if (!NILP (Vcoding_system_for_write
))
4859 val
= Vcoding_system_for_write
;
4860 if (coding_system_require_warning
4861 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4862 /* Confirm that VAL can surely encode the current region. */
4863 val
= call5 (Vselect_safe_coding_system_function
,
4864 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4869 /* If the variable `buffer-file-coding-system' is set locally,
4870 it means that the file was read with some kind of code
4871 conversion or the variable is explicitly set by users. We
4872 had better write it out with the same coding system even if
4873 `enable-multibyte-characters' is nil.
4875 If it is not set locally, we anyway have to convert EOL
4876 format if the default value of `buffer-file-coding-system'
4877 tells that it is not Unix-like (LF only) format. */
4878 int using_default_coding
= 0;
4879 int force_raw_text
= 0;
4881 val
= current_buffer
->buffer_file_coding_system
;
4883 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4886 if (NILP (current_buffer
->enable_multibyte_characters
))
4892 /* Check file-coding-system-alist. */
4893 Lisp_Object args
[7], coding_systems
;
4895 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4896 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4898 coding_systems
= Ffind_operation_coding_system (7, args
);
4899 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4900 val
= XCDR (coding_systems
);
4904 && !NILP (current_buffer
->buffer_file_coding_system
))
4906 /* If we still have not decided a coding system, use the
4907 default value of buffer-file-coding-system. */
4908 val
= current_buffer
->buffer_file_coding_system
;
4909 using_default_coding
= 1;
4913 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4914 /* Confirm that VAL can surely encode the current region. */
4915 val
= call5 (Vselect_safe_coding_system_function
,
4916 start
, end
, val
, Qnil
, filename
);
4918 setup_coding_system (Fcheck_coding_system (val
), coding
);
4919 if (coding
->eol_type
== CODING_EOL_UNDECIDED
4920 && !using_default_coding
)
4922 if (! EQ (default_buffer_file_coding
.symbol
,
4923 buffer_defaults
.buffer_file_coding_system
))
4924 setup_coding_system (buffer_defaults
.buffer_file_coding_system
,
4925 &default_buffer_file_coding
);
4926 if (default_buffer_file_coding
.eol_type
!= CODING_EOL_UNDECIDED
)
4928 Lisp_Object subsidiaries
;
4930 coding
->eol_type
= default_buffer_file_coding
.eol_type
;
4931 subsidiaries
= Fget (coding
->symbol
, Qeol_type
);
4932 if (VECTORP (subsidiaries
)
4933 && XVECTOR (subsidiaries
)->size
== 3)
4935 = XVECTOR (subsidiaries
)->contents
[coding
->eol_type
];
4940 setup_raw_text_coding_system (coding
);
4941 goto done_setup_coding
;
4944 setup_coding_system (Fcheck_coding_system (val
), coding
);
4947 if (!STRINGP (start
) && !NILP (current_buffer
->selective_display
))
4948 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4951 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4952 "r\nFWrite region to file: \ni\ni\ni\np",
4953 doc
: /* Write current region into specified file.
4954 When called from a program, requires three arguments:
4955 START, END and FILENAME. START and END are normally buffer positions
4956 specifying the part of the buffer to write.
4957 If START is nil, that means to use the entire buffer contents.
4958 If START is a string, then output that string to the file
4959 instead of any buffer contents; END is ignored.
4961 Optional fourth argument APPEND if non-nil means
4962 append to existing file contents (if any). If it is an integer,
4963 seek to that offset in the file before writing.
4964 Optional fifth argument VISIT, if t or a string, means
4965 set the last-save-file-modtime of buffer to this file's modtime
4966 and mark buffer not modified.
4967 If VISIT is a string, it is a second file name;
4968 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4969 VISIT is also the file name to lock and unlock for clash detection.
4970 If VISIT is neither t nor nil nor a string,
4971 that means do not display the \"Wrote file\" message.
4972 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4973 use for locking and unlocking, overriding FILENAME and VISIT.
4974 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4975 for an existing file with the same name. If MUSTBENEW is `excl',
4976 that means to get an error if the file already exists; never overwrite.
4977 If MUSTBENEW is neither nil nor `excl', that means ask for
4978 confirmation before overwriting, but do go ahead and overwrite the file
4979 if the user confirms.
4981 This does code conversion according to the value of
4982 `coding-system-for-write', `buffer-file-coding-system', or
4983 `file-coding-system-alist', and sets the variable
4984 `last-coding-system-used' to the coding system actually used. */)
4985 (start
, end
, filename
, append
, visit
, lockname
, mustbenew
)
4986 Lisp_Object start
, end
, filename
, append
, visit
, lockname
, mustbenew
;
4991 const unsigned char *fn
;
4994 int count
= SPECPDL_INDEX ();
4997 unsigned char *fname
= 0; /* If non-0, original filename (must rename) */
4999 Lisp_Object handler
;
5000 Lisp_Object visit_file
;
5001 Lisp_Object annotations
;
5002 Lisp_Object encoded_filename
;
5003 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
5004 int quietly
= !NILP (visit
);
5005 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
5006 struct buffer
*given_buffer
;
5008 int buffer_file_type
= O_BINARY
;
5010 struct coding_system coding
;
5012 if (current_buffer
->base_buffer
&& visiting
)
5013 error ("Cannot do file visiting in an indirect buffer");
5015 if (!NILP (start
) && !STRINGP (start
))
5016 validate_region (&start
, &end
);
5018 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
5020 filename
= Fexpand_file_name (filename
, Qnil
);
5022 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
5023 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
5025 if (STRINGP (visit
))
5026 visit_file
= Fexpand_file_name (visit
, Qnil
);
5028 visit_file
= filename
;
5030 if (NILP (lockname
))
5031 lockname
= visit_file
;
5035 /* If the file name has special constructs in it,
5036 call the corresponding file handler. */
5037 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
5038 /* If FILENAME has no handler, see if VISIT has one. */
5039 if (NILP (handler
) && STRINGP (visit
))
5040 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
5042 if (!NILP (handler
))
5045 val
= call6 (handler
, Qwrite_region
, start
, end
,
5046 filename
, append
, visit
);
5050 SAVE_MODIFF
= MODIFF
;
5051 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5052 current_buffer
->filename
= visit_file
;
5058 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
5060 /* Special kludge to simplify auto-saving. */
5063 XSETFASTINT (start
, BEG
);
5064 XSETFASTINT (end
, Z
);
5068 record_unwind_protect (build_annotations_unwind
, Fcurrent_buffer ());
5069 count1
= SPECPDL_INDEX ();
5071 given_buffer
= current_buffer
;
5073 if (!STRINGP (start
))
5075 annotations
= build_annotations (start
, end
);
5077 if (current_buffer
!= given_buffer
)
5079 XSETFASTINT (start
, BEGV
);
5080 XSETFASTINT (end
, ZV
);
5086 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
5088 /* Decide the coding-system to encode the data with.
5089 We used to make this choice before calling build_annotations, but that
5090 leads to problems when a write-annotate-function takes care of
5091 unsavable chars (as was the case with X-Symbol). */
5092 choose_write_coding_system (start
, end
, filename
,
5093 append
, visit
, lockname
, &coding
);
5094 Vlast_coding_system_used
= coding
.symbol
;
5096 given_buffer
= current_buffer
;
5097 if (! STRINGP (start
))
5099 annotations
= build_annotations_2 (start
, end
,
5100 coding
.pre_write_conversion
, annotations
);
5101 if (current_buffer
!= given_buffer
)
5103 XSETFASTINT (start
, BEGV
);
5104 XSETFASTINT (end
, ZV
);
5108 #ifdef CLASH_DETECTION
5111 #if 0 /* This causes trouble for GNUS. */
5112 /* If we've locked this file for some other buffer,
5113 query before proceeding. */
5114 if (!visiting
&& EQ (Ffile_locked_p (lockname
), Qt
))
5115 call2 (intern ("ask-user-about-lock"), filename
, Vuser_login_name
);
5118 lock_file (lockname
);
5120 #endif /* CLASH_DETECTION */
5122 encoded_filename
= ENCODE_FILE (filename
);
5124 fn
= SDATA (encoded_filename
);
5128 desc
= emacs_open (fn
, O_WRONLY
| buffer_file_type
, 0);
5129 #else /* not DOS_NT */
5130 desc
= emacs_open (fn
, O_WRONLY
, 0);
5131 #endif /* not DOS_NT */
5133 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
5135 if (auto_saving
) /* Overwrite any previous version of autosave file */
5137 vms_truncate (fn
); /* if fn exists, truncate to zero length */
5138 desc
= emacs_open (fn
, O_RDWR
, 0);
5140 desc
= creat_copy_attrs (STRINGP (current_buffer
->filename
)
5141 ? SDATA (current_buffer
->filename
) : 0,
5144 else /* Write to temporary name and rename if no errors */
5146 Lisp_Object temp_name
;
5147 temp_name
= Ffile_name_directory (filename
);
5149 if (!NILP (temp_name
))
5151 temp_name
= Fmake_temp_name (concat2 (temp_name
,
5152 build_string ("$$SAVE$$")));
5153 fname
= SDATA (filename
);
5154 fn
= SDATA (temp_name
);
5155 desc
= creat_copy_attrs (fname
, fn
);
5158 /* If we can't open the temporary file, try creating a new
5159 version of the original file. VMS "creat" creates a
5160 new version rather than truncating an existing file. */
5163 desc
= creat (fn
, 0666);
5164 #if 0 /* This can clobber an existing file and fail to replace it,
5165 if the user runs out of space. */
5168 /* We can't make a new version;
5169 try to truncate and rewrite existing version if any. */
5171 desc
= emacs_open (fn
, O_RDWR
, 0);
5177 desc
= creat (fn
, 0666);
5181 desc
= emacs_open (fn
,
5182 O_WRONLY
| O_CREAT
| buffer_file_type
5183 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
5184 S_IREAD
| S_IWRITE
);
5185 #else /* not DOS_NT */
5186 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
5187 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
5188 auto_saving
? auto_save_mode_bits
: 0666);
5189 #endif /* not DOS_NT */
5190 #endif /* not VMS */
5194 #ifdef CLASH_DETECTION
5196 if (!auto_saving
) unlock_file (lockname
);
5198 #endif /* CLASH_DETECTION */
5200 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
5203 record_unwind_protect (close_file_unwind
, make_number (desc
));
5205 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
5209 if (NUMBERP (append
))
5210 ret
= lseek (desc
, XINT (append
), 1);
5212 ret
= lseek (desc
, 0, 2);
5215 #ifdef CLASH_DETECTION
5216 if (!auto_saving
) unlock_file (lockname
);
5217 #endif /* CLASH_DETECTION */
5219 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
5227 * Kludge Warning: The VMS C RTL likes to insert carriage returns
5228 * if we do writes that don't end with a carriage return. Furthermore
5229 * it cannot handle writes of more then 16K. The modified
5230 * version of "sys_write" in SYSDEP.C (see comment there) copes with
5231 * this EXCEPT for the last record (iff it doesn't end with a carriage
5232 * return). This implies that if your buffer doesn't end with a carriage
5233 * return, you get one free... tough. However it also means that if
5234 * we make two calls to sys_write (a la the following code) you can
5235 * get one at the gap as well. The easiest way to fix this (honest)
5236 * is to move the gap to the next newline (or the end of the buffer).
5241 if (GPT
> BEG
&& GPT_ADDR
[-1] != '\n')
5242 move_gap (find_next_newline (GPT
, 1));
5244 /* Whether VMS or not, we must move the gap to the next of newline
5245 when we must put designation sequences at beginning of line. */
5246 if (INTEGERP (start
)
5247 && coding
.type
== coding_type_iso2022
5248 && coding
.flags
& CODING_FLAG_ISO_DESIGNATE_AT_BOL
5249 && GPT
> BEG
&& GPT_ADDR
[-1] != '\n')
5251 int opoint
= PT
, opoint_byte
= PT_BYTE
;
5252 scan_newline (PT
, PT_BYTE
, ZV
, ZV_BYTE
, 1, 0);
5253 move_gap_both (PT
, PT_BYTE
);
5254 SET_PT_BOTH (opoint
, opoint_byte
);
5261 if (STRINGP (start
))
5263 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
5264 &annotations
, &coding
);
5267 else if (XINT (start
) != XINT (end
))
5269 tem
= CHAR_TO_BYTE (XINT (start
));
5271 if (XINT (start
) < GPT
)
5273 failure
= 0 > a_write (desc
, Qnil
, XINT (start
),
5274 min (GPT
, XINT (end
)) - XINT (start
),
5275 &annotations
, &coding
);
5279 if (XINT (end
) > GPT
&& !failure
)
5281 tem
= max (XINT (start
), GPT
);
5282 failure
= 0 > a_write (desc
, Qnil
, tem
, XINT (end
) - tem
,
5283 &annotations
, &coding
);
5289 /* If file was empty, still need to write the annotations */
5290 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
5291 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
5295 if (CODING_REQUIRE_FLUSHING (&coding
)
5296 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
5299 /* We have to flush out a data. */
5300 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
5301 failure
= 0 > e_write (desc
, Qnil
, 0, 0, &coding
);
5308 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
5309 Disk full in NFS may be reported here. */
5310 /* mib says that closing the file will try to write as fast as NFS can do
5311 it, and that means the fsync here is not crucial for autosave files. */
5312 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
5314 /* If fsync fails with EINTR, don't treat that as serious. */
5316 failure
= 1, save_errno
= errno
;
5320 /* Spurious "file has changed on disk" warnings have been
5321 observed on Suns as well.
5322 It seems that `close' can change the modtime, under nfs.
5324 (This has supposedly been fixed in Sunos 4,
5325 but who knows about all the other machines with NFS?) */
5328 /* On VMS and APOLLO, must do the stat after the close
5329 since closing changes the modtime. */
5332 /* Recall that #if defined does not work on VMS. */
5339 /* NFS can report a write failure now. */
5340 if (emacs_close (desc
) < 0)
5341 failure
= 1, save_errno
= errno
;
5344 /* If we wrote to a temporary name and had no errors, rename to real name. */
5348 failure
= (rename (fn
, fname
) != 0), save_errno
= errno
;
5356 /* Discard the unwind protect for close_file_unwind. */
5357 specpdl_ptr
= specpdl
+ count1
;
5358 /* Restore the original current buffer. */
5359 visit_file
= unbind_to (count
, visit_file
);
5361 #ifdef CLASH_DETECTION
5363 unlock_file (lockname
);
5364 #endif /* CLASH_DETECTION */
5366 /* Do this before reporting IO error
5367 to avoid a "file has changed on disk" warning on
5368 next attempt to save. */
5370 current_buffer
->modtime
= st
.st_mtime
;
5373 error ("IO error writing %s: %s", SDATA (filename
),
5374 emacs_strerror (save_errno
));
5378 SAVE_MODIFF
= MODIFF
;
5379 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5380 current_buffer
->filename
= visit_file
;
5381 update_mode_lines
++;
5386 && ! NILP (Fstring_equal (current_buffer
->filename
,
5387 current_buffer
->auto_save_file_name
)))
5388 SAVE_MODIFF
= MODIFF
;
5394 message_with_string ((INTEGERP (append
)
5404 Lisp_Object
merge ();
5406 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5407 doc
: /* Return t if (car A) is numerically less than (car B). */)
5411 return Flss (Fcar (a
), Fcar (b
));
5414 /* Build the complete list of annotations appropriate for writing out
5415 the text between START and END, by calling all the functions in
5416 write-region-annotate-functions and merging the lists they return.
5417 If one of these functions switches to a different buffer, we assume
5418 that buffer contains altered text. Therefore, the caller must
5419 make sure to restore the current buffer in all cases,
5420 as save-excursion would do. */
5423 build_annotations (start
, end
)
5424 Lisp_Object start
, end
;
5426 Lisp_Object annotations
;
5428 struct gcpro gcpro1
, gcpro2
;
5429 Lisp_Object original_buffer
;
5430 int i
, used_global
= 0;
5432 XSETBUFFER (original_buffer
, current_buffer
);
5435 p
= Vwrite_region_annotate_functions
;
5436 GCPRO2 (annotations
, p
);
5439 struct buffer
*given_buffer
= current_buffer
;
5440 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5441 { /* Use the global value of the hook. */
5444 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5446 p
= Fappend (2, arg
);
5449 Vwrite_region_annotations_so_far
= annotations
;
5450 res
= call2 (XCAR (p
), start
, end
);
5451 /* If the function makes a different buffer current,
5452 assume that means this buffer contains altered text to be output.
5453 Reset START and END from the buffer bounds
5454 and discard all previous annotations because they should have
5455 been dealt with by this function. */
5456 if (current_buffer
!= given_buffer
)
5458 XSETFASTINT (start
, BEGV
);
5459 XSETFASTINT (end
, ZV
);
5462 Flength (res
); /* Check basic validity of return value */
5463 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5467 /* Now do the same for annotation functions implied by the file-format */
5468 if (auto_saving
&& (!EQ (current_buffer
->auto_save_file_format
, Qt
)))
5469 p
= current_buffer
->auto_save_file_format
;
5471 p
= current_buffer
->file_format
;
5472 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5474 struct buffer
*given_buffer
= current_buffer
;
5476 Vwrite_region_annotations_so_far
= annotations
;
5478 /* Value is either a list of annotations or nil if the function
5479 has written annotations to a temporary buffer, which is now
5481 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5482 original_buffer
, make_number (i
));
5483 if (current_buffer
!= given_buffer
)
5485 XSETFASTINT (start
, BEGV
);
5486 XSETFASTINT (end
, ZV
);
5491 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5499 build_annotations_2 (start
, end
, pre_write_conversion
, annotations
)
5500 Lisp_Object start
, end
, pre_write_conversion
, annotations
;
5502 struct gcpro gcpro1
;
5505 GCPRO1 (annotations
);
5506 /* At last, do the same for the function PRE_WRITE_CONVERSION
5507 implied by the current coding-system. */
5508 if (!NILP (pre_write_conversion
))
5510 struct buffer
*given_buffer
= current_buffer
;
5511 Vwrite_region_annotations_so_far
= annotations
;
5512 res
= call2 (pre_write_conversion
, start
, end
);
5514 annotations
= (current_buffer
!= given_buffer
5516 : merge (annotations
, res
, Qcar_less_than_car
));
5523 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5524 If STRING is nil, POS is the character position in the current buffer.
5525 Intersperse with them the annotations from *ANNOT
5526 which fall within the range of POS to POS + NCHARS,
5527 each at its appropriate position.
5529 We modify *ANNOT by discarding elements as we use them up.
5531 The return value is negative in case of system call failure. */
5534 a_write (desc
, string
, pos
, nchars
, annot
, coding
)
5537 register int nchars
;
5540 struct coding_system
*coding
;
5544 int lastpos
= pos
+ nchars
;
5546 while (NILP (*annot
) || CONSP (*annot
))
5548 tem
= Fcar_safe (Fcar (*annot
));
5551 nextpos
= XFASTINT (tem
);
5553 /* If there are no more annotations in this range,
5554 output the rest of the range all at once. */
5555 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5556 return e_write (desc
, string
, pos
, lastpos
, coding
);
5558 /* Output buffer text up to the next annotation's position. */
5561 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
5565 /* Output the annotation. */
5566 tem
= Fcdr (Fcar (*annot
));
5569 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5572 *annot
= Fcdr (*annot
);
5577 #ifndef WRITE_BUF_SIZE
5578 #define WRITE_BUF_SIZE (16 * 1024)
5581 /* Write text in the range START and END into descriptor DESC,
5582 encoding them with coding system CODING. If STRING is nil, START
5583 and END are character positions of the current buffer, else they
5584 are indexes to the string STRING. */
5587 e_write (desc
, string
, start
, end
, coding
)
5591 struct coding_system
*coding
;
5593 register char *addr
;
5594 register int nbytes
;
5595 char buf
[WRITE_BUF_SIZE
];
5599 coding
->composing
= COMPOSITION_DISABLED
;
5600 if (coding
->composing
!= COMPOSITION_DISABLED
)
5601 coding_save_composition (coding
, start
, end
, string
);
5603 if (STRINGP (string
))
5605 addr
= SDATA (string
);
5606 nbytes
= SBYTES (string
);
5607 coding
->src_multibyte
= STRING_MULTIBYTE (string
);
5609 else if (start
< end
)
5611 /* It is assured that the gap is not in the range START and END-1. */
5612 addr
= CHAR_POS_ADDR (start
);
5613 nbytes
= CHAR_TO_BYTE (end
) - CHAR_TO_BYTE (start
);
5614 coding
->src_multibyte
5615 = !NILP (current_buffer
->enable_multibyte_characters
);
5621 coding
->src_multibyte
= 1;
5624 /* We used to have a code for handling selective display here. But,
5625 now it is handled within encode_coding. */
5630 result
= encode_coding (coding
, addr
, buf
, nbytes
, WRITE_BUF_SIZE
);
5631 if (coding
->produced
> 0)
5633 coding
->produced
-= emacs_write (desc
, buf
, coding
->produced
);
5634 if (coding
->produced
)
5640 nbytes
-= coding
->consumed
;
5641 addr
+= coding
->consumed
;
5642 if (result
== CODING_FINISH_INSUFFICIENT_SRC
5645 /* The source text ends by an incomplete multibyte form.
5646 There's no way other than write it out as is. */
5647 nbytes
-= emacs_write (desc
, addr
, nbytes
);
5656 start
+= coding
->consumed_char
;
5657 if (coding
->cmp_data
)
5658 coding_adjust_composition_offset (coding
, start
);
5661 if (coding
->cmp_data
)
5662 coding_free_composition_data (coding
);
5667 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5668 Sverify_visited_file_modtime
, 1, 1, 0,
5669 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5670 This means that the file has not been changed since it was visited or saved.
5671 See Info node `(elisp)Modification Time' for more details. */)
5677 Lisp_Object handler
;
5678 Lisp_Object filename
;
5683 if (!STRINGP (b
->filename
)) return Qt
;
5684 if (b
->modtime
== 0) return Qt
;
5686 /* If the file name has special constructs in it,
5687 call the corresponding file handler. */
5688 handler
= Ffind_file_name_handler (b
->filename
,
5689 Qverify_visited_file_modtime
);
5690 if (!NILP (handler
))
5691 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5693 filename
= ENCODE_FILE (b
->filename
);
5695 if (stat (SDATA (filename
), &st
) < 0)
5697 /* If the file doesn't exist now and didn't exist before,
5698 we say that it isn't modified, provided the error is a tame one. */
5699 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
5704 if (st
.st_mtime
== b
->modtime
5705 /* If both are positive, accept them if they are off by one second. */
5706 || (st
.st_mtime
> 0 && b
->modtime
> 0
5707 && (st
.st_mtime
== b
->modtime
+ 1
5708 || st
.st_mtime
== b
->modtime
- 1)))
5713 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5714 Sclear_visited_file_modtime
, 0, 0, 0,
5715 doc
: /* Clear out records of last mod time of visited file.
5716 Next attempt to save will certainly not complain of a discrepancy. */)
5719 current_buffer
->modtime
= 0;
5723 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5724 Svisited_file_modtime
, 0, 0, 0,
5725 doc
: /* Return the current buffer's recorded visited file modification time.
5726 The value is a list of the form (HIGH LOW), like the time values
5727 that `file-attributes' returns. If the current buffer has no recorded
5728 file modification time, this function returns 0.
5729 See Info node `(elisp)Modification Time' for more details. */)
5733 tcons
= long_to_cons ((unsigned long) current_buffer
->modtime
);
5735 return list2 (XCAR (tcons
), XCDR (tcons
));
5739 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5740 Sset_visited_file_modtime
, 0, 1, 0,
5741 doc
: /* Update buffer's recorded modification time from the visited file's time.
5742 Useful if the buffer was not read from the file normally
5743 or if the file itself has been changed for some known benign reason.
5744 An argument specifies the modification time value to use
5745 \(instead of that of the visited file), in the form of a list
5746 \(HIGH . LOW) or (HIGH LOW). */)
5748 Lisp_Object time_list
;
5750 if (!NILP (time_list
))
5751 current_buffer
->modtime
= cons_to_long (time_list
);
5754 register Lisp_Object filename
;
5756 Lisp_Object handler
;
5758 filename
= Fexpand_file_name (current_buffer
->filename
, Qnil
);
5760 /* If the file name has special constructs in it,
5761 call the corresponding file handler. */
5762 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5763 if (!NILP (handler
))
5764 /* The handler can find the file name the same way we did. */
5765 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5767 filename
= ENCODE_FILE (filename
);
5769 if (stat (SDATA (filename
), &st
) >= 0)
5770 current_buffer
->modtime
= st
.st_mtime
;
5777 auto_save_error (error
)
5780 Lisp_Object args
[3], msg
;
5782 struct gcpro gcpro1
;
5786 ring_bell (XFRAME (selected_frame
));
5788 args
[0] = build_string ("Auto-saving %s: %s");
5789 args
[1] = current_buffer
->name
;
5790 args
[2] = Ferror_message_string (error
);
5791 msg
= Fformat (3, args
);
5793 nbytes
= SBYTES (msg
);
5794 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5795 bcopy (SDATA (msg
), msgbuf
, nbytes
);
5797 for (i
= 0; i
< 3; ++i
)
5800 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5802 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5803 Fsleep_for (make_number (1), Qnil
);
5817 auto_save_mode_bits
= 0666;
5819 /* Get visited file's mode to become the auto save file's mode. */
5820 if (! NILP (current_buffer
->filename
))
5822 if (stat (SDATA (current_buffer
->filename
), &st
) >= 0)
5823 /* But make sure we can overwrite it later! */
5824 auto_save_mode_bits
= st
.st_mode
| 0600;
5825 else if ((modes
= Ffile_modes (current_buffer
->filename
),
5827 /* Remote files don't cooperate with stat. */
5828 auto_save_mode_bits
= XINT (modes
) | 0600;
5832 Fwrite_region (Qnil
, Qnil
,
5833 current_buffer
->auto_save_file_name
,
5834 Qnil
, Qlambda
, Qnil
, Qnil
);
5838 do_auto_save_unwind (arg
) /* used as unwind-protect function */
5841 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5849 do_auto_save_unwind_1 (value
) /* used as unwind-protect function */
5852 minibuffer_auto_raise
= XINT (value
);
5857 do_auto_save_make_dir (dir
)
5860 return call2 (Qmake_directory
, dir
, Qt
);
5864 do_auto_save_eh (ignore
)
5870 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5871 doc
: /* Auto-save all buffers that need it.
5872 This is all buffers that have auto-saving enabled
5873 and are changed since last auto-saved.
5874 Auto-saving writes the buffer into a file
5875 so that your editing is not lost if the system crashes.
5876 This file is not the file you visited; that changes only when you save.
5877 Normally we run the normal hook `auto-save-hook' before saving.
5879 A non-nil NO-MESSAGE argument means do not print any message if successful.
5880 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5881 (no_message
, current_only
)
5882 Lisp_Object no_message
, current_only
;
5884 struct buffer
*old
= current_buffer
, *b
;
5885 Lisp_Object tail
, buf
;
5887 int do_handled_files
;
5889 FILE *stream
= NULL
;
5890 int count
= SPECPDL_INDEX ();
5891 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5892 int old_message_p
= 0;
5893 struct gcpro gcpro1
, gcpro2
;
5895 if (max_specpdl_size
< specpdl_size
+ 40)
5896 max_specpdl_size
= specpdl_size
+ 40;
5901 if (NILP (no_message
))
5903 old_message_p
= push_message ();
5904 record_unwind_protect (pop_message_unwind
, Qnil
);
5907 /* Ordinarily don't quit within this function,
5908 but don't make it impossible to quit (in case we get hung in I/O). */
5912 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5913 point to non-strings reached from Vbuffer_alist. */
5915 if (!NILP (Vrun_hooks
))
5916 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5918 if (STRINGP (Vauto_save_list_file_name
))
5920 Lisp_Object listfile
;
5922 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5924 /* Don't try to create the directory when shutting down Emacs,
5925 because creating the directory might signal an error, and
5926 that would leave Emacs in a strange state. */
5927 if (!NILP (Vrun_hooks
))
5931 GCPRO2 (dir
, listfile
);
5932 dir
= Ffile_name_directory (listfile
);
5933 if (NILP (Ffile_directory_p (dir
)))
5934 internal_condition_case_1 (do_auto_save_make_dir
,
5935 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5940 stream
= fopen (SDATA (listfile
), "w");
5943 record_unwind_protect (do_auto_save_unwind
,
5944 make_save_value (stream
, 0));
5945 record_unwind_protect (do_auto_save_unwind_1
,
5946 make_number (minibuffer_auto_raise
));
5947 minibuffer_auto_raise
= 0;
5950 /* On first pass, save all files that don't have handlers.
5951 On second pass, save all files that do have handlers.
5953 If Emacs is crashing, the handlers may tweak what is causing
5954 Emacs to crash in the first place, and it would be a shame if
5955 Emacs failed to autosave perfectly ordinary files because it
5956 couldn't handle some ange-ftp'd file. */
5958 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5959 for (tail
= Vbuffer_alist
; GC_CONSP (tail
); tail
= XCDR (tail
))
5961 buf
= XCDR (XCAR (tail
));
5964 /* Record all the buffers that have auto save mode
5965 in the special file that lists them. For each of these buffers,
5966 Record visited name (if any) and auto save name. */
5967 if (STRINGP (b
->auto_save_file_name
)
5968 && stream
!= NULL
&& do_handled_files
== 0)
5970 if (!NILP (b
->filename
))
5972 fwrite (SDATA (b
->filename
), 1,
5973 SBYTES (b
->filename
), stream
);
5975 putc ('\n', stream
);
5976 fwrite (SDATA (b
->auto_save_file_name
), 1,
5977 SBYTES (b
->auto_save_file_name
), stream
);
5978 putc ('\n', stream
);
5981 if (!NILP (current_only
)
5982 && b
!= current_buffer
)
5985 /* Don't auto-save indirect buffers.
5986 The base buffer takes care of it. */
5990 /* Check for auto save enabled
5991 and file changed since last auto save
5992 and file changed since last real save. */
5993 if (STRINGP (b
->auto_save_file_name
)
5994 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5995 && b
->auto_save_modified
< BUF_MODIFF (b
)
5996 /* -1 means we've turned off autosaving for a while--see below. */
5997 && XINT (b
->save_length
) >= 0
5998 && (do_handled_files
5999 || NILP (Ffind_file_name_handler (b
->auto_save_file_name
,
6002 EMACS_TIME before_time
, after_time
;
6004 EMACS_GET_TIME (before_time
);
6006 /* If we had a failure, don't try again for 20 minutes. */
6007 if (b
->auto_save_failure_time
>= 0
6008 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
6011 if ((XFASTINT (b
->save_length
) * 10
6012 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
6013 /* A short file is likely to change a large fraction;
6014 spare the user annoying messages. */
6015 && XFASTINT (b
->save_length
) > 5000
6016 /* These messages are frequent and annoying for `*mail*'. */
6017 && !EQ (b
->filename
, Qnil
)
6018 && NILP (no_message
))
6020 /* It has shrunk too much; turn off auto-saving here. */
6021 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
6022 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
6024 minibuffer_auto_raise
= 0;
6025 /* Turn off auto-saving until there's a real save,
6026 and prevent any more warnings. */
6027 XSETINT (b
->save_length
, -1);
6028 Fsleep_for (make_number (1), Qnil
);
6031 set_buffer_internal (b
);
6032 if (!auto_saved
&& NILP (no_message
))
6033 message1 ("Auto-saving...");
6034 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
6036 b
->auto_save_modified
= BUF_MODIFF (b
);
6037 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
6038 set_buffer_internal (old
);
6040 EMACS_GET_TIME (after_time
);
6042 /* If auto-save took more than 60 seconds,
6043 assume it was an NFS failure that got a timeout. */
6044 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
6045 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
6049 /* Prevent another auto save till enough input events come in. */
6050 record_auto_save ();
6052 if (auto_saved
&& NILP (no_message
))
6056 /* If we are going to restore an old message,
6057 give time to read ours. */
6058 sit_for (1, 0, 0, 0, 0);
6062 /* If we displayed a message and then restored a state
6063 with no message, leave a "done" message on the screen. */
6064 message1 ("Auto-saving...done");
6069 /* This restores the message-stack status. */
6070 unbind_to (count
, Qnil
);
6074 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
6075 Sset_buffer_auto_saved
, 0, 0, 0,
6076 doc
: /* Mark current buffer as auto-saved with its current text.
6077 No auto-save file will be written until the buffer changes again. */)
6080 current_buffer
->auto_save_modified
= MODIFF
;
6081 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
6082 current_buffer
->auto_save_failure_time
= -1;
6086 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
6087 Sclear_buffer_auto_save_failure
, 0, 0, 0,
6088 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
6091 current_buffer
->auto_save_failure_time
= -1;
6095 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
6097 doc
: /* Return t if current buffer has been auto-saved recently.
6098 More precisely, if it has been auto-saved since last read from or saved
6099 in the visited file. If the buffer has no visited file,
6100 then any auto-save counts as "recent". */)
6103 return (SAVE_MODIFF
< current_buffer
->auto_save_modified
) ? Qt
: Qnil
;
6106 /* Reading and completing file names */
6107 extern Lisp_Object
Ffile_name_completion (), Ffile_name_all_completions ();
6109 /* In the string VAL, change each $ to $$ and return the result. */
6112 double_dollars (val
)
6115 register const unsigned char *old
;
6116 register unsigned char *new;
6120 osize
= SBYTES (val
);
6122 /* Count the number of $ characters. */
6123 for (n
= osize
, count
= 0, old
= SDATA (val
); n
> 0; n
--)
6124 if (*old
++ == '$') count
++;
6128 val
= make_uninit_multibyte_string (SCHARS (val
) + count
,
6131 for (n
= osize
; n
> 0; n
--)
6145 read_file_name_cleanup (arg
)
6148 return (current_buffer
->directory
= arg
);
6151 DEFUN ("read-file-name-internal", Fread_file_name_internal
, Sread_file_name_internal
,
6153 doc
: /* Internal subroutine for read-file-name. Do not call this. */)
6154 (string
, dir
, action
)
6155 Lisp_Object string
, dir
, action
;
6156 /* action is nil for complete, t for return list of completions,
6157 lambda for verify final value */
6159 Lisp_Object name
, specdir
, realdir
, val
, orig_string
;
6161 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
6163 CHECK_STRING (string
);
6170 /* No need to protect ACTION--we only compare it with t and nil. */
6171 GCPRO5 (string
, realdir
, name
, specdir
, orig_string
);
6173 if (SCHARS (string
) == 0)
6175 if (EQ (action
, Qlambda
))
6183 orig_string
= string
;
6184 string
= Fsubstitute_in_file_name (string
);
6185 changed
= NILP (Fstring_equal (string
, orig_string
));
6186 name
= Ffile_name_nondirectory (string
);
6187 val
= Ffile_name_directory (string
);
6189 realdir
= Fexpand_file_name (val
, realdir
);
6194 specdir
= Ffile_name_directory (string
);
6195 val
= Ffile_name_completion (name
, realdir
);
6200 return double_dollars (string
);
6204 if (!NILP (specdir
))
6205 val
= concat2 (specdir
, val
);
6207 return double_dollars (val
);
6210 #endif /* not VMS */
6214 if (EQ (action
, Qt
))
6216 Lisp_Object all
= Ffile_name_all_completions (name
, realdir
);
6220 if (NILP (Vread_file_name_predicate
)
6221 || EQ (Vread_file_name_predicate
, Qfile_exists_p
))
6225 if (EQ (Vread_file_name_predicate
, Qfile_directory_p
))
6227 /* Brute-force speed up for directory checking:
6228 Discard strings which don't end in a slash. */
6229 for (comp
= Qnil
; CONSP (all
); all
= XCDR (all
))
6231 Lisp_Object tem
= XCAR (all
);
6233 if (STRINGP (tem
) &&
6234 (len
= SCHARS (tem
), len
> 0) &&
6235 IS_DIRECTORY_SEP (SREF (tem
, len
-1)))
6236 comp
= Fcons (tem
, comp
);
6242 /* Must do it the hard (and slow) way. */
6244 GCPRO3 (all
, comp
, specdir
);
6245 count
= SPECPDL_INDEX ();
6246 record_unwind_protect (read_file_name_cleanup
, current_buffer
->directory
);
6247 current_buffer
->directory
= realdir
;
6248 for (comp
= Qnil
; CONSP (all
); all
= XCDR (all
))
6250 tem
= call1 (Vread_file_name_predicate
, XCAR (all
));
6252 comp
= Fcons (XCAR (all
), comp
);
6254 unbind_to (count
, Qnil
);
6257 return Fnreverse (comp
);
6260 /* Only other case actually used is ACTION = lambda */
6262 /* Supposedly this helps commands such as `cd' that read directory names,
6263 but can someone explain how it helps them? -- RMS */
6264 if (SCHARS (name
) == 0)
6267 string
= Fexpand_file_name (string
, dir
);
6268 if (!NILP (Vread_file_name_predicate
))
6269 return call1 (Vread_file_name_predicate
, string
);
6270 return Ffile_exists_p (string
);
6273 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
6274 Snext_read_file_uses_dialog_p
, 0, 0, 0,
6275 doc
: /* Return t if a call to `read-file-name' will use a dialog.
6276 The return value is only relevant for a call to `read-file-name' that happens
6277 before any other event (mouse or keypress) is handeled. */)
6280 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6281 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
6290 DEFUN ("read-file-name", Fread_file_name
, Sread_file_name
, 1, 6, 0,
6291 doc
: /* Read file name, prompting with PROMPT and completing in directory DIR.
6292 Value is not expanded---you must call `expand-file-name' yourself.
6293 Default name to DEFAULT-FILENAME if user exits the minibuffer with
6294 the same non-empty string that was inserted by this function.
6295 (If DEFAULT-FILENAME is omitted, the visited file name is used,
6296 except that if INITIAL is specified, that combined with DIR is used.)
6297 If the user exits with an empty minibuffer, this function returns
6298 an empty string. (This can only happen if the user erased the
6299 pre-inserted contents or if `insert-default-directory' is nil.)
6300 Fourth arg MUSTMATCH non-nil means require existing file's name.
6301 Non-nil and non-t means also require confirmation after completion.
6302 Fifth arg INITIAL specifies text to start with.
6303 If optional sixth arg PREDICATE is non-nil, possible completions and
6304 the resulting file name must satisfy (funcall PREDICATE NAME).
6305 DIR should be an absolute directory name. It defaults to the value of
6306 `default-directory'.
6308 If this command was invoked with the mouse, use a file dialog box if
6309 `use-dialog-box' is non-nil, and the window system or X toolkit in use
6310 provides a file dialog box.
6312 See also `read-file-name-completion-ignore-case'
6313 and `read-file-name-function'. */)
6314 (prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
)
6315 Lisp_Object prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
;
6317 Lisp_Object val
, insdef
, tem
;
6318 struct gcpro gcpro1
, gcpro2
;
6319 register char *homedir
;
6320 Lisp_Object decoded_homedir
;
6321 int replace_in_history
= 0;
6322 int add_to_history
= 0;
6326 dir
= current_buffer
->directory
;
6327 if (NILP (Ffile_name_absolute_p (dir
)))
6328 dir
= Fexpand_file_name (dir
, Qnil
);
6329 if (NILP (default_filename
))
6332 ? Fexpand_file_name (initial
, dir
)
6333 : current_buffer
->filename
);
6335 /* If dir starts with user's homedir, change that to ~. */
6336 homedir
= (char *) egetenv ("HOME");
6338 /* homedir can be NULL in temacs, since Vglobal_environment is not
6339 yet set up. We shouldn't crash in that case. */
6342 homedir
= strcpy (alloca (strlen (homedir
) + 1), homedir
);
6343 CORRECT_DIR_SEPS (homedir
);
6348 = DECODE_FILE (make_unibyte_string (homedir
, strlen (homedir
)));
6351 && !strncmp (SDATA (decoded_homedir
), SDATA (dir
),
6352 SBYTES (decoded_homedir
))
6353 && IS_DIRECTORY_SEP (SREF (dir
, SBYTES (decoded_homedir
))))
6355 dir
= Fsubstring (dir
, make_number (SCHARS (decoded_homedir
)), Qnil
);
6356 dir
= concat2 (build_string ("~"), dir
);
6358 /* Likewise for default_filename. */
6360 && STRINGP (default_filename
)
6361 && !strncmp (SDATA (decoded_homedir
), SDATA (default_filename
),
6362 SBYTES (decoded_homedir
))
6363 && IS_DIRECTORY_SEP (SREF (default_filename
, SBYTES (decoded_homedir
))))
6366 = Fsubstring (default_filename
,
6367 make_number (SCHARS (decoded_homedir
)), Qnil
);
6368 default_filename
= concat2 (build_string ("~"), default_filename
);
6370 if (!NILP (default_filename
))
6372 CHECK_STRING (default_filename
);
6373 default_filename
= double_dollars (default_filename
);
6376 if (insert_default_directory
&& STRINGP (dir
))
6379 if (!NILP (initial
))
6381 Lisp_Object args
[2], pos
;
6385 insdef
= Fconcat (2, args
);
6386 pos
= make_number (SCHARS (double_dollars (dir
)));
6387 insdef
= Fcons (double_dollars (insdef
), pos
);
6390 insdef
= double_dollars (insdef
);
6392 else if (STRINGP (initial
))
6393 insdef
= Fcons (double_dollars (initial
), make_number (0));
6397 if (!NILP (Vread_file_name_function
))
6399 Lisp_Object args
[7];
6401 GCPRO2 (insdef
, default_filename
);
6402 args
[0] = Vread_file_name_function
;
6405 args
[3] = default_filename
;
6406 args
[4] = mustmatch
;
6408 args
[6] = predicate
;
6409 RETURN_UNGCPRO (Ffuncall (7, args
));
6412 count
= SPECPDL_INDEX ();
6413 specbind (intern ("completion-ignore-case"),
6414 read_file_name_completion_ignore_case
? Qt
: Qnil
);
6415 specbind (intern ("minibuffer-completing-file-name"), Qt
);
6416 specbind (intern ("read-file-name-predicate"),
6417 (NILP (predicate
) ? Qfile_exists_p
: predicate
));
6419 GCPRO2 (insdef
, default_filename
);
6421 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6422 if (! NILP (Fnext_read_file_uses_dialog_p ()))
6424 /* If DIR contains a file name, split it. */
6426 file
= Ffile_name_nondirectory (dir
);
6427 if (SCHARS (file
) && NILP (default_filename
))
6429 default_filename
= file
;
6430 dir
= Ffile_name_directory (dir
);
6432 if (!NILP(default_filename
))
6433 default_filename
= Fexpand_file_name (default_filename
, dir
);
6434 val
= Fx_file_dialog (prompt
, dir
, default_filename
, mustmatch
,
6435 EQ (predicate
, Qfile_directory_p
) ? Qt
: Qnil
);
6440 val
= Fcompleting_read (prompt
, intern ("read-file-name-internal"),
6441 dir
, mustmatch
, insdef
,
6442 Qfile_name_history
, default_filename
, Qnil
);
6444 tem
= Fsymbol_value (Qfile_name_history
);
6445 if (CONSP (tem
) && EQ (XCAR (tem
), val
))
6446 replace_in_history
= 1;
6448 /* If Fcompleting_read returned the inserted default string itself
6449 (rather than a new string with the same contents),
6450 it has to mean that the user typed RET with the minibuffer empty.
6451 In that case, we really want to return ""
6452 so that commands such as set-visited-file-name can distinguish. */
6453 if (EQ (val
, default_filename
))
6455 /* In this case, Fcompleting_read has not added an element
6456 to the history. Maybe we should. */
6457 if (! replace_in_history
)
6463 unbind_to (count
, Qnil
);
6466 error ("No file name specified");
6468 tem
= Fstring_equal (val
, CONSP (insdef
) ? XCAR (insdef
) : insdef
);
6470 if (!NILP (tem
) && !NILP (default_filename
))
6471 val
= default_filename
;
6472 val
= Fsubstitute_in_file_name (val
);
6474 if (replace_in_history
)
6475 /* Replace what Fcompleting_read added to the history
6476 with what we will actually return. */
6478 Lisp_Object val1
= double_dollars (val
);
6479 tem
= Fsymbol_value (Qfile_name_history
);
6480 if (history_delete_duplicates
)
6481 XSETCDR (tem
, Fdelete (val1
, XCDR(tem
)));
6482 XSETCAR (tem
, val1
);
6484 else if (add_to_history
)
6486 /* Add the value to the history--but not if it matches
6487 the last value already there. */
6488 Lisp_Object val1
= double_dollars (val
);
6489 tem
= Fsymbol_value (Qfile_name_history
);
6490 if (! CONSP (tem
) || NILP (Fequal (XCAR (tem
), val1
)))
6492 if (history_delete_duplicates
) tem
= Fdelete (val1
, tem
);
6493 Fset (Qfile_name_history
, Fcons (val1
, tem
));
6504 /* Must be set before any path manipulation is performed. */
6505 XSETFASTINT (Vdirectory_sep_char
, '/');
6512 Qoperations
= intern ("operations");
6513 Qexpand_file_name
= intern ("expand-file-name");
6514 Qsubstitute_in_file_name
= intern ("substitute-in-file-name");
6515 Qdirectory_file_name
= intern ("directory-file-name");
6516 Qfile_name_directory
= intern ("file-name-directory");
6517 Qfile_name_nondirectory
= intern ("file-name-nondirectory");
6518 Qunhandled_file_name_directory
= intern ("unhandled-file-name-directory");
6519 Qfile_name_as_directory
= intern ("file-name-as-directory");
6520 Qcopy_file
= intern ("copy-file");
6521 Qmake_directory_internal
= intern ("make-directory-internal");
6522 Qmake_directory
= intern ("make-directory");
6523 Qdelete_directory
= intern ("delete-directory");
6524 Qdelete_file
= intern ("delete-file");
6525 Qrename_file
= intern ("rename-file");
6526 Qadd_name_to_file
= intern ("add-name-to-file");
6527 Qmake_symbolic_link
= intern ("make-symbolic-link");
6528 Qfile_exists_p
= intern ("file-exists-p");
6529 Qfile_executable_p
= intern ("file-executable-p");
6530 Qfile_readable_p
= intern ("file-readable-p");
6531 Qfile_writable_p
= intern ("file-writable-p");
6532 Qfile_symlink_p
= intern ("file-symlink-p");
6533 Qaccess_file
= intern ("access-file");
6534 Qfile_directory_p
= intern ("file-directory-p");
6535 Qfile_regular_p
= intern ("file-regular-p");
6536 Qfile_accessible_directory_p
= intern ("file-accessible-directory-p");
6537 Qfile_modes
= intern ("file-modes");
6538 Qset_file_modes
= intern ("set-file-modes");
6539 Qset_file_times
= intern ("set-file-times");
6540 Qfile_newer_than_file_p
= intern ("file-newer-than-file-p");
6541 Qinsert_file_contents
= intern ("insert-file-contents");
6542 Qwrite_region
= intern ("write-region");
6543 Qverify_visited_file_modtime
= intern ("verify-visited-file-modtime");
6544 Qset_visited_file_modtime
= intern ("set-visited-file-modtime");
6545 Qauto_save_coding
= intern ("auto-save-coding");
6547 staticpro (&Qoperations
);
6548 staticpro (&Qexpand_file_name
);
6549 staticpro (&Qsubstitute_in_file_name
);
6550 staticpro (&Qdirectory_file_name
);
6551 staticpro (&Qfile_name_directory
);
6552 staticpro (&Qfile_name_nondirectory
);
6553 staticpro (&Qunhandled_file_name_directory
);
6554 staticpro (&Qfile_name_as_directory
);
6555 staticpro (&Qcopy_file
);
6556 staticpro (&Qmake_directory_internal
);
6557 staticpro (&Qmake_directory
);
6558 staticpro (&Qdelete_directory
);
6559 staticpro (&Qdelete_file
);
6560 staticpro (&Qrename_file
);
6561 staticpro (&Qadd_name_to_file
);
6562 staticpro (&Qmake_symbolic_link
);
6563 staticpro (&Qfile_exists_p
);
6564 staticpro (&Qfile_executable_p
);
6565 staticpro (&Qfile_readable_p
);
6566 staticpro (&Qfile_writable_p
);
6567 staticpro (&Qaccess_file
);
6568 staticpro (&Qfile_symlink_p
);
6569 staticpro (&Qfile_directory_p
);
6570 staticpro (&Qfile_regular_p
);
6571 staticpro (&Qfile_accessible_directory_p
);
6572 staticpro (&Qfile_modes
);
6573 staticpro (&Qset_file_modes
);
6574 staticpro (&Qset_file_times
);
6575 staticpro (&Qfile_newer_than_file_p
);
6576 staticpro (&Qinsert_file_contents
);
6577 staticpro (&Qwrite_region
);
6578 staticpro (&Qverify_visited_file_modtime
);
6579 staticpro (&Qset_visited_file_modtime
);
6580 staticpro (&Qauto_save_coding
);
6582 Qfile_name_history
= intern ("file-name-history");
6583 Fset (Qfile_name_history
, Qnil
);
6584 staticpro (&Qfile_name_history
);
6586 Qfile_error
= intern ("file-error");
6587 staticpro (&Qfile_error
);
6588 Qfile_already_exists
= intern ("file-already-exists");
6589 staticpro (&Qfile_already_exists
);
6590 Qfile_date_error
= intern ("file-date-error");
6591 staticpro (&Qfile_date_error
);
6592 Qexcl
= intern ("excl");
6596 Qfind_buffer_file_type
= intern ("find-buffer-file-type");
6597 staticpro (&Qfind_buffer_file_type
);
6600 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system
,
6601 doc
: /* *Coding system for encoding file names.
6602 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6603 Vfile_name_coding_system
= Qnil
;
6605 DEFVAR_LISP ("default-file-name-coding-system",
6606 &Vdefault_file_name_coding_system
,
6607 doc
: /* Default coding system for encoding file names.
6608 This variable is used only when `file-name-coding-system' is nil.
6610 This variable is set/changed by the command `set-language-environment'.
6611 User should not set this variable manually,
6612 instead use `file-name-coding-system' to get a constant encoding
6613 of file names regardless of the current language environment. */);
6614 Vdefault_file_name_coding_system
= Qnil
;
6616 Qformat_decode
= intern ("format-decode");
6617 staticpro (&Qformat_decode
);
6618 Qformat_annotate_function
= intern ("format-annotate-function");
6619 staticpro (&Qformat_annotate_function
);
6620 Qafter_insert_file_set_coding
= intern ("after-insert-file-set-coding");
6621 staticpro (&Qafter_insert_file_set_coding
);
6623 Qcar_less_than_car
= intern ("car-less-than-car");
6624 staticpro (&Qcar_less_than_car
);
6626 Fput (Qfile_error
, Qerror_conditions
,
6627 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
)));
6628 Fput (Qfile_error
, Qerror_message
,
6629 build_string ("File error"));
6631 Fput (Qfile_already_exists
, Qerror_conditions
,
6632 Fcons (Qfile_already_exists
,
6633 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
))));
6634 Fput (Qfile_already_exists
, Qerror_message
,
6635 build_string ("File already exists"));
6637 Fput (Qfile_date_error
, Qerror_conditions
,
6638 Fcons (Qfile_date_error
,
6639 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
))));
6640 Fput (Qfile_date_error
, Qerror_message
,
6641 build_string ("Cannot set file date"));
6643 DEFVAR_LISP ("read-file-name-function", &Vread_file_name_function
,
6644 doc
: /* If this is non-nil, `read-file-name' does its work by calling this function. */);
6645 Vread_file_name_function
= Qnil
;
6647 DEFVAR_LISP ("read-file-name-predicate", &Vread_file_name_predicate
,
6648 doc
: /* Current predicate used by `read-file-name-internal'. */);
6649 Vread_file_name_predicate
= Qnil
;
6651 DEFVAR_BOOL ("read-file-name-completion-ignore-case", &read_file_name_completion_ignore_case
,
6652 doc
: /* *Non-nil means when reading a file name completion ignores case. */);
6653 #if defined VMS || defined DOS_NT || defined MAC_OS
6654 read_file_name_completion_ignore_case
= 1;
6656 read_file_name_completion_ignore_case
= 0;
6659 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory
,
6660 doc
: /* *Non-nil means when reading a filename start with default dir in minibuffer.
6661 If the initial minibuffer contents are non-empty, you can usually
6662 request a default filename by typing RETURN without editing. For some
6663 commands, exiting with an empty minibuffer has a special meaning,
6664 such as making the current buffer visit no file in the case of
6665 `set-visited-file-name'.
6666 If this variable is non-nil, the minibuffer contents are always
6667 initially non-empty and typing RETURN without editing will fetch the
6668 default name, if one is provided. Note however that this default name
6669 is not necessarily the name originally inserted in the minibuffer, if
6670 that is just the default directory.
6671 If this variable is nil, the minibuffer often starts out empty. In
6672 that case you may have to explicitly fetch the next history element to
6673 request the default name. */);
6674 insert_default_directory
= 1;
6676 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm
,
6677 doc
: /* *Non-nil means write new files with record format `stmlf'.
6678 nil means use format `var'. This variable is meaningful only on VMS. */);
6679 vms_stmlf_recfm
= 0;
6681 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char
,
6682 doc
: /* Directory separator character for built-in functions that return file names.
6683 The value is always ?/. Don't use this variable, just use `/'. */);
6685 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist
,
6686 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6687 If a file name matches REGEXP, then all I/O on that file is done by calling
6690 The first argument given to HANDLER is the name of the I/O primitive
6691 to be handled; the remaining arguments are the arguments that were
6692 passed to that primitive. For example, if you do
6693 (file-exists-p FILENAME)
6694 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6695 (funcall HANDLER 'file-exists-p FILENAME)
6696 The function `find-file-name-handler' checks this list for a handler
6697 for its argument. */);
6698 Vfile_name_handler_alist
= Qnil
;
6700 DEFVAR_LISP ("set-auto-coding-function",
6701 &Vset_auto_coding_function
,
6702 doc
: /* If non-nil, a function to call to decide a coding system of file.
6703 Two arguments are passed to this function: the file name
6704 and the length of a file contents following the point.
6705 This function should return a coding system to decode the file contents.
6706 It should check the file name against `auto-coding-alist'.
6707 If no coding system is decided, it should check a coding system
6708 specified in the heading lines with the format:
6709 -*- ... coding: CODING-SYSTEM; ... -*-
6710 or local variable spec of the tailing lines with `coding:' tag. */);
6711 Vset_auto_coding_function
= Qnil
;
6713 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions
,
6714 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
6715 Each is passed one argument, the number of characters inserted.
6716 It should return the new character count, and leave point the same.
6717 If `insert-file-contents' is intercepted by a handler from
6718 `file-name-handler-alist', that handler is responsible for calling the
6719 functions in `after-insert-file-functions' if appropriate. */);
6720 Vafter_insert_file_functions
= Qnil
;
6722 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions
,
6723 doc
: /* A list of functions to be called at the start of `write-region'.
6724 Each is passed two arguments, START and END as for `write-region'.
6725 These are usually two numbers but not always; see the documentation
6726 for `write-region'. The function should return a list of pairs
6727 of the form (POSITION . STRING), consisting of strings to be effectively
6728 inserted at the specified positions of the file being written (1 means to
6729 insert before the first byte written). The POSITIONs must be sorted into
6730 increasing order. If there are several functions in the list, the several
6731 lists are merged destructively. Alternatively, the function can return
6732 with a different buffer current; in that case it should pay attention
6733 to the annotations returned by previous functions and listed in
6734 `write-region-annotations-so-far'.*/);
6735 Vwrite_region_annotate_functions
= Qnil
;
6736 staticpro (&Qwrite_region_annotate_functions
);
6737 Qwrite_region_annotate_functions
6738 = intern ("write-region-annotate-functions");
6740 DEFVAR_LISP ("write-region-annotations-so-far",
6741 &Vwrite_region_annotations_so_far
,
6742 doc
: /* When an annotation function is called, this holds the previous annotations.
6743 These are the annotations made by other annotation functions
6744 that were already called. See also `write-region-annotate-functions'. */);
6745 Vwrite_region_annotations_so_far
= Qnil
;
6747 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers
,
6748 doc
: /* A list of file name handlers that temporarily should not be used.
6749 This applies only to the operation `inhibit-file-name-operation'. */);
6750 Vinhibit_file_name_handlers
= Qnil
;
6752 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation
,
6753 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6754 Vinhibit_file_name_operation
= Qnil
;
6756 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name
,
6757 doc
: /* File name in which we write a list of all auto save file names.
6758 This variable is initialized automatically from `auto-save-list-file-prefix'
6759 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6760 a non-nil value. */);
6761 Vauto_save_list_file_name
= Qnil
;
6764 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync
,
6765 doc
: /* *Non-nil means don't call fsync in `write-region'.
6766 This variable affects calls to `write-region' as well as save commands.
6767 A non-nil value may result in data loss! */);
6768 write_region_inhibit_fsync
= 0;
6771 defsubr (&Sfind_file_name_handler
);
6772 defsubr (&Sfile_name_directory
);
6773 defsubr (&Sfile_name_nondirectory
);
6774 defsubr (&Sunhandled_file_name_directory
);
6775 defsubr (&Sfile_name_as_directory
);
6776 defsubr (&Sdirectory_file_name
);
6777 defsubr (&Smake_temp_name
);
6778 defsubr (&Sexpand_file_name
);
6779 defsubr (&Ssubstitute_in_file_name
);
6780 defsubr (&Scopy_file
);
6781 defsubr (&Smake_directory_internal
);
6782 defsubr (&Sdelete_directory
);
6783 defsubr (&Sdelete_file
);
6784 defsubr (&Srename_file
);
6785 defsubr (&Sadd_name_to_file
);
6787 defsubr (&Smake_symbolic_link
);
6788 #endif /* S_IFLNK */
6790 defsubr (&Sdefine_logical_name
);
6793 defsubr (&Ssysnetunam
);
6794 #endif /* HPUX_NET */
6795 defsubr (&Sfile_name_absolute_p
);
6796 defsubr (&Sfile_exists_p
);
6797 defsubr (&Sfile_executable_p
);
6798 defsubr (&Sfile_readable_p
);
6799 defsubr (&Sfile_writable_p
);
6800 defsubr (&Saccess_file
);
6801 defsubr (&Sfile_symlink_p
);
6802 defsubr (&Sfile_directory_p
);
6803 defsubr (&Sfile_accessible_directory_p
);
6804 defsubr (&Sfile_regular_p
);
6805 defsubr (&Sfile_modes
);
6806 defsubr (&Sset_file_modes
);
6807 defsubr (&Sset_file_times
);
6808 defsubr (&Sset_default_file_modes
);
6809 defsubr (&Sdefault_file_modes
);
6810 defsubr (&Sfile_newer_than_file_p
);
6811 defsubr (&Sinsert_file_contents
);
6812 defsubr (&Swrite_region
);
6813 defsubr (&Scar_less_than_car
);
6814 defsubr (&Sverify_visited_file_modtime
);
6815 defsubr (&Sclear_visited_file_modtime
);
6816 defsubr (&Svisited_file_modtime
);
6817 defsubr (&Sset_visited_file_modtime
);
6818 defsubr (&Sdo_auto_save
);
6819 defsubr (&Sset_buffer_auto_saved
);
6820 defsubr (&Sclear_buffer_auto_save_failure
);
6821 defsubr (&Srecent_auto_save_p
);
6823 defsubr (&Sread_file_name_internal
);
6824 defsubr (&Sread_file_name
);
6825 defsubr (&Snext_read_file_uses_dialog_p
);
6828 defsubr (&Sunix_sync
);
6832 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
6833 (do not change this comment) */