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

3
Copyright (C) 1985-1987, 1993-1995, 1997-1999, 2001-2012
4
  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 28
#include <signal.h>
#include <errno.h>
#include <stdio.h>

#include <sys/types.h>
#include <sys/file.h>
29
#include <setjmp.h>
30 31
#include <unistd.h>

32 33
#include "lisp.h"

34 35
#ifdef WINDOWSNT
#include <fcntl.h>
36 37
#include <windows.h> /* just for w32.h */
#include "w32.h"
38
#include "w32heap.h" /* for prototype of sbrk */
39 40
#endif

41 42 43 44 45
#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
46
#include "commands.h"
Joseph Arceneaux's avatar
Joseph Arceneaux committed
47
#include "intervals.h"
48
#include "character.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
49
#include "buffer.h"
Stefan Monnier's avatar
Stefan Monnier committed
50
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
51

52
#include "systty.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
53
#include "blockinput.h"
54
#include "syssignal.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
55
#include "process.h"
56
#include "frame.h"
57
#include "termhooks.h"
Andreas Schwab's avatar
Andreas Schwab committed
58
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
59
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
60

Ted Zlatanov's avatar
Ted Zlatanov committed
61 62 63 64
#ifdef HAVE_GNUTLS
#include "gnutls.h"
#endif

65 66 67 68
#ifdef HAVE_NS
#include "nsterm.h"
#endif

69 70 71 72 73 74
#if (defined PROFILING \
     && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
# include <sys/gmon.h>
extern void moncontrol (int mode);
#endif

75 76 77 78
#ifdef HAVE_X_WINDOWS
#include "xterm.h"
#endif

79 80 81 82
#ifdef HAVE_SETLOCALE
#include <locale.h>
#endif

83 84 85 86 87
#ifdef HAVE_SETRLIMIT
#include <sys/time.h>
#include <sys/resource.h>
#endif

88 89 90 91
#ifdef HAVE_PERSONALITY_LINUX32
#include <sys/personality.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
92 93 94 95
#ifndef O_RDWR
#define O_RDWR 2
#endif

96
static const char emacs_version[] = VERSION;
97
static const char emacs_copyright[] = "Copyright (C) 2012 Free Software Foundation, Inc.";
98

99 100
/* 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
101

Jim Blandy's avatar
Jim Blandy committed
102 103 104 105 106
/* Set nonzero after Emacs has started up the first time.
  Prevents reinitialization of the Lisp world and keymaps
  on subsequent starts.  */
int initialized;

107 108 109 110
#ifdef DARWIN_OS
extern void unexec_init_emacs_zone (void);
#endif

111 112 113
#ifdef DOUG_LEA_MALLOC
/* Preserves a pointer to the memory allocated that copies that
   static data inside glibc's malloc.  */
114
static void *malloc_state_ptr;
115
/* From glibc, a routine that returns a copy of the malloc internal state.  */
116
extern void *malloc_get_state (void);
117
/* From glibc, a routine that overwrites the malloc internal state.  */
118
extern int malloc_set_state (void*);
119
/* Non-zero if the MALLOC_CHECK_ environment variable was set while
120
   dumping.  Used to work around a bug in glibc's malloc.  */
121
static int malloc_using_checking;
122 123
#endif

124 125
Lisp_Object Qfile_name_handler_alist;

Glenn Morris's avatar
Glenn Morris committed
126 127
Lisp_Object Qrisky_local_variable;

128 129
Lisp_Object Qkill_emacs;

130
/* If non-zero, Emacs should not attempt to use a window-specific code,
Pavel Janík's avatar
Pavel Janík committed
131
   but instead should use the virtual terminal under which it was started.  */
Jim Blandy's avatar
Jim Blandy committed
132 133
int inhibit_window_system;

Pavel Janík's avatar
Pavel Janík committed
134 135
/* If non-zero, a filter or a sentinel is running.  Tested to save the match
   data on the first attempt to change it inside asynchronous code.  */
