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