emacs.c 70.8 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Fully extensible Emacs, running on Unix, intended for GNU.
2

3 4
Copyright (C) 1985-1987, 1993-1995, 1997-1999, 2001-2013 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


22
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
23 24 25 26 27
#include <errno.h>
#include <stdio.h>

#include <sys/types.h>
#include <sys/file.h>
28 29
#include <unistd.h>

Paul Eggert's avatar
Paul Eggert committed
30
#include <close-stream.h>
31

32 33
#include "lisp.h"

34 35
#ifdef WINDOWSNT
#include <fcntl.h>
36
#include <sys/socket.h>
37
#include "w32.h"
Daniel Colascione's avatar
Daniel Colascione committed
38 39 40
#include "w32heap.h"
#endif

41
#if defined WINDOWSNT || defined HAVE_NTGUI
Daniel Colascione's avatar
Daniel Colascione committed
42 43
#include "w32select.h"
#include "w32font.h"
44
#include "w32common.h"
Daniel Colascione's avatar
Daniel Colascione committed
45 46
#endif

47
#if defined CYGWIN
Daniel Colascione's avatar
Daniel Colascione committed
48
#include "cygw32.h"
49 50
#endif

51 52 53 54
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */

55 56 57 58 59
#ifdef NS_IMPL_GNUSTEP
/* At least under Debian, GSConfig is in a subdirectory.  --Stef  */
#include <GNUstepBase/GSConfig.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
60
#include "commands.h"
Joseph Arceneaux's avatar
Joseph Arceneaux committed
61
#include "intervals.h"
62
#include "character.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
63
#include "buffer.h"
Stefan Monnier's avatar
Stefan Monnier committed
64
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
65

66
#include "systty.h"
67
#include "atimer.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
68
#include "blockinput.h"
69
#include "syssignal.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
70
#include "process.h"
71
#include "frame.h"
72
#include "termhooks.h"
Andreas Schwab's avatar
Andreas Schwab committed
73
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
74
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
75

Ted Zlatanov's avatar
Ted Zlatanov committed
76 77 78 79
#ifdef HAVE_GNUTLS
#include "gnutls.h"
#endif

80 81 82 83 84 85
#if (defined PROFILING \
     && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
# include <sys/gmon.h>
extern void moncontrol (int mode);
#endif

86 87 88 89
#ifdef HAVE_SETLOCALE
#include <locale.h>
#endif

90 91 92 93 94
#ifdef HAVE_SETRLIMIT
#include <sys/time.h>
#include <sys/resource.h>
#endif

95 96 97 98
#ifdef HAVE_PERSONALITY_LINUX32
#include <sys/personality.h>
#endif

99
static const char emacs_version[] = VERSION;
100
static const char emacs_copyright[] = COPYRIGHT;
101

102 103
/* Empty lisp strings.  To avoid having to build any others.  */
Lisp_Object empty_unibyte_string, empty_multibyte_string;
Stefan Monnier's avatar
Stefan Monnier committed
104

105 106 107 108 109
#ifdef WINDOWSNT
/* Cache for externally loaded libraries.  */
Lisp_Object Vlibrary_cache;
#endif

110 111 112 113
/* Set after Emacs has started up the first time.
   Prevents reinitialization of the Lisp world and keymaps
   on subsequent starts.  */
bool initialized;
Jim Blandy's avatar
Jim Blandy committed
114

115 116 117 118
#ifdef DARWIN_OS
extern void unexec_init_emacs_zone (void);
#endif

119 120 121
#ifdef DOUG_LEA_MALLOC
/* Preserves a pointer to the memory allocated that copies that
   static data inside glibc's malloc.  */
122
static void *malloc_state_ptr;
123
/* From glibc, a routine that returns a copy of the malloc internal state.  */
124
extern void *malloc_get_state (void);
125
/* From glibc, a routine that overwrites the malloc internal state.  */
126
extern int malloc_set_state (void*);
127
/* True if the MALLOC_CHECK_ environment variable was set while
128
   dumping.  Used to work around a bug in glibc's malloc.  */
129
static bool malloc_using_checking;
130 131
#elif defined HAVE_PTHREAD && !defined SYSTEM_MALLOC
extern void malloc_enable_thread (void);
132 133
#endif

134 135
Lisp_Object Qfile_name_handler_alist;

Glenn Morris's avatar
Glenn Morris committed
136 137
Lisp_Object Qrisky_local_variable;

138 139
Lisp_Object Qkill_emacs;
static Lisp_Object Qkill_emacs_hook;
140

141
/* If true, Emacs should not attempt to use a window-specific code,
Pavel Janík's avatar
Pavel Janík committed
142
   but instead should use the virtual terminal under which it was started.  */
143
bool inhibit_window_system;
Jim Blandy's avatar
Jim Blandy committed
144

145
/* If true, a filter or a sentinel is running.  Tested to save the match
Pavel Janík's avatar
Pavel Janík committed
146
   data on the first attempt to change it inside asynchronous code.  */
147
bool running_asynch_code;
148

Juanma Barranquero's avatar
Juanma Barranquero committed
149
#if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
150 151
/* If true, -d was specified, meaning we're using some window system.  */
bool display_arg;
Jim Blandy's avatar
Jim Blandy committed
152 153 154 155 156 157
#endif

/* An address near the bottom of the stack.
   Tells GC how to save a copy of the stack.  */
char *stack_bottom;

158
#if defined (DOUG_LEA_MALLOC) || defined (GNU_LINUX)
159 160
/* The address where the heap starts (from the first sbrk (0) call).  */
static void *my_heap_start;
161
#endif
162

163
#ifdef GNU_LINUX
164
/* The gap between BSS end and heap start as far as we can tell.  */
165 166
static uprintmax_t heap_bss_diff;
#endif
167

