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