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