136 137
int running_asynch_code;

Juanma Barranquero's avatar
Juanma Barranquero committed
138
#if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
Pavel Janík's avatar
Pavel Janík committed
139
/* If non-zero, -d was specified, meaning we're using some window system.  */
Jim Blandy's avatar
Jim Blandy committed
140 141 142 143 144 145 146
int display_arg;
#endif

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

147
#if defined (DOUG_LEA_MALLOC) || defined (GNU_LINUX)
148 149
/* The address where the heap starts (from the first sbrk (0) call).  */
static void *my_heap_start;
150
#endif
151

152
#ifdef GNU_LINUX
153
/* The gap between BSS end and heap start as far as we can tell.  */
154 155
static uprintmax_t heap_bss_diff;
#endif
156

Jim Blandy's avatar
Jim Blandy committed
157 158 159
/* Nonzero means running Emacs without interactive terminal.  */
int noninteractive;

160 161 162
/* Nonzero means remove site-lisp directories from load-path.  */
int no_site_lisp;

163 164
/* Name for the server started by the daemon.*/
static char *daemon_name;
165

166 167
/* Pipe used to send exit notification to the daemon parent at
   startup.  */
168
int daemon_pipe[2];
169

170 171 172
/* Save argv and argc.  */
char **initial_argv;
int initial_argc;
173

174
static void sort_args (int argc, char **argv);
175
static void syms_of_emacs (void);
Gerd Moellmann's avatar
Gerd Moellmann committed
176

Kenichi Handa's avatar
Kenichi Handa committed
177 178
/* MSVC needs each string be shorter than 2048 bytes, so the usage
   strings below are split to not overflow this limit.  */
179
#define USAGE1 "\
Gerd Moellmann's avatar
Gerd Moellmann committed
180 181 182 183 184 185
Usage: %s [OPTION-OR-FILENAME]...\n\
\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\
186
Run M-x info RET m emacs RET m emacs invocation RET inside Emacs to\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
187 188 189 190
read the main documentation for these command-line arguments.\n\
\n\
Initialization options:\n\
\n\
Kenichi Handa's avatar
Kenichi Handa committed
191
--batch                     do not do interactive display; implies -q\n\
192
--chdir DIR                 change to directory DIR\n\
Glenn Morris's avatar
Glenn Morris committed
193
--daemon                    start a server in the background\n\
Kenichi Handa's avatar
Kenichi Handa committed
194 195 196 197 198 199
--debug-init                enable Emacs Lisp debugger for init file\n\
--display, -d DISPLAY       use X server DISPLAY\n\
--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\
200
--no-site-lisp, -nsl        do not add site-lisp directories to load-path\n\
Kenichi Handa's avatar
Kenichi Handa committed
201
--no-splash                 do not display a splash screen on startup\n\
202
--no-window-system, -nw     do not communicate with X, ignoring $DISPLAY\n\
203 204
--quick, -Q                 equivalent to:\n\
                              -q --no-site-file --no-site-lisp --no-splash\n\
Kenichi Handa's avatar
Kenichi Handa committed
205 206 207 208 209 210
--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\
\n%s"

#define USAGE2 "\
Gerd Moellmann's avatar
Gerd Moellmann committed
211 212
Action options:\n\
\n\
Kenichi Handa's avatar
Kenichi Handa committed
213
FILE                    visit FILE using find-file\n\
214 215
+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
216 217 218 219 220 221 222 223 224 225
--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\
--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\
226 227
\n"

Kenichi Handa's avatar
Kenichi Handa committed
228
#define USAGE3 "\
229
Display options:\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
230
\n\
Kenichi Handa's avatar
Kenichi Handa committed
231
--background-color, -bg COLOR   window background color\n\
232 233
--basic-display, -D             disable many display features;\n\
                                  used for debugging Emacs\n\
