fileio.c 195 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* File IO for GNU Emacs.
2
   Copyright (C) 1985,86,87,88,93,94,95,96,97,98,99,2000,01,03,2004
3
     Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21

22
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
23

24
#ifdef HAVE_FCNTL_H
25 26 27
#include <fcntl.h>
#endif

28
#include <stdio.h>
Jim Blandy's avatar
Jim Blandy committed
29 30
#include <sys/types.h>
#include <sys/stat.h>
Jim Blandy's avatar
Jim Blandy committed
31

32 33 34 35
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

36 37 38 39
#if !defined (S_ISLNK) && defined (S_IFLNK)
#  define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
#endif

40 41 42 43
#if !defined (S_ISFIFO) && defined (S_IFIFO)
#  define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
#endif

44 45 46 47
#if !defined (S_ISREG) && defined (S_IFREG)
#  define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
#endif

Jim Blandy's avatar
Jim Blandy committed
48
#ifdef VMS
Jim Blandy's avatar
Jim Blandy committed
49
#include "vms-pwd.h"
Jim Blandy's avatar
Jim Blandy committed
50
#else
Jim Blandy's avatar
Jim Blandy committed
51
#include <pwd.h>
Jim Blandy's avatar
Jim Blandy committed
52 53
#endif

Jim Blandy's avatar
Jim Blandy committed
54
#include <ctype.h>
Jim Blandy's avatar
Jim Blandy committed
55 56

#ifdef VMS
Richard M. Stallman's avatar
Richard M. Stallman committed
57
#include "vmsdir.h"
Jim Blandy's avatar
Jim Blandy committed
58 59 60 61 62
#include <perror.h>
#include <stddef.h>
#include <string.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
63 64
#include <errno.h>

Jim Blandy's avatar
Jim Blandy committed
65
#ifndef vax11c
66
#ifndef USE_CRT_DLL
Jim Blandy's avatar
Jim Blandy committed
67 68
extern int errno;
#endif
69
#endif
Jim Blandy's avatar
Jim Blandy committed
70 71 72 73 74 75

#ifdef APOLLO
#include <sys/time.h>
#endif

#include "lisp.h"
76
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
77
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
78 79
#include "charset.h"
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
80 81
#include "window.h"

82 83 84 85 86 87 88
#ifdef WINDOWSNT
#define NOMINMAX 1
#include <windows.h>
#include <stdlib.h>
#include <fcntl.h>
#endif /* not WINDOWSNT */

Eli Zaretskii's avatar
Eli Zaretskii committed
89 90 91 92 93 94 95 96 97
#ifdef MSDOS
#include "msdos.h"
#include <sys/param.h>
#if __DJGPP__ >= 2
#include <fcntl.h>
#include <string.h>
#endif
#endif

98 99 100 101 102 103 104 105 106 107 108 109 110
#ifdef DOS_NT
#define CORRECT_DIR_SEPS(s) \
  do { if ('/' == DIRECTORY_SEP) dostounix_filename (s); \
       else unixtodos_filename (s); \
  } while (0)
/* On Windows, drive letters must be alphabetic - on DOS, the Netware
   redirector allows the six letters between 'Z' and 'a' as well. */
#ifdef MSDOS
#define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
#endif
#ifdef WINDOWSNT
#define IS_DRIVE(x) isalpha (x)
#endif
111 112 113 114
/* Need to lower-case the drive letter, or else expanded
   filenames will sometimes compare inequal, because
   `expand-file-name' doesn't always down-case the drive letter.  */
#define DRIVE_LETTER(x) (tolower (x))
115 116
#endif

Jim Blandy's avatar
Jim Blandy committed
117 118 119 120 121 122 123
#ifdef VMS
#include <file.h>
#include <rmsdef.h>
#include <fab.h>
#include <nam.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
124
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
125 126 127

#ifdef HPUX
#include <netio.h>
Jim Blandy's avatar
Jim Blandy committed
128
#ifndef HPUX8
129
#ifndef HPUX9
Jim Blandy's avatar
Jim Blandy committed
130 131
#include <errnet.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
132
#endif
133
#endif
Jim Blandy's avatar
Jim Blandy committed
134

135 136
#include "commands.h"
extern int use_dialog_box;
137
extern int use_file_dialog;
138

Jim Blandy's avatar
Jim Blandy committed
139 140 141 142
#ifndef O_WRONLY
#define O_WRONLY 1
#endif

Richard M. Stallman's avatar
Richard M. Stallman committed
143 144 145 146
#ifndef O_RDONLY
#define O_RDONLY 0
#endif

147 148 149 150
#ifndef S_ISLNK
#  define lstat stat
#endif

Jim Blandy's avatar
Jim Blandy committed
151 152 153 154 155 156 157
/* Nonzero during writing of auto-save files */
int auto_saving;

/* Set by auto_save_1 to mode of original file so Fwrite_region will create
   a new file with the same mode as the original */
int auto_save_mode_bits;

158 159 160 161 162 163 164
/* The symbol bound to coding-system-for-read when
   insert-file-contents is called for recovering a file.  This is not
   an actual coding system name, but just an indicator to tell
   insert-file-contents to use `emacs-mule' with a special flag for
   auto saving and recovering a file.  */
