fileio.c 156 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,1997 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

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
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17
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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20

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

23 24 25 26
#if defined (USG5) || defined (BSD_SYSTEM) || defined (LINUX)
#include <fcntl.h>
#endif

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

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

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

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

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

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

53 54 55
#ifdef MSDOS
#include "msdos.h"
#include <sys/param.h>
56 57 58 59
#if __DJGPP__ >= 2
#include <fcntl.h>
#include <string.h>
#endif
60 61
#endif

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

#ifdef VMS
Richard M. Stallman's avatar
Richard M. Stallman committed
65
#include "vmsdir.h"
Jim Blandy's avatar
Jim Blandy committed
66 67 68 69 70
#include <perror.h>
#include <stddef.h>
#include <string.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
71 72
#include <errno.h>

Jim Blandy's avatar
Jim Blandy committed
73
#ifndef vax11c
Jim Blandy's avatar
Jim Blandy committed
74 75 76
extern int errno;
#endif

77
extern char *strerror ();
Jim Blandy's avatar
Jim Blandy committed
78 79 80 81 82

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

83 84 85
#ifndef USG
#ifndef VMS
#ifndef BSD4_1
86
#ifndef WINDOWSNT
87 88 89 90
#define HAVE_FSYNC
#endif
#endif
#endif
91
#endif
92

Jim Blandy's avatar
Jim Blandy committed
93
#include "lisp.h"
94
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
95
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
96 97
#include "charset.h"
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
98 99
#include "window.h"

100 101 102 103 104 105 106
#ifdef WINDOWSNT
#define NOMINMAX 1
#include <windows.h>
#include <stdlib.h>
#include <fcntl.h>
#endif /* not WINDOWSNT */

107 108 109 110 111 112 113 114 115 116 117 118 119
#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
120 121 122 123
/* 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))
124 125
#endif

Jim Blandy's avatar
Jim Blandy committed
126 127 128 129 130 131 132
#ifdef VMS
#include <file.h>
#include <rmsdef.h>
#include <fab.h>
#include <nam.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
133
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
134 135 136

#ifdef HPUX
#include <netio.h>
Jim Blandy's avatar
Jim Blandy committed
137
#ifndef HPUX8
138
#ifndef HPUX9
Jim Blandy's avatar
Jim Blandy committed
139 140
#include <errnet.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
141
#endif
142
#endif
Jim Blandy's avatar
Jim Blandy committed
143 144 145 146 147

#ifndef O_WRONLY
#define O_WRONLY 1
#endif

Richard M. Stallman's avatar
Richard M. Stallman committed
148 149 150 151
#ifndef O_RDONLY
#define O_RDONLY 0
#endif

Jim Blandy's avatar
Jim Blandy committed
152 153 154
#define min(a, b) ((a) < (b) ? (a) : (b))
#define max(a, b) ((a) > (b) ? (a) : (b))

155 156 157 158 159 160 161 162
/* Encode the file name NAME using the specified coding system
   for file names, if any.  */
#define ENCODE_FILE(name)					\
  (! NILP (Vfile_name_coding_system)				\
   && XFASTINT (Vfile_name_coding_system) != 0			\
   ? Fencode_coding_string (name, Vfile_name_coding_system, Qt)	\
   : name)

Jim Blandy's avatar
Jim Blandy committed
163 164 165 166 167 168 169
/* 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;

170 171 172
/* Coding system for file names, or nil if none.  */
Lisp_Object Vfile_name_coding_system;

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

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

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

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

186 187 188 189 190 191
/* Functions to be called to process text properties in inserted file.  */
Lisp_Object Vafter_insert_file_functions;

/* Functions to be called to create text property annotations for file.  */
Lisp_Object Vwrite_region_annotate_functions;

192 193 194 195
/* 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;

196 197 198
/* File name in which we write a list of all our auto save files.  */
Lisp_Object Vauto_save_list_file_name;

Jim Blandy's avatar
Jim Blandy committed
199 200 201 202 203 204 205 206
/* 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;

207 208 209 210
/* On NT, specifies the directory separator character, used (eg.) when
   expanding file names.  This can be bound to / or \. */