Kenichi Handa's avatar
Kenichi Handa committed
234 235
--border-color, -bd COLOR       main border color\n\
--border-width, -bw WIDTH       width of main border\n\
236
--color, --color=MODE           override color mode for character terminals;\n\
237 238
                                  MODE defaults to `auto', and\n\
                                  can also be `never', `always',\n\
Kenichi Handa's avatar
Kenichi Handa committed
239 240 241 242 243
                                  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\
--fullheight, -fh               make the first frame high as the screen\n\
244
--fullscreen, -fs               make the first frame fullscreen\n\
Kenichi Handa's avatar
Kenichi Handa committed
245
--fullwidth, -fw                make the first frame wide as the screen\n\
246
--maximized, -mm                make the first frame maximized\n\
Kenichi Handa's avatar
Kenichi Handa committed
247
--geometry, -g GEOMETRY         window geometry\n\
Jan Djärv's avatar
Jan Djärv committed
248
--no-bitmap-icon, -nbi          do not use picture of gnu for Emacs icon\n\
Kenichi Handa's avatar
Kenichi Handa committed
249 250 251 252 253
--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\
254
--no-blinking-cursor, -nbc      disable blinking cursor\n\
Kenichi Handa's avatar
Kenichi Handa committed
255 256 257 258
--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
259
--parent-id XID                 set parent window\n\
Kenichi Handa's avatar
Kenichi Handa committed
260 261
--help                          display this help and exit\n\
--version                       output version information and exit\n\
262 263 264
\n"

#define USAGE4 "\
Gerd Moellmann's avatar
Gerd Moellmann committed
265 266 267 268 269 270
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\
271
\n\
272
Report bugs to bug-gnu-emacs@gnu.org.  First, please see the Bugs\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
273 274
section of the Emacs manual or the file BUGS.\n"

Jim Blandy's avatar
Jim Blandy committed
275

Pavel Janík's avatar
Pavel Janík committed
276
/* Signal code for the fatal signal that was received.  */
277
static int fatal_error_code;
Jim Blandy's avatar
Jim Blandy committed
278

Pavel Janík's avatar
Pavel Janík committed
279
/* Nonzero if handling a fatal error already.  */
Jim Blandy's avatar
Jim Blandy committed
280 281
int fatal_error_in_progress;

Pavel Janík's avatar
Pavel Janík committed
282
/* If non-null, call this function from fatal_error_signal before
283 284
   committing suicide.  */

285
static void (*fatal_error_signal_hook) (void);
286

287
#ifdef FORWARD_SIGNAL_TO_MAIN_THREAD
288 289
/* When compiled with GTK and running under Gnome,
   multiple threads may be created.  Keep track of our main
290
   thread to make sure signals are delivered to it (see syssignal.h).  */
291 292 293 294

pthread_t main_thread;
#endif

295 296 297
#ifdef HAVE_NS
/* NS autrelease pool, for memory management.  */
static void *ns_pool;
298 299
#endif

300

301

Pavel Janík's avatar
Pavel Janík committed
302
/* Handle bus errors, invalid instruction, etc.  */
303 304 305
#ifndef FLOAT_CATCH_SIGILL
static
#endif
306
void
307
fatal_error_signal (int sig)
Jim Blandy's avatar
Jim Blandy committed
308
{
309
  SIGNAL_THREAD_CHECK (sig);
Jim Blandy's avatar
Jim Blandy committed
310 311 312
  fatal_error_code = sig;
  signal (sig, SIG_DFL);

313 314
  TOTALLY_UNBLOCK_INPUT;

Jim Blandy's avatar
Jim Blandy committed
315
  /* If fatal error occurs in code below, avoid infinite recursion.  */
316 317 318
  if (! fatal_error_in_progress)
    {
      fatal_error_in_progress = 1;
Jim Blandy's avatar
Jim Blandy committed
319

320
      if (sig == SIGTERM || sig == SIGHUP || sig == SIGINT)
321 322
        Fkill_emacs (make_number (sig));

323
      shut_down_emacs (sig, 0, Qnil);
324
    }
Jim Blandy's avatar
Jim Blandy committed
325

326 327 328 329
  /* Signal the same code; this time it will really be fatal.
     Remember that since we're in a signal handler, the signal we're
     going to send is probably blocked, so we have to unblock it if we
     want to really receive it.  */
330
#ifndef MSDOS
331
  sigunblock (sigmask (fatal_error_code));
332
#endif
333 334 335

  if (fatal_error_signal_hook)
    fatal_error_signal_hook ();
Pavel Janík's avatar
Pavel Janík committed
336

Jim Blandy's avatar
Jim Blandy committed
337 338
  kill (getpid (), fatal_error_code);
}
339 340 341

