(rmail-convert-babyl-to-mbox): Disable undo while
[emacs.git] / src / fileio.c
blob9651ac8e18b452d2b74158e85b21116884bb1be3
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, 2007, 2008, 2009 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 3 of the License, or
11 (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <limits.h>
24 #ifdef HAVE_FCNTL_H
25 #include <fcntl.h>
26 #endif
28 #include <stdio.h>
29 #include <sys/types.h>
30 #include <sys/stat.h>
32 #ifdef HAVE_UNISTD_H
33 #include <unistd.h>
34 #endif
36 #if !defined (S_ISLNK) && defined (S_IFLNK)
37 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
38 #endif
40 #if !defined (S_ISFIFO) && defined (S_IFIFO)
41 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
42 #endif
44 #if !defined (S_ISREG) && defined (S_IFREG)
45 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
46 #endif
48 #ifdef HAVE_PWD_H
49 #include <pwd.h>
50 #endif
52 #include <ctype.h>
53 #include <errno.h>
55 #ifndef vax11c
56 #ifndef USE_CRT_DLL
57 extern int errno;
58 #endif
59 #endif
61 #include "lisp.h"
62 #include "intervals.h"
63 #include "buffer.h"
64 #include "character.h"
65 #include "coding.h"
66 #include "window.h"
67 #include "blockinput.h"
68 #include "frame.h"
69 #include "dispextern.h"
71 #ifdef WINDOWSNT
72 #define NOMINMAX 1
73 #include <windows.h>
74 #include <stdlib.h>
75 #include <fcntl.h>
76 #endif /* not WINDOWSNT */
78 #ifdef MSDOS
79 #include "msdos.h"
80 #include <sys/param.h>
81 #if __DJGPP__ >= 2
82 #include <fcntl.h>
83 #include <string.h>
84 #endif
85 #endif
87 #ifdef DOS_NT
88 #define CORRECT_DIR_SEPS(s) \
89 do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
90 else unixtodos_filename (s); \
91 } while (0)
92 /* On Windows, drive letters must be alphabetic - on DOS, the Netware
93 redirector allows the six letters between 'Z' and 'a' as well. */
94 #ifdef MSDOS
95 #define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
96 #endif
97 #ifdef WINDOWSNT
98 #define IS_DRIVE(x) isalpha (x)
99 #endif
100 /* Need to lower-case the drive letter, or else expanded
101 filenames will sometimes compare inequal, because
102 `expand-file-name' doesn't always down-case the drive letter. */
103 #define DRIVE_LETTER(x) (tolower (x))
104 #endif
106 #include "systime.h"
108 #ifdef HPUX
109 #include <netio.h>
110 #endif
112 #include "commands.h"
113 extern int use_dialog_box;
114 extern int use_file_dialog;
116 #ifndef O_WRONLY
117 #define O_WRONLY 1
118 #endif
120 #ifndef O_RDONLY
121 #define O_RDONLY 0
122 #endif
124 #ifndef S_ISLNK
125 # define lstat stat
126 #endif
128 #ifndef FILE_SYSTEM_CASE
129 #define FILE_SYSTEM_CASE(filename) (filename)
130 #endif
132 /* Nonzero during writing of auto-save files */
133 int auto_saving;
135 /* Set by auto_save_1 to mode of original file so Fwrite_region will create
136 a new file with the same mode as the original */
137 int auto_save_mode_bits;
139 /* Set by auto_save_1 if an error occurred during the last auto-save. */
140 int auto_save_error_occurred;
142 /* The symbol bound to coding-system-for-read when
143 insert-file-contents is called for recovering a file. This is not
144 an actual coding system name, but just an indicator to tell
145 insert-file-contents to use `emacs-mule' with a special flag for
146 auto saving and recovering a file. */
147 Lisp_Object Qauto_save_coding;
149 /* Coding system for file names, or nil if none. */
150 Lisp_Object Vfile_name_coding_system;
152 /* Coding system for file names used only when
153 Vfile_name_coding_system is nil. */
154 Lisp_Object Vdefault_file_name_coding_system;
156 /* Alist of elements (REGEXP . HANDLER) for file names
157 whose I/O is done with a special handler. */
158 Lisp_Object Vfile_name_handler_alist;
160 /* Property name of a file name handler,
161 which gives a list of operations it handles.. */
162 Lisp_Object Qoperations;
164 /* Lisp functions for translating file formats */
165 Lisp_Object Qformat_decode, Qformat_annotate_function;
167 /* Function to be called to decide a coding system of a reading file. */
168 Lisp_Object Vset_auto_coding_function;
170 /* Functions to be called to process text properties in inserted file. */
171 Lisp_Object Vafter_insert_file_functions;
173 /* Lisp function for setting buffer-file-coding-system and the
174 multibyteness of the current buffer after inserting a file. */
175 Lisp_Object Qafter_insert_file_set_coding;
177 /* Functions to be called to create text property annotations for file. */
178 Lisp_Object Vwrite_region_annotate_functions;
179 Lisp_Object Qwrite_region_annotate_functions;
180 Lisp_Object Vwrite_region_post_annotation_function;
182 /* During build_annotations, each time an annotation function is called,
183 this holds the annotations made by the previous functions. */
184 Lisp_Object Vwrite_region_annotations_so_far;
186 /* Each time an annotation function changes the buffer, the new buffer
187 is added here. */
188 Lisp_Object Vwrite_region_annotation_buffers;
190 /* File name in which we write a list of all our auto save files. */
191 Lisp_Object Vauto_save_list_file_name;
193 /* Whether or not files are auto-saved into themselves. */
194 Lisp_Object Vauto_save_visited_file_name;
196 /* On NT, specifies the directory separator character, used (eg.) when
197 expanding file names. This can be bound to / or \. */
198 Lisp_Object Vdirectory_sep_char;
200 #ifdef HAVE_FSYNC
201 /* Nonzero means skip the call to fsync in Fwrite-region. */
202 int write_region_inhibit_fsync;
203 #endif
205 /* Non-zero means call move-file-to-trash in Fdelete_file or
206 Fdelete_directory. */
207 int delete_by_moving_to_trash;
209 Lisp_Object Qdelete_by_moving_to_trash;
211 /* Lisp function for moving files to trash. */
212 Lisp_Object Qmove_file_to_trash;
214 extern Lisp_Object Vuser_login_name;
216 #ifdef WINDOWSNT
217 extern Lisp_Object Vw32_get_true_file_attributes;
218 #endif
220 extern int minibuf_level;
222 extern int minibuffer_auto_raise;
224 extern int history_delete_duplicates;
226 /* These variables describe handlers that have "already" had a chance
227 to handle the current operation.
229 Vinhibit_file_name_handlers is a list of file name handlers.
230 Vinhibit_file_name_operation is the operation being handled.
231 If we try to handle that operation, we ignore those handlers. */
233 static Lisp_Object Vinhibit_file_name_handlers;
234 static Lisp_Object Vinhibit_file_name_operation;
236 Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
237 Lisp_Object Qexcl;
238 Lisp_Object Qfile_name_history;
240 Lisp_Object Qcar_less_than_car;
242 static int a_write P_ ((int, Lisp_Object, int, int,
243 Lisp_Object *, struct coding_system *));
244 static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));
247 void
248 report_file_error (string, data)
249 const char *string;
250 Lisp_Object data;
252 Lisp_Object errstring;
253 int errorno = errno;
254 char *str;
256 synchronize_system_messages_locale ();
257 str = strerror (errorno);
258 errstring = code_convert_string_norecord (make_unibyte_string (str,
259 strlen (str)),
260 Vlocale_coding_system, 0);
262 while (1)
263 switch (errorno)
265 case EEXIST:
266 xsignal (Qfile_already_exists, Fcons (errstring, data));
267 break;
268 default:
269 /* System error messages are capitalized. Downcase the initial
270 unless it is followed by a slash. (The slash case caters to
271 error messages that begin with "I/O" or, in German, "E/A".) */
272 if (STRING_MULTIBYTE (errstring)
273 && ! EQ (Faref (errstring, make_number (1)), make_number ('/')))
275 int c;
277 str = (char *) SDATA (errstring);
278 c = STRING_CHAR (str, 0);
279 Faset (errstring, make_number (0), make_number (DOWNCASE (c)));
282 xsignal (Qfile_error,
283 Fcons (build_string (string), Fcons (errstring, data)));
287 Lisp_Object
288 close_file_unwind (fd)
289 Lisp_Object fd;
291 emacs_close (XFASTINT (fd));
292 return Qnil;
295 /* Restore point, having saved it as a marker. */
297 static Lisp_Object
298 restore_point_unwind (location)
299 Lisp_Object location;
301 Fgoto_char (location);
302 Fset_marker (location, Qnil, Qnil);
303 return Qnil;
307 Lisp_Object Qexpand_file_name;
308 Lisp_Object Qsubstitute_in_file_name;
309 Lisp_Object Qdirectory_file_name;
310 Lisp_Object Qfile_name_directory;
311 Lisp_Object Qfile_name_nondirectory;
312 Lisp_Object Qunhandled_file_name_directory;
313 Lisp_Object Qfile_name_as_directory;
314 Lisp_Object Qcopy_file;
315 Lisp_Object Qmake_directory_internal;
316 Lisp_Object Qmake_directory;
317 Lisp_Object Qdelete_directory;
318 Lisp_Object Qdelete_file;
319 Lisp_Object Qrename_file;
320 Lisp_Object Qadd_name_to_file;
321 Lisp_Object Qmake_symbolic_link;
322 Lisp_Object Qfile_exists_p;
323 Lisp_Object Qfile_executable_p;
324 Lisp_Object Qfile_readable_p;
325 Lisp_Object Qfile_writable_p;
326 Lisp_Object Qfile_symlink_p;
327 Lisp_Object Qaccess_file;
328 Lisp_Object Qfile_directory_p;
329 Lisp_Object Qfile_regular_p;
330 Lisp_Object Qfile_accessible_directory_p;
331 Lisp_Object Qfile_modes;
332 Lisp_Object Qset_file_modes;
333 Lisp_Object Qset_file_times;
334 Lisp_Object Qfile_newer_than_file_p;
335 Lisp_Object Qinsert_file_contents;
336 Lisp_Object Qwrite_region;
337 Lisp_Object Qverify_visited_file_modtime;
338 Lisp_Object Qset_visited_file_modtime;
340 DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
341 doc: /* Return FILENAME's handler function for OPERATION, if it has one.
342 Otherwise, return nil.
343 A file name is handled if one of the regular expressions in
344 `file-name-handler-alist' matches it.
346 If OPERATION equals `inhibit-file-name-operation', then we ignore
347 any handlers that are members of `inhibit-file-name-handlers',
348 but we still do run any other handlers. This lets handlers
349 use the standard functions without calling themselves recursively. */)
350 (filename, operation)
351 Lisp_Object filename, operation;
353 /* This function must not munge the match data. */
354 Lisp_Object chain, inhibited_handlers, result;
355 int pos = -1;
357 result = Qnil;
358 CHECK_STRING (filename);
360 if (EQ (operation, Vinhibit_file_name_operation))
361 inhibited_handlers = Vinhibit_file_name_handlers;
362 else
363 inhibited_handlers = Qnil;
365 for (chain = Vfile_name_handler_alist; CONSP (chain);
366 chain = XCDR (chain))
368 Lisp_Object elt;
369 elt = XCAR (chain);
370 if (CONSP (elt))
372 Lisp_Object string = XCAR (elt);
373 int match_pos;
374 Lisp_Object handler = XCDR (elt);
375 Lisp_Object operations = Qnil;
377 if (SYMBOLP (handler))
378 operations = Fget (handler, Qoperations);
380 if (STRINGP (string)
381 && (match_pos = fast_string_match (string, filename)) > pos
382 && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
384 Lisp_Object tem;
386 handler = XCDR (elt);
387 tem = Fmemq (handler, inhibited_handlers);
388 if (NILP (tem))
390 result = handler;
391 pos = match_pos;
396 QUIT;
398 return result;
401 DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
402 1, 1, 0,
403 doc: /* Return the directory component in file name FILENAME.
404 Return nil if FILENAME does not include a directory.
405 Otherwise return a directory name.
406 Given a Unix syntax file name, returns a string ending in slash. */)
407 (filename)
408 Lisp_Object filename;
410 #ifndef DOS_NT
411 register const unsigned char *beg;
412 #else
413 register unsigned char *beg;
414 #endif
415 register const unsigned char *p;
416 Lisp_Object handler;
418 CHECK_STRING (filename);
420 /* If the file name has special constructs in it,
421 call the corresponding file handler. */
422 handler = Ffind_file_name_handler (filename, Qfile_name_directory);
423 if (!NILP (handler))
424 return call2 (handler, Qfile_name_directory, filename);
426 filename = FILE_SYSTEM_CASE (filename);
427 beg = SDATA (filename);
428 #ifdef DOS_NT
429 beg = strcpy (alloca (strlen (beg) + 1), beg);
430 #endif
431 p = beg + SBYTES (filename);
433 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
434 #ifdef DOS_NT
435 /* only recognise drive specifier at the beginning */
436 && !(p[-1] == ':'
437 /* handle the "/:d:foo" and "/:foo" cases correctly */
438 && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
439 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
440 #endif
441 ) p--;
443 if (p == beg)
444 return Qnil;
445 #ifdef DOS_NT
446 /* Expansion of "c:" to drive and default directory. */
447 if (p[-1] == ':')
449 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
450 unsigned char *res = alloca (MAXPATHLEN + 1);
451 unsigned char *r = res;
453 if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
455 strncpy (res, beg, 2);
456 beg += 2;
457 r += 2;
460 if (getdefdir (toupper (*beg) - 'A' + 1, r))
462 if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
463 strcat (res, "/");
464 beg = res;
465 p = beg + strlen (beg);
468 CORRECT_DIR_SEPS (beg);
469 #endif /* DOS_NT */
471 return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
474 DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
475 Sfile_name_nondirectory, 1, 1, 0,
476 doc: /* Return file name FILENAME sans its directory.
477 For example, in a Unix-syntax file name,
478 this is everything after the last slash,
479 or the entire name if it contains no slash. */)
480 (filename)
481 Lisp_Object filename;
483 register const unsigned char *beg, *p, *end;
484 Lisp_Object handler;
486 CHECK_STRING (filename);
488 /* If the file name has special constructs in it,
489 call the corresponding file handler. */
490 handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
491 if (!NILP (handler))
492 return call2 (handler, Qfile_name_nondirectory, filename);
494 beg = SDATA (filename);
495 end = p = beg + SBYTES (filename);
497 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
498 #ifdef DOS_NT
499 /* only recognise drive specifier at beginning */
500 && !(p[-1] == ':'
501 /* handle the "/:d:foo" case correctly */
502 && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
503 #endif
505 p--;
507 return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
510 DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
511 Sunhandled_file_name_directory, 1, 1, 0,
512 doc: /* Return a directly usable directory name somehow associated with FILENAME.
513 A `directly usable' directory name is one that may be used without the
514 intervention of any file handler.
515 If FILENAME is a directly usable file itself, return
516 \(file-name-directory FILENAME).
517 If FILENAME refers to a file which is not accessible from a local process,
518 then this should return nil.
519 The `call-process' and `start-process' functions use this function to
520 get a current directory to run processes in. */)
521 (filename)
522 Lisp_Object filename;
524 Lisp_Object handler;
526 /* If the file name has special constructs in it,
527 call the corresponding file handler. */
528 handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
529 if (!NILP (handler))
530 return call2 (handler, Qunhandled_file_name_directory, filename);
532 return Ffile_name_directory (filename);
536 char *
537 file_name_as_directory (out, in)
538 char *out, *in;
540 int size = strlen (in) - 1;
542 strcpy (out, in);
544 if (size < 0)
546 out[0] = '.';
547 out[1] = '/';
548 out[2] = 0;
549 return out;
552 /* For Unix syntax, Append a slash if necessary */
553 if (!IS_DIRECTORY_SEP (out[size]))
555 /* Cannot use DIRECTORY_SEP, which could have any value */
556 out[size + 1] = '/';
557 out[size + 2] = '\0';
559 #ifdef DOS_NT
560 CORRECT_DIR_SEPS (out);
561 #endif
562 return out;
565 DEFUN ("file-name-as-directory", Ffile_name_as_directory,
566 Sfile_name_as_directory, 1, 1, 0,
567 doc: /* Return a string representing the file name FILE interpreted as a directory.
568 This operation exists because a directory is also a file, but its name as
569 a directory is different from its name as a file.
570 The result can be used as the value of `default-directory'
571 or passed as second argument to `expand-file-name'.
572 For a Unix-syntax file name, just appends a slash. */)
573 (file)
574 Lisp_Object file;
576 char *buf;
577 Lisp_Object handler;
579 CHECK_STRING (file);
580 if (NILP (file))
581 return Qnil;
583 /* If the file name has special constructs in it,
584 call the corresponding file handler. */
585 handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
586 if (!NILP (handler))
587 return call2 (handler, Qfile_name_as_directory, file);
589 buf = (char *) alloca (SBYTES (file) + 10);
590 file_name_as_directory (buf, SDATA (file));
591 return make_specified_string (buf, -1, strlen (buf),
592 STRING_MULTIBYTE (file));
596 * Convert from directory name to filename.
597 * On UNIX, it's simple: just make sure there isn't a terminating /
599 * Value is nonzero if the string output is different from the input.
603 directory_file_name (src, dst)
604 char *src, *dst;
606 long slen;
608 slen = strlen (src);
610 /* Process as Unix format: just remove any final slash.
611 But leave "/" unchanged; do not change it to "". */
612 strcpy (dst, src);
613 if (slen > 1
614 && IS_DIRECTORY_SEP (dst[slen - 1])
615 #ifdef DOS_NT
616 && !IS_ANY_SEP (dst[slen - 2])
617 #endif
619 dst[slen - 1] = 0;
620 #ifdef DOS_NT
621 CORRECT_DIR_SEPS (dst);
622 #endif
623 return 1;
626 DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
627 1, 1, 0,
628 doc: /* Returns the file name of the directory named DIRECTORY.
629 This is the name of the file that holds the data for the directory DIRECTORY.
630 This operation exists because a directory is also a file, but its name as
631 a directory is different from its name as a file.
632 In Unix-syntax, this function just removes the final slash. */)
633 (directory)
634 Lisp_Object directory;
636 char *buf;
637 Lisp_Object handler;
639 CHECK_STRING (directory);
641 if (NILP (directory))
642 return Qnil;
644 /* If the file name has special constructs in it,
645 call the corresponding file handler. */
646 handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
647 if (!NILP (handler))
648 return call2 (handler, Qdirectory_file_name, directory);
650 buf = (char *) alloca (SBYTES (directory) + 20);
651 directory_file_name (SDATA (directory), buf);
652 return make_specified_string (buf, -1, strlen (buf),
653 STRING_MULTIBYTE (directory));
656 static char make_temp_name_tbl[64] =
658 'A','B','C','D','E','F','G','H',
659 'I','J','K','L','M','N','O','P',
660 'Q','R','S','T','U','V','W','X',
661 'Y','Z','a','b','c','d','e','f',
662 'g','h','i','j','k','l','m','n',
663 'o','p','q','r','s','t','u','v',
664 'w','x','y','z','0','1','2','3',
665 '4','5','6','7','8','9','-','_'
668 static unsigned make_temp_name_count, make_temp_name_count_initialized_p;
670 /* Value is a temporary file name starting with PREFIX, a string.
672 The Emacs process number forms part of the result, so there is
673 no danger of generating a name being used by another process.
674 In addition, this function makes an attempt to choose a name
675 which has no existing file. To make this work, PREFIX should be
676 an absolute file name.
678 BASE64_P non-zero means add the pid as 3 characters in base64
679 encoding. In this case, 6 characters will be added to PREFIX to
680 form the file name. Otherwise, if Emacs is running on a system
681 with long file names, add the pid as a decimal number.
683 This function signals an error if no unique file name could be
684 generated. */
686 Lisp_Object
687 make_temp_name (prefix, base64_p)
688 Lisp_Object prefix;
689 int base64_p;
691 Lisp_Object val;
692 int len, clen;
693 int pid;
694 unsigned char *p, *data;
695 char pidbuf[20];
696 int pidlen;
698 CHECK_STRING (prefix);
700 /* VAL is created by adding 6 characters to PREFIX. The first
701 three are the PID of this process, in base 64, and the second
702 three are incremented if the file already exists. This ensures
703 262144 unique file names per PID per PREFIX. */
705 pid = (int) getpid ();
707 if (base64_p)
709 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
710 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
711 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
712 pidlen = 3;
714 else
716 #ifdef HAVE_LONG_FILE_NAMES
717 sprintf (pidbuf, "%d", pid);
718 pidlen = strlen (pidbuf);
719 #else
720 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
721 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
722 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
723 pidlen = 3;
724 #endif
727 len = SBYTES (prefix); clen = SCHARS (prefix);
728 val = make_uninit_multibyte_string (clen + 3 + pidlen, len + 3 + pidlen);
729 if (!STRING_MULTIBYTE (prefix))
730 STRING_SET_UNIBYTE (val);
731 data = SDATA (val);
732 bcopy(SDATA (prefix), data, len);
733 p = data + len;
735 bcopy (pidbuf, p, pidlen);
736 p += pidlen;
738 /* Here we try to minimize useless stat'ing when this function is
739 invoked many times successively with the same PREFIX. We achieve
740 this by initializing count to a random value, and incrementing it
741 afterwards.
743 We don't want make-temp-name to be called while dumping,
744 because then make_temp_name_count_initialized_p would get set
745 and then make_temp_name_count would not be set when Emacs starts. */
747 if (!make_temp_name_count_initialized_p)
749 make_temp_name_count = (unsigned) time (NULL);
750 make_temp_name_count_initialized_p = 1;
753 while (1)
755 struct stat ignored;
756 unsigned num = make_temp_name_count;
758 p[0] = make_temp_name_tbl[num & 63], num >>= 6;
759 p[1] = make_temp_name_tbl[num & 63], num >>= 6;
760 p[2] = make_temp_name_tbl[num & 63], num >>= 6;
762 /* Poor man's congruential RN generator. Replace with
763 ++make_temp_name_count for debugging. */
764 make_temp_name_count += 25229;
765 make_temp_name_count %= 225307;
767 if (stat (data, &ignored) < 0)
769 /* We want to return only if errno is ENOENT. */
770 if (errno == ENOENT)
771 return val;
772 else
773 /* The error here is dubious, but there is little else we
774 can do. The alternatives are to return nil, which is
775 as bad as (and in many cases worse than) throwing the
776 error, or to ignore the error, which will likely result
777 in looping through 225307 stat's, which is not only
778 dog-slow, but also useless since it will fallback to
779 the errow below, anyway. */
780 report_file_error ("Cannot create temporary name for prefix",
781 Fcons (prefix, Qnil));
782 /* not reached */
786 error ("Cannot create temporary name for prefix `%s'",
787 SDATA (prefix));
788 return Qnil;
792 DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
793 doc: /* Generate temporary file name (string) starting with PREFIX (a string).
794 The Emacs process number forms part of the result,
795 so there is no danger of generating a name being used by another process.
797 In addition, this function makes an attempt to choose a name
798 which has no existing file. To make this work,
799 PREFIX should be an absolute file name.
801 There is a race condition between calling `make-temp-name' and creating the
802 file which opens all kinds of security holes. For that reason, you should
803 probably use `make-temp-file' instead, except in three circumstances:
805 * If you are creating the file in the user's home directory.
806 * If you are creating a directory rather than an ordinary file.
807 * If you are taking special precautions as `make-temp-file' does. */)
808 (prefix)
809 Lisp_Object prefix;
811 return make_temp_name (prefix, 0);
816 DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
817 doc: /* Convert filename NAME to absolute, and canonicalize it.
818 Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
819 \(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
820 the current buffer's value of `default-directory' is used.
821 File name components that are `.' are removed, and
822 so are file name components followed by `..', along with the `..' itself;
823 note that these simplifications are done without checking the resulting
824 file names in the file system.
825 An initial `~/' expands to your home directory.
826 An initial `~USER/' expands to USER's home directory.
827 See also the function `substitute-in-file-name'.
829 For technical reasons, this function can return correct but
830 non-intuitive results for the root directory; for instance,
831 \(expand-file-name ".." "/") returns "/..". For this reason, use
832 (directory-file-name (file-name-directory dirname)) to traverse a
833 filesystem tree, not (expand-file-name ".." dirname). */)
834 (name, default_directory)
835 Lisp_Object name, default_directory;
837 /* These point to SDATA and need to be careful with string-relocation
838 during GC (via DECODE_FILE). */
839 unsigned char *nm, *newdir;
840 /* This should only point to alloca'd data. */
841 unsigned char *target;
843 int tlen;
844 struct passwd *pw;
845 #ifdef DOS_NT
846 int drive = 0;
847 int collapse_newdir = 1;
848 int is_escaped = 0;
849 #endif /* DOS_NT */
850 int length;
851 Lisp_Object handler, result;
852 int multibyte;
853 Lisp_Object hdir;
855 CHECK_STRING (name);
857 /* If the file name has special constructs in it,
858 call the corresponding file handler. */
859 handler = Ffind_file_name_handler (name, Qexpand_file_name);
860 if (!NILP (handler))
861 return call3 (handler, Qexpand_file_name, name, default_directory);
863 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
864 if (NILP (default_directory))
865 default_directory = current_buffer->directory;
866 if (! STRINGP (default_directory))
868 #ifdef DOS_NT
869 /* "/" is not considered a root directory on DOS_NT, so using "/"
870 here causes an infinite recursion in, e.g., the following:
872 (let (default-directory)
873 (expand-file-name "a"))
875 To avoid this, we set default_directory to the root of the
876 current drive. */
877 extern char *emacs_root_dir (void);
879 default_directory = build_string (emacs_root_dir ());
880 #else
881 default_directory = build_string ("/");
882 #endif
885 if (!NILP (default_directory))
887 handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
888 if (!NILP (handler))
889 return call3 (handler, Qexpand_file_name, name, default_directory);
893 unsigned char *o = SDATA (default_directory);
895 /* Make sure DEFAULT_DIRECTORY is properly expanded.
896 It would be better to do this down below where we actually use
897 default_directory. Unfortunately, calling Fexpand_file_name recursively
898 could invoke GC, and the strings might be relocated. This would
899 be annoying because we have pointers into strings lying around
900 that would need adjusting, and people would add new pointers to
901 the code and forget to adjust them, resulting in intermittent bugs.
902 Putting this call here avoids all that crud.
904 The EQ test avoids infinite recursion. */
905 if (! NILP (default_directory) && !EQ (default_directory, name)
906 /* Save time in some common cases - as long as default_directory
907 is not relative, it can be canonicalized with name below (if it
908 is needed at all) without requiring it to be expanded now. */
909 #ifdef DOS_NT
910 /* Detect MSDOS file names with drive specifiers. */
911 && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1])
912 && IS_DIRECTORY_SEP (o[2]))
913 #ifdef WINDOWSNT
914 /* Detect Windows file names in UNC format. */
915 && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
916 #endif
917 #else /* not DOS_NT */
918 /* Detect Unix absolute file names (/... alone is not absolute on
919 DOS or Windows). */
920 && ! (IS_DIRECTORY_SEP (o[0]))
921 #endif /* not DOS_NT */
924 struct gcpro gcpro1;
926 GCPRO1 (name);
927 default_directory = Fexpand_file_name (default_directory, Qnil);
928 UNGCPRO;
931 name = FILE_SYSTEM_CASE (name);
932 multibyte = STRING_MULTIBYTE (name);
933 if (multibyte != STRING_MULTIBYTE (default_directory))
935 if (multibyte)
936 default_directory = string_to_multibyte (default_directory);
937 else
939 name = string_to_multibyte (name);
940 multibyte = 1;
944 nm = SDATA (name);
946 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
947 nm = strcpy (alloca (strlen (nm) + 1), nm);
949 #ifdef DOS_NT
950 /* Note if special escape prefix is present, but remove for now. */
951 if (nm[0] == '/' && nm[1] == ':')
953 is_escaped = 1;
954 nm += 2;
957 /* Find and remove drive specifier if present; this makes nm absolute
958 even if the rest of the name appears to be relative. Only look for
959 drive specifier at the beginning. */
960 if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
962 drive = nm[0];
963 nm += 2;
966 #ifdef WINDOWSNT
967 /* If we see "c://somedir", we want to strip the first slash after the
968 colon when stripping the drive letter. Otherwise, this expands to
969 "//somedir". */
970 if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
971 nm++;
973 /* Discard any previous drive specifier if nm is now in UNC format. */
974 if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
976 drive = 0;
978 #endif /* WINDOWSNT */
979 #endif /* DOS_NT */
981 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
982 none are found, we can probably return right away. We will avoid
983 allocating a new string if name is already fully expanded. */
984 if (
985 IS_DIRECTORY_SEP (nm[0])
986 #ifdef MSDOS
987 && drive && !is_escaped
988 #endif
989 #ifdef WINDOWSNT
990 && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
991 #endif
994 /* If it turns out that the filename we want to return is just a
995 suffix of FILENAME, we don't need to go through and edit
996 things; we just need to construct a new string using data
997 starting at the middle of FILENAME. If we set lose to a
998 non-zero value, that means we've discovered that we can't do
999 that cool trick. */
1000 int lose = 0;
1001 unsigned char *p = nm;
1003 while (*p)
1005 /* Since we know the name is absolute, we can assume that each
1006 element starts with a "/". */
1008 /* "." and ".." are hairy. */
1009 if (IS_DIRECTORY_SEP (p[0])
1010 && p[1] == '.'
1011 && (IS_DIRECTORY_SEP (p[2])
1012 || p[2] == 0
1013 || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
1014 || p[3] == 0))))
1015 lose = 1;
1016 /* We want to replace multiple `/' in a row with a single
1017 slash. */
1018 else if (p > nm
1019 && IS_DIRECTORY_SEP (p[0])
1020 && IS_DIRECTORY_SEP (p[1]))
1021 lose = 1;
1022 p++;
1024 if (!lose)
1026 #ifdef DOS_NT
1027 /* Make sure directories are all separated with / or \ as
1028 desired, but avoid allocation of a new string when not
1029 required. */
1030 CORRECT_DIR_SEPS (nm);
1031 #ifdef WINDOWSNT
1032 if (IS_DIRECTORY_SEP (nm[1]))
1034 if (strcmp (nm, SDATA (name)) != 0)
1035 name = make_specified_string (nm, -1, strlen (nm), multibyte);
1037 else
1038 #endif
1039 /* drive must be set, so this is okay */
1040 if (strcmp (nm - 2, SDATA (name)) != 0)
1042 char temp[] = " :";
1044 name = make_specified_string (nm, -1, p - nm, multibyte);
1045 temp[0] = DRIVE_LETTER (drive);
1046 name = concat2 (build_string (temp), name);
1048 return name;
1049 #else /* not DOS_NT */
1050 if (strcmp (nm, SDATA (name)) == 0)
1051 return name;
1052 return make_specified_string (nm, -1, strlen (nm), multibyte);
1053 #endif /* not DOS_NT */
1057 /* At this point, nm might or might not be an absolute file name. We
1058 need to expand ~ or ~user if present, otherwise prefix nm with
1059 default_directory if nm is not absolute, and finally collapse /./
1060 and /foo/../ sequences.
1062 We set newdir to be the appropriate prefix if one is needed:
1063 - the relevant user directory if nm starts with ~ or ~user
1064 - the specified drive's working dir (DOS/NT only) if nm does not
1065 start with /
1066 - the value of default_directory.
1068 Note that these prefixes are not guaranteed to be absolute (except
1069 for the working dir of a drive). Therefore, to ensure we always
1070 return an absolute name, if the final prefix is not absolute we
1071 append it to the current working directory. */
1073 newdir = 0;
1075 if (nm[0] == '~') /* prefix ~ */
1077 if (IS_DIRECTORY_SEP (nm[1])
1078 || nm[1] == 0) /* ~ by itself */
1080 Lisp_Object tem;
1082 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1083 newdir = (unsigned char *) "";
1084 nm++;
1085 /* egetenv may return a unibyte string, which will bite us since
1086 we expect the directory to be multibyte. */
1087 tem = build_string (newdir);
1088 if (!STRING_MULTIBYTE (tem))
1090 hdir = DECODE_FILE (tem);
1091 newdir = SDATA (hdir);
1093 #ifdef DOS_NT
1094 collapse_newdir = 0;
1095 #endif
1097 else /* ~user/filename */
1099 unsigned char *o, *p;
1100 for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)); p++);
1101 o = alloca (p - nm + 1);
1102 bcopy ((char *) nm, o, p - nm);
1103 o [p - nm] = 0;
1105 BLOCK_INPUT;
1106 pw = (struct passwd *) getpwnam (o + 1);
1107 UNBLOCK_INPUT;
1108 if (pw)
1110 newdir = (unsigned char *) pw -> pw_dir;
1111 nm = p;
1112 #ifdef DOS_NT
1113 collapse_newdir = 0;
1114 #endif
1117 /* If we don't find a user of that name, leave the name
1118 unchanged; don't move nm forward to p. */
1122 #ifdef DOS_NT
1123 /* On DOS and Windows, nm is absolute if a drive name was specified;
1124 use the drive's current directory as the prefix if needed. */
1125 if (!newdir && drive)
1127 /* Get default directory if needed to make nm absolute. */
1128 if (!IS_DIRECTORY_SEP (nm[0]))
1130 newdir = alloca (MAXPATHLEN + 1);
1131 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1132 newdir = NULL;
1134 if (!newdir)
1136 /* Either nm starts with /, or drive isn't mounted. */
1137 newdir = alloca (4);
1138 newdir[0] = DRIVE_LETTER (drive);
1139 newdir[1] = ':';
1140 newdir[2] = '/';
1141 newdir[3] = 0;
1144 #endif /* DOS_NT */
1146 /* Finally, if no prefix has been specified and nm is not absolute,
1147 then it must be expanded relative to default_directory. */
1149 if (1
1150 #ifndef DOS_NT
1151 /* /... alone is not absolute on DOS and Windows. */
1152 && !IS_DIRECTORY_SEP (nm[0])
1153 #endif
1154 #ifdef WINDOWSNT
1155 && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
1156 #endif
1157 && !newdir)
1159 newdir = SDATA (default_directory);
1160 #ifdef DOS_NT
1161 /* Note if special escape prefix is present, but remove for now. */
1162 if (newdir[0] == '/' && newdir[1] == ':')
1164 is_escaped = 1;
1165 newdir += 2;
1167 #endif
1170 #ifdef DOS_NT
1171 if (newdir)
1173 /* First ensure newdir is an absolute name. */
1174 if (
1175 /* Detect MSDOS file names with drive specifiers. */
1176 ! (IS_DRIVE (newdir[0])
1177 && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2]))
1178 #ifdef WINDOWSNT
1179 /* Detect Windows file names in UNC format. */
1180 && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1181 #endif
1184 /* Effectively, let newdir be (expand-file-name newdir cwd).
1185 Because of the admonition against calling expand-file-name
1186 when we have pointers into lisp strings, we accomplish this
1187 indirectly by prepending newdir to nm if necessary, and using
1188 cwd (or the wd of newdir's drive) as the new newdir. */
1190 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1192 drive = newdir[0];
1193 newdir += 2;
1195 if (!IS_DIRECTORY_SEP (nm[0]))
1197 char * tmp = alloca (strlen (newdir) + strlen (nm) + 2);
1198 file_name_as_directory (tmp, newdir);
1199 strcat (tmp, nm);
1200 nm = tmp;
1202 newdir = alloca (MAXPATHLEN + 1);
1203 if (drive)
1205 if (!getdefdir (toupper (drive) - 'A' + 1, newdir))
1206 newdir = "/";
1208 else
1209 getwd (newdir);
1212 /* Strip off drive name from prefix, if present. */
1213 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
1215 drive = newdir[0];
1216 newdir += 2;
1219 /* Keep only a prefix from newdir if nm starts with slash
1220 (//server/share for UNC, nothing otherwise). */
1221 if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir)
1223 #ifdef WINDOWSNT
1224 if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1226 unsigned char *p;
1227 newdir = strcpy (alloca (strlen (newdir) + 1), newdir);
1228 p = newdir + 2;
1229 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1230 p++;
1231 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1232 *p = 0;
1234 else
1235 #endif
1236 newdir = "";
1239 #endif /* DOS_NT */
1241 if (newdir)
1243 /* Get rid of any slash at the end of newdir, unless newdir is
1244 just / or // (an incomplete UNC name). */
1245 length = strlen (newdir);
1246 if (length > 1 && IS_DIRECTORY_SEP (newdir[length - 1])
1247 #ifdef WINDOWSNT
1248 && !(length == 2 && IS_DIRECTORY_SEP (newdir[0]))
1249 #endif
1252 unsigned char *temp = (unsigned char *) alloca (length);
1253 bcopy (newdir, temp, length - 1);
1254 temp[length - 1] = 0;
1255 newdir = temp;
1257 tlen = length + 1;
1259 else
1260 tlen = 0;
1262 /* Now concatenate the directory and name to new space in the stack frame */
1263 tlen += strlen (nm) + 1;
1264 #ifdef DOS_NT
1265 /* Reserve space for drive specifier and escape prefix, since either
1266 or both may need to be inserted. (The Microsoft x86 compiler
1267 produces incorrect code if the following two lines are combined.) */
1268 target = (unsigned char *) alloca (tlen + 4);
1269 target += 4;
1270 #else /* not DOS_NT */
1271 target = (unsigned char *) alloca (tlen);
1272 #endif /* not DOS_NT */
1273 *target = 0;
1275 if (newdir)
1277 if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0]))
1279 #ifdef DOS_NT
1280 /* If newdir is effectively "C:/", then the drive letter will have
1281 been stripped and newdir will be "/". Concatenating with an
1282 absolute directory in nm produces "//", which will then be
1283 incorrectly treated as a network share. Ignore newdir in
1284 this case (keeping the drive letter). */
1285 if (!(drive && nm[0] && IS_DIRECTORY_SEP (newdir[0])
1286 && newdir[1] == '\0'))
1287 #endif
1288 strcpy (target, newdir);
1290 else
1291 file_name_as_directory (target, newdir);
1294 strcat (target, nm);
1296 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1297 appear. */
1299 unsigned char *p = target;
1300 unsigned char *o = target;
1302 while (*p)
1304 if (!IS_DIRECTORY_SEP (*p))
1306 *o++ = *p++;
1308 else if (p[1] == '.'
1309 && (IS_DIRECTORY_SEP (p[2])
1310 || p[2] == 0))
1312 /* If "/." is the entire filename, keep the "/". Otherwise,
1313 just delete the whole "/.". */
1314 if (o == target && p[2] == '\0')
1315 *o++ = *p;
1316 p += 2;
1318 else if (p[1] == '.' && p[2] == '.'
1319 /* `/../' is the "superroot" on certain file systems.
1320 Turned off on DOS_NT systems because they have no
1321 "superroot" and because this causes us to produce
1322 file names like "d:/../foo" which fail file-related
1323 functions of the underlying OS. (To reproduce, try a
1324 long series of "../../" in default_directory, longer
1325 than the number of levels from the root.) */
1326 #ifndef DOS_NT
1327 && o != target
1328 #endif
1329 && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0))
1331 #ifdef WINDOWSNT
1332 unsigned char *prev_o = o;
1333 #endif
1334 while (o != target && (--o) && !IS_DIRECTORY_SEP (*o))
1336 #ifdef WINDOWSNT
1337 /* Don't go below server level in UNC filenames. */
1338 if (o == target + 1 && IS_DIRECTORY_SEP (*o)
1339 && IS_DIRECTORY_SEP (*target))
1340 o = prev_o;
1341 else
1342 #endif
1343 /* Keep initial / only if this is the whole name. */
1344 if (o == target && IS_ANY_SEP (*o) && p[3] == 0)
1345 ++o;
1346 p += 3;
1348 else if (p > target && IS_DIRECTORY_SEP (p[1]))
1349 /* Collapse multiple `/' in a row. */
1350 p++;
1351 else
1353 *o++ = *p++;
1357 #ifdef DOS_NT
1358 /* At last, set drive name. */
1359 #ifdef WINDOWSNT
1360 /* Except for network file name. */
1361 if (!(IS_DIRECTORY_SEP (target[0]) && IS_DIRECTORY_SEP (target[1])))
1362 #endif /* WINDOWSNT */
1364 if (!drive) abort ();
1365 target -= 2;
1366 target[0] = DRIVE_LETTER (drive);
1367 target[1] = ':';
1369 /* Reinsert the escape prefix if required. */
1370 if (is_escaped)
1372 target -= 2;
1373 target[0] = '/';
1374 target[1] = ':';
1376 CORRECT_DIR_SEPS (target);
1377 #endif /* DOS_NT */
1379 result = make_specified_string (target, -1, o - target, multibyte);
1382 /* Again look to see if the file name has special constructs in it
1383 and perhaps call the corresponding file handler. This is needed
1384 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1385 the ".." component gives us "/user@host:/bar/../baz" which needs
1386 to be expanded again. */
1387 handler = Ffind_file_name_handler (result, Qexpand_file_name);
1388 if (!NILP (handler))
1389 return call3 (handler, Qexpand_file_name, result, default_directory);
1391 return result;
1394 #if 0
1395 /* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1396 This is the old version of expand-file-name, before it was thoroughly
1397 rewritten for Emacs 10.31. We leave this version here commented-out,
1398 because the code is very complex and likely to have subtle bugs. If
1399 bugs _are_ found, it might be of interest to look at the old code and
1400 see what did it do in the relevant situation.
1402 Don't remove this code: it's true that it will be accessible via CVS,
1403 but a few years from deletion, people will forget it is there. */
1405 /* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1406 DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1407 "Convert FILENAME to absolute, and canonicalize it.\n\
1408 Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1409 \(does not start with slash); if DEFAULT is nil or missing,\n\
1410 the current buffer's value of default-directory is used.\n\
1411 Filenames containing `.' or `..' as components are simplified;\n\
1412 initial `~/' expands to your home directory.\n\
1413 See also the function `substitute-in-file-name'.")
1414 (name, defalt)
1415 Lisp_Object name, defalt;
1417 unsigned char *nm;
1419 register unsigned char *newdir, *p, *o;
1420 int tlen;
1421 unsigned char *target;
1422 struct passwd *pw;
1423 int lose;
1425 CHECK_STRING (name);
1426 nm = SDATA (name);
1428 /* If nm is absolute, flush ...// and detect /./ and /../.
1429 If no /./ or /../ we can return right away. */
1430 if (nm[0] == '/')
1432 p = nm;
1433 lose = 0;
1434 while (*p)
1436 if (p[0] == '/' && p[1] == '/'
1438 nm = p + 1;
1439 if (p[0] == '/' && p[1] == '~')
1440 nm = p + 1, lose = 1;
1441 if (p[0] == '/' && p[1] == '.'
1442 && (p[2] == '/' || p[2] == 0
1443 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1444 lose = 1;
1445 p++;
1447 if (!lose)
1449 if (nm == SDATA (name))
1450 return name;
1451 return build_string (nm);
1455 /* Now determine directory to start with and put it in NEWDIR */
1457 newdir = 0;
1459 if (nm[0] == '~') /* prefix ~ */
1460 if (nm[1] == '/' || nm[1] == 0)/* ~/filename */
1462 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1463 newdir = (unsigned char *) "";
1464 nm++;
1466 else /* ~user/filename */
1468 /* Get past ~ to user */
1469 unsigned char *user = nm + 1;
1470 /* Find end of name. */
1471 unsigned char *ptr = (unsigned char *) index (user, '/');
1472 int len = ptr ? ptr - user : strlen (user);
1473 /* Copy the user name into temp storage. */
1474 o = (unsigned char *) alloca (len + 1);
1475 bcopy ((char *) user, o, len);
1476 o[len] = 0;
1478 /* Look up the user name. */
1479 BLOCK_INPUT;
1480 pw = (struct passwd *) getpwnam (o + 1);
1481 UNBLOCK_INPUT;
1482 if (!pw)
1483 error ("\"%s\" isn't a registered user", o + 1);
1485 newdir = (unsigned char *) pw->pw_dir;
1487 /* Discard the user name from NM. */
1488 nm += len;
1491 if (nm[0] != '/' && !newdir)
1493 if (NILP (defalt))
1494 defalt = current_buffer->directory;
1495 CHECK_STRING (defalt);
1496 newdir = SDATA (defalt);
1499 /* Now concatenate the directory and name to new space in the stack frame */
1501 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
1502 target = (unsigned char *) alloca (tlen);
1503 *target = 0;
1505 if (newdir)
1507 if (nm[0] == 0 || nm[0] == '/')
1508 strcpy (target, newdir);
1509 else
1510 file_name_as_directory (target, newdir);
1513 strcat (target, nm);
1515 /* Now canonicalize by removing /. and /foo/.. if they appear */
1517 p = target;
1518 o = target;
1520 while (*p)
1522 if (*p != '/')
1524 *o++ = *p++;
1526 else if (!strncmp (p, "//", 2)
1529 o = target;
1530 p++;
1532 else if (p[0] == '/' && p[1] == '.'
1533 && (p[2] == '/' || p[2] == 0))
1534 p += 2;
1535 else if (!strncmp (p, "/..", 3)
1536 /* `/../' is the "superroot" on certain file systems. */
1537 && o != target
1538 && (p[3] == '/' || p[3] == 0))
1540 while (o != target && *--o != '/')
1542 if (o == target && *o == '/')
1543 ++o;
1544 p += 3;
1546 else
1548 *o++ = *p++;
1552 return make_string (target, o - target);
1554 #endif
1556 /* If /~ or // appears, discard everything through first slash. */
1557 static int
1558 file_name_absolute_p (filename)
1559 const unsigned char *filename;
1561 return
1562 (IS_DIRECTORY_SEP (*filename) || *filename == '~'
1563 #ifdef DOS_NT
1564 || (IS_DRIVE (*filename) && IS_DEVICE_SEP (filename[1])
1565 && IS_DIRECTORY_SEP (filename[2]))
1566 #endif
1570 static unsigned char *
1571 search_embedded_absfilename (nm, endp)
1572 unsigned char *nm, *endp;
1574 unsigned char *p, *s;
1576 for (p = nm + 1; p < endp; p++)
1578 if ((0
1579 || IS_DIRECTORY_SEP (p[-1]))
1580 && file_name_absolute_p (p)
1581 #if defined (WINDOWSNT) || defined(CYGWIN)
1582 /* // at start of file name is meaningful in Apollo,
1583 WindowsNT and Cygwin systems. */
1584 && !(IS_DIRECTORY_SEP (p[0]) && p - 1 == nm)
1585 #endif /* not (WINDOWSNT || CYGWIN) */
1588 for (s = p; *s && (!IS_DIRECTORY_SEP (*s)); s++);
1589 if (p[0] == '~' && s > p + 1) /* we've got "/~something/" */
1591 unsigned char *o = alloca (s - p + 1);
1592 struct passwd *pw;
1593 bcopy (p, o, s - p);
1594 o [s - p] = 0;
1596 /* If we have ~user and `user' exists, discard
1597 everything up to ~. But if `user' does not exist, leave
1598 ~user alone, it might be a literal file name. */
1599 BLOCK_INPUT;
1600 pw = getpwnam (o + 1);
1601 UNBLOCK_INPUT;
1602 if (pw)
1603 return p;
1605 else
1606 return p;
1609 return NULL;
1612 DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
1613 Ssubstitute_in_file_name, 1, 1, 0,
1614 doc: /* Substitute environment variables referred to in FILENAME.
1615 `$FOO' where FOO is an environment variable name means to substitute
1616 the value of that variable. The variable name should be terminated
1617 with a character not a letter, digit or underscore; otherwise, enclose
1618 the entire variable name in braces.
1619 If `/~' appears, all of FILENAME through that `/' is discarded. */)
1620 (filename)
1621 Lisp_Object filename;
1623 unsigned char *nm;
1625 register unsigned char *s, *p, *o, *x, *endp;
1626 unsigned char *target = NULL;
1627 int total = 0;
1628 int substituted = 0;
1629 unsigned char *xnm;
1630 Lisp_Object handler;
1632 CHECK_STRING (filename);
1634 /* If the file name has special constructs in it,
1635 call the corresponding file handler. */
1636 handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name);
1637 if (!NILP (handler))
1638 return call2 (handler, Qsubstitute_in_file_name, filename);
1640 nm = SDATA (filename);
1641 #ifdef DOS_NT
1642 nm = strcpy (alloca (strlen (nm) + 1), nm);
1643 CORRECT_DIR_SEPS (nm);
1644 substituted = (strcmp (nm, SDATA (filename)) != 0);
1645 #endif
1646 endp = nm + SBYTES (filename);
1648 /* If /~ or // appears, discard everything through first slash. */
1649 p = search_embedded_absfilename (nm, endp);
1650 if (p)
1651 /* Start over with the new string, so we check the file-name-handler
1652 again. Important with filenames like "/home/foo//:/hello///there"
1653 which whould substitute to "/:/hello///there" rather than "/there". */
1654 return Fsubstitute_in_file_name
1655 (make_specified_string (p, -1, endp - p,
1656 STRING_MULTIBYTE (filename)));
1659 /* See if any variables are substituted into the string
1660 and find the total length of their values in `total' */
1662 for (p = nm; p != endp;)
1663 if (*p != '$')
1664 p++;
1665 else
1667 p++;
1668 if (p == endp)
1669 goto badsubst;
1670 else if (*p == '$')
1672 /* "$$" means a single "$" */
1673 p++;
1674 total -= 1;
1675 substituted = 1;
1676 continue;
1678 else if (*p == '{')
1680 o = ++p;
1681 while (p != endp && *p != '}') p++;
1682 if (*p != '}') goto missingclose;
1683 s = p;
1685 else
1687 o = p;
1688 while (p != endp && (isalnum (*p) || *p == '_')) p++;
1689 s = p;
1692 /* Copy out the variable name */
1693 target = (unsigned char *) alloca (s - o + 1);
1694 strncpy (target, o, s - o);
1695 target[s - o] = 0;
1696 #ifdef DOS_NT
1697 strupr (target); /* $home == $HOME etc. */
1698 #endif /* DOS_NT */
1700 /* Get variable value */
1701 o = (unsigned char *) egetenv (target);
1702 if (o)
1703 { /* Eight-bit chars occupy upto 2 bytes in multibyte. */
1704 total += strlen (o) * (STRING_MULTIBYTE (filename) ? 2 : 1);
1705 substituted = 1;
1707 else if (*p == '}')
1708 goto badvar;
1711 if (!substituted)
1712 return filename;
1714 /* If substitution required, recopy the string and do it */
1715 /* Make space in stack frame for the new copy */
1716 xnm = (unsigned char *) alloca (SBYTES (filename) + total + 1);
1717 x = xnm;
1719 /* Copy the rest of the name through, replacing $ constructs with values */
1720 for (p = nm; *p;)
1721 if (*p != '$')
1722 *x++ = *p++;
1723 else
1725 p++;
1726 if (p == endp)
1727 goto badsubst;
1728 else if (*p == '$')
1730 *x++ = *p++;
1731 continue;
1733 else if (*p == '{')
1735 o = ++p;
1736 while (p != endp && *p != '}') p++;
1737 if (*p != '}') goto missingclose;
1738 s = p++;
1740 else
1742 o = p;
1743 while (p != endp && (isalnum (*p) || *p == '_')) p++;
1744 s = p;
1747 /* Copy out the variable name */
1748 target = (unsigned char *) alloca (s - o + 1);
1749 strncpy (target, o, s - o);
1750 target[s - o] = 0;
1751 #ifdef DOS_NT
1752 strupr (target); /* $home == $HOME etc. */
1753 #endif /* DOS_NT */
1755 /* Get variable value */
1756 o = (unsigned char *) egetenv (target);
1757 if (!o)
1759 *x++ = '$';
1760 strcpy (x, target); x+= strlen (target);
1762 else if (STRING_MULTIBYTE (filename))
1764 /* If the original string is multibyte,
1765 convert what we substitute into multibyte. */
1766 while (*o)
1768 int c = *o++;
1769 c = unibyte_char_to_multibyte (c);
1770 x += CHAR_STRING (c, x);
1773 else
1775 strcpy (x, o);
1776 x += strlen (o);
1780 *x = 0;
1782 /* If /~ or // appears, discard everything through first slash. */
1783 while ((p = search_embedded_absfilename (xnm, x)))
1784 /* This time we do not start over because we've already expanded envvars
1785 and replaced $$ with $. Maybe we should start over as well, but we'd
1786 need to quote some $ to $$ first. */
1787 xnm = p;
1789 return make_specified_string (xnm, -1, x - xnm, STRING_MULTIBYTE (filename));
1791 badsubst:
1792 error ("Bad format environment-variable substitution");
1793 missingclose:
1794 error ("Missing \"}\" in environment-variable substitution");
1795 badvar:
1796 error ("Substituting nonexistent environment variable \"%s\"", target);
1798 /* NOTREACHED */
1799 return Qnil;
1802 /* A slightly faster and more convenient way to get
1803 (directory-file-name (expand-file-name FOO)). */
1805 Lisp_Object
1806 expand_and_dir_to_file (filename, defdir)
1807 Lisp_Object filename, defdir;
1809 register Lisp_Object absname;
1811 absname = Fexpand_file_name (filename, defdir);
1813 /* Remove final slash, if any (unless this is the root dir).
1814 stat behaves differently depending! */
1815 if (SCHARS (absname) > 1
1816 && IS_DIRECTORY_SEP (SREF (absname, SBYTES (absname) - 1))
1817 && !IS_DEVICE_SEP (SREF (absname, SBYTES (absname)-2)))
1818 /* We cannot take shortcuts; they might be wrong for magic file names. */
1819 absname = Fdirectory_file_name (absname);
1820 return absname;
1823 /* Signal an error if the file ABSNAME already exists.
1824 If INTERACTIVE is nonzero, ask the user whether to proceed,
1825 and bypass the error if the user says to go ahead.
1826 QUERYSTRING is a name for the action that is being considered
1827 to alter the file.
1829 *STATPTR is used to store the stat information if the file exists.
1830 If the file does not exist, STATPTR->st_mode is set to 0.
1831 If STATPTR is null, we don't store into it.
1833 If QUICK is nonzero, we ask for y or n, not yes or no. */
1835 void
1836 barf_or_query_if_file_exists (absname, querystring, interactive, statptr, quick)
1837 Lisp_Object absname;
1838 unsigned char *querystring;
1839 int interactive;
1840 struct stat *statptr;
1841 int quick;
1843 register Lisp_Object tem, encoded_filename;
1844 struct stat statbuf;
1845 struct gcpro gcpro1;
1847 encoded_filename = ENCODE_FILE (absname);
1849 /* stat is a good way to tell whether the file exists,
1850 regardless of what access permissions it has. */
1851 if (lstat (SDATA (encoded_filename), &statbuf) >= 0)
1853 if (! interactive)
1854 xsignal2 (Qfile_already_exists,
1855 build_string ("File already exists"), absname);
1856 GCPRO1 (absname);
1857 tem = format2 ("File %s already exists; %s anyway? ",
1858 absname, build_string (querystring));
1859 if (quick)
1860 tem = Fy_or_n_p (tem);
1861 else
1862 tem = do_yes_or_no_p (tem);
1863 UNGCPRO;
1864 if (NILP (tem))
1865 xsignal2 (Qfile_already_exists,
1866 build_string ("File already exists"), absname);
1867 if (statptr)
1868 *statptr = statbuf;
1870 else
1872 if (statptr)
1873 statptr->st_mode = 0;
1875 return;
1878 DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 5,
1879 "fCopy file: \nGCopy %s to file: \np\nP",
1880 doc: /* Copy FILE to NEWNAME. Both args must be strings.
1881 If NEWNAME names a directory, copy FILE there.
1883 This function always sets the file modes of the output file to match
1884 the input file.
1886 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1887 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1888 signal a `file-already-exists' error without overwriting. If
1889 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1890 about overwriting; this is what happens in interactive use with M-x.
1891 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1892 existing file.
1894 Fourth arg KEEP-TIME non-nil means give the output file the same
1895 last-modified time as the old one. (This works on only some systems.)
1897 A prefix arg makes KEEP-TIME non-nil.
1899 If PRESERVE-UID-GID is non-nil, we try to transfer the
1900 uid and gid of FILE to NEWNAME. */)
1901 (file, newname, ok_if_already_exists, keep_time, preserve_uid_gid)
1902 Lisp_Object file, newname, ok_if_already_exists, keep_time;
1903 Lisp_Object preserve_uid_gid;
1905 int ifd, ofd, n;
1906 char buf[16 * 1024];
1907 struct stat st, out_st;
1908 Lisp_Object handler;
1909 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1910 int count = SPECPDL_INDEX ();
1911 int input_file_statable_p;
1912 Lisp_Object encoded_file, encoded_newname;
1914 encoded_file = encoded_newname = Qnil;
1915 GCPRO4 (file, newname, encoded_file, encoded_newname);
1916 CHECK_STRING (file);
1917 CHECK_STRING (newname);
1919 if (!NILP (Ffile_directory_p (newname)))
1920 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
1921 else
1922 newname = Fexpand_file_name (newname, Qnil);
1924 file = Fexpand_file_name (file, Qnil);
1926 /* If the input file name has special constructs in it,
1927 call the corresponding file handler. */
1928 handler = Ffind_file_name_handler (file, Qcopy_file);
1929 /* Likewise for output file name. */
1930 if (NILP (handler))
1931 handler = Ffind_file_name_handler (newname, Qcopy_file);
1932 if (!NILP (handler))
1933 RETURN_UNGCPRO (call6 (handler, Qcopy_file, file, newname,
1934 ok_if_already_exists, keep_time, preserve_uid_gid));
1936 encoded_file = ENCODE_FILE (file);
1937 encoded_newname = ENCODE_FILE (newname);
1939 if (NILP (ok_if_already_exists)
1940 || INTEGERP (ok_if_already_exists))
1941 barf_or_query_if_file_exists (newname, "copy to it",
1942 INTEGERP (ok_if_already_exists), &out_st, 0);
1943 else if (stat (SDATA (encoded_newname), &out_st) < 0)
1944 out_st.st_mode = 0;
1946 #ifdef WINDOWSNT
1947 if (!CopyFile (SDATA (encoded_file),
1948 SDATA (encoded_newname),
1949 FALSE))
1950 report_file_error ("Copying file", Fcons (file, Fcons (newname, Qnil)));
1951 /* CopyFile retains the timestamp by default. */
1952 else if (NILP (keep_time))
1954 EMACS_TIME now;
1955 DWORD attributes;
1956 char * filename;
1958 EMACS_GET_TIME (now);
1959 filename = SDATA (encoded_newname);
1961 /* Ensure file is writable while its modified time is set. */
1962 attributes = GetFileAttributes (filename);
1963 SetFileAttributes (filename, attributes & ~FILE_ATTRIBUTE_READONLY);
1964 if (set_file_times (filename, now, now))
1966 /* Restore original attributes. */
1967 SetFileAttributes (filename, attributes);
1968 xsignal2 (Qfile_date_error,
1969 build_string ("Cannot set file date"), newname);
1971 /* Restore original attributes. */
1972 SetFileAttributes (filename, attributes);
1974 #else /* not WINDOWSNT */
1975 immediate_quit = 1;
1976 ifd = emacs_open (SDATA (encoded_file), O_RDONLY, 0);
1977 immediate_quit = 0;
1979 if (ifd < 0)
1980 report_file_error ("Opening input file", Fcons (file, Qnil));
1982 record_unwind_protect (close_file_unwind, make_number (ifd));
1984 /* We can only copy regular files and symbolic links. Other files are not
1985 copyable by us. */
1986 input_file_statable_p = (fstat (ifd, &st) >= 0);
1988 #if !defined (MSDOS) || __DJGPP__ > 1
1989 if (out_st.st_mode != 0
1990 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
1992 errno = 0;
1993 report_file_error ("Input and output files are the same",
1994 Fcons (file, Fcons (newname, Qnil)));
1996 #endif
1998 #if defined (S_ISREG) && defined (S_ISLNK)
1999 if (input_file_statable_p)
2001 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
2003 #if defined (EISDIR)
2004 /* Get a better looking error message. */
2005 errno = EISDIR;
2006 #endif /* EISDIR */
2007 report_file_error ("Non-regular file", Fcons (file, Qnil));
2010 #endif /* S_ISREG && S_ISLNK */
2012 #ifdef MSDOS
2013 /* System's default file type was set to binary by _fmode in emacs.c. */
2014 ofd = emacs_open (SDATA (encoded_newname),
2015 O_WRONLY | O_TRUNC | O_CREAT
2016 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2017 S_IREAD | S_IWRITE);
2018 #else /* not MSDOS */
2019 ofd = emacs_open (SDATA (encoded_newname),
2020 O_WRONLY | O_TRUNC | O_CREAT
2021 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2022 0666);
2023 #endif /* not MSDOS */
2024 if (ofd < 0)
2025 report_file_error ("Opening output file", Fcons (newname, Qnil));
2027 record_unwind_protect (close_file_unwind, make_number (ofd));
2029 immediate_quit = 1;
2030 QUIT;
2031 while ((n = emacs_read (ifd, buf, sizeof buf)) > 0)
2032 if (emacs_write (ofd, buf, n) != n)
2033 report_file_error ("I/O error", Fcons (newname, Qnil));
2034 immediate_quit = 0;
2036 #ifndef MSDOS
2037 /* Preserve the original file modes, and if requested, also its
2038 owner and group. */
2039 if (input_file_statable_p)
2041 if (! NILP (preserve_uid_gid))
2042 fchown (ofd, st.st_uid, st.st_gid);
2043 fchmod (ofd, st.st_mode & 07777);
2045 #endif /* not MSDOS */
2047 /* Closing the output clobbers the file times on some systems. */
2048 if (emacs_close (ofd) < 0)
2049 report_file_error ("I/O error", Fcons (newname, Qnil));
2051 if (input_file_statable_p)
2053 if (!NILP (keep_time))
2055 EMACS_TIME atime, mtime;
2056 EMACS_SET_SECS_USECS (atime, st.st_atime, 0);
2057 EMACS_SET_SECS_USECS (mtime, st.st_mtime, 0);
2058 if (set_file_times (SDATA (encoded_newname),
2059 atime, mtime))
2060 xsignal2 (Qfile_date_error,
2061 build_string ("Cannot set file date"), newname);
2065 emacs_close (ifd);
2067 #if defined (__DJGPP__) && __DJGPP__ > 1
2068 if (input_file_statable_p)
2070 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2071 and if it can't, it tells so. Otherwise, under MSDOS we usually
2072 get only the READ bit, which will make the copied file read-only,
2073 so it's better not to chmod at all. */
2074 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2075 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2077 #endif /* DJGPP version 2 or newer */
2078 #endif /* not WINDOWSNT */
2080 /* Discard the unwind protects. */
2081 specpdl_ptr = specpdl + count;
2083 UNGCPRO;
2084 return Qnil;
2087 DEFUN ("make-directory-internal", Fmake_directory_internal,
2088 Smake_directory_internal, 1, 1, 0,
2089 doc: /* Create a new directory named DIRECTORY. */)
2090 (directory)
2091 Lisp_Object directory;
2093 const unsigned char *dir;
2094 Lisp_Object handler;
2095 Lisp_Object encoded_dir;
2097 CHECK_STRING (directory);
2098 directory = Fexpand_file_name (directory, Qnil);
2100 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
2101 if (!NILP (handler))
2102 return call2 (handler, Qmake_directory_internal, directory);
2104 encoded_dir = ENCODE_FILE (directory);
2106 dir = SDATA (encoded_dir);
2108 #ifdef WINDOWSNT
2109 if (mkdir (dir) != 0)
2110 #else
2111 if (mkdir (dir, 0777) != 0)
2112 #endif
2113 report_file_error ("Creating directory", list1 (directory));
2115 return Qnil;
2118 DEFUN ("delete-directory", Fdelete_directory, Sdelete_directory, 1, 1, "FDelete directory: ",
2119 doc: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2120 (directory)
2121 Lisp_Object directory;
2123 const unsigned char *dir;
2124 Lisp_Object handler;
2125 Lisp_Object encoded_dir;
2127 CHECK_STRING (directory);
2128 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
2130 handler = Ffind_file_name_handler (directory, Qdelete_directory);
2131 if (!NILP (handler))
2132 return call2 (handler, Qdelete_directory, directory);
2134 if (delete_by_moving_to_trash)
2135 return call1 (Qmove_file_to_trash, directory);
2137 encoded_dir = ENCODE_FILE (directory);
2139 dir = SDATA (encoded_dir);
2141 if (rmdir (dir) != 0)
2142 report_file_error ("Removing directory", list1 (directory));
2144 return Qnil;
2147 DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 1, "fDelete file: ",
2148 doc: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2149 If file has multiple names, it continues to exist with the other names. */)
2150 (filename)
2151 Lisp_Object filename;
2153 Lisp_Object handler;
2154 Lisp_Object encoded_file;
2155 struct gcpro gcpro1;
2157 GCPRO1 (filename);
2158 if (!NILP (Ffile_directory_p (filename))
2159 && NILP (Ffile_symlink_p (filename)))
2160 xsignal2 (Qfile_error,
2161 build_string ("Removing old name: is a directory"),
2162 filename);
2163 UNGCPRO;
2164 filename = Fexpand_file_name (filename, Qnil);
2166 handler = Ffind_file_name_handler (filename, Qdelete_file);
2167 if (!NILP (handler))
2168 return call2 (handler, Qdelete_file, filename);
2170 if (delete_by_moving_to_trash)
2171 return call1 (Qmove_file_to_trash, filename);
2173 encoded_file = ENCODE_FILE (filename);
2175 if (0 > unlink (SDATA (encoded_file)))
2176 report_file_error ("Removing old name", list1 (filename));
2177 return Qnil;
2180 static Lisp_Object
2181 internal_delete_file_1 (ignore)
2182 Lisp_Object ignore;
2184 return Qt;
2187 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2190 internal_delete_file (filename)
2191 Lisp_Object filename;
2193 Lisp_Object tem;
2194 tem = internal_condition_case_1 (Fdelete_file, filename,
2195 Qt, internal_delete_file_1);
2196 return NILP (tem);
2199 DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
2200 "fRename file: \nGRename %s to file: \np",
2201 doc: /* Rename FILE as NEWNAME. Both args must be strings.
2202 If file has names other than FILE, it continues to have those names.
2203 Signals a `file-already-exists' error if a file NEWNAME already exists
2204 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2205 A number as third arg means request confirmation if NEWNAME already exists.
2206 This is what happens in interactive use with M-x. */)
2207 (file, newname, ok_if_already_exists)
2208 Lisp_Object file, newname, ok_if_already_exists;
2210 Lisp_Object handler;
2211 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
2212 Lisp_Object encoded_file, encoded_newname, symlink_target;
2214 symlink_target = encoded_file = encoded_newname = Qnil;
2215 GCPRO5 (file, newname, encoded_file, encoded_newname, symlink_target);
2216 CHECK_STRING (file);
2217 CHECK_STRING (newname);
2218 file = Fexpand_file_name (file, Qnil);
2220 if ((!NILP (Ffile_directory_p (newname)))
2221 #ifdef DOS_NT
2222 /* If the file names are identical but for the case,
2223 don't attempt to move directory to itself. */
2224 && (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2225 #endif
2227 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2228 else
2229 newname = Fexpand_file_name (newname, Qnil);
2231 /* If the file name has special constructs in it,
2232 call the corresponding file handler. */
2233 handler = Ffind_file_name_handler (file, Qrename_file);
2234 if (NILP (handler))
2235 handler = Ffind_file_name_handler (newname, Qrename_file);
2236 if (!NILP (handler))
2237 RETURN_UNGCPRO (call4 (handler, Qrename_file,
2238 file, newname, ok_if_already_exists));
2240 encoded_file = ENCODE_FILE (file);
2241 encoded_newname = ENCODE_FILE (newname);
2243 #ifdef DOS_NT
2244 /* If the file names are identical but for the case, don't ask for
2245 confirmation: they simply want to change the letter-case of the
2246 file name. */
2247 if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2248 #endif
2249 if (NILP (ok_if_already_exists)
2250 || INTEGERP (ok_if_already_exists))
2251 barf_or_query_if_file_exists (newname, "rename to it",
2252 INTEGERP (ok_if_already_exists), 0, 0);
2253 if (0 > rename (SDATA (encoded_file), SDATA (encoded_newname)))
2255 if (errno == EXDEV)
2257 int count;
2258 #ifdef S_IFLNK
2259 symlink_target = Ffile_symlink_p (file);
2260 if (! NILP (symlink_target))
2261 Fmake_symbolic_link (symlink_target, newname,
2262 NILP (ok_if_already_exists) ? Qnil : Qt);
2263 else
2264 #endif
2265 Fcopy_file (file, newname,
2266 /* We have already prompted if it was an integer,
2267 so don't have copy-file prompt again. */
2268 NILP (ok_if_already_exists) ? Qnil : Qt,
2269 Qt, Qt);
2271 count = SPECPDL_INDEX ();
2272 specbind (Qdelete_by_moving_to_trash, Qnil);
2273 Fdelete_file (file);
2274 unbind_to (count, Qnil);
2276 else
2277 report_file_error ("Renaming", list2 (file, newname));
2279 UNGCPRO;
2280 return Qnil;
2283 DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
2284 "fAdd name to file: \nGName to add to %s: \np",
2285 doc: /* Give FILE additional name NEWNAME. Both args must be strings.
2286 Signals a `file-already-exists' error if a file NEWNAME already exists
2287 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2288 A number as third arg means request confirmation if NEWNAME already exists.
2289 This is what happens in interactive use with M-x. */)
2290 (file, newname, ok_if_already_exists)
2291 Lisp_Object file, newname, ok_if_already_exists;
2293 Lisp_Object handler;
2294 Lisp_Object encoded_file, encoded_newname;
2295 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2297 GCPRO4 (file, newname, encoded_file, encoded_newname);
2298 encoded_file = encoded_newname = Qnil;
2299 CHECK_STRING (file);
2300 CHECK_STRING (newname);
2301 file = Fexpand_file_name (file, Qnil);
2303 if (!NILP (Ffile_directory_p (newname)))
2304 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2305 else
2306 newname = Fexpand_file_name (newname, Qnil);
2308 /* If the file name has special constructs in it,
2309 call the corresponding file handler. */
2310 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
2311 if (!NILP (handler))
2312 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2313 newname, ok_if_already_exists));
2315 /* If the new name has special constructs in it,
2316 call the corresponding file handler. */
2317 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2318 if (!NILP (handler))
2319 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2320 newname, ok_if_already_exists));
2322 encoded_file = ENCODE_FILE (file);
2323 encoded_newname = ENCODE_FILE (newname);
2325 if (NILP (ok_if_already_exists)
2326 || INTEGERP (ok_if_already_exists))
2327 barf_or_query_if_file_exists (newname, "make it a new name",
2328 INTEGERP (ok_if_already_exists), 0, 0);
2330 unlink (SDATA (newname));
2331 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname)))
2332 report_file_error ("Adding new name", list2 (file, newname));
2334 UNGCPRO;
2335 return Qnil;
2338 DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2339 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2340 doc: /* Make a symbolic link to FILENAME, named LINKNAME.
2341 Both args must be strings.
2342 Signals a `file-already-exists' error if a file LINKNAME already exists
2343 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2344 A number as third arg means request confirmation if LINKNAME already exists.
2345 This happens for interactive use with M-x. */)
2346 (filename, linkname, ok_if_already_exists)
2347 Lisp_Object filename, linkname, ok_if_already_exists;
2349 Lisp_Object handler;
2350 Lisp_Object encoded_filename, encoded_linkname;
2351 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2353 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2354 encoded_filename = encoded_linkname = Qnil;
2355 CHECK_STRING (filename);
2356 CHECK_STRING (linkname);
2357 /* If the link target has a ~, we must expand it to get
2358 a truly valid file name. Otherwise, do not expand;
2359 we want to permit links to relative file names. */
2360 if (SREF (filename, 0) == '~')
2361 filename = Fexpand_file_name (filename, Qnil);
2363 if (!NILP (Ffile_directory_p (linkname)))
2364 linkname = Fexpand_file_name (Ffile_name_nondirectory (filename), linkname);
2365 else
2366 linkname = Fexpand_file_name (linkname, Qnil);
2368 /* If the file name has special constructs in it,
2369 call the corresponding file handler. */
2370 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
2371 if (!NILP (handler))
2372 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2373 linkname, ok_if_already_exists));
2375 /* If the new link name has special constructs in it,
2376 call the corresponding file handler. */
2377 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2378 if (!NILP (handler))
2379 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2380 linkname, ok_if_already_exists));
2382 #ifdef S_IFLNK
2383 encoded_filename = ENCODE_FILE (filename);
2384 encoded_linkname = ENCODE_FILE (linkname);
2386 if (NILP (ok_if_already_exists)
2387 || INTEGERP (ok_if_already_exists))
2388 barf_or_query_if_file_exists (linkname, "make it a link",
2389 INTEGERP (ok_if_already_exists), 0, 0);
2390 if (0 > symlink (SDATA (encoded_filename),
2391 SDATA (encoded_linkname)))
2393 /* If we didn't complain already, silently delete existing file. */
2394 if (errno == EEXIST)
2396 unlink (SDATA (encoded_linkname));
2397 if (0 <= symlink (SDATA (encoded_filename),
2398 SDATA (encoded_linkname)))
2400 UNGCPRO;
2401 return Qnil;
2405 report_file_error ("Making symbolic link", list2 (filename, linkname));
2407 UNGCPRO;
2408 return Qnil;
2410 #else
2411 UNGCPRO;
2412 xsignal1 (Qfile_error, build_string ("Symbolic links are not supported"));
2414 #endif /* S_IFLNK */
2418 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
2419 1, 1, 0,
2420 doc: /* Return t if file FILENAME specifies an absolute file name.
2421 On Unix, this is a name starting with a `/' or a `~'. */)
2422 (filename)
2423 Lisp_Object filename;
2425 CHECK_STRING (filename);
2426 return file_name_absolute_p (SDATA (filename)) ? Qt : Qnil;
2429 /* Return nonzero if file FILENAME exists and can be executed. */
2431 static int
2432 check_executable (filename)
2433 char *filename;
2435 #ifdef DOS_NT
2436 int len = strlen (filename);
2437 char *suffix;
2438 struct stat st;
2439 if (stat (filename, &st) < 0)
2440 return 0;
2441 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
2442 return ((st.st_mode & S_IEXEC) != 0);
2443 #else
2444 return (S_ISREG (st.st_mode)
2445 && len >= 5
2446 && (xstrcasecmp ((suffix = filename + len-4), ".com") == 0
2447 || xstrcasecmp (suffix, ".exe") == 0
2448 || xstrcasecmp (suffix, ".bat") == 0)
2449 || (st.st_mode & S_IFMT) == S_IFDIR);
2450 #endif /* not WINDOWSNT */
2451 #else /* not DOS_NT */
2452 #ifdef HAVE_EUIDACCESS
2453 return (euidaccess (filename, 1) >= 0);
2454 #else
2455 /* Access isn't quite right because it uses the real uid
2456 and we really want to test with the effective uid.
2457 But Unix doesn't give us a right way to do it. */
2458 return (access (filename, 1) >= 0);
2459 #endif
2460 #endif /* not DOS_NT */
2463 /* Return nonzero if file FILENAME exists and can be written. */
2465 static int
2466 check_writable (filename)
2467 char *filename;
2469 #ifdef MSDOS
2470 struct stat st;
2471 if (stat (filename, &st) < 0)
2472 return 0;
2473 return (st.st_mode & S_IWRITE || (st.st_mode & S_IFMT) == S_IFDIR);
2474 #else /* not MSDOS */
2475 #ifdef HAVE_EUIDACCESS
2476 return (euidaccess (filename, 2) >= 0);
2477 #else
2478 /* Access isn't quite right because it uses the real uid
2479 and we really want to test with the effective uid.
2480 But Unix doesn't give us a right way to do it.
2481 Opening with O_WRONLY could work for an ordinary file,
2482 but would lose for directories. */
2483 return (access (filename, 2) >= 0);
2484 #endif
2485 #endif /* not MSDOS */
2488 DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
2489 doc: /* Return t if file FILENAME exists (whether or not you can read it.)
2490 See also `file-readable-p' and `file-attributes'.
2491 This returns nil for a symlink to a nonexistent file.
2492 Use `file-symlink-p' to test for such links. */)
2493 (filename)
2494 Lisp_Object filename;
2496 Lisp_Object absname;
2497 Lisp_Object handler;
2498 struct stat statbuf;
2500 CHECK_STRING (filename);
2501 absname = Fexpand_file_name (filename, Qnil);
2503 /* If the file name has special constructs in it,
2504 call the corresponding file handler. */
2505 handler = Ffind_file_name_handler (absname, Qfile_exists_p);
2506 if (!NILP (handler))
2507 return call2 (handler, Qfile_exists_p, absname);
2509 absname = ENCODE_FILE (absname);
2511 return (stat (SDATA (absname), &statbuf) >= 0) ? Qt : Qnil;
2514 DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
2515 doc: /* Return t if FILENAME can be executed by you.
2516 For a directory, this means you can access files in that directory. */)
2517 (filename)
2518 Lisp_Object filename;
2520 Lisp_Object absname;
2521 Lisp_Object handler;
2523 CHECK_STRING (filename);
2524 absname = Fexpand_file_name (filename, Qnil);
2526 /* If the file name has special constructs in it,
2527 call the corresponding file handler. */
2528 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
2529 if (!NILP (handler))
2530 return call2 (handler, Qfile_executable_p, absname);
2532 absname = ENCODE_FILE (absname);
2534 return (check_executable (SDATA (absname)) ? Qt : Qnil);
2537 DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
2538 doc: /* Return t if file FILENAME exists and you can read it.
2539 See also `file-exists-p' and `file-attributes'. */)
2540 (filename)
2541 Lisp_Object filename;
2543 Lisp_Object absname;
2544 Lisp_Object handler;
2545 int desc;
2546 int flags;
2547 struct stat statbuf;
2549 CHECK_STRING (filename);
2550 absname = Fexpand_file_name (filename, Qnil);
2552 /* If the file name has special constructs in it,
2553 call the corresponding file handler. */
2554 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
2555 if (!NILP (handler))
2556 return call2 (handler, Qfile_readable_p, absname);
2558 absname = ENCODE_FILE (absname);
2560 #if defined(DOS_NT) || defined(macintosh)
2561 /* Under MS-DOS, Windows, and Macintosh, open does not work for
2562 directories. */
2563 if (access (SDATA (absname), 0) == 0)
2564 return Qt;
2565 return Qnil;
2566 #else /* not DOS_NT and not macintosh */
2567 flags = O_RDONLY;
2568 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
2569 /* Opening a fifo without O_NONBLOCK can wait.
2570 We don't want to wait. But we don't want to mess wth O_NONBLOCK
2571 except in the case of a fifo, on a system which handles it. */
2572 desc = stat (SDATA (absname), &statbuf);
2573 if (desc < 0)
2574 return Qnil;
2575 if (S_ISFIFO (statbuf.st_mode))
2576 flags |= O_NONBLOCK;
2577 #endif
2578 desc = emacs_open (SDATA (absname), flags, 0);
2579 if (desc < 0)
2580 return Qnil;
2581 emacs_close (desc);
2582 return Qt;
2583 #endif /* not DOS_NT and not macintosh */
2586 /* Having this before file-symlink-p mysteriously caused it to be forgotten
2587 on the RT/PC. */
2588 DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
2589 doc: /* Return t if file FILENAME can be written or created by you. */)
2590 (filename)
2591 Lisp_Object filename;
2593 Lisp_Object absname, dir, encoded;
2594 Lisp_Object handler;
2595 struct stat statbuf;
2597 CHECK_STRING (filename);
2598 absname = Fexpand_file_name (filename, Qnil);
2600 /* If the file name has special constructs in it,
2601 call the corresponding file handler. */
2602 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
2603 if (!NILP (handler))
2604 return call2 (handler, Qfile_writable_p, absname);
2606 encoded = ENCODE_FILE (absname);
2607 if (stat (SDATA (encoded), &statbuf) >= 0)
2608 return (check_writable (SDATA (encoded))
2609 ? Qt : Qnil);
2611 dir = Ffile_name_directory (absname);
2612 #ifdef MSDOS
2613 if (!NILP (dir))
2614 dir = Fdirectory_file_name (dir);
2615 #endif /* MSDOS */
2617 dir = ENCODE_FILE (dir);
2618 #ifdef WINDOWSNT
2619 /* The read-only attribute of the parent directory doesn't affect
2620 whether a file or directory can be created within it. Some day we
2621 should check ACLs though, which do affect this. */
2622 if (stat (SDATA (dir), &statbuf) < 0)
2623 return Qnil;
2624 return (statbuf.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
2625 #else
2626 return (check_writable (!NILP (dir) ? (char *) SDATA (dir) : "")
2627 ? Qt : Qnil);
2628 #endif
2631 DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
2632 doc: /* Access file FILENAME, and get an error if that does not work.
2633 The second argument STRING is used in the error message.
2634 If there is no error, returns nil. */)
2635 (filename, string)
2636 Lisp_Object filename, string;
2638 Lisp_Object handler, encoded_filename, absname;
2639 int fd;
2641 CHECK_STRING (filename);
2642 absname = Fexpand_file_name (filename, Qnil);
2644 CHECK_STRING (string);
2646 /* If the file name has special constructs in it,
2647 call the corresponding file handler. */
2648 handler = Ffind_file_name_handler (absname, Qaccess_file);
2649 if (!NILP (handler))
2650 return call3 (handler, Qaccess_file, absname, string);
2652 encoded_filename = ENCODE_FILE (absname);
2654 fd = emacs_open (SDATA (encoded_filename), O_RDONLY, 0);
2655 if (fd < 0)
2656 report_file_error (SDATA (string), Fcons (filename, Qnil));
2657 emacs_close (fd);
2659 return Qnil;
2662 DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
2663 doc: /* Return non-nil if file FILENAME is the name of a symbolic link.
2664 The value is the link target, as a string.
2665 Otherwise it returns nil.
2667 This function returns t when given the name of a symlink that
2668 points to a nonexistent file. */)
2669 (filename)
2670 Lisp_Object filename;
2672 Lisp_Object handler;
2674 CHECK_STRING (filename);
2675 filename = Fexpand_file_name (filename, Qnil);
2677 /* If the file name has special constructs in it,
2678 call the corresponding file handler. */
2679 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
2680 if (!NILP (handler))
2681 return call2 (handler, Qfile_symlink_p, filename);
2683 #ifdef S_IFLNK
2685 char *buf;
2686 int bufsize;
2687 int valsize;
2688 Lisp_Object val;
2690 filename = ENCODE_FILE (filename);
2692 bufsize = 50;
2693 buf = NULL;
2696 bufsize *= 2;
2697 buf = (char *) xrealloc (buf, bufsize);
2698 bzero (buf, bufsize);
2700 errno = 0;
2701 valsize = readlink (SDATA (filename), buf, bufsize);
2702 if (valsize == -1)
2704 #ifdef ERANGE
2705 /* HP-UX reports ERANGE if buffer is too small. */
2706 if (errno == ERANGE)
2707 valsize = bufsize;
2708 else
2709 #endif
2711 xfree (buf);
2712 return Qnil;
2716 while (valsize >= bufsize);
2718 val = make_string (buf, valsize);
2719 if (buf[0] == '/' && index (buf, ':'))
2720 val = concat2 (build_string ("/:"), val);
2721 xfree (buf);
2722 val = DECODE_FILE (val);
2723 return val;
2725 #else /* not S_IFLNK */
2726 return Qnil;
2727 #endif /* not S_IFLNK */
2730 DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
2731 doc: /* Return t if FILENAME names an existing directory.
2732 Symbolic links to directories count as directories.
2733 See `file-symlink-p' to distinguish symlinks. */)
2734 (filename)
2735 Lisp_Object filename;
2737 register Lisp_Object absname;
2738 struct stat st;
2739 Lisp_Object handler;
2741 absname = expand_and_dir_to_file (filename, current_buffer->directory);
2743 /* If the file name has special constructs in it,
2744 call the corresponding file handler. */
2745 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
2746 if (!NILP (handler))
2747 return call2 (handler, Qfile_directory_p, absname);
2749 absname = ENCODE_FILE (absname);
2751 if (stat (SDATA (absname), &st) < 0)
2752 return Qnil;
2753 return (st.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
2756 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0,
2757 doc: /* Return t if file FILENAME names a directory you can open.
2758 For the value to be t, FILENAME must specify the name of a directory as a file,
2759 and the directory must allow you to open files in it. In order to use a
2760 directory as a buffer's current directory, this predicate must return true.
2761 A directory name spec may be given instead; then the value is t
2762 if the directory so specified exists and really is a readable and
2763 searchable directory. */)
2764 (filename)
2765 Lisp_Object filename;
2767 Lisp_Object handler;
2768 int tem;
2769 struct gcpro gcpro1;
2771 /* If the file name has special constructs in it,
2772 call the corresponding file handler. */
2773 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
2774 if (!NILP (handler))
2775 return call2 (handler, Qfile_accessible_directory_p, filename);
2777 GCPRO1 (filename);
2778 tem = (NILP (Ffile_directory_p (filename))
2779 || NILP (Ffile_executable_p (filename)));
2780 UNGCPRO;
2781 return tem ? Qnil : Qt;
2784 DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
2785 doc: /* Return t if FILENAME names a regular file.
2786 This is the sort of file that holds an ordinary stream of data bytes.
2787 Symbolic links to regular files count as regular files.
2788 See `file-symlink-p' to distinguish symlinks. */)
2789 (filename)
2790 Lisp_Object filename;
2792 register Lisp_Object absname;
2793 struct stat st;
2794 Lisp_Object handler;
2796 absname = expand_and_dir_to_file (filename, current_buffer->directory);
2798 /* If the file name has special constructs in it,
2799 call the corresponding file handler. */
2800 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
2801 if (!NILP (handler))
2802 return call2 (handler, Qfile_regular_p, absname);
2804 absname = ENCODE_FILE (absname);
2806 #ifdef WINDOWSNT
2808 int result;
2809 Lisp_Object tem = Vw32_get_true_file_attributes;
2811 /* Tell stat to use expensive method to get accurate info. */
2812 Vw32_get_true_file_attributes = Qt;
2813 result = stat (SDATA (absname), &st);
2814 Vw32_get_true_file_attributes = tem;
2816 if (result < 0)
2817 return Qnil;
2818 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
2820 #else
2821 if (stat (SDATA (absname), &st) < 0)
2822 return Qnil;
2823 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
2824 #endif
2827 DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
2828 doc: /* Return mode bits of file named FILENAME, as an integer.
2829 Return nil, if file does not exist or is not accessible. */)
2830 (filename)
2831 Lisp_Object filename;
2833 Lisp_Object absname;
2834 struct stat st;
2835 Lisp_Object handler;
2837 absname = expand_and_dir_to_file (filename, current_buffer->directory);
2839 /* If the file name has special constructs in it,
2840 call the corresponding file handler. */
2841 handler = Ffind_file_name_handler (absname, Qfile_modes);
2842 if (!NILP (handler))
2843 return call2 (handler, Qfile_modes, absname);
2845 absname = ENCODE_FILE (absname);
2847 if (stat (SDATA (absname), &st) < 0)
2848 return Qnil;
2849 #if defined (MSDOS) && __DJGPP__ < 2
2850 if (check_executable (SDATA (absname)))
2851 st.st_mode |= S_IEXEC;
2852 #endif /* MSDOS && __DJGPP__ < 2 */
2854 return make_number (st.st_mode & 07777);
2857 DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2,
2858 "(let ((file (read-file-name \"File: \"))) \
2859 (list file (read-file-modes nil file)))",
2860 doc: /* Set mode bits of file named FILENAME to MODE (an integer).
2861 Only the 12 low bits of MODE are used.
2863 Interactively, mode bits are read by `read-file-modes', which accepts
2864 symbolic notation, like the `chmod' command from GNU Coreutils. */)
2865 (filename, mode)
2866 Lisp_Object filename, mode;
2868 Lisp_Object absname, encoded_absname;
2869 Lisp_Object handler;
2871 absname = Fexpand_file_name (filename, current_buffer->directory);
2872 CHECK_NUMBER (mode);
2874 /* If the file name has special constructs in it,
2875 call the corresponding file handler. */
2876 handler = Ffind_file_name_handler (absname, Qset_file_modes);
2877 if (!NILP (handler))
2878 return call3 (handler, Qset_file_modes, absname, mode);
2880 encoded_absname = ENCODE_FILE (absname);
2882 if (chmod (SDATA (encoded_absname), XINT (mode)) < 0)
2883 report_file_error ("Doing chmod", Fcons (absname, Qnil));
2885 return Qnil;
2888 DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
2889 doc: /* Set the file permission bits for newly created files.
2890 The argument MODE should be an integer; only the low 9 bits are used.
2891 This setting is inherited by subprocesses. */)
2892 (mode)
2893 Lisp_Object mode;
2895 CHECK_NUMBER (mode);
2897 umask ((~ XINT (mode)) & 0777);
2899 return Qnil;
2902 DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
2903 doc: /* Return the default file protection for created files.
2904 The value is an integer. */)
2907 int realmask;
2908 Lisp_Object value;
2910 realmask = umask (0);
2911 umask (realmask);
2913 XSETINT (value, (~ realmask) & 0777);
2914 return value;
2917 extern int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
2919 DEFUN ("set-file-times", Fset_file_times, Sset_file_times, 1, 2, 0,
2920 doc: /* Set times of file FILENAME to TIME.
2921 Set both access and modification times.
2922 Return t on success, else nil.
2923 Use the current time if TIME is nil. TIME is in the format of
2924 `current-time'. */)
2925 (filename, time)
2926 Lisp_Object filename, time;
2928 Lisp_Object absname, encoded_absname;
2929 Lisp_Object handler;
2930 time_t sec;
2931 int usec;
2933 if (! lisp_time_argument (time, &sec, &usec))
2934 error ("Invalid time specification");
2936 absname = Fexpand_file_name (filename, current_buffer->directory);
2938 /* If the file name has special constructs in it,
2939 call the corresponding file handler. */
2940 handler = Ffind_file_name_handler (absname, Qset_file_times);
2941 if (!NILP (handler))
2942 return call3 (handler, Qset_file_times, absname, time);
2944 encoded_absname = ENCODE_FILE (absname);
2947 EMACS_TIME t;
2949 EMACS_SET_SECS (t, sec);
2950 EMACS_SET_USECS (t, usec);
2952 if (set_file_times (SDATA (encoded_absname), t, t))
2954 #ifdef DOS_NT
2955 struct stat st;
2957 /* Setting times on a directory always fails. */
2958 if (stat (SDATA (encoded_absname), &st) == 0
2959 && (st.st_mode & S_IFMT) == S_IFDIR)
2960 return Qnil;
2961 #endif
2962 report_file_error ("Setting file times", Fcons (absname, Qnil));
2963 return Qnil;
2967 return Qt;
2970 #ifdef HAVE_SYNC
2971 DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
2972 doc: /* Tell Unix to finish all pending disk updates. */)
2975 sync ();
2976 return Qnil;
2979 #endif /* HAVE_SYNC */
2981 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
2982 doc: /* Return t if file FILE1 is newer than file FILE2.
2983 If FILE1 does not exist, the answer is nil;
2984 otherwise, if FILE2 does not exist, the answer is t. */)
2985 (file1, file2)
2986 Lisp_Object file1, file2;
2988 Lisp_Object absname1, absname2;
2989 struct stat st;
2990 int mtime1;
2991 Lisp_Object handler;
2992 struct gcpro gcpro1, gcpro2;
2994 CHECK_STRING (file1);
2995 CHECK_STRING (file2);
2997 absname1 = Qnil;
2998 GCPRO2 (absname1, file2);
2999 absname1 = expand_and_dir_to_file (file1, current_buffer->directory);
3000 absname2 = expand_and_dir_to_file (file2, current_buffer->directory);
3001 UNGCPRO;
3003 /* If the file name has special constructs in it,
3004 call the corresponding file handler. */
3005 handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p);
3006 if (NILP (handler))
3007 handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p);
3008 if (!NILP (handler))
3009 return call3 (handler, Qfile_newer_than_file_p, absname1, absname2);
3011 GCPRO2 (absname1, absname2);
3012 absname1 = ENCODE_FILE (absname1);
3013 absname2 = ENCODE_FILE (absname2);
3014 UNGCPRO;
3016 if (stat (SDATA (absname1), &st) < 0)
3017 return Qnil;
3019 mtime1 = st.st_mtime;
3021 if (stat (SDATA (absname2), &st) < 0)
3022 return Qt;
3024 return (mtime1 > st.st_mtime) ? Qt : Qnil;
3027 #ifdef DOS_NT
3028 Lisp_Object Qfind_buffer_file_type;
3029 #endif /* DOS_NT */
3031 #ifndef READ_BUF_SIZE
3032 #define READ_BUF_SIZE (64 << 10)
3033 #endif
3035 extern void adjust_markers_for_delete P_ ((int, int, int, int));
3037 /* This function is called after Lisp functions to decide a coding
3038 system are called, or when they cause an error. Before they are
3039 called, the current buffer is set unibyte and it contains only a
3040 newly inserted text (thus the buffer was empty before the
3041 insertion).
3043 The functions may set markers, overlays, text properties, or even
3044 alter the buffer contents, change the current buffer.
3046 Here, we reset all those changes by:
3047 o set back the current buffer.
3048 o move all markers and overlays to BEG.
3049 o remove all text properties.
3050 o set back the buffer multibyteness. */
3052 static Lisp_Object
3053 decide_coding_unwind (unwind_data)
3054 Lisp_Object unwind_data;
3056 Lisp_Object multibyte, undo_list, buffer;
3058 multibyte = XCAR (unwind_data);
3059 unwind_data = XCDR (unwind_data);
3060 undo_list = XCAR (unwind_data);
3061 buffer = XCDR (unwind_data);
3063 if (current_buffer != XBUFFER (buffer))
3064 set_buffer_internal (XBUFFER (buffer));
3065 adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE);
3066 adjust_overlays_for_delete (BEG, Z - BEG);
3067 BUF_INTERVALS (current_buffer) = 0;
3068 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3070 /* Now we are safe to change the buffer's multibyteness directly. */
3071 current_buffer->enable_multibyte_characters = multibyte;
3072 current_buffer->undo_list = undo_list;
3074 return Qnil;
3078 /* Used to pass values from insert-file-contents to read_non_regular. */
3080 static int non_regular_fd;
3081 static int non_regular_inserted;
3082 static int non_regular_nbytes;
3085 /* Read from a non-regular file.
3086 Read non_regular_trytry bytes max from non_regular_fd.
3087 Non_regular_inserted specifies where to put the read bytes.
3088 Value is the number of bytes read. */
3090 static Lisp_Object
3091 read_non_regular ()
3093 int nbytes;
3095 immediate_quit = 1;
3096 QUIT;
3097 nbytes = emacs_read (non_regular_fd,
3098 BEG_ADDR + PT_BYTE - BEG_BYTE + non_regular_inserted,
3099 non_regular_nbytes);
3100 immediate_quit = 0;
3101 return make_number (nbytes);
3105 /* Condition-case handler used when reading from non-regular files
3106 in insert-file-contents. */
3108 static Lisp_Object
3109 read_non_regular_quit ()
3111 return Qnil;
3115 DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3116 1, 5, 0,
3117 doc: /* Insert contents of file FILENAME after point.
3118 Returns list of absolute file name and number of characters inserted.
3119 If second argument VISIT is non-nil, the buffer's visited filename and
3120 last save file modtime are set, and it is marked unmodified. If
3121 visiting and the file does not exist, visiting is completed before the
3122 error is signaled.
3124 The optional third and fourth arguments BEG and END specify what portion
3125 of the file to insert. These arguments count bytes in the file, not
3126 characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3128 If optional fifth argument REPLACE is non-nil, replace the current
3129 buffer contents (in the accessible portion) with the file contents.
3130 This is better than simply deleting and inserting the whole thing
3131 because (1) it preserves some marker positions and (2) it puts less data
3132 in the undo list. When REPLACE is non-nil, the second return value is
3133 the number of characters that replace previous buffer contents.
3135 This function does code conversion according to the value of
3136 `coding-system-for-read' or `file-coding-system-alist', and sets the
3137 variable `last-coding-system-used' to the coding system actually used. */)
3138 (filename, visit, beg, end, replace)
3139 Lisp_Object filename, visit, beg, end, replace;
3141 struct stat st;
3142 register int fd;
3143 int inserted = 0;
3144 int nochange = 0;
3145 register int how_much;
3146 register int unprocessed;
3147 int count = SPECPDL_INDEX ();
3148 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
3149 Lisp_Object handler, val, insval, orig_filename, old_undo;
3150 Lisp_Object p;
3151 int total = 0;
3152 int not_regular = 0;
3153 unsigned char read_buf[READ_BUF_SIZE];
3154 struct coding_system coding;
3155 unsigned char buffer[1 << 14];
3156 int replace_handled = 0;
3157 int set_coding_system = 0;
3158 Lisp_Object coding_system;
3159 int read_quit = 0;
3160 Lisp_Object old_Vdeactivate_mark = Vdeactivate_mark;
3161 int we_locked_file = 0;
3162 int deferred_remove_unwind_protect = 0;
3164 if (current_buffer->base_buffer && ! NILP (visit))
3165 error ("Cannot do file visiting in an indirect buffer");
3167 if (!NILP (current_buffer->read_only))
3168 Fbarf_if_buffer_read_only ();
3170 val = Qnil;
3171 p = Qnil;
3172 orig_filename = Qnil;
3173 old_undo = Qnil;
3175 GCPRO5 (filename, val, p, orig_filename, old_undo);
3177 CHECK_STRING (filename);
3178 filename = Fexpand_file_name (filename, Qnil);
3180 /* The value Qnil means that the coding system is not yet
3181 decided. */
3182 coding_system = Qnil;
3184 /* If the file name has special constructs in it,
3185 call the corresponding file handler. */
3186 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
3187 if (!NILP (handler))
3189 val = call6 (handler, Qinsert_file_contents, filename,
3190 visit, beg, end, replace);
3191 if (CONSP (val) && CONSP (XCDR (val)))
3192 inserted = XINT (XCAR (XCDR (val)));
3193 goto handled;
3196 orig_filename = filename;
3197 filename = ENCODE_FILE (filename);
3199 fd = -1;
3201 #ifdef WINDOWSNT
3203 Lisp_Object tem = Vw32_get_true_file_attributes;
3205 /* Tell stat to use expensive method to get accurate info. */
3206 Vw32_get_true_file_attributes = Qt;
3207 total = stat (SDATA (filename), &st);
3208 Vw32_get_true_file_attributes = tem;
3210 if (total < 0)
3211 #else
3212 if (stat (SDATA (filename), &st) < 0)
3213 #endif /* WINDOWSNT */
3215 if (fd >= 0) emacs_close (fd);
3216 badopen:
3217 if (NILP (visit))
3218 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3219 st.st_mtime = -1;
3220 how_much = 0;
3221 if (!NILP (Vcoding_system_for_read))
3222 Fset (Qbuffer_file_coding_system, Vcoding_system_for_read);
3223 goto notfound;
3226 #ifdef S_IFREG
3227 /* This code will need to be changed in order to work on named
3228 pipes, and it's probably just not worth it. So we should at
3229 least signal an error. */
3230 if (!S_ISREG (st.st_mode))
3232 not_regular = 1;
3234 if (! NILP (visit))
3235 goto notfound;
3237 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
3238 xsignal2 (Qfile_error,
3239 build_string ("not a regular file"), orig_filename);
3241 #endif
3243 if (fd < 0)
3244 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0)
3245 goto badopen;
3247 /* Replacement should preserve point as it preserves markers. */
3248 if (!NILP (replace))
3249 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3251 record_unwind_protect (close_file_unwind, make_number (fd));
3253 /* Can happen on any platform that uses long as type of off_t, but allows
3254 file sizes to exceed 2Gb, so give a suitable message. */
3255 if (! not_regular && st.st_size < 0)
3256 error ("Maximum buffer size exceeded");
3258 /* Prevent redisplay optimizations. */
3259 current_buffer->clip_changed = 1;
3261 if (!NILP (visit))
3263 if (!NILP (beg) || !NILP (end))
3264 error ("Attempt to visit less than an entire file");
3265 if (BEG < Z && NILP (replace))
3266 error ("Cannot do file visiting in a non-empty buffer");
3269 if (!NILP (beg))
3270 CHECK_NUMBER (beg);
3271 else
3272 XSETFASTINT (beg, 0);
3274 if (!NILP (end))
3275 CHECK_NUMBER (end);
3276 else
3278 if (! not_regular)
3280 XSETINT (end, st.st_size);
3282 /* Arithmetic overflow can occur if an Emacs integer cannot
3283 represent the file size, or if the calculations below
3284 overflow. The calculations below double the file size
3285 twice, so check that it can be multiplied by 4 safely. */
3286 if (XINT (end) != st.st_size
3287 || st.st_size > INT_MAX / 4)
3288 error ("Maximum buffer size exceeded");
3290 /* The file size returned from stat may be zero, but data
3291 may be readable nonetheless, for example when this is a
3292 file in the /proc filesystem. */
3293 if (st.st_size == 0)
3294 XSETINT (end, READ_BUF_SIZE);
3298 if (EQ (Vcoding_system_for_read, Qauto_save_coding))
3300 coding_system = coding_inherit_eol_type (Qutf_8_emacs, Qunix);
3301 setup_coding_system (coding_system, &coding);
3302 /* Ensure we set Vlast_coding_system_used. */
3303 set_coding_system = 1;
3305 else if (BEG < Z)
3307 /* Decide the coding system to use for reading the file now
3308 because we can't use an optimized method for handling
3309 `coding:' tag if the current buffer is not empty. */
3310 if (!NILP (Vcoding_system_for_read))
3311 coding_system = Vcoding_system_for_read;
3312 else
3314 /* Don't try looking inside a file for a coding system
3315 specification if it is not seekable. */
3316 if (! not_regular && ! NILP (Vset_auto_coding_function))
3318 /* Find a coding system specified in the heading two
3319 lines or in the tailing several lines of the file.
3320 We assume that the 1K-byte and 3K-byte for heading
3321 and tailing respectively are sufficient for this
3322 purpose. */
3323 int nread;
3325 if (st.st_size <= (1024 * 4))
3326 nread = emacs_read (fd, read_buf, 1024 * 4);
3327 else
3329 nread = emacs_read (fd, read_buf, 1024);
3330 if (nread >= 0)
3332 if (lseek (fd, st.st_size - (1024 * 3), 0) < 0)
3333 report_file_error ("Setting file position",
3334 Fcons (orig_filename, Qnil));
3335 nread += emacs_read (fd, read_buf + nread, 1024 * 3);
3339 if (nread < 0)
3340 error ("IO error reading %s: %s",
3341 SDATA (orig_filename), emacs_strerror (errno));
3342 else if (nread > 0)
3344 struct buffer *prev = current_buffer;
3345 Lisp_Object buffer;
3346 struct buffer *buf;
3348 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3350 buffer = Fget_buffer_create (build_string (" *code-converting-work*"));
3351 buf = XBUFFER (buffer);
3353 delete_all_overlays (buf);
3354 buf->directory = current_buffer->directory;
3355 buf->read_only = Qnil;
3356 buf->filename = Qnil;
3357 buf->undo_list = Qt;
3358 eassert (buf->overlays_before == NULL);
3359 eassert (buf->overlays_after == NULL);
3361 set_buffer_internal (buf);
3362 Ferase_buffer ();
3363 buf->enable_multibyte_characters = Qnil;
3365 insert_1_both (read_buf, nread, nread, 0, 0, 0);
3366 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3367 coding_system = call2 (Vset_auto_coding_function,
3368 filename, make_number (nread));
3369 set_buffer_internal (prev);
3371 /* Discard the unwind protect for recovering the
3372 current buffer. */
3373 specpdl_ptr--;
3375 /* Rewind the file for the actual read done later. */
3376 if (lseek (fd, 0, 0) < 0)
3377 report_file_error ("Setting file position",
3378 Fcons (orig_filename, Qnil));
3382 if (NILP (coding_system))
3384 /* If we have not yet decided a coding system, check
3385 file-coding-system-alist. */
3386 Lisp_Object args[6];
3388 args[0] = Qinsert_file_contents, args[1] = orig_filename;
3389 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
3390 coding_system = Ffind_operation_coding_system (6, args);
3391 if (CONSP (coding_system))
3392 coding_system = XCAR (coding_system);
3396 if (NILP (coding_system))
3397 coding_system = Qundecided;
3398 else
3399 CHECK_CODING_SYSTEM (coding_system);
3401 if (NILP (current_buffer->enable_multibyte_characters))
3402 /* We must suppress all character code conversion except for
3403 end-of-line conversion. */
3404 coding_system = raw_text_coding_system (coding_system);
3406 setup_coding_system (coding_system, &coding);
3407 /* Ensure we set Vlast_coding_system_used. */
3408 set_coding_system = 1;
3411 /* If requested, replace the accessible part of the buffer
3412 with the file contents. Avoid replacing text at the
3413 beginning or end of the buffer that matches the file contents;
3414 that preserves markers pointing to the unchanged parts.
3416 Here we implement this feature in an optimized way
3417 for the case where code conversion is NOT needed.
3418 The following if-statement handles the case of conversion
3419 in a less optimal way.
3421 If the code conversion is "automatic" then we try using this
3422 method and hope for the best.
3423 But if we discover the need for conversion, we give up on this method
3424 and let the following if-statement handle the replace job. */
3425 if (!NILP (replace)
3426 && BEGV < ZV
3427 && (NILP (coding_system)
3428 || ! CODING_REQUIRE_DECODING (&coding)))
3430 /* same_at_start and same_at_end count bytes,
3431 because file access counts bytes
3432 and BEG and END count bytes. */
3433 int same_at_start = BEGV_BYTE;
3434 int same_at_end = ZV_BYTE;
3435 int overlap;
3436 /* There is still a possibility we will find the need to do code
3437 conversion. If that happens, we set this variable to 1 to
3438 give up on handling REPLACE in the optimized way. */
3439 int giveup_match_end = 0;
3441 if (XINT (beg) != 0)
3443 if (lseek (fd, XINT (beg), 0) < 0)
3444 report_file_error ("Setting file position",
3445 Fcons (orig_filename, Qnil));
3448 immediate_quit = 1;
3449 QUIT;
3450 /* Count how many chars at the start of the file
3451 match the text at the beginning of the buffer. */
3452 while (1)
3454 int nread, bufpos;
3456 nread = emacs_read (fd, buffer, sizeof buffer);
3457 if (nread < 0)
3458 error ("IO error reading %s: %s",
3459 SDATA (orig_filename), emacs_strerror (errno));
3460 else if (nread == 0)
3461 break;
3463 if (CODING_REQUIRE_DETECTION (&coding))
3465 coding_system = detect_coding_system (buffer, nread, nread, 1, 0,
3466 coding_system);
3467 setup_coding_system (coding_system, &coding);
3470 if (CODING_REQUIRE_DECODING (&coding))
3471 /* We found that the file should be decoded somehow.
3472 Let's give up here. */
3474 giveup_match_end = 1;
3475 break;
3478 bufpos = 0;
3479 while (bufpos < nread && same_at_start < ZV_BYTE
3480 && FETCH_BYTE (same_at_start) == buffer[bufpos])
3481 same_at_start++, bufpos++;
3482 /* If we found a discrepancy, stop the scan.
3483 Otherwise loop around and scan the next bufferful. */
3484 if (bufpos != nread)
3485 break;
3487 immediate_quit = 0;
3488 /* If the file matches the buffer completely,
3489 there's no need to replace anything. */
3490 if (same_at_start - BEGV_BYTE == XINT (end))
3492 emacs_close (fd);
3493 specpdl_ptr--;
3494 /* Truncate the buffer to the size of the file. */
3495 del_range_1 (same_at_start, same_at_end, 0, 0);
3496 goto handled;
3498 immediate_quit = 1;
3499 QUIT;
3500 /* Count how many chars at the end of the file
3501 match the text at the end of the buffer. But, if we have
3502 already found that decoding is necessary, don't waste time. */
3503 while (!giveup_match_end)
3505 int total_read, nread, bufpos, curpos, trial;
3507 /* At what file position are we now scanning? */
3508 curpos = XINT (end) - (ZV_BYTE - same_at_end);
3509 /* If the entire file matches the buffer tail, stop the scan. */
3510 if (curpos == 0)
3511 break;
3512 /* How much can we scan in the next step? */
3513 trial = min (curpos, sizeof buffer);
3514 if (lseek (fd, curpos - trial, 0) < 0)
3515 report_file_error ("Setting file position",
3516 Fcons (orig_filename, Qnil));
3518 total_read = nread = 0;
3519 while (total_read < trial)
3521 nread = emacs_read (fd, buffer + total_read, trial - total_read);
3522 if (nread < 0)
3523 error ("IO error reading %s: %s",
3524 SDATA (orig_filename), emacs_strerror (errno));
3525 else if (nread == 0)
3526 break;
3527 total_read += nread;
3530 /* Scan this bufferful from the end, comparing with
3531 the Emacs buffer. */
3532 bufpos = total_read;
3534 /* Compare with same_at_start to avoid counting some buffer text
3535 as matching both at the file's beginning and at the end. */
3536 while (bufpos > 0 && same_at_end > same_at_start
3537 && FETCH_BYTE (same_at_end - 1) == buffer[bufpos - 1])
3538 same_at_end--, bufpos--;
3540 /* If we found a discrepancy, stop the scan.
3541 Otherwise loop around and scan the preceding bufferful. */
3542 if (bufpos != 0)
3544 /* If this discrepancy is because of code conversion,
3545 we cannot use this method; giveup and try the other. */
3546 if (same_at_end > same_at_start
3547 && FETCH_BYTE (same_at_end - 1) >= 0200
3548 && ! NILP (current_buffer->enable_multibyte_characters)
3549 && (CODING_MAY_REQUIRE_DECODING (&coding)))
3550 giveup_match_end = 1;
3551 break;
3554 if (nread == 0)
3555 break;
3557 immediate_quit = 0;
3559 if (! giveup_match_end)
3561 int temp;
3563 /* We win! We can handle REPLACE the optimized way. */
3565 /* Extend the start of non-matching text area to multibyte
3566 character boundary. */
3567 if (! NILP (current_buffer->enable_multibyte_characters))
3568 while (same_at_start > BEGV_BYTE
3569 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
3570 same_at_start--;
3572 /* Extend the end of non-matching text area to multibyte
3573 character boundary. */
3574 if (! NILP (current_buffer->enable_multibyte_characters))
3575 while (same_at_end < ZV_BYTE
3576 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
3577 same_at_end++;
3579 /* Don't try to reuse the same piece of text twice. */
3580 overlap = (same_at_start - BEGV_BYTE
3581 - (same_at_end + st.st_size - ZV));
3582 if (overlap > 0)
3583 same_at_end += overlap;
3585 /* Arrange to read only the nonmatching middle part of the file. */
3586 XSETFASTINT (beg, XINT (beg) + (same_at_start - BEGV_BYTE));
3587 XSETFASTINT (end, XINT (end) - (ZV_BYTE - same_at_end));
3589 del_range_byte (same_at_start, same_at_end, 0);
3590 /* Insert from the file at the proper position. */
3591 temp = BYTE_TO_CHAR (same_at_start);
3592 SET_PT_BOTH (temp, same_at_start);
3594 /* If display currently starts at beginning of line,
3595 keep it that way. */
3596 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
3597 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
3599 replace_handled = 1;
3603 /* If requested, replace the accessible part of the buffer
3604 with the file contents. Avoid replacing text at the
3605 beginning or end of the buffer that matches the file contents;
3606 that preserves markers pointing to the unchanged parts.
3608 Here we implement this feature for the case where code conversion
3609 is needed, in a simple way that needs a lot of memory.
3610 The preceding if-statement handles the case of no conversion
3611 in a more optimized way. */
3612 if (!NILP (replace) && ! replace_handled && BEGV < ZV)
3614 EMACS_INT same_at_start = BEGV_BYTE;
3615 EMACS_INT same_at_end = ZV_BYTE;
3616 EMACS_INT same_at_start_charpos;
3617 EMACS_INT inserted_chars;
3618 EMACS_INT overlap;
3619 EMACS_INT bufpos;
3620 unsigned char *decoded;
3621 int temp;
3622 int this_count = SPECPDL_INDEX ();
3623 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
3624 Lisp_Object conversion_buffer;
3626 conversion_buffer = code_conversion_save (1, multibyte);
3628 /* First read the whole file, performing code conversion into
3629 CONVERSION_BUFFER. */
3631 if (lseek (fd, XINT (beg), 0) < 0)
3632 report_file_error ("Setting file position",
3633 Fcons (orig_filename, Qnil));
3635 total = st.st_size; /* Total bytes in the file. */
3636 how_much = 0; /* Bytes read from file so far. */
3637 inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */
3638 unprocessed = 0; /* Bytes not processed in previous loop. */
3640 GCPRO1 (conversion_buffer);
3641 while (how_much < total)
3643 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3644 quitting while reading a huge while. */
3645 /* try is reserved in some compilers (Microsoft C) */
3646 int trytry = min (total - how_much, READ_BUF_SIZE - unprocessed);
3647 int this;
3649 /* Allow quitting out of the actual I/O. */
3650 immediate_quit = 1;
3651 QUIT;
3652 this = emacs_read (fd, read_buf + unprocessed, trytry);
3653 immediate_quit = 0;
3655 if (this <= 0)
3657 if (this < 0)
3658 how_much = this;
3659 break;
3662 how_much += this;
3664 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer),
3665 BUF_Z (XBUFFER (conversion_buffer)));
3666 decode_coding_c_string (&coding, read_buf, unprocessed + this,
3667 conversion_buffer);
3668 unprocessed = coding.carryover_bytes;
3669 if (coding.carryover_bytes > 0)
3670 bcopy (coding.carryover, read_buf, unprocessed);
3672 UNGCPRO;
3673 emacs_close (fd);
3675 /* We should remove the unwind_protect calling
3676 close_file_unwind, but other stuff has been added the stack,
3677 so defer the removal till we reach the `handled' label. */
3678 deferred_remove_unwind_protect = 1;
3680 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3681 if we couldn't read the file. */
3683 if (how_much < 0)
3684 error ("IO error reading %s: %s",
3685 SDATA (orig_filename), emacs_strerror (errno));
3687 if (unprocessed > 0)
3689 coding.mode |= CODING_MODE_LAST_BLOCK;
3690 decode_coding_c_string (&coding, read_buf, unprocessed,
3691 conversion_buffer);
3692 coding.mode &= ~CODING_MODE_LAST_BLOCK;
3695 coding_system = CODING_ID_NAME (coding.id);
3696 decoded = BUF_BEG_ADDR (XBUFFER (conversion_buffer));
3697 inserted = (BUF_Z_BYTE (XBUFFER (conversion_buffer))
3698 - BUF_BEG_BYTE (XBUFFER (conversion_buffer)));
3700 /* Compare the beginning of the converted string with the buffer
3701 text. */
3703 bufpos = 0;
3704 while (bufpos < inserted && same_at_start < same_at_end
3705 && FETCH_BYTE (same_at_start) == decoded[bufpos])
3706 same_at_start++, bufpos++;
3708 /* If the file matches the head of buffer completely,
3709 there's no need to replace anything. */
3711 if (bufpos == inserted)
3713 /* Truncate the buffer to the size of the file. */
3714 if (same_at_start == same_at_end)
3715 nochange = 1;
3716 else
3717 del_range_byte (same_at_start, same_at_end, 0);
3718 inserted = 0;
3720 unbind_to (this_count, Qnil);
3721 goto handled;
3724 /* Extend the start of non-matching text area to the previous
3725 multibyte character boundary. */
3726 if (! NILP (current_buffer->enable_multibyte_characters))
3727 while (same_at_start > BEGV_BYTE
3728 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
3729 same_at_start--;
3731 /* Scan this bufferful from the end, comparing with
3732 the Emacs buffer. */
3733 bufpos = inserted;
3735 /* Compare with same_at_start to avoid counting some buffer text
3736 as matching both at the file's beginning and at the end. */
3737 while (bufpos > 0 && same_at_end > same_at_start
3738 && FETCH_BYTE (same_at_end - 1) == decoded[bufpos - 1])
3739 same_at_end--, bufpos--;
3741 /* Extend the end of non-matching text area to the next
3742 multibyte character boundary. */
3743 if (! NILP (current_buffer->enable_multibyte_characters))
3744 while (same_at_end < ZV_BYTE
3745 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
3746 same_at_end++;
3748 /* Don't try to reuse the same piece of text twice. */
3749 overlap = same_at_start - BEGV_BYTE - (same_at_end + inserted - ZV_BYTE);
3750 if (overlap > 0)
3751 same_at_end += overlap;
3753 /* If display currently starts at beginning of line,
3754 keep it that way. */
3755 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
3756 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
3758 /* Replace the chars that we need to replace,
3759 and update INSERTED to equal the number of bytes
3760 we are taking from the decoded string. */
3761 inserted -= (ZV_BYTE - same_at_end) + (same_at_start - BEGV_BYTE);
3763 if (same_at_end != same_at_start)
3765 del_range_byte (same_at_start, same_at_end, 0);
3766 temp = GPT;
3767 same_at_start = GPT_BYTE;
3769 else
3771 temp = BYTE_TO_CHAR (same_at_start);
3773 /* Insert from the file at the proper position. */
3774 SET_PT_BOTH (temp, same_at_start);
3775 same_at_start_charpos
3776 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer),
3777 same_at_start - BEGV_BYTE
3778 + BUF_BEG_BYTE (XBUFFER (conversion_buffer)));
3779 inserted_chars
3780 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer),
3781 same_at_start + inserted - BEGV_BYTE
3782 + BUF_BEG_BYTE (XBUFFER (conversion_buffer)))
3783 - same_at_start_charpos);
3784 /* This binding is to avoid ask-user-about-supersession-threat
3785 being called in insert_from_buffer (via in
3786 prepare_to_modify_buffer). */
3787 specbind (intern ("buffer-file-name"), Qnil);
3788 insert_from_buffer (XBUFFER (conversion_buffer),
3789 same_at_start_charpos, inserted_chars, 0);
3790 /* Set `inserted' to the number of inserted characters. */
3791 inserted = PT - temp;
3792 /* Set point before the inserted characters. */
3793 SET_PT_BOTH (temp, same_at_start);
3795 unbind_to (this_count, Qnil);
3797 goto handled;
3800 if (! not_regular)
3802 register Lisp_Object temp;
3804 total = XINT (end) - XINT (beg);
3806 /* Make sure point-max won't overflow after this insertion. */
3807 XSETINT (temp, total);
3808 if (total != XINT (temp))
3809 error ("Maximum buffer size exceeded");
3811 else
3812 /* For a special file, all we can do is guess. */
3813 total = READ_BUF_SIZE;
3815 if (NILP (visit) && inserted > 0)
3817 #ifdef CLASH_DETECTION
3818 if (!NILP (current_buffer->file_truename)
3819 /* Make binding buffer-file-name to nil effective. */
3820 && !NILP (current_buffer->filename)
3821 && SAVE_MODIFF >= MODIFF)
3822 we_locked_file = 1;
3823 #endif /* CLASH_DETECTION */
3824 prepare_to_modify_buffer (GPT, GPT, NULL);
3827 move_gap (PT);
3828 if (GAP_SIZE < total)
3829 make_gap (total - GAP_SIZE);
3831 if (XINT (beg) != 0 || !NILP (replace))
3833 if (lseek (fd, XINT (beg), 0) < 0)
3834 report_file_error ("Setting file position",
3835 Fcons (orig_filename, Qnil));
3838 /* In the following loop, HOW_MUCH contains the total bytes read so
3839 far for a regular file, and not changed for a special file. But,
3840 before exiting the loop, it is set to a negative value if I/O
3841 error occurs. */
3842 how_much = 0;
3844 /* Total bytes inserted. */
3845 inserted = 0;
3847 /* Here, we don't do code conversion in the loop. It is done by
3848 decode_coding_gap after all data are read into the buffer. */
3850 int gap_size = GAP_SIZE;
3852 while (how_much < total)
3854 /* try is reserved in some compilers (Microsoft C) */
3855 int trytry = min (total - how_much, READ_BUF_SIZE);
3856 int this;
3858 if (not_regular)
3860 Lisp_Object val;
3862 /* Maybe make more room. */
3863 if (gap_size < trytry)
3865 make_gap (total - gap_size);
3866 gap_size = GAP_SIZE;
3869 /* Read from the file, capturing `quit'. When an
3870 error occurs, end the loop, and arrange for a quit
3871 to be signaled after decoding the text we read. */
3872 non_regular_fd = fd;
3873 non_regular_inserted = inserted;
3874 non_regular_nbytes = trytry;
3875 val = internal_condition_case_1 (read_non_regular, Qnil, Qerror,
3876 read_non_regular_quit);
3877 if (NILP (val))
3879 read_quit = 1;
3880 break;
3883 this = XINT (val);
3885 else
3887 /* Allow quitting out of the actual I/O. We don't make text
3888 part of the buffer until all the reading is done, so a C-g
3889 here doesn't do any harm. */
3890 immediate_quit = 1;
3891 QUIT;
3892 this = emacs_read (fd, BEG_ADDR + PT_BYTE - BEG_BYTE + inserted, trytry);
3893 immediate_quit = 0;
3896 if (this <= 0)
3898 how_much = this;
3899 break;
3902 gap_size -= this;
3904 /* For a regular file, where TOTAL is the real size,
3905 count HOW_MUCH to compare with it.
3906 For a special file, where TOTAL is just a buffer size,
3907 so don't bother counting in HOW_MUCH.
3908 (INSERTED is where we count the number of characters inserted.) */
3909 if (! not_regular)
3910 how_much += this;
3911 inserted += this;
3915 /* Now we have read all the file data into the gap.
3916 If it was empty, undo marking the buffer modified. */
3918 if (inserted == 0)
3920 #ifdef CLASH_DETECTION
3921 if (we_locked_file)
3922 unlock_file (current_buffer->file_truename);
3923 #endif
3924 Vdeactivate_mark = old_Vdeactivate_mark;
3926 else
3927 Vdeactivate_mark = Qt;
3929 /* Make the text read part of the buffer. */
3930 GAP_SIZE -= inserted;
3931 GPT += inserted;
3932 GPT_BYTE += inserted;
3933 ZV += inserted;
3934 ZV_BYTE += inserted;
3935 Z += inserted;
3936 Z_BYTE += inserted;
3938 if (GAP_SIZE > 0)
3939 /* Put an anchor to ensure multi-byte form ends at gap. */
3940 *GPT_ADDR = 0;
3942 emacs_close (fd);
3944 /* Discard the unwind protect for closing the file. */
3945 specpdl_ptr--;
3947 if (how_much < 0)
3948 error ("IO error reading %s: %s",
3949 SDATA (orig_filename), emacs_strerror (errno));
3951 notfound:
3953 if (NILP (coding_system))
3955 /* The coding system is not yet decided. Decide it by an
3956 optimized method for handling `coding:' tag.
3958 Note that we can get here only if the buffer was empty
3959 before the insertion. */
3961 if (!NILP (Vcoding_system_for_read))
3962 coding_system = Vcoding_system_for_read;
3963 else
3965 /* Since we are sure that the current buffer was empty
3966 before the insertion, we can toggle
3967 enable-multibyte-characters directly here without taking
3968 care of marker adjustment. By this way, we can run Lisp
3969 program safely before decoding the inserted text. */
3970 Lisp_Object unwind_data;
3971 int count = SPECPDL_INDEX ();
3973 unwind_data = Fcons (current_buffer->enable_multibyte_characters,
3974 Fcons (current_buffer->undo_list,
3975 Fcurrent_buffer ()));
3976 current_buffer->enable_multibyte_characters = Qnil;
3977 current_buffer->undo_list = Qt;
3978 record_unwind_protect (decide_coding_unwind, unwind_data);
3980 if (inserted > 0 && ! NILP (Vset_auto_coding_function))
3982 coding_system = call2 (Vset_auto_coding_function,
3983 filename, make_number (inserted));
3986 if (NILP (coding_system))
3988 /* If the coding system is not yet decided, check
3989 file-coding-system-alist. */
3990 Lisp_Object args[6];
3992 args[0] = Qinsert_file_contents, args[1] = orig_filename;
3993 args[2] = visit, args[3] = beg, args[4] = end, args[5] = Qnil;
3994 coding_system = Ffind_operation_coding_system (6, args);
3995 if (CONSP (coding_system))
3996 coding_system = XCAR (coding_system);
3998 unbind_to (count, Qnil);
3999 inserted = Z_BYTE - BEG_BYTE;
4002 if (NILP (coding_system))
4003 coding_system = Qundecided;
4004 else
4005 CHECK_CODING_SYSTEM (coding_system);
4007 if (NILP (current_buffer->enable_multibyte_characters))
4008 /* We must suppress all character code conversion except for
4009 end-of-line conversion. */
4010 coding_system = raw_text_coding_system (coding_system);
4011 setup_coding_system (coding_system, &coding);
4012 /* Ensure we set Vlast_coding_system_used. */
4013 set_coding_system = 1;
4016 if (!NILP (visit))
4018 /* When we visit a file by raw-text, we change the buffer to
4019 unibyte. */
4020 if (CODING_FOR_UNIBYTE (&coding)
4021 /* Can't do this if part of the buffer might be preserved. */
4022 && NILP (replace))
4023 /* Visiting a file with these coding system makes the buffer
4024 unibyte. */
4025 current_buffer->enable_multibyte_characters = Qnil;
4028 coding.dst_multibyte = ! NILP (current_buffer->enable_multibyte_characters);
4029 if (CODING_MAY_REQUIRE_DECODING (&coding)
4030 && (inserted > 0 || CODING_REQUIRE_FLUSHING (&coding)))
4032 move_gap_both (PT, PT_BYTE);
4033 GAP_SIZE += inserted;
4034 ZV_BYTE -= inserted;
4035 Z_BYTE -= inserted;
4036 ZV -= inserted;
4037 Z -= inserted;
4038 decode_coding_gap (&coding, inserted, inserted);
4039 inserted = coding.produced_char;
4040 coding_system = CODING_ID_NAME (coding.id);
4042 else if (inserted > 0)
4043 adjust_after_insert (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4044 inserted);
4046 /* Now INSERTED is measured in characters. */
4048 #ifdef DOS_NT
4049 /* Use the conversion type to determine buffer-file-type
4050 (find-buffer-file-type is now used to help determine the
4051 conversion). */
4052 if ((VECTORP (CODING_ID_EOL_TYPE (coding.id))
4053 || EQ (CODING_ID_EOL_TYPE (coding.id), Qunix))
4054 && ! CODING_REQUIRE_DECODING (&coding))
4055 current_buffer->buffer_file_type = Qt;
4056 else
4057 current_buffer->buffer_file_type = Qnil;
4058 #endif
4060 handled:
4062 if (deferred_remove_unwind_protect)
4063 /* If requested above, discard the unwind protect for closing the
4064 file. */
4065 specpdl_ptr--;
4067 if (!NILP (visit))
4069 if (!EQ (current_buffer->undo_list, Qt) && !nochange)
4070 current_buffer->undo_list = Qnil;
4072 if (NILP (handler))
4074 current_buffer->modtime = st.st_mtime;
4075 current_buffer->filename = orig_filename;
4078 SAVE_MODIFF = MODIFF;
4079 current_buffer->auto_save_modified = MODIFF;
4080 XSETFASTINT (current_buffer->save_length, Z - BEG);
4081 #ifdef CLASH_DETECTION
4082 if (NILP (handler))
4084 if (!NILP (current_buffer->file_truename))
4085 unlock_file (current_buffer->file_truename);
4086 unlock_file (filename);
4088 #endif /* CLASH_DETECTION */
4089 if (not_regular)
4090 xsignal2 (Qfile_error,
4091 build_string ("not a regular file"), orig_filename);
4094 if (set_coding_system)
4095 Vlast_coding_system_used = coding_system;
4097 if (! NILP (Ffboundp (Qafter_insert_file_set_coding)))
4099 insval = call2 (Qafter_insert_file_set_coding, make_number (inserted),
4100 visit);
4101 if (! NILP (insval))
4103 CHECK_NUMBER (insval);
4104 inserted = XFASTINT (insval);
4108 /* Decode file format. */
4109 if (inserted > 0)
4111 /* Don't run point motion or modification hooks when decoding. */
4112 int count = SPECPDL_INDEX ();
4113 int old_inserted = inserted;
4114 specbind (Qinhibit_point_motion_hooks, Qt);
4115 specbind (Qinhibit_modification_hooks, Qt);
4117 /* Save old undo list and don't record undo for decoding. */
4118 old_undo = current_buffer->undo_list;
4119 current_buffer->undo_list = Qt;
4121 if (NILP (replace))
4123 insval = call3 (Qformat_decode,
4124 Qnil, make_number (inserted), visit);
4125 CHECK_NUMBER (insval);
4126 inserted = XFASTINT (insval);
4128 else
4130 /* If REPLACE is non-nil and we succeeded in not replacing the
4131 beginning or end of the buffer text with the file's contents,
4132 call format-decode with `point' positioned at the beginning
4133 of the buffer and `inserted' equalling the number of
4134 characters in the buffer. Otherwise, format-decode might
4135 fail to correctly analyze the beginning or end of the buffer.
4136 Hence we temporarily save `point' and `inserted' here and
4137 restore `point' iff format-decode did not insert or delete
4138 any text. Otherwise we leave `point' at point-min. */
4139 int opoint = PT;
4140 int opoint_byte = PT_BYTE;
4141 int oinserted = ZV - BEGV;
4142 int ochars_modiff = CHARS_MODIFF;
4144 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
4145 insval = call3 (Qformat_decode,
4146 Qnil, make_number (oinserted), visit);
4147 CHECK_NUMBER (insval);
4148 if (ochars_modiff == CHARS_MODIFF)
4149 /* format_decode didn't modify buffer's characters => move
4150 point back to position before inserted text and leave
4151 value of inserted alone. */
4152 SET_PT_BOTH (opoint, opoint_byte);
4153 else
4154 /* format_decode modified buffer's characters => consider
4155 entire buffer changed and leave point at point-min. */
4156 inserted = XFASTINT (insval);
4159 /* For consistency with format-decode call these now iff inserted > 0
4160 (martin 2007-06-28). */
4161 p = Vafter_insert_file_functions;
4162 while (CONSP (p))
4164 if (NILP (replace))
4166 insval = call1 (XCAR (p), make_number (inserted));
4167 if (!NILP (insval))
4169 CHECK_NUMBER (insval);
4170 inserted = XFASTINT (insval);
4173 else
4175 /* For the rationale of this see the comment on
4176 format-decode above. */
4177 int opoint = PT;
4178 int opoint_byte = PT_BYTE;
4179 int oinserted = ZV - BEGV;
4180 int ochars_modiff = CHARS_MODIFF;
4182 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
4183 insval = call1 (XCAR (p), make_number (oinserted));
4184 if (!NILP (insval))
4186 CHECK_NUMBER (insval);
4187 if (ochars_modiff == CHARS_MODIFF)
4188 /* after_insert_file_functions didn't modify
4189 buffer's characters => move point back to
4190 position before inserted text and leave value of
4191 inserted alone. */
4192 SET_PT_BOTH (opoint, opoint_byte);
4193 else
4194 /* after_insert_file_functions did modify buffer's
4195 characters => consider entire buffer changed and
4196 leave point at point-min. */
4197 inserted = XFASTINT (insval);
4201 QUIT;
4202 p = XCDR (p);
4205 if (NILP (visit))
4207 current_buffer->undo_list = old_undo;
4208 if (CONSP (old_undo) && inserted != old_inserted)
4210 /* Adjust the last undo record for the size change during
4211 the format conversion. */
4212 Lisp_Object tem = XCAR (old_undo);
4213 if (CONSP (tem) && INTEGERP (XCAR (tem))
4214 && INTEGERP (XCDR (tem))
4215 && XFASTINT (XCDR (tem)) == PT + old_inserted)
4216 XSETCDR (tem, make_number (PT + inserted));
4219 else
4220 /* If undo_list was Qt before, keep it that way.
4221 Otherwise start with an empty undo_list. */
4222 current_buffer->undo_list = EQ (old_undo, Qt) ? Qt : Qnil;
4224 unbind_to (count, Qnil);
4227 /* Call after-change hooks for the inserted text, aside from the case
4228 of normal visiting (not with REPLACE), which is done in a new buffer
4229 "before" the buffer is changed. */
4230 if (inserted > 0 && total > 0
4231 && (NILP (visit) || !NILP (replace)))
4233 signal_after_change (PT, 0, inserted);
4234 update_compositions (PT, PT, CHECK_BORDER);
4237 if (!NILP (visit)
4238 && current_buffer->modtime == -1)
4240 /* If visiting nonexistent file, return nil. */
4241 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
4244 if (read_quit)
4245 Fsignal (Qquit, Qnil);
4247 /* ??? Retval needs to be dealt with in all cases consistently. */
4248 if (NILP (val))
4249 val = Fcons (orig_filename,
4250 Fcons (make_number (inserted),
4251 Qnil));
4253 RETURN_UNGCPRO (unbind_to (count, val));
4256 static Lisp_Object build_annotations P_ ((Lisp_Object, Lisp_Object));
4258 static Lisp_Object
4259 build_annotations_unwind (arg)
4260 Lisp_Object arg;
4262 Vwrite_region_annotation_buffers = arg;
4263 return Qnil;
4266 /* Decide the coding-system to encode the data with. */
4268 static Lisp_Object
4269 choose_write_coding_system (start, end, filename,
4270 append, visit, lockname, coding)
4271 Lisp_Object start, end, filename, append, visit, lockname;
4272 struct coding_system *coding;
4274 Lisp_Object val;
4275 Lisp_Object eol_parent = Qnil;
4277 if (auto_saving
4278 && NILP (Fstring_equal (current_buffer->filename,
4279 current_buffer->auto_save_file_name)))
4281 val = Qutf_8_emacs;
4282 eol_parent = Qunix;
4284 else if (!NILP (Vcoding_system_for_write))
4286 val = Vcoding_system_for_write;
4287 if (coding_system_require_warning
4288 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4289 /* Confirm that VAL can surely encode the current region. */
4290 val = call5 (Vselect_safe_coding_system_function,
4291 start, end, Fcons (Qt, Fcons (val, Qnil)),
4292 Qnil, filename);
4294 else
4296 /* If the variable `buffer-file-coding-system' is set locally,
4297 it means that the file was read with some kind of code
4298 conversion or the variable is explicitly set by users. We
4299 had better write it out with the same coding system even if
4300 `enable-multibyte-characters' is nil.
4302 If it is not set locally, we anyway have to convert EOL
4303 format if the default value of `buffer-file-coding-system'
4304 tells that it is not Unix-like (LF only) format. */
4305 int using_default_coding = 0;
4306 int force_raw_text = 0;
4308 val = current_buffer->buffer_file_coding_system;
4309 if (NILP (val)
4310 || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
4312 val = Qnil;
4313 if (NILP (current_buffer->enable_multibyte_characters))
4314 force_raw_text = 1;
4317 if (NILP (val))
4319 /* Check file-coding-system-alist. */
4320 Lisp_Object args[7], coding_systems;
4322 args[0] = Qwrite_region; args[1] = start; args[2] = end;
4323 args[3] = filename; args[4] = append; args[5] = visit;
4324 args[6] = lockname;
4325 coding_systems = Ffind_operation_coding_system (7, args);
4326 if (CONSP (coding_systems) && !NILP (XCDR (coding_systems)))
4327 val = XCDR (coding_systems);
4330 if (NILP (val))
4332 /* If we still have not decided a coding system, use the
4333 default value of buffer-file-coding-system. */
4334 val = current_buffer->buffer_file_coding_system;
4335 using_default_coding = 1;
4338 if (! NILP (val) && ! force_raw_text)
4340 Lisp_Object spec, attrs;
4342 CHECK_CODING_SYSTEM_GET_SPEC (val, spec);
4343 attrs = AREF (spec, 0);
4344 if (EQ (CODING_ATTR_TYPE (attrs), Qraw_text))
4345 force_raw_text = 1;
4348 if (!force_raw_text
4349 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4350 /* Confirm that VAL can surely encode the current region. */
4351 val = call5 (Vselect_safe_coding_system_function,
4352 start, end, val, Qnil, filename);
4354 /* If the decided coding-system doesn't specify end-of-line
4355 format, we use that of
4356 `default-buffer-file-coding-system'. */
4357 if (! using_default_coding
4358 && ! NILP (buffer_defaults.buffer_file_coding_system))
4359 val = (coding_inherit_eol_type
4360 (val, buffer_defaults.buffer_file_coding_system));
4362 /* If we decide not to encode text, use `raw-text' or one of its
4363 subsidiaries. */
4364 if (force_raw_text)
4365 val = raw_text_coding_system (val);
4368 val = coding_inherit_eol_type (val, eol_parent);
4369 setup_coding_system (val, coding);
4371 if (!STRINGP (start) && !NILP (current_buffer->selective_display))
4372 coding->mode |= CODING_MODE_SELECTIVE_DISPLAY;
4373 return val;
4376 DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7,
4377 "r\nFWrite region to file: \ni\ni\ni\np",
4378 doc: /* Write current region into specified file.
4379 When called from a program, requires three arguments:
4380 START, END and FILENAME. START and END are normally buffer positions
4381 specifying the part of the buffer to write.
4382 If START is nil, that means to use the entire buffer contents.
4383 If START is a string, then output that string to the file
4384 instead of any buffer contents; END is ignored.
4386 Optional fourth argument APPEND if non-nil means
4387 append to existing file contents (if any). If it is an integer,
4388 seek to that offset in the file before writing.
4389 Optional fifth argument VISIT, if t or a string, means
4390 set the last-save-file-modtime of buffer to this file's modtime
4391 and mark buffer not modified.
4392 If VISIT is a string, it is a second file name;
4393 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4394 VISIT is also the file name to lock and unlock for clash detection.
4395 If VISIT is neither t nor nil nor a string,
4396 that means do not display the \"Wrote file\" message.
4397 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4398 use for locking and unlocking, overriding FILENAME and VISIT.
4399 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4400 for an existing file with the same name. If MUSTBENEW is `excl',
4401 that means to get an error if the file already exists; never overwrite.
4402 If MUSTBENEW is neither nil nor `excl', that means ask for
4403 confirmation before overwriting, but do go ahead and overwrite the file
4404 if the user confirms.
4406 This does code conversion according to the value of
4407 `coding-system-for-write', `buffer-file-coding-system', or
4408 `file-coding-system-alist', and sets the variable
4409 `last-coding-system-used' to the coding system actually used. */)
4410 (start, end, filename, append, visit, lockname, mustbenew)
4411 Lisp_Object start, end, filename, append, visit, lockname, mustbenew;
4413 register int desc;
4414 int failure;
4415 int save_errno = 0;
4416 const unsigned char *fn;
4417 struct stat st;
4418 int count = SPECPDL_INDEX ();
4419 int count1;
4420 Lisp_Object handler;
4421 Lisp_Object visit_file;
4422 Lisp_Object annotations;
4423 Lisp_Object encoded_filename;
4424 int visiting = (EQ (visit, Qt) || STRINGP (visit));
4425 int quietly = !NILP (visit);
4426 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4427 struct buffer *given_buffer;
4428 #ifdef DOS_NT
4429 int buffer_file_type = O_BINARY;
4430 #endif /* DOS_NT */
4431 struct coding_system coding;
4433 if (current_buffer->base_buffer && visiting)
4434 error ("Cannot do file visiting in an indirect buffer");
4436 if (!NILP (start) && !STRINGP (start))
4437 validate_region (&start, &end);
4439 visit_file = Qnil;
4440 GCPRO5 (start, filename, visit, visit_file, lockname);
4442 filename = Fexpand_file_name (filename, Qnil);
4444 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
4445 barf_or_query_if_file_exists (filename, "overwrite", 1, 0, 1);
4447 if (STRINGP (visit))
4448 visit_file = Fexpand_file_name (visit, Qnil);
4449 else
4450 visit_file = filename;
4452 if (NILP (lockname))
4453 lockname = visit_file;
4455 annotations = Qnil;
4457 /* If the file name has special constructs in it,
4458 call the corresponding file handler. */
4459 handler = Ffind_file_name_handler (filename, Qwrite_region);
4460 /* If FILENAME has no handler, see if VISIT has one. */
4461 if (NILP (handler) && STRINGP (visit))
4462 handler = Ffind_file_name_handler (visit, Qwrite_region);
4464 if (!NILP (handler))
4466 Lisp_Object val;
4467 val = call6 (handler, Qwrite_region, start, end,
4468 filename, append, visit);
4470 if (visiting)
4472 SAVE_MODIFF = MODIFF;
4473 XSETFASTINT (current_buffer->save_length, Z - BEG);
4474 current_buffer->filename = visit_file;
4476 UNGCPRO;
4477 return val;
4480 record_unwind_protect (save_restriction_restore, save_restriction_save ());
4482 /* Special kludge to simplify auto-saving. */
4483 if (NILP (start))
4485 /* Do it later, so write-region-annotate-function can work differently
4486 if we save "the buffer" vs "a region".
4487 This is useful in tar-mode. --Stef
4488 XSETFASTINT (start, BEG);
4489 XSETFASTINT (end, Z); */
4490 Fwiden ();
4493 record_unwind_protect (build_annotations_unwind,
4494 Vwrite_region_annotation_buffers);
4495 Vwrite_region_annotation_buffers = Fcons (Fcurrent_buffer (), Qnil);
4496 count1 = SPECPDL_INDEX ();
4498 given_buffer = current_buffer;
4500 if (!STRINGP (start))
4502 annotations = build_annotations (start, end);
4504 if (current_buffer != given_buffer)
4506 XSETFASTINT (start, BEGV);
4507 XSETFASTINT (end, ZV);
4511 if (NILP (start))
4513 XSETFASTINT (start, BEGV);
4514 XSETFASTINT (end, ZV);
4517 UNGCPRO;
4519 GCPRO5 (start, filename, annotations, visit_file, lockname);
4521 /* Decide the coding-system to encode the data with.
4522 We used to make this choice before calling build_annotations, but that
4523 leads to problems when a write-annotate-function takes care of
4524 unsavable chars (as was the case with X-Symbol). */
4525 Vlast_coding_system_used
4526 = choose_write_coding_system (start, end, filename,
4527 append, visit, lockname, &coding);
4529 #ifdef CLASH_DETECTION
4530 if (!auto_saving)
4531 lock_file (lockname);
4532 #endif /* CLASH_DETECTION */
4534 encoded_filename = ENCODE_FILE (filename);
4536 fn = SDATA (encoded_filename);
4537 desc = -1;
4538 if (!NILP (append))
4539 #ifdef DOS_NT
4540 desc = emacs_open (fn, O_WRONLY | buffer_file_type, 0);
4541 #else /* not DOS_NT */
4542 desc = emacs_open (fn, O_WRONLY, 0);
4543 #endif /* not DOS_NT */
4545 if (desc < 0 && (NILP (append) || errno == ENOENT))
4546 #ifdef DOS_NT
4547 desc = emacs_open (fn,
4548 O_WRONLY | O_CREAT | buffer_file_type
4549 | (EQ (mustbenew, Qexcl) ? O_EXCL : O_TRUNC),
4550 S_IREAD | S_IWRITE);
4551 #else /* not DOS_NT */
4552 desc = emacs_open (fn, O_WRONLY | O_TRUNC | O_CREAT
4553 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
4554 auto_saving ? auto_save_mode_bits : 0666);
4555 #endif /* not DOS_NT */
4557 if (desc < 0)
4559 #ifdef CLASH_DETECTION
4560 save_errno = errno;
4561 if (!auto_saving) unlock_file (lockname);
4562 errno = save_errno;
4563 #endif /* CLASH_DETECTION */
4564 UNGCPRO;
4565 report_file_error ("Opening output file", Fcons (filename, Qnil));
4568 record_unwind_protect (close_file_unwind, make_number (desc));
4570 if (!NILP (append) && !NILP (Ffile_regular_p (filename)))
4572 long ret;
4574 if (NUMBERP (append))
4575 ret = lseek (desc, XINT (append), 1);
4576 else
4577 ret = lseek (desc, 0, 2);
4578 if (ret < 0)
4580 #ifdef CLASH_DETECTION
4581 if (!auto_saving) unlock_file (lockname);
4582 #endif /* CLASH_DETECTION */
4583 UNGCPRO;
4584 report_file_error ("Lseek error", Fcons (filename, Qnil));
4588 UNGCPRO;
4590 failure = 0;
4591 immediate_quit = 1;
4593 if (STRINGP (start))
4595 failure = 0 > a_write (desc, start, 0, SCHARS (start),
4596 &annotations, &coding);
4597 save_errno = errno;
4599 else if (XINT (start) != XINT (end))
4601 failure = 0 > a_write (desc, Qnil,
4602 XINT (start), XINT (end) - XINT (start),
4603 &annotations, &coding);
4604 save_errno = errno;
4606 else
4608 /* If file was empty, still need to write the annotations */
4609 coding.mode |= CODING_MODE_LAST_BLOCK;
4610 failure = 0 > a_write (desc, Qnil, XINT (end), 0, &annotations, &coding);
4611 save_errno = errno;
4614 if (CODING_REQUIRE_FLUSHING (&coding)
4615 && !(coding.mode & CODING_MODE_LAST_BLOCK)
4616 && ! failure)
4618 /* We have to flush out a data. */
4619 coding.mode |= CODING_MODE_LAST_BLOCK;
4620 failure = 0 > e_write (desc, Qnil, 1, 1, &coding);
4621 save_errno = errno;
4624 immediate_quit = 0;
4626 #ifdef HAVE_FSYNC
4627 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4628 Disk full in NFS may be reported here. */
4629 /* mib says that closing the file will try to write as fast as NFS can do
4630 it, and that means the fsync here is not crucial for autosave files. */
4631 if (!auto_saving && !write_region_inhibit_fsync && fsync (desc) < 0)
4633 /* If fsync fails with EINTR, don't treat that as serious. Also
4634 ignore EINVAL which happens when fsync is not supported on this
4635 file. */
4636 if (errno != EINTR && errno != EINVAL)
4637 failure = 1, save_errno = errno;
4639 #endif
4641 /* NFS can report a write failure now. */
4642 if (emacs_close (desc) < 0)
4643 failure = 1, save_errno = errno;
4645 stat (fn, &st);
4647 /* Discard the unwind protect for close_file_unwind. */
4648 specpdl_ptr = specpdl + count1;
4650 /* Call write-region-post-annotation-function. */
4651 while (!NILP (Vwrite_region_annotation_buffers))
4653 Lisp_Object buf = XCAR (Vwrite_region_annotation_buffers);
4654 if (!NILP (Fbuffer_live_p (buf)))
4656 Fset_buffer (buf);
4657 if (FUNCTIONP (Vwrite_region_post_annotation_function))
4658 call0 (Vwrite_region_post_annotation_function);
4660 Vwrite_region_annotation_buffers
4661 = XCDR (Vwrite_region_annotation_buffers);
4664 unbind_to (count, Qnil);
4666 #ifdef CLASH_DETECTION
4667 if (!auto_saving)
4668 unlock_file (lockname);
4669 #endif /* CLASH_DETECTION */
4671 /* Do this before reporting IO error
4672 to avoid a "file has changed on disk" warning on
4673 next attempt to save. */
4674 if (visiting)
4675 current_buffer->modtime = st.st_mtime;
4677 if (failure)
4678 error ("IO error writing %s: %s", SDATA (filename),
4679 emacs_strerror (save_errno));
4681 if (visiting)
4683 SAVE_MODIFF = MODIFF;
4684 XSETFASTINT (current_buffer->save_length, Z - BEG);
4685 current_buffer->filename = visit_file;
4686 update_mode_lines++;
4688 else if (quietly)
4690 if (auto_saving
4691 && ! NILP (Fstring_equal (current_buffer->filename,
4692 current_buffer->auto_save_file_name)))
4693 SAVE_MODIFF = MODIFF;
4695 return Qnil;
4698 if (!auto_saving)
4699 message_with_string ((INTEGERP (append)
4700 ? "Updated %s"
4701 : ! NILP (append)
4702 ? "Added to %s"
4703 : "Wrote %s"),
4704 visit_file, 1);
4706 return Qnil;
4709 Lisp_Object merge ();
4711 DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
4712 doc: /* Return t if (car A) is numerically less than (car B). */)
4713 (a, b)
4714 Lisp_Object a, b;
4716 return Flss (Fcar (a), Fcar (b));
4719 /* Build the complete list of annotations appropriate for writing out
4720 the text between START and END, by calling all the functions in
4721 write-region-annotate-functions and merging the lists they return.
4722 If one of these functions switches to a different buffer, we assume
4723 that buffer contains altered text. Therefore, the caller must
4724 make sure to restore the current buffer in all cases,
4725 as save-excursion would do. */
4727 static Lisp_Object
4728 build_annotations (start, end)
4729 Lisp_Object start, end;
4731 Lisp_Object annotations;
4732 Lisp_Object p, res;
4733 struct gcpro gcpro1, gcpro2;
4734 Lisp_Object original_buffer;
4735 int i, used_global = 0;
4737 XSETBUFFER (original_buffer, current_buffer);
4739 annotations = Qnil;
4740 p = Vwrite_region_annotate_functions;
4741 GCPRO2 (annotations, p);
4742 while (CONSP (p))
4744 struct buffer *given_buffer = current_buffer;
4745 if (EQ (Qt, XCAR (p)) && !used_global)
4746 { /* Use the global value of the hook. */
4747 Lisp_Object arg[2];
4748 used_global = 1;
4749 arg[0] = Fdefault_value (Qwrite_region_annotate_functions);
4750 arg[1] = XCDR (p);
4751 p = Fappend (2, arg);
4752 continue;
4754 Vwrite_region_annotations_so_far = annotations;
4755 res = call2 (XCAR (p), start, end);
4756 /* If the function makes a different buffer current,
4757 assume that means this buffer contains altered text to be output.
4758 Reset START and END from the buffer bounds
4759 and discard all previous annotations because they should have
4760 been dealt with by this function. */
4761 if (current_buffer != given_buffer)
4763 Vwrite_region_annotation_buffers
4764 = Fcons (Fcurrent_buffer (),
4765 Vwrite_region_annotation_buffers);
4766 XSETFASTINT (start, BEGV);
4767 XSETFASTINT (end, ZV);
4768 annotations = Qnil;
4770 Flength (res); /* Check basic validity of return value */
4771 annotations = merge (annotations, res, Qcar_less_than_car);
4772 p = XCDR (p);
4775 /* Now do the same for annotation functions implied by the file-format */
4776 if (auto_saving && (!EQ (current_buffer->auto_save_file_format, Qt)))
4777 p = current_buffer->auto_save_file_format;
4778 else
4779 p = current_buffer->file_format;
4780 for (i = 0; CONSP (p); p = XCDR (p), ++i)
4782 struct buffer *given_buffer = current_buffer;
4784 Vwrite_region_annotations_so_far = annotations;
4786 /* Value is either a list of annotations or nil if the function
4787 has written annotations to a temporary buffer, which is now
4788 current. */
4789 res = call5 (Qformat_annotate_function, XCAR (p), start, end,
4790 original_buffer, make_number (i));
4791 if (current_buffer != given_buffer)
4793 XSETFASTINT (start, BEGV);
4794 XSETFASTINT (end, ZV);
4795 annotations = Qnil;
4798 if (CONSP (res))
4799 annotations = merge (annotations, res, Qcar_less_than_car);
4802 UNGCPRO;
4803 return annotations;
4807 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4808 If STRING is nil, POS is the character position in the current buffer.
4809 Intersperse with them the annotations from *ANNOT
4810 which fall within the range of POS to POS + NCHARS,
4811 each at its appropriate position.
4813 We modify *ANNOT by discarding elements as we use them up.
4815 The return value is negative in case of system call failure. */
4817 static int
4818 a_write (desc, string, pos, nchars, annot, coding)
4819 int desc;
4820 Lisp_Object string;
4821 register int nchars;
4822 int pos;
4823 Lisp_Object *annot;
4824 struct coding_system *coding;
4826 Lisp_Object tem;
4827 int nextpos;
4828 int lastpos = pos + nchars;
4830 while (NILP (*annot) || CONSP (*annot))
4832 tem = Fcar_safe (Fcar (*annot));
4833 nextpos = pos - 1;
4834 if (INTEGERP (tem))
4835 nextpos = XFASTINT (tem);
4837 /* If there are no more annotations in this range,
4838 output the rest of the range all at once. */
4839 if (! (nextpos >= pos && nextpos <= lastpos))
4840 return e_write (desc, string, pos, lastpos, coding);
4842 /* Output buffer text up to the next annotation's position. */
4843 if (nextpos > pos)
4845 if (0 > e_write (desc, string, pos, nextpos, coding))
4846 return -1;
4847 pos = nextpos;
4849 /* Output the annotation. */
4850 tem = Fcdr (Fcar (*annot));
4851 if (STRINGP (tem))
4853 if (0 > e_write (desc, tem, 0, SCHARS (tem), coding))
4854 return -1;
4856 *annot = Fcdr (*annot);
4858 return 0;
4862 /* Write text in the range START and END into descriptor DESC,
4863 encoding them with coding system CODING. If STRING is nil, START
4864 and END are character positions of the current buffer, else they
4865 are indexes to the string STRING. */
4867 static int
4868 e_write (desc, string, start, end, coding)
4869 int desc;
4870 Lisp_Object string;
4871 int start, end;
4872 struct coding_system *coding;
4874 if (STRINGP (string))
4876 start = 0;
4877 end = SCHARS (string);
4880 /* We used to have a code for handling selective display here. But,
4881 now it is handled within encode_coding. */
4883 while (start < end)
4885 if (STRINGP (string))
4887 coding->src_multibyte = SCHARS (string) < SBYTES (string);
4888 if (CODING_REQUIRE_ENCODING (coding))
4890 encode_coding_object (coding, string,
4891 start, string_char_to_byte (string, start),
4892 end, string_char_to_byte (string, end), Qt);
4894 else
4896 coding->dst_object = string;
4897 coding->consumed_char = SCHARS (string);
4898 coding->produced = SBYTES (string);
4901 else
4903 int start_byte = CHAR_TO_BYTE (start);
4904 int end_byte = CHAR_TO_BYTE (end);
4906 coding->src_multibyte = (end - start) < (end_byte - start_byte);
4907 if (CODING_REQUIRE_ENCODING (coding))
4909 encode_coding_object (coding, Fcurrent_buffer (),
4910 start, start_byte, end, end_byte, Qt);
4912 else
4914 coding->dst_object = Qnil;
4915 coding->dst_pos_byte = start_byte;
4916 if (start >= GPT || end <= GPT)
4918 coding->consumed_char = end - start;
4919 coding->produced = end_byte - start_byte;
4921 else
4923 coding->consumed_char = GPT - start;
4924 coding->produced = GPT_BYTE - start_byte;
4929 if (coding->produced > 0)
4931 coding->produced -=
4932 emacs_write (desc,
4933 STRINGP (coding->dst_object)
4934 ? SDATA (coding->dst_object)
4935 : BYTE_POS_ADDR (coding->dst_pos_byte),
4936 coding->produced);
4938 if (coding->produced)
4939 return -1;
4941 start += coding->consumed_char;
4944 return 0;
4947 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
4948 Sverify_visited_file_modtime, 1, 1, 0,
4949 doc: /* Return t if last mod time of BUF's visited file matches what BUF records.
4950 This means that the file has not been changed since it was visited or saved.
4951 See Info node `(elisp)Modification Time' for more details. */)
4952 (buf)
4953 Lisp_Object buf;
4955 struct buffer *b;
4956 struct stat st;
4957 Lisp_Object handler;
4958 Lisp_Object filename;
4960 CHECK_BUFFER (buf);
4961 b = XBUFFER (buf);
4963 if (!STRINGP (b->filename)) return Qt;
4964 if (b->modtime == 0) return Qt;
4966 /* If the file name has special constructs in it,
4967 call the corresponding file handler. */
4968 handler = Ffind_file_name_handler (b->filename,
4969 Qverify_visited_file_modtime);
4970 if (!NILP (handler))
4971 return call2 (handler, Qverify_visited_file_modtime, buf);
4973 filename = ENCODE_FILE (b->filename);
4975 if (stat (SDATA (filename), &st) < 0)
4977 /* If the file doesn't exist now and didn't exist before,
4978 we say that it isn't modified, provided the error is a tame one. */
4979 if (errno == ENOENT || errno == EACCES || errno == ENOTDIR)
4980 st.st_mtime = -1;
4981 else
4982 st.st_mtime = 0;
4984 if (st.st_mtime == b->modtime
4985 /* If both are positive, accept them if they are off by one second. */
4986 || (st.st_mtime > 0 && b->modtime > 0
4987 && (st.st_mtime == b->modtime + 1
4988 || st.st_mtime == b->modtime - 1)))
4989 return Qt;
4990 return Qnil;
4993 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
4994 Sclear_visited_file_modtime, 0, 0, 0,
4995 doc: /* Clear out records of last mod time of visited file.
4996 Next attempt to save will certainly not complain of a discrepancy. */)
4999 current_buffer->modtime = 0;
5000 return Qnil;
5003 DEFUN ("visited-file-modtime", Fvisited_file_modtime,
5004 Svisited_file_modtime, 0, 0, 0,
5005 doc: /* Return the current buffer's recorded visited file modification time.
5006 The value is a list of the form (HIGH LOW), like the time values
5007 that `file-attributes' returns. If the current buffer has no recorded
5008 file modification time, this function returns 0.
5009 See Info node `(elisp)Modification Time' for more details. */)
5012 if (! current_buffer->modtime)
5013 return make_number (0);
5014 return make_time ((time_t) current_buffer->modtime);
5017 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
5018 Sset_visited_file_modtime, 0, 1, 0,
5019 doc: /* Update buffer's recorded modification time from the visited file's time.
5020 Useful if the buffer was not read from the file normally
5021 or if the file itself has been changed for some known benign reason.
5022 An argument specifies the modification time value to use
5023 \(instead of that of the visited file), in the form of a list
5024 \(HIGH . LOW) or (HIGH LOW). */)
5025 (time_list)
5026 Lisp_Object time_list;
5028 if (!NILP (time_list))
5029 current_buffer->modtime = cons_to_long (time_list);
5030 else
5032 register Lisp_Object filename;
5033 struct stat st;
5034 Lisp_Object handler;
5036 filename = Fexpand_file_name (current_buffer->filename, Qnil);
5038 /* If the file name has special constructs in it,
5039 call the corresponding file handler. */
5040 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
5041 if (!NILP (handler))
5042 /* The handler can find the file name the same way we did. */
5043 return call2 (handler, Qset_visited_file_modtime, Qnil);
5045 filename = ENCODE_FILE (filename);
5047 if (stat (SDATA (filename), &st) >= 0)
5048 current_buffer->modtime = st.st_mtime;
5051 return Qnil;
5054 Lisp_Object
5055 auto_save_error (error)
5056 Lisp_Object error;
5058 Lisp_Object args[3], msg;
5059 int i, nbytes;
5060 struct gcpro gcpro1;
5061 char *msgbuf;
5062 USE_SAFE_ALLOCA;
5064 auto_save_error_occurred = 1;
5066 ring_bell (XFRAME (selected_frame));
5068 args[0] = build_string ("Auto-saving %s: %s");
5069 args[1] = current_buffer->name;
5070 args[2] = Ferror_message_string (error);
5071 msg = Fformat (3, args);
5072 GCPRO1 (msg);
5073 nbytes = SBYTES (msg);
5074 SAFE_ALLOCA (msgbuf, char *, nbytes);
5075 bcopy (SDATA (msg), msgbuf, nbytes);
5077 for (i = 0; i < 3; ++i)
5079 if (i == 0)
5080 message2 (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5081 else
5082 message2_nolog (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5083 Fsleep_for (make_number (1), Qnil);
5086 SAFE_FREE ();
5087 UNGCPRO;
5088 return Qnil;
5091 Lisp_Object
5092 auto_save_1 ()
5094 struct stat st;
5095 Lisp_Object modes;
5097 auto_save_mode_bits = 0666;
5099 /* Get visited file's mode to become the auto save file's mode. */
5100 if (! NILP (current_buffer->filename))
5102 if (stat (SDATA (current_buffer->filename), &st) >= 0)
5103 /* But make sure we can overwrite it later! */
5104 auto_save_mode_bits = st.st_mode | 0600;
5105 else if ((modes = Ffile_modes (current_buffer->filename),
5106 INTEGERP (modes)))
5107 /* Remote files don't cooperate with stat. */
5108 auto_save_mode_bits = XINT (modes) | 0600;
5111 return
5112 Fwrite_region (Qnil, Qnil, current_buffer->auto_save_file_name, Qnil,
5113 NILP (Vauto_save_visited_file_name) ? Qlambda : Qt,
5114 Qnil, Qnil);
5117 static Lisp_Object
5118 do_auto_save_unwind (arg) /* used as unwind-protect function */
5119 Lisp_Object arg;
5121 FILE *stream = (FILE *) XSAVE_VALUE (arg)->pointer;
5122 auto_saving = 0;
5123 if (stream != NULL)
5125 BLOCK_INPUT;
5126 fclose (stream);
5127 UNBLOCK_INPUT;
5129 return Qnil;
5132 static Lisp_Object
5133 do_auto_save_unwind_1 (value) /* used as unwind-protect function */
5134 Lisp_Object value;
5136 minibuffer_auto_raise = XINT (value);
5137 return Qnil;
5140 static Lisp_Object
5141 do_auto_save_make_dir (dir)
5142 Lisp_Object dir;
5144 Lisp_Object mode;
5146 call2 (Qmake_directory, dir, Qt);
5147 XSETFASTINT (mode, 0700);
5148 return Fset_file_modes (dir, mode);
5151 static Lisp_Object
5152 do_auto_save_eh (ignore)
5153 Lisp_Object ignore;
5155 return Qnil;
5158 DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
5159 doc: /* Auto-save all buffers that need it.
5160 This is all buffers that have auto-saving enabled
5161 and are changed since last auto-saved.
5162 Auto-saving writes the buffer into a file
5163 so that your editing is not lost if the system crashes.
5164 This file is not the file you visited; that changes only when you save.
5165 Normally we run the normal hook `auto-save-hook' before saving.
5167 A non-nil NO-MESSAGE argument means do not print any message if successful.
5168 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5169 (no_message, current_only)
5170 Lisp_Object no_message, current_only;
5172 struct buffer *old = current_buffer, *b;
5173 Lisp_Object tail, buf;
5174 int auto_saved = 0;
5175 int do_handled_files;
5176 Lisp_Object oquit;
5177 FILE *stream = NULL;
5178 int count = SPECPDL_INDEX ();
5179 int orig_minibuffer_auto_raise = minibuffer_auto_raise;
5180 int old_message_p = 0;
5181 struct gcpro gcpro1, gcpro2;
5183 if (max_specpdl_size < specpdl_size + 40)
5184 max_specpdl_size = specpdl_size + 40;
5186 if (minibuf_level)
5187 no_message = Qt;
5189 if (NILP (no_message))
5191 old_message_p = push_message ();
5192 record_unwind_protect (pop_message_unwind, Qnil);
5195 /* Ordinarily don't quit within this function,
5196 but don't make it impossible to quit (in case we get hung in I/O). */
5197 oquit = Vquit_flag;
5198 Vquit_flag = Qnil;
5200 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5201 point to non-strings reached from Vbuffer_alist. */
5203 if (!NILP (Vrun_hooks))
5204 call1 (Vrun_hooks, intern ("auto-save-hook"));
5206 if (STRINGP (Vauto_save_list_file_name))
5208 Lisp_Object listfile;
5210 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
5212 /* Don't try to create the directory when shutting down Emacs,
5213 because creating the directory might signal an error, and
5214 that would leave Emacs in a strange state. */
5215 if (!NILP (Vrun_hooks))
5217 Lisp_Object dir;
5218 dir = Qnil;
5219 GCPRO2 (dir, listfile);
5220 dir = Ffile_name_directory (listfile);
5221 if (NILP (Ffile_directory_p (dir)))
5222 internal_condition_case_1 (do_auto_save_make_dir,
5223 dir, Fcons (Fcons (Qfile_error, Qnil), Qnil),
5224 do_auto_save_eh);
5225 UNGCPRO;
5228 stream = fopen (SDATA (listfile), "w");
5231 record_unwind_protect (do_auto_save_unwind,
5232 make_save_value (stream, 0));
5233 record_unwind_protect (do_auto_save_unwind_1,
5234 make_number (minibuffer_auto_raise));
5235 minibuffer_auto_raise = 0;
5236 auto_saving = 1;
5237 auto_save_error_occurred = 0;
5239 /* On first pass, save all files that don't have handlers.
5240 On second pass, save all files that do have handlers.
5242 If Emacs is crashing, the handlers may tweak what is causing
5243 Emacs to crash in the first place, and it would be a shame if
5244 Emacs failed to autosave perfectly ordinary files because it
5245 couldn't handle some ange-ftp'd file. */
5247 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
5248 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
5250 buf = XCDR (XCAR (tail));
5251 b = XBUFFER (buf);
5253 /* Record all the buffers that have auto save mode
5254 in the special file that lists them. For each of these buffers,
5255 Record visited name (if any) and auto save name. */
5256 if (STRINGP (b->auto_save_file_name)
5257 && stream != NULL && do_handled_files == 0)
5259 BLOCK_INPUT;
5260 if (!NILP (b->filename))
5262 fwrite (SDATA (b->filename), 1,
5263 SBYTES (b->filename), stream);
5265 putc ('\n', stream);
5266 fwrite (SDATA (b->auto_save_file_name), 1,
5267 SBYTES (b->auto_save_file_name), stream);
5268 putc ('\n', stream);
5269 UNBLOCK_INPUT;
5272 if (!NILP (current_only)
5273 && b != current_buffer)
5274 continue;
5276 /* Don't auto-save indirect buffers.
5277 The base buffer takes care of it. */
5278 if (b->base_buffer)
5279 continue;
5281 /* Check for auto save enabled
5282 and file changed since last auto save
5283 and file changed since last real save. */
5284 if (STRINGP (b->auto_save_file_name)
5285 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
5286 && b->auto_save_modified < BUF_MODIFF (b)
5287 /* -1 means we've turned off autosaving for a while--see below. */
5288 && XINT (b->save_length) >= 0
5289 && (do_handled_files
5290 || NILP (Ffind_file_name_handler (b->auto_save_file_name,
5291 Qwrite_region))))
5293 EMACS_TIME before_time, after_time;
5295 EMACS_GET_TIME (before_time);
5297 /* If we had a failure, don't try again for 20 minutes. */
5298 if (b->auto_save_failure_time >= 0
5299 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
5300 continue;
5302 if ((XFASTINT (b->save_length) * 10
5303 > (BUF_Z (b) - BUF_BEG (b)) * 13)
5304 /* A short file is likely to change a large fraction;
5305 spare the user annoying messages. */
5306 && XFASTINT (b->save_length) > 5000
5307 /* These messages are frequent and annoying for `*mail*'. */
5308 && !EQ (b->filename, Qnil)
5309 && NILP (no_message))
5311 /* It has shrunk too much; turn off auto-saving here. */
5312 minibuffer_auto_raise = orig_minibuffer_auto_raise;
5313 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
5314 b->name, 1);
5315 minibuffer_auto_raise = 0;
5316 /* Turn off auto-saving until there's a real save,
5317 and prevent any more warnings. */
5318 XSETINT (b->save_length, -1);
5319 Fsleep_for (make_number (1), Qnil);
5320 continue;
5322 set_buffer_internal (b);
5323 if (!auto_saved && NILP (no_message))
5324 message1 ("Auto-saving...");
5325 internal_condition_case (auto_save_1, Qt, auto_save_error);
5326 auto_saved++;
5327 b->auto_save_modified = BUF_MODIFF (b);
5328 XSETFASTINT (current_buffer->save_length, Z - BEG);
5329 set_buffer_internal (old);
5331 EMACS_GET_TIME (after_time);
5333 /* If auto-save took more than 60 seconds,
5334 assume it was an NFS failure that got a timeout. */
5335 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
5336 b->auto_save_failure_time = EMACS_SECS (after_time);
5340 /* Prevent another auto save till enough input events come in. */
5341 record_auto_save ();
5343 if (auto_saved && NILP (no_message))
5345 if (old_message_p)
5347 /* If we are going to restore an old message,
5348 give time to read ours. */
5349 sit_for (make_number (1), 0, 0);
5350 restore_message ();
5352 else if (!auto_save_error_occurred)
5353 /* Don't overwrite the error message if an error occurred.
5354 If we displayed a message and then restored a state
5355 with no message, leave a "done" message on the screen. */
5356 message1 ("Auto-saving...done");
5359 Vquit_flag = oquit;
5361 /* This restores the message-stack status. */
5362 unbind_to (count, Qnil);
5363 return Qnil;
5366 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
5367 Sset_buffer_auto_saved, 0, 0, 0,
5368 doc: /* Mark current buffer as auto-saved with its current text.
5369 No auto-save file will be written until the buffer changes again. */)
5372 current_buffer->auto_save_modified = MODIFF;
5373 XSETFASTINT (current_buffer->save_length, Z - BEG);
5374 current_buffer->auto_save_failure_time = -1;
5375 return Qnil;
5378 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
5379 Sclear_buffer_auto_save_failure, 0, 0, 0,
5380 doc: /* Clear any record of a recent auto-save failure in the current buffer. */)
5383 current_buffer->auto_save_failure_time = -1;
5384 return Qnil;
5387 DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
5388 0, 0, 0,
5389 doc: /* Return t if current buffer has been auto-saved recently.
5390 More precisely, if it has been auto-saved since last read from or saved
5391 in the visited file. If the buffer has no visited file,
5392 then any auto-save counts as "recent". */)
5395 return (SAVE_MODIFF < current_buffer->auto_save_modified) ? Qt : Qnil;
5398 /* Reading and completing file names */
5400 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p,
5401 Snext_read_file_uses_dialog_p, 0, 0, 0,
5402 doc: /* Return t if a call to `read-file-name' will use a dialog.
5403 The return value is only relevant for a call to `read-file-name' that happens
5404 before any other event (mouse or keypress) is handeled. */)
5407 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK)
5408 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
5409 && use_dialog_box
5410 && use_file_dialog
5411 && have_menus_p ())
5412 return Qt;
5413 #endif
5414 return Qnil;
5417 Lisp_Object
5418 Fread_file_name (prompt, dir, default_filename, mustmatch, initial, predicate)
5419 Lisp_Object prompt, dir, default_filename, mustmatch, initial, predicate;
5421 struct gcpro gcpro1, gcpro2;
5422 Lisp_Object args[7];
5424 GCPRO1 (default_filename);
5425 args[0] = intern ("read-file-name");
5426 args[1] = prompt;
5427 args[2] = dir;
5428 args[3] = default_filename;
5429 args[4] = mustmatch;
5430 args[5] = initial;
5431 args[6] = predicate;
5432 RETURN_UNGCPRO (Ffuncall (7, args));
5436 void
5437 init_fileio_once ()
5439 /* Must be set before any path manipulation is performed. */
5440 XSETFASTINT (Vdirectory_sep_char, '/');
5444 void
5445 syms_of_fileio ()
5447 Qoperations = intern ("operations");
5448 Qexpand_file_name = intern ("expand-file-name");
5449 Qsubstitute_in_file_name = intern ("substitute-in-file-name");
5450 Qdirectory_file_name = intern ("directory-file-name");
5451 Qfile_name_directory = intern ("file-name-directory");
5452 Qfile_name_nondirectory = intern ("file-name-nondirectory");
5453 Qunhandled_file_name_directory = intern ("unhandled-file-name-directory");
5454 Qfile_name_as_directory = intern ("file-name-as-directory");
5455 Qcopy_file = intern ("copy-file");
5456 Qmake_directory_internal = intern ("make-directory-internal");
5457 Qmake_directory = intern ("make-directory");
5458 Qdelete_directory = intern ("delete-directory");
5459 Qdelete_file = intern ("delete-file");
5460 Qrename_file = intern ("rename-file");
5461 Qadd_name_to_file = intern ("add-name-to-file");
5462 Qmake_symbolic_link = intern ("make-symbolic-link");
5463 Qfile_exists_p = intern ("file-exists-p");
5464 Qfile_executable_p = intern ("file-executable-p");
5465 Qfile_readable_p = intern ("file-readable-p");
5466 Qfile_writable_p = intern ("file-writable-p");
5467 Qfile_symlink_p = intern ("file-symlink-p");
5468 Qaccess_file = intern ("access-file");
5469 Qfile_directory_p = intern ("file-directory-p");
5470 Qfile_regular_p = intern ("file-regular-p");
5471 Qfile_accessible_directory_p = intern ("file-accessible-directory-p");
5472 Qfile_modes = intern ("file-modes");
5473 Qset_file_modes = intern ("set-file-modes");
5474 Qset_file_times = intern ("set-file-times");
5475 Qfile_newer_than_file_p = intern ("file-newer-than-file-p");
5476 Qinsert_file_contents = intern ("insert-file-contents");
5477 Qwrite_region = intern ("write-region");
5478 Qverify_visited_file_modtime = intern ("verify-visited-file-modtime");
5479 Qset_visited_file_modtime = intern ("set-visited-file-modtime");
5480 Qauto_save_coding = intern ("auto-save-coding");
5482 staticpro (&Qoperations);
5483 staticpro (&Qexpand_file_name);
5484 staticpro (&Qsubstitute_in_file_name);
5485 staticpro (&Qdirectory_file_name);
5486 staticpro (&Qfile_name_directory);
5487 staticpro (&Qfile_name_nondirectory);
5488 staticpro (&Qunhandled_file_name_directory);
5489 staticpro (&Qfile_name_as_directory);
5490 staticpro (&Qcopy_file);
5491 staticpro (&Qmake_directory_internal);
5492 staticpro (&Qmake_directory);
5493 staticpro (&Qdelete_directory);
5494 staticpro (&Qdelete_file);
5495 staticpro (&Qrename_file);
5496 staticpro (&Qadd_name_to_file);
5497 staticpro (&Qmake_symbolic_link);
5498 staticpro (&Qfile_exists_p);
5499 staticpro (&Qfile_executable_p);
5500 staticpro (&Qfile_readable_p);
5501 staticpro (&Qfile_writable_p);
5502 staticpro (&Qaccess_file);
5503 staticpro (&Qfile_symlink_p);
5504 staticpro (&Qfile_directory_p);
5505 staticpro (&Qfile_regular_p);
5506 staticpro (&Qfile_accessible_directory_p);
5507 staticpro (&Qfile_modes);
5508 staticpro (&Qset_file_modes);
5509 staticpro (&Qset_file_times);
5510 staticpro (&Qfile_newer_than_file_p);
5511 staticpro (&Qinsert_file_contents);
5512 staticpro (&Qwrite_region);
5513 staticpro (&Qverify_visited_file_modtime);
5514 staticpro (&Qset_visited_file_modtime);
5515 staticpro (&Qauto_save_coding);
5517 Qfile_name_history = intern ("file-name-history");
5518 Fset (Qfile_name_history, Qnil);
5519 staticpro (&Qfile_name_history);
5521 Qfile_error = intern ("file-error");
5522 staticpro (&Qfile_error);
5523 Qfile_already_exists = intern ("file-already-exists");
5524 staticpro (&Qfile_already_exists);
5525 Qfile_date_error = intern ("file-date-error");
5526 staticpro (&Qfile_date_error);
5527 Qexcl = intern ("excl");
5528 staticpro (&Qexcl);
5530 #ifdef DOS_NT
5531 Qfind_buffer_file_type = intern ("find-buffer-file-type");
5532 staticpro (&Qfind_buffer_file_type);
5533 #endif /* DOS_NT */
5535 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system,
5536 doc: /* *Coding system for encoding file names.
5537 If it is nil, `default-file-name-coding-system' (which see) is used. */);
5538 Vfile_name_coding_system = Qnil;
5540 DEFVAR_LISP ("default-file-name-coding-system",
5541 &Vdefault_file_name_coding_system,
5542 doc: /* Default coding system for encoding file names.
5543 This variable is used only when `file-name-coding-system' is nil.
5545 This variable is set/changed by the command `set-language-environment'.
5546 User should not set this variable manually,
5547 instead use `file-name-coding-system' to get a constant encoding
5548 of file names regardless of the current language environment. */);
5549 Vdefault_file_name_coding_system = Qnil;
5551 Qformat_decode = intern ("format-decode");
5552 staticpro (&Qformat_decode);
5553 Qformat_annotate_function = intern ("format-annotate-function");
5554 staticpro (&Qformat_annotate_function);
5555 Qafter_insert_file_set_coding = intern ("after-insert-file-set-coding");
5556 staticpro (&Qafter_insert_file_set_coding);
5558 Qcar_less_than_car = intern ("car-less-than-car");
5559 staticpro (&Qcar_less_than_car);
5561 Fput (Qfile_error, Qerror_conditions,
5562 list2 (Qfile_error, Qerror));
5563 Fput (Qfile_error, Qerror_message,
5564 build_string ("File error"));
5566 Fput (Qfile_already_exists, Qerror_conditions,
5567 list3 (Qfile_already_exists, Qfile_error, Qerror));
5568 Fput (Qfile_already_exists, Qerror_message,
5569 build_string ("File already exists"));
5571 Fput (Qfile_date_error, Qerror_conditions,
5572 list3 (Qfile_date_error, Qfile_error, Qerror));
5573 Fput (Qfile_date_error, Qerror_message,
5574 build_string ("Cannot set file date"));
5576 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char,
5577 doc: /* Directory separator character for built-in functions that return file names.
5578 The value is always ?/. Don't use this variable, just use `/'. */);
5580 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist,
5581 doc: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
5582 If a file name matches REGEXP, then all I/O on that file is done by calling
5583 HANDLER.
5585 The first argument given to HANDLER is the name of the I/O primitive
5586 to be handled; the remaining arguments are the arguments that were
5587 passed to that primitive. For example, if you do
5588 (file-exists-p FILENAME)
5589 and FILENAME is handled by HANDLER, then HANDLER is called like this:
5590 (funcall HANDLER 'file-exists-p FILENAME)
5591 The function `find-file-name-handler' checks this list for a handler
5592 for its argument. */);
5593 Vfile_name_handler_alist = Qnil;
5595 DEFVAR_LISP ("set-auto-coding-function",
5596 &Vset_auto_coding_function,
5597 doc: /* If non-nil, a function to call to decide a coding system of file.
5598 Two arguments are passed to this function: the file name
5599 and the length of a file contents following the point.
5600 This function should return a coding system to decode the file contents.
5601 It should check the file name against `auto-coding-alist'.
5602 If no coding system is decided, it should check a coding system
5603 specified in the heading lines with the format:
5604 -*- ... coding: CODING-SYSTEM; ... -*-
5605 or local variable spec of the tailing lines with `coding:' tag. */);
5606 Vset_auto_coding_function = Qnil;
5608 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions,
5609 doc: /* A list of functions to be called at the end of `insert-file-contents'.
5610 Each is passed one argument, the number of characters inserted,
5611 with point at the start of the inserted text. Each function
5612 should leave point the same, and return the new character count.
5613 If `insert-file-contents' is intercepted by a handler from
5614 `file-name-handler-alist', that handler is responsible for calling the
5615 functions in `after-insert-file-functions' if appropriate. */);
5616 Vafter_insert_file_functions = Qnil;
5618 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions,
5619 doc: /* A list of functions to be called at the start of `write-region'.
5620 Each is passed two arguments, START and END as for `write-region'.
5621 These are usually two numbers but not always; see the documentation
5622 for `write-region'. The function should return a list of pairs
5623 of the form (POSITION . STRING), consisting of strings to be effectively
5624 inserted at the specified positions of the file being written (1 means to
5625 insert before the first byte written). The POSITIONs must be sorted into
5626 increasing order.
5628 If there are several annotation functions, the lists returned by these
5629 functions are merged destructively. As each annotation function runs,
5630 the variable `write-region-annotations-so-far' contains a list of all
5631 annotations returned by previous annotation functions.
5633 An annotation function can return with a different buffer current.
5634 Doing so removes the annotations returned by previous functions, and
5635 resets START and END to `point-min' and `point-max' of the new buffer.
5637 After `write-region' completes, Emacs calls the function stored in
5638 `write-region-post-annotation-function', once for each buffer that was
5639 current when building the annotations (i.e., at least once), with that
5640 buffer current. */);
5641 Vwrite_region_annotate_functions = Qnil;
5642 staticpro (&Qwrite_region_annotate_functions);
5643 Qwrite_region_annotate_functions
5644 = intern ("write-region-annotate-functions");
5646 DEFVAR_LISP ("write-region-post-annotation-function",
5647 &Vwrite_region_post_annotation_function,
5648 doc: /* Function to call after `write-region' completes.
5649 The function is called with no arguments. If one or more of the
5650 annotation functions in `write-region-annotate-functions' changed the
5651 current buffer, the function stored in this variable is called for
5652 each of those additional buffers as well, in addition to the original
5653 buffer. The relevant buffer is current during each function call. */);
5654 Vwrite_region_post_annotation_function = Qnil;
5655 staticpro (&Vwrite_region_annotation_buffers);
5657 DEFVAR_LISP ("write-region-annotations-so-far",
5658 &Vwrite_region_annotations_so_far,
5659 doc: /* When an annotation function is called, this holds the previous annotations.
5660 These are the annotations made by other annotation functions
5661 that were already called. See also `write-region-annotate-functions'. */);
5662 Vwrite_region_annotations_so_far = Qnil;
5664 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers,
5665 doc: /* A list of file name handlers that temporarily should not be used.
5666 This applies only to the operation `inhibit-file-name-operation'. */);
5667 Vinhibit_file_name_handlers = Qnil;
5669 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation,
5670 doc: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
5671 Vinhibit_file_name_operation = Qnil;
5673 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name,
5674 doc: /* File name in which we write a list of all auto save file names.
5675 This variable is initialized automatically from `auto-save-list-file-prefix'
5676 shortly after Emacs reads your `.emacs' file, if you have not yet given it
5677 a non-nil value. */);
5678 Vauto_save_list_file_name = Qnil;
5680 DEFVAR_LISP ("auto-save-visited-file-name", &Vauto_save_visited_file_name,
5681 doc: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5682 Normally auto-save files are written under other names. */);
5683 Vauto_save_visited_file_name = Qnil;
5685 #ifdef HAVE_FSYNC
5686 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync,
5687 doc: /* *Non-nil means don't call fsync in `write-region'.
5688 This variable affects calls to `write-region' as well as save commands.
5689 A non-nil value may result in data loss! */);
5690 write_region_inhibit_fsync = 0;
5691 #endif
5693 DEFVAR_BOOL ("delete-by-moving-to-trash", &delete_by_moving_to_trash,
5694 doc: /* Specifies whether to use the system's trash can.
5695 When non-nil, the function `move-file-to-trash' will be used by
5696 `delete-file' and `delete-directory'. */);
5697 delete_by_moving_to_trash = 0;
5698 Qdelete_by_moving_to_trash = intern ("delete-by-moving-to-trash");
5699 Qmove_file_to_trash = intern ("move-file-to-trash");
5700 staticpro (&Qmove_file_to_trash);
5702 defsubr (&Sfind_file_name_handler);
5703 defsubr (&Sfile_name_directory);
5704 defsubr (&Sfile_name_nondirectory);
5705 defsubr (&Sunhandled_file_name_directory);
5706 defsubr (&Sfile_name_as_directory);
5707 defsubr (&Sdirectory_file_name);
5708 defsubr (&Smake_temp_name);
5709 defsubr (&Sexpand_file_name);
5710 defsubr (&Ssubstitute_in_file_name);
5711 defsubr (&Scopy_file);
5712 defsubr (&Smake_directory_internal);
5713 defsubr (&Sdelete_directory);
5714 defsubr (&Sdelete_file);
5715 defsubr (&Srename_file);
5716 defsubr (&Sadd_name_to_file);
5717 defsubr (&Smake_symbolic_link);
5718 defsubr (&Sfile_name_absolute_p);
5719 defsubr (&Sfile_exists_p);
5720 defsubr (&Sfile_executable_p);
5721 defsubr (&Sfile_readable_p);
5722 defsubr (&Sfile_writable_p);
5723 defsubr (&Saccess_file);
5724 defsubr (&Sfile_symlink_p);
5725 defsubr (&Sfile_directory_p);
5726 defsubr (&Sfile_accessible_directory_p);
5727 defsubr (&Sfile_regular_p);
5728 defsubr (&Sfile_modes);
5729 defsubr (&Sset_file_modes);
5730 defsubr (&Sset_file_times);
5731 defsubr (&Sset_default_file_modes);
5732 defsubr (&Sdefault_file_modes);
5733 defsubr (&Sfile_newer_than_file_p);
5734 defsubr (&Sinsert_file_contents);
5735 defsubr (&Swrite_region);
5736 defsubr (&Scar_less_than_car);
5737 defsubr (&Sverify_visited_file_modtime);
5738 defsubr (&Sclear_visited_file_modtime);
5739 defsubr (&Svisited_file_modtime);
5740 defsubr (&Sset_visited_file_modtime);
5741 defsubr (&Sdo_auto_save);
5742 defsubr (&Sset_buffer_auto_saved);
5743 defsubr (&Sclear_buffer_auto_save_failure);
5744 defsubr (&Srecent_auto_save_p);
5746 defsubr (&Snext_read_file_uses_dialog_p);
5748 #ifdef HAVE_SYNC
5749 defsubr (&Sunix_sync);
5750 #endif
5753 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
5754 (do not change this comment) */