(Foverlay_lists): Doc fix.
[bpt/emacs.git] / src / fileio.c
CommitLineData
570d7624 1/* File IO for GNU Emacs.
ce97267f 2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994 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
18the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
19
18160b98 20#include <config.h>
570d7624
JB
21
22#include <sys/types.h>
23#include <sys/stat.h>
bfb61299 24
29beb080
RS
25#ifdef HAVE_UNISTD_H
26#include <unistd.h>
27#endif
28
f73b0ada
BF
29#if !defined (S_ISLNK) && defined (S_IFLNK)
30# define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
31#endif
32
33#if !defined (S_ISREG) && defined (S_IFREG)
34# define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
35#endif
36
bfb61299 37#ifdef VMS
de5bf5d3 38#include "vms-pwd.h"
bfb61299 39#else
570d7624 40#include <pwd.h>
bfb61299
JB
41#endif
42
4c3c22f3
RS
43#ifdef MSDOS
44#include "msdos.h"
45#include <sys/param.h>
46#endif
47
570d7624 48#include <ctype.h>
bfb61299
JB
49
50#ifdef VMS
3d9f5ce2 51#include "vmsdir.h"
bfb61299
JB
52#include <perror.h>
53#include <stddef.h>
54#include <string.h>
bfb61299
JB
55#endif
56
570d7624
JB
57#include <errno.h>
58
bfb61299 59#ifndef vax11c
570d7624 60extern int errno;
570d7624
JB
61#endif
62
ce97267f 63extern char *strerror ();
570d7624
JB
64
65#ifdef APOLLO
66#include <sys/time.h>
67#endif
68
6e23c83e
JB
69#ifndef USG
70#ifndef VMS
71#ifndef BSD4_1
72#define HAVE_FSYNC
73#endif
74#endif
75#endif
76
570d7624 77#include "lisp.h"
8d4e077b 78#include "intervals.h"
570d7624
JB
79#include "buffer.h"
80#include "window.h"
81
82#ifdef VMS
570d7624
JB
83#include <file.h>
84#include <rmsdef.h>
85#include <fab.h>
86#include <nam.h>
87#endif
88
de5bf5d3 89#include "systime.h"
570d7624
JB
90
91#ifdef HPUX
92#include <netio.h>
9b7828a5 93#ifndef HPUX8
47e7b9e5 94#ifndef HPUX9
570d7624
JB
95#include <errnet.h>
96#endif
9b7828a5 97#endif
47e7b9e5 98#endif
570d7624
JB
99
100#ifndef O_WRONLY
101#define O_WRONLY 1
102#endif
103
104#define min(a, b) ((a) < (b) ? (a) : (b))
105#define max(a, b) ((a) > (b) ? (a) : (b))
106
107/* Nonzero during writing of auto-save files */
108int auto_saving;
109
110/* Set by auto_save_1 to mode of original file so Fwrite_region will create
111 a new file with the same mode as the original */
112int auto_save_mode_bits;
113
32f4334d
RS
114/* Alist of elements (REGEXP . HANDLER) for file names
115 whose I/O is done with a special handler. */
116Lisp_Object Vfile_name_handler_alist;
117
d6a3cc15
RS
118/* Functions to be called to process text properties in inserted file. */
119Lisp_Object Vafter_insert_file_functions;
120
121/* Functions to be called to create text property annotations for file. */
122Lisp_Object Vwrite_region_annotate_functions;
123
e54d3b5d
RS
124/* File name in which we write a list of all our auto save files. */
125Lisp_Object Vauto_save_list_file_name;
126
570d7624
JB
127/* Nonzero means, when reading a filename in the minibuffer,
128 start out by inserting the default directory into the minibuffer. */
129int insert_default_directory;
130
131/* On VMS, nonzero means write new files with record format stmlf.
132 Zero means use var format. */
133int vms_stmlf_recfm;
134
a65970a0
RS
135/* These variables describe handlers that have "already" had a chance
136 to handle the current operation.
137
138 Vinhibit_file_name_handlers is a list of file name handlers.
139 Vinhibit_file_name_operation is the operation being handled.
140 If we try to handle that operation, we ignore those handlers. */
141
82c2d839 142static Lisp_Object Vinhibit_file_name_handlers;
a65970a0 143static Lisp_Object Vinhibit_file_name_operation;
82c2d839 144
570d7624
JB
145Lisp_Object Qfile_error, Qfile_already_exists;
146
15c65264
RS
147Lisp_Object Qfile_name_history;
148
d6a3cc15
RS
149Lisp_Object Qcar_less_than_car;
150
570d7624
JB
151report_file_error (string, data)
152 char *string;
153 Lisp_Object data;
154{
155 Lisp_Object errstring;
156
a1f17b2d 157 errstring = build_string (strerror (errno));
570d7624
JB
158
159 /* System error messages are capitalized. Downcase the initial
160 unless it is followed by a slash. */
161 if (XSTRING (errstring)->data[1] != '/')
162 XSTRING (errstring)->data[0] = DOWNCASE (XSTRING (errstring)->data[0]);
163
164 while (1)
165 Fsignal (Qfile_error,
166 Fcons (build_string (string), Fcons (errstring, data)));
167}
b5148e85
RS
168
169close_file_unwind (fd)
170 Lisp_Object fd;
171{
172 close (XFASTINT (fd));
173}
a1d2b64a
RS
174
175/* Restore point, having saved it as a marker. */
176
177restore_point_unwind (location)
178 Lisp_Object location;
179{
180 SET_PT (marker_position (location));
181 Fset_marker (location, Qnil, Qnil);
182}
570d7624 183\f
0bf2eed2
RS
184Lisp_Object Qexpand_file_name;
185Lisp_Object Qdirectory_file_name;
186Lisp_Object Qfile_name_directory;
187Lisp_Object Qfile_name_nondirectory;
642ef245 188Lisp_Object Qunhandled_file_name_directory;
0bf2eed2 189Lisp_Object Qfile_name_as_directory;
32f4334d
RS
190Lisp_Object Qcopy_file;
191Lisp_Object Qmake_directory;
192Lisp_Object Qdelete_directory;
193Lisp_Object Qdelete_file;
194Lisp_Object Qrename_file;
195Lisp_Object Qadd_name_to_file;
196Lisp_Object Qmake_symbolic_link;
197Lisp_Object Qfile_exists_p;
198Lisp_Object Qfile_executable_p;
199Lisp_Object Qfile_readable_p;
200Lisp_Object Qfile_symlink_p;
201Lisp_Object Qfile_writable_p;
202Lisp_Object Qfile_directory_p;
203Lisp_Object Qfile_accessible_directory_p;
204Lisp_Object Qfile_modes;
205Lisp_Object Qset_file_modes;
206Lisp_Object Qfile_newer_than_file_p;
207Lisp_Object Qinsert_file_contents;
208Lisp_Object Qwrite_region;
209Lisp_Object Qverify_visited_file_modtime;
3ec46acd 210Lisp_Object Qset_visited_file_modtime;
32f4334d 211
49307295
KH
212DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
213 "Return FILENAME's handler function for OPERATION, if it has one.\n\
642ef245
JB
214Otherwise, return nil.\n\
215A file name is handled if one of the regular expressions in\n\
82c2d839 216`file-name-handler-alist' matches it.\n\n\
a65970a0
RS
217If OPERATION equals `inhibit-file-name-operation', then we ignore\n\
218any handlers that are members of `inhibit-file-name-handlers',\n\
219but we still do run any other handlers. This lets handlers\n\
82c2d839 220use the standard functions without calling themselves recursively.")
49307295
KH
221 (filename, operation)
222 Lisp_Object filename, operation;
32f4334d 223{
642ef245 224 /* This function must not munge the match data. */
a65970a0 225 Lisp_Object chain, inhibited_handlers;
642ef245 226
e4432095
JB
227 CHECK_STRING (filename, 0);
228
a65970a0
RS
229 if (EQ (operation, Vinhibit_file_name_operation))
230 inhibited_handlers = Vinhibit_file_name_handlers;
231 else
232 inhibited_handlers = Qnil;
82c2d839 233
3eac9910 234 for (chain = Vfile_name_handler_alist; XTYPE (chain) == Lisp_Cons;
32f4334d
RS
235 chain = XCONS (chain)->cdr)
236 {
237 Lisp_Object elt;
238 elt = XCONS (chain)->car;
239 if (XTYPE (elt) == Lisp_Cons)
240 {
241 Lisp_Object string;
242 string = XCONS (elt)->car;
243 if (XTYPE (string) == Lisp_String
09121adc 244 && fast_string_match (string, filename) >= 0)
a65970a0
RS
245 {
246 Lisp_Object handler, tem;
247
248 handler = XCONS (elt)->cdr;
249 tem = Fmemq (handler, inhibited_handlers);
250 if (NILP (tem))
251 return handler;
252 }
32f4334d 253 }
642ef245
JB
254
255 QUIT;
32f4334d
RS
256 }
257 return Qnil;
258}
259\f
570d7624
JB
260DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
261 1, 1, 0,
262 "Return the directory component in file name NAME.\n\
263Return nil if NAME does not include a directory.\n\
264Otherwise return a directory spec.\n\
265Given a Unix syntax file name, returns a string ending in slash;\n\
266on VMS, perhaps instead a string ending in `:', `]' or `>'.")
267 (file)
268 Lisp_Object file;
269{
270 register unsigned char *beg;
271 register unsigned char *p;
0bf2eed2 272 Lisp_Object handler;
570d7624
JB
273
274 CHECK_STRING (file, 0);
275
0bf2eed2
RS
276 /* If the file name has special constructs in it,
277 call the corresponding file handler. */
49307295 278 handler = Ffind_file_name_handler (file, Qfile_name_directory);
0bf2eed2
RS
279 if (!NILP (handler))
280 return call2 (handler, Qfile_name_directory, file);
281
4c3c22f3
RS
282#ifdef FILE_SYSTEM_CASE
283 file = FILE_SYSTEM_CASE (file);
284#endif
570d7624
JB
285 beg = XSTRING (file)->data;
286 p = beg + XSTRING (file)->size;
287
288 while (p != beg && p[-1] != '/'
289#ifdef VMS
290 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
291#endif /* VMS */
4c3c22f3
RS
292#ifdef MSDOS
293 && p[-1] != ':'
294#endif
570d7624
JB
295 ) p--;
296
297 if (p == beg)
298 return Qnil;
4c3c22f3
RS
299#ifdef MSDOS
300 /* Expansion of "c:" to drive and default directory. */
301 if (p == beg + 2 && beg[1] == ':')
302 {
303 int drive = (*beg) - 'a';
304 /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir. */
305 unsigned char *res = alloca (MAXPATHLEN + 5);
306 if (getdefdir (drive + 1, res + 2))
307 {
308 res[0] = drive + 'a';
309 res[1] = ':';
310 if (res[strlen (res) - 1] != '/')
311 strcat (res, "/");
312 beg = res;
313 p = beg + strlen (beg);
314 }
315 }
316#endif
570d7624
JB
317 return make_string (beg, p - beg);
318}
319
320DEFUN ("file-name-nondirectory", Ffile_name_nondirectory, Sfile_name_nondirectory,
321 1, 1, 0,
322 "Return file name NAME sans its directory.\n\
323For example, in a Unix-syntax file name,\n\
324this is everything after the last slash,\n\
325or the entire name if it contains no slash.")
326 (file)
327 Lisp_Object file;
328{
329 register unsigned char *beg, *p, *end;
0bf2eed2 330 Lisp_Object handler;
570d7624
JB
331
332 CHECK_STRING (file, 0);
333
0bf2eed2
RS
334 /* If the file name has special constructs in it,
335 call the corresponding file handler. */
49307295 336 handler = Ffind_file_name_handler (file, Qfile_name_nondirectory);
0bf2eed2
RS
337 if (!NILP (handler))
338 return call2 (handler, Qfile_name_nondirectory, file);
339
570d7624
JB
340 beg = XSTRING (file)->data;
341 end = p = beg + XSTRING (file)->size;
342
343 while (p != beg && p[-1] != '/'
344#ifdef VMS
345 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
346#endif /* VMS */
4c3c22f3
RS
347#ifdef MSDOS
348 && p[-1] != ':'
349#endif
570d7624
JB
350 ) p--;
351
352 return make_string (p, end - p);
353}
642ef245
JB
354
355DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory, Sunhandled_file_name_directory, 1, 1, 0,
356 "Return a directly usable directory name somehow associated with FILENAME.\n\
357A `directly usable' directory name is one that may be used without the\n\
358intervention of any file handler.\n\
359If FILENAME is a directly usable file itself, return\n\
360(file-name-directory FILENAME).\n\
361The `call-process' and `start-process' functions use this function to\n\
362get a current directory to run processes in.")
363 (filename)
364 Lisp_Object filename;
365{
366 Lisp_Object handler;
367
368 /* If the file name has special constructs in it,
369 call the corresponding file handler. */
49307295 370 handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
642ef245
JB
371 if (!NILP (handler))
372 return call2 (handler, Qunhandled_file_name_directory, filename);
373
374 return Ffile_name_directory (filename);
375}
376
570d7624
JB
377\f
378char *
379file_name_as_directory (out, in)
380 char *out, *in;
381{
382 int size = strlen (in) - 1;
383
384 strcpy (out, in);
385
386#ifdef VMS
387 /* Is it already a directory string? */
388 if (in[size] == ':' || in[size] == ']' || in[size] == '>')
389 return out;
390 /* Is it a VMS directory file name? If so, hack VMS syntax. */
391 else if (! index (in, '/')
392 && ((size > 3 && ! strcmp (&in[size - 3], ".DIR"))
393 || (size > 3 && ! strcmp (&in[size - 3], ".dir"))
394 || (size > 5 && (! strncmp (&in[size - 5], ".DIR", 4)
395 || ! strncmp (&in[size - 5], ".dir", 4))
396 && (in[size - 1] == '.' || in[size - 1] == ';')
397 && in[size] == '1')))
398 {
399 register char *p, *dot;
400 char brack;
401
402 /* x.dir -> [.x]
403 dir:x.dir --> dir:[x]
404 dir:[x]y.dir --> dir:[x.y] */
405 p = in + size;
406 while (p != in && *p != ':' && *p != '>' && *p != ']') p--;
407 if (p != in)
408 {
409 strncpy (out, in, p - in);
410 out[p - in] = '\0';
411 if (*p == ':')
412 {
413 brack = ']';
414 strcat (out, ":[");
415 }
416 else
417 {
418 brack = *p;
419 strcat (out, ".");
420 }
421 p++;
422 }
423 else
424 {
425 brack = ']';
426 strcpy (out, "[.");
427 }
bfb61299
JB
428 dot = index (p, '.');
429 if (dot)
570d7624
JB
430 {
431 /* blindly remove any extension */
432 size = strlen (out) + (dot - p);
433 strncat (out, p, dot - p);
434 }
435 else
436 {
437 strcat (out, p);
438 size = strlen (out);
439 }
440 out[size++] = brack;
441 out[size] = '\0';
442 }
443#else /* not VMS */
444 /* For Unix syntax, Append a slash if necessary */
4c3c22f3
RS
445#ifdef MSDOS
446 if (out[size] != ':' && out[size] != '/')
447#else
570d7624 448 if (out[size] != '/')
4c3c22f3 449#endif
570d7624
JB
450 strcat (out, "/");
451#endif /* not VMS */
452 return out;
453}
454
455DEFUN ("file-name-as-directory", Ffile_name_as_directory,
456 Sfile_name_as_directory, 1, 1, 0,
457 "Return a string representing file FILENAME interpreted as a directory.\n\
458This operation exists because a directory is also a file, but its name as\n\
459a directory is different from its name as a file.\n\
460The result can be used as the value of `default-directory'\n\
461or passed as second argument to `expand-file-name'.\n\
462For a Unix-syntax file name, just appends a slash.\n\
463On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc.")
464 (file)
465 Lisp_Object file;
466{
467 char *buf;
0bf2eed2 468 Lisp_Object handler;
570d7624
JB
469
470 CHECK_STRING (file, 0);
265a9e55 471 if (NILP (file))
570d7624 472 return Qnil;
0bf2eed2
RS
473
474 /* If the file name has special constructs in it,
475 call the corresponding file handler. */
49307295 476 handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
0bf2eed2
RS
477 if (!NILP (handler))
478 return call2 (handler, Qfile_name_as_directory, file);
479
570d7624
JB
480 buf = (char *) alloca (XSTRING (file)->size + 10);
481 return build_string (file_name_as_directory (buf, XSTRING (file)->data));
482}
483\f
484/*
485 * Convert from directory name to filename.
486 * On VMS:
487 * xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
488 * xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
489 * On UNIX, it's simple: just make sure there is a terminating /
490
491 * Value is nonzero if the string output is different from the input.
492 */
493
494directory_file_name (src, dst)
495 char *src, *dst;
496{
497 long slen;
498#ifdef VMS
499 long rlen;
500 char * ptr, * rptr;
501 char bracket;
502 struct FAB fab = cc$rms_fab;
503 struct NAM nam = cc$rms_nam;
504 char esa[NAM$C_MAXRSS];
505#endif /* VMS */
506
507 slen = strlen (src);
508#ifdef VMS
509 if (! index (src, '/')
510 && (src[slen - 1] == ']'
511 || src[slen - 1] == ':'
512 || src[slen - 1] == '>'))
513 {
514 /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
515 fab.fab$l_fna = src;
516 fab.fab$b_fns = slen;
517 fab.fab$l_nam = &nam;
518 fab.fab$l_fop = FAB$M_NAM;
519
520 nam.nam$l_esa = esa;
521 nam.nam$b_ess = sizeof esa;
522 nam.nam$b_nop |= NAM$M_SYNCHK;
523
524 /* We call SYS$PARSE to handle such things as [--] for us. */
525 if (SYS$PARSE(&fab, 0, 0) == RMS$_NORMAL)
526 {
527 slen = nam.nam$b_esl;
528 if (esa[slen - 1] == ';' && esa[slen - 2] == '.')
529 slen -= 2;
530 esa[slen] = '\0';
531 src = esa;
532 }
533 if (src[slen - 1] != ']' && src[slen - 1] != '>')
534 {
535 /* what about when we have logical_name:???? */
536 if (src[slen - 1] == ':')
537 { /* Xlate logical name and see what we get */
538 ptr = strcpy (dst, src); /* upper case for getenv */
539 while (*ptr)
540 {
541 if ('a' <= *ptr && *ptr <= 'z')
542 *ptr -= 040;
543 ptr++;
544 }
545 dst[slen - 1] = 0; /* remove colon */
546 if (!(src = egetenv (dst)))
547 return 0;
548 /* should we jump to the beginning of this procedure?
549 Good points: allows us to use logical names that xlate
550 to Unix names,
551 Bad points: can be a problem if we just translated to a device
552 name...
553 For now, I'll punt and always expect VMS names, and hope for
554 the best! */
555 slen = strlen (src);
556 if (src[slen - 1] != ']' && src[slen - 1] != '>')
557 { /* no recursion here! */
558 strcpy (dst, src);
559 return 0;
560 }
561 }
562 else
563 { /* not a directory spec */
564 strcpy (dst, src);
565 return 0;
566 }
567 }
568 bracket = src[slen - 1];
569
570 /* If bracket is ']' or '>', bracket - 2 is the corresponding
571 opening bracket. */
bfb61299
JB
572 ptr = index (src, bracket - 2);
573 if (ptr == 0)
570d7624
JB
574 { /* no opening bracket */
575 strcpy (dst, src);
576 return 0;
577 }
578 if (!(rptr = rindex (src, '.')))
579 rptr = ptr;
580 slen = rptr - src;
581 strncpy (dst, src, slen);
582 dst[slen] = '\0';
583 if (*rptr == '.')
584 {
585 dst[slen++] = bracket;
586 dst[slen] = '\0';
587 }
588 else
589 {
590 /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
591 then translate the device and recurse. */
592 if (dst[slen - 1] == ':'
593 && dst[slen - 2] != ':' /* skip decnet nodes */
594 && strcmp(src + slen, "[000000]") == 0)
595 {
596 dst[slen - 1] = '\0';
597 if ((ptr = egetenv (dst))
598 && (rlen = strlen (ptr) - 1) > 0
599 && (ptr[rlen] == ']' || ptr[rlen] == '>')
600 && ptr[rlen - 1] == '.')
601 {
72b21817
RS
602 char * buf = (char *) alloca (strlen (ptr) + 1);
603 strcpy (buf, ptr);
604 buf[rlen - 1] = ']';
605 buf[rlen] = '\0';
606 return directory_file_name (buf, dst);
570d7624
JB
607 }
608 else
609 dst[slen - 1] = ':';
610 }
611 strcat (dst, "[000000]");
612 slen += 8;
613 }
614 rptr++;
615 rlen = strlen (rptr) - 1;
616 strncat (dst, rptr, rlen);
617 dst[slen + rlen] = '\0';
618 strcat (dst, ".DIR.1");
619 return 1;
620 }
621#endif /* VMS */
622 /* Process as Unix format: just remove any final slash.
623 But leave "/" unchanged; do not change it to "". */
624 strcpy (dst, src);
4c3c22f3
RS
625 if (slen > 1
626 && dst[slen - 1] == '/'
627#ifdef MSDOS
628 && dst[slen - 2] != ':'
629#endif
630 )
570d7624
JB
631 dst[slen - 1] = 0;
632 return 1;
633}
634
635DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
636 1, 1, 0,
637 "Returns the file name of the directory named DIR.\n\
638This is the name of the file that holds the data for the directory DIR.\n\
639This operation exists because a directory is also a file, but its name as\n\
640a directory is different from its name as a file.\n\
641In Unix-syntax, this function just removes the final slash.\n\
642On VMS, given a VMS-syntax directory name such as \"[X.Y]\",\n\
643it returns a file name such as \"[X]Y.DIR.1\".")
644 (directory)
645 Lisp_Object directory;
646{
647 char *buf;
0bf2eed2 648 Lisp_Object handler;
570d7624
JB
649
650 CHECK_STRING (directory, 0);
651
265a9e55 652 if (NILP (directory))
570d7624 653 return Qnil;
0bf2eed2
RS
654
655 /* If the file name has special constructs in it,
656 call the corresponding file handler. */
49307295 657 handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
0bf2eed2
RS
658 if (!NILP (handler))
659 return call2 (handler, Qdirectory_file_name, directory);
660
570d7624
JB
661#ifdef VMS
662 /* 20 extra chars is insufficient for VMS, since we might perform a
663 logical name translation. an equivalence string can be up to 255
664 chars long, so grab that much extra space... - sss */
665 buf = (char *) alloca (XSTRING (directory)->size + 20 + 255);
666#else
667 buf = (char *) alloca (XSTRING (directory)->size + 20);
668#endif
669 directory_file_name (XSTRING (directory)->data, buf);
670 return build_string (buf);
671}
672
673DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
674 "Generate temporary file name (string) starting with PREFIX (a string).\n\
675The Emacs process number forms part of the result,\n\
676so there is no danger of generating a name being used by another process.")
677 (prefix)
678 Lisp_Object prefix;
679{
680 Lisp_Object val;
681 val = concat2 (prefix, build_string ("XXXXXX"));
682 mktemp (XSTRING (val)->data);
683 return val;
684}
685\f
686DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
687 "Convert FILENAME to absolute, and canonicalize it.\n\
688Second arg DEFAULT is directory to start with if FILENAME is relative\n\
689 (does not start with slash); if DEFAULT is nil or missing,\n\
690the current buffer's value of default-directory is used.\n\
b72dea2a
JB
691Path components that are `.' are removed, and \n\
692path components followed by `..' are removed, along with the `..' itself;\n\
693note that these simplifications are done without checking the resulting\n\
694paths in the file system.\n\
695An initial `~/' expands to your home directory.\n\
696An initial `~USER/' expands to USER's home directory.\n\
570d7624
JB
697See also the function `substitute-in-file-name'.")
698 (name, defalt)
699 Lisp_Object name, defalt;
700{
701 unsigned char *nm;
702
703 register unsigned char *newdir, *p, *o;
704 int tlen;
705 unsigned char *target;
706 struct passwd *pw;
570d7624
JB
707#ifdef VMS
708 unsigned char * colon = 0;
709 unsigned char * close = 0;
710 unsigned char * slash = 0;
711 unsigned char * brack = 0;
712 int lbrack = 0, rbrack = 0;
713 int dots = 0;
714#endif /* VMS */
4c3c22f3
RS
715#ifdef MSDOS /* Demacs 1.1.2 91/10/20 Manabu Higashida */
716 int drive = -1;
717 int relpath = 0;
718 unsigned char *tmp, *defdir;
719#endif
0bf2eed2 720 Lisp_Object handler;
570d7624
JB
721
722 CHECK_STRING (name, 0);
723
0bf2eed2
RS
724 /* If the file name has special constructs in it,
725 call the corresponding file handler. */
49307295 726 handler = Ffind_file_name_handler (name, Qexpand_file_name);
0bf2eed2 727 if (!NILP (handler))
09121adc 728 return call3 (handler, Qexpand_file_name, name, defalt);
0bf2eed2 729
4ad827c5
RS
730 /* Use the buffer's default-directory if DEFALT is omitted. */
731 if (NILP (defalt))
732 defalt = current_buffer->directory;
733 CHECK_STRING (defalt, 1);
734
f14b1c68
JB
735 /* Make sure DEFALT is properly expanded.
736 It would be better to do this down below where we actually use
737 defalt. Unfortunately, calling Fexpand_file_name recursively
738 could invoke GC, and the strings might be relocated. This would
739 be annoying because we have pointers into strings lying around
740 that would need adjusting, and people would add new pointers to
741 the code and forget to adjust them, resulting in intermittent bugs.
4ad827c5
RS
742 Putting this call here avoids all that crud.
743
744 The EQ test avoids infinite recursion. */
745 if (! NILP (defalt) && !EQ (defalt, name)
746 /* This saves time in a common case. */
747 && XSTRING (defalt)->data[0] != '/')
f14b1c68
JB
748 {
749 struct gcpro gcpro1;
750
751 GCPRO1 (name);
752 defalt = Fexpand_file_name (defalt, Qnil);
753 UNGCPRO;
754 }
755
570d7624
JB
756#ifdef VMS
757 /* Filenames on VMS are always upper case. */
758 name = Fupcase (name);
759#endif
4c3c22f3
RS
760#ifdef FILE_SYSTEM_CASE
761 name = FILE_SYSTEM_CASE (name);
762#endif
570d7624
JB
763
764 nm = XSTRING (name)->data;
765
4c3c22f3
RS
766#ifdef MSDOS
767 /* firstly, strip drive name. */
768 {
769 unsigned char *colon = rindex (nm, ':');
770 if (colon)
771 if (nm == colon)
772 nm++;
773 else
774 {
775 drive = tolower (colon[-1]) - 'a';
776 nm = colon + 1;
777 if (*nm != '/')
778 {
779 defdir = alloca (MAXPATHLEN + 1);
780 relpath = getdefdir (drive + 1, defdir);
781 }
782 }
783 }
784#endif
785
570d7624
JB
786 /* If nm is absolute, flush ...// and detect /./ and /../.
787 If no /./ or /../ we can return right away. */
788 if (
789 nm[0] == '/'
790#ifdef VMS
791 || index (nm, ':')
792#endif /* VMS */
793 )
794 {
f14b1c68
JB
795 /* If it turns out that the filename we want to return is just a
796 suffix of FILENAME, we don't need to go through and edit
797 things; we just need to construct a new string using data
798 starting at the middle of FILENAME. If we set lose to a
799 non-zero value, that means we've discovered that we can't do
800 that cool trick. */
801 int lose = 0;
802
570d7624 803 p = nm;
570d7624
JB
804 while (*p)
805 {
c77d647e
JB
806 /* Since we know the path is absolute, we can assume that each
807 element starts with a "/". */
808
809 /* "//" anywhere isn't necessarily hairy; we just start afresh
810 with the second slash. */
570d7624
JB
811 if (p[0] == '/' && p[1] == '/'
812#ifdef APOLLO
813 /* // at start of filename is meaningful on Apollo system */
814 && nm != p
815#endif /* APOLLO */
816 )
817 nm = p + 1;
c77d647e
JB
818
819 /* "~" is hairy as the start of any path element. */
570d7624
JB
820 if (p[0] == '/' && p[1] == '~')
821 nm = p + 1, lose = 1;
c77d647e
JB
822
823 /* "." and ".." are hairy. */
824 if (p[0] == '/'
825 && p[1] == '.'
826 && (p[2] == '/'
827 || p[2] == 0
828 || (p[2] == '.' && (p[3] == '/'
829 || p[3] == 0))))
570d7624
JB
830 lose = 1;
831#ifdef VMS
832 if (p[0] == '\\')
833 lose = 1;
834 if (p[0] == '/') {
835 /* if dev:[dir]/, move nm to / */
836 if (!slash && p > nm && (brack || colon)) {
837 nm = (brack ? brack + 1 : colon + 1);
838 lbrack = rbrack = 0;
839 brack = 0;
840 colon = 0;
841 }
842 slash = p;
843 }
844 if (p[0] == '-')
845#ifndef VMS4_4
846 /* VMS pre V4.4,convert '-'s in filenames. */
847 if (lbrack == rbrack)
848 {
849 if (dots < 2) /* this is to allow negative version numbers */
850 p[0] = '_';
851 }
852 else
853#endif /* VMS4_4 */
854 if (lbrack > rbrack &&
855 ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<') &&
856 (p[1] == '.' || p[1] == ']' || p[1] == '>')))
857 lose = 1;
858#ifndef VMS4_4
859 else
860 p[0] = '_';
861#endif /* VMS4_4 */
862 /* count open brackets, reset close bracket pointer */
863 if (p[0] == '[' || p[0] == '<')
864 lbrack++, brack = 0;
865 /* count close brackets, set close bracket pointer */
866 if (p[0] == ']' || p[0] == '>')
867 rbrack++, brack = p;
868 /* detect ][ or >< */
869 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
870 lose = 1;
871 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
872 nm = p + 1, lose = 1;
873 if (p[0] == ':' && (colon || slash))
874 /* if dev1:[dir]dev2:, move nm to dev2: */
875 if (brack)
876 {
877 nm = brack + 1;
878 brack = 0;
879 }
880 /* if /pathname/dev:, move nm to dev: */
881 else if (slash)
882 nm = slash + 1;
883 /* if node::dev:, move colon following dev */
884 else if (colon && colon[-1] == ':')
885 colon = p;
886 /* if dev1:dev2:, move nm to dev2: */
887 else if (colon && colon[-1] != ':')
888 {
889 nm = colon + 1;
890 colon = 0;
891 }
892 if (p[0] == ':' && !colon)
893 {
894 if (p[1] == ':')
895 p++;
896 colon = p;
897 }
898 if (lbrack == rbrack)
899 if (p[0] == ';')
900 dots = 2;
901 else if (p[0] == '.')
902 dots++;
903#endif /* VMS */
904 p++;
905 }
906 if (!lose)
907 {
908#ifdef VMS
909 if (index (nm, '/'))
910 return build_string (sys_translate_unix (nm));
911#endif /* VMS */
4c3c22f3 912#ifndef MSDOS
570d7624
JB
913 if (nm == XSTRING (name)->data)
914 return name;
915 return build_string (nm);
4c3c22f3 916#endif
570d7624
JB
917 }
918 }
919
920 /* Now determine directory to start with and put it in newdir */
921
922 newdir = 0;
923
924 if (nm[0] == '~') /* prefix ~ */
c77d647e
JB
925 {
926 if (nm[1] == '/'
570d7624 927#ifdef VMS
c77d647e
JB
928 || nm[1] == ':'
929#endif /* VMS */
930 || nm[1] == 0) /* ~ by itself */
931 {
932 if (!(newdir = (unsigned char *) egetenv ("HOME")))
933 newdir = (unsigned char *) "";
4c3c22f3
RS
934#ifdef MSDOS
935 dostounix_filename (newdir);
936#endif
c77d647e 937 nm++;
570d7624 938#ifdef VMS
c77d647e
JB
939 nm++; /* Don't leave the slash in nm. */
940#endif /* VMS */
941 }
942 else /* ~user/filename */
943 {
944 for (p = nm; *p && (*p != '/'
570d7624 945#ifdef VMS
c77d647e
JB
946 && *p != ':'
947#endif /* VMS */
948 ); p++);
949 o = (unsigned char *) alloca (p - nm + 1);
950 bcopy ((char *) nm, o, p - nm);
951 o [p - nm] = 0;
952
953 pw = (struct passwd *) getpwnam (o + 1);
954 if (pw)
955 {
956 newdir = (unsigned char *) pw -> pw_dir;
570d7624 957#ifdef VMS
c77d647e 958 nm = p + 1; /* skip the terminator */
570d7624 959#else
c77d647e
JB
960 nm = p;
961#endif /* VMS */
962 }
e5d77022 963
c77d647e
JB
964 /* If we don't find a user of that name, leave the name
965 unchanged; don't move nm forward to p. */
966 }
967 }
570d7624
JB
968
969 if (nm[0] != '/'
970#ifdef VMS
971 && !index (nm, ':')
972#endif /* not VMS */
4c3c22f3
RS
973#ifdef MSDOS
974 && drive == -1
975#endif
570d7624
JB
976 && !newdir)
977 {
570d7624
JB
978 newdir = XSTRING (defalt)->data;
979 }
980
4c3c22f3
RS
981#ifdef MSDOS
982 if (newdir == 0 && relpath)
983 newdir = defdir;
984#endif
bfb61299
JB
985 if (newdir != 0)
986 {
987 /* Get rid of any slash at the end of newdir. */
988 int length = strlen (newdir);
eabf01d4
RS
989 /* Adding `length > 1 &&' makes ~ expand into / when homedir
990 is the root dir. People disagree about whether that is right.
991 Anyway, we can't take the risk of this change now. */
4c3c22f3
RS
992#ifdef MSDOS
993 if (newdir[1] != ':' && length > 1)
994#endif
eabf01d4 995 if (newdir[length - 1] == '/')
bfb61299
JB
996 {
997 unsigned char *temp = (unsigned char *) alloca (length);
998 bcopy (newdir, temp, length - 1);
999 temp[length - 1] = 0;
1000 newdir = temp;
1001 }
1002 tlen = length + 1;
1003 }
1004 else
1005 tlen = 0;
570d7624 1006
bfb61299
JB
1007 /* Now concatenate the directory and name to new space in the stack frame */
1008 tlen += strlen (nm) + 1;
4c3c22f3
RS
1009#ifdef MSDOS
1010 /* Add reserved space for drive name. */
1011 target = (unsigned char *) alloca (tlen + 2) + 2;
1012#else
570d7624 1013 target = (unsigned char *) alloca (tlen);
4c3c22f3 1014#endif
570d7624
JB
1015 *target = 0;
1016
1017 if (newdir)
1018 {
1019#ifndef VMS
1020 if (nm[0] == 0 || nm[0] == '/')
1021 strcpy (target, newdir);
1022 else
1023#endif
c77d647e 1024 file_name_as_directory (target, newdir);
570d7624
JB
1025 }
1026
1027 strcat (target, nm);
1028#ifdef VMS
1029 if (index (target, '/'))
1030 strcpy (target, sys_translate_unix (target));
1031#endif /* VMS */
1032
c77d647e 1033 /* Now canonicalize by removing /. and /foo/.. if they appear. */
570d7624
JB
1034
1035 p = target;
1036 o = target;
1037
1038 while (*p)
1039 {
1040#ifdef VMS
1041 if (*p != ']' && *p != '>' && *p != '-')
1042 {
1043 if (*p == '\\')
1044 p++;
1045 *o++ = *p++;
1046 }
1047 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1048 /* brackets are offset from each other by 2 */
1049 {
1050 p += 2;
1051 if (*p != '.' && *p != '-' && o[-1] != '.')
1052 /* convert [foo][bar] to [bar] */
1053 while (o[-1] != '[' && o[-1] != '<')
1054 o--;
1055 else if (*p == '-' && *o != '.')
1056 *--p = '.';
1057 }
1058 else if (p[0] == '-' && o[-1] == '.' &&
1059 (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1060 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1061 {
1062 do
1063 o--;
1064 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1065 if (p[1] == '.') /* foo.-.bar ==> bar*/
1066 p += 2;
1067 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1068 p++, o--;
1069 /* else [foo.-] ==> [-] */
1070 }
1071 else
1072 {
1073#ifndef VMS4_4
1074 if (*p == '-' &&
1075 o[-1] != '[' && o[-1] != '<' && o[-1] != '.' &&
1076 p[1] != ']' && p[1] != '>' && p[1] != '.')
1077 *p = '_';
1078#endif /* VMS4_4 */
1079 *o++ = *p++;
1080 }
1081#else /* not VMS */
1082 if (*p != '/')
1083 {
1084 *o++ = *p++;
1085 }
1086 else if (!strncmp (p, "//", 2)
1087#ifdef APOLLO
1088 /* // at start of filename is meaningful in Apollo system */
1089 && o != target
1090#endif /* APOLLO */
1091 )
1092 {
1093 o = target;
1094 p++;
1095 }
c77d647e
JB
1096 else if (p[0] == '/'
1097 && p[1] == '.'
1098 && (p[2] == '/'
1099 || p[2] == 0))
1100 {
1101 /* If "/." is the entire filename, keep the "/". Otherwise,
1102 just delete the whole "/.". */
1103 if (o == target && p[2] == '\0')
1104 *o++ = *p;
1105 p += 2;
1106 }
570d7624
JB
1107 else if (!strncmp (p, "/..", 3)
1108 /* `/../' is the "superroot" on certain file systems. */
1109 && o != target
1110 && (p[3] == '/' || p[3] == 0))
1111 {
1112 while (o != target && *--o != '/')
1113 ;
1114#ifdef APOLLO
1115 if (o == target + 1 && o[-1] == '/' && o[0] == '/')
1116 ++o;
1117 else
1118#endif /* APOLLO */
1119 if (o == target && *o == '/')
1120 ++o;
1121 p += 3;
1122 }
1123 else
1124 {
1125 *o++ = *p++;
1126 }
1127#endif /* not VMS */
1128 }
1129
4c3c22f3
RS
1130#ifdef MSDOS
1131 /* at last, set drive name. */
1132 if (target[1] != ':')
1133 {
1134 target -= 2;
1135 target[0] = (drive < 0 ? getdisk () : drive) + 'a';
1136 target[1] = ':';
1137 }
1138#endif
1139
570d7624
JB
1140 return make_string (target, o - target);
1141}
1142#if 0
e5d77022
JB
1143/* Changed this DEFUN to a DEAFUN, so as not to confuse `make-docfile'.
1144DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
570d7624
JB
1145 "Convert FILENAME to absolute, and canonicalize it.\n\
1146Second arg DEFAULT is directory to start with if FILENAME is relative\n\
1147 (does not start with slash); if DEFAULT is nil or missing,\n\
1148the current buffer's value of default-directory is used.\n\
1149Filenames containing `.' or `..' as components are simplified;\n\
1150initial `~/' expands to your home directory.\n\
1151See also the function `substitute-in-file-name'.")
1152 (name, defalt)
1153 Lisp_Object name, defalt;
1154{
1155 unsigned char *nm;
1156
1157 register unsigned char *newdir, *p, *o;
1158 int tlen;
1159 unsigned char *target;
1160 struct passwd *pw;
1161 int lose;
1162#ifdef VMS
1163 unsigned char * colon = 0;
1164 unsigned char * close = 0;
1165 unsigned char * slash = 0;
1166 unsigned char * brack = 0;
1167 int lbrack = 0, rbrack = 0;
1168 int dots = 0;
1169#endif /* VMS */
1170
1171 CHECK_STRING (name, 0);
1172
1173#ifdef VMS
1174 /* Filenames on VMS are always upper case. */
1175 name = Fupcase (name);
1176#endif
1177
1178 nm = XSTRING (name)->data;
1179
1180 /* If nm is absolute, flush ...// and detect /./ and /../.
1181 If no /./ or /../ we can return right away. */
1182 if (
1183 nm[0] == '/'
1184#ifdef VMS
1185 || index (nm, ':')
1186#endif /* VMS */
1187 )
1188 {
1189 p = nm;
1190 lose = 0;
1191 while (*p)
1192 {
1193 if (p[0] == '/' && p[1] == '/'
1194#ifdef APOLLO
1195 /* // at start of filename is meaningful on Apollo system */
1196 && nm != p
1197#endif /* APOLLO */
1198 )
1199 nm = p + 1;
1200 if (p[0] == '/' && p[1] == '~')
1201 nm = p + 1, lose = 1;
1202 if (p[0] == '/' && p[1] == '.'
1203 && (p[2] == '/' || p[2] == 0
1204 || (p[2] == '.' && (p[3] == '/' || p[3] == 0))))
1205 lose = 1;
1206#ifdef VMS
1207 if (p[0] == '\\')
1208 lose = 1;
1209 if (p[0] == '/') {
1210 /* if dev:[dir]/, move nm to / */
1211 if (!slash && p > nm && (brack || colon)) {
1212 nm = (brack ? brack + 1 : colon + 1);
1213 lbrack = rbrack = 0;
1214 brack = 0;
1215 colon = 0;
1216 }
1217 slash = p;
1218 }
1219 if (p[0] == '-')
1220#ifndef VMS4_4
1221 /* VMS pre V4.4,convert '-'s in filenames. */
1222 if (lbrack == rbrack)
1223 {
1224 if (dots < 2) /* this is to allow negative version numbers */
1225 p[0] = '_';
1226 }
1227 else
1228#endif /* VMS4_4 */
1229 if (lbrack > rbrack &&
1230 ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<') &&
1231 (p[1] == '.' || p[1] == ']' || p[1] == '>')))
1232 lose = 1;
1233#ifndef VMS4_4
1234 else
1235 p[0] = '_';
1236#endif /* VMS4_4 */
1237 /* count open brackets, reset close bracket pointer */
1238 if (p[0] == '[' || p[0] == '<')
1239 lbrack++, brack = 0;
1240 /* count close brackets, set close bracket pointer */
1241 if (p[0] == ']' || p[0] == '>')
1242 rbrack++, brack = p;
1243 /* detect ][ or >< */
1244 if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
1245 lose = 1;
1246 if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
1247 nm = p + 1, lose = 1;
1248 if (p[0] == ':' && (colon || slash))
1249 /* if dev1:[dir]dev2:, move nm to dev2: */
1250 if (brack)
1251 {
1252 nm = brack + 1;
1253 brack = 0;
1254 }
1255 /* if /pathname/dev:, move nm to dev: */
1256 else if (slash)
1257 nm = slash + 1;
1258 /* if node::dev:, move colon following dev */
1259 else if (colon && colon[-1] == ':')
1260 colon = p;
1261 /* if dev1:dev2:, move nm to dev2: */
1262 else if (colon && colon[-1] != ':')
1263 {
1264 nm = colon + 1;
1265 colon = 0;
1266 }
1267 if (p[0] == ':' && !colon)
1268 {
1269 if (p[1] == ':')
1270 p++;
1271 colon = p;
1272 }
1273 if (lbrack == rbrack)
1274 if (p[0] == ';')
1275 dots = 2;
1276 else if (p[0] == '.')
1277 dots++;
1278#endif /* VMS */
1279 p++;
1280 }
1281 if (!lose)
1282 {
1283#ifdef VMS
1284 if (index (nm, '/'))
1285 return build_string (sys_translate_unix (nm));
1286#endif /* VMS */
1287 if (nm == XSTRING (name)->data)
1288 return name;
1289 return build_string (nm);
1290 }
1291 }
1292
1293 /* Now determine directory to start with and put it in NEWDIR */
1294
1295 newdir = 0;
1296
1297 if (nm[0] == '~') /* prefix ~ */
1298 if (nm[1] == '/'
1299#ifdef VMS
1300 || nm[1] == ':'
1301#endif /* VMS */
1302 || nm[1] == 0)/* ~/filename */
1303 {
1304 if (!(newdir = (unsigned char *) egetenv ("HOME")))
1305 newdir = (unsigned char *) "";
1306 nm++;
1307#ifdef VMS
1308 nm++; /* Don't leave the slash in nm. */
1309#endif /* VMS */
1310 }
1311 else /* ~user/filename */
1312 {
1313 /* Get past ~ to user */
1314 unsigned char *user = nm + 1;
1315 /* Find end of name. */
1316 unsigned char *ptr = (unsigned char *) index (user, '/');
1317 int len = ptr ? ptr - user : strlen (user);
1318#ifdef VMS
1319 unsigned char *ptr1 = index (user, ':');
1320 if (ptr1 != 0 && ptr1 - user < len)
1321 len = ptr1 - user;
1322#endif /* VMS */
1323 /* Copy the user name into temp storage. */
1324 o = (unsigned char *) alloca (len + 1);
1325 bcopy ((char *) user, o, len);
1326 o[len] = 0;
1327
1328 /* Look up the user name. */
1329 pw = (struct passwd *) getpwnam (o + 1);
1330 if (!pw)
1331 error ("\"%s\" isn't a registered user", o + 1);
1332
1333 newdir = (unsigned char *) pw->pw_dir;
1334
1335 /* Discard the user name from NM. */
1336 nm += len;
1337 }
1338
1339 if (nm[0] != '/'
1340#ifdef VMS
1341 && !index (nm, ':')
1342#endif /* not VMS */
1343 && !newdir)
1344 {
265a9e55 1345 if (NILP (defalt))
570d7624
JB
1346 defalt = current_buffer->directory;
1347 CHECK_STRING (defalt, 1);
1348 newdir = XSTRING (defalt)->data;
1349 }
1350
1351 /* Now concatenate the directory and name to new space in the stack frame */
1352
1353 tlen = (newdir ? strlen (newdir) + 1 : 0) + strlen (nm) + 1;
1354 target = (unsigned char *) alloca (tlen);
1355 *target = 0;
1356
1357 if (newdir)
1358 {
1359#ifndef VMS
1360 if (nm[0] == 0 || nm[0] == '/')
1361 strcpy (target, newdir);
1362 else
1363#endif
1364 file_name_as_directory (target, newdir);
1365 }
1366
1367 strcat (target, nm);
1368#ifdef VMS
1369 if (index (target, '/'))
1370 strcpy (target, sys_translate_unix (target));
1371#endif /* VMS */
1372
1373 /* Now canonicalize by removing /. and /foo/.. if they appear */
1374
1375 p = target;
1376 o = target;
1377
1378 while (*p)
1379 {
1380#ifdef VMS
1381 if (*p != ']' && *p != '>' && *p != '-')
1382 {
1383 if (*p == '\\')
1384 p++;
1385 *o++ = *p++;
1386 }
1387 else if ((p[0] == ']' || p[0] == '>') && p[0] == p[1] + 2)
1388 /* brackets are offset from each other by 2 */
1389 {
1390 p += 2;
1391 if (*p != '.' && *p != '-' && o[-1] != '.')
1392 /* convert [foo][bar] to [bar] */
1393 while (o[-1] != '[' && o[-1] != '<')
1394 o--;
1395 else if (*p == '-' && *o != '.')
1396 *--p = '.';
1397 }
1398 else if (p[0] == '-' && o[-1] == '.' &&
1399 (p[1] == '.' || p[1] == ']' || p[1] == '>'))
1400 /* flush .foo.- ; leave - if stopped by '[' or '<' */
1401 {
1402 do
1403 o--;
1404 while (o[-1] != '.' && o[-1] != '[' && o[-1] != '<');
1405 if (p[1] == '.') /* foo.-.bar ==> bar*/
1406 p += 2;
1407 else if (o[-1] == '.') /* '.foo.-]' ==> ']' */
1408 p++, o--;
1409 /* else [foo.-] ==> [-] */
1410 }
1411 else
1412 {
1413#ifndef VMS4_4
1414 if (*p == '-' &&
1415 o[-1] != '[' && o[-1] != '<' && o[-1] != '.' &&
1416 p[1] != ']' && p[1] != '>' && p[1] != '.')
1417 *p = '_';
1418#endif /* VMS4_4 */
1419 *o++ = *p++;
1420 }
1421#else /* not VMS */
1422 if (*p != '/')
1423 {
1424 *o++ = *p++;
1425 }
1426 else if (!strncmp (p, "//", 2)
1427#ifdef APOLLO
1428 /* // at start of filename is meaningful in Apollo system */
1429 && o != target
1430#endif /* APOLLO */
1431 )
1432 {
1433 o = target;
1434 p++;
1435 }
1436 else if (p[0] == '/' && p[1] == '.' &&
1437 (p[2] == '/' || p[2] == 0))
1438 p += 2;
1439 else if (!strncmp (p, "/..", 3)
1440 /* `/../' is the "superroot" on certain file systems. */
1441 && o != target
1442 && (p[3] == '/' || p[3] == 0))
1443 {
1444 while (o != target && *--o != '/')
1445 ;
1446#ifdef APOLLO
1447 if (o == target + 1 && o[-1] == '/' && o[0] == '/')
1448 ++o;
1449 else
1450#endif /* APOLLO */
1451 if (o == target && *o == '/')
1452 ++o;
1453 p += 3;
1454 }
1455 else
1456 {
1457 *o++ = *p++;
1458 }
1459#endif /* not VMS */
1460 }
1461
1462 return make_string (target, o - target);
1463}
1464#endif
1465\f
1466DEFUN ("substitute-in-file-name", Fsubstitute_in_file_name,
1467 Ssubstitute_in_file_name, 1, 1, 0,
1468 "Substitute environment variables referred to in FILENAME.\n\
1469`$FOO' where FOO is an environment variable name means to substitute\n\
1470the value of that variable. The variable name should be terminated\n\
1471with a character not a letter, digit or underscore; otherwise, enclose\n\
1472the entire variable name in braces.\n\
1473If `/~' appears, all of FILENAME through that `/' is discarded.\n\n\
1474On VMS, `$' substitution is not done; this function does little and only\n\
1475duplicates what `expand-file-name' does.")
1476 (string)
1477 Lisp_Object string;
1478{
1479 unsigned char *nm;
1480
1481 register unsigned char *s, *p, *o, *x, *endp;
1482 unsigned char *target;
1483 int total = 0;
1484 int substituted = 0;
1485 unsigned char *xnm;
1486
1487 CHECK_STRING (string, 0);
1488
1489 nm = XSTRING (string)->data;
1490 endp = nm + XSTRING (string)->size;
1491
1492 /* If /~ or // appears, discard everything through first slash. */
1493
1494 for (p = nm; p != endp; p++)
1495 {
1496 if ((p[0] == '~' ||
1497#ifdef APOLLO
1498 /* // at start of file name is meaningful in Apollo system */
1499 (p[0] == '/' && p - 1 != nm)
1500#else /* not APOLLO */
1501 p[0] == '/'
1502#endif /* not APOLLO */
1503 )
1504 && p != nm &&
1505#ifdef VMS
1506 (p[-1] == ':' || p[-1] == ']' || p[-1] == '>' ||
1507#endif /* VMS */
1508 p[-1] == '/')
1509#ifdef VMS
1510 )
1511#endif /* VMS */
1512 {
1513 nm = p;
1514 substituted = 1;
1515 }
4c3c22f3
RS
1516#ifdef MSDOS
1517 if (p[0] && p[1] == ':')
1518 {
1519 nm = p;
1520 substituted = 1;
1521 }
1522#endif /* MSDOS */
570d7624
JB
1523 }
1524
1525#ifdef VMS
1526 return build_string (nm);
1527#else
1528
1529 /* See if any variables are substituted into the string
1530 and find the total length of their values in `total' */
1531
1532 for (p = nm; p != endp;)
1533 if (*p != '$')
1534 p++;
1535 else
1536 {
1537 p++;
1538 if (p == endp)
1539 goto badsubst;
1540 else if (*p == '$')
1541 {
1542 /* "$$" means a single "$" */
1543 p++;
1544 total -= 1;
1545 substituted = 1;
1546 continue;
1547 }
1548 else if (*p == '{')
1549 {
1550 o = ++p;
1551 while (p != endp && *p != '}') p++;
1552 if (*p != '}') goto missingclose;
1553 s = p;
1554 }
1555 else
1556 {
1557 o = p;
1558 while (p != endp && (isalnum (*p) || *p == '_')) p++;
1559 s = p;
1560 }
1561
1562 /* Copy out the variable name */
1563 target = (unsigned char *) alloca (s - o + 1);
1564 strncpy (target, o, s - o);
1565 target[s - o] = 0;
4c3c22f3
RS
1566#ifdef MSDOS
1567 strupr (target); /* $home == $HOME etc. */
1568#endif
570d7624
JB
1569
1570 /* Get variable value */
1571 o = (unsigned char *) egetenv (target);
570d7624
JB
1572 if (!o) goto badvar;
1573 total += strlen (o);
1574 substituted = 1;
1575 }
1576
1577 if (!substituted)
1578 return string;
1579
1580 /* If substitution required, recopy the string and do it */
1581 /* Make space in stack frame for the new copy */
1582 xnm = (unsigned char *) alloca (XSTRING (string)->size + total + 1);
1583 x = xnm;
1584
1585 /* Copy the rest of the name through, replacing $ constructs with values */
1586 for (p = nm; *p;)
1587 if (*p != '$')
1588 *x++ = *p++;
1589 else
1590 {
1591 p++;
1592 if (p == endp)
1593 goto badsubst;
1594 else if (*p == '$')
1595 {
1596 *x++ = *p++;
1597 continue;
1598 }
1599 else if (*p == '{')
1600 {
1601 o = ++p;
1602 while (p != endp && *p != '}') p++;
1603 if (*p != '}') goto missingclose;
1604 s = p++;
1605 }
1606 else
1607 {
1608 o = p;
1609 while (p != endp && (isalnum (*p) || *p == '_')) p++;
1610 s = p;
1611 }
1612
1613 /* Copy out the variable name */
1614 target = (unsigned char *) alloca (s - o + 1);
1615 strncpy (target, o, s - o);
1616 target[s - o] = 0;
4c3c22f3
RS
1617#ifdef MSDOS
1618 strupr (target); /* $home == $HOME etc. */
1619#endif
570d7624
JB
1620
1621 /* Get variable value */
1622 o = (unsigned char *) egetenv (target);
570d7624
JB
1623 if (!o)
1624 goto badvar;
1625
1626 strcpy (x, o);
1627 x += strlen (o);
1628 }
1629
1630 *x = 0;
1631
1632 /* If /~ or // appears, discard everything through first slash. */
1633
1634 for (p = xnm; p != x; p++)
1635 if ((p[0] == '~' ||
1636#ifdef APOLLO
1637 /* // at start of file name is meaningful in Apollo system */
1638 (p[0] == '/' && p - 1 != xnm)
1639#else /* not APOLLO */
1640 p[0] == '/'
1641#endif /* not APOLLO */
1642 )
1643 && p != nm && p[-1] == '/')
1644 xnm = p;
4c3c22f3
RS
1645#ifdef MSDOS
1646 else if (p[0] && p[1] == ':')
1647 xnm = p;
1648#endif
570d7624
JB
1649
1650 return make_string (xnm, x - xnm);
1651
1652 badsubst:
1653 error ("Bad format environment-variable substitution");
1654 missingclose:
1655 error ("Missing \"}\" in environment-variable substitution");
1656 badvar:
1657 error ("Substituting nonexistent environment variable \"%s\"", target);
1658
1659 /* NOTREACHED */
1660#endif /* not VMS */
1661}
1662\f
067ffa38 1663/* A slightly faster and more convenient way to get
298b760e 1664 (directory-file-name (expand-file-name FOO)). */
067ffa38 1665
570d7624
JB
1666Lisp_Object
1667expand_and_dir_to_file (filename, defdir)
1668 Lisp_Object filename, defdir;
1669{
1670 register Lisp_Object abspath;
1671
1672 abspath = Fexpand_file_name (filename, defdir);
1673#ifdef VMS
1674 {
1675 register int c = XSTRING (abspath)->data[XSTRING (abspath)->size - 1];
1676 if (c == ':' || c == ']' || c == '>')
1677 abspath = Fdirectory_file_name (abspath);
1678 }
1679#else
1680 /* Remove final slash, if any (unless path is root).
1681 stat behaves differently depending! */
1682 if (XSTRING (abspath)->size > 1
1683 && XSTRING (abspath)->data[XSTRING (abspath)->size - 1] == '/')
ddc61f46
RS
1684 /* We cannot take shortcuts; they might be wrong for magic file names. */
1685 abspath = Fdirectory_file_name (abspath);
570d7624
JB
1686#endif
1687 return abspath;
1688}
1689\f
1690barf_or_query_if_file_exists (absname, querystring, interactive)
1691 Lisp_Object absname;
1692 unsigned char *querystring;
1693 int interactive;
1694{
1695 register Lisp_Object tem;
1696 struct gcpro gcpro1;
1697
1698 if (access (XSTRING (absname)->data, 4) >= 0)
1699 {
1700 if (! interactive)
1701 Fsignal (Qfile_already_exists,
1702 Fcons (build_string ("File already exists"),
1703 Fcons (absname, Qnil)));
1704 GCPRO1 (absname);
1705 tem = do_yes_or_no_p (format1 ("File %s already exists; %s anyway? ",
1706 XSTRING (absname)->data, querystring));
1707 UNGCPRO;
265a9e55 1708 if (NILP (tem))
570d7624
JB
1709 Fsignal (Qfile_already_exists,
1710 Fcons (build_string ("File already exists"),
1711 Fcons (absname, Qnil)));
1712 }
1713 return;
1714}
1715
1716DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 4,
349a7710 1717 "fCopy file: \nFCopy %s to file: \np\nP",
570d7624
JB
1718 "Copy FILE to NEWNAME. Both args must be strings.\n\
1719Signals a `file-already-exists' error if file NEWNAME already exists,\n\
1720unless a third argument OK-IF-ALREADY-EXISTS is supplied and non-nil.\n\
1721A number as third arg means request confirmation if NEWNAME already exists.\n\
1722This is what happens in interactive use with M-x.\n\
349a7710
JB
1723Fourth arg KEEP-TIME non-nil means give the new file the same\n\
1724last-modified time as the old one. (This works on only some systems.)\n\
1725A prefix arg makes KEEP-TIME non-nil.")
570d7624
JB
1726 (filename, newname, ok_if_already_exists, keep_date)
1727 Lisp_Object filename, newname, ok_if_already_exists, keep_date;
1728{
1729 int ifd, ofd, n;
1730 char buf[16 * 1024];
1731 struct stat st;
32f4334d 1732 Lisp_Object handler;
570d7624 1733 struct gcpro gcpro1, gcpro2;
b5148e85 1734 int count = specpdl_ptr - specpdl;
51cf6d37 1735 Lisp_Object args[6];
f73b0ada 1736 int input_file_statable_p;
570d7624
JB
1737
1738 GCPRO2 (filename, newname);
1739 CHECK_STRING (filename, 0);
1740 CHECK_STRING (newname, 1);
1741 filename = Fexpand_file_name (filename, Qnil);
1742 newname = Fexpand_file_name (newname, Qnil);
32f4334d 1743
0bf2eed2 1744 /* If the input file name has special constructs in it,
32f4334d 1745 call the corresponding file handler. */
49307295 1746 handler = Ffind_file_name_handler (filename, Qcopy_file);
0bf2eed2 1747 /* Likewise for output file name. */
51cf6d37 1748 if (NILP (handler))
49307295 1749 handler = Ffind_file_name_handler (newname, Qcopy_file);
32f4334d 1750 if (!NILP (handler))
36712b0a
KH
1751 RETURN_UNGCPRO (call5 (handler, Qcopy_file, filename, newname,
1752 ok_if_already_exists, keep_date));
32f4334d 1753
265a9e55 1754 if (NILP (ok_if_already_exists)
570d7624
JB
1755 || XTYPE (ok_if_already_exists) == Lisp_Int)
1756 barf_or_query_if_file_exists (newname, "copy to it",
1757 XTYPE (ok_if_already_exists) == Lisp_Int);
1758
1759 ifd = open (XSTRING (filename)->data, 0);
1760 if (ifd < 0)
1761 report_file_error ("Opening input file", Fcons (filename, Qnil));
1762
b5148e85
RS
1763 record_unwind_protect (close_file_unwind, make_number (ifd));
1764
f73b0ada
BF
1765 /* We can only copy regular files and symbolic links. Other files are not
1766 copyable by us. */
1767 input_file_statable_p = (fstat (ifd, &st) >= 0);
1768
1769#if defined (S_ISREG) && defined (S_ISLNK)
1770 if (input_file_statable_p)
1771 {
1772 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
1773 {
1774#if defined (EISDIR)
1775 /* Get a better looking error message. */
1776 errno = EISDIR;
1777#endif /* EISDIR */
1778 report_file_error ("Non-regular file", Fcons (filename, Qnil));
1779 }
1780 }
1781#endif /* S_ISREG && S_ISLNK */
1782
570d7624
JB
1783#ifdef VMS
1784 /* Create the copy file with the same record format as the input file */
1785 ofd = sys_creat (XSTRING (newname)->data, 0666, ifd);
1786#else
4c3c22f3
RS
1787#ifdef MSDOS
1788 /* System's default file type was set to binary by _fmode in emacs.c. */
1789 ofd = creat (XSTRING (newname)->data, S_IREAD | S_IWRITE);
1790#else /* not MSDOS */
570d7624 1791 ofd = creat (XSTRING (newname)->data, 0666);
4c3c22f3 1792#endif /* not MSDOS */
570d7624
JB
1793#endif /* VMS */
1794 if (ofd < 0)
66331187 1795 report_file_error ("Opening output file", Fcons (newname, Qnil));
b5148e85
RS
1796
1797 record_unwind_protect (close_file_unwind, make_number (ofd));
570d7624 1798
b5148e85
RS
1799 immediate_quit = 1;
1800 QUIT;
570d7624
JB
1801 while ((n = read (ifd, buf, sizeof buf)) > 0)
1802 if (write (ofd, buf, n) != n)
66331187 1803 report_file_error ("I/O error", Fcons (newname, Qnil));
b5148e85 1804 immediate_quit = 0;
570d7624 1805
f73b0ada 1806 if (input_file_statable_p)
570d7624 1807 {
265a9e55 1808 if (!NILP (keep_date))
570d7624 1809 {
de5bf5d3
JB
1810 EMACS_TIME atime, mtime;
1811 EMACS_SET_SECS_USECS (atime, st.st_atime, 0);
1812 EMACS_SET_SECS_USECS (mtime, st.st_mtime, 0);
1813 EMACS_SET_UTIMES (XSTRING (newname)->data, atime, mtime);
570d7624 1814 }
570d7624
JB
1815#ifdef APOLLO
1816 if (!egetenv ("USE_DOMAIN_ACLS"))
1817#endif
de5bf5d3 1818 chmod (XSTRING (newname)->data, st.st_mode & 07777);
570d7624
JB
1819 }
1820
b5148e85
RS
1821 /* Discard the unwind protects. */
1822 specpdl_ptr = specpdl + count;
1823
570d7624
JB
1824 close (ifd);
1825 if (close (ofd) < 0)
1826 report_file_error ("I/O error", Fcons (newname, Qnil));
1827
1828 UNGCPRO;
1829 return Qnil;
1830}
1831
9bbe01fb 1832DEFUN ("make-directory-internal", Fmake_directory_internal,
353cfc19 1833 Smake_directory_internal, 1, 1, 0,
570d7624
JB
1834 "Create a directory. One argument, a file name string.")
1835 (dirname)
1836 Lisp_Object dirname;
1837{
1838 unsigned char *dir;
32f4334d 1839 Lisp_Object handler;
570d7624
JB
1840
1841 CHECK_STRING (dirname, 0);
1842 dirname = Fexpand_file_name (dirname, Qnil);
32f4334d 1843
49307295 1844 handler = Ffind_file_name_handler (dirname, Qmake_directory);
32f4334d 1845 if (!NILP (handler))
9bbe01fb
RS
1846 return call3 (handler, Qmake_directory, dirname, Qnil);
1847
570d7624
JB
1848 dir = XSTRING (dirname)->data;
1849
1850 if (mkdir (dir, 0777) != 0)
1851 report_file_error ("Creating directory", Flist (1, &dirname));
1852
32f4334d 1853 return Qnil;
570d7624
JB
1854}
1855
aa734e17
RS
1856DEFUN ("delete-directory", Fdelete_directory, Sdelete_directory, 1, 1, "FDelete directory: ",
1857 "Delete a directory. One argument, a file name string.")
570d7624
JB
1858 (dirname)
1859 Lisp_Object dirname;
1860{
1861 unsigned char *dir;
32f4334d 1862 Lisp_Object handler;
570d7624
JB
1863
1864 CHECK_STRING (dirname, 0);
1865 dirname = Fexpand_file_name (dirname, Qnil);
1866 dir = XSTRING (dirname)->data;
1867
49307295 1868 handler = Ffind_file_name_handler (dirname, Qdelete_directory);
32f4334d
RS
1869 if (!NILP (handler))
1870 return call2 (handler, Qdelete_directory, dirname);
1871
570d7624
JB
1872 if (rmdir (dir) != 0)
1873 report_file_error ("Removing directory", Flist (1, &dirname));
1874
1875 return Qnil;
1876}
1877
1878DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 1, "fDelete file: ",
1879 "Delete specified file. One argument, a file name string.\n\
1880If file has multiple names, it continues to exist with the other names.")
1881 (filename)
1882 Lisp_Object filename;
1883{
32f4334d 1884 Lisp_Object handler;
570d7624
JB
1885 CHECK_STRING (filename, 0);
1886 filename = Fexpand_file_name (filename, Qnil);
32f4334d 1887
49307295 1888 handler = Ffind_file_name_handler (filename, Qdelete_file);
32f4334d
RS
1889 if (!NILP (handler))
1890 return call2 (handler, Qdelete_file, filename);
1891
570d7624
JB
1892 if (0 > unlink (XSTRING (filename)->data))
1893 report_file_error ("Removing old name", Flist (1, &filename));
1894 return Qnil;
1895}
1896
1897DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
1898 "fRename file: \nFRename %s to file: \np",
1899 "Rename FILE as NEWNAME. Both args strings.\n\
1900If file has names other than FILE, it continues to have those names.\n\
1901Signals a `file-already-exists' error if a file NEWNAME already exists\n\
1902unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.\n\
1903A number as third arg means request confirmation if NEWNAME already exists.\n\
1904This is what happens in interactive use with M-x.")
1905 (filename, newname, ok_if_already_exists)
1906 Lisp_Object filename, newname, ok_if_already_exists;
1907{
1908#ifdef NO_ARG_ARRAY
1909 Lisp_Object args[2];
1910#endif
32f4334d 1911 Lisp_Object handler;
570d7624
JB
1912 struct gcpro gcpro1, gcpro2;
1913
1914 GCPRO2 (filename, newname);
1915 CHECK_STRING (filename, 0);
1916 CHECK_STRING (newname, 1);
1917 filename = Fexpand_file_name (filename, Qnil);
1918 newname = Fexpand_file_name (newname, Qnil);
32f4334d
RS
1919
1920 /* If the file name has special constructs in it,
1921 call the corresponding file handler. */
49307295 1922 handler = Ffind_file_name_handler (filename, Qrename_file);
51cf6d37 1923 if (NILP (handler))
49307295 1924 handler = Ffind_file_name_handler (newname, Qrename_file);
32f4334d 1925 if (!NILP (handler))
36712b0a
KH
1926 RETURN_UNGCPRO (call4 (handler, Qrename_file,
1927 filename, newname, ok_if_already_exists));
32f4334d 1928
265a9e55 1929 if (NILP (ok_if_already_exists)
570d7624
JB
1930 || XTYPE (ok_if_already_exists) == Lisp_Int)
1931 barf_or_query_if_file_exists (newname, "rename to it",
1932 XTYPE (ok_if_already_exists) == Lisp_Int);
1933#ifndef BSD4_1
1934 if (0 > rename (XSTRING (filename)->data, XSTRING (newname)->data))
1935#else
1936 if (0 > link (XSTRING (filename)->data, XSTRING (newname)->data)
1937 || 0 > unlink (XSTRING (filename)->data))
1938#endif
1939 {
1940 if (errno == EXDEV)
1941 {
d093c3ac
RM
1942 Fcopy_file (filename, newname,
1943 /* We have already prompted if it was an integer,
1944 so don't have copy-file prompt again. */
1945 NILP (ok_if_already_exists) ? Qnil : Qt, Qt);
570d7624
JB
1946 Fdelete_file (filename);
1947 }
1948 else
1949#ifdef NO_ARG_ARRAY
1950 {
1951 args[0] = filename;
1952 args[1] = newname;
1953 report_file_error ("Renaming", Flist (2, args));
1954 }
1955#else
1956 report_file_error ("Renaming", Flist (2, &filename));
1957#endif
1958 }
1959 UNGCPRO;
1960 return Qnil;
1961}
1962
1963DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
1964 "fAdd name to file: \nFName to add to %s: \np",
1965 "Give FILE additional name NEWNAME. Both args strings.\n\
1966Signals a `file-already-exists' error if a file NEWNAME already exists\n\
1967unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.\n\
1968A number as third arg means request confirmation if NEWNAME already exists.\n\
1969This is what happens in interactive use with M-x.")
1970 (filename, newname, ok_if_already_exists)
1971 Lisp_Object filename, newname, ok_if_already_exists;
1972{
1973#ifdef NO_ARG_ARRAY
1974 Lisp_Object args[2];
1975#endif
32f4334d 1976 Lisp_Object handler;
570d7624
JB
1977 struct gcpro gcpro1, gcpro2;
1978
1979 GCPRO2 (filename, newname);
1980 CHECK_STRING (filename, 0);
1981 CHECK_STRING (newname, 1);
1982 filename = Fexpand_file_name (filename, Qnil);
1983 newname = Fexpand_file_name (newname, Qnil);
32f4334d
RS
1984
1985 /* If the file name has special constructs in it,
1986 call the corresponding file handler. */
49307295 1987 handler = Ffind_file_name_handler (filename, Qadd_name_to_file);
32f4334d 1988 if (!NILP (handler))
36712b0a
KH
1989 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, filename,
1990 newname, ok_if_already_exists));
32f4334d 1991
265a9e55 1992 if (NILP (ok_if_already_exists)
570d7624
JB
1993 || XTYPE (ok_if_already_exists) == Lisp_Int)
1994 barf_or_query_if_file_exists (newname, "make it a new name",
1995 XTYPE (ok_if_already_exists) == Lisp_Int);
1996 unlink (XSTRING (newname)->data);
1997 if (0 > link (XSTRING (filename)->data, XSTRING (newname)->data))
1998 {
1999#ifdef NO_ARG_ARRAY
2000 args[0] = filename;
2001 args[1] = newname;
2002 report_file_error ("Adding new name", Flist (2, args));
2003#else
2004 report_file_error ("Adding new name", Flist (2, &filename));
2005#endif
2006 }
2007
2008 UNGCPRO;
2009 return Qnil;
2010}
2011
2012#ifdef S_IFLNK
2013DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2014 "FMake symbolic link to file: \nFMake symbolic link to file %s: \np",
2015 "Make a symbolic link to FILENAME, named LINKNAME. Both args strings.\n\
2016Signals a `file-already-exists' error if a file NEWNAME already exists\n\
2017unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.\n\
2018A number as third arg means request confirmation if NEWNAME already exists.\n\
2019This happens for interactive use with M-x.")
e5d77022
JB
2020 (filename, linkname, ok_if_already_exists)
2021 Lisp_Object filename, linkname, ok_if_already_exists;
570d7624
JB
2022{
2023#ifdef NO_ARG_ARRAY
2024 Lisp_Object args[2];
2025#endif
32f4334d 2026 Lisp_Object handler;
570d7624
JB
2027 struct gcpro gcpro1, gcpro2;
2028
e5d77022 2029 GCPRO2 (filename, linkname);
570d7624 2030 CHECK_STRING (filename, 0);
e5d77022 2031 CHECK_STRING (linkname, 1);
d9bc1c99
RS
2032 /* If the link target has a ~, we must expand it to get
2033 a truly valid file name. Otherwise, do not expand;
2034 we want to permit links to relative file names. */
2035 if (XSTRING (filename)->data[0] == '~')
2036 filename = Fexpand_file_name (filename, Qnil);
e5d77022 2037 linkname = Fexpand_file_name (linkname, Qnil);
32f4334d
RS
2038
2039 /* If the file name has special constructs in it,
2040 call the corresponding file handler. */
49307295 2041 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
32f4334d 2042 if (!NILP (handler))
36712b0a
KH
2043 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2044 linkname, ok_if_already_exists));
32f4334d 2045
265a9e55 2046 if (NILP (ok_if_already_exists)
570d7624 2047 || XTYPE (ok_if_already_exists) == Lisp_Int)
e5d77022 2048 barf_or_query_if_file_exists (linkname, "make it a link",
570d7624 2049 XTYPE (ok_if_already_exists) == Lisp_Int);
e5d77022 2050 if (0 > symlink (XSTRING (filename)->data, XSTRING (linkname)->data))
570d7624
JB
2051 {
2052 /* If we didn't complain already, silently delete existing file. */
2053 if (errno == EEXIST)
2054 {
9083124b 2055 unlink (XSTRING (linkname)->data);
e5d77022 2056 if (0 <= symlink (XSTRING (filename)->data, XSTRING (linkname)->data))
570d7624
JB
2057 return Qnil;
2058 }
2059
2060#ifdef NO_ARG_ARRAY
2061 args[0] = filename;
e5d77022 2062 args[1] = linkname;
570d7624
JB
2063 report_file_error ("Making symbolic link", Flist (2, args));
2064#else
2065 report_file_error ("Making symbolic link", Flist (2, &filename));
2066#endif
2067 }
2068 UNGCPRO;
2069 return Qnil;
2070}
2071#endif /* S_IFLNK */
2072
2073#ifdef VMS
2074
2075DEFUN ("define-logical-name", Fdefine_logical_name, Sdefine_logical_name,
2076 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2077 "Define the job-wide logical name NAME to have the value STRING.\n\
2078If STRING is nil or a null string, the logical name NAME is deleted.")
2079 (varname, string)
2080 Lisp_Object varname;
2081 Lisp_Object string;
2082{
2083 CHECK_STRING (varname, 0);
265a9e55 2084 if (NILP (string))
570d7624
JB
2085 delete_logical_name (XSTRING (varname)->data);
2086 else
2087 {
2088 CHECK_STRING (string, 1);
2089
2090 if (XSTRING (string)->size == 0)
2091 delete_logical_name (XSTRING (varname)->data);
2092 else
2093 define_logical_name (XSTRING (varname)->data, XSTRING (string)->data);
2094 }
2095
2096 return string;
2097}
2098#endif /* VMS */
2099
2100#ifdef HPUX_NET
2101
2102DEFUN ("sysnetunam", Fsysnetunam, Ssysnetunam, 2, 2, 0,
2103 "Open a network connection to PATH using LOGIN as the login string.")
2104 (path, login)
2105 Lisp_Object path, login;
2106{
2107 int netresult;
2108
2109 CHECK_STRING (path, 0);
2110 CHECK_STRING (login, 0);
2111
2112 netresult = netunam (XSTRING (path)->data, XSTRING (login)->data);
2113
2114 if (netresult == -1)
2115 return Qnil;
2116 else
2117 return Qt;
2118}
2119#endif /* HPUX_NET */
2120\f
2121DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
2122 1, 1, 0,
2123 "Return t if file FILENAME specifies an absolute path name.\n\
2124On Unix, this is a name starting with a `/' or a `~'.")
2125 (filename)
2126 Lisp_Object filename;
2127{
2128 unsigned char *ptr;
2129
2130 CHECK_STRING (filename, 0);
2131 ptr = XSTRING (filename)->data;
2132 if (*ptr == '/' || *ptr == '~'
2133#ifdef VMS
2134/* ??? This criterion is probably wrong for '<'. */
2135 || index (ptr, ':') || index (ptr, '<')
2136 || (*ptr == '[' && (ptr[1] != '-' || (ptr[2] != '.' && ptr[2] != ']'))
2137 && ptr[1] != '.')
2138#endif /* VMS */
4c3c22f3
RS
2139#ifdef MSDOS
2140 || (*ptr != 0 && ptr[1] == ':' && ptr[2] == '/')
2141#endif
570d7624
JB
2142 )
2143 return Qt;
2144 else
2145 return Qnil;
2146}
2147
2148DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
2149 "Return t if file FILENAME exists. (This does not mean you can read it.)\n\
2150See also `file-readable-p' and `file-attributes'.")
2151 (filename)
2152 Lisp_Object filename;
2153{
2154 Lisp_Object abspath;
32f4334d 2155 Lisp_Object handler;
570d7624
JB
2156
2157 CHECK_STRING (filename, 0);
2158 abspath = Fexpand_file_name (filename, Qnil);
32f4334d
RS
2159
2160 /* If the file name has special constructs in it,
2161 call the corresponding file handler. */
49307295 2162 handler = Ffind_file_name_handler (abspath, Qfile_exists_p);
32f4334d 2163 if (!NILP (handler))
09121adc 2164 return call2 (handler, Qfile_exists_p, abspath);
32f4334d 2165
570d7624
JB
2166 return (access (XSTRING (abspath)->data, 0) >= 0) ? Qt : Qnil;
2167}
2168
2169DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
2170 "Return t if FILENAME can be executed by you.\n\
8b235fde 2171For a directory, this means you can access files in that directory.")
570d7624
JB
2172 (filename)
2173 Lisp_Object filename;
2174
2175{
2176 Lisp_Object abspath;
32f4334d 2177 Lisp_Object handler;
570d7624
JB
2178
2179 CHECK_STRING (filename, 0);
2180 abspath = Fexpand_file_name (filename, Qnil);
32f4334d
RS
2181
2182 /* If the file name has special constructs in it,
2183 call the corresponding file handler. */
49307295 2184 handler = Ffind_file_name_handler (abspath, Qfile_executable_p);
32f4334d 2185 if (!NILP (handler))
09121adc 2186 return call2 (handler, Qfile_executable_p, abspath);
32f4334d 2187
570d7624
JB
2188 return (access (XSTRING (abspath)->data, 1) >= 0) ? Qt : Qnil;
2189}
2190
2191DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
2192 "Return t if file FILENAME exists and you can read it.\n\
2193See also `file-exists-p' and `file-attributes'.")
2194 (filename)
2195 Lisp_Object filename;
2196{
2197 Lisp_Object abspath;
32f4334d 2198 Lisp_Object handler;
570d7624
JB
2199
2200 CHECK_STRING (filename, 0);
2201 abspath = Fexpand_file_name (filename, Qnil);
32f4334d
RS
2202
2203 /* If the file name has special constructs in it,
2204 call the corresponding file handler. */
49307295 2205 handler = Ffind_file_name_handler (abspath, Qfile_readable_p);
32f4334d 2206 if (!NILP (handler))
09121adc 2207 return call2 (handler, Qfile_readable_p, abspath);
32f4334d 2208
570d7624
JB
2209 return (access (XSTRING (abspath)->data, 4) >= 0) ? Qt : Qnil;
2210}
2211
2212DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
89de89c7
RS
2213 "Return non-nil if file FILENAME is the name of a symbolic link.\n\
2214The value is the name of the file to which it is linked.\n\
2215Otherwise returns nil.")
570d7624
JB
2216 (filename)
2217 Lisp_Object filename;
2218{
2219#ifdef S_IFLNK
2220 char *buf;
2221 int bufsize;
2222 int valsize;
2223 Lisp_Object val;
32f4334d 2224 Lisp_Object handler;
570d7624
JB
2225
2226 CHECK_STRING (filename, 0);
2227 filename = Fexpand_file_name (filename, Qnil);
2228
32f4334d
RS
2229 /* If the file name has special constructs in it,
2230 call the corresponding file handler. */
49307295 2231 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
32f4334d
RS
2232 if (!NILP (handler))
2233 return call2 (handler, Qfile_symlink_p, filename);
2234
570d7624
JB
2235 bufsize = 100;
2236 while (1)
2237 {
2238 buf = (char *) xmalloc (bufsize);
2239 bzero (buf, bufsize);
2240 valsize = readlink (XSTRING (filename)->data, buf, bufsize);
2241 if (valsize < bufsize) break;
2242 /* Buffer was not long enough */
9ac0d9e0 2243 xfree (buf);
570d7624
JB
2244 bufsize *= 2;
2245 }
2246 if (valsize == -1)
2247 {
9ac0d9e0 2248 xfree (buf);
570d7624
JB
2249 return Qnil;
2250 }
2251 val = make_string (buf, valsize);
9ac0d9e0 2252 xfree (buf);
570d7624
JB
2253 return val;
2254#else /* not S_IFLNK */
2255 return Qnil;
2256#endif /* not S_IFLNK */
2257}
2258
a253bab2
JB
2259#ifdef SOLARIS_BROKEN_ACCESS
2260/* In Solaris 2.1, the readonly-ness of the filesystem is not
2261 considered by the access system call. This is Sun's bug, but we
2262 still have to make Emacs work. */
2263
2264#include <sys/statvfs.h>
2265
2266static int
2267ro_fsys (path)
2268 char *path;
2269{
2270 struct statvfs statvfsb;
2271
2272 if (statvfs(path, &statvfsb))
2273 return 1; /* error from statvfs, be conservative and say not wrtable */
2274 else
2275 /* Otherwise, fsys is ro if bit is set. */
2276 return statvfsb.f_flag & ST_RDONLY;
2277}
2278#else
2279/* But on every other os, access has already done the right thing. */
2280#define ro_fsys(path) 0
2281#endif
2282
570d7624
JB
2283/* Having this before file-symlink-p mysteriously caused it to be forgotten
2284 on the RT/PC. */
2285DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
2286 "Return t if file FILENAME can be written or created by you.")
2287 (filename)
2288 Lisp_Object filename;
2289{
2290 Lisp_Object abspath, dir;
32f4334d 2291 Lisp_Object handler;
570d7624
JB
2292
2293 CHECK_STRING (filename, 0);
2294 abspath = Fexpand_file_name (filename, Qnil);
32f4334d
RS
2295
2296 /* If the file name has special constructs in it,
2297 call the corresponding file handler. */
49307295 2298 handler = Ffind_file_name_handler (abspath, Qfile_writable_p);
32f4334d 2299 if (!NILP (handler))
09121adc 2300 return call2 (handler, Qfile_writable_p, abspath);
32f4334d 2301
570d7624 2302 if (access (XSTRING (abspath)->data, 0) >= 0)
a253bab2 2303 return ((access (XSTRING (abspath)->data, 2) >= 0
e7c7295c 2304 && ! ro_fsys ((char *) XSTRING (abspath)->data))
a253bab2 2305 ? Qt : Qnil);
570d7624
JB
2306 dir = Ffile_name_directory (abspath);
2307#ifdef VMS
265a9e55 2308 if (!NILP (dir))
570d7624
JB
2309 dir = Fdirectory_file_name (dir);
2310#endif /* VMS */
4c3c22f3
RS
2311#ifdef MSDOS
2312 if (!NILP (dir))
2313 dir = Fdirectory_file_name (dir);
2314#endif /* MSDOS */
a253bab2 2315 return ((access (!NILP (dir) ? (char *) XSTRING (dir)->data : "", 2) >= 0
e7c7295c 2316 && ! ro_fsys ((char *) XSTRING (dir)->data))
570d7624
JB
2317 ? Qt : Qnil);
2318}
2319
2320DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
2321 "Return t if file FILENAME is the name of a directory as a file.\n\
2322A directory name spec may be given instead; then the value is t\n\
2323if the directory so specified exists and really is a directory.")
2324 (filename)
2325 Lisp_Object filename;
2326{
2327 register Lisp_Object abspath;
2328 struct stat st;
32f4334d 2329 Lisp_Object handler;
570d7624
JB
2330
2331 abspath = expand_and_dir_to_file (filename, current_buffer->directory);
2332
32f4334d
RS
2333 /* If the file name has special constructs in it,
2334 call the corresponding file handler. */
49307295 2335 handler = Ffind_file_name_handler (abspath, Qfile_directory_p);
32f4334d 2336 if (!NILP (handler))
09121adc 2337 return call2 (handler, Qfile_directory_p, abspath);
32f4334d 2338
570d7624
JB
2339 if (stat (XSTRING (abspath)->data, &st) < 0)
2340 return Qnil;
2341 return (st.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
2342}
2343
b72dea2a
JB
2344DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0,
2345 "Return t if file FILENAME is the name of a directory as a file,\n\
2346and files in that directory can be opened by you. In order to use a\n\
2347directory as a buffer's current directory, this predicate must return true.\n\
2348A directory name spec may be given instead; then the value is t\n\
2349if the directory so specified exists and really is a readable and\n\
2350searchable directory.")
2351 (filename)
2352 Lisp_Object filename;
2353{
32f4334d
RS
2354 Lisp_Object handler;
2355
2356 /* If the file name has special constructs in it,
2357 call the corresponding file handler. */
49307295 2358 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
32f4334d
RS
2359 if (!NILP (handler))
2360 return call2 (handler, Qfile_accessible_directory_p, filename);
2361
b72dea2a
JB
2362 if (NILP (Ffile_directory_p (filename))
2363 || NILP (Ffile_executable_p (filename)))
2364 return Qnil;
2365 else
2366 return Qt;
2367}
2368
570d7624
JB
2369DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
2370 "Return mode bits of FILE, as an integer.")
2371 (filename)
2372 Lisp_Object filename;
2373{
2374 Lisp_Object abspath;
2375 struct stat st;
32f4334d 2376 Lisp_Object handler;
570d7624
JB
2377
2378 abspath = expand_and_dir_to_file (filename, current_buffer->directory);
2379
32f4334d
RS
2380 /* If the file name has special constructs in it,
2381 call the corresponding file handler. */
49307295 2382 handler = Ffind_file_name_handler (abspath, Qfile_modes);
32f4334d 2383 if (!NILP (handler))
09121adc 2384 return call2 (handler, Qfile_modes, abspath);
32f4334d 2385
570d7624
JB
2386 if (stat (XSTRING (abspath)->data, &st) < 0)
2387 return Qnil;
3ace87e3
KH
2388#ifdef MSDOS
2389 {
2390 int len;
2391 char *suffix;
2392 if (S_ISREG (st.st_mode)
2393 && (len = XSTRING (abspath)->size) >= 5
2394 && (stricmp ((suffix = XSTRING (abspath)->data + len-4), ".com") == 0
2395 || stricmp (suffix, ".exe") == 0
2396 || stricmp (suffix, ".bat") == 0))
2397 st.st_mode |= S_IEXEC;
2398 }
2399#endif /* MSDOS */
2400
570d7624
JB
2401 return make_number (st.st_mode & 07777);
2402}
2403
2404DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2, 0,
2405 "Set mode bits of FILE to MODE (an integer).\n\
2406Only the 12 low bits of MODE are used.")
2407 (filename, mode)
2408 Lisp_Object filename, mode;
2409{
2410 Lisp_Object abspath;
32f4334d 2411 Lisp_Object handler;
570d7624
JB
2412
2413 abspath = Fexpand_file_name (filename, current_buffer->directory);
2414 CHECK_NUMBER (mode, 1);
2415
32f4334d
RS
2416 /* If the file name has special constructs in it,
2417 call the corresponding file handler. */
49307295 2418 handler = Ffind_file_name_handler (abspath, Qset_file_modes);
32f4334d 2419 if (!NILP (handler))
09121adc 2420 return call3 (handler, Qset_file_modes, abspath, mode);
32f4334d 2421
570d7624
JB
2422#ifndef APOLLO
2423 if (chmod (XSTRING (abspath)->data, XINT (mode)) < 0)
2424 report_file_error ("Doing chmod", Fcons (abspath, Qnil));
2425#else /* APOLLO */
2426 if (!egetenv ("USE_DOMAIN_ACLS"))
2427 {
2428 struct stat st;
2429 struct timeval tvp[2];
2430
2431 /* chmod on apollo also change the file's modtime; need to save the
2432 modtime and then restore it. */
2433 if (stat (XSTRING (abspath)->data, &st) < 0)
2434 {
2435 report_file_error ("Doing chmod", Fcons (abspath, Qnil));
2436 return (Qnil);
2437 }
2438
2439 if (chmod (XSTRING (abspath)->data, XINT (mode)) < 0)
2440 report_file_error ("Doing chmod", Fcons (abspath, Qnil));
2441
2442 /* reset the old accessed and modified times. */
2443 tvp[0].tv_sec = st.st_atime + 1; /* +1 due to an Apollo roundoff bug */
2444 tvp[0].tv_usec = 0;
2445 tvp[1].tv_sec = st.st_mtime + 1; /* +1 due to an Apollo roundoff bug */
2446 tvp[1].tv_usec = 0;
2447
2448 if (utimes (XSTRING (abspath)->data, tvp) < 0)
2449 report_file_error ("Doing utimes", Fcons (abspath, Qnil));
2450 }
2451#endif /* APOLLO */
2452
2453 return Qnil;
2454}
2455
c24e9a53 2456DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
5f85ea58
RS
2457 "Set the file permission bits for newly created files.\n\
2458The argument MODE should be an integer; only the low 9 bits are used.\n\
36a8c287 2459This setting is inherited by subprocesses.")
5f85ea58
RS
2460 (mode)
2461 Lisp_Object mode;
36a8c287 2462{
5f85ea58 2463 CHECK_NUMBER (mode, 0);
36a8c287 2464
5f85ea58 2465 umask ((~ XINT (mode)) & 0777);
36a8c287
JB
2466
2467 return Qnil;
2468}
2469
c24e9a53 2470DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
5f85ea58
RS
2471 "Return the default file protection for created files.\n\
2472The value is an integer.")
36a8c287
JB
2473 ()
2474{
5f85ea58
RS
2475 int realmask;
2476 Lisp_Object value;
36a8c287 2477
5f85ea58
RS
2478 realmask = umask (0);
2479 umask (realmask);
36a8c287 2480
5f85ea58
RS
2481 XSET (value, Lisp_Int, (~ realmask) & 0777);
2482 return value;
36a8c287
JB
2483}
2484
85ffea93
RS
2485#ifdef unix
2486
2487DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
2488 "Tell Unix to finish all pending disk updates.")
2489 ()
2490{
2491 sync ();
2492 return Qnil;
2493}
2494
2495#endif /* unix */
2496
570d7624
JB
2497DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
2498 "Return t if file FILE1 is newer than file FILE2.\n\
2499If FILE1 does not exist, the answer is nil;\n\
2500otherwise, if FILE2 does not exist, the answer is t.")
2501 (file1, file2)
2502 Lisp_Object file1, file2;
2503{
32f4334d 2504 Lisp_Object abspath1, abspath2;
570d7624
JB
2505 struct stat st;
2506 int mtime1;
32f4334d 2507 Lisp_Object handler;
09121adc 2508 struct gcpro gcpro1, gcpro2;
570d7624
JB
2509
2510 CHECK_STRING (file1, 0);
2511 CHECK_STRING (file2, 0);
2512
09121adc
RS
2513 abspath1 = Qnil;
2514 GCPRO2 (abspath1, file2);
32f4334d
RS
2515 abspath1 = expand_and_dir_to_file (file1, current_buffer->directory);
2516 abspath2 = expand_and_dir_to_file (file2, current_buffer->directory);
09121adc 2517 UNGCPRO;
570d7624 2518
32f4334d
RS
2519 /* If the file name has special constructs in it,
2520 call the corresponding file handler. */
49307295 2521 handler = Ffind_file_name_handler (abspath1, Qfile_newer_than_file_p);
51cf6d37 2522 if (NILP (handler))
49307295 2523 handler = Ffind_file_name_handler (abspath2, Qfile_newer_than_file_p);
32f4334d
RS
2524 if (!NILP (handler))
2525 return call3 (handler, Qfile_newer_than_file_p, abspath1, abspath2);
2526
2527 if (stat (XSTRING (abspath1)->data, &st) < 0)
570d7624
JB
2528 return Qnil;
2529
2530 mtime1 = st.st_mtime;
2531
32f4334d 2532 if (stat (XSTRING (abspath2)->data, &st) < 0)
570d7624
JB
2533 return Qt;
2534
2535 return (mtime1 > st.st_mtime) ? Qt : Qnil;
2536}
2537\f
4c3c22f3
RS
2538#ifdef MSDOS
2539Lisp_Object Qfind_buffer_file_type;
2540#endif
2541
570d7624 2542DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3d0387c0 2543 1, 5, 0,
570d7624 2544 "Insert contents of file FILENAME after point.\n\
7fded690 2545Returns list of absolute file name and length of data inserted.\n\
570d7624
JB
2546If second argument VISIT is non-nil, the buffer's visited filename\n\
2547and last save file modtime are set, and it is marked unmodified.\n\
2548If visiting and the file does not exist, visiting is completed\n\
7fded690
JB
2549before the error is signaled.\n\n\
2550The optional third and fourth arguments BEG and END\n\
2551specify what portion of the file to insert.\n\
3d0387c0
RS
2552If VISIT is non-nil, BEG and END must be nil.\n\
2553If optional fifth argument REPLACE is non-nil,\n\
2554it means replace the current buffer contents (in the accessible portion)\n\
2555with the file contents. This is better than simply deleting and inserting\n\
2556the whole thing because (1) it preserves some marker positions\n\
2557and (2) it puts less data in the undo list.")
2558 (filename, visit, beg, end, replace)
2559 Lisp_Object filename, visit, beg, end, replace;
570d7624
JB
2560{
2561 struct stat st;
2562 register int fd;
2563 register int inserted = 0;
2564 register int how_much;
2565 int count = specpdl_ptr - specpdl;
d6a3cc15
RS
2566 struct gcpro gcpro1, gcpro2;
2567 Lisp_Object handler, val, insval;
2568 Lisp_Object p;
7fded690 2569 int total;
32f4334d
RS
2570
2571 val = Qnil;
d6a3cc15 2572 p = Qnil;
32f4334d 2573
d6a3cc15 2574 GCPRO2 (filename, p);
265a9e55 2575 if (!NILP (current_buffer->read_only))
570d7624
JB
2576 Fbarf_if_buffer_read_only();
2577
2578 CHECK_STRING (filename, 0);
2579 filename = Fexpand_file_name (filename, Qnil);
2580
32f4334d
RS
2581 /* If the file name has special constructs in it,
2582 call the corresponding file handler. */
49307295 2583 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
32f4334d
RS
2584 if (!NILP (handler))
2585 {
3d0387c0
RS
2586 val = call6 (handler, Qinsert_file_contents, filename,
2587 visit, beg, end, replace);
32f4334d
RS
2588 goto handled;
2589 }
2590
570d7624
JB
2591 fd = -1;
2592
2593#ifndef APOLLO
2594 if (stat (XSTRING (filename)->data, &st) < 0
349a7710 2595 || (fd = open (XSTRING (filename)->data, 0)) < 0)
570d7624
JB
2596#else
2597 if ((fd = open (XSTRING (filename)->data, 0)) < 0
2598 || fstat (fd, &st) < 0)
2599#endif /* not APOLLO */
2600 {
2601 if (fd >= 0) close (fd);
265a9e55 2602 if (NILP (visit))
570d7624
JB
2603 report_file_error ("Opening input file", Fcons (filename, Qnil));
2604 st.st_mtime = -1;
2605 how_much = 0;
2606 goto notfound;
2607 }
2608
a1d2b64a
RS
2609 /* Replacement should preserve point as it preserves markers. */
2610 if (!NILP (replace))
2611 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
2612
570d7624
JB
2613 record_unwind_protect (close_file_unwind, make_number (fd));
2614
be53b411
JB
2615#ifdef S_IFSOCK
2616 /* This code will need to be changed in order to work on named
2617 pipes, and it's probably just not worth it. So we should at
2618 least signal an error. */
2619 if ((st.st_mode & S_IFMT) == S_IFSOCK)
2620 Fsignal (Qfile_error,
2621 Fcons (build_string ("reading from named pipe"),
2622 Fcons (filename, Qnil)));
2623#endif
2624
570d7624
JB
2625 /* Supposedly happens on VMS. */
2626 if (st.st_size < 0)
2627 error ("File size is negative");
be53b411 2628
7fded690
JB
2629 if (!NILP (beg) || !NILP (end))
2630 if (!NILP (visit))
2631 error ("Attempt to visit less than an entire file");
2632
2633 if (!NILP (beg))
2634 CHECK_NUMBER (beg, 0);
2635 else
2636 XFASTINT (beg) = 0;
2637
2638 if (!NILP (end))
2639 CHECK_NUMBER (end, 0);
2640 else
2641 {
2642 XSETINT (end, st.st_size);
2643 if (XINT (end) != st.st_size)
2644 error ("maximum buffer size exceeded");
2645 }
2646
3d0387c0
RS
2647 /* If requested, replace the accessible part of the buffer
2648 with the file contents. Avoid replacing text at the
2649 beginning or end of the buffer that matches the file contents;
2650 that preserves markers pointing to the unchanged parts. */
e54d3b5d
RS
2651#ifdef MSDOS
2652 /* On MSDOS, replace mode doesn't really work, except for binary files,
2653 and it's not worth supporting just for them. */
2654 if (!NILP (replace))
2655 {
2656 replace = Qnil;
2657 XFASTINT (beg) = 0;
2658 XFASTINT (end) = st.st_size;
2659 del_range_1 (BEGV, ZV, 0);
2660 }
2661#else /* MSDOS */
3d0387c0
RS
2662 if (!NILP (replace))
2663 {
2664 char buffer[1 << 14];
2665 int same_at_start = BEGV;
2666 int same_at_end = ZV;
9c28748f
RS
2667 int overlap;
2668
3d0387c0
RS
2669 immediate_quit = 1;
2670 QUIT;
2671 /* Count how many chars at the start of the file
2672 match the text at the beginning of the buffer. */
2673 while (1)
2674 {
2675 int nread, bufpos;
2676
2677 nread = read (fd, buffer, sizeof buffer);
2678 if (nread < 0)
2679 error ("IO error reading %s: %s",
2680 XSTRING (filename)->data, strerror (errno));
2681 else if (nread == 0)
2682 break;
2683 bufpos = 0;
2684 while (bufpos < nread && same_at_start < ZV
2685 && FETCH_CHAR (same_at_start) == buffer[bufpos])
2686 same_at_start++, bufpos++;
2687 /* If we found a discrepancy, stop the scan.
2688 Otherwise loop around and scan the next bufferfull. */
2689 if (bufpos != nread)
2690 break;
2691 }
2692 immediate_quit = 0;
2693 /* If the file matches the buffer completely,
2694 there's no need to replace anything. */
e846c982 2695 if (same_at_start == st.st_size)
3d0387c0
RS
2696 {
2697 close (fd);
a1d2b64a 2698 specpdl_ptr--;
3d0387c0
RS
2699 goto handled;
2700 }
2701 immediate_quit = 1;
2702 QUIT;
2703 /* Count how many chars at the end of the file
2704 match the text at the end of the buffer. */
2705 while (1)
2706 {
2707 int total_read, nread, bufpos, curpos, trial;
2708
2709 /* At what file position are we now scanning? */
2710 curpos = st.st_size - (ZV - same_at_end);
2711 /* How much can we scan in the next step? */
2712 trial = min (curpos, sizeof buffer);
2713 if (lseek (fd, curpos - trial, 0) < 0)
2714 report_file_error ("Setting file position",
2715 Fcons (filename, Qnil));
2716
2717 total_read = 0;
2718 while (total_read < trial)
2719 {
2720 nread = read (fd, buffer + total_read, trial - total_read);
2721 if (nread <= 0)
2722 error ("IO error reading %s: %s",
2723 XSTRING (filename)->data, strerror (errno));
2724 total_read += nread;
2725 }
2726 /* Scan this bufferfull from the end, comparing with
2727 the Emacs buffer. */
2728 bufpos = total_read;
2729 /* Compare with same_at_start to avoid counting some buffer text
2730 as matching both at the file's beginning and at the end. */
2731 while (bufpos > 0 && same_at_end > same_at_start
2732 && FETCH_CHAR (same_at_end - 1) == buffer[bufpos - 1])
2733 same_at_end--, bufpos--;
2734 /* If we found a discrepancy, stop the scan.
2735 Otherwise loop around and scan the preceding bufferfull. */
2736 if (bufpos != 0)
2737 break;
2738 }
2739 immediate_quit = 0;
9c28748f
RS
2740
2741 /* Don't try to reuse the same piece of text twice. */
2742 overlap = same_at_start - BEGV - (same_at_end + st.st_size - ZV);
2743 if (overlap > 0)
2744 same_at_end += overlap;
2745
3d0387c0
RS
2746 /* Arrange to read only the nonmatching middle part of the file. */
2747 XFASTINT (beg) = same_at_start - BEGV;
2748 XFASTINT (end) = st.st_size - (ZV - same_at_end);
9c28748f 2749
251f623e 2750 del_range_1 (same_at_start, same_at_end, 0);
a1d2b64a
RS
2751 /* Insert from the file at the proper position. */
2752 SET_PT (same_at_start);
3d0387c0 2753 }
e54d3b5d 2754#endif /* MSDOS */
3d0387c0 2755
7fded690
JB
2756 total = XINT (end) - XINT (beg);
2757
570d7624
JB
2758 {
2759 register Lisp_Object temp;
2760
2761 /* Make sure point-max won't overflow after this insertion. */
7fded690
JB
2762 XSET (temp, Lisp_Int, total);
2763 if (total != XINT (temp))
570d7624
JB
2764 error ("maximum buffer size exceeded");
2765 }
2766
57d8d468 2767 if (NILP (visit) && total > 0)
570d7624
JB
2768 prepare_to_modify_buffer (point, point);
2769
2770 move_gap (point);
7fded690
JB
2771 if (GAP_SIZE < total)
2772 make_gap (total - GAP_SIZE);
2773
a1d2b64a 2774 if (XINT (beg) != 0 || !NILP (replace))
7fded690
JB
2775 {
2776 if (lseek (fd, XINT (beg), 0) < 0)
2777 report_file_error ("Setting file position", Fcons (filename, Qnil));
2778 }
2779
a1d2b64a
RS
2780 how_much = 0;
2781 while (inserted < total)
570d7624 2782 {
7fded690 2783 int try = min (total - inserted, 64 << 10);
b5148e85
RS
2784 int this;
2785
2786 /* Allow quitting out of the actual I/O. */
2787 immediate_quit = 1;
2788 QUIT;
2789 this = read (fd, &FETCH_CHAR (point + inserted - 1) + 1, try);
2790 immediate_quit = 0;
570d7624
JB
2791
2792 if (this <= 0)
2793 {
2794 how_much = this;
2795 break;
2796 }
2797
2798 GPT += this;
2799 GAP_SIZE -= this;
2800 ZV += this;
2801 Z += this;
2802 inserted += this;
2803 }
2804
4c3c22f3
RS
2805#ifdef MSDOS
2806 /* Demacs 1.1.1 91/10/16 HIRANO Satoshi, MW July 1993 */
2807 /* Determine file type from name and remove LFs from CR-LFs if the file
2808 is deemed to be a text file. */
2809 {
2810 struct gcpro gcpro1;
e762e30a
KH
2811 Lisp_Object code;
2812 code = Qnil;
4c3c22f3 2813 GCPRO1 (filename);
bf162ea8
RS
2814 current_buffer->buffer_file_type
2815 = call1 (Qfind_buffer_file_type, filename);
4c3c22f3 2816 UNGCPRO;
bf162ea8 2817 if (NILP (current_buffer->buffer_file_type))
4c3c22f3 2818 {
a1d2b64a
RS
2819 int reduced_size
2820 = inserted - crlf_to_lf (inserted, &FETCH_CHAR (point - 1) + 1);
4c3c22f3
RS
2821 ZV -= reduced_size;
2822 Z -= reduced_size;
2823 GPT -= reduced_size;
2824 GAP_SIZE += reduced_size;
2825 inserted -= reduced_size;
2826 }
2827 }
2828#endif
2829
570d7624 2830 if (inserted > 0)
7d8451f1
RS
2831 {
2832 record_insert (point, inserted);
8d4e077b
JA
2833
2834 /* Only defined if Emacs is compiled with USE_TEXT_PROPERTIES */
2835 offset_intervals (current_buffer, point, inserted);
7d8451f1
RS
2836 MODIFF++;
2837 }
570d7624
JB
2838
2839 close (fd);
2840
a1d2b64a
RS
2841 /* Discard the unwind protect for closing the file. */
2842 specpdl_ptr--;
570d7624
JB
2843
2844 if (how_much < 0)
2845 error ("IO error reading %s: %s",
ce97267f 2846 XSTRING (filename)->data, strerror (errno));
570d7624
JB
2847
2848 notfound:
32f4334d 2849 handled:
570d7624 2850
265a9e55 2851 if (!NILP (visit))
570d7624 2852 {
cfadd376
RS
2853 if (!EQ (current_buffer->undo_list, Qt))
2854 current_buffer->undo_list = Qnil;
570d7624
JB
2855#ifdef APOLLO
2856 stat (XSTRING (filename)->data, &st);
2857#endif
62bcf009 2858
a7e82472
RS
2859 if (NILP (handler))
2860 {
2861 current_buffer->modtime = st.st_mtime;
2862 current_buffer->filename = filename;
2863 }
62bcf009 2864
570d7624
JB
2865 current_buffer->save_modified = MODIFF;
2866 current_buffer->auto_save_modified = MODIFF;
2867 XFASTINT (current_buffer->save_length) = Z - BEG;
2868#ifdef CLASH_DETECTION
32f4334d
RS
2869 if (NILP (handler))
2870 {
2871 if (!NILP (current_buffer->filename))
2872 unlock_file (current_buffer->filename);
2873 unlock_file (filename);
2874 }
570d7624 2875#endif /* CLASH_DETECTION */
570d7624 2876 /* If visiting nonexistent file, return nil. */
32f4334d 2877 if (current_buffer->modtime == -1)
570d7624
JB
2878 report_file_error ("Opening input file", Fcons (filename, Qnil));
2879 }
2880
62bcf009 2881 if (inserted > 0 && NILP (visit) && total > 0)
d2cad97d 2882 signal_after_change (point, 0, inserted);
570d7624 2883
d6a3cc15
RS
2884 if (inserted > 0)
2885 {
2886 p = Vafter_insert_file_functions;
2887 while (!NILP (p))
2888 {
2889 insval = call1 (Fcar (p), make_number (inserted));
2890 if (!NILP (insval))
2891 {
2892 CHECK_NUMBER (insval, 0);
2893 inserted = XFASTINT (insval);
2894 }
2895 QUIT;
2896 p = Fcdr (p);
2897 }
2898 }
2899
a1d2b64a
RS
2900 if (NILP (val))
2901 val = Fcons (filename,
2902 Fcons (make_number (inserted),
2903 Qnil));
2904
2905 RETURN_UNGCPRO (unbind_to (count, val));
570d7624 2906}
7fded690 2907\f
d6a3cc15
RS
2908static Lisp_Object build_annotations ();
2909
570d7624
JB
2910DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 5,
2911 "r\nFWrite region to file: ",
2912 "Write current region into specified file.\n\
2913When called from a program, takes three arguments:\n\
2914START, END and FILENAME. START and END are buffer positions.\n\
2915Optional fourth argument APPEND if non-nil means\n\
2916 append to existing file contents (if any).\n\
2917Optional fifth argument VISIT if t means\n\
2918 set the last-save-file-modtime of buffer to this file's modtime\n\
2919 and mark buffer not modified.\n\
3b7792ed
RS
2920If VISIT is a string, it is a second file name;\n\
2921 the output goes to FILENAME, but the buffer is marked as visiting VISIT.\n\
2922 VISIT is also the file name to lock and unlock for clash detection.\n\
1d386d28
RS
2923If VISIT is neither t nor nil nor a string,\n\
2924 that means do not print the \"Wrote file\" message.\n\
570d7624
JB
2925Kludgy feature: if START is a string, then that string is written\n\
2926to the file, instead of any buffer contents, and END is ignored.")
2927 (start, end, filename, append, visit)
2928 Lisp_Object start, end, filename, append, visit;
2929{
2930 register int desc;
2931 int failure;
2932 int save_errno;
2933 unsigned char *fn;
2934 struct stat st;
c975dd7a 2935 int tem;
570d7624
JB
2936 int count = specpdl_ptr - specpdl;
2937#ifdef VMS
2938 unsigned char *fname = 0; /* If non-0, original filename (must rename) */
2939#endif /* VMS */
3eac9910 2940 Lisp_Object handler;
4ad827c5 2941 Lisp_Object visit_file;
d6a3cc15
RS
2942 Lisp_Object annotations;
2943 int visiting, quietly;
3b7792ed 2944 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4c3c22f3
RS
2945#ifdef MSDOS
2946 int buffer_file_type
2947 = NILP (current_buffer->buffer_file_type) ? O_TEXT : O_BINARY;
2948#endif
570d7624 2949
561cb8e1 2950 if (!NILP (start) && !STRINGP (start))
570d7624
JB
2951 validate_region (&start, &end);
2952
2953 filename = Fexpand_file_name (filename, Qnil);
561cb8e1 2954 if (STRINGP (visit))
e5176bae 2955 visit_file = Fexpand_file_name (visit, Qnil);
4ad827c5
RS
2956 else
2957 visit_file = filename;
2958
561cb8e1 2959 visiting = (EQ (visit, Qt) || STRINGP (visit));
d6a3cc15
RS
2960 quietly = !NILP (visit);
2961
2962 annotations = Qnil;
2963
2964 GCPRO4 (start, filename, annotations, visit_file);
570d7624 2965
32f4334d
RS
2966 /* If the file name has special constructs in it,
2967 call the corresponding file handler. */
49307295 2968 handler = Ffind_file_name_handler (filename, Qwrite_region);
b56ad927
RS
2969 /* If FILENAME has no handler, see if VISIT has one. */
2970 if (NILP (handler) && XTYPE (visit) == Lisp_String)
49307295 2971 handler = Ffind_file_name_handler (visit, Qwrite_region);
3eac9910 2972
32f4334d
RS
2973 if (!NILP (handler))
2974 {
32f4334d 2975 Lisp_Object val;
51cf6d37
RS
2976 val = call6 (handler, Qwrite_region, start, end,
2977 filename, append, visit);
32f4334d 2978
d6a3cc15 2979 if (visiting)
32f4334d 2980 {
32f4334d
RS
2981 current_buffer->save_modified = MODIFF;
2982 XFASTINT (current_buffer->save_length) = Z - BEG;
3b7792ed 2983 current_buffer->filename = visit_file;
32f4334d 2984 }
09121adc 2985 UNGCPRO;
32f4334d
RS
2986 return val;
2987 }
2988
561cb8e1
RS
2989 /* Special kludge to simplify auto-saving. */
2990 if (NILP (start))
2991 {
2992 XFASTINT (start) = BEG;
2993 XFASTINT (end) = Z;
2994 }
2995
d6a3cc15
RS
2996 annotations = build_annotations (start, end);
2997
570d7624
JB
2998#ifdef CLASH_DETECTION
2999 if (!auto_saving)
3b7792ed 3000 lock_file (visit_file);
570d7624
JB
3001#endif /* CLASH_DETECTION */
3002
09121adc 3003 fn = XSTRING (filename)->data;
570d7624 3004 desc = -1;
265a9e55 3005 if (!NILP (append))
4c3c22f3
RS
3006#ifdef MSDOS
3007 desc = open (fn, O_WRONLY | buffer_file_type);
3008#else
570d7624 3009 desc = open (fn, O_WRONLY);
4c3c22f3 3010#endif
570d7624
JB
3011
3012 if (desc < 0)
3013#ifdef VMS
3014 if (auto_saving) /* Overwrite any previous version of autosave file */
3015 {
3016 vms_truncate (fn); /* if fn exists, truncate to zero length */
3017 desc = open (fn, O_RDWR);
3018 if (desc < 0)
561cb8e1 3019 desc = creat_copy_attrs (STRINGP (current_buffer->filename)
b72dea2a
JB
3020 ? XSTRING (current_buffer->filename)->data : 0,
3021 fn);
570d7624
JB
3022 }
3023 else /* Write to temporary name and rename if no errors */
3024 {
3025 Lisp_Object temp_name;
3026 temp_name = Ffile_name_directory (filename);
3027
265a9e55 3028 if (!NILP (temp_name))
570d7624
JB
3029 {
3030 temp_name = Fmake_temp_name (concat2 (temp_name,
3031 build_string ("$$SAVE$$")));
3032 fname = XSTRING (filename)->data;
3033 fn = XSTRING (temp_name)->data;
3034 desc = creat_copy_attrs (fname, fn);
3035 if (desc < 0)
3036 {
3037 /* If we can't open the temporary file, try creating a new
3038 version of the original file. VMS "creat" creates a
3039 new version rather than truncating an existing file. */
3040 fn = fname;
3041 fname = 0;
3042 desc = creat (fn, 0666);
3043#if 0 /* This can clobber an existing file and fail to replace it,
3044 if the user runs out of space. */
3045 if (desc < 0)
3046 {
3047 /* We can't make a new version;
3048 try to truncate and rewrite existing version if any. */
3049 vms_truncate (fn);
3050 desc = open (fn, O_RDWR);
3051 }
3052#endif
3053 }
3054 }
3055 else
3056 desc = creat (fn, 0666);
3057 }
3058#else /* not VMS */
4c3c22f3
RS
3059#ifdef MSDOS
3060 desc = open (fn,
3061 O_WRONLY | O_TRUNC | O_CREAT | buffer_file_type,
3062 S_IREAD | S_IWRITE);
3063#else /* not MSDOS */
570d7624 3064 desc = creat (fn, auto_saving ? auto_save_mode_bits : 0666);
4c3c22f3 3065#endif /* not MSDOS */
570d7624
JB
3066#endif /* not VMS */
3067
09121adc
RS
3068 UNGCPRO;
3069
570d7624
JB
3070 if (desc < 0)
3071 {
3072#ifdef CLASH_DETECTION
3073 save_errno = errno;
3b7792ed 3074 if (!auto_saving) unlock_file (visit_file);
570d7624
JB
3075 errno = save_errno;
3076#endif /* CLASH_DETECTION */
3077 report_file_error ("Opening output file", Fcons (filename, Qnil));
3078 }
3079
3080 record_unwind_protect (close_file_unwind, make_number (desc));
3081
265a9e55 3082 if (!NILP (append))
570d7624
JB
3083 if (lseek (desc, 0, 2) < 0)
3084 {
3085#ifdef CLASH_DETECTION
3b7792ed 3086 if (!auto_saving) unlock_file (visit_file);
570d7624
JB
3087#endif /* CLASH_DETECTION */
3088 report_file_error ("Lseek error", Fcons (filename, Qnil));
3089 }
3090
3091#ifdef VMS
3092/*
3093 * Kludge Warning: The VMS C RTL likes to insert carriage returns
3094 * if we do writes that don't end with a carriage return. Furthermore
3095 * it cannot handle writes of more then 16K. The modified
3096 * version of "sys_write" in SYSDEP.C (see comment there) copes with
3097 * this EXCEPT for the last record (iff it doesn't end with a carriage
3098 * return). This implies that if your buffer doesn't end with a carriage
3099 * return, you get one free... tough. However it also means that if
3100 * we make two calls to sys_write (a la the following code) you can
3101 * get one at the gap as well. The easiest way to fix this (honest)
3102 * is to move the gap to the next newline (or the end of the buffer).
3103 * Thus this change.
3104 *
3105 * Yech!
3106 */
3107 if (GPT > BEG && GPT_ADDR[-1] != '\n')
3108 move_gap (find_next_newline (GPT, 1));
3109#endif
3110
3111 failure = 0;
3112 immediate_quit = 1;
3113
561cb8e1 3114 if (STRINGP (start))
570d7624 3115 {
d6a3cc15
RS
3116 failure = 0 > a_write (desc, XSTRING (start)->data,
3117 XSTRING (start)->size, 0, &annotations);
570d7624
JB
3118 save_errno = errno;
3119 }
3120 else if (XINT (start) != XINT (end))
3121 {
c975dd7a 3122 int nwritten = 0;
570d7624
JB
3123 if (XINT (start) < GPT)
3124 {
3125 register int end1 = XINT (end);
3126 tem = XINT (start);
d6a3cc15 3127 failure = 0 > a_write (desc, &FETCH_CHAR (tem),
c975dd7a
RS
3128 min (GPT, end1) - tem, tem, &annotations);
3129 nwritten += min (GPT, end1) - tem;
570d7624
JB
3130 save_errno = errno;
3131 }
3132
3133 if (XINT (end) > GPT && !failure)
3134 {
3135 tem = XINT (start);
3136 tem = max (tem, GPT);
d6a3cc15 3137 failure = 0 > a_write (desc, &FETCH_CHAR (tem), XINT (end) - tem,
c975dd7a
RS
3138 tem, &annotations);
3139 nwritten += XINT (end) - tem;
d6a3cc15
RS
3140 save_errno = errno;
3141 }
c975dd7a
RS
3142
3143 if (nwritten == 0)
d6a3cc15
RS
3144 {
3145 /* If file was empty, still need to write the annotations */
c975dd7a 3146 failure = 0 > a_write (desc, "", 0, XINT (start), &annotations);
570d7624
JB
3147 save_errno = errno;
3148 }
3149 }
3150
3151 immediate_quit = 0;
3152
6e23c83e 3153#ifdef HAVE_FSYNC
570d7624
JB
3154 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
3155 Disk full in NFS may be reported here. */
1daffa1c
RS
3156 /* mib says that closing the file will try to write as fast as NFS can do
3157 it, and that means the fsync here is not crucial for autosave files. */
3158 if (!auto_saving && fsync (desc) < 0)
570d7624 3159 failure = 1, save_errno = errno;
570d7624
JB
3160#endif
3161
3162 /* Spurious "file has changed on disk" warnings have been
3163 observed on Suns as well.
3164 It seems that `close' can change the modtime, under nfs.
3165
3166 (This has supposedly been fixed in Sunos 4,
3167 but who knows about all the other machines with NFS?) */
3168#if 0
3169
3170 /* On VMS and APOLLO, must do the stat after the close
3171 since closing changes the modtime. */
3172#ifndef VMS
3173#ifndef APOLLO
3174 /* Recall that #if defined does not work on VMS. */
3175#define FOO
3176 fstat (desc, &st);
3177#endif
3178#endif
3179#endif
3180
3181 /* NFS can report a write failure now. */
3182 if (close (desc) < 0)
3183 failure = 1, save_errno = errno;
3184
3185#ifdef VMS
3186 /* If we wrote to a temporary name and had no errors, rename to real name. */
3187 if (fname)
3188 {
3189 if (!failure)
3190 failure = (rename (fn, fname) != 0), save_errno = errno;
3191 fn = fname;
3192 }
3193#endif /* VMS */
3194
3195#ifndef FOO
3196 stat (fn, &st);
3197#endif
3198 /* Discard the unwind protect */
3199 specpdl_ptr = specpdl + count;
3200
3201#ifdef CLASH_DETECTION
3202 if (!auto_saving)
3b7792ed 3203 unlock_file (visit_file);
570d7624
JB
3204#endif /* CLASH_DETECTION */
3205
3206 /* Do this before reporting IO error
3207 to avoid a "file has changed on disk" warning on
3208 next attempt to save. */
d6a3cc15 3209 if (visiting)
570d7624
JB
3210 current_buffer->modtime = st.st_mtime;
3211
3212 if (failure)
ce97267f 3213 error ("IO error writing %s: %s", fn, strerror (save_errno));
570d7624 3214
d6a3cc15 3215 if (visiting)
570d7624
JB
3216 {
3217 current_buffer->save_modified = MODIFF;
3218 XFASTINT (current_buffer->save_length) = Z - BEG;
3b7792ed 3219 current_buffer->filename = visit_file;
570d7624 3220 }
d6a3cc15 3221 else if (quietly)
570d7624
JB
3222 return Qnil;
3223
3224 if (!auto_saving)
3b7792ed 3225 message ("Wrote %s", XSTRING (visit_file)->data);
570d7624
JB
3226
3227 return Qnil;
3228}
3229
d6a3cc15
RS
3230Lisp_Object merge ();
3231
3232DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
2ba0ccff 3233 "Return t if (car A) is numerically less than (car B).")
d6a3cc15
RS
3234 (a, b)
3235 Lisp_Object a, b;
3236{
3237 return Flss (Fcar (a), Fcar (b));
3238}
3239
3240/* Build the complete list of annotations appropriate for writing out
3241 the text between START and END, by calling all the functions in
3242 write-region-annotate-functions and merging the lists they return. */
3243
3244static Lisp_Object
3245build_annotations (start, end)
3246 Lisp_Object start, end;
3247{
3248 Lisp_Object annotations;
3249 Lisp_Object p, res;
3250 struct gcpro gcpro1, gcpro2;
3251
3252 annotations = Qnil;
3253 p = Vwrite_region_annotate_functions;
3254 GCPRO2 (annotations, p);
3255 while (!NILP (p))
3256 {
3257 res = call2 (Fcar (p), start, end);
3258 Flength (res); /* Check basic validity of return value */
3259 annotations = merge (annotations, res, Qcar_less_than_car);
3260 p = Fcdr (p);
3261 }
3262 UNGCPRO;
3263 return annotations;
3264}
3265
3266/* Write to descriptor DESC the LEN characters starting at ADDR,
3267 assuming they start at position POS in the buffer.
3268 Intersperse with them the annotations from *ANNOT
3269 (those which fall within the range of positions POS to POS + LEN),
3270 each at its appropriate position.
3271
3272 Modify *ANNOT by discarding elements as we output them.
3273 The return value is negative in case of system call failure. */
3274
3275int
3276a_write (desc, addr, len, pos, annot)
3277 int desc;
3278 register char *addr;
3279 register int len;
3280 int pos;
3281 Lisp_Object *annot;
3282{
3283 Lisp_Object tem;
3284 int nextpos;
3285 int lastpos = pos + len;
3286
3287 while (1)
3288 {
3289 tem = Fcar_safe (Fcar (*annot));
3290 if (INTEGERP (tem) && XINT (tem) >= pos && XFASTINT (tem) <= lastpos)
3291 nextpos = XFASTINT (tem);
3292 else
3293 return e_write (desc, addr, lastpos - pos);
3294 if (nextpos > pos)
3295 {
3296 if (0 > e_write (desc, addr, nextpos - pos))
3297 return -1;
3298 addr += nextpos - pos;
3299 pos = nextpos;
3300 }
3301 tem = Fcdr (Fcar (*annot));
3302 if (STRINGP (tem))
3303 {
3304 if (0 > e_write (desc, XSTRING (tem)->data, XSTRING (tem)->size))
3305 return -1;
3306 }
3307 *annot = Fcdr (*annot);
3308 }
3309}
3310
570d7624
JB
3311int
3312e_write (desc, addr, len)
3313 int desc;
3314 register char *addr;
3315 register int len;
3316{
3317 char buf[16 * 1024];
3318 register char *p, *end;
3319
3320 if (!EQ (current_buffer->selective_display, Qt))
3321 return write (desc, addr, len) - len;
3322 else
3323 {
3324 p = buf;
3325 end = p + sizeof buf;
3326 while (len--)
3327 {
3328 if (p == end)
3329 {
3330 if (write (desc, buf, sizeof buf) != sizeof buf)
3331 return -1;
3332 p = buf;
3333 }
3334 *p = *addr++;
3335 if (*p++ == '\015')
3336 p[-1] = '\n';
3337 }
3338 if (p != buf)
3339 if (write (desc, buf, p - buf) != p - buf)
3340 return -1;
3341 }
3342 return 0;
3343}
3344
3345DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
3346 Sverify_visited_file_modtime, 1, 1, 0,
3347 "Return t if last mod time of BUF's visited file matches what BUF records.\n\
3348This means that the file has not been changed since it was visited or saved.")
3349 (buf)
3350 Lisp_Object buf;
3351{
3352 struct buffer *b;
3353 struct stat st;
32f4334d 3354 Lisp_Object handler;
570d7624
JB
3355
3356 CHECK_BUFFER (buf, 0);
3357 b = XBUFFER (buf);
3358
3359 if (XTYPE (b->filename) != Lisp_String) return Qt;
3360 if (b->modtime == 0) return Qt;
3361
32f4334d
RS
3362 /* If the file name has special constructs in it,
3363 call the corresponding file handler. */
49307295
KH
3364 handler = Ffind_file_name_handler (b->filename,
3365 Qverify_visited_file_modtime);
32f4334d 3366 if (!NILP (handler))
09121adc 3367 return call2 (handler, Qverify_visited_file_modtime, buf);
32f4334d 3368
570d7624
JB
3369 if (stat (XSTRING (b->filename)->data, &st) < 0)
3370 {
3371 /* If the file doesn't exist now and didn't exist before,
3372 we say that it isn't modified, provided the error is a tame one. */
3373 if (errno == ENOENT || errno == EACCES || errno == ENOTDIR)
3374 st.st_mtime = -1;
3375 else
3376 st.st_mtime = 0;
3377 }
3378 if (st.st_mtime == b->modtime
3379 /* If both are positive, accept them if they are off by one second. */
3380 || (st.st_mtime > 0 && b->modtime > 0
3381 && (st.st_mtime == b->modtime + 1
3382 || st.st_mtime == b->modtime - 1)))
3383 return Qt;
3384 return Qnil;
3385}
3386
3387DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
3388 Sclear_visited_file_modtime, 0, 0, 0,
3389 "Clear out records of last mod time of visited file.\n\
3390Next attempt to save will certainly not complain of a discrepancy.")
3391 ()
3392{
3393 current_buffer->modtime = 0;
3394 return Qnil;
3395}
3396
f5d5eccf
RS
3397DEFUN ("visited-file-modtime", Fvisited_file_modtime,
3398 Svisited_file_modtime, 0, 0, 0,
3399 "Return the current buffer's recorded visited file modification time.\n\
3400The value is a list of the form (HIGH . LOW), like the time values\n\
3401that `file-attributes' returns.")
3402 ()
3403{
3404 return long_to_cons (current_buffer->modtime);
3405}
3406
570d7624 3407DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
f5d5eccf 3408 Sset_visited_file_modtime, 0, 1, 0,
570d7624
JB
3409 "Update buffer's recorded modification time from the visited file's time.\n\
3410Useful if the buffer was not read from the file normally\n\
f5d5eccf
RS
3411or if the file itself has been changed for some known benign reason.\n\
3412An argument specifies the modification time value to use\n\
3413\(instead of that of the visited file), in the form of a list\n\
3414\(HIGH . LOW) or (HIGH LOW).")
3415 (time_list)
3416 Lisp_Object time_list;
570d7624 3417{
f5d5eccf
RS
3418 if (!NILP (time_list))
3419 current_buffer->modtime = cons_to_long (time_list);
3420 else
3421 {
3422 register Lisp_Object filename;
3423 struct stat st;
3424 Lisp_Object handler;
570d7624 3425
f5d5eccf 3426 filename = Fexpand_file_name (current_buffer->filename, Qnil);
32f4334d 3427
f5d5eccf
RS
3428 /* If the file name has special constructs in it,
3429 call the corresponding file handler. */
49307295 3430 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
f5d5eccf 3431 if (!NILP (handler))
caf3c431 3432 /* The handler can find the file name the same way we did. */
76c881b0 3433 return call2 (handler, Qset_visited_file_modtime, Qnil);
f5d5eccf
RS
3434 else if (stat (XSTRING (filename)->data, &st) >= 0)
3435 current_buffer->modtime = st.st_mtime;
3436 }
570d7624
JB
3437
3438 return Qnil;
3439}
3440\f
3441Lisp_Object
3442auto_save_error ()
3443{
3444 unsigned char *name = XSTRING (current_buffer->name)->data;
3445
3446 ring_bell ();
3447 message ("Autosaving...error for %s", name);
de49a6d3 3448 Fsleep_for (make_number (1), Qnil);
570d7624 3449 message ("Autosaving...error!for %s", name);
de49a6d3 3450 Fsleep_for (make_number (1), Qnil);
570d7624 3451 message ("Autosaving...error for %s", name);
de49a6d3 3452 Fsleep_for (make_number (1), Qnil);
570d7624
JB
3453 return Qnil;
3454}
3455
3456Lisp_Object
3457auto_save_1 ()
3458{
3459 unsigned char *fn;
3460 struct stat st;
3461
3462 /* Get visited file's mode to become the auto save file's mode. */
3463 if (stat (XSTRING (current_buffer->filename)->data, &st) >= 0)
3464 /* But make sure we can overwrite it later! */
3465 auto_save_mode_bits = st.st_mode | 0600;
3466 else
3467 auto_save_mode_bits = 0666;
3468
3469 return
3470 Fwrite_region (Qnil, Qnil,
3471 current_buffer->auto_save_file_name,
3472 Qnil, Qlambda);
3473}
3474
e54d3b5d
RS
3475static Lisp_Object
3476do_auto_save_unwind (stream) /* used as unwind-protect function */
3477 Lisp_Object stream;
3478{
3479 close (*(int *)XPNTR (stream));
3480 xfree (XPNTR (stream));
3481 return Qnil;
3482}
3483
570d7624
JB
3484DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
3485 "Auto-save all buffers that need it.\n\
3486This is all buffers that have auto-saving enabled\n\
3487and are changed since last auto-saved.\n\
3488Auto-saving writes the buffer into a file\n\
3489so that your editing is not lost if the system crashes.\n\
012d4cdc
RS
3490This file is not the file you visited; that changes only when you save.\n\
3491Normally we run the normal hook `auto-save-hook' before saving.\n\n\
570d7624 3492Non-nil first argument means do not print any message if successful.\n\
4746118a 3493Non-nil second argument means save only current buffer.")
17857782
JB
3494 (no_message, current_only)
3495 Lisp_Object no_message, current_only;
570d7624
JB
3496{
3497 struct buffer *old = current_buffer, *b;
3498 Lisp_Object tail, buf;
3499 int auto_saved = 0;
3500 char *omessage = echo_area_glyphs;
f05b275b 3501 int omessage_length = echo_area_glyphs_length;
f14b1c68
JB
3502 extern int minibuf_level;
3503 int do_handled_files;
ff4c9993 3504 Lisp_Object oquit;
e54d3b5d
RS
3505 int listdesc;
3506 Lisp_Object lispstream;
3507 int count = specpdl_ptr - specpdl;
3508 int *ptr;
ff4c9993
RS
3509
3510 /* Ordinarily don't quit within this function,
3511 but don't make it impossible to quit (in case we get hung in I/O). */
3512 oquit = Vquit_flag;
3513 Vquit_flag = Qnil;
570d7624
JB
3514
3515 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
3516 point to non-strings reached from Vbuffer_alist. */
3517
3518 auto_saving = 1;
3519 if (minibuf_level)
17857782 3520 no_message = Qt;
570d7624 3521
265a9e55 3522 if (!NILP (Vrun_hooks))
570d7624
JB
3523 call1 (Vrun_hooks, intern ("auto-save-hook"));
3524
e54d3b5d
RS
3525 if (STRINGP (Vauto_save_list_file_name))
3526 {
3527#ifdef MSDOS
3528 listdesc = open (XSTRING (Vauto_save_list_file_name)->data,
3529 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
3530 S_IREAD | S_IWRITE);
3531#else /* not MSDOS */
3532 listdesc = creat (XSTRING (Vauto_save_list_file_name)->data, 0666);
3533#endif /* not MSDOS */
3534 }
3535 else
3536 listdesc = -1;
3537
3538 /* We may not be able to store STREAM itself as a Lisp_Object pointer
3539 since that is guaranteed to work only for data that has been malloc'd.
3540 So malloc a full-size pointer, and record the address of that pointer. */
3541 ptr = (int *) xmalloc (sizeof (int));
3542 *ptr = listdesc;
3543 XSET (lispstream, Lisp_Internal_Stream, (int) ptr);
3544
3545 record_unwind_protect (do_auto_save_unwind, lispstream);
3546
f14b1c68
JB
3547 /* First, save all files which don't have handlers. If Emacs is
3548 crashing, the handlers may tweak what is causing Emacs to crash
3549 in the first place, and it would be a shame if Emacs failed to
3550 autosave perfectly ordinary files because it couldn't handle some
3551 ange-ftp'd file. */
3552 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
3553 for (tail = Vbuffer_alist; XGCTYPE (tail) == Lisp_Cons;
3554 tail = XCONS (tail)->cdr)
3555 {
3556 buf = XCONS (XCONS (tail)->car)->cdr;
3557 b = XBUFFER (buf);
e54d3b5d
RS
3558
3559 /* Record all the buffers that have auto save mode
3560 in the special file that lists them. */
3561 if (XTYPE (b->auto_save_file_name) == Lisp_String
3562 && listdesc >= 0 && do_handled_files == 0)
3563 {
3564 write (listdesc, XSTRING (b->auto_save_file_name)->data,
3565 XSTRING (b->auto_save_file_name)->size);
3566 write (listdesc, "\n", 1);
3567 }
17857782 3568
f14b1c68
JB
3569 if (!NILP (current_only)
3570 && b != current_buffer)
3571 continue;
e54d3b5d 3572
f14b1c68
JB
3573 /* Check for auto save enabled
3574 and file changed since last auto save
3575 and file changed since last real save. */
3576 if (XTYPE (b->auto_save_file_name) == Lisp_String
3577 && b->save_modified < BUF_MODIFF (b)
3578 && b->auto_save_modified < BUF_MODIFF (b)
82c2d839
RS
3579 /* -1 means we've turned off autosaving for a while--see below. */
3580 && XINT (b->save_length) >= 0
f14b1c68 3581 && (do_handled_files
49307295
KH
3582 || NILP (Ffind_file_name_handler (b->auto_save_file_name,
3583 Qwrite_region))))
f14b1c68 3584 {
b60247d9
RS
3585 EMACS_TIME before_time, after_time;
3586
3587 EMACS_GET_TIME (before_time);
3588
3589 /* If we had a failure, don't try again for 20 minutes. */
3590 if (b->auto_save_failure_time >= 0
3591 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
3592 continue;
3593
f14b1c68
JB
3594 if ((XFASTINT (b->save_length) * 10
3595 > (BUF_Z (b) - BUF_BEG (b)) * 13)
3596 /* A short file is likely to change a large fraction;
3597 spare the user annoying messages. */
3598 && XFASTINT (b->save_length) > 5000
3599 /* These messages are frequent and annoying for `*mail*'. */
3600 && !EQ (b->filename, Qnil)
3601 && NILP (no_message))
3602 {
3603 /* It has shrunk too much; turn off auto-saving here. */
3604 message ("Buffer %s has shrunk a lot; auto save turned off there",
3605 XSTRING (b->name)->data);
82c2d839
RS
3606 /* Turn off auto-saving until there's a real save,
3607 and prevent any more warnings. */
3608 XSET (b->save_length, Lisp_Int, -1);
f14b1c68
JB
3609 Fsleep_for (make_number (1), Qnil);
3610 continue;
3611 }
3612 set_buffer_internal (b);
3613 if (!auto_saved && NILP (no_message))
3614 message1 ("Auto-saving...");
3615 internal_condition_case (auto_save_1, Qt, auto_save_error);
3616 auto_saved++;
3617 b->auto_save_modified = BUF_MODIFF (b);
3618 XFASTINT (current_buffer->save_length) = Z - BEG;
3619 set_buffer_internal (old);
b60247d9
RS
3620
3621 EMACS_GET_TIME (after_time);
3622
3623 /* If auto-save took more than 60 seconds,
3624 assume it was an NFS failure that got a timeout. */
3625 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
3626 b->auto_save_failure_time = EMACS_SECS (after_time);
f14b1c68
JB
3627 }
3628 }
570d7624 3629
b67f2ca5
RS
3630 /* Prevent another auto save till enough input events come in. */
3631 record_auto_save ();
570d7624 3632
17857782 3633 if (auto_saved && NILP (no_message))
f05b275b
KH
3634 {
3635 if (omessage)
3636 message2 (omessage, omessage_length);
3637 else
3638 message1 ("Auto-saving...done");
3639 }
570d7624 3640
ff4c9993
RS
3641 Vquit_flag = oquit;
3642
570d7624 3643 auto_saving = 0;
e54d3b5d 3644 unbind_to (count, Qnil);
570d7624
JB
3645 return Qnil;
3646}
3647
3648DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
3649 Sset_buffer_auto_saved, 0, 0, 0,
3650 "Mark current buffer as auto-saved with its current text.\n\
3651No auto-save file will be written until the buffer changes again.")
3652 ()
3653{
3654 current_buffer->auto_save_modified = MODIFF;
3655 XFASTINT (current_buffer->save_length) = Z - BEG;
b60247d9
RS
3656 current_buffer->auto_save_failure_time = -1;
3657 return Qnil;
3658}
3659
3660DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
3661 Sclear_buffer_auto_save_failure, 0, 0, 0,
3662 "Clear any record of a recent auto-save failure in the current buffer.")
3663 ()
3664{
3665 current_buffer->auto_save_failure_time = -1;
570d7624
JB
3666 return Qnil;
3667}
3668
3669DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
3670 0, 0, 0,
3671 "Return t if buffer has been auto-saved since last read in or saved.")
3672 ()
3673{
3674 return (current_buffer->save_modified < current_buffer->auto_save_modified) ? Qt : Qnil;
3675}
3676\f
3677/* Reading and completing file names */
3678extern Lisp_Object Ffile_name_completion (), Ffile_name_all_completions ();
3679
6e710ae5
RS
3680/* In the string VAL, change each $ to $$ and return the result. */
3681
3682static Lisp_Object
3683double_dollars (val)
3684 Lisp_Object val;
3685{
3686 register unsigned char *old, *new;
3687 register int n;
3688 int osize, count;
3689
3690 osize = XSTRING (val)->size;
3691 /* Quote "$" as "$$" to get it past substitute-in-file-name */
3692 for (n = osize, count = 0, old = XSTRING (val)->data; n > 0; n--)
3693 if (*old++ == '$') count++;
3694 if (count > 0)
3695 {
3696 old = XSTRING (val)->data;
3697 val = Fmake_string (make_number (osize + count), make_number (0));
3698 new = XSTRING (val)->data;
3699 for (n = osize; n > 0; n--)
3700 if (*old != '$')
3701 *new++ = *old++;
3702 else
3703 {
3704 *new++ = '$';
3705 *new++ = '$';
3706 old++;
3707 }
3708 }
3709 return val;
3710}
3711
570d7624
JB
3712DEFUN ("read-file-name-internal", Fread_file_name_internal, Sread_file_name_internal,
3713 3, 3, 0,
3714 "Internal subroutine for read-file-name. Do not call this.")
3715 (string, dir, action)
3716 Lisp_Object string, dir, action;
3717 /* action is nil for complete, t for return list of completions,
3718 lambda for verify final value */
3719{
3720 Lisp_Object name, specdir, realdir, val, orig_string;
09121adc
RS
3721 int changed;
3722 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3723
3724 realdir = dir;
3725 name = string;
3726 orig_string = Qnil;
3727 specdir = Qnil;
3728 changed = 0;
3729 /* No need to protect ACTION--we only compare it with t and nil. */
3730 GCPRO4 (string, realdir, name, specdir);
570d7624
JB
3731
3732 if (XSTRING (string)->size == 0)
3733 {
570d7624 3734 if (EQ (action, Qlambda))
09121adc
RS
3735 {
3736 UNGCPRO;
3737 return Qnil;
3738 }
570d7624
JB
3739 }
3740 else
3741 {
3742 orig_string = string;
3743 string = Fsubstitute_in_file_name (string);
09121adc 3744 changed = NILP (Fstring_equal (string, orig_string));
570d7624 3745 name = Ffile_name_nondirectory (string);
09121adc
RS
3746 val = Ffile_name_directory (string);
3747 if (! NILP (val))
3748 realdir = Fexpand_file_name (val, realdir);
570d7624
JB
3749 }
3750
265a9e55 3751 if (NILP (action))
570d7624
JB
3752 {
3753 specdir = Ffile_name_directory (string);
3754 val = Ffile_name_completion (name, realdir);
09121adc 3755 UNGCPRO;
570d7624
JB
3756 if (XTYPE (val) != Lisp_String)
3757 {
09121adc 3758 if (changed)
570d7624 3759 return string;
09121adc 3760 return val;
570d7624
JB
3761 }
3762
265a9e55 3763 if (!NILP (specdir))
570d7624
JB
3764 val = concat2 (specdir, val);
3765#ifndef VMS
6e710ae5
RS
3766 return double_dollars (val);
3767#else /* not VMS */
09121adc 3768 return val;
6e710ae5 3769#endif /* not VMS */
570d7624 3770 }
09121adc 3771 UNGCPRO;
570d7624
JB
3772
3773 if (EQ (action, Qt))
3774 return Ffile_name_all_completions (name, realdir);
3775 /* Only other case actually used is ACTION = lambda */
3776#ifdef VMS
3777 /* Supposedly this helps commands such as `cd' that read directory names,
3778 but can someone explain how it helps them? -- RMS */
3779 if (XSTRING (name)->size == 0)
3780 return Qt;
3781#endif /* VMS */
3782 return Ffile_exists_p (string);
3783}
3784
3785DEFUN ("read-file-name", Fread_file_name, Sread_file_name, 1, 5, 0,
3786 "Read file name, prompting with PROMPT and completing in directory DIR.\n\
3787Value is not expanded---you must call `expand-file-name' yourself.\n\
3788Default name to DEFAULT if user enters a null string.\n\
3789 (If DEFAULT is omitted, the visited file name is used.)\n\
3790Fourth arg MUSTMATCH non-nil means require existing file's name.\n\
3791 Non-nil and non-t means also require confirmation after completion.\n\
3792Fifth arg INITIAL specifies text to start with.\n\
3793DIR defaults to current buffer's directory default.")
3794 (prompt, dir, defalt, mustmatch, initial)
3795 Lisp_Object prompt, dir, defalt, mustmatch, initial;
3796{
85b5fe07 3797 Lisp_Object val, insdef, insdef1, tem;
570d7624
JB
3798 struct gcpro gcpro1, gcpro2;
3799 register char *homedir;
3800 int count;
3801
265a9e55 3802 if (NILP (dir))
570d7624 3803 dir = current_buffer->directory;
265a9e55 3804 if (NILP (defalt))
570d7624
JB
3805 defalt = current_buffer->filename;
3806
3807 /* If dir starts with user's homedir, change that to ~. */
3808 homedir = (char *) egetenv ("HOME");
3809 if (homedir != 0
3810 && XTYPE (dir) == Lisp_String
3811 && !strncmp (homedir, XSTRING (dir)->data, strlen (homedir))
3812 && XSTRING (dir)->data[strlen (homedir)] == '/')
3813 {
3814 dir = make_string (XSTRING (dir)->data + strlen (homedir) - 1,
3815 XSTRING (dir)->size - strlen (homedir) + 1);
3816 XSTRING (dir)->data[0] = '~';
3817 }
3818
3819 if (insert_default_directory)
3820 {
3821 insdef = dir;
265a9e55 3822 if (!NILP (initial))
570d7624 3823 {
15c65264 3824 Lisp_Object args[2], pos;
570d7624
JB
3825
3826 args[0] = insdef;
3827 args[1] = initial;
3828 insdef = Fconcat (2, args);
351bd676 3829 pos = make_number (XSTRING (double_dollars (dir))->size);
6e710ae5 3830 insdef1 = Fcons (double_dollars (insdef), pos);
570d7624 3831 }
6e710ae5
RS
3832 else
3833 insdef1 = double_dollars (insdef);
570d7624 3834 }
351bd676
KH
3835 else if (!NILP (initial))
3836 {
3837 insdef = initial;
3838 insdef1 = Fcons (double_dollars (insdef), 0);
3839 }
570d7624 3840 else
85b5fe07 3841 insdef = Qnil, insdef1 = Qnil;
570d7624
JB
3842
3843#ifdef VMS
3844 count = specpdl_ptr - specpdl;
3845 specbind (intern ("completion-ignore-case"), Qt);
3846#endif
3847
3848 GCPRO2 (insdef, defalt);
3849 val = Fcompleting_read (prompt, intern ("read-file-name-internal"),
85b5fe07 3850 dir, mustmatch, insdef1,
15c65264 3851 Qfile_name_history);
570d7624
JB
3852
3853#ifdef VMS
3854 unbind_to (count, Qnil);
3855#endif
3856
3857 UNGCPRO;
265a9e55 3858 if (NILP (val))
570d7624
JB
3859 error ("No file name specified");
3860 tem = Fstring_equal (val, insdef);
265a9e55 3861 if (!NILP (tem) && !NILP (defalt))
570d7624 3862 return defalt;
b320926a 3863 if (XSTRING (val)->size == 0 && NILP (insdef))
d9bc1c99
RS
3864 {
3865 if (!NILP (defalt))
3866 return defalt;
3867 else
3868 error ("No default file name");
3869 }
570d7624
JB
3870 return Fsubstitute_in_file_name (val);
3871}
3872
3873#if 0 /* Old version */
3874DEFUN ("read-file-name", Fread_file_name, Sread_file_name, 1, 5, 0,
0de25302
KH
3875 /* Don't confuse make-docfile by having two doc strings for this function.
3876 make-docfile does not pay attention to #if, for good reason! */
3877 0)
570d7624
JB
3878 (prompt, dir, defalt, mustmatch, initial)
3879 Lisp_Object prompt, dir, defalt, mustmatch, initial;
3880{
3881 Lisp_Object val, insdef, tem;
3882 struct gcpro gcpro1, gcpro2;
3883 register char *homedir;
3884 int count;
3885
265a9e55 3886 if (NILP (dir))
570d7624 3887 dir = current_buffer->directory;
265a9e55 3888 if (NILP (defalt))
570d7624
JB
3889 defalt = current_buffer->filename;
3890
3891 /* If dir starts with user's homedir, change that to ~. */
3892 homedir = (char *) egetenv ("HOME");
3893 if (homedir != 0
3894 && XTYPE (dir) == Lisp_String
3895 && !strncmp (homedir, XSTRING (dir)->data, strlen (homedir))
3896 && XSTRING (dir)->data[strlen (homedir)] == '/')
3897 {
3898 dir = make_string (XSTRING (dir)->data + strlen (homedir) - 1,
3899 XSTRING (dir)->size - strlen (homedir) + 1);
3900 XSTRING (dir)->data[0] = '~';
3901 }
3902
265a9e55 3903 if (!NILP (initial))
570d7624
JB
3904 insdef = initial;
3905 else if (insert_default_directory)
3906 insdef = dir;
3907 else
3908 insdef = build_string ("");
3909
3910#ifdef VMS
3911 count = specpdl_ptr - specpdl;
3912 specbind (intern ("completion-ignore-case"), Qt);
3913#endif
3914
3915 GCPRO2 (insdef, defalt);
3916 val = Fcompleting_read (prompt, intern ("read-file-name-internal"),
3917 dir, mustmatch,
15c65264
RS
3918 insert_default_directory ? insdef : Qnil,
3919 Qfile_name_history);
570d7624
JB
3920
3921#ifdef VMS
3922 unbind_to (count, Qnil);
3923#endif
3924
3925 UNGCPRO;
265a9e55 3926 if (NILP (val))
570d7624
JB
3927 error ("No file name specified");
3928 tem = Fstring_equal (val, insdef);
265a9e55 3929 if (!NILP (tem) && !NILP (defalt))
570d7624
JB
3930 return defalt;
3931 return Fsubstitute_in_file_name (val);
3932}
3933#endif /* Old version */
3934\f
3935syms_of_fileio ()
3936{
0bf2eed2
RS
3937 Qexpand_file_name = intern ("expand-file-name");
3938 Qdirectory_file_name = intern ("directory-file-name");
3939 Qfile_name_directory = intern ("file-name-directory");
3940 Qfile_name_nondirectory = intern ("file-name-nondirectory");
642ef245 3941 Qunhandled_file_name_directory = intern ("unhandled-file-name-directory");
0bf2eed2 3942 Qfile_name_as_directory = intern ("file-name-as-directory");
32f4334d
RS
3943 Qcopy_file = intern ("copy-file");
3944 Qmake_directory = intern ("make-directory");
3945 Qdelete_directory = intern ("delete-directory");
3946 Qdelete_file = intern ("delete-file");
3947 Qrename_file = intern ("rename-file");
3948 Qadd_name_to_file = intern ("add-name-to-file");
3949 Qmake_symbolic_link = intern ("make-symbolic-link");
3950 Qfile_exists_p = intern ("file-exists-p");
3951 Qfile_executable_p = intern ("file-executable-p");
3952 Qfile_readable_p = intern ("file-readable-p");
3953 Qfile_symlink_p = intern ("file-symlink-p");
3954 Qfile_writable_p = intern ("file-writable-p");
3955 Qfile_directory_p = intern ("file-directory-p");
3956 Qfile_accessible_directory_p = intern ("file-accessible-directory-p");
3957 Qfile_modes = intern ("file-modes");
3958 Qset_file_modes = intern ("set-file-modes");
3959 Qfile_newer_than_file_p = intern ("file-newer-than-file-p");
3960 Qinsert_file_contents = intern ("insert-file-contents");
3961 Qwrite_region = intern ("write-region");
3962 Qverify_visited_file_modtime = intern ("verify-visited-file-modtime");
3ec46acd 3963 Qset_visited_file_modtime = intern ("set-visited-file-modtime");
32f4334d 3964
642ef245
JB
3965 staticpro (&Qexpand_file_name);
3966 staticpro (&Qdirectory_file_name);
3967 staticpro (&Qfile_name_directory);
3968 staticpro (&Qfile_name_nondirectory);
3969 staticpro (&Qunhandled_file_name_directory);
3970 staticpro (&Qfile_name_as_directory);
15c65264
RS
3971 staticpro (&Qcopy_file);
3972 staticpro (&Qmake_directory);
3973 staticpro (&Qdelete_directory);
3974 staticpro (&Qdelete_file);
3975 staticpro (&Qrename_file);
3976 staticpro (&Qadd_name_to_file);
3977 staticpro (&Qmake_symbolic_link);
3978 staticpro (&Qfile_exists_p);
3979 staticpro (&Qfile_executable_p);
3980 staticpro (&Qfile_readable_p);
3981 staticpro (&Qfile_symlink_p);
3982 staticpro (&Qfile_writable_p);
3983 staticpro (&Qfile_directory_p);
3984 staticpro (&Qfile_accessible_directory_p);
3985 staticpro (&Qfile_modes);
3986 staticpro (&Qset_file_modes);
3987 staticpro (&Qfile_newer_than_file_p);
3988 staticpro (&Qinsert_file_contents);
3989 staticpro (&Qwrite_region);
3990 staticpro (&Qverify_visited_file_modtime);
642ef245
JB
3991
3992 Qfile_name_history = intern ("file-name-history");
3993 Fset (Qfile_name_history, Qnil);
15c65264
RS
3994 staticpro (&Qfile_name_history);
3995
570d7624
JB
3996 Qfile_error = intern ("file-error");
3997 staticpro (&Qfile_error);
3998 Qfile_already_exists = intern("file-already-exists");
3999 staticpro (&Qfile_already_exists);
4000
4c3c22f3
RS
4001#ifdef MSDOS
4002 Qfind_buffer_file_type = intern ("find-buffer-file-type");
4003 staticpro (&Qfind_buffer_file_type);
4004#endif
4005
d6a3cc15
RS
4006 Qcar_less_than_car = intern ("car-less-than-car");
4007 staticpro (&Qcar_less_than_car);
4008
570d7624
JB
4009 Fput (Qfile_error, Qerror_conditions,
4010 Fcons (Qfile_error, Fcons (Qerror, Qnil)));
4011 Fput (Qfile_error, Qerror_message,
4012 build_string ("File error"));
4013
4014 Fput (Qfile_already_exists, Qerror_conditions,
4015 Fcons (Qfile_already_exists,
4016 Fcons (Qfile_error, Fcons (Qerror, Qnil))));
4017 Fput (Qfile_already_exists, Qerror_message,
4018 build_string ("File already exists"));
4019
4020 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory,
4021 "*Non-nil means when reading a filename start with default dir in minibuffer.");
4022 insert_default_directory = 1;
4023
4024 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm,
4025 "*Non-nil means write new files with record format `stmlf'.\n\
4026nil means use format `var'. This variable is meaningful only on VMS.");
4027 vms_stmlf_recfm = 0;
4028
1d1826db
RS
4029 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist,
4030 "*Alist of elements (REGEXP . HANDLER) for file names handled specially.\n\
4031If a file name matches REGEXP, then all I/O on that file is done by calling\n\
4032HANDLER.\n\
4033\n\
4034The first argument given to HANDLER is the name of the I/O primitive\n\
4035to be handled; the remaining arguments are the arguments that were\n\
4036passed to that primitive. For example, if you do\n\
4037 (file-exists-p FILENAME)\n\
4038and FILENAME is handled by HANDLER, then HANDLER is called like this:\n\
642ef245
JB
4039 (funcall HANDLER 'file-exists-p FILENAME)\n\
4040The function `find-file-name-handler' checks this list for a handler\n\
4041for its argument.");
09121adc
RS
4042 Vfile_name_handler_alist = Qnil;
4043
d6a3cc15 4044 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions,
246cfea5
RS
4045 "A list of functions to be called at the end of `insert-file-contents'.\n\
4046Each is passed one argument, the number of bytes inserted. It should return\n\
4047the new byte count, and leave point the same. If `insert-file-contents' is\n\
4048intercepted by a handler from `file-name-handler-alist', that handler is\n\
d6a3cc15
RS
4049responsible for calling the after-insert-file-functions if appropriate.");
4050 Vafter_insert_file_functions = Qnil;
4051
4052 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions,
246cfea5
RS
4053 "A list of functions to be called at the start of `write-region'.\n\
4054Each is passed two arguments, START and END as for `write-region'. It should\n\
4055return a list of pairs (POSITION . STRING) of strings to be effectively\n\
4056inserted at the specified positions of the file being written (1 means to\n\
4057insert before the first byte written). The POSITIONs must be sorted into\n\
4058increasing order. If there are several functions in the list, the several\n\
d6a3cc15
RS
4059lists are merged destructively.");
4060 Vwrite_region_annotate_functions = Qnil;
4061
82c2d839 4062 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers,
a65970a0 4063 "A list of file names for which handlers should not be used.\n\
e3e86241 4064This applies only to the operation `inhibit-file-name-operation'.");
82c2d839
RS
4065 Vinhibit_file_name_handlers = Qnil;
4066
a65970a0
RS
4067 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation,
4068 "The operation for which `inhibit-file-name-handlers' is applicable.");
4069 Vinhibit_file_name_operation = Qnil;
4070
e54d3b5d
RS
4071 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name,
4072 "File name in which we write a list of all auto save file names.");
4073 Vauto_save_list_file_name = Qnil;
4074
642ef245 4075 defsubr (&Sfind_file_name_handler);
570d7624
JB
4076 defsubr (&Sfile_name_directory);
4077 defsubr (&Sfile_name_nondirectory);
642ef245 4078 defsubr (&Sunhandled_file_name_directory);
570d7624
JB
4079 defsubr (&Sfile_name_as_directory);
4080 defsubr (&Sdirectory_file_name);
4081 defsubr (&Smake_temp_name);
4082 defsubr (&Sexpand_file_name);
4083 defsubr (&Ssubstitute_in_file_name);
4084 defsubr (&Scopy_file);
9bbe01fb 4085 defsubr (&Smake_directory_internal);
aa734e17 4086 defsubr (&Sdelete_directory);
570d7624
JB
4087 defsubr (&Sdelete_file);
4088 defsubr (&Srename_file);
4089 defsubr (&Sadd_name_to_file);
4090#ifdef S_IFLNK
4091 defsubr (&Smake_symbolic_link);
4092#endif /* S_IFLNK */
4093#ifdef VMS
4094 defsubr (&Sdefine_logical_name);
4095#endif /* VMS */
4096#ifdef HPUX_NET
4097 defsubr (&Ssysnetunam);
4098#endif /* HPUX_NET */
4099 defsubr (&Sfile_name_absolute_p);
4100 defsubr (&Sfile_exists_p);
4101 defsubr (&Sfile_executable_p);
4102 defsubr (&Sfile_readable_p);
4103 defsubr (&Sfile_writable_p);
4104 defsubr (&Sfile_symlink_p);
4105 defsubr (&Sfile_directory_p);
b72dea2a 4106 defsubr (&Sfile_accessible_directory_p);
570d7624
JB
4107 defsubr (&Sfile_modes);
4108 defsubr (&Sset_file_modes);
c24e9a53
RS
4109 defsubr (&Sset_default_file_modes);
4110 defsubr (&Sdefault_file_modes);
570d7624
JB
4111 defsubr (&Sfile_newer_than_file_p);
4112 defsubr (&Sinsert_file_contents);
4113 defsubr (&Swrite_region);
d6a3cc15 4114 defsubr (&Scar_less_than_car);
570d7624
JB
4115 defsubr (&Sverify_visited_file_modtime);
4116 defsubr (&Sclear_visited_file_modtime);
f5d5eccf 4117 defsubr (&Svisited_file_modtime);
570d7624
JB
4118 defsubr (&Sset_visited_file_modtime);
4119 defsubr (&Sdo_auto_save);
4120 defsubr (&Sset_buffer_auto_saved);
b60247d9 4121 defsubr (&Sclear_buffer_auto_save_failure);
570d7624
JB
4122 defsubr (&Srecent_auto_save_p);
4123
4124 defsubr (&Sread_file_name_internal);
4125 defsubr (&Sread_file_name);
85ffea93 4126
483a2e10 4127#ifdef unix
85ffea93 4128 defsubr (&Sunix_sync);
483a2e10 4129#endif
570d7624 4130}