168 169 170 171 172 173 174 175 176 177 178 179
/* To run as a daemon under Cocoa or Windows, we must do a fork+exec,
   not a simple fork.

   On Cocoa, CoreFoundation lib fails in forked process:
   http://developer.apple.com/ReleaseNotes/
   CoreFoundation/CoreFoundation.html)

   On Windows, a Cygwin fork child cannot access the USER subsystem.

   We mark being in the exec'd process by a daemon name argument of
   form "--daemon=\nFD0,FD1\nNAME" where FD are the pipe file descriptors,
   NAME is the original daemon name, if any. */
180
#if defined NS_IMPL_COCOA || (defined HAVE_NTGUI && defined CYGWIN)
181 182 183
# define DAEMON_MUST_EXEC
#endif

184 185
/* True means running Emacs without interactive terminal.  */
bool noninteractive;
Jim Blandy's avatar
Jim Blandy committed
186

187 188
/* True means remove site-lisp directories from load-path.  */
bool no_site_lisp;
189

190 191
/* Name for the server started by the daemon.*/
static char *daemon_name;
192

193 194
/* Pipe used to send exit notification to the daemon parent at
   startup.  */
195
int daemon_pipe[2];
196

197 198 199
/* Save argv and argc.  */
char **initial_argv;
int initial_argc;
200

201
static void sort_args (int argc, char **argv);
202
static void syms_of_emacs (void);
Gerd Moellmann's avatar
Gerd Moellmann committed
203

Paul Eggert's avatar
Paul Eggert committed
204
/* C89 needs each string be at most 509 characters, so the usage
Kenichi Handa's avatar
Kenichi Handa committed
205
   strings below are split to not overflow this limit.  */
