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