Lisp_Object Qauto_save_coding;

165 166 167
/* Coding system for file names, or nil if none.  */
Lisp_Object Vfile_name_coding_system;

168 169 170 171
/* Coding system for file names used only when
   Vfile_name_coding_system is nil.  */
Lisp_Object Vdefault_file_name_coding_system;

172
/* Alist of elements (REGEXP . HANDLER) for file names
173 174 175
   whose I/O is done with a special handler.  */
Lisp_Object Vfile_name_handler_alist;

176 177 178 179 180 181
/* Format for auto-save files */
Lisp_Object Vauto_save_file_format;

/* Lisp functions for translating file formats */
Lisp_Object Qformat_decode, Qformat_annotate_function;

182
/* Function to be called to decide a coding system of a reading file.  */
183
Lisp_Object Vset_auto_coding_function;
184

185 186 187
/* Functions to be called to process text properties in inserted file.  */
Lisp_Object Vafter_insert_file_functions;

188
/* Lisp function for setting buffer-file-coding-system and the
189
   multibyteness of the current buffer after inserting a file.  */
190
Lisp_Object Qafter_insert_file_set_coding;
191

192 193
/* Functions to be called to create text property annotations for file.  */
Lisp_Object Vwrite_region_annotate_functions;
194
Lisp_Object Qwrite_region_annotate_functions;
195

196 197 198 199
/* During build_annotations, each time an annotation function is called,
   this holds the annotations made by the previous functions.  */
Lisp_Object Vwrite_region_annotations_so_far;

200 201 202
/* File name in which we write a list of all our auto save files.  */
Lisp_Object Vauto_save_list_file_name;

203
/* Function to call to read a file name.  */
204
Lisp_Object Vread_file_name_function;
205 206 207 208

/* Current predicate used by read_file_name_internal.  */
Lisp_Object Vread_file_name_predicate;

209 210 211
/* Nonzero means completion ignores case when reading file name.  */
int read_file_name_completion_ignore_case;

Jim Blandy's avatar
Jim Blandy committed
212 213 214 215 216 217 218 219
/* Nonzero means, when reading a filename in the minibuffer,
 start out by inserting the default directory into the minibuffer. */
int insert_default_directory;

/* On VMS, nonzero means write new files with record format stmlf.
   Zero means use var format.  */
int vms_stmlf_recfm;

220 221 222 223
/* On NT, specifies the directory separator character, used (eg.) when
   expanding file names.  This can be bound to / or \. */
Lisp_Object Vdirectory_sep_char;

224 225
extern Lisp_Object Vuser_login_name;

226 227 228 229
#ifdef WINDOWSNT
extern Lisp_Object Vw32_get_true_file_attributes;
#endif

230 231
extern int minibuf_level;

232 233
extern int minibuffer_auto_raise;

234 235 236 237 238 239 240
/* These variables describe handlers that have "already" had a chance
   to handle the current operation.

   Vinhibit_file_name_handlers is a list of file name handlers.
   Vinhibit_file_name_operation is the operation being handled.
   If we try to handle that operation, we ignore those handlers.  */

241
static Lisp_Object Vinhibit_file_name_handlers;
242
static Lisp_Object Vinhibit_file_name_operation;
243

244
Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
245
Lisp_Object Qexcl;
246 247
Lisp_Object Qfile_name_history;

248 249
Lisp_Object Qcar_less_than_car;

250
static int a_write P_ ((int, Lisp_Object, int, int,
251
			Lisp_Object *, struct coding_system *));
252 253
static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));

254

255
void
Jim Blandy's avatar
Jim Blandy committed
256
report_file_error (string, data)
257
     const char *string;
Jim Blandy's avatar
Jim Blandy committed
258 259 260
     Lisp_Object data;
{
  Lisp_Object errstring;
Richard M. Stallman's avatar
Richard M. Stallman committed
261
  int errorno = errno;
Jim Blandy's avatar
Jim Blandy committed
262

263
  synchronize_system_messages_locale ();
264 265 266
  errstring = code_convert_string_norecord (build_string (strerror (errorno)),
					    Vlocale_coding_system, 0);

Jim Blandy's avatar
Jim Blandy committed
267
  while (1)
Richard M. Stallman's avatar
Richard M. Stallman committed
268 269 270 271 272 273 274 275
    switch (errorno)
      {
      case EEXIST:
	Fsignal (Qfile_already_exists, Fcons (errstring, data));
	break;
      default:
	/* System error messages are capitalized.  Downcase the initial
	   unless it is followed by a slash.  */
276
	if (SREF (errstring, 1) != '/')
277
	  SSET (errstring, 0, DOWNCASE (SREF (errstring, 0)));
Richard M. Stallman's avatar
Richard M. Stallman committed
278 279 280 281

	Fsignal (Qfile_error,
		 Fcons (build_string (string), Fcons (errstring, data)));
      }
Jim Blandy's avatar
Jim Blandy committed
282
}
283

284
Lisp_Object
285 286 287
close_file_unwind (fd)
     Lisp_Object fd;
{
288
  emacs_close (XFASTINT (fd));
289
  return Qnil;
290
}
291 292 293

/* Restore point, having saved it as a marker.  */

294
static Lisp_Object
295
restore_point_unwind (location)
296
     Lisp_Object location;
