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