Paul Eggert's avatar
Paul Eggert committed
206 207
static char const *const usage_message[] =
  { "\
Gerd Moellmann's avatar
Gerd Moellmann committed
208 209 210 211 212
\n\
Run Emacs, the extensible, customizable, self-documenting real-time\n\
display editor.  The recommended way to start Emacs for normal editing\n\
is with no options at all.\n\
\n\
213
Run M-x info RET m emacs RET m emacs invocation RET inside Emacs to\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
214 215 216 217
read the main documentation for these command-line arguments.\n\
\n\
Initialization options:\n\
\n\
Paul Eggert's avatar
Paul Eggert committed
218 219
",
    "\
Kenichi Handa's avatar
Kenichi Handa committed
220
--batch                     do not do interactive display; implies -q\n\
221
--chdir DIR                 change to directory DIR\n\
Glenn Morris's avatar
Glenn Morris committed
222
--daemon                    start a server in the background\n\
Kenichi Handa's avatar
Kenichi Handa committed
223 224
--debug-init                enable Emacs Lisp debugger for init file\n\
--display, -d DISPLAY       use X server DISPLAY\n\
Paul Eggert's avatar
Paul Eggert committed
225 226
",
    "\
Kenichi Handa's avatar
Kenichi Handa committed
227 228 229 230
--no-desktop                do not load a saved desktop\n\
--no-init-file, -q          load neither ~/.emacs nor default.el\n\
--no-shared-memory, -nl     do not use shared memory\n\
--no-site-file              do not load site-start.el\n\
231
--no-site-lisp, -nsl        do not add site-lisp directories to load-path\n\
Kenichi Handa's avatar
Kenichi Handa committed
232
--no-splash                 do not display a splash screen on startup\n\
233
--no-window-system, -nw     do not communicate with X, ignoring $DISPLAY\n\
Paul Eggert's avatar
Paul Eggert committed
234 235
",
    "\
236 237
--quick, -Q                 equivalent to:\n\
                              -q --no-site-file --no-site-lisp --no-splash\n\
Kenichi Handa's avatar
Kenichi Handa committed
238 239 240
--script FILE               run FILE as an Emacs Lisp script\n\
--terminal, -t DEVICE       use DEVICE for terminal I/O\n\
--user, -u USER             load ~USER/.emacs instead of your own\n\
Paul Eggert's avatar
Paul Eggert committed
241 242 243
\n\
",
    "\
Gerd Moellmann's avatar
Gerd Moellmann committed
244 245
Action options:\n\
\n\
Kenichi Handa's avatar
Kenichi Handa committed
246
FILE                    visit FILE using find-file\n\
247 248
+LINE                   go to line LINE in next FILE\n\
+LINE:COLUMN            go to line LINE, column COLUMN, in next FILE\n\
Kenichi Handa's avatar
Kenichi Handa committed
249 250 251
--directory, -L DIR     add DIR to variable load-path\n\
--eval EXPR             evaluate Emacs Lisp expression EXPR\n\
--execute EXPR          evaluate Emacs Lisp expression EXPR\n\
Paul Eggert's avatar
Paul Eggert committed
252 253
",
    "\
Kenichi Handa's avatar
Kenichi Handa committed
254 255 256 257 258 259 260
--file FILE             visit FILE using find-file\n\
--find-file FILE        visit FILE using find-file\n\
--funcall, -f FUNC      call Emacs Lisp function FUNC with no arguments\n\
--insert FILE           insert contents of FILE into current buffer\n\
--kill                  exit without asking for confirmation\n\
--load, -l FILE         load Emacs Lisp FILE using the load function\n\
--visit FILE            visit FILE using find-file\n\
Paul Eggert's avatar
Paul Eggert committed
261 262 263
\n\
",
    "\
264
Display options:\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
265
\n\
Kenichi Handa's avatar
Kenichi Handa committed
266
--background-color, -bg COLOR   window background color\n\
267 268
--basic-display, -D             disable many display features;\n\
                                  used for debugging Emacs\n\
Kenichi Handa's avatar
Kenichi Handa committed
269 270
--border-color, -bd COLOR       main border color\n\
--border-width, -bw WIDTH       width of main border\n\
Paul Eggert's avatar
Paul Eggert committed
271 272
",
    "\
273
--color, --color=MODE           override color mode for character terminals;\n\
274 275
                                  MODE defaults to `auto', and\n\
                                  can also be `never', `always',\n\
Kenichi Handa's avatar
Kenichi Handa committed
276 277 278 279
                                  or a mode name like `ansi8'\n\
--cursor-color, -cr COLOR       color of the Emacs cursor indicating point\n\
--font, -fn FONT                default font; must be fixed-width\n\
--foreground-color, -fg COLOR   window foreground color\n\
Paul Eggert's avatar
Paul Eggert committed
280 281
",
    "\
Kenichi Handa's avatar
Kenichi Handa committed
282
--fullheight, -fh               make the first frame high as the screen\n\
283
--fullscreen, -fs               make the first frame fullscreen\n\
Kenichi Handa's avatar
Kenichi Handa committed
284
--fullwidth, -fw                make the first frame wide as the screen\n\
285
--maximized, -mm                make the first frame maximized\n\
Kenichi Handa's avatar
Kenichi Handa committed
286
--geometry, -g GEOMETRY         window geometry\n\
Paul Eggert's avatar
Paul Eggert committed
287 288
",
    "\
Jan Djärv's avatar
Jan Djärv committed
289
--no-bitmap-icon, -nbi          do not use picture of gnu for Emacs icon\n\
Kenichi Handa's avatar
Kenichi Handa committed
290 291 292 293 294
--iconic                        start Emacs in iconified state\n\
--internal-border, -ib WIDTH    width between text and main border\n\
--line-spacing, -lsp PIXELS     additional space to put between lines\n\
--mouse-color, -ms COLOR        mouse cursor color in Emacs window\n\
--name NAME                     title for initial Emacs frame\n\
Paul Eggert's avatar
Paul Eggert committed
295 296
",
    "\
297
--no-blinking-cursor, -nbc      disable blinking cursor\n\
Kenichi Handa's avatar
Kenichi Handa committed
298 299 300 301
--reverse-video, -r, -rv        switch foreground and background\n\
--title, -T TITLE               title for initial Emacs frame\n\
--vertical-scroll-bars, -vb     enable vertical scroll bars\n\
--xrm XRESOURCES                set additional X resources\n\
Jan Djärv's avatar
Jan Djärv committed
302
--parent-id XID                 set parent window\n\
Kenichi Handa's avatar
Kenichi Handa committed
303 304
--help                          display this help and exit\n\
--version                       output version information and exit\n\
Paul Eggert's avatar
Paul Eggert committed
305 306 307
\n\
",
    "\
Gerd Moellmann's avatar
Gerd Moellmann committed
308 309 310 311 312 313
You can generally also specify long option names with a single -; for\n\
example, -batch as well as --batch.  You can use any unambiguous\n\
abbreviation for a --option.\n\
\n\
Various environment variables and window system resources also affect\n\
Emacs' operation.  See the main documentation.\n\
314
\n\
315
Report bugs to bug-gnu-emacs@gnu.org.  First, please see the Bugs\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
316
section of the Emacs manual or the file BUGS.\n"
Paul Eggert's avatar
Paul Eggert committed
317
  };
Gerd Moellmann's avatar
Gerd Moellmann committed
318

Jim Blandy's avatar
Jim Blandy committed
319

320 321
/* True if handling a fatal error already.  */
bool fatal_error_in_progress;
Jim Blandy's avatar
Jim Blandy committed
322

323 324 325
#ifdef HAVE_NS
/* NS autrelease pool, for memory management.  */
static void *ns_pool;
326 327
#endif

328 329 330 331 332 333 334
#if !HAVE_SETLOCALE
static char *
setlocale (int cat, char const *locale)
{
  return 0;
}
#endif
335

336

337 338 339
/* Report a fatal error due to signal SIG, output a backtrace of at
   most BACKTRACE_LIMIT lines, and exit.  */
_Noreturn void
340
terminate_due_to_signal (int sig, int backtrace_limit)
341
{
Paul Eggert's avatar
Paul Eggert committed
342
  signal (sig, SIG_DFL);
343
  totally_unblock_input ();
344

Jim Blandy's avatar
Jim Blandy committed
345
  /* If fatal error occurs in code below, avoid infinite recursion.  */
346 347 348
  if (! fatal_error_in_progress)
    {
      fatal_error_in_progress = 1;
Jim Blandy's avatar
Jim Blandy committed
349

350
      if (sig == SIGTERM || sig == SIGHUP || sig == SIGINT)
351 352
        Fkill_emacs (make_number (sig));

353
      shut_down_emacs (sig, Qnil);
354
      emacs_backtrace (backtrace_limit);
355
    }
Jim Blandy's avatar
Jim Blandy committed
356

357
  /* Signal the same code; this time it will really be fatal.
358 359
     Since we're in a signal handler, the signal is blocked, so we
     have to unblock it if we want to really receive it.  */
360
#ifndef MSDOS
Paul Eggert's avatar
Paul Eggert committed
361 362 363
  {
    sigset_t unblocked;
    sigemptyset (&unblocked);
364
    sigaddset (&unblocked, sig);
Paul Eggert's avatar
Paul Eggert committed
365 366
    pthread_sigmask (SIG_UNBLOCK, &unblocked, 0);
  }
367
#endif
368

369
  emacs_raise (sig);
370 371 372

  /* This shouldn't be executed, but it prevents a warning.  */
  exit (1);
Jim Blandy's avatar
Jim Blandy committed
373 374
}

Pavel Janík's avatar
Pavel Janík committed
375
/* Code for dealing with Lisp access to the Unix command line.  */
Jim Blandy's avatar
Jim Blandy committed
376

Andreas Schwab's avatar
Andreas Schwab committed
377
static void
378
init_cmdargs (int argc, char **argv, int skip_args)
Jim Blandy's avatar
Jim Blandy committed
379 380
{
  register int i;
381
  Lisp_Object name, dir, handler;
382
  ptrdiff_t count = SPECPDL_INDEX ();
383
  Lisp_Object raw_name;
Jim Blandy's avatar
Jim Blandy committed
384

385 386 387
  initial_argv = argv;
  initial_argc = argc;

388 389 390 391
  raw_name = build_string (argv[0]);

  /* Add /: to the front of the name
     if it would otherwise be treated as magic.  */
392 393
  handler = Ffind_file_name_handler (raw_name, Qt);
  if (! NILP (handler))
394 395 396 397 398
    raw_name = concat2 (build_string ("/:"), raw_name);

  Vinvocation_name = Ffile_name_nondirectory (raw_name);
  Vinvocation_directory = Ffile_name_directory (raw_name);

399 400 401 402 403 404
  /* If we got no directory in argv[0], search PATH to find where
     Emacs actually came from.  */
  if (NILP (Vinvocation_directory))
    {
      Lisp_Object found;
      int yes = openp (Vexec_path, Vinvocation_name,
405
		       Vexec_suffixes, &found, make_number (X_OK));
406
      if (yes == 1)
407 408 409
	{
	  /* Add /: to the front of the name
	     if it would otherwise be treated as magic.  */
410 411
	  handler = Ffind_file_name_handler (found, Qt);
	  if (! NILP (handler))
412 413 414
	    found = concat2 (build_string ("/:"), found);
	  Vinvocation_directory = Ffile_name_directory (found);
	}
415
    }
416

417 418
  if (!NILP (Vinvocation_directory)
      && NILP (Ffile_name_absolute_p (Vinvocation_directory)))
419 420
    /* Emacs was started with relative path, like ./emacs.
       Make it absolute.  */
421 422
    Vinvocation_directory = Fexpand_file_name (Vinvocation_directory, Qnil);

423 424 425 426 427
  Vinstallation_directory = Qnil;

  if (!NILP (Vinvocation_directory))
    {
      dir = Vinvocation_directory;
428 429 430 431 432 433 434 435 436 437
#ifdef WINDOWSNT
      /* If we are running from the build directory, set DIR to the
	 src subdirectory of the Emacs tree, like on Posix
	 platforms.  */
      if (SBYTES (dir) > sizeof ("/i386/") - 1
	  && 0 == strcmp (SSDATA (dir) + SBYTES (dir) - sizeof ("/i386/") + 1,
			  "/i386/"))
	dir = Fexpand_file_name (build_string ("../.."), dir);
#else  /* !WINDOWSNT */
#endif
438 439 440
      name = Fexpand_file_name (Vinvocation_name, dir);
      while (1)
	{
441
	  Lisp_Object tem, lib_src_exists;
442 443
	  Lisp_Object etc_exists, info_exists;

444 445 446 447 448
	  /* See if dir contains subdirs for use by Emacs.
	     Check for the ones that would exist in a build directory,
	     not including lisp and info.  */
	  tem = Fexpand_file_name (build_string ("lib-src"), dir);
	  lib_src_exists = Ffile_exists_p (tem);
449

450
#ifdef MSDOS
451 452 453 454 455
	  /* MSDOS installations frequently remove lib-src, but we still
	     must set installation-directory, or else info won't find
	     its files (it uses the value of installation-directory).  */
	  tem = Fexpand_file_name (build_string ("info"), dir);
	  info_exists = Ffile_exists_p (tem);
456 457 458
#else
	  info_exists = Qnil;
#endif
459 460

	  if (!NILP (lib_src_exists) || !NILP (info_exists))
461
	    {
462 463 464
	      tem = Fexpand_file_name (build_string ("etc"), dir);
	      etc_exists = Ffile_exists_p (tem);
	      if (!NILP (etc_exists))
465
		{
466 467 468
		  Vinstallation_directory
		    = Ffile_name_as_directory (dir);
		  break;
469 470 471 472
		}
	    }

	  /* See if dir's parent contains those subdirs.  */
473 474
	  tem = Fexpand_file_name (build_string ("../lib-src"), dir);
	  lib_src_exists = Ffile_exists_p (tem);
475

476 477 478

#ifdef MSDOS
	  /* See the MSDOS commentary above.  */
479 480
	  tem = Fexpand_file_name (build_string ("../info"), dir);
	  info_exists = Ffile_exists_p (tem);
481 482 483
#else
	  info_exists = Qnil;
#endif
484 485

	  if (!NILP (lib_src_exists) || !NILP (info_exists))
486
	    {
487 488 489
	      tem = Fexpand_file_name (build_string ("../etc"), dir);
	      etc_exists = Ffile_exists_p (tem);
	      if (!NILP (etc_exists))
490
		{
491 492 493 494
		  tem = Fexpand_file_name (build_string (".."), dir);
		  Vinstallation_directory
		    = Ffile_name_as_directory (tem);
		  break;
495 496 497 498 499 500 501 502
		}
	    }

	  /* If the Emacs executable is actually a link,
	     next try the dir that the link points into.  */
	  tem = Ffile_symlink_p (name);
	  if (!NILP (tem))
	    {
503
	      name = Fexpand_file_name (tem, dir);
504 505 506 507 508 509 510
	      dir = Ffile_name_directory (name);
	    }
	  else
	    break;
	}
    }

Jim Blandy's avatar
Jim Blandy committed
511 512 513 514 515
  Vcommand_line_args = Qnil;

  for (i = argc - 1; i >= 0; i--)
    {
      if (i == 0 || i > skip_args)
516 517 518
	/* For the moment, we keep arguments as is in unibyte strings.
	   They are decoded in the function command-line after we know
	   locale-coding-system.  */
Jim Blandy's avatar
Jim Blandy committed
519
	Vcommand_line_args
520
	  = Fcons (build_unibyte_string (argv[i]), Vcommand_line_args);
Jim Blandy's avatar
Jim Blandy committed
521
    }
522 523

  unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
524
}
525 526

DEFUN ("invocation-name", Finvocation_name, Sinvocation_name, 0, 0, 0,
Pavel Janík's avatar
Pavel Janík committed
527 528
       doc: /* Return the program name that was used to run Emacs.
Any directory names are omitted.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
529
  (void)
530 531 532 533
{
  return Fcopy_sequence (Vinvocation_name);
}

534
DEFUN ("invocation-directory", Finvocation_directory, Sinvocation_directory,
Pavel Janík's avatar
Pavel Janík committed
535 536
       0, 0, 0,
       doc: /* Return the directory name in which the Emacs executable was located.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
537
  (void)
538 539 540 541
{
  return Fcopy_sequence (Vinvocation_directory);
}

Jim Blandy's avatar
Jim Blandy committed
542

543 544 545
#ifdef HAVE_TZSET
/* A valid but unlikely value for the TZ environment value.
   It is OK (though a bit slower) if the user actually chooses this value.  */
546
static char const dump_tz[] = "UtC0";
547 548
#endif

Karl Heuer's avatar
Karl Heuer committed
549 550 551 552 553 554 555 556 557
/* Test whether the next argument in ARGV matches SSTR or a prefix of
   LSTR (at least MINLEN characters).  If so, then if VALPTR is non-null
   (the argument is supposed to have a value) store in *VALPTR either
   the next argument or the portion of this one after the equal sign.
   ARGV is read starting at position *SKIPPTR; this index is advanced
   by the number of arguments used.

   Too bad we can't just use getopt for all of this, but we don't have
   enough information to do it right.  */
558

559
static bool
560 561
argmatch (char **argv, int argc, const char *sstr, const char *lstr,
          int minlen, char **valptr, int *skipptr)
Karl Heuer's avatar
Karl Heuer committed
562
{
563
  char *p = NULL;
564
  ptrdiff_t arglen;
565 566 567 568 569 570 571
  char *arg;

  /* Don't access argv[argc]; give up in advance.  */
  if (argc <= *skipptr + 1)
    return 0;

  arg = argv[*skipptr+1];
Karl Heuer's avatar
Karl Heuer committed
572 573 574 575 576 577 578 579 580 581 582 583 584
  if (arg == NULL)
    return 0;
  if (strcmp (arg, sstr) == 0)
    {
      if (valptr != NULL)
	{
	  *valptr = argv[*skipptr+2];
	  *skipptr += 2;
	}
      else
	*skipptr += 1;
      return 1;
    }
585
  arglen = (valptr != NULL && (p = strchr (arg, '=')) != NULL
Karl Heuer's avatar
Karl Heuer committed
586
	    ? p - arg : strlen (arg));
587
  if (lstr == 0 || arglen < minlen || strncmp (arg, lstr, arglen) != 0)
Karl Heuer's avatar
Karl Heuer committed
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
    return 0;
  else if (valptr == NULL)
    {
      *skipptr += 1;
      return 1;
    }
  else if (p != NULL)
    {
      *valptr = p+1;
      *skipptr += 1;
      return 1;
    }
  else if (argv[*skipptr+2] != NULL)
    {
      *valptr = argv[*skipptr+2];
      *skipptr += 2;
      return 1;
    }
  else
    {
      return 0;
    }
}

612
#ifdef DOUG_LEA_MALLOC
Jim Blandy's avatar
Jim Blandy committed
613

614 615 616 617 618
/* malloc can be invoked even before main (e.g. by the dynamic
   linker), so the dumped malloc state must be restored as early as
   possible using this special hook.  */

static void
619
malloc_initialize_hook (void)
620
{
621 622
  if (initialized)
    {
623 624 625
      if (!malloc_using_checking)
	/* Work around a bug in glibc's malloc.  MALLOC_CHECK_ must be
	   ignored if the heap to be restored was constructed without
626 627 628 629
	   malloc checking.  Can't use unsetenv, since that calls malloc.  */
	{
	  char **p;

630
	  for (p = environ; p && *p; p++)
631 632 633 634 635 636 637 638
	    if (strncmp (*p, "MALLOC_CHECK_=", 14) == 0)
	      {
		do
		  *p = p[1];
		while (*++p);
		break;
	      }
	}
639

640
      malloc_set_state (malloc_state_ptr);
641
#ifndef XMALLOC_OVERRUN_CHECK
642
      free (malloc_state_ptr);
643
#endif
644
    }
645
  else
646 647 648 649 650
    {
      if (my_heap_start == 0)
        my_heap_start = sbrk (0);
      malloc_using_checking = getenv ("MALLOC_CHECK_") != NULL;
    }
651 652
}

653
void (*__malloc_initialize_hook) (void) EXTERNALLY_VISIBLE = malloc_initialize_hook;
654 655 656

#endif /* DOUG_LEA_MALLOC */

Paul Eggert's avatar
Paul Eggert committed
657 658 659 660 661 662 663
/* Close standard output and standard error, reporting any write
   errors as best we can.  This is intended for use with atexit.  */
static void
close_output_streams (void)
{
  if (close_stream (stdout) != 0)
    {
664
      emacs_perror ("Write error to standard output");
Paul Eggert's avatar
Paul Eggert committed
665 666 667 668 669 670
      _exit (EXIT_FAILURE);
    }

   if (close_stream (stderr) != 0)
     _exit (EXIT_FAILURE);
}
671

672 673
/* ARGSUSED */
int
Dan Nicolaescu's avatar
Dan Nicolaescu committed
674
main (int argc, char **argv)
675
{
676
#if GC_MARK_STACK
677 678
  Lisp_Object dummy;
#endif
679
  char stack_bottom_variable;
680
  bool do_initial_setlocale;
681
  bool dumping;
682 683 684 685
  int skip_args = 0;
#ifdef HAVE_SETRLIMIT
  struct rlimit rlim;
#endif
686
  bool no_loadup = 0;
Richard M. Stallman's avatar
Richard M. Stallman committed
687
  char *junk = 0;
688
  char *dname_arg = 0;
689
#ifdef DAEMON_MUST_EXEC
690
  char dname_arg2[80];
691
#endif
692
  char *ch_to_dir;
693

694
#if GC_MARK_STACK
695 696 697
  stack_base = &dummy;
#endif

Ken Brown's avatar
Ken Brown committed
698
#ifdef G_SLICE_ALWAYS_MALLOC
699 700
  /* This is used by the Cygwin build.  It's not needed starting with
     cygwin-1.7.24, but it doesn't do any harm.  */
701
  xputenv ("G_SLICE=always-malloc");
702 703
#endif

704
#ifdef GNU_LINUX
705 706 707 708 709 710 711 712 713 714
  if (!initialized)
    {
      extern char my_endbss[];
      extern char *my_endbss_static;

      if (my_heap_start == 0)
        my_heap_start = sbrk (0);

      heap_bss_diff = (char *)my_heap_start - max (my_endbss, my_endbss_static);
    }
715
#endif
716

717 718 719 720 721 722 723
#if defined WINDOWSNT || defined HAVE_NTGUI
  /* Set global variables used to detect Windows version.  Do this as
     early as possible.  (unexw32.c calls this function as well, but
     the additional call here is harmless.) */
  cache_system_info ();
#endif

724 725 726 727 728
#ifdef RUN_TIME_REMAP
  if (initialized)
    run_time_remap (argv[0]);
#endif

729 730
/* If using unexmacosx.c (set by s/darwin.h), we must do this. */
#ifdef DARWIN_OS
731 732 733 734
  if (!initialized)
    unexec_init_emacs_zone ();
#endif

Paul Eggert's avatar
Paul Eggert committed
735 736
  atexit (close_output_streams);

737
  sort_args (argc, argv);
738 739
  argc = 0;
  while (argv[argc]) argc++;
740

741
  if (argmatch (argv, argc, "-version", "--version", 3, NULL, &skip_args))
742
    {
743 744
      const char *version, *copyright;
      if (initialized)
745
	{
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
	  Lisp_Object tem, tem2;
	  tem = Fsymbol_value (intern_c_string ("emacs-version"));
	  tem2 = Fsymbol_value (intern_c_string ("emacs-copyright"));
	  if (!STRINGP (tem))
	    {
	      fprintf (stderr, "Invalid value of `emacs-version'\n");
	      exit (1);
	    }
	  if (!STRINGP (tem2))
	    {
	      fprintf (stderr, "Invalid value of `emacs-copyright'\n");
	      exit (1);
	    }
	  else
	    {
761 762
	      version = SSDATA (tem);
	      copyright = SSDATA (tem2);
763
	    }