297
{
298
  Fgoto_char (location);
299
  Fset_marker (location, Qnil, Qnil);
300
  return Qnil;
301
}
Jim Blandy's avatar
Jim Blandy committed
302

303
Lisp_Object Qexpand_file_name;
304
Lisp_Object Qsubstitute_in_file_name;
305 306 307
Lisp_Object Qdirectory_file_name;
Lisp_Object Qfile_name_directory;
Lisp_Object Qfile_name_nondirectory;
308
Lisp_Object Qunhandled_file_name_directory;
309
Lisp_Object Qfile_name_as_directory;
310
Lisp_Object Qcopy_file;
311
Lisp_Object Qmake_directory_internal;
312
Lisp_Object Qmake_directory;
313 314 315 316 317 318 319 320 321
Lisp_Object Qdelete_directory;
Lisp_Object Qdelete_file;
Lisp_Object Qrename_file;
Lisp_Object Qadd_name_to_file;
Lisp_Object Qmake_symbolic_link;
Lisp_Object Qfile_exists_p;
Lisp_Object Qfile_executable_p;
Lisp_Object Qfile_readable_p;
Lisp_Object Qfile_writable_p;
322 323
Lisp_Object Qfile_symlink_p;
Lisp_Object Qaccess_file;
324
Lisp_Object Qfile_directory_p;
325
Lisp_Object Qfile_regular_p;
326 327 328
Lisp_Object Qfile_accessible_directory_p;
Lisp_Object Qfile_modes;
Lisp_Object Qset_file_modes;
329
Lisp_Object Qset_file_times;
330 331 332 333
Lisp_Object Qfile_newer_than_file_p;
Lisp_Object Qinsert_file_contents;
Lisp_Object Qwrite_region;
Lisp_Object Qverify_visited_file_modtime;
334
Lisp_Object Qset_visited_file_modtime;
335

336
DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
337 338 339 340 341 342 343 344 345 346 347
       doc: /* Return FILENAME's handler function for OPERATION, if it has one.
Otherwise, return nil.
A file name is handled if one of the regular expressions in
`file-name-handler-alist' matches it.

If OPERATION equals `inhibit-file-name-operation', then we ignore
any handlers that are members of `inhibit-file-name-handlers',
but we still do run any other handlers.  This lets handlers
use the standard functions without calling themselves recursively.  */)
     (filename, operation)
     Lisp_Object filename, operation;
348
{
349
  /* This function must not munge the match data.  */
350
  Lisp_Object chain, inhibited_handlers, result;
351
  int pos = -1;
352

353
  result = Qnil;
354
  CHECK_STRING (filename);
355

356 357 358 359
  if (EQ (operation, Vinhibit_file_name_operation))
    inhibited_handlers = Vinhibit_file_name_handlers;
  else
    inhibited_handlers = Qnil;
360

361
  for (chain = Vfile_name_handler_alist; CONSP (chain);
362
       chain = XCDR (chain))
363 364
    {
      Lisp_Object elt;
365
      elt = XCAR (chain);
366
      if (CONSP (elt))
367 368
	{
	  Lisp_Object string;
369
	  int match_pos;
370
	  string = XCAR (elt);
371 372
	  if (STRINGP (string)
	      && (match_pos = fast_string_match (string, filename)) > pos)
373 374 375
	    {
	      Lisp_Object handler, tem;

376
	      handler = XCDR (elt);
377 378
	      tem = Fmemq (handler, inhibited_handlers);
	      if (NILP (tem))
379 380 381 382
		{
		  result = handler;
		  pos = match_pos;
		}
383
	    }
384
	}
385 386

      QUIT;
387
    }
388
  return result;
389 390
}

Jim Blandy's avatar
Jim Blandy committed
391
DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
392 393 394 395 396 397 398
       1, 1, 0,
       doc: /* Return the directory component in file name FILENAME.
Return nil if FILENAME does not include a directory.
Otherwise return a directory spec.
Given a Unix syntax file name, returns a string ending in slash;
on VMS, perhaps instead a string ending in `:', `]' or `>'.  */)
     (filename)
399
     Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
400
{
401
#ifndef DOS_NT
402
  register const unsigned char *beg;
403 404 405
#else
  register unsigned char *beg;
#endif
406
  register const unsigned char *p;
407
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
408

409
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
410

411 412
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
413
  handler = Ffind_file_name_handler (filename, Qfile_name_directory);
414
  if (!NILP (handler))
415
    return call2 (handler, Qfile_name_directory, filename);
416

417
#ifdef FILE_SYSTEM_CASE
418
  filename = FILE_SYSTEM_CASE (filename);
419
#endif
420
  beg = SDATA (filename);
421 422 423
#ifdef DOS_NT
  beg = strcpy (alloca (strlen (beg) + 1), beg);
#endif
424
  p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
425

426
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
Jim Blandy's avatar
Jim Blandy committed
427 428 429
#ifdef VMS
	 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
#endif /* VMS */
430
#ifdef DOS_NT
431 432 433 434 435
	 /* only recognise drive specifier at the beginning */
	 && !(p[-1] == ':'
	      /* handle the "/:d:foo" and "/:foo" cases correctly  */
	      && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
		  || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
436
#endif
Jim Blandy's avatar
Jim Blandy committed
437 438 439 440
	 ) p--;

  if (p == beg)
    return Qnil;
441
#ifdef DOS_NT
442
  /* Expansion of "c:" to drive and default directory.  */
443
  if (p[-1] == ':')
444 445
    {
      /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir.  */
446
      unsigned char *res = alloca (MAXPATHLEN + 1);
447 448 449 450 451 452 453 454 455 456
      unsigned char *r = res;

      if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
	{
	  strncpy (res, beg, 2);
	  beg += 2;
	  r += 2;
	}

      if (getdefdir (toupper (*beg) - 'A' + 1, r))
457
	{
458
	  if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
459 460 461 462 463
	    strcat (res, "/");
	  beg = res;
	  p = beg + strlen (beg);
	}
    }
464
  CORRECT_DIR_SEPS (beg);
465
#endif /* DOS_NT */
466

467
  return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
468 469
}

