fileio.c 199 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 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>
Jim Blandy's avatar
Jim Blandy committed
24

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

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

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

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

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

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

49
#ifdef HAVE_PWD_H
Jim Blandy's avatar
Jim Blandy committed
50
#include <pwd.h>
Jim Blandy's avatar
Jim Blandy committed
51 52
#endif

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

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

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

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

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
126
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
127 128 129

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

137 138
#include "commands.h"
extern int use_dialog_box;
Kenichi Handa's avatar
Kenichi Handa committed
139
extern int use_file_dialog;
140

Jim Blandy's avatar
Jim Blandy committed
141 142 143 144
#ifndef O_WRONLY
#define O_WRONLY 1
#endif

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

149 150 151 152
#ifndef S_ISLNK
#  define lstat stat
#endif

153 154 155 156
#ifndef FILE_SYSTEM_CASE
#define FILE_SYSTEM_CASE(filename)  (filename)
#endif

Jim Blandy's avatar
Jim Blandy committed
157 158 159 160 161 162 163
/* 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;

164 165 166 167 168 169 170
/* 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;

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

174 175 176 177
/* Coding system for file names used only when
   Vfile_name_coding_system is nil.  */
Lisp_Object Vdefault_file_name_coding_system;

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

182 183 184 185
/* Property name of a file name handler,
   which gives a list of operations it handles..  */
Lisp_Object Qoperations;

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

189
/* Function to be called to decide a coding system of a reading file.  */
190
Lisp_Object Vset_auto_coding_function;
191

192 193 194
/* Functions to be called to process text properties in inserted file.  */
Lisp_Object Vafter_insert_file_functions;

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

199 200
/* Functions to be called to create text property annotations for file.  */
Lisp_Object Vwrite_region_annotate_functions;
201
Lisp_Object Qwrite_region_annotate_functions;
202

203 204 205 206
/* 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;

207 208 209
/* File name in which we write a list of all our auto save files.  */
Lisp_Object Vauto_save_list_file_name;

210
/* Function to call to read a file name.  */
211
Lisp_Object Vread_file_name_function;
212 213 214 215

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

216 217 218
/* Nonzero means completion ignores case when reading file name.  */
int read_file_name_completion_ignore_case;

Jim Blandy's avatar
Jim Blandy committed
219 220 221 222 223 224 225 226
/* 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;

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

231 232 233 234 235
#ifdef HAVE_FSYNC
/* Nonzero means skip the call to fsync in Fwrite-region.  */
int write_region_inhibit_fsync;
#endif

236 237
extern Lisp_Object Vuser_login_name;

238 239 240 241
#ifdef WINDOWSNT
extern Lisp_Object Vw32_get_true_file_attributes;
#endif

242 243
extern int minibuf_level;

244 245
extern int minibuffer_auto_raise;

246 247
extern int history_delete_duplicates;

248 249 250 251 252 253 254
/* 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.  */

255
static Lisp_Object Vinhibit_file_name_handlers;
256
static Lisp_Object Vinhibit_file_name_operation;
257

258
Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
259
Lisp_Object Qexcl;
260 261
Lisp_Object Qfile_name_history;

262 263
Lisp_Object Qcar_less_than_car;

264
static int a_write P_ ((int, Lisp_Object, int, int,
265
			Lisp_Object *, struct coding_system *));
266 267
static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));

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

278
  synchronize_system_messages_locale ();
279 280 281
  str = strerror (errorno);
  errstring = code_convert_string_norecord (make_unibyte_string (str,
								 strlen (str)),
282 283
					    Vlocale_coding_system, 0);

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

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

301
Lisp_Object
302 303 304
close_file_unwind (fd)
     Lisp_Object fd;
{
305
  emacs_close (XFASTINT (fd));
306
  return Qnil;
307
}
308 309 310

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

311
static Lisp_Object
312
restore_point_unwind (location)
313
     Lisp_Object location;
314
{
315
  Fgoto_char (location);
316
  Fset_marker (location, Qnil, Qnil);
317
  return Qnil;
318
}
319

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

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

371
  result = Qnil;
372
  CHECK_STRING (filename);
373

374 375 376 377
  if (EQ (operation, Vinhibit_file_name_operation))
    inhibited_handlers = Vinhibit_file_name_handlers;
  else
    inhibited_handlers = Qnil;
378

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

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

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

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

      QUIT;
411
    }
412
  return result;
413 414
}

Jim Blandy's avatar
Jim Blandy committed
415
DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
416 417 418 419 420 421 422
       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)
423
     Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
424
{
425
#ifndef DOS_NT
426
  register const unsigned char *beg;
427 428 429
#else
  register unsigned char *beg;
#endif
430
  register const unsigned char *p;
431
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
432

433
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
434

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

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

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

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

489
  return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
490 491
}

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

504
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
505

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

512 513
  beg = SDATA (filename);
  end = p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
514

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

528
  return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
529
}
530

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

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

  return Ffile_name_directory (filename);
}

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

  strcpy (out, in);

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

Jim Blandy's avatar
Jim Blandy committed
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 610 611 612
#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
613 614
      dot = index (p, '.');
      if (dot)
Jim Blandy's avatar
Jim Blandy committed
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
	{
	  /* 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 */
630
  if (!IS_DIRECTORY_SEP (out[size]))
631
    {
632 633
      /* Cannot use DIRECTORY_SEP, which could have any value */
      out[size + 1] = '/';
634 635
      out[size + 2] = '\0';
    }
636 637 638
#ifdef DOS_NT
  CORRECT_DIR_SEPS (out);
#endif
Jim Blandy's avatar
Jim Blandy committed
639 640 641 642 643 644
#endif /* not VMS */
  return out;
}

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

658
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
659
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
660
    return Qnil;
