fileio.c 198 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* File IO for GNU Emacs.
2 3
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996,
                 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
                 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

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
10
the Free Software Foundation; either version 3, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17 18 19
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
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22

23
#include <config.h>
24
#include <limits.h>
Jim Blandy's avatar
Jim Blandy committed
25

26
#ifdef HAVE_FCNTL_H
27 28 29
#include <fcntl.h>
#endif

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

34 35 36 37
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

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

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

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

50
#ifdef HAVE_PWD_H
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

#include "lisp.h"
72
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
73
#include "buffer.h"
74
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
75
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
76
#include "window.h"
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
77
#include "blockinput.h"
Karoly Lorentey's avatar
Karoly Lorentey committed
78 79
#include "frame.h"
#include "dispextern.h"
Jim Blandy's avatar
Jim Blandy committed
80

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

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

97 98 99 100 101 102 103 104 105 106 107 108 109
#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
110 111 112 113
/* 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))
114 115
#endif

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

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

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

134 135
#include "commands.h"
extern int use_dialog_box;
Kenichi Handa's avatar
Kenichi Handa committed
136
extern int use_file_dialog;
137

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

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

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

150 151 152 153
#ifndef FILE_SYSTEM_CASE
#define FILE_SYSTEM_CASE(filename)  (filename)
#endif

Jim Blandy's avatar
Jim Blandy committed
154 155 156 157 158 159 160
/* 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;

161 162 163 164 165 166 167
/* 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;

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

171 172 173 174
/* Coding system for file names used only when
   Vfile_name_coding_system is nil.  */
Lisp_Object Vdefault_file_name_coding_system;

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

179 180 181 182
/* Property name of a file name handler,
   which gives a list of operations it handles..  */
Lisp_Object Qoperations;

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

186
/* Function to be called to decide a coding system of a reading file.  */
187
Lisp_Object Vset_auto_coding_function;
188

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

192
/* Lisp function for setting buffer-file-coding-system and the
193
   multibyteness of the current buffer after inserting a file.  */
194
Lisp_Object Qafter_insert_file_set_coding;
195

196 197
/* Functions to be called to create text property annotations for file.  */
Lisp_Object Vwrite_region_annotate_functions;
198
Lisp_Object Qwrite_region_annotate_functions;
199

200 201 202 203
/* 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;

204 205 206
/* File name in which we write a list of all our auto save files.  */
Lisp_Object Vauto_save_list_file_name;

207
/* Function to call to read a file name.  */
208
Lisp_Object Vread_file_name_function;
209 210 211 212

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

213 214 215
/* Nonzero means completion ignores case when reading file name.  */
int read_file_name_completion_ignore_case;

Jim Blandy's avatar
Jim Blandy committed
216 217 218 219 220 221 222 223
/* 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;

224 225 226 227
/* On NT, specifies the directory separator character, used (eg.) when
   expanding file names.  This can be bound to / or \. */
Lisp_Object Vdirectory_sep_char;

228 229 230 231 232
#ifdef HAVE_FSYNC
/* Nonzero means skip the call to fsync in Fwrite-region.  */
int write_region_inhibit_fsync;
#endif

233 234
extern Lisp_Object Vuser_login_name;

235 236 237 238
#ifdef WINDOWSNT
extern Lisp_Object Vw32_get_true_file_attributes;
#endif

239 240
extern int minibuf_level;

241 242
extern int minibuffer_auto_raise;

243 244
extern int history_delete_duplicates;

245 246 247 248 249 250 251
/* 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.  */

252
static Lisp_Object Vinhibit_file_name_handlers;
253
static Lisp_Object Vinhibit_file_name_operation;
254

255
Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
256
Lisp_Object Qexcl;
257 258
Lisp_Object Qfile_name_history;

259 260
Lisp_Object Qcar_less_than_car;

261
static int a_write P_ ((int, Lisp_Object, int, int,
262
			Lisp_Object *, struct coding_system *));
263 264
static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));

265

266
void
Jim Blandy's avatar
Jim Blandy committed
267
report_file_error (string, data)
268
     const char *string;
