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