764
	}
765 766
      else
	{
767 768
	  version = emacs_version;
	  copyright = emacs_copyright;
769
	}
770 771 772 773 774 775 776 777
      printf ("GNU Emacs %s\n", version);
      printf ("%s\n", copyright);
      printf ("GNU Emacs comes with ABSOLUTELY NO WARRANTY.\n");
      printf ("You may redistribute copies of Emacs\n");
      printf ("under the terms of the GNU General Public License.\n");
      printf ("For more information about these matters, ");
      printf ("see the file named COPYING.\n");
      exit (0);
778
    }
779 780 781 782 783 784 785 786

  if (argmatch (argv, argc, "-chdir", "--chdir", 4, &ch_to_dir, &skip_args))
    if (chdir (ch_to_dir) == -1)
      {
	fprintf (stderr, "%s: Can't chdir to %s: %s\n",
		 argv[0], ch_to_dir, strerror (errno));
	exit (1);
      }
787

788 789
  dumping = !initialized && (strcmp (argv[argc - 1], "dump") == 0
			     || strcmp (argv[argc - 1], "bootstrap") == 0);
790

791
#ifdef HAVE_PERSONALITY_LINUX32
792
  if (dumping && ! getenv ("EMACS_HEAP_EXEC"))
793
    {
794
      /* Set this so we only do this once.  */
795
      xputenv ("EMACS_HEAP_EXEC=true");
796

797 798
      /* A flag to turn off address randomization which is introduced
         in linux kernel shipped with fedora core 4 */
799
#define ADD_NO_RANDOMIZE 0x0040000
800
      personality (PER_LINUX32 | ADD_NO_RANDOMIZE);
801 802
#undef  ADD_NO_RANDOMIZE

803
      execvp (argv[0], argv);
804

805
      /* If the exec fails, try to dump anyway.  */
806
      emacs_perror (argv[0]);
807 808 809
    }