Jim Blandy's avatar
Jim Blandy committed
269 270 271
     Lisp_Object data;
{
  Lisp_Object errstring;
Richard M. Stallman's avatar
Richard M. Stallman committed
272
  int errorno = errno;
273
  char *str;
Jim Blandy's avatar
Jim Blandy committed
274

275
  synchronize_system_messages_locale ();
276 277 278
  str = strerror (errorno);
  errstring = code_convert_string_norecord (make_unibyte_string (str,
								 strlen (str)),
279 280
					    Vlocale_coding_system, 0);

Jim Blandy's avatar
Jim Blandy committed
281
  while (1)
Richard M. Stallman's avatar
Richard M. Stallman committed
282 283 284
    switch (errorno)
      {
      case EEXIST:
285
	xsignal (Qfile_already_exists, Fcons (errstring, data));
Richard M. Stallman's avatar
Richard M. Stallman committed
286 287 288 289
	break;
      default:
	/* System error messages are capitalized.  Downcase the initial
	   unless it is followed by a slash.  */
290
	if (SREF (errstring, 1) != '/')
291
	  SSET (errstring, 0, DOWNCASE (SREF (errstring, 0)));
Richard M. Stallman's avatar
Richard M. Stallman committed
292

293
	xsignal (Qfile_error,
Richard M. Stallman's avatar
Richard M. Stallman committed
294 295
		 Fcons (build_string (string), Fcons (errstring, data)));
      }
Jim Blandy's avatar
Jim Blandy committed
296
}
297

298
Lisp_Object
299 300 301
close_file_unwind (fd)
     Lisp_Object fd;
{
302
  emacs_close (XFASTINT (fd));
303
  return Qnil;
304
}
305 306 307

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

308
static Lisp_Object
309
restore_point_unwind (location)
310
     Lisp_Object location;
311
{
312
  Fgoto_char (location);
313
  Fset_marker (location, Qnil, Qnil);
314
  return Qnil;
315
}
316

Jim Blandy's avatar
Jim Blandy committed
317

318
Lisp_Object Qexpand_file_name;
319
Lisp_Object Qsubstitute_in_file_name;
320 321 322
Lisp_Object Qdirectory_file_name;
Lisp_Object Qfile_name_directory;
Lisp_Object Qfile_name_nondirectory;
323
Lisp_Object Qunhandled_file_name_directory;
324
Lisp_Object Qfile_name_as_directory;
325
Lisp_Object Qcopy_file;
326
Lisp_Object Qmake_directory_internal;
327
Lisp_Object Qmake_directory;
328 329 330 331 332 333 334 335 336
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;
337 338
Lisp_Object Qfile_symlink_p;
Lisp_Object Qaccess_file;
339
Lisp_Object Qfile_directory_p;
340
Lisp_Object Qfile_regular_p;
341 342 343
Lisp_Object Qfile_accessible_directory_p;
Lisp_Object Qfile_modes;
Lisp_Object Qset_file_modes;
344
Lisp_Object Qset_file_times;
345 346 347 348
Lisp_Object Qfile_newer_than_file_p;
Lisp_Object Qinsert_file_contents;
Lisp_Object Qwrite_region;
Lisp_Object Qverify_visited_file_modtime;
349
Lisp_Object Qset_visited_file_modtime;
350

351
DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
352 353 354 355 356 357 358 359 360 361 362
       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;
363
{
364
  /* This function must not munge the match data.  */
365
  Lisp_Object chain, inhibited_handlers, result;
366
  int pos = -1;
367

368
  result = Qnil;
369
  CHECK_STRING (filename);
370

371 372 373 374
  if (EQ (operation, Vinhibit_file_name_operation))
    inhibited_handlers = Vinhibit_file_name_handlers;
  else
    inhibited_handlers = Qnil;
375

376
  for (chain = Vfile_name_handler_alist; CONSP (chain);
377
       chain = XCDR (chain))
378 379
    {
      Lisp_Object elt;
380
      elt = XCAR (chain);
381
      if (CONSP (elt))
382
	{
383
	  Lisp_Object string = XCAR (elt);
384
	  int match_pos;
385
	  Lisp_Object handler = XCDR (elt);
386 387 388 389
	  Lisp_Object operations = Qnil;

	  if (SYMBOLP (handler))
	    operations = Fget (handler, Qoperations);
390

391
	  if (STRINGP (string)
392 393
	      && (match_pos = fast_string_match (string, filename)) > pos
	      && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
394
	    {
395
	      Lisp_Object tem;
396

397
	      handler = XCDR (elt);
398 399
	      tem = Fmemq (handler, inhibited_handlers);
	      if (NILP (tem))
400 401 402 403
		{
		  result = handler;
		  pos = match_pos;
		}
404
	    }
405
	}
406 407

      QUIT;
408
    }
409
  return result;
410 411
}

Jim Blandy's avatar
Jim Blandy committed
412
DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
413 414 415
       1, 1, 0,
       doc: /* Return the directory component in file name FILENAME.
Return nil if FILENAME does not include a directory.
416
Otherwise return a directory name.
417 418 419
Given a Unix syntax file name, returns a string ending in slash;
on VMS, perhaps instead a string ending in `:', `]' or `>'.  */)
     (filename)