Lisp_Object Vdirectory_sep_char;

211 212 213 214
extern Lisp_Object Vuser_login_name;

extern int minibuf_level;

215 216
extern int minibuffer_auto_raise;

217 218 219 220 221 222 223
/* 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.  */

224
static Lisp_Object Vinhibit_file_name_handlers;
225
static Lisp_Object Vinhibit_file_name_operation;
226

227
Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
Jim Blandy's avatar
Jim Blandy committed
228

229 230
Lisp_Object Qfile_name_history;

231 232
Lisp_Object Qcar_less_than_car;

233
static int a_write P_ ((int, char *, int, int,
234
			Lisp_Object *, struct coding_system *));
235 236
static int e_write P_ ((int, char *, int, struct coding_system *));

237
void
Jim Blandy's avatar
Jim Blandy committed
238 239 240 241 242 243
report_file_error (string, data)
     char *string;
     Lisp_Object data;
{
  Lisp_Object errstring;

244
  errstring = build_string (strerror (errno));
Jim Blandy's avatar
Jim Blandy committed
245 246 247 248 249 250 251 252 253 254

  /* System error messages are capitalized.  Downcase the initial
     unless it is followed by a slash.  */
  if (XSTRING (errstring)->data[1] != '/')
    XSTRING (errstring)->data[0] = DOWNCASE (XSTRING (errstring)->data[0]);

  while (1)
    Fsignal (Qfile_error,
	     Fcons (build_string (string), Fcons (errstring, data)));
}
255

256
Lisp_Object
257 258 259 260
close_file_unwind (fd)
     Lisp_Object fd;
{
  close (XFASTINT (fd));
261
  return Qnil;
262
}
263 264 265

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

266
static Lisp_Object
267
restore_point_unwind (location)
268
     Lisp_Object location;
269
{
270
  Fgoto_char (location);
271
  Fset_marker (location, Qnil, Qnil);
272
  return Qnil;
273
}
Jim Blandy's avatar
Jim Blandy committed
274

275
Lisp_Object Qexpand_file_name;
276
Lisp_Object Qsubstitute_in_file_name;
277 278 279
Lisp_Object Qdirectory_file_name;
Lisp_Object Qfile_name_directory;
Lisp_Object Qfile_name_nondirectory;
280
Lisp_Object Qunhandled_file_name_directory;
281
Lisp_Object Qfile_name_as_directory;
282
Lisp_Object Qcopy_file;
283
Lisp_Object Qmake_directory_internal;
284 285 286 287 288 289 290 291 292
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;
293 294
Lisp_Object Qfile_symlink_p;
Lisp_Object Qaccess_file;
295
Lisp_Object Qfile_directory_p;
296
Lisp_Object Qfile_regular_p;
297 298 299 300 301 302 303
Lisp_Object Qfile_accessible_directory_p;
Lisp_Object Qfile_modes;
Lisp_Object Qset_file_modes;
Lisp_Object Qfile_newer_than_file_p;
Lisp_Object Qinsert_file_contents;
Lisp_Object Qwrite_region;
Lisp_Object Qverify_visited_file_modtime;
304
Lisp_Object Qset_visited_file_modtime;
305

306 307
DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
  "Return FILENAME's handler function for OPERATION, if it has one.\n\
308 309
Otherwise, return nil.\n\
A file name is handled if one of the regular expressions in\n\
310
`file-name-handler-alist' matches it.\n\n\
311 312 313
If OPERATION equals `inhibit-file-name-operation', then we ignore\n\
any handlers that are members of `inhibit-file-name-handlers',\n\
but we still do run any other handlers.  This lets handlers\n\
314
use the standard functions without calling themselves recursively.")
315 316
  (filename, operation)
    Lisp_Object filename, operation;