#endif /* HAVE_PERSONALITY_LINUX32 */

810
#if defined (HAVE_SETRLIMIT) && defined (RLIMIT_STACK)
811 812 813 814 815 816 817 818
  /* Extend the stack space available.
     Don't do that if dumping, since some systems (e.g. DJGPP)
     might define a smaller stack limit at that time.  */
  if (1
#ifndef CANNOT_DUMP
      && (!noninteractive || initialized)
#endif
      && !getrlimit (RLIMIT_STACK, &rlim))
819
    {
820
      long newlim;
821
      extern size_t re_max_failures;
822 823 824 825 826 827 828 829
      /* Approximate the amount regex.c needs per unit of re_max_failures.  */
      int ratio = 20 * sizeof (char *);
      /* Then add 33% to cover the size of the smaller stacks that regex.c
	 successively allocates and discards, on its way to the maximum.  */
      ratio += ratio / 3;
      /* Add in some extra to cover
	 what we're likely to use for other reasons.  */
      newlim = re_max_failures * ratio + 200000;
830 831 832 833 834
#ifdef __NetBSD__
      /* NetBSD (at least NetBSD 1.2G and former) has a bug in its
       stack allocation routine for new process that the allocation
       fails if stack limit is not on page boundary.  So, round up the
       new limit to page boundary.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
835
      newlim = (newlim + getpagesize () - 1) / getpagesize () * getpagesize ();
836
#endif
837
      if (newlim > rlim.rlim_max)
838 839
	{
	  newlim = rlim.rlim_max;
840 841
	  /* Don't let regex.c overflow the stack we have.  */
	  re_max_failures = (newlim - 200000) / ratio;
842
	}
