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