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