317
{
318
  /* This function must not munge the match data.  */
319
  Lisp_Object chain, inhibited_handlers;
320

321 322
  CHECK_STRING (filename, 0);

323 324 325 326
  if (EQ (operation, Vinhibit_file_name_operation))
    inhibited_handlers = Vinhibit_file_name_handlers;
  else
    inhibited_handlers = Qnil;
327

328
  for (chain = Vfile_name_handler_alist; CONSP (chain);
329 330 331 332
       chain = XCONS (chain)->cdr)
    {
      Lisp_Object elt;
      elt = XCONS (chain)->car;
333
      if (CONSP (elt))
334 335 336
	{
	  Lisp_Object string;
	  string = XCONS (elt)->car;
337
	  if (STRINGP (string) && fast_string_match (string, filename) >= 0)
338 339 340 341 342 343 344 345
	    {
	      Lisp_Object handler, tem;

	      handler = XCONS (elt)->cdr;
	      tem = Fmemq (handler, inhibited_handlers);
	      if (NILP (tem))
		return handler;
	    }
346
	}
347 348

      QUIT;
349 350 351 352
    }
  return Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
353 354
DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
  1, 1, 0,
355 356
  "Return the directory component in file name FILENAME.\n\
Return nil if FILENAME does not include a directory.\n\
Jim Blandy's avatar
Jim Blandy committed
357 358 359
Otherwise return a directory spec.\n\
Given a Unix syntax file name, returns a string ending in slash;\n\
on VMS, perhaps instead a string ending in `:', `]' or `>'.")
360 361
  (filename)
     Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
362 363 364
{
  register unsigned char *beg;
  register unsigned char *p;
365
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
366

367
  CHECK_STRING (filename, 0);
Jim Blandy's avatar
Jim Blandy committed
368

369 370
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
371
  handler = Ffind_file_name_handler (filename, Qfile_name_directory);
372
  if (!NILP (handler))
373
    return call2 (handler, Qfile_name_directory, filename);
374

375
#ifdef FILE_SYSTEM_CASE
376
  filename = FILE_SYSTEM_CASE (filename);
377
#endif
378
  beg = XSTRING (filename)->data;
379 380 381
#ifdef DOS_NT
  beg = strcpy (alloca (strlen (beg) + 1), beg);
#endif
382
  p = beg + XSTRING (filename)->size;
Jim Blandy's avatar
Jim Blandy committed
383

384
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
Jim Blandy's avatar
Jim Blandy committed
385 386 387
#ifdef VMS
	 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
#endif /* VMS */
388 389 390 391
#ifdef DOS_NT
	 /* only recognise drive specifier at beginning */
	 && !(p[-1] == ':' && p == beg + 2)
#endif
Jim Blandy's avatar
Jim Blandy committed
392 393 394 395
	 ) p--;

  if (p == beg)
    return Qnil;
396
#ifdef DOS_NT
397 398 399 400
  /* Expansion of "c:" to drive and default directory.  */
  if (p == beg + 2 && beg[1] == ':')
    {
      /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir.  */
401 402
      unsigned char *res = alloca (MAXPATHLEN + 1);
      if (getdefdir (toupper (*beg) - 'A' + 1, res))
403
	{
404
	  if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
405 406 407 408 409
	    strcat (res, "/");
	  beg = res;
	  p = beg + strlen (beg);
	}
    }
410
  CORRECT_DIR_SEPS (beg);
411
#endif /* DOS_NT */
Jim Blandy's avatar
Jim Blandy committed
412 413 414 415 416
  return make_string (beg, p - beg);
}

DEFUN ("file-name-nondirectory", Ffile_name_nondirectory, Sfile_name_nondirectory,
  1, 1, 0,
417
  "Return file name FILENAME sans its directory.\n\
Jim Blandy's avatar
Jim Blandy committed
418 419 420
For example, in a Unix-syntax file name,\n\
this is everything after the last slash,\n\
or the entire name if it contains no slash.")
421 422
  (filename)
     Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
423 424
{
  register unsigned char *beg, *p, *end;
425
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
426

427
  CHECK_STRING (filename, 0);
Jim Blandy's avatar
Jim Blandy committed
428

429 430
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
431
  handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
432
  if (!NILP (handler))
433
    return call2 (handler, Qfile_name_nondirectory, filename);
434

435 436
  beg = XSTRING (filename)->data;
  end = p = beg + XSTRING (filename)->size;
Jim Blandy's avatar
Jim Blandy committed
437

438
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
Jim Blandy's avatar
Jim Blandy committed
439 440 441
#ifdef VMS
	 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
#endif /* VMS */
442 443 444 445
#ifdef DOS_NT
	 /* only recognise drive specifier at beginning */
	 && !(p[-1] == ':' && p == beg + 2)
#endif
Jim Blandy's avatar
Jim Blandy committed
446 447 448 449
	 ) p--;

  return make_string (p, end - p);
}
450 451 452 453 454 455

DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory, Sunhandled_file_name_directory, 1, 1, 0,
  "Return a directly usable directory name somehow associated with FILENAME.\n\
A `directly usable' directory name is one that may be used without the\n\
intervention of any file handler.\n\
If FILENAME is a directly usable file itself, return\n\
456
\(file-name-directory FILENAME).\n\
457 458 459 460 461 462 463 464 465
The `call-process' and `start-process' functions use this function to\n\
get a current directory to run processes in.")
  (filename)
    Lisp_Object filename;
{
  Lisp_Object handler;

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
466
  handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
467 468 469 470 471 472
  if (!NILP (handler))
    return call2 (handler, Qunhandled_file_name_directory, filename);

  return Ffile_name_directory (filename);
}

Jim Blandy's avatar
Jim Blandy committed
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523

char *
file_name_as_directory (out, in)
     char *out, *in;
{
  int size = strlen (in) - 1;

  strcpy (out, in);

#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
524 525
      dot = index (p, '.');
      if (dot)
Jim Blandy's avatar
Jim Blandy committed
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
	{
	  /* 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 */
541
  if (!IS_DIRECTORY_SEP (out[size]))
542 543 544 545
    {
      out[size + 1] = DIRECTORY_SEP;
      out[size + 2] = '\0';
    }
546 547 548
#ifdef DOS_NT
  CORRECT_DIR_SEPS (out);
#endif
Jim Blandy's avatar
Jim Blandy committed
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
#endif /* not VMS */
  return out;
}

DEFUN ("file-name-as-directory", Ffile_name_as_directory,
       Sfile_name_as_directory, 1, 1, 0,
  "Return a string representing file FILENAME interpreted as a directory.\n\
This operation exists because a directory is also a file, but its name as\n\
a directory is different from its name as a file.\n\
The result can be used as the value of `default-directory'\n\
or passed as second argument to `expand-file-name'.\n\
For a Unix-syntax file name, just appends a slash.\n\
On VMS, converts \"[X]FOO.DIR\" to \"[X.FOO]\", etc.")
  (file)
     Lisp_Object file;
{
  char *buf;
566
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
567 568

  CHECK_STRING (file, 0);
Jim Blandy's avatar
Jim Blandy committed
569
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
570
    return Qnil;
571 572 573

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
574
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
575 576 577
  if (!NILP (handler))
    return call2 (handler, Qfile_name_as_directory, file);

Jim Blandy's avatar
Jim Blandy committed
578 579 580 581 582 583 584 585 586
  buf = (char *) alloca (XSTRING (file)->size + 10);
  return build_string (file_name_as_directory (buf, XSTRING (file)->data));
}

/*
 * Convert from directory name to filename.
 * On VMS:
 *       xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
 *       xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
587
 * On UNIX, it's simple: just make sure there isn't a terminating /
Jim Blandy's avatar
Jim Blandy committed
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622

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

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. */
623
      if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
Jim Blandy's avatar
Jim Blandy committed
624 625 626 627 628 629 630 631 632 633 634
	{
	  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] == ':')