470 471
DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
       Sfile_name_nondirectory, 1, 1, 0,
472 473 474 475 476
       doc: /* Return file name FILENAME sans its directory.
For example, in a Unix-syntax file name,
this is everything after the last slash,
or the entire name if it contains no slash.  */)
     (filename)
477
     Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
478
{
479
  register const unsigned char *beg, *p, *end;
480
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
481

482
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
483

484 485
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
486
  handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
487
  if (!NILP (handler))
488
    return call2 (handler, Qfile_name_nondirectory, filename);
489

490 491
  beg = SDATA (filename);
  end = p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
492

493
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
Jim Blandy's avatar
Jim Blandy committed
494 495 496
#ifdef VMS
	 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
#endif /* VMS */
497 498
#ifdef DOS_NT
	 /* only recognise drive specifier at beginning */
499 500 501
	 && !(p[-1] == ':'
	      /* handle the "/:d:foo" case correctly  */
	      && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
502
#endif
503 504
	 )
    p--;
Jim Blandy's avatar
Jim Blandy committed
505

506
  return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
507
}
508

509 510
DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
       Sunhandled_file_name_directory, 1, 1, 0,
511 512 513 514 515 516 517 518 519
       doc: /* Return a directly usable directory name somehow associated with FILENAME.
A `directly usable' directory name is one that may be used without the
intervention of any file handler.
If FILENAME is a directly usable file itself, return
\(file-name-directory FILENAME).
The `call-process' and `start-process' functions use this function to
get a current directory to run processes in.  */)
     (filename)
     Lisp_Object filename;
520 521 522 523 524
{
  Lisp_Object handler;

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
525
  handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
526 527 528 529 530 531
  if (!NILP (handler))
    return call2 (handler, Qunhandled_file_name_directory, filename);

  return Ffile_name_directory (filename);
}

Jim Blandy's avatar
Jim Blandy committed
532 533 534 535 536 537 538 539 540

char *
file_name_as_directory (out, in)
     char *out, *in;
{
  int size = strlen (in) - 1;

  strcpy (out, in);

541 542
  if (size < 0)
    {
543 544 545
      out[0] = '.';
      out[1] = '/';
      out[2] = 0;
546 547 548
      return out;
    }

Jim Blandy's avatar
Jim Blandy committed
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
#ifdef VMS
  /* Is it already a directory string? */
  if (in[size] == ':' || in[size] == ']' || in[size] == '>')
    return out;
  /* Is it a VMS directory file name?  If so, hack VMS syntax.  */
  else if (! index (in, '/')
	   && ((size > 3 && ! strcmp (&in[size - 3], ".DIR"))
	       || (size > 3 && ! strcmp (&in[size - 3], ".dir"))
	       || (size > 5 && (! strncmp (&in[size - 5], ".DIR", 4)
				|| ! strncmp (&in[size - 5], ".dir", 4))
		   && (in[size - 1] == '.' || in[size - 1] == ';')
		   && in[size] == '1')))
    {
      register char *p, *dot;
      char brack;

      /* x.dir -> [.x]
	 dir:x.dir --> dir:[x]
	 dir:[x]y.dir --> dir:[x.y] */
      p = in + size;
      while (p != in && *p != ':' && *p != '>' && *p != ']') p--;
      if (p != in)
	{
	  strncpy (out, in, p - in);
	  out[p - in] = '\0';
	  if (*p == ':')
	    {
	      brack = ']';
	      strcat (out, ":[");
	    }
	  else
	    {
	      brack = *p;
	      strcat (out, ".");
	    }
	  p++;
	}
      else
	{
	  brack = ']';
	  strcpy (out, "[.");
	}
Jim Blandy's avatar
Jim Blandy committed
591 592
      dot = index (p, '.');
      if (dot)
Jim Blandy's avatar
Jim Blandy committed
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
	{
	  /* blindly remove any extension */
	  size = strlen (out) + (dot - p);
	  strncat (out, p, dot - p);
	}
      else
	{
	  strcat (out, p);
	  size = strlen (out);
	}
      out[size++] = brack;
      out[size] = '\0';
    }
#else /* not VMS */
  /* For Unix syntax, Append a slash if necessary */
608
  if (!IS_DIRECTORY_SEP (out[size]))
609
    {
610 611
      /* Cannot use DIRECTORY_SEP, which could have any value */
      out[size + 1] = '/';
612 613
      out[size + 2] = '\0';
    }
614 615 616
#ifdef DOS_NT
  CORRECT_DIR_SEPS (out);
#endif
Jim Blandy's avatar
Jim Blandy committed
617 618 619 620 621 622
#endif /* not VMS */
  return out;
}

