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