#ifdef SIGDANGER

Richard M. Stallman's avatar
Richard M. Stallman committed
342
/* Handler for SIGDANGER.  */
343
void
Andreas Schwab's avatar
Andreas Schwab committed
344
memory_warning_signal (int sig)
345 346
{
  signal (sig, memory_warning_signal);
347
  SIGNAL_THREAD_CHECK (sig);
348 349

  malloc_warning ("Operating system warns that virtual memory is running low.\n");
350 351 352

  /* It might be unsafe to call do_auto_save now.  */
  force_auto_save_soon ();
353 354
}
#endif
Richard M. Stallman's avatar
Richard M. Stallman committed
355 356

/* We define abort, rather than using it from the library,
Karl Heuer's avatar
Karl Heuer committed
357
   so that GDB can return from a breakpoint here.
Pavel Janík's avatar
Pavel Janík committed
358
   MSDOS has its own definition in msdos.c.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
359

360
#if ! defined (DOS_NT) && ! defined (NO_ABORT)
361

362
void
Andreas Schwab's avatar
Andreas Schwab committed
363
abort (void)
Richard M. Stallman's avatar
Richard M. Stallman committed
364 365
{
  kill (getpid (), SIGABRT);
366 367
  /* This shouldn't be executed, but it prevents a warning.  */
  exit (1);
Richard M. Stallman's avatar
Richard M. Stallman committed
368
}
Karl Heuer's avatar
Karl Heuer committed
369
#endif
Richard M. Stallman's avatar
Richard M. Stallman committed
370

Jim Blandy's avatar
Jim Blandy committed
371

Pavel Janík's avatar
Pavel Janík committed
372
/* Code for dealing with Lisp access to the Unix command line.  */
Jim Blandy's avatar
Jim Blandy committed
373

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

382 383 384
  initial_argv = argv;
  initial_argc = argc;

385 386 387 388
  raw_name = build_string (argv[0]);

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

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

396 397 398 399 400 401
  /* 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,
402
		       Vexec_suffixes, &found, make_number (X_OK));
403
      if (yes == 1)
404 405 406
	{
	  /* Add /: to the front of the name
	     if it would otherwise be treated as magic.  */
407 408
	  handler = Ffind_file_name_handler (found, Qt);
	  if (! NILP (handler))
409 410 411
	    found = concat2 (build_string ("/:"), found);
	  Vinvocation_directory = Ffile_name_directory (found);
	}
412
    }
413

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