DEFUN ("file-name-as-directory", Ffile_name_as_directory,
       Sfile_name_as_directory, 1, 1, 0,
623
       doc: /* Return a string representing the file name FILE interpreted as a directory.
624 625 626 627 628 629 630
This operation exists because a directory is also a file, but its name as
a directory is different from its name as a file.
The result can be used as the value of `default-directory'
or passed as second argument to `expand-file-name'.
For a Unix-syntax file name, just appends a slash.
On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc.  */)
     (file)
Jim Blandy's avatar
Jim Blandy committed
631 632 633
     Lisp_Object file;
{
  char *buf;
634
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
635

636
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
637
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
638
    return Qnil;
639 640 641

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
642
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
643 644 645
  if (!NILP (handler))
    return call2 (handler, Qfile_name_as_directory, file);

646
  buf = (char *) alloca (SBYTES (file) + 10);
647 648 649
  file_name_as_directory (buf, SDATA (file));
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (file));
Jim Blandy's avatar
Jim Blandy committed
650 651 652 653 654 655 656
}

/*
 * Convert from directory name to filename.
 * On VMS:
 *       xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
 *       xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
657
 * On UNIX, it's simple: just make sure there isn't a terminating /
Jim Blandy's avatar
Jim Blandy committed
658 659 660 661

 * Value is nonzero if the string output is different from the input.
 */

Andreas Schwab's avatar
Andreas Schwab committed
662
int
Jim Blandy's avatar
Jim Blandy committed
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
directory_file_name (src, dst)
     char *src, *dst;
{
  long slen;
#ifdef VMS
  long rlen;
  char * ptr, * rptr;
  char bracket;
  struct FAB fab = cc$rms_fab;
  struct NAM nam = cc$rms_nam;
  char esa[NAM$C_MAXRSS];
#endif /* VMS */

  slen = strlen (src);
#ifdef VMS
  if (! index (src, '/')
      && (src[slen - 1] == ']'
	  || src[slen - 1] == ':'
	  || src[slen - 1] == '>'))
    {
      /* VMS style - convert [x.y.z] to [x.y]z, [x] to [000000]x */
      fab.fab$l_fna = src;
      fab.fab$b_fns = slen;
      fab.fab$l_nam = &nam;
      fab.fab$l_fop = FAB$M_NAM;

      nam.nam$l_esa = esa;
      nam.nam$b_ess = sizeof esa;
      nam.nam$b_nop |= NAM$M_SYNCHK;

      /* We call SYS$PARSE to handle such things as [--] for us. */
694
      if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
Jim Blandy's avatar
Jim Blandy committed
695 696 697 698 699 700 701 702 703 704 705
	{
	  slen = nam.nam$b_esl;
	  if (esa[slen - 1] == ';' && esa[slen - 2] == '.')
	    slen -= 2;
	  esa[slen] = '\0';
	  src = esa;
	}
      if (src[slen - 1] != ']' && src[slen - 1] != '>')
	{
	  /* what about when we have logical_name:???? */
	  if (src[slen - 1] == ':')
706
	    {                   /* Xlate logical name and see what we get */
Jim Blandy's avatar
Jim Blandy committed
707 708 709 710 711 712 713
	      ptr = strcpy (dst, src); /* upper case for getenv */
	      while (*ptr)
		{
		  if ('a' <= *ptr && *ptr <= 'z')
		    *ptr -= 040;
		  ptr++;
		}
714
	      dst[slen - 1] = 0;        /* remove colon */
Jim Blandy's avatar
Jim Blandy committed
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
	      if (!(src = egetenv (dst)))
		return 0;
	      /* should we jump to the beginning of this procedure?
		 Good points: allows us to use logical names that xlate
		 to Unix names,
		 Bad points: can be a problem if we just translated to a device
		 name...
		 For now, I'll punt and always expect VMS names, and hope for
		 the best! */
	      slen = strlen (src);
	      if (src[slen - 1] != ']' && src[slen - 1] != '>')
		{ /* no recursion here! */
		  strcpy (dst, src);
		  return 0;
		}
	    }
	  else
732
	    {           /* not a directory spec */
Jim Blandy's avatar
Jim Blandy committed
733 734 735 736 737 738 739 740
	      strcpy (dst, src);
	      return 0;
	    }
	}
      bracket = src[slen - 1];

      /* If bracket is ']' or '>', bracket - 2 is the corresponding
	 opening bracket.  */
Jim Blandy's avatar
Jim Blandy committed
741 742
      ptr = index (src, bracket - 2);
      if (ptr == 0)
Jim Blandy's avatar
Jim Blandy committed
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
	{ /* no opening bracket */
	  strcpy (dst, src);
	  return 0;
	}
      if (!(rptr = rindex (src, '.')))
	rptr = ptr;
      slen = rptr - src;
      strncpy (dst, src, slen);
      dst[slen] = '\0';
      if (*rptr == '.')
	{
	  dst[slen++] = bracket;
	  dst[slen] = '\0';
	}
      else
	{
	  /* If we have the top-level of a rooted directory (i.e. xx:[000000]),
	     then translate the device and recurse. */
	  if (dst[slen - 1] == ':'
762
	      && dst[slen - 2] != ':'   /* skip decnet nodes */
763
	      && strcmp (src + slen, "[000000]") == 0)
Jim Blandy's avatar
Jim Blandy committed
764 765 766 767 768 769 770
	    {
	      dst[slen - 1] = '\0';
	      if ((ptr = egetenv (dst))
		  && (rlen = strlen (ptr) - 1) > 0
		  && (ptr[rlen] == ']' || ptr[rlen] == '>')
		  && ptr[rlen - 1] == '.')
		{
771 772 773 774 775
		  char * buf = (char *) alloca (strlen (ptr) + 1);
		  strcpy (buf, ptr);
		  buf[rlen - 1] = ']';
		  buf[rlen] = '\0';
		  return directory_file_name (buf, dst);
Jim Blandy's avatar
Jim Blandy committed
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
		}
	      else
		dst[slen - 1] = ':';
	    }
	  strcat (dst, "[000000]");
	  slen += 8;
	}
      rptr++;
      rlen = strlen (rptr) - 1;
      strncat (dst, rptr, rlen);
      dst[slen + rlen] = '\0';
      strcat (dst, ".DIR.1");
      return 1;
    }
#endif /* VMS */
  /* Process as Unix format: just remove any final slash.
     But leave "/" unchanged; do not change it to "".  */
  strcpy (dst, src);
794 795 796 797 798 799
#ifdef APOLLO
  /* Handle // as root for apollo's.  */
  if ((slen > 2 && dst[slen - 1] == '/')
      || (slen > 1 && dst[0] != '/' && dst[slen - 1] == '/'))
    dst[slen - 1] = 0;
#else
800
  if (slen > 1
801
      && IS_DIRECTORY_SEP (dst[slen - 1])
802 803 804 805
#ifdef DOS_NT
      && !IS_ANY_SEP (dst[slen - 2])
#endif
      )
Jim Blandy's avatar
Jim Blandy committed
806
    dst[slen - 1] = 0;
807 808 809
#endif
#ifdef DOS_NT
  CORRECT_DIR_SEPS (dst);
810
#endif
Jim Blandy's avatar
Jim Blandy committed
811 812 813 814
  return 1;
}

DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
815 816 817 818 819 820 821 822 823
       1, 1, 0,
       doc: /* Returns the file name of the directory named DIRECTORY.
This is the name of the file that holds the data for the directory DIRECTORY.
This operation exists because a directory is also a file, but its name as
a directory is different from its name as a file.
In Unix-syntax, this function just removes the final slash.
On VMS, given a VMS-syntax directory name such as \"[X.Y]\",
it returns a file name such as \"[X]Y.DIR.1\".  */)
     (directory)
Jim Blandy's avatar
Jim Blandy committed
824 825 826
     Lisp_Object directory;
{
  char *buf;
827
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
828

829
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
830

Jim Blandy's avatar
Jim Blandy committed
831
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
832
    return Qnil;
833 834 835

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
836
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
837 838 839
  if (!NILP (handler))
    return call2 (handler, Qdirectory_file_name, directory);

Jim Blandy's avatar
Jim Blandy committed
840 841 842 843
#ifdef VMS
  /* 20 extra chars is insufficient for VMS, since we might perform a
     logical name translation. an equivalence string can be up to 255
     chars long, so grab that much extra space...  - sss */
844
  buf = (char *) alloca (SBYTES (directory) + 20 + 255);
Jim Blandy's avatar
Jim Blandy committed
845
#else
846
  buf = (char *) alloca (SBYTES (directory) + 20);
Jim Blandy's avatar
Jim Blandy committed
847
#endif
848
  directory_file_name (SDATA (directory), buf);
849 850
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (directory));
Jim Blandy's avatar
Jim Blandy committed
851 852
}

853 854 855 856 857 858 859 860 861 862 863
static char make_temp_name_tbl[64] =
{
  'A','B','C','D','E','F','G','H',
  'I','J','K','L','M','N','O','P',
  'Q','R','S','T','U','V','W','X',
  'Y','Z','a','b','c','d','e','f',
  'g','h','i','j','k','l','m','n',
  'o','p','q','r','s','t','u','v',
  'w','x','y','z','0','1','2','3',
  '4','5','6','7','8','9','-','_'
};
864

865 866
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

867
/* Value is a temporary file name starting with PREFIX, a string.
868

869 870 871 872 873
   The Emacs process number forms part of the result, so there is
   no danger of generating a name being used by another process.
   In addition, this function makes an attempt to choose a name
   which has no existing file.  To make this work, PREFIX should be
   an absolute file name.
874

875 876 877 878 879 880 881 882 883 884
   BASE64_P non-zero means add the pid as 3 characters in base64
   encoding.  In this case, 6 characters will be added to PREFIX to
   form the file name.  Otherwise, if Emacs is running on a system
   with long file names, add the pid as a decimal number.

   This function signals an error if no unique file name could be
   generated.  */