661 662 663

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

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

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

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

DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
837 838 839 840 841 842 843 844 845
       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
846 847 848
     Lisp_Object directory;
{
  char *buf;
849
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
850

851
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
852

Jim Blandy's avatar
Jim Blandy committed
853
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
854
    return Qnil;
855 856 857

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
858
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
859 860 861
  if (!NILP (handler))
    return call2 (handler, Qdirectory_file_name, directory);

Jim Blandy's avatar
Jim Blandy committed
862 863 864 865
#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 */
866
  buf = (char *) alloca (SBYTES (directory) + 20 + 255);
Jim Blandy's avatar
Jim Blandy committed
867
#else
868
  buf = (char *) alloca (SBYTES (directory) + 20);
Jim Blandy's avatar
Jim Blandy committed
869
#endif
870
  directory_file_name (SDATA (directory), buf);
871 872
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (directory));
Jim Blandy's avatar
Jim Blandy committed
873 874
}

875 876 877 878 879 880 881 882 883 884 885
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','-','_'
};
886

887 888
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

889
/* Value is a temporary file name starting with PREFIX, a string.
890

891 892 893 894 895
   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.
896

897 898 899 900 901 902 903 904 905 906
   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
907
     Lisp_Object prefix;
908
     int base64_p;
Jim Blandy's avatar
Jim Blandy committed
909 910
{
  Lisp_Object val;
911
  int len, clen;
912 913 914 915
  int pid;
  unsigned char *p, *data;
  char pidbuf[20];
  int pidlen;
916

917
  CHECK_STRING (prefix);
918 919 920 921 922 923 924 925

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

926 927 928 929 930 931 932 933 934
  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
    {
935
#ifdef HAVE_LONG_FILE_NAMES
936 937
      sprintf (pidbuf, "%d", pid);
      pidlen = strlen (pidbuf);
938
#else
939 940 941 942
      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;
943
#endif
944
    }
945

946 947 948 949
  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);
950 951
  data = SDATA (val);
  bcopy(SDATA (prefix), data, len);
952 953 954 955 956 957 958 959
  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
960 961 962 963 964 965
     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.  */

966 967 968 969 970 971 972 973 974
  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;
975
      unsigned num = make_temp_name_count;
976 977 978 979 980

      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;

981 982 983 984 985
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

986 987 988 989 990 991 992 993 994 995
      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
996 997 998
	       in looping through 225307 stat's, which is not only
	       dog-slow, but also useless since it will fallback to
	       the errow below, anyway.  */
999
	    report_file_error ("Cannot create temporary name for prefix",
1000 1001 1002 1003 1004 1005
			       Fcons (prefix, Qnil));
	  /* not reached */
	}
    }

  error ("Cannot create temporary name for prefix `%s'",
1006
	 SDATA (prefix));
1007
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
1008
}
1009

1010 1011

DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
       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
1022 1023 1024 1025 1026
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.  */)
1027
     (prefix)
1028 1029 1030 1031 1032 1033
     Lisp_Object prefix;
{
  return make_temp_name (prefix, 0);
}


Jim Blandy's avatar
Jim Blandy committed
1034 1035

DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1036 1037
       doc: /* Convert filename NAME to absolute, and canonicalize it.
Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1038
\(does not start with slash); if DEFAULT-DIRECTORY is nil or missing,
1039
the current buffer's value of `default-directory' is used.
1040 1041 1042 1043 1044 1045 1046 1047
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)
1048
     Lisp_Object name, default_directory;
Jim Blandy's avatar
Jim Blandy committed
1049 1050
{
  unsigned char *nm;
1051

Jim Blandy's avatar
Jim Blandy committed
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
  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 */
1064
#ifdef DOS_NT
1065
  int drive = 0;
1066
  int collapse_newdir = 1;
1067
  int is_escaped = 0;
1068
#endif /* DOS_NT */
1069
  int length;
1070
  Lisp_Object handler, result;
1071
  int multibyte;
1072

1073
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
1074

1075 1076
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
1077
  handler = Ffind_file_name_handler (name, Qexpand_file_name);
1078
  if (!NILP (handler))
1079
    return call3 (handler, Qexpand_file_name, name, default_directory);
1080

1081 1082 1083
  /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted.  */
  if (NILP (default_directory))
    default_directory = current_buffer->directory;
1084
  if (! STRINGP (default_directory))
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
    {
#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
    }
1102

1103
  if (!NILP (default_directory))
1104
    {
1105
      handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
1106
      if (!NILP (handler))
1107
	return call3 (handler, Qexpand_file_name, name, default_directory);
1108
    }
1109

1110
  o = SDATA (default_directory);
1111

1112
  /* Make sure DEFAULT_DIRECTORY is properly expanded.
1113
     It would be better to do this down below where we actually use
1114
     default_directory.  Unfortunately, calling Fexpand_file_name recursively
1115 1116 1117 1118
     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.
1119 1120 1121
     Putting this call here avoids all that crud.

     The EQ test avoids infinite recursion.  */
1122
  if (! NILP (default_directory) && !EQ (default_directory, name)
1123 1124 1125
      /* 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.  */
1126
#ifdef DOS_NT
1127
      /* Detect MSDOS file names with drive specifiers.  */
1128
      && ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1]) && IS_DIRECTORY_SEP (o[2]))
1129 1130 1131
#ifdef WINDOWSNT
      /* Detect Windows file names in UNC format.  */
      && ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
1132
#endif
1133 1134 1135 1136 1137 1138
#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 */
      )
1139 1140 1141 1142
    {
      struct gcpro gcpro1;

      GCPRO1 (name);
1143
      default_directory = Fexpand_file_name (default_directory, Qnil);
1144 1145 1146
      UNGCPRO;
    }