fileio.c 187 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

This file is part of GNU Emacs.

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

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

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

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

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

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

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

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
63
#ifndef vax11c
64
#ifndef USE_CRT_DLL
Jim Blandy's avatar
Jim Blandy committed
65 66
extern int errno;
#endif
67
#endif
Jim Blandy's avatar
Jim Blandy committed
68 69

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
121
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
122 123 124

#ifdef HPUX
#include <netio.h>
125
#endif
Jim Blandy's avatar
Jim Blandy committed
126

127 128
#include "commands.h"
extern int use_dialog_box;
Kenichi Handa's avatar
Kenichi Handa committed
129
extern int use_file_dialog;
130

Jim Blandy's avatar
Jim Blandy committed
131 132 133 134
#ifndef O_WRONLY
#define O_WRONLY 1
#endif

Richard M. Stallman's avatar
Richard M. Stallman committed
135 136 137 138
#ifndef O_RDONLY
#define O_RDONLY 0
#endif

139 140 141 142
#ifndef S_ISLNK
#  define lstat stat
#endif

143 144 145 146
#ifndef FILE_SYSTEM_CASE
#define FILE_SYSTEM_CASE(filename)  (filename)
#endif

Jim Blandy's avatar
Jim Blandy committed
147 148 149 150 151 152 153
/* 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;

154 155 156
/* Set by auto_save_1 if an error occurred during the last auto-save. */
int auto_save_error_occurred;

157 158 159 160 161 162 163
/* 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;

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

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

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

175 176 177 178
/* Property name of a file name handler,
   which gives a list of operations it handles..  */
Lisp_Object Qoperations;

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

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
203 204 205 206
/* 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 215
#ifdef HAVE_FSYNC
/* Nonzero means skip the call to fsync in Fwrite-region.  */
int write_region_inhibit_fsync;
#endif

216 217
extern Lisp_Object Vuser_login_name;

218 219 220 221
#ifdef WINDOWSNT
extern Lisp_Object Vw32_get_true_file_attributes;
#endif

222 223
extern int minibuf_level;

224 225
extern int minibuffer_auto_raise;

226 227
extern int history_delete_duplicates;

228 229 230 231 232 233 234
/* 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.  */

235
static Lisp_Object Vinhibit_file_name_handlers;
236
static Lisp_Object Vinhibit_file_name_operation;
237

238
Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
239
Lisp_Object Qexcl;
240 241
Lisp_Object Qfile_name_history;

242 243
Lisp_Object Qcar_less_than_car;

244
static int a_write P_ ((int, Lisp_Object, int, int,
245
			Lisp_Object *, struct coding_system *));
246 247
static int e_write P_ ((int, Lisp_Object, int, int, struct coding_system *));

248

249
void
Jim Blandy's avatar
Jim Blandy committed
250
report_file_error (string, data)
251
     const char *string;
Jim Blandy's avatar
Jim Blandy committed
252 253 254
     Lisp_Object data;
{
  Lisp_Object errstring;
Richard M. Stallman's avatar
Richard M. Stallman committed
255
  int errorno = errno;
256
  char *str;
Jim Blandy's avatar
Jim Blandy committed
257

258
  synchronize_system_messages_locale ();
259 260 261
  str = strerror (errorno);
  errstring = code_convert_string_norecord (make_unibyte_string (str,
								 strlen (str)),
262 263
					    Vlocale_coding_system, 0);

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

276
	xsignal (Qfile_error,
Richard M. Stallman's avatar
Richard M. Stallman committed
277 278
		 Fcons (build_string (string), Fcons (errstring, data)));
      }
Jim Blandy's avatar
Jim Blandy committed
279
}
280

281
Lisp_Object
282 283 284
close_file_unwind (fd)
     Lisp_Object fd;
{
285
  emacs_close (XFASTINT (fd));
286
  return Qnil;
287
}
288 289 290

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

291
static Lisp_Object
292
restore_point_unwind (location)
293
     Lisp_Object location;
294
{
295
  Fgoto_char (location);
296
  Fset_marker (location, Qnil, Qnil);
297
  return Qnil;
298
}
299

Jim Blandy's avatar
Jim Blandy committed
300

