fileio.c 174 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,
4
                 2005, 2006, 2007, 2008, 2009, 2010 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>
31
#include <setjmp.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 54 55
#include <ctype.h>
#include <errno.h>

Jim Blandy's avatar
Jim Blandy committed
56
#ifndef vax11c
57
#ifndef USE_CRT_DLL
Jim Blandy's avatar
Jim Blandy committed
58 59
extern int errno;
#endif
60
#endif
Jim Blandy's avatar
Jim Blandy committed
61 62

#include "lisp.h"
63
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
64
#include "buffer.h"
65
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
66
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
67
#include "window.h"
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
68
#include "blockinput.h"
Karoly Lorentey's avatar
Karoly Lorentey committed
69 70
#include "frame.h"
#include "dispextern.h"
Jim Blandy's avatar
Jim Blandy committed
71

72 73 74 75 76 77 78
#ifdef WINDOWSNT
#define NOMINMAX 1
#include <windows.h>
#include <stdlib.h>
#include <fcntl.h>
#endif /* not WINDOWSNT */

Eli Zaretskii's avatar
Eli Zaretskii committed
79 80 81 82 83 84 85 86 87
#ifdef MSDOS
#include "msdos.h"
#include <sys/param.h>
#if __DJGPP__ >= 2
#include <fcntl.h>
#include <string.h>
#endif
#endif

88 89 90 91 92 93 94 95 96 97 98 99 100
#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
101 102 103 104
/* 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))
105 106
#endif

Jim Blandy's avatar
Jim Blandy committed
107
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
108 109 110

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

113 114
#include "commands.h"
extern int use_dialog_box;
Kenichi Handa's avatar
Kenichi Handa committed
115
extern int use_file_dialog;
116

Jim Blandy's avatar
Jim Blandy committed
117 118 119 120
#ifndef O_WRONLY
#define O_WRONLY 1
#endif

Richard M. Stallman's avatar
Richard M. Stallman committed
121 122 123 124
#ifndef O_RDONLY
#define O_RDONLY 0
#endif

125 126 127 128
#ifndef S_ISLNK
#  define lstat stat
#endif

129 130 131 132
#ifndef FILE_SYSTEM_CASE
#define FILE_SYSTEM_CASE(filename)  (filename)
#endif

Jim Blandy's avatar
Jim Blandy committed
133 134 135 136 137 138 139
/* 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;

140 141 142
/* Set by auto_save_1 if an error occurred during the last auto-save. */
int auto_save_error_occurred;

143 144 145 146 147 148 149
/* 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;

150 151 152
/* Coding system for file names, or nil if none.  */
Lisp_Object Vfile_name_coding_system;

153 154 155 156
/* Coding system for file names used only when
   Vfile_name_coding_system is nil.  */
Lisp_Object Vdefault_file_name_coding_system;

157
/* Alist of elements (REGEXP . HANDLER) for file names
158 159 160
   whose I/O is done with a special handler.  */
Lisp_Object Vfile_name_handler_alist;

161 162 163 164
/* Property name of a file name handler,
   which gives a list of operations it handles..  */
Lisp_Object Qoperations;

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

168
/* Function to be called to decide a coding system of a reading file.  */
169
Lisp_Object Vset_auto_coding_function;
170

171 172 173
/* Functions to be called to process text properties in inserted file.  */
Lisp_Object Vafter_insert_file_functions;

174
/* Lisp function for setting buffer-file-coding-system and the
175
   multibyteness of the current buffer after inserting a file.  */
176
Lisp_Object Qafter_insert_file_set_coding;
177

178 179
/* Functions to be called to create text property annotations for file.  */
Lisp_Object Vwrite_region_annotate_functions;
180
Lisp_Object Qwrite_region_annotate_functions;
181
Lisp_Object Vwrite_region_post_annotation_function;
182

183 184 185 186
/* 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;

187 188 189 190
/* Each time an annotation function changes the buffer, the new buffer
   is added here.  */
Lisp_Object Vwrite_region_annotation_buffers;

191 192 193
/* File name in which we write a list of all our auto save files.  */
Lisp_Object Vauto_save_list_file_name;

