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