301
Lisp_Object Qexpand_file_name;
302
Lisp_Object Qsubstitute_in_file_name;
303 304 305
Lisp_Object Qdirectory_file_name;
Lisp_Object Qfile_name_directory;
Lisp_Object Qfile_name_nondirectory;
306
Lisp_Object Qunhandled_file_name_directory;
307
Lisp_Object Qfile_name_as_directory;
308
Lisp_Object Qcopy_file;
309
Lisp_Object Qmake_directory_internal;
310
Lisp_Object Qmake_directory;
311 312 313 314 315 316 317 318 319
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;
320 321
Lisp_Object Qfile_symlink_p;
Lisp_Object Qaccess_file;
322
Lisp_Object Qfile_directory_p;
323
Lisp_Object Qfile_regular_p;
324 325 326
Lisp_Object Qfile_accessible_directory_p;
Lisp_Object Qfile_modes;
Lisp_Object Qset_file_modes;
327
Lisp_Object Qset_file_times;
328 329 330 331
Lisp_Object Qfile_newer_than_file_p;
Lisp_Object Qinsert_file_contents;
Lisp_Object Qwrite_region;
Lisp_Object Qverify_visited_file_modtime;
332
Lisp_Object Qset_visited_file_modtime;
333

334
DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
335 336 337 338 339 340 341 342 343 344 345
       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;
346
{
347
  /* This function must not munge the match data.  */
348
  Lisp_Object chain, inhibited_handlers, result;
349
  int pos = -1;
350

351
  result = Qnil;
352
  CHECK_STRING (filename);
353

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

359
  for (chain = Vfile_name_handler_alist; CONSP (chain);
360
       chain = XCDR (chain))
361 362
    {
      Lisp_Object elt;
363
      elt = XCAR (chain);
364
      if (CONSP (elt))
365
	{
366
	  Lisp_Object string = XCAR (elt);
367
	  int match_pos;
368
	  Lisp_Object handler = XCDR (elt);
369 370 371 372
	  Lisp_Object operations = Qnil;

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

374
	  if (STRINGP (string)
375 376
	      && (match_pos = fast_string_match (string, filename)) > pos
	      && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
377
	    {
378
	      Lisp_Object tem;
379

380
	      handler = XCDR (elt);
381 382
	      tem = Fmemq (handler, inhibited_handlers);
	      if (NILP (tem))
383 384 385 386
		{
		  result = handler;
		  pos = match_pos;
		}
387
	    }
388
	}
389 390

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

413
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
414

415 416
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
417
  handler = Ffind_file_name_handler (filename, Qfile_name_directory);
418
  if (!NILP (handler))
419
    return call2 (handler, Qfile_name_directory, filename);
420

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

428
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
Jim Blandy's avatar
Jim Blandy committed
429 430 431
#ifdef VMS
	 && p[-1] != ':' && p[-1] != ']' && p[-1] != '>'
#endif /* VMS */
432
#ifdef DOS_NT
433 434 435 436 437
	 /* 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))))
438
#endif
Jim Blandy's avatar
Jim Blandy committed
439 440 441 442
	 ) p--;

  if (p == beg)
    return Qnil;
443
#ifdef DOS_NT
444
  /* Expansion of "c:" to drive and default directory.  */
445
  if (p[-1] == ':')
446 447
    {
      /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir.  */
448
      unsigned char *res = alloca (MAXPATHLEN + 1);
449 450 451 452 453 454 455 456 457 458
      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))
459
	{
460
	  if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
461 462 463 464 465
	    strcat (res, "/");
	  beg = res;
	  p = beg + strlen (beg);
	}
    }
466
  CORRECT_DIR_SEPS (beg);
467
#endif /* DOS_NT */
468

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

472 473
DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
       Sfile_name_nondirectory, 1, 1, 0,
474 475 476 477 478
       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)
479
     Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
480
{
481
  register const unsigned char *beg, *p, *end;
482
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
483

484
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
485

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

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

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

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

511 512
DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
       Sunhandled_file_name_directory, 1, 1, 0,
513 514 515 516 517
       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).
Stefan Monnier's avatar
Stefan Monnier committed
518 519
If FILENAME refers to a file which is not accessible from a local process,
then this should return nil.
520 521 522 523
The `call-process' and `start-process' functions use this function to
get a current directory to run processes in.  */)
     (filename)
     Lisp_Object filename;