420 421 422 423 424 425 426 427
  Vinstallation_directory = Qnil;

  if (!NILP (Vinvocation_directory))
    {
      dir = Vinvocation_directory;
      name = Fexpand_file_name (Vinvocation_name, dir);
      while (1)
	{
428
	  Lisp_Object tem, lib_src_exists;
429 430
	  Lisp_Object etc_exists, info_exists;

431 432 433 434 435
	  /* 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);
436

437
#ifdef MSDOS
438 439 440 441 442
	  /* 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);
443 444 445
#else
	  info_exists = Qnil;
#endif
446 447

	  if (!NILP (lib_src_exists) || !NILP (info_exists))
448
	    {
449 450 451
	      tem = Fexpand_file_name (build_string ("etc"), dir);
	      etc_exists = Ffile_exists_p (tem);
	      if (!NILP (etc_exists))
452
		{
453 454 455
		  Vinstallation_directory
		    = Ffile_name_as_directory (dir);
		  break;
456 457 458 459
		}
	    }

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

463 464 465

#ifdef MSDOS
	  /* See the MSDOS commentary above.  */
466 467
	  tem = Fexpand_file_name (build_string ("../info"), dir);
	  info_exists = Ffile_exists_p (tem);
468 469 470
#else
	  info_exists = Qnil;
#endif
471 472

	  if (!NILP (lib_src_exists) || !NILP (info_exists))
473
	    {
474 475 476
	      tem = Fexpand_file_name (build_string ("../etc"), dir);
	      etc_exists = Ffile_exists_p (tem);
	      if (!NILP (etc_exists))
477
		{
478 479 480 481
		  tem = Fexpand_file_name (build_string (".."), dir);
		  Vinstallation_directory
		    = Ffile_name_as_directory (tem);
		  break;
482 483 484 485 486 487 488 489
		}
	    }

	  /* 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))
	    {
490
	      name = Fexpand_file_name (tem, dir);
491 492 493 494 495 496 497
	      dir = Ffile_name_directory (name);
	    }
	  else
	    break;
	}
    }

Jim Blandy's avatar
Jim Blandy committed
498 499 500 501 502
  Vcommand_line_args = Qnil;

  for (i = argc - 1; i >= 0; i--)
    {
      if (i == 0 || i > skip_args)
503 504 505
	/* 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
506
	Vcommand_line_args
507
	  = Fcons (make_unibyte_string (argv[i], strlen (argv[i])),
508
		   Vcommand_line_args);
Jim Blandy's avatar
Jim Blandy committed
509
    }
510 511

  unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
512
}
513 514

DEFUN ("invocation-name", Finvocation_name, Sinvocation_name, 0, 0, 0,
Pavel Janík's avatar
Pavel Janík committed
515 516
       doc: /* Return the program name that was used to run Emacs.
Any directory names are omitted.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
517
  (void)
518 519 520 521
{
  return Fcopy_sequence (Vinvocation_name);
}

522
DEFUN ("invocation-directory", Finvocation_directory, Sinvocation_directory,
Pavel Janík's avatar
Pavel Janík committed
523 524
       0, 0, 0,
       doc: /* Return the directory name in which the Emacs executable was located.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
525
  (void)
526 527 528 529
{
  return Fcopy_sequence (Vinvocation_directory);
}

Jim Blandy's avatar
Jim Blandy committed
530

531 532 533 534 535 536
#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.  */
static char dump_tz[] = "UtC0";
#endif

537
#ifndef ORDINARY_LINK
538 539 540 541 542
/* We don't include crtbegin.o and crtend.o in the link,
   so these functions and variables might be missed.
   Provide dummy definitions to avoid error.
   (We don't have any real constructors or destructors.)  */
#ifdef __GNUC__
543 544 545

/* Define a dummy function F.  Declare F too, to pacify gcc
   -Wmissing-prototypes.  */
546
#define DEFINE_DUMMY_FUNCTION(f) \
547
  void f (void) ATTRIBUTE_CONST EXTERNALLY_VISIBLE; void f (void) {}
548

549
#ifndef GCC_CTORS_IN_LIBC
550 551 552
DEFINE_DUMMY_FUNCTION (__do_global_ctors)
DEFINE_DUMMY_FUNCTION (__do_global_ctors_aux)
DEFINE_DUMMY_FUNCTION (__do_global_dtors)
Richard M. Stallman's avatar
Richard M. Stallman committed
553
/* GNU/Linux has a bug in its library; avoid an error.  */
554
#ifndef GNU_LINUX
555
char * __CTOR_LIST__[2] EXTERNALLY_VISIBLE = { (char *) (-1), 0 };
556
#endif
557
char * __DTOR_LIST__[2] EXTERNALLY_VISIBLE = { (char *) (-1), 0 };
558
#endif /* GCC_CTORS_IN_LIBC */
559
DEFINE_DUMMY_FUNCTION (__main)
560
#endif /* __GNUC__ */
561
#endif /* ORDINARY_LINK */
562

Karl Heuer's avatar
Karl Heuer committed
563 564 565 566 567 568 569 570 571
/* 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.  */
572

Karl Heuer's avatar
Karl Heuer committed
573
static int
574 575
argmatch (char **argv, int argc, const char *sstr, const char *lstr,
          int minlen, char **valptr, int *skipptr)
Karl Heuer's avatar
Karl Heuer committed
576
{
577
  char *p = NULL;
578
  ptrdiff_t arglen;
579 580 581 582 583 584 585
  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
586 587 588 589 590 591 592 593 594 595 596 597 598
  if (arg == NULL)
    return 0;
  if (strcmp (arg, sstr) == 0)
    {
      if (valptr != NULL)
	{
	  *valptr = argv[*skipptr+2];
	  *skipptr += 2;
	}
      else
	*skipptr += 1;
      return 1;
    }
599
  arglen = (valptr != NULL && (p = strchr (arg, '=')) != NULL
Karl Heuer's avatar
Karl Heuer committed
600
	    ? p - arg : strlen (arg));
601
  if (lstr == 0 || arglen < minlen || strncmp (arg, lstr, arglen) != 0)
Karl Heuer's avatar
Karl Heuer committed
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
    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;
    }
}

626
#ifdef DOUG_LEA_MALLOC
Jim Blandy's avatar
Jim Blandy committed
627

628 629 630 631 632
/* 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
633
malloc_initialize_hook (void)
634
{
635
#ifndef USE_CRT_DLL
636
  extern char **environ;
637
#endif
638

639 640
  if (initialized)
    {
641 642 643
      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
644 645 646 647
	   malloc checking.  Can't use unsetenv, since that calls malloc.  */
	{
	  char **p;

648
	  for (p = environ; p && *p; p++)
649 650 651 652 653 654 655 656
	    if (strncmp (*p, "MALLOC_CHECK_=", 14) == 0)
	      {
		do
		  *p = p[1];
		while (*++p);
		break;
	      }
	}
657

658
      malloc_set_state (malloc_state_ptr);
659
#ifndef XMALLOC_OVERRUN_CHECK
660
      free (malloc_state_ptr);
661
#endif
662
    }