420
     Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
421
{
422
#ifndef DOS_NT
423
  register const unsigned char *beg;
424 425 426
#else
  register unsigned char *beg;
#endif
427
  register const unsigned char *p;
428
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
429

430
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
431

432 433
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
434
  handler = Ffind_file_name_handler (filename, Qfile_name_directory);
435
  if (!NILP (handler))
436
    return call2 (handler, Qfile_name_directory, filename);
437

438
  filename = FILE_SYSTEM_CASE (filename);
439
  beg = SDATA (filename);
440 441 442
#ifdef DOS_NT
  beg = strcpy (alloca (strlen (beg) + 1), beg);
#endif
443
  p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
444

445
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
Jim Blandy's avatar
Jim Blandy committed
446 447 448
#ifdef VMS
	 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
#endif /* VMS */
449
#ifdef DOS_NT
450 451 452 453 454
	 /* 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))))
455
#endif
Jim Blandy's avatar
Jim Blandy committed
456 457 458 459
	 ) p--;

  if (p == beg)
    return Qnil;
460
#ifdef DOS_NT
461
  /* Expansion of "c:" to drive and default directory.  */
462
  if (p[-1] == ':')
463 464
    {
      /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir.  */
465
      unsigned char *res = alloca (MAXPATHLEN + 1);
466 467 468 469 470 471 472 473 474 475
      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))
476
	{
477
	  if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
478 479 480 481 482
	    strcat (res, "/");
	  beg = res;
	  p = beg + strlen (beg);
	}
    }
483
  CORRECT_DIR_SEPS (beg);
484
#endif /* DOS_NT */
485

486
  return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
487 488
}

489 490
DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
       Sfile_name_nondirectory, 1, 1, 0,
491 492 493 494 495
       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)
496
     Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
497
{
498
  register const unsigned char *beg, *p, *end;
499
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
500

501
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
502

503 504
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
505
  handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
506
  if (!NILP (handler))
507
    return call2 (handler, Qfile_name_nondirectory, filename);
508

509 510
  beg = SDATA (filename);
  end = p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
511

512
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
Jim Blandy's avatar
Jim Blandy committed
513 514 515
#ifdef VMS
	 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
#endif /* VMS */
516 517
#ifdef DOS_NT
	 /* only recognise drive specifier at beginning */
518 519 520
	 && !(p[-1] == ':'
	      /* handle the "/:d:foo" case correctly  */
	      && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
521
#endif
522 523
	 )
    p--;
Jim Blandy's avatar
Jim Blandy committed
524

525
  return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
526
}
527

528 529
DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
       Sunhandled_file_name_directory, 1, 1, 0,
530 531 532 533 534 535 536 537 538
       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;
539 540 541 542 543
{
  Lisp_Object handler;

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
544
  handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
545 546 547 548 549 550
  if (!NILP (handler))
    return call2 (handler, Qunhandled_file_name_directory, filename);

  return Ffile_name_directory (filename);
}

Jim Blandy's avatar
Jim Blandy committed
551 552 553 554 555 556 557 558 559