524 525 526 527 528
{
  Lisp_Object handler;

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
529
  handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
530 531 532 533 534 535
  if (!NILP (handler))
    return call2 (handler, Qunhandled_file_name_directory, filename);

  return Ffile_name_directory (filename);
}

Jim Blandy's avatar
Jim Blandy committed
536 537 538 539 540 541 542 543 544

char *
file_name_as_directory (out, in)
     char *out, *in;
{
  int size = strlen (in) - 1;

  strcpy (out, in);

545 546
  if (size < 0)
    {
547 548 549
      out[0] = '.';
      out[1] = '/';
      out[2] = 0;
550 551 552
      return out;
    }

Jim Blandy's avatar
Jim Blandy committed
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
#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
595 596
      dot = index (p, '.');
      if (dot)
Jim Blandy's avatar
Jim Blandy committed
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
	{
	  /* 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 */
612
  if (!IS_DIRECTORY_SEP (out[size]))
613
    {
614 615
      /* Cannot use DIRECTORY_SEP, which could have any value */
      out[size + 1] = '/';
616 617
      out[size + 2] = '\0';
    }
618 619 620
#ifdef DOS_NT
  CORRECT_DIR_SEPS (out);
#endif
Jim Blandy's avatar
Jim Blandy committed
621 622 623 624 625 626
#endif /* not VMS */
  return out;
}

DEFUN ("file-name-as-directory", Ffile_name_as_directory,
       Sfile_name_as_directory, 1, 1, 0,
627
       doc: /* Return a string representing the file name FILE interpreted as a directory.
628 629 630 631 632 633 634
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
635 636 637
     Lisp_Object file;
{
  char *buf;
638
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
639

640
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
641
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
642
    return Qnil;
643 644 645

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
646
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
647 648 649
  if (!NILP (handler))
    return call2 (handler, Qfile_name_as_directory, file);

650
  buf = (char *) alloca (SBYTES (file) + 10);
651 652 653
  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
654 655 656 657 658 659 660
}

/*
 * Convert from directory name to filename.
 * On VMS:
 *       xyzzy:[mukesh.emacs] => xyzzy:[mukesh]emacs.dir.1
 *       xyzzy:[mukesh] => xyzzy:[000000]mukesh.dir.1
661
 * On UNIX, it's simple: just make sure there isn't a terminating /
Jim Blandy's avatar
Jim Blandy committed
662 663 664 665

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

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

DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
812 813 814 815 816 817 818 819 820
       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
821 822 823
     Lisp_Object directory;
{
  char *buf;
824
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
825

826
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
827

Jim Blandy's avatar
Jim Blandy committed
828
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
829
    return Qnil;
830 831 832

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

Jim Blandy's avatar
Jim Blandy committed
837 838 839 840
#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 */
841
  buf = (char *) alloca (SBYTES (directory) + 20 + 255);
Jim Blandy's avatar
Jim Blandy committed
842
#else
843
  buf = (char *) alloca (SBYTES (directory) + 20);
Jim Blandy's avatar
Jim Blandy committed
844
#endif
845
  directory_file_name (SDATA (directory), buf);
846 847
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (directory));
Jim Blandy's avatar
Jim Blandy committed
848 849
}

850 851 852 853 854 855 856 857 858 859 860
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','-','_'
};
861

862 863
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

864
/* Value is a temporary file name starting with PREFIX, a string.
865

866 867 868 869 870
   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.
871

872 873 874 875 876 877 878 879 880 881
   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
882
     Lisp_Object prefix;
883
     int base64_p;
Jim Blandy's avatar
Jim Blandy committed
884 885
{
  Lisp_Object val;
886
  int len, clen;
887 888 889 890
  int pid;
  unsigned char *p, *data;
  char pidbuf[20];
  int pidlen;
891

892
  CHECK_STRING (prefix);
893 894 895 896 897 898 899 900

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

901 902 903 904 905 906 907 908 909
  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
    {
910
#ifdef HAVE_LONG_FILE_NAMES
911 912
      sprintf (pidbuf, "%d", pid);
      pidlen = strlen (pidbuf);
913
#else
914 915 916 917
      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;
918
#endif
919
    }
920

921 922 923 924
  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);
925 926
  data = SDATA (val);
  bcopy(SDATA (prefix), data, len);
927 928 929 930 931 932 933 934
  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
935 936 937 938 939 940
     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.  */