635
	    {                   /* Xlate logical name and see what we get */
Jim Blandy's avatar
Jim Blandy committed
636 637 638 639 640 641 642
	      ptr = strcpy (dst, src); /* upper case for getenv */
	      while (*ptr)
		{
		  if ('a' <= *ptr && *ptr <= 'z')
		    *ptr -= 040;
		  ptr++;
		}
643
	      dst[slen - 1] = 0;        /* remove colon */
Jim Blandy's avatar
Jim Blandy committed
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
	      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
661
	    {           /* not a directory spec */
Jim Blandy's avatar
Jim Blandy committed
662 663 664 665 666 667 668 669
	      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
670 671
      ptr = index (src, bracket - 2);
      if (ptr == 0)
Jim Blandy's avatar
Jim Blandy committed
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
	{ /* 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] == ':'
691
	      && dst[slen - 2] != ':'   /* skip decnet nodes */
692
	      && strcmp (src + slen, "[000000]") == 0)
Jim Blandy's avatar
Jim Blandy committed
693 694 695 696 697 698 699
	    {
	      dst[slen - 1] = '\0';
	      if ((ptr = egetenv (dst))
		  && (rlen = strlen (ptr) - 1) > 0
		  && (ptr[rlen] == ']' || ptr[rlen] == '>')
		  && ptr[rlen - 1] == '.')
		{
700 701 702 703 704
		  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
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
		}
	      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);
723 724 725 726 727 728
#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
729
  if (slen > 1
730
      && IS_DIRECTORY_SEP (dst[slen - 1])
731 732 733 734
#ifdef DOS_NT
      && !IS_ANY_SEP (dst[slen - 2])
#endif
      )
Jim Blandy's avatar
Jim Blandy committed
735
    dst[slen - 1] = 0;
736 737 738
#endif
#ifdef DOS_NT
  CORRECT_DIR_SEPS (dst);
739
#endif
Jim Blandy's avatar
Jim Blandy committed
740 741 742 743 744
  return 1;
}

DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
  1, 1, 0,
745 746
  "Returns the file name of the directory named DIRECTORY.\n\
This is the name of the file that holds the data for the directory DIRECTORY.\n\
Jim Blandy's avatar
Jim Blandy committed
747 748 749 750 751 752 753 754 755
This operation exists because a directory is also a file, but its name as\n\
a directory is different from its name as a file.\n\
In Unix-syntax, this function just removes the final slash.\n\
On VMS, given a VMS-syntax directory name such as \"[X.Y]\",\n\
it returns a file name such as \"[X]Y.DIR.1\".")
  (directory)
     Lisp_Object directory;
{
  char *buf;
756
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
757 758 759

  CHECK_STRING (directory, 0);

Jim Blandy's avatar
Jim Blandy committed
760
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
761
    return Qnil;
762 763 764

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
765
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
766 767 768
  if (!NILP (handler))
    return call2 (handler, Qdirectory_file_name, directory);

Jim Blandy's avatar
Jim Blandy committed
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
#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 */
  buf = (char *) alloca (XSTRING (directory)->size + 20 + 255);
#else
  buf = (char *) alloca (XSTRING (directory)->size + 20);
#endif
  directory_file_name (XSTRING (directory)->data, buf);
  return build_string (buf);
}

DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
  "Generate temporary file name (string) starting with PREFIX (a string).\n\
The Emacs process number forms part of the result,\n\
784 785 786
so there is no danger of generating a name being used by another process.\n\
In addition, this function makes an attempt to choose a name\n\
which has no existing file.")
Jim Blandy's avatar
Jim Blandy committed
787 788 789 790
  (prefix)
     Lisp_Object prefix;
{
  Lisp_Object val;
791
#ifdef MSDOS
792
  /* Don't use too many characters of the restricted 8+3 DOS
793
     filename space.  */
794
  val = concat2 (prefix, build_string ("a.XXX"));
795
#else
Jim Blandy's avatar
Jim Blandy committed
796
  val = concat2 (prefix, build_string ("XXXXXX"));
797
#endif
Jim Blandy's avatar
Jim Blandy committed
798
  mktemp (XSTRING (val)->data);
799 800 801
#ifdef DOS_NT
  CORRECT_DIR_SEPS (XSTRING (val)->data);
#endif
Jim Blandy's avatar
Jim Blandy committed
802 803 804 805
  return val;
}

DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
806 807 808
  "Convert filename NAME to absolute, and canonicalize it.\n\
Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative\n\
 (does not start with slash); if DEFAULT-DIRECTORY is nil or missing,\n\
Jim Blandy's avatar
Jim Blandy committed
809
the current buffer's value of default-directory is used.\n\
810 811
File name components that are `.' are removed, and \n\
so are file name components followed by `..', along with the `..' itself;\n\
Jim Blandy's avatar
Jim Blandy committed
812
note that these simplifications are done without checking the resulting\n\
813
file names in the file system.\n\
Jim Blandy's avatar
Jim Blandy committed
814 815
An initial `~/' expands to your home directory.\n\
An initial `~USER/' expands to USER's home directory.\n\
Jim Blandy's avatar
Jim Blandy committed
816
See also the function `substitute-in-file-name'.")
817
  (name, default_directory)
818
     Lisp_Object name, default_directory;
Jim Blandy's avatar
Jim Blandy committed
819 820
{
  unsigned char *nm;
821

Jim Blandy's avatar
Jim Blandy committed
822 823 824 825 826 827 828 829 830 831 832 833
  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 */
834
#ifdef DOS_NT
835
  int drive = 0;
836
  int collapse_newdir = 1;
837
#endif /* DOS_NT */
838
  int length;
839
  Lisp_Object handler;
840

Jim Blandy's avatar
Jim Blandy committed
841 842
  CHECK_STRING (name, 0);

843 844
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
845
  handler = Ffind_file_name_handler (name, Qexpand_file_name);
846
  if (!NILP (handler))
847
    return call3 (handler, Qexpand_file_name, name, default_directory);
848

849 850 851
  /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted.  */
  if (NILP (default_directory))
    default_directory = current_buffer->directory;
852 853
  if (! STRINGP (default_directory))
    default_directory = build_string ("/");
854

855
  if (!NILP (default_directory))
856
    {
857
      handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
858
      if (!NILP (handler))
859
	return call3 (handler, Qexpand_file_name, name, default_directory);
860
    }
861

862
  o = XSTRING (default_directory)->data;
863

864
  /* Make sure DEFAULT_DIRECTORY is properly expanded.
865
     It would be better to do this down below where we actually use
866
     default_directory.  Unfortunately, calling Fexpand_file_name recursively
867 868 869 870
     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.
871 872 873
     Putting this call here avoids all that crud.

     The EQ test avoids infinite recursion.  */
874
  if (! NILP (default_directory) && !EQ (default_directory, name)
875 876 877
      /* 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.  */
878
#ifdef DOS_NT
879 880 881 882 883
      /* Detect MSDOS file names with drive specifiers.  */
      && ! (IS_DRIVE (o[0]) && (IS_DEVICE_SEP (o[1]) && IS_DIRECTORY_SEP (o[2])))
#ifdef WINDOWSNT
      /* Detect Windows file names in UNC format.  */
      && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
884
#endif
885 886 887 888 889 890
#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 */
      )
891 892 893 894
    {
      struct gcpro gcpro1;

      GCPRO1 (name);
895
      default_directory = Fexpand_file_name (default_directory, Qnil);
896 897 898
      UNGCPRO;
    }

Jim Blandy's avatar
Jim Blandy committed
899 900 901 902
#ifdef VMS
  /* Filenames on VMS are always upper case.  */
  name = Fupcase (name);
#endif
903 904 905
#ifdef FILE_SYSTEM_CASE
  name = FILE_SYSTEM_CASE (name);
#endif
Jim Blandy's avatar
Jim Blandy committed
906 907

  nm = XSTRING (name)->data;
908

909
#ifdef DOS_NT
910 911 912 913 914 915
  /* 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);

  /* Find and remove drive specifier if present; this makes nm absolute
     even if the rest of the name appears to be relative. */
916 917
  {
    unsigned char *colon = rindex (nm, ':');
918

919
    if (colon)
920 921 922 923 924 925
      /* Only recognize colon as part of drive specifier if there is a
	 single alphabetic character preceeding the colon (and if the
	 character before the drive letter, if present, is a directory
	 separator); this is to support the remote system syntax used by
	 ange-ftp, and the "po:username" syntax for POP mailboxes. */
    look_again:
926 927
      if (nm == colon)
	nm++;
928 929
      else if (IS_DRIVE (colon[-1])
	       && (colon == nm + 1 || IS_DIRECTORY_SEP (colon[-2])))
930
	{
931
	  drive = colon[-1];
932
	  nm = colon + 1;
933 934 935 936 937 938 939
	}
      else
	{
	  while (--colon >= nm)
	    if (colon[0] == ':')
	      goto look_again;
	}
940
  }
941 942 943 944 945 946 947 948

#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 */
949
#endif /* DOS_NT */
950

951 952 953 954 955 956 957 958 959 960 961
#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

  /* If nm is absolute, look for /./ 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
962
  if (
963
      IS_DIRECTORY_SEP (nm[0])
964 965 966 967 968 969
#ifdef MSDOS
      && drive
#endif
#ifdef WINDOWSNT
      && (drive || IS_DIRECTORY_SEP (nm[1]))
#endif
Jim Blandy's avatar
Jim Blandy committed
970 971 972 973 974
#ifdef VMS
      || index (nm, ':')
#endif /* VMS */
      )
    {
975 976 977 978 979 980 981 982
      /* If it turns out that the filename we want to return is just a
	 suffix of FILENAME, we don't need to go through and edit
	 things; we just need to construct a new string using data
	 starting at the middle of FILENAME.  If we set lose to a
	 non-zero value, that means we've discovered that we can't do
	 that cool trick.  */
      int lose = 0;

Jim Blandy's avatar
Jim Blandy committed
983 984 985
      p = nm;
      while (*p)
	{
986
	  /* Since we know the name is absolute, we can assume that each
987 988 989
	     element starts with a "/".  */

	  /* "." and ".." are hairy.  */
990
	  if (IS_DIRECTORY_SEP (p[0])
991
	      && p[1] == '.'
992
	      && (IS_DIRECTORY_SEP (p[2])
993
		  || p[2] == 0
994
		  || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
995
				      || p[3] == 0))))
Jim Blandy's avatar
Jim Blandy committed
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
	    lose = 1;
#ifdef VMS
	  if (p[0] == '\\')
	    lose = 1;
	  if (p[0] == '/') {
	    /* if dev:[dir]/, move nm to / */
	    if (!slash && p > nm && (brack || colon)) {
	      nm = (brack ? brack + 1 : colon + 1);
	      lbrack = rbrack = 0;
	      brack = 0;
	      colon = 0;
	    }
	    slash = p;
	  }
	  if (p[0] == '-')
#ifndef VMS4_4
	    /* VMS pre V4.4,convert '-'s in filenames. */
	    if (lbrack == rbrack)
	      {
1015
		if (dots < 2)   /* this is to allow negative version numbers */
Jim Blandy's avatar
Jim Blandy committed
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
		  p[0] = '_';
	      }
	    else
#endif /* VMS4_4 */
	      if (lbrack > rbrack &&
		  ((p[-1] == '.' || p[-1] == '[' || p[-1] == '<') &&
		   (p[1] == '.' || p[1] == ']' || p[1] == '>')))
		lose = 1;
#ifndef VMS4_4
	      else
		p[0] = '_';
#endif /* VMS4_4 */
	  /* count open brackets, reset close bracket pointer */
	  if (p[0] == '[' || p[0] == '<')
	    lbrack++, brack = 0;
	  /* count close brackets, set close bracket pointer */
	  if (p[0] == ']' || p[0] == '>')
	    rbrack++, brack = p;
	  /* detect ][ or >< */
	  if ((p[0] == ']' || p[0] == '>') && (p[1] == '[' || p[1] == '<'))
	    lose = 1;
	  if ((p[0] == ':' || p[0] == ']' || p[0] == '>') && p[1] == '~')
	    nm = p + 1, lose = 1;
	  if (p[0] == ':' && (colon || slash))
	    /* if dev1:[dir]dev2:, move nm to dev2: */
	    if (brack)
	      {
		nm = brack + 1;
		brack = 0;
	      }
1046
	    /* if /name/dev:, move nm to dev: */
Jim Blandy's avatar
Jim Blandy committed
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
	    else if (slash)
	      nm = slash + 1;
	    /* if node::dev:, move colon following dev */
	    else if (colon && colon[-1] == ':')
	      colon = p;
	    /* if dev1:dev2:, move nm to dev2: */
	    else if (colon && colon[-1] != ':')
	      {
		nm = colon + 1;
		colon = 0;
	      }
	  if (p[0] == ':' && !colon)
	    {
	      if (p[1] == ':')
		p++;
	      colon = p;
	    }
	  if (lbrack == rbrack)
	    if (p[0] == ';')
	      dots = 2;
	    else if (p[0] == '.')
	      dots++;
#endif /* VMS */
	  p++;
	}
      if (!lose)
	{
#ifdef VMS
	  if (index (nm, '/'))
	    return build_string (sys_translate_unix (nm));
#endif /* VMS */
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
#ifdef DOS_NT
	  /* Make sure directories are all separated with / or \ as
	     desired, but avoid allocation of a new string when not
	     required. */
	  CORRECT_DIR_SEPS (nm);
#ifdef WINDOWSNT
	  if (IS_DIRECTORY_SEP (nm[1]))
	    {
	      if (strcmp (nm, XSTRING (name)->data) != 0)
		name = build_string (nm);
	    }
	  else
#endif
	  /* drive must be set, so this is okay */
	  if (strcmp (nm - 2, XSTRING (name)->data) != 0)
	    {
	      name = make_string (nm - 2, p - nm + 2);
1095
	      XSTRING (name)->data[0] = DRIVE_LETTER (drive);
1096 1097 1098 1099
	      XSTRING (name)->data[1] = ':';
	    }
	  return name;
#else /* not DOS_NT */
Jim Blandy's avatar
Jim Blandy committed
1100 1101 1102
	  if (nm == XSTRING (name)->data)
	    return name;
	  return build_string (nm);
1103
#endif /* not DOS_NT */
Jim Blandy's avatar
Jim Blandy committed
1104 1105 1106
	}
    }

1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
  /* At this point, nm might or might not be an absolute file name.  We
     need to expand ~ or ~user if present, otherwise prefix nm with
     default_directory if nm is not absolute, and finally collapse /./
     and /foo/../ sequences.

     We set newdir to be the appropriate prefix if one is needed:
       - the relevant user directory if nm starts with ~ or ~user
       - the specified drive's working dir (DOS/NT only) if nm does not
         start with /
       - the value of default_directory.

     Note that these prefixes are not guaranteed to be absolute (except
     for the working dir of a drive).  Therefore, to ensure we always
     return an absolute name, if the final prefix is not absolute we
     append it to the current working directory.  */
Jim Blandy's avatar
Jim Blandy committed
1122 1123 1124 1125

  newdir = 0;

  if (nm[0] == '~')		/* prefix ~ */
1126
    {
1127
      if (IS_DIRECTORY_SEP (nm[1])
Jim Blandy's avatar
Jim Blandy committed
1128
#ifdef VMS
1129
	  || nm[1] == ':'
1130
#endif /* VMS */
1131 1132 1133 1134
	  || nm[1] == 0)	/* ~ by itself */
	{
	  if (!(newdir = (unsigned char *) egetenv ("HOME")))
	    newdir = (unsigned char *) "";
1135
	  nm++;
1136
#ifdef DOS_NT
1137
	  collapse_newdir = 0;
1138
#endif
Jim Blandy's avatar
Jim Blandy committed
1139
#ifdef VMS
1140
	  nm++;			/* Don't leave the slash in nm.  */
1141
#endif /* VMS */
1142 1143 1144
	}
      else			/* ~user/filename */
	{
1145
	  for (p = nm; *p && (!IS_DIRECTORY_SEP (*p)
Jim Blandy's avatar
Jim Blandy committed
1146
#ifdef VMS
1147
			      && *p != ':'
1148
#endif /* VMS */
1149 1150