194 195 196
/* Whether or not files are auto-saved into themselves.  */
Lisp_Object Vauto_save_visited_file_name;

197 198 199
/* Whether or not to continue auto-saving after a large deletion.  */
Lisp_Object Vauto_save_include_big_deletions;

200 201 202 203
/* On NT, specifies the directory separator character, used (eg.) when
   expanding file names.  This can be bound to / or \. */
Lisp_Object Vdirectory_sep_char;

204 205 206 207 208
#ifdef HAVE_FSYNC
/* Nonzero means skip the call to fsync in Fwrite-region.  */
int write_region_inhibit_fsync;
#endif

209
/* Non-zero means call move-file-to-trash in Fdelete_file or
210
   Fdelete_directory_internal.  */
211 212
int delete_by_moving_to_trash;

213 214
Lisp_Object Qdelete_by_moving_to_trash;

215 216 217
/* Lisp function for moving files to trash.  */
Lisp_Object Qmove_file_to_trash;

218 219
extern Lisp_Object Vuser_login_name;

220 221 222 223
#ifdef WINDOWSNT
extern Lisp_Object Vw32_get_true_file_attributes;
#endif

224 225
extern int minibuf_level;

226 227
extern int minibuffer_auto_raise;

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
	break;
      default:
	/* System error messages are capitalized.  Downcase the initial
272 273
	   unless it is followed by a slash.  (The slash case caters to
	   error messages that begin with "I/O" or, in German, "E/A".)  */
274 275
	if (STRING_MULTIBYTE (errstring)
	    && ! EQ (Faref (errstring, make_number (1)), make_number ('/')))
276 277 278 279
	  {
	    int c;

	    str = (char *) SDATA (errstring);
280
	    c = STRING_CHAR (str);
Stefan Monnier's avatar
Stefan Monnier committed
281
	    Faset (errstring, make_number (0), make_number (DOWNCASE (c)));
282
	  }
Richard M. Stallman's avatar
Richard M. Stallman committed
283

284
	xsignal (Qfile_error,
Richard M. Stallman's avatar
Richard M. Stallman committed
285 286
		 Fcons (build_string (string), Fcons (errstring, data)));
      }
Jim Blandy's avatar
Jim Blandy committed
287
}
288

289
Lisp_Object
290 291 292
close_file_unwind (fd)
     Lisp_Object fd;
{
293
  emacs_close (XFASTINT (fd));
294
  return Qnil;
295
}
296 297 298

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

299
static Lisp_Object
300
restore_point_unwind (location)
301
     Lisp_Object location;
302
{
303
  Fgoto_char (location);
304
  Fset_marker (location, Qnil, Qnil);
305
  return Qnil;
306
}
307

Jim Blandy's avatar
Jim Blandy committed
308

309
Lisp_Object Qexpand_file_name;
310
Lisp_Object Qsubstitute_in_file_name;
311 312 313
Lisp_Object Qdirectory_file_name;
Lisp_Object Qfile_name_directory;
Lisp_Object Qfile_name_nondirectory;
314
Lisp_Object Qunhandled_file_name_directory;
315
Lisp_Object Qfile_name_as_directory;
316
Lisp_Object Qcopy_file;
317
Lisp_Object Qmake_directory_internal;
318
Lisp_Object Qmake_directory;
319
Lisp_Object Qdelete_directory_internal;
320 321 322 323 324 325 326 327
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;
328 329
Lisp_Object Qfile_symlink_p;
Lisp_Object Qaccess_file;
330
Lisp_Object Qfile_directory_p;
331
Lisp_Object Qfile_regular_p;
332 333 334
Lisp_Object Qfile_accessible_directory_p;
Lisp_Object Qfile_modes;
Lisp_Object Qset_file_modes;
335
Lisp_Object Qset_file_times;
336 337 338 339
Lisp_Object Qfile_newer_than_file_p;
Lisp_Object Qinsert_file_contents;
Lisp_Object Qwrite_region;
Lisp_Object Qverify_visited_file_modtime;
340
Lisp_Object Qset_visited_file_modtime;
341

