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