char *
file_name_as_directory (out, in)
     char *out, *in;
{
  int size = strlen (in) - 1;

  strcpy (out, in);

560 561
  if (size < 0)
    {
562 563 564
      out[0] = '.';
      out[1] = '/';
      out[2] = 0;
565 566 567
      return out;
    }

Jim Blandy's avatar
Jim Blandy committed
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
#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
610 611
      dot = index (p, '.');
      if (dot)
Jim Blandy's avatar
Jim Blandy committed
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
	{
	  /* 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 */
627
  if (!IS_DIRECTORY_SEP (out[size]))
628
    {
629 630
      /* Cannot use DIRECTORY_SEP, which could have any value */
      out[size + 1] = '/';
631 632
      out[size + 2] = '\0';
    }
633 634 635
#ifdef DOS_NT
  CORRECT_DIR_SEPS (out);
#endif
Jim Blandy's avatar
Jim Blandy committed
636 637 638 639 640 641
#endif /* not VMS */
  return out;
}

DEFUN ("file-name-as-directory", Ffile_name_as_directory,
       Sfile_name_as_directory, 1, 1, 0,
642
       doc: /* Return a string representing the file name FILE interpreted as a directory.
643 644 645 646 647 648 649
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
650 651 652
     Lisp_Object file;
{
  char *buf;
653
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
654

655
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
656
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
657
    return Qnil;
658 659 660

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
661
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
662 663 664
  if (!NILP (handler))
    return call2 (handler, Qfile_name_as_directory, file);

665
  buf = (char *) alloca (SBYTES (file) + 10);
666 667 668
  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
669 670 671 672 673 674 675
}

/*
 * Convert from directory name to filename.
 * On VMS:
 *       xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
 *       xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
676
 * On UNIX, it's simple: just make sure there isn't a terminating /
Jim Blandy's avatar
Jim Blandy committed
677 678 679 680

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

Andreas Schwab's avatar
Andreas Schwab committed
681
int
Jim Blandy's avatar
Jim Blandy committed
682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
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. */
713
      if (SYS$PARSE (&fab, 0, 0) == RMS$_NORMAL)
Jim Blandy's avatar
Jim Blandy committed
714 715 716 717 718 719 720 721 722 723 724
	{
	  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] == ':')
725
	    {                   /* Xlate logical name and see what we get */
Jim Blandy's avatar
Jim Blandy committed
726 727 728 729 730 731 732
	      ptr = strcpy (dst, src); /* upper case for getenv */
	      while (*ptr)
		{
		  if ('a' <= *ptr && *ptr <= 'z')
		    *ptr -= 040;
		  ptr++;
		}
733
	      dst[slen - 1] = 0;        /* remove colon */
Jim Blandy's avatar
Jim Blandy committed
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
	      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
751
	    {           /* not a directory spec */
Jim Blandy's avatar
Jim Blandy committed
752 753 754 755 756 757 758 759
	      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
760 761
      ptr = index (src, bracket - 2);
      if (ptr == 0)
Jim Blandy's avatar
Jim Blandy committed
762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
	{ /* 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] == ':'
781
	      && dst[slen - 2] != ':'   /* skip decnet nodes */
782
	      && strcmp (src + slen, "[000000]") == 0)
Jim Blandy's avatar
Jim Blandy committed
783 784 785 786 787 788 789
	    {
	      dst[slen - 1] = '\0';
	      if ((ptr = egetenv (dst))
		  && (rlen = strlen (ptr) - 1) > 0
		  && (ptr[rlen] == ']' || ptr[rlen] == '>')
		  && ptr[rlen - 1] == '.')
		{
790 791 792 793 794
		  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
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
		}
	      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);
813
  if (slen > 1
814
      && IS_DIRECTORY_SEP (dst[slen - 1])
815 816 817 818
#ifdef DOS_NT
      && !IS_ANY_SEP (dst[slen - 2])
#endif
      )
Jim Blandy's avatar
Jim Blandy committed
819
    dst[slen - 1] = 0;
820 821
#ifdef DOS_NT
  CORRECT_DIR_SEPS (dst);
822
#endif
Jim Blandy's avatar
Jim Blandy committed
823 824 825 826
  return 1;
}

DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
827 828 829 830 831 832 833 834 835
       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
836 837 838
     Lisp_Object directory;
{
  char *buf;
839
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
840

841
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
842

Jim Blandy's avatar
Jim Blandy committed
843
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
844
    return Qnil;
845 846 847

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
848
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
849 850 851
  if (!NILP (handler))
    return call2 (handler, Qdirectory_file_name, directory);

Jim Blandy's avatar
Jim Blandy committed
852 853 854 855
#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 */
856
  buf = (char *) alloca (SBYTES (directory) + 20 + 255);
Jim Blandy's avatar
Jim Blandy committed
857
#else
858
  buf = (char *) alloca (SBYTES (directory) + 20);
Jim Blandy's avatar
Jim Blandy committed
859
#endif
860
  directory_file_name (SDATA (directory), buf);
861 862
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (directory));
Jim Blandy's avatar
Jim Blandy committed
863 864
}

865 866 867 868 869 870 871 872 873 874 875
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','-','_'
};
876

877 878
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