342
DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
343 344 345 346 347 348 349 350 351 352 353
       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;
354
{
355
  /* This function must not munge the match data.  */
356
  Lisp_Object chain, inhibited_handlers, result;
357
  int pos = -1;
358

359
  result = Qnil;
360
  CHECK_STRING (filename);
361

362 363 364 365
  if (EQ (operation, Vinhibit_file_name_operation))
    inhibited_handlers = Vinhibit_file_name_handlers;
  else
    inhibited_handlers = Qnil;
366

367
  for (chain = Vfile_name_handler_alist; CONSP (chain);
368
       chain = XCDR (chain))
369 370
    {
      Lisp_Object elt;
371
      elt = XCAR (chain);
372
      if (CONSP (elt))
373
	{
374
	  Lisp_Object string = XCAR (elt);
375
	  int match_pos;
376
	  Lisp_Object handler = XCDR (elt);
377 378 379 380
	  Lisp_Object operations = Qnil;

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

382
	  if (STRINGP (string)
383 384
	      && (match_pos = fast_string_match (string, filename)) > pos
	      && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
385
	    {
386
	      Lisp_Object tem;
387

388
	      handler = XCDR (elt);
389 390
	      tem = Fmemq (handler, inhibited_handlers);
	      if (NILP (tem))
391 392 393 394
		{
		  result = handler;
		  pos = match_pos;
		}
395
	    }
396
	}
397 398

      QUIT;
399
    }
400
  return result;
401 402
}

Jim Blandy's avatar
Jim Blandy committed
403
DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
404 405 406
       1, 1, 0,
       doc: /* Return the directory component in file name FILENAME.
Return nil if FILENAME does not include a directory.
407
Otherwise return a directory name.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
408
Given a Unix syntax file name, returns a string ending in slash.  */)
409
     (filename)
410
     Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
411
{
412
#ifndef DOS_NT
413
  register const unsigned char *beg;
414 415 416
#else
  register unsigned char *beg;
#endif
417
  register const unsigned char *p;
418
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
419

420
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
421

422 423
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
424
  handler = Ffind_file_name_handler (filename, Qfile_name_directory);
425
  if (!NILP (handler))
426
    return call2 (handler, Qfile_name_directory, filename);
427

428
  filename = FILE_SYSTEM_CASE (filename);
429
#ifdef DOS_NT
430 431 432 433
  beg = (unsigned char *) alloca (SBYTES (filename) + 1);
  bcopy (SDATA (filename), beg, SBYTES (filename) + 1);
#else
  beg = SDATA (filename);
434
#endif
435
  p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
436

437 438
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
#ifdef DOS_NT
439 440 441 442 443
	 /* 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))))
444
#endif
Jim Blandy's avatar
Jim Blandy committed
445 446 447 448
	 ) p--;

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

475
  return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
476 477
}

478 479
DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
       Sfile_name_nondirectory, 1, 1, 0,
480 481 482 483 484
       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)
485
     Lisp_Object filename;
Jim Blandy's avatar
Jim Blandy committed
486
{
487
  register const unsigned char *beg, *p, *end;
488
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
489

490
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
491

492 493
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
494
  handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
495
  if (!NILP (handler))
496
    return call2 (handler, Qfile_name_nondirectory, filename);
497

498 499
  beg = SDATA (filename);
  end = p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
500

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

511
  return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
512
}
513

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

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

  return Ffile_name_directory (filename);
}

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

  strcpy (out, in);

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

Jim Blandy's avatar
Jim Blandy committed
556
  /* For Unix syntax, Append a slash if necessary */
557
  if (!IS_DIRECTORY_SEP (out[size]))
558
    {
559 560
      /* Cannot use DIRECTORY_SEP, which could have any value */
      out[size + 1] = '/';
561 562
      out[size + 2] = '\0';
    }
563 564 565
#ifdef DOS_NT
  CORRECT_DIR_SEPS (out);
#endif
Jim Blandy's avatar
Jim Blandy committed
566 567 568 569 570
  return out;
}

