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