663
  else
664 665 666 667 668
    {
      if (my_heap_start == 0)
        my_heap_start = sbrk (0);
      malloc_using_checking = getenv ("MALLOC_CHECK_") != NULL;
    }
669 670
}

671
void (*__malloc_initialize_hook) (void) EXTERNALLY_VISIBLE = malloc_initialize_hook;
672 673 674

#endif /* DOUG_LEA_MALLOC */

675

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

697
#if GC_MARK_STACK
698 699 700
  stack_base = &dummy;
#endif

701 702 703 704 705
#if defined (USE_GTK) && defined (G_SLICE_ALWAYS_MALLOC)
  /* This is used by the Cygwin build.  */
  setenv ("G_SLICE", "always-malloc", 1);
#endif

706
#ifdef GNU_LINUX
707 708 709 710 711 712 713 714 715 716
  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);
    }
717
#endif
718

719 720 721 722 723
#ifdef RUN_TIME_REMAP
  if (initialized)
    run_time_remap (argv[0]);
#endif

724 725
/* If using unexmacosx.c (set by s/darwin.h), we must do this. */
#ifdef DARWIN_OS
726 727 728 729
  if (!initialized)
    unexec_init_emacs_zone ();
#endif

730
  sort_args (argc, argv);
731 732
  argc = 0;
  while (argv[argc]) argc++;
733