DEFUN ("file-name-as-directory", Ffile_name_as_directory,
       Sfile_name_as_directory, 1, 1, 0,
571
       doc: /* Return a string representing the file name FILE interpreted as a directory.
572 573 574 575
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'.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
576
For a Unix-syntax file name, just appends a slash.  */)
577
     (file)
Jim Blandy's avatar
Jim Blandy committed
578 579 580
     Lisp_Object file;
{
  char *buf;
581
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
582

583
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
584
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
585
    return Qnil;
586 587 588

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
589
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
590 591 592
  if (!NILP (handler))
    return call2 (handler, Qfile_name_as_directory, file);

593
  buf = (char *) alloca (SBYTES (file) + 10);
594 595 596
  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
597 598 599 600
}

/*
 * Convert from directory name to filename.
601
 * On UNIX, it's simple: just make sure there isn't a terminating /
Jim Blandy's avatar
Jim Blandy committed
602 603 604 605

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

Andreas Schwab's avatar
Andreas Schwab committed
606
int
Jim Blandy's avatar
Jim Blandy committed
607 608 609 610 611 612
directory_file_name (src, dst)
     char *src, *dst;
{
  long slen;

  slen = strlen (src);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
613

Jim Blandy's avatar
Jim Blandy committed
614 615 616
  /* Process as Unix format: just remove any final slash.
     But leave "/" unchanged; do not change it to "".  */
  strcpy (dst, src);
617
  if (slen > 1
618
      && IS_DIRECTORY_SEP (dst[slen - 1])
619 620 621 622
#ifdef DOS_NT
      && !IS_ANY_SEP (dst[slen - 2])
#endif
      )
Jim Blandy's avatar
Jim Blandy committed
623
    dst[slen - 1] = 0;
624 625
#ifdef DOS_NT
  CORRECT_DIR_SEPS (dst);
626
#endif
Jim Blandy's avatar
Jim Blandy committed
627 628 629 630
  return 1;
}

DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
631 632 633 634 635
       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.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
636
In Unix-syntax, this function just removes the final slash.  */)
637
     (directory)
Jim Blandy's avatar
Jim Blandy committed
638 639 640
     Lisp_Object directory;
{
  char *buf;
641
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
642

643
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
644

Jim Blandy's avatar
Jim Blandy committed
645
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
646
    return Qnil;
647 648 649

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
650
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
651 652 653
  if (!NILP (handler))
    return call2 (handler, Qdirectory_file_name, directory);

654 655
  buf = (char *) alloca (SBYTES (directory) + 20);
  directory_file_name (SDATA (directory), buf);
656 657
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (directory));
Jim Blandy's avatar
Jim Blandy committed
658 659
}

660
static const char make_temp_name_tbl[64] =
661 662 663 664 665 666 667 668 669 670
{
  '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','-','_'
};
671

672 673
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

674
/* Value is a temporary file name starting with PREFIX, a string.
675

676 677 678 679 680
   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.
681

682 683 684 685 686 687 688 689 690 691
   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
692
     Lisp_Object prefix;
693
     int base64_p;
Jim Blandy's avatar
Jim Blandy committed
694 695
{
  Lisp_Object val;
696
  int len, clen;
697 698 699 700
  int pid;
  unsigned char *p, *data;
  char pidbuf[20];
  int pidlen;
701

702
  CHECK_STRING (prefix);
703 704 705 706 707 708 709 710

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

711 712 713 714 715 716 717 718 719
  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
    {
720
#ifdef HAVE_LONG_FILE_NAMES
721 722
      sprintf (pidbuf, "%d", pid);
      pidlen = strlen (pidbuf);
723
#else
724 725 726 727
      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;
728
#endif
729
    }
730

731 732 733 734
  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);
735 736
  data = SDATA (val);
  bcopy(SDATA (prefix), data, len);
737 738 739 740 741 742 743 744
  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
745 746 747 748 749 750
     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.  */

751 752 753 754 755 756 757 758 759
  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;
760
      unsigned num = make_temp_name_count;
761 762 763 764 765

      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;

766 767 768 769 770
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

771 772 773 774 775 776 777 778 779 780
      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
781 782 783
	       in looping through 225307 stat's, which is not only
	       dog-slow, but also useless since it will fallback to
	       the errow below, anyway.  */