941 942 943 944 945 946 947 948 949
  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;
950
      unsigned num = make_temp_name_count;
951 952 953 954 955

      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;

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

961 962 963 964 965 966 967 968 969 970
      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
971 972 973
	       in looping through 225307 stat's, which is not only
	       dog-slow, but also useless since it will fallback to
	       the errow below, anyway.  */
974
	    report_file_error ("Cannot create temporary name for prefix",
975 976 977 978 979 980
			       Fcons (prefix, Qnil));
	  /* not reached */
	}
    }

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

985 986

DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
987 988 989 990 991 992 993 994 995 996
       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
997 998 999 1000 1001
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.  */)
1002
     (prefix)
1003 1004 1005 1006 1007 1008
     Lisp_Object prefix;
{
  return make_temp_name (prefix, 0);
}


Jim Blandy's avatar
Jim Blandy committed
1009 1010

DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
1011 1012
       doc: /* Convert filename NAME to absolute, and canonicalize it.
Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
1013
\(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
1014
the current buffer's value of `default-directory' is used.
1015 1016 1017 1018 1019 1020 1021 1022
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)
1023
     Lisp_Object name, default_directory;
Jim Blandy's avatar
Jim Blandy committed
1024
{
1025 1026 1027
  /* These point to SDATA and need to be careful with string-relocation
     during GC (via DECODE_FILE).  */
  unsigned char *nm, *newdir;
1028
  int nm_in_name;
1029 1030
  /* This should only point to alloca'd data.  */
  unsigned char *target;
1031

Jim Blandy's avatar
Jim Blandy committed
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
  int tlen;
  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 */
1042
#ifdef DOS_NT
1043
  int drive = 0;
1044
  int collapse_newdir = 1;
1045
  int is_escaped = 0;
1046
#endif /* DOS_NT */
1047
  int length;
1048
  Lisp_Object handler, result;
1049
  int multibyte;
1050
  Lisp_Object hdir;
1051

1052
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
1053

1054 1055
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
1056
  handler = Ffind_file_name_handler (name, Qexpand_file_name);
1057
  if (!NILP (handler))
1058
    return call3 (handler, Qexpand_file_name, name, default_directory);
1059

1060 1061 1062
  /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted.  */
  if (NILP (default_directory))
    default_directory = current_buffer->directory;
1063
  if (! STRINGP (default_directory))
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
    {
#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
    }
1081

1082
  if (!NILP (default_directory))
1083
    {
1084
      handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
1085
      if (!NILP (handler))
1086
	return call3 (handler, Qexpand_file_name, name, default_directory);
1087
    }
1088

1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
  {
    unsigned char *o = SDATA (default_directory);

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

       The EQ test avoids infinite recursion.  */
    if (! NILP (default_directory) && !EQ (default_directory, name)
	/* 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.  */
1106
#ifdef DOS_NT
1107 1108 1109
	/* Detect MSDOS file names with drive specifiers.  */
	&& ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1])
	      && IS_DIRECTORY_SEP (o[2]))
1110
#ifdef WINDOWSNT
1111 1112
	/* Detect Windows file names in UNC format.  */
	&& ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
1113
#endif
1114 1115 1116
#else /* not DOS_NT */
      /* Detect Unix absolute file names (/... alone is not absolute on
	 DOS or Windows).  */
1117
	&& ! (IS_DIRECTORY_SEP (o[0]))
1118
#endif /* not DOS_NT */
1119 1120 1121
	)
      {
	struct gcpro gcpro1;
1122

1123 1124 1125 1126 1127
	GCPRO1 (name);
	default_directory = Fexpand_file_name (default_directory, Qnil);
	UNGCPRO;
      }
  }
1128
  name = FILE_SYSTEM_CASE (name);
1129
  multibyte = STRING_MULTIBYTE (name);
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
  if (multibyte != STRING_MULTIBYTE (default_directory))
    {
      if (multibyte)
	default_directory = string_to_multibyte (default_directory);
      else
	{
	  name = string_to_multibyte (name);
	  multibyte = 1;
	}
    }

  nm = SDATA (name);
1142
  nm_in_name = 1;