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