]> code.delx.au - gnu-emacs/blob - src/fileio.c
(which-function): Fix documentation/comment typo.
[gnu-emacs] / src / fileio.c
1 /* File IO for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006 Free Software Foundation, Inc.
5
6 This file is part of GNU Emacs.
7
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
11 any later version.
12
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
22
23 #include <config.h>
24
25 #ifdef HAVE_FCNTL_H
26 #include <fcntl.h>
27 #endif
28
29 #include <stdio.h>
30 #include <sys/types.h>
31 #include <sys/stat.h>
32
33 #ifdef HAVE_UNISTD_H
34 #include <unistd.h>
35 #endif
36
37 #if !defined (S_ISLNK) && defined (S_IFLNK)
38 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
39 #endif
40
41 #if !defined (S_ISFIFO) && defined (S_IFIFO)
42 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
43 #endif
44
45 #if !defined (S_ISREG) && defined (S_IFREG)
46 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
47 #endif
48
49 #ifdef HAVE_PWD_H
50 #include <pwd.h>
51 #endif
52
53 #include <ctype.h>
54
55 #ifdef VMS
56 #include "vmsdir.h"
57 #include <perror.h>
58 #include <stddef.h>
59 #include <string.h>
60 #endif
61
62 #include <errno.h>
63
64 #ifndef vax11c
65 #ifndef USE_CRT_DLL
66 extern int errno;
67 #endif
68 #endif
69
70 #ifdef APOLLO
71 #include <sys/time.h>
72 #endif
73
74 #include "lisp.h"
75 #include "intervals.h"
76 #include "buffer.h"
77 #include "charset.h"
78 #include "coding.h"
79 #include "window.h"
80 #include "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 xsignal (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 xsignal (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 xsignal2 (Qfile_already_exists,
2388 build_string ("File already exists"), absname);
2389 GCPRO1 (absname);
2390 tem = format2 ("File %s already exists; %s anyway? ",
2391 absname, build_string (querystring));
2392 if (quick)
2393 tem = Fy_or_n_p (tem);
2394 else
2395 tem = do_yes_or_no_p (tem);
2396 UNGCPRO;
2397 if (NILP (tem))
2398 xsignal2 (Qfile_already_exists,
2399 build_string ("File already exists"), absname);
2400 if (statptr)
2401 *statptr = statbuf;
2402 }
2403 else
2404 {
2405 if (statptr)
2406 statptr->st_mode = 0;
2407 }
2408 return;
2409 }
2410
2411 DEFUN ("copy-file", Fcopy_file, Scopy_file, 2, 5,
2412 "fCopy file: \nGCopy %s to file: \np\nP",
2413 doc: /* Copy FILE to NEWNAME. Both args must be strings.
2414 If NEWNAME names a directory, copy FILE there.
2415
2416 This function always sets the file modes of the output file to match
2417 the input file.
2418
2419 The optional third argument OK-IF-ALREADY-EXISTS specifies what to do
2420 if file NEWNAME already exists. If OK-IF-ALREADY-EXISTS is nil, we
2421 signal a `file-already-exists' error without overwriting. If
2422 OK-IF-ALREADY-EXISTS is a number, we request confirmation from the user
2423 about overwriting; this is what happens in interactive use with M-x.
2424 Any other value for OK-IF-ALREADY-EXISTS means to overwrite the
2425 existing file.
2426
2427 Fourth arg KEEP-TIME non-nil means give the output file the same
2428 last-modified time as the old one. (This works on only some systems.)
2429
2430 A prefix arg makes KEEP-TIME non-nil.
2431
2432 If PRESERVE-UID-GID is non-nil, we try to transfer the
2433 uid and gid of FILE to NEWNAME. */)
2434 (file, newname, ok_if_already_exists, keep_time, preserve_uid_gid)
2435 Lisp_Object file, newname, ok_if_already_exists, keep_time;
2436 Lisp_Object preserve_uid_gid;
2437 {
2438 int ifd, ofd, n;
2439 char buf[16 * 1024];
2440 struct stat st, out_st;
2441 Lisp_Object handler;
2442 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2443 int count = SPECPDL_INDEX ();
2444 int input_file_statable_p;
2445 Lisp_Object encoded_file, encoded_newname;
2446
2447 encoded_file = encoded_newname = Qnil;
2448 GCPRO4 (file, newname, encoded_file, encoded_newname);
2449 CHECK_STRING (file);
2450 CHECK_STRING (newname);
2451
2452 if (!NILP (Ffile_directory_p (newname)))
2453 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2454 else
2455 newname = Fexpand_file_name (newname, Qnil);
2456
2457 file = Fexpand_file_name (file, Qnil);
2458
2459 /* If the input file name has special constructs in it,
2460 call the corresponding file handler. */
2461 handler = Ffind_file_name_handler (file, Qcopy_file);
2462 /* Likewise for output file name. */
2463 if (NILP (handler))
2464 handler = Ffind_file_name_handler (newname, Qcopy_file);
2465 if (!NILP (handler))
2466 RETURN_UNGCPRO (call5 (handler, Qcopy_file, file, newname,
2467 ok_if_already_exists, keep_time));
2468
2469 encoded_file = ENCODE_FILE (file);
2470 encoded_newname = ENCODE_FILE (newname);
2471
2472 if (NILP (ok_if_already_exists)
2473 || INTEGERP (ok_if_already_exists))
2474 barf_or_query_if_file_exists (encoded_newname, "copy to it",
2475 INTEGERP (ok_if_already_exists), &out_st, 0);
2476 else if (stat (SDATA (encoded_newname), &out_st) < 0)
2477 out_st.st_mode = 0;
2478
2479 #ifdef WINDOWSNT
2480 if (!CopyFile (SDATA (encoded_file),
2481 SDATA (encoded_newname),
2482 FALSE))
2483 report_file_error ("Copying file", Fcons (file, Fcons (newname, Qnil)));
2484 /* CopyFile retains the timestamp by default. */
2485 else if (NILP (keep_time))
2486 {
2487 EMACS_TIME now;
2488 DWORD attributes;
2489 char * filename;
2490
2491 EMACS_GET_TIME (now);
2492 filename = SDATA (encoded_newname);
2493
2494 /* Ensure file is writable while its modified time is set. */
2495 attributes = GetFileAttributes (filename);
2496 SetFileAttributes (filename, attributes & ~FILE_ATTRIBUTE_READONLY);
2497 if (set_file_times (filename, now, now))
2498 {
2499 /* Restore original attributes. */
2500 SetFileAttributes (filename, attributes);
2501 xsignal2 (Qfile_date_error,
2502 build_string ("Cannot set file date"), newname);
2503 }
2504 /* Restore original attributes. */
2505 SetFileAttributes (filename, attributes);
2506 }
2507 #else /* not WINDOWSNT */
2508 immediate_quit = 1;
2509 ifd = emacs_open (SDATA (encoded_file), O_RDONLY, 0);
2510 immediate_quit = 0;
2511
2512 if (ifd < 0)
2513 report_file_error ("Opening input file", Fcons (file, Qnil));
2514
2515 record_unwind_protect (close_file_unwind, make_number (ifd));
2516
2517 /* We can only copy regular files and symbolic links. Other files are not
2518 copyable by us. */
2519 input_file_statable_p = (fstat (ifd, &st) >= 0);
2520
2521 #if !defined (MSDOS) || __DJGPP__ > 1
2522 if (out_st.st_mode != 0
2523 && st.st_dev == out_st.st_dev && st.st_ino == out_st.st_ino)
2524 {
2525 errno = 0;
2526 report_file_error ("Input and output files are the same",
2527 Fcons (file, Fcons (newname, Qnil)));
2528 }
2529 #endif
2530
2531 #if defined (S_ISREG) && defined (S_ISLNK)
2532 if (input_file_statable_p)
2533 {
2534 if (!(S_ISREG (st.st_mode)) && !(S_ISLNK (st.st_mode)))
2535 {
2536 #if defined (EISDIR)
2537 /* Get a better looking error message. */
2538 errno = EISDIR;
2539 #endif /* EISDIR */
2540 report_file_error ("Non-regular file", Fcons (file, Qnil));
2541 }
2542 }
2543 #endif /* S_ISREG && S_ISLNK */
2544
2545 #ifdef VMS
2546 /* Create the copy file with the same record format as the input file */
2547 ofd = sys_creat (SDATA (encoded_newname), 0666, ifd);
2548 #else
2549 #ifdef MSDOS
2550 /* System's default file type was set to binary by _fmode in emacs.c. */
2551 ofd = emacs_open (SDATA (encoded_newname),
2552 O_WRONLY | O_TRUNC | O_CREAT
2553 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2554 S_IREAD | S_IWRITE);
2555 #else /* not MSDOS */
2556 ofd = emacs_open (SDATA (encoded_newname),
2557 O_WRONLY | O_TRUNC | O_CREAT
2558 | (NILP (ok_if_already_exists) ? O_EXCL : 0),
2559 0666);
2560 #endif /* not MSDOS */
2561 #endif /* VMS */
2562 if (ofd < 0)
2563 report_file_error ("Opening output file", Fcons (newname, Qnil));
2564
2565 record_unwind_protect (close_file_unwind, make_number (ofd));
2566
2567 immediate_quit = 1;
2568 QUIT;
2569 while ((n = emacs_read (ifd, buf, sizeof buf)) > 0)
2570 if (emacs_write (ofd, buf, n) != n)
2571 report_file_error ("I/O error", Fcons (newname, Qnil));
2572 immediate_quit = 0;
2573
2574 #ifndef MSDOS
2575 /* Preserve the original file modes, and if requested, also its
2576 owner and group. */
2577 if (input_file_statable_p)
2578 {
2579 if (! NILP (preserve_uid_gid))
2580 fchown (ofd, st.st_uid, st.st_gid);
2581 fchmod (ofd, st.st_mode & 07777);
2582 }
2583 #endif /* not MSDOS */
2584
2585 /* Closing the output clobbers the file times on some systems. */
2586 if (emacs_close (ofd) < 0)
2587 report_file_error ("I/O error", Fcons (newname, Qnil));
2588
2589 if (input_file_statable_p)
2590 {
2591 if (!NILP (keep_time))
2592 {
2593 EMACS_TIME atime, mtime;
2594 EMACS_SET_SECS_USECS (atime, st.st_atime, 0);
2595 EMACS_SET_SECS_USECS (mtime, st.st_mtime, 0);
2596 if (set_file_times (SDATA (encoded_newname),
2597 atime, mtime))
2598 xsignal2 (Qfile_date_error,
2599 build_string ("Cannot set file date"), newname);
2600 }
2601 }
2602
2603 emacs_close (ifd);
2604
2605 #if defined (__DJGPP__) && __DJGPP__ > 1
2606 if (input_file_statable_p)
2607 {
2608 /* In DJGPP v2.0 and later, fstat usually returns true file mode bits,
2609 and if it can't, it tells so. Otherwise, under MSDOS we usually
2610 get only the READ bit, which will make the copied file read-only,
2611 so it's better not to chmod at all. */
2612 if ((_djstat_flags & _STFAIL_WRITEBIT) == 0)
2613 chmod (SDATA (encoded_newname), st.st_mode & 07777);
2614 }
2615 #endif /* DJGPP version 2 or newer */
2616 #endif /* not WINDOWSNT */
2617
2618 /* Discard the unwind protects. */
2619 specpdl_ptr = specpdl + count;
2620
2621 UNGCPRO;
2622 return Qnil;
2623 }
2624 \f
2625 DEFUN ("make-directory-internal", Fmake_directory_internal,
2626 Smake_directory_internal, 1, 1, 0,
2627 doc: /* Create a new directory named DIRECTORY. */)
2628 (directory)
2629 Lisp_Object directory;
2630 {
2631 const unsigned char *dir;
2632 Lisp_Object handler;
2633 Lisp_Object encoded_dir;
2634
2635 CHECK_STRING (directory);
2636 directory = Fexpand_file_name (directory, Qnil);
2637
2638 handler = Ffind_file_name_handler (directory, Qmake_directory_internal);
2639 if (!NILP (handler))
2640 return call2 (handler, Qmake_directory_internal, directory);
2641
2642 encoded_dir = ENCODE_FILE (directory);
2643
2644 dir = SDATA (encoded_dir);
2645
2646 #ifdef WINDOWSNT
2647 if (mkdir (dir) != 0)
2648 #else
2649 if (mkdir (dir, 0777) != 0)
2650 #endif
2651 report_file_error ("Creating directory", Flist (1, &directory));
2652
2653 return Qnil;
2654 }
2655
2656 DEFUN ("delete-directory", Fdelete_directory, Sdelete_directory, 1, 1, "FDelete directory: ",
2657 doc: /* Delete the directory named DIRECTORY. Does not follow symlinks. */)
2658 (directory)
2659 Lisp_Object directory;
2660 {
2661 const unsigned char *dir;
2662 Lisp_Object handler;
2663 Lisp_Object encoded_dir;
2664
2665 CHECK_STRING (directory);
2666 directory = Fdirectory_file_name (Fexpand_file_name (directory, Qnil));
2667
2668 handler = Ffind_file_name_handler (directory, Qdelete_directory);
2669 if (!NILP (handler))
2670 return call2 (handler, Qdelete_directory, directory);
2671
2672 encoded_dir = ENCODE_FILE (directory);
2673
2674 dir = SDATA (encoded_dir);
2675
2676 if (rmdir (dir) != 0)
2677 report_file_error ("Removing directory", Flist (1, &directory));
2678
2679 return Qnil;
2680 }
2681
2682 DEFUN ("delete-file", Fdelete_file, Sdelete_file, 1, 1, "fDelete file: ",
2683 doc: /* Delete file named FILENAME. If it is a symlink, remove the symlink.
2684 If file has multiple names, it continues to exist with the other names. */)
2685 (filename)
2686 Lisp_Object filename;
2687 {
2688 Lisp_Object handler;
2689 Lisp_Object encoded_file;
2690 struct gcpro gcpro1;
2691
2692 GCPRO1 (filename);
2693 if (!NILP (Ffile_directory_p (filename))
2694 && NILP (Ffile_symlink_p (filename)))
2695 xsignal2 (Qfile_error,
2696 build_string ("Removing old name: is a directory"),
2697 filename);
2698 UNGCPRO;
2699 filename = Fexpand_file_name (filename, Qnil);
2700
2701 handler = Ffind_file_name_handler (filename, Qdelete_file);
2702 if (!NILP (handler))
2703 return call2 (handler, Qdelete_file, filename);
2704
2705 encoded_file = ENCODE_FILE (filename);
2706
2707 if (0 > unlink (SDATA (encoded_file)))
2708 report_file_error ("Removing old name", Flist (1, &filename));
2709 return Qnil;
2710 }
2711
2712 static Lisp_Object
2713 internal_delete_file_1 (ignore)
2714 Lisp_Object ignore;
2715 {
2716 return Qt;
2717 }
2718
2719 /* Delete file FILENAME, returning 1 if successful and 0 if failed. */
2720
2721 int
2722 internal_delete_file (filename)
2723 Lisp_Object filename;
2724 {
2725 Lisp_Object tem;
2726 tem = internal_condition_case_1 (Fdelete_file, filename,
2727 Qt, internal_delete_file_1);
2728 return NILP (tem);
2729 }
2730 \f
2731 DEFUN ("rename-file", Frename_file, Srename_file, 2, 3,
2732 "fRename file: \nGRename %s to file: \np",
2733 doc: /* Rename FILE as NEWNAME. Both args must be strings.
2734 If file has names other than FILE, it continues to have those names.
2735 Signals a `file-already-exists' error if a file NEWNAME already exists
2736 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2737 A number as third arg means request confirmation if NEWNAME already exists.
2738 This is what happens in interactive use with M-x. */)
2739 (file, newname, ok_if_already_exists)
2740 Lisp_Object file, newname, ok_if_already_exists;
2741 {
2742 #ifdef NO_ARG_ARRAY
2743 Lisp_Object args[2];
2744 #endif
2745 Lisp_Object handler;
2746 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
2747 Lisp_Object encoded_file, encoded_newname, symlink_target;
2748
2749 symlink_target = encoded_file = encoded_newname = Qnil;
2750 GCPRO5 (file, newname, encoded_file, encoded_newname, symlink_target);
2751 CHECK_STRING (file);
2752 CHECK_STRING (newname);
2753 file = Fexpand_file_name (file, Qnil);
2754
2755 if ((!NILP (Ffile_directory_p (newname)))
2756 #ifdef DOS_NT
2757 /* If the file names are identical but for the case,
2758 don't attempt to move directory to itself. */
2759 && (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2760 #endif
2761 )
2762 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2763 else
2764 newname = Fexpand_file_name (newname, Qnil);
2765
2766 /* If the file name has special constructs in it,
2767 call the corresponding file handler. */
2768 handler = Ffind_file_name_handler (file, Qrename_file);
2769 if (NILP (handler))
2770 handler = Ffind_file_name_handler (newname, Qrename_file);
2771 if (!NILP (handler))
2772 RETURN_UNGCPRO (call4 (handler, Qrename_file,
2773 file, newname, ok_if_already_exists));
2774
2775 encoded_file = ENCODE_FILE (file);
2776 encoded_newname = ENCODE_FILE (newname);
2777
2778 #ifdef DOS_NT
2779 /* If the file names are identical but for the case, don't ask for
2780 confirmation: they simply want to change the letter-case of the
2781 file name. */
2782 if (NILP (Fstring_equal (Fdowncase (file), Fdowncase (newname))))
2783 #endif
2784 if (NILP (ok_if_already_exists)
2785 || INTEGERP (ok_if_already_exists))
2786 barf_or_query_if_file_exists (encoded_newname, "rename to it",
2787 INTEGERP (ok_if_already_exists), 0, 0);
2788 #ifndef BSD4_1
2789 if (0 > rename (SDATA (encoded_file), SDATA (encoded_newname)))
2790 #else
2791 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname))
2792 || 0 > unlink (SDATA (encoded_file)))
2793 #endif
2794 {
2795 if (errno == EXDEV)
2796 {
2797 #ifdef S_IFLNK
2798 symlink_target = Ffile_symlink_p (file);
2799 if (! NILP (symlink_target))
2800 Fmake_symbolic_link (symlink_target, newname,
2801 NILP (ok_if_already_exists) ? Qnil : Qt);
2802 else
2803 #endif
2804 Fcopy_file (file, newname,
2805 /* We have already prompted if it was an integer,
2806 so don't have copy-file prompt again. */
2807 NILP (ok_if_already_exists) ? Qnil : Qt,
2808 Qt, Qt);
2809
2810 Fdelete_file (file);
2811 }
2812 else
2813 #ifdef NO_ARG_ARRAY
2814 {
2815 args[0] = file;
2816 args[1] = newname;
2817 report_file_error ("Renaming", Flist (2, args));
2818 }
2819 #else
2820 report_file_error ("Renaming", Flist (2, &file));
2821 #endif
2822 }
2823 UNGCPRO;
2824 return Qnil;
2825 }
2826
2827 DEFUN ("add-name-to-file", Fadd_name_to_file, Sadd_name_to_file, 2, 3,
2828 "fAdd name to file: \nGName to add to %s: \np",
2829 doc: /* Give FILE additional name NEWNAME. Both args must be strings.
2830 Signals a `file-already-exists' error if a file NEWNAME already exists
2831 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2832 A number as third arg means request confirmation if NEWNAME already exists.
2833 This is what happens in interactive use with M-x. */)
2834 (file, newname, ok_if_already_exists)
2835 Lisp_Object file, newname, ok_if_already_exists;
2836 {
2837 #ifdef NO_ARG_ARRAY
2838 Lisp_Object args[2];
2839 #endif
2840 Lisp_Object handler;
2841 Lisp_Object encoded_file, encoded_newname;
2842 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2843
2844 GCPRO4 (file, newname, encoded_file, encoded_newname);
2845 encoded_file = encoded_newname = Qnil;
2846 CHECK_STRING (file);
2847 CHECK_STRING (newname);
2848 file = Fexpand_file_name (file, Qnil);
2849
2850 if (!NILP (Ffile_directory_p (newname)))
2851 newname = Fexpand_file_name (Ffile_name_nondirectory (file), newname);
2852 else
2853 newname = Fexpand_file_name (newname, Qnil);
2854
2855 /* If the file name has special constructs in it,
2856 call the corresponding file handler. */
2857 handler = Ffind_file_name_handler (file, Qadd_name_to_file);
2858 if (!NILP (handler))
2859 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2860 newname, ok_if_already_exists));
2861
2862 /* If the new name has special constructs in it,
2863 call the corresponding file handler. */
2864 handler = Ffind_file_name_handler (newname, Qadd_name_to_file);
2865 if (!NILP (handler))
2866 RETURN_UNGCPRO (call4 (handler, Qadd_name_to_file, file,
2867 newname, ok_if_already_exists));
2868
2869 encoded_file = ENCODE_FILE (file);
2870 encoded_newname = ENCODE_FILE (newname);
2871
2872 if (NILP (ok_if_already_exists)
2873 || INTEGERP (ok_if_already_exists))
2874 barf_or_query_if_file_exists (encoded_newname, "make it a new name",
2875 INTEGERP (ok_if_already_exists), 0, 0);
2876
2877 unlink (SDATA (newname));
2878 if (0 > link (SDATA (encoded_file), SDATA (encoded_newname)))
2879 {
2880 #ifdef NO_ARG_ARRAY
2881 args[0] = file;
2882 args[1] = newname;
2883 report_file_error ("Adding new name", Flist (2, args));
2884 #else
2885 report_file_error ("Adding new name", Flist (2, &file));
2886 #endif
2887 }
2888
2889 UNGCPRO;
2890 return Qnil;
2891 }
2892
2893 #ifdef S_IFLNK
2894 DEFUN ("make-symbolic-link", Fmake_symbolic_link, Smake_symbolic_link, 2, 3,
2895 "FMake symbolic link to file: \nGMake symbolic link to file %s: \np",
2896 doc: /* Make a symbolic link to FILENAME, named LINKNAME.
2897 Both args must be strings.
2898 Signals a `file-already-exists' error if a file LINKNAME already exists
2899 unless optional third argument OK-IF-ALREADY-EXISTS is non-nil.
2900 A number as third arg means request confirmation if LINKNAME already exists.
2901 This happens for interactive use with M-x. */)
2902 (filename, linkname, ok_if_already_exists)
2903 Lisp_Object filename, linkname, ok_if_already_exists;
2904 {
2905 #ifdef NO_ARG_ARRAY
2906 Lisp_Object args[2];
2907 #endif
2908 Lisp_Object handler;
2909 Lisp_Object encoded_filename, encoded_linkname;
2910 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2911
2912 GCPRO4 (filename, linkname, encoded_filename, encoded_linkname);
2913 encoded_filename = encoded_linkname = Qnil;
2914 CHECK_STRING (filename);
2915 CHECK_STRING (linkname);
2916 /* If the link target has a ~, we must expand it to get
2917 a truly valid file name. Otherwise, do not expand;
2918 we want to permit links to relative file names. */
2919 if (SREF (filename, 0) == '~')
2920 filename = Fexpand_file_name (filename, Qnil);
2921
2922 if (!NILP (Ffile_directory_p (linkname)))
2923 linkname = Fexpand_file_name (Ffile_name_nondirectory (filename), linkname);
2924 else
2925 linkname = Fexpand_file_name (linkname, Qnil);
2926
2927 /* If the file name has special constructs in it,
2928 call the corresponding file handler. */
2929 handler = Ffind_file_name_handler (filename, Qmake_symbolic_link);
2930 if (!NILP (handler))
2931 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2932 linkname, ok_if_already_exists));
2933
2934 /* If the new link name has special constructs in it,
2935 call the corresponding file handler. */
2936 handler = Ffind_file_name_handler (linkname, Qmake_symbolic_link);
2937 if (!NILP (handler))
2938 RETURN_UNGCPRO (call4 (handler, Qmake_symbolic_link, filename,
2939 linkname, ok_if_already_exists));
2940
2941 encoded_filename = ENCODE_FILE (filename);
2942 encoded_linkname = ENCODE_FILE (linkname);
2943
2944 if (NILP (ok_if_already_exists)
2945 || INTEGERP (ok_if_already_exists))
2946 barf_or_query_if_file_exists (encoded_linkname, "make it a link",
2947 INTEGERP (ok_if_already_exists), 0, 0);
2948 if (0 > symlink (SDATA (encoded_filename),
2949 SDATA (encoded_linkname)))
2950 {
2951 /* If we didn't complain already, silently delete existing file. */
2952 if (errno == EEXIST)
2953 {
2954 unlink (SDATA (encoded_linkname));
2955 if (0 <= symlink (SDATA (encoded_filename),
2956 SDATA (encoded_linkname)))
2957 {
2958 UNGCPRO;
2959 return Qnil;
2960 }
2961 }
2962
2963 #ifdef NO_ARG_ARRAY
2964 args[0] = filename;
2965 args[1] = linkname;
2966 report_file_error ("Making symbolic link", Flist (2, args));
2967 #else
2968 report_file_error ("Making symbolic link", Flist (2, &filename));
2969 #endif
2970 }
2971 UNGCPRO;
2972 return Qnil;
2973 }
2974 #endif /* S_IFLNK */
2975
2976 #ifdef VMS
2977
2978 DEFUN ("define-logical-name", Fdefine_logical_name, Sdefine_logical_name,
2979 2, 2, "sDefine logical name: \nsDefine logical name %s as: ",
2980 doc: /* Define the job-wide logical name NAME to have the value STRING.
2981 If STRING is nil or a null string, the logical name NAME is deleted. */)
2982 (name, string)
2983 Lisp_Object name;
2984 Lisp_Object string;
2985 {
2986 CHECK_STRING (name);
2987 if (NILP (string))
2988 delete_logical_name (SDATA (name));
2989 else
2990 {
2991 CHECK_STRING (string);
2992
2993 if (SCHARS (string) == 0)
2994 delete_logical_name (SDATA (name));
2995 else
2996 define_logical_name (SDATA (name), SDATA (string));
2997 }
2998
2999 return string;
3000 }
3001 #endif /* VMS */
3002
3003 #ifdef HPUX_NET
3004
3005 DEFUN ("sysnetunam", Fsysnetunam, Ssysnetunam, 2, 2, 0,
3006 doc: /* Open a network connection to PATH using LOGIN as the login string. */)
3007 (path, login)
3008 Lisp_Object path, login;
3009 {
3010 int netresult;
3011
3012 CHECK_STRING (path);
3013 CHECK_STRING (login);
3014
3015 netresult = netunam (SDATA (path), SDATA (login));
3016
3017 if (netresult == -1)
3018 return Qnil;
3019 else
3020 return Qt;
3021 }
3022 #endif /* HPUX_NET */
3023 \f
3024 DEFUN ("file-name-absolute-p", Ffile_name_absolute_p, Sfile_name_absolute_p,
3025 1, 1, 0,
3026 doc: /* Return t if file FILENAME specifies an absolute file name.
3027 On Unix, this is a name starting with a `/' or a `~'. */)
3028 (filename)
3029 Lisp_Object filename;
3030 {
3031 CHECK_STRING (filename);
3032 return file_name_absolute_p (SDATA (filename)) ? Qt : Qnil;
3033 }
3034 \f
3035 /* Return nonzero if file FILENAME exists and can be executed. */
3036
3037 static int
3038 check_executable (filename)
3039 char *filename;
3040 {
3041 #ifdef DOS_NT
3042 int len = strlen (filename);
3043 char *suffix;
3044 struct stat st;
3045 if (stat (filename, &st) < 0)
3046 return 0;
3047 #if defined (WINDOWSNT) || (defined (MSDOS) && __DJGPP__ > 1)
3048 return ((st.st_mode & S_IEXEC) != 0);
3049 #else
3050 return (S_ISREG (st.st_mode)
3051 && len >= 5
3052 && (stricmp ((suffix = filename + len-4), ".com") == 0
3053 || stricmp (suffix, ".exe") == 0
3054 || stricmp (suffix, ".bat") == 0)
3055 || (st.st_mode & S_IFMT) == S_IFDIR);
3056 #endif /* not WINDOWSNT */
3057 #else /* not DOS_NT */
3058 #ifdef HAVE_EUIDACCESS
3059 return (euidaccess (filename, 1) >= 0);
3060 #else
3061 /* Access isn't quite right because it uses the real uid
3062 and we really want to test with the effective uid.
3063 But Unix doesn't give us a right way to do it. */
3064 return (access (filename, 1) >= 0);
3065 #endif
3066 #endif /* not DOS_NT */
3067 }
3068
3069 /* Return nonzero if file FILENAME exists and can be written. */
3070
3071 static int
3072 check_writable (filename)
3073 char *filename;
3074 {
3075 #ifdef MSDOS
3076 struct stat st;
3077 if (stat (filename, &st) < 0)
3078 return 0;
3079 return (st.st_mode & S_IWRITE || (st.st_mode & S_IFMT) == S_IFDIR);
3080 #else /* not MSDOS */
3081 #ifdef HAVE_EUIDACCESS
3082 return (euidaccess (filename, 2) >= 0);
3083 #else
3084 /* Access isn't quite right because it uses the real uid
3085 and we really want to test with the effective uid.
3086 But Unix doesn't give us a right way to do it.
3087 Opening with O_WRONLY could work for an ordinary file,
3088 but would lose for directories. */
3089 return (access (filename, 2) >= 0);
3090 #endif
3091 #endif /* not MSDOS */
3092 }
3093
3094 DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
3095 doc: /* Return t if file FILENAME exists (whether or not you can read it.)
3096 See also `file-readable-p' and `file-attributes'.
3097 This returns nil for a symlink to a nonexistent file.
3098 Use `file-symlink-p' to test for such links. */)
3099 (filename)
3100 Lisp_Object filename;
3101 {
3102 Lisp_Object absname;
3103 Lisp_Object handler;
3104 struct stat statbuf;
3105
3106 CHECK_STRING (filename);
3107 absname = Fexpand_file_name (filename, Qnil);
3108
3109 /* If the file name has special constructs in it,
3110 call the corresponding file handler. */
3111 handler = Ffind_file_name_handler (absname, Qfile_exists_p);
3112 if (!NILP (handler))
3113 return call2 (handler, Qfile_exists_p, absname);
3114
3115 absname = ENCODE_FILE (absname);
3116
3117 return (stat (SDATA (absname), &statbuf) >= 0) ? Qt : Qnil;
3118 }
3119
3120 DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0,
3121 doc: /* Return t if FILENAME can be executed by you.
3122 For a directory, this means you can access files in that directory. */)
3123 (filename)
3124 Lisp_Object filename;
3125 {
3126 Lisp_Object absname;
3127 Lisp_Object handler;
3128
3129 CHECK_STRING (filename);
3130 absname = Fexpand_file_name (filename, Qnil);
3131
3132 /* If the file name has special constructs in it,
3133 call the corresponding file handler. */
3134 handler = Ffind_file_name_handler (absname, Qfile_executable_p);
3135 if (!NILP (handler))
3136 return call2 (handler, Qfile_executable_p, absname);
3137
3138 absname = ENCODE_FILE (absname);
3139
3140 return (check_executable (SDATA (absname)) ? Qt : Qnil);
3141 }
3142
3143 DEFUN ("file-readable-p", Ffile_readable_p, Sfile_readable_p, 1, 1, 0,
3144 doc: /* Return t if file FILENAME exists and you can read it.
3145 See also `file-exists-p' and `file-attributes'. */)
3146 (filename)
3147 Lisp_Object filename;
3148 {
3149 Lisp_Object absname;
3150 Lisp_Object handler;
3151 int desc;
3152 int flags;
3153 struct stat statbuf;
3154
3155 CHECK_STRING (filename);
3156 absname = Fexpand_file_name (filename, Qnil);
3157
3158 /* If the file name has special constructs in it,
3159 call the corresponding file handler. */
3160 handler = Ffind_file_name_handler (absname, Qfile_readable_p);
3161 if (!NILP (handler))
3162 return call2 (handler, Qfile_readable_p, absname);
3163
3164 absname = ENCODE_FILE (absname);
3165
3166 #if defined(DOS_NT) || defined(macintosh)
3167 /* Under MS-DOS, Windows, and Macintosh, open does not work for
3168 directories. */
3169 if (access (SDATA (absname), 0) == 0)
3170 return Qt;
3171 return Qnil;
3172 #else /* not DOS_NT and not macintosh */
3173 flags = O_RDONLY;
3174 #if defined (S_ISFIFO) && defined (O_NONBLOCK)
3175 /* Opening a fifo without O_NONBLOCK can wait.
3176 We don't want to wait. But we don't want to mess wth O_NONBLOCK
3177 except in the case of a fifo, on a system which handles it. */
3178 desc = stat (SDATA (absname), &statbuf);
3179 if (desc < 0)
3180 return Qnil;
3181 if (S_ISFIFO (statbuf.st_mode))
3182 flags |= O_NONBLOCK;
3183 #endif
3184 desc = emacs_open (SDATA (absname), flags, 0);
3185 if (desc < 0)
3186 return Qnil;
3187 emacs_close (desc);
3188 return Qt;
3189 #endif /* not DOS_NT and not macintosh */
3190 }
3191
3192 /* Having this before file-symlink-p mysteriously caused it to be forgotten
3193 on the RT/PC. */
3194 DEFUN ("file-writable-p", Ffile_writable_p, Sfile_writable_p, 1, 1, 0,
3195 doc: /* Return t if file FILENAME can be written or created by you. */)
3196 (filename)
3197 Lisp_Object filename;
3198 {
3199 Lisp_Object absname, dir, encoded;
3200 Lisp_Object handler;
3201 struct stat statbuf;
3202
3203 CHECK_STRING (filename);
3204 absname = Fexpand_file_name (filename, Qnil);
3205
3206 /* If the file name has special constructs in it,
3207 call the corresponding file handler. */
3208 handler = Ffind_file_name_handler (absname, Qfile_writable_p);
3209 if (!NILP (handler))
3210 return call2 (handler, Qfile_writable_p, absname);
3211
3212 encoded = ENCODE_FILE (absname);
3213 if (stat (SDATA (encoded), &statbuf) >= 0)
3214 return (check_writable (SDATA (encoded))
3215 ? Qt : Qnil);
3216
3217 dir = Ffile_name_directory (absname);
3218 #ifdef VMS
3219 if (!NILP (dir))
3220 dir = Fdirectory_file_name (dir);
3221 #endif /* VMS */
3222 #ifdef MSDOS
3223 if (!NILP (dir))
3224 dir = Fdirectory_file_name (dir);
3225 #endif /* MSDOS */
3226
3227 dir = ENCODE_FILE (dir);
3228 #ifdef WINDOWSNT
3229 /* The read-only attribute of the parent directory doesn't affect
3230 whether a file or directory can be created within it. Some day we
3231 should check ACLs though, which do affect this. */
3232 if (stat (SDATA (dir), &statbuf) < 0)
3233 return Qnil;
3234 return (statbuf.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3235 #else
3236 return (check_writable (!NILP (dir) ? (char *) SDATA (dir) : "")
3237 ? Qt : Qnil);
3238 #endif
3239 }
3240 \f
3241 DEFUN ("access-file", Faccess_file, Saccess_file, 2, 2, 0,
3242 doc: /* Access file FILENAME, and get an error if that does not work.
3243 The second argument STRING is used in the error message.
3244 If there is no error, returns nil. */)
3245 (filename, string)
3246 Lisp_Object filename, string;
3247 {
3248 Lisp_Object handler, encoded_filename, absname;
3249 int fd;
3250
3251 CHECK_STRING (filename);
3252 absname = Fexpand_file_name (filename, Qnil);
3253
3254 CHECK_STRING (string);
3255
3256 /* If the file name has special constructs in it,
3257 call the corresponding file handler. */
3258 handler = Ffind_file_name_handler (absname, Qaccess_file);
3259 if (!NILP (handler))
3260 return call3 (handler, Qaccess_file, absname, string);
3261
3262 encoded_filename = ENCODE_FILE (absname);
3263
3264 fd = emacs_open (SDATA (encoded_filename), O_RDONLY, 0);
3265 if (fd < 0)
3266 report_file_error (SDATA (string), Fcons (filename, Qnil));
3267 emacs_close (fd);
3268
3269 return Qnil;
3270 }
3271 \f
3272 DEFUN ("file-symlink-p", Ffile_symlink_p, Sfile_symlink_p, 1, 1, 0,
3273 doc: /* Return non-nil if file FILENAME is the name of a symbolic link.
3274 The value is the link target, as a string.
3275 Otherwise it returns nil.
3276
3277 This function returns t when given the name of a symlink that
3278 points to a nonexistent file. */)
3279 (filename)
3280 Lisp_Object filename;
3281 {
3282 Lisp_Object handler;
3283
3284 CHECK_STRING (filename);
3285 filename = Fexpand_file_name (filename, Qnil);
3286
3287 /* If the file name has special constructs in it,
3288 call the corresponding file handler. */
3289 handler = Ffind_file_name_handler (filename, Qfile_symlink_p);
3290 if (!NILP (handler))
3291 return call2 (handler, Qfile_symlink_p, filename);
3292
3293 #ifdef S_IFLNK
3294 {
3295 char *buf;
3296 int bufsize;
3297 int valsize;
3298 Lisp_Object val;
3299
3300 filename = ENCODE_FILE (filename);
3301
3302 bufsize = 50;
3303 buf = NULL;
3304 do
3305 {
3306 bufsize *= 2;
3307 buf = (char *) xrealloc (buf, bufsize);
3308 bzero (buf, bufsize);
3309
3310 errno = 0;
3311 valsize = readlink (SDATA (filename), buf, bufsize);
3312 if (valsize == -1)
3313 {
3314 #ifdef ERANGE
3315 /* HP-UX reports ERANGE if buffer is too small. */
3316 if (errno == ERANGE)
3317 valsize = bufsize;
3318 else
3319 #endif
3320 {
3321 xfree (buf);
3322 return Qnil;
3323 }
3324 }
3325 }
3326 while (valsize >= bufsize);
3327
3328 val = make_string (buf, valsize);
3329 if (buf[0] == '/' && index (buf, ':'))
3330 val = concat2 (build_string ("/:"), val);
3331 xfree (buf);
3332 val = DECODE_FILE (val);
3333 return val;
3334 }
3335 #else /* not S_IFLNK */
3336 return Qnil;
3337 #endif /* not S_IFLNK */
3338 }
3339
3340 DEFUN ("file-directory-p", Ffile_directory_p, Sfile_directory_p, 1, 1, 0,
3341 doc: /* Return t if FILENAME names an existing directory.
3342 Symbolic links to directories count as directories.
3343 See `file-symlink-p' to distinguish symlinks. */)
3344 (filename)
3345 Lisp_Object filename;
3346 {
3347 register Lisp_Object absname;
3348 struct stat st;
3349 Lisp_Object handler;
3350
3351 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3352
3353 /* If the file name has special constructs in it,
3354 call the corresponding file handler. */
3355 handler = Ffind_file_name_handler (absname, Qfile_directory_p);
3356 if (!NILP (handler))
3357 return call2 (handler, Qfile_directory_p, absname);
3358
3359 absname = ENCODE_FILE (absname);
3360
3361 if (stat (SDATA (absname), &st) < 0)
3362 return Qnil;
3363 return (st.st_mode & S_IFMT) == S_IFDIR ? Qt : Qnil;
3364 }
3365
3366 DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0,
3367 doc: /* Return t if file FILENAME names a directory you can open.
3368 For the value to be t, FILENAME must specify the name of a directory as a file,
3369 and the directory must allow you to open files in it. In order to use a
3370 directory as a buffer's current directory, this predicate must return true.
3371 A directory name spec may be given instead; then the value is t
3372 if the directory so specified exists and really is a readable and
3373 searchable directory. */)
3374 (filename)
3375 Lisp_Object filename;
3376 {
3377 Lisp_Object handler;
3378 int tem;
3379 struct gcpro gcpro1;
3380
3381 /* If the file name has special constructs in it,
3382 call the corresponding file handler. */
3383 handler = Ffind_file_name_handler (filename, Qfile_accessible_directory_p);
3384 if (!NILP (handler))
3385 return call2 (handler, Qfile_accessible_directory_p, filename);
3386
3387 GCPRO1 (filename);
3388 tem = (NILP (Ffile_directory_p (filename))
3389 || NILP (Ffile_executable_p (filename)));
3390 UNGCPRO;
3391 return tem ? Qnil : Qt;
3392 }
3393
3394 DEFUN ("file-regular-p", Ffile_regular_p, Sfile_regular_p, 1, 1, 0,
3395 doc: /* Return t if FILENAME names a regular file.
3396 This is the sort of file that holds an ordinary stream of data bytes.
3397 Symbolic links to regular files count as regular files.
3398 See `file-symlink-p' to distinguish symlinks. */)
3399 (filename)
3400 Lisp_Object filename;
3401 {
3402 register Lisp_Object absname;
3403 struct stat st;
3404 Lisp_Object handler;
3405
3406 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3407
3408 /* If the file name has special constructs in it,
3409 call the corresponding file handler. */
3410 handler = Ffind_file_name_handler (absname, Qfile_regular_p);
3411 if (!NILP (handler))
3412 return call2 (handler, Qfile_regular_p, absname);
3413
3414 absname = ENCODE_FILE (absname);
3415
3416 #ifdef WINDOWSNT
3417 {
3418 int result;
3419 Lisp_Object tem = Vw32_get_true_file_attributes;
3420
3421 /* Tell stat to use expensive method to get accurate info. */
3422 Vw32_get_true_file_attributes = Qt;
3423 result = stat (SDATA (absname), &st);
3424 Vw32_get_true_file_attributes = tem;
3425
3426 if (result < 0)
3427 return Qnil;
3428 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3429 }
3430 #else
3431 if (stat (SDATA (absname), &st) < 0)
3432 return Qnil;
3433 return (st.st_mode & S_IFMT) == S_IFREG ? Qt : Qnil;
3434 #endif
3435 }
3436 \f
3437 DEFUN ("file-modes", Ffile_modes, Sfile_modes, 1, 1, 0,
3438 doc: /* Return mode bits of file named FILENAME, as an integer.
3439 Return nil, if file does not exist or is not accessible. */)
3440 (filename)
3441 Lisp_Object filename;
3442 {
3443 Lisp_Object absname;
3444 struct stat st;
3445 Lisp_Object handler;
3446
3447 absname = expand_and_dir_to_file (filename, current_buffer->directory);
3448
3449 /* If the file name has special constructs in it,
3450 call the corresponding file handler. */
3451 handler = Ffind_file_name_handler (absname, Qfile_modes);
3452 if (!NILP (handler))
3453 return call2 (handler, Qfile_modes, absname);
3454
3455 absname = ENCODE_FILE (absname);
3456
3457 if (stat (SDATA (absname), &st) < 0)
3458 return Qnil;
3459 #if defined (MSDOS) && __DJGPP__ < 2
3460 if (check_executable (SDATA (absname)))
3461 st.st_mode |= S_IEXEC;
3462 #endif /* MSDOS && __DJGPP__ < 2 */
3463
3464 return make_number (st.st_mode & 07777);
3465 }
3466
3467 DEFUN ("set-file-modes", Fset_file_modes, Sset_file_modes, 2, 2, 0,
3468 doc: /* Set mode bits of file named FILENAME to MODE (an integer).
3469 Only the 12 low bits of MODE are used. */)
3470 (filename, mode)
3471 Lisp_Object filename, mode;
3472 {
3473 Lisp_Object absname, encoded_absname;
3474 Lisp_Object handler;
3475
3476 absname = Fexpand_file_name (filename, current_buffer->directory);
3477 CHECK_NUMBER (mode);
3478
3479 /* If the file name has special constructs in it,
3480 call the corresponding file handler. */
3481 handler = Ffind_file_name_handler (absname, Qset_file_modes);
3482 if (!NILP (handler))
3483 return call3 (handler, Qset_file_modes, absname, mode);
3484
3485 encoded_absname = ENCODE_FILE (absname);
3486
3487 if (chmod (SDATA (encoded_absname), XINT (mode)) < 0)
3488 report_file_error ("Doing chmod", Fcons (absname, Qnil));
3489
3490 return Qnil;
3491 }
3492
3493 DEFUN ("set-default-file-modes", Fset_default_file_modes, Sset_default_file_modes, 1, 1, 0,
3494 doc: /* Set the file permission bits for newly created files.
3495 The argument MODE should be an integer; only the low 9 bits are used.
3496 This setting is inherited by subprocesses. */)
3497 (mode)
3498 Lisp_Object mode;
3499 {
3500 CHECK_NUMBER (mode);
3501
3502 umask ((~ XINT (mode)) & 0777);
3503
3504 return Qnil;
3505 }
3506
3507 DEFUN ("default-file-modes", Fdefault_file_modes, Sdefault_file_modes, 0, 0, 0,
3508 doc: /* Return the default file protection for created files.
3509 The value is an integer. */)
3510 ()
3511 {
3512 int realmask;
3513 Lisp_Object value;
3514
3515 realmask = umask (0);
3516 umask (realmask);
3517
3518 XSETINT (value, (~ realmask) & 0777);
3519 return value;
3520 }
3521 \f
3522 extern int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
3523
3524 DEFUN ("set-file-times", Fset_file_times, Sset_file_times, 1, 2, 0,
3525 doc: /* Set times of file FILENAME to TIME.
3526 Set both access and modification times.
3527 Return t on success, else nil.
3528 Use the current time if TIME is nil. TIME is in the format of
3529 `current-time'. */)
3530 (filename, time)
3531 Lisp_Object filename, time;
3532 {
3533 Lisp_Object absname, encoded_absname;
3534 Lisp_Object handler;
3535 time_t sec;
3536 int usec;
3537
3538 if (! lisp_time_argument (time, &sec, &usec))
3539 error ("Invalid time specification");
3540
3541 absname = Fexpand_file_name (filename, current_buffer->directory);
3542
3543 /* If the file name has special constructs in it,
3544 call the corresponding file handler. */
3545 handler = Ffind_file_name_handler (absname, Qset_file_times);
3546 if (!NILP (handler))
3547 return call3 (handler, Qset_file_times, absname, time);
3548
3549 encoded_absname = ENCODE_FILE (absname);
3550
3551 {
3552 EMACS_TIME t;
3553
3554 EMACS_SET_SECS (t, sec);
3555 EMACS_SET_USECS (t, usec);
3556
3557 if (set_file_times (SDATA (encoded_absname), t, t))
3558 {
3559 #ifdef DOS_NT
3560 struct stat st;
3561
3562 /* Setting times on a directory always fails. */
3563 if (stat (SDATA (encoded_absname), &st) == 0
3564 && (st.st_mode & S_IFMT) == S_IFDIR)
3565 return Qnil;
3566 #endif
3567 report_file_error ("Setting file times", Fcons (absname, Qnil));
3568 return Qnil;
3569 }
3570 }
3571
3572 return Qt;
3573 }
3574 \f
3575 #ifdef __NetBSD__
3576 #define unix 42
3577 #endif
3578
3579 #ifdef unix
3580 DEFUN ("unix-sync", Funix_sync, Sunix_sync, 0, 0, "",
3581 doc: /* Tell Unix to finish all pending disk updates. */)
3582 ()
3583 {
3584 sync ();
3585 return Qnil;
3586 }
3587
3588 #endif /* unix */
3589
3590 DEFUN ("file-newer-than-file-p", Ffile_newer_than_file_p, Sfile_newer_than_file_p, 2, 2, 0,
3591 doc: /* Return t if file FILE1 is newer than file FILE2.
3592 If FILE1 does not exist, the answer is nil;
3593 otherwise, if FILE2 does not exist, the answer is t. */)
3594 (file1, file2)
3595 Lisp_Object file1, file2;
3596 {
3597 Lisp_Object absname1, absname2;
3598 struct stat st;
3599 int mtime1;
3600 Lisp_Object handler;
3601 struct gcpro gcpro1, gcpro2;
3602
3603 CHECK_STRING (file1);
3604 CHECK_STRING (file2);
3605
3606 absname1 = Qnil;
3607 GCPRO2 (absname1, file2);
3608 absname1 = expand_and_dir_to_file (file1, current_buffer->directory);
3609 absname2 = expand_and_dir_to_file (file2, current_buffer->directory);
3610 UNGCPRO;
3611
3612 /* If the file name has special constructs in it,
3613 call the corresponding file handler. */
3614 handler = Ffind_file_name_handler (absname1, Qfile_newer_than_file_p);
3615 if (NILP (handler))
3616 handler = Ffind_file_name_handler (absname2, Qfile_newer_than_file_p);
3617 if (!NILP (handler))
3618 return call3 (handler, Qfile_newer_than_file_p, absname1, absname2);
3619
3620 GCPRO2 (absname1, absname2);
3621 absname1 = ENCODE_FILE (absname1);
3622 absname2 = ENCODE_FILE (absname2);
3623 UNGCPRO;
3624
3625 if (stat (SDATA (absname1), &st) < 0)
3626 return Qnil;
3627
3628 mtime1 = st.st_mtime;
3629
3630 if (stat (SDATA (absname2), &st) < 0)
3631 return Qt;
3632
3633 return (mtime1 > st.st_mtime) ? Qt : Qnil;
3634 }
3635 \f
3636 #ifdef DOS_NT
3637 Lisp_Object Qfind_buffer_file_type;
3638 #endif /* DOS_NT */
3639
3640 #ifndef READ_BUF_SIZE
3641 #define READ_BUF_SIZE (64 << 10)
3642 #endif
3643
3644 extern void adjust_markers_for_delete P_ ((int, int, int, int));
3645
3646 /* This function is called after Lisp functions to decide a coding
3647 system are called, or when they cause an error. Before they are
3648 called, the current buffer is set unibyte and it contains only a
3649 newly inserted text (thus the buffer was empty before the
3650 insertion).
3651
3652 The functions may set markers, overlays, text properties, or even
3653 alter the buffer contents, change the current buffer.
3654
3655 Here, we reset all those changes by:
3656 o set back the current buffer.
3657 o move all markers and overlays to BEG.
3658 o remove all text properties.
3659 o set back the buffer multibyteness. */
3660
3661 static Lisp_Object
3662 decide_coding_unwind (unwind_data)
3663 Lisp_Object unwind_data;
3664 {
3665 Lisp_Object multibyte, undo_list, buffer;
3666
3667 multibyte = XCAR (unwind_data);
3668 unwind_data = XCDR (unwind_data);
3669 undo_list = XCAR (unwind_data);
3670 buffer = XCDR (unwind_data);
3671
3672 if (current_buffer != XBUFFER (buffer))
3673 set_buffer_internal (XBUFFER (buffer));
3674 adjust_markers_for_delete (BEG, BEG_BYTE, Z, Z_BYTE);
3675 adjust_overlays_for_delete (BEG, Z - BEG);
3676 BUF_INTERVALS (current_buffer) = 0;
3677 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3678
3679 /* Now we are safe to change the buffer's multibyteness directly. */
3680 current_buffer->enable_multibyte_characters = multibyte;
3681 current_buffer->undo_list = undo_list;
3682
3683 return Qnil;
3684 }
3685
3686
3687 /* Used to pass values from insert-file-contents to read_non_regular. */
3688
3689 static int non_regular_fd;
3690 static int non_regular_inserted;
3691 static int non_regular_nbytes;
3692
3693
3694 /* Read from a non-regular file.
3695 Read non_regular_trytry bytes max from non_regular_fd.
3696 Non_regular_inserted specifies where to put the read bytes.
3697 Value is the number of bytes read. */
3698
3699 static Lisp_Object
3700 read_non_regular ()
3701 {
3702 int nbytes;
3703
3704 immediate_quit = 1;
3705 QUIT;
3706 nbytes = emacs_read (non_regular_fd,
3707 BEG_ADDR + PT_BYTE - BEG_BYTE + non_regular_inserted,
3708 non_regular_nbytes);
3709 immediate_quit = 0;
3710 return make_number (nbytes);
3711 }
3712
3713
3714 /* Condition-case handler used when reading from non-regular files
3715 in insert-file-contents. */
3716
3717 static Lisp_Object
3718 read_non_regular_quit ()
3719 {
3720 return Qnil;
3721 }
3722
3723
3724 DEFUN ("insert-file-contents", Finsert_file_contents, Sinsert_file_contents,
3725 1, 5, 0,
3726 doc: /* Insert contents of file FILENAME after point.
3727 Returns list of absolute file name and number of characters inserted.
3728 If second argument VISIT is non-nil, the buffer's visited filename
3729 and last save file modtime are set, and it is marked unmodified.
3730 If visiting and the file does not exist, visiting is completed
3731 before the error is signaled.
3732 The optional third and fourth arguments BEG and END
3733 specify what portion of the file to insert.
3734 These arguments count bytes in the file, not characters in the buffer.
3735 If VISIT is non-nil, BEG and END must be nil.
3736
3737 If optional fifth argument REPLACE is non-nil,
3738 it means replace the current buffer contents (in the accessible portion)
3739 with the file contents. This is better than simply deleting and inserting
3740 the whole thing because (1) it preserves some marker positions
3741 and (2) it puts less data in the undo list.
3742 When REPLACE is non-nil, the value is the number of characters actually read,
3743 which is often less than the number of characters to be read.
3744
3745 This does code conversion according to the value of
3746 `coding-system-for-read' or `file-coding-system-alist',
3747 and sets the variable `last-coding-system-used' to the coding system
3748 actually used. */)
3749 (filename, visit, beg, end, replace)
3750 Lisp_Object filename, visit, beg, end, replace;
3751 {
3752 struct stat st;
3753 register int fd;
3754 int inserted = 0;
3755 register int how_much;
3756 register int unprocessed;
3757 int count = SPECPDL_INDEX ();
3758 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3759 Lisp_Object handler, val, insval, orig_filename;
3760 Lisp_Object p;
3761 int total = 0;
3762 int not_regular = 0;
3763 unsigned char read_buf[READ_BUF_SIZE];
3764 struct coding_system coding;
3765 unsigned char buffer[1 << 14];
3766 int replace_handled = 0;
3767 int set_coding_system = 0;
3768 int coding_system_decided = 0;
3769 int read_quit = 0;
3770 Lisp_Object old_Vdeactivate_mark = Vdeactivate_mark;
3771 int we_locked_file = 0;
3772
3773 if (current_buffer->base_buffer && ! NILP (visit))
3774 error ("Cannot do file visiting in an indirect buffer");
3775
3776 if (!NILP (current_buffer->read_only))
3777 Fbarf_if_buffer_read_only ();
3778
3779 val = Qnil;
3780 p = Qnil;
3781 orig_filename = Qnil;
3782
3783 GCPRO4 (filename, val, p, orig_filename);
3784
3785 CHECK_STRING (filename);
3786 filename = Fexpand_file_name (filename, Qnil);
3787
3788 /* If the file name has special constructs in it,
3789 call the corresponding file handler. */
3790 handler = Ffind_file_name_handler (filename, Qinsert_file_contents);
3791 if (!NILP (handler))
3792 {
3793 val = call6 (handler, Qinsert_file_contents, filename,
3794 visit, beg, end, replace);
3795 if (CONSP (val) && CONSP (XCDR (val)))
3796 inserted = XINT (XCAR (XCDR (val)));
3797 goto handled;
3798 }
3799
3800 orig_filename = filename;
3801 filename = ENCODE_FILE (filename);
3802
3803 fd = -1;
3804
3805 #ifdef WINDOWSNT
3806 {
3807 Lisp_Object tem = Vw32_get_true_file_attributes;
3808
3809 /* Tell stat to use expensive method to get accurate info. */
3810 Vw32_get_true_file_attributes = Qt;
3811 total = stat (SDATA (filename), &st);
3812 Vw32_get_true_file_attributes = tem;
3813 }
3814 if (total < 0)
3815 #else
3816 #ifndef APOLLO
3817 if (stat (SDATA (filename), &st) < 0)
3818 #else
3819 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0
3820 || fstat (fd, &st) < 0)
3821 #endif /* not APOLLO */
3822 #endif /* WINDOWSNT */
3823 {
3824 if (fd >= 0) emacs_close (fd);
3825 badopen:
3826 if (NILP (visit))
3827 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
3828 st.st_mtime = -1;
3829 how_much = 0;
3830 if (!NILP (Vcoding_system_for_read))
3831 Fset (Qbuffer_file_coding_system, Vcoding_system_for_read);
3832 goto notfound;
3833 }
3834
3835 #ifdef S_IFREG
3836 /* This code will need to be changed in order to work on named
3837 pipes, and it's probably just not worth it. So we should at
3838 least signal an error. */
3839 if (!S_ISREG (st.st_mode))
3840 {
3841 not_regular = 1;
3842
3843 if (! NILP (visit))
3844 goto notfound;
3845
3846 if (! NILP (replace) || ! NILP (beg) || ! NILP (end))
3847 xsignal2 (Qfile_error,
3848 build_string ("not a regular file"), orig_filename);
3849 }
3850 #endif
3851
3852 if (fd < 0)
3853 if ((fd = emacs_open (SDATA (filename), O_RDONLY, 0)) < 0)
3854 goto badopen;
3855
3856 /* Replacement should preserve point as it preserves markers. */
3857 if (!NILP (replace))
3858 record_unwind_protect (restore_point_unwind, Fpoint_marker ());
3859
3860 record_unwind_protect (close_file_unwind, make_number (fd));
3861
3862 /* Supposedly happens on VMS. */
3863 /* Can happen on any platform that uses long as type of off_t, but allows
3864 file sizes to exceed 2Gb. VMS is no longer officially supported, so
3865 give a message suitable for the latter case. */
3866 if (! not_regular && st.st_size < 0)
3867 error ("Maximum buffer size exceeded");
3868
3869 /* Prevent redisplay optimizations. */
3870 current_buffer->clip_changed = 1;
3871
3872 if (!NILP (visit))
3873 {
3874 if (!NILP (beg) || !NILP (end))
3875 error ("Attempt to visit less than an entire file");
3876 if (BEG < Z && NILP (replace))
3877 error ("Cannot do file visiting in a non-empty buffer");
3878 }
3879
3880 if (!NILP (beg))
3881 CHECK_NUMBER (beg);
3882 else
3883 XSETFASTINT (beg, 0);
3884
3885 if (!NILP (end))
3886 CHECK_NUMBER (end);
3887 else
3888 {
3889 if (! not_regular)
3890 {
3891 XSETINT (end, st.st_size);
3892
3893 /* Arithmetic overflow can occur if an Emacs integer cannot
3894 represent the file size, or if the calculations below
3895 overflow. The calculations below double the file size
3896 twice, so check that it can be multiplied by 4 safely. */
3897 if (XINT (end) != st.st_size
3898 || ((int) st.st_size * 4) / 4 != st.st_size)
3899 error ("Maximum buffer size exceeded");
3900
3901 /* The file size returned from stat may be zero, but data
3902 may be readable nonetheless, for example when this is a
3903 file in the /proc filesystem. */
3904 if (st.st_size == 0)
3905 XSETINT (end, READ_BUF_SIZE);
3906 }
3907 }
3908
3909 if (EQ (Vcoding_system_for_read, Qauto_save_coding))
3910 {
3911 /* We use emacs-mule for auto saving... */
3912 setup_coding_system (Qemacs_mule, &coding);
3913 /* ... but with the special flag to indicate to read in a
3914 multibyte sequence for eight-bit-control char as is. */
3915 coding.flags = 1;
3916 coding.src_multibyte = 0;
3917 coding.dst_multibyte
3918 = !NILP (current_buffer->enable_multibyte_characters);
3919 coding.eol_type = CODING_EOL_LF;
3920 coding_system_decided = 1;
3921 }
3922 else if (BEG < Z)
3923 {
3924 /* Decide the coding system to use for reading the file now
3925 because we can't use an optimized method for handling
3926 `coding:' tag if the current buffer is not empty. */
3927 Lisp_Object val;
3928 val = Qnil;
3929
3930 if (!NILP (Vcoding_system_for_read))
3931 val = Vcoding_system_for_read;
3932 else
3933 {
3934 /* Don't try looking inside a file for a coding system
3935 specification if it is not seekable. */
3936 if (! not_regular && ! NILP (Vset_auto_coding_function))
3937 {
3938 /* Find a coding system specified in the heading two
3939 lines or in the tailing several lines of the file.
3940 We assume that the 1K-byte and 3K-byte for heading
3941 and tailing respectively are sufficient for this
3942 purpose. */
3943 int nread;
3944
3945 if (st.st_size <= (1024 * 4))
3946 nread = emacs_read (fd, read_buf, 1024 * 4);
3947 else
3948 {
3949 nread = emacs_read (fd, read_buf, 1024);
3950 if (nread >= 0)
3951 {
3952 if (lseek (fd, st.st_size - (1024 * 3), 0) < 0)
3953 report_file_error ("Setting file position",
3954 Fcons (orig_filename, Qnil));
3955 nread += emacs_read (fd, read_buf + nread, 1024 * 3);
3956 }
3957 }
3958
3959 if (nread < 0)
3960 error ("IO error reading %s: %s",
3961 SDATA (orig_filename), emacs_strerror (errno));
3962 else if (nread > 0)
3963 {
3964 struct buffer *prev = current_buffer;
3965 Lisp_Object buffer;
3966 struct buffer *buf;
3967
3968 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
3969
3970 buffer = Fget_buffer_create (build_string (" *code-converting-work*"));
3971 buf = XBUFFER (buffer);
3972
3973 delete_all_overlays (buf);
3974 buf->directory = current_buffer->directory;
3975 buf->read_only = Qnil;
3976 buf->filename = Qnil;
3977 buf->undo_list = Qt;
3978 eassert (buf->overlays_before == NULL);
3979 eassert (buf->overlays_after == NULL);
3980
3981 set_buffer_internal (buf);
3982 Ferase_buffer ();
3983 buf->enable_multibyte_characters = Qnil;
3984
3985 insert_1_both (read_buf, nread, nread, 0, 0, 0);
3986 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
3987 val = call2 (Vset_auto_coding_function,
3988 filename, make_number (nread));
3989 set_buffer_internal (prev);
3990
3991 /* Discard the unwind protect for recovering the
3992 current buffer. */
3993 specpdl_ptr--;
3994
3995 /* Rewind the file for the actual read done later. */
3996 if (lseek (fd, 0, 0) < 0)
3997 report_file_error ("Setting file position",
3998 Fcons (orig_filename, Qnil));
3999 }
4000 }
4001
4002 if (NILP (val))
4003 {
4004 /* If we have not yet decided a coding system, check
4005 file-coding-system-alist. */
4006 Lisp_Object args[6], coding_systems;
4007
4008 args[0] = Qinsert_file_contents, args[1] = orig_filename;
4009 args[2] = visit, args[3] = beg, args[4] = end, args[5] = replace;
4010 coding_systems = Ffind_operation_coding_system (6, args);
4011 if (CONSP (coding_systems))
4012 val = XCAR (coding_systems);
4013 }
4014 }
4015
4016 setup_coding_system (Fcheck_coding_system (val), &coding);
4017 /* Ensure we set Vlast_coding_system_used. */
4018 set_coding_system = 1;
4019
4020 if (NILP (current_buffer->enable_multibyte_characters)
4021 && ! NILP (val))
4022 /* We must suppress all character code conversion except for
4023 end-of-line conversion. */
4024 setup_raw_text_coding_system (&coding);
4025
4026 coding.src_multibyte = 0;
4027 coding.dst_multibyte
4028 = !NILP (current_buffer->enable_multibyte_characters);
4029 coding_system_decided = 1;
4030 }
4031
4032 /* If requested, replace the accessible part of the buffer
4033 with the file contents. Avoid replacing text at the
4034 beginning or end of the buffer that matches the file contents;
4035 that preserves markers pointing to the unchanged parts.
4036
4037 Here we implement this feature in an optimized way
4038 for the case where code conversion is NOT needed.
4039 The following if-statement handles the case of conversion
4040 in a less optimal way.
4041
4042 If the code conversion is "automatic" then we try using this
4043 method and hope for the best.
4044 But if we discover the need for conversion, we give up on this method
4045 and let the following if-statement handle the replace job. */
4046 if (!NILP (replace)
4047 && BEGV < ZV
4048 && !(coding.common_flags & CODING_REQUIRE_DECODING_MASK))
4049 {
4050 /* same_at_start and same_at_end count bytes,
4051 because file access counts bytes
4052 and BEG and END count bytes. */
4053 int same_at_start = BEGV_BYTE;
4054 int same_at_end = ZV_BYTE;
4055 int overlap;
4056 /* There is still a possibility we will find the need to do code
4057 conversion. If that happens, we set this variable to 1 to
4058 give up on handling REPLACE in the optimized way. */
4059 int giveup_match_end = 0;
4060
4061 if (XINT (beg) != 0)
4062 {
4063 if (lseek (fd, XINT (beg), 0) < 0)
4064 report_file_error ("Setting file position",
4065 Fcons (orig_filename, Qnil));
4066 }
4067
4068 immediate_quit = 1;
4069 QUIT;
4070 /* Count how many chars at the start of the file
4071 match the text at the beginning of the buffer. */
4072 while (1)
4073 {
4074 int nread, bufpos;
4075
4076 nread = emacs_read (fd, buffer, sizeof buffer);
4077 if (nread < 0)
4078 error ("IO error reading %s: %s",
4079 SDATA (orig_filename), emacs_strerror (errno));
4080 else if (nread == 0)
4081 break;
4082
4083 if (coding.type == coding_type_undecided)
4084 detect_coding (&coding, buffer, nread);
4085 if (coding.common_flags & CODING_REQUIRE_DECODING_MASK)
4086 /* We found that the file should be decoded somehow.
4087 Let's give up here. */
4088 {
4089 giveup_match_end = 1;
4090 break;
4091 }
4092
4093 if (coding.eol_type == CODING_EOL_UNDECIDED)
4094 detect_eol (&coding, buffer, nread);
4095 if (coding.eol_type != CODING_EOL_UNDECIDED
4096 && coding.eol_type != CODING_EOL_LF)
4097 /* We found that the format of eol should be decoded.
4098 Let's give up here. */
4099 {
4100 giveup_match_end = 1;
4101 break;
4102 }
4103
4104 bufpos = 0;
4105 while (bufpos < nread && same_at_start < ZV_BYTE
4106 && FETCH_BYTE (same_at_start) == buffer[bufpos])
4107 same_at_start++, bufpos++;
4108 /* If we found a discrepancy, stop the scan.
4109 Otherwise loop around and scan the next bufferful. */
4110 if (bufpos != nread)
4111 break;
4112 }
4113 immediate_quit = 0;
4114 /* If the file matches the buffer completely,
4115 there's no need to replace anything. */
4116 if (same_at_start - BEGV_BYTE == XINT (end))
4117 {
4118 emacs_close (fd);
4119 specpdl_ptr--;
4120 /* Truncate the buffer to the size of the file. */
4121 del_range_1 (same_at_start, same_at_end, 0, 0);
4122 goto handled;
4123 }
4124 immediate_quit = 1;
4125 QUIT;
4126 /* Count how many chars at the end of the file
4127 match the text at the end of the buffer. But, if we have
4128 already found that decoding is necessary, don't waste time. */
4129 while (!giveup_match_end)
4130 {
4131 int total_read, nread, bufpos, curpos, trial;
4132
4133 /* At what file position are we now scanning? */
4134 curpos = XINT (end) - (ZV_BYTE - same_at_end);
4135 /* If the entire file matches the buffer tail, stop the scan. */
4136 if (curpos == 0)
4137 break;
4138 /* How much can we scan in the next step? */
4139 trial = min (curpos, sizeof buffer);
4140 if (lseek (fd, curpos - trial, 0) < 0)
4141 report_file_error ("Setting file position",
4142 Fcons (orig_filename, Qnil));
4143
4144 total_read = nread = 0;
4145 while (total_read < trial)
4146 {
4147 nread = emacs_read (fd, buffer + total_read, trial - total_read);
4148 if (nread < 0)
4149 error ("IO error reading %s: %s",
4150 SDATA (orig_filename), emacs_strerror (errno));
4151 else if (nread == 0)
4152 break;
4153 total_read += nread;
4154 }
4155
4156 /* Scan this bufferful from the end, comparing with
4157 the Emacs buffer. */
4158 bufpos = total_read;
4159
4160 /* Compare with same_at_start to avoid counting some buffer text
4161 as matching both at the file's beginning and at the end. */
4162 while (bufpos > 0 && same_at_end > same_at_start
4163 && FETCH_BYTE (same_at_end - 1) == buffer[bufpos - 1])
4164 same_at_end--, bufpos--;
4165
4166 /* If we found a discrepancy, stop the scan.
4167 Otherwise loop around and scan the preceding bufferful. */
4168 if (bufpos != 0)
4169 {
4170 /* If this discrepancy is because of code conversion,
4171 we cannot use this method; giveup and try the other. */
4172 if (same_at_end > same_at_start
4173 && FETCH_BYTE (same_at_end - 1) >= 0200
4174 && ! NILP (current_buffer->enable_multibyte_characters)
4175 && (CODING_MAY_REQUIRE_DECODING (&coding)))
4176 giveup_match_end = 1;
4177 break;
4178 }
4179
4180 if (nread == 0)
4181 break;
4182 }
4183 immediate_quit = 0;
4184
4185 if (! giveup_match_end)
4186 {
4187 int temp;
4188
4189 /* We win! We can handle REPLACE the optimized way. */
4190
4191 /* Extend the start of non-matching text area to multibyte
4192 character boundary. */
4193 if (! NILP (current_buffer->enable_multibyte_characters))
4194 while (same_at_start > BEGV_BYTE
4195 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4196 same_at_start--;
4197
4198 /* Extend the end of non-matching text area to multibyte
4199 character boundary. */
4200 if (! NILP (current_buffer->enable_multibyte_characters))
4201 while (same_at_end < ZV_BYTE
4202 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4203 same_at_end++;
4204
4205 /* Don't try to reuse the same piece of text twice. */
4206 overlap = (same_at_start - BEGV_BYTE
4207 - (same_at_end + st.st_size - ZV));
4208 if (overlap > 0)
4209 same_at_end += overlap;
4210
4211 /* Arrange to read only the nonmatching middle part of the file. */
4212 XSETFASTINT (beg, XINT (beg) + (same_at_start - BEGV_BYTE));
4213 XSETFASTINT (end, XINT (end) - (ZV_BYTE - same_at_end));
4214
4215 del_range_byte (same_at_start, same_at_end, 0);
4216 /* Insert from the file at the proper position. */
4217 temp = BYTE_TO_CHAR (same_at_start);
4218 SET_PT_BOTH (temp, same_at_start);
4219
4220 /* If display currently starts at beginning of line,
4221 keep it that way. */
4222 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4223 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4224
4225 replace_handled = 1;
4226 }
4227 }
4228
4229 /* If requested, replace the accessible part of the buffer
4230 with the file contents. Avoid replacing text at the
4231 beginning or end of the buffer that matches the file contents;
4232 that preserves markers pointing to the unchanged parts.
4233
4234 Here we implement this feature for the case where code conversion
4235 is needed, in a simple way that needs a lot of memory.
4236 The preceding if-statement handles the case of no conversion
4237 in a more optimized way. */
4238 if (!NILP (replace) && ! replace_handled && BEGV < ZV)
4239 {
4240 int same_at_start = BEGV_BYTE;
4241 int same_at_end = ZV_BYTE;
4242 int overlap;
4243 int bufpos;
4244 /* Make sure that the gap is large enough. */
4245 int bufsize = 2 * st.st_size;
4246 unsigned char *conversion_buffer = (unsigned char *) xmalloc (bufsize);
4247 int temp;
4248
4249 /* First read the whole file, performing code conversion into
4250 CONVERSION_BUFFER. */
4251
4252 if (lseek (fd, XINT (beg), 0) < 0)
4253 {
4254 xfree (conversion_buffer);
4255 report_file_error ("Setting file position",
4256 Fcons (orig_filename, Qnil));
4257 }
4258
4259 total = st.st_size; /* Total bytes in the file. */
4260 how_much = 0; /* Bytes read from file so far. */
4261 inserted = 0; /* Bytes put into CONVERSION_BUFFER so far. */
4262 unprocessed = 0; /* Bytes not processed in previous loop. */
4263
4264 while (how_much < total)
4265 {
4266 /* try is reserved in some compilers (Microsoft C) */
4267 int trytry = min (total - how_much, READ_BUF_SIZE - unprocessed);
4268 unsigned char *destination = read_buf + unprocessed;
4269 int this;
4270
4271 /* Allow quitting out of the actual I/O. */
4272 immediate_quit = 1;
4273 QUIT;
4274 this = emacs_read (fd, destination, trytry);
4275 immediate_quit = 0;
4276
4277 if (this < 0 || this + unprocessed == 0)
4278 {
4279 how_much = this;
4280 break;
4281 }
4282
4283 how_much += this;
4284
4285 if (CODING_MAY_REQUIRE_DECODING (&coding))
4286 {
4287 int require, result;
4288
4289 this += unprocessed;
4290
4291 /* If we are using more space than estimated,
4292 make CONVERSION_BUFFER bigger. */
4293 require = decoding_buffer_size (&coding, this);
4294 if (inserted + require + 2 * (total - how_much) > bufsize)
4295 {
4296 bufsize = inserted + require + 2 * (total - how_much);
4297 conversion_buffer = (unsigned char *) xrealloc (conversion_buffer, bufsize);
4298 }
4299
4300 /* Convert this batch with results in CONVERSION_BUFFER. */
4301 if (how_much >= total) /* This is the last block. */
4302 coding.mode |= CODING_MODE_LAST_BLOCK;
4303 if (coding.composing != COMPOSITION_DISABLED)
4304 coding_allocate_composition_data (&coding, BEGV);
4305 result = decode_coding (&coding, read_buf,
4306 conversion_buffer + inserted,
4307 this, bufsize - inserted);
4308
4309 /* Save for next iteration whatever we didn't convert. */
4310 unprocessed = this - coding.consumed;
4311 bcopy (read_buf + coding.consumed, read_buf, unprocessed);
4312 if (!NILP (current_buffer->enable_multibyte_characters))
4313 this = coding.produced;
4314 else
4315 this = str_as_unibyte (conversion_buffer + inserted,
4316 coding.produced);
4317 }
4318
4319 inserted += this;
4320 }
4321
4322 /* At this point, INSERTED is how many characters (i.e. bytes)
4323 are present in CONVERSION_BUFFER.
4324 HOW_MUCH should equal TOTAL,
4325 or should be <= 0 if we couldn't read the file. */
4326
4327 if (how_much < 0)
4328 {
4329 xfree (conversion_buffer);
4330 coding_free_composition_data (&coding);
4331 error ("IO error reading %s: %s",
4332 SDATA (orig_filename), emacs_strerror (errno));
4333 }
4334
4335 /* Compare the beginning of the converted file
4336 with the buffer text. */
4337
4338 bufpos = 0;
4339 while (bufpos < inserted && same_at_start < same_at_end
4340 && FETCH_BYTE (same_at_start) == conversion_buffer[bufpos])
4341 same_at_start++, bufpos++;
4342
4343 /* If the file matches the buffer completely,
4344 there's no need to replace anything. */
4345
4346 if (bufpos == inserted)
4347 {
4348 xfree (conversion_buffer);
4349 coding_free_composition_data (&coding);
4350 emacs_close (fd);
4351 specpdl_ptr--;
4352 /* Truncate the buffer to the size of the file. */
4353 del_range_byte (same_at_start, same_at_end, 0);
4354 inserted = 0;
4355 goto handled;
4356 }
4357
4358 /* Extend the start of non-matching text area to multibyte
4359 character boundary. */
4360 if (! NILP (current_buffer->enable_multibyte_characters))
4361 while (same_at_start > BEGV_BYTE
4362 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_start)))
4363 same_at_start--;
4364
4365 /* Scan this bufferful from the end, comparing with
4366 the Emacs buffer. */
4367 bufpos = inserted;
4368
4369 /* Compare with same_at_start to avoid counting some buffer text
4370 as matching both at the file's beginning and at the end. */
4371 while (bufpos > 0 && same_at_end > same_at_start
4372 && FETCH_BYTE (same_at_end - 1) == conversion_buffer[bufpos - 1])
4373 same_at_end--, bufpos--;
4374
4375 /* Extend the end of non-matching text area to multibyte
4376 character boundary. */
4377 if (! NILP (current_buffer->enable_multibyte_characters))
4378 while (same_at_end < ZV_BYTE
4379 && ! CHAR_HEAD_P (FETCH_BYTE (same_at_end)))
4380 same_at_end++;
4381
4382 /* Don't try to reuse the same piece of text twice. */
4383 overlap = same_at_start - BEGV_BYTE - (same_at_end + inserted - ZV_BYTE);
4384 if (overlap > 0)
4385 same_at_end += overlap;
4386
4387 /* If display currently starts at beginning of line,
4388 keep it that way. */
4389 if (XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
4390 XWINDOW (selected_window)->start_at_line_beg = Fbolp ();
4391
4392 /* Replace the chars that we need to replace,
4393 and update INSERTED to equal the number of bytes
4394 we are taking from the file. */
4395 inserted -= (ZV_BYTE - same_at_end) + (same_at_start - BEGV_BYTE);
4396
4397 if (same_at_end != same_at_start)
4398 {
4399 del_range_byte (same_at_start, same_at_end, 0);
4400 temp = GPT;
4401 same_at_start = GPT_BYTE;
4402 }
4403 else
4404 {
4405 temp = BYTE_TO_CHAR (same_at_start);
4406 }
4407 /* Insert from the file at the proper position. */
4408 SET_PT_BOTH (temp, same_at_start);
4409 insert_1 (conversion_buffer + same_at_start - BEGV_BYTE, inserted,
4410 0, 0, 0);
4411 if (coding.cmp_data && coding.cmp_data->used)
4412 coding_restore_composition (&coding, Fcurrent_buffer ());
4413 coding_free_composition_data (&coding);
4414
4415 /* Set `inserted' to the number of inserted characters. */
4416 inserted = PT - temp;
4417 /* Set point before the inserted characters. */
4418 SET_PT_BOTH (temp, same_at_start);
4419
4420 xfree (conversion_buffer);
4421 emacs_close (fd);
4422 specpdl_ptr--;
4423
4424 goto handled;
4425 }
4426
4427 if (! not_regular)
4428 {
4429 register Lisp_Object temp;
4430
4431 total = XINT (end) - XINT (beg);
4432
4433 /* Make sure point-max won't overflow after this insertion. */
4434 XSETINT (temp, total);
4435 if (total != XINT (temp))
4436 error ("Maximum buffer size exceeded");
4437 }
4438 else
4439 /* For a special file, all we can do is guess. */
4440 total = READ_BUF_SIZE;
4441
4442 if (NILP (visit) && inserted > 0)
4443 {
4444 #ifdef CLASH_DETECTION
4445 if (!NILP (current_buffer->file_truename)
4446 /* Make binding buffer-file-name to nil effective. */
4447 && !NILP (current_buffer->filename)
4448 && SAVE_MODIFF >= MODIFF)
4449 we_locked_file = 1;
4450 #endif /* CLASH_DETECTION */
4451 prepare_to_modify_buffer (GPT, GPT, NULL);
4452 }
4453
4454 move_gap (PT);
4455 if (GAP_SIZE < total)
4456 make_gap (total - GAP_SIZE);
4457
4458 if (XINT (beg) != 0 || !NILP (replace))
4459 {
4460 if (lseek (fd, XINT (beg), 0) < 0)
4461 report_file_error ("Setting file position",
4462 Fcons (orig_filename, Qnil));
4463 }
4464
4465 /* In the following loop, HOW_MUCH contains the total bytes read so
4466 far for a regular file, and not changed for a special file. But,
4467 before exiting the loop, it is set to a negative value if I/O
4468 error occurs. */
4469 how_much = 0;
4470
4471 /* Total bytes inserted. */
4472 inserted = 0;
4473
4474 /* Here, we don't do code conversion in the loop. It is done by
4475 code_convert_region after all data are read into the buffer. */
4476 {
4477 int gap_size = GAP_SIZE;
4478
4479 while (how_much < total)
4480 {
4481 /* try is reserved in some compilers (Microsoft C) */
4482 int trytry = min (total - how_much, READ_BUF_SIZE);
4483 int this;
4484
4485 if (not_regular)
4486 {
4487 Lisp_Object val;
4488
4489 /* Maybe make more room. */
4490 if (gap_size < trytry)
4491 {
4492 make_gap (total - gap_size);
4493 gap_size = GAP_SIZE;
4494 }
4495
4496 /* Read from the file, capturing `quit'. When an
4497 error occurs, end the loop, and arrange for a quit
4498 to be signaled after decoding the text we read. */
4499 non_regular_fd = fd;
4500 non_regular_inserted = inserted;
4501 non_regular_nbytes = trytry;
4502 val = internal_condition_case_1 (read_non_regular, Qnil, Qerror,
4503 read_non_regular_quit);
4504 if (NILP (val))
4505 {
4506 read_quit = 1;
4507 break;
4508 }
4509
4510 this = XINT (val);
4511 }
4512 else
4513 {
4514 /* Allow quitting out of the actual I/O. We don't make text
4515 part of the buffer until all the reading is done, so a C-g
4516 here doesn't do any harm. */
4517 immediate_quit = 1;
4518 QUIT;
4519 this = emacs_read (fd, BEG_ADDR + PT_BYTE - BEG_BYTE + inserted, trytry);
4520 immediate_quit = 0;
4521 }
4522
4523 if (this <= 0)
4524 {
4525 how_much = this;
4526 break;
4527 }
4528
4529 gap_size -= this;
4530
4531 /* For a regular file, where TOTAL is the real size,
4532 count HOW_MUCH to compare with it.
4533 For a special file, where TOTAL is just a buffer size,
4534 so don't bother counting in HOW_MUCH.
4535 (INSERTED is where we count the number of characters inserted.) */
4536 if (! not_regular)
4537 how_much += this;
4538 inserted += this;
4539 }
4540 }
4541
4542 /* Now we have read all the file data into the gap.
4543 If it was empty, undo marking the buffer modified. */
4544
4545 if (inserted == 0)
4546 {
4547 #ifdef CLASH_DETECTION
4548 if (we_locked_file)
4549 unlock_file (current_buffer->file_truename);
4550 #endif
4551 Vdeactivate_mark = old_Vdeactivate_mark;
4552 }
4553 else
4554 Vdeactivate_mark = Qt;
4555
4556 /* Make the text read part of the buffer. */
4557 GAP_SIZE -= inserted;
4558 GPT += inserted;
4559 GPT_BYTE += inserted;
4560 ZV += inserted;
4561 ZV_BYTE += inserted;
4562 Z += inserted;
4563 Z_BYTE += inserted;
4564
4565 if (GAP_SIZE > 0)
4566 /* Put an anchor to ensure multi-byte form ends at gap. */
4567 *GPT_ADDR = 0;
4568
4569 emacs_close (fd);
4570
4571 /* Discard the unwind protect for closing the file. */
4572 specpdl_ptr--;
4573
4574 if (how_much < 0)
4575 error ("IO error reading %s: %s",
4576 SDATA (orig_filename), emacs_strerror (errno));
4577
4578 notfound:
4579
4580 if (! coding_system_decided)
4581 {
4582 /* The coding system is not yet decided. Decide it by an
4583 optimized method for handling `coding:' tag.
4584
4585 Note that we can get here only if the buffer was empty
4586 before the insertion. */
4587 Lisp_Object val;
4588 val = Qnil;
4589
4590 if (!NILP (Vcoding_system_for_read))
4591 val = Vcoding_system_for_read;
4592 else
4593 {
4594 /* Since we are sure that the current buffer was empty
4595 before the insertion, we can toggle
4596 enable-multibyte-characters directly here without taking
4597 care of marker adjustment and byte combining problem. By
4598 this way, we can run Lisp program safely before decoding
4599 the inserted text. */
4600 Lisp_Object unwind_data;
4601 int count = SPECPDL_INDEX ();
4602
4603 unwind_data = Fcons (current_buffer->enable_multibyte_characters,
4604 Fcons (current_buffer->undo_list,
4605 Fcurrent_buffer ()));
4606 current_buffer->enable_multibyte_characters = Qnil;
4607 current_buffer->undo_list = Qt;
4608 record_unwind_protect (decide_coding_unwind, unwind_data);
4609
4610 if (inserted > 0 && ! NILP (Vset_auto_coding_function))
4611 {
4612 val = call2 (Vset_auto_coding_function,
4613 filename, make_number (inserted));
4614 }
4615
4616 if (NILP (val))
4617 {
4618 /* If the coding system is not yet decided, check
4619 file-coding-system-alist. */
4620 Lisp_Object args[6], coding_systems;
4621
4622 args[0] = Qinsert_file_contents, args[1] = orig_filename;
4623 args[2] = visit, args[3] = beg, args[4] = end, args[5] = Qnil;
4624 coding_systems = Ffind_operation_coding_system (6, args);
4625 if (CONSP (coding_systems))
4626 val = XCAR (coding_systems);
4627 }
4628 unbind_to (count, Qnil);
4629 inserted = Z_BYTE - BEG_BYTE;
4630 }
4631
4632 /* The following kludgy code is to avoid some compiler bug.
4633 We can't simply do
4634 setup_coding_system (val, &coding);
4635 on some system. */
4636 {
4637 struct coding_system temp_coding;
4638 setup_coding_system (Fcheck_coding_system (val), &temp_coding);
4639 bcopy (&temp_coding, &coding, sizeof coding);
4640 }
4641 /* Ensure we set Vlast_coding_system_used. */
4642 set_coding_system = 1;
4643
4644 if (NILP (current_buffer->enable_multibyte_characters)
4645 && ! NILP (val))
4646 /* We must suppress all character code conversion except for
4647 end-of-line conversion. */
4648 setup_raw_text_coding_system (&coding);
4649 coding.src_multibyte = 0;
4650 coding.dst_multibyte
4651 = !NILP (current_buffer->enable_multibyte_characters);
4652 }
4653
4654 if (!NILP (visit)
4655 /* Can't do this if part of the buffer might be preserved. */
4656 && NILP (replace)
4657 && (coding.type == coding_type_no_conversion
4658 || coding.type == coding_type_raw_text))
4659 {
4660 /* Visiting a file with these coding system makes the buffer
4661 unibyte. */
4662 current_buffer->enable_multibyte_characters = Qnil;
4663 coding.dst_multibyte = 0;
4664 }
4665
4666 if (inserted > 0 || coding.type == coding_type_ccl)
4667 {
4668 if (CODING_MAY_REQUIRE_DECODING (&coding))
4669 {
4670 code_convert_region (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4671 &coding, 0, 0);
4672 inserted = coding.produced_char;
4673 }
4674 else
4675 adjust_after_insert (PT, PT_BYTE, PT + inserted, PT_BYTE + inserted,
4676 inserted);
4677 }
4678
4679 /* Now INSERTED is measured in characters. */
4680
4681 #ifdef DOS_NT
4682 /* Use the conversion type to determine buffer-file-type
4683 (find-buffer-file-type is now used to help determine the
4684 conversion). */
4685 if ((coding.eol_type == CODING_EOL_UNDECIDED
4686 || coding.eol_type == CODING_EOL_LF)
4687 && ! CODING_REQUIRE_DECODING (&coding))
4688 current_buffer->buffer_file_type = Qt;
4689 else
4690 current_buffer->buffer_file_type = Qnil;
4691 #endif
4692
4693 handled:
4694
4695 if (!NILP (visit))
4696 {
4697 if (!EQ (current_buffer->undo_list, Qt))
4698 current_buffer->undo_list = Qnil;
4699 #ifdef APOLLO
4700 stat (SDATA (filename), &st);
4701 #endif
4702
4703 if (NILP (handler))
4704 {
4705 current_buffer->modtime = st.st_mtime;
4706 current_buffer->filename = orig_filename;
4707 }
4708
4709 SAVE_MODIFF = MODIFF;
4710 current_buffer->auto_save_modified = MODIFF;
4711 XSETFASTINT (current_buffer->save_length, Z - BEG);
4712 #ifdef CLASH_DETECTION
4713 if (NILP (handler))
4714 {
4715 if (!NILP (current_buffer->file_truename))
4716 unlock_file (current_buffer->file_truename);
4717 unlock_file (filename);
4718 }
4719 #endif /* CLASH_DETECTION */
4720 if (not_regular)
4721 xsignal2 (Qfile_error,
4722 build_string ("not a regular file"), orig_filename);
4723 }
4724
4725 if (set_coding_system)
4726 Vlast_coding_system_used = coding.symbol;
4727
4728 if (! NILP (Ffboundp (Qafter_insert_file_set_coding)))
4729 {
4730 insval = call2 (Qafter_insert_file_set_coding, make_number (inserted),
4731 visit);
4732 if (! NILP (insval))
4733 {
4734 CHECK_NUMBER (insval);
4735 inserted = XFASTINT (insval);
4736 }
4737 }
4738
4739 /* Decode file format */
4740 if (inserted > 0)
4741 {
4742 int empty_undo_list_p = 0;
4743
4744 /* If we're anyway going to discard undo information, don't
4745 record it in the first place. The buffer's undo list at this
4746 point is either nil or t when visiting a file. */
4747 if (!NILP (visit))
4748 {
4749 empty_undo_list_p = NILP (current_buffer->undo_list);
4750 current_buffer->undo_list = Qt;
4751 }
4752
4753 insval = call3 (Qformat_decode,
4754 Qnil, make_number (inserted), visit);
4755 CHECK_NUMBER (insval);
4756 inserted = XFASTINT (insval);
4757
4758 if (!NILP (visit))
4759 current_buffer->undo_list = empty_undo_list_p ? Qnil : Qt;
4760 }
4761
4762 /* Call after-change hooks for the inserted text, aside from the case
4763 of normal visiting (not with REPLACE), which is done in a new buffer
4764 "before" the buffer is changed. */
4765 if (inserted > 0 && total > 0
4766 && (NILP (visit) || !NILP (replace)))
4767 {
4768 signal_after_change (PT, 0, inserted);
4769 update_compositions (PT, PT, CHECK_BORDER);
4770 }
4771
4772 p = Vafter_insert_file_functions;
4773 while (CONSP (p))
4774 {
4775 insval = call1 (XCAR (p), make_number (inserted));
4776 if (!NILP (insval))
4777 {
4778 CHECK_NUMBER (insval);
4779 inserted = XFASTINT (insval);
4780 }
4781 QUIT;
4782 p = XCDR (p);
4783 }
4784
4785 if (!NILP (visit)
4786 && current_buffer->modtime == -1)
4787 {
4788 /* If visiting nonexistent file, return nil. */
4789 report_file_error ("Opening input file", Fcons (orig_filename, Qnil));
4790 }
4791
4792 if (read_quit)
4793 Fsignal (Qquit, Qnil);
4794
4795 /* ??? Retval needs to be dealt with in all cases consistently. */
4796 if (NILP (val))
4797 val = Fcons (orig_filename,
4798 Fcons (make_number (inserted),
4799 Qnil));
4800
4801 RETURN_UNGCPRO (unbind_to (count, val));
4802 }
4803 \f
4804 static Lisp_Object build_annotations P_ ((Lisp_Object, Lisp_Object));
4805 static Lisp_Object build_annotations_2 P_ ((Lisp_Object, Lisp_Object,
4806 Lisp_Object, Lisp_Object));
4807
4808 /* If build_annotations switched buffers, switch back to BUF.
4809 Kill the temporary buffer that was selected in the meantime.
4810
4811 Since this kill only the last temporary buffer, some buffers remain
4812 not killed if build_annotations switched buffers more than once.
4813 -- K.Handa */
4814
4815 static Lisp_Object
4816 build_annotations_unwind (buf)
4817 Lisp_Object buf;
4818 {
4819 Lisp_Object tembuf;
4820
4821 if (XBUFFER (buf) == current_buffer)
4822 return Qnil;
4823 tembuf = Fcurrent_buffer ();
4824 Fset_buffer (buf);
4825 Fkill_buffer (tembuf);
4826 return Qnil;
4827 }
4828
4829 /* Decide the coding-system to encode the data with. */
4830
4831 void
4832 choose_write_coding_system (start, end, filename,
4833 append, visit, lockname, coding)
4834 Lisp_Object start, end, filename, append, visit, lockname;
4835 struct coding_system *coding;
4836 {
4837 Lisp_Object val;
4838
4839 if (auto_saving
4840 && NILP (Fstring_equal (current_buffer->filename,
4841 current_buffer->auto_save_file_name)))
4842 {
4843 /* We use emacs-mule for auto saving... */
4844 setup_coding_system (Qemacs_mule, coding);
4845 /* ... but with the special flag to indicate not to strip off
4846 leading code of eight-bit-control chars. */
4847 coding->flags = 1;
4848 goto done_setup_coding;
4849 }
4850 else if (!NILP (Vcoding_system_for_write))
4851 {
4852 val = Vcoding_system_for_write;
4853 if (coding_system_require_warning
4854 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4855 /* Confirm that VAL can surely encode the current region. */
4856 val = call5 (Vselect_safe_coding_system_function,
4857 start, end, Fcons (Qt, Fcons (val, Qnil)),
4858 Qnil, filename);
4859 }
4860 else
4861 {
4862 /* If the variable `buffer-file-coding-system' is set locally,
4863 it means that the file was read with some kind of code
4864 conversion or the variable is explicitly set by users. We
4865 had better write it out with the same coding system even if
4866 `enable-multibyte-characters' is nil.
4867
4868 If it is not set locally, we anyway have to convert EOL
4869 format if the default value of `buffer-file-coding-system'
4870 tells that it is not Unix-like (LF only) format. */
4871 int using_default_coding = 0;
4872 int force_raw_text = 0;
4873
4874 val = current_buffer->buffer_file_coding_system;
4875 if (NILP (val)
4876 || NILP (Flocal_variable_p (Qbuffer_file_coding_system, Qnil)))
4877 {
4878 val = Qnil;
4879 if (NILP (current_buffer->enable_multibyte_characters))
4880 force_raw_text = 1;
4881 }
4882
4883 if (NILP (val))
4884 {
4885 /* Check file-coding-system-alist. */
4886 Lisp_Object args[7], coding_systems;
4887
4888 args[0] = Qwrite_region; args[1] = start; args[2] = end;
4889 args[3] = filename; args[4] = append; args[5] = visit;
4890 args[6] = lockname;
4891 coding_systems = Ffind_operation_coding_system (7, args);
4892 if (CONSP (coding_systems) && !NILP (XCDR (coding_systems)))
4893 val = XCDR (coding_systems);
4894 }
4895
4896 if (NILP (val)
4897 && !NILP (current_buffer->buffer_file_coding_system))
4898 {
4899 /* If we still have not decided a coding system, use the
4900 default value of buffer-file-coding-system. */
4901 val = current_buffer->buffer_file_coding_system;
4902 using_default_coding = 1;
4903 }
4904
4905 if (!force_raw_text
4906 && !NILP (Ffboundp (Vselect_safe_coding_system_function)))
4907 /* Confirm that VAL can surely encode the current region. */
4908 val = call5 (Vselect_safe_coding_system_function,
4909 start, end, val, Qnil, filename);
4910
4911 setup_coding_system (Fcheck_coding_system (val), coding);
4912 if (coding->eol_type == CODING_EOL_UNDECIDED
4913 && !using_default_coding)
4914 {
4915 if (! EQ (default_buffer_file_coding.symbol,
4916 buffer_defaults.buffer_file_coding_system))
4917 setup_coding_system (buffer_defaults.buffer_file_coding_system,
4918 &default_buffer_file_coding);
4919 if (default_buffer_file_coding.eol_type != CODING_EOL_UNDECIDED)
4920 {
4921 Lisp_Object subsidiaries;
4922
4923 coding->eol_type = default_buffer_file_coding.eol_type;
4924 subsidiaries = Fget (coding->symbol, Qeol_type);
4925 if (VECTORP (subsidiaries)
4926 && XVECTOR (subsidiaries)->size == 3)
4927 coding->symbol
4928 = XVECTOR (subsidiaries)->contents[coding->eol_type];
4929 }
4930 }
4931
4932 if (force_raw_text)
4933 setup_raw_text_coding_system (coding);
4934 goto done_setup_coding;
4935 }
4936
4937 setup_coding_system (Fcheck_coding_system (val), coding);
4938
4939 done_setup_coding:
4940 if (coding->eol_type == CODING_EOL_UNDECIDED)
4941 coding->eol_type = system_eol_type;
4942 if (!STRINGP (start) && !NILP (current_buffer->selective_display))
4943 coding->mode |= CODING_MODE_SELECTIVE_DISPLAY;
4944 }
4945
4946 DEFUN ("write-region", Fwrite_region, Swrite_region, 3, 7,
4947 "r\nFWrite region to file: \ni\ni\ni\np",
4948 doc: /* Write current region into specified file.
4949 When called from a program, requires three arguments:
4950 START, END and FILENAME. START and END are normally buffer positions
4951 specifying the part of the buffer to write.
4952 If START is nil, that means to use the entire buffer contents.
4953 If START is a string, then output that string to the file
4954 instead of any buffer contents; END is ignored.
4955
4956 Optional fourth argument APPEND if non-nil means
4957 append to existing file contents (if any). If it is an integer,
4958 seek to that offset in the file before writing.
4959 Optional fifth argument VISIT, if t or a string, means
4960 set the last-save-file-modtime of buffer to this file's modtime
4961 and mark buffer not modified.
4962 If VISIT is a string, it is a second file name;
4963 the output goes to FILENAME, but the buffer is marked as visiting VISIT.
4964 VISIT is also the file name to lock and unlock for clash detection.
4965 If VISIT is neither t nor nil nor a string,
4966 that means do not display the \"Wrote file\" message.
4967 The optional sixth arg LOCKNAME, if non-nil, specifies the name to
4968 use for locking and unlocking, overriding FILENAME and VISIT.
4969 The optional seventh arg MUSTBENEW, if non-nil, insists on a check
4970 for an existing file with the same name. If MUSTBENEW is `excl',
4971 that means to get an error if the file already exists; never overwrite.
4972 If MUSTBENEW is neither nil nor `excl', that means ask for
4973 confirmation before overwriting, but do go ahead and overwrite the file
4974 if the user confirms.
4975
4976 This does code conversion according to the value of
4977 `coding-system-for-write', `buffer-file-coding-system', or
4978 `file-coding-system-alist', and sets the variable
4979 `last-coding-system-used' to the coding system actually used. */)
4980 (start, end, filename, append, visit, lockname, mustbenew)
4981 Lisp_Object start, end, filename, append, visit, lockname, mustbenew;
4982 {
4983 register int desc;
4984 int failure;
4985 int save_errno = 0;
4986 const unsigned char *fn;
4987 struct stat st;
4988 int tem;
4989 int count = SPECPDL_INDEX ();
4990 int count1;
4991 #ifdef VMS
4992 unsigned char *fname = 0; /* If non-0, original filename (must rename) */
4993 #endif /* VMS */
4994 Lisp_Object handler;
4995 Lisp_Object visit_file;
4996 Lisp_Object annotations;
4997 Lisp_Object encoded_filename;
4998 int visiting = (EQ (visit, Qt) || STRINGP (visit));
4999 int quietly = !NILP (visit);
5000 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
5001 struct buffer *given_buffer;
5002 #ifdef DOS_NT
5003 int buffer_file_type = O_BINARY;
5004 #endif /* DOS_NT */
5005 struct coding_system coding;
5006
5007 if (current_buffer->base_buffer && visiting)
5008 error ("Cannot do file visiting in an indirect buffer");
5009
5010 if (!NILP (start) && !STRINGP (start))
5011 validate_region (&start, &end);
5012
5013 visit_file = Qnil;
5014 GCPRO5 (start, filename, visit, visit_file, lockname);
5015
5016 filename = Fexpand_file_name (filename, Qnil);
5017
5018 if (!NILP (mustbenew) && !EQ (mustbenew, Qexcl))
5019 barf_or_query_if_file_exists (filename, "overwrite", 1, 0, 1);
5020
5021 if (STRINGP (visit))
5022 visit_file = Fexpand_file_name (visit, Qnil);
5023 else
5024 visit_file = filename;
5025
5026 if (NILP (lockname))
5027 lockname = visit_file;
5028
5029 annotations = Qnil;
5030
5031 /* If the file name has special constructs in it,
5032 call the corresponding file handler. */
5033 handler = Ffind_file_name_handler (filename, Qwrite_region);
5034 /* If FILENAME has no handler, see if VISIT has one. */
5035 if (NILP (handler) && STRINGP (visit))
5036 handler = Ffind_file_name_handler (visit, Qwrite_region);
5037
5038 if (!NILP (handler))
5039 {
5040 Lisp_Object val;
5041 val = call6 (handler, Qwrite_region, start, end,
5042 filename, append, visit);
5043
5044 if (visiting)
5045 {
5046 SAVE_MODIFF = MODIFF;
5047 XSETFASTINT (current_buffer->save_length, Z - BEG);
5048 current_buffer->filename = visit_file;
5049 }
5050 UNGCPRO;
5051 return val;
5052 }
5053
5054 record_unwind_protect (save_restriction_restore, save_restriction_save ());
5055
5056 /* Special kludge to simplify auto-saving. */
5057 if (NILP (start))
5058 {
5059 XSETFASTINT (start, BEG);
5060 XSETFASTINT (end, Z);
5061 Fwiden ();
5062 }
5063
5064 record_unwind_protect (build_annotations_unwind, Fcurrent_buffer ());
5065 count1 = SPECPDL_INDEX ();
5066
5067 given_buffer = current_buffer;
5068
5069 if (!STRINGP (start))
5070 {
5071 annotations = build_annotations (start, end);
5072
5073 if (current_buffer != given_buffer)
5074 {
5075 XSETFASTINT (start, BEGV);
5076 XSETFASTINT (end, ZV);
5077 }
5078 }
5079
5080 UNGCPRO;
5081
5082 GCPRO5 (start, filename, annotations, visit_file, lockname);
5083
5084 /* Decide the coding-system to encode the data with.
5085 We used to make this choice before calling build_annotations, but that
5086 leads to problems when a write-annotate-function takes care of
5087 unsavable chars (as was the case with X-Symbol). */
5088 choose_write_coding_system (start, end, filename,
5089 append, visit, lockname, &coding);
5090 Vlast_coding_system_used = coding.symbol;
5091
5092 given_buffer = current_buffer;
5093 if (! STRINGP (start))
5094 {
5095 annotations = build_annotations_2 (start, end,
5096 coding.pre_write_conversion, annotations);
5097 if (current_buffer != given_buffer)
5098 {
5099 XSETFASTINT (start, BEGV);
5100 XSETFASTINT (end, ZV);
5101 }
5102 }
5103
5104 #ifdef CLASH_DETECTION
5105 if (!auto_saving)
5106 {
5107 #if 0 /* This causes trouble for GNUS. */
5108 /* If we've locked this file for some other buffer,
5109 query before proceeding. */
5110 if (!visiting && EQ (Ffile_locked_p (lockname), Qt))
5111 call2 (intern ("ask-user-about-lock"), filename, Vuser_login_name);
5112 #endif
5113
5114 lock_file (lockname);
5115 }
5116 #endif /* CLASH_DETECTION */
5117
5118 encoded_filename = ENCODE_FILE (filename);
5119
5120 fn = SDATA (encoded_filename);
5121 desc = -1;
5122 if (!NILP (append))
5123 #ifdef DOS_NT
5124 desc = emacs_open (fn, O_WRONLY | buffer_file_type, 0);
5125 #else /* not DOS_NT */
5126 desc = emacs_open (fn, O_WRONLY, 0);
5127 #endif /* not DOS_NT */
5128
5129 if (desc < 0 && (NILP (append) || errno == ENOENT))
5130 #ifdef VMS
5131 if (auto_saving) /* Overwrite any previous version of autosave file */
5132 {
5133 vms_truncate (fn); /* if fn exists, truncate to zero length */
5134 desc = emacs_open (fn, O_RDWR, 0);
5135 if (desc < 0)
5136 desc = creat_copy_attrs (STRINGP (current_buffer->filename)
5137 ? SDATA (current_buffer->filename) : 0,
5138 fn);
5139 }
5140 else /* Write to temporary name and rename if no errors */
5141 {
5142 Lisp_Object temp_name;
5143 temp_name = Ffile_name_directory (filename);
5144
5145 if (!NILP (temp_name))
5146 {
5147 temp_name = Fmake_temp_name (concat2 (temp_name,
5148 build_string ("$$SAVE$$")));
5149 fname = SDATA (filename);
5150 fn = SDATA (temp_name);
5151 desc = creat_copy_attrs (fname, fn);
5152 if (desc < 0)
5153 {
5154 /* If we can't open the temporary file, try creating a new
5155 version of the original file. VMS "creat" creates a
5156 new version rather than truncating an existing file. */
5157 fn = fname;
5158 fname = 0;
5159 desc = creat (fn, 0666);
5160 #if 0 /* This can clobber an existing file and fail to replace it,
5161 if the user runs out of space. */
5162 if (desc < 0)
5163 {
5164 /* We can't make a new version;
5165 try to truncate and rewrite existing version if any. */
5166 vms_truncate (fn);
5167 desc = emacs_open (fn, O_RDWR, 0);
5168 }
5169 #endif
5170 }
5171 }
5172 else
5173 desc = creat (fn, 0666);
5174 }
5175 #else /* not VMS */
5176 #ifdef DOS_NT
5177 desc = emacs_open (fn,
5178 O_WRONLY | O_CREAT | buffer_file_type
5179 | (EQ (mustbenew, Qexcl) ? O_EXCL : O_TRUNC),
5180 S_IREAD | S_IWRITE);
5181 #else /* not DOS_NT */
5182 desc = emacs_open (fn, O_WRONLY | O_TRUNC | O_CREAT
5183 | (EQ (mustbenew, Qexcl) ? O_EXCL : 0),
5184 auto_saving ? auto_save_mode_bits : 0666);
5185 #endif /* not DOS_NT */
5186 #endif /* not VMS */
5187
5188 if (desc < 0)
5189 {
5190 #ifdef CLASH_DETECTION
5191 save_errno = errno;
5192 if (!auto_saving) unlock_file (lockname);
5193 errno = save_errno;
5194 #endif /* CLASH_DETECTION */
5195 UNGCPRO;
5196 report_file_error ("Opening output file", Fcons (filename, Qnil));
5197 }
5198
5199 record_unwind_protect (close_file_unwind, make_number (desc));
5200
5201 if (!NILP (append) && !NILP (Ffile_regular_p (filename)))
5202 {
5203 long ret;
5204
5205 if (NUMBERP (append))
5206 ret = lseek (desc, XINT (append), 1);
5207 else
5208 ret = lseek (desc, 0, 2);
5209 if (ret < 0)
5210 {
5211 #ifdef CLASH_DETECTION
5212 if (!auto_saving) unlock_file (lockname);
5213 #endif /* CLASH_DETECTION */
5214 UNGCPRO;
5215 report_file_error ("Lseek error", Fcons (filename, Qnil));
5216 }
5217 }
5218
5219 UNGCPRO;
5220
5221 #ifdef VMS
5222 /*
5223 * Kludge Warning: The VMS C RTL likes to insert carriage returns
5224 * if we do writes that don't end with a carriage return. Furthermore
5225 * it cannot handle writes of more then 16K. The modified
5226 * version of "sys_write" in SYSDEP.C (see comment there) copes with
5227 * this EXCEPT for the last record (iff it doesn't end with a carriage
5228 * return). This implies that if your buffer doesn't end with a carriage
5229 * return, you get one free... tough. However it also means that if
5230 * we make two calls to sys_write (a la the following code) you can
5231 * get one at the gap as well. The easiest way to fix this (honest)
5232 * is to move the gap to the next newline (or the end of the buffer).
5233 * Thus this change.
5234 *
5235 * Yech!
5236 */
5237 if (GPT > BEG && GPT_ADDR[-1] != '\n')
5238 move_gap (find_next_newline (GPT, 1));
5239 #else
5240 /* Whether VMS or not, we must move the gap to the next of newline
5241 when we must put designation sequences at beginning of line. */
5242 if (INTEGERP (start)
5243 && coding.type == coding_type_iso2022
5244 && coding.flags & CODING_FLAG_ISO_DESIGNATE_AT_BOL
5245 && GPT > BEG && GPT_ADDR[-1] != '\n')
5246 {
5247 int opoint = PT, opoint_byte = PT_BYTE;
5248 scan_newline (PT, PT_BYTE, ZV, ZV_BYTE, 1, 0);
5249 move_gap_both (PT, PT_BYTE);
5250 SET_PT_BOTH (opoint, opoint_byte);
5251 }
5252 #endif
5253
5254 failure = 0;
5255 immediate_quit = 1;
5256
5257 if (STRINGP (start))
5258 {
5259 failure = 0 > a_write (desc, start, 0, SCHARS (start),
5260 &annotations, &coding);
5261 save_errno = errno;
5262 }
5263 else if (XINT (start) != XINT (end))
5264 {
5265 tem = CHAR_TO_BYTE (XINT (start));
5266
5267 if (XINT (start) < GPT)
5268 {
5269 failure = 0 > a_write (desc, Qnil, XINT (start),
5270 min (GPT, XINT (end)) - XINT (start),
5271 &annotations, &coding);
5272 save_errno = errno;
5273 }
5274
5275 if (XINT (end) > GPT && !failure)
5276 {
5277 tem = max (XINT (start), GPT);
5278 failure = 0 > a_write (desc, Qnil, tem , XINT (end) - tem,
5279 &annotations, &coding);
5280 save_errno = errno;
5281 }
5282 }
5283 else
5284 {
5285 /* If file was empty, still need to write the annotations */
5286 coding.mode |= CODING_MODE_LAST_BLOCK;
5287 failure = 0 > a_write (desc, Qnil, XINT (end), 0, &annotations, &coding);
5288 save_errno = errno;
5289 }
5290
5291 if (CODING_REQUIRE_FLUSHING (&coding)
5292 && !(coding.mode & CODING_MODE_LAST_BLOCK)
5293 && ! failure)
5294 {
5295 /* We have to flush out a data. */
5296 coding.mode |= CODING_MODE_LAST_BLOCK;
5297 failure = 0 > e_write (desc, Qnil, 0, 0, &coding);
5298 save_errno = errno;
5299 }
5300
5301 immediate_quit = 0;
5302
5303 #ifdef HAVE_FSYNC
5304 /* Note fsync appears to change the modtime on BSD4.2 (both vax and sun).
5305 Disk full in NFS may be reported here. */
5306 /* mib says that closing the file will try to write as fast as NFS can do
5307 it, and that means the fsync here is not crucial for autosave files. */
5308 if (!auto_saving && !write_region_inhibit_fsync && fsync (desc) < 0)
5309 {
5310 /* If fsync fails with EINTR, don't treat that as serious. */
5311 if (errno != EINTR)
5312 failure = 1, save_errno = errno;
5313 }
5314 #endif
5315
5316 /* Spurious "file has changed on disk" warnings have been
5317 observed on Suns as well.
5318 It seems that `close' can change the modtime, under nfs.
5319
5320 (This has supposedly been fixed in Sunos 4,
5321 but who knows about all the other machines with NFS?) */
5322 #if 0
5323
5324 /* On VMS and APOLLO, must do the stat after the close
5325 since closing changes the modtime. */
5326 #ifndef VMS
5327 #ifndef APOLLO
5328 /* Recall that #if defined does not work on VMS. */
5329 #define FOO
5330 fstat (desc, &st);
5331 #endif
5332 #endif
5333 #endif
5334
5335 /* NFS can report a write failure now. */
5336 if (emacs_close (desc) < 0)
5337 failure = 1, save_errno = errno;
5338
5339 #ifdef VMS
5340 /* If we wrote to a temporary name and had no errors, rename to real name. */
5341 if (fname)
5342 {
5343 if (!failure)
5344 failure = (rename (fn, fname) != 0), save_errno = errno;
5345 fn = fname;
5346 }
5347 #endif /* VMS */
5348
5349 #ifndef FOO
5350 stat (fn, &st);
5351 #endif
5352 /* Discard the unwind protect for close_file_unwind. */
5353 specpdl_ptr = specpdl + count1;
5354 /* Restore the original current buffer. */
5355 visit_file = unbind_to (count, visit_file);
5356
5357 #ifdef CLASH_DETECTION
5358 if (!auto_saving)
5359 unlock_file (lockname);
5360 #endif /* CLASH_DETECTION */
5361
5362 /* Do this before reporting IO error
5363 to avoid a "file has changed on disk" warning on
5364 next attempt to save. */
5365 if (visiting)
5366 current_buffer->modtime = st.st_mtime;
5367
5368 if (failure)
5369 error ("IO error writing %s: %s", SDATA (filename),
5370 emacs_strerror (save_errno));
5371
5372 if (visiting)
5373 {
5374 SAVE_MODIFF = MODIFF;
5375 XSETFASTINT (current_buffer->save_length, Z - BEG);
5376 current_buffer->filename = visit_file;
5377 update_mode_lines++;
5378 }
5379 else if (quietly)
5380 {
5381 if (auto_saving
5382 && ! NILP (Fstring_equal (current_buffer->filename,
5383 current_buffer->auto_save_file_name)))
5384 SAVE_MODIFF = MODIFF;
5385
5386 return Qnil;
5387 }
5388
5389 if (!auto_saving)
5390 message_with_string ((INTEGERP (append)
5391 ? "Updated %s"
5392 : ! NILP (append)
5393 ? "Added to %s"
5394 : "Wrote %s"),
5395 visit_file, 1);
5396
5397 return Qnil;
5398 }
5399 \f
5400 Lisp_Object merge ();
5401
5402 DEFUN ("car-less-than-car", Fcar_less_than_car, Scar_less_than_car, 2, 2, 0,
5403 doc: /* Return t if (car A) is numerically less than (car B). */)
5404 (a, b)
5405 Lisp_Object a, b;
5406 {
5407 return Flss (Fcar (a), Fcar (b));
5408 }
5409
5410 /* Build the complete list of annotations appropriate for writing out
5411 the text between START and END, by calling all the functions in
5412 write-region-annotate-functions and merging the lists they return.
5413 If one of these functions switches to a different buffer, we assume
5414 that buffer contains altered text. Therefore, the caller must
5415 make sure to restore the current buffer in all cases,
5416 as save-excursion would do. */
5417
5418 static Lisp_Object
5419 build_annotations (start, end)
5420 Lisp_Object start, end;
5421 {
5422 Lisp_Object annotations;
5423 Lisp_Object p, res;
5424 struct gcpro gcpro1, gcpro2;
5425 Lisp_Object original_buffer;
5426 int i, used_global = 0;
5427
5428 XSETBUFFER (original_buffer, current_buffer);
5429
5430 annotations = Qnil;
5431 p = Vwrite_region_annotate_functions;
5432 GCPRO2 (annotations, p);
5433 while (CONSP (p))
5434 {
5435 struct buffer *given_buffer = current_buffer;
5436 if (EQ (Qt, XCAR (p)) && !used_global)
5437 { /* Use the global value of the hook. */
5438 Lisp_Object arg[2];
5439 used_global = 1;
5440 arg[0] = Fdefault_value (Qwrite_region_annotate_functions);
5441 arg[1] = XCDR (p);
5442 p = Fappend (2, arg);
5443 continue;
5444 }
5445 Vwrite_region_annotations_so_far = annotations;
5446 res = call2 (XCAR (p), start, end);
5447 /* If the function makes a different buffer current,
5448 assume that means this buffer contains altered text to be output.
5449 Reset START and END from the buffer bounds
5450 and discard all previous annotations because they should have
5451 been dealt with by this function. */
5452 if (current_buffer != given_buffer)
5453 {
5454 XSETFASTINT (start, BEGV);
5455 XSETFASTINT (end, ZV);
5456 annotations = Qnil;
5457 }
5458 Flength (res); /* Check basic validity of return value */
5459 annotations = merge (annotations, res, Qcar_less_than_car);
5460 p = XCDR (p);
5461 }
5462
5463 /* Now do the same for annotation functions implied by the file-format */
5464 if (auto_saving && (!EQ (current_buffer->auto_save_file_format, Qt)))
5465 p = current_buffer->auto_save_file_format;
5466 else
5467 p = current_buffer->file_format;
5468 for (i = 0; CONSP (p); p = XCDR (p), ++i)
5469 {
5470 struct buffer *given_buffer = current_buffer;
5471
5472 Vwrite_region_annotations_so_far = annotations;
5473
5474 /* Value is either a list of annotations or nil if the function
5475 has written annotations to a temporary buffer, which is now
5476 current. */
5477 res = call5 (Qformat_annotate_function, XCAR (p), start, end,
5478 original_buffer, make_number (i));
5479 if (current_buffer != given_buffer)
5480 {
5481 XSETFASTINT (start, BEGV);
5482 XSETFASTINT (end, ZV);
5483 annotations = Qnil;
5484 }
5485
5486 if (CONSP (res))
5487 annotations = merge (annotations, res, Qcar_less_than_car);
5488 }
5489
5490 UNGCPRO;
5491 return annotations;
5492 }
5493
5494 static Lisp_Object
5495 build_annotations_2 (start, end, pre_write_conversion, annotations)
5496 Lisp_Object start, end, pre_write_conversion, annotations;
5497 {
5498 struct gcpro gcpro1;
5499 Lisp_Object res;
5500
5501 GCPRO1 (annotations);
5502 /* At last, do the same for the function PRE_WRITE_CONVERSION
5503 implied by the current coding-system. */
5504 if (!NILP (pre_write_conversion))
5505 {
5506 struct buffer *given_buffer = current_buffer;
5507 Vwrite_region_annotations_so_far = annotations;
5508 res = call2 (pre_write_conversion, start, end);
5509 Flength (res);
5510 annotations = (current_buffer != given_buffer
5511 ? res
5512 : merge (annotations, res, Qcar_less_than_car));
5513 }
5514
5515 UNGCPRO;
5516 return annotations;
5517 }
5518 \f
5519 /* Write to descriptor DESC the NCHARS chars starting at POS of STRING.
5520 If STRING is nil, POS is the character position in the current buffer.
5521 Intersperse with them the annotations from *ANNOT
5522 which fall within the range of POS to POS + NCHARS,
5523 each at its appropriate position.
5524
5525 We modify *ANNOT by discarding elements as we use them up.
5526
5527 The return value is negative in case of system call failure. */
5528
5529 static int
5530 a_write (desc, string, pos, nchars, annot, coding)
5531 int desc;
5532 Lisp_Object string;
5533 register int nchars;
5534 int pos;
5535 Lisp_Object *annot;
5536 struct coding_system *coding;
5537 {
5538 Lisp_Object tem;
5539 int nextpos;
5540 int lastpos = pos + nchars;
5541
5542 while (NILP (*annot) || CONSP (*annot))
5543 {
5544 tem = Fcar_safe (Fcar (*annot));
5545 nextpos = pos - 1;
5546 if (INTEGERP (tem))
5547 nextpos = XFASTINT (tem);
5548
5549 /* If there are no more annotations in this range,
5550 output the rest of the range all at once. */
5551 if (! (nextpos >= pos && nextpos <= lastpos))
5552 return e_write (desc, string, pos, lastpos, coding);
5553
5554 /* Output buffer text up to the next annotation's position. */
5555 if (nextpos > pos)
5556 {
5557 if (0 > e_write (desc, string, pos, nextpos, coding))
5558 return -1;
5559 pos = nextpos;
5560 }
5561 /* Output the annotation. */
5562 tem = Fcdr (Fcar (*annot));
5563 if (STRINGP (tem))
5564 {
5565 if (0 > e_write (desc, tem, 0, SCHARS (tem), coding))
5566 return -1;
5567 }
5568 *annot = Fcdr (*annot);
5569 }
5570 return 0;
5571 }
5572
5573 #ifndef WRITE_BUF_SIZE
5574 #define WRITE_BUF_SIZE (16 * 1024)
5575 #endif
5576
5577 /* Write text in the range START and END into descriptor DESC,
5578 encoding them with coding system CODING. If STRING is nil, START
5579 and END are character positions of the current buffer, else they
5580 are indexes to the string STRING. */
5581
5582 static int
5583 e_write (desc, string, start, end, coding)
5584 int desc;
5585 Lisp_Object string;
5586 int start, end;
5587 struct coding_system *coding;
5588 {
5589 register char *addr;
5590 register int nbytes;
5591 char buf[WRITE_BUF_SIZE];
5592 int return_val = 0;
5593
5594 if (start >= end)
5595 coding->composing = COMPOSITION_DISABLED;
5596 if (coding->composing != COMPOSITION_DISABLED)
5597 coding_save_composition (coding, start, end, string);
5598
5599 if (STRINGP (string))
5600 {
5601 addr = SDATA (string);
5602 nbytes = SBYTES (string);
5603 coding->src_multibyte = STRING_MULTIBYTE (string);
5604 }
5605 else if (start < end)
5606 {
5607 /* It is assured that the gap is not in the range START and END-1. */
5608 addr = CHAR_POS_ADDR (start);
5609 nbytes = CHAR_TO_BYTE (end) - CHAR_TO_BYTE (start);
5610 coding->src_multibyte
5611 = !NILP (current_buffer->enable_multibyte_characters);
5612 }
5613 else
5614 {
5615 addr = "";
5616 nbytes = 0;
5617 coding->src_multibyte = 1;
5618 }
5619
5620 /* We used to have a code for handling selective display here. But,
5621 now it is handled within encode_coding. */
5622 while (1)
5623 {
5624 int result;
5625
5626 result = encode_coding (coding, addr, buf, nbytes, WRITE_BUF_SIZE);
5627 if (coding->produced > 0)
5628 {
5629 coding->produced -= emacs_write (desc, buf, coding->produced);
5630 if (coding->produced)
5631 {
5632 return_val = -1;
5633 break;
5634 }
5635 }
5636 nbytes -= coding->consumed;
5637 addr += coding->consumed;
5638 if (result == CODING_FINISH_INSUFFICIENT_SRC
5639 && nbytes > 0)
5640 {
5641 /* The source text ends by an incomplete multibyte form.
5642 There's no way other than write it out as is. */
5643 nbytes -= emacs_write (desc, addr, nbytes);
5644 if (nbytes)
5645 {
5646 return_val = -1;
5647 break;
5648 }
5649 }
5650 if (nbytes <= 0)
5651 break;
5652 start += coding->consumed_char;
5653 if (coding->cmp_data)
5654 coding_adjust_composition_offset (coding, start);
5655 }
5656
5657 if (coding->cmp_data)
5658 coding_free_composition_data (coding);
5659
5660 return return_val;
5661 }
5662 \f
5663 DEFUN ("verify-visited-file-modtime", Fverify_visited_file_modtime,
5664 Sverify_visited_file_modtime, 1, 1, 0,
5665 doc: /* Return t if last mod time of BUF's visited file matches what BUF records.
5666 This means that the file has not been changed since it was visited or saved.
5667 See Info node `(elisp)Modification Time' for more details. */)
5668 (buf)
5669 Lisp_Object buf;
5670 {
5671 struct buffer *b;
5672 struct stat st;
5673 Lisp_Object handler;
5674 Lisp_Object filename;
5675
5676 CHECK_BUFFER (buf);
5677 b = XBUFFER (buf);
5678
5679 if (!STRINGP (b->filename)) return Qt;
5680 if (b->modtime == 0) return Qt;
5681
5682 /* If the file name has special constructs in it,
5683 call the corresponding file handler. */
5684 handler = Ffind_file_name_handler (b->filename,
5685 Qverify_visited_file_modtime);
5686 if (!NILP (handler))
5687 return call2 (handler, Qverify_visited_file_modtime, buf);
5688
5689 filename = ENCODE_FILE (b->filename);
5690
5691 if (stat (SDATA (filename), &st) < 0)
5692 {
5693 /* If the file doesn't exist now and didn't exist before,
5694 we say that it isn't modified, provided the error is a tame one. */
5695 if (errno == ENOENT || errno == EACCES || errno == ENOTDIR)
5696 st.st_mtime = -1;
5697 else
5698 st.st_mtime = 0;
5699 }
5700 if (st.st_mtime == b->modtime
5701 /* If both are positive, accept them if they are off by one second. */
5702 || (st.st_mtime > 0 && b->modtime > 0
5703 && (st.st_mtime == b->modtime + 1
5704 || st.st_mtime == b->modtime - 1)))
5705 return Qt;
5706 return Qnil;
5707 }
5708
5709 DEFUN ("clear-visited-file-modtime", Fclear_visited_file_modtime,
5710 Sclear_visited_file_modtime, 0, 0, 0,
5711 doc: /* Clear out records of last mod time of visited file.
5712 Next attempt to save will certainly not complain of a discrepancy. */)
5713 ()
5714 {
5715 current_buffer->modtime = 0;
5716 return Qnil;
5717 }
5718
5719 DEFUN ("visited-file-modtime", Fvisited_file_modtime,
5720 Svisited_file_modtime, 0, 0, 0,
5721 doc: /* Return the current buffer's recorded visited file modification time.
5722 The value is a list of the form (HIGH LOW), like the time values
5723 that `file-attributes' returns. If the current buffer has no recorded
5724 file modification time, this function returns 0.
5725 See Info node `(elisp)Modification Time' for more details. */)
5726 ()
5727 {
5728 Lisp_Object tcons;
5729 tcons = long_to_cons ((unsigned long) current_buffer->modtime);
5730 if (CONSP (tcons))
5731 return list2 (XCAR (tcons), XCDR (tcons));
5732 return tcons;
5733 }
5734
5735 DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime,
5736 Sset_visited_file_modtime, 0, 1, 0,
5737 doc: /* Update buffer's recorded modification time from the visited file's time.
5738 Useful if the buffer was not read from the file normally
5739 or if the file itself has been changed for some known benign reason.
5740 An argument specifies the modification time value to use
5741 \(instead of that of the visited file), in the form of a list
5742 \(HIGH . LOW) or (HIGH LOW). */)
5743 (time_list)
5744 Lisp_Object time_list;
5745 {
5746 if (!NILP (time_list))
5747 current_buffer->modtime = cons_to_long (time_list);
5748 else
5749 {
5750 register Lisp_Object filename;
5751 struct stat st;
5752 Lisp_Object handler;
5753
5754 filename = Fexpand_file_name (current_buffer->filename, Qnil);
5755
5756 /* If the file name has special constructs in it,
5757 call the corresponding file handler. */
5758 handler = Ffind_file_name_handler (filename, Qset_visited_file_modtime);
5759 if (!NILP (handler))
5760 /* The handler can find the file name the same way we did. */
5761 return call2 (handler, Qset_visited_file_modtime, Qnil);
5762
5763 filename = ENCODE_FILE (filename);
5764
5765 if (stat (SDATA (filename), &st) >= 0)
5766 current_buffer->modtime = st.st_mtime;
5767 }
5768
5769 return Qnil;
5770 }
5771 \f
5772 Lisp_Object
5773 auto_save_error (error)
5774 Lisp_Object error;
5775 {
5776 Lisp_Object args[3], msg;
5777 int i, nbytes;
5778 struct gcpro gcpro1;
5779 char *msgbuf;
5780 USE_SAFE_ALLOCA;
5781
5782 ring_bell ();
5783
5784 args[0] = build_string ("Auto-saving %s: %s");
5785 args[1] = current_buffer->name;
5786 args[2] = Ferror_message_string (error);
5787 msg = Fformat (3, args);
5788 GCPRO1 (msg);
5789 nbytes = SBYTES (msg);
5790 SAFE_ALLOCA (msgbuf, char *, nbytes);
5791 bcopy (SDATA (msg), msgbuf, nbytes);
5792
5793 for (i = 0; i < 3; ++i)
5794 {
5795 if (i == 0)
5796 message2 (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5797 else
5798 message2_nolog (msgbuf, nbytes, STRING_MULTIBYTE (msg));
5799 Fsleep_for (make_number (1), Qnil);
5800 }
5801
5802 SAFE_FREE ();
5803 UNGCPRO;
5804 return Qnil;
5805 }
5806
5807 Lisp_Object
5808 auto_save_1 ()
5809 {
5810 struct stat st;
5811 Lisp_Object modes;
5812
5813 auto_save_mode_bits = 0666;
5814
5815 /* Get visited file's mode to become the auto save file's mode. */
5816 if (! NILP (current_buffer->filename))
5817 {
5818 if (stat (SDATA (current_buffer->filename), &st) >= 0)
5819 /* But make sure we can overwrite it later! */
5820 auto_save_mode_bits = st.st_mode | 0600;
5821 else if ((modes = Ffile_modes (current_buffer->filename),
5822 INTEGERP (modes)))
5823 /* Remote files don't cooperate with stat. */
5824 auto_save_mode_bits = XINT (modes) | 0600;
5825 }
5826
5827 return
5828 Fwrite_region (Qnil, Qnil,
5829 current_buffer->auto_save_file_name,
5830 Qnil, Qlambda, Qnil, Qnil);
5831 }
5832
5833 static Lisp_Object
5834 do_auto_save_unwind (arg) /* used as unwind-protect function */
5835 Lisp_Object arg;
5836 {
5837 FILE *stream = (FILE *) XSAVE_VALUE (arg)->pointer;
5838 auto_saving = 0;
5839 if (stream != NULL)
5840 fclose (stream);
5841 return Qnil;
5842 }
5843
5844 static Lisp_Object
5845 do_auto_save_unwind_1 (value) /* used as unwind-protect function */
5846 Lisp_Object value;
5847 {
5848 minibuffer_auto_raise = XINT (value);
5849 return Qnil;
5850 }
5851
5852 static Lisp_Object
5853 do_auto_save_make_dir (dir)
5854 Lisp_Object dir;
5855 {
5856 Lisp_Object mode;
5857
5858 call2 (Qmake_directory, dir, Qt);
5859 XSETFASTINT (mode, 0700);
5860 return Fset_file_modes (dir, mode);
5861 }
5862
5863 static Lisp_Object
5864 do_auto_save_eh (ignore)
5865 Lisp_Object ignore;
5866 {
5867 return Qnil;
5868 }
5869
5870 DEFUN ("do-auto-save", Fdo_auto_save, Sdo_auto_save, 0, 2, "",
5871 doc: /* Auto-save all buffers that need it.
5872 This is all buffers that have auto-saving enabled
5873 and are changed since last auto-saved.
5874 Auto-saving writes the buffer into a file
5875 so that your editing is not lost if the system crashes.
5876 This file is not the file you visited; that changes only when you save.
5877 Normally we run the normal hook `auto-save-hook' before saving.
5878
5879 A non-nil NO-MESSAGE argument means do not print any message if successful.
5880 A non-nil CURRENT-ONLY argument means save only current buffer. */)
5881 (no_message, current_only)
5882 Lisp_Object no_message, current_only;
5883 {
5884 struct buffer *old = current_buffer, *b;
5885 Lisp_Object tail, buf;
5886 int auto_saved = 0;
5887 int do_handled_files;
5888 Lisp_Object oquit;
5889 FILE *stream = NULL;
5890 int count = SPECPDL_INDEX ();
5891 int orig_minibuffer_auto_raise = minibuffer_auto_raise;
5892 int old_message_p = 0;
5893 struct gcpro gcpro1, gcpro2;
5894
5895 if (max_specpdl_size < specpdl_size + 40)
5896 max_specpdl_size = specpdl_size + 40;
5897
5898 if (minibuf_level)
5899 no_message = Qt;
5900
5901 if (NILP (no_message))
5902 {
5903 old_message_p = push_message ();
5904 record_unwind_protect (pop_message_unwind, Qnil);
5905 }
5906
5907 /* Ordinarily don't quit within this function,
5908 but don't make it impossible to quit (in case we get hung in I/O). */
5909 oquit = Vquit_flag;
5910 Vquit_flag = Qnil;
5911
5912 /* No GCPRO needed, because (when it matters) all Lisp_Object variables
5913 point to non-strings reached from Vbuffer_alist. */
5914
5915 if (!NILP (Vrun_hooks))
5916 call1 (Vrun_hooks, intern ("auto-save-hook"));
5917
5918 if (STRINGP (Vauto_save_list_file_name))
5919 {
5920 Lisp_Object listfile;
5921
5922 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
5923
5924 /* Don't try to create the directory when shutting down Emacs,
5925 because creating the directory might signal an error, and
5926 that would leave Emacs in a strange state. */
5927 if (!NILP (Vrun_hooks))
5928 {
5929 Lisp_Object dir;
5930 dir = Qnil;
5931 GCPRO2 (dir, listfile);
5932 dir = Ffile_name_directory (listfile);
5933 if (NILP (Ffile_directory_p (dir)))
5934 internal_condition_case_1 (do_auto_save_make_dir,
5935 dir, Fcons (Fcons (Qfile_error, Qnil), Qnil),
5936 do_auto_save_eh);
5937 UNGCPRO;
5938 }
5939
5940 stream = fopen (SDATA (listfile), "w");
5941 }
5942
5943 record_unwind_protect (do_auto_save_unwind,
5944 make_save_value (stream, 0));
5945 record_unwind_protect (do_auto_save_unwind_1,
5946 make_number (minibuffer_auto_raise));
5947 minibuffer_auto_raise = 0;
5948 auto_saving = 1;
5949
5950 /* On first pass, save all files that don't have handlers.
5951 On second pass, save all files that do have handlers.
5952
5953 If Emacs is crashing, the handlers may tweak what is causing
5954 Emacs to crash in the first place, and it would be a shame if
5955 Emacs failed to autosave perfectly ordinary files because it
5956 couldn't handle some ange-ftp'd file. */
5957
5958 for (do_handled_files = 0; do_handled_files < 2; do_handled_files++)
5959 for (tail = Vbuffer_alist; GC_CONSP (tail); tail = XCDR (tail))
5960 {
5961 buf = XCDR (XCAR (tail));
5962 b = XBUFFER (buf);
5963
5964 /* Record all the buffers that have auto save mode
5965 in the special file that lists them. For each of these buffers,
5966 Record visited name (if any) and auto save name. */
5967 if (STRINGP (b->auto_save_file_name)
5968 && stream != NULL && do_handled_files == 0)
5969 {
5970 if (!NILP (b->filename))
5971 {
5972 fwrite (SDATA (b->filename), 1,
5973 SBYTES (b->filename), stream);
5974 }
5975 putc ('\n', stream);
5976 fwrite (SDATA (b->auto_save_file_name), 1,
5977 SBYTES (b->auto_save_file_name), stream);
5978 putc ('\n', stream);
5979 }
5980
5981 if (!NILP (current_only)
5982 && b != current_buffer)
5983 continue;
5984
5985 /* Don't auto-save indirect buffers.
5986 The base buffer takes care of it. */
5987 if (b->base_buffer)
5988 continue;
5989
5990 /* Check for auto save enabled
5991 and file changed since last auto save
5992 and file changed since last real save. */
5993 if (STRINGP (b->auto_save_file_name)
5994 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
5995 && b->auto_save_modified < BUF_MODIFF (b)
5996 /* -1 means we've turned off autosaving for a while--see below. */
5997 && XINT (b->save_length) >= 0
5998 && (do_handled_files
5999 || NILP (Ffind_file_name_handler (b->auto_save_file_name,
6000 Qwrite_region))))
6001 {
6002 EMACS_TIME before_time, after_time;
6003
6004 EMACS_GET_TIME (before_time);
6005
6006 /* If we had a failure, don't try again for 20 minutes. */
6007 if (b->auto_save_failure_time >= 0
6008 && EMACS_SECS (before_time) - b->auto_save_failure_time < 1200)
6009 continue;
6010
6011 if ((XFASTINT (b->save_length) * 10
6012 > (BUF_Z (b) - BUF_BEG (b)) * 13)
6013 /* A short file is likely to change a large fraction;
6014 spare the user annoying messages. */
6015 && XFASTINT (b->save_length) > 5000
6016 /* These messages are frequent and annoying for `*mail*'. */
6017 && !EQ (b->filename, Qnil)
6018 && NILP (no_message))
6019 {
6020 /* It has shrunk too much; turn off auto-saving here. */
6021 minibuffer_auto_raise = orig_minibuffer_auto_raise;
6022 message_with_string ("Buffer %s has shrunk a lot; auto save disabled in that buffer until next real save",
6023 b->name, 1);
6024 minibuffer_auto_raise = 0;
6025 /* Turn off auto-saving until there's a real save,
6026 and prevent any more warnings. */
6027 XSETINT (b->save_length, -1);
6028 Fsleep_for (make_number (1), Qnil);
6029 continue;
6030 }
6031 set_buffer_internal (b);
6032 if (!auto_saved && NILP (no_message))
6033 message1 ("Auto-saving...");
6034 internal_condition_case (auto_save_1, Qt, auto_save_error);
6035 auto_saved++;
6036 b->auto_save_modified = BUF_MODIFF (b);
6037 XSETFASTINT (current_buffer->save_length, Z - BEG);
6038 set_buffer_internal (old);
6039
6040 EMACS_GET_TIME (after_time);
6041
6042 /* If auto-save took more than 60 seconds,
6043 assume it was an NFS failure that got a timeout. */
6044 if (EMACS_SECS (after_time) - EMACS_SECS (before_time) > 60)
6045 b->auto_save_failure_time = EMACS_SECS (after_time);
6046 }
6047 }
6048
6049 /* Prevent another auto save till enough input events come in. */
6050 record_auto_save ();
6051
6052 if (auto_saved && NILP (no_message))
6053 {
6054 if (old_message_p)
6055 {
6056 /* If we are going to restore an old message,
6057 give time to read ours. */
6058 sit_for (make_number (1), 0, 0);
6059 restore_message ();
6060 }
6061 else
6062 /* If we displayed a message and then restored a state
6063 with no message, leave a "done" message on the screen. */
6064 message1 ("Auto-saving...done");
6065 }
6066
6067 Vquit_flag = oquit;
6068
6069 /* This restores the message-stack status. */
6070 unbind_to (count, Qnil);
6071 return Qnil;
6072 }
6073
6074 DEFUN ("set-buffer-auto-saved", Fset_buffer_auto_saved,
6075 Sset_buffer_auto_saved, 0, 0, 0,
6076 doc: /* Mark current buffer as auto-saved with its current text.
6077 No auto-save file will be written until the buffer changes again. */)
6078 ()
6079 {
6080 current_buffer->auto_save_modified = MODIFF;
6081 XSETFASTINT (current_buffer->save_length, Z - BEG);
6082 current_buffer->auto_save_failure_time = -1;
6083 return Qnil;
6084 }
6085
6086 DEFUN ("clear-buffer-auto-save-failure", Fclear_buffer_auto_save_failure,
6087 Sclear_buffer_auto_save_failure, 0, 0, 0,
6088 doc: /* Clear any record of a recent auto-save failure in the current buffer. */)
6089 ()
6090 {
6091 current_buffer->auto_save_failure_time = -1;
6092 return Qnil;
6093 }
6094
6095 DEFUN ("recent-auto-save-p", Frecent_auto_save_p, Srecent_auto_save_p,
6096 0, 0, 0,
6097 doc: /* Return t if current buffer has been auto-saved recently.
6098 More precisely, if it has been auto-saved since last read from or saved
6099 in the visited file. If the buffer has no visited file,
6100 then any auto-save counts as "recent". */)
6101 ()
6102 {
6103 return (SAVE_MODIFF < current_buffer->auto_save_modified) ? Qt : Qnil;
6104 }
6105 \f
6106 /* Reading and completing file names */
6107 extern Lisp_Object Ffile_name_completion (), Ffile_name_all_completions ();
6108
6109 /* In the string VAL, change each $ to $$ and return the result. */
6110
6111 static Lisp_Object
6112 double_dollars (val)
6113 Lisp_Object val;
6114 {
6115 register const unsigned char *old;
6116 register unsigned char *new;
6117 register int n;
6118 int osize, count;
6119
6120 osize = SBYTES (val);
6121
6122 /* Count the number of $ characters. */
6123 for (n = osize, count = 0, old = SDATA (val); n > 0; n--)
6124 if (*old++ == '$') count++;
6125 if (count > 0)
6126 {
6127 old = SDATA (val);
6128 val = make_uninit_multibyte_string (SCHARS (val) + count,
6129 osize + count);
6130 new = SDATA (val);
6131 for (n = osize; n > 0; n--)
6132 if (*old != '$')
6133 *new++ = *old++;
6134 else
6135 {
6136 *new++ = '$';
6137 *new++ = '$';
6138 old++;
6139 }
6140 }
6141 return val;
6142 }
6143
6144 static Lisp_Object
6145 read_file_name_cleanup (arg)
6146 Lisp_Object arg;
6147 {
6148 return (current_buffer->directory = arg);
6149 }
6150
6151 DEFUN ("read-file-name-internal", Fread_file_name_internal, Sread_file_name_internal,
6152 3, 3, 0,
6153 doc: /* Internal subroutine for read-file-name. Do not call this. */)
6154 (string, dir, action)
6155 Lisp_Object string, dir, action;
6156 /* action is nil for complete, t for return list of completions,
6157 lambda for verify final value */
6158 {
6159 Lisp_Object name, specdir, realdir, val, orig_string;
6160 int changed;
6161 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
6162
6163 CHECK_STRING (string);
6164
6165 realdir = dir;
6166 name = string;
6167 orig_string = Qnil;
6168 specdir = Qnil;
6169 changed = 0;
6170 /* No need to protect ACTION--we only compare it with t and nil. */
6171 GCPRO5 (string, realdir, name, specdir, orig_string);
6172
6173 if (SCHARS (string) == 0)
6174 {
6175 if (EQ (action, Qlambda))
6176 {
6177 UNGCPRO;
6178 return Qnil;
6179 }
6180 }
6181 else
6182 {
6183 orig_string = string;
6184 string = Fsubstitute_in_file_name (string);
6185 changed = NILP (Fstring_equal (string, orig_string));
6186 name = Ffile_name_nondirectory (string);
6187 val = Ffile_name_directory (string);
6188 if (! NILP (val))
6189 realdir = Fexpand_file_name (val, realdir);
6190 }
6191
6192 if (NILP (action))
6193 {
6194 specdir = Ffile_name_directory (string);
6195 val = Ffile_name_completion (name, realdir);
6196 UNGCPRO;
6197 if (!STRINGP (val))
6198 {
6199 if (changed)
6200 return double_dollars (string);
6201 return val;
6202 }
6203
6204 if (!NILP (specdir))
6205 val = concat2 (specdir, val);
6206 #ifndef VMS
6207 return double_dollars (val);
6208 #else /* not VMS */
6209 return val;
6210 #endif /* not VMS */
6211 }
6212 UNGCPRO;
6213
6214 if (EQ (action, Qt))
6215 {
6216 Lisp_Object all = Ffile_name_all_completions (name, realdir);
6217 Lisp_Object comp;
6218 int count;
6219
6220 if (NILP (Vread_file_name_predicate)
6221 || EQ (Vread_file_name_predicate, Qfile_exists_p))
6222 return all;
6223
6224 #ifndef VMS
6225 if (EQ (Vread_file_name_predicate, Qfile_directory_p))
6226 {
6227 /* Brute-force speed up for directory checking:
6228 Discard strings which don't end in a slash. */
6229 for (comp = Qnil; CONSP (all); all = XCDR (all))
6230 {
6231 Lisp_Object tem = XCAR (all);
6232 int len;
6233 if (STRINGP (tem) &&
6234 (len = SCHARS (tem), len > 0) &&
6235 IS_DIRECTORY_SEP (SREF (tem, len-1)))
6236 comp = Fcons (tem, comp);
6237 }
6238 }
6239 else
6240 #endif
6241 {
6242 /* Must do it the hard (and slow) way. */
6243 Lisp_Object tem;
6244 GCPRO3 (all, comp, specdir);
6245 count = SPECPDL_INDEX ();
6246 record_unwind_protect (read_file_name_cleanup, current_buffer->directory);
6247 current_buffer->directory = realdir;
6248 for (comp = Qnil; CONSP (all); all = XCDR (all))
6249 {
6250 tem = call1 (Vread_file_name_predicate, XCAR (all));
6251 if (!NILP (tem))
6252 comp = Fcons (XCAR (all), comp);
6253 }
6254 unbind_to (count, Qnil);
6255 UNGCPRO;
6256 }
6257 return Fnreverse (comp);
6258 }
6259
6260 /* Only other case actually used is ACTION = lambda */
6261 #ifdef VMS
6262 /* Supposedly this helps commands such as `cd' that read directory names,
6263 but can someone explain how it helps them? -- RMS */
6264 if (SCHARS (name) == 0)
6265 return Qt;
6266 #endif /* VMS */
6267 string = Fexpand_file_name (string, dir);
6268 if (!NILP (Vread_file_name_predicate))
6269 return call1 (Vread_file_name_predicate, string);
6270 return Ffile_exists_p (string);
6271 }
6272
6273 DEFUN ("next-read-file-uses-dialog-p", Fnext_read_file_uses_dialog_p,
6274 Snext_read_file_uses_dialog_p, 0, 0, 0,
6275 doc: /* Return t if a call to `read-file-name' will use a dialog.
6276 The return value is only relevant for a call to `read-file-name' that happens
6277 before any other event (mouse or keypress) is handeled. */)
6278 ()
6279 {
6280 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6281 if ((NILP (last_nonmenu_event) || CONSP (last_nonmenu_event))
6282 && use_dialog_box
6283 && use_file_dialog
6284 && have_menus_p ())
6285 return Qt;
6286 #endif
6287 return Qnil;
6288 }
6289
6290 DEFUN ("read-file-name", Fread_file_name, Sread_file_name, 1, 6, 0,
6291 doc: /* Read file name, prompting with PROMPT and completing in directory DIR.
6292 Value is not expanded---you must call `expand-file-name' yourself.
6293 Default name to DEFAULT-FILENAME if user exits the minibuffer with
6294 the same non-empty string that was inserted by this function.
6295 (If DEFAULT-FILENAME is omitted, the visited file name is used,
6296 except that if INITIAL is specified, that combined with DIR is used.)
6297 If the user exits with an empty minibuffer, this function returns
6298 an empty string. (This can only happen if the user erased the
6299 pre-inserted contents or if `insert-default-directory' is nil.)
6300 Fourth arg MUSTMATCH non-nil means require existing file's name.
6301 Non-nil and non-t means also require confirmation after completion.
6302 Fifth arg INITIAL specifies text to start with.
6303 If optional sixth arg PREDICATE is non-nil, possible completions and
6304 the resulting file name must satisfy (funcall PREDICATE NAME).
6305 DIR should be an absolute directory name. It defaults to the value of
6306 `default-directory'.
6307
6308 If this command was invoked with the mouse, use a file dialog box if
6309 `use-dialog-box' is non-nil, and the window system or X toolkit in use
6310 provides a file dialog box.
6311
6312 See also `read-file-name-completion-ignore-case'
6313 and `read-file-name-function'. */)
6314 (prompt, dir, default_filename, mustmatch, initial, predicate)
6315 Lisp_Object prompt, dir, default_filename, mustmatch, initial, predicate;
6316 {
6317 Lisp_Object val, insdef, tem;
6318 struct gcpro gcpro1, gcpro2;
6319 register char *homedir;
6320 Lisp_Object decoded_homedir;
6321 int replace_in_history = 0;
6322 int add_to_history = 0;
6323 int count;
6324
6325 if (NILP (dir))
6326 dir = current_buffer->directory;
6327 if (NILP (Ffile_name_absolute_p (dir)))
6328 dir = Fexpand_file_name (dir, Qnil);
6329 if (NILP (default_filename))
6330 default_filename
6331 = (!NILP (initial)
6332 ? Fexpand_file_name (initial, dir)
6333 : current_buffer->filename);
6334
6335 /* If dir starts with user's homedir, change that to ~. */
6336 homedir = (char *) egetenv ("HOME");
6337 #ifdef DOS_NT
6338 /* homedir can be NULL in temacs, since Vprocess_environment is not
6339 yet set up. We shouldn't crash in that case. */
6340 if (homedir != 0)
6341 {
6342 homedir = strcpy (alloca (strlen (homedir) + 1), homedir);
6343 CORRECT_DIR_SEPS (homedir);
6344 }
6345 #endif
6346 if (homedir != 0)
6347 decoded_homedir
6348 = DECODE_FILE (make_unibyte_string (homedir, strlen (homedir)));
6349 if (homedir != 0
6350 && STRINGP (dir)
6351 && !strncmp (SDATA (decoded_homedir), SDATA (dir),
6352 SBYTES (decoded_homedir))
6353 && IS_DIRECTORY_SEP (SREF (dir, SBYTES (decoded_homedir))))
6354 {
6355 dir = Fsubstring (dir, make_number (SCHARS (decoded_homedir)), Qnil);
6356 dir = concat2 (build_string ("~"), dir);
6357 }
6358 /* Likewise for default_filename. */
6359 if (homedir != 0
6360 && STRINGP (default_filename)
6361 && !strncmp (SDATA (decoded_homedir), SDATA (default_filename),
6362 SBYTES (decoded_homedir))
6363 && IS_DIRECTORY_SEP (SREF (default_filename, SBYTES (decoded_homedir))))
6364 {
6365 default_filename
6366 = Fsubstring (default_filename,
6367 make_number (SCHARS (decoded_homedir)), Qnil);
6368 default_filename = concat2 (build_string ("~"), default_filename);
6369 }
6370 if (!NILP (default_filename))
6371 {
6372 CHECK_STRING (default_filename);
6373 default_filename = double_dollars (default_filename);
6374 }
6375
6376 if (insert_default_directory && STRINGP (dir))
6377 {
6378 insdef = dir;
6379 if (!NILP (initial))
6380 {
6381 Lisp_Object args[2], pos;
6382
6383 args[0] = insdef;
6384 args[1] = initial;
6385 insdef = Fconcat (2, args);
6386 pos = make_number (SCHARS (double_dollars (dir)));
6387 insdef = Fcons (double_dollars (insdef), pos);
6388 }
6389 else
6390 insdef = double_dollars (insdef);
6391 }
6392 else if (STRINGP (initial))
6393 insdef = Fcons (double_dollars (initial), make_number (0));
6394 else
6395 insdef = Qnil;
6396
6397 if (!NILP (Vread_file_name_function))
6398 {
6399 Lisp_Object args[7];
6400
6401 GCPRO2 (insdef, default_filename);
6402 args[0] = Vread_file_name_function;
6403 args[1] = prompt;
6404 args[2] = dir;
6405 args[3] = default_filename;
6406 args[4] = mustmatch;
6407 args[5] = initial;
6408 args[6] = predicate;
6409 RETURN_UNGCPRO (Ffuncall (7, args));
6410 }
6411
6412 count = SPECPDL_INDEX ();
6413 specbind (intern ("completion-ignore-case"),
6414 read_file_name_completion_ignore_case ? Qt : Qnil);
6415 specbind (intern ("minibuffer-completing-file-name"), Qt);
6416 specbind (intern ("read-file-name-predicate"),
6417 (NILP (predicate) ? Qfile_exists_p : predicate));
6418
6419 GCPRO2 (insdef, default_filename);
6420
6421 #if defined (USE_MOTIF) || defined (HAVE_NTGUI) || defined (USE_GTK) || defined (HAVE_CARBON)
6422 if (! NILP (Fnext_read_file_uses_dialog_p ()))
6423 {
6424 /* If DIR contains a file name, split it. */
6425 Lisp_Object file;
6426 file = Ffile_name_nondirectory (dir);
6427 if (SCHARS (file) && NILP (default_filename))
6428 {
6429 default_filename = file;
6430 dir = Ffile_name_directory (dir);
6431 }
6432 if (!NILP(default_filename))
6433 default_filename = Fexpand_file_name (default_filename, dir);
6434 val = Fx_file_dialog (prompt, dir, default_filename, mustmatch,
6435 EQ (predicate, Qfile_directory_p) ? Qt : Qnil);
6436 add_to_history = 1;
6437 }
6438 else
6439 #endif
6440 val = Fcompleting_read (prompt, intern ("read-file-name-internal"),
6441 dir, mustmatch, insdef,
6442 Qfile_name_history, default_filename, Qnil);
6443
6444 tem = Fsymbol_value (Qfile_name_history);
6445 if (CONSP (tem) && EQ (XCAR (tem), val))
6446 replace_in_history = 1;
6447
6448 /* If Fcompleting_read returned the inserted default string itself
6449 (rather than a new string with the same contents),
6450 it has to mean that the user typed RET with the minibuffer empty.
6451 In that case, we really want to return ""
6452 so that commands such as set-visited-file-name can distinguish. */
6453 if (EQ (val, default_filename))
6454 {
6455 /* In this case, Fcompleting_read has not added an element
6456 to the history. Maybe we should. */
6457 if (! replace_in_history)
6458 add_to_history = 1;
6459
6460 val = empty_string;
6461 }
6462
6463 unbind_to (count, Qnil);
6464 UNGCPRO;
6465 if (NILP (val))
6466 error ("No file name specified");
6467
6468 tem = Fstring_equal (val, CONSP (insdef) ? XCAR (insdef) : insdef);
6469
6470 if (!NILP (tem) && !NILP (default_filename))
6471 val = default_filename;
6472 val = Fsubstitute_in_file_name (val);
6473
6474 if (replace_in_history)
6475 /* Replace what Fcompleting_read added to the history
6476 with what we will actually return. */
6477 {
6478 Lisp_Object val1 = double_dollars (val);
6479 tem = Fsymbol_value (Qfile_name_history);
6480 if (history_delete_duplicates)
6481 XSETCDR (tem, Fdelete (val1, XCDR(tem)));
6482 XSETCAR (tem, val1);
6483 }
6484 else if (add_to_history)
6485 {
6486 /* Add the value to the history--but not if it matches
6487 the last value already there. */
6488 Lisp_Object val1 = double_dollars (val);
6489 tem = Fsymbol_value (Qfile_name_history);
6490 if (! CONSP (tem) || NILP (Fequal (XCAR (tem), val1)))
6491 {
6492 if (history_delete_duplicates) tem = Fdelete (val1, tem);
6493 Fset (Qfile_name_history, Fcons (val1, tem));
6494 }
6495 }
6496
6497 return val;
6498 }
6499
6500 \f
6501 void
6502 init_fileio_once ()
6503 {
6504 /* Must be set before any path manipulation is performed. */
6505 XSETFASTINT (Vdirectory_sep_char, '/');
6506 }
6507
6508 \f
6509 void
6510 syms_of_fileio ()
6511 {
6512 Qoperations = intern ("operations");
6513 Qexpand_file_name = intern ("expand-file-name");
6514 Qsubstitute_in_file_name = intern ("substitute-in-file-name");
6515 Qdirectory_file_name = intern ("directory-file-name");
6516 Qfile_name_directory = intern ("file-name-directory");
6517 Qfile_name_nondirectory = intern ("file-name-nondirectory");
6518 Qunhandled_file_name_directory = intern ("unhandled-file-name-directory");
6519 Qfile_name_as_directory = intern ("file-name-as-directory");
6520 Qcopy_file = intern ("copy-file");
6521 Qmake_directory_internal = intern ("make-directory-internal");
6522 Qmake_directory = intern ("make-directory");
6523 Qdelete_directory = intern ("delete-directory");
6524 Qdelete_file = intern ("delete-file");
6525 Qrename_file = intern ("rename-file");
6526 Qadd_name_to_file = intern ("add-name-to-file");
6527 Qmake_symbolic_link = intern ("make-symbolic-link");
6528 Qfile_exists_p = intern ("file-exists-p");
6529 Qfile_executable_p = intern ("file-executable-p");
6530 Qfile_readable_p = intern ("file-readable-p");
6531 Qfile_writable_p = intern ("file-writable-p");
6532 Qfile_symlink_p = intern ("file-symlink-p");
6533 Qaccess_file = intern ("access-file");
6534 Qfile_directory_p = intern ("file-directory-p");
6535 Qfile_regular_p = intern ("file-regular-p");
6536 Qfile_accessible_directory_p = intern ("file-accessible-directory-p");
6537 Qfile_modes = intern ("file-modes");
6538 Qset_file_modes = intern ("set-file-modes");
6539 Qset_file_times = intern ("set-file-times");
6540 Qfile_newer_than_file_p = intern ("file-newer-than-file-p");
6541 Qinsert_file_contents = intern ("insert-file-contents");
6542 Qwrite_region = intern ("write-region");
6543 Qverify_visited_file_modtime = intern ("verify-visited-file-modtime");
6544 Qset_visited_file_modtime = intern ("set-visited-file-modtime");
6545 Qauto_save_coding = intern ("auto-save-coding");
6546
6547 staticpro (&Qoperations);
6548 staticpro (&Qexpand_file_name);
6549 staticpro (&Qsubstitute_in_file_name);
6550 staticpro (&Qdirectory_file_name);
6551 staticpro (&Qfile_name_directory);
6552 staticpro (&Qfile_name_nondirectory);
6553 staticpro (&Qunhandled_file_name_directory);
6554 staticpro (&Qfile_name_as_directory);
6555 staticpro (&Qcopy_file);
6556 staticpro (&Qmake_directory_internal);
6557 staticpro (&Qmake_directory);
6558 staticpro (&Qdelete_directory);
6559 staticpro (&Qdelete_file);
6560 staticpro (&Qrename_file);
6561 staticpro (&Qadd_name_to_file);
6562 staticpro (&Qmake_symbolic_link);
6563 staticpro (&Qfile_exists_p);
6564 staticpro (&Qfile_executable_p);
6565 staticpro (&Qfile_readable_p);
6566 staticpro (&Qfile_writable_p);
6567 staticpro (&Qaccess_file);
6568 staticpro (&Qfile_symlink_p);
6569 staticpro (&Qfile_directory_p);
6570 staticpro (&Qfile_regular_p);
6571 staticpro (&Qfile_accessible_directory_p);
6572 staticpro (&Qfile_modes);
6573 staticpro (&Qset_file_modes);
6574 staticpro (&Qset_file_times);
6575 staticpro (&Qfile_newer_than_file_p);
6576 staticpro (&Qinsert_file_contents);
6577 staticpro (&Qwrite_region);
6578 staticpro (&Qverify_visited_file_modtime);
6579 staticpro (&Qset_visited_file_modtime);
6580 staticpro (&Qauto_save_coding);
6581
6582 Qfile_name_history = intern ("file-name-history");
6583 Fset (Qfile_name_history, Qnil);
6584 staticpro (&Qfile_name_history);
6585
6586 Qfile_error = intern ("file-error");
6587 staticpro (&Qfile_error);
6588 Qfile_already_exists = intern ("file-already-exists");
6589 staticpro (&Qfile_already_exists);
6590 Qfile_date_error = intern ("file-date-error");
6591 staticpro (&Qfile_date_error);
6592 Qexcl = intern ("excl");
6593 staticpro (&Qexcl);
6594
6595 #ifdef DOS_NT
6596 Qfind_buffer_file_type = intern ("find-buffer-file-type");
6597 staticpro (&Qfind_buffer_file_type);
6598 #endif /* DOS_NT */
6599
6600 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system,
6601 doc: /* *Coding system for encoding file names.
6602 If it is nil, `default-file-name-coding-system' (which see) is used. */);
6603 Vfile_name_coding_system = Qnil;
6604
6605 DEFVAR_LISP ("default-file-name-coding-system",
6606 &Vdefault_file_name_coding_system,
6607 doc: /* Default coding system for encoding file names.
6608 This variable is used only when `file-name-coding-system' is nil.
6609
6610 This variable is set/changed by the command `set-language-environment'.
6611 User should not set this variable manually,
6612 instead use `file-name-coding-system' to get a constant encoding
6613 of file names regardless of the current language environment. */);
6614 Vdefault_file_name_coding_system = Qnil;
6615
6616 Qformat_decode = intern ("format-decode");
6617 staticpro (&Qformat_decode);
6618 Qformat_annotate_function = intern ("format-annotate-function");
6619 staticpro (&Qformat_annotate_function);
6620 Qafter_insert_file_set_coding = intern ("after-insert-file-set-coding");
6621 staticpro (&Qafter_insert_file_set_coding);
6622
6623 Qcar_less_than_car = intern ("car-less-than-car");
6624 staticpro (&Qcar_less_than_car);
6625
6626 Fput (Qfile_error, Qerror_conditions,
6627 list2 (Qfile_error, Qerror));
6628 Fput (Qfile_error, Qerror_message,
6629 build_string ("File error"));
6630
6631 Fput (Qfile_already_exists, Qerror_conditions,
6632 list3 (Qfile_already_exists, Qfile_error, Qerror));
6633 Fput (Qfile_already_exists, Qerror_message,
6634 build_string ("File already exists"));
6635
6636 Fput (Qfile_date_error, Qerror_conditions,
6637 list3 (Qfile_date_error, Qfile_error, Qerror));
6638 Fput (Qfile_date_error, Qerror_message,
6639 build_string ("Cannot set file date"));
6640
6641 DEFVAR_LISP ("read-file-name-function", &Vread_file_name_function,
6642 doc: /* If this is non-nil, `read-file-name' does its work by calling this function. */);
6643 Vread_file_name_function = Qnil;
6644
6645 DEFVAR_LISP ("read-file-name-predicate", &Vread_file_name_predicate,
6646 doc: /* Current predicate used by `read-file-name-internal'. */);
6647 Vread_file_name_predicate = Qnil;
6648
6649 DEFVAR_BOOL ("read-file-name-completion-ignore-case", &read_file_name_completion_ignore_case,
6650 doc: /* *Non-nil means when reading a file name completion ignores case. */);
6651 #if defined VMS || defined DOS_NT || defined MAC_OS
6652 read_file_name_completion_ignore_case = 1;
6653 #else
6654 read_file_name_completion_ignore_case = 0;
6655 #endif
6656
6657 DEFVAR_BOOL ("insert-default-directory", &insert_default_directory,
6658 doc: /* *Non-nil means when reading a filename start with default dir in minibuffer.
6659 If the initial minibuffer contents are non-empty, you can usually
6660 request a default filename by typing RETURN without editing. For some
6661 commands, exiting with an empty minibuffer has a special meaning,
6662 such as making the current buffer visit no file in the case of
6663 `set-visited-file-name'.
6664 If this variable is non-nil, the minibuffer contents are always
6665 initially non-empty and typing RETURN without editing will fetch the
6666 default name, if one is provided. Note however that this default name
6667 is not necessarily the name originally inserted in the minibuffer, if
6668 that is just the default directory.
6669 If this variable is nil, the minibuffer often starts out empty. In
6670 that case you may have to explicitly fetch the next history element to
6671 request the default name. */);
6672 insert_default_directory = 1;
6673
6674 DEFVAR_BOOL ("vms-stmlf-recfm", &vms_stmlf_recfm,
6675 doc: /* *Non-nil means write new files with record format `stmlf'.
6676 nil means use format `var'. This variable is meaningful only on VMS. */);
6677 vms_stmlf_recfm = 0;
6678
6679 DEFVAR_LISP ("directory-sep-char", &Vdirectory_sep_char,
6680 doc: /* Directory separator character for built-in functions that return file names.
6681 The value is always ?/. Don't use this variable, just use `/'. */);
6682
6683 DEFVAR_LISP ("file-name-handler-alist", &Vfile_name_handler_alist,
6684 doc: /* *Alist of elements (REGEXP . HANDLER) for file names handled specially.
6685 If a file name matches REGEXP, then all I/O on that file is done by calling
6686 HANDLER.
6687
6688 The first argument given to HANDLER is the name of the I/O primitive
6689 to be handled; the remaining arguments are the arguments that were
6690 passed to that primitive. For example, if you do
6691 (file-exists-p FILENAME)
6692 and FILENAME is handled by HANDLER, then HANDLER is called like this:
6693 (funcall HANDLER 'file-exists-p FILENAME)
6694 The function `find-file-name-handler' checks this list for a handler
6695 for its argument. */);
6696 Vfile_name_handler_alist = Qnil;
6697
6698 DEFVAR_LISP ("set-auto-coding-function",
6699 &Vset_auto_coding_function,
6700 doc: /* If non-nil, a function to call to decide a coding system of file.
6701 Two arguments are passed to this function: the file name
6702 and the length of a file contents following the point.
6703 This function should return a coding system to decode the file contents.
6704 It should check the file name against `auto-coding-alist'.
6705 If no coding system is decided, it should check a coding system
6706 specified in the heading lines with the format:
6707 -*- ... coding: CODING-SYSTEM; ... -*-
6708 or local variable spec of the tailing lines with `coding:' tag. */);
6709 Vset_auto_coding_function = Qnil;
6710
6711 DEFVAR_LISP ("after-insert-file-functions", &Vafter_insert_file_functions,
6712 doc: /* A list of functions to be called at the end of `insert-file-contents'.
6713 Each is passed one argument, the number of characters inserted.
6714 It should return the new character count, and leave point the same.
6715 If `insert-file-contents' is intercepted by a handler from
6716 `file-name-handler-alist', that handler is responsible for calling the
6717 functions in `after-insert-file-functions' if appropriate. */);
6718 Vafter_insert_file_functions = Qnil;
6719
6720 DEFVAR_LISP ("write-region-annotate-functions", &Vwrite_region_annotate_functions,
6721 doc: /* A list of functions to be called at the start of `write-region'.
6722 Each is passed two arguments, START and END as for `write-region'.
6723 These are usually two numbers but not always; see the documentation
6724 for `write-region'. The function should return a list of pairs
6725 of the form (POSITION . STRING), consisting of strings to be effectively
6726 inserted at the specified positions of the file being written (1 means to
6727 insert before the first byte written). The POSITIONs must be sorted into
6728 increasing order. If there are several functions in the list, the several
6729 lists are merged destructively. Alternatively, the function can return
6730 with a different buffer current; in that case it should pay attention
6731 to the annotations returned by previous functions and listed in
6732 `write-region-annotations-so-far'.*/);
6733 Vwrite_region_annotate_functions = Qnil;
6734 staticpro (&Qwrite_region_annotate_functions);
6735 Qwrite_region_annotate_functions
6736 = intern ("write-region-annotate-functions");
6737
6738 DEFVAR_LISP ("write-region-annotations-so-far",
6739 &Vwrite_region_annotations_so_far,
6740 doc: /* When an annotation function is called, this holds the previous annotations.
6741 These are the annotations made by other annotation functions
6742 that were already called. See also `write-region-annotate-functions'. */);
6743 Vwrite_region_annotations_so_far = Qnil;
6744
6745 DEFVAR_LISP ("inhibit-file-name-handlers", &Vinhibit_file_name_handlers,
6746 doc: /* A list of file name handlers that temporarily should not be used.
6747 This applies only to the operation `inhibit-file-name-operation'. */);
6748 Vinhibit_file_name_handlers = Qnil;
6749
6750 DEFVAR_LISP ("inhibit-file-name-operation", &Vinhibit_file_name_operation,
6751 doc: /* The operation for which `inhibit-file-name-handlers' is applicable. */);
6752 Vinhibit_file_name_operation = Qnil;
6753
6754 DEFVAR_LISP ("auto-save-list-file-name", &Vauto_save_list_file_name,
6755 doc: /* File name in which we write a list of all auto save file names.
6756 This variable is initialized automatically from `auto-save-list-file-prefix'
6757 shortly after Emacs reads your `.emacs' file, if you have not yet given it
6758 a non-nil value. */);
6759 Vauto_save_list_file_name = Qnil;
6760
6761 #ifdef HAVE_FSYNC
6762 DEFVAR_BOOL ("write-region-inhibit-fsync", &write_region_inhibit_fsync,
6763 doc: /* *Non-nil means don't call fsync in `write-region'.
6764 This variable affects calls to `write-region' as well as save commands.
6765 A non-nil value may result in data loss! */);
6766 write_region_inhibit_fsync = 0;
6767 #endif
6768
6769 defsubr (&Sfind_file_name_handler);
6770 defsubr (&Sfile_name_directory);
6771 defsubr (&Sfile_name_nondirectory);
6772 defsubr (&Sunhandled_file_name_directory);
6773 defsubr (&Sfile_name_as_directory);
6774 defsubr (&Sdirectory_file_name);
6775 defsubr (&Smake_temp_name);
6776 defsubr (&Sexpand_file_name);
6777 defsubr (&Ssubstitute_in_file_name);
6778 defsubr (&Scopy_file);
6779 defsubr (&Smake_directory_internal);
6780 defsubr (&Sdelete_directory);
6781 defsubr (&Sdelete_file);
6782 defsubr (&Srename_file);
6783 defsubr (&Sadd_name_to_file);
6784 #ifdef S_IFLNK
6785 defsubr (&Smake_symbolic_link);
6786 #endif /* S_IFLNK */
6787 #ifdef VMS
6788 defsubr (&Sdefine_logical_name);
6789 #endif /* VMS */
6790 #ifdef HPUX_NET
6791 defsubr (&Ssysnetunam);
6792 #endif /* HPUX_NET */
6793 defsubr (&Sfile_name_absolute_p);
6794 defsubr (&Sfile_exists_p);
6795 defsubr (&Sfile_executable_p);
6796 defsubr (&Sfile_readable_p);
6797 defsubr (&Sfile_writable_p);
6798 defsubr (&Saccess_file);
6799 defsubr (&Sfile_symlink_p);
6800 defsubr (&Sfile_directory_p);
6801 defsubr (&Sfile_accessible_directory_p);
6802 defsubr (&Sfile_regular_p);
6803 defsubr (&Sfile_modes);
6804 defsubr (&Sset_file_modes);
6805 defsubr (&Sset_file_times);
6806 defsubr (&Sset_default_file_modes);
6807 defsubr (&Sdefault_file_modes);
6808 defsubr (&Sfile_newer_than_file_p);
6809 defsubr (&Sinsert_file_contents);
6810 defsubr (&Swrite_region);
6811 defsubr (&Scar_less_than_car);
6812 defsubr (&Sverify_visited_file_modtime);
6813 defsubr (&Sclear_visited_file_modtime);
6814 defsubr (&Svisited_file_modtime);
6815 defsubr (&Sset_visited_file_modtime);
6816 defsubr (&Sdo_auto_save);
6817 defsubr (&Sset_buffer_auto_saved);
6818 defsubr (&Sclear_buffer_auto_save_failure);
6819 defsubr (&Srecent_auto_save_p);
6820
6821 defsubr (&Sread_file_name_internal);
6822 defsubr (&Sread_file_name);
6823 defsubr (&Snext_read_file_uses_dialog_p);
6824
6825 #ifdef unix
6826 defsubr (&Sunix_sync);
6827 #endif
6828 }
6829
6830 /* arch-tag: 64ba3fd7-f844-4fb2-ba4b-427eb928786c
6831 (do not change this comment) */