Lisp_Object
make_temp_name (prefix, base64_p)
Jim Blandy's avatar
Jim Blandy committed
885
     Lisp_Object prefix;
886
     int base64_p;
Jim Blandy's avatar
Jim Blandy committed
887 888
{
  Lisp_Object val;
889 890 891 892 893
  int len;
  int pid;
  unsigned char *p, *data;
  char pidbuf[20];
  int pidlen;
894

895
  CHECK_STRING (prefix);
896 897 898 899 900 901 902 903

  /* VAL is created by adding 6 characters to PREFIX.  The first
     three are the PID of this process, in base 64, and the second
     three are incremented if the file already exists.  This ensures
     262144 unique file names per PID per PREFIX.  */

  pid = (int) getpid ();

904 905 906 907 908 909 910 911 912
  if (base64_p)
    {
      pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidlen = 3;
    }
  else
    {
913
#ifdef HAVE_LONG_FILE_NAMES
914 915
      sprintf (pidbuf, "%d", pid);
      pidlen = strlen (pidbuf);
916
#else
917 918 919 920
      pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidlen = 3;
921
#endif
922
    }
923

924
  len = SCHARS (prefix);
925
  val = make_uninit_string (len + 3 + pidlen);
926 927
  data = SDATA (val);
  bcopy(SDATA (prefix), data, len);
928 929 930 931 932 933 934 935
  p = data + len;

  bcopy (pidbuf, p, pidlen);
  p += pidlen;

  /* Here we try to minimize useless stat'ing when this function is
     invoked many times successively with the same PREFIX.  We achieve
     this by initializing count to a random value, and incrementing it
Richard M. Stallman's avatar
Richard M. Stallman committed
936 937 938 939 940 941
     afterwards.

     We don't want make-temp-name to be called while dumping,
     because then make_temp_name_count_initialized_p would get set
     and then make_temp_name_count would not be set when Emacs starts.  */

942 943 944 945 946 947 948 949 950
  if (!make_temp_name_count_initialized_p)
    {
      make_temp_name_count = (unsigned) time (NULL);
      make_temp_name_count_initialized_p = 1;
    }

  while (1)
    {
      struct stat ignored;
951
      unsigned num = make_temp_name_count;
952 953 954 955 956

      p[0] = make_temp_name_tbl[num & 63], num >>= 6;
      p[1] = make_temp_name_tbl[num & 63], num >>= 6;
      p[2] = make_temp_name_tbl[num & 63], num >>= 6;

957 958 959 960 961
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

962 963 964 965 966 967 968 969 970 971
      if (stat (data, &ignored) < 0)
	{
	  /* We want to return only if errno is ENOENT.  */
	  if (errno == ENOENT)
	    return val;
	  else
	    /* The error here is dubious, but there is little else we
	       can do.  The alternatives are to return nil, which is
	       as bad as (and in many cases worse than) throwing the
	       error, or to ignore the error, which will likely result
972 973 974
	       in looping through 225307 stat's, which is not only
	       dog-slow, but also useless since it will fallback to
	       the errow below, anyway.  */
975
	    report_file_error ("Cannot create temporary name for prefix",
976 977 978 979 980 981
			       Fcons (prefix, Qnil));
	  /* not reached */
	}
    }

  error ("Cannot create temporary name for prefix `%s'",
982
	 SDATA (prefix));
983
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
984
}
985

986 987

DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
988 989 990 991 992 993 994 995 996 997
       doc: /* Generate temporary file name (string) starting with PREFIX (a string).
The Emacs process number forms part of the result,
so there is no danger of generating a name being used by another process.

In addition, this function makes an attempt to choose a name
which has no existing file.  To make this work,
PREFIX should be an absolute file name.

There is a race condition between calling `make-temp-name' and creating the
file which opens all kinds of security holes.  For that reason, you should
998 999 1000 1001 1002
probably use `make-temp-file' instead, except in three circumstances:

* If you are creating the file in the user's home directory.
* If you are creating a directory rather than an ordinary file.
* If you are taking special precautions as `make-temp-file' does.  */)
1003
     (prefix)
1004 1005 1006 1007 1008 1009
     Lisp_Object prefix;
{
  return make_temp_name (prefix, 0);
}


Jim Blandy's avatar
Jim Blandy committed
1010 1011

DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
       doc: /* Convert filename NAME to absolute, and canonicalize it.
Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
 (does not start with slash); if DEFAULT-DIRECTORY is nil or missing,
the current buffer's value of default-directory is used.
File name components that are `.' are removed, and
so are file name components followed by `..', along with the `..' itself;
note that these simplifications are done without checking the resulting
file names in the file system.
An initial `~/' expands to your home directory.
An initial `~USER/' expands to USER's home directory.
See also the function `substitute-in-file-name'.  */)
     (name, default_directory)
1024
     Lisp_Object name, default_directory;
