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