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