879
/* Value is a temporary file name starting with PREFIX, a string.
880

881 882 883 884 885
   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.
886

887 888 889 890 891 892 893 894 895 896
   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
897
     Lisp_Object prefix;
898
     int base64_p;
Jim Blandy's avatar
Jim Blandy committed
899 900
{
  Lisp_Object val;
901
  int len, clen;
902 903 904 905
  int pid;
  unsigned char *p, *data;
  char pidbuf[20];
  int pidlen;
906

907
  CHECK_STRING (prefix);
908 909 910 911 912 913 914 915

  /* 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 ();

916 917 918 919 920 921 922 923 924
  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
    {
925
#ifdef HAVE_LONG_FILE_NAMES
926 927
      sprintf (pidbuf, "%d", pid);
      pidlen = strlen (pidbuf);
928
#else
929 930 931 932
      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;
933
#endif
934
    }
935

936 937 938 939
  len = SBYTES (prefix); clen = SCHARS (prefix);
  val = make_uninit_multibyte_string (clen + 3 + pidlen, len + 3 + pidlen);
  if (!STRING_MULTIBYTE (prefix))
    STRING_SET_UNIBYTE (val);
940 941
  data = SDATA (val);
  bcopy(SDATA (prefix), data, len);
942 943 944 945 946 947 948 949
  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
950 951 952 953 954 955
     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.  */

956 957 958 959 960 961 962 963 964
  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;
965
      unsigned num = make_temp_name_count;
966 967 968 969 970

      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;

971 972 973 974 975
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

976 977 978 979 980 981 982 983 984 985
      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
986 987 988
	       in looping through 225307 stat's, which is not only
	       dog-slow, but also useless since it will fallback to
	       the errow below, anyway.  */
989
	    report_file_error ("Cannot create temporary name for prefix",
990 991 992 993 994 995
			       Fcons (prefix, Qnil));
	  /* not reached */
	}
    }

  error ("Cannot create temporary name for prefix `%s'",
996
	 SDATA (prefix));
997
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
998
}
999

1000 1001

DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
       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
1012 1013 1014 1015 1016
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.  */)
1017
     (prefix)
1018 1019 1020 1021 1022 1023
     Lisp_Object prefix;
{
  return make_temp_name (prefix, 0);
}


Jim Blandy's avatar
Jim Blandy committed
1024 1025

DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1026 1027
       doc: /* Convert filename NAME to absolute, and canonicalize it.
Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1028
\(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
1029
the current buffer's value of `default-directory' is used.
1030 1031 1032 1033 1034 1035 1036 1037
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)
1038
     Lisp_Object name, default_directory;
Jim Blandy's avatar
Jim Blandy committed
1039 1040
{
  unsigned char *nm;
1041

Jim Blandy's avatar
Jim Blandy committed
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
  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 */
1054
#ifdef DOS_NT
1055
  int drive = 0;
1056
  int collapse_newdir = 1;
1057
  int is_escaped = 0;
1058
#endif /* DOS_NT */
1059
  int length;
1060
  Lisp_Object handler, result;
1061
  int multibyte;
1062

1063
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
1064

1065 1066
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
1067
  handler = Ffind_file_name_handler (name, Qexpand_file_name);
1068
  if (!NILP (handler))
1069
    return call3 (handler, Qexpand_file_name, name, default_directory);
1070

1071 1072 1073
  /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted.  */
  if (NILP (default_directory))
    default_directory = current_buffer->directory;
1074
  if (! STRINGP (default_directory))
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
    {
#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
    }
1092

1093
  if (!NILP (default_directory))
1094
    {
1095
      handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
1096
      if (!NILP (handler))
1097
	return call3 (handler, Qexpand_file_name, name, default_directory);
1098
    }
1099

1100
  o = SDATA (default_directory);
1101

1102
  /* Make sure DEFAULT_DIRECTORY is properly expanded.
1103
     It would be better to do this down below where we actually use
1104
     default_directory.  Unfortunately, calling Fexpand_file_name recursively
1105 1106 1107 1108
     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.
1109 1110 1111
     Putting this call here avoids all that crud.

     The EQ test avoids infinite recursion.  */
1112
  if (! NILP (default_directory) && !EQ (default_directory, name)
1113 1114 1115
      /* 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.  */
1116
#ifdef DOS_NT
1117
      /* Detect MSDOS file names with drive specifiers.  */
1118
      && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1]) && IS_DIRECTORY_SEP (o[2]))
1119 1120 1121
#ifdef WINDOWSNT
      /* Detect Windows file names in UNC format.  */
      && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
1122
#endif
1123 1124 1125 1126 1127 1128
#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 */
      )
1129 1130 1131 1132
    {
      struct gcpro gcpro1;

      GCPRO1 (name);
1133
      default_directory = Fexpand_file_name (default_directory, Qnil);
1134 1135 1136
      UNGCPRO;
    }

1137
  name = FILE_SYSTEM_CASE (name);