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