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