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, 2006 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"
86 #endif /* not WINDOWSNT */
90 #include <sys/param.h>
98 #define CORRECT_DIR_SEPS(s) \
99 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
100 else unixtodos_filename (s); \
102 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
103 redirector allows the six letters between 'Z' and 'a' as well. */
105 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
108 #define IS_DRIVE(x) isalpha (x)
110 /* Need to lower-case the drive letter, or else expanded
111 filenames will sometimes compare inequal, because
112 `expand-file-name' doesn't always down-case the drive letter. */
113 #define DRIVE_LETTER(x) (tolower (x))
134 #include "commands.h"
135 extern int use_dialog_box
;
136 extern int use_file_dialog
;
150 #ifndef FILE_SYSTEM_CASE
151 #define FILE_SYSTEM_CASE(filename) (filename)
154 /* Nonzero during writing of auto-save files */
157 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
158 a new file with the same mode as the original */
159 int auto_save_mode_bits
;
161 /* The symbol bound to coding-system-for-read when
162 insert-file-contents is called for recovering a file. This is not
163 an actual coding system name, but just an indicator to tell
164 insert-file-contents to use `emacs-mule' with a special flag for
165 auto saving and recovering a file. */
166 Lisp_Object Qauto_save_coding
;
168 /* Coding system for file names, or nil if none. */
169 Lisp_Object Vfile_name_coding_system
;
171 /* Coding system for file names used only when
172 Vfile_name_coding_system is nil. */
173 Lisp_Object Vdefault_file_name_coding_system
;
175 /* Alist of elements (REGEXP . HANDLER) for file names
176 whose I/O is done with a special handler. */
177 Lisp_Object Vfile_name_handler_alist
;
179 /* Property name of a file name handler,
180 which gives a list of operations it handles.. */
181 Lisp_Object Qoperations
;
183 /* Lisp functions for translating file formats */
184 Lisp_Object Qformat_decode
, Qformat_annotate_function
;
186 /* Function to be called to decide a coding system of a reading file. */
187 Lisp_Object Vset_auto_coding_function
;
189 /* Functions to be called to process text properties in inserted file. */
190 Lisp_Object Vafter_insert_file_functions
;
192 /* Lisp function for setting buffer-file-coding-system and the
193 multibyteness of the current buffer after inserting a file. */
194 Lisp_Object Qafter_insert_file_set_coding
;
196 /* Functions to be called to create text property annotations for file. */
197 Lisp_Object Vwrite_region_annotate_functions
;
198 Lisp_Object Qwrite_region_annotate_functions
;
200 /* During build_annotations, each time an annotation function is called,
201 this holds the annotations made by the previous functions. */
202 Lisp_Object Vwrite_region_annotations_so_far
;
204 /* File name in which we write a list of all our auto save files. */
205 Lisp_Object Vauto_save_list_file_name
;
207 /* Function to call to read a file name. */
208 Lisp_Object Vread_file_name_function
;
210 /* Current predicate used by read_file_name_internal. */
211 Lisp_Object Vread_file_name_predicate
;
213 /* Nonzero means completion ignores case when reading file name. */
214 int read_file_name_completion_ignore_case
;
216 /* Nonzero means, when reading a filename in the minibuffer,
217 start out by inserting the default directory into the minibuffer. */
218 int insert_default_directory
;
220 /* On VMS, nonzero means write new files with record format stmlf.
221 Zero means use var format. */
224 /* On NT, specifies the directory separator character, used (eg.) when
225 expanding file names. This can be bound to / or \. */
226 Lisp_Object Vdirectory_sep_char
;
229 /* Nonzero means skip the call to fsync in Fwrite-region. */
230 int write_region_inhibit_fsync
;
233 extern Lisp_Object Vuser_login_name
;
236 extern Lisp_Object Vw32_get_true_file_attributes
;
239 extern int minibuf_level
;
241 extern int minibuffer_auto_raise
;
243 extern int history_delete_duplicates
;
245 /* These variables describe handlers that have "already" had a chance
246 to handle the current operation.
248 Vinhibit_file_name_handlers is a list of file name handlers.
249 Vinhibit_file_name_operation is the operation being handled.
250 If we try to handle that operation, we ignore those handlers. */
252 static Lisp_Object Vinhibit_file_name_handlers
;
253 static Lisp_Object Vinhibit_file_name_operation
;
255 Lisp_Object Qfile_error
, Qfile_already_exists
, Qfile_date_error
;
257 Lisp_Object Qfile_name_history
;
259 Lisp_Object Qcar_less_than_car
;
261 static int a_write
P_ ((int, Lisp_Object
, int, int,
262 Lisp_Object
*, struct coding_system
*));
263 static int e_write
P_ ((int, Lisp_Object
, int, int, struct coding_system
*));
267 report_file_error (string
, data
)
271 Lisp_Object errstring
;
274 synchronize_system_messages_locale ();
275 errstring
= code_convert_string_norecord (build_string (strerror (errorno
)),
276 Vlocale_coding_system
, 0);
282 Fsignal (Qfile_already_exists
, Fcons (errstring
, data
));
285 /* System error messages are capitalized. Downcase the initial
286 unless it is followed by a slash. */
287 if (SREF (errstring
, 1) != '/')
288 SSET (errstring
, 0, DOWNCASE (SREF (errstring
, 0)));
290 Fsignal (Qfile_error
,
291 Fcons (build_string (string
), Fcons (errstring
, data
)));
296 close_file_unwind (fd
)
299 emacs_close (XFASTINT (fd
));
303 /* Restore point, having saved it as a marker. */
306 restore_point_unwind (location
)
307 Lisp_Object location
;
309 Fgoto_char (location
);
310 Fset_marker (location
, Qnil
, Qnil
);
314 Lisp_Object Qexpand_file_name
;
315 Lisp_Object Qsubstitute_in_file_name
;
316 Lisp_Object Qdirectory_file_name
;
317 Lisp_Object Qfile_name_directory
;
318 Lisp_Object Qfile_name_nondirectory
;
319 Lisp_Object Qunhandled_file_name_directory
;
320 Lisp_Object Qfile_name_as_directory
;
321 Lisp_Object Qcopy_file
;
322 Lisp_Object Qmake_directory_internal
;
323 Lisp_Object Qmake_directory
;
324 Lisp_Object Qdelete_directory
;
325 Lisp_Object Qdelete_file
;
326 Lisp_Object Qrename_file
;
327 Lisp_Object Qadd_name_to_file
;
328 Lisp_Object Qmake_symbolic_link
;
329 Lisp_Object Qfile_exists_p
;
330 Lisp_Object Qfile_executable_p
;
331 Lisp_Object Qfile_readable_p
;
332 Lisp_Object Qfile_writable_p
;
333 Lisp_Object Qfile_symlink_p
;
334 Lisp_Object Qaccess_file
;
335 Lisp_Object Qfile_directory_p
;
336 Lisp_Object Qfile_regular_p
;
337 Lisp_Object Qfile_accessible_directory_p
;
338 Lisp_Object Qfile_modes
;
339 Lisp_Object Qset_file_modes
;
340 Lisp_Object Qset_file_times
;
341 Lisp_Object Qfile_newer_than_file_p
;
342 Lisp_Object Qinsert_file_contents
;
343 Lisp_Object Qwrite_region
;
344 Lisp_Object Qverify_visited_file_modtime
;
345 Lisp_Object Qset_visited_file_modtime
;
347 DEFUN ("find-file-name-handler", Ffind_file_name_handler
, Sfind_file_name_handler
, 2, 2, 0,
348 doc
: /* Return FILENAME's handler function for OPERATION, if it has one.
349 Otherwise, return nil.
350 A file name is handled if one of the regular expressions in
351 `file-name-handler-alist' matches it.
353 If OPERATION equals `inhibit-file-name-operation', then we ignore
354 any handlers that are members of `inhibit-file-name-handlers',
355 but we still do run any other handlers. This lets handlers
356 use the standard functions without calling themselves recursively. */)
357 (filename
, operation
)
358 Lisp_Object filename
, operation
;
360 /* This function must not munge the match data. */
361 Lisp_Object chain
, inhibited_handlers
, result
;
365 CHECK_STRING (filename
);
367 if (EQ (operation
, Vinhibit_file_name_operation
))
368 inhibited_handlers
= Vinhibit_file_name_handlers
;
370 inhibited_handlers
= Qnil
;
372 for (chain
= Vfile_name_handler_alist
; CONSP (chain
);
373 chain
= XCDR (chain
))
379 Lisp_Object string
= XCAR (elt
);
381 Lisp_Object handler
= XCDR (elt
);
382 Lisp_Object operations
= Qnil
;
384 if (SYMBOLP (handler
))
385 operations
= Fget (handler
, Qoperations
);
388 && (match_pos
= fast_string_match (string
, filename
)) > pos
389 && (NILP (operations
) || ! NILP (Fmemq (operation
, operations
))))
393 handler
= XCDR (elt
);
394 tem
= Fmemq (handler
, inhibited_handlers
);
408 DEFUN ("file-name-directory", Ffile_name_directory
, Sfile_name_directory
,
410 doc
: /* Return the directory component in file name FILENAME.
411 Return nil if FILENAME does not include a directory.
412 Otherwise return a directory spec.
413 Given a Unix syntax file name, returns a string ending in slash;
414 on VMS, perhaps instead a string ending in `:', `]' or `>'. */)
416 Lisp_Object filename
;
419 register const unsigned char *beg
;
421 register unsigned char *beg
;
423 register const unsigned char *p
;
426 CHECK_STRING (filename
);
428 /* If the file name has special constructs in it,
429 call the corresponding file handler. */
430 handler
= Ffind_file_name_handler (filename
, Qfile_name_directory
);
432 return call2 (handler
, Qfile_name_directory
, filename
);
434 filename
= FILE_SYSTEM_CASE (filename
);
435 beg
= SDATA (filename
);
437 beg
= strcpy (alloca (strlen (beg
) + 1), beg
);
439 p
= beg
+ SBYTES (filename
);
441 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
443 && p
[-1] != ':' && p
[-1] != ']' && p
[-1] != '>'
446 /* only recognise drive specifier at the beginning */
448 /* handle the "/:d:foo" and "/:foo" cases correctly */
449 && ((p
== beg
+ 2 && !IS_DIRECTORY_SEP (*beg
))
450 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
457 /* Expansion of "c:" to drive and default directory. */
460 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
461 unsigned char *res
= alloca (MAXPATHLEN
+ 1);
462 unsigned char *r
= res
;
464 if (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
) && beg
[1] == ':')
466 strncpy (res
, beg
, 2);
471 if (getdefdir (toupper (*beg
) - 'A' + 1, r
))
473 if (!IS_DIRECTORY_SEP (res
[strlen (res
) - 1]))
476 p
= beg
+ strlen (beg
);
479 CORRECT_DIR_SEPS (beg
);
482 return make_specified_string (beg
, -1, p
- beg
, STRING_MULTIBYTE (filename
));
485 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory
,
486 Sfile_name_nondirectory
, 1, 1, 0,
487 doc
: /* Return file name FILENAME sans its directory.
488 For example, in a Unix-syntax file name,
489 this is everything after the last slash,
490 or the entire name if it contains no slash. */)
492 Lisp_Object filename
;
494 register const unsigned char *beg
, *p
, *end
;
497 CHECK_STRING (filename
);
499 /* If the file name has special constructs in it,
500 call the corresponding file handler. */
501 handler
= Ffind_file_name_handler (filename
, Qfile_name_nondirectory
);
503 return call2 (handler
, Qfile_name_nondirectory
, filename
);
505 beg
= SDATA (filename
);
506 end
= p
= beg
+ SBYTES (filename
);
508 while (p
!= beg
&& !IS_DIRECTORY_SEP (p
[-1])
510 && p
[-1] != ':' && p
[-1] != ']' && p
[-1] != '>'
513 /* only recognise drive specifier at beginning */
515 /* handle the "/:d:foo" case correctly */
516 && (p
== beg
+ 2 || (p
== beg
+ 4 && IS_DIRECTORY_SEP (*beg
))))
521 return make_specified_string (p
, -1, end
- p
, STRING_MULTIBYTE (filename
));
524 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory
,
525 Sunhandled_file_name_directory
, 1, 1, 0,
526 doc
: /* Return a directly usable directory name somehow associated with FILENAME.
527 A `directly usable' directory name is one that may be used without the
528 intervention of any file handler.
529 If FILENAME is a directly usable file itself, return
530 \(file-name-directory FILENAME).
531 The `call-process' and `start-process' functions use this function to
532 get a current directory to run processes in. */)
534 Lisp_Object filename
;
538 /* If the file name has special constructs in it,
539 call the corresponding file handler. */
540 handler
= Ffind_file_name_handler (filename
, Qunhandled_file_name_directory
);
542 return call2 (handler
, Qunhandled_file_name_directory
, filename
);
544 return Ffile_name_directory (filename
);
549 file_name_as_directory (out
, in
)
552 int size
= strlen (in
) - 1;
565 /* Is it already a directory string? */
566 if (in
[size
] == ':' || in
[size
] == ']' || in
[size
] == '>')
568 /* Is it a VMS directory file name? If so, hack VMS syntax. */
569 else if (! index (in
, '/')
570 && ((size
> 3 && ! strcmp (&in
[size
- 3], ".DIR"))
571 || (size
> 3 && ! strcmp (&in
[size
- 3], ".dir"))
572 || (size
> 5 && (! strncmp (&in
[size
- 5], ".DIR", 4)
573 || ! strncmp (&in
[size
- 5], ".dir", 4))
574 && (in
[size
- 1] == '.' || in
[size
- 1] == ';')
575 && in
[size
] == '1')))
577 register char *p
, *dot
;
581 dir:x.dir --> dir:[x]
582 dir:[x]y.dir --> dir:[x.y] */
584 while (p
!= in
&& *p
!= ':' && *p
!= '>' && *p
!= ']') p
--;
587 strncpy (out
, in
, p
- in
);
606 dot
= index (p
, '.');
609 /* blindly remove any extension */
610 size
= strlen (out
) + (dot
- p
);
611 strncat (out
, p
, dot
- p
);
622 /* For Unix syntax, Append a slash if necessary */
623 if (!IS_DIRECTORY_SEP (out
[size
]))
625 /* Cannot use DIRECTORY_SEP, which could have any value */
627 out
[size
+ 2] = '\0';
630 CORRECT_DIR_SEPS (out
);
636 DEFUN ("file-name-as-directory", Ffile_name_as_directory
,
637 Sfile_name_as_directory
, 1, 1, 0,
638 doc
: /* Return a string representing the file name FILE interpreted as a directory.
639 This operation exists because a directory is also a file, but its name as
640 a directory is different from its name as a file.
641 The result can be used as the value of `default-directory'
642 or passed as second argument to `expand-file-name'.
643 For a Unix-syntax file name, just appends a slash.
644 On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc. */)
655 /* If the file name has special constructs in it,
656 call the corresponding file handler. */
657 handler
= Ffind_file_name_handler (file
, Qfile_name_as_directory
);
659 return call2 (handler
, Qfile_name_as_directory
, file
);
661 buf
= (char *) alloca (SBYTES (file
) + 10);
662 file_name_as_directory (buf
, SDATA (file
));
663 return make_specified_string (buf
, -1, strlen (buf
),
664 STRING_MULTIBYTE (file
));
668 * Convert from directory name to filename.
670 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
671 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
672 * On UNIX, it's simple: just make sure there isn't a terminating /
674 * Value is nonzero if the string output is different from the input.
678 directory_file_name (src
, dst
)
686 struct FAB fab
= cc$rms_fab
;
687 struct NAM nam
= cc$rms_nam
;
688 char esa
[NAM$C_MAXRSS
];
693 if (! index (src
, '/')
694 && (src
[slen
- 1] == ']'
695 || src
[slen
- 1] == ':'
696 || src
[slen
- 1] == '>'))
698 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
700 fab
.fab$b_fns
= slen
;
701 fab
.fab$l_nam
= &nam
;
702 fab
.fab$l_fop
= FAB$M_NAM
;
705 nam
.nam$b_ess
= sizeof esa
;
706 nam
.nam$b_nop
|= NAM$M_SYNCHK
;
708 /* We call SYS$PARSE to handle such things as [--] for us. */
709 if (SYS$
PARSE (&fab
, 0, 0) == RMS$_NORMAL
)
711 slen
= nam
.nam$b_esl
;
712 if (esa
[slen
- 1] == ';' && esa
[slen
- 2] == '.')
717 if (src
[slen
- 1] != ']' && src
[slen
- 1] != '>')
719 /* what about when we have logical_name:???? */
720 if (src
[slen
- 1] == ':')
721 { /* Xlate logical name and see what we get */
722 ptr
= strcpy (dst
, src
); /* upper case for getenv */
725 if ('a' <= *ptr
&& *ptr
<= 'z')
729 dst
[slen
- 1] = 0; /* remove colon */
730 if (!(src
= egetenv (dst
)))
732 /* should we jump to the beginning of this procedure?
733 Good points: allows us to use logical names that xlate
735 Bad points: can be a problem if we just translated to a device
737 For now, I'll punt and always expect VMS names, and hope for
740 if (src
[slen
- 1] != ']' && src
[slen
- 1] != '>')
741 { /* no recursion here! */
747 { /* not a directory spec */
752 bracket
= src
[slen
- 1];
754 /* If bracket is ']' or '>', bracket - 2 is the corresponding
756 ptr
= index (src
, bracket
- 2);
758 { /* no opening bracket */
762 if (!(rptr
= rindex (src
, '.')))
765 strncpy (dst
, src
, slen
);
769 dst
[slen
++] = bracket
;
774 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
775 then translate the device and recurse. */
776 if (dst
[slen
- 1] == ':'
777 && dst
[slen
- 2] != ':' /* skip decnet nodes */
778 && strcmp (src
+ slen
, "[000000]") == 0)
780 dst
[slen
- 1] = '\0';
781 if ((ptr
= egetenv (dst
))
782 && (rlen
= strlen (ptr
) - 1) > 0
783 && (ptr
[rlen
] == ']' || ptr
[rlen
] == '>')
784 && ptr
[rlen
- 1] == '.')
786 char * buf
= (char *) alloca (strlen (ptr
) + 1);
790 return directory_file_name (buf
, dst
);
795 strcat (dst
, "[000000]");
799 rlen
= strlen (rptr
) - 1;
800 strncat (dst
, rptr
, rlen
);
801 dst
[slen
+ rlen
] = '\0';
802 strcat (dst
, ".DIR.1");
806 /* Process as Unix format: just remove any final slash.
807 But leave "/" unchanged; do not change it to "". */
810 /* Handle // as root for apollo's. */
811 if ((slen
> 2 && dst
[slen
- 1] == '/')
812 || (slen
> 1 && dst
[0] != '/' && dst
[slen
- 1] == '/'))
816 && IS_DIRECTORY_SEP (dst
[slen
- 1])
818 && !IS_ANY_SEP (dst
[slen
- 2])
824 CORRECT_DIR_SEPS (dst
);
829 DEFUN ("directory-file-name", Fdirectory_file_name
, Sdirectory_file_name
,
831 doc
: /* Returns the file name of the directory named DIRECTORY.
832 This is the name of the file that holds the data for the directory DIRECTORY.
833 This operation exists because a directory is also a file, but its name as
834 a directory is different from its name as a file.
835 In Unix-syntax, this function just removes the final slash.
836 On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
837 it returns a file name such as \"[X]Y.DIR.1\". */)
839 Lisp_Object directory
;
844 CHECK_STRING (directory
);
846 if (NILP (directory
))
849 /* If the file name has special constructs in it,
850 call the corresponding file handler. */
851 handler
= Ffind_file_name_handler (directory
, Qdirectory_file_name
);
853 return call2 (handler
, Qdirectory_file_name
, directory
);
856 /* 20 extra chars is insufficient for VMS, since we might perform a
857 logical name translation. an equivalence string can be up to 255
858 chars long, so grab that much extra space... - sss */
859 buf
= (char *) alloca (SBYTES (directory
) + 20 + 255);
861 buf
= (char *) alloca (SBYTES (directory
) + 20);
863 directory_file_name (SDATA (directory
), buf
);
864 return make_specified_string (buf
, -1, strlen (buf
),
865 STRING_MULTIBYTE (directory
));
868 static char make_temp_name_tbl
[64] =
870 'A','B','C','D','E','F','G','H',
871 'I','J','K','L','M','N','O','P',
872 'Q','R','S','T','U','V','W','X',
873 'Y','Z','a','b','c','d','e','f',
874 'g','h','i','j','k','l','m','n',
875 'o','p','q','r','s','t','u','v',
876 'w','x','y','z','0','1','2','3',
877 '4','5','6','7','8','9','-','_'
880 static unsigned make_temp_name_count
, make_temp_name_count_initialized_p
;
882 /* Value is a temporary file name starting with PREFIX, a string.
884 The Emacs process number forms part of the result, so there is
885 no danger of generating a name being used by another process.
886 In addition, this function makes an attempt to choose a name
887 which has no existing file. To make this work, PREFIX should be
888 an absolute file name.
890 BASE64_P non-zero means add the pid as 3 characters in base64
891 encoding. In this case, 6 characters will be added to PREFIX to
892 form the file name. Otherwise, if Emacs is running on a system
893 with long file names, add the pid as a decimal number.
895 This function signals an error if no unique file name could be
899 make_temp_name (prefix
, base64_p
)
906 unsigned char *p
, *data
;
910 CHECK_STRING (prefix
);
912 /* VAL is created by adding 6 characters to PREFIX. The first
913 three are the PID of this process, in base 64, and the second
914 three are incremented if the file already exists. This ensures
915 262144 unique file names per PID per PREFIX. */
917 pid
= (int) getpid ();
921 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
922 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
923 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
928 #ifdef HAVE_LONG_FILE_NAMES
929 sprintf (pidbuf
, "%d", pid
);
930 pidlen
= strlen (pidbuf
);
932 pidbuf
[0] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
933 pidbuf
[1] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
934 pidbuf
[2] = make_temp_name_tbl
[pid
& 63], pid
>>= 6;
939 len
= SBYTES (prefix
); clen
= SCHARS (prefix
);
940 val
= make_uninit_multibyte_string (clen
+ 3 + pidlen
, len
+ 3 + pidlen
);
941 if (!STRING_MULTIBYTE (prefix
))
942 STRING_SET_UNIBYTE (val
);
944 bcopy(SDATA (prefix
), data
, len
);
947 bcopy (pidbuf
, p
, pidlen
);
950 /* Here we try to minimize useless stat'ing when this function is
951 invoked many times successively with the same PREFIX. We achieve
952 this by initializing count to a random value, and incrementing it
955 We don't want make-temp-name to be called while dumping,
956 because then make_temp_name_count_initialized_p would get set
957 and then make_temp_name_count would not be set when Emacs starts. */
959 if (!make_temp_name_count_initialized_p
)
961 make_temp_name_count
= (unsigned) time (NULL
);
962 make_temp_name_count_initialized_p
= 1;
968 unsigned num
= make_temp_name_count
;
970 p
[0] = make_temp_name_tbl
[num
& 63], num
>>= 6;
971 p
[1] = make_temp_name_tbl
[num
& 63], num
>>= 6;
972 p
[2] = make_temp_name_tbl
[num
& 63], num
>>= 6;
974 /* Poor man's congruential RN generator. Replace with
975 ++make_temp_name_count for debugging. */
976 make_temp_name_count
+= 25229;
977 make_temp_name_count
%= 225307;
979 if (stat (data
, &ignored
) < 0)
981 /* We want to return only if errno is ENOENT. */
985 /* The error here is dubious, but there is little else we
986 can do. The alternatives are to return nil, which is
987 as bad as (and in many cases worse than) throwing the
988 error, or to ignore the error, which will likely result
989 in looping through 225307 stat's, which is not only
990 dog-slow, but also useless since it will fallback to
991 the errow below, anyway. */
992 report_file_error ("Cannot create temporary name for prefix",
993 Fcons (prefix
, Qnil
));
998 error ("Cannot create temporary name for prefix `%s'",
1004 DEFUN ("make-temp-name", Fmake_temp_name
, Smake_temp_name
, 1, 1, 0,
1005 doc
: /* Generate temporary file name (string) starting with PREFIX (a string).
1006 The Emacs process number forms part of the result,
1007 so there is no danger of generating a name being used by another process.
1009 In addition, this function makes an attempt to choose a name
1010 which has no existing file. To make this work,
1011 PREFIX should be an absolute file name.
1013 There is a race condition between calling `make-temp-name' and creating the
1014 file which opens all kinds of security holes. For that reason, you should
1015 probably use `make-temp-file' instead, except in three circumstances:
1017 * If you are creating the file in the user's home directory.
1018 * If you are creating a directory rather than an ordinary file.
1019 * If you are taking special precautions as `make-temp-file' does. */)
1023 return make_temp_name (prefix
, 0);
1028 DEFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1029 doc
: /* Convert filename NAME to absolute, and canonicalize it.
1030 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1031 \(does not start with slash); if DEFAULT-DIRECTORY is nil or missing,
1032 the current buffer's value of `default-directory' is used.
1033 File name components that are `.' are removed, and
1034 so are file name components followed by `..', along with the `..' itself;
1035 note that these simplifications are done without checking the resulting
1036 file names in the file system.
1037 An initial `~/' expands to your home directory.
1038 An initial `~USER/' expands to USER's home directory.
1039 See also the function `substitute-in-file-name'. */)
1040 (name
, default_directory
)
1041 Lisp_Object name
, default_directory
;
1045 register unsigned char *newdir
, *p
, *o
;
1047 unsigned char *target
;
1050 unsigned char * colon
= 0;
1051 unsigned char * close
= 0;
1052 unsigned char * slash
= 0;
1053 unsigned char * brack
= 0;
1054 int lbrack
= 0, rbrack
= 0;
1059 int collapse_newdir
= 1;
1063 Lisp_Object handler
, result
;
1066 CHECK_STRING (name
);
1068 /* If the file name has special constructs in it,
1069 call the corresponding file handler. */
1070 handler
= Ffind_file_name_handler (name
, Qexpand_file_name
);
1071 if (!NILP (handler
))
1072 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
1074 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
1075 if (NILP (default_directory
))
1076 default_directory
= current_buffer
->directory
;
1077 if (! STRINGP (default_directory
))
1080 /* "/" is not considered a root directory on DOS_NT, so using "/"
1081 here causes an infinite recursion in, e.g., the following:
1083 (let (default-directory)
1084 (expand-file-name "a"))
1086 To avoid this, we set default_directory to the root of the
1088 extern char *emacs_root_dir (void);
1090 default_directory
= build_string (emacs_root_dir ());
1092 default_directory
= build_string ("/");
1096 if (!NILP (default_directory
))
1098 handler
= Ffind_file_name_handler (default_directory
, Qexpand_file_name
);
1099 if (!NILP (handler
))
1100 return call3 (handler
, Qexpand_file_name
, name
, default_directory
);
1103 o
= SDATA (default_directory
);
1105 /* Make sure DEFAULT_DIRECTORY is properly expanded.
1106 It would be better to do this down below where we actually use
1107 default_directory. Unfortunately, calling Fexpand_file_name recursively
1108 could invoke GC, and the strings might be relocated. This would
1109 be annoying because we have pointers into strings lying around
1110 that would need adjusting, and people would add new pointers to
1111 the code and forget to adjust them, resulting in intermittent bugs.
1112 Putting this call here avoids all that crud.
1114 The EQ test avoids infinite recursion. */
1115 if (! NILP (default_directory
) && !EQ (default_directory
, name
)
1116 /* Save time in some common cases - as long as default_directory
1117 is not relative, it can be canonicalized with name below (if it
1118 is needed at all) without requiring it to be expanded now. */
1120 /* Detect MSDOS file names with drive specifiers. */
1121 && ! (IS_DRIVE (o
[0]) && IS_DEVICE_SEP (o
[1]) && IS_DIRECTORY_SEP (o
[2]))
1123 /* Detect Windows file names in UNC format. */
1124 && ! (IS_DIRECTORY_SEP (o
[0]) && IS_DIRECTORY_SEP (o
[1]))
1126 #else /* not DOS_NT */
1127 /* Detect Unix absolute file names (/... alone is not absolute on
1129 && ! (IS_DIRECTORY_SEP (o
[0]))
1130 #endif /* not DOS_NT */
1133 struct gcpro gcpro1
;
1136 default_directory
= Fexpand_file_name (default_directory
, Qnil
);
1140 name
= FILE_SYSTEM_CASE (name
);
1142 multibyte
= STRING_MULTIBYTE (name
);
1145 /* We will force directory separators to be either all \ or /, so make
1146 a local copy to modify, even if there ends up being no change. */
1147 nm
= strcpy (alloca (strlen (nm
) + 1), nm
);
1149 /* Note if special escape prefix is present, but remove for now. */
1150 if (nm
[0] == '/' && nm
[1] == ':')
1156 /* Find and remove drive specifier if present; this makes nm absolute
1157 even if the rest of the name appears to be relative. Only look for
1158 drive specifier at the beginning. */
1159 if (IS_DRIVE (nm
[0]) && IS_DEVICE_SEP (nm
[1]))
1166 /* If we see "c://somedir", we want to strip the first slash after the
1167 colon when stripping the drive letter. Otherwise, this expands to
1169 if (drive
&& IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1171 #endif /* WINDOWSNT */
1175 /* Discard any previous drive specifier if nm is now in UNC format. */
1176 if (IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1182 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
1183 none are found, we can probably return right away. We will avoid
1184 allocating a new string if name is already fully expanded. */
1186 IS_DIRECTORY_SEP (nm
[0])
1188 && drive
&& !is_escaped
1191 && (drive
|| IS_DIRECTORY_SEP (nm
[1])) && !is_escaped
1198 /* If it turns out that the filename we want to return is just a
1199 suffix of FILENAME, we don't need to go through and edit
1200 things; we just need to construct a new string using data
1201 starting at the middle of FILENAME. If we set lose to a
1202 non-zero value, that means we've discovered that we can't do
1209 /* Since we know the name is absolute, we can assume that each
1210 element starts with a "/". */
1212 /* "." and ".." are hairy. */
1213 if (IS_DIRECTORY_SEP (p
[0])
1215 && (IS_DIRECTORY_SEP (p
[2])
1217 || (p
[2] == '.' && (IS_DIRECTORY_SEP (p
[3])
1220 /* We want to replace multiple `/' in a row with a single
1223 && IS_DIRECTORY_SEP (p
[0])
1224 && IS_DIRECTORY_SEP (p
[1]))
1231 /* if dev:[dir]/, move nm to / */
1232 if (!slash
&& p
> nm
&& (brack
|| colon
)) {
1233 nm
= (brack
? brack
+ 1 : colon
+ 1);
1234 lbrack
= rbrack
= 0;
1241 #ifdef NO_HYPHENS_IN_FILENAMES
1242 if (lbrack
== rbrack
)
1244 /* Avoid clobbering negative version numbers. */
1249 #endif /* NO_HYPHENS_IN_FILENAMES */
1250 if (lbrack
> rbrack
&&
1251 ((p
[-1] == '.' || p
[-1] == '[' || p
[-1] == '<') &&
1252 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>')))
1254 #ifdef NO_HYPHENS_IN_FILENAMES
1257 #endif /* NO_HYPHENS_IN_FILENAMES */
1258 /* count open brackets, reset close bracket pointer */
1259 if (p
[0] == '[' || p
[0] == '<')
1260 lbrack
++, brack
= 0;
1261 /* count close brackets, set close bracket pointer */
1262 if (p
[0] == ']' || p
[0] == '>')
1263 rbrack
++, brack
= p
;
1264 /* detect ][ or >< */
1265 if ((p
[0] == ']' || p
[0] == '>') && (p
[1] == '[' || p
[1] == '<'))
1267 if ((p
[0] == ':' || p
[0] == ']' || p
[0] == '>') && p
[1] == '~')
1268 nm
= p
+ 1, lose
= 1;
1269 if (p
[0] == ':' && (colon
|| slash
))
1270 /* if dev1:[dir]dev2:, move nm to dev2: */
1276 /* if /name/dev:, move nm to dev: */
1279 /* if node::dev:, move colon following dev */
1280 else if (colon
&& colon
[-1] == ':')
1282 /* if dev1:dev2:, move nm to dev2: */
1283 else if (colon
&& colon
[-1] != ':')
1288 if (p
[0] == ':' && !colon
)
1294 if (lbrack
== rbrack
)
1297 else if (p
[0] == '.')
1305 if (index (nm
, '/'))
1307 nm
= sys_translate_unix (nm
);
1308 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1312 /* Make sure directories are all separated with / or \ as
1313 desired, but avoid allocation of a new string when not
1315 CORRECT_DIR_SEPS (nm
);
1317 if (IS_DIRECTORY_SEP (nm
[1]))
1319 if (strcmp (nm
, SDATA (name
)) != 0)
1320 name
= make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1324 /* drive must be set, so this is okay */
1325 if (strcmp (nm
- 2, SDATA (name
)) != 0)
1329 name
= make_specified_string (nm
, -1, p
- nm
, multibyte
);
1330 temp
[0] = DRIVE_LETTER (drive
);
1331 name
= concat2 (build_string (temp
), name
);
1334 #else /* not DOS_NT */
1335 if (nm
== SDATA (name
))
1337 return make_specified_string (nm
, -1, strlen (nm
), multibyte
);
1338 #endif /* not DOS_NT */
1342 /* At this point, nm might or might not be an absolute file name. We
1343 need to expand ~ or ~user if present, otherwise prefix nm with
1344 default_directory if nm is not absolute, and finally collapse /./
1345 and /foo/../ sequences.
1347 We set newdir to be the appropriate prefix if one is needed:
1348 - the relevant user directory if nm starts with ~ or ~user
1349 - the specified drive's working dir (DOS/NT only) if nm does not
1351 - the value of default_directory.
1353 Note that these prefixes are not guaranteed to be absolute (except
1354 for the working dir of a drive). Therefore, to ensure we always
1355 return an absolute name, if the final prefix is not absolute we
1356 append it to the current working directory. */
1360 if (nm
[0] == '~') /* prefix ~ */
1362 if (IS_DIRECTORY_SEP (nm
[1])
1366 || nm
[1] == 0) /* ~ by itself */
1368 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1369 newdir
= (unsigned char *) "";
1372 collapse_newdir
= 0;
1375 nm
++; /* Don't leave the slash in nm. */
1378 else /* ~user/filename */
1380 for (p
= nm
; *p
&& (!IS_DIRECTORY_SEP (*p
)
1385 o
= (unsigned char *) alloca (p
- nm
+ 1);
1386 bcopy ((char *) nm
, o
, p
- nm
);
1389 pw
= (struct passwd
*) getpwnam (o
+ 1);
1392 newdir
= (unsigned char *) pw
-> pw_dir
;
1394 nm
= p
+ 1; /* skip the terminator */
1398 collapse_newdir
= 0;
1403 /* If we don't find a user of that name, leave the name
1404 unchanged; don't move nm forward to p. */
1409 /* On DOS and Windows, nm is absolute if a drive name was specified;
1410 use the drive's current directory as the prefix if needed. */
1411 if (!newdir
&& drive
)
1413 /* Get default directory if needed to make nm absolute. */
1414 if (!IS_DIRECTORY_SEP (nm
[0]))
1416 newdir
= alloca (MAXPATHLEN
+ 1);
1417 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1422 /* Either nm starts with /, or drive isn't mounted. */
1423 newdir
= alloca (4);
1424 newdir
[0] = DRIVE_LETTER (drive
);
1432 /* Finally, if no prefix has been specified and nm is not absolute,
1433 then it must be expanded relative to default_directory. */
1437 /* /... alone is not absolute on DOS and Windows. */
1438 && !IS_DIRECTORY_SEP (nm
[0])
1441 && !(IS_DIRECTORY_SEP (nm
[0]) && IS_DIRECTORY_SEP (nm
[1]))
1448 newdir
= SDATA (default_directory
);
1449 multibyte
|= STRING_MULTIBYTE (default_directory
);
1451 /* Note if special escape prefix is present, but remove for now. */
1452 if (newdir
[0] == '/' && newdir
[1] == ':')
1463 /* First ensure newdir is an absolute name. */
1465 /* Detect MSDOS file names with drive specifiers. */
1466 ! (IS_DRIVE (newdir
[0])
1467 && IS_DEVICE_SEP (newdir
[1]) && IS_DIRECTORY_SEP (newdir
[2]))
1469 /* Detect Windows file names in UNC format. */
1470 && ! (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1474 /* Effectively, let newdir be (expand-file-name newdir cwd).
1475 Because of the admonition against calling expand-file-name
1476 when we have pointers into lisp strings, we accomplish this
1477 indirectly by prepending newdir to nm if necessary, and using
1478 cwd (or the wd of newdir's drive) as the new newdir. */
1480 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1485 if (!IS_DIRECTORY_SEP (nm
[0]))
1487 char * tmp
= alloca (strlen (newdir
) + strlen (nm
) + 2);
1488 file_name_as_directory (tmp
, newdir
);
1492 newdir
= alloca (MAXPATHLEN
+ 1);
1495 if (!getdefdir (toupper (drive
) - 'A' + 1, newdir
))
1502 /* Strip off drive name from prefix, if present. */
1503 if (IS_DRIVE (newdir
[0]) && IS_DEVICE_SEP (newdir
[1]))
1509 /* Keep only a prefix from newdir if nm starts with slash
1510 (//server/share for UNC, nothing otherwise). */
1511 if (IS_DIRECTORY_SEP (nm
[0]) && collapse_newdir
)
1514 if (IS_DIRECTORY_SEP (newdir
[0]) && IS_DIRECTORY_SEP (newdir
[1]))
1516 newdir
= strcpy (alloca (strlen (newdir
) + 1), newdir
);
1518 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1520 while (*p
&& !IS_DIRECTORY_SEP (*p
)) p
++;
1532 /* Get rid of any slash at the end of newdir, unless newdir is
1533 just / or // (an incomplete UNC name). */
1534 length
= strlen (newdir
);
1535 if (length
> 1 && IS_DIRECTORY_SEP (newdir
[length
- 1])
1537 && !(length
== 2 && IS_DIRECTORY_SEP (newdir
[0]))
1541 unsigned char *temp
= (unsigned char *) alloca (length
);
1542 bcopy (newdir
, temp
, length
- 1);
1543 temp
[length
- 1] = 0;
1551 /* Now concatenate the directory and name to new space in the stack frame */
1552 tlen
+= strlen (nm
) + 1;
1554 /* Reserve space for drive specifier and escape prefix, since either
1555 or both may need to be inserted. (The Microsoft x86 compiler
1556 produces incorrect code if the following two lines are combined.) */
1557 target
= (unsigned char *) alloca (tlen
+ 4);
1559 #else /* not DOS_NT */
1560 target
= (unsigned char *) alloca (tlen
);
1561 #endif /* not DOS_NT */
1567 if (nm
[0] == 0 || IS_DIRECTORY_SEP (nm
[0]))
1570 /* If newdir is effectively "C:/", then the drive letter will have
1571 been stripped and newdir will be "/". Concatenating with an
1572 absolute directory in nm produces "//", which will then be
1573 incorrectly treated as a network share. Ignore newdir in
1574 this case (keeping the drive letter). */
1575 if (!(drive
&& nm
[0] && IS_DIRECTORY_SEP (newdir
[0])
1576 && newdir
[1] == '\0'))
1578 strcpy (target
, newdir
);
1582 file_name_as_directory (target
, newdir
);
1585 strcat (target
, nm
);
1587 if (index (target
, '/'))
1588 strcpy (target
, sys_translate_unix (target
));
1591 /* ASSERT (IS_DIRECTORY_SEP (target[0])) if not VMS */
1593 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1602 if (*p
!= ']' && *p
!= '>' && *p
!= '-')
1608 else if ((p
[0] == ']' || p
[0] == '>') && p
[0] == p
[1] + 2)
1609 /* brackets are offset from each other by 2 */
1612 if (*p
!= '.' && *p
!= '-' && o
[-1] != '.')
1613 /* convert [foo][bar] to [bar] */
1614 while (o
[-1] != '[' && o
[-1] != '<')
1616 else if (*p
== '-' && *o
!= '.')
1619 else if (p
[0] == '-' && o
[-1] == '.' &&
1620 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>'))
1621 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1625 while (o
[-1] != '.' && o
[-1] != '[' && o
[-1] != '<');
1626 if (p
[1] == '.') /* foo.-.bar ==> bar. */
1628 else if (o
[-1] == '.') /* '.foo.-]' ==> ']' */
1630 /* else [foo.-] ==> [-] */
1634 #ifdef NO_HYPHENS_IN_FILENAMES
1636 o
[-1] != '[' && o
[-1] != '<' && o
[-1] != '.' &&
1637 p
[1] != ']' && p
[1] != '>' && p
[1] != '.')
1639 #endif /* NO_HYPHENS_IN_FILENAMES */
1643 if (!IS_DIRECTORY_SEP (*p
))
1647 else if (p
[1] == '.'
1648 && (IS_DIRECTORY_SEP (p
[2])
1651 /* If "/." is the entire filename, keep the "/". Otherwise,
1652 just delete the whole "/.". */
1653 if (o
== target
&& p
[2] == '\0')
1657 else if (p
[1] == '.' && p
[2] == '.'
1658 /* `/../' is the "superroot" on certain file systems.
1659 Turned off on DOS_NT systems because they have no
1660 "superroot" and because this causes us to produce
1661 file names like "d:/../foo" which fail file-related
1662 functions of the underlying OS. (To reproduce, try a
1663 long series of "../../" in default_directory, longer
1664 than the number of levels from the root.) */
1668 && (IS_DIRECTORY_SEP (p
[3]) || p
[3] == 0))
1670 while (o
!= target
&& (--o
) && !IS_DIRECTORY_SEP (*o
))
1672 /* Keep initial / only if this is the whole name. */
1673 if (o
== target
&& IS_ANY_SEP (*o
) && p
[3] == 0)
1677 else if (p
> target
&& IS_DIRECTORY_SEP (p
[1]))
1678 /* Collapse multiple `/' in a row. */
1684 #endif /* not VMS */
1688 /* At last, set drive name. */
1690 /* Except for network file name. */
1691 if (!(IS_DIRECTORY_SEP (target
[0]) && IS_DIRECTORY_SEP (target
[1])))
1692 #endif /* WINDOWSNT */
1694 if (!drive
) abort ();
1696 target
[0] = DRIVE_LETTER (drive
);
1699 /* Reinsert the escape prefix if required. */
1706 CORRECT_DIR_SEPS (target
);
1709 result
= make_specified_string (target
, -1, o
- target
, multibyte
);
1711 /* Again look to see if the file name has special constructs in it
1712 and perhaps call the corresponding file handler. This is needed
1713 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1714 the ".." component gives us "/user@host:/bar/../baz" which needs
1715 to be expanded again. */
1716 handler
= Ffind_file_name_handler (result
, Qexpand_file_name
);
1717 if (!NILP (handler
))
1718 return call3 (handler
, Qexpand_file_name
, result
, default_directory
);
1724 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1725 This is the old version of expand-file-name, before it was thoroughly
1726 rewritten for Emacs 10.31. We leave this version here commented-out,
1727 because the code is very complex and likely to have subtle bugs. If
1728 bugs _are_ found, it might be of interest to look at the old code and
1729 see what did it do in the relevant situation.
1731 Don't remove this code: it's true that it will be accessible via CVS,
1732 but a few years from deletion, people will forget it is there. */
1734 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1735 DEAFUN ("expand-file-name", Fexpand_file_name
, Sexpand_file_name
, 1, 2, 0,
1736 "Convert FILENAME to absolute, and canonicalize it.\n\
1737 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1738 \(does not start with slash); if DEFAULT is nil or missing,\n\
1739 the current buffer's value of default-directory is used.\n\
1740 Filenames containing `.' or `..' as components are simplified;\n\
1741 initial `~/' expands to your home directory.\n\
1742 See also the function `substitute-in-file-name'.")
1744 Lisp_Object name
, defalt
;
1748 register unsigned char *newdir
, *p
, *o
;
1750 unsigned char *target
;
1754 unsigned char * colon
= 0;
1755 unsigned char * close
= 0;
1756 unsigned char * slash
= 0;
1757 unsigned char * brack
= 0;
1758 int lbrack
= 0, rbrack
= 0;
1762 CHECK_STRING (name
);
1765 /* Filenames on VMS are always upper case. */
1766 name
= Fupcase (name
);
1771 /* If nm is absolute, flush ...// and detect /./ and /../.
1772 If no /./ or /../ we can return right away. */
1784 if (p
[0] == '/' && p
[1] == '/'
1786 /* // at start of filename is meaningful on Apollo system. */
1791 if (p
[0] == '/' && p
[1] == '~')
1792 nm
= p
+ 1, lose
= 1;
1793 if (p
[0] == '/' && p
[1] == '.'
1794 && (p
[2] == '/' || p
[2] == 0
1795 || (p
[2] == '.' && (p
[3] == '/' || p
[3] == 0))))
1801 /* if dev:[dir]/, move nm to / */
1802 if (!slash
&& p
> nm
&& (brack
|| colon
)) {
1803 nm
= (brack
? brack
+ 1 : colon
+ 1);
1804 lbrack
= rbrack
= 0;
1812 /* VMS pre V4.4,convert '-'s in filenames. */
1813 if (lbrack
== rbrack
)
1815 if (dots
< 2) /* this is to allow negative version numbers */
1820 if (lbrack
> rbrack
&&
1821 ((p
[-1] == '.' || p
[-1] == '[' || p
[-1] == '<') &&
1822 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>')))
1828 /* count open brackets, reset close bracket pointer */
1829 if (p
[0] == '[' || p
[0] == '<')
1830 lbrack
++, brack
= 0;
1831 /* count close brackets, set close bracket pointer */
1832 if (p
[0] == ']' || p
[0] == '>')
1833 rbrack
++, brack
= p
;
1834 /* detect ][ or >< */
1835 if ((p
[0] == ']' || p
[0] == '>') && (p
[1] == '[' || p
[1] == '<'))
1837 if ((p
[0] == ':' || p
[0] == ']' || p
[0] == '>') && p
[1] == '~')
1838 nm
= p
+ 1, lose
= 1;
1839 if (p
[0] == ':' && (colon
|| slash
))
1840 /* if dev1:[dir]dev2:, move nm to dev2: */
1846 /* If /name/dev:, move nm to dev: */
1849 /* If node::dev:, move colon following dev */
1850 else if (colon
&& colon
[-1] == ':')
1852 /* If dev1:dev2:, move nm to dev2: */
1853 else if (colon
&& colon
[-1] != ':')
1858 if (p
[0] == ':' && !colon
)
1864 if (lbrack
== rbrack
)
1867 else if (p
[0] == '.')
1875 if (index (nm
, '/'))
1876 return build_string (sys_translate_unix (nm
));
1878 if (nm
== SDATA (name
))
1880 return build_string (nm
);
1884 /* Now determine directory to start with and put it in NEWDIR */
1888 if (nm
[0] == '~') /* prefix ~ */
1893 || nm
[1] == 0)/* ~/filename */
1895 if (!(newdir
= (unsigned char *) egetenv ("HOME")))
1896 newdir
= (unsigned char *) "";
1899 nm
++; /* Don't leave the slash in nm. */
1902 else /* ~user/filename */
1904 /* Get past ~ to user */
1905 unsigned char *user
= nm
+ 1;
1906 /* Find end of name. */
1907 unsigned char *ptr
= (unsigned char *) index (user
, '/');
1908 int len
= ptr
? ptr
- user
: strlen (user
);
1910 unsigned char *ptr1
= index (user
, ':');
1911 if (ptr1
!= 0 && ptr1
- user
< len
)
1914 /* Copy the user name into temp storage. */
1915 o
= (unsigned char *) alloca (len
+ 1);
1916 bcopy ((char *) user
, o
, len
);
1919 /* Look up the user name. */
1920 pw
= (struct passwd
*) getpwnam (o
+ 1);
1922 error ("\"%s\" isn't a registered user", o
+ 1);
1924 newdir
= (unsigned char *) pw
->pw_dir
;
1926 /* Discard the user name from NM. */
1933 #endif /* not VMS */
1937 defalt
= current_buffer
->directory
;
1938 CHECK_STRING (defalt
);
1939 newdir
= SDATA (defalt
);
1942 /* Now concatenate the directory and name to new space in the stack frame */
1944 tlen
= (newdir
? strlen (newdir
) + 1 : 0) + strlen (nm
) + 1;
1945 target
= (unsigned char *) alloca (tlen
);
1951 if (nm
[0] == 0 || nm
[0] == '/')
1952 strcpy (target
, newdir
);
1955 file_name_as_directory (target
, newdir
);
1958 strcat (target
, nm
);
1960 if (index (target
, '/'))
1961 strcpy (target
, sys_translate_unix (target
));
1964 /* Now canonicalize by removing /. and /foo/.. if they appear */
1972 if (*p
!= ']' && *p
!= '>' && *p
!= '-')
1978 else if ((p
[0] == ']' || p
[0] == '>') && p
[0] == p
[1] + 2)
1979 /* brackets are offset from each other by 2 */
1982 if (*p
!= '.' && *p
!= '-' && o
[-1] != '.')
1983 /* convert [foo][bar] to [bar] */
1984 while (o
[-1] != '[' && o
[-1] != '<')
1986 else if (*p
== '-' && *o
!= '.')
1989 else if (p
[0] == '-' && o
[-1] == '.' &&
1990 (p
[1] == '.' || p
[1] == ']' || p
[1] == '>'))
1991 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1995 while (o
[-1] != '.' && o
[-1] != '[' && o
[-1] != '<');
1996 if (p
[1] == '.') /* foo.-.bar ==> bar. */
1998 else if (o
[-1] == '.') /* '.foo.-]' ==> ']' */
2000 /* else [foo.-] ==> [-] */
2006 o
[-1] != '[' && o
[-1] != '<' && o
[-1] != '.' &&
2007 p
[1] != ']' && p
[1] != '>' && p
[1] != '.')
2017 else if (!strncmp (p
, "//", 2)
2019 /* // at start of filename is meaningful in Apollo system. */
2027 else if (p
[0] == '/' && p
[1] == '.' &&
2028 (p
[2] == '/' || p
[2] == 0))
2030 else if (!strncmp (p
, "/..", 3)
2031 /* `/../' is the "superroot" on certain file systems. */
2033 && (p
[3] == '/' || p
[3] == 0))
2035 while (o
!= target
&& *--o
!= '/')
2038 if (o
== target
+ 1 && o
[-1] == '/' && o
[0] == '/')
2042 if (o
== target
&& *o
== '/')
2050 #endif /* not VMS */
2053 return make_string (target
, o
- target
);
2057 /* If /~ or // appears, discard everything through first slash. */
2059 file_name_absolute_p (filename
)
2060 const unsigned char *filename
;
2063 (IS_DIRECTORY_SEP (*filename
) || *filename
== '~'
2065 /* ??? This criterion is probably wrong for '<'. */
2066 || index (filename
, ':') || index (filename
, '<')
2067 || (*filename
== '[' && (filename
[1] != '-'
2068 || (filename
[2] != '.' && filename
[2] != ']'))
2069 && filename
[1] != '.')
2072 || (IS_DRIVE (*filename
) && IS_DEVICE_SEP (filename
[1])
2073 && IS_DIRECTORY_SEP (filename
[2]))
2078 static unsigned char *
2079 search_embedded_absfilename (nm
, endp
)
2080 unsigned char *nm
, *endp
;
2082 unsigned char *p
, *s
;
2084 for (p
= nm
+ 1; p
< endp
; p
++)
2088 || p
[-1] == ':' || p
[-1] == ']' || p
[-1] == '>'
2090 || IS_DIRECTORY_SEP (p
[-1]))
2091 && file_name_absolute_p (p
)
2092 #if defined (APOLLO) || defined (WINDOWSNT) || defined(CYGWIN)
2093 /* // at start of file name is meaningful in Apollo,
2094 WindowsNT and Cygwin systems. */
2095 && !(IS_DIRECTORY_SEP (p
[0]) && p
- 1 == nm
)
2096 #endif /* not (APOLLO || WINDOWSNT || CYGWIN) */
2099 for (s
= p
; *s
&& (!IS_DIRECTORY_SEP (*s
)
2104 if (p
[0] == '~' && s
> p
+ 1) /* we've got "/~something/" */
2106 unsigned char *o
= alloca (s
- p
+ 1);
2108 bcopy (p
, o
, s
- p
);
2111 /* If we have ~user and `user' exists, discard
2112 everything up to ~. But if `user' does not exist, leave
2113 ~user alone, it might be a literal file name. */
2114 if ((pw
= getpwnam (o
+ 1)))
2126 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name
,
2127 Ssubstitute_in_file_name
, 1, 1, 0,
2128 doc
: /* Substitute environment variables referred to in FILENAME.
2129 `$FOO' where FOO is an environment variable name means to substitute
2130 the value of that variable. The variable name should be terminated
2131 with a character not a letter, digit or underscore; otherwise, enclose
2132 the entire variable name in braces.
2133 If `/~' appears, all of FILENAME through that `/' is discarded.
2135 On VMS, `$' substitution is not done; this function does little and only
2136 duplicates what `expand-file-name' does. */)
2138 Lisp_Object filename
;
2142 register unsigned char *s
, *p
, *o
, *x
, *endp
;
2143 unsigned char *target
= NULL
;
2145 int substituted
= 0;
2147 Lisp_Object handler
;
2149 CHECK_STRING (filename
);
2151 /* If the file name has special constructs in it,
2152 call the corresponding file handler. */
2153 handler
= Ffind_file_name_handler (filename
, Qsubstitute_in_file_name
);
2154 if (!NILP (handler
))
2155 return call2 (handler
, Qsubstitute_in_file_name
, filename
);
2157 nm
= SDATA (filename
);
2159 nm
= strcpy (alloca (strlen (nm
) + 1), nm
);
2160 CORRECT_DIR_SEPS (nm
);
2161 substituted
= (strcmp (nm
, SDATA (filename
)) != 0);
2163 endp
= nm
+ SBYTES (filename
);
2165 /* If /~ or // appears, discard everything through first slash. */
2166 p
= search_embedded_absfilename (nm
, endp
);
2168 /* Start over with the new string, so we check the file-name-handler
2169 again. Important with filenames like "/home/foo//:/hello///there"
2170 which whould substitute to "/:/hello///there" rather than "/there". */
2171 return Fsubstitute_in_file_name
2172 (make_specified_string (p
, -1, endp
- p
,
2173 STRING_MULTIBYTE (filename
)));
2179 /* See if any variables are substituted into the string
2180 and find the total length of their values in `total' */
2182 for (p
= nm
; p
!= endp
;)
2192 /* "$$" means a single "$" */
2201 while (p
!= endp
&& *p
!= '}') p
++;
2202 if (*p
!= '}') goto missingclose
;
2208 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
2212 /* Copy out the variable name */
2213 target
= (unsigned char *) alloca (s
- o
+ 1);
2214 strncpy (target
, o
, s
- o
);
2217 strupr (target
); /* $home == $HOME etc. */
2220 /* Get variable value */
2221 o
= (unsigned char *) egetenv (target
);
2224 total
+= strlen (o
);
2234 /* If substitution required, recopy the string and do it */
2235 /* Make space in stack frame for the new copy */
2236 xnm
= (unsigned char *) alloca (SBYTES (filename
) + total
+ 1);
2239 /* Copy the rest of the name through, replacing $ constructs with values */
2256 while (p
!= endp
&& *p
!= '}') p
++;
2257 if (*p
!= '}') goto missingclose
;
2263 while (p
!= endp
&& (isalnum (*p
) || *p
== '_')) p
++;
2267 /* Copy out the variable name */
2268 target
= (unsigned char *) alloca (s
- o
+ 1);
2269 strncpy (target
, o
, s
- o
);
2272 strupr (target
); /* $home == $HOME etc. */
2275 /* Get variable value */
2276 o
= (unsigned char *) egetenv (target
);
2280 strcpy (x
, target
); x
+= strlen (target
);
2282 else if (STRING_MULTIBYTE (filename
))
2284 /* If the original string is multibyte,
2285 convert what we substitute into multibyte. */
2288 int c
= unibyte_char_to_multibyte (*o
++);
2289 x
+= CHAR_STRING (c
, x
);
2301 /* If /~ or // appears, discard everything through first slash. */
2302 while ((p
= search_embedded_absfilename (xnm
, x
)))
2303 /* This time we do not start over because we've already expanded envvars
2304 and replaced $$ with $. Maybe we should start over as well, but we'd
2305 need to quote some $ to $$ first. */
2308 return make_specified_string (xnm
, -1, x
- xnm
, STRING_MULTIBYTE (filename
));
2311 error ("Bad format environment-variable substitution");
2313 error ("Missing \"}\" in environment-variable substitution");
2315 error ("Substituting nonexistent environment variable \"%s\"", target
);
2318 #endif /* not VMS */
2322 /* A slightly faster and more convenient way to get
2323 (directory-file-name (expand-file-name FOO)). */
2326 expand_and_dir_to_file (filename
, defdir
)
2327 Lisp_Object filename
, defdir
;
2329 register Lisp_Object absname
;
2331 absname
= Fexpand_file_name (filename
, defdir
);
2334 register int c
= SREF (absname
, SBYTES (absname
) - 1);
2335 if (c
== ':' || c
== ']' || c
== '>')
2336 absname
= Fdirectory_file_name (absname
);
2339 /* Remove final slash, if any (unless this is the root dir).
2340 stat behaves differently depending! */
2341 if (SCHARS (absname
) > 1
2342 && IS_DIRECTORY_SEP (SREF (absname
, SBYTES (absname
) - 1))
2343 && !IS_DEVICE_SEP (SREF (absname
, SBYTES (absname
)-2)))
2344 /* We cannot take shortcuts; they might be wrong for magic file names. */
2345 absname
= Fdirectory_file_name (absname
);
2350 /* Signal an error if the file ABSNAME already exists.
2351 If INTERACTIVE is nonzero, ask the user whether to proceed,
2352 and bypass the error if the user says to go ahead.
2353 QUERYSTRING is a name for the action that is being considered
2356 *STATPTR is used to store the stat information if the file exists.
2357 If the file does not exist, STATPTR->st_mode is set to 0.
2358 If STATPTR is null, we don't store into it.
2360 If QUICK is nonzero, we ask for y or n, not yes or no. */
2363 barf_or_query_if_file_exists (absname
, querystring
, interactive
, statptr
, quick
)
2364 Lisp_Object absname
;
2365 unsigned char *querystring
;
2367 struct stat
*statptr
;
2370 register Lisp_Object tem
, encoded_filename
;
2371 struct stat statbuf
;
2372 struct gcpro gcpro1
;
2374 encoded_filename
= ENCODE_FILE (absname
);
2376 /* stat is a good way to tell whether the file exists,
2377 regardless of what access permissions it has. */
2378 if (lstat (SDATA (encoded_filename
), &statbuf
) >= 0)
2381 Fsignal (Qfile_already_exists
,
2382 Fcons (build_string ("File already exists"),
2383 Fcons (absname
, Qnil
)));
2385 tem
= format2 ("File %s already exists; %s anyway? ",
2386 absname
, build_string (querystring
));
2388 tem
= Fy_or_n_p (tem
);
2390 tem
= do_yes_or_no_p (tem
);
2393 Fsignal (Qfile_already_exists
,
2394 Fcons (build_string ("File already exists"),
2395 Fcons (absname
, Qnil
)));
2402 statptr
->st_mode
= 0;
2407 DEFUN ("copy-file", Fcopy_file
, Scopy_file
, 2, 5,
2408 "fCopy file: \nGCopy %s to file: \np\nP",
2409 doc
: /* Copy FILE to NEWNAME. Both args must be strings.
2410 If NEWNAME names a directory, copy FILE there.
2412 This function always sets the file modes of the output file to match
2415 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
2416 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
2417 signal a `file-already-exists' error without overwriting. If
2418 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
2419 about overwriting; this is what happens in interactive use with M-x.
2420 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
2423 Fourth arg KEEP-TIME non-nil means give the output file the same
2424 last-modified time as the old one. (This works on only some systems.)
2426 A prefix arg makes KEEP-TIME non-nil.
2428 If PRESERVE-UID-GID is non-nil, we try to transfer the
2429 uid and gid of FILE to NEWNAME. */)
2430 (file
, newname
, ok_if_already_exists
, keep_time
, preserve_uid_gid
)
2431 Lisp_Object file
, newname
, ok_if_already_exists
, keep_time
;
2432 Lisp_Object preserve_uid_gid
;
2435 char buf
[16 * 1024];
2436 struct stat st
, out_st
;
2437 Lisp_Object handler
;
2438 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2439 int count
= SPECPDL_INDEX ();
2440 int input_file_statable_p
;
2441 Lisp_Object encoded_file
, encoded_newname
;
2443 encoded_file
= encoded_newname
= Qnil
;
2444 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2445 CHECK_STRING (file
);
2446 CHECK_STRING (newname
);
2448 if (!NILP (Ffile_directory_p (newname
)))
2449 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2451 newname
= Fexpand_file_name (newname
, Qnil
);
2453 file
= Fexpand_file_name (file
, Qnil
);
2455 /* If the input file name has special constructs in it,
2456 call the corresponding file handler. */
2457 handler
= Ffind_file_name_handler (file
, Qcopy_file
);
2458 /* Likewise for output file name. */
2460 handler
= Ffind_file_name_handler (newname
, Qcopy_file
);
2461 if (!NILP (handler
))
2462 RETURN_UNGCPRO (call5 (handler
, Qcopy_file
, file
, newname
,
2463 ok_if_already_exists
, keep_time
));
2465 encoded_file
= ENCODE_FILE (file
);
2466 encoded_newname
= ENCODE_FILE (newname
);
2468 if (NILP (ok_if_already_exists
)
2469 || INTEGERP (ok_if_already_exists
))
2470 barf_or_query_if_file_exists (encoded_newname
, "copy to it",
2471 INTEGERP (ok_if_already_exists
), &out_st
, 0);
2472 else if (stat (SDATA (encoded_newname
), &out_st
) < 0)
2476 if (!CopyFile (SDATA (encoded_file
),
2477 SDATA (encoded_newname
),
2479 report_file_error ("Copying file", Fcons (file
, Fcons (newname
, Qnil
)));
2480 /* CopyFile retains the timestamp by default. */
2481 else if (NILP (keep_time
))
2487 EMACS_GET_TIME (now
);
2488 filename
= SDATA (encoded_newname
);
2490 /* Ensure file is writable while its modified time is set. */
2491 attributes
= GetFileAttributes (filename
);
2492 SetFileAttributes (filename
, attributes
& ~FILE_ATTRIBUTE_READONLY
);
2493 if (set_file_times (filename
, now
, now
))
2495 /* Restore original attributes. */
2496 SetFileAttributes (filename
, attributes
);
2497 Fsignal (Qfile_date_error
,
2498 Fcons (build_string ("Cannot set file date"),
2499 Fcons (newname
, Qnil
)));
2501 /* Restore original attributes. */
2502 SetFileAttributes (filename
, attributes
);
2504 #else /* not WINDOWSNT */
2506 ifd
= emacs_open (SDATA (encoded_file
), O_RDONLY
, 0);
2510 report_file_error ("Opening input file", Fcons (file
, Qnil
));
2512 record_unwind_protect (close_file_unwind
, make_number (ifd
));
2514 /* We can only copy regular files and symbolic links. Other files are not
2516 input_file_statable_p
= (fstat (ifd
, &st
) >= 0);
2518 #if !defined (MSDOS) || __DJGPP__ > 1
2519 if (out_st
.st_mode
!= 0
2520 && st
.st_dev
== out_st
.st_dev
&& st
.st_ino
== out_st
.st_ino
)
2523 report_file_error ("Input and output files are the same",
2524 Fcons (file
, Fcons (newname
, Qnil
)));
2528 #if defined (S_ISREG) && defined (S_ISLNK)
2529 if (input_file_statable_p
)
2531 if (!(S_ISREG (st
.st_mode
)) && !(S_ISLNK (st
.st_mode
)))
2533 #if defined (EISDIR)
2534 /* Get a better looking error message. */
2537 report_file_error ("Non-regular file", Fcons (file
, Qnil
));
2540 #endif /* S_ISREG && S_ISLNK */
2543 /* Create the copy file with the same record format as the input file */
2544 ofd
= sys_creat (SDATA (encoded_newname
), 0666, ifd
);
2547 /* System's default file type was set to binary by _fmode in emacs.c. */
2548 ofd
= emacs_open (SDATA (encoded_newname
),
2549 O_WRONLY
| O_TRUNC
| O_CREAT
2550 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2551 S_IREAD
| S_IWRITE
);
2552 #else /* not MSDOS */
2553 ofd
= emacs_open (SDATA (encoded_newname
),
2554 O_WRONLY
| O_TRUNC
| O_CREAT
2555 | (NILP (ok_if_already_exists
) ? O_EXCL
: 0),
2557 #endif /* not MSDOS */
2560 report_file_error ("Opening output file", Fcons (newname
, Qnil
));
2562 record_unwind_protect (close_file_unwind
, make_number (ofd
));
2566 while ((n
= emacs_read (ifd
, buf
, sizeof buf
)) > 0)
2567 if (emacs_write (ofd
, buf
, n
) != n
)
2568 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2572 /* Preserve the original file modes, and if requested, also its
2574 if (input_file_statable_p
)
2576 if (! NILP (preserve_uid_gid
))
2577 fchown (ofd
, st
.st_uid
, st
.st_gid
);
2578 fchmod (ofd
, st
.st_mode
& 07777);
2580 #endif /* not MSDOS */
2582 /* Closing the output clobbers the file times on some systems. */
2583 if (emacs_close (ofd
) < 0)
2584 report_file_error ("I/O error", Fcons (newname
, Qnil
));
2586 if (input_file_statable_p
)
2588 if (!NILP (keep_time
))
2590 EMACS_TIME atime
, mtime
;
2591 EMACS_SET_SECS_USECS (atime
, st
.st_atime
, 0);
2592 EMACS_SET_SECS_USECS (mtime
, st
.st_mtime
, 0);
2593 if (set_file_times (SDATA (encoded_newname
),
2595 Fsignal (Qfile_date_error
,
2596 Fcons (build_string ("Cannot set file date"),
2597 Fcons (newname
, Qnil
)));
2603 #if defined (__DJGPP__) && __DJGPP__ > 1
2604 if (input_file_statable_p
)
2606 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2607 and if it can't, it tells so. Otherwise, under MSDOS we usually
2608 get only the READ bit, which will make the copied file read-only,
2609 so it's better not to chmod at all. */
2610 if ((_djstat_flags
& _STFAIL_WRITEBIT
) == 0)
2611 chmod (SDATA (encoded_newname
), st
.st_mode
& 07777);
2613 #endif /* DJGPP version 2 or newer */
2614 #endif /* not WINDOWSNT */
2616 /* Discard the unwind protects. */
2617 specpdl_ptr
= specpdl
+ count
;
2623 DEFUN ("make-directory-internal", Fmake_directory_internal
,
2624 Smake_directory_internal
, 1, 1, 0,
2625 doc
: /* Create a new directory named DIRECTORY. */)
2627 Lisp_Object directory
;
2629 const unsigned char *dir
;
2630 Lisp_Object handler
;
2631 Lisp_Object encoded_dir
;
2633 CHECK_STRING (directory
);
2634 directory
= Fexpand_file_name (directory
, Qnil
);
2636 handler
= Ffind_file_name_handler (directory
, Qmake_directory_internal
);
2637 if (!NILP (handler
))
2638 return call2 (handler
, Qmake_directory_internal
, directory
);
2640 encoded_dir
= ENCODE_FILE (directory
);
2642 dir
= SDATA (encoded_dir
);
2645 if (mkdir (dir
) != 0)
2647 if (mkdir (dir
, 0777) != 0)
2649 report_file_error ("Creating directory", Flist (1, &directory
));
2654 DEFUN ("delete-directory", Fdelete_directory
, Sdelete_directory
, 1, 1, "FDelete directory: ",
2655 doc
: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2657 Lisp_Object directory
;
2659 const unsigned char *dir
;
2660 Lisp_Object handler
;
2661 Lisp_Object encoded_dir
;
2663 CHECK_STRING (directory
);
2664 directory
= Fdirectory_file_name (Fexpand_file_name (directory
, Qnil
));
2666 handler
= Ffind_file_name_handler (directory
, Qdelete_directory
);
2667 if (!NILP (handler
))
2668 return call2 (handler
, Qdelete_directory
, directory
);
2670 encoded_dir
= ENCODE_FILE (directory
);
2672 dir
= SDATA (encoded_dir
);
2674 if (rmdir (dir
) != 0)
2675 report_file_error ("Removing directory", Flist (1, &directory
));
2680 DEFUN ("delete-file", Fdelete_file
, Sdelete_file
, 1, 1, "fDelete file: ",
2681 doc
: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2682 If file has multiple names, it continues to exist with the other names. */)
2684 Lisp_Object filename
;
2686 Lisp_Object handler
;
2687 Lisp_Object encoded_file
;
2688 struct gcpro gcpro1
;
2691 if (!NILP (Ffile_directory_p (filename
))
2692 && NILP (Ffile_symlink_p (filename
)))
2693 Fsignal (Qfile_error
,
2694 Fcons (build_string ("Removing old name: is a directory"),
2695 Fcons (filename
, Qnil
)));
2697 filename
= Fexpand_file_name (filename
, Qnil
);
2699 handler
= Ffind_file_name_handler (filename
, Qdelete_file
);
2700 if (!NILP (handler
))
2701 return call2 (handler
, Qdelete_file
, filename
);
2703 encoded_file
= ENCODE_FILE (filename
);
2705 if (0 > unlink (SDATA (encoded_file
)))
2706 report_file_error ("Removing old name", Flist (1, &filename
));
2711 internal_delete_file_1 (ignore
)
2717 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2720 internal_delete_file (filename
)
2721 Lisp_Object filename
;
2724 tem
= internal_condition_case_1 (Fdelete_file
, filename
,
2725 Qt
, internal_delete_file_1
);
2729 DEFUN ("rename-file", Frename_file
, Srename_file
, 2, 3,
2730 "fRename file: \nGRename %s to file: \np",
2731 doc
: /* Rename FILE as NEWNAME. Both args must be strings.
2732 If file has names other than FILE, it continues to have those names.
2733 Signals a `file-already-exists' error if a file NEWNAME already exists
2734 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2735 A number as third arg means request confirmation if NEWNAME already exists.
2736 This is what happens in interactive use with M-x. */)
2737 (file
, newname
, ok_if_already_exists
)
2738 Lisp_Object file
, newname
, ok_if_already_exists
;
2741 Lisp_Object args
[2];
2743 Lisp_Object handler
;
2744 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
2745 Lisp_Object encoded_file
, encoded_newname
, symlink_target
;
2747 symlink_target
= encoded_file
= encoded_newname
= Qnil
;
2748 GCPRO5 (file
, newname
, encoded_file
, encoded_newname
, symlink_target
);
2749 CHECK_STRING (file
);
2750 CHECK_STRING (newname
);
2751 file
= Fexpand_file_name (file
, Qnil
);
2753 if ((!NILP (Ffile_directory_p (newname
)))
2755 /* If the file names are identical but for the case,
2756 don't attempt to move directory to itself. */
2757 && (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2760 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2762 newname
= Fexpand_file_name (newname
, Qnil
);
2764 /* If the file name has special constructs in it,
2765 call the corresponding file handler. */
2766 handler
= Ffind_file_name_handler (file
, Qrename_file
);
2768 handler
= Ffind_file_name_handler (newname
, Qrename_file
);
2769 if (!NILP (handler
))
2770 RETURN_UNGCPRO (call4 (handler
, Qrename_file
,
2771 file
, newname
, ok_if_already_exists
));
2773 encoded_file
= ENCODE_FILE (file
);
2774 encoded_newname
= ENCODE_FILE (newname
);
2777 /* If the file names are identical but for the case, don't ask for
2778 confirmation: they simply want to change the letter-case of the
2780 if (NILP (Fstring_equal (Fdowncase (file
), Fdowncase (newname
))))
2782 if (NILP (ok_if_already_exists
)
2783 || INTEGERP (ok_if_already_exists
))
2784 barf_or_query_if_file_exists (encoded_newname
, "rename to it",
2785 INTEGERP (ok_if_already_exists
), 0, 0);
2787 if (0 > rename (SDATA (encoded_file
), SDATA (encoded_newname
)))
2789 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
))
2790 || 0 > unlink (SDATA (encoded_file
)))
2796 symlink_target
= Ffile_symlink_p (file
);
2797 if (! NILP (symlink_target
))
2798 Fmake_symbolic_link (symlink_target
, newname
,
2799 NILP (ok_if_already_exists
) ? Qnil
: Qt
);
2802 Fcopy_file (file
, newname
,
2803 /* We have already prompted if it was an integer,
2804 so don't have copy-file prompt again. */
2805 NILP (ok_if_already_exists
) ? Qnil
: Qt
,
2808 Fdelete_file (file
);
2815 report_file_error ("Renaming", Flist (2, args
));
2818 report_file_error ("Renaming", Flist (2, &file
));
2825 DEFUN ("add-name-to-file", Fadd_name_to_file
, Sadd_name_to_file
, 2, 3,
2826 "fAdd name to file: \nGName to add to %s: \np",
2827 doc
: /* Give FILE additional name NEWNAME. Both args must be strings.
2828 Signals a `file-already-exists' error if a file NEWNAME already exists
2829 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2830 A number as third arg means request confirmation if NEWNAME already exists.
2831 This is what happens in interactive use with M-x. */)
2832 (file
, newname
, ok_if_already_exists
)
2833 Lisp_Object file
, newname
, ok_if_already_exists
;
2836 Lisp_Object args
[2];
2838 Lisp_Object handler
;
2839 Lisp_Object encoded_file
, encoded_newname
;
2840 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2842 GCPRO4 (file
, newname
, encoded_file
, encoded_newname
);
2843 encoded_file
= encoded_newname
= Qnil
;
2844 CHECK_STRING (file
);
2845 CHECK_STRING (newname
);
2846 file
= Fexpand_file_name (file
, Qnil
);
2848 if (!NILP (Ffile_directory_p (newname
)))
2849 newname
= Fexpand_file_name (Ffile_name_nondirectory (file
), newname
);
2851 newname
= Fexpand_file_name (newname
, Qnil
);
2853 /* If the file name has special constructs in it,
2854 call the corresponding file handler. */
2855 handler
= Ffind_file_name_handler (file
, Qadd_name_to_file
);
2856 if (!NILP (handler
))
2857 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2858 newname
, ok_if_already_exists
));
2860 /* If the new name has special constructs in it,
2861 call the corresponding file handler. */
2862 handler
= Ffind_file_name_handler (newname
, Qadd_name_to_file
);
2863 if (!NILP (handler
))
2864 RETURN_UNGCPRO (call4 (handler
, Qadd_name_to_file
, file
,
2865 newname
, ok_if_already_exists
));
2867 encoded_file
= ENCODE_FILE (file
);
2868 encoded_newname
= ENCODE_FILE (newname
);
2870 if (NILP (ok_if_already_exists
)
2871 || INTEGERP (ok_if_already_exists
))
2872 barf_or_query_if_file_exists (encoded_newname
, "make it a new name",
2873 INTEGERP (ok_if_already_exists
), 0, 0);
2875 unlink (SDATA (newname
));
2876 if (0 > link (SDATA (encoded_file
), SDATA (encoded_newname
)))
2881 report_file_error ("Adding new name", Flist (2, args
));
2883 report_file_error ("Adding new name", Flist (2, &file
));
2892 DEFUN ("make-symbolic-link", Fmake_symbolic_link
, Smake_symbolic_link
, 2, 3,
2893 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2894 doc
: /* Make a symbolic link to FILENAME, named LINKNAME.
2895 Both args must be strings.
2896 Signals a `file-already-exists' error if a file LINKNAME already exists
2897 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2898 A number as third arg means request confirmation if LINKNAME already exists.
2899 This happens for interactive use with M-x. */)
2900 (filename
, linkname
, ok_if_already_exists
)
2901 Lisp_Object filename
, linkname
, ok_if_already_exists
;
2904 Lisp_Object args
[2];
2906 Lisp_Object handler
;
2907 Lisp_Object encoded_filename
, encoded_linkname
;
2908 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
2910 GCPRO4 (filename
, linkname
, encoded_filename
, encoded_linkname
);
2911 encoded_filename
= encoded_linkname
= Qnil
;
2912 CHECK_STRING (filename
);
2913 CHECK_STRING (linkname
);
2914 /* If the link target has a ~, we must expand it to get
2915 a truly valid file name. Otherwise, do not expand;
2916 we want to permit links to relative file names. */
2917 if (SREF (filename
, 0) == '~')
2918 filename
= Fexpand_file_name (filename
, Qnil
);
2920 if (!NILP (Ffile_directory_p (linkname
)))
2921 linkname
= Fexpand_file_name (Ffile_name_nondirectory (filename
), linkname
);
2923 linkname
= Fexpand_file_name (linkname
, Qnil
);
2925 /* If the file name has special constructs in it,
2926 call the corresponding file handler. */
2927 handler
= Ffind_file_name_handler (filename
, Qmake_symbolic_link
);
2928 if (!NILP (handler
))
2929 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2930 linkname
, ok_if_already_exists
));
2932 /* If the new link name has special constructs in it,
2933 call the corresponding file handler. */
2934 handler
= Ffind_file_name_handler (linkname
, Qmake_symbolic_link
);
2935 if (!NILP (handler
))
2936 RETURN_UNGCPRO (call4 (handler
, Qmake_symbolic_link
, filename
,
2937 linkname
, ok_if_already_exists
));
2939 encoded_filename
= ENCODE_FILE (filename
);
2940 encoded_linkname
= ENCODE_FILE (linkname
);
2942 if (NILP (ok_if_already_exists
)
2943 || INTEGERP (ok_if_already_exists
))
2944 barf_or_query_if_file_exists (encoded_linkname
, "make it a link",
2945 INTEGERP (ok_if_already_exists
), 0, 0);
2946 if (0 > symlink (SDATA (encoded_filename
),
2947 SDATA (encoded_linkname
)))
2949 /* If we didn't complain already, silently delete existing file. */
2950 if (errno
== EEXIST
)
2952 unlink (SDATA (encoded_linkname
));
2953 if (0 <= symlink (SDATA (encoded_filename
),
2954 SDATA (encoded_linkname
)))
2964 report_file_error ("Making symbolic link", Flist (2, args
));
2966 report_file_error ("Making symbolic link", Flist (2, &filename
));
2972 #endif /* S_IFLNK */
2976 DEFUN ("define-logical-name", Fdefine_logical_name
, Sdefine_logical_name
,
2977 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2978 doc
: /* Define the job-wide logical name NAME to have the value STRING.
2979 If STRING is nil or a null string, the logical name NAME is deleted. */)
2984 CHECK_STRING (name
);
2986 delete_logical_name (SDATA (name
));
2989 CHECK_STRING (string
);
2991 if (SCHARS (string
) == 0)
2992 delete_logical_name (SDATA (name
));
2994 define_logical_name (SDATA (name
), SDATA (string
));
3003 DEFUN ("sysnetunam", Fsysnetunam
, Ssysnetunam
, 2, 2, 0,
3004 doc
: /* Open a network connection to PATH using LOGIN as the login string. */)
3006 Lisp_Object path
, login
;
3010 CHECK_STRING (path
);
3011 CHECK_STRING (login
);
3013 netresult
= netunam (SDATA (path
), SDATA (login
));
3015 if (netresult
== -1)
3020 #endif /* HPUX_NET */
3022 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p
, Sfile_name_absolute_p
,
3024 doc
: /* Return t if file FILENAME specifies an absolute file name.
3025 On Unix, this is a name starting with a `/' or a `~'. */)
3027 Lisp_Object filename
;
3029 CHECK_STRING (filename
);
3030 return file_name_absolute_p (SDATA (filename
)) ? Qt
: Qnil
;
3033 /* Return nonzero if file FILENAME exists and can be executed. */
3036 check_executable (filename
)
3040 int len
= strlen (filename
);
3043 if (stat (filename
, &st
) < 0)
3045 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
3046 return ((st
.st_mode
& S_IEXEC
) != 0);
3048 return (S_ISREG (st
.st_mode
)
3050 && (stricmp ((suffix
= filename
+ len
-4), ".com") == 0
3051 || stricmp (suffix
, ".exe") == 0
3052 || stricmp (suffix
, ".bat") == 0)
3053 || (st
.st_mode
& S_IFMT
) == S_IFDIR
);
3054 #endif /* not WINDOWSNT */
3055 #else /* not DOS_NT */
3056 #ifdef HAVE_EUIDACCESS
3057 return (euidaccess (filename
, 1) >= 0);
3059 /* Access isn't quite right because it uses the real uid
3060 and we really want to test with the effective uid.
3061 But Unix doesn't give us a right way to do it. */
3062 return (access (filename
, 1) >= 0);
3064 #endif /* not DOS_NT */
3067 /* Return nonzero if file FILENAME exists and can be written. */
3070 check_writable (filename
)
3075 if (stat (filename
, &st
) < 0)
3077 return (st
.st_mode
& S_IWRITE
|| (st
.st_mode
& S_IFMT
) == S_IFDIR
);
3078 #else /* not MSDOS */
3079 #ifdef HAVE_EUIDACCESS
3080 return (euidaccess (filename
, 2) >= 0);
3082 /* Access isn't quite right because it uses the real uid
3083 and we really want to test with the effective uid.
3084 But Unix doesn't give us a right way to do it.
3085 Opening with O_WRONLY could work for an ordinary file,
3086 but would lose for directories. */
3087 return (access (filename
, 2) >= 0);
3089 #endif /* not MSDOS */
3092 DEFUN ("file-exists-p", Ffile_exists_p
, Sfile_exists_p
, 1, 1, 0,
3093 doc
: /* Return t if file FILENAME exists (whether or not you can read it.)
3094 See also `file-readable-p' and `file-attributes'.
3095 This returns nil for a symlink to a nonexistent file.
3096 Use `file-symlink-p' to test for such links. */)
3098 Lisp_Object filename
;
3100 Lisp_Object absname
;
3101 Lisp_Object handler
;
3102 struct stat statbuf
;
3104 CHECK_STRING (filename
);
3105 absname
= Fexpand_file_name (filename
, Qnil
);
3107 /* If the file name has special constructs in it,
3108 call the corresponding file handler. */
3109 handler
= Ffind_file_name_handler (absname
, Qfile_exists_p
);
3110 if (!NILP (handler
))
3111 return call2 (handler
, Qfile_exists_p
, absname
);
3113 absname
= ENCODE_FILE (absname
);
3115 return (stat (SDATA (absname
), &statbuf
) >= 0) ? Qt
: Qnil
;
3118 DEFUN ("file-executable-p", Ffile_executable_p
, Sfile_executable_p
, 1, 1, 0,
3119 doc
: /* Return t if FILENAME can be executed by you.
3120 For a directory, this means you can access files in that directory. */)
3122 Lisp_Object filename
;
3124 Lisp_Object absname
;
3125 Lisp_Object handler
;
3127 CHECK_STRING (filename
);
3128 absname
= Fexpand_file_name (filename
, Qnil
);
3130 /* If the file name has special constructs in it,
3131 call the corresponding file handler. */
3132 handler
= Ffind_file_name_handler (absname
, Qfile_executable_p
);
3133 if (!NILP (handler
))
3134 return call2 (handler
, Qfile_executable_p
, absname
);
3136 absname
= ENCODE_FILE (absname
);
3138 return (check_executable (SDATA (absname
)) ? Qt
: Qnil
);
3141 DEFUN ("file-readable-p", Ffile_readable_p
, Sfile_readable_p
, 1, 1, 0,
3142 doc
: /* Return t if file FILENAME exists and you can read it.
3143 See also `file-exists-p' and `file-attributes'. */)
3145 Lisp_Object filename
;
3147 Lisp_Object absname
;
3148 Lisp_Object handler
;
3151 struct stat statbuf
;
3153 CHECK_STRING (filename
);
3154 absname
= Fexpand_file_name (filename
, Qnil
);
3156 /* If the file name has special constructs in it,
3157 call the corresponding file handler. */
3158 handler
= Ffind_file_name_handler (absname
, Qfile_readable_p
);
3159 if (!NILP (handler
))
3160 return call2 (handler
, Qfile_readable_p
, absname
);
3162 absname
= ENCODE_FILE (absname
);
3164 #if defined(DOS_NT) || defined(macintosh)
3165 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3167 if (access (SDATA (absname
), 0) == 0)
3170 #else /* not DOS_NT and not macintosh */
3172 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3173 /* Opening a fifo without O_NONBLOCK can wait.
3174 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3175 except in the case of a fifo, on a system which handles it. */
3176 desc
= stat (SDATA (absname
), &statbuf
);
3179 if (S_ISFIFO (statbuf
.st_mode
))
3180 flags
|= O_NONBLOCK
;
3182 desc
= emacs_open (SDATA (absname
), flags
, 0);
3187 #endif /* not DOS_NT and not macintosh */
3190 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3192 DEFUN ("file-writable-p", Ffile_writable_p
, Sfile_writable_p
, 1, 1, 0,
3193 doc
: /* Return t if file FILENAME can be written or created by you. */)
3195 Lisp_Object filename
;
3197 Lisp_Object absname
, dir
, encoded
;
3198 Lisp_Object handler
;
3199 struct stat statbuf
;
3201 CHECK_STRING (filename
);
3202 absname
= Fexpand_file_name (filename
, Qnil
);
3204 /* If the file name has special constructs in it,
3205 call the corresponding file handler. */
3206 handler
= Ffind_file_name_handler (absname
, Qfile_writable_p
);
3207 if (!NILP (handler
))
3208 return call2 (handler
, Qfile_writable_p
, absname
);
3210 encoded
= ENCODE_FILE (absname
);
3211 if (stat (SDATA (encoded
), &statbuf
) >= 0)
3212 return (check_writable (SDATA (encoded
))
3215 dir
= Ffile_name_directory (absname
);
3218 dir
= Fdirectory_file_name (dir
);
3222 dir
= Fdirectory_file_name (dir
);
3225 dir
= ENCODE_FILE (dir
);
3227 /* The read-only attribute of the parent directory doesn't affect
3228 whether a file or directory can be created within it. Some day we
3229 should check ACLs though, which do affect this. */
3230 if (stat (SDATA (dir
), &statbuf
) < 0)
3232 return (statbuf
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
3234 return (check_writable (!NILP (dir
) ? (char *) SDATA (dir
) : "")
3239 DEFUN ("access-file", Faccess_file
, Saccess_file
, 2, 2, 0,
3240 doc
: /* Access file FILENAME, and get an error if that does not work.
3241 The second argument STRING is used in the error message.
3242 If there is no error, returns nil. */)
3244 Lisp_Object filename
, string
;
3246 Lisp_Object handler
, encoded_filename
, absname
;
3249 CHECK_STRING (filename
);
3250 absname
= Fexpand_file_name (filename
, Qnil
);
3252 CHECK_STRING (string
);
3254 /* If the file name has special constructs in it,
3255 call the corresponding file handler. */
3256 handler
= Ffind_file_name_handler (absname
, Qaccess_file
);
3257 if (!NILP (handler
))
3258 return call3 (handler
, Qaccess_file
, absname
, string
);
3260 encoded_filename
= ENCODE_FILE (absname
);
3262 fd
= emacs_open (SDATA (encoded_filename
), O_RDONLY
, 0);
3264 report_file_error (SDATA (string
), Fcons (filename
, Qnil
));
3270 DEFUN ("file-symlink-p", Ffile_symlink_p
, Sfile_symlink_p
, 1, 1, 0,
3271 doc
: /* Return non-nil if file FILENAME is the name of a symbolic link.
3272 The value is the link target, as a string.
3273 Otherwise it returns nil.
3275 This function returns t when given the name of a symlink that
3276 points to a nonexistent file. */)
3278 Lisp_Object filename
;
3280 Lisp_Object handler
;
3282 CHECK_STRING (filename
);
3283 filename
= Fexpand_file_name (filename
, Qnil
);
3285 /* If the file name has special constructs in it,
3286 call the corresponding file handler. */
3287 handler
= Ffind_file_name_handler (filename
, Qfile_symlink_p
);
3288 if (!NILP (handler
))
3289 return call2 (handler
, Qfile_symlink_p
, filename
);
3298 filename
= ENCODE_FILE (filename
);
3305 buf
= (char *) xrealloc (buf
, bufsize
);
3306 bzero (buf
, bufsize
);
3309 valsize
= readlink (SDATA (filename
), buf
, bufsize
);
3313 /* HP-UX reports ERANGE if buffer is too small. */
3314 if (errno
== ERANGE
)
3324 while (valsize
>= bufsize
);
3326 val
= make_string (buf
, valsize
);
3327 if (buf
[0] == '/' && index (buf
, ':'))
3328 val
= concat2 (build_string ("/:"), val
);
3330 val
= DECODE_FILE (val
);
3333 #else /* not S_IFLNK */
3335 #endif /* not S_IFLNK */
3338 DEFUN ("file-directory-p", Ffile_directory_p
, Sfile_directory_p
, 1, 1, 0,
3339 doc
: /* Return t if FILENAME names an existing directory.
3340 Symbolic links to directories count as directories.
3341 See `file-symlink-p' to distinguish symlinks. */)
3343 Lisp_Object filename
;
3345 register Lisp_Object absname
;
3347 Lisp_Object handler
;
3349 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3351 /* If the file name has special constructs in it,
3352 call the corresponding file handler. */
3353 handler
= Ffind_file_name_handler (absname
, Qfile_directory_p
);
3354 if (!NILP (handler
))
3355 return call2 (handler
, Qfile_directory_p
, absname
);
3357 absname
= ENCODE_FILE (absname
);
3359 if (stat (SDATA (absname
), &st
) < 0)
3361 return (st
.st_mode
& S_IFMT
) == S_IFDIR
? Qt
: Qnil
;
3364 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p
, Sfile_accessible_directory_p
, 1, 1, 0,
3365 doc
: /* Return t if file FILENAME names a directory you can open.
3366 For the value to be t, FILENAME must specify the name of a directory as a file,
3367 and the directory must allow you to open files in it. In order to use a
3368 directory as a buffer's current directory, this predicate must return true.
3369 A directory name spec may be given instead; then the value is t
3370 if the directory so specified exists and really is a readable and
3371 searchable directory. */)
3373 Lisp_Object filename
;
3375 Lisp_Object handler
;
3377 struct gcpro gcpro1
;
3379 /* If the file name has special constructs in it,
3380 call the corresponding file handler. */
3381 handler
= Ffind_file_name_handler (filename
, Qfile_accessible_directory_p
);
3382 if (!NILP (handler
))
3383 return call2 (handler
, Qfile_accessible_directory_p
, filename
);
3386 tem
= (NILP (Ffile_directory_p (filename
))
3387 || NILP (Ffile_executable_p (filename
)));
3389 return tem
? Qnil
: Qt
;
3392 DEFUN ("file-regular-p", Ffile_regular_p
, Sfile_regular_p
, 1, 1, 0,
3393 doc
: /* Return t if FILENAME names a regular file.
3394 This is the sort of file that holds an ordinary stream of data bytes.
3395 Symbolic links to regular files count as regular files.
3396 See `file-symlink-p' to distinguish symlinks. */)
3398 Lisp_Object filename
;
3400 register Lisp_Object absname
;
3402 Lisp_Object handler
;
3404 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3406 /* If the file name has special constructs in it,
3407 call the corresponding file handler. */
3408 handler
= Ffind_file_name_handler (absname
, Qfile_regular_p
);
3409 if (!NILP (handler
))
3410 return call2 (handler
, Qfile_regular_p
, absname
);
3412 absname
= ENCODE_FILE (absname
);
3417 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3419 /* Tell stat to use expensive method to get accurate info. */
3420 Vw32_get_true_file_attributes
= Qt
;
3421 result
= stat (SDATA (absname
), &st
);
3422 Vw32_get_true_file_attributes
= tem
;
3426 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
3429 if (stat (SDATA (absname
), &st
) < 0)
3431 return (st
.st_mode
& S_IFMT
) == S_IFREG
? Qt
: Qnil
;
3435 DEFUN ("file-modes", Ffile_modes
, Sfile_modes
, 1, 1, 0,
3436 doc
: /* Return mode bits of file named FILENAME, as an integer.
3437 Return nil, if file does not exist or is not accessible. */)
3439 Lisp_Object filename
;
3441 Lisp_Object absname
;
3443 Lisp_Object handler
;
3445 absname
= expand_and_dir_to_file (filename
, current_buffer
->directory
);
3447 /* If the file name has special constructs in it,
3448 call the corresponding file handler. */
3449 handler
= Ffind_file_name_handler (absname
, Qfile_modes
);
3450 if (!NILP (handler
))
3451 return call2 (handler
, Qfile_modes
, absname
);
3453 absname
= ENCODE_FILE (absname
);
3455 if (stat (SDATA (absname
), &st
) < 0)
3457 #if defined (MSDOS) && __DJGPP__ < 2
3458 if (check_executable (SDATA (absname
)))
3459 st
.st_mode
|= S_IEXEC
;
3460 #endif /* MSDOS && __DJGPP__ < 2 */
3462 return make_number (st
.st_mode
& 07777);
3465 DEFUN ("set-file-modes", Fset_file_modes
, Sset_file_modes
, 2, 2, 0,
3466 doc
: /* Set mode bits of file named FILENAME to MODE (an integer).
3467 Only the 12 low bits of MODE are used. */)
3469 Lisp_Object filename
, mode
;
3471 Lisp_Object absname
, encoded_absname
;
3472 Lisp_Object handler
;
3474 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
3475 CHECK_NUMBER (mode
);
3477 /* If the file name has special constructs in it,
3478 call the corresponding file handler. */
3479 handler
= Ffind_file_name_handler (absname
, Qset_file_modes
);
3480 if (!NILP (handler
))
3481 return call3 (handler
, Qset_file_modes
, absname
, mode
);
3483 encoded_absname
= ENCODE_FILE (absname
);
3485 if (chmod (SDATA (encoded_absname
), XINT (mode
)) < 0)
3486 report_file_error ("Doing chmod", Fcons (absname
, Qnil
));
3491 DEFUN ("set-default-file-modes", Fset_default_file_modes
, Sset_default_file_modes
, 1, 1, 0,
3492 doc
: /* Set the file permission bits for newly created files.
3493 The argument MODE should be an integer; only the low 9 bits are used.
3494 This setting is inherited by subprocesses. */)
3498 CHECK_NUMBER (mode
);
3500 umask ((~ XINT (mode
)) & 0777);
3505 DEFUN ("default-file-modes", Fdefault_file_modes
, Sdefault_file_modes
, 0, 0, 0,
3506 doc
: /* Return the default file protection for created files.
3507 The value is an integer. */)
3513 realmask
= umask (0);
3516 XSETINT (value
, (~ realmask
) & 0777);
3520 extern int lisp_time_argument
P_ ((Lisp_Object
, time_t *, int *));
3522 DEFUN ("set-file-times", Fset_file_times
, Sset_file_times
, 1, 2, 0,
3523 doc
: /* Set times of file FILENAME to TIME.
3524 Set both access and modification times.
3525 Return t on success, else nil.
3526 Use the current time if TIME is nil. TIME is in the format of
3529 Lisp_Object filename
, time
;
3531 Lisp_Object absname
, encoded_absname
;
3532 Lisp_Object handler
;
3536 if (! lisp_time_argument (time
, &sec
, &usec
))
3537 error ("Invalid time specification");
3539 absname
= Fexpand_file_name (filename
, current_buffer
->directory
);
3541 /* If the file name has special constructs in it,
3542 call the corresponding file handler. */
3543 handler
= Ffind_file_name_handler (absname
, Qset_file_times
);
3544 if (!NILP (handler
))
3545 return call3 (handler
, Qset_file_times
, absname
, time
);
3547 encoded_absname
= ENCODE_FILE (absname
);
3552 EMACS_SET_SECS (t
, sec
);
3553 EMACS_SET_USECS (t
, usec
);
3555 if (set_file_times (SDATA (encoded_absname
), t
, t
))
3560 /* Setting times on a directory always fails. */
3561 if (stat (SDATA (encoded_absname
), &st
) == 0
3562 && (st
.st_mode
& S_IFMT
) == S_IFDIR
)
3565 report_file_error ("Setting file times", Fcons (absname
, Qnil
));
3578 DEFUN ("unix-sync", Funix_sync
, Sunix_sync
, 0, 0, "",
3579 doc
: /* Tell Unix to finish all pending disk updates. */)
3588 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p
, Sfile_newer_than_file_p
, 2, 2, 0,
3589 doc
: /* Return t if file FILE1 is newer than file FILE2.
3590 If FILE1 does not exist, the answer is nil;
3591 otherwise, if FILE2 does not exist, the answer is t. */)
3593 Lisp_Object file1
, file2
;
3595 Lisp_Object absname1
, absname2
;
3598 Lisp_Object handler
;
3599 struct gcpro gcpro1
, gcpro2
;
3601 CHECK_STRING (file1
);
3602 CHECK_STRING (file2
);
3605 GCPRO2 (absname1
, file2
);
3606 absname1
= expand_and_dir_to_file (file1
, current_buffer
->directory
);
3607 absname2
= expand_and_dir_to_file (file2
, current_buffer
->directory
);
3610 /* If the file name has special constructs in it,
3611 call the corresponding file handler. */
3612 handler
= Ffind_file_name_handler (absname1
, Qfile_newer_than_file_p
);
3614 handler
= Ffind_file_name_handler (absname2
, Qfile_newer_than_file_p
);
3615 if (!NILP (handler
))
3616 return call3 (handler
, Qfile_newer_than_file_p
, absname1
, absname2
);
3618 GCPRO2 (absname1
, absname2
);
3619 absname1
= ENCODE_FILE (absname1
);
3620 absname2
= ENCODE_FILE (absname2
);
3623 if (stat (SDATA (absname1
), &st
) < 0)
3626 mtime1
= st
.st_mtime
;
3628 if (stat (SDATA (absname2
), &st
) < 0)
3631 return (mtime1
> st
.st_mtime
) ? Qt
: Qnil
;
3635 Lisp_Object Qfind_buffer_file_type
;
3638 #ifndef READ_BUF_SIZE
3639 #define READ_BUF_SIZE (64 << 10)
3642 extern void adjust_markers_for_delete
P_ ((int, int, int, int));
3644 /* This function is called after Lisp functions to decide a coding
3645 system are called, or when they cause an error. Before they are
3646 called, the current buffer is set unibyte and it contains only a
3647 newly inserted text (thus the buffer was empty before the
3650 The functions may set markers, overlays, text properties, or even
3651 alter the buffer contents, change the current buffer.
3653 Here, we reset all those changes by:
3654 o set back the current buffer.
3655 o move all markers and overlays to BEG.
3656 o remove all text properties.
3657 o set back the buffer multibyteness. */
3660 decide_coding_unwind (unwind_data
)
3661 Lisp_Object unwind_data
;
3663 Lisp_Object multibyte
, undo_list
, buffer
;
3665 multibyte
= XCAR (unwind_data
);
3666 unwind_data
= XCDR (unwind_data
);
3667 undo_list
= XCAR (unwind_data
);
3668 buffer
= XCDR (unwind_data
);
3670 if (current_buffer
!= XBUFFER (buffer
))
3671 set_buffer_internal (XBUFFER (buffer
));
3672 adjust_markers_for_delete (BEG
, BEG_BYTE
, Z
, Z_BYTE
);
3673 adjust_overlays_for_delete (BEG
, Z
- BEG
);
3674 BUF_INTERVALS (current_buffer
) = 0;
3675 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3677 /* Now we are safe to change the buffer's multibyteness directly. */
3678 current_buffer
->enable_multibyte_characters
= multibyte
;
3679 current_buffer
->undo_list
= undo_list
;
3685 /* Used to pass values from insert-file-contents to read_non_regular. */
3687 static int non_regular_fd
;
3688 static int non_regular_inserted
;
3689 static int non_regular_nbytes
;
3692 /* Read from a non-regular file.
3693 Read non_regular_trytry bytes max from non_regular_fd.
3694 Non_regular_inserted specifies where to put the read bytes.
3695 Value is the number of bytes read. */
3704 nbytes
= emacs_read (non_regular_fd
,
3705 BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ non_regular_inserted
,
3706 non_regular_nbytes
);
3708 return make_number (nbytes
);
3712 /* Condition-case handler used when reading from non-regular files
3713 in insert-file-contents. */
3716 read_non_regular_quit ()
3722 DEFUN ("insert-file-contents", Finsert_file_contents
, Sinsert_file_contents
,
3724 doc
: /* Insert contents of file FILENAME after point.
3725 Returns list of absolute file name and number of characters inserted.
3726 If second argument VISIT is non-nil, the buffer's visited filename
3727 and last save file modtime are set, and it is marked unmodified.
3728 If visiting and the file does not exist, visiting is completed
3729 before the error is signaled.
3730 The optional third and fourth arguments BEG and END
3731 specify what portion of the file to insert.
3732 These arguments count bytes in the file, not characters in the buffer.
3733 If VISIT is non-nil, BEG and END must be nil.
3735 If optional fifth argument REPLACE is non-nil,
3736 it means replace the current buffer contents (in the accessible portion)
3737 with the file contents. This is better than simply deleting and inserting
3738 the whole thing because (1) it preserves some marker positions
3739 and (2) it puts less data in the undo list.
3740 When REPLACE is non-nil, the value is the number of characters actually read,
3741 which is often less than the number of characters to be read.
3743 This does code conversion according to the value of
3744 `coding-system-for-read' or `file-coding-system-alist',
3745 and sets the variable `last-coding-system-used' to the coding system
3747 (filename
, visit
, beg
, end
, replace
)
3748 Lisp_Object filename
, visit
, beg
, end
, replace
;
3753 register int how_much
;
3754 register int unprocessed
;
3755 int count
= SPECPDL_INDEX ();
3756 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3757 Lisp_Object handler
, val
, insval
, orig_filename
;
3760 int not_regular
= 0;
3761 unsigned char read_buf
[READ_BUF_SIZE
];
3762 struct coding_system coding
;
3763 unsigned char buffer
[1 << 14];
3764 int replace_handled
= 0;
3765 int set_coding_system
= 0;
3766 int coding_system_decided
= 0;
3768 Lisp_Object old_Vdeactivate_mark
= Vdeactivate_mark
;
3769 int we_locked_file
= 0;
3771 if (current_buffer
->base_buffer
&& ! NILP (visit
))
3772 error ("Cannot do file visiting in an indirect buffer");
3774 if (!NILP (current_buffer
->read_only
))
3775 Fbarf_if_buffer_read_only ();
3779 orig_filename
= Qnil
;
3781 GCPRO4 (filename
, val
, p
, orig_filename
);
3783 CHECK_STRING (filename
);
3784 filename
= Fexpand_file_name (filename
, Qnil
);
3786 /* If the file name has special constructs in it,
3787 call the corresponding file handler. */
3788 handler
= Ffind_file_name_handler (filename
, Qinsert_file_contents
);
3789 if (!NILP (handler
))
3791 val
= call6 (handler
, Qinsert_file_contents
, filename
,
3792 visit
, beg
, end
, replace
);
3793 if (CONSP (val
) && CONSP (XCDR (val
)))
3794 inserted
= XINT (XCAR (XCDR (val
)));
3798 orig_filename
= filename
;
3799 filename
= ENCODE_FILE (filename
);
3805 Lisp_Object tem
= Vw32_get_true_file_attributes
;
3807 /* Tell stat to use expensive method to get accurate info. */
3808 Vw32_get_true_file_attributes
= Qt
;
3809 total
= stat (SDATA (filename
), &st
);
3810 Vw32_get_true_file_attributes
= tem
;
3815 if (stat (SDATA (filename
), &st
) < 0)
3817 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0
3818 || fstat (fd
, &st
) < 0)
3819 #endif /* not APOLLO */
3820 #endif /* WINDOWSNT */
3822 if (fd
>= 0) emacs_close (fd
);
3825 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
3828 if (!NILP (Vcoding_system_for_read
))
3829 Fset (Qbuffer_file_coding_system
, Vcoding_system_for_read
);
3834 /* This code will need to be changed in order to work on named
3835 pipes, and it's probably just not worth it. So we should at
3836 least signal an error. */
3837 if (!S_ISREG (st
.st_mode
))
3844 if (! NILP (replace
) || ! NILP (beg
) || ! NILP (end
))
3845 Fsignal (Qfile_error
,
3846 Fcons (build_string ("not a regular file"),
3847 Fcons (orig_filename
, Qnil
)));
3852 if ((fd
= emacs_open (SDATA (filename
), O_RDONLY
, 0)) < 0)
3855 /* Replacement should preserve point as it preserves markers. */
3856 if (!NILP (replace
))
3857 record_unwind_protect (restore_point_unwind
, Fpoint_marker ());
3859 record_unwind_protect (close_file_unwind
, make_number (fd
));
3861 /* Supposedly happens on VMS. */
3862 /* Can happen on any platform that uses long as type of off_t, but allows
3863 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3864 give a message suitable for the latter case. */
3865 if (! not_regular
&& st
.st_size
< 0)
3866 error ("Maximum buffer size exceeded");
3868 /* Prevent redisplay optimizations. */
3869 current_buffer
->clip_changed
= 1;
3873 if (!NILP (beg
) || !NILP (end
))
3874 error ("Attempt to visit less than an entire file");
3875 if (BEG
< Z
&& NILP (replace
))
3876 error ("Cannot do file visiting in a non-empty buffer");
3882 XSETFASTINT (beg
, 0);
3890 XSETINT (end
, st
.st_size
);
3892 /* Arithmetic overflow can occur if an Emacs integer cannot
3893 represent the file size, or if the calculations below
3894 overflow. The calculations below double the file size
3895 twice, so check that it can be multiplied by 4 safely. */
3896 if (XINT (end
) != st
.st_size
3897 || ((int) st
.st_size
* 4) / 4 != st
.st_size
)
3898 error ("Maximum buffer size exceeded");
3900 /* The file size returned from stat may be zero, but data
3901 may be readable nonetheless, for example when this is a
3902 file in the /proc filesystem. */
3903 if (st
.st_size
== 0)
3904 XSETINT (end
, READ_BUF_SIZE
);
3908 if (EQ (Vcoding_system_for_read
, Qauto_save_coding
))
3910 /* We use emacs-mule for auto saving... */
3911 setup_coding_system (Qemacs_mule
, &coding
);
3912 /* ... but with the special flag to indicate to read in a
3913 multibyte sequence for eight-bit-control char as is. */
3915 coding
.src_multibyte
= 0;
3916 coding
.dst_multibyte
3917 = !NILP (current_buffer
->enable_multibyte_characters
);
3918 coding
.eol_type
= CODING_EOL_LF
;
3919 coding_system_decided
= 1;
3923 /* Decide the coding system to use for reading the file now
3924 because we can't use an optimized method for handling
3925 `coding:' tag if the current buffer is not empty. */
3929 if (!NILP (Vcoding_system_for_read
))
3930 val
= Vcoding_system_for_read
;
3933 /* Don't try looking inside a file for a coding system
3934 specification if it is not seekable. */
3935 if (! not_regular
&& ! NILP (Vset_auto_coding_function
))
3937 /* Find a coding system specified in the heading two
3938 lines or in the tailing several lines of the file.
3939 We assume that the 1K-byte and 3K-byte for heading
3940 and tailing respectively are sufficient for this
3944 if (st
.st_size
<= (1024 * 4))
3945 nread
= emacs_read (fd
, read_buf
, 1024 * 4);
3948 nread
= emacs_read (fd
, read_buf
, 1024);
3951 if (lseek (fd
, st
.st_size
- (1024 * 3), 0) < 0)
3952 report_file_error ("Setting file position",
3953 Fcons (orig_filename
, Qnil
));
3954 nread
+= emacs_read (fd
, read_buf
+ nread
, 1024 * 3);
3959 error ("IO error reading %s: %s",
3960 SDATA (orig_filename
), emacs_strerror (errno
));
3963 struct buffer
*prev
= current_buffer
;
3967 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
3969 buffer
= Fget_buffer_create (build_string (" *code-converting-work*"));
3970 buf
= XBUFFER (buffer
);
3972 delete_all_overlays (buf
);
3973 buf
->directory
= current_buffer
->directory
;
3974 buf
->read_only
= Qnil
;
3975 buf
->filename
= Qnil
;
3976 buf
->undo_list
= Qt
;
3977 eassert (buf
->overlays_before
== NULL
);
3978 eassert (buf
->overlays_after
== NULL
);
3980 set_buffer_internal (buf
);
3982 buf
->enable_multibyte_characters
= Qnil
;
3984 insert_1_both (read_buf
, nread
, nread
, 0, 0, 0);
3985 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
3986 val
= call2 (Vset_auto_coding_function
,
3987 filename
, make_number (nread
));
3988 set_buffer_internal (prev
);
3990 /* Discard the unwind protect for recovering the
3994 /* Rewind the file for the actual read done later. */
3995 if (lseek (fd
, 0, 0) < 0)
3996 report_file_error ("Setting file position",
3997 Fcons (orig_filename
, Qnil
));
4003 /* If we have not yet decided a coding system, check
4004 file-coding-system-alist. */
4005 Lisp_Object args
[6], coding_systems
;
4007 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4008 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = replace
;
4009 coding_systems
= Ffind_operation_coding_system (6, args
);
4010 if (CONSP (coding_systems
))
4011 val
= XCAR (coding_systems
);
4015 setup_coding_system (Fcheck_coding_system (val
), &coding
);
4016 /* Ensure we set Vlast_coding_system_used. */
4017 set_coding_system
= 1;
4019 if (NILP (current_buffer
->enable_multibyte_characters
)
4021 /* We must suppress all character code conversion except for
4022 end-of-line conversion. */
4023 setup_raw_text_coding_system (&coding
);
4025 coding
.src_multibyte
= 0;
4026 coding
.dst_multibyte
4027 = !NILP (current_buffer
->enable_multibyte_characters
);
4028 coding_system_decided
= 1;
4031 /* If requested, replace the accessible part of the buffer
4032 with the file contents. Avoid replacing text at the
4033 beginning or end of the buffer that matches the file contents;
4034 that preserves markers pointing to the unchanged parts.
4036 Here we implement this feature in an optimized way
4037 for the case where code conversion is NOT needed.
4038 The following if-statement handles the case of conversion
4039 in a less optimal way.
4041 If the code conversion is "automatic" then we try using this
4042 method and hope for the best.
4043 But if we discover the need for conversion, we give up on this method
4044 and let the following if-statement handle the replace job. */
4047 && !(coding
.common_flags
& CODING_REQUIRE_DECODING_MASK
))
4049 /* same_at_start and same_at_end count bytes,
4050 because file access counts bytes
4051 and BEG and END count bytes. */
4052 int same_at_start
= BEGV_BYTE
;
4053 int same_at_end
= ZV_BYTE
;
4055 /* There is still a possibility we will find the need to do code
4056 conversion. If that happens, we set this variable to 1 to
4057 give up on handling REPLACE in the optimized way. */
4058 int giveup_match_end
= 0;
4060 if (XINT (beg
) != 0)
4062 if (lseek (fd
, XINT (beg
), 0) < 0)
4063 report_file_error ("Setting file position",
4064 Fcons (orig_filename
, Qnil
));
4069 /* Count how many chars at the start of the file
4070 match the text at the beginning of the buffer. */
4075 nread
= emacs_read (fd
, buffer
, sizeof buffer
);
4077 error ("IO error reading %s: %s",
4078 SDATA (orig_filename
), emacs_strerror (errno
));
4079 else if (nread
== 0)
4082 if (coding
.type
== coding_type_undecided
)
4083 detect_coding (&coding
, buffer
, nread
);
4084 if (coding
.common_flags
& CODING_REQUIRE_DECODING_MASK
)
4085 /* We found that the file should be decoded somehow.
4086 Let's give up here. */
4088 giveup_match_end
= 1;
4092 if (coding
.eol_type
== CODING_EOL_UNDECIDED
)
4093 detect_eol (&coding
, buffer
, nread
);
4094 if (coding
.eol_type
!= CODING_EOL_UNDECIDED
4095 && coding
.eol_type
!= CODING_EOL_LF
)
4096 /* We found that the format of eol should be decoded.
4097 Let's give up here. */
4099 giveup_match_end
= 1;
4104 while (bufpos
< nread
&& same_at_start
< ZV_BYTE
4105 && FETCH_BYTE (same_at_start
) == buffer
[bufpos
])
4106 same_at_start
++, bufpos
++;
4107 /* If we found a discrepancy, stop the scan.
4108 Otherwise loop around and scan the next bufferful. */
4109 if (bufpos
!= nread
)
4113 /* If the file matches the buffer completely,
4114 there's no need to replace anything. */
4115 if (same_at_start
- BEGV_BYTE
== XINT (end
))
4119 /* Truncate the buffer to the size of the file. */
4120 del_range_1 (same_at_start
, same_at_end
, 0, 0);
4125 /* Count how many chars at the end of the file
4126 match the text at the end of the buffer. But, if we have
4127 already found that decoding is necessary, don't waste time. */
4128 while (!giveup_match_end
)
4130 int total_read
, nread
, bufpos
, curpos
, trial
;
4132 /* At what file position are we now scanning? */
4133 curpos
= XINT (end
) - (ZV_BYTE
- same_at_end
);
4134 /* If the entire file matches the buffer tail, stop the scan. */
4137 /* How much can we scan in the next step? */
4138 trial
= min (curpos
, sizeof buffer
);
4139 if (lseek (fd
, curpos
- trial
, 0) < 0)
4140 report_file_error ("Setting file position",
4141 Fcons (orig_filename
, Qnil
));
4143 total_read
= nread
= 0;
4144 while (total_read
< trial
)
4146 nread
= emacs_read (fd
, buffer
+ total_read
, trial
- total_read
);
4148 error ("IO error reading %s: %s",
4149 SDATA (orig_filename
), emacs_strerror (errno
));
4150 else if (nread
== 0)
4152 total_read
+= nread
;
4155 /* Scan this bufferful from the end, comparing with
4156 the Emacs buffer. */
4157 bufpos
= total_read
;
4159 /* Compare with same_at_start to avoid counting some buffer text
4160 as matching both at the file's beginning and at the end. */
4161 while (bufpos
> 0 && same_at_end
> same_at_start
4162 && FETCH_BYTE (same_at_end
- 1) == buffer
[bufpos
- 1])
4163 same_at_end
--, bufpos
--;
4165 /* If we found a discrepancy, stop the scan.
4166 Otherwise loop around and scan the preceding bufferful. */
4169 /* If this discrepancy is because of code conversion,
4170 we cannot use this method; giveup and try the other. */
4171 if (same_at_end
> same_at_start
4172 && FETCH_BYTE (same_at_end
- 1) >= 0200
4173 && ! NILP (current_buffer
->enable_multibyte_characters
)
4174 && (CODING_MAY_REQUIRE_DECODING (&coding
)))
4175 giveup_match_end
= 1;
4184 if (! giveup_match_end
)
4188 /* We win! We can handle REPLACE the optimized way. */
4190 /* Extend the start of non-matching text area to multibyte
4191 character boundary. */
4192 if (! NILP (current_buffer
->enable_multibyte_characters
))
4193 while (same_at_start
> BEGV_BYTE
4194 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4197 /* Extend the end of non-matching text area to multibyte
4198 character boundary. */
4199 if (! NILP (current_buffer
->enable_multibyte_characters
))
4200 while (same_at_end
< ZV_BYTE
4201 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4204 /* Don't try to reuse the same piece of text twice. */
4205 overlap
= (same_at_start
- BEGV_BYTE
4206 - (same_at_end
+ st
.st_size
- ZV
));
4208 same_at_end
+= overlap
;
4210 /* Arrange to read only the nonmatching middle part of the file. */
4211 XSETFASTINT (beg
, XINT (beg
) + (same_at_start
- BEGV_BYTE
));
4212 XSETFASTINT (end
, XINT (end
) - (ZV_BYTE
- same_at_end
));
4214 del_range_byte (same_at_start
, same_at_end
, 0);
4215 /* Insert from the file at the proper position. */
4216 temp
= BYTE_TO_CHAR (same_at_start
);
4217 SET_PT_BOTH (temp
, same_at_start
);
4219 /* If display currently starts at beginning of line,
4220 keep it that way. */
4221 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
4222 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
4224 replace_handled
= 1;
4228 /* If requested, replace the accessible part of the buffer
4229 with the file contents. Avoid replacing text at the
4230 beginning or end of the buffer that matches the file contents;
4231 that preserves markers pointing to the unchanged parts.
4233 Here we implement this feature for the case where code conversion
4234 is needed, in a simple way that needs a lot of memory.
4235 The preceding if-statement handles the case of no conversion
4236 in a more optimized way. */
4237 if (!NILP (replace
) && ! replace_handled
&& BEGV
< ZV
)
4239 int same_at_start
= BEGV_BYTE
;
4240 int same_at_end
= ZV_BYTE
;
4243 /* Make sure that the gap is large enough. */
4244 int bufsize
= 2 * st
.st_size
;
4245 unsigned char *conversion_buffer
= (unsigned char *) xmalloc (bufsize
);
4248 /* First read the whole file, performing code conversion into
4249 CONVERSION_BUFFER. */
4251 if (lseek (fd
, XINT (beg
), 0) < 0)
4253 xfree (conversion_buffer
);
4254 report_file_error ("Setting file position",
4255 Fcons (orig_filename
, Qnil
));
4258 total
= st
.st_size
; /* Total bytes in the file. */
4259 how_much
= 0; /* Bytes read from file so far. */
4260 inserted
= 0; /* Bytes put into CONVERSION_BUFFER so far. */
4261 unprocessed
= 0; /* Bytes not processed in previous loop. */
4263 while (how_much
< total
)
4265 /* try is reserved in some compilers (Microsoft C) */
4266 int trytry
= min (total
- how_much
, READ_BUF_SIZE
- unprocessed
);
4267 unsigned char *destination
= read_buf
+ unprocessed
;
4270 /* Allow quitting out of the actual I/O. */
4273 this = emacs_read (fd
, destination
, trytry
);
4276 if (this < 0 || this + unprocessed
== 0)
4284 if (CODING_MAY_REQUIRE_DECODING (&coding
))
4286 int require
, result
;
4288 this += unprocessed
;
4290 /* If we are using more space than estimated,
4291 make CONVERSION_BUFFER bigger. */
4292 require
= decoding_buffer_size (&coding
, this);
4293 if (inserted
+ require
+ 2 * (total
- how_much
) > bufsize
)
4295 bufsize
= inserted
+ require
+ 2 * (total
- how_much
);
4296 conversion_buffer
= (unsigned char *) xrealloc (conversion_buffer
, bufsize
);
4299 /* Convert this batch with results in CONVERSION_BUFFER. */
4300 if (how_much
>= total
) /* This is the last block. */
4301 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
4302 if (coding
.composing
!= COMPOSITION_DISABLED
)
4303 coding_allocate_composition_data (&coding
, BEGV
);
4304 result
= decode_coding (&coding
, read_buf
,
4305 conversion_buffer
+ inserted
,
4306 this, bufsize
- inserted
);
4308 /* Save for next iteration whatever we didn't convert. */
4309 unprocessed
= this - coding
.consumed
;
4310 bcopy (read_buf
+ coding
.consumed
, read_buf
, unprocessed
);
4311 if (!NILP (current_buffer
->enable_multibyte_characters
))
4312 this = coding
.produced
;
4314 this = str_as_unibyte (conversion_buffer
+ inserted
,
4321 /* At this point, INSERTED is how many characters (i.e. bytes)
4322 are present in CONVERSION_BUFFER.
4323 HOW_MUCH should equal TOTAL,
4324 or should be <= 0 if we couldn't read the file. */
4328 xfree (conversion_buffer
);
4329 coding_free_composition_data (&coding
);
4330 error ("IO error reading %s: %s",
4331 SDATA (orig_filename
), emacs_strerror (errno
));
4334 /* Compare the beginning of the converted file
4335 with the buffer text. */
4338 while (bufpos
< inserted
&& same_at_start
< same_at_end
4339 && FETCH_BYTE (same_at_start
) == conversion_buffer
[bufpos
])
4340 same_at_start
++, bufpos
++;
4342 /* If the file matches the buffer completely,
4343 there's no need to replace anything. */
4345 if (bufpos
== inserted
)
4347 xfree (conversion_buffer
);
4348 coding_free_composition_data (&coding
);
4351 /* Truncate the buffer to the size of the file. */
4352 del_range_byte (same_at_start
, same_at_end
, 0);
4357 /* Extend the start of non-matching text area to multibyte
4358 character boundary. */
4359 if (! NILP (current_buffer
->enable_multibyte_characters
))
4360 while (same_at_start
> BEGV_BYTE
4361 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start
)))
4364 /* Scan this bufferful from the end, comparing with
4365 the Emacs buffer. */
4368 /* Compare with same_at_start to avoid counting some buffer text
4369 as matching both at the file's beginning and at the end. */
4370 while (bufpos
> 0 && same_at_end
> same_at_start
4371 && FETCH_BYTE (same_at_end
- 1) == conversion_buffer
[bufpos
- 1])
4372 same_at_end
--, bufpos
--;
4374 /* Extend the end of non-matching text area to multibyte
4375 character boundary. */
4376 if (! NILP (current_buffer
->enable_multibyte_characters
))
4377 while (same_at_end
< ZV_BYTE
4378 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end
)))
4381 /* Don't try to reuse the same piece of text twice. */
4382 overlap
= same_at_start
- BEGV_BYTE
- (same_at_end
+ inserted
- ZV_BYTE
);
4384 same_at_end
+= overlap
;
4386 /* If display currently starts at beginning of line,
4387 keep it that way. */
4388 if (XBUFFER (XWINDOW (selected_window
)->buffer
) == current_buffer
)
4389 XWINDOW (selected_window
)->start_at_line_beg
= Fbolp ();
4391 /* Replace the chars that we need to replace,
4392 and update INSERTED to equal the number of bytes
4393 we are taking from the file. */
4394 inserted
-= (ZV_BYTE
- same_at_end
) + (same_at_start
- BEGV_BYTE
);
4396 if (same_at_end
!= same_at_start
)
4398 del_range_byte (same_at_start
, same_at_end
, 0);
4400 same_at_start
= GPT_BYTE
;
4404 temp
= BYTE_TO_CHAR (same_at_start
);
4406 /* Insert from the file at the proper position. */
4407 SET_PT_BOTH (temp
, same_at_start
);
4408 insert_1 (conversion_buffer
+ same_at_start
- BEGV_BYTE
, inserted
,
4410 if (coding
.cmp_data
&& coding
.cmp_data
->used
)
4411 coding_restore_composition (&coding
, Fcurrent_buffer ());
4412 coding_free_composition_data (&coding
);
4414 /* Set `inserted' to the number of inserted characters. */
4415 inserted
= PT
- temp
;
4416 /* Set point before the inserted characters. */
4417 SET_PT_BOTH (temp
, same_at_start
);
4419 xfree (conversion_buffer
);
4428 register Lisp_Object temp
;
4430 total
= XINT (end
) - XINT (beg
);
4432 /* Make sure point-max won't overflow after this insertion. */
4433 XSETINT (temp
, total
);
4434 if (total
!= XINT (temp
))
4435 error ("Maximum buffer size exceeded");
4438 /* For a special file, all we can do is guess. */
4439 total
= READ_BUF_SIZE
;
4441 if (NILP (visit
) && inserted
> 0)
4443 #ifdef CLASH_DETECTION
4444 if (!NILP (current_buffer
->file_truename
)
4445 /* Make binding buffer-file-name to nil effective. */
4446 && !NILP (current_buffer
->filename
)
4447 && SAVE_MODIFF
>= MODIFF
)
4449 #endif /* CLASH_DETECTION */
4450 prepare_to_modify_buffer (GPT
, GPT
, NULL
);
4454 if (GAP_SIZE
< total
)
4455 make_gap (total
- GAP_SIZE
);
4457 if (XINT (beg
) != 0 || !NILP (replace
))
4459 if (lseek (fd
, XINT (beg
), 0) < 0)
4460 report_file_error ("Setting file position",
4461 Fcons (orig_filename
, Qnil
));
4464 /* In the following loop, HOW_MUCH contains the total bytes read so
4465 far for a regular file, and not changed for a special file. But,
4466 before exiting the loop, it is set to a negative value if I/O
4470 /* Total bytes inserted. */
4473 /* Here, we don't do code conversion in the loop. It is done by
4474 code_convert_region after all data are read into the buffer. */
4476 int gap_size
= GAP_SIZE
;
4478 while (how_much
< total
)
4480 /* try is reserved in some compilers (Microsoft C) */
4481 int trytry
= min (total
- how_much
, READ_BUF_SIZE
);
4488 /* Maybe make more room. */
4489 if (gap_size
< trytry
)
4491 make_gap (total
- gap_size
);
4492 gap_size
= GAP_SIZE
;
4495 /* Read from the file, capturing `quit'. When an
4496 error occurs, end the loop, and arrange for a quit
4497 to be signaled after decoding the text we read. */
4498 non_regular_fd
= fd
;
4499 non_regular_inserted
= inserted
;
4500 non_regular_nbytes
= trytry
;
4501 val
= internal_condition_case_1 (read_non_regular
, Qnil
, Qerror
,
4502 read_non_regular_quit
);
4513 /* Allow quitting out of the actual I/O. We don't make text
4514 part of the buffer until all the reading is done, so a C-g
4515 here doesn't do any harm. */
4518 this = emacs_read (fd
, BEG_ADDR
+ PT_BYTE
- BEG_BYTE
+ inserted
, trytry
);
4530 /* For a regular file, where TOTAL is the real size,
4531 count HOW_MUCH to compare with it.
4532 For a special file, where TOTAL is just a buffer size,
4533 so don't bother counting in HOW_MUCH.
4534 (INSERTED is where we count the number of characters inserted.) */
4541 /* Now we have read all the file data into the gap.
4542 If it was empty, undo marking the buffer modified. */
4546 #ifdef CLASH_DETECTION
4548 unlock_file (current_buffer
->file_truename
);
4550 Vdeactivate_mark
= old_Vdeactivate_mark
;
4553 Vdeactivate_mark
= Qt
;
4555 /* Make the text read part of the buffer. */
4556 GAP_SIZE
-= inserted
;
4558 GPT_BYTE
+= inserted
;
4560 ZV_BYTE
+= inserted
;
4565 /* Put an anchor to ensure multi-byte form ends at gap. */
4570 /* Discard the unwind protect for closing the file. */
4574 error ("IO error reading %s: %s",
4575 SDATA (orig_filename
), emacs_strerror (errno
));
4579 if (! coding_system_decided
)
4581 /* The coding system is not yet decided. Decide it by an
4582 optimized method for handling `coding:' tag.
4584 Note that we can get here only if the buffer was empty
4585 before the insertion. */
4589 if (!NILP (Vcoding_system_for_read
))
4590 val
= Vcoding_system_for_read
;
4593 /* Since we are sure that the current buffer was empty
4594 before the insertion, we can toggle
4595 enable-multibyte-characters directly here without taking
4596 care of marker adjustment and byte combining problem. By
4597 this way, we can run Lisp program safely before decoding
4598 the inserted text. */
4599 Lisp_Object unwind_data
;
4600 int count
= SPECPDL_INDEX ();
4602 unwind_data
= Fcons (current_buffer
->enable_multibyte_characters
,
4603 Fcons (current_buffer
->undo_list
,
4604 Fcurrent_buffer ()));
4605 current_buffer
->enable_multibyte_characters
= Qnil
;
4606 current_buffer
->undo_list
= Qt
;
4607 record_unwind_protect (decide_coding_unwind
, unwind_data
);
4609 if (inserted
> 0 && ! NILP (Vset_auto_coding_function
))
4611 val
= call2 (Vset_auto_coding_function
,
4612 filename
, make_number (inserted
));
4617 /* If the coding system is not yet decided, check
4618 file-coding-system-alist. */
4619 Lisp_Object args
[6], coding_systems
;
4621 args
[0] = Qinsert_file_contents
, args
[1] = orig_filename
;
4622 args
[2] = visit
, args
[3] = beg
, args
[4] = end
, args
[5] = Qnil
;
4623 coding_systems
= Ffind_operation_coding_system (6, args
);
4624 if (CONSP (coding_systems
))
4625 val
= XCAR (coding_systems
);
4627 unbind_to (count
, Qnil
);
4628 inserted
= Z_BYTE
- BEG_BYTE
;
4631 /* The following kludgy code is to avoid some compiler bug.
4633 setup_coding_system (val, &coding);
4636 struct coding_system temp_coding
;
4637 setup_coding_system (Fcheck_coding_system (val
), &temp_coding
);
4638 bcopy (&temp_coding
, &coding
, sizeof coding
);
4640 /* Ensure we set Vlast_coding_system_used. */
4641 set_coding_system
= 1;
4643 if (NILP (current_buffer
->enable_multibyte_characters
)
4645 /* We must suppress all character code conversion except for
4646 end-of-line conversion. */
4647 setup_raw_text_coding_system (&coding
);
4648 coding
.src_multibyte
= 0;
4649 coding
.dst_multibyte
4650 = !NILP (current_buffer
->enable_multibyte_characters
);
4654 /* Can't do this if part of the buffer might be preserved. */
4656 && (coding
.type
== coding_type_no_conversion
4657 || coding
.type
== coding_type_raw_text
))
4659 /* Visiting a file with these coding system makes the buffer
4661 current_buffer
->enable_multibyte_characters
= Qnil
;
4662 coding
.dst_multibyte
= 0;
4665 if (inserted
> 0 || coding
.type
== coding_type_ccl
)
4667 if (CODING_MAY_REQUIRE_DECODING (&coding
))
4669 code_convert_region (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4671 inserted
= coding
.produced_char
;
4674 adjust_after_insert (PT
, PT_BYTE
, PT
+ inserted
, PT_BYTE
+ inserted
,
4678 /* Now INSERTED is measured in characters. */
4681 /* Use the conversion type to determine buffer-file-type
4682 (find-buffer-file-type is now used to help determine the
4684 if ((coding
.eol_type
== CODING_EOL_UNDECIDED
4685 || coding
.eol_type
== CODING_EOL_LF
)
4686 && ! CODING_REQUIRE_DECODING (&coding
))
4687 current_buffer
->buffer_file_type
= Qt
;
4689 current_buffer
->buffer_file_type
= Qnil
;
4696 if (!EQ (current_buffer
->undo_list
, Qt
))
4697 current_buffer
->undo_list
= Qnil
;
4699 stat (SDATA (filename
), &st
);
4704 current_buffer
->modtime
= st
.st_mtime
;
4705 current_buffer
->filename
= orig_filename
;
4708 SAVE_MODIFF
= MODIFF
;
4709 current_buffer
->auto_save_modified
= MODIFF
;
4710 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
4711 #ifdef CLASH_DETECTION
4714 if (!NILP (current_buffer
->file_truename
))
4715 unlock_file (current_buffer
->file_truename
);
4716 unlock_file (filename
);
4718 #endif /* CLASH_DETECTION */
4720 Fsignal (Qfile_error
,
4721 Fcons (build_string ("not a regular file"),
4722 Fcons (orig_filename
, Qnil
)));
4725 if (set_coding_system
)
4726 Vlast_coding_system_used
= coding
.symbol
;
4728 if (! NILP (Ffboundp (Qafter_insert_file_set_coding
)))
4730 insval
= call2 (Qafter_insert_file_set_coding
, make_number (inserted
),
4732 if (! NILP (insval
))
4734 CHECK_NUMBER (insval
);
4735 inserted
= XFASTINT (insval
);
4739 /* Decode file format */
4742 int empty_undo_list_p
= 0;
4744 /* If we're anyway going to discard undo information, don't
4745 record it in the first place. The buffer's undo list at this
4746 point is either nil or t when visiting a file. */
4749 empty_undo_list_p
= NILP (current_buffer
->undo_list
);
4750 current_buffer
->undo_list
= Qt
;
4753 insval
= call3 (Qformat_decode
,
4754 Qnil
, make_number (inserted
), visit
);
4755 CHECK_NUMBER (insval
);
4756 inserted
= XFASTINT (insval
);
4759 current_buffer
->undo_list
= empty_undo_list_p
? Qnil
: Qt
;
4762 /* Call after-change hooks for the inserted text, aside from the case
4763 of normal visiting (not with REPLACE), which is done in a new buffer
4764 "before" the buffer is changed. */
4765 if (inserted
> 0 && total
> 0
4766 && (NILP (visit
) || !NILP (replace
)))
4768 signal_after_change (PT
, 0, inserted
);
4769 update_compositions (PT
, PT
, CHECK_BORDER
);
4772 p
= Vafter_insert_file_functions
;
4775 insval
= call1 (XCAR (p
), make_number (inserted
));
4778 CHECK_NUMBER (insval
);
4779 inserted
= XFASTINT (insval
);
4786 && current_buffer
->modtime
== -1)
4788 /* If visiting nonexistent file, return nil. */
4789 report_file_error ("Opening input file", Fcons (orig_filename
, Qnil
));
4793 Fsignal (Qquit
, Qnil
);
4795 /* ??? Retval needs to be dealt with in all cases consistently. */
4797 val
= Fcons (orig_filename
,
4798 Fcons (make_number (inserted
),
4801 RETURN_UNGCPRO (unbind_to (count
, val
));
4804 static Lisp_Object build_annotations
P_ ((Lisp_Object
, Lisp_Object
));
4805 static Lisp_Object build_annotations_2
P_ ((Lisp_Object
, Lisp_Object
,
4806 Lisp_Object
, Lisp_Object
));
4808 /* If build_annotations switched buffers, switch back to BUF.
4809 Kill the temporary buffer that was selected in the meantime.
4811 Since this kill only the last temporary buffer, some buffers remain
4812 not killed if build_annotations switched buffers more than once.
4816 build_annotations_unwind (buf
)
4821 if (XBUFFER (buf
) == current_buffer
)
4823 tembuf
= Fcurrent_buffer ();
4825 Fkill_buffer (tembuf
);
4829 /* Decide the coding-system to encode the data with. */
4832 choose_write_coding_system (start
, end
, filename
,
4833 append
, visit
, lockname
, coding
)
4834 Lisp_Object start
, end
, filename
, append
, visit
, lockname
;
4835 struct coding_system
*coding
;
4840 && NILP (Fstring_equal (current_buffer
->filename
,
4841 current_buffer
->auto_save_file_name
)))
4843 /* We use emacs-mule for auto saving... */
4844 setup_coding_system (Qemacs_mule
, coding
);
4845 /* ... but with the special flag to indicate not to strip off
4846 leading code of eight-bit-control chars. */
4848 goto done_setup_coding
;
4850 else if (!NILP (Vcoding_system_for_write
))
4852 val
= Vcoding_system_for_write
;
4853 if (coding_system_require_warning
4854 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4855 /* Confirm that VAL can surely encode the current region. */
4856 val
= call5 (Vselect_safe_coding_system_function
,
4857 start
, end
, Fcons (Qt
, Fcons (val
, Qnil
)),
4862 /* If the variable `buffer-file-coding-system' is set locally,
4863 it means that the file was read with some kind of code
4864 conversion or the variable is explicitly set by users. We
4865 had better write it out with the same coding system even if
4866 `enable-multibyte-characters' is nil.
4868 If it is not set locally, we anyway have to convert EOL
4869 format if the default value of `buffer-file-coding-system'
4870 tells that it is not Unix-like (LF only) format. */
4871 int using_default_coding
= 0;
4872 int force_raw_text
= 0;
4874 val
= current_buffer
->buffer_file_coding_system
;
4876 || NILP (Flocal_variable_p (Qbuffer_file_coding_system
, Qnil
)))
4879 if (NILP (current_buffer
->enable_multibyte_characters
))
4885 /* Check file-coding-system-alist. */
4886 Lisp_Object args
[7], coding_systems
;
4888 args
[0] = Qwrite_region
; args
[1] = start
; args
[2] = end
;
4889 args
[3] = filename
; args
[4] = append
; args
[5] = visit
;
4891 coding_systems
= Ffind_operation_coding_system (7, args
);
4892 if (CONSP (coding_systems
) && !NILP (XCDR (coding_systems
)))
4893 val
= XCDR (coding_systems
);
4897 && !NILP (current_buffer
->buffer_file_coding_system
))
4899 /* If we still have not decided a coding system, use the
4900 default value of buffer-file-coding-system. */
4901 val
= current_buffer
->buffer_file_coding_system
;
4902 using_default_coding
= 1;
4906 && !NILP (Ffboundp (Vselect_safe_coding_system_function
)))
4907 /* Confirm that VAL can surely encode the current region. */
4908 val
= call5 (Vselect_safe_coding_system_function
,
4909 start
, end
, val
, Qnil
, filename
);
4911 setup_coding_system (Fcheck_coding_system (val
), coding
);
4912 if (coding
->eol_type
== CODING_EOL_UNDECIDED
4913 && !using_default_coding
)
4915 if (! EQ (default_buffer_file_coding
.symbol
,
4916 buffer_defaults
.buffer_file_coding_system
))
4917 setup_coding_system (buffer_defaults
.buffer_file_coding_system
,
4918 &default_buffer_file_coding
);
4919 if (default_buffer_file_coding
.eol_type
!= CODING_EOL_UNDECIDED
)
4921 Lisp_Object subsidiaries
;
4923 coding
->eol_type
= default_buffer_file_coding
.eol_type
;
4924 subsidiaries
= Fget (coding
->symbol
, Qeol_type
);
4925 if (VECTORP (subsidiaries
)
4926 && XVECTOR (subsidiaries
)->size
== 3)
4928 = XVECTOR (subsidiaries
)->contents
[coding
->eol_type
];
4933 setup_raw_text_coding_system (coding
);
4934 goto done_setup_coding
;
4937 setup_coding_system (Fcheck_coding_system (val
), coding
);
4940 if (coding
->eol_type
== CODING_EOL_UNDECIDED
)
4941 coding
->eol_type
= system_eol_type
;
4942 if (!STRINGP (start
) && !NILP (current_buffer
->selective_display
))
4943 coding
->mode
|= CODING_MODE_SELECTIVE_DISPLAY
;
4946 DEFUN ("write-region", Fwrite_region
, Swrite_region
, 3, 7,
4947 "r\nFWrite region to file: \ni\ni\ni\np",
4948 doc
: /* Write current region into specified file.
4949 When called from a program, requires three arguments:
4950 START, END and FILENAME. START and END are normally buffer positions
4951 specifying the part of the buffer to write.
4952 If START is nil, that means to use the entire buffer contents.
4953 If START is a string, then output that string to the file
4954 instead of any buffer contents; END is ignored.
4956 Optional fourth argument APPEND if non-nil means
4957 append to existing file contents (if any). If it is an integer,
4958 seek to that offset in the file before writing.
4959 Optional fifth argument VISIT, if t or a string, means
4960 set the last-save-file-modtime of buffer to this file's modtime
4961 and mark buffer not modified.
4962 If VISIT is a string, it is a second file name;
4963 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4964 VISIT is also the file name to lock and unlock for clash detection.
4965 If VISIT is neither t nor nil nor a string,
4966 that means do not display the \"Wrote file\" message.
4967 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4968 use for locking and unlocking, overriding FILENAME and VISIT.
4969 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4970 for an existing file with the same name. If MUSTBENEW is `excl',
4971 that means to get an error if the file already exists; never overwrite.
4972 If MUSTBENEW is neither nil nor `excl', that means ask for
4973 confirmation before overwriting, but do go ahead and overwrite the file
4974 if the user confirms.
4976 This does code conversion according to the value of
4977 `coding-system-for-write', `buffer-file-coding-system', or
4978 `file-coding-system-alist', and sets the variable
4979 `last-coding-system-used' to the coding system actually used. */)
4980 (start
, end
, filename
, append
, visit
, lockname
, mustbenew
)
4981 Lisp_Object start
, end
, filename
, append
, visit
, lockname
, mustbenew
;
4986 const unsigned char *fn
;
4989 int count
= SPECPDL_INDEX ();
4992 unsigned char *fname
= 0; /* If non-0, original filename (must rename) */
4994 Lisp_Object handler
;
4995 Lisp_Object visit_file
;
4996 Lisp_Object annotations
;
4997 Lisp_Object encoded_filename
;
4998 int visiting
= (EQ (visit
, Qt
) || STRINGP (visit
));
4999 int quietly
= !NILP (visit
);
5000 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
5001 struct buffer
*given_buffer
;
5003 int buffer_file_type
= O_BINARY
;
5005 struct coding_system coding
;
5007 if (current_buffer
->base_buffer
&& visiting
)
5008 error ("Cannot do file visiting in an indirect buffer");
5010 if (!NILP (start
) && !STRINGP (start
))
5011 validate_region (&start
, &end
);
5014 GCPRO5 (start
, filename
, visit
, visit_file
, lockname
);
5016 filename
= Fexpand_file_name (filename
, Qnil
);
5018 if (!NILP (mustbenew
) && !EQ (mustbenew
, Qexcl
))
5019 barf_or_query_if_file_exists (filename
, "overwrite", 1, 0, 1);
5021 if (STRINGP (visit
))
5022 visit_file
= Fexpand_file_name (visit
, Qnil
);
5024 visit_file
= filename
;
5026 if (NILP (lockname
))
5027 lockname
= visit_file
;
5031 /* If the file name has special constructs in it,
5032 call the corresponding file handler. */
5033 handler
= Ffind_file_name_handler (filename
, Qwrite_region
);
5034 /* If FILENAME has no handler, see if VISIT has one. */
5035 if (NILP (handler
) && STRINGP (visit
))
5036 handler
= Ffind_file_name_handler (visit
, Qwrite_region
);
5038 if (!NILP (handler
))
5041 val
= call6 (handler
, Qwrite_region
, start
, end
,
5042 filename
, append
, visit
);
5046 SAVE_MODIFF
= MODIFF
;
5047 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5048 current_buffer
->filename
= visit_file
;
5054 record_unwind_protect (save_restriction_restore
, save_restriction_save ());
5056 /* Special kludge to simplify auto-saving. */
5059 XSETFASTINT (start
, BEG
);
5060 XSETFASTINT (end
, Z
);
5064 record_unwind_protect (build_annotations_unwind
, Fcurrent_buffer ());
5065 count1
= SPECPDL_INDEX ();
5067 given_buffer
= current_buffer
;
5069 if (!STRINGP (start
))
5071 annotations
= build_annotations (start
, end
);
5073 if (current_buffer
!= given_buffer
)
5075 XSETFASTINT (start
, BEGV
);
5076 XSETFASTINT (end
, ZV
);
5082 GCPRO5 (start
, filename
, annotations
, visit_file
, lockname
);
5084 /* Decide the coding-system to encode the data with.
5085 We used to make this choice before calling build_annotations, but that
5086 leads to problems when a write-annotate-function takes care of
5087 unsavable chars (as was the case with X-Symbol). */
5088 choose_write_coding_system (start
, end
, filename
,
5089 append
, visit
, lockname
, &coding
);
5090 Vlast_coding_system_used
= coding
.symbol
;
5092 given_buffer
= current_buffer
;
5093 if (! STRINGP (start
))
5095 annotations
= build_annotations_2 (start
, end
,
5096 coding
.pre_write_conversion
, annotations
);
5097 if (current_buffer
!= given_buffer
)
5099 XSETFASTINT (start
, BEGV
);
5100 XSETFASTINT (end
, ZV
);
5104 #ifdef CLASH_DETECTION
5107 #if 0 /* This causes trouble for GNUS. */
5108 /* If we've locked this file for some other buffer,
5109 query before proceeding. */
5110 if (!visiting
&& EQ (Ffile_locked_p (lockname
), Qt
))
5111 call2 (intern ("ask-user-about-lock"), filename
, Vuser_login_name
);
5114 lock_file (lockname
);
5116 #endif /* CLASH_DETECTION */
5118 encoded_filename
= ENCODE_FILE (filename
);
5120 fn
= SDATA (encoded_filename
);
5124 desc
= emacs_open (fn
, O_WRONLY
| buffer_file_type
, 0);
5125 #else /* not DOS_NT */
5126 desc
= emacs_open (fn
, O_WRONLY
, 0);
5127 #endif /* not DOS_NT */
5129 if (desc
< 0 && (NILP (append
) || errno
== ENOENT
))
5131 if (auto_saving
) /* Overwrite any previous version of autosave file */
5133 vms_truncate (fn
); /* if fn exists, truncate to zero length */
5134 desc
= emacs_open (fn
, O_RDWR
, 0);
5136 desc
= creat_copy_attrs (STRINGP (current_buffer
->filename
)
5137 ? SDATA (current_buffer
->filename
) : 0,
5140 else /* Write to temporary name and rename if no errors */
5142 Lisp_Object temp_name
;
5143 temp_name
= Ffile_name_directory (filename
);
5145 if (!NILP (temp_name
))
5147 temp_name
= Fmake_temp_name (concat2 (temp_name
,
5148 build_string ("$$SAVE$$")));
5149 fname
= SDATA (filename
);
5150 fn
= SDATA (temp_name
);
5151 desc
= creat_copy_attrs (fname
, fn
);
5154 /* If we can't open the temporary file, try creating a new
5155 version of the original file. VMS "creat" creates a
5156 new version rather than truncating an existing file. */
5159 desc
= creat (fn
, 0666);
5160 #if 0 /* This can clobber an existing file and fail to replace it,
5161 if the user runs out of space. */
5164 /* We can't make a new version;
5165 try to truncate and rewrite existing version if any. */
5167 desc
= emacs_open (fn
, O_RDWR
, 0);
5173 desc
= creat (fn
, 0666);
5177 desc
= emacs_open (fn
,
5178 O_WRONLY
| O_CREAT
| buffer_file_type
5179 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: O_TRUNC
),
5180 S_IREAD
| S_IWRITE
);
5181 #else /* not DOS_NT */
5182 desc
= emacs_open (fn
, O_WRONLY
| O_TRUNC
| O_CREAT
5183 | (EQ (mustbenew
, Qexcl
) ? O_EXCL
: 0),
5184 auto_saving
? auto_save_mode_bits
: 0666);
5185 #endif /* not DOS_NT */
5186 #endif /* not VMS */
5190 #ifdef CLASH_DETECTION
5192 if (!auto_saving
) unlock_file (lockname
);
5194 #endif /* CLASH_DETECTION */
5196 report_file_error ("Opening output file", Fcons (filename
, Qnil
));
5199 record_unwind_protect (close_file_unwind
, make_number (desc
));
5201 if (!NILP (append
) && !NILP (Ffile_regular_p (filename
)))
5205 if (NUMBERP (append
))
5206 ret
= lseek (desc
, XINT (append
), 1);
5208 ret
= lseek (desc
, 0, 2);
5211 #ifdef CLASH_DETECTION
5212 if (!auto_saving
) unlock_file (lockname
);
5213 #endif /* CLASH_DETECTION */
5215 report_file_error ("Lseek error", Fcons (filename
, Qnil
));
5223 * Kludge Warning: The VMS C RTL likes to insert carriage returns
5224 * if we do writes that don't end with a carriage return. Furthermore
5225 * it cannot handle writes of more then 16K. The modified
5226 * version of "sys_write" in SYSDEP.C (see comment there) copes with
5227 * this EXCEPT for the last record (iff it doesn't end with a carriage
5228 * return). This implies that if your buffer doesn't end with a carriage
5229 * return, you get one free... tough. However it also means that if
5230 * we make two calls to sys_write (a la the following code) you can
5231 * get one at the gap as well. The easiest way to fix this (honest)
5232 * is to move the gap to the next newline (or the end of the buffer).
5237 if (GPT
> BEG
&& GPT_ADDR
[-1] != '\n')
5238 move_gap (find_next_newline (GPT
, 1));
5240 /* Whether VMS or not, we must move the gap to the next of newline
5241 when we must put designation sequences at beginning of line. */
5242 if (INTEGERP (start
)
5243 && coding
.type
== coding_type_iso2022
5244 && coding
.flags
& CODING_FLAG_ISO_DESIGNATE_AT_BOL
5245 && GPT
> BEG
&& GPT_ADDR
[-1] != '\n')
5247 int opoint
= PT
, opoint_byte
= PT_BYTE
;
5248 scan_newline (PT
, PT_BYTE
, ZV
, ZV_BYTE
, 1, 0);
5249 move_gap_both (PT
, PT_BYTE
);
5250 SET_PT_BOTH (opoint
, opoint_byte
);
5257 if (STRINGP (start
))
5259 failure
= 0 > a_write (desc
, start
, 0, SCHARS (start
),
5260 &annotations
, &coding
);
5263 else if (XINT (start
) != XINT (end
))
5265 tem
= CHAR_TO_BYTE (XINT (start
));
5267 if (XINT (start
) < GPT
)
5269 failure
= 0 > a_write (desc
, Qnil
, XINT (start
),
5270 min (GPT
, XINT (end
)) - XINT (start
),
5271 &annotations
, &coding
);
5275 if (XINT (end
) > GPT
&& !failure
)
5277 tem
= max (XINT (start
), GPT
);
5278 failure
= 0 > a_write (desc
, Qnil
, tem
, XINT (end
) - tem
,
5279 &annotations
, &coding
);
5285 /* If file was empty, still need to write the annotations */
5286 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
5287 failure
= 0 > a_write (desc
, Qnil
, XINT (end
), 0, &annotations
, &coding
);
5291 if (CODING_REQUIRE_FLUSHING (&coding
)
5292 && !(coding
.mode
& CODING_MODE_LAST_BLOCK
)
5295 /* We have to flush out a data. */
5296 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
5297 failure
= 0 > e_write (desc
, Qnil
, 0, 0, &coding
);
5304 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
5305 Disk full in NFS may be reported here. */
5306 /* mib says that closing the file will try to write as fast as NFS can do
5307 it, and that means the fsync here is not crucial for autosave files. */
5308 if (!auto_saving
&& !write_region_inhibit_fsync
&& fsync (desc
) < 0)
5310 /* If fsync fails with EINTR, don't treat that as serious. */
5312 failure
= 1, save_errno
= errno
;
5316 /* Spurious "file has changed on disk" warnings have been
5317 observed on Suns as well.
5318 It seems that `close' can change the modtime, under nfs.
5320 (This has supposedly been fixed in Sunos 4,
5321 but who knows about all the other machines with NFS?) */
5324 /* On VMS and APOLLO, must do the stat after the close
5325 since closing changes the modtime. */
5328 /* Recall that #if defined does not work on VMS. */
5335 /* NFS can report a write failure now. */
5336 if (emacs_close (desc
) < 0)
5337 failure
= 1, save_errno
= errno
;
5340 /* If we wrote to a temporary name and had no errors, rename to real name. */
5344 failure
= (rename (fn
, fname
) != 0), save_errno
= errno
;
5352 /* Discard the unwind protect for close_file_unwind. */
5353 specpdl_ptr
= specpdl
+ count1
;
5354 /* Restore the original current buffer. */
5355 visit_file
= unbind_to (count
, visit_file
);
5357 #ifdef CLASH_DETECTION
5359 unlock_file (lockname
);
5360 #endif /* CLASH_DETECTION */
5362 /* Do this before reporting IO error
5363 to avoid a "file has changed on disk" warning on
5364 next attempt to save. */
5366 current_buffer
->modtime
= st
.st_mtime
;
5369 error ("IO error writing %s: %s", SDATA (filename
),
5370 emacs_strerror (save_errno
));
5374 SAVE_MODIFF
= MODIFF
;
5375 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
5376 current_buffer
->filename
= visit_file
;
5377 update_mode_lines
++;
5382 && ! NILP (Fstring_equal (current_buffer
->filename
,
5383 current_buffer
->auto_save_file_name
)))
5384 SAVE_MODIFF
= MODIFF
;
5390 message_with_string ((INTEGERP (append
)
5400 Lisp_Object
merge ();
5402 DEFUN ("car-less-than-car", Fcar_less_than_car
, Scar_less_than_car
, 2, 2, 0,
5403 doc
: /* Return t if (car A) is numerically less than (car B). */)
5407 return Flss (Fcar (a
), Fcar (b
));
5410 /* Build the complete list of annotations appropriate for writing out
5411 the text between START and END, by calling all the functions in
5412 write-region-annotate-functions and merging the lists they return.
5413 If one of these functions switches to a different buffer, we assume
5414 that buffer contains altered text. Therefore, the caller must
5415 make sure to restore the current buffer in all cases,
5416 as save-excursion would do. */
5419 build_annotations (start
, end
)
5420 Lisp_Object start
, end
;
5422 Lisp_Object annotations
;
5424 struct gcpro gcpro1
, gcpro2
;
5425 Lisp_Object original_buffer
;
5426 int i
, used_global
= 0;
5428 XSETBUFFER (original_buffer
, current_buffer
);
5431 p
= Vwrite_region_annotate_functions
;
5432 GCPRO2 (annotations
, p
);
5435 struct buffer
*given_buffer
= current_buffer
;
5436 if (EQ (Qt
, XCAR (p
)) && !used_global
)
5437 { /* Use the global value of the hook. */
5440 arg
[0] = Fdefault_value (Qwrite_region_annotate_functions
);
5442 p
= Fappend (2, arg
);
5445 Vwrite_region_annotations_so_far
= annotations
;
5446 res
= call2 (XCAR (p
), start
, end
);
5447 /* If the function makes a different buffer current,
5448 assume that means this buffer contains altered text to be output.
5449 Reset START and END from the buffer bounds
5450 and discard all previous annotations because they should have
5451 been dealt with by this function. */
5452 if (current_buffer
!= given_buffer
)
5454 XSETFASTINT (start
, BEGV
);
5455 XSETFASTINT (end
, ZV
);
5458 Flength (res
); /* Check basic validity of return value */
5459 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5463 /* Now do the same for annotation functions implied by the file-format */
5464 if (auto_saving
&& (!EQ (current_buffer
->auto_save_file_format
, Qt
)))
5465 p
= current_buffer
->auto_save_file_format
;
5467 p
= current_buffer
->file_format
;
5468 for (i
= 0; CONSP (p
); p
= XCDR (p
), ++i
)
5470 struct buffer
*given_buffer
= current_buffer
;
5472 Vwrite_region_annotations_so_far
= annotations
;
5474 /* Value is either a list of annotations or nil if the function
5475 has written annotations to a temporary buffer, which is now
5477 res
= call5 (Qformat_annotate_function
, XCAR (p
), start
, end
,
5478 original_buffer
, make_number (i
));
5479 if (current_buffer
!= given_buffer
)
5481 XSETFASTINT (start
, BEGV
);
5482 XSETFASTINT (end
, ZV
);
5487 annotations
= merge (annotations
, res
, Qcar_less_than_car
);
5495 build_annotations_2 (start
, end
, pre_write_conversion
, annotations
)
5496 Lisp_Object start
, end
, pre_write_conversion
, annotations
;
5498 struct gcpro gcpro1
;
5501 GCPRO1 (annotations
);
5502 /* At last, do the same for the function PRE_WRITE_CONVERSION
5503 implied by the current coding-system. */
5504 if (!NILP (pre_write_conversion
))
5506 struct buffer
*given_buffer
= current_buffer
;
5507 Vwrite_region_annotations_so_far
= annotations
;
5508 res
= call2 (pre_write_conversion
, start
, end
);
5510 annotations
= (current_buffer
!= given_buffer
5512 : merge (annotations
, res
, Qcar_less_than_car
));
5519 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5520 If STRING is nil, POS is the character position in the current buffer.
5521 Intersperse with them the annotations from *ANNOT
5522 which fall within the range of POS to POS + NCHARS,
5523 each at its appropriate position.
5525 We modify *ANNOT by discarding elements as we use them up.
5527 The return value is negative in case of system call failure. */
5530 a_write (desc
, string
, pos
, nchars
, annot
, coding
)
5533 register int nchars
;
5536 struct coding_system
*coding
;
5540 int lastpos
= pos
+ nchars
;
5542 while (NILP (*annot
) || CONSP (*annot
))
5544 tem
= Fcar_safe (Fcar (*annot
));
5547 nextpos
= XFASTINT (tem
);
5549 /* If there are no more annotations in this range,
5550 output the rest of the range all at once. */
5551 if (! (nextpos
>= pos
&& nextpos
<= lastpos
))
5552 return e_write (desc
, string
, pos
, lastpos
, coding
);
5554 /* Output buffer text up to the next annotation's position. */
5557 if (0 > e_write (desc
, string
, pos
, nextpos
, coding
))
5561 /* Output the annotation. */
5562 tem
= Fcdr (Fcar (*annot
));
5565 if (0 > e_write (desc
, tem
, 0, SCHARS (tem
), coding
))
5568 *annot
= Fcdr (*annot
);
5573 #ifndef WRITE_BUF_SIZE
5574 #define WRITE_BUF_SIZE (16 * 1024)
5577 /* Write text in the range START and END into descriptor DESC,
5578 encoding them with coding system CODING. If STRING is nil, START
5579 and END are character positions of the current buffer, else they
5580 are indexes to the string STRING. */
5583 e_write (desc
, string
, start
, end
, coding
)
5587 struct coding_system
*coding
;
5589 register char *addr
;
5590 register int nbytes
;
5591 char buf
[WRITE_BUF_SIZE
];
5595 coding
->composing
= COMPOSITION_DISABLED
;
5596 if (coding
->composing
!= COMPOSITION_DISABLED
)
5597 coding_save_composition (coding
, start
, end
, string
);
5599 if (STRINGP (string
))
5601 addr
= SDATA (string
);
5602 nbytes
= SBYTES (string
);
5603 coding
->src_multibyte
= STRING_MULTIBYTE (string
);
5605 else if (start
< end
)
5607 /* It is assured that the gap is not in the range START and END-1. */
5608 addr
= CHAR_POS_ADDR (start
);
5609 nbytes
= CHAR_TO_BYTE (end
) - CHAR_TO_BYTE (start
);
5610 coding
->src_multibyte
5611 = !NILP (current_buffer
->enable_multibyte_characters
);
5617 coding
->src_multibyte
= 1;
5620 /* We used to have a code for handling selective display here. But,
5621 now it is handled within encode_coding. */
5626 result
= encode_coding (coding
, addr
, buf
, nbytes
, WRITE_BUF_SIZE
);
5627 if (coding
->produced
> 0)
5629 coding
->produced
-= emacs_write (desc
, buf
, coding
->produced
);
5630 if (coding
->produced
)
5636 nbytes
-= coding
->consumed
;
5637 addr
+= coding
->consumed
;
5638 if (result
== CODING_FINISH_INSUFFICIENT_SRC
5641 /* The source text ends by an incomplete multibyte form.
5642 There's no way other than write it out as is. */
5643 nbytes
-= emacs_write (desc
, addr
, nbytes
);
5652 start
+= coding
->consumed_char
;
5653 if (coding
->cmp_data
)
5654 coding_adjust_composition_offset (coding
, start
);
5657 if (coding
->cmp_data
)
5658 coding_free_composition_data (coding
);
5663 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime
,
5664 Sverify_visited_file_modtime
, 1, 1, 0,
5665 doc
: /* Return t if last mod time of BUF's visited file matches what BUF records.
5666 This means that the file has not been changed since it was visited or saved.
5667 See Info node `(elisp)Modification Time' for more details. */)
5673 Lisp_Object handler
;
5674 Lisp_Object filename
;
5679 if (!STRINGP (b
->filename
)) return Qt
;
5680 if (b
->modtime
== 0) return Qt
;
5682 /* If the file name has special constructs in it,
5683 call the corresponding file handler. */
5684 handler
= Ffind_file_name_handler (b
->filename
,
5685 Qverify_visited_file_modtime
);
5686 if (!NILP (handler
))
5687 return call2 (handler
, Qverify_visited_file_modtime
, buf
);
5689 filename
= ENCODE_FILE (b
->filename
);
5691 if (stat (SDATA (filename
), &st
) < 0)
5693 /* If the file doesn't exist now and didn't exist before,
5694 we say that it isn't modified, provided the error is a tame one. */
5695 if (errno
== ENOENT
|| errno
== EACCES
|| errno
== ENOTDIR
)
5700 if (st
.st_mtime
== b
->modtime
5701 /* If both are positive, accept them if they are off by one second. */
5702 || (st
.st_mtime
> 0 && b
->modtime
> 0
5703 && (st
.st_mtime
== b
->modtime
+ 1
5704 || st
.st_mtime
== b
->modtime
- 1)))
5709 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime
,
5710 Sclear_visited_file_modtime
, 0, 0, 0,
5711 doc
: /* Clear out records of last mod time of visited file.
5712 Next attempt to save will certainly not complain of a discrepancy. */)
5715 current_buffer
->modtime
= 0;
5719 DEFUN ("visited-file-modtime", Fvisited_file_modtime
,
5720 Svisited_file_modtime
, 0, 0, 0,
5721 doc
: /* Return the current buffer's recorded visited file modification time.
5722 The value is a list of the form (HIGH LOW), like the time values
5723 that `file-attributes' returns. If the current buffer has no recorded
5724 file modification time, this function returns 0.
5725 See Info node `(elisp)Modification Time' for more details. */)
5729 tcons
= long_to_cons ((unsigned long) current_buffer
->modtime
);
5731 return list2 (XCAR (tcons
), XCDR (tcons
));
5735 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime
,
5736 Sset_visited_file_modtime
, 0, 1, 0,
5737 doc
: /* Update buffer's recorded modification time from the visited file's time.
5738 Useful if the buffer was not read from the file normally
5739 or if the file itself has been changed for some known benign reason.
5740 An argument specifies the modification time value to use
5741 \(instead of that of the visited file), in the form of a list
5742 \(HIGH . LOW) or (HIGH LOW). */)
5744 Lisp_Object time_list
;
5746 if (!NILP (time_list
))
5747 current_buffer
->modtime
= cons_to_long (time_list
);
5750 register Lisp_Object filename
;
5752 Lisp_Object handler
;
5754 filename
= Fexpand_file_name (current_buffer
->filename
, Qnil
);
5756 /* If the file name has special constructs in it,
5757 call the corresponding file handler. */
5758 handler
= Ffind_file_name_handler (filename
, Qset_visited_file_modtime
);
5759 if (!NILP (handler
))
5760 /* The handler can find the file name the same way we did. */
5761 return call2 (handler
, Qset_visited_file_modtime
, Qnil
);
5763 filename
= ENCODE_FILE (filename
);
5765 if (stat (SDATA (filename
), &st
) >= 0)
5766 current_buffer
->modtime
= st
.st_mtime
;
5773 auto_save_error (error
)
5776 Lisp_Object args
[3], msg
;
5778 struct gcpro gcpro1
;
5784 args
[0] = build_string ("Auto-saving %s: %s");
5785 args
[1] = current_buffer
->name
;
5786 args
[2] = Ferror_message_string (error
);
5787 msg
= Fformat (3, args
);
5789 nbytes
= SBYTES (msg
);
5790 SAFE_ALLOCA (msgbuf
, char *, nbytes
);
5791 bcopy (SDATA (msg
), msgbuf
, nbytes
);
5793 for (i
= 0; i
< 3; ++i
)
5796 message2 (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5798 message2_nolog (msgbuf
, nbytes
, STRING_MULTIBYTE (msg
));
5799 Fsleep_for (make_number (1), Qnil
);
5813 auto_save_mode_bits
= 0666;
5815 /* Get visited file's mode to become the auto save file's mode. */
5816 if (! NILP (current_buffer
->filename
))
5818 if (stat (SDATA (current_buffer
->filename
), &st
) >= 0)
5819 /* But make sure we can overwrite it later! */
5820 auto_save_mode_bits
= st
.st_mode
| 0600;
5821 else if ((modes
= Ffile_modes (current_buffer
->filename
),
5823 /* Remote files don't cooperate with stat. */
5824 auto_save_mode_bits
= XINT (modes
) | 0600;
5828 Fwrite_region (Qnil
, Qnil
,
5829 current_buffer
->auto_save_file_name
,
5830 Qnil
, Qlambda
, Qnil
, Qnil
);
5834 do_auto_save_unwind (arg
) /* used as unwind-protect function */
5837 FILE *stream
= (FILE *) XSAVE_VALUE (arg
)->pointer
;
5845 do_auto_save_unwind_1 (value
) /* used as unwind-protect function */
5848 minibuffer_auto_raise
= XINT (value
);
5853 do_auto_save_make_dir (dir
)
5856 return call2 (Qmake_directory
, dir
, Qt
);
5860 do_auto_save_eh (ignore
)
5866 DEFUN ("do-auto-save", Fdo_auto_save
, Sdo_auto_save
, 0, 2, "",
5867 doc
: /* Auto-save all buffers that need it.
5868 This is all buffers that have auto-saving enabled
5869 and are changed since last auto-saved.
5870 Auto-saving writes the buffer into a file
5871 so that your editing is not lost if the system crashes.
5872 This file is not the file you visited; that changes only when you save.
5873 Normally we run the normal hook `auto-save-hook' before saving.
5875 A non-nil NO-MESSAGE argument means do not print any message if successful.
5876 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5877 (no_message
, current_only
)
5878 Lisp_Object no_message
, current_only
;
5880 struct buffer
*old
= current_buffer
, *b
;
5881 Lisp_Object tail
, buf
;
5883 int do_handled_files
;
5885 FILE *stream
= NULL
;
5886 int count
= SPECPDL_INDEX ();
5887 int orig_minibuffer_auto_raise
= minibuffer_auto_raise
;
5888 int old_message_p
= 0;
5889 struct gcpro gcpro1
, gcpro2
;
5891 if (max_specpdl_size
< specpdl_size
+ 40)
5892 max_specpdl_size
= specpdl_size
+ 40;
5897 if (NILP (no_message
))
5899 old_message_p
= push_message ();
5900 record_unwind_protect (pop_message_unwind
, Qnil
);
5903 /* Ordinarily don't quit within this function,
5904 but don't make it impossible to quit (in case we get hung in I/O). */
5908 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5909 point to non-strings reached from Vbuffer_alist. */
5911 if (!NILP (Vrun_hooks
))
5912 call1 (Vrun_hooks
, intern ("auto-save-hook"));
5914 if (STRINGP (Vauto_save_list_file_name
))
5916 Lisp_Object listfile
;
5918 listfile
= Fexpand_file_name (Vauto_save_list_file_name
, Qnil
);
5920 /* Don't try to create the directory when shutting down Emacs,
5921 because creating the directory might signal an error, and
5922 that would leave Emacs in a strange state. */
5923 if (!NILP (Vrun_hooks
))
5927 GCPRO2 (dir
, listfile
);
5928 dir
= Ffile_name_directory (listfile
);
5929 if (NILP (Ffile_directory_p (dir
)))
5930 internal_condition_case_1 (do_auto_save_make_dir
,
5931 dir
, Fcons (Fcons (Qfile_error
, Qnil
), Qnil
),
5936 stream
= fopen (SDATA (listfile
), "w");
5939 record_unwind_protect (do_auto_save_unwind
,
5940 make_save_value (stream
, 0));
5941 record_unwind_protect (do_auto_save_unwind_1
,
5942 make_number (minibuffer_auto_raise
));
5943 minibuffer_auto_raise
= 0;
5946 /* On first pass, save all files that don't have handlers.
5947 On second pass, save all files that do have handlers.
5949 If Emacs is crashing, the handlers may tweak what is causing
5950 Emacs to crash in the first place, and it would be a shame if
5951 Emacs failed to autosave perfectly ordinary files because it
5952 couldn't handle some ange-ftp'd file. */
5954 for (do_handled_files
= 0; do_handled_files
< 2; do_handled_files
++)
5955 for (tail
= Vbuffer_alist
; GC_CONSP (tail
); tail
= XCDR (tail
))
5957 buf
= XCDR (XCAR (tail
));
5960 /* Record all the buffers that have auto save mode
5961 in the special file that lists them. For each of these buffers,
5962 Record visited name (if any) and auto save name. */
5963 if (STRINGP (b
->auto_save_file_name
)
5964 && stream
!= NULL
&& do_handled_files
== 0)
5966 if (!NILP (b
->filename
))
5968 fwrite (SDATA (b
->filename
), 1,
5969 SBYTES (b
->filename
), stream
);
5971 putc ('\n', stream
);
5972 fwrite (SDATA (b
->auto_save_file_name
), 1,
5973 SBYTES (b
->auto_save_file_name
), stream
);
5974 putc ('\n', stream
);
5977 if (!NILP (current_only
)
5978 && b
!= current_buffer
)
5981 /* Don't auto-save indirect buffers.
5982 The base buffer takes care of it. */
5986 /* Check for auto save enabled
5987 and file changed since last auto save
5988 and file changed since last real save. */
5989 if (STRINGP (b
->auto_save_file_name
)
5990 && BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)
5991 && b
->auto_save_modified
< BUF_MODIFF (b
)
5992 /* -1 means we've turned off autosaving for a while--see below. */
5993 && XINT (b
->save_length
) >= 0
5994 && (do_handled_files
5995 || NILP (Ffind_file_name_handler (b
->auto_save_file_name
,
5998 EMACS_TIME before_time
, after_time
;
6000 EMACS_GET_TIME (before_time
);
6002 /* If we had a failure, don't try again for 20 minutes. */
6003 if (b
->auto_save_failure_time
>= 0
6004 && EMACS_SECS (before_time
) - b
->auto_save_failure_time
< 1200)
6007 if ((XFASTINT (b
->save_length
) * 10
6008 > (BUF_Z (b
) - BUF_BEG (b
)) * 13)
6009 /* A short file is likely to change a large fraction;
6010 spare the user annoying messages. */
6011 && XFASTINT (b
->save_length
) > 5000
6012 /* These messages are frequent and annoying for `*mail*'. */
6013 && !EQ (b
->filename
, Qnil
)
6014 && NILP (no_message
))
6016 /* It has shrunk too much; turn off auto-saving here. */
6017 minibuffer_auto_raise
= orig_minibuffer_auto_raise
;
6018 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
6020 minibuffer_auto_raise
= 0;
6021 /* Turn off auto-saving until there's a real save,
6022 and prevent any more warnings. */
6023 XSETINT (b
->save_length
, -1);
6024 Fsleep_for (make_number (1), Qnil
);
6027 set_buffer_internal (b
);
6028 if (!auto_saved
&& NILP (no_message
))
6029 message1 ("Auto-saving...");
6030 internal_condition_case (auto_save_1
, Qt
, auto_save_error
);
6032 b
->auto_save_modified
= BUF_MODIFF (b
);
6033 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
6034 set_buffer_internal (old
);
6036 EMACS_GET_TIME (after_time
);
6038 /* If auto-save took more than 60 seconds,
6039 assume it was an NFS failure that got a timeout. */
6040 if (EMACS_SECS (after_time
) - EMACS_SECS (before_time
) > 60)
6041 b
->auto_save_failure_time
= EMACS_SECS (after_time
);
6045 /* Prevent another auto save till enough input events come in. */
6046 record_auto_save ();
6048 if (auto_saved
&& NILP (no_message
))
6052 /* If we are going to restore an old message,
6053 give time to read ours. */
6054 sit_for (1, 0, 0, 0, 0);
6058 /* If we displayed a message and then restored a state
6059 with no message, leave a "done" message on the screen. */
6060 message1 ("Auto-saving...done");
6065 /* This restores the message-stack status. */
6066 unbind_to (count
, Qnil
);
6070 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved
,
6071 Sset_buffer_auto_saved
, 0, 0, 0,
6072 doc
: /* Mark current buffer as auto-saved with its current text.
6073 No auto-save file will be written until the buffer changes again. */)
6076 current_buffer
->auto_save_modified
= MODIFF
;
6077 XSETFASTINT (current_buffer
->save_length
, Z
- BEG
);
6078 current_buffer
->auto_save_failure_time
= -1;
6082 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure
,
6083 Sclear_buffer_auto_save_failure
, 0, 0, 0,
6084 doc
: /* Clear any record of a recent auto-save failure in the current buffer. */)
6087 current_buffer
->auto_save_failure_time
= -1;
6091 DEFUN ("recent-auto-save-p", Frecent_auto_save_p
, Srecent_auto_save_p
,
6093 doc
: /* Return t if current buffer has been auto-saved recently.
6094 More precisely, if it has been auto-saved since last read from or saved
6095 in the visited file. If the buffer has no visited file,
6096 then any auto-save counts as "recent". */)
6099 return (SAVE_MODIFF
< current_buffer
->auto_save_modified
) ? Qt
: Qnil
;
6102 /* Reading and completing file names */
6103 extern Lisp_Object
Ffile_name_completion (), Ffile_name_all_completions ();
6105 /* In the string VAL, change each $ to $$ and return the result. */
6108 double_dollars (val
)
6111 register const unsigned char *old
;
6112 register unsigned char *new;
6116 osize
= SBYTES (val
);
6118 /* Count the number of $ characters. */
6119 for (n
= osize
, count
= 0, old
= SDATA (val
); n
> 0; n
--)
6120 if (*old
++ == '$') count
++;
6124 val
= make_uninit_multibyte_string (SCHARS (val
) + count
,
6127 for (n
= osize
; n
> 0; n
--)
6141 read_file_name_cleanup (arg
)
6144 return (current_buffer
->directory
= arg
);
6147 DEFUN ("read-file-name-internal", Fread_file_name_internal
, Sread_file_name_internal
,
6149 doc
: /* Internal subroutine for read-file-name. Do not call this. */)
6150 (string
, dir
, action
)
6151 Lisp_Object string
, dir
, action
;
6152 /* action is nil for complete, t for return list of completions,
6153 lambda for verify final value */
6155 Lisp_Object name
, specdir
, realdir
, val
, orig_string
;
6157 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
6159 CHECK_STRING (string
);
6166 /* No need to protect ACTION--we only compare it with t and nil. */
6167 GCPRO5 (string
, realdir
, name
, specdir
, orig_string
);
6169 if (SCHARS (string
) == 0)
6171 if (EQ (action
, Qlambda
))
6179 orig_string
= string
;
6180 string
= Fsubstitute_in_file_name (string
);
6181 changed
= NILP (Fstring_equal (string
, orig_string
));
6182 name
= Ffile_name_nondirectory (string
);
6183 val
= Ffile_name_directory (string
);
6185 realdir
= Fexpand_file_name (val
, realdir
);
6190 specdir
= Ffile_name_directory (string
);
6191 val
= Ffile_name_completion (name
, realdir
);
6196 return double_dollars (string
);
6200 if (!NILP (specdir
))
6201 val
= concat2 (specdir
, val
);
6203 return double_dollars (val
);
6206 #endif /* not VMS */
6210 if (EQ (action
, Qt
))
6212 Lisp_Object all
= Ffile_name_all_completions (name
, realdir
);
6216 if (NILP (Vread_file_name_predicate
)
6217 || EQ (Vread_file_name_predicate
, Qfile_exists_p
))
6221 if (EQ (Vread_file_name_predicate
, Qfile_directory_p
))
6223 /* Brute-force speed up for directory checking:
6224 Discard strings which don't end in a slash. */
6225 for (comp
= Qnil
; CONSP (all
); all
= XCDR (all
))
6227 Lisp_Object tem
= XCAR (all
);
6229 if (STRINGP (tem
) &&
6230 (len
= SCHARS (tem
), len
> 0) &&
6231 IS_DIRECTORY_SEP (SREF (tem
, len
-1)))
6232 comp
= Fcons (tem
, comp
);
6238 /* Must do it the hard (and slow) way. */
6240 GCPRO3 (all
, comp
, specdir
);
6241 count
= SPECPDL_INDEX ();
6242 record_unwind_protect (read_file_name_cleanup
, current_buffer
->directory
);
6243 current_buffer
->directory
= realdir
;
6244 for (comp
= Qnil
; CONSP (all
); all
= XCDR (all
))
6246 tem
= call1 (Vread_file_name_predicate
, XCAR (all
));
6248 comp
= Fcons (XCAR (all
), comp
);
6250 unbind_to (count
, Qnil
);
6253 return Fnreverse (comp
);
6256 /* Only other case actually used is ACTION = lambda */
6258 /* Supposedly this helps commands such as `cd' that read directory names,
6259 but can someone explain how it helps them? -- RMS */
6260 if (SCHARS (name
) == 0)
6263 string
= Fexpand_file_name (string
, dir
);
6264 if (!NILP (Vread_file_name_predicate
))
6265 return call1 (Vread_file_name_predicate
, string
);
6266 return Ffile_exists_p (string
);
6269 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p
,
6270 Snext_read_file_uses_dialog_p
, 0, 0, 0,
6271 doc
: /* Return t if a call to `read-file-name' will use a dialog.
6272 The return value is only relevant for a call to `read-file-name' that happens
6273 before any other event (mouse or keypress) is handeled. */)
6276 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6277 if ((NILP (last_nonmenu_event
) || CONSP (last_nonmenu_event
))
6286 DEFUN ("read-file-name", Fread_file_name
, Sread_file_name
, 1, 6, 0,
6287 doc
: /* Read file name, prompting with PROMPT and completing in directory DIR.
6288 Value is not expanded---you must call `expand-file-name' yourself.
6289 Default name to DEFAULT-FILENAME if user exits the minibuffer with
6290 the same non-empty string that was inserted by this function.
6291 (If DEFAULT-FILENAME is omitted, the visited file name is used,
6292 except that if INITIAL is specified, that combined with DIR is used.)
6293 If the user exits with an empty minibuffer, this function returns
6294 an empty string. (This can only happen if the user erased the
6295 pre-inserted contents or if `insert-default-directory' is nil.)
6296 Fourth arg MUSTMATCH non-nil means require existing file's name.
6297 Non-nil and non-t means also require confirmation after completion.
6298 Fifth arg INITIAL specifies text to start with.
6299 If optional sixth arg PREDICATE is non-nil, possible completions and
6300 the resulting file name must satisfy (funcall PREDICATE NAME).
6301 DIR should be an absolute directory name. It defaults to the value of
6302 `default-directory'.
6304 If this command was invoked with the mouse, use a file dialog box if
6305 `use-dialog-box' is non-nil, and the window system or X toolkit in use
6306 provides a file dialog box.
6308 See also `read-file-name-completion-ignore-case'
6309 and `read-file-name-function'. */)
6310 (prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
)
6311 Lisp_Object prompt
, dir
, default_filename
, mustmatch
, initial
, predicate
;
6313 Lisp_Object val
, insdef
, tem
;
6314 struct gcpro gcpro1
, gcpro2
;
6315 register char *homedir
;
6316 Lisp_Object decoded_homedir
;
6317 int replace_in_history
= 0;
6318 int add_to_history
= 0;
6322 dir
= current_buffer
->directory
;
6323 if (NILP (Ffile_name_absolute_p (dir
)))
6324 dir
= Fexpand_file_name (dir
, Qnil
);
6325 if (NILP (default_filename
))
6328 ? Fexpand_file_name (initial
, dir
)
6329 : current_buffer
->filename
);
6331 /* If dir starts with user's homedir, change that to ~. */
6332 homedir
= (char *) egetenv ("HOME");
6334 /* homedir can be NULL in temacs, since Vprocess_environment is not
6335 yet set up. We shouldn't crash in that case. */
6338 homedir
= strcpy (alloca (strlen (homedir
) + 1), homedir
);
6339 CORRECT_DIR_SEPS (homedir
);
6344 = DECODE_FILE (make_unibyte_string (homedir
, strlen (homedir
)));
6347 && !strncmp (SDATA (decoded_homedir
), SDATA (dir
),
6348 SBYTES (decoded_homedir
))
6349 && IS_DIRECTORY_SEP (SREF (dir
, SBYTES (decoded_homedir
))))
6351 dir
= Fsubstring (dir
, make_number (SCHARS (decoded_homedir
)), Qnil
);
6352 dir
= concat2 (build_string ("~"), dir
);
6354 /* Likewise for default_filename. */
6356 && STRINGP (default_filename
)
6357 && !strncmp (SDATA (decoded_homedir
), SDATA (default_filename
),
6358 SBYTES (decoded_homedir
))
6359 && IS_DIRECTORY_SEP (SREF (default_filename
, SBYTES (decoded_homedir
))))
6362 = Fsubstring (default_filename
,
6363 make_number (SCHARS (decoded_homedir
)), Qnil
);
6364 default_filename
= concat2 (build_string ("~"), default_filename
);
6366 if (!NILP (default_filename
))
6368 CHECK_STRING (default_filename
);
6369 default_filename
= double_dollars (default_filename
);
6372 if (insert_default_directory
&& STRINGP (dir
))
6375 if (!NILP (initial
))
6377 Lisp_Object args
[2], pos
;
6381 insdef
= Fconcat (2, args
);
6382 pos
= make_number (SCHARS (double_dollars (dir
)));
6383 insdef
= Fcons (double_dollars (insdef
), pos
);
6386 insdef
= double_dollars (insdef
);
6388 else if (STRINGP (initial
))
6389 insdef
= Fcons (double_dollars (initial
), make_number (0));
6393 if (!NILP (Vread_file_name_function
))
6395 Lisp_Object args
[7];
6397 GCPRO2 (insdef
, default_filename
);
6398 args
[0] = Vread_file_name_function
;
6401 args
[3] = default_filename
;
6402 args
[4] = mustmatch
;
6404 args
[6] = predicate
;
6405 RETURN_UNGCPRO (Ffuncall (7, args
));
6408 count
= SPECPDL_INDEX ();
6409 specbind (intern ("completion-ignore-case"),
6410 read_file_name_completion_ignore_case
? Qt
: Qnil
);
6411 specbind (intern ("minibuffer-completing-file-name"), Qt
);
6412 specbind (intern ("read-file-name-predicate"),
6413 (NILP (predicate
) ? Qfile_exists_p
: predicate
));
6415 GCPRO2 (insdef
, default_filename
);
6417 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6418 if (! NILP (Fnext_read_file_uses_dialog_p ()))
6420 /* If DIR contains a file name, split it. */
6422 file
= Ffile_name_nondirectory (dir
);
6423 if (SCHARS (file
) && NILP (default_filename
))
6425 default_filename
= file
;
6426 dir
= Ffile_name_directory (dir
);
6428 if (!NILP(default_filename
))
6429 default_filename
= Fexpand_file_name (default_filename
, dir
);
6430 val
= Fx_file_dialog (prompt
, dir
, default_filename
, mustmatch
,
6431 EQ (predicate
, Qfile_directory_p
) ? Qt
: Qnil
);
6436 val
= Fcompleting_read (prompt
, intern ("read-file-name-internal"),
6437 dir
, mustmatch
, insdef
,
6438 Qfile_name_history
, default_filename
, Qnil
);
6440 tem
= Fsymbol_value (Qfile_name_history
);
6441 if (CONSP (tem
) && EQ (XCAR (tem
), val
))
6442 replace_in_history
= 1;
6444 /* If Fcompleting_read returned the inserted default string itself
6445 (rather than a new string with the same contents),
6446 it has to mean that the user typed RET with the minibuffer empty.
6447 In that case, we really want to return ""
6448 so that commands such as set-visited-file-name can distinguish. */
6449 if (EQ (val
, default_filename
))
6451 /* In this case, Fcompleting_read has not added an element
6452 to the history. Maybe we should. */
6453 if (! replace_in_history
)
6459 unbind_to (count
, Qnil
);
6462 error ("No file name specified");
6464 tem
= Fstring_equal (val
, CONSP (insdef
) ? XCAR (insdef
) : insdef
);
6466 if (!NILP (tem
) && !NILP (default_filename
))
6467 val
= default_filename
;
6468 val
= Fsubstitute_in_file_name (val
);
6470 if (replace_in_history
)
6471 /* Replace what Fcompleting_read added to the history
6472 with what we will actually return. */
6474 Lisp_Object val1
= double_dollars (val
);
6475 tem
= Fsymbol_value (Qfile_name_history
);
6476 if (history_delete_duplicates
)
6477 XSETCDR (tem
, Fdelete (val1
, XCDR(tem
)));
6478 XSETCAR (tem
, val1
);
6480 else if (add_to_history
)
6482 /* Add the value to the history--but not if it matches
6483 the last value already there. */
6484 Lisp_Object val1
= double_dollars (val
);
6485 tem
= Fsymbol_value (Qfile_name_history
);
6486 if (! CONSP (tem
) || NILP (Fequal (XCAR (tem
), val1
)))
6488 if (history_delete_duplicates
) tem
= Fdelete (val1
, tem
);
6489 Fset (Qfile_name_history
, Fcons (val1
, tem
));
6500 /* Must be set before any path manipulation is performed. */
6501 XSETFASTINT (Vdirectory_sep_char
, '/');
6508 Qoperations
= intern ("operations");
6509 Qexpand_file_name
= intern ("expand-file-name");
6510 Qsubstitute_in_file_name
= intern ("substitute-in-file-name");
6511 Qdirectory_file_name
= intern ("directory-file-name");
6512 Qfile_name_directory
= intern ("file-name-directory");
6513 Qfile_name_nondirectory
= intern ("file-name-nondirectory");
6514 Qunhandled_file_name_directory
= intern ("unhandled-file-name-directory");
6515 Qfile_name_as_directory
= intern ("file-name-as-directory");
6516 Qcopy_file
= intern ("copy-file");
6517 Qmake_directory_internal
= intern ("make-directory-internal");
6518 Qmake_directory
= intern ("make-directory");
6519 Qdelete_directory
= intern ("delete-directory");
6520 Qdelete_file
= intern ("delete-file");
6521 Qrename_file
= intern ("rename-file");
6522 Qadd_name_to_file
= intern ("add-name-to-file");
6523 Qmake_symbolic_link
= intern ("make-symbolic-link");
6524 Qfile_exists_p
= intern ("file-exists-p");
6525 Qfile_executable_p
= intern ("file-executable-p");
6526 Qfile_readable_p
= intern ("file-readable-p");
6527 Qfile_writable_p
= intern ("file-writable-p");
6528 Qfile_symlink_p
= intern ("file-symlink-p");
6529 Qaccess_file
= intern ("access-file");
6530 Qfile_directory_p
= intern ("file-directory-p");
6531 Qfile_regular_p
= intern ("file-regular-p");
6532 Qfile_accessible_directory_p
= intern ("file-accessible-directory-p");
6533 Qfile_modes
= intern ("file-modes");
6534 Qset_file_modes
= intern ("set-file-modes");
6535 Qset_file_times
= intern ("set-file-times");
6536 Qfile_newer_than_file_p
= intern ("file-newer-than-file-p");
6537 Qinsert_file_contents
= intern ("insert-file-contents");
6538 Qwrite_region
= intern ("write-region");
6539 Qverify_visited_file_modtime
= intern ("verify-visited-file-modtime");
6540 Qset_visited_file_modtime
= intern ("set-visited-file-modtime");
6541 Qauto_save_coding
= intern ("auto-save-coding");
6543 staticpro (&Qoperations
);
6544 staticpro (&Qexpand_file_name
);
6545 staticpro (&Qsubstitute_in_file_name
);
6546 staticpro (&Qdirectory_file_name
);
6547 staticpro (&Qfile_name_directory
);
6548 staticpro (&Qfile_name_nondirectory
);
6549 staticpro (&Qunhandled_file_name_directory
);
6550 staticpro (&Qfile_name_as_directory
);
6551 staticpro (&Qcopy_file
);
6552 staticpro (&Qmake_directory_internal
);
6553 staticpro (&Qmake_directory
);
6554 staticpro (&Qdelete_directory
);
6555 staticpro (&Qdelete_file
);
6556 staticpro (&Qrename_file
);
6557 staticpro (&Qadd_name_to_file
);
6558 staticpro (&Qmake_symbolic_link
);
6559 staticpro (&Qfile_exists_p
);
6560 staticpro (&Qfile_executable_p
);
6561 staticpro (&Qfile_readable_p
);
6562 staticpro (&Qfile_writable_p
);
6563 staticpro (&Qaccess_file
);
6564 staticpro (&Qfile_symlink_p
);
6565 staticpro (&Qfile_directory_p
);
6566 staticpro (&Qfile_regular_p
);
6567 staticpro (&Qfile_accessible_directory_p
);
6568 staticpro (&Qfile_modes
);
6569 staticpro (&Qset_file_modes
);
6570 staticpro (&Qset_file_times
);
6571 staticpro (&Qfile_newer_than_file_p
);
6572 staticpro (&Qinsert_file_contents
);
6573 staticpro (&Qwrite_region
);
6574 staticpro (&Qverify_visited_file_modtime
);
6575 staticpro (&Qset_visited_file_modtime
);
6576 staticpro (&Qauto_save_coding
);
6578 Qfile_name_history
= intern ("file-name-history");
6579 Fset (Qfile_name_history
, Qnil
);
6580 staticpro (&Qfile_name_history
);
6582 Qfile_error
= intern ("file-error");
6583 staticpro (&Qfile_error
);
6584 Qfile_already_exists
= intern ("file-already-exists");
6585 staticpro (&Qfile_already_exists
);
6586 Qfile_date_error
= intern ("file-date-error");
6587 staticpro (&Qfile_date_error
);
6588 Qexcl
= intern ("excl");
6592 Qfind_buffer_file_type
= intern ("find-buffer-file-type");
6593 staticpro (&Qfind_buffer_file_type
);
6596 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system
,
6597 doc
: /* *Coding system for encoding file names.
6598 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6599 Vfile_name_coding_system
= Qnil
;
6601 DEFVAR_LISP ("default-file-name-coding-system",
6602 &Vdefault_file_name_coding_system
,
6603 doc
: /* Default coding system for encoding file names.
6604 This variable is used only when `file-name-coding-system' is nil.
6606 This variable is set/changed by the command `set-language-environment'.
6607 User should not set this variable manually,
6608 instead use `file-name-coding-system' to get a constant encoding
6609 of file names regardless of the current language environment. */);
6610 Vdefault_file_name_coding_system
= Qnil
;
6612 Qformat_decode
= intern ("format-decode");
6613 staticpro (&Qformat_decode
);
6614 Qformat_annotate_function
= intern ("format-annotate-function");
6615 staticpro (&Qformat_annotate_function
);
6616 Qafter_insert_file_set_coding
= intern ("after-insert-file-set-coding");
6617 staticpro (&Qafter_insert_file_set_coding
);
6619 Qcar_less_than_car
= intern ("car-less-than-car");
6620 staticpro (&Qcar_less_than_car
);
6622 Fput (Qfile_error
, Qerror_conditions
,
6623 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
)));
6624 Fput (Qfile_error
, Qerror_message
,
6625 build_string ("File error"));
6627 Fput (Qfile_already_exists
, Qerror_conditions
,
6628 Fcons (Qfile_already_exists
,
6629 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
))));
6630 Fput (Qfile_already_exists
, Qerror_message
,
6631 build_string ("File already exists"));
6633 Fput (Qfile_date_error
, Qerror_conditions
,
6634 Fcons (Qfile_date_error
,
6635 Fcons (Qfile_error
, Fcons (Qerror
, Qnil
))));
6636 Fput (Qfile_date_error
, Qerror_message
,
6637 build_string ("Cannot set file date"));
6639 DEFVAR_LISP ("read-file-name-function", &Vread_file_name_function
,
6640 doc
: /* If this is non-nil, `read-file-name' does its work by calling this function. */);
6641 Vread_file_name_function
= Qnil
;
6643 DEFVAR_LISP ("read-file-name-predicate", &Vread_file_name_predicate
,
6644 doc
: /* Current predicate used by `read-file-name-internal'. */);
6645 Vread_file_name_predicate
= Qnil
;
6647 DEFVAR_BOOL ("read-file-name-completion-ignore-case", &read_file_name_completion_ignore_case
,
6648 doc
: /* *Non-nil means when reading a file name completion ignores case. */);
6649 #if defined VMS || defined DOS_NT || defined MAC_OS
6650 read_file_name_completion_ignore_case
= 1;
6652 read_file_name_completion_ignore_case
= 0;
6655 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory
,
6656 doc
: /* *Non-nil means when reading a filename start with default dir in minibuffer.
6657 If the initial minibuffer contents are non-empty, you can usually
6658 request a default filename by typing RETURN without editing. For some
6659 commands, exiting with an empty minibuffer has a special meaning,
6660 such as making the current buffer visit no file in the case of
6661 `set-visited-file-name'.
6662 If this variable is non-nil, the minibuffer contents are always
6663 initially non-empty and typing RETURN without editing will fetch the
6664 default name, if one is provided. Note however that this default name
6665 is not necessarily the name originally inserted in the minibuffer, if
6666 that is just the default directory.
6667 If this variable is nil, the minibuffer often starts out empty. In
6668 that case you may have to explicitly fetch the next history element to
6669 request the default name. */);
6670 insert_default_directory
= 1;
6672 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm
,
6673 doc
: /* *Non-nil means write new files with record format `stmlf'.
6674 nil means use format `var'. This variable is meaningful only on VMS. */);
6675 vms_stmlf_recfm
= 0;
6677 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char
,
6678 doc
: /* Directory separator character for built-in functions that return file names.
6679 The value is always ?/. Don't use this variable, just use `/'. */);
6681 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist
,
6682 doc
: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6683 If a file name matches REGEXP, then all I/O on that file is done by calling
6686 The first argument given to HANDLER is the name of the I/O primitive
6687 to be handled; the remaining arguments are the arguments that were
6688 passed to that primitive. For example, if you do
6689 (file-exists-p FILENAME)
6690 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6691 (funcall HANDLER 'file-exists-p FILENAME)
6692 The function `find-file-name-handler' checks this list for a handler
6693 for its argument. */);
6694 Vfile_name_handler_alist
= Qnil
;
6696 DEFVAR_LISP ("set-auto-coding-function",
6697 &Vset_auto_coding_function
,
6698 doc
: /* If non-nil, a function to call to decide a coding system of file.
6699 Two arguments are passed to this function: the file name
6700 and the length of a file contents following the point.
6701 This function should return a coding system to decode the file contents.
6702 It should check the file name against `auto-coding-alist'.
6703 If no coding system is decided, it should check a coding system
6704 specified in the heading lines with the format:
6705 -*- ... coding: CODING-SYSTEM; ... -*-
6706 or local variable spec of the tailing lines with `coding:' tag. */);
6707 Vset_auto_coding_function
= Qnil
;
6709 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions
,
6710 doc
: /* A list of functions to be called at the end of `insert-file-contents'.
6711 Each is passed one argument, the number of characters inserted.
6712 It should return the new character count, and leave point the same.
6713 If `insert-file-contents' is intercepted by a handler from
6714 `file-name-handler-alist', that handler is responsible for calling the
6715 functions in `after-insert-file-functions' if appropriate. */);
6716 Vafter_insert_file_functions
= Qnil
;
6718 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions
,
6719 doc
: /* A list of functions to be called at the start of `write-region'.
6720 Each is passed two arguments, START and END as for `write-region'.
6721 These are usually two numbers but not always; see the documentation
6722 for `write-region'. The function should return a list of pairs
6723 of the form (POSITION . STRING), consisting of strings to be effectively
6724 inserted at the specified positions of the file being written (1 means to
6725 insert before the first byte written). The POSITIONs must be sorted into
6726 increasing order. If there are several functions in the list, the several
6727 lists are merged destructively. Alternatively, the function can return
6728 with a different buffer current; in that case it should pay attention
6729 to the annotations returned by previous functions and listed in
6730 `write-region-annotations-so-far'.*/);
6731 Vwrite_region_annotate_functions
= Qnil
;
6732 staticpro (&Qwrite_region_annotate_functions
);
6733 Qwrite_region_annotate_functions
6734 = intern ("write-region-annotate-functions");
6736 DEFVAR_LISP ("write-region-annotations-so-far",
6737 &Vwrite_region_annotations_so_far
,
6738 doc
: /* When an annotation function is called, this holds the previous annotations.
6739 These are the annotations made by other annotation functions
6740 that were already called. See also `write-region-annotate-functions'. */);
6741 Vwrite_region_annotations_so_far
= Qnil
;
6743 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers
,
6744 doc
: /* A list of file name handlers that temporarily should not be used.
6745 This applies only to the operation `inhibit-file-name-operation'. */);
6746 Vinhibit_file_name_handlers
= Qnil
;
6748 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation
,
6749 doc
: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6750 Vinhibit_file_name_operation
= Qnil
;
6752 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name
,
6753 doc
: /* File name in which we write a list of all auto save file names.
6754 This variable is initialized automatically from `auto-save-list-file-prefix'
6755 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6756 a non-nil value. */);
6757 Vauto_save_list_file_name
= Qnil
;
6760 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync
,
6761 doc
: /* *Non-nil means don't call fsync in `write-region'.
6762 This variable affects calls to `write-region' as well as save commands.
6763 A non-nil value may result in data loss! */);
6764 write_region_inhibit_fsync
= 0;
6767 defsubr (&Sfind_file_name_handler
);
6768 defsubr (&Sfile_name_directory
);
6769 defsubr (&Sfile_name_nondirectory
);
6770 defsubr (&Sunhandled_file_name_directory
);
6771 defsubr (&Sfile_name_as_directory
);
6772 defsubr (&Sdirectory_file_name
);
6773 defsubr (&Smake_temp_name
);
6774 defsubr (&Sexpand_file_name
);
6775 defsubr (&Ssubstitute_in_file_name
);
6776 defsubr (&Scopy_file
);
6777 defsubr (&Smake_directory_internal
);
6778 defsubr (&Sdelete_directory
);
6779 defsubr (&Sdelete_file
);
6780 defsubr (&Srename_file
);
6781 defsubr (&Sadd_name_to_file
);
6783 defsubr (&Smake_symbolic_link
);
6784 #endif /* S_IFLNK */
6786 defsubr (&Sdefine_logical_name
);
6789 defsubr (&Ssysnetunam
);
6790 #endif /* HPUX_NET */
6791 defsubr (&Sfile_name_absolute_p
);
6792 defsubr (&Sfile_exists_p
);
6793 defsubr (&Sfile_executable_p
);
6794 defsubr (&Sfile_readable_p
);
6795 defsubr (&Sfile_writable_p
);
6796 defsubr (&Saccess_file
);
6797 defsubr (&Sfile_symlink_p
);
6798 defsubr (&Sfile_directory_p
);
6799 defsubr (&Sfile_accessible_directory_p
);
6800 defsubr (&Sfile_regular_p
);
6801 defsubr (&Sfile_modes
);
6802 defsubr (&Sset_file_modes
);
6803 defsubr (&Sset_file_times
);
6804 defsubr (&Sset_default_file_modes
);
6805 defsubr (&Sdefault_file_modes
);
6806 defsubr (&Sfile_newer_than_file_p
);
6807 defsubr (&Sinsert_file_contents
);
6808 defsubr (&Swrite_region
);
6809 defsubr (&Scar_less_than_car
);
6810 defsubr (&Sverify_visited_file_modtime
);
6811 defsubr (&Sclear_visited_file_modtime
);
6812 defsubr (&Svisited_file_modtime
);
6813 defsubr (&Sset_visited_file_modtime
);
6814 defsubr (&Sdo_auto_save
);
6815 defsubr (&Sset_buffer_auto_saved
);
6816 defsubr (&Sclear_buffer_auto_save_failure
);
6817 defsubr (&Srecent_auto_save_p
);
6819 defsubr (&Sread_file_name_internal
);
6820 defsubr (&Sread_file_name
);
6821 defsubr (&Snext_read_file_uses_dialog_p
);
6824 defsubr (&Sunix_sync
);
6828 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
6829 (do not change this comment) */