843 844 845
      if (rlim.rlim_cur < newlim)
	rlim.rlim_cur = newlim;

846 847
      setrlimit (RLIMIT_STACK, &rlim);
    }
848
#endif /* HAVE_SETRLIMIT and RLIMIT_STACK */
849

Jim Blandy's avatar
Jim Blandy committed
850 851 852 853
  /* Record (approximately) where the stack begins.  */
  stack_bottom = &stack_bottom_variable;

  clearerr (stdin);
854

Jim Blandy's avatar
Jim Blandy committed
855
#ifndef SYSTEM_MALLOC
856 857
  /* Arrange to get warning messages as memory fills up.  */
  memory_warnings (0, malloc_warning);
858

859
  /* Call malloc at least once, to run malloc_initialize_hook.
860 861
     Also call realloc and free for consistency.  */
  free (realloc (malloc (4), 4));
862

Jim Blandy's avatar
Jim Blandy committed
863 864
#endif	/* not SYSTEM_MALLOC */

865
#if defined (MSDOS) || defined (WINDOWSNT)
866 867 868
  /* We do all file input/output as binary files.  When we need to translate
     newlines, we do that manually.  */
  _fmode = O_BINARY;
869
#endif /* MSDOS || WINDOWSNT */
870

871
#ifdef MSDOS
872 873 874 875 876 877 878
  if (!isatty (fileno (stdin)))
    setmode (fileno (stdin), O_BINARY);
  if (!isatty (fileno (stdout)))
    {
      fflush (stdout);
      setmode (fileno (stdout), O_BINARY);
    }