734
  if (argmatch (argv, argc, "-version", "--version", 3, NULL, &skip_args))
735
    {
736 737
      const char *version, *copyright;
      if (initialized)
738
	{
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
	  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
	    {
754 755
	      version = SSDATA (tem);
	      copyright = SSDATA (tem2);
756
	    }
757
	}
758 759
      else
	{
760 761
	  version = emacs_version;
	  copyright = emacs_copyright;
762
	}
763 764 765 766 767 768 769 770
      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);
771
    }
772 773 774 775 776 777 778 779

  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);
      }
780

781

782 783 784 785
#ifdef HAVE_PERSONALITY_LINUX32
  if (!initialized
      && (strcmp (argv[argc-1], "dump") == 0
          || strcmp (argv[argc-1], "bootstrap") == 0)
786
      && ! getenv ("EMACS_HEAP_EXEC"))
787
    {
788
      static char heapexec[] = "EMACS_HEAP_EXEC=true";
789
      /* Set this so we only do this once.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
790
      putenv (heapexec);
791

792 793
      /* A flag to turn off address randomization which is introduced
         in linux kernel shipped with fedora core 4 */
794
#define ADD_NO_RANDOMIZE 0x0040000
795
      personality (PER_LINUX32 | ADD_NO_RANDOMIZE);
796 797
#undef  ADD_NO_RANDOMIZE

798
      execvp (argv[0], argv);
799

800 801
      /* If the exec fails, try to dump anyway.  */
      perror ("execvp");
802 803 804
    }
#endif /* HAVE_PERSONALITY_LINUX32 */

805
#if defined (HAVE_SETRLIMIT) && defined (RLIMIT_STACK)
806 807 808 809 810 811 812 813
  /* 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))
814
    {
815
      long newlim;
816
      extern size_t re_max_failures;
817 818 819 820 821 822 823 824
      /* 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;
825 826 827 828 829
#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
830
      newlim = (newlim + getpagesize () - 1) / getpagesize () * getpagesize ();
831
#endif
832
      if (newlim > rlim.rlim_max)
833 834
	{
	  newlim = rlim.rlim_max;
835 836
	  /* Don't let regex.c overflow the stack we have.  */
	  re_max_failures = (newlim - 200000) / ratio;
837
	}
838 839 840
      if (rlim.rlim_cur < newlim)
	rlim.rlim_cur = newlim;

841 842
      setrlimit (RLIMIT_STACK, &rlim);
    }
843
#endif /* HAVE_SETRLIMIT and RLIMIT_STACK */
844

Jim Blandy's avatar
Jim Blandy committed
845 846 847 848
  /* Record (approximately) where the stack begins.  */
  stack_bottom = &stack_bottom_variable;

  clearerr (stdin);
849

Jim Blandy's avatar
Jim Blandy committed
850
#ifndef SYSTEM_MALLOC
851 852
  /* Arrange to get warning messages as memory fills up.  */
  memory_warnings (0, malloc_warning);
853

854 855 856
  /* Call malloc at least once, to run the initial __malloc_hook.
     Also call realloc and free for consistency.  */
  free (realloc (malloc (4), 4));
857

858
# ifndef SYNC_INPUT
859 860
  /* Arrange to disable interrupt input inside malloc etc.  */
  uninterrupt_malloc ();
861
# endif /* not SYNC_INPUT */
Jim Blandy's avatar
Jim Blandy committed
862 863
#endif	/* not SYSTEM_MALLOC */

864
#ifdef FORWARD_SIGNAL_TO_MAIN_THREAD
865
  main_thread = pthread_self ();
866
#endif /* FORWARD_SIGNAL_TO_MAIN_THREAD */
867

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

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

884 885 886 887 888 889 890 891 892 893 894 895 896 897
  /* 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
898 899
  inhibit_window_system = 0;

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

930
  /* Command line option --no-windows is deprecated and thus not mentioned
Paul Eggert's avatar
Paul Eggert committed
931
     in the manual and usage information.  */
