Auto-commit of loaddefs files.
[bpt/emacs.git] / src / fileio.c
CommitLineData
570d7624 1/* File IO for GNU Emacs.
e9bffc61 2
24c51a09 3Copyright (C) 1985-1988, 1993-2012 Free Software Foundation, Inc.
570d7624
JB
4
5This file is part of GNU Emacs.
6
9ec0b715 7GNU Emacs is free software: you can redistribute it and/or modify
570d7624 8it under the terms of the GNU General Public License as published by
9ec0b715
GM
9the Free Software Foundation, either version 3 of the License, or
10(at your option) any later version.
570d7624
JB
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
9ec0b715 18along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
570d7624 19
18160b98 20#include <config.h>
77a28bbf 21#include <limits.h>
bb369dc6 22#include <fcntl.h>
1b335d29 23#include <stdio.h>
570d7624
JB
24#include <sys/types.h>
25#include <sys/stat.h>
29beb080 26#include <unistd.h>
29beb080 27
5b9c0a1d 28#ifdef HAVE_PWD_H
570d7624 29#include <pwd.h>
bfb61299
JB
30#endif
31
570d7624
JB
32#include <errno.h>
33
574c05e2
KK
34#ifdef HAVE_LIBSELINUX
35#include <selinux/selinux.h>
36#include <selinux/context.h>
37#endif
38
620f13b0
PE
39#include <c-ctype.h>
40
570d7624 41#include "lisp.h"
8d4e077b 42#include "intervals.h"
db327c7e 43#include "character.h"
e5560ff7 44#include "buffer.h"
6fdaa9a0 45#include "coding.h"
570d7624 46#include "window.h"
67c08d6c 47#include "blockinput.h"
385ed61f
KL
48#include "frame.h"
49#include "dispextern.h"
570d7624 50
5e570b75
RS
51#ifdef WINDOWSNT
52#define NOMINMAX 1
53#include <windows.h>
5e570b75 54#include <fcntl.h>
bb385a92 55#include <sys/file.h>
a68089e4 56#include "w32.h"
5e570b75
RS
57#endif /* not WINDOWSNT */
58
7990d02a
EZ
59#ifdef MSDOS
60#include "msdos.h"
61#include <sys/param.h>
7990d02a 62#include <fcntl.h>
7990d02a 63#endif
7990d02a 64
199607e4 65#ifdef DOS_NT
199607e4 66/* On Windows, drive letters must be alphabetic - on DOS, the Netware
a5bb9bd3 67 redirector allows the six letters between 'Z' and 'a' as well. */
199607e4
RS
68#ifdef MSDOS
69#define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
70#endif
71#ifdef WINDOWSNT
620f13b0 72#define IS_DRIVE(x) c_isalpha (x)
199607e4 73#endif
f54b565c 74/* Need to lower-case the drive letter, or else expanded
53964682 75 filenames will sometimes compare unequal, because
f54b565c 76 `expand-file-name' doesn't always down-case the drive letter. */
620f13b0 77#define DRIVE_LETTER(x) c_tolower (x)
199607e4
RS
78#endif
79
de5bf5d3 80#include "systime.h"
d35af63c 81#include <stat-time.h>
570d7624
JB
82
83#ifdef HPUX
84#include <netio.h>
47e7b9e5 85#endif
570d7624 86
9c856db9 87#include "commands.h"
9c856db9 88
f75d7a91
PE
89/* True during writing of auto-save files. */
90static bool auto_saving;
570d7624 91
71873e2b 92/* Nonzero umask during creation of auto-save directories. */
f75d7a91 93static mode_t auto_saving_dir_umask;
09450bae 94
570d7624 95/* Set by auto_save_1 to mode of original file so Fwrite_region will create
71873e2b 96 a new file with the same mode as the original. */
f75d7a91 97static mode_t auto_save_mode_bits;
570d7624 98
71873e2b 99/* Set by auto_save_1 if an error occurred during the last auto-save. */
f75d7a91 100static bool auto_save_error_occurred;
ca730bf0 101
356a6224
KH
102/* The symbol bound to coding-system-for-read when
103 insert-file-contents is called for recovering a file. This is not
104 an actual coding system name, but just an indicator to tell
105 insert-file-contents to use `emacs-mule' with a special flag for
106 auto saving and recovering a file. */
955cbe7b 107static Lisp_Object Qauto_save_coding;
356a6224 108
f6c9b683
RS
109/* Property name of a file name handler,
110 which gives a list of operations it handles.. */
955cbe7b 111static Lisp_Object Qoperations;
f6c9b683 112
71873e2b 113/* Lisp functions for translating file formats. */
955cbe7b 114static Lisp_Object Qformat_decode, Qformat_annotate_function;
0d420e88 115
2080470e 116/* Lisp function for setting buffer-file-coding-system and the
b6426b03 117 multibyteness of the current buffer after inserting a file. */
955cbe7b 118static Lisp_Object Qafter_insert_file_set_coding;
b6426b03 119
955cbe7b 120static Lisp_Object Qwrite_region_annotate_functions;
67fbc0cb
CY
121/* Each time an annotation function changes the buffer, the new buffer
122 is added here. */
5045092b 123static Lisp_Object Vwrite_region_annotation_buffers;
67fbc0cb 124
ccf61795 125#ifdef HAVE_FSYNC
ccf61795
RF
126#endif
127
955cbe7b 128static Lisp_Object Qdelete_by_moving_to_trash;
d2b66acf 129
6cf29fe8 130/* Lisp function for moving files to trash. */
955cbe7b 131static Lisp_Object Qmove_file_to_trash;
6cf29fe8 132
8719abec 133/* Lisp function for recursively copying directories. */
955cbe7b 134static Lisp_Object Qcopy_directory;
8719abec
CY
135
136/* Lisp function for recursively deleting directories. */
955cbe7b 137static Lisp_Object Qdelete_directory;
8719abec 138
c1c4693e 139#ifdef WINDOWSNT
c1c4693e
RS
140#endif
141
955cbe7b
PE
142Lisp_Object Qfile_error;
143static Lisp_Object Qfile_already_exists, Qfile_date_error;
144static Lisp_Object Qexcl;
15c65264
RS
145Lisp_Object Qfile_name_history;
146
955cbe7b 147static Lisp_Object Qcar_less_than_car;
d6a3cc15 148
f75d7a91
PE
149static bool a_write (int, Lisp_Object, ptrdiff_t, ptrdiff_t,
150 Lisp_Object *, struct coding_system *);
151static bool e_write (int, Lisp_Object, ptrdiff_t, ptrdiff_t,
152 struct coding_system *);
ce51c54c 153
ec7adf26 154\f
5d01d666 155void
971de7fb 156report_file_error (const char *string, Lisp_Object data)
570d7624
JB
157{
158 Lisp_Object errstring;
505ab9bc 159 int errorno = errno;
d7259fdb 160 char *str;
570d7624 161
ca9c0567 162 synchronize_system_messages_locale ();
d7259fdb 163 str = strerror (errorno);
d7ea76b4 164 errstring = code_convert_string_norecord (build_unibyte_string (str),
68c45bf0
PE
165 Vlocale_coding_system, 0);
166
570d7624 167 while (1)
505ab9bc
RS
168 switch (errorno)
169 {
170 case EEXIST:
24b1ddad 171 xsignal (Qfile_already_exists, Fcons (errstring, data));
505ab9bc
RS
172 break;
173 default:
174 /* System error messages are capitalized. Downcase the initial
39824137
EZ
175 unless it is followed by a slash. (The slash case caters to
176 error messages that begin with "I/O" or, in German, "E/A".) */
d5443ffd
KH
177 if (STRING_MULTIBYTE (errstring)
178 && ! EQ (Faref (errstring, make_number (1)), make_number ('/')))
6c0969ca
KH
179 {
180 int c;
181
51b59d79 182 str = SSDATA (errstring);
5976c3fe 183 c = STRING_CHAR ((unsigned char *) str);
5da9919f 184 Faset (errstring, make_number (0), make_number (downcase (c)));
6c0969ca 185 }
505ab9bc 186
24b1ddad 187 xsignal (Qfile_error,
505ab9bc
RS
188 Fcons (build_string (string), Fcons (errstring, data)));
189 }
570d7624 190}
b5148e85 191
b27a1703 192Lisp_Object
971de7fb 193close_file_unwind (Lisp_Object fd)
b5148e85 194{
68c45bf0 195 emacs_close (XFASTINT (fd));
b27a1703 196 return Qnil;
b5148e85 197}
a1d2b64a
RS
198
199/* Restore point, having saved it as a marker. */
200
5dcde606 201Lisp_Object
971de7fb 202restore_point_unwind (Lisp_Object location)
a1d2b64a 203{
ec7adf26 204 Fgoto_char (location);
a1d2b64a 205 Fset_marker (location, Qnil, Qnil);
b27a1703 206 return Qnil;
a1d2b64a 207}
59c94f03 208
570d7624 209\f
955cbe7b
PE
210static Lisp_Object Qexpand_file_name;
211static Lisp_Object Qsubstitute_in_file_name;
212static Lisp_Object Qdirectory_file_name;
213static Lisp_Object Qfile_name_directory;
214static Lisp_Object Qfile_name_nondirectory;
215static Lisp_Object Qunhandled_file_name_directory;
216static Lisp_Object Qfile_name_as_directory;
217static Lisp_Object Qcopy_file;
218static Lisp_Object Qmake_directory_internal;
219static Lisp_Object Qmake_directory;
220static Lisp_Object Qdelete_directory_internal;
32f4334d 221Lisp_Object Qdelete_file;
955cbe7b
PE
222static Lisp_Object Qrename_file;
223static Lisp_Object Qadd_name_to_file;
224static Lisp_Object Qmake_symbolic_link;
32f4334d 225Lisp_Object Qfile_exists_p;
955cbe7b
PE
226static Lisp_Object Qfile_executable_p;
227static Lisp_Object Qfile_readable_p;
228static Lisp_Object Qfile_writable_p;
229static Lisp_Object Qfile_symlink_p;
230static Lisp_Object Qaccess_file;
32f4334d 231Lisp_Object Qfile_directory_p;
955cbe7b
PE
232static Lisp_Object Qfile_regular_p;
233static Lisp_Object Qfile_accessible_directory_p;
234static Lisp_Object Qfile_modes;
235static Lisp_Object Qset_file_modes;
236static Lisp_Object Qset_file_times;
237static Lisp_Object Qfile_selinux_context;
238static Lisp_Object Qset_file_selinux_context;
239static Lisp_Object Qfile_newer_than_file_p;
32f4334d
RS
240Lisp_Object Qinsert_file_contents;
241Lisp_Object Qwrite_region;
955cbe7b
PE
242static Lisp_Object Qverify_visited_file_modtime;
243static Lisp_Object Qset_visited_file_modtime;
32f4334d 244
a7ca3326 245DEFUN ("find-file-name-handler", Ffind_file_name_handler,
16a97296 246 Sfind_file_name_handler, 2, 2, 0,
8c1a1077
PJ
247 doc: /* Return FILENAME's handler function for OPERATION, if it has one.
248Otherwise, return nil.
249A file name is handled if one of the regular expressions in
250`file-name-handler-alist' matches it.
251
252If OPERATION equals `inhibit-file-name-operation', then we ignore
253any handlers that are members of `inhibit-file-name-handlers',
254but we still do run any other handlers. This lets handlers
255use the standard functions without calling themselves recursively. */)
5842a27b 256 (Lisp_Object filename, Lisp_Object operation)
32f4334d 257{
642ef245 258 /* This function must not munge the match data. */
204ee271 259 Lisp_Object chain, inhibited_handlers, result;
d311d28c 260 ptrdiff_t pos = -1;
642ef245 261
204ee271 262 result = Qnil;
b7826503 263 CHECK_STRING (filename);
e4432095 264
a65970a0
RS
265 if (EQ (operation, Vinhibit_file_name_operation))
266 inhibited_handlers = Vinhibit_file_name_handlers;
267 else
268 inhibited_handlers = Qnil;
82c2d839 269
93c30b5f 270 for (chain = Vfile_name_handler_alist; CONSP (chain);
03699b14 271 chain = XCDR (chain))
32f4334d
RS
272 {
273 Lisp_Object elt;
03699b14 274 elt = XCAR (chain);
93c30b5f 275 if (CONSP (elt))
32f4334d 276 {
f6c9b683 277 Lisp_Object string = XCAR (elt);
d311d28c 278 ptrdiff_t match_pos;
f6c9b683 279 Lisp_Object handler = XCDR (elt);
68780e2a
RS
280 Lisp_Object operations = Qnil;
281
282 if (SYMBOLP (handler))
283 operations = Fget (handler, Qoperations);
f6c9b683 284
8d2ced53 285 if (STRINGP (string)
f6c9b683
RS
286 && (match_pos = fast_string_match (string, filename)) > pos
287 && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
a65970a0 288 {
f6c9b683 289 Lisp_Object tem;
a65970a0 290
03699b14 291 handler = XCDR (elt);
a65970a0
RS
292 tem = Fmemq (handler, inhibited_handlers);
293 if (NILP (tem))
8d2ced53
SM
294 {
295 result = handler;
296 pos = match_pos;
297 }
a65970a0 298 }
32f4334d 299 }
642ef245
JB
300
301 QUIT;
32f4334d 302 }
8d2ced53 303 return result;
32f4334d
RS
304}
305\f
a7ca3326 306DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
8c1a1077
PJ
307 1, 1, 0,
308 doc: /* Return the directory component in file name FILENAME.
309Return nil if FILENAME does not include a directory.
78379264 310Otherwise return a directory name.
7c2fb837 311Given a Unix syntax file name, returns a string ending in slash. */)
5842a27b 312 (Lisp_Object filename)
570d7624 313{
100c44b7 314#ifndef DOS_NT
5976c3fe 315 register const char *beg;
100c44b7 316#else
5976c3fe 317 register char *beg;
273ac8d1 318 Lisp_Object tem_fn;
100c44b7 319#endif
5976c3fe 320 register const char *p;
0bf2eed2 321 Lisp_Object handler;
570d7624 322
b7826503 323 CHECK_STRING (filename);
570d7624 324
0bf2eed2
RS
325 /* If the file name has special constructs in it,
326 call the corresponding file handler. */
3b7f6e60 327 handler = Ffind_file_name_handler (filename, Qfile_name_directory);
0bf2eed2 328 if (!NILP (handler))
2375c96a
CY
329 {
330 Lisp_Object handled_name = call2 (handler, Qfile_name_directory,
331 filename);
332 return STRINGP (handled_name) ? handled_name : Qnil;
333 }
0bf2eed2 334
199607e4 335#ifdef DOS_NT
38182d90 336 beg = alloca (SBYTES (filename) + 1);
5976c3fe 337 memcpy (beg, SSDATA (filename), SBYTES (filename) + 1);
0f3f018c 338#else
5976c3fe 339 beg = SSDATA (filename);
199607e4 340#endif
d5db4077 341 p = beg + SBYTES (filename);
570d7624 342
199607e4 343 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
199607e4 344#ifdef DOS_NT
e1dbe924 345 /* only recognize drive specifier at the beginning */
ba14e174
RS
346 && !(p[-1] == ':'
347 /* handle the "/:d:foo" and "/:foo" cases correctly */
348 && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
349 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
199607e4 350#endif
570d7624
JB
351 ) p--;
352
353 if (p == beg)
354 return Qnil;
5e570b75 355#ifdef DOS_NT
4c3c22f3 356 /* Expansion of "c:" to drive and default directory. */
ba14e174 357 if (p[-1] == ':')
4c3c22f3 358 {
4c3c22f3 359 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
5976c3fe
PE
360 char *res = alloca (MAXPATHLEN + 1);
361 char *r = res;
ba14e174
RS
362
363 if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
364 {
e99a530f 365 memcpy (res, beg, 2);
ba14e174
RS
366 beg += 2;
367 r += 2;
368 }
369
620f13b0 370 if (getdefdir (c_toupper (*beg) - 'A' + 1, r))
4c3c22f3 371 {
199607e4 372 if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
4c3c22f3
RS
373 strcat (res, "/");
374 beg = res;
375 p = beg + strlen (beg);
376 }
377 }
273ac8d1
EZ
378 tem_fn = ENCODE_FILE (make_specified_string (beg, -1, p - beg,
379 STRING_MULTIBYTE (filename)));
380 dostounix_filename (SSDATA (tem_fn));
381 return DECODE_FILE (tem_fn);
382#else /* DOS_NT */
d7231f93 383 return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
273ac8d1 384#endif /* DOS_NT */
570d7624
JB
385}
386
a7ca3326 387DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
60d67b83 388 Sfile_name_nondirectory, 1, 1, 0,
8c1a1077
PJ
389 doc: /* Return file name FILENAME sans its directory.
390For example, in a Unix-syntax file name,
391this is everything after the last slash,
392or the entire name if it contains no slash. */)
5842a27b 393 (Lisp_Object filename)
570d7624 394{
5976c3fe 395 register const char *beg, *p, *end;
0bf2eed2 396 Lisp_Object handler;
570d7624 397
b7826503 398 CHECK_STRING (filename);
570d7624 399
0bf2eed2
RS
400 /* If the file name has special constructs in it,
401 call the corresponding file handler. */
3b7f6e60 402 handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
0bf2eed2 403 if (!NILP (handler))
2375c96a
CY
404 {
405 Lisp_Object handled_name = call2 (handler, Qfile_name_nondirectory,
406 filename);
407 if (STRINGP (handled_name))
408 return handled_name;
409 error ("Invalid handler in `file-name-handler-alist'");
410 }
0bf2eed2 411
5976c3fe 412 beg = SSDATA (filename);
d5db4077 413 end = p = beg + SBYTES (filename);
570d7624 414
199607e4 415 while (p != beg && !IS_DIRECTORY_SEP (p[-1])
199607e4 416#ifdef DOS_NT
e1dbe924 417 /* only recognize drive specifier at beginning */
ba14e174
RS
418 && !(p[-1] == ':'
419 /* handle the "/:d:foo" case correctly */
420 && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
199607e4 421#endif
60d67b83
RS
422 )
423 p--;
570d7624 424
d7231f93 425 return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
570d7624 426}
642ef245 427
a7ca3326 428DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
60d67b83 429 Sunhandled_file_name_directory, 1, 1, 0,
8c1a1077
PJ
430 doc: /* Return a directly usable directory name somehow associated with FILENAME.
431A `directly usable' directory name is one that may be used without the
432intervention of any file handler.
433If FILENAME is a directly usable file itself, return
434\(file-name-directory FILENAME).
ca319910
SM
435If FILENAME refers to a file which is not accessible from a local process,
436then this should return nil.
8c1a1077
PJ
437The `call-process' and `start-process' functions use this function to
438get a current directory to run processes in. */)
5842a27b 439 (Lisp_Object filename)
642ef245
JB
440{
441 Lisp_Object handler;
442
443 /* If the file name has special constructs in it,
444 call the corresponding file handler. */
49307295 445 handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
642ef245 446 if (!NILP (handler))
2375c96a
CY
447 {
448 Lisp_Object handled_name = call2 (handler, Qunhandled_file_name_directory,
449 filename);
450 return STRINGP (handled_name) ? handled_name : Qnil;
451 }
642ef245
JB
452
453 return Ffile_name_directory (filename);
454}
455
c293e30c
DA
456/* Convert from file name SRC of length SRCLEN to directory name
457 in DST. On UNIX, just make sure there is a terminating /.
2e7cddd3 458 Return the length of DST in bytes. */
570d7624 459
c293e30c
DA
460static ptrdiff_t
461file_name_as_directory (char *dst, const char *src, ptrdiff_t srclen)
462{
463 if (srclen == 0)
8aa3a244 464 {
c293e30c
DA
465 dst[0] = '.';
466 dst[1] = '/';
467 dst[2] = '\0';
468 return 2;
8aa3a244
RS
469 }
470
c293e30c 471 strcpy (dst, src);
93f4cf88 472
c293e30c 473 if (!IS_DIRECTORY_SEP (dst[srclen - 1]))
5e570b75 474 {
c293e30c
DA
475 dst[srclen] = DIRECTORY_SEP;
476 dst[srclen + 1] = '\0';
477 srclen++;
5e570b75 478 }
199607e4 479#ifdef DOS_NT
2e7cddd3
EZ
480 {
481 Lisp_Object tem_fn = make_specified_string (dst, -1, srclen, 1);
482
483 tem_fn = ENCODE_FILE (tem_fn);
484 dostounix_filename (SSDATA (tem_fn));
485 tem_fn = DECODE_FILE (tem_fn);
486 memcpy (dst, SSDATA (tem_fn), (srclen = SBYTES (tem_fn)) + 1);
487 }
199607e4 488#endif
c293e30c 489 return srclen;
570d7624
JB
490}
491
a7ca3326 492DEFUN ("file-name-as-directory", Ffile_name_as_directory,
570d7624 493 Sfile_name_as_directory, 1, 1, 0,
0dac4f85 494 doc: /* Return a string representing the file name FILE interpreted as a directory.
8c1a1077
PJ
495This operation exists because a directory is also a file, but its name as
496a directory is different from its name as a file.
497The result can be used as the value of `default-directory'
498or passed as second argument to `expand-file-name'.
7c2fb837 499For a Unix-syntax file name, just appends a slash. */)
5842a27b 500 (Lisp_Object file)
570d7624
JB
501{
502 char *buf;
c293e30c 503 ptrdiff_t length;
0bf2eed2 504 Lisp_Object handler;
570d7624 505
b7826503 506 CHECK_STRING (file);
265a9e55 507 if (NILP (file))
570d7624 508 return Qnil;
0bf2eed2
RS
509
510 /* If the file name has special constructs in it,
511 call the corresponding file handler. */
49307295 512 handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
0bf2eed2 513 if (!NILP (handler))
2375c96a
CY
514 {
515 Lisp_Object handled_name = call2 (handler, Qfile_name_as_directory,
516 file);
517 if (STRINGP (handled_name))
518 return handled_name;
519 error ("Invalid handler in `file-name-handler-alist'");
520 }
0bf2eed2 521
38182d90 522 buf = alloca (SBYTES (file) + 10);
c293e30c
DA
523 length = file_name_as_directory (buf, SSDATA (file), SBYTES (file));
524 return make_specified_string (buf, -1, length, STRING_MULTIBYTE (file));
570d7624
JB
525}
526\f
c293e30c
DA
527/* Convert from directory name SRC of length SRCLEN to
528 file name in DST. On UNIX, just make sure there isn't
2e7cddd3 529 a terminating /. Return the length of DST in bytes. */
570d7624 530
c293e30c
DA
531static ptrdiff_t
532directory_file_name (char *dst, char *src, ptrdiff_t srclen)
570d7624 533{
570d7624
JB
534 /* Process as Unix format: just remove any final slash.
535 But leave "/" unchanged; do not change it to "". */
536 strcpy (dst, src);
c293e30c
DA
537 if (srclen > 1
538 && IS_DIRECTORY_SEP (dst[srclen - 1])
4592782e 539#ifdef DOS_NT
c293e30c 540 && !IS_ANY_SEP (dst[srclen - 2])
4592782e
RS
541#endif
542 )
c293e30c
DA
543 {
544 dst[srclen - 1] = 0;
545 srclen--;
546 }
199607e4 547#ifdef DOS_NT
2e7cddd3
EZ
548 {
549 Lisp_Object tem_fn = make_specified_string (dst, -1, srclen, 1);
550
551 tem_fn = ENCODE_FILE (tem_fn);
552 dostounix_filename (SSDATA (tem_fn));
553 tem_fn = DECODE_FILE (tem_fn);
554 memcpy (dst, SSDATA (tem_fn), (srclen = SBYTES (tem_fn)) + 1);
555 }
125feee8 556#endif
c293e30c 557 return srclen;
570d7624
JB
558}
559
a7ca3326 560DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
8c1a1077
PJ
561 1, 1, 0,
562 doc: /* Returns the file name of the directory named DIRECTORY.
563This is the name of the file that holds the data for the directory DIRECTORY.
564This operation exists because a directory is also a file, but its name as
565a directory is different from its name as a file.
7c2fb837 566In Unix-syntax, this function just removes the final slash. */)
5842a27b 567 (Lisp_Object directory)
570d7624
JB
568{
569 char *buf;
c293e30c 570 ptrdiff_t length;
0bf2eed2 571 Lisp_Object handler;
570d7624 572
b7826503 573 CHECK_STRING (directory);
570d7624 574
265a9e55 575 if (NILP (directory))
570d7624 576 return Qnil;
0bf2eed2
RS
577
578 /* If the file name has special constructs in it,
579 call the corresponding file handler. */
49307295 580 handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
0bf2eed2 581 if (!NILP (handler))
2375c96a
CY
582 {
583 Lisp_Object handled_name = call2 (handler, Qdirectory_file_name,
584 directory);
585 if (STRINGP (handled_name))
586 return handled_name;
587 error ("Invalid handler in `file-name-handler-alist'");
588 }
0bf2eed2 589
38182d90 590 buf = alloca (SBYTES (directory) + 20);
c293e30c
DA
591 length = directory_file_name (buf, SSDATA (directory), SBYTES (directory));
592 return make_specified_string (buf, -1, length, STRING_MULTIBYTE (directory));
570d7624
JB
593}
594
91433552 595static const char make_temp_name_tbl[64] =
3ce839e4
RS
596{
597 'A','B','C','D','E','F','G','H',
598 'I','J','K','L','M','N','O','P',
599 'Q','R','S','T','U','V','W','X',
600 'Y','Z','a','b','c','d','e','f',
601 'g','h','i','j','k','l','m','n',
602 'o','p','q','r','s','t','u','v',
603 'w','x','y','z','0','1','2','3',
604 '4','5','6','7','8','9','-','_'
605};
cb613bb8 606
3ce839e4
RS
607static unsigned make_temp_name_count, make_temp_name_count_initialized_p;
608
cb613bb8 609/* Value is a temporary file name starting with PREFIX, a string.
efdc16c9 610
cb613bb8
GM
611 The Emacs process number forms part of the result, so there is
612 no danger of generating a name being used by another process.
613 In addition, this function makes an attempt to choose a name
614 which has no existing file. To make this work, PREFIX should be
615 an absolute file name.
efdc16c9 616
f75d7a91 617 BASE64_P means add the pid as 3 characters in base64
cb613bb8
GM
618 encoding. In this case, 6 characters will be added to PREFIX to
619 form the file name. Otherwise, if Emacs is running on a system
620 with long file names, add the pid as a decimal number.
621
622 This function signals an error if no unique file name could be
623 generated. */
624
625Lisp_Object
f75d7a91 626make_temp_name (Lisp_Object prefix, bool base64_p)
570d7624
JB
627{
628 Lisp_Object val;
0cedd530 629 int len, clen;
a81d11a3 630 printmax_t pid;
5976c3fe 631 char *p, *data;
a81d11a3 632 char pidbuf[INT_BUFSIZE_BOUND (printmax_t)];
3ce839e4 633 int pidlen;
efdc16c9 634
b7826503 635 CHECK_STRING (prefix);
3ce839e4
RS
636
637 /* VAL is created by adding 6 characters to PREFIX. The first
638 three are the PID of this process, in base 64, and the second
639 three are incremented if the file already exists. This ensures
640 262144 unique file names per PID per PREFIX. */
641
93f4cf88 642 pid = getpid ();
3ce839e4 643
cb613bb8
GM
644 if (base64_p)
645 {
646 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
647 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
648 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
649 pidlen = 3;
650 }
651 else
652 {
3ce839e4 653#ifdef HAVE_LONG_FILE_NAMES
a81d11a3 654 pidlen = sprintf (pidbuf, "%"pMd, pid);
3a3bfb18 655#else
cb613bb8
GM
656 pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
657 pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
658 pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
659 pidlen = 3;
3ce839e4 660#endif
cb613bb8 661 }
efdc16c9 662
0cedd530
SM
663 len = SBYTES (prefix); clen = SCHARS (prefix);
664 val = make_uninit_multibyte_string (clen + 3 + pidlen, len + 3 + pidlen);
665 if (!STRING_MULTIBYTE (prefix))
666 STRING_SET_UNIBYTE (val);
5976c3fe
PE
667 data = SSDATA (val);
668 memcpy (data, SSDATA (prefix), len);
3ce839e4
RS
669 p = data + len;
670
72af86bd 671 memcpy (p, pidbuf, pidlen);
3ce839e4
RS
672 p += pidlen;
673
674 /* Here we try to minimize useless stat'ing when this function is
675 invoked many times successively with the same PREFIX. We achieve
676 this by initializing count to a random value, and incrementing it
f6a492a9
RS
677 afterwards.
678
679 We don't want make-temp-name to be called while dumping,
680 because then make_temp_name_count_initialized_p would get set
681 and then make_temp_name_count would not be set when Emacs starts. */
682
3ce839e4
RS
683 if (!make_temp_name_count_initialized_p)
684 {
327eeec8 685 make_temp_name_count = time (NULL);
3ce839e4
RS
686 make_temp_name_count_initialized_p = 1;
687 }
688
689 while (1)
690 {
8a7777fc 691 unsigned num = make_temp_name_count;
3ce839e4
RS
692
693 p[0] = make_temp_name_tbl[num & 63], num >>= 6;
694 p[1] = make_temp_name_tbl[num & 63], num >>= 6;
695 p[2] = make_temp_name_tbl[num & 63], num >>= 6;
696
8a7777fc
RS
697 /* Poor man's congruential RN generator. Replace with
698 ++make_temp_name_count for debugging. */
699 make_temp_name_count += 25229;
700 make_temp_name_count %= 225307;
701
bb385a92 702 if (!check_existing (data))
3ce839e4
RS
703 {
704 /* We want to return only if errno is ENOENT. */
705 if (errno == ENOENT)
706 return val;
707 else
708 /* The error here is dubious, but there is little else we
709 can do. The alternatives are to return nil, which is
710 as bad as (and in many cases worse than) throwing the
711 error, or to ignore the error, which will likely result
8a7777fc 712 in looping through 225307 stat's, which is not only
410ed5c3
PE
713 dog-slow, but also useless since eventually nil would
714 have to be returned anyway. */
9869bb0b 715 report_file_error ("Cannot create temporary name for prefix",
3ce839e4
RS
716 Fcons (prefix, Qnil));
717 /* not reached */
718 }
719 }
570d7624 720}
3ce839e4 721
cb613bb8
GM
722
723DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
8c1a1077
PJ
724 doc: /* Generate temporary file name (string) starting with PREFIX (a string).
725The Emacs process number forms part of the result,
726so there is no danger of generating a name being used by another process.
727
728In addition, this function makes an attempt to choose a name
729which has no existing file. To make this work,
730PREFIX should be an absolute file name.
731
732There is a race condition between calling `make-temp-name' and creating the
733file which opens all kinds of security holes. For that reason, you should
f9e6f049
RS
734probably use `make-temp-file' instead, except in three circumstances:
735
736* If you are creating the file in the user's home directory.
737* If you are creating a directory rather than an ordinary file.
738* If you are taking special precautions as `make-temp-file' does. */)
5842a27b 739 (Lisp_Object prefix)
cb613bb8
GM
740{
741 return make_temp_name (prefix, 0);
742}
743
744
570d7624 745\f
a7ca3326 746DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
8c1a1077
PJ
747 doc: /* Convert filename NAME to absolute, and canonicalize it.
748Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
78379264 749\(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
a4e03fe5 750the current buffer's value of `default-directory' is used.
1b2a627f
EZ
751NAME should be a string that is a valid file name for the underlying
752filesystem.
8c1a1077
PJ
753File name components that are `.' are removed, and
754so are file name components followed by `..', along with the `..' itself;
755note that these simplifications are done without checking the resulting
756file names in the file system.
15579471
EZ
757Multiple consecutive slashes are collapsed into a single slash,
758except at the beginning of the file name when they are significant (e.g.,
759UNC file names on MS-Windows.)
8c1a1077
PJ
760An initial `~/' expands to your home directory.
761An initial `~USER/' expands to USER's home directory.
07114296
CY
762See also the function `substitute-in-file-name'.
763
764For technical reasons, this function can return correct but
765non-intuitive results for the root directory; for instance,
766\(expand-file-name ".." "/") returns "/..". For this reason, use
15579471 767\(directory-file-name (file-name-directory dirname)) to traverse a
07114296 768filesystem tree, not (expand-file-name ".." dirname). */)
5842a27b 769 (Lisp_Object name, Lisp_Object default_directory)
570d7624 770{
5b5a2ea1
SM
771 /* These point to SDATA and need to be careful with string-relocation
772 during GC (via DECODE_FILE). */
2893f146
PE
773 char *nm;
774 const char *newdir;
5b5a2ea1 775 /* This should only point to alloca'd data. */
5976c3fe 776 char *target;
199607e4 777
93f4cf88 778 ptrdiff_t tlen;
570d7624 779 struct passwd *pw;
5e570b75 780#ifdef DOS_NT
199607e4 781 int drive = 0;
f75d7a91
PE
782 bool collapse_newdir = 1;
783 bool is_escaped = 0;
5e570b75 784#endif /* DOS_NT */
93f4cf88 785 ptrdiff_t length;
2375c96a 786 Lisp_Object handler, result, handled_name;
fce31d69 787 bool multibyte;
9c06a1f3 788 Lisp_Object hdir;
199607e4 789
b7826503 790 CHECK_STRING (name);
570d7624 791
0bf2eed2
RS
792 /* If the file name has special constructs in it,
793 call the corresponding file handler. */
49307295 794 handler = Ffind_file_name_handler (name, Qexpand_file_name);
0bf2eed2 795 if (!NILP (handler))
2375c96a
CY
796 {
797 handled_name = call3 (handler, Qexpand_file_name,
798 name, default_directory);
799 if (STRINGP (handled_name))
800 return handled_name;
801 error ("Invalid handler in `file-name-handler-alist'");
802 }
803
58fc9587 804
3b7f6e60
EN
805 /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted. */
806 if (NILP (default_directory))
4b4deea2 807 default_directory = BVAR (current_buffer, directory);
82330e7f 808 if (! STRINGP (default_directory))
dd693537
EZ
809 {
810#ifdef DOS_NT
811 /* "/" is not considered a root directory on DOS_NT, so using "/"
812 here causes an infinite recursion in, e.g., the following:
813
814 (let (default-directory)
815 (expand-file-name "a"))
816
817 To avoid this, we set default_directory to the root of the
818 current drive. */
dd693537
EZ
819 default_directory = build_string (emacs_root_dir ());
820#else
821 default_directory = build_string ("/");
822#endif
823 }
58fc9587 824
3b7f6e60 825 if (!NILP (default_directory))
273e0829 826 {
3b7f6e60 827 handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
273e0829 828 if (!NILP (handler))
2375c96a
CY
829 {
830 handled_name = call3 (handler, Qexpand_file_name,
831 name, default_directory);
832 if (STRINGP (handled_name))
833 return handled_name;
834 error ("Invalid handler in `file-name-handler-alist'");
835 }
273e0829 836 }
0bf2eed2 837
5b5a2ea1 838 {
5976c3fe 839 char *o = SSDATA (default_directory);
5b5a2ea1
SM
840
841 /* Make sure DEFAULT_DIRECTORY is properly expanded.
842 It would be better to do this down below where we actually use
843 default_directory. Unfortunately, calling Fexpand_file_name recursively
844 could invoke GC, and the strings might be relocated. This would
845 be annoying because we have pointers into strings lying around
846 that would need adjusting, and people would add new pointers to
847 the code and forget to adjust them, resulting in intermittent bugs.
848 Putting this call here avoids all that crud.
849
850 The EQ test avoids infinite recursion. */
851 if (! NILP (default_directory) && !EQ (default_directory, name)
852 /* Save time in some common cases - as long as default_directory
853 is not relative, it can be canonicalized with name below (if it
854 is needed at all) without requiring it to be expanded now. */
01937013 855#ifdef DOS_NT
5b5a2ea1
SM
856 /* Detect MSDOS file names with drive specifiers. */
857 && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1])
858 && IS_DIRECTORY_SEP (o[2]))
199607e4 859#ifdef WINDOWSNT
5b5a2ea1
SM
860 /* Detect Windows file names in UNC format. */
861 && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
01937013 862#endif
199607e4
RS
863#else /* not DOS_NT */
864 /* Detect Unix absolute file names (/... alone is not absolute on
865 DOS or Windows). */
5b5a2ea1 866 && ! (IS_DIRECTORY_SEP (o[0]))
199607e4 867#endif /* not DOS_NT */
5b5a2ea1
SM
868 )
869 {
870 struct gcpro gcpro1;
f14b1c68 871
5b5a2ea1
SM
872 GCPRO1 (name);
873 default_directory = Fexpand_file_name (default_directory, Qnil);
874 UNGCPRO;
875 }
876 }
2b046a72 877 multibyte = STRING_MULTIBYTE (name);
6d060996
KH
878 if (multibyte != STRING_MULTIBYTE (default_directory))
879 {
880 if (multibyte)
881 default_directory = string_to_multibyte (default_directory);
882 else
883 {
884 name = string_to_multibyte (name);
885 multibyte = 1;
886 }
887 }
888
e8d32c7e 889 /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
38182d90 890 nm = alloca (SBYTES (name) + 1);
5976c3fe 891 memcpy (nm, SSDATA (name), SBYTES (name) + 1);
199607e4 892
565f0b98 893#ifdef DOS_NT
f0f95d31
RS
894 /* Note if special escape prefix is present, but remove for now. */
895 if (nm[0] == '/' && nm[1] == ':')
896 {
897 is_escaped = 1;
898 nm += 2;
899 }
900
199607e4 901 /* Find and remove drive specifier if present; this makes nm absolute
f0f95d31
RS
902 even if the rest of the name appears to be relative. Only look for
903 drive specifier at the beginning. */
904 if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
905 {
5976c3fe 906 drive = (unsigned char) nm[0];
f0f95d31
RS
907 nm += 2;
908 }
bb1ff1f4
GV
909
910#ifdef WINDOWSNT
911 /* If we see "c://somedir", we want to strip the first slash after the
912 colon when stripping the drive letter. Otherwise, this expands to
913 "//somedir". */
914 if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
915 nm++;
4c3c22f3 916
e8d32c7e 917 /* Discard any previous drive specifier if nm is now in UNC format. */
199607e4
RS
918 if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
919 {
920 drive = 0;
921 }
5b5a2ea1
SM
922#endif /* WINDOWSNT */
923#endif /* DOS_NT */
199607e4 924
214378ec
GM
925 /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
926 none are found, we can probably return right away. We will avoid
927 allocating a new string if name is already fully expanded. */
570d7624 928 if (
5e570b75 929 IS_DIRECTORY_SEP (nm[0])
199607e4 930#ifdef MSDOS
f0f95d31 931 && drive && !is_escaped
199607e4
RS
932#endif
933#ifdef WINDOWSNT
f0f95d31 934 && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
199607e4 935#endif
570d7624
JB
936 )
937 {
f14b1c68
JB
938 /* If it turns out that the filename we want to return is just a
939 suffix of FILENAME, we don't need to go through and edit
940 things; we just need to construct a new string using data
f75d7a91
PE
941 starting at the middle of FILENAME. If we set LOSE, that
942 means we've discovered that we can't do that cool trick. */
943 bool lose = 0;
5976c3fe 944 char *p = nm;
f14b1c68 945
570d7624
JB
946 while (*p)
947 {
199607e4 948 /* Since we know the name is absolute, we can assume that each
c77d647e
JB
949 element starts with a "/". */
950
c77d647e 951 /* "." and ".." are hairy. */
5e570b75 952 if (IS_DIRECTORY_SEP (p[0])
c77d647e 953 && p[1] == '.'
5e570b75 954 && (IS_DIRECTORY_SEP (p[2])
c77d647e 955 || p[2] == 0
5e570b75 956 || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
c77d647e 957 || p[3] == 0))))
570d7624 958 lose = 1;
214378ec
GM
959 /* We want to replace multiple `/' in a row with a single
960 slash. */
961 else if (p > nm
962 && IS_DIRECTORY_SEP (p[0])
963 && IS_DIRECTORY_SEP (p[1]))
964 lose = 1;
570d7624
JB
965 p++;
966 }
967 if (!lose)
968 {
199607e4 969#ifdef DOS_NT
087fc47a
JB
970 /* Make sure directories are all separated with /, but
971 avoid allocation of a new string when not required. */
273ac8d1
EZ
972 if (multibyte)
973 {
974 Lisp_Object tem_name = make_specified_string (nm, -1, strlen (nm),
975 multibyte);
976
977 tem_name = ENCODE_FILE (tem_name);
978 dostounix_filename (SSDATA (tem_name));
979 tem_name = DECODE_FILE (tem_name);
980 memcpy (nm, SSDATA (tem_name), SBYTES (tem_name) + 1);
981 }
982 else
983 dostounix_filename (nm);
199607e4
RS
984#ifdef WINDOWSNT
985 if (IS_DIRECTORY_SEP (nm[1]))
986 {
42a5b22f 987 if (strcmp (nm, SSDATA (name)) != 0)
2b046a72 988 name = make_specified_string (nm, -1, strlen (nm), multibyte);
199607e4
RS
989 }
990 else
991#endif
e8d32c7e 992 /* Drive must be set, so this is okay. */
5976c3fe 993 if (strcmp (nm - 2, SSDATA (name)) != 0)
199607e4 994 {
3f817c73
KH
995 char temp[] = " :";
996
2b046a72 997 name = make_specified_string (nm, -1, p - nm, multibyte);
3f817c73
KH
998 temp[0] = DRIVE_LETTER (drive);
999 name = concat2 (build_string (temp), name);
199607e4
RS
1000 }
1001 return name;
1002#else /* not DOS_NT */
42a5b22f 1003 if (strcmp (nm, SSDATA (name)) == 0)
570d7624 1004 return name;
2b046a72 1005 return make_specified_string (nm, -1, strlen (nm), multibyte);
5e570b75 1006#endif /* not DOS_NT */
570d7624
JB
1007 }
1008 }
1009
199607e4
RS
1010 /* At this point, nm might or might not be an absolute file name. We
1011 need to expand ~ or ~user if present, otherwise prefix nm with
1012 default_directory if nm is not absolute, and finally collapse /./
1013 and /foo/../ sequences.
1014
1015 We set newdir to be the appropriate prefix if one is needed:
1016 - the relevant user directory if nm starts with ~ or ~user
1017 - the specified drive's working dir (DOS/NT only) if nm does not
1018 start with /
1019 - the value of default_directory.
1020
1021 Note that these prefixes are not guaranteed to be absolute (except
1022 for the working dir of a drive). Therefore, to ensure we always
1023 return an absolute name, if the final prefix is not absolute we
1024 append it to the current working directory. */
570d7624
JB
1025
1026 newdir = 0;
1027
1028 if (nm[0] == '~') /* prefix ~ */
c77d647e 1029 {
5e570b75 1030 if (IS_DIRECTORY_SEP (nm[1])
c77d647e
JB
1031 || nm[1] == 0) /* ~ by itself */
1032 {
6d557778
EZ
1033 Lisp_Object tem;
1034
5976c3fe
PE
1035 if (!(newdir = egetenv ("HOME")))
1036 newdir = "";
199607e4 1037 nm++;
e8d32c7e 1038 /* `egetenv' may return a unibyte string, which will bite us since
6d557778 1039 we expect the directory to be multibyte. */
9c06a1f3
EZ
1040 tem = build_string (newdir);
1041 if (!STRING_MULTIBYTE (tem))
1042 {
1043 hdir = DECODE_FILE (tem);
5976c3fe 1044 newdir = SSDATA (hdir);
9c06a1f3 1045 }
5e570b75 1046#ifdef DOS_NT
9a1dc3be 1047 collapse_newdir = 0;
4c3c22f3 1048#endif
c77d647e
JB
1049 }
1050 else /* ~user/filename */
1051 {
5976c3fe 1052 char *o, *p;
7c2fb837 1053 for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)); p++);
5b5a2ea1 1054 o = alloca (p - nm + 1);
72af86bd 1055 memcpy (o, nm, p - nm);
c77d647e
JB
1056 o [p - nm] = 0;
1057
4d7e6e51 1058 block_input ();
350e0088 1059 pw = getpwnam (o + 1);
4d7e6e51 1060 unblock_input ();
c77d647e
JB
1061 if (pw)
1062 {
5976c3fe 1063 newdir = pw->pw_dir;
c77d647e 1064 nm = p;
199607e4 1065#ifdef DOS_NT
9a1dc3be 1066 collapse_newdir = 0;
199607e4 1067#endif
c77d647e 1068 }
e5d77022 1069
c77d647e
JB
1070 /* If we don't find a user of that name, leave the name
1071 unchanged; don't move nm forward to p. */
1072 }
1073 }
570d7624 1074
5e570b75 1075#ifdef DOS_NT
199607e4
RS
1076 /* On DOS and Windows, nm is absolute if a drive name was specified;
1077 use the drive's current directory as the prefix if needed. */
1078 if (!newdir && drive)
1079 {
e8d32c7e 1080 /* Get default directory if needed to make nm absolute. */
2893f146 1081 char *adir = NULL;
199607e4
RS
1082 if (!IS_DIRECTORY_SEP (nm[0]))
1083 {
2893f146 1084 adir = alloca (MAXPATHLEN + 1);
620f13b0 1085 if (!getdefdir (c_toupper (drive) - 'A' + 1, adir))
2893f146 1086 adir = NULL;
199607e4 1087 }
2893f146 1088 if (!adir)
199607e4 1089 {
e8d32c7e 1090 /* Either nm starts with /, or drive isn't mounted. */
2893f146
PE
1091 adir = alloca (4);
1092 adir[0] = DRIVE_LETTER (drive);
1093 adir[1] = ':';
1094 adir[2] = '/';
1095 adir[3] = 0;
199607e4 1096 }
2893f146 1097 newdir = adir;
199607e4 1098 }
5e570b75 1099#endif /* DOS_NT */
199607e4
RS
1100
1101 /* Finally, if no prefix has been specified and nm is not absolute,
e8d32c7e 1102 then it must be expanded relative to default_directory. */
199607e4 1103
34097368 1104 if (1
199607e4 1105#ifndef DOS_NT
e8d32c7e 1106 /* /... alone is not absolute on DOS and Windows. */
34097368 1107 && !IS_DIRECTORY_SEP (nm[0])
199607e4
RS
1108#endif
1109#ifdef WINDOWSNT
34097368 1110 && !(IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
199607e4 1111#endif
570d7624
JB
1112 && !newdir)
1113 {
5976c3fe 1114 newdir = SSDATA (default_directory);
f0f95d31
RS
1115#ifdef DOS_NT
1116 /* Note if special escape prefix is present, but remove for now. */
1117 if (newdir[0] == '/' && newdir[1] == ':')
1118 {
1119 is_escaped = 1;
1120 newdir += 2;
1121 }
1122#endif
570d7624
JB
1123 }
1124
5e570b75 1125#ifdef DOS_NT
199607e4
RS
1126 if (newdir)
1127 {
e8d32c7e 1128 /* First ensure newdir is an absolute name. */
199607e4
RS
1129 if (
1130 /* Detect MSDOS file names with drive specifiers. */
1131 ! (IS_DRIVE (newdir[0])
1132 && IS_DEVICE_SEP (newdir[1]) && IS_DIRECTORY_SEP (newdir[2]))
1133#ifdef WINDOWSNT
1134 /* Detect Windows file names in UNC format. */
1135 && ! (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1136#endif
1137 )
1138 {
1139 /* Effectively, let newdir be (expand-file-name newdir cwd).
1140 Because of the admonition against calling expand-file-name
1141 when we have pointers into lisp strings, we accomplish this
1142 indirectly by prepending newdir to nm if necessary, and using
e8d32c7e 1143 cwd (or the wd of newdir's drive) as the new newdir. */
2893f146 1144 char *adir;
c70a4df6 1145 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
199607e4 1146 {
5976c3fe 1147 drive = (unsigned char) newdir[0];
199607e4
RS
1148 newdir += 2;
1149 }
1150 if (!IS_DIRECTORY_SEP (nm[0]))
1151 {
c293e30c
DA
1152 ptrdiff_t newlen = strlen (newdir);
1153 char *tmp = alloca (newlen + strlen (nm) + 2);
1154 file_name_as_directory (tmp, newdir, newlen);
199607e4
RS
1155 strcat (tmp, nm);
1156 nm = tmp;
1157 }
2893f146 1158 adir = alloca (MAXPATHLEN + 1);
199607e4
RS
1159 if (drive)
1160 {
620f13b0 1161 if (!getdefdir (c_toupper (drive) - 'A' + 1, adir))
199607e4
RS
1162 newdir = "/";
1163 }
1164 else
9239d970 1165 getcwd (adir, MAXPATHLEN + 1);
2893f146 1166 newdir = adir;
199607e4
RS
1167 }
1168
e8d32c7e 1169 /* Strip off drive name from prefix, if present. */
c70a4df6 1170 if (IS_DRIVE (newdir[0]) && IS_DEVICE_SEP (newdir[1]))
199607e4
RS
1171 {
1172 drive = newdir[0];
1173 newdir += 2;
1174 }
1175
1176 /* Keep only a prefix from newdir if nm starts with slash
82330e7f 1177 (//server/share for UNC, nothing otherwise). */
9a1dc3be 1178 if (IS_DIRECTORY_SEP (nm[0]) && collapse_newdir)
199607e4
RS
1179 {
1180#ifdef WINDOWSNT
1181 if (IS_DIRECTORY_SEP (newdir[0]) && IS_DIRECTORY_SEP (newdir[1]))
1182 {
2893f146
PE
1183 char *adir = strcpy (alloca (strlen (newdir) + 1), newdir);
1184 char *p = adir + 2;
199607e4
RS
1185 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1186 p++;
1187 while (*p && !IS_DIRECTORY_SEP (*p)) p++;
1188 *p = 0;
2893f146 1189 newdir = adir;
199607e4
RS
1190 }
1191 else
1192#endif
1193 newdir = "";
1194 }
1195 }
5e570b75 1196#endif /* DOS_NT */
199607e4
RS
1197
1198 if (newdir)
bfb61299 1199 {
57676091 1200 /* Get rid of any slash at the end of newdir, unless newdir is
f0f95d31 1201 just / or // (an incomplete UNC name). */
199607e4 1202 length = strlen (newdir);
c293e30c 1203 tlen = length + 1;
f0f95d31 1204 if (length > 1 && IS_DIRECTORY_SEP (newdir[length - 1])
57676091
RS
1205#ifdef WINDOWSNT
1206 && !(length == 2 && IS_DIRECTORY_SEP (newdir[0]))
1207#endif
1208 )
bfb61299 1209 {
38182d90 1210 char *temp = alloca (length);
72af86bd 1211 memcpy (temp, newdir, length - 1);
bfb61299 1212 temp[length - 1] = 0;
c293e30c 1213 length--;
bfb61299
JB
1214 newdir = temp;
1215 }
bfb61299
JB
1216 }
1217 else
c293e30c
DA
1218 {
1219 length = 0;
1220 tlen = 0;
1221 }
570d7624 1222
e8d32c7e 1223 /* Now concatenate the directory and name to new space in the stack frame. */
bfb61299 1224 tlen += strlen (nm) + 1;
5e570b75 1225#ifdef DOS_NT
f0f95d31
RS
1226 /* Reserve space for drive specifier and escape prefix, since either
1227 or both may need to be inserted. (The Microsoft x86 compiler
5e570b75 1228 produces incorrect code if the following two lines are combined.) */
38182d90 1229 target = alloca (tlen + 4);
f0f95d31 1230 target += 4;
5e570b75 1231#else /* not DOS_NT */
38182d90 1232 target = alloca (tlen);
5e570b75 1233#endif /* not DOS_NT */
570d7624
JB
1234 *target = 0;
1235
1236 if (newdir)
1237 {
5e570b75 1238 if (nm[0] == 0 || IS_DIRECTORY_SEP (nm[0]))
f5321b5c 1239 {
3ea2d8b2 1240#ifdef DOS_NT
f5321b5c
RS
1241 /* If newdir is effectively "C:/", then the drive letter will have
1242 been stripped and newdir will be "/". Concatenating with an
1243 absolute directory in nm produces "//", which will then be
1244 incorrectly treated as a network share. Ignore newdir in
1245 this case (keeping the drive letter). */
efdc16c9 1246 if (!(drive && nm[0] && IS_DIRECTORY_SEP (newdir[0])
f5321b5c
RS
1247 && newdir[1] == '\0'))
1248#endif
1249 strcpy (target, newdir);
1250 }
570d7624 1251 else
c293e30c 1252 file_name_as_directory (target, newdir, length);
570d7624
JB
1253 }
1254
1255 strcat (target, nm);
199607e4 1256
214378ec
GM
1257 /* Now canonicalize by removing `//', `/.' and `/foo/..' if they
1258 appear. */
5b5a2ea1 1259 {
5976c3fe
PE
1260 char *p = target;
1261 char *o = target;
570d7624 1262
5b5a2ea1
SM
1263 while (*p)
1264 {
5b5a2ea1
SM
1265 if (!IS_DIRECTORY_SEP (*p))
1266 {
1267 *o++ = *p++;
1268 }
1269 else if (p[1] == '.'
1270 && (IS_DIRECTORY_SEP (p[2])
1271 || p[2] == 0))
1272 {
1273 /* If "/." is the entire filename, keep the "/". Otherwise,
1274 just delete the whole "/.". */
1275 if (o == target && p[2] == '\0')
1276 *o++ = *p;
1277 p += 2;
1278 }
1279 else if (p[1] == '.' && p[2] == '.'
1280 /* `/../' is the "superroot" on certain file systems.
1281 Turned off on DOS_NT systems because they have no
1282 "superroot" and because this causes us to produce
1283 file names like "d:/../foo" which fail file-related
1284 functions of the underlying OS. (To reproduce, try a
1285 long series of "../../" in default_directory, longer
1286 than the number of levels from the root.) */
aa4060b9 1287#ifndef DOS_NT
5b5a2ea1 1288 && o != target
aa4060b9 1289#endif
5b5a2ea1
SM
1290 && (IS_DIRECTORY_SEP (p[3]) || p[3] == 0))
1291 {
972ed246 1292#ifdef WINDOWSNT
5976c3fe 1293 char *prev_o = o;
972ed246 1294#endif
5b5a2ea1
SM
1295 while (o != target && (--o) && !IS_DIRECTORY_SEP (*o))
1296 ;
972ed246
JR
1297#ifdef WINDOWSNT
1298 /* Don't go below server level in UNC filenames. */
1299 if (o == target + 1 && IS_DIRECTORY_SEP (*o)
1300 && IS_DIRECTORY_SEP (*target))
1301 o = prev_o;
1302 else
1303#endif
5b5a2ea1
SM
1304 /* Keep initial / only if this is the whole name. */
1305 if (o == target && IS_ANY_SEP (*o) && p[3] == 0)
1306 ++o;
1307 p += 3;
1308 }
1309 else if (p > target && IS_DIRECTORY_SEP (p[1]))
1310 /* Collapse multiple `/' in a row. */
1311 p++;
1312 else
1313 {
1314 *o++ = *p++;
1315 }
5b5a2ea1 1316 }
570d7624 1317
5e570b75 1318#ifdef DOS_NT
e8d32c7e 1319 /* At last, set drive name. */
5e570b75 1320#ifdef WINDOWSNT
5b5a2ea1
SM
1321 /* Except for network file name. */
1322 if (!(IS_DIRECTORY_SEP (target[0]) && IS_DIRECTORY_SEP (target[1])))
5e570b75 1323#endif /* WINDOWSNT */
5b5a2ea1 1324 {
1088b922 1325 if (!drive) emacs_abort ();
5b5a2ea1
SM
1326 target -= 2;
1327 target[0] = DRIVE_LETTER (drive);
1328 target[1] = ':';
1329 }
1330 /* Reinsert the escape prefix if required. */
1331 if (is_escaped)
1332 {
1333 target -= 2;
1334 target[0] = '/';
1335 target[1] = ':';
1336 }
5b5a2ea1 1337 result = make_specified_string (target, -1, o - target, multibyte);
273ac8d1
EZ
1338 result = ENCODE_FILE (result);
1339 dostounix_filename (SSDATA (result));
1340 result = DECODE_FILE (result);
1341#else /* !DOS_NT */
1342 result = make_specified_string (target, -1, o - target, multibyte);
1343#endif /* !DOS_NT */
5b5a2ea1 1344 }
beb402de
KG
1345
1346 /* Again look to see if the file name has special constructs in it
1347 and perhaps call the corresponding file handler. This is needed
1348 for filenames such as "/foo/../user@host:/bar/../baz". Expanding
1349 the ".." component gives us "/user@host:/bar/../baz" which needs
e8d32c7e 1350 to be expanded again. */
beb402de
KG
1351 handler = Ffind_file_name_handler (result, Qexpand_file_name);
1352 if (!NILP (handler))
2375c96a
CY
1353 {
1354 handled_name = call3 (handler, Qexpand_file_name,
1355 result, default_directory);
1356 if (STRINGP (handled_name))
1357 return handled_name;
1358 error ("Invalid handler in `file-name-handler-alist'");
1359 }
beb402de
KG
1360
1361 return result;
570d7624 1362}
5e570b75 1363
4887597a
EZ
1364#if 0
1365/* PLEASE DO NOT DELETE THIS COMMENTED-OUT VERSION!
1366 This is the old version of expand-file-name, before it was thoroughly
1367 rewritten for Emacs 10.31. We leave this version here commented-out,
1368 because the code is very complex and likely to have subtle bugs. If
1369 bugs _are_ found, it might be of interest to look at the old code and
1370 see what did it do in the relevant situation.
1371
30f50381
GM
1372 Don't remove this code: it's true that it will be accessible
1373 from the repository, but a few years from deletion, people will
1374 forget it is there. */
4887597a
EZ
1375
1376/* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'. */
1377DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1378 "Convert FILENAME to absolute, and canonicalize it.\n\
1379Second arg DEFAULT is directory to start with if FILENAME is relative\n\
c70a4df6 1380\(does not start with slash); if DEFAULT is nil or missing,\n\
4887597a
EZ
1381the current buffer's value of default-directory is used.\n\
1382Filenames containing `.' or `..' as components are simplified;\n\
1383initial `~/' expands to your home directory.\n\
1384See also the function `substitute-in-file-name'.")
1385 (name, defalt)
1386 Lisp_Object name, defalt;
1387{
1388 unsigned char *nm;
1389
1390 register unsigned char *newdir, *p, *o;
93f4cf88 1391 ptrdiff_t tlen;
4887597a
EZ
1392 unsigned char *target;
1393 struct passwd *pw;
4887597a 1394
b7826503 1395 CHECK_STRING (name);
d5db4077 1396 nm = SDATA (name);
4887597a
EZ
1397
1398 /* If nm is absolute, flush ...// and detect /./ and /../.
1399 If no /./ or /../ we can return right away. */
7c2fb837 1400 if (nm[0] == '/')
4887597a 1401 {
f75d7a91 1402 bool lose = 0;
4887597a 1403 p = nm;
4887597a
EZ
1404 while (*p)
1405 {
ce2fe65a 1406 if (p[0] == '/' && p[1] == '/')
4887597a
EZ
1407 nm = p + 1;
1408 if (p[0] == '/' && p[1] == '~')
1409 nm = p + 1, lose = 1;
1410 if (p[0] == '/' && p[1] == '.'
1411 && (p[2] == '/' || p[2] == 0
1412 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1413 lose = 1;
4887597a
EZ
1414 p++;
1415 }
1416 if (!lose)
1417 {
d5db4077 1418 if (nm == SDATA (name))
4887597a
EZ
1419 return name;
1420 return build_string (nm);
1421 }
1422 }
1423
e8d32c7e 1424 /* Now determine directory to start with and put it in NEWDIR. */
4887597a
EZ
1425
1426 newdir = 0;
1427
1428 if (nm[0] == '~') /* prefix ~ */
7c2fb837 1429 if (nm[1] == '/' || nm[1] == 0)/* ~/filename */
4887597a
EZ
1430 {
1431 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1432 newdir = (unsigned char *) "";
1433 nm++;
4887597a
EZ
1434 }
1435 else /* ~user/filename */
1436 {
e8d32c7e 1437 /* Get past ~ to user. */
4887597a 1438 unsigned char *user = nm + 1;
e8d32c7e 1439 /* Find end of name. */
8966b757 1440 unsigned char *ptr = (unsigned char *) strchr (user, '/');
93f4cf88 1441 ptrdiff_t len = ptr ? ptr - user : strlen (user);
e8d32c7e 1442 /* Copy the user name into temp storage. */
38182d90 1443 o = alloca (len + 1);
72af86bd 1444 memcpy (o, user, len);
4887597a
EZ
1445 o[len] = 0;
1446
e8d32c7e 1447 /* Look up the user name. */
4d7e6e51 1448 block_input ();
4887597a 1449 pw = (struct passwd *) getpwnam (o + 1);
4d7e6e51 1450 unblock_input ();
4887597a
EZ
1451 if (!pw)
1452 error ("\"%s\" isn't a registered user", o + 1);
1453
1454 newdir = (unsigned char *) pw->pw_dir;
1455
1456 /* Discard the user name from NM. */
1457 nm += len;
1458 }
1459
7c2fb837 1460 if (nm[0] != '/' && !newdir)
4887597a
EZ
1461 {
1462 if (NILP (defalt))
1463 defalt = current_buffer->directory;
b7826503 1464 CHECK_STRING (defalt);
d5db4077 1465 newdir = SDATA (defalt);
4887597a
EZ
1466 }
1467
e8d32c7e 1468 /* Now concatenate the directory and name to new space in the stack frame. */
4887597a
EZ
1469
1470 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
38182d90 1471 target = alloca (tlen);
4887597a
EZ
1472 *target = 0;
1473
1474 if (newdir)
1475 {
4887597a
EZ
1476 if (nm[0] == 0 || nm[0] == '/')
1477 strcpy (target, newdir);
1478 else
4887597a
EZ
1479 file_name_as_directory (target, newdir);
1480 }
1481
1482 strcat (target, nm);
4887597a 1483
e8d32c7e 1484 /* Now canonicalize by removing /. and /foo/.. if they appear. */
4887597a
EZ
1485
1486 p = target;
1487 o = target;
1488
1489 while (*p)
1490 {
4887597a
EZ
1491 if (*p != '/')
1492 {
1493 *o++ = *p++;
1494 }
1495 else if (!strncmp (p, "//", 2)
4887597a
EZ
1496 )
1497 {
1498 o = target;
1499 p++;
1500 }
994a7262
RS
1501 else if (p[0] == '/' && p[1] == '.'
1502 && (p[2] == '/' || p[2] == 0))
4887597a
EZ
1503 p += 2;
1504 else if (!strncmp (p, "/..", 3)
1505 /* `/../' is the "superroot" on certain file systems. */
1506 && o != target
1507 && (p[3] == '/' || p[3] == 0))
1508 {
1509 while (o != target && *--o != '/')
1510 ;
4887597a
EZ
1511 if (o == target && *o == '/')
1512 ++o;
1513 p += 3;
1514 }
1515 else
1516 {
1517 *o++ = *p++;
1518 }
4887597a
EZ
1519 }
1520
1521 return make_string (target, o - target);
1522}
1523#endif
570d7624 1524\f
c70a4df6 1525/* If /~ or // appears, discard everything through first slash. */
f75d7a91 1526static bool
5976c3fe 1527file_name_absolute_p (const char *filename)
c70a4df6
SM
1528{
1529 return
1530 (IS_DIRECTORY_SEP (*filename) || *filename == '~'
c70a4df6
SM
1531#ifdef DOS_NT
1532 || (IS_DRIVE (*filename) && IS_DEVICE_SEP (filename[1])
1533 && IS_DIRECTORY_SEP (filename[2]))
1534#endif
1535 );
1536}
1537
5976c3fe
PE
1538static char *
1539search_embedded_absfilename (char *nm, char *endp)
c70a4df6 1540{
5976c3fe 1541 char *p, *s;
c70a4df6
SM
1542
1543 for (p = nm + 1; p < endp; p++)
1544 {
ce2fe65a 1545 if (IS_DIRECTORY_SEP (p[-1])
c70a4df6 1546 && file_name_absolute_p (p)
5e617bc2 1547#if defined (WINDOWSNT) || defined (CYGWIN)
c70a4df6
SM
1548 /* // at start of file name is meaningful in Apollo,
1549 WindowsNT and Cygwin systems. */
f34574c6 1550 && !(IS_DIRECTORY_SEP (p[0]) && p - 1 == nm)
e39a993c 1551#endif /* not (WINDOWSNT || CYGWIN) */
ce2fe65a 1552 )
c70a4df6 1553 {
ce2fe65a 1554 for (s = p; *s && !IS_DIRECTORY_SEP (*s); s++);
e8d32c7e 1555 if (p[0] == '~' && s > p + 1) /* We've got "/~something/". */
c70a4df6 1556 {
5976c3fe 1557 char *o = alloca (s - p + 1);
c70a4df6 1558 struct passwd *pw;
72af86bd 1559 memcpy (o, p, s - p);
c70a4df6
SM
1560 o [s - p] = 0;
1561
1562 /* If we have ~user and `user' exists, discard
1563 everything up to ~. But if `user' does not exist, leave
1564 ~user alone, it might be a literal file name. */
4d7e6e51 1565 block_input ();
67c08d6c 1566 pw = getpwnam (o + 1);
4d7e6e51 1567 unblock_input ();
67c08d6c 1568 if (pw)
c70a4df6 1569 return p;
c70a4df6
SM
1570 }
1571 else
1572 return p;
1573 }
1574 }
1575 return NULL;
1576}
1577
a7ca3326 1578DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
8c1a1077
PJ
1579 Ssubstitute_in_file_name, 1, 1, 0,
1580 doc: /* Substitute environment variables referred to in FILENAME.
1581`$FOO' where FOO is an environment variable name means to substitute
1582the value of that variable. The variable name should be terminated
1583with a character not a letter, digit or underscore; otherwise, enclose
1584the entire variable name in braces.
c68845e0
GM
1585
1586If `/~' appears, all of FILENAME through that `/' is discarded.
1587If `//' appears, everything up to and including the first of
1588those `/' is discarded. */)
5842a27b 1589 (Lisp_Object filename)
570d7624 1590{
f75d7a91 1591 char *nm, *s, *p, *o, *x, *endp;
5976c3fe 1592 char *target = NULL;
5f460827 1593 ptrdiff_t total = 0;
f75d7a91 1594 bool substituted = 0;
fce31d69 1595 bool multibyte;
5976c3fe 1596 char *xnm;
8ce069f5 1597 Lisp_Object handler;
570d7624 1598
b7826503 1599 CHECK_STRING (filename);
570d7624 1600
58aec0d6
JR
1601 multibyte = STRING_MULTIBYTE (filename);
1602
8ce069f5
RS
1603 /* If the file name has special constructs in it,
1604 call the corresponding file handler. */
3b7f6e60 1605 handler = Ffind_file_name_handler (filename, Qsubstitute_in_file_name);
8ce069f5 1606 if (!NILP (handler))
2375c96a
CY
1607 {
1608 Lisp_Object handled_name = call2 (handler, Qsubstitute_in_file_name,
1609 filename);
1610 if (STRINGP (handled_name))
1611 return handled_name;
1612 error ("Invalid handler in `file-name-handler-alist'");
1613 }
8ce069f5 1614
58aec0d6
JR
1615 /* Always work on a copy of the string, in case GC happens during
1616 decode of environment variables, causing the original Lisp_String
1617 data to be relocated. */
38182d90 1618 nm = alloca (SBYTES (filename) + 1);
72af86bd 1619 memcpy (nm, SDATA (filename), SBYTES (filename) + 1);
0f3f018c 1620
58aec0d6 1621#ifdef DOS_NT
273ac8d1
EZ
1622 {
1623 Lisp_Object encoded_filename = ENCODE_FILE (filename);
1624 Lisp_Object tem_fn;
1625
1626 dostounix_filename (SDATA (encoded_filename));
1627 tem_fn = DECODE_FILE (encoded_filename);
1628 nm = alloca (SBYTES (tem_fn) + 1);
1629 memcpy (nm, SDATA (tem_fn), SBYTES (tem_fn) + 1);
1630 substituted = (memcmp (nm, SDATA (filename), SBYTES (filename)) != 0);
1631 if (substituted)
1632 filename = tem_fn;
1633 }
a5a1cc06 1634#endif
d5db4077 1635 endp = nm + SBYTES (filename);
570d7624 1636
82330e7f 1637 /* If /~ or // appears, discard everything through first slash. */
c70a4df6
SM
1638 p = search_embedded_absfilename (nm, endp);
1639 if (p)
1640 /* Start over with the new string, so we check the file-name-handler
1641 again. Important with filenames like "/home/foo//:/hello///there"
ee7683eb 1642 which would substitute to "/:/hello///there" rather than "/there". */
c70a4df6 1643 return Fsubstitute_in_file_name
58aec0d6 1644 (make_specified_string (p, -1, endp - p, multibyte));
570d7624
JB
1645
1646 /* See if any variables are substituted into the string
e8d32c7e 1647 and find the total length of their values in `total'. */
570d7624
JB
1648
1649 for (p = nm; p != endp;)
1650 if (*p != '$')
1651 p++;
1652 else
1653 {
1654 p++;
1655 if (p == endp)
1656 goto badsubst;
1657 else if (*p == '$')
1658 {
e8d32c7e 1659 /* "$$" means a single "$". */
570d7624
JB
1660 p++;
1661 total -= 1;
1662 substituted = 1;
1663 continue;
1664 }
1665 else if (*p == '{')
1666 {
1667 o = ++p;
1668 while (p != endp && *p != '}') p++;
1669 if (*p != '}') goto missingclose;
1670 s = p;
1671 }
1672 else
1673 {
1674 o = p;
620f13b0 1675 while (p != endp && (c_isalnum (*p) || *p == '_')) p++;
570d7624
JB
1676 s = p;
1677 }
1678
e8d32c7e 1679 /* Copy out the variable name. */
38182d90 1680 target = alloca (s - o + 1);
e99a530f 1681 memcpy (target, o, s - o);
570d7624 1682 target[s - o] = 0;
5e570b75 1683#ifdef DOS_NT
4c3c22f3 1684 strupr (target); /* $home == $HOME etc. */
5e570b75 1685#endif /* DOS_NT */
570d7624 1686
e8d32c7e 1687 /* Get variable value. */
5976c3fe 1688 o = egetenv (target);
8d2ced53 1689 if (o)
58aec0d6
JR
1690 {
1691 /* Don't try to guess a maximum length - UTF8 can use up to
1692 four bytes per character. This code is unlikely to run
1693 in a situation that requires performance, so decoding the
1694 env variables twice should be acceptable. Note that
1695 decoding may cause a garbage collect. */
1696 Lisp_Object orig, decoded;
d7ea76b4 1697 orig = build_unibyte_string (o);
58aec0d6
JR
1698 decoded = DECODE_FILE (orig);
1699 total += SBYTES (decoded);
8d2ced53
SM
1700 substituted = 1;
1701 }
1702 else if (*p == '}')
1703 goto badvar;
570d7624
JB
1704 }
1705
1706 if (!substituted)
3b7f6e60 1707 return filename;
570d7624 1708
e8d32c7e
SM
1709 /* If substitution required, recopy the string and do it. */
1710 /* Make space in stack frame for the new copy. */
38182d90 1711 xnm = alloca (SBYTES (filename) + total + 1);
570d7624
JB
1712 x = xnm;
1713
e8d32c7e 1714 /* Copy the rest of the name through, replacing $ constructs with values. */
570d7624
JB
1715 for (p = nm; *p;)
1716 if (*p != '$')
1717 *x++ = *p++;
1718 else
1719 {
1720 p++;
1721 if (p == endp)
1722 goto badsubst;
1723 else if (*p == '$')
1724 {
1725 *x++ = *p++;
1726 continue;
1727 }
1728 else if (*p == '{')
1729 {
1730 o = ++p;
1731 while (p != endp && *p != '}') p++;
1732 if (*p != '}') goto missingclose;
1733 s = p++;
1734 }
1735 else
1736 {
1737 o = p;
620f13b0 1738 while (p != endp && (c_isalnum (*p) || *p == '_')) p++;
570d7624
JB
1739 s = p;
1740 }
1741
e8d32c7e 1742 /* Copy out the variable name. */
38182d90 1743 target = alloca (s - o + 1);
e99a530f 1744 memcpy (target, o, s - o);
570d7624 1745 target[s - o] = 0;
5e570b75 1746#ifdef DOS_NT
4c3c22f3 1747 strupr (target); /* $home == $HOME etc. */
5e570b75 1748#endif /* DOS_NT */
570d7624 1749
e8d32c7e 1750 /* Get variable value. */
5976c3fe 1751 o = egetenv (target);
570d7624 1752 if (!o)
8d2ced53
SM
1753 {
1754 *x++ = '$';
1755 strcpy (x, target); x+= strlen (target);
1756 }
60d67b83
RS
1757 else
1758 {
58aec0d6 1759 Lisp_Object orig, decoded;
93f4cf88 1760 ptrdiff_t orig_length, decoded_length;
58aec0d6
JR
1761 orig_length = strlen (o);
1762 orig = make_unibyte_string (o, orig_length);
1763 decoded = DECODE_FILE (orig);
1764 decoded_length = SBYTES (decoded);
e99a530f 1765 memcpy (x, SDATA (decoded), decoded_length);
58aec0d6
JR
1766 x += decoded_length;
1767
1768 /* If environment variable needed decoding, return value
1769 needs to be multibyte. */
1770 if (decoded_length != orig_length
e99a530f 1771 || memcmp (SDATA (decoded), o, orig_length))
58aec0d6 1772 multibyte = 1;
60d67b83 1773 }
570d7624
JB
1774 }
1775
1776 *x = 0;
1777
82330e7f 1778 /* If /~ or // appears, discard everything through first slash. */
ce2fe65a 1779 while ((p = search_embedded_absfilename (xnm, x)) != NULL)
c70a4df6
SM
1780 /* This time we do not start over because we've already expanded envvars
1781 and replaced $$ with $. Maybe we should start over as well, but we'd
1782 need to quote some $ to $$ first. */
1783 xnm = p;
570d7624 1784
58aec0d6 1785 return make_specified_string (xnm, -1, x - xnm, multibyte);
570d7624
JB
1786
1787 badsubst:
1788 error ("Bad format environment-variable substitution");
1789 missingclose:
1790 error ("Missing \"}\" in environment-variable substitution");
1791 badvar:
1792 error ("Substituting nonexistent environment variable \"%s\"", target);
1793
1794 /* NOTREACHED */
6bbd7a29 1795 return Qnil;
570d7624
JB
1796}
1797\f
067ffa38 1798/* A slightly faster and more convenient way to get
298b760e 1799 (directory-file-name (expand-file-name FOO)). */
067ffa38 1800
570d7624 1801Lisp_Object
971de7fb 1802expand_and_dir_to_file (Lisp_Object filename, Lisp_Object defdir)
570d7624 1803{
199607e4 1804 register Lisp_Object absname;
570d7624 1805
199607e4 1806 absname = Fexpand_file_name (filename, defdir);
7c2fb837 1807
199607e4 1808 /* Remove final slash, if any (unless this is the root dir).
570d7624 1809 stat behaves differently depending! */
d5db4077
KR
1810 if (SCHARS (absname) > 1
1811 && IS_DIRECTORY_SEP (SREF (absname, SBYTES (absname) - 1))
e8d32c7e 1812 && !IS_DEVICE_SEP (SREF (absname, SBYTES (absname) - 2)))
ddc61f46 1813 /* We cannot take shortcuts; they might be wrong for magic file names. */
199607e4 1814 absname = Fdirectory_file_name (absname);
199607e4 1815 return absname;
570d7624
JB
1816}
1817\f
3ed15d97 1818/* Signal an error if the file ABSNAME already exists.
f75d7a91 1819 If INTERACTIVE, ask the user whether to proceed,
3ed15d97
RS
1820 and bypass the error if the user says to go ahead.
1821 QUERYSTRING is a name for the action that is being considered
1822 to alter the file.
de1d0127 1823
3ed15d97 1824 *STATPTR is used to store the stat information if the file exists.
de1d0127 1825 If the file does not exist, STATPTR->st_mode is set to 0.
b8b29dc9
RS
1826 If STATPTR is null, we don't store into it.
1827
f75d7a91 1828 If QUICK, ask for y or n, not yes or no. */
3ed15d97 1829
f14b7e14 1830static void
5976c3fe 1831barf_or_query_if_file_exists (Lisp_Object absname, const char *querystring,
f75d7a91
PE
1832 bool interactive, struct stat *statptr,
1833 bool quick)
570d7624 1834{
f75d7a91 1835 Lisp_Object tem, encoded_filename;
4018b5ef 1836 struct stat statbuf;
570d7624
JB
1837 struct gcpro gcpro1;
1838
643c73b9
RS
1839 encoded_filename = ENCODE_FILE (absname);
1840
e8d32c7e 1841 /* `stat' is a good way to tell whether the file exists,
4018b5ef 1842 regardless of what access permissions it has. */
42a5b22f 1843 if (lstat (SSDATA (encoded_filename), &statbuf) >= 0)
570d7624 1844 {
6e9b2be9 1845 if (S_ISDIR (statbuf.st_mode))
c4f2d8d4 1846 xsignal2 (Qfile_error,
ad637907 1847 build_string ("File is a directory"), absname);
c4f2d8d4 1848
570d7624 1849 if (! interactive)
24b1ddad
KS
1850 xsignal2 (Qfile_already_exists,
1851 build_string ("File already exists"), absname);
570d7624 1852 GCPRO1 (absname);
67e8e2b8
RS
1853 tem = format2 ("File %s already exists; %s anyway? ",
1854 absname, build_string (querystring));
b8b29dc9 1855 if (quick)
5616cc54 1856 tem = call1 (intern ("y-or-n-p"), tem);
b8b29dc9
RS
1857 else
1858 tem = do_yes_or_no_p (tem);
570d7624 1859 UNGCPRO;
265a9e55 1860 if (NILP (tem))
24b1ddad
KS
1861 xsignal2 (Qfile_already_exists,
1862 build_string ("File already exists"), absname);
3ed15d97
RS
1863 if (statptr)
1864 *statptr = statbuf;
1865 }
1866 else
1867 {
1868 if (statptr)
1869 statptr->st_mode = 0;
570d7624
JB
1870 }
1871 return;
1872}
1873
574c05e2 1874DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 6,
7c0f6118 1875 "fCopy file: \nGCopy %s to file: \np\nP",
8c1a1077
PJ
1876 doc: /* Copy FILE to NEWNAME. Both args must be strings.
1877If NEWNAME names a directory, copy FILE there.
795c20df
CY
1878
1879This function always sets the file modes of the output file to match
1880the input file.
1881
1882The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
1883if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
1884signal a `file-already-exists' error without overwriting. If
1885OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
1886about overwriting; this is what happens in interactive use with M-x.
1887Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
1888existing file.
c50f15d0 1889
7f08b80e 1890Fourth arg KEEP-TIME non-nil means give the output file the same
8c1a1077 1891last-modified time as the old one. (This works on only some systems.)
c50f15d0 1892
7fce7dfe
EZ
1893A prefix arg makes KEEP-TIME non-nil.
1894
586702ce 1895If PRESERVE-UID-GID is non-nil, we try to transfer the
574c05e2
KK
1896uid and gid of FILE to NEWNAME.
1897
f5783df3 1898If PRESERVE-SELINUX-CONTEXT is non-nil and SELinux is enabled
574c05e2 1899on the system, we copy the SELinux context of FILE to NEWNAME. */)
5842a27b 1900 (Lisp_Object file, Lisp_Object newname, Lisp_Object ok_if_already_exists, Lisp_Object keep_time, Lisp_Object preserve_uid_gid, Lisp_Object preserve_selinux_context)
570d7624 1901{
8a2cbd72 1902 int ifd, ofd;
d311d28c 1903 int n;
570d7624 1904 char buf[16 * 1024];
3ed15d97 1905 struct stat st, out_st;
32f4334d 1906 Lisp_Object handler;
b1d1b865 1907 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
d311d28c 1908 ptrdiff_t count = SPECPDL_INDEX ();
b1d1b865 1909 Lisp_Object encoded_file, encoded_newname;
574c05e2
KK
1910#if HAVE_LIBSELINUX
1911 security_context_t con;
f75d7a91 1912 int conlength = 0;
574c05e2 1913#endif
570d7624 1914
b1d1b865
RS
1915 encoded_file = encoded_newname = Qnil;
1916 GCPRO4 (file, newname, encoded_file, encoded_newname);
b7826503
PJ
1917 CHECK_STRING (file);
1918 CHECK_STRING (newname);
b1d1b865 1919
a9d14e54 1920 if (!NILP (Ffile_directory_p (newname)))
6b61353c 1921 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
a9d14e54
GM
1922 else
1923 newname = Fexpand_file_name (newname, Qnil);
1924
3b7f6e60 1925 file = Fexpand_file_name (file, Qnil);
32f4334d 1926
0bf2eed2 1927 /* If the input file name has special constructs in it,
32f4334d 1928 call the corresponding file handler. */
3b7f6e60 1929 handler = Ffind_file_name_handler (file, Qcopy_file);
0bf2eed2 1930 /* Likewise for output file name. */
51cf6d37 1931 if (NILP (handler))
49307295 1932 handler = Ffind_file_name_handler (newname, Qcopy_file);
32f4334d 1933 if (!NILP (handler))
574c05e2
KK
1934 RETURN_UNGCPRO (call7 (handler, Qcopy_file, file, newname,
1935 ok_if_already_exists, keep_time, preserve_uid_gid,
1936 preserve_selinux_context));
32f4334d 1937
b1d1b865
RS
1938 encoded_file = ENCODE_FILE (file);
1939 encoded_newname = ENCODE_FILE (newname);
1940
265a9e55 1941 if (NILP (ok_if_already_exists)
93c30b5f 1942 || INTEGERP (ok_if_already_exists))
2f868094 1943 barf_or_query_if_file_exists (newname, "copy to it",
b8b29dc9 1944 INTEGERP (ok_if_already_exists), &out_st, 0);
42a5b22f 1945 else if (stat (SSDATA (encoded_newname), &out_st) < 0)
3ed15d97 1946 out_st.st_mode = 0;
570d7624 1947
e8691c59 1948#ifdef WINDOWSNT
d5db4077 1949 if (!CopyFile (SDATA (encoded_file),
efdc16c9 1950 SDATA (encoded_newname),
e8691c59
GM
1951 FALSE))
1952 report_file_error ("Copying file", Fcons (file, Fcons (newname, Qnil)));
8b53dc06
JR
1953 /* CopyFile retains the timestamp by default. */
1954 else if (NILP (keep_time))
e8691c59
GM
1955 {
1956 EMACS_TIME now;
ad497129
JR
1957 DWORD attributes;
1958 char * filename;
1959
d5db4077 1960 filename = SDATA (encoded_newname);
ad497129
JR
1961
1962 /* Ensure file is writable while its modified time is set. */
1963 attributes = GetFileAttributes (filename);
02cca86b 1964 SetFileAttributes (filename, attributes & ~FILE_ATTRIBUTE_READONLY);
e9a9ae03 1965 now = current_emacs_time ();
d35af63c 1966 if (set_file_times (-1, filename, now, now))
ad497129
JR
1967 {
1968 /* Restore original attributes. */
1969 SetFileAttributes (filename, attributes);
24b1ddad
KS
1970 xsignal2 (Qfile_date_error,
1971 build_string ("Cannot set file date"), newname);
ad497129
JR
1972 }
1973 /* Restore original attributes. */
1974 SetFileAttributes (filename, attributes);
e8691c59
GM
1975 }
1976#else /* not WINDOWSNT */
13336908 1977 immediate_quit = 1;
42a5b22f 1978 ifd = emacs_open (SSDATA (encoded_file), O_RDONLY, 0);
13336908
RS
1979 immediate_quit = 0;
1980
570d7624 1981 if (ifd < 0)
3b7f6e60 1982 report_file_error ("Opening input file", Fcons (file, Qnil));
570d7624 1983
b5148e85
RS
1984 record_unwind_protect (close_file_unwind, make_number (ifd));
1985
d20704ef
PE
1986 if (fstat (ifd, &st) != 0)
1987 report_file_error ("Input file status", Fcons (file, Qnil));
f73b0ada 1988
574c05e2
KK
1989#if HAVE_LIBSELINUX
1990 if (!NILP (preserve_selinux_context) && is_selinux_enabled ())
1991 {
1992 conlength = fgetfilecon (ifd, &con);
1993 if (conlength == -1)
1994 report_file_error ("Doing fgetfilecon", Fcons (file, Qnil));
1995 }
1996#endif
1997
3ed15d97
RS
1998 if (out_st.st_mode != 0
1999 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
2000 {
2001 errno = 0;
2002 report_file_error ("Input and output files are the same",
3b7f6e60 2003 Fcons (file, Fcons (newname, Qnil)));
3ed15d97 2004 }
3ed15d97 2005
d20704ef
PE
2006 /* We can copy only regular files. */
2007 if (!S_ISREG (st.st_mode))
f73b0ada 2008 {
d20704ef
PE
2009 /* Get a better looking error message. */
2010 errno = S_ISDIR (st.st_mode) ? EISDIR : EINVAL;
2011 report_file_error ("Non-regular file", Fcons (file, Qnil));
f73b0ada 2012 }
f73b0ada 2013
4c3c22f3
RS
2014#ifdef MSDOS
2015 /* System's default file type was set to binary by _fmode in emacs.c. */
c50f15d0 2016 ofd = emacs_open (SDATA (encoded_newname),
7fce7dfe 2017 O_WRONLY | O_TRUNC | O_CREAT
795c20df 2018 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
c50f15d0
RS
2019 S_IREAD | S_IWRITE);
2020#else /* not MSDOS */
15e3a074 2021 {
d20704ef
PE
2022 mode_t new_mask = !NILP (preserve_uid_gid) ? 0600 : 0666;
2023 new_mask &= st.st_mode;
15e3a074
PE
2024 ofd = emacs_open (SSDATA (encoded_newname),
2025 (O_WRONLY | O_TRUNC | O_CREAT
2026 | (NILP (ok_if_already_exists) ? O_EXCL : 0)),
2027 new_mask);
2028 }
4c3c22f3 2029#endif /* not MSDOS */
570d7624 2030 if (ofd < 0)
3ed15d97 2031 report_file_error ("Opening output file", Fcons (newname, Qnil));
b5148e85
RS
2032
2033 record_unwind_protect (close_file_unwind, make_number (ofd));
570d7624 2034
b5148e85
RS
2035 immediate_quit = 1;
2036 QUIT;
68c45bf0
PE
2037 while ((n = emacs_read (ifd, buf, sizeof buf)) > 0)
2038 if (emacs_write (ofd, buf, n) != n)
3ed15d97 2039 report_file_error ("I/O error", Fcons (newname, Qnil));
b5148e85 2040 immediate_quit = 0;
570d7624 2041
b016179b
EZ
2042#ifndef MSDOS
2043 /* Preserve the original file modes, and if requested, also its
2044 owner and group. */
d20704ef
PE
2045 {
2046 mode_t mode_mask = 07777;
2047 if (!NILP (preserve_uid_gid))
2048 {
2049 /* Attempt to change owner and group. If that doesn't work
2050 attempt to change just the group, as that is sometimes allowed.
2051 Adjust the mode mask to eliminate setuid or setgid bits
2052 that are inappropriate if the owner and group are wrong. */
2053 if (fchown (ofd, st.st_uid, st.st_gid) != 0)
2054 {
2055 mode_mask &= ~06000;
2056 if (fchown (ofd, -1, st.st_gid) == 0)
2057 mode_mask |= 02000;
2058 }
2059 }
2060 if (fchmod (ofd, st.st_mode & mode_mask) != 0)
2061 report_file_error ("Doing chmod", Fcons (newname, Qnil));
2062 }
b016179b 2063#endif /* not MSDOS */
586702ce 2064
574c05e2
KK
2065#if HAVE_LIBSELINUX
2066 if (conlength > 0)
2067 {
24c51a09 2068 /* Set the modified context back to the file. */
f75d7a91 2069 bool fail = fsetfilecon (ofd, con) != 0;
24c51a09
GM
2070 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2071 if (fail && errno != ENOTSUP)
574c05e2
KK
2072 report_file_error ("Doing fsetfilecon", Fcons (newname, Qnil));
2073
2074 freecon (con);
2075 }
2076#endif
2077
d20704ef 2078 if (!NILP (keep_time))
570d7624 2079 {
d20704ef
PE
2080 EMACS_TIME atime = get_stat_atime (&st);
2081 EMACS_TIME mtime = get_stat_mtime (&st);
2082 if (set_file_times (ofd, SSDATA (encoded_newname), atime, mtime))
2083 xsignal2 (Qfile_date_error,
2084 build_string ("Cannot set file date"), newname);
570d7624
JB
2085 }
2086
d35af63c
PE
2087 if (emacs_close (ofd) < 0)
2088 report_file_error ("I/O error", Fcons (newname, Qnil));
2089
68c45bf0 2090 emacs_close (ifd);
b016179b 2091
ed68db4d 2092#ifdef MSDOS
d20704ef
PE
2093 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2094 and if it can't, it tells so. Otherwise, under MSDOS we usually
2095 get only the READ bit, which will make the copied file read-only,
2096 so it's better not to chmod at all. */
2097 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2098 chmod (SDATA (encoded_newname), st.st_mode & 07777);
ed68db4d 2099#endif /* MSDOS */
b016179b 2100#endif /* not WINDOWSNT */
5acac34e 2101
b5148e85
RS
2102 /* Discard the unwind protects. */
2103 specpdl_ptr = specpdl + count;
2104
570d7624
JB
2105 UNGCPRO;
2106 return Qnil;
2107}
385b6cc7 2108\f
9bbe01fb 2109DEFUN ("make-directory-internal", Fmake_directory_internal,
353cfc19 2110 Smake_directory_internal, 1, 1, 0,
8c1a1077 2111 doc: /* Create a new directory named DIRECTORY. */)
5842a27b 2112 (Lisp_Object directory)
570d7624 2113{
5976c3fe 2114 const char *dir;
32f4334d 2115 Lisp_Object handler;
b1d1b865 2116 Lisp_Object encoded_dir;
570d7624 2117
b7826503 2118 CHECK_STRING (directory);
3b7f6e60 2119 directory = Fexpand_file_name (directory, Qnil);
32f4334d 2120
3b7f6e60 2121 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
32f4334d 2122 if (!NILP (handler))
3b7f6e60 2123 return call2 (handler, Qmake_directory_internal, directory);
9bbe01fb 2124
b1d1b865
RS
2125 encoded_dir = ENCODE_FILE (directory);
2126
5976c3fe 2127 dir = SSDATA (encoded_dir);
570d7624 2128
5e570b75
RS
2129#ifdef WINDOWSNT
2130 if (mkdir (dir) != 0)
2131#else
09450bae 2132 if (mkdir (dir, 0777 & ~auto_saving_dir_umask) != 0)
5e570b75 2133#endif
a9f2aeae 2134 report_file_error ("Creating directory", list1 (directory));
570d7624 2135
32f4334d 2136 return Qnil;
570d7624
JB
2137}
2138
9d8f3bd9
MA
2139DEFUN ("delete-directory-internal", Fdelete_directory_internal,
2140 Sdelete_directory_internal, 1, 1, 0,
efdc16c9 2141 doc: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
5842a27b 2142 (Lisp_Object directory)
570d7624 2143{
5976c3fe 2144 const char *dir;
b1d1b865 2145 Lisp_Object encoded_dir;
570d7624 2146
b7826503 2147 CHECK_STRING (directory);
3b7f6e60 2148 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
b1d1b865 2149 encoded_dir = ENCODE_FILE (directory);
5976c3fe 2150 dir = SSDATA (encoded_dir);
b1d1b865 2151
570d7624 2152 if (rmdir (dir) != 0)
a9f2aeae 2153 report_file_error ("Removing directory", list1 (directory));
570d7624
JB
2154
2155 return Qnil;
2156}
2157
2e2bbddb 2158DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 2,
f1a5d776
CY
2159 "(list (read-file-name \
2160 (if (and delete-by-moving-to-trash (null current-prefix-arg)) \
2161 \"Move file to trash: \" \"Delete file: \") \
2162 nil default-directory (confirm-nonexistent-file-or-buffer)) \
2163 (null current-prefix-arg))",
efdc16c9 2164 doc: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
53967e09 2165If file has multiple names, it continues to exist with the other names.
f1a5d776
CY
2166TRASH non-nil means to trash the file instead of deleting, provided
2167`delete-by-moving-to-trash' is non-nil.
53967e09 2168
f1a5d776
CY
2169When called interactively, TRASH is t if no prefix argument is given.
2170With a prefix argument, TRASH is nil. */)
5842a27b 2171 (Lisp_Object filename, Lisp_Object trash)
570d7624 2172{
32f4334d 2173 Lisp_Object handler;
b1d1b865 2174 Lisp_Object encoded_file;
efdc16c9 2175 struct gcpro gcpro1;
b1d1b865 2176
efdc16c9 2177 GCPRO1 (filename);
b4bd27c5
RS
2178 if (!NILP (Ffile_directory_p (filename))
2179 && NILP (Ffile_symlink_p (filename)))
24b1ddad
KS
2180 xsignal2 (Qfile_error,
2181 build_string ("Removing old name: is a directory"),
2182 filename);
efdc16c9 2183 UNGCPRO;
570d7624 2184 filename = Fexpand_file_name (filename, Qnil);
32f4334d 2185
49307295 2186 handler = Ffind_file_name_handler (filename, Qdelete_file);
32f4334d 2187 if (!NILP (handler))
f5783df3 2188 return call3 (handler, Qdelete_file, filename, trash);
32f4334d 2189
f1a5d776 2190 if (delete_by_moving_to_trash && !NILP (trash))
6cf29fe8
JR
2191 return call1 (Qmove_file_to_trash, filename);
2192
b1d1b865
RS
2193 encoded_file = ENCODE_FILE (filename);
2194
ce2fe65a 2195 if (unlink (SSDATA (encoded_file)) < 0)
a9f2aeae 2196 report_file_error ("Removing old name", list1 (filename));
8a9b0da9 2197 return Qnil;
570d7624
JB
2198}
2199
385b6cc7 2200static Lisp_Object
971de7fb 2201internal_delete_file_1 (Lisp_Object ignore)
385b6cc7
RS
2202{
2203 return Qt;
2204}
2205
7d80ea23 2206/* Delete file FILENAME, returning true if successful.
f1a5d776 2207 This ignores `delete-by-moving-to-trash'. */
385b6cc7 2208
7d80ea23 2209bool
f1a5d776 2210internal_delete_file (Lisp_Object filename)
385b6cc7 2211{
b0728617
EZ
2212 Lisp_Object tem;
2213
2214 tem = internal_condition_case_2 (Fdelete_file, filename, Qnil,
2215 Qt, internal_delete_file_1);
2216 return NILP (tem);
385b6cc7
RS
2217}
2218\f
570d7624 2219DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
7c0f6118 2220 "fRename file: \nGRename %s to file: \np",
a4e03fe5 2221 doc: /* Rename FILE as NEWNAME. Both args must be strings.
8c1a1077
PJ
2222If file has names other than FILE, it continues to have those names.
2223Signals a `file-already-exists' error if a file NEWNAME already exists
2224unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2225A number as third arg means request confirmation if NEWNAME already exists.
2226This is what happens in interactive use with M-x. */)
5842a27b 2227 (Lisp_Object file, Lisp_Object newname, Lisp_Object ok_if_already_exists)
570d7624 2228{
32f4334d 2229 Lisp_Object handler;
f72b5416
JD
2230 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
2231 Lisp_Object encoded_file, encoded_newname, symlink_target;
570d7624 2232
f72b5416
JD
2233 symlink_target = encoded_file = encoded_newname = Qnil;
2234 GCPRO5 (file, newname, encoded_file, encoded_newname, symlink_target);
b7826503
PJ
2235 CHECK_STRING (file);
2236 CHECK_STRING (newname);
3b7f6e60 2237 file = Fexpand_file_name (file, Qnil);
1ffc5c90 2238
f83caf70
EZ
2239 if ((!NILP (Ffile_directory_p (newname)))
2240#ifdef DOS_NT
2241 /* If the file names are identical but for the case,
2242 don't attempt to move directory to itself. */
2243 && (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2244#endif
2245 )
8719abec 2246 {
ce2fe65a
AS
2247 Lisp_Object fname = (NILP (Ffile_directory_p (file))
2248 ? file : Fdirectory_file_name (file));
8719abec
CY
2249 newname = Fexpand_file_name (Ffile_name_nondirectory (fname), newname);
2250 }
1ffc5c90
RS
2251 else
2252 newname = Fexpand_file_name (newname, Qnil);
32f4334d
RS
2253
2254 /* If the file name has special constructs in it,
2255 call the corresponding file handler. */
3b7f6e60 2256 handler = Ffind_file_name_handler (file, Qrename_file);
51cf6d37 2257 if (NILP (handler))
49307295 2258 handler = Ffind_file_name_handler (newname, Qrename_file);
32f4334d 2259 if (!NILP (handler))
36712b0a 2260 RETURN_UNGCPRO (call4 (handler, Qrename_file,
3b7f6e60 2261 file, newname, ok_if_already_exists));
32f4334d 2262
b1d1b865
RS
2263 encoded_file = ENCODE_FILE (file);
2264 encoded_newname = ENCODE_FILE (newname);
2265
bc77278f
EZ
2266#ifdef DOS_NT
2267 /* If the file names are identical but for the case, don't ask for
2268 confirmation: they simply want to change the letter-case of the
2269 file name. */
2270 if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2271#endif
265a9e55 2272 if (NILP (ok_if_already_exists)
93c30b5f 2273 || INTEGERP (ok_if_already_exists))
2f868094 2274 barf_or_query_if_file_exists (newname, "rename to it",
b8b29dc9 2275 INTEGERP (ok_if_already_exists), 0, 0);
ce2fe65a 2276 if (rename (SSDATA (encoded_file), SSDATA (encoded_newname)) < 0)
570d7624
JB
2277 {
2278 if (errno == EXDEV)
2279 {
d311d28c 2280 ptrdiff_t count;
f72b5416 2281 symlink_target = Ffile_symlink_p (file);
440c7d00
JD
2282 if (! NILP (symlink_target))
2283 Fmake_symbolic_link (symlink_target, newname,
f59abab9 2284 NILP (ok_if_already_exists) ? Qnil : Qt);
ae0d7250 2285 else if (!NILP (Ffile_directory_p (file)))
8719abec
CY
2286 call4 (Qcopy_directory, file, newname, Qt, Qnil);
2287 else
2288 /* We have already prompted if it was an integer, so don't
2289 have copy-file prompt again. */
586702ce 2290 Fcopy_file (file, newname,
586702ce 2291 NILP (ok_if_already_exists) ? Qnil : Qt,
574c05e2 2292 Qt, Qt, Qt);
d550c425 2293
6bddfc97 2294 count = SPECPDL_INDEX ();
d2b66acf 2295 specbind (Qdelete_by_moving_to_trash, Qnil);
8fab2362 2296
ae0d7250 2297 if (!NILP (Ffile_directory_p (file)) && NILP (symlink_target))
8719abec
CY
2298 call2 (Qdelete_directory, file, Qt);
2299 else
f1a5d776 2300 Fdelete_file (file, Qnil);
6bddfc97 2301 unbind_to (count, Qnil);
570d7624
JB
2302 }
2303 else
a9f2aeae 2304 report_file_error ("Renaming", list2 (file, newname));
570d7624
JB
2305 }
2306 UNGCPRO;
2307 return Qnil;
2308}
2309
2310DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
7c0f6118 2311 "fAdd name to file: \nGName to add to %s: \np",
a4e03fe5 2312 doc: /* Give FILE additional name NEWNAME. Both args must be strings.
8c1a1077
PJ
2313Signals a `file-already-exists' error if a file NEWNAME already exists
2314unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2315A number as third arg means request confirmation if NEWNAME already exists.
2316This is what happens in interactive use with M-x. */)
5842a27b 2317 (Lisp_Object file, Lisp_Object newname, Lisp_Object ok_if_already_exists)
570d7624 2318{
32f4334d 2319 Lisp_Object handler;
b1d1b865
RS
2320 Lisp_Object encoded_file, encoded_newname;
2321 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
570d7624 2322
b1d1b865
RS
2323 GCPRO4 (file, newname, encoded_file, encoded_newname);
2324 encoded_file = encoded_newname = Qnil;
b7826503
PJ
2325 CHECK_STRING (file);
2326 CHECK_STRING (newname);
3b7f6e60 2327 file = Fexpand_file_name (file, Qnil);
1ffc5c90
RS
2328
2329 if (!NILP (Ffile_directory_p (newname)))
2330 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2331 else
2332 newname = Fexpand_file_name (newname, Qnil);
32f4334d
RS
2333
2334 /* If the file name has special constructs in it,
2335 call the corresponding file handler. */
3b7f6e60 2336 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
32f4334d 2337 if (!NILP (handler))
3b7f6e60 2338 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
36712b0a 2339 newname, ok_if_already_exists));
32f4334d 2340
adc6741c
RS
2341 /* If the new name has special constructs in it,
2342 call the corresponding file handler. */
2343 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2344 if (!NILP (handler))
3b7f6e60 2345 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
adc6741c
RS
2346 newname, ok_if_already_exists));
2347
b1d1b865
RS
2348 encoded_file = ENCODE_FILE (file);
2349 encoded_newname = ENCODE_FILE (newname);
2350
265a9e55 2351 if (NILP (ok_if_already_exists)
93c30b5f 2352 || INTEGERP (ok_if_already_exists))
2f868094 2353 barf_or_query_if_file_exists (newname, "make it a new name",
b8b29dc9 2354 INTEGERP (ok_if_already_exists), 0, 0);
5e570b75 2355
42a5b22f 2356 unlink (SSDATA (newname));
ce2fe65a 2357 if (link (SSDATA (encoded_file), SSDATA (encoded_newname)) < 0)
a9f2aeae 2358 report_file_error ("Adding new name", list2 (file, newname));
570d7624
JB
2359
2360 UNGCPRO;
2361 return Qnil;
2362}
2363
570d7624 2364DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
7c0f6118 2365 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
68780e2a
RS
2366 doc: /* Make a symbolic link to FILENAME, named LINKNAME.
2367Both args must be strings.
8c1a1077
PJ
2368Signals a `file-already-exists' error if a file LINKNAME already exists
2369unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2370A number as third arg means request confirmation if LINKNAME already exists.
2371This happens for interactive use with M-x. */)
5842a27b 2372 (Lisp_Object filename, Lisp_Object linkname, Lisp_Object ok_if_already_exists)
570d7624 2373{
32f4334d 2374 Lisp_Object handler;
b1d1b865
RS
2375 Lisp_Object encoded_filename, encoded_linkname;
2376 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
570d7624 2377
b1d1b865
RS
2378 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2379 encoded_filename = encoded_linkname = Qnil;
b7826503
PJ
2380 CHECK_STRING (filename);
2381 CHECK_STRING (linkname);
d9bc1c99
RS
2382 /* If the link target has a ~, we must expand it to get
2383 a truly valid file name. Otherwise, do not expand;
2384 we want to permit links to relative file names. */
d5db4077 2385 if (SREF (filename, 0) == '~')
d9bc1c99 2386 filename = Fexpand_file_name (filename, Qnil);
1ffc5c90
RS
2387
2388 if (!NILP (Ffile_directory_p (linkname)))
dac24db4 2389 linkname = Fexpand_file_name (Ffile_name_nondirectory (filename), linkname);
1ffc5c90
RS
2390 else
2391 linkname = Fexpand_file_name (linkname, Qnil);
32f4334d
RS
2392
2393 /* If the file name has special constructs in it,
2394 call the corresponding file handler. */
49307295 2395 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
32f4334d 2396 if (!NILP (handler))
36712b0a
KH
2397 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2398 linkname, ok_if_already_exists));
32f4334d 2399
adc6741c
RS
2400 /* If the new link name has special constructs in it,
2401 call the corresponding file handler. */
2402 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2403 if (!NILP (handler))
2404 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2405 linkname, ok_if_already_exists));
2406
b1d1b865
RS
2407 encoded_filename = ENCODE_FILE (filename);
2408 encoded_linkname = ENCODE_FILE (linkname);
2409
265a9e55 2410 if (NILP (ok_if_already_exists)
93c30b5f 2411 || INTEGERP (ok_if_already_exists))
2f868094 2412 barf_or_query_if_file_exists (linkname, "make it a link",
b8b29dc9 2413 INTEGERP (ok_if_already_exists), 0, 0);
ce2fe65a 2414 if (symlink (SSDATA (encoded_filename), SSDATA (encoded_linkname)) < 0)
570d7624
JB
2415 {
2416 /* If we didn't complain already, silently delete existing file. */
2417 if (errno == EEXIST)
2418 {
42a5b22f 2419 unlink (SSDATA (encoded_linkname));
ce2fe65a
AS
2420 if (symlink (SSDATA (encoded_filename), SSDATA (encoded_linkname))
2421 >= 0)
1a04498e
KH
2422 {
2423 UNGCPRO;
2424 return Qnil;
2425 }
570d7624 2426 }
d9d0d182
PE
2427 if (errno == ENOSYS)
2428 {
2429 UNGCPRO;
2430 xsignal1 (Qfile_error,
2431 build_string ("Symbolic links are not supported"));
2432 }
570d7624 2433
a9f2aeae 2434 report_file_error ("Making symbolic link", list2 (filename, linkname));
570d7624
JB
2435 }
2436 UNGCPRO;
2437 return Qnil;
e89b536d 2438}
570d7624 2439
570d7624 2440\f
a7ca3326 2441DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
570d7624 2442 1, 1, 0,
8c1a1077
PJ
2443 doc: /* Return t if file FILENAME specifies an absolute file name.
2444On Unix, this is a name starting with a `/' or a `~'. */)
5842a27b 2445 (Lisp_Object filename)
570d7624 2446{
b7826503 2447 CHECK_STRING (filename);
5976c3fe 2448 return file_name_absolute_p (SSDATA (filename)) ? Qt : Qnil;
570d7624 2449}
3beeedfe 2450\f
bb385a92
EZ
2451/* Return true if FILENAME exists. */
2452bool
2453check_existing (const char *filename)
2454{
73dcdb9f 2455 return faccessat (AT_FDCWD, filename, F_OK, AT_EACCESS) == 0;
bb385a92
EZ
2456}
2457
f75d7a91 2458/* Return true if file FILENAME exists and can be executed. */
3beeedfe 2459
f75d7a91 2460static bool
971de7fb 2461check_executable (char *filename)
3beeedfe 2462{
73dcdb9f 2463 return faccessat (AT_FDCWD, filename, X_OK, AT_EACCESS) == 0;
3beeedfe
RS
2464}
2465
73dcdb9f
PE
2466/* Return true if file FILENAME exists and can be accessed
2467 according to AMODE, which should include W_OK.
2468 On failure, return false and set errno. */
3beeedfe 2469
f75d7a91 2470static bool
73dcdb9f 2471check_writable (const char *filename, int amode)
3beeedfe 2472{
3be3c08e 2473#ifdef MSDOS
73dcdb9f
PE
2474 /* FIXME: an faccessat implementation should be added to the
2475 DOS/Windows ports and this #ifdef branch should be removed. */
3be3c08e
RS
2476 struct stat st;
2477 if (stat (filename, &st) < 0)
2478 return 0;
73dcdb9f 2479 errno = EPERM;
f68c809d 2480 return (st.st_mode & S_IWRITE || S_ISDIR (st.st_mode));
3be3c08e 2481#else /* not MSDOS */
73dcdb9f 2482 bool res = faccessat (AT_FDCWD, filename, amode, AT_EACCESS) == 0;
e1b01a3a 2483#ifdef CYGWIN
73dcdb9f 2484 /* faccessat may have returned failure because Cygwin couldn't
e1b01a3a
KB
2485 determine the file's UID or GID; if so, we return success. */
2486 if (!res)
2487 {
73dcdb9f 2488 int faccessat_errno = errno;
e1b01a3a
KB
2489 struct stat st;
2490 if (stat (filename, &st) < 0)
2491 return 0;
2492 res = (st.st_uid == -1 || st.st_gid == -1);
73dcdb9f 2493 errno = faccessat_errno;
e1b01a3a
KB
2494 }
2495#endif /* CYGWIN */
2496 return res;
3be3c08e 2497#endif /* not MSDOS */
3beeedfe 2498}
570d7624 2499
a7ca3326 2500DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
68780e2a
RS
2501 doc: /* Return t if file FILENAME exists (whether or not you can read it.)
2502See also `file-readable-p' and `file-attributes'.
2503This returns nil for a symlink to a nonexistent file.
2504Use `file-symlink-p' to test for such links. */)
5842a27b 2505 (Lisp_Object filename)
570d7624 2506{
199607e4 2507 Lisp_Object absname;
32f4334d 2508 Lisp_Object handler;
570d7624 2509
b7826503 2510 CHECK_STRING (filename);
199607e4 2511 absname = Fexpand_file_name (filename, Qnil);
32f4334d
RS
2512
2513 /* If the file name has special constructs in it,
2514 call the corresponding file handler. */
199607e4 2515 handler = Ffind_file_name_handler (absname, Qfile_exists_p);
32f4334d 2516 if (!NILP (handler))
199607e4 2517 return call2 (handler, Qfile_exists_p, absname);
32f4334d 2518
b1d1b865
RS
2519 absname = ENCODE_FILE (absname);
2520
bb385a92 2521 return (check_existing (SSDATA (absname))) ? Qt : Qnil;
570d7624
JB
2522}
2523
2524DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
8c1a1077
PJ
2525 doc: /* Return t if FILENAME can be executed by you.
2526For a directory, this means you can access files in that directory. */)
5842a27b 2527 (Lisp_Object filename)
570d7624 2528{
199607e4 2529 Lisp_Object absname;
32f4334d 2530 Lisp_Object handler;
570d7624 2531
b7826503 2532 CHECK_STRING (filename);
199607e4 2533 absname = Fexpand_file_name (filename, Qnil);
32f4334d
RS
2534
2535 /* If the file name has special constructs in it,
2536 call the corresponding file handler. */
199607e4 2537 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
32f4334d 2538 if (!NILP (handler))
199607e4 2539 return call2 (handler, Qfile_executable_p, absname);
32f4334d 2540
b1d1b865
RS
2541 absname = ENCODE_FILE (absname);
2542
42a5b22f 2543 return (check_executable (SSDATA (absname)) ? Qt : Qnil);
570d7624
JB
2544}
2545
a7ca3326 2546DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
8c1a1077
PJ
2547 doc: /* Return t if file FILENAME exists and you can read it.
2548See also `file-exists-p' and `file-attributes'. */)
5842a27b 2549 (Lisp_Object filename)
570d7624 2550{
199607e4 2551 Lisp_Object absname;
32f4334d 2552 Lisp_Object handler;
570d7624 2553
b7826503 2554 CHECK_STRING (filename);
199607e4 2555 absname = Fexpand_file_name (filename, Qnil);
32f4334d
RS
2556
2557 /* If the file name has special constructs in it,
2558 call the corresponding file handler. */
199607e4 2559 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
32f4334d 2560 if (!NILP (handler))
199607e4 2561 return call2 (handler, Qfile_readable_p, absname);
32f4334d 2562
b1d1b865 2563 absname = ENCODE_FILE (absname);
73dcdb9f
PE
2564 return (faccessat (AT_FDCWD, SSDATA (absname), R_OK, AT_EACCESS) == 0
2565 ? Qt : Qnil);
570d7624
JB
2566}
2567
f793dc6c 2568DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
8c1a1077 2569 doc: /* Return t if file FILENAME can be written or created by you. */)
5842a27b 2570 (Lisp_Object filename)
f793dc6c 2571{
b1d1b865 2572 Lisp_Object absname, dir, encoded;
f793dc6c 2573 Lisp_Object handler;
f793dc6c 2574
b7826503 2575 CHECK_STRING (filename);
199607e4 2576 absname = Fexpand_file_name (filename, Qnil);
f793dc6c
RS
2577
2578 /* If the file name has special constructs in it,
2579 call the corresponding file handler. */
199607e4 2580 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
f793dc6c 2581 if (!NILP (handler))
199607e4 2582 return call2 (handler, Qfile_writable_p, absname);
f793dc6c 2583
b1d1b865 2584 encoded = ENCODE_FILE (absname);
73dcdb9f
PE
2585 if (check_writable (SSDATA (encoded), W_OK))
2586 return Qt;
2587 if (errno != ENOENT)
2588 return Qnil;
b1d1b865 2589
199607e4 2590 dir = Ffile_name_directory (absname);
73dcdb9f 2591 eassert (!NILP (dir));
f793dc6c 2592#ifdef MSDOS
73dcdb9f 2593 dir = Fdirectory_file_name (dir);
f793dc6c 2594#endif /* MSDOS */
b1d1b865
RS
2595
2596 dir = ENCODE_FILE (dir);
e3e8a75a
GM
2597#ifdef WINDOWSNT
2598 /* The read-only attribute of the parent directory doesn't affect
2599 whether a file or directory can be created within it. Some day we
2600 should check ACLs though, which do affect this. */
73dcdb9f 2601 return file_directory_p (SDATA (dir)) ? Qt : Qnil;
e3e8a75a 2602#else
73dcdb9f 2603 return check_writable (SSDATA (dir), W_OK | X_OK) ? Qt : Qnil;
e3e8a75a 2604#endif
f793dc6c
RS
2605}
2606\f
1f8653eb 2607DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
8c1a1077
PJ
2608 doc: /* Access file FILENAME, and get an error if that does not work.
2609The second argument STRING is used in the error message.
a4e03fe5 2610If there is no error, returns nil. */)
5842a27b 2611 (Lisp_Object filename, Lisp_Object string)
1f8653eb 2612{
49475635 2613 Lisp_Object handler, encoded_filename, absname;
1f8653eb
RS
2614 int fd;
2615
b7826503 2616 CHECK_STRING (filename);
49475635
EZ
2617 absname = Fexpand_file_name (filename, Qnil);
2618
b7826503 2619 CHECK_STRING (string);
1f8653eb
RS
2620
2621 /* If the file name has special constructs in it,
2622 call the corresponding file handler. */
49475635 2623 handler = Ffind_file_name_handler (absname, Qaccess_file);
1f8653eb 2624 if (!NILP (handler))
49475635 2625 return call3 (handler, Qaccess_file, absname, string);
1f8653eb 2626
49475635 2627 encoded_filename = ENCODE_FILE (absname);
b1d1b865 2628
42a5b22f 2629 fd = emacs_open (SSDATA (encoded_filename), O_RDONLY, 0);
1f8653eb 2630 if (fd < 0)
42a5b22f 2631 report_file_error (SSDATA (string), Fcons (filename, Qnil));
68c45bf0 2632 emacs_close (fd);
1f8653eb
RS
2633
2634 return Qnil;
2635}
2636\f
a7ca3326 2637DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
8c1a1077 2638 doc: /* Return non-nil if file FILENAME is the name of a symbolic link.
1c353c74 2639The value is the link target, as a string.
68780e2a
RS
2640Otherwise it returns nil.
2641
2642This function returns t when given the name of a symlink that
2643points to a nonexistent file. */)
5842a27b 2644 (Lisp_Object filename)
570d7624 2645{
32f4334d 2646 Lisp_Object handler;
ae0d7250 2647 char *buf;
ae0d7250 2648 Lisp_Object val;
d1fdcab7 2649 char readlink_buf[READLINK_BUFSIZE];
570d7624 2650
b7826503 2651 CHECK_STRING (filename);
570d7624
JB
2652 filename = Fexpand_file_name (filename, Qnil);
2653
32f4334d
RS
2654 /* If the file name has special constructs in it,
2655 call the corresponding file handler. */
49307295 2656 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
32f4334d
RS
2657 if (!NILP (handler))
2658 return call2 (handler, Qfile_symlink_p, filename);
2659
b1d1b865
RS
2660 filename = ENCODE_FILE (filename);
2661
d1fdcab7
PE
2662 buf = emacs_readlink (SSDATA (filename), readlink_buf);
2663 if (! buf)
2664 return Qnil;
efdc16c9 2665
d1fdcab7 2666 val = build_string (buf);
8966b757 2667 if (buf[0] == '/' && strchr (buf, ':'))
69ac1891 2668 val = concat2 (build_string ("/:"), val);
d1fdcab7
PE
2669 if (buf != readlink_buf)
2670 xfree (buf);
cd913586
KH
2671 val = DECODE_FILE (val);
2672 return val;
570d7624
JB
2673}
2674
a7ca3326 2675DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
8c1a1077
PJ
2676 doc: /* Return t if FILENAME names an existing directory.
2677Symbolic links to directories count as directories.
2678See `file-symlink-p' to distinguish symlinks. */)
5842a27b 2679 (Lisp_Object filename)
570d7624 2680{
73dcdb9f 2681 Lisp_Object absname;
32f4334d 2682 Lisp_Object handler;
570d7624 2683
4b4deea2 2684 absname = expand_and_dir_to_file (filename, BVAR (current_buffer, directory));
570d7624 2685
32f4334d
RS
2686 /* If the file name has special constructs in it,
2687 call the corresponding file handler. */
199607e4 2688 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
32f4334d 2689 if (!NILP (handler))
199607e4 2690 return call2 (handler, Qfile_directory_p, absname);
32f4334d 2691
b1d1b865
RS
2692 absname = ENCODE_FILE (absname);
2693
73dcdb9f
PE
2694 return file_directory_p (SSDATA (absname)) ? Qt : Qnil;
2695}
2696
2697/* Return true if FILE is a directory or a symlink to a directory. */
2698bool
2699file_directory_p (char const *file)
2700{
2701#ifdef WINDOWSNT
2702 /* This is cheaper than 'stat'. */
2703 return faccessat (AT_FDCWD, file, D_OK, AT_EACCESS) == 0;
2704#else
2705 struct stat st;
2706 return stat (file, &st) == 0 && S_ISDIR (st.st_mode);
2707#endif
570d7624
JB
2708}
2709
a7ca3326 2710DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p,
16a97296 2711 Sfile_accessible_directory_p, 1, 1, 0,
e385ec41
RS
2712 doc: /* Return t if file FILENAME names a directory you can open.
2713For the value to be t, FILENAME must specify the name of a directory as a file,
2714and the directory must allow you to open files in it. In order to use a
8c1a1077
PJ
2715directory as a buffer's current directory, this predicate must return true.
2716A directory name spec may be given instead; then the value is t
2717if the directory so specified exists and really is a readable and
2718searchable directory. */)
5842a27b 2719 (Lisp_Object filename)
b72dea2a 2720{
73dcdb9f 2721 Lisp_Object absname;
32f4334d 2722 Lisp_Object handler;
73dcdb9f
PE
2723
2724 CHECK_STRING (filename);
2725 absname = Fexpand_file_name (filename, Qnil);
32f4334d
RS
2726
2727 /* If the file name has special constructs in it,
2728 call the corresponding file handler. */
73dcdb9f 2729 handler = Ffind_file_name_handler (absname, Qfile_accessible_directory_p);
32f4334d 2730 if (!NILP (handler))
73dcdb9f 2731 return call2 (handler, Qfile_accessible_directory_p, absname);
32f4334d 2732
73dcdb9f
PE
2733 absname = ENCODE_FILE (absname);
2734 return file_accessible_directory_p (SSDATA (absname)) ? Qt : Qnil;
2735}
2736
2737/* If FILE is a searchable directory or a symlink to a
2738 searchable directory, return true. Otherwise return
2739 false and set errno to an error number. */
2740bool
2741file_accessible_directory_p (char const *file)
2742{
2743#ifdef DOS_NT
2744 /* There's no need to test whether FILE is searchable, as the
2745 searchable/executable bit is invented on DOS_NT platforms. */
2746 return file_directory_p (file);
2747#else
2748 /* On POSIXish platforms, use just one system call; this avoids a
2749 race and is typically faster. */
2750 ptrdiff_t len = strlen (file);
2751 char const *dir;
2752 bool ok;
2753 int saved_errno;
2754 USE_SAFE_ALLOCA;
2755
2756 /* Normally a file "FOO" is an accessible directory if "FOO/." exists.
2757 There are three exceptions: "", "/", and "//". Leave "" alone,
2758 as it's invalid. Append only "." to the other two exceptions as
2759 "/" and "//" are distinct on some platforms, whereas "/", "///",
2760 "////", etc. are all equivalent. */
2761 if (! len)
2762 dir = file;
2763 else
2764 {
2765 /* Just check for trailing '/' when deciding whether to append '/'.
2766 That's simpler than testing the two special cases "/" and "//",
2767 and it's a safe optimization here. */
2768 char *buf = SAFE_ALLOCA (len + 3);
2769 memcpy (buf, file, len);
2770 strcpy (buf + len, "/." + (file[len - 1] == '/'));
2771 dir = buf;
2772 }
2773
2774 ok = check_existing (dir);
2775 saved_errno = errno;
2776 SAFE_FREE ();
2777 errno = saved_errno;
2778 return ok;
2779#endif
b72dea2a
JB
2780}
2781
f793dc6c 2782DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
19a9c3b7
LH
2783 doc: /* Return t if FILENAME names a regular file.
2784This is the sort of file that holds an ordinary stream of data bytes.
2785Symbolic links to regular files count as regular files.
2786See `file-symlink-p' to distinguish symlinks. */)
5842a27b 2787 (Lisp_Object filename)
f793dc6c 2788{
199607e4 2789 register Lisp_Object absname;
f793dc6c
RS
2790 struct stat st;
2791 Lisp_Object handler;
2792
4b4deea2 2793 absname = expand_and_dir_to_file (filename, BVAR (current_buffer, directory));
f793dc6c
RS
2794
2795 /* If the file name has special constructs in it,
2796 call the corresponding file handler. */
199607e4 2797 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
f793dc6c 2798 if (!NILP (handler))
199607e4 2799 return call2 (handler, Qfile_regular_p, absname);
f793dc6c 2800
b1d1b865
RS
2801 absname = ENCODE_FILE (absname);
2802
c1c4693e
RS
2803#ifdef WINDOWSNT
2804 {
2805 int result;
2806 Lisp_Object tem = Vw32_get_true_file_attributes;
2807
2808 /* Tell stat to use expensive method to get accurate info. */
2809 Vw32_get_true_file_attributes = Qt;
d5db4077 2810 result = stat (SDATA (absname), &st);
c1c4693e
RS
2811 Vw32_get_true_file_attributes = tem;
2812
2813 if (result < 0)
2814 return Qnil;
f68c809d 2815 return S_ISREG (st.st_mode) ? Qt : Qnil;
c1c4693e
RS
2816 }
2817#else
42a5b22f 2818 if (stat (SSDATA (absname), &st) < 0)
f793dc6c 2819 return Qnil;
f68c809d 2820 return S_ISREG (st.st_mode) ? Qt : Qnil;
c1c4693e 2821#endif
f793dc6c
RS
2822}
2823\f
574c05e2
KK
2824DEFUN ("file-selinux-context", Ffile_selinux_context,
2825 Sfile_selinux_context, 1, 1, 0,
fa74b241
CY
2826 doc: /* Return SELinux context of file named FILENAME.
2827The return value is a list (USER ROLE TYPE RANGE), where the list
2828elements are strings naming the user, role, type, and range of the
2829file's SELinux security context.
2830
2831Return (nil nil nil nil) if the file is nonexistent or inaccessible,
2832or if SELinux is disabled, or if Emacs lacks SELinux support. */)
5842a27b 2833 (Lisp_Object filename)
574c05e2
KK
2834{
2835 Lisp_Object absname;
2836 Lisp_Object values[4];
2837 Lisp_Object handler;
2838#if HAVE_LIBSELINUX
2839 security_context_t con;
2840 int conlength;
2841 context_t context;
2842#endif
2843
4b4deea2 2844 absname = expand_and_dir_to_file (filename, BVAR (current_buffer, directory));
574c05e2
KK
2845
2846 /* If the file name has special constructs in it,
2847 call the corresponding file handler. */
2848 handler = Ffind_file_name_handler (absname, Qfile_selinux_context);
2849 if (!NILP (handler))
2850 return call2 (handler, Qfile_selinux_context, absname);
2851
2852 absname = ENCODE_FILE (absname);
2853
2854 values[0] = Qnil;
2855 values[1] = Qnil;
2856 values[2] = Qnil;
2857 values[3] = Qnil;
2858#if HAVE_LIBSELINUX
2859 if (is_selinux_enabled ())
2860 {
b14aac08 2861 conlength = lgetfilecon (SSDATA (absname), &con);
574c05e2
KK
2862 if (conlength > 0)
2863 {
2864 context = context_new (con);
45841e65
KK
2865 if (context_user_get (context))
2866 values[0] = build_string (context_user_get (context));
2867 if (context_role_get (context))
2868 values[1] = build_string (context_role_get (context));
2869 if (context_type_get (context))
2870 values[2] = build_string (context_type_get (context));
2871 if (context_range_get (context))
2872 values[3] = build_string (context_range_get (context));
574c05e2 2873 context_free (context);
c6ba4138 2874 freecon (con);
574c05e2 2875 }
574c05e2
KK
2876 }
2877#endif
2878
5e617bc2 2879 return Flist (sizeof (values) / sizeof (values[0]), values);
574c05e2
KK
2880}
2881\f
2882DEFUN ("set-file-selinux-context", Fset_file_selinux_context,
2883 Sset_file_selinux_context, 2, 2, 0,
fa74b241
CY
2884 doc: /* Set SELinux context of file named FILENAME to CONTEXT.
2885CONTEXT should be a list (USER ROLE TYPE RANGE), where the list
2886elements are strings naming the components of a SELinux context.
2887
2888This function does nothing if SELinux is disabled, or if Emacs was not
2889compiled with SELinux support. */)
5842a27b 2890 (Lisp_Object filename, Lisp_Object context)
574c05e2 2891{
0f4a96b5 2892 Lisp_Object absname;
574c05e2 2893 Lisp_Object handler;
0f4a96b5
JB
2894#if HAVE_LIBSELINUX
2895 Lisp_Object encoded_absname;
574c05e2
KK
2896 Lisp_Object user = CAR_SAFE (context);
2897 Lisp_Object role = CAR_SAFE (CDR_SAFE (context));
2898 Lisp_Object type = CAR_SAFE (CDR_SAFE (CDR_SAFE (context)));
2899 Lisp_Object range = CAR_SAFE (CDR_SAFE (CDR_SAFE (CDR_SAFE (context))));
574c05e2 2900 security_context_t con;
f75d7a91
PE
2901 bool fail;
2902 int conlength;
574c05e2
KK
2903 context_t parsed_con;
2904#endif
2905
4b4deea2 2906 absname = Fexpand_file_name (filename, BVAR (current_buffer, directory));
574c05e2
KK
2907
2908 /* If the file name has special constructs in it,
2909 call the corresponding file handler. */
2910 handler = Ffind_file_name_handler (absname, Qset_file_selinux_context);
2911 if (!NILP (handler))
2912 return call3 (handler, Qset_file_selinux_context, absname, context);
2913
0f4a96b5 2914#if HAVE_LIBSELINUX
574c05e2
KK
2915 if (is_selinux_enabled ())
2916 {
2917 /* Get current file context. */
a9b53ad3 2918 encoded_absname = ENCODE_FILE (absname);
b14aac08 2919 conlength = lgetfilecon (SSDATA (encoded_absname), &con);
574c05e2
KK
2920 if (conlength > 0)
2921 {
2922 parsed_con = context_new (con);
2923 /* Change the parts defined in the parameter.*/
2924 if (STRINGP (user))
2925 {
b14aac08 2926 if (context_user_set (parsed_con, SSDATA (user)))
574c05e2
KK
2927 error ("Doing context_user_set");
2928 }
2929 if (STRINGP (role))
2930 {
b14aac08 2931 if (context_role_set (parsed_con, SSDATA (role)))
574c05e2
KK
2932 error ("Doing context_role_set");
2933 }
2934 if (STRINGP (type))
2935 {
b14aac08 2936 if (context_type_set (parsed_con, SSDATA (type)))
574c05e2
KK
2937 error ("Doing context_type_set");
2938 }
2939 if (STRINGP (range))
2940 {
b14aac08 2941 if (context_range_set (parsed_con, SSDATA (range)))
574c05e2
KK
2942 error ("Doing context_range_set");
2943 }
2944
24c51a09 2945 /* Set the modified context back to the file. */
f75d7a91
PE
2946 fail = (lsetfilecon (SSDATA (encoded_absname),
2947 context_str (parsed_con))
2948 != 0);
24c51a09
GM
2949 /* See http://debbugs.gnu.org/11245 for ENOTSUP. */
2950 if (fail && errno != ENOTSUP)
574c05e2
KK
2951 report_file_error ("Doing lsetfilecon", Fcons (absname, Qnil));
2952
2953 context_free (parsed_con);
c6ba4138 2954 freecon (con);
574c05e2
KK
2955 }
2956 else
5e617bc2 2957 report_file_error ("Doing lgetfilecon", Fcons (absname, Qnil));
574c05e2
KK
2958 }
2959#endif
2960
2961 return Qnil;
2962}
2963\f
570d7624 2964DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
d4a42098
KS
2965 doc: /* Return mode bits of file named FILENAME, as an integer.
2966Return nil, if file does not exist or is not accessible. */)
5842a27b 2967 (Lisp_Object filename)
570d7624 2968{
199607e4 2969 Lisp_Object absname;
570d7624 2970 struct stat st;
32f4334d 2971 Lisp_Object handler;
570d7624 2972
4b4deea2 2973 absname = expand_and_dir_to_file (filename, BVAR (current_buffer, directory));
570d7624 2974
32f4334d
RS
2975 /* If the file name has special constructs in it,
2976 call the corresponding file handler. */
199607e4 2977 handler = Ffind_file_name_handler (absname, Qfile_modes);
32f4334d 2978 if (!NILP (handler))
199607e4 2979 return call2 (handler, Qfile_modes, absname);
32f4334d 2980
b1d1b865
RS
2981 absname = ENCODE_FILE (absname);
2982
42a5b22f 2983 if (stat (SSDATA (absname), &st) < 0)
570d7624 2984 return Qnil;
3ace87e3 2985
570d7624
JB
2986 return make_number (st.st_mode & 07777);
2987}
2988
09fbdf6c
MC
2989DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2,
2990 "(let ((file (read-file-name \"File: \"))) \
2991 (list file (read-file-modes nil file)))",
8c1a1077 2992 doc: /* Set mode bits of file named FILENAME to MODE (an integer).
ea429250
EZ
2993Only the 12 low bits of MODE are used.
2994
2995Interactively, mode bits are read by `read-file-modes', which accepts
712adc82 2996symbolic notation, like the `chmod' command from GNU Coreutils. */)
5842a27b 2997 (Lisp_Object filename, Lisp_Object mode)
570d7624 2998{
b1d1b865 2999 Lisp_Object absname, encoded_absname;
32f4334d 3000 Lisp_Object handler;
570d7624 3001
4b4deea2 3002 absname = Fexpand_file_name (filename, BVAR (current_buffer, directory));
b7826503 3003 CHECK_NUMBER (mode);
570d7624 3004
32f4334d
RS
3005 /* If the file name has special constructs in it,
3006 call the corresponding file handler. */
199607e4 3007 handler = Ffind_file_name_handler (absname, Qset_file_modes);
32f4334d 3008 if (!NILP (handler))
199607e4 3009 return call3 (handler, Qset_file_modes, absname, mode);
32f4334d 3010
b1d1b865
RS
3011 encoded_absname = ENCODE_FILE (absname);
3012
18c52557 3013 if (chmod (SSDATA (encoded_absname), XINT (mode) & 07777) < 0)
199607e4 3014 report_file_error ("Doing chmod", Fcons (absname, Qnil));
570d7624
JB
3015
3016 return Qnil;
3017}
3018
c24e9a53 3019DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
8c1a1077
PJ
3020 doc: /* Set the file permission bits for newly created files.
3021The argument MODE should be an integer; only the low 9 bits are used.
3022This setting is inherited by subprocesses. */)
5842a27b 3023 (Lisp_Object mode)
36a8c287 3024{
b7826503 3025 CHECK_NUMBER (mode);
199607e4 3026
5f85ea58 3027 umask ((~ XINT (mode)) & 0777);
36a8c287
JB
3028
3029 return Qnil;
3030}
3031
c24e9a53 3032DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
8c1a1077
PJ
3033 doc: /* Return the default file protection for created files.
3034The value is an integer. */)
5842a27b 3035 (void)
36a8c287 3036{
f75d7a91 3037 mode_t realmask;
5f85ea58 3038 Lisp_Object value;
36a8c287 3039
4d7e6e51 3040 block_input ();
5f85ea58
RS
3041 realmask = umask (0);
3042 umask (realmask);
4d7e6e51 3043 unblock_input ();
36a8c287 3044
46283abe 3045 XSETINT (value, (~ realmask) & 0777);
5f85ea58 3046 return value;
36a8c287 3047}
819da85b 3048\f
819da85b
EZ
3049
3050DEFUN ("set-file-times", Fset_file_times, Sset_file_times, 1, 2, 0,
f839df0c 3051 doc: /* Set times of file FILENAME to TIMESTAMP.
819da85b
EZ
3052Set both access and modification times.
3053Return t on success, else nil.
f839df0c 3054Use the current time if TIMESTAMP is nil. TIMESTAMP is in the format of
819da85b 3055`current-time'. */)
f839df0c 3056 (Lisp_Object filename, Lisp_Object timestamp)
819da85b
EZ
3057{
3058 Lisp_Object absname, encoded_absname;
3059 Lisp_Object handler;
31571fd7 3060 EMACS_TIME t = lisp_time_argument (timestamp);
819da85b 3061
4b4deea2 3062 absname = Fexpand_file_name (filename, BVAR (current_buffer, directory));
819da85b
EZ
3063
3064 /* If the file name has special constructs in it,
3065 call the corresponding file handler. */
3066 handler = Ffind_file_name_handler (absname, Qset_file_times);
3067 if (!NILP (handler))
f839df0c 3068 return call3 (handler, Qset_file_times, absname, timestamp);
819da85b
EZ
3069
3070 encoded_absname = ENCODE_FILE (absname);
5df5e07c 3071
819da85b 3072 {
d35af63c 3073 if (set_file_times (-1, SSDATA (encoded_absname), t, t))
819da85b 3074 {
0d9f584b 3075#ifdef MSDOS
819da85b 3076 /* Setting times on a directory always fails. */
73dcdb9f 3077 if (file_directory_p (SSDATA (encoded_absname)))
819da85b
EZ
3078 return Qnil;
3079#endif
3080 report_file_error ("Setting file times", Fcons (absname, Qnil));
3081 return Qnil;
3082 }
3083 }
5df5e07c 3084
819da85b
EZ
3085 return Qt;
3086}
f793dc6c 3087\f
697c17a2 3088#ifdef HAVE_SYNC
85ffea93 3089DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
8c1a1077 3090 doc: /* Tell Unix to finish all pending disk updates. */)
5842a27b 3091 (void)
85ffea93
RS
3092{
3093 sync ();
3094 return Qnil;
3095}
3096
697c17a2 3097#endif /* HAVE_SYNC */
85ffea93 3098
570d7624 3099DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
8c1a1077
PJ
3100 doc: /* Return t if file FILE1 is newer than file FILE2.
3101If FILE1 does not exist, the answer is nil;
3102otherwise, if FILE2 does not exist, the answer is t. */)
5842a27b 3103 (Lisp_Object file1, Lisp_Object file2)
570d7624 3104{
199607e4 3105 Lisp_Object absname1, absname2;
39adff0d 3106 struct stat st1, st2;
32f4334d 3107 Lisp_Object handler;
09121adc 3108 struct gcpro gcpro1, gcpro2;
570d7624 3109
b7826503
PJ
3110 CHECK_STRING (file1);
3111 CHECK_STRING (file2);
570d7624 3112
199607e4
RS
3113 absname1 = Qnil;
3114 GCPRO2 (absname1, file2);
4b4deea2
TT
3115 absname1 = expand_and_dir_to_file (file1, BVAR (current_buffer, directory));
3116 absname2 = expand_and_dir_to_file (file2, BVAR (current_buffer, directory));
09121adc 3117 UNGCPRO;
570d7624 3118
32f4334d
RS
3119 /* If the file name has special constructs in it,
3120 call the corresponding file handler. */
199607e4 3121 handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p);
51cf6d37 3122 if (NILP (handler))
199607e4 3123 handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p);
32f4334d 3124 if (!NILP (handler))
199607e4 3125 return call3 (handler, Qfile_newer_than_file_p, absname1, absname2);
32f4334d 3126
b1d1b865
RS
3127 GCPRO2 (absname1, absname2);
3128 absname1 = ENCODE_FILE (absname1);
3129 absname2 = ENCODE_FILE (absname2);
3130 UNGCPRO;
3131
39adff0d 3132 if (stat (SSDATA (absname1), &st1) < 0)
570d7624
JB
3133 return Qnil;
3134
39adff0d 3135 if (stat (SSDATA (absname2), &st2) < 0)
570d7624
JB
3136 return Qt;
3137
39adff0d
PE
3138 return (EMACS_TIME_GT (get_stat_mtime (&st1), get_stat_mtime (&st2))
3139 ? Qt : Qnil);
570d7624
JB
3140}
3141\f
6fdaa9a0
KH
3142#ifndef READ_BUF_SIZE
3143#define READ_BUF_SIZE (64 << 10)
3144#endif
d311d28c
PE
3145/* Some buffer offsets are stored in 'int' variables. */
3146verify (READ_BUF_SIZE <= INT_MAX);
6fdaa9a0 3147
98a7d268
KH
3148/* This function is called after Lisp functions to decide a coding
3149 system are called, or when they cause an error. Before they are
3150 called, the current buffer is set unibyte and it contains only a
3151 newly inserted text (thus the buffer was empty before the
3152 insertion).
3153
3154 The functions may set markers, overlays, text properties, or even
3155 alter the buffer contents, change the current buffer.
3156
3157 Here, we reset all those changes by:
3158 o set back the current buffer.
3159 o move all markers and overlays to BEG.
3160 o remove all text properties.
3161 o set back the buffer multibyteness. */
f736ffbf
KH
3162
3163static Lisp_Object
971de7fb 3164decide_coding_unwind (Lisp_Object unwind_data)
f736ffbf 3165{
98a7d268 3166 Lisp_Object multibyte, undo_list, buffer;
f736ffbf 3167
98a7d268
KH
3168 multibyte = XCAR (unwind_data);
3169 unwind_data = XCDR (unwind_data);
3170 undo_list = XCAR (unwind_data);
3171 buffer = XCDR (unwind_data);
3172
a3d794a1 3173 set_buffer_internal (XBUFFER (buffer));
98a7d268
KH
3174 adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE);
3175 adjust_overlays_for_delete (BEG, Z - BEG);
0c94c8d6 3176 set_buffer_intervals (current_buffer, NULL);
98a7d268
KH
3177 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3178
3179 /* Now we are safe to change the buffer's multibyteness directly. */
39eb03f1
PE
3180 bset_enable_multibyte_characters (current_buffer, multibyte);
3181 bset_undo_list (current_buffer, undo_list);
f736ffbf
KH
3182
3183 return Qnil;
3184}
3185
55587f8a 3186
1b978129 3187/* Used to pass values from insert-file-contents to read_non_regular. */
55587f8a 3188
1b978129 3189static int non_regular_fd;
d311d28c
PE
3190static ptrdiff_t non_regular_inserted;
3191static int non_regular_nbytes;
55587f8a 3192
55587f8a 3193
1b978129 3194/* Read from a non-regular file.
438105ed 3195 Read non_regular_nbytes bytes max from non_regular_fd.
1b978129
GM
3196 Non_regular_inserted specifies where to put the read bytes.
3197 Value is the number of bytes read. */
55587f8a
GM
3198
3199static Lisp_Object
9c8a2331 3200read_non_regular (Lisp_Object ignore)
55587f8a 3201{
d311d28c 3202 int nbytes;
efdc16c9 3203
1b978129
GM
3204 immediate_quit = 1;
3205 QUIT;
3206 nbytes = emacs_read (non_regular_fd,
5976c3fe
PE
3207 ((char *) BEG_ADDR + PT_BYTE - BEG_BYTE
3208 + non_regular_inserted),
1b978129 3209 non_regular_nbytes);
1b978129
GM
3210 immediate_quit = 0;
3211 return make_number (nbytes);
3212}
55587f8a 3213
d0e2444e 3214
1b978129
GM
3215/* Condition-case handler used when reading from non-regular files
3216 in insert-file-contents. */
3217
3218static Lisp_Object
9c8a2331 3219read_non_regular_quit (Lisp_Object ignore)
1b978129 3220{
55587f8a
GM
3221 return Qnil;
3222}
3223
e69dafad
PE
3224/* Reposition FD to OFFSET, based on WHENCE. This acts like lseek
3225 except that it also tests for OFFSET being out of lseek's range. */
3226static off_t
3227emacs_lseek (int fd, EMACS_INT offset, int whence)
3228{
096a9774
PE
3229 /* Use "&" rather than "&&" to suppress a bogus GCC warning; see
3230 <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43772>. */
ce2fe65a 3231 if (! ((offset >= TYPE_MINIMUM (off_t)) & (offset <= TYPE_MAXIMUM (off_t))))
e69dafad
PE
3232 {
3233 errno = EINVAL;
3234 return -1;
3235 }
3236 return lseek (fd, offset, whence);
3237}
3238
f0941253 3239/* Return a special time value indicating the error number ERRNUM. */
dbeed9a6 3240static EMACS_TIME
f0941253 3241time_error_value (int errnum)
dbeed9a6 3242{
0497dc44 3243 int ns = (errnum == ENOENT || errnum == EACCES || errnum == ENOTDIR
dbeed9a6
PE
3244 ? NONEXISTENT_MODTIME_NSECS
3245 : UNKNOWN_MODTIME_NSECS);
e9a9ae03 3246 return make_emacs_time (0, ns);
dbeed9a6 3247}
55587f8a 3248
570d7624 3249DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
8c1a1077
PJ
3250 1, 5, 0,
3251 doc: /* Insert contents of file FILENAME after point.
cf6d2357 3252Returns list of absolute file name and number of characters inserted.
6f2528d8
MR
3253If second argument VISIT is non-nil, the buffer's visited filename and
3254last save file modtime are set, and it is marked unmodified. If
3255visiting and the file does not exist, visiting is completed before the
3256error is signaled.
3257
3258The optional third and fourth arguments BEG and END specify what portion
3259of the file to insert. These arguments count bytes in the file, not
3260characters in the buffer. If VISIT is non-nil, BEG and END must be nil.
3261
3262If optional fifth argument REPLACE is non-nil, replace the current
3263buffer contents (in the accessible portion) with the file contents.
3264This is better than simply deleting and inserting the whole thing
3265because (1) it preserves some marker positions and (2) it puts less data
3266in the undo list. When REPLACE is non-nil, the second return value is
3267the number of characters that replace previous buffer contents.
3268
3269This function does code conversion according to the value of
3270`coding-system-for-read' or `file-coding-system-alist', and sets the
3271variable `last-coding-system-used' to the coding system actually used. */)
5842a27b 3272 (Lisp_Object filename, Lisp_Object visit, Lisp_Object beg, Lisp_Object end, Lisp_Object replace)
570d7624
JB
3273{
3274 struct stat st;
dbeed9a6
PE
3275 int file_status;
3276 EMACS_TIME mtime;
f75d7a91 3277 int fd;
d311d28c 3278 ptrdiff_t inserted = 0;
f75d7a91
PE
3279 bool nochange = 0;
3280 ptrdiff_t how_much;
728f8f0a 3281 off_t beg_offset, end_offset;
f75d7a91 3282 int unprocessed;
d311d28c 3283 ptrdiff_t count = SPECPDL_INDEX ();
6f2528d8
MR
3284 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
3285 Lisp_Object handler, val, insval, orig_filename, old_undo;
d6a3cc15 3286 Lisp_Object p;
d311d28c 3287 ptrdiff_t total = 0;
f75d7a91 3288 bool not_regular = 0;
e5e9d610 3289 int save_errno = 0;
5976c3fe 3290 char read_buf[READ_BUF_SIZE];
6fdaa9a0 3291 struct coding_system coding;
5976c3fe 3292 char buffer[1 << 14];
f75d7a91
PE
3293 bool replace_handled = 0;
3294 bool set_coding_system = 0;
db327c7e 3295 Lisp_Object coding_system;
f75d7a91 3296 bool read_quit = 0;
490ee853 3297 Lisp_Object old_Vdeactivate_mark = Vdeactivate_mark;
f75d7a91
PE
3298 bool we_locked_file = 0;
3299 bool deferred_remove_unwind_protect = 0;
32f4334d 3300
95385625
RS
3301 if (current_buffer->base_buffer && ! NILP (visit))
3302 error ("Cannot do file visiting in an indirect buffer");
3303
4b4deea2 3304 if (!NILP (BVAR (current_buffer, read_only)))
95385625
RS
3305 Fbarf_if_buffer_read_only ();
3306
32f4334d 3307 val = Qnil;
d6a3cc15 3308 p = Qnil;
b1d1b865 3309 orig_filename = Qnil;
6f2528d8 3310 old_undo = Qnil;
32f4334d 3311
6f2528d8 3312 GCPRO5 (filename, val, p, orig_filename, old_undo);
570d7624 3313
b7826503 3314 CHECK_STRING (filename);
570d7624
JB
3315 filename = Fexpand_file_name (filename, Qnil);
3316
1c157f8d
KH
3317 /* The value Qnil means that the coding system is not yet
3318 decided. */
3319 coding_system = Qnil;
3320
32f4334d
RS
3321 /* If the file name has special constructs in it,
3322 call the corresponding file handler. */
49307295 3323 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
32f4334d
RS
3324 if (!NILP (handler))
3325 {
3d0387c0
RS
3326 val = call6 (handler, Qinsert_file_contents, filename,
3327 visit, beg, end, replace);
d311d28c
PE
3328 if (CONSP (val) && CONSP (XCDR (val))
3329 && RANGED_INTEGERP (0, XCAR (XCDR (val)), ZV - PT))
03699b14 3330 inserted = XINT (XCAR (XCDR (val)));
32f4334d
RS
3331 goto handled;
3332 }
3333
b1d1b865
RS
3334 orig_filename = filename;
3335 filename = ENCODE_FILE (filename);
3336
570d7624
JB
3337 fd = -1;
3338
c1c4693e
RS
3339#ifdef WINDOWSNT
3340 {
3341 Lisp_Object tem = Vw32_get_true_file_attributes;
3342
3343 /* Tell stat to use expensive method to get accurate info. */
3344 Vw32_get_true_file_attributes = Qt;
dbeed9a6 3345 file_status = stat (SSDATA (filename), &st);
c1c4693e
RS
3346 Vw32_get_true_file_attributes = tem;
3347 }
c1c4693e 3348#else
dbeed9a6 3349 file_status = stat (SSDATA (filename), &st);
c1c4693e 3350#endif /* WINDOWSNT */
dbeed9a6
PE
3351
3352 if (file_status == 0)
3353 mtime = get_stat_mtime (&st);
3354 else
570d7624 3355 {
99bc28f4 3356 badopen:
e5e9d610 3357 save_errno = errno;
265a9e55 3358 if (NILP (visit))
b1d1b865 3359 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
f0941253 3360 mtime = time_error_value (save_errno);
b885bf36 3361 st.st_size = -1;
570d7624 3362 how_much = 0;
0de6b8f4 3363 if (!NILP (Vcoding_system_for_read))
22d92d6b 3364 Fset (Qbuffer_file_coding_system, Vcoding_system_for_read);
570d7624
JB
3365 goto notfound;
3366 }
3367
be53b411
JB
3368 /* This code will need to be changed in order to work on named
3369 pipes, and it's probably just not worth it. So we should at
3370 least signal an error. */
99bc28f4 3371 if (!S_ISREG (st.st_mode))
330bfe57 3372 {
d4b8687b
RS
3373 not_regular = 1;
3374
3375 if (! NILP (visit))
3376 goto notfound;
3377
3378 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
24b1ddad
KS
3379 xsignal2 (Qfile_error,
3380 build_string ("not a regular file"), orig_filename);
330bfe57 3381 }
be53b411 3382
99bc28f4 3383 if (fd < 0)
42a5b22f 3384 if ((fd = emacs_open (SSDATA (filename), O_RDONLY, 0)) < 0)
99bc28f4
KH
3385 goto badopen;
3386
3387 /* Replacement should preserve point as it preserves markers. */
3388 if (!NILP (replace))
3389 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3390
3391 record_unwind_protect (close_file_unwind, make_number (fd));
3392
2a47c44d 3393
9f57b6b4
KH
3394 if (!NILP (visit))
3395 {
3396 if (!NILP (beg) || !NILP (end))
3397 error ("Attempt to visit less than an entire file");
3398 if (BEG < Z && NILP (replace))
3399 error ("Cannot do file visiting in a non-empty buffer");
3400 }
7fded690
JB
3401
3402 if (!NILP (beg))
728f8f0a 3403 {
ce2fe65a 3404 if (! RANGED_INTEGERP (0, beg, TYPE_MAXIMUM (off_t)))
728f8f0a
PE
3405 wrong_type_argument (intern ("file-offset"), beg);
3406 beg_offset = XFASTINT (beg);
3407 }
7fded690 3408 else
728f8f0a 3409 beg_offset = 0;
7fded690
JB
3410
3411 if (!NILP (end))
728f8f0a 3412 {
ce2fe65a 3413 if (! RANGED_INTEGERP (0, end, TYPE_MAXIMUM (off_t)))
728f8f0a
PE
3414 wrong_type_argument (intern ("file-offset"), end);
3415 end_offset = XFASTINT (end);
3416 }
7fded690
JB
3417 else
3418 {
728f8f0a
PE
3419 if (not_regular)
3420 end_offset = TYPE_MAXIMUM (off_t);
3421 else
d4b8687b 3422 {
728f8f0a
PE
3423 end_offset = st.st_size;
3424
3425 /* A negative size can happen on a platform that allows file
3426 sizes greater than the maximum off_t value. */
3427 if (end_offset < 0)
3428 buffer_overflow ();
68c45bf0 3429
d21dd12d
GM
3430 /* The file size returned from stat may be zero, but data
3431 may be readable nonetheless, for example when this is a
3432 file in the /proc filesystem. */
728f8f0a
PE
3433 if (end_offset == 0)
3434 end_offset = READ_BUF_SIZE;
d4b8687b 3435 }
7fded690
JB
3436 }
3437
728f8f0a
PE
3438 /* Check now whether the buffer will become too large,
3439 in the likely case where the file's length is not changing.
3440 This saves a lot of needless work before a buffer overflow. */
3441 if (! not_regular)
3442 {
3443 /* The likely offset where we will stop reading. We could read
3444 more (or less), if the file grows (or shrinks) as we read it. */
3445 off_t likely_end = min (end_offset, st.st_size);
3446
3447 if (beg_offset < likely_end)
3448 {
ce2fe65a
AS
3449 ptrdiff_t buf_bytes
3450 = Z_BYTE - (!NILP (replace) ? ZV_BYTE - BEGV_BYTE : 0);
728f8f0a
PE
3451 ptrdiff_t buf_growth_max = BUF_BYTES_MAX - buf_bytes;
3452 off_t likely_growth = likely_end - beg_offset;
3453 if (buf_growth_max < likely_growth)
3454 buffer_overflow ();
3455 }
3456 }
3457
3458 /* Prevent redisplay optimizations. */
3459 current_buffer->clip_changed = 1;
3460
356a6224 3461 if (EQ (Vcoding_system_for_read, Qauto_save_coding))
5560aecd 3462 {
75421805 3463 coding_system = coding_inherit_eol_type (Qutf_8_emacs, Qunix);
5560aecd
KH
3464 setup_coding_system (coding_system, &coding);
3465 /* Ensure we set Vlast_coding_system_used. */
3466 set_coding_system = 1;
3467 }
356a6224 3468 else if (BEG < Z)
f736ffbf
KH
3469 {
3470 /* Decide the coding system to use for reading the file now
3471 because we can't use an optimized method for handling
3472 `coding:' tag if the current buffer is not empty. */
f736ffbf 3473 if (!NILP (Vcoding_system_for_read))
db327c7e 3474 coding_system = Vcoding_system_for_read;
f736ffbf
KH
3475 else
3476 {
3477 /* Don't try looking inside a file for a coding system
3478 specification if it is not seekable. */
3479 if (! not_regular && ! NILP (Vset_auto_coding_function))
3480 {
3481 /* Find a coding system specified in the heading two
3482 lines or in the tailing several lines of the file.
3483 We assume that the 1K-byte and 3K-byte for heading
003a7eaa 3484 and tailing respectively are sufficient for this
f736ffbf 3485 purpose. */
d311d28c 3486 int nread;
f736ffbf
KH
3487
3488 if (st.st_size <= (1024 * 4))
68c45bf0 3489 nread = emacs_read (fd, read_buf, 1024 * 4);
f736ffbf
KH
3490 else
3491 {
68c45bf0 3492 nread = emacs_read (fd, read_buf, 1024);
4c95c9a5 3493 if (nread == 1024)
f736ffbf 3494 {
4c95c9a5
PE
3495 int ntail;
3496 if (lseek (fd, - (1024 * 3), SEEK_END) < 0)
f736ffbf
KH
3497 report_file_error ("Setting file position",
3498 Fcons (orig_filename, Qnil));
4c95c9a5
PE
3499 ntail = emacs_read (fd, read_buf + nread, 1024 * 3);
3500 nread = ntail < 0 ? ntail : nread + ntail;
f736ffbf
KH
3501 }
3502 }
feb9dc27 3503
f736ffbf
KH
3504 if (nread < 0)
3505 error ("IO error reading %s: %s",
d5db4077 3506 SDATA (orig_filename), emacs_strerror (errno));
f736ffbf
KH
3507 else if (nread > 0)
3508 {
f736ffbf 3509 struct buffer *prev = current_buffer;
f839df0c 3510 Lisp_Object workbuf;
685fc579 3511 struct buffer *buf;
f736ffbf 3512
66322887 3513 record_unwind_current_buffer ();
1d92afcd 3514
f839df0c
PE
3515 workbuf = Fget_buffer_create (build_string (" *code-converting-work*"));
3516 buf = XBUFFER (workbuf);
685fc579 3517
29ea8ae9 3518 delete_all_overlays (buf);
39eb03f1
PE
3519 bset_directory (buf, BVAR (current_buffer, directory));
3520 bset_read_only (buf, Qnil);
3521 bset_filename (buf, Qnil);
3522 bset_undo_list (buf, Qt);
fd318b54
DA
3523 eassert (buf->overlays_before == NULL);
3524 eassert (buf->overlays_after == NULL);
efdc16c9 3525
685fc579
RS
3526 set_buffer_internal (buf);
3527 Ferase_buffer ();
39eb03f1 3528 bset_enable_multibyte_characters (buf, Qnil);
685fc579 3529
b68864e5 3530 insert_1_both ((char *) read_buf, nread, nread, 0, 0, 0);
f736ffbf 3531 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
db327c7e 3532 coding_system = call2 (Vset_auto_coding_function,
8f924df7 3533 filename, make_number (nread));
f736ffbf 3534 set_buffer_internal (prev);
efdc16c9 3535
f736ffbf
KH
3536 /* Discard the unwind protect for recovering the
3537 current buffer. */
3538 specpdl_ptr--;
3539
3540 /* Rewind the file for the actual read done later. */
e69dafad 3541 if (lseek (fd, 0, SEEK_SET) < 0)
f736ffbf
KH
3542 report_file_error ("Setting file position",
3543 Fcons (orig_filename, Qnil));
3544 }
3545 }
feb9dc27 3546
db327c7e 3547 if (NILP (coding_system))
f736ffbf
KH
3548 {
3549 /* If we have not yet decided a coding system, check
3550 file-coding-system-alist. */
8f924df7 3551 Lisp_Object args[6];
f736ffbf
KH
3552
3553 args[0] = Qinsert_file_contents, args[1] = orig_filename;
3554 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
8f924df7
KH
3555 coding_system = Ffind_operation_coding_system (6, args);
3556 if (CONSP (coding_system))
3557 coding_system = XCAR (coding_system);
f736ffbf
KH
3558 }
3559 }
c9e82392 3560
db327c7e
KH
3561 if (NILP (coding_system))
3562 coding_system = Qundecided;
3563 else
3564 CHECK_CODING_SYSTEM (coding_system);
c8a6d68a 3565
4b4deea2 3566 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
237a6fd2
RS
3567 /* We must suppress all character code conversion except for
3568 end-of-line conversion. */
db327c7e 3569 coding_system = raw_text_coding_system (coding_system);
54369368 3570
db327c7e
KH
3571 setup_coding_system (coding_system, &coding);
3572 /* Ensure we set Vlast_coding_system_used. */
3573 set_coding_system = 1;
f736ffbf 3574 }
6cf71bf1 3575
3d0387c0
RS
3576 /* If requested, replace the accessible part of the buffer
3577 with the file contents. Avoid replacing text at the
3578 beginning or end of the buffer that matches the file contents;
3dbcf3f6
RS
3579 that preserves markers pointing to the unchanged parts.
3580
3581 Here we implement this feature in an optimized way
3582 for the case where code conversion is NOT needed.
3583 The following if-statement handles the case of conversion
727a0b4a
RS
3584 in a less optimal way.
3585
3586 If the code conversion is "automatic" then we try using this
3587 method and hope for the best.
3588 But if we discover the need for conversion, we give up on this method
3589 and let the following if-statement handle the replace job. */
3dbcf3f6 3590 if (!NILP (replace)
f736ffbf 3591 && BEGV < ZV
db327c7e
KH
3592 && (NILP (coding_system)
3593 || ! CODING_REQUIRE_DECODING (&coding)))
3d0387c0 3594 {
ec7adf26
RS
3595 /* same_at_start and same_at_end count bytes,
3596 because file access counts bytes
3597 and BEG and END count bytes. */
d311d28c
PE
3598 ptrdiff_t same_at_start = BEGV_BYTE;
3599 ptrdiff_t same_at_end = ZV_BYTE;
3600 ptrdiff_t overlap;
6fdaa9a0 3601 /* There is still a possibility we will find the need to do code
f75d7a91 3602 conversion. If that happens, set this variable to
727a0b4a 3603 give up on handling REPLACE in the optimized way. */
f75d7a91 3604 bool giveup_match_end = 0;
9c28748f 3605
728f8f0a 3606 if (beg_offset != 0)
4d2a0879 3607 {
728f8f0a 3608 if (lseek (fd, beg_offset, SEEK_SET) < 0)
4d2a0879 3609 report_file_error ("Setting file position",
b1d1b865 3610 Fcons (orig_filename, Qnil));
4d2a0879
RS
3611 }
3612
3d0387c0
RS
3613 immediate_quit = 1;
3614 QUIT;
3615 /* Count how many chars at the start of the file
3616 match the text at the beginning of the buffer. */
3617 while (1)
3618 {
d311d28c 3619 int nread, bufpos;
3d0387c0 3620
68c45bf0 3621 nread = emacs_read (fd, buffer, sizeof buffer);
3d0387c0
RS
3622 if (nread < 0)
3623 error ("IO error reading %s: %s",
5976c3fe 3624 SSDATA (orig_filename), emacs_strerror (errno));
3d0387c0
RS
3625 else if (nread == 0)
3626 break;
6fdaa9a0 3627
db327c7e 3628 if (CODING_REQUIRE_DETECTION (&coding))
727a0b4a 3629 {
5976c3fe
PE
3630 coding_system = detect_coding_system ((unsigned char *) buffer,
3631 nread, nread, 1, 0,
db327c7e
KH
3632 coding_system);
3633 setup_coding_system (coding_system, &coding);
727a0b4a
RS
3634 }
3635
db327c7e
KH
3636 if (CODING_REQUIRE_DECODING (&coding))
3637 /* We found that the file should be decoded somehow.
727a0b4a
RS
3638 Let's give up here. */
3639 {
3640 giveup_match_end = 1;
3641 break;
3642 }
3643
3d0387c0 3644 bufpos = 0;
ec7adf26 3645 while (bufpos < nread && same_at_start < ZV_BYTE
6fdaa9a0 3646 && FETCH_BYTE (same_at_start) == buffer[bufpos])
3d0387c0
RS
3647 same_at_start++, bufpos++;
3648 /* If we found a discrepancy, stop the scan.
8e6208c5 3649 Otherwise loop around and scan the next bufferful. */
3d0387c0
RS
3650 if (bufpos != nread)
3651 break;
3652 }
3653 immediate_quit = 0;
3654 /* If the file matches the buffer completely,
3655 there's no need to replace anything. */
2ba8e008 3656 if (same_at_start - BEGV_BYTE == end_offset - beg_offset)
3d0387c0 3657 {
68c45bf0 3658 emacs_close (fd);
a1d2b64a 3659 specpdl_ptr--;
1051b3b3 3660 /* Truncate the buffer to the size of the file. */
7dae4502 3661 del_range_1 (same_at_start, same_at_end, 0, 0);
3d0387c0
RS
3662 goto handled;
3663 }
3664 immediate_quit = 1;
3665 QUIT;
3666 /* Count how many chars at the end of the file
6fdaa9a0
KH
3667 match the text at the end of the buffer. But, if we have
3668 already found that decoding is necessary, don't waste time. */
3669 while (!giveup_match_end)
3d0387c0 3670 {
728f8f0a
PE
3671 int total_read, nread, bufpos, trial;
3672 off_t curpos;
3d0387c0
RS
3673
3674 /* At what file position are we now scanning? */
728f8f0a 3675 curpos = end_offset - (ZV_BYTE - same_at_end);
fc81fa9e
KH
3676 /* If the entire file matches the buffer tail, stop the scan. */
3677 if (curpos == 0)
3678 break;
3d0387c0
RS
3679 /* How much can we scan in the next step? */
3680 trial = min (curpos, sizeof buffer);
728f8f0a 3681 if (lseek (fd, curpos - trial, SEEK_SET) < 0)
3d0387c0 3682 report_file_error ("Setting file position",
b1d1b865 3683 Fcons (orig_filename, Qnil));
3d0387c0 3684
b02439c8 3685 total_read = nread = 0;
3d0387c0
RS
3686 while (total_read < trial)
3687 {
68c45bf0 3688 nread = emacs_read (fd, buffer + total_read, trial - total_read);
2bd2273e 3689 if (nread < 0)
3d0387c0 3690 error ("IO error reading %s: %s",
d5db4077 3691 SDATA (orig_filename), emacs_strerror (errno));
2bd2273e
GM
3692 else if (nread == 0)
3693 break;
3d0387c0
RS
3694 total_read += nread;
3695 }
efdc16c9 3696
8e6208c5 3697 /* Scan this bufferful from the end, comparing with
3d0387c0
RS
3698 the Emacs buffer. */
3699 bufpos = total_read;
efdc16c9 3700
3d0387c0
RS
3701 /* Compare with same_at_start to avoid counting some buffer text
3702 as matching both at the file's beginning and at the end. */
3703 while (bufpos > 0 && same_at_end > same_at_start
6fdaa9a0 3704 && FETCH_BYTE (same_at_end - 1) == buffer[bufpos - 1])
3d0387c0 3705 same_at_end--, bufpos--;
727a0b4a 3706
3d0387c0 3707 /* If we found a discrepancy, stop the scan.
8e6208c5 3708 Otherwise loop around and scan the preceding bufferful. */
3d0387c0 3709 if (bufpos != 0)
727a0b4a
RS
3710 {
3711 /* If this discrepancy is because of code conversion,
3712 we cannot use this method; giveup and try the other. */
3713 if (same_at_end > same_at_start
3714 && FETCH_BYTE (same_at_end - 1) >= 0200
4b4deea2 3715 && ! NILP (BVAR (current_buffer, enable_multibyte_characters))
c8a6d68a 3716 && (CODING_MAY_REQUIRE_DECODING (&coding)))
727a0b4a
RS
3717 giveup_match_end = 1;
3718 break;
3719 }
b02439c8
GM
3720
3721 if (nread == 0)
3722 break;
3d0387c0
RS
3723 }
3724 immediate_quit = 0;
9c28748f 3725
727a0b4a
RS
3726 if (! giveup_match_end)
3727 {
d311d28c 3728 ptrdiff_t temp;
ec7adf26 3729
727a0b4a 3730 /* We win! We can handle REPLACE the optimized way. */
9c28748f 3731
20f6783d
RS
3732 /* Extend the start of non-matching text area to multibyte
3733 character boundary. */
4b4deea2 3734 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)))
20f6783d
RS
3735 while (same_at_start > BEGV_BYTE
3736 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
3737 same_at_start--;
3738
3739 /* Extend the end of non-matching text area to multibyte
71312b68 3740 character boundary. */
4b4deea2 3741 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)))
ec7adf26
RS
3742 while (same_at_end < ZV_BYTE
3743 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
71312b68
RS
3744 same_at_end++;
3745
727a0b4a 3746 /* Don't try to reuse the same piece of text twice. */
ec7adf26 3747 overlap = (same_at_start - BEGV_BYTE
728f8f0a
PE
3748 - (same_at_end
3749 + (! NILP (end) ? end_offset : st.st_size) - ZV_BYTE));
727a0b4a
RS
3750 if (overlap > 0)
3751 same_at_end += overlap;
9c28748f 3752
727a0b4a 3753 /* Arrange to read only the nonmatching middle part of the file. */
728f8f0a
PE
3754 beg_offset += same_at_start - BEGV_BYTE;
3755 end_offset -= ZV_BYTE - same_at_end;
3dbcf3f6 3756
ec7adf26 3757 del_range_byte (same_at_start, same_at_end, 0);
727a0b4a 3758 /* Insert from the file at the proper position. */
ec7adf26
RS
3759 temp = BYTE_TO_CHAR (same_at_start);
3760 SET_PT_BOTH (temp, same_at_start);
727a0b4a
RS
3761
3762 /* If display currently starts at beginning of line,
3763 keep it that way. */
d3d50620 3764 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
c98ff5dd 3765 XWINDOW (selected_window)->start_at_line_beg = !NILP (Fbolp ());
727a0b4a
RS
3766
3767 replace_handled = 1;
3768 }
3dbcf3f6
RS
3769 }
3770
3771 /* If requested, replace the accessible part of the buffer
3772 with the file contents. Avoid replacing text at the
3773 beginning or end of the buffer that matches the file contents;
3774 that preserves markers pointing to the unchanged parts.
3775
3776 Here we implement this feature for the case where code conversion
3777 is needed, in a simple way that needs a lot of memory.
3778 The preceding if-statement handles the case of no conversion
3779 in a more optimized way. */
f736ffbf 3780 if (!NILP (replace) && ! replace_handled && BEGV < ZV)
3dbcf3f6 3781 {
d311d28c
PE
3782 ptrdiff_t same_at_start = BEGV_BYTE;
3783 ptrdiff_t same_at_end = ZV_BYTE;
3784 ptrdiff_t same_at_start_charpos;
3785 ptrdiff_t inserted_chars;
3786 ptrdiff_t overlap;
3787 ptrdiff_t bufpos;
db327c7e 3788 unsigned char *decoded;
d311d28c
PE
3789 ptrdiff_t temp;
3790 ptrdiff_t this = 0;
3791 ptrdiff_t this_count = SPECPDL_INDEX ();
f10fe38f
PE
3792 bool multibyte
3793 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
5b359650 3794 Lisp_Object conversion_buffer;
83aca1cb 3795 struct gcpro gcpro1;
db327c7e 3796
5b359650 3797 conversion_buffer = code_conversion_save (1, multibyte);
3dbcf3f6
RS
3798
3799 /* First read the whole file, performing code conversion into
3800 CONVERSION_BUFFER. */
3801
728f8f0a 3802 if (lseek (fd, beg_offset, SEEK_SET) < 0)
8f924df7
KH
3803 report_file_error ("Setting file position",
3804 Fcons (orig_filename, Qnil));
727a0b4a 3805
3dbcf3f6
RS
3806 total = st.st_size; /* Total bytes in the file. */
3807 how_much = 0; /* Bytes read from file so far. */
3808 inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */
3809 unprocessed = 0; /* Bytes not processed in previous loop. */
3810
2ba48777 3811 GCPRO1 (conversion_buffer);
3dbcf3f6
RS
3812 while (how_much < total)
3813 {
db327c7e
KH
3814 /* We read one bunch by one (READ_BUF_SIZE bytes) to allow
3815 quitting while reading a huge while. */
a5bb9bd3 3816 /* `try'' is reserved in some compilers (Microsoft C). */
d311d28c 3817 int trytry = min (total - how_much, READ_BUF_SIZE - unprocessed);
3dbcf3f6
RS
3818
3819 /* Allow quitting out of the actual I/O. */
3820 immediate_quit = 1;
3821 QUIT;
db327c7e 3822 this = emacs_read (fd, read_buf + unprocessed, trytry);
3dbcf3f6
RS
3823 immediate_quit = 0;
3824
db327c7e 3825 if (this <= 0)
43aae36e 3826 break;
3dbcf3f6
RS
3827
3828 how_much += this;
3829
bf1c0f27
SM
3830 BUF_TEMP_SET_PT (XBUFFER (conversion_buffer),
3831 BUF_Z (XBUFFER (conversion_buffer)));
5976c3fe
PE
3832 decode_coding_c_string (&coding, (unsigned char *) read_buf,
3833 unprocessed + this, conversion_buffer);
db327c7e
KH
3834 unprocessed = coding.carryover_bytes;
3835 if (coding.carryover_bytes > 0)
72af86bd 3836 memcpy (read_buf, coding.carryover, unprocessed);
3dbcf3f6 3837 }
2ba48777 3838 UNGCPRO;
db327c7e 3839 emacs_close (fd);
3dbcf3f6 3840
db65a627
CY
3841 /* We should remove the unwind_protect calling
3842 close_file_unwind, but other stuff has been added the stack,
3843 so defer the removal till we reach the `handled' label. */
3844 deferred_remove_unwind_protect = 1;
3845
db327c7e
KH
3846 /* At this point, HOW_MUCH should equal TOTAL, or should be <= 0
3847 if we couldn't read the file. */
3dbcf3f6 3848
43aae36e 3849 if (this < 0)
4ed925c6
MB
3850 error ("IO error reading %s: %s",
3851 SDATA (orig_filename), emacs_strerror (errno));
3dbcf3f6 3852
db327c7e
KH
3853 if (unprocessed > 0)
3854 {
3855 coding.mode |= CODING_MODE_LAST_BLOCK;
5976c3fe
PE
3856 decode_coding_c_string (&coding, (unsigned char *) read_buf,
3857 unprocessed, conversion_buffer);
db327c7e
KH
3858 coding.mode &= ~CODING_MODE_LAST_BLOCK;
3859 }
3860
50b06221 3861 coding_system = CODING_ID_NAME (coding.id);
f6a07420 3862 set_coding_system = 1;
db327c7e 3863 decoded = BUF_BEG_ADDR (XBUFFER (conversion_buffer));
50342b35
KH
3864 inserted = (BUF_Z_BYTE (XBUFFER (conversion_buffer))
3865 - BUF_BEG_BYTE (XBUFFER (conversion_buffer)));
db327c7e
KH
3866
3867 /* Compare the beginning of the converted string with the buffer
3868 text. */
3dbcf3f6
RS
3869
3870 bufpos = 0;
3871 while (bufpos < inserted && same_at_start < same_at_end
db327c7e 3872 && FETCH_BYTE (same_at_start) == decoded[bufpos])
3dbcf3f6
RS
3873 same_at_start++, bufpos++;
3874
db327c7e 3875 /* If the file matches the head of buffer completely,
3dbcf3f6
RS
3876 there's no need to replace anything. */
3877
3878 if (bufpos == inserted)
3879 {
3dbcf3f6 3880 /* Truncate the buffer to the size of the file. */
18a9f8d9
SM
3881 if (same_at_start == same_at_end)
3882 nochange = 1;
3883 else
3884 del_range_byte (same_at_start, same_at_end, 0);
427f5aab 3885 inserted = 0;
e8553dd1
KH
3886
3887 unbind_to (this_count, Qnil);
3dbcf3f6
RS
3888 goto handled;
3889 }
3890
db327c7e
KH
3891 /* Extend the start of non-matching text area to the previous
3892 multibyte character boundary. */
4b4deea2 3893 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)))
20f6783d
RS
3894 while (same_at_start > BEGV_BYTE
3895 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
3896 same_at_start--;
3897
3dbcf3f6
RS
3898 /* Scan this bufferful from the end, comparing with
3899 the Emacs buffer. */
3900 bufpos = inserted;
3901
3902 /* Compare with same_at_start to avoid counting some buffer text
3903 as matching both at the file's beginning and at the end. */
3904 while (bufpos > 0 && same_at_end > same_at_start
db327c7e 3905 && FETCH_BYTE (same_at_end - 1) == decoded[bufpos - 1])
3dbcf3f6
RS
3906 same_at_end--, bufpos--;
3907
db327c7e
KH
3908 /* Extend the end of non-matching text area to the next
3909 multibyte character boundary. */
4b4deea2 3910 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)))
20f6783d
RS
3911 while (same_at_end < ZV_BYTE
3912 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
3913 same_at_end++;
3914
3dbcf3f6 3915 /* Don't try to reuse the same piece of text twice. */
ec7adf26 3916 overlap = same_at_start - BEGV_BYTE - (same_at_end + inserted - ZV_BYTE);
3dbcf3f6
RS
3917 if (overlap > 0)
3918 same_at_end += overlap;
3919
727a0b4a
RS
3920 /* If display currently starts at beginning of line,
3921 keep it that way. */
d3d50620 3922 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
c98ff5dd 3923 XWINDOW (selected_window)->start_at_line_beg = !NILP (Fbolp ());
727a0b4a 3924
3dbcf3f6
RS
3925 /* Replace the chars that we need to replace,
3926 and update INSERTED to equal the number of bytes
db327c7e 3927 we are taking from the decoded string. */
4b70e2c9 3928 inserted -= (ZV_BYTE - same_at_end) + (same_at_start - BEGV_BYTE);
427f5aab 3929
643c73b9 3930 if (same_at_end != same_at_start)
427f5aab
KH
3931 {
3932 del_range_byte (same_at_start, same_at_end, 0);
3933 temp = GPT;
3934 same_at_start = GPT_BYTE;
3935 }
643c73b9
RS
3936 else
3937 {
643c73b9 3938 temp = BYTE_TO_CHAR (same_at_start);
643c73b9 3939 }
427f5aab
KH
3940 /* Insert from the file at the proper position. */
3941 SET_PT_BOTH (temp, same_at_start);
50342b35
KH
3942 same_at_start_charpos
3943 = buf_bytepos_to_charpos (XBUFFER (conversion_buffer),
7f5d2c72
SM
3944 same_at_start - BEGV_BYTE
3945 + BUF_BEG_BYTE (XBUFFER (conversion_buffer)));
50342b35
KH
3946 inserted_chars
3947 = (buf_bytepos_to_charpos (XBUFFER (conversion_buffer),
7f5d2c72
SM
3948 same_at_start + inserted - BEGV_BYTE
3949 + BUF_BEG_BYTE (XBUFFER (conversion_buffer)))
50342b35 3950 - same_at_start_charpos);
d07af40d
KH
3951 /* This binding is to avoid ask-user-about-supersession-threat
3952 being called in insert_from_buffer (via in
3953 prepare_to_modify_buffer). */
3954 specbind (intern ("buffer-file-name"), Qnil);
db327c7e 3955 insert_from_buffer (XBUFFER (conversion_buffer),
50342b35 3956 same_at_start_charpos, inserted_chars, 0);
427f5aab
KH
3957 /* Set `inserted' to the number of inserted characters. */
3958 inserted = PT - temp;
77343e1d
KH
3959 /* Set point before the inserted characters. */
3960 SET_PT_BOTH (temp, same_at_start);
3dbcf3f6 3961
db327c7e 3962 unbind_to (this_count, Qnil);
3dbcf3f6 3963
3dbcf3f6 3964 goto handled;
3d0387c0
RS
3965 }
3966
d4b8687b 3967 if (! not_regular)
728f8f0a 3968 total = end_offset - beg_offset;
d4b8687b
RS
3969 else
3970 /* For a special file, all we can do is guess. */
3971 total = READ_BUF_SIZE;
570d7624 3972
8b913b57 3973 if (NILP (visit) && total > 0)
68780e2a
RS
3974 {
3975#ifdef CLASH_DETECTION
4b4deea2 3976 if (!NILP (BVAR (current_buffer, file_truename))
68780e2a 3977 /* Make binding buffer-file-name to nil effective. */
4b4deea2 3978 && !NILP (BVAR (current_buffer, filename))
68780e2a
RS
3979 && SAVE_MODIFF >= MODIFF)
3980 we_locked_file = 1;
3981#endif /* CLASH_DETECTION */
3982 prepare_to_modify_buffer (GPT, GPT, NULL);
3983 }
570d7624 3984
7fe52289 3985 move_gap (PT);
7fded690
JB
3986 if (GAP_SIZE < total)
3987 make_gap (total - GAP_SIZE);
3988
728f8f0a 3989 if (beg_offset != 0 || !NILP (replace))
7fded690 3990 {
728f8f0a 3991 if (lseek (fd, beg_offset, SEEK_SET) < 0)
b1d1b865
RS
3992 report_file_error ("Setting file position",
3993 Fcons (orig_filename, Qnil));
7fded690
JB
3994 }
3995
6fdaa9a0 3996 /* In the following loop, HOW_MUCH contains the total bytes read so
c8a6d68a
KH
3997 far for a regular file, and not changed for a special file. But,
3998 before exiting the loop, it is set to a negative value if I/O
3999 error occurs. */
a1d2b64a 4000 how_much = 0;
efdc16c9 4001
6fdaa9a0
KH
4002 /* Total bytes inserted. */
4003 inserted = 0;
efdc16c9 4004
c8a6d68a 4005 /* Here, we don't do code conversion in the loop. It is done by
db327c7e 4006 decode_coding_gap after all data are read into the buffer. */
1b978129 4007 {
d311d28c 4008 ptrdiff_t gap_size = GAP_SIZE;
efdc16c9 4009
1b978129
GM
4010 while (how_much < total)
4011 {
5e570b75 4012 /* try is reserved in some compilers (Microsoft C) */
d311d28c
PE
4013 int trytry = min (total - how_much, READ_BUF_SIZE);
4014 ptrdiff_t this;
570d7624 4015
1b978129
GM
4016 if (not_regular)
4017 {
f839df0c 4018 Lisp_Object nbytes;
570d7624 4019
1b978129
GM
4020 /* Maybe make more room. */
4021 if (gap_size < trytry)
4022 {
4023 make_gap (total - gap_size);
4024 gap_size = GAP_SIZE;
4025 }
4026
4027 /* Read from the file, capturing `quit'. When an
4028 error occurs, end the loop, and arrange for a quit
4029 to be signaled after decoding the text we read. */
4030 non_regular_fd = fd;
4031 non_regular_inserted = inserted;
4032 non_regular_nbytes = trytry;
f839df0c
PE
4033 nbytes = internal_condition_case_1 (read_non_regular,
4034 Qnil, Qerror,
4035 read_non_regular_quit);
4036 if (NILP (nbytes))
1b978129
GM
4037 {
4038 read_quit = 1;
4039 break;
4040 }
4041
f839df0c 4042 this = XINT (nbytes);
1b978129
GM
4043 }
4044 else
4045 {
4046 /* Allow quitting out of the actual I/O. We don't make text
4047 part of the buffer until all the reading is done, so a C-g
4048 here doesn't do any harm. */
4049 immediate_quit = 1;
4050 QUIT;
5976c3fe
PE
4051 this = emacs_read (fd,
4052 ((char *) BEG_ADDR + PT_BYTE - BEG_BYTE
4053 + inserted),
4054 trytry);
1b978129
GM
4055 immediate_quit = 0;
4056 }
efdc16c9 4057
1b978129
GM
4058 if (this <= 0)
4059 {
4060 how_much = this;
4061 break;
4062 }
4063
4064 gap_size -= this;
4065
4066 /* For a regular file, where TOTAL is the real size,
4067 count HOW_MUCH to compare with it.
4068 For a special file, where TOTAL is just a buffer size,
4069 so don't bother counting in HOW_MUCH.
4070 (INSERTED is where we count the number of characters inserted.) */
4071 if (! not_regular)
4072 how_much += this;
4073 inserted += this;
4074 }
4075 }
4076
68780e2a
RS
4077 /* Now we have read all the file data into the gap.
4078 If it was empty, undo marking the buffer modified. */
4079
4080 if (inserted == 0)
4081 {
6840d350 4082#ifdef CLASH_DETECTION
68780e2a 4083 if (we_locked_file)
4b4deea2 4084 unlock_file (BVAR (current_buffer, file_truename));
6840d350 4085#endif
68780e2a
RS
4086 Vdeactivate_mark = old_Vdeactivate_mark;
4087 }
83c1cf6d
RS
4088 else
4089 Vdeactivate_mark = Qt;
68780e2a 4090
1b978129
GM
4091 /* Make the text read part of the buffer. */
4092 GAP_SIZE -= inserted;
4093 GPT += inserted;
4094 GPT_BYTE += inserted;
4095 ZV += inserted;
4096 ZV_BYTE += inserted;
4097 Z += inserted;
4098 Z_BYTE += inserted;
6fdaa9a0 4099
c8a6d68a
KH
4100 if (GAP_SIZE > 0)
4101 /* Put an anchor to ensure multi-byte form ends at gap. */
4102 *GPT_ADDR = 0;
d4b8687b 4103
68c45bf0 4104 emacs_close (fd);
6fdaa9a0 4105
c8a6d68a
KH
4106 /* Discard the unwind protect for closing the file. */
4107 specpdl_ptr--;
6fdaa9a0 4108
c8a6d68a
KH
4109 if (how_much < 0)
4110 error ("IO error reading %s: %s",
d5db4077 4111 SDATA (orig_filename), emacs_strerror (errno));
ec7adf26 4112
f8569325
DL
4113 notfound:
4114
db327c7e 4115 if (NILP (coding_system))
c8a6d68a 4116 {
2df42e09 4117 /* The coding system is not yet decided. Decide it by an
dfe35e7b
RS
4118 optimized method for handling `coding:' tag.
4119
4120 Note that we can get here only if the buffer was empty
4121 before the insertion. */
f736ffbf 4122
2df42e09 4123 if (!NILP (Vcoding_system_for_read))
db327c7e 4124 coding_system = Vcoding_system_for_read;
2df42e09
KH
4125 else
4126 {
98a7d268
KH
4127 /* Since we are sure that the current buffer was empty
4128 before the insertion, we can toggle
4129 enable-multibyte-characters directly here without taking
9a7f80aa
KH
4130 care of marker adjustment. By this way, we can run Lisp
4131 program safely before decoding the inserted text. */
98a7d268 4132 Lisp_Object unwind_data;
d311d28c 4133 ptrdiff_t count1 = SPECPDL_INDEX ();
2df42e09 4134
4b4deea2
TT
4135 unwind_data = Fcons (BVAR (current_buffer, enable_multibyte_characters),
4136 Fcons (BVAR (current_buffer, undo_list),
98a7d268 4137 Fcurrent_buffer ()));
39eb03f1
PE
4138 bset_enable_multibyte_characters (current_buffer, Qnil);
4139 bset_undo_list (current_buffer, Qt);
98a7d268
KH
4140 record_unwind_protect (decide_coding_unwind, unwind_data);
4141
4142 if (inserted > 0 && ! NILP (Vset_auto_coding_function))
4143 {
db327c7e 4144 coding_system = call2 (Vset_auto_coding_function,
8f924df7 4145 filename, make_number (inserted));
2df42e09 4146 }
f736ffbf 4147
db327c7e 4148 if (NILP (coding_system))
2df42e09
KH
4149 {
4150 /* If the coding system is not yet decided, check
4151 file-coding-system-alist. */
8f924df7 4152 Lisp_Object args[6];
f736ffbf 4153
2df42e09
KH
4154 args[0] = Qinsert_file_contents, args[1] = orig_filename;
4155 args[2] = visit, args[3] = beg, args[4] = end, args[5] = Qnil;
8f924df7
KH
4156 coding_system = Ffind_operation_coding_system (6, args);
4157 if (CONSP (coding_system))
4158 coding_system = XCAR (coding_system);
f736ffbf 4159 }
f839df0c 4160 unbind_to (count1, Qnil);
98a7d268 4161 inserted = Z_BYTE - BEG_BYTE;
2df42e09 4162 }
f736ffbf 4163
db327c7e
KH
4164 if (NILP (coding_system))
4165 coding_system = Qundecided;
4166 else
4167 CHECK_CODING_SYSTEM (coding_system);
f736ffbf 4168
4b4deea2 4169 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
237a6fd2 4170 /* We must suppress all character code conversion except for
2df42e09 4171 end-of-line conversion. */
db327c7e 4172 coding_system = raw_text_coding_system (coding_system);
db327c7e
KH
4173 setup_coding_system (coding_system, &coding);
4174 /* Ensure we set Vlast_coding_system_used. */
4175 set_coding_system = 1;
2df42e09 4176 }
f736ffbf 4177
db327c7e 4178 if (!NILP (visit))
8c3b9441 4179 {
db327c7e 4180 /* When we visit a file by raw-text, we change the buffer to
9a7f80aa 4181 unibyte. */
db327c7e
KH
4182 if (CODING_FOR_UNIBYTE (&coding)
4183 /* Can't do this if part of the buffer might be preserved. */
4184 && NILP (replace))
4185 /* Visiting a file with these coding system makes the buffer
4186 unibyte. */
39eb03f1 4187 bset_enable_multibyte_characters (current_buffer, Qnil);
8c3b9441
KH
4188 }
4189
4b4deea2 4190 coding.dst_multibyte = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
5b359650 4191 if (CODING_MAY_REQUIRE_DECODING (&coding)
1c157f8d 4192 && (inserted > 0 || CODING_REQUIRE_FLUSHING (&coding)))
2df42e09 4193 {
db327c7e
KH
4194 move_gap_both (PT, PT_BYTE);
4195 GAP_SIZE += inserted;
4196 ZV_BYTE -= inserted;
4197 Z_BYTE -= inserted;
4198 ZV -= inserted;
4199 Z -= inserted;
4200 decode_coding_gap (&coding, inserted, inserted);
4201 inserted = coding.produced_char;
5b359650 4202 coding_system = CODING_ID_NAME (coding.id);
2df42e09 4203 }
db327c7e
KH
4204 else if (inserted > 0)
4205 adjust_after_insert (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4206 inserted);
570d7624 4207
0068070e
SM
4208 /* Call after-change hooks for the inserted text, aside from the case
4209 of normal visiting (not with REPLACE), which is done in a new buffer
4210 "before" the buffer is changed. */
4211 if (inserted > 0 && total > 0
4212 && (NILP (visit) || !NILP (replace)))
4213 {
4214 signal_after_change (PT, 0, inserted);
4215 update_compositions (PT, PT, CHECK_BORDER);
4216 }
4217
cf6d2357
RS
4218 /* Now INSERTED is measured in characters. */
4219
32f4334d 4220 handled:
570d7624 4221
db65a627
CY
4222 if (deferred_remove_unwind_protect)
4223 /* If requested above, discard the unwind protect for closing the
4224 file. */
4225 specpdl_ptr--;
4226
265a9e55 4227 if (!NILP (visit))
570d7624 4228 {
4b4deea2 4229 if (!EQ (BVAR (current_buffer, undo_list), Qt) && !nochange)
39eb03f1 4230 bset_undo_list (current_buffer, Qnil);
62bcf009 4231
a7e82472
RS
4232 if (NILP (handler))
4233 {
dbeed9a6 4234 current_buffer->modtime = mtime;
58b963f7 4235 current_buffer->modtime_size = st.st_size;
39eb03f1 4236 bset_filename (current_buffer, orig_filename);
a7e82472 4237 }
62bcf009 4238
95385625 4239 SAVE_MODIFF = MODIFF;
0b5397c2 4240 BUF_AUTOSAVE_MODIFF (current_buffer) = MODIFF;
4b4deea2 4241 XSETFASTINT (BVAR (current_buffer, save_length), Z - BEG);
570d7624 4242#ifdef CLASH_DETECTION
32f4334d
RS
4243 if (NILP (handler))
4244 {
4b4deea2
TT
4245 if (!NILP (BVAR (current_buffer, file_truename)))
4246 unlock_file (BVAR (current_buffer, file_truename));
32f4334d
RS
4247 unlock_file (filename);
4248 }
570d7624 4249#endif /* CLASH_DETECTION */
330bfe57 4250 if (not_regular)
24b1ddad
KS
4251 xsignal2 (Qfile_error,
4252 build_string ("not a regular file"), orig_filename);
570d7624
JB
4253 }
4254
b6426b03 4255 if (set_coding_system)
8f924df7 4256 Vlast_coding_system_used = coding_system;
b6426b03 4257
2080470e 4258 if (! NILP (Ffboundp (Qafter_insert_file_set_coding)))
b6426b03 4259 {
37a3c774
KH
4260 insval = call2 (Qafter_insert_file_set_coding, make_number (inserted),
4261 visit);
b6426b03
KH
4262 if (! NILP (insval))
4263 {
d311d28c
PE
4264 if (! RANGED_INTEGERP (0, insval, ZV - PT))
4265 wrong_type_argument (intern ("inserted-chars"), insval);
b6426b03
KH
4266 inserted = XFASTINT (insval);
4267 }
4268 }
4269
6420e80c 4270 /* Decode file format. */
c8a6d68a 4271 if (inserted > 0)
0d420e88 4272 {
6420e80c 4273 /* Don't run point motion or modification hooks when decoding. */
d311d28c
PE
4274 ptrdiff_t count1 = SPECPDL_INDEX ();
4275 ptrdiff_t old_inserted = inserted;
6f2528d8
MR
4276 specbind (Qinhibit_point_motion_hooks, Qt);
4277 specbind (Qinhibit_modification_hooks, Qt);
4278
6420e80c 4279 /* Save old undo list and don't record undo for decoding. */
4b4deea2 4280 old_undo = BVAR (current_buffer, undo_list);
39eb03f1 4281 bset_undo_list (current_buffer, Qt);
efdc16c9 4282
6f2528d8 4283 if (NILP (replace))
ed8e506f 4284 {
6f2528d8
MR
4285 insval = call3 (Qformat_decode,
4286 Qnil, make_number (inserted), visit);
d311d28c
PE
4287 if (! RANGED_INTEGERP (0, insval, ZV - PT))
4288 wrong_type_argument (intern ("inserted-chars"), insval);
6f2528d8
MR
4289 inserted = XFASTINT (insval);
4290 }
4291 else
4292 {
4293 /* If REPLACE is non-nil and we succeeded in not replacing the
6420e80c
AS
4294 beginning or end of the buffer text with the file's contents,
4295 call format-decode with `point' positioned at the beginning
fa463103 4296 of the buffer and `inserted' equaling the number of
6420e80c
AS
4297 characters in the buffer. Otherwise, format-decode might
4298 fail to correctly analyze the beginning or end of the buffer.
4299 Hence we temporarily save `point' and `inserted' here and
4300 restore `point' iff format-decode did not insert or delete
4301 any text. Otherwise we leave `point' at point-min. */
d311d28c
PE
4302 ptrdiff_t opoint = PT;
4303 ptrdiff_t opoint_byte = PT_BYTE;
4304 ptrdiff_t oinserted = ZV - BEGV;
4305 EMACS_INT ochars_modiff = CHARS_MODIFF;
1f163f28
MA
4306
4307 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
6f2528d8
MR
4308 insval = call3 (Qformat_decode,
4309 Qnil, make_number (oinserted), visit);
d311d28c
PE
4310 if (! RANGED_INTEGERP (0, insval, ZV - PT))
4311 wrong_type_argument (intern ("inserted-chars"), insval);
cac4219c
MR
4312 if (ochars_modiff == CHARS_MODIFF)
4313 /* format_decode didn't modify buffer's characters => move
4314 point back to position before inserted text and leave
6420e80c 4315 value of inserted alone. */
6f2528d8 4316 SET_PT_BOTH (opoint, opoint_byte);
cac4219c
MR
4317 else
4318 /* format_decode modified buffer's characters => consider
6420e80c 4319 entire buffer changed and leave point at point-min. */
cac4219c 4320 inserted = XFASTINT (insval);
ed8e506f 4321 }
efdc16c9 4322
6f2528d8 4323 /* For consistency with format-decode call these now iff inserted > 0
6420e80c 4324 (martin 2007-06-28). */
6f2528d8
MR
4325 p = Vafter_insert_file_functions;
4326 while (CONSP (p))
4327 {
4328 if (NILP (replace))
4329 {
4330 insval = call1 (XCAR (p), make_number (inserted));
4331 if (!NILP (insval))
4332 {
d311d28c
PE
4333 if (! RANGED_INTEGERP (0, insval, ZV - PT))
4334 wrong_type_argument (intern ("inserted-chars"), insval);
6f2528d8
MR
4335 inserted = XFASTINT (insval);
4336 }
4337 }
4338 else
4339 {
6420e80c
AS
4340 /* For the rationale of this see the comment on
4341 format-decode above. */
d311d28c
PE
4342 ptrdiff_t opoint = PT;
4343 ptrdiff_t opoint_byte = PT_BYTE;
4344 ptrdiff_t oinserted = ZV - BEGV;
4345 EMACS_INT ochars_modiff = CHARS_MODIFF;
1f163f28 4346
6f2528d8
MR
4347 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
4348 insval = call1 (XCAR (p), make_number (oinserted));
4349 if (!NILP (insval))
4350 {
d311d28c
PE
4351 if (! RANGED_INTEGERP (0, insval, ZV - PT))
4352 wrong_type_argument (intern ("inserted-chars"), insval);
cac4219c
MR
4353 if (ochars_modiff == CHARS_MODIFF)
4354 /* after_insert_file_functions didn't modify
4355 buffer's characters => move point back to
4356 position before inserted text and leave value of
6420e80c 4357 inserted alone. */
6f2528d8 4358 SET_PT_BOTH (opoint, opoint_byte);
cac4219c
MR
4359 else
4360 /* after_insert_file_functions did modify buffer's
4361 characters => consider entire buffer changed and
6420e80c 4362 leave point at point-min. */
cac4219c 4363 inserted = XFASTINT (insval);
6f2528d8
MR
4364 }
4365 }
4366
4367 QUIT;
4368 p = XCDR (p);
ed8e506f 4369 }
efdc16c9 4370
6f2528d8
MR
4371 if (NILP (visit))
4372 {
39eb03f1 4373 bset_undo_list (current_buffer, old_undo);
6420e80c 4374 if (CONSP (old_undo) && inserted != old_inserted)
6f2528d8 4375 {
6420e80c
AS
4376 /* Adjust the last undo record for the size change during
4377 the format conversion. */
6f2528d8 4378 Lisp_Object tem = XCAR (old_undo);
6420e80c
AS
4379 if (CONSP (tem) && INTEGERP (XCAR (tem))
4380 && INTEGERP (XCDR (tem))
4381 && XFASTINT (XCDR (tem)) == PT + old_inserted)
4382 XSETCDR (tem, make_number (PT + inserted));
6f2528d8
MR
4383 }
4384 }
6f2528d8 4385 else
1bc99c9c 4386 /* If undo_list was Qt before, keep it that way.
6420e80c 4387 Otherwise start with an empty undo_list. */
39eb03f1 4388 bset_undo_list (current_buffer, EQ (old_undo, Qt) ? Qt : Qnil);
efdc16c9 4389
f839df0c 4390 unbind_to (count1, Qnil);
0d420e88
BG
4391 }
4392
f8569325 4393 if (!NILP (visit)
d35af63c 4394 && EMACS_NSECS (current_buffer->modtime) == NONEXISTENT_MODTIME_NSECS)
f8569325
DL
4395 {
4396 /* If visiting nonexistent file, return nil. */
e5e9d610 4397 errno = save_errno;
f8569325 4398 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
d6a3cc15
RS
4399 }
4400
1b978129
GM
4401 if (read_quit)
4402 Fsignal (Qquit, Qnil);
4403
ec7adf26 4404 /* ??? Retval needs to be dealt with in all cases consistently. */
a1d2b64a 4405 if (NILP (val))
b1d1b865 4406 val = Fcons (orig_filename,
a1d2b64a
RS
4407 Fcons (make_number (inserted),
4408 Qnil));
4409
4410 RETURN_UNGCPRO (unbind_to (count, val));
570d7624 4411}
7fded690 4412\f
f57e2426 4413static Lisp_Object build_annotations (Lisp_Object, Lisp_Object);
d6a3cc15 4414
199607e4 4415static Lisp_Object
971de7fb 4416build_annotations_unwind (Lisp_Object arg)
6fc6f94b 4417{
67fbc0cb 4418 Vwrite_region_annotation_buffers = arg;
6fc6f94b
RS
4419 return Qnil;
4420}
4421
7c82a4a9
SM
4422/* Decide the coding-system to encode the data with. */
4423
c934586d 4424static Lisp_Object
dd4c5104
DN
4425choose_write_coding_system (Lisp_Object start, Lisp_Object end, Lisp_Object filename,
4426 Lisp_Object append, Lisp_Object visit, Lisp_Object lockname,
4427 struct coding_system *coding)
7c82a4a9
SM
4428{
4429 Lisp_Object val;
75421805 4430 Lisp_Object eol_parent = Qnil;
7c82a4a9 4431
6b61353c 4432 if (auto_saving
4b4deea2
TT
4433 && NILP (Fstring_equal (BVAR (current_buffer, filename),
4434 BVAR (current_buffer, auto_save_file_name))))
75421805
KH
4435 {
4436 val = Qutf_8_emacs;
4437 eol_parent = Qunix;
4438 }
7c82a4a9 4439 else if (!NILP (Vcoding_system_for_write))
42b01e1e
KH
4440 {
4441 val = Vcoding_system_for_write;
4442 if (coding_system_require_warning
4443 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4444 /* Confirm that VAL can surely encode the current region. */
4445 val = call5 (Vselect_safe_coding_system_function,
4446 start, end, Fcons (Qt, Fcons (val, Qnil)),
4447 Qnil, filename);
4448 }
7c82a4a9
SM
4449 else
4450 {
4451 /* If the variable `buffer-file-coding-system' is set locally,
4452 it means that the file was read with some kind of code
4453 conversion or the variable is explicitly set by users. We
4454 had better write it out with the same coding system even if
4455 `enable-multibyte-characters' is nil.
4456
4457 If it is not set locally, we anyway have to convert EOL
4458 format if the default value of `buffer-file-coding-system'
4459 tells that it is not Unix-like (LF only) format. */
f75d7a91
PE
4460 bool using_default_coding = 0;
4461 bool force_raw_text = 0;
7c82a4a9 4462
4b4deea2 4463 val = BVAR (current_buffer, buffer_file_coding_system);
7c82a4a9
SM
4464 if (NILP (val)
4465 || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
4466 {
4467 val = Qnil;
4b4deea2 4468 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
7c82a4a9
SM
4469 force_raw_text = 1;
4470 }
efdc16c9 4471
7c82a4a9
SM
4472 if (NILP (val))
4473 {
4474 /* Check file-coding-system-alist. */
4475 Lisp_Object args[7], coding_systems;
4476
4477 args[0] = Qwrite_region; args[1] = start; args[2] = end;
4478 args[3] = filename; args[4] = append; args[5] = visit;
4479 args[6] = lockname;
4480 coding_systems = Ffind_operation_coding_system (7, args);
4481 if (CONSP (coding_systems) && !NILP (XCDR (coding_systems)))
4482 val = XCDR (coding_systems);
4483 }
4484
c934586d 4485 if (NILP (val))
7c82a4a9
SM
4486 {
4487 /* If we still have not decided a coding system, use the
4488 default value of buffer-file-coding-system. */
4b4deea2 4489 val = BVAR (current_buffer, buffer_file_coding_system);
7c82a4a9
SM
4490 using_default_coding = 1;
4491 }
efdc16c9 4492
db327c7e
KH
4493 if (! NILP (val) && ! force_raw_text)
4494 {
4495 Lisp_Object spec, attrs;
4496
4497 CHECK_CODING_SYSTEM_GET_SPEC (val, spec);
4498 attrs = AREF (spec, 0);
4499 if (EQ (CODING_ATTR_TYPE (attrs), Qraw_text))
4500 force_raw_text = 1;
4501 }
4502
7c82a4a9
SM
4503 if (!force_raw_text
4504 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4505 /* Confirm that VAL can surely encode the current region. */
905a4276
PJ
4506 val = call5 (Vselect_safe_coding_system_function,
4507 start, end, val, Qnil, filename);
7c82a4a9 4508
db327c7e
KH
4509 /* If the decided coding-system doesn't specify end-of-line
4510 format, we use that of
4511 `default-buffer-file-coding-system'. */
c934586d 4512 if (! using_default_coding
4b4deea2 4513 && ! NILP (BVAR (&buffer_defaults, buffer_file_coding_system)))
db327c7e 4514 val = (coding_inherit_eol_type
4b4deea2 4515 (val, BVAR (&buffer_defaults, buffer_file_coding_system)));
7c82a4a9 4516
db327c7e
KH
4517 /* If we decide not to encode text, use `raw-text' or one of its
4518 subsidiaries. */
7c82a4a9 4519 if (force_raw_text)
db327c7e 4520 val = raw_text_coding_system (val);
7c82a4a9
SM
4521 }
4522
75421805 4523 val = coding_inherit_eol_type (val, eol_parent);
c934586d 4524 setup_coding_system (val, coding);
7c82a4a9 4525
4b4deea2 4526 if (!STRINGP (start) && !NILP (BVAR (current_buffer, selective_display)))
7c82a4a9 4527 coding->mode |= CODING_MODE_SELECTIVE_DISPLAY;
c934586d 4528 return val;
7c82a4a9
SM
4529}
4530
a7ca3326 4531DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7,
8c1a1077
PJ
4532 "r\nFWrite region to file: \ni\ni\ni\np",
4533 doc: /* Write current region into specified file.
c2efea25
RS
4534When called from a program, requires three arguments:
4535START, END and FILENAME. START and END are normally buffer positions
4536specifying the part of the buffer to write.
4537If START is nil, that means to use the entire buffer contents.
4538If START is a string, then output that string to the file
4539instead of any buffer contents; END is ignored.
4540
8c1a1077
PJ
4541Optional fourth argument APPEND if non-nil means
4542 append to existing file contents (if any). If it is an integer,
4543 seek to that offset in the file before writing.
36e50520 4544Optional fifth argument VISIT, if t or a string, means
8c1a1077
PJ
4545 set the last-save-file-modtime of buffer to this file's modtime
4546 and mark buffer not modified.
4547If VISIT is a string, it is a second file name;
4548 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4549 VISIT is also the file name to lock and unlock for clash detection.
4550If VISIT is neither t nor nil nor a string,
5f4e6aa9 4551 that means do not display the \"Wrote file\" message.
8c1a1077
PJ
4552The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4553 use for locking and unlocking, overriding FILENAME and VISIT.
4554The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4555 for an existing file with the same name. If MUSTBENEW is `excl',
4556 that means to get an error if the file already exists; never overwrite.
4557 If MUSTBENEW is neither nil nor `excl', that means ask for
4558 confirmation before overwriting, but do go ahead and overwrite the file
4559 if the user confirms.
8c1a1077
PJ
4560
4561This does code conversion according to the value of
4562`coding-system-for-write', `buffer-file-coding-system', or
4563`file-coding-system-alist', and sets the variable
aacd8ba1
GM
4564`last-coding-system-used' to the coding system actually used.
4565
4566This calls `write-region-annotate-functions' at the start, and
4567`write-region-post-annotation-function' at the end. */)
5842a27b 4568 (Lisp_Object start, Lisp_Object end, Lisp_Object filename, Lisp_Object append, Lisp_Object visit, Lisp_Object lockname, Lisp_Object mustbenew)
570d7624 4569{
f75d7a91
PE
4570 int desc;
4571 bool ok;
6bbd7a29 4572 int save_errno = 0;
5976c3fe 4573 const char *fn;
570d7624 4574 struct stat st;
d6453ce4 4575 EMACS_TIME modtime;
d311d28c 4576 ptrdiff_t count = SPECPDL_INDEX ();
6fc6f94b 4577 int count1;
3eac9910 4578 Lisp_Object handler;
4ad827c5 4579 Lisp_Object visit_file;
65b7d3e7 4580 Lisp_Object annotations;
b1d1b865 4581 Lisp_Object encoded_filename;
f75d7a91
PE
4582 bool visiting = (EQ (visit, Qt) || STRINGP (visit));
4583 bool quietly = !NILP (visit);
7204a979 4584 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
6fc6f94b 4585 struct buffer *given_buffer;
6fdaa9a0 4586 struct coding_system coding;
570d7624 4587
d3a67486 4588 if (current_buffer->base_buffer && visiting)
95385625
RS
4589 error ("Cannot do file visiting in an indirect buffer");
4590
561cb8e1 4591 if (!NILP (start) && !STRINGP (start))
570d7624
JB
4592 validate_region (&start, &end);
4593
95c1c901 4594 visit_file = Qnil;
59fac292 4595 GCPRO5 (start, filename, visit, visit_file, lockname);
b56567b5 4596
570d7624 4597 filename = Fexpand_file_name (filename, Qnil);
de1d0127 4598
236a12f2 4599 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
b8b29dc9 4600 barf_or_query_if_file_exists (filename, "overwrite", 1, 0, 1);
de1d0127 4601
561cb8e1 4602 if (STRINGP (visit))
e5176bae 4603 visit_file = Fexpand_file_name (visit, Qnil);
4ad827c5
RS
4604 else
4605 visit_file = filename;
4606
7204a979
RS
4607 if (NILP (lockname))
4608 lockname = visit_file;
4609
65b7d3e7
RS
4610 annotations = Qnil;
4611
32f4334d
RS
4612 /* If the file name has special constructs in it,
4613 call the corresponding file handler. */
49307295 4614 handler = Ffind_file_name_handler (filename, Qwrite_region);
b56ad927 4615 /* If FILENAME has no handler, see if VISIT has one. */
93c30b5f 4616 if (NILP (handler) && STRINGP (visit))
199607e4 4617 handler = Ffind_file_name_handler (visit, Qwrite_region);
3eac9910 4618
32f4334d
RS
4619 if (!NILP (handler))
4620 {
32f4334d 4621 Lisp_Object val;
51cf6d37
RS
4622 val = call6 (handler, Qwrite_region, start, end,
4623 filename, append, visit);
32f4334d 4624
d6a3cc15 4625 if (visiting)
32f4334d 4626 {
95385625 4627 SAVE_MODIFF = MODIFF;
4b4deea2 4628 XSETFASTINT (BVAR (current_buffer, save_length), Z - BEG);
39eb03f1 4629 bset_filename (current_buffer, visit_file);
32f4334d 4630 }
09121adc 4631 UNGCPRO;
32f4334d
RS
4632 return val;
4633 }
4634
4a38de71
KH
4635 record_unwind_protect (save_restriction_restore, save_restriction_save ());
4636
561cb8e1
RS
4637 /* Special kludge to simplify auto-saving. */
4638 if (NILP (start))
4639 {
6b3d752c
SM
4640 /* Do it later, so write-region-annotate-function can work differently
4641 if we save "the buffer" vs "a region".
4642 This is useful in tar-mode. --Stef
2acfd7ae 4643 XSETFASTINT (start, BEG);
6b3d752c 4644 XSETFASTINT (end, Z); */
4a38de71 4645 Fwiden ();
561cb8e1
RS
4646 }
4647
67fbc0cb
CY
4648 record_unwind_protect (build_annotations_unwind,
4649 Vwrite_region_annotation_buffers);
4650 Vwrite_region_annotation_buffers = Fcons (Fcurrent_buffer (), Qnil);
aed13378 4651 count1 = SPECPDL_INDEX ();
6fc6f94b
RS
4652
4653 given_buffer = current_buffer;
bf3428a1
RS
4654
4655 if (!STRINGP (start))
236a12f2 4656 {
bf3428a1
RS
4657 annotations = build_annotations (start, end);
4658
4659 if (current_buffer != given_buffer)
4660 {
4661 XSETFASTINT (start, BEGV);
4662 XSETFASTINT (end, ZV);
4663 }
236a12f2
SM
4664 }
4665
6b3d752c
SM
4666 if (NILP (start))
4667 {
4668 XSETFASTINT (start, BEGV);
4669 XSETFASTINT (end, ZV);
4670 }
4671
236a12f2
SM
4672 UNGCPRO;
4673
4674 GCPRO5 (start, filename, annotations, visit_file, lockname);
4675
59fac292
SM
4676 /* Decide the coding-system to encode the data with.
4677 We used to make this choice before calling build_annotations, but that
4678 leads to problems when a write-annotate-function takes care of
4679 unsavable chars (as was the case with X-Symbol). */
c934586d
KH
4680 Vlast_coding_system_used
4681 = choose_write_coding_system (start, end, filename,
4682 append, visit, lockname, &coding);
d6a3cc15 4683
570d7624
JB
4684#ifdef CLASH_DETECTION
4685 if (!auto_saving)
67fbc0cb 4686 lock_file (lockname);
570d7624
JB
4687#endif /* CLASH_DETECTION */
4688
b1d1b865
RS
4689 encoded_filename = ENCODE_FILE (filename);
4690
5976c3fe 4691 fn = SSDATA (encoded_filename);
570d7624 4692 desc = -1;
265a9e55 4693 if (!NILP (append))
5e570b75 4694#ifdef DOS_NT
05c65251 4695 desc = emacs_open (fn, O_WRONLY | O_BINARY, 0);
5e570b75 4696#else /* not DOS_NT */
68c45bf0 4697 desc = emacs_open (fn, O_WRONLY, 0);
5e570b75 4698#endif /* not DOS_NT */
570d7624 4699
b1d1b865 4700 if (desc < 0 && (NILP (append) || errno == ENOENT))
5e570b75 4701#ifdef DOS_NT
68c45bf0 4702 desc = emacs_open (fn,
05c65251 4703 O_WRONLY | O_CREAT | O_BINARY
95522746 4704 | (EQ (mustbenew, Qexcl) ? O_EXCL : O_TRUNC),
68c45bf0 4705 S_IREAD | S_IWRITE);
5e570b75 4706#else /* not DOS_NT */
68c45bf0 4707 desc = emacs_open (fn, O_WRONLY | O_TRUNC | O_CREAT
7c752c80 4708 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
68c45bf0 4709 auto_saving ? auto_save_mode_bits : 0666);
5e570b75 4710#endif /* not DOS_NT */
570d7624
JB
4711
4712 if (desc < 0)
4713 {
4714#ifdef CLASH_DETECTION
4715 save_errno = errno;
7204a979 4716 if (!auto_saving) unlock_file (lockname);
570d7624
JB
4717 errno = save_errno;
4718#endif /* CLASH_DETECTION */
43fb7d9a 4719 UNGCPRO;
570d7624
JB
4720 report_file_error ("Opening output file", Fcons (filename, Qnil));
4721 }
4722
4723 record_unwind_protect (close_file_unwind, make_number (desc));
4724
c1c4693e 4725 if (!NILP (append) && !NILP (Ffile_regular_p (filename)))
43fb7d9a 4726 {
728f8f0a 4727 off_t ret;
efdc16c9 4728
43fb7d9a 4729 if (NUMBERP (append))
e69dafad 4730 ret = emacs_lseek (desc, XINT (append), SEEK_CUR);
43fb7d9a 4731 else
e69dafad 4732 ret = lseek (desc, 0, SEEK_END);
43fb7d9a
DL
4733 if (ret < 0)
4734 {
570d7624 4735#ifdef CLASH_DETECTION
e5e9d610 4736 save_errno = errno;
43fb7d9a 4737 if (!auto_saving) unlock_file (lockname);
e5e9d610 4738 errno = save_errno;
570d7624 4739#endif /* CLASH_DETECTION */
43fb7d9a
DL
4740 UNGCPRO;
4741 report_file_error ("Lseek error", Fcons (filename, Qnil));
4742 }
4743 }
efdc16c9 4744
43fb7d9a 4745 UNGCPRO;
570d7624 4746
570d7624
JB
4747 immediate_quit = 1;
4748
561cb8e1 4749 if (STRINGP (start))
f75d7a91 4750 ok = a_write (desc, start, 0, SCHARS (start), &annotations, &coding);
570d7624 4751 else if (XINT (start) != XINT (end))
f75d7a91
PE
4752 ok = a_write (desc, Qnil, XINT (start), XINT (end) - XINT (start),
4753 &annotations, &coding);
69f6e679
RS
4754 else
4755 {
f75d7a91 4756 /* If file was empty, still need to write the annotations. */
c8a6d68a 4757 coding.mode |= CODING_MODE_LAST_BLOCK;
f75d7a91 4758 ok = a_write (desc, Qnil, XINT (end), 0, &annotations, &coding);
6fdaa9a0 4759 }
f75d7a91 4760 save_errno = errno;
6fdaa9a0 4761
f75d7a91
PE
4762 if (ok && CODING_REQUIRE_FLUSHING (&coding)
4763 && !(coding.mode & CODING_MODE_LAST_BLOCK))
6fdaa9a0
KH
4764 {
4765 /* We have to flush out a data. */
c8a6d68a 4766 coding.mode |= CODING_MODE_LAST_BLOCK;
f75d7a91 4767 ok = e_write (desc, Qnil, 1, 1, &coding);
69f6e679 4768 save_errno = errno;
570d7624
JB
4769 }
4770
4771 immediate_quit = 0;
4772
6e23c83e 4773#ifdef HAVE_FSYNC
570d7624
JB
4774 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
4775 Disk full in NFS may be reported here. */
1daffa1c
RS
4776 /* mib says that closing the file will try to write as fast as NFS can do
4777 it, and that means the fsync here is not crucial for autosave files. */
ccf61795 4778 if (!auto_saving && !write_region_inhibit_fsync && fsync (desc) < 0)
cb33c142 4779 {
6cff77fd
AS
4780 /* If fsync fails with EINTR, don't treat that as serious. Also
4781 ignore EINVAL which happens when fsync is not supported on this
4782 file. */
4783 if (errno != EINTR && errno != EINVAL)
f75d7a91 4784 ok = 0, save_errno = errno;
cb33c142 4785 }
570d7624
JB
4786#endif
4787
d6453ce4
PE
4788 modtime = invalid_emacs_time ();
4789 if (visiting)
4790 {
4791 if (fstat (desc, &st) == 0)
4792 modtime = get_stat_mtime (&st);
4793 else
4794 ok = 0, save_errno = errno;
4795 }
4796
570d7624 4797 /* NFS can report a write failure now. */
68c45bf0 4798 if (emacs_close (desc) < 0)
f75d7a91 4799 ok = 0, save_errno = errno;
570d7624 4800
6fc6f94b
RS
4801 /* Discard the unwind protect for close_file_unwind. */
4802 specpdl_ptr = specpdl + count1;
67fbc0cb
CY
4803
4804 /* Call write-region-post-annotation-function. */
294fa707 4805 while (CONSP (Vwrite_region_annotation_buffers))
67fbc0cb
CY
4806 {
4807 Lisp_Object buf = XCAR (Vwrite_region_annotation_buffers);
4808 if (!NILP (Fbuffer_live_p (buf)))
4809 {
4810 Fset_buffer (buf);
4811 if (FUNCTIONP (Vwrite_region_post_annotation_function))
4812 call0 (Vwrite_region_post_annotation_function);
4813 }
4814 Vwrite_region_annotation_buffers
4815 = XCDR (Vwrite_region_annotation_buffers);
4816 }
4817
4818 unbind_to (count, Qnil);
570d7624
JB
4819
4820#ifdef CLASH_DETECTION
4821 if (!auto_saving)
7204a979 4822 unlock_file (lockname);
570d7624
JB
4823#endif /* CLASH_DETECTION */
4824
4825 /* Do this before reporting IO error
4826 to avoid a "file has changed on disk" warning on
4827 next attempt to save. */
d6453ce4 4828 if (EMACS_TIME_VALID_P (modtime))
58b963f7 4829 {
d6453ce4 4830 current_buffer->modtime = modtime;
58b963f7
SM
4831 current_buffer->modtime_size = st.st_size;
4832 }
570d7624 4833
f75d7a91 4834 if (! ok)
d5db4077 4835 error ("IO error writing %s: %s", SDATA (filename),
68c45bf0 4836 emacs_strerror (save_errno));
570d7624 4837
d6a3cc15 4838 if (visiting)
570d7624 4839 {
95385625 4840 SAVE_MODIFF = MODIFF;
4b4deea2 4841 XSETFASTINT (BVAR (current_buffer, save_length), Z - BEG);
39eb03f1 4842 bset_filename (current_buffer, visit_file);
f4226e89 4843 update_mode_lines++;
570d7624 4844 }
d6a3cc15 4845 else if (quietly)
6b61353c
KH
4846 {
4847 if (auto_saving
4b4deea2
TT
4848 && ! NILP (Fstring_equal (BVAR (current_buffer, filename),
4849 BVAR (current_buffer, auto_save_file_name))))
6b61353c
KH
4850 SAVE_MODIFF = MODIFF;
4851
4852 return Qnil;
4853 }
570d7624
JB
4854
4855 if (!auto_saving)
6b61353c 4856 message_with_string ((INTEGERP (append)
0c328a0e
RS
4857 ? "Updated %s"
4858 : ! NILP (append)
4859 ? "Added to %s"
4860 : "Wrote %s"),
4861 visit_file, 1);
570d7624
JB
4862
4863 return Qnil;
4864}
ec7adf26 4865\f
dd4c5104 4866Lisp_Object merge (Lisp_Object, Lisp_Object, Lisp_Object);
d6a3cc15
RS
4867
4868DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
8c1a1077 4869 doc: /* Return t if (car A) is numerically less than (car B). */)
5842a27b 4870 (Lisp_Object a, Lisp_Object b)
d6a3cc15
RS
4871{
4872 return Flss (Fcar (a), Fcar (b));
4873}
4874
4875/* Build the complete list of annotations appropriate for writing out
4876 the text between START and END, by calling all the functions in
6fc6f94b
RS
4877 write-region-annotate-functions and merging the lists they return.
4878 If one of these functions switches to a different buffer, we assume
4879 that buffer contains altered text. Therefore, the caller must
4880 make sure to restore the current buffer in all cases,
4881 as save-excursion would do. */
d6a3cc15
RS
4882
4883static Lisp_Object
971de7fb 4884build_annotations (Lisp_Object start, Lisp_Object end)
d6a3cc15
RS
4885{
4886 Lisp_Object annotations;
4887 Lisp_Object p, res;
4888 struct gcpro gcpro1, gcpro2;
0a20b684 4889 Lisp_Object original_buffer;
f75d7a91
PE
4890 int i;
4891 bool used_global = 0;
0a20b684
RS
4892
4893 XSETBUFFER (original_buffer, current_buffer);
d6a3cc15
RS
4894
4895 annotations = Qnil;
4896 p = Vwrite_region_annotate_functions;
4897 GCPRO2 (annotations, p);
28c3eb5a 4898 while (CONSP (p))
d6a3cc15 4899 {
6fc6f94b 4900 struct buffer *given_buffer = current_buffer;
bd235610
SM
4901 if (EQ (Qt, XCAR (p)) && !used_global)
4902 { /* Use the global value of the hook. */
4903 Lisp_Object arg[2];
4904 used_global = 1;
4905 arg[0] = Fdefault_value (Qwrite_region_annotate_functions);
4906 arg[1] = XCDR (p);
4907 p = Fappend (2, arg);
4908 continue;
4909 }
6fc6f94b 4910 Vwrite_region_annotations_so_far = annotations;
28c3eb5a 4911 res = call2 (XCAR (p), start, end);
6fc6f94b
RS
4912 /* If the function makes a different buffer current,
4913 assume that means this buffer contains altered text to be output.
4914 Reset START and END from the buffer bounds
4915 and discard all previous annotations because they should have
4916 been dealt with by this function. */
4917 if (current_buffer != given_buffer)
4918 {
67fbc0cb
CY
4919 Vwrite_region_annotation_buffers
4920 = Fcons (Fcurrent_buffer (),
4921 Vwrite_region_annotation_buffers);
3cf29f61
RS
4922 XSETFASTINT (start, BEGV);
4923 XSETFASTINT (end, ZV);
6fc6f94b
RS
4924 annotations = Qnil;
4925 }
d6a3cc15
RS
4926 Flength (res); /* Check basic validity of return value */
4927 annotations = merge (annotations, res, Qcar_less_than_car);
28c3eb5a 4928 p = XCDR (p);
d6a3cc15 4929 }
0d420e88
BG
4930
4931 /* Now do the same for annotation functions implied by the file-format */
4b4deea2
TT
4932 if (auto_saving && (!EQ (BVAR (current_buffer, auto_save_file_format), Qt)))
4933 p = BVAR (current_buffer, auto_save_file_format);
0d420e88 4934 else
4b4deea2 4935 p = BVAR (current_buffer, file_format);
28c3eb5a 4936 for (i = 0; CONSP (p); p = XCDR (p), ++i)
0d420e88
BG
4937 {
4938 struct buffer *given_buffer = current_buffer;
efdc16c9 4939
0d420e88 4940 Vwrite_region_annotations_so_far = annotations;
532ed661
GM
4941
4942 /* Value is either a list of annotations or nil if the function
4943 has written annotations to a temporary buffer, which is now
4944 current. */
28c3eb5a 4945 res = call5 (Qformat_annotate_function, XCAR (p), start, end,
532ed661 4946 original_buffer, make_number (i));
0d420e88
BG
4947 if (current_buffer != given_buffer)
4948 {
3cf29f61
RS
4949 XSETFASTINT (start, BEGV);
4950 XSETFASTINT (end, ZV);
0d420e88
BG
4951 annotations = Qnil;
4952 }
efdc16c9 4953
532ed661
GM
4954 if (CONSP (res))
4955 annotations = merge (annotations, res, Qcar_less_than_car);
0d420e88 4956 }
6fdaa9a0 4957
236a12f2
SM
4958 UNGCPRO;
4959 return annotations;
4960}
4961
ec7adf26 4962\f
ce51c54c
KH
4963/* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
4964 If STRING is nil, POS is the character position in the current buffer.
d6a3cc15 4965 Intersperse with them the annotations from *ANNOT
ce51c54c 4966 which fall within the range of POS to POS + NCHARS,
d6a3cc15
RS
4967 each at its appropriate position.
4968
ec7adf26
RS
4969 We modify *ANNOT by discarding elements as we use them up.
4970
f75d7a91 4971 Return true if successful. */
d6a3cc15 4972
f75d7a91 4973static bool
d311d28c 4974a_write (int desc, Lisp_Object string, ptrdiff_t pos,
f75d7a91 4975 ptrdiff_t nchars, Lisp_Object *annot,
8a2cbd72 4976 struct coding_system *coding)
d6a3cc15
RS
4977{
4978 Lisp_Object tem;
d311d28c
PE
4979 ptrdiff_t nextpos;
4980 ptrdiff_t lastpos = pos + nchars;
d6a3cc15 4981
eb15aa18 4982 while (NILP (*annot) || CONSP (*annot))
d6a3cc15
RS
4983 {
4984 tem = Fcar_safe (Fcar (*annot));
ce51c54c 4985 nextpos = pos - 1;
ec7adf26 4986 if (INTEGERP (tem))
ce51c54c 4987 nextpos = XFASTINT (tem);
ec7adf26
RS
4988
4989 /* If there are no more annotations in this range,
4990 output the rest of the range all at once. */
ce51c54c
KH
4991 if (! (nextpos >= pos && nextpos <= lastpos))
4992 return e_write (desc, string, pos, lastpos, coding);
ec7adf26
RS
4993
4994 /* Output buffer text up to the next annotation's position. */
ce51c54c 4995 if (nextpos > pos)
d6a3cc15 4996 {
f75d7a91
PE
4997 if (!e_write (desc, string, pos, nextpos, coding))
4998 return 0;
ce51c54c 4999 pos = nextpos;
d6a3cc15 5000 }
ec7adf26 5001 /* Output the annotation. */
d6a3cc15
RS
5002 tem = Fcdr (Fcar (*annot));
5003 if (STRINGP (tem))
5004 {
f75d7a91
PE
5005 if (!e_write (desc, tem, 0, SCHARS (tem), coding))
5006 return 0;
d6a3cc15
RS
5007 }
5008 *annot = Fcdr (*annot);
5009 }
f75d7a91 5010 return 1;
d6a3cc15
RS
5011}
5012
6fdaa9a0 5013
ce51c54c
KH
5014/* Write text in the range START and END into descriptor DESC,
5015 encoding them with coding system CODING. If STRING is nil, START
5016 and END are character positions of the current buffer, else they
f75d7a91 5017 are indexes to the string STRING. Return true if successful. */
ec7adf26 5018
f75d7a91 5019static bool
d311d28c 5020e_write (int desc, Lisp_Object string, ptrdiff_t start, ptrdiff_t end,
8a2cbd72 5021 struct coding_system *coding)
570d7624 5022{
ce51c54c
KH
5023 if (STRINGP (string))
5024 {
db327c7e 5025 start = 0;
8f924df7 5026 end = SCHARS (string);
ce51c54c 5027 }
570d7624 5028
6fdaa9a0
KH
5029 /* We used to have a code for handling selective display here. But,
5030 now it is handled within encode_coding. */
01ca97a2
KH
5031
5032 while (start < end)
570d7624 5033 {
01ca97a2 5034 if (STRINGP (string))
6ad568dd 5035 {
01ca97a2
KH
5036 coding->src_multibyte = SCHARS (string) < SBYTES (string);
5037 if (CODING_REQUIRE_ENCODING (coding))
5038 {
5039 encode_coding_object (coding, string,
5040 start, string_char_to_byte (string, start),
5041 end, string_char_to_byte (string, end), Qt);
5042 }
5043 else
5044 {
5045 coding->dst_object = string;
5046 coding->consumed_char = SCHARS (string);
5047 coding->produced = SBYTES (string);
5048 }
6ad568dd 5049 }
db327c7e 5050 else
6ad568dd 5051 {
d311d28c
PE
5052 ptrdiff_t start_byte = CHAR_TO_BYTE (start);
5053 ptrdiff_t end_byte = CHAR_TO_BYTE (end);
b4132433 5054
01ca97a2
KH
5055 coding->src_multibyte = (end - start) < (end_byte - start_byte);
5056 if (CODING_REQUIRE_ENCODING (coding))
5057 {
5058 encode_coding_object (coding, Fcurrent_buffer (),
5059 start, start_byte, end, end_byte, Qt);
5060 }
5061 else
5062 {
5063 coding->dst_object = Qnil;
5064 coding->dst_pos_byte = start_byte;
5065 if (start >= GPT || end <= GPT)
5066 {
5067 coding->consumed_char = end - start;
5068 coding->produced = end_byte - start_byte;
5069 }
5070 else
5071 {
5072 coding->consumed_char = GPT - start;
5073 coding->produced = GPT_BYTE - start_byte;
5074 }
5075 }
c185d744 5076 }
01ca97a2
KH
5077
5078 if (coding->produced > 0)
c185d744 5079 {
ce2fe65a
AS
5080 coding->produced
5081 -= emacs_write (desc,
5082 STRINGP (coding->dst_object)
5083 ? SSDATA (coding->dst_object)
5084 : (char *) BYTE_POS_ADDR (coding->dst_pos_byte),
5085 coding->produced);
01ca97a2
KH
5086
5087 if (coding->produced)
f75d7a91 5088 return 0;
570d7624 5089 }
01ca97a2 5090 start += coding->consumed_char;
c185d744
KH
5091 }
5092
f75d7a91 5093 return 1;
570d7624 5094}
ec7adf26 5095\f
a7ca3326 5096DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
ec1b9b17 5097 Sverify_visited_file_modtime, 0, 1, 0,
8c1a1077 5098 doc: /* Return t if last mod time of BUF's visited file matches what BUF records.
6b61353c 5099This means that the file has not been changed since it was visited or saved.
ec1b9b17 5100If BUF is omitted or nil, it defaults to the current buffer.
6b61353c 5101See Info node `(elisp)Modification Time' for more details. */)
5842a27b 5102 (Lisp_Object buf)
570d7624
JB
5103{
5104 struct buffer *b;
5105 struct stat st;
32f4334d 5106 Lisp_Object handler;
b1d1b865 5107 Lisp_Object filename;
b95a9c0c 5108 EMACS_TIME mtime;
570d7624 5109
ec1b9b17
GM
5110 if (NILP (buf))
5111 b = current_buffer;
5112 else
5113 {
5114 CHECK_BUFFER (buf);
5115 b = XBUFFER (buf);
5116 }
570d7624 5117
4b4deea2 5118 if (!STRINGP (BVAR (b, filename))) return Qt;
d35af63c 5119 if (EMACS_NSECS (b->modtime) == UNKNOWN_MODTIME_NSECS) return Qt;
570d7624 5120
32f4334d
RS
5121 /* If the file name has special constructs in it,
5122 call the corresponding file handler. */
4b4deea2 5123 handler = Ffind_file_name_handler (BVAR (b, filename),
49307295 5124 Qverify_visited_file_modtime);
32f4334d 5125 if (!NILP (handler))
09121adc 5126 return call2 (handler, Qverify_visited_file_modtime, buf);
32f4334d 5127
4b4deea2 5128 filename = ENCODE_FILE (BVAR (b, filename));
b1d1b865 5129
dbeed9a6
PE
5130 mtime = (stat (SSDATA (filename), &st) == 0
5131 ? get_stat_mtime (&st)
f0941253 5132 : time_error_value (errno));
b95a9c0c 5133 if (EMACS_TIME_EQ (mtime, b->modtime)
645c6a30
PE
5134 && (b->modtime_size < 0
5135 || st.st_size == b->modtime_size))
570d7624
JB
5136 return Qt;
5137 return Qnil;
5138}
5139
5140DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
8c1a1077
PJ
5141 Sclear_visited_file_modtime, 0, 0, 0,
5142 doc: /* Clear out records of last mod time of visited file.
5143Next attempt to save will certainly not complain of a discrepancy. */)
5842a27b 5144 (void)
570d7624 5145{
e9a9ae03 5146 current_buffer->modtime = make_emacs_time (0, UNKNOWN_MODTIME_NSECS);
58b963f7 5147 current_buffer->modtime_size = -1;
570d7624
JB
5148 return Qnil;
5149}
5150
f5d5eccf 5151DEFUN ("visited-file-modtime", Fvisited_file_modtime,
8c1a1077
PJ
5152 Svisited_file_modtime, 0, 0, 0,
5153 doc: /* Return the current buffer's recorded visited file modification time.
d35af63c 5154The value is a list of the form (HIGH LOW USEC PSEC), like the time values that
1c4d7f3d
LMI
5155`file-attributes' returns. If the current buffer has no recorded file
5156modification time, this function returns 0. If the visited file
9d1d6e68 5157doesn't exist, HIGH will be -1.
6b61353c 5158See Info node `(elisp)Modification Time' for more details. */)
5842a27b 5159 (void)
f5d5eccf 5160{
d35af63c 5161 if (EMACS_NSECS (current_buffer->modtime) < 0)
184246df
PE
5162 {
5163 if (EMACS_NSECS (current_buffer->modtime) == NONEXISTENT_MODTIME_NSECS)
5164 {
5165 /* make_lisp_time won't work here if time_t is unsigned. */
5166 return list4 (make_number (-1), make_number (65535),
5167 make_number (0), make_number (0));
5168 }
5169 return make_number (0);
5170 }
d35af63c 5171 return make_lisp_time (current_buffer->modtime);
f5d5eccf
RS
5172}
5173
570d7624 5174DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
8c1a1077
PJ
5175 Sset_visited_file_modtime, 0, 1, 0,
5176 doc: /* Update buffer's recorded modification time from the visited file's time.
5177Useful if the buffer was not read from the file normally
5178or if the file itself has been changed for some known benign reason.
5179An argument specifies the modification time value to use
5180\(instead of that of the visited file), in the form of a list
d35af63c 5181\(HIGH LOW USEC PSEC) as returned by `current-time'. */)
5842a27b 5182 (Lisp_Object time_list)
570d7624 5183{
f5d5eccf 5184 if (!NILP (time_list))
58b963f7 5185 {
31571fd7 5186 current_buffer->modtime = lisp_time_argument (time_list);
58b963f7
SM
5187 current_buffer->modtime_size = -1;
5188 }
f5d5eccf
RS
5189 else
5190 {
5191 register Lisp_Object filename;
5192 struct stat st;
5193 Lisp_Object handler;
570d7624 5194
4b4deea2 5195 filename = Fexpand_file_name (BVAR (current_buffer, filename), Qnil);
32f4334d 5196
f5d5eccf
RS
5197 /* If the file name has special constructs in it,
5198 call the corresponding file handler. */
49307295 5199 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
f5d5eccf 5200 if (!NILP (handler))
caf3c431 5201 /* The handler can find the file name the same way we did. */
76c881b0 5202 return call2 (handler, Qset_visited_file_modtime, Qnil);
b1d1b865
RS
5203
5204 filename = ENCODE_FILE (filename);
5205
42a5b22f 5206 if (stat (SSDATA (filename), &st) >= 0)
58b963f7 5207 {
d35af63c 5208 current_buffer->modtime = get_stat_mtime (&st);
58b963f7
SM
5209 current_buffer->modtime_size = st.st_size;
5210 }
f5d5eccf 5211 }
570d7624
JB
5212
5213 return Qnil;
5214}
5215\f
f14b7e14 5216static Lisp_Object
f839df0c 5217auto_save_error (Lisp_Object error_val)
570d7624 5218{
d7f31e22
GM
5219 Lisp_Object args[3], msg;
5220 int i, nbytes;
5221 struct gcpro gcpro1;
dfc22242
KS
5222 char *msgbuf;
5223 USE_SAFE_ALLOCA;
efdc16c9 5224
ca730bf0
CY
5225 auto_save_error_occurred = 1;
5226
385ed61f 5227 ring_bell (XFRAME (selected_frame));
efdc16c9 5228
d7f31e22 5229 args[0] = build_string ("Auto-saving %s: %s");
4b4deea2 5230 args[1] = BVAR (current_buffer, name);
f839df0c 5231 args[2] = Ferror_message_string (error_val);
d7f31e22
GM
5232 msg = Fformat (3, args);
5233 GCPRO1 (msg);
d5db4077 5234 nbytes = SBYTES (msg);
98c6f1e3 5235 msgbuf = SAFE_ALLOCA (nbytes);
72af86bd 5236 memcpy (msgbuf, SDATA (msg), nbytes);
d7f31e22
GM
5237
5238 for (i = 0; i < 3; ++i)
5239 {
5240 if (i == 0)
dfc22242 5241 message2 (msgbuf, nbytes, STRING_MULTIBYTE (msg));
d7f31e22 5242 else
dfc22242 5243 message2_nolog (msgbuf, nbytes, STRING_MULTIBYTE (msg));
d7f31e22
GM
5244 Fsleep_for (make_number (1), Qnil);
5245 }
5246
e01f7773 5247 SAFE_FREE ();
d7f31e22 5248 UNGCPRO;
570d7624
JB
5249 return Qnil;
5250}
5251
f14b7e14 5252static Lisp_Object
971de7fb 5253auto_save_1 (void)
570d7624 5254{
570d7624 5255 struct stat st;
d4a42098
KS
5256 Lisp_Object modes;
5257
5258 auto_save_mode_bits = 0666;
570d7624
JB
5259
5260 /* Get visited file's mode to become the auto save file's mode. */
4b4deea2 5261 if (! NILP (BVAR (current_buffer, filename)))
d4a42098 5262 {
4b4deea2 5263 if (stat (SSDATA (BVAR (current_buffer, filename)), &st) >= 0)
d4a42098 5264 /* But make sure we can overwrite it later! */
18c52557 5265 auto_save_mode_bits = (st.st_mode | 0600) & 0777;
ce2fe65a
AS
5266 else if (modes = Ffile_modes (BVAR (current_buffer, filename)),
5267 INTEGERP (modes))
d4a42098 5268 /* Remote files don't cooperate with stat. */
18c52557 5269 auto_save_mode_bits = (XINT (modes) | 0600) & 0777;
d4a42098 5270 }
570d7624
JB
5271
5272 return
4b4deea2 5273 Fwrite_region (Qnil, Qnil, BVAR (current_buffer, auto_save_file_name), Qnil,
699b53bc
CY
5274 NILP (Vauto_save_visited_file_name) ? Qlambda : Qt,
5275 Qnil, Qnil);
570d7624
JB
5276}
5277
e54d3b5d 5278static Lisp_Object
971de7fb 5279do_auto_save_unwind (Lisp_Object arg) /* used as unwind-protect function */
410ed5c3 5280
e54d3b5d 5281{
fff7e982 5282 FILE *stream = (FILE *) XSAVE_VALUE (arg)->pointer;
3be3c08e 5283 auto_saving = 0;
fff7e982 5284 if (stream != NULL)
aab12958 5285 {
4d7e6e51 5286 block_input ();
aab12958 5287 fclose (stream);
4d7e6e51 5288 unblock_input ();
aab12958 5289 }
e54d3b5d
RS
5290 return Qnil;
5291}
5292
a8c828be 5293static Lisp_Object
971de7fb 5294do_auto_save_unwind_1 (Lisp_Object value) /* used as unwind-protect function */
410ed5c3 5295
a8c828be
RS
5296{
5297 minibuffer_auto_raise = XINT (value);
5298 return Qnil;
5299}
5300
5794dd61 5301static Lisp_Object
971de7fb 5302do_auto_save_make_dir (Lisp_Object dir)
5794dd61 5303{
09450bae 5304 Lisp_Object result;
26816cbf 5305
09450bae
PE
5306 auto_saving_dir_umask = 077;
5307 result = call2 (Qmake_directory, dir, Qt);
5308 auto_saving_dir_umask = 0;
5309 return result;
5794dd61
RS
5310}
5311
5312static Lisp_Object
971de7fb 5313do_auto_save_eh (Lisp_Object ignore)
5794dd61 5314{
09450bae 5315 auto_saving_dir_umask = 0;
5794dd61
RS
5316 return Qnil;
5317}
5318
a7ca3326 5319DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
8c1a1077
PJ
5320 doc: /* Auto-save all buffers that need it.
5321This is all buffers that have auto-saving enabled
5322and are changed since last auto-saved.
5323Auto-saving writes the buffer into a file
5324so that your editing is not lost if the system crashes.
5325This file is not the file you visited; that changes only when you save.
5326Normally we run the normal hook `auto-save-hook' before saving.
5327
5328A non-nil NO-MESSAGE argument means do not print any message if successful.
5329A non-nil CURRENT-ONLY argument means save only current buffer. */)
5842a27b 5330 (Lisp_Object no_message, Lisp_Object current_only)
570d7624
JB
5331{
5332 struct buffer *old = current_buffer, *b;
dee091a3 5333 Lisp_Object tail, buf, hook;
f75d7a91 5334 bool auto_saved = 0;
f14b1c68 5335 int do_handled_files;
ff4c9993 5336 Lisp_Object oquit;
fff7e982 5337 FILE *stream = NULL;
d311d28c 5338 ptrdiff_t count = SPECPDL_INDEX ();
f75d7a91 5339 bool orig_minibuffer_auto_raise = minibuffer_auto_raise;
fce31d69 5340 bool old_message_p = 0;
d57563b6 5341 struct gcpro gcpro1, gcpro2;
38da540d
RS
5342
5343 if (max_specpdl_size < specpdl_size + 40)
5344 max_specpdl_size = specpdl_size + 40;
5345
5346 if (minibuf_level)
5347 no_message = Qt;
5348
5794dd61
RS
5349 if (NILP (no_message))
5350 {
5351 old_message_p = push_message ();
5352 record_unwind_protect (pop_message_unwind, Qnil);
5353 }
efdc16c9 5354
ff4c9993
RS
5355 /* Ordinarily don't quit within this function,
5356 but don't make it impossible to quit (in case we get hung in I/O). */
5357 oquit = Vquit_flag;
5358 Vquit_flag = Qnil;
570d7624
JB
5359
5360 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5361 point to non-strings reached from Vbuffer_alist. */
5362
dee091a3
JD
5363 hook = intern ("auto-save-hook");
5364 Frun_hooks (1, &hook);
570d7624 5365
e54d3b5d
RS
5366 if (STRINGP (Vauto_save_list_file_name))
5367 {
0894672f 5368 Lisp_Object listfile;
efdc16c9 5369
258fd2cb 5370 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
0894672f
GM
5371
5372 /* Don't try to create the directory when shutting down Emacs,
5373 because creating the directory might signal an error, and
5374 that would leave Emacs in a strange state. */
5375 if (!NILP (Vrun_hooks))
5376 {
5377 Lisp_Object dir;
d57563b6
RS
5378 dir = Qnil;
5379 GCPRO2 (dir, listfile);
0894672f
GM
5380 dir = Ffile_name_directory (listfile);
5381 if (NILP (Ffile_directory_p (dir)))
5794dd61 5382 internal_condition_case_1 (do_auto_save_make_dir,
09450bae 5383 dir, Qt,
5794dd61 5384 do_auto_save_eh);
d57563b6 5385 UNGCPRO;
0894672f 5386 }
efdc16c9 5387
42a5b22f 5388 stream = fopen (SSDATA (listfile), "w");
1b335d29 5389 }
199607e4 5390
fff7e982
KS
5391 record_unwind_protect (do_auto_save_unwind,
5392 make_save_value (stream, 0));
a8c828be
RS
5393 record_unwind_protect (do_auto_save_unwind_1,
5394 make_number (minibuffer_auto_raise));
5395 minibuffer_auto_raise = 0;
3be3c08e 5396 auto_saving = 1;
ca730bf0 5397 auto_save_error_occurred = 0;
3be3c08e 5398
6b61353c
KH
5399 /* On first pass, save all files that don't have handlers.
5400 On second pass, save all files that do have handlers.
5401
5402 If Emacs is crashing, the handlers may tweak what is causing
5403 Emacs to crash in the first place, and it would be a shame if
5404 Emacs failed to autosave perfectly ordinary files because it
5405 couldn't handle some ange-ftp'd file. */
5406
f14b1c68 5407 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
8e50cc2d 5408 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
f14b1c68 5409 {
03699b14 5410 buf = XCDR (XCAR (tail));
f14b1c68 5411 b = XBUFFER (buf);
199607e4 5412
e54d3b5d 5413 /* Record all the buffers that have auto save mode
258fd2cb
RS
5414 in the special file that lists them. For each of these buffers,
5415 Record visited name (if any) and auto save name. */
4b4deea2 5416 if (STRINGP (BVAR (b, auto_save_file_name))
1b335d29 5417 && stream != NULL && do_handled_files == 0)
e54d3b5d 5418 {
4d7e6e51 5419 block_input ();
4b4deea2 5420 if (!NILP (BVAR (b, filename)))
258fd2cb 5421 {
4b4deea2
TT
5422 fwrite (SDATA (BVAR (b, filename)), 1,
5423 SBYTES (BVAR (b, filename)), stream);
258fd2cb 5424 }
1b335d29 5425 putc ('\n', stream);
4b4deea2
TT
5426 fwrite (SDATA (BVAR (b, auto_save_file_name)), 1,
5427 SBYTES (BVAR (b, auto_save_file_name)), stream);
1b335d29 5428 putc ('\n', stream);
4d7e6e51 5429 unblock_input ();
e54d3b5d 5430 }
17857782 5431
f14b1c68
JB
5432 if (!NILP (current_only)
5433 && b != current_buffer)
5434 continue;
e54d3b5d 5435
95385625
RS
5436 /* Don't auto-save indirect buffers.
5437 The base buffer takes care of it. */
5438 if (b->base_buffer)
5439 continue;
5440
f14b1c68
JB
5441 /* Check for auto save enabled
5442 and file changed since last auto save
5443 and file changed since last real save. */
4b4deea2 5444 if (STRINGP (BVAR (b, auto_save_file_name))
95385625 5445 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
0b5397c2 5446 && BUF_AUTOSAVE_MODIFF (b) < BUF_MODIFF (b)
82c2d839 5447 /* -1 means we've turned off autosaving for a while--see below. */
4b4deea2 5448 && XINT (BVAR (b, save_length)) >= 0
f14b1c68 5449 && (do_handled_files
4b4deea2 5450 || NILP (Ffind_file_name_handler (BVAR (b, auto_save_file_name),
49307295 5451 Qwrite_region))))
f14b1c68 5452 {
e9a9ae03
PE
5453 EMACS_TIME before_time = current_emacs_time ();
5454 EMACS_TIME after_time;
b60247d9
RS
5455
5456 /* If we had a failure, don't try again for 20 minutes. */
d311d28c 5457 if (b->auto_save_failure_time > 0
b60247d9
RS
5458 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
5459 continue;
5460
090101cf
CY
5461 set_buffer_internal (b);
5462 if (NILP (Vauto_save_include_big_deletions)
4b4deea2 5463 && (XFASTINT (BVAR (b, save_length)) * 10
4be941e3 5464 > (BUF_Z (b) - BUF_BEG (b)) * 13)
f14b1c68
JB
5465 /* A short file is likely to change a large fraction;
5466 spare the user annoying messages. */
4b4deea2 5467 && XFASTINT (BVAR (b, save_length)) > 5000
f14b1c68 5468 /* These messages are frequent and annoying for `*mail*'. */
4b4deea2 5469 && !EQ (BVAR (b, filename), Qnil)
f14b1c68
JB
5470 && NILP (no_message))
5471 {
5472 /* It has shrunk too much; turn off auto-saving here. */
a8c828be 5473 minibuffer_auto_raise = orig_minibuffer_auto_raise;
fd91d0d4 5474 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
4b4deea2 5475 BVAR (b, name), 1);
a8c828be 5476 minibuffer_auto_raise = 0;
82c2d839
RS
5477 /* Turn off auto-saving until there's a real save,
5478 and prevent any more warnings. */
4b4deea2 5479 XSETINT (BVAR (b, save_length), -1);
f14b1c68
JB
5480 Fsleep_for (make_number (1), Qnil);
5481 continue;
5482 }
f14b1c68
JB
5483 if (!auto_saved && NILP (no_message))
5484 message1 ("Auto-saving...");
5485 internal_condition_case (auto_save_1, Qt, auto_save_error);
f75d7a91 5486 auto_saved = 1;
0b5397c2 5487 BUF_AUTOSAVE_MODIFF (b) = BUF_MODIFF (b);
4b4deea2 5488 XSETFASTINT (BVAR (current_buffer, save_length), Z - BEG);
f14b1c68 5489 set_buffer_internal (old);
b60247d9 5490
e9a9ae03 5491 after_time = current_emacs_time ();
b60247d9
RS
5492
5493 /* If auto-save took more than 60 seconds,
5494 assume it was an NFS failure that got a timeout. */
5495 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
5496 b->auto_save_failure_time = EMACS_SECS (after_time);
f14b1c68
JB
5497 }
5498 }
570d7624 5499
b67f2ca5
RS
5500 /* Prevent another auto save till enough input events come in. */
5501 record_auto_save ();
570d7624 5502
17857782 5503 if (auto_saved && NILP (no_message))
f05b275b 5504 {
5794dd61 5505 if (old_message_p)
31f3d831 5506 {
5794dd61
RS
5507 /* If we are going to restore an old message,
5508 give time to read ours. */
83f8d903 5509 sit_for (make_number (1), 0, 0);
c71106e5 5510 restore_message ();
31f3d831 5511 }
ca730bf0 5512 else if (!auto_save_error_occurred)
31e31a15
CY
5513 /* Don't overwrite the error message if an error occurred.
5514 If we displayed a message and then restored a state
5794dd61 5515 with no message, leave a "done" message on the screen. */
f05b275b
KH
5516 message1 ("Auto-saving...done");
5517 }
570d7624 5518
ff4c9993
RS
5519 Vquit_flag = oquit;
5520
5794dd61 5521 /* This restores the message-stack status. */
e54d3b5d 5522 unbind_to (count, Qnil);
570d7624
JB
5523 return Qnil;
5524}
5525
5526DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
8c1a1077
PJ
5527 Sset_buffer_auto_saved, 0, 0, 0,
5528 doc: /* Mark current buffer as auto-saved with its current text.
5529No auto-save file will be written until the buffer changes again. */)
5842a27b 5530 (void)
570d7624 5531{
0b5397c2
SM
5532 /* FIXME: This should not be called in indirect buffers, since
5533 they're not autosaved. */
5534 BUF_AUTOSAVE_MODIFF (current_buffer) = MODIFF;
4b4deea2 5535 XSETFASTINT (BVAR (current_buffer, save_length), Z - BEG);
d311d28c 5536 current_buffer->auto_save_failure_time = 0;
b60247d9
RS
5537 return Qnil;
5538}
5539
5540DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
8c1a1077
PJ
5541 Sclear_buffer_auto_save_failure, 0, 0, 0,
5542 doc: /* Clear any record of a recent auto-save failure in the current buffer. */)
5842a27b 5543 (void)
b60247d9 5544{
d311d28c 5545 current_buffer->auto_save_failure_time = 0;
570d7624
JB
5546 return Qnil;
5547}
5548
5549DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
8c1a1077 5550 0, 0, 0,
68780e2a
RS
5551 doc: /* Return t if current buffer has been auto-saved recently.
5552More precisely, if it has been auto-saved since last read from or saved
5553in the visited file. If the buffer has no visited file,
5554then any auto-save counts as "recent". */)
5842a27b 5555 (void)
570d7624 5556{
0b5397c2
SM
5557 /* FIXME: maybe we should return nil for indirect buffers since
5558 they're never autosaved. */
5559 return (SAVE_MODIFF < BUF_AUTOSAVE_MODIFF (current_buffer) ? Qt : Qnil);
570d7624
JB
5560}
5561\f
5562/* Reading and completing file names */
6e710ae5 5563
88208bb8
JD
5564DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p,
5565 Snext_read_file_uses_dialog_p, 0, 0, 0,
5566 doc: /* Return t if a call to `read-file-name' will use a dialog.
5567The return value is only relevant for a call to `read-file-name' that happens
1a0de25c 5568before any other event (mouse or keypress) is handled. */)
5842a27b 5569 (void)
88208bb8 5570{
d7e642cc
JD
5571#if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) \
5572 || defined (HAVE_NS)
88208bb8
JD
5573 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
5574 && use_dialog_box
5575 && use_file_dialog
5576 && have_menus_p ())
5577 return Qt;
5578#endif
5579 return Qnil;
5580}
d4a42098 5581
dbd50d4b 5582Lisp_Object
971de7fb 5583Fread_file_name (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object initial, Lisp_Object predicate)
570d7624 5584{
fd4ead52 5585 struct gcpro gcpro1;
dbd50d4b 5586 Lisp_Object args[7];
a79485af 5587
71e1f69d 5588 GCPRO1 (default_filename);
dbd50d4b
SM
5589 args[0] = intern ("read-file-name");
5590 args[1] = prompt;
5591 args[2] = dir;
5592 args[3] = default_filename;
5593 args[4] = mustmatch;
5594 args[5] = initial;
5595 args[6] = predicate;
5596 RETURN_UNGCPRO (Ffuncall (7, args));
570d7624 5597}
9c856db9 5598
570d7624 5599\f
dfcf069d 5600void
971de7fb 5601syms_of_fileio (void)
570d7624 5602{
cd3520a4
JB
5603 DEFSYM (Qoperations, "operations");
5604 DEFSYM (Qexpand_file_name, "expand-file-name");
5605 DEFSYM (Qsubstitute_in_file_name, "substitute-in-file-name");
5606 DEFSYM (Qdirectory_file_name, "directory-file-name");
5607 DEFSYM (Qfile_name_directory, "file-name-directory");
5608 DEFSYM (Qfile_name_nondirectory, "file-name-nondirectory");
5609 DEFSYM (Qunhandled_file_name_directory, "unhandled-file-name-directory");
5610 DEFSYM (Qfile_name_as_directory, "file-name-as-directory");
5611 DEFSYM (Qcopy_file, "copy-file");
5612 DEFSYM (Qmake_directory_internal, "make-directory-internal");
5613 DEFSYM (Qmake_directory, "make-directory");
5614 DEFSYM (Qdelete_directory_internal, "delete-directory-internal");
5615 DEFSYM (Qdelete_file, "delete-file");
5616 DEFSYM (Qrename_file, "rename-file");
5617 DEFSYM (Qadd_name_to_file, "add-name-to-file");
5618 DEFSYM (Qmake_symbolic_link, "make-symbolic-link");
5619 DEFSYM (Qfile_exists_p, "file-exists-p");
5620 DEFSYM (Qfile_executable_p, "file-executable-p");
5621 DEFSYM (Qfile_readable_p, "file-readable-p");
5622 DEFSYM (Qfile_writable_p, "file-writable-p");
5623 DEFSYM (Qfile_symlink_p, "file-symlink-p");
5624 DEFSYM (Qaccess_file, "access-file");
5625 DEFSYM (Qfile_directory_p, "file-directory-p");
5626 DEFSYM (Qfile_regular_p, "file-regular-p");
5627 DEFSYM (Qfile_accessible_directory_p, "file-accessible-directory-p");
5628 DEFSYM (Qfile_modes, "file-modes");
5629 DEFSYM (Qset_file_modes, "set-file-modes");
5630 DEFSYM (Qset_file_times, "set-file-times");
5631 DEFSYM (Qfile_selinux_context, "file-selinux-context");
5632 DEFSYM (Qset_file_selinux_context, "set-file-selinux-context");
5633 DEFSYM (Qfile_newer_than_file_p, "file-newer-than-file-p");
5634 DEFSYM (Qinsert_file_contents, "insert-file-contents");
5635 DEFSYM (Qwrite_region, "write-region");
5636 DEFSYM (Qverify_visited_file_modtime, "verify-visited-file-modtime");
5637 DEFSYM (Qset_visited_file_modtime, "set-visited-file-modtime");
5638 DEFSYM (Qauto_save_coding, "auto-save-coding");
5639
5640 DEFSYM (Qfile_name_history, "file-name-history");
642ef245 5641 Fset (Qfile_name_history, Qnil);
15c65264 5642
cd3520a4
JB
5643 DEFSYM (Qfile_error, "file-error");
5644 DEFSYM (Qfile_already_exists, "file-already-exists");
5645 DEFSYM (Qfile_date_error, "file-date-error");
5646 DEFSYM (Qexcl, "excl");
570d7624 5647
29208e82 5648 DEFVAR_LISP ("file-name-coding-system", Vfile_name_coding_system,
fb7ada5f 5649 doc: /* Coding system for encoding file names.
346ebf53 5650If it is nil, `default-file-name-coding-system' (which see) is used. */);
b1d1b865
RS
5651 Vfile_name_coding_system = Qnil;
5652
cd913586 5653 DEFVAR_LISP ("default-file-name-coding-system",
29208e82 5654 Vdefault_file_name_coding_system,
8c1a1077 5655 doc: /* Default coding system for encoding file names.
346ebf53 5656This variable is used only when `file-name-coding-system' is nil.
8c1a1077 5657
346ebf53 5658This variable is set/changed by the command `set-language-environment'.
8c1a1077 5659User should not set this variable manually,
346ebf53 5660instead use `file-name-coding-system' to get a constant encoding
8c1a1077 5661of file names regardless of the current language environment. */);
cd913586
KH
5662 Vdefault_file_name_coding_system = Qnil;
5663
cd3520a4
JB
5664 DEFSYM (Qformat_decode, "format-decode");
5665 DEFSYM (Qformat_annotate_function, "format-annotate-function");
5666 DEFSYM (Qafter_insert_file_set_coding, "after-insert-file-set-coding");
5667 DEFSYM (Qcar_less_than_car, "car-less-than-car");
d6a3cc15 5668
570d7624 5669 Fput (Qfile_error, Qerror_conditions,
d67b4f80 5670 Fpurecopy (list2 (Qfile_error, Qerror)));
570d7624 5671 Fput (Qfile_error, Qerror_message,
2a0213a6 5672 build_pure_c_string ("File error"));
570d7624
JB
5673
5674 Fput (Qfile_already_exists, Qerror_conditions,
d67b4f80 5675 Fpurecopy (list3 (Qfile_already_exists, Qfile_error, Qerror)));
570d7624 5676 Fput (Qfile_already_exists, Qerror_message,
2a0213a6 5677 build_pure_c_string ("File already exists"));
570d7624 5678
c0b7b21c 5679 Fput (Qfile_date_error, Qerror_conditions,
d67b4f80 5680 Fpurecopy (list3 (Qfile_date_error, Qfile_error, Qerror)));
c0b7b21c 5681 Fput (Qfile_date_error, Qerror_message,
2a0213a6 5682 build_pure_c_string ("Cannot set file date"));
c0b7b21c 5683
29208e82 5684 DEFVAR_LISP ("file-name-handler-alist", Vfile_name_handler_alist,
a59225b1
CY
5685 doc: /* Alist of elements (REGEXP . HANDLER) for file names handled specially.
5686If a file name matches REGEXP, all I/O on that file is done by calling
5687HANDLER. If a file name matches more than one handler, the handler
5688whose match starts last in the file name gets precedence. The
5689function `find-file-name-handler' checks this list for a handler for
5690its argument.
5691
5692HANDLER should be a function. The first argument given to it is the
5693name of the I/O primitive to be handled; the remaining arguments are
5694the arguments that were passed to that primitive. For example, if you
5695do (file-exists-p FILENAME) and FILENAME is handled by HANDLER, then
5696HANDLER is called like this:
5697
5698 (funcall HANDLER 'file-exists-p FILENAME)
5699
5700Note that HANDLER must be able to handle all I/O primitives; if it has
5701nothing special to do for a primitive, it should reinvoke the
5702primitive to handle the operation \"the usual way\".
5703See Info node `(elisp)Magic File Names' for more details. */);
09121adc
RS
5704 Vfile_name_handler_alist = Qnil;
5705
0414b394 5706 DEFVAR_LISP ("set-auto-coding-function",
29208e82 5707 Vset_auto_coding_function,
8c1a1077
PJ
5708 doc: /* If non-nil, a function to call to decide a coding system of file.
5709Two arguments are passed to this function: the file name
5710and the length of a file contents following the point.
5711This function should return a coding system to decode the file contents.
5712It should check the file name against `auto-coding-alist'.
5713If no coding system is decided, it should check a coding system
5714specified in the heading lines with the format:
5715 -*- ... coding: CODING-SYSTEM; ... -*-
5716or local variable spec of the tailing lines with `coding:' tag. */);
0414b394 5717 Vset_auto_coding_function = Qnil;
c9e82392 5718
29208e82 5719 DEFVAR_LISP ("after-insert-file-functions", Vafter_insert_file_functions,
8c1a1077 5720 doc: /* A list of functions to be called at the end of `insert-file-contents'.
0cf9f5b5
RS
5721Each is passed one argument, the number of characters inserted,
5722with point at the start of the inserted text. Each function
5723should leave point the same, and return the new character count.
cf6d2357
RS
5724If `insert-file-contents' is intercepted by a handler from
5725`file-name-handler-alist', that handler is responsible for calling the
5726functions in `after-insert-file-functions' if appropriate. */);
d6a3cc15
RS
5727 Vafter_insert_file_functions = Qnil;
5728
29208e82 5729 DEFVAR_LISP ("write-region-annotate-functions", Vwrite_region_annotate_functions,
8c1a1077
PJ
5730 doc: /* A list of functions to be called at the start of `write-region'.
5731Each is passed two arguments, START and END as for `write-region'.
5732These are usually two numbers but not always; see the documentation
5733for `write-region'. The function should return a list of pairs
5734of the form (POSITION . STRING), consisting of strings to be effectively
5735inserted at the specified positions of the file being written (1 means to
5736insert before the first byte written). The POSITIONs must be sorted into
67fbc0cb
CY
5737increasing order.
5738
5739If there are several annotation functions, the lists returned by these
5740functions are merged destructively. As each annotation function runs,
5741the variable `write-region-annotations-so-far' contains a list of all
5742annotations returned by previous annotation functions.
5743
5744An annotation function can return with a different buffer current.
5745Doing so removes the annotations returned by previous functions, and
5746resets START and END to `point-min' and `point-max' of the new buffer.
5747
5748After `write-region' completes, Emacs calls the function stored in
5749`write-region-post-annotation-function', once for each buffer that was
5750current when building the annotations (i.e., at least once), with that
5751buffer current. */);
d6a3cc15 5752 Vwrite_region_annotate_functions = Qnil;
cd3520a4 5753 DEFSYM (Qwrite_region_annotate_functions, "write-region-annotate-functions");
d6a3cc15 5754
67fbc0cb 5755 DEFVAR_LISP ("write-region-post-annotation-function",
29208e82 5756 Vwrite_region_post_annotation_function,
67fbc0cb
CY
5757 doc: /* Function to call after `write-region' completes.
5758The function is called with no arguments. If one or more of the
5759annotation functions in `write-region-annotate-functions' changed the
5760current buffer, the function stored in this variable is called for
5761each of those additional buffers as well, in addition to the original
5762buffer. The relevant buffer is current during each function call. */);
5763 Vwrite_region_post_annotation_function = Qnil;
5764 staticpro (&Vwrite_region_annotation_buffers);
5765
6fc6f94b 5766 DEFVAR_LISP ("write-region-annotations-so-far",
29208e82 5767 Vwrite_region_annotations_so_far,
8c1a1077
PJ
5768 doc: /* When an annotation function is called, this holds the previous annotations.
5769These are the annotations made by other annotation functions
5770that were already called. See also `write-region-annotate-functions'. */);
6fc6f94b
RS
5771 Vwrite_region_annotations_so_far = Qnil;
5772
29208e82 5773 DEFVAR_LISP ("inhibit-file-name-handlers", Vinhibit_file_name_handlers,
8c1a1077
PJ
5774 doc: /* A list of file name handlers that temporarily should not be used.
5775This applies only to the operation `inhibit-file-name-operation'. */);
82c2d839
RS
5776 Vinhibit_file_name_handlers = Qnil;
5777
29208e82 5778 DEFVAR_LISP ("inhibit-file-name-operation", Vinhibit_file_name_operation,
8c1a1077 5779 doc: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
a65970a0
RS
5780 Vinhibit_file_name_operation = Qnil;
5781
29208e82 5782 DEFVAR_LISP ("auto-save-list-file-name", Vauto_save_list_file_name,
8c1a1077
PJ
5783 doc: /* File name in which we write a list of all auto save file names.
5784This variable is initialized automatically from `auto-save-list-file-prefix'
a2458031 5785shortly after Emacs reads your init file, if you have not yet given it
8c1a1077 5786a non-nil value. */);
e54d3b5d
RS
5787 Vauto_save_list_file_name = Qnil;
5788
29208e82 5789 DEFVAR_LISP ("auto-save-visited-file-name", Vauto_save_visited_file_name,
699b53bc
CY
5790 doc: /* Non-nil says auto-save a buffer in the file it is visiting, when practical.
5791Normally auto-save files are written under other names. */);
5792 Vauto_save_visited_file_name = Qnil;
5793
29208e82 5794 DEFVAR_LISP ("auto-save-include-big-deletions", Vauto_save_include_big_deletions,
090101cf
CY
5795 doc: /* If non-nil, auto-save even if a large part of the text is deleted.
5796If nil, deleting a substantial portion of the text disables auto-save
5797in the buffer; this is the default behavior, because the auto-save
5798file is usually more useful if it contains the deleted text. */);
5799 Vauto_save_include_big_deletions = Qnil;
5800
ccf61795 5801#ifdef HAVE_FSYNC
29208e82 5802 DEFVAR_BOOL ("write-region-inhibit-fsync", write_region_inhibit_fsync,
fb7ada5f 5803 doc: /* Non-nil means don't call fsync in `write-region'.
e3f509dd
RF
5804This variable affects calls to `write-region' as well as save commands.
5805A non-nil value may result in data loss! */);
ccf61795
RF
5806 write_region_inhibit_fsync = 0;
5807#endif
5808
29208e82 5809 DEFVAR_BOOL ("delete-by-moving-to-trash", delete_by_moving_to_trash,
6cf29fe8 5810 doc: /* Specifies whether to use the system's trash can.
f1a5d776
CY
5811When non-nil, certain file deletion commands use the function
5812`move-file-to-trash' instead of deleting files outright.
5813This includes interactive calls to `delete-file' and
5814`delete-directory' and the Dired deletion commands. */);
6cf29fe8 5815 delete_by_moving_to_trash = 0;
d67b4f80 5816 Qdelete_by_moving_to_trash = intern_c_string ("delete-by-moving-to-trash");
cd3520a4
JB
5817
5818 DEFSYM (Qmove_file_to_trash, "move-file-to-trash");
5819 DEFSYM (Qcopy_directory, "copy-directory");
5820 DEFSYM (Qdelete_directory, "delete-directory");
6cf29fe8 5821
642ef245 5822 defsubr (&Sfind_file_name_handler);
570d7624
JB
5823 defsubr (&Sfile_name_directory);
5824 defsubr (&Sfile_name_nondirectory);
642ef245 5825 defsubr (&Sunhandled_file_name_directory);
570d7624
JB
5826 defsubr (&Sfile_name_as_directory);
5827 defsubr (&Sdirectory_file_name);
5828 defsubr (&Smake_temp_name);
5829 defsubr (&Sexpand_file_name);
5830 defsubr (&Ssubstitute_in_file_name);
5831 defsubr (&Scopy_file);
9bbe01fb 5832 defsubr (&Smake_directory_internal);
9d8f3bd9 5833 defsubr (&Sdelete_directory_internal);
570d7624
JB
5834 defsubr (&Sdelete_file);
5835 defsubr (&Srename_file);
5836 defsubr (&Sadd_name_to_file);
570d7624 5837 defsubr (&Smake_symbolic_link);
570d7624
JB
5838 defsubr (&Sfile_name_absolute_p);
5839 defsubr (&Sfile_exists_p);
5840 defsubr (&Sfile_executable_p);
5841 defsubr (&Sfile_readable_p);
5842 defsubr (&Sfile_writable_p);
1f8653eb 5843 defsubr (&Saccess_file);
570d7624
JB
5844 defsubr (&Sfile_symlink_p);
5845 defsubr (&Sfile_directory_p);
b72dea2a 5846 defsubr (&Sfile_accessible_directory_p);
f793dc6c 5847 defsubr (&Sfile_regular_p);
570d7624
JB
5848 defsubr (&Sfile_modes);
5849 defsubr (&Sset_file_modes);
819da85b 5850 defsubr (&Sset_file_times);
574c05e2
KK
5851 defsubr (&Sfile_selinux_context);
5852 defsubr (&Sset_file_selinux_context);
c24e9a53
RS
5853 defsubr (&Sset_default_file_modes);
5854 defsubr (&Sdefault_file_modes);
570d7624
JB
5855 defsubr (&Sfile_newer_than_file_p);
5856 defsubr (&Sinsert_file_contents);
5857 defsubr (&Swrite_region);
d6a3cc15 5858 defsubr (&Scar_less_than_car);
570d7624
JB
5859 defsubr (&Sverify_visited_file_modtime);
5860 defsubr (&Sclear_visited_file_modtime);
f5d5eccf 5861 defsubr (&Svisited_file_modtime);
570d7624
JB
5862 defsubr (&Sset_visited_file_modtime);
5863 defsubr (&Sdo_auto_save);
5864 defsubr (&Sset_buffer_auto_saved);
b60247d9 5865 defsubr (&Sclear_buffer_auto_save_failure);
570d7624
JB
5866 defsubr (&Srecent_auto_save_p);
5867
88208bb8 5868 defsubr (&Snext_read_file_uses_dialog_p);
85ffea93 5869
697c17a2 5870#ifdef HAVE_SYNC
85ffea93 5871 defsubr (&Sunix_sync);
483a2e10 5872#endif
570d7624 5873}