879 880
#endif /* MSDOS */

881 882 883 884 885 886 887 888 889 890 891 892 893 894
  /* Skip initial setlocale if LC_ALL is "C", as it's not needed in that case.
     The build procedure uses this while dumping, to ensure that the
     dumped Emacs does not have its system locale tables initialized,
     as that might cause screwups when the dumped Emacs starts up.  */
  {
    char *lc_all = getenv ("LC_ALL");
    do_initial_setlocale = ! lc_all || strcmp (lc_all, "C");
  }

  /* Set locale now, so that initial error messages are localized properly.
     fixup_locale must wait until later, since it builds strings.  */
  if (do_initial_setlocale)
    setlocale (LC_ALL, "");

Jim Blandy's avatar
Jim Blandy committed
895 896
  inhibit_window_system = 0;

Pavel Janík's avatar
Pavel Janík committed
897
  /* Handle the -t switch, which specifies filename to use as terminal.  */
898 899 900 901 902 903
  while (1)
    {
      char *term;
      if (argmatch (argv, argc, "-t", "--terminal", 4, &term, &skip_args))
	{
	  int result;
904 905 906
	  emacs_close (0);
	  emacs_close (1);
	  result = emacs_open (term, O_RDWR, 0);
907
	  if (result < 0 || fcntl (0, F_DUPFD_CLOEXEC, 1) < 0)
908 909
	    {
	      char *errstring = strerror (errno);
910
	      fprintf (stderr, "%s: %s: %s\n", argv[0], term, errstring);
911 912 913 914
	      exit (1);
	    }
	  if (! isatty (0))
	    {
915
	      fprintf (stderr, "%s: %s: not a tty\n", argv[0], term);
916 917 918
	      exit (1);
	    }
	  fprintf (stderr, "Using %s\n", term);
919
#ifdef HAVE_WINDOW_SYSTEM
920
	  inhibit_window_system = 1; /* -t => -nw */
Jim Blandy's avatar
Jim Blandy committed
921
#endif
922 923 924 925 926
	}
      else
	break;
    }

927
  /* Command line option --no-windows is deprecated and thus not mentioned
Paul Eggert's avatar
Paul Eggert committed
928
     in the manual and usage information.  */
929 930
  if (argmatch (argv, argc, "-nw", "--no-window-system", 6, NULL, &skip_args)
      || argmatch (argv, argc, "-nw", "--no-windows", 6, NULL, &skip_args))
Karl Heuer's avatar
Karl Heuer committed
931
    inhibit_window_system = 1;
Jim Blandy's avatar
Jim Blandy committed
932

Karl Heuer's avatar
Karl Heuer committed
933
  /* Handle the -batch switch, which means don't do interactive display.  */
Jim Blandy's avatar
Jim Blandy committed
934
  noninteractive = 0;
935
  if (argmatch (argv, argc, "-batch", "--batch", 5, NULL, &skip_args))