932 933
  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
934
    inhibit_window_system = 1;
Jim Blandy's avatar
Jim Blandy committed
935

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

Pavel Janík's avatar
Pavel Janík committed
954
  /* Handle the --help option, which gives a usage message.  */
955
  if (argmatch (argv, argc, "-help", "--help", 3, NULL, &skip_args))
Jim Blandy's avatar
Jim Blandy committed
956
    {
Kenichi Handa's avatar
Kenichi Handa committed
957 958
      printf (USAGE1, argv[0], USAGE2);
      printf (USAGE3);
959
      printf (USAGE4);
Karl Heuer's avatar
Karl Heuer committed
960
      exit (0);
Jim Blandy's avatar
Jim Blandy committed
961 962
    }

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

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

972 973 974 975 976 977 978 979 980 981 982 983 984 985
	 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.

986 987 988 989 990 991 992 993 994 995
	 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.  */
      if (pipe (daemon_pipe) == -1)
	{
	  fprintf (stderr, "Cannot pipe!\n");
	  exit (1);
	}

996
#ifndef NS_IMPL_COCOA
997 998 999 1000 1001
#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");
#endif
1002
      f = fork ();
Adrian Robert's avatar
Adrian Robert committed
1003 1004 1005 1006
#else /* NS_IMPL_COCOA */
      /* Under Cocoa we must do fork+exec as CoreFoundation lib fails in
         forked process: http://developer.apple.com/ReleaseNotes/
                                  CoreFoundation/CoreFoundation.html)
1007 1008 1009 1010 1011 1012 1013
         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. */
      if (!dname_arg || !strchr (dname_arg, '\n'))
	  f = fork ();  /* in orig */
      else
	  f = 0;  /* in exec'd */
Adrian Robert's avatar
Adrian Robert committed
1014
#endif /* NS_IMPL_COCOA */
1015
      if (f > 0)
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
	{
	  int retval;
	  char buf[1];

	  /* Close unused writing end of the pipe.  */
	  close (daemon_pipe[1]);

	  /* 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);
	    }
1035 1036 1037 1038 1039
	  else if (retval == 0)
	    {
	      fprintf (stderr, "Error: server did not start correctly\n");
	      exit (1);
	    }
1040 1041 1042 1043

	  close (daemon_pipe[0]);
	  exit (0);
	}
1044 1045 1046
      if (f < 0)
	{
	  fprintf (stderr, "Cannot fork!\n");
1047
	  exit (1);
1048 1049
	}

1050 1051
#ifdef NS_IMPL_COCOA
      {
Adrian Robert's avatar
Adrian Robert committed
1052
        /* In orig process, forked as child, OR in exec'd. */
1053
        if (!dname_arg || !strchr (dname_arg, '\n'))
Adrian Robert's avatar
Adrian Robert committed
1054
          {  /* In orig, child: now exec w/special daemon name. */
1055
            char fdStr[80];
1056 1057 1058 1059
	    int fdStrlen =
	      snprintf (fdStr, sizeof fdStr,
			"--daemon=\n%d,%d\n%s", daemon_pipe[0],
			daemon_pipe[1], dname_arg ? dname_arg : "");
1060

1061
	    if (! (0 <= fdStrlen && fdStrlen < sizeof fdStr))
1062 1063 1064 1065 1066 1067 1068 1069
              {
                fprintf (stderr, "daemon: child name too long\n");
                exit (1);
              }

            argv[skip_args] = fdStr;

            execv (argv[0], argv);
1070
            fprintf (stderr, "emacs daemon: exec failed: %d\n", errno);
1071 1072 1073
            exit (1);
          }

Adrian Robert's avatar
Adrian Robert committed
1074
        /* In exec'd: parse special dname into pipe and name info. */
1075 1076 1077 1078
        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");
Juanma Barranquero's avatar
Juanma Barranquero committed
1079
            exit (1);
1080 1081