784
	    report_file_error ("Cannot create temporary name for prefix",
785 786 787 788 789 790
			       Fcons (prefix, Qnil));
	  /* not reached */
	}
    }

  error ("Cannot create temporary name for prefix `%s'",
791
	 SDATA (prefix));
792
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
793
}
794

795 796

DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
797 798 799 800 801 802 803 804 805 806
       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
807 808 809 810 811
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.  */)
812
     (prefix)
813 814 815 816 817 818
     Lisp_Object prefix;
{
  return make_temp_name (prefix, 0);
}


Jim Blandy's avatar
Jim Blandy committed
819 820

DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
821 822
       doc: /* Convert filename NAME to absolute, and canonicalize it.
Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
823
\(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
824
the current buffer's value of `default-directory' is used.
825 826 827 828 829 830
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.
Chong Yidong's avatar
Chong Yidong committed
831 832 833 834 835 836 837
See also the function `substitute-in-file-name'.

For technical reasons, this function can return correct but
non-intuitive results for the root directory; for instance,
\(expand-file-name ".." "/") returns "/..".  For this reason, use
(directory-file-name (file-name-directory dirname)) to traverse a
filesystem tree, not (expand-file-name ".."  dirname).  */)
838
     (name, default_directory)
839
     Lisp_Object name, default_directory;
Jim Blandy's avatar
Jim Blandy committed
840
{
841 842 843 844 845
  /* These point to SDATA and need to be careful with string-relocation
     during GC (via DECODE_FILE).  */
  unsigned char *nm, *newdir;
  /* This should only point to alloca'd data.  */
  unsigned char *target;
846

Jim Blandy's avatar
Jim Blandy committed
847 848
  int tlen;
  struct passwd *pw;
849
#ifdef DOS_NT
850
  int drive = 0;
851
  int collapse_newdir = 1;
852
  int is_escaped = 0;
853
#endif /* DOS_NT */
854
  int length;
855
  Lisp_Object handler, result;
856
  int multibyte;
857
  Lisp_Object hdir;
858

859
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
860

861 862
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
863
  handler = Ffind_file_name_handler (name, Qexpand_file_name);
864
  if (!NILP (handler))
865
    return call3 (handler, Qexpand_file_name, name, default_directory);
866

867 868 869
  /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted.  */
  if (NILP (default_directory))
    default_directory = current_buffer->directory;
870
  if (! STRINGP (default_directory))
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
    {
#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
    }
888

889
  if (!NILP (default_directory))
890
    {
891
      handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
892
      if (!NILP (handler))
893
	return call3 (handler, Qexpand_file_name, name, default_directory);
894
    }
895

896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
  {
    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.  */
913
#ifdef DOS_NT
914 915 916
	/* Detect MSDOS file names with drive specifiers.  */
	&& ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1])
	      && IS_DIRECTORY_SEP (o[2]))
917
#ifdef WINDOWSNT
918 919
	/* Detect Windows file names in UNC format.  */
	&& ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
920
#endif
921 922 923
#else /* not DOS_NT */
      /* Detect Unix absolute file names (/... alone is not absolute on
	 DOS or Windows).  */
924
	&& ! (IS_DIRECTORY_SEP (o[0]))
925
#endif /* not DOS_NT */
926 927 928
	)
      {
	struct gcpro gcpro1;
929

930 931 932 933 934
	GCPRO1 (name);
	default_directory = Fexpand_file_name (default_directory, Qnil);
	UNGCPRO;
      }
  }
935
  name = FILE_SYSTEM_CASE (name);
936
  multibyte = STRING_MULTIBYTE (name);
937 938 939 940 941 942 943 944 945 946 947
  if (multibyte != STRING_MULTIBYTE (default_directory))
    {
      if (multibyte)
	default_directory = string_to_multibyte (default_directory);
      else
	{
	  name = string_to_multibyte (name);
	  multibyte = 1;
	}
    }

948
  /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
949 950
  nm = (unsigned char *) alloca (SBYTES (name) + 1);
  bcopy (SDATA (name), nm, SBYTES (name) + 1);