936 937 938 939
    {
      noninteractive = 1;
      Vundo_outer_limit = Qnil;
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
940 941 942
  if (argmatch (argv, argc, "-script", "--script", 3, &junk, &skip_args))
    {
      noninteractive = 1;	/* Set batch mode.  */
Glenn Morris's avatar
Glenn Morris committed
943
      /* Convert --script to -scriptload, un-skip it, and sort again
944
	 so that it will be handled in proper sequence.  */
945
      /* FIXME broken for --script=FILE - is that supposed to work?  */
946
      argv[skip_args - 1] = (char *) "-scriptload";
Richard M. Stallman's avatar
Richard M. Stallman committed
947 948 949
      skip_args -= 2;
      sort_args (argc, argv);
    }
Karl Heuer's avatar
Karl Heuer committed
950

Pavel Janík's avatar
Pavel Janík committed
951
  /* Handle the --help option, which gives a usage message.  */
952
  if (argmatch (argv, argc, "-help", "--help", 3, NULL, &skip_args))
Jim Blandy's avatar
Jim Blandy committed
953
    {
Paul Eggert's avatar
Paul Eggert committed
954 955 956 957
      int i;
      printf ("Usage: %s [OPTION-OR-FILENAME]...\n", argv[0]);
      for (i = 0; i < sizeof usage_message / sizeof *usage_message; i++)
	fputs (usage_message[i], stdout);
Karl Heuer's avatar
Karl Heuer committed
958
      exit (0);
Jim Blandy's avatar
Jim Blandy committed
959 960
    }

961 962
  if (argmatch (argv, argc, "-daemon", "--daemon", 5, NULL, &skip_args)
      || argmatch (argv, argc, "-daemon", "--daemon", 5, &dname_arg, &skip_args))
963
    {
964
#ifndef DOS_NT
965 966 967 968 969
      pid_t f;

      /* Start as a daemon: fork a new child process which will run the
	 rest of the initialization code, then exit.

970 971 972 973 974 975 976 977 978 979 980 981 982 983
	 Detaching a daemon requires the following steps:
	 - fork
	 - setsid
	 - exit the parent
	 - close the tty file-descriptors

	 We only want to do the last 2 steps once the daemon is ready to
	 serve requests, i.e. after loading .emacs (initialization).
	 OTOH initialization may start subprocesses (e.g. ispell) and these
	 should be run from the proper process (the one that will end up
	 running as daemon) and with the proper "session id" in order for
	 them to keep working after detaching, so fork and setsid need to be
	 performed before initialization.

984 985 986 987
	 We want to avoid exiting before the server socket is ready, so
	 use a pipe for synchronization.  The parent waits for the child
	 to close its end of the pipe (using `daemon-initialized')
	 before exiting.  */
988
      if (emacs_pipe (daemon_pipe) != 0)
989 990 991 992 993
	{
	  fprintf (stderr, "Cannot pipe!\n");
	  exit (1);
	}

994
#ifndef DAEMON_MUST_EXEC
995 996 997 998
#ifdef USE_GTK
      fprintf (stderr, "\nWarning: due to a long standing Gtk+ bug\nhttp://bugzilla.gnome.org/show_bug.cgi?id=85715\n\
Emacs might crash when run in daemon mode and the X11 connection is unexpectedly lost.\n\
Using an Emacs configured with --with-x-toolkit=lucid does not have this problem.\n");
999
#endif /* USE_GTK */
1000
      f = fork ();
1001
#else /* DAEMON_MUST_EXEC */
1002 1003 1004 1005
      if (!dname_arg || !strchr (dname_arg, '\n'))
	  f = fork ();  /* in orig */
      else
	  f = 0;  /* in exec'd */
1006
#endif /* !DAEMON_MUST_EXEC */
1007
      if (f > 0)
1008 1009 1010 1011 1012
	{
	  int retval;
	  char buf[1];

	  /* Close unused writing end of the pipe.  */
1013
	  emacs_close (daemon_pipe[1]);
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026

	  /* Just wait for the child to close its end of the pipe.  */
	  do
	    {
	      retval = read (daemon_pipe[0], &buf, 1);
	    }
	  while (retval == -1 && errno == EINTR);

	  if (retval < 0)
	    {
	      fprintf (stderr, "Error reading status from child\n");
	      exit (1);
	    }
1027 1028 1029 1030 1031
	  else if (retval == 0)
	    {
	      fprintf (stderr, "Error: server did not start correctly\n");
	      exit (1);
	    }
1032

1033
	  emacs_close (daemon_pipe[0]);
1034 1035
	  exit (0);
	}
1036 1037
      if (f < 0)
	{
1038 1039
	  emacs_perror ("fork");
	  exit (EXIT_CANCELED);
1040 1041
	}

1042
#ifdef DAEMON_MUST_EXEC
1043
      {
Adrian Robert's avatar
Adrian Robert committed
1044
        /* In orig process, forked as child, OR in exec'd. */
1045
        if (!dname_arg || !strchr (dname_arg, '\n'))
Adrian Robert's avatar
Adrian Robert committed
1046
          {  /* In orig, child: now exec w/special daemon name. */
1047
            char fdStr[80];
1048 1049 1050 1051
	    int fdStrlen =
	      snprintf (fdStr, sizeof fdStr,
			"--daemon=\n%d,%d\n%s", daemon_pipe[0],
			daemon_pipe[1], dname_arg ? dname_arg : "");
1052

1053
	    if (! (0 <= fdStrlen && fdStrlen < sizeof fdStr))
1054 1055
              {
                fprintf (stderr, "daemon: child name too long\n");
1056
                exit (EXIT_CANNOT_INVOKE);
1057 1058 1059 1060
              }

            argv[skip_args] = fdStr;

1061
            execvp (argv[0], argv);
1062
	    emacs_perror (argv[0]);
1063
	    exit (errno == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1064 1065
          }

Adrian Robert's avatar
Adrian Robert committed
1066
        /* In exec'd: parse special dname into pipe and name info. */
1067 1068 1069 1070
        if (!dname_arg || !strchr (dname_arg, '\n')
            || strlen (dname_arg) < 1 || strlen (dname_arg) > 70)
          {
            fprintf (stderr, "emacs daemon: daemon name absent or too long\n");