Jim Blandy's avatar
Jim Blandy committed
1025 1026
{
  unsigned char *nm;
1027

Jim Blandy's avatar
Jim Blandy committed
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
  register unsigned char *newdir, *p, *o;
  int tlen;
  unsigned char *target;
  struct passwd *pw;
#ifdef VMS
  unsigned char * colon = 0;
  unsigned char * close = 0;
  unsigned char * slash = 0;
  unsigned char * brack = 0;
  int lbrack = 0, rbrack = 0;
  int dots = 0;
#endif /* VMS */
1040
#ifdef DOS_NT
1041
  int drive = 0;
1042
  int collapse_newdir = 1;
1043
  int is_escaped = 0;
1044
#endif /* DOS_NT */
1045
  int length;
1046
  Lisp_Object handler, result;
1047

1048
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
1049

1050 1051
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
1052
  handler = Ffind_file_name_handler (name, Qexpand_file_name);
1053
  if (!NILP (handler))
1054
    return call3 (handler, Qexpand_file_name, name, default_directory);
1055

1056 1057 1058
  /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted.  */
  if (NILP (default_directory))
    default_directory = current_buffer->directory;
1059
  if (! STRINGP (default_directory))
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
    {
#ifdef DOS_NT
      /* "/" is not considered a root directory on DOS_NT, so using "/"
	 here causes an infinite recursion in, e.g., the following:

            (let (default-directory)
	      (expand-file-name "a"))

	 To avoid this, we set default_directory to the root of the
	 current drive.  */
      extern char *emacs_root_dir (void);

      default_directory = build_string (emacs_root_dir ());
#else
      default_directory = build_string ("/");
#endif
    }
1077

1078
  if (!NILP (default_directory))
1079
    {
1080
      handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
1081
      if (!NILP (handler))
1082
	return call3 (handler, Qexpand_file_name, name, default_directory);
1083
    }
1084

1085
  o = SDATA (default_directory);
1086

1087
  /* Make sure DEFAULT_DIRECTORY is properly expanded.
1088
     It would be better to do this down below where we actually use
1089
     default_directory.  Unfortunately, calling Fexpand_file_name recursively
1090 1091 1092 1093
     could invoke GC, and the strings might be relocated.  This would
     be annoying because we have pointers into strings lying around
     that would need adjusting, and people would add new pointers to
     the code and forget to adjust them, resulting in intermittent bugs.
1094 1095 1096
     Putting this call here avoids all that crud.

     The EQ test avoids infinite recursion.  */
1097
  if (! NILP (default_directory) && !EQ (default_directory, name)
1098 1099 1100
      /* Save time in some common cases - as long as default_directory
	 is not relative, it can be canonicalized with name below (if it
	 is needed at all) without requiring it to be expanded now.  */
1101
#ifdef DOS_NT
1102
      /* Detect MSDOS file names with drive specifiers.  */
1103
      && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1]) && IS_DIRECTORY_SEP (o[2]))
1104 1105 1106
#ifdef WINDOWSNT
      /* Detect Windows file names in UNC format.  */
      && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
1107
#endif
1108 1109 1110 1111 1112 1113
#else /* not DOS_NT */
      /* Detect Unix absolute file names (/... alone is not absolute on
	 DOS or Windows).  */
      && ! (IS_DIRECTORY_SEP (o[0]))
#endif /* not DOS_NT */
      )
1114 1115 1116 1117
    {
      struct gcpro gcpro1;

      GCPRO1 (name);
1118
      default_directory = Fexpand_file_name (default_directory, Qnil);
1119 1120 1121
      UNGCPRO;
    }

Jim Blandy's avatar
Jim Blandy committed
1122 1123 1124 1125
#ifdef VMS
  /* Filenames on VMS are always upper case.  */
  name = Fupcase (name);
#endif
1126 1127 1128
#ifdef FILE_SYSTEM_CASE
  name = FILE_SYSTEM_CASE (name);
#endif
Jim Blandy's avatar
Jim Blandy committed
1129

1130
  nm = SDATA (name);
1131

1132
#ifdef DOS_NT
1133 1134 1135 1136
  /* We will force directory separators to be either all \ or /, so make
     a local copy to modify, even if there ends up being no change. */
  nm = strcpy (alloca (strlen (nm) + 1), nm);

1137 1138 1139 1140 1141 1142 1143
  /* Note if special escape prefix is present, but remove for now.  */
  if (nm[0] == '/' && nm[1] == ':')
    {
      is_escaped = 1;
      nm += 2;
    }

1144
  /* Find and remove drive specifier if present; this makes nm absolute
1145 1146 1147 1148 1149 1150 1151
     even if the rest of the name appears to be relative.  Only look for
     drive specifier at the beginning.  */
  if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
    {
      drive = nm[0];
      nm += 2;
    }
1152 1153 1154 1155 1156 1157 1158 1159

#ifdef WINDOWSNT
  /* If we see "c://somedir", we want to strip the first slash after the
     colon when stripping the drive letter.  Otherwise, this expands to
     "//somedir".  */
  if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
    nm++;
#endif /* WINDOWSNT */
1160
#endif /* DOS_NT */
1161

1162 1163 1164 1165 1166 1167 1168 1169
#ifdef WINDOWSNT
  /* Discard any previous drive specifier if nm is now in UNC format. */
  if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
    {
      drive = 0;
    }
#endif

1170 1171 1172
  /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
     none are found, we can probably return right away.  We will avoid
     allocating a new string if name is already fully expanded.  */
Jim Blandy's avatar
Jim Blandy committed
1173
  if (
Richard M. Stallman's avatar