(read_key_sewuence): Use POSN in second event when needed (bug#30955)
[emacs.git] / src / emacs.c
blob8ea61b71fb73d19af9ed7c72cb19911eaa457812
1 /* Fully extensible Emacs, running on Unix, intended for GNU.
3 Copyright (C) 1985-1987, 1993-1995, 1997-1999, 2001-2018 Free Software
4 Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or (at
11 your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. */
21 #define INLINE EXTERN_INLINE
22 #include <config.h>
24 #include <errno.h>
25 #include <fcntl.h>
26 #include <stdlib.h>
28 #include <sys/file.h>
29 #include <unistd.h>
31 #include <close-stream.h>
33 #define MAIN_PROGRAM
34 #include "lisp.h"
35 #include "sysstdio.h"
37 #ifdef WINDOWSNT
38 #include <fcntl.h>
39 #include <sys/socket.h>
40 #include <mbstring.h>
41 #include "w32.h"
42 #include "w32heap.h"
43 #endif
45 #if defined WINDOWSNT || defined HAVE_NTGUI
46 #include "w32select.h"
47 #include "w32font.h"
48 #include "w32common.h"
49 #endif
51 #if defined CYGWIN
52 #include "cygw32.h"
53 #endif
55 #ifdef MSDOS
56 #include <binary-io.h>
57 #include "dosfns.h"
58 #endif
60 #ifdef HAVE_LIBSYSTEMD
61 # include <systemd/sd-daemon.h>
62 # include <sys/socket.h>
63 #endif
65 #ifdef HAVE_WINDOW_SYSTEM
66 #include TERM_HEADER
67 #endif /* HAVE_WINDOW_SYSTEM */
69 #include "intervals.h"
70 #include "character.h"
71 #include "buffer.h"
72 #include "window.h"
73 #include "xwidget.h"
74 #include "atimer.h"
75 #include "blockinput.h"
76 #include "syssignal.h"
77 #include "process.h"
78 #include "frame.h"
79 #include "termhooks.h"
80 #include "keyboard.h"
81 #include "keymap.h"
82 #include "category.h"
83 #include "charset.h"
84 #include "composite.h"
85 #include "dispextern.h"
86 #include "ptr-bounds.h"
87 #include "regex.h"
88 #include "sheap.h"
89 #include "syntax.h"
90 #include "sysselect.h"
91 #include "systime.h"
92 #include "puresize.h"
94 #include "getpagesize.h"
95 #include "gnutls.h"
97 #if (defined PROFILING \
98 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
99 # include <sys/gmon.h>
100 extern void moncontrol (int mode);
101 #endif
103 #ifdef HAVE_SETLOCALE
104 #include <locale.h>
105 #endif
107 #if HAVE_WCHAR_H
108 # include <wchar.h>
109 #endif
111 #ifdef HAVE_SETRLIMIT
112 #include <sys/time.h>
113 #include <sys/resource.h>
114 #endif
116 static const char emacs_version[] = PACKAGE_VERSION;
117 static const char emacs_copyright[] = COPYRIGHT;
118 static const char emacs_bugreport[] = PACKAGE_BUGREPORT;
120 /* Empty lisp strings. To avoid having to build any others. */
121 Lisp_Object empty_unibyte_string, empty_multibyte_string;
123 #ifdef WINDOWSNT
124 /* Cache for externally loaded libraries. */
125 Lisp_Object Vlibrary_cache;
126 #endif
128 /* Set after Emacs has started up the first time.
129 Prevents reinitialization of the Lisp world and keymaps
130 on subsequent starts. */
131 bool initialized;
133 #ifndef CANNOT_DUMP
134 /* Set to true if this instance of Emacs might dump. */
135 # ifndef DOUG_LEA_MALLOC
136 static
137 # endif
138 bool might_dump;
139 #endif
141 /* If true, Emacs should not attempt to use a window-specific code,
142 but instead should use the virtual terminal under which it was started. */
143 bool inhibit_window_system;
145 /* If true, a filter or a sentinel is running. Tested to save the match
146 data on the first attempt to change it inside asynchronous code. */
147 bool running_asynch_code;
149 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
150 /* If true, -d was specified, meaning we're using some window system. */
151 bool display_arg;
152 #endif
154 #if defined GNU_LINUX && !defined CANNOT_DUMP
155 /* The gap between BSS end and heap start as far as we can tell. */
156 static uprintmax_t heap_bss_diff;
157 #endif
159 /* To run as a background daemon under Cocoa or Windows,
160 we must do a fork+exec, not a simple fork.
162 On Cocoa, CoreFoundation lib fails in forked process:
163 http://developer.apple.com/ReleaseNotes/
164 CoreFoundation/CoreFoundation.html)
166 On Windows, a Cygwin fork child cannot access the USER subsystem.
168 We mark being in the exec'd process by a daemon name argument of
169 form "--daemon=\nFD0,FD1\nNAME" where FD are the pipe file descriptors,
170 NAME is the original daemon name, if any. */
171 #if defined NS_IMPL_COCOA || (defined HAVE_NTGUI && defined CYGWIN)
172 # define DAEMON_MUST_EXEC
173 #endif
175 /* True means running Emacs without interactive terminal. */
176 bool noninteractive;
178 /* True means remove site-lisp directories from load-path. */
179 bool no_site_lisp;
181 /* True means put details like time stamps into builds. */
182 bool build_details;
184 /* Name for the server started by the daemon.*/
185 static char *daemon_name;
187 /* 0 not a daemon, 1 new-style (foreground), 2 old-style (background). */
188 int daemon_type;
190 #ifndef WINDOWSNT
191 /* Pipe used to send exit notification to the background daemon parent at
192 startup. On Windows, we use a kernel event instead. */
193 static int daemon_pipe[2];
194 #else
195 HANDLE w32_daemon_event;
196 #endif
198 /* Save argv and argc. */
199 char **initial_argv;
200 int initial_argc;
202 static void sort_args (int argc, char **argv);
203 static void syms_of_emacs (void);
205 /* C99 needs each string to be at most 4095 characters, and the usage
206 strings below are split to not overflow this limit. */
207 static char const *const usage_message[] =
208 { "\
210 Run Emacs, the extensible, customizable, self-documenting real-time\n\
211 display editor. The recommended way to start Emacs for normal editing\n\
212 is with no options at all.\n\
214 Run M-x info RET m emacs RET m emacs invocation RET inside Emacs to\n\
215 read the main documentation for these command-line arguments.\n\
217 Initialization options:\n\
221 --batch do not do interactive display; implies -q\n\
222 --chdir DIR change to directory DIR\n\
223 --daemon, --bg-daemon[=NAME] start a (named) server in the background\n\
224 --fg-daemon[=NAME] start a (named) server in the foreground\n\
225 --debug-init enable Emacs Lisp debugger for init file\n\
226 --display, -d DISPLAY use X server DISPLAY\n\
228 #ifdef HAVE_MODULES
230 --module-assertions assert behavior of dynamic modules\n\
232 #endif
234 --no-build-details do not add build details such as time stamps\n\
235 --no-desktop do not load a saved desktop\n\
236 --no-init-file, -q load neither ~/.emacs nor default.el\n\
237 --no-loadup, -nl do not load loadup.el into bare Emacs\n\
238 --no-site-file do not load site-start.el\n\
239 --no-x-resources do not load X resources\n\
240 --no-site-lisp, -nsl do not add site-lisp directories to load-path\n\
241 --no-splash do not display a splash screen on startup\n\
242 --no-window-system, -nw do not communicate with X, ignoring $DISPLAY\n\
245 --quick, -Q equivalent to:\n\
246 -q --no-site-file --no-site-lisp --no-splash\n\
247 --no-x-resources\n\
248 --script FILE run FILE as an Emacs Lisp script\n\
249 --terminal, -t DEVICE use DEVICE for terminal I/O\n\
250 --user, -u USER load ~USER/.emacs instead of your own\n\
254 Action options:\n\
256 FILE visit FILE\n\
257 +LINE go to line LINE in next FILE\n\
258 +LINE:COLUMN go to line LINE, column COLUMN, in next FILE\n\
259 --directory, -L DIR prepend DIR to load-path (with :DIR, append DIR)\n\
260 --eval EXPR evaluate Emacs Lisp expression EXPR\n\
261 --execute EXPR evaluate Emacs Lisp expression EXPR\n\
264 --file FILE visit FILE\n\
265 --find-file FILE visit FILE\n\
266 --funcall, -f FUNC call Emacs Lisp function FUNC with no arguments\n\
267 --insert FILE insert contents of FILE into current buffer\n\
268 --kill exit without asking for confirmation\n\
269 --load, -l FILE load Emacs Lisp FILE using the load function\n\
270 --visit FILE visit FILE\n\
274 Display options:\n\
276 --background-color, -bg COLOR window background color\n\
277 --basic-display, -D disable many display features;\n\
278 used for debugging Emacs\n\
279 --border-color, -bd COLOR main border color\n\
280 --border-width, -bw WIDTH width of main border\n\
283 --color, --color=MODE override color mode for character terminals;\n\
284 MODE defaults to `auto', and\n\
285 can also be `never', `always',\n\
286 or a mode name like `ansi8'\n\
287 --cursor-color, -cr COLOR color of the Emacs cursor indicating point\n\
288 --font, -fn FONT default font; must be fixed-width\n\
289 --foreground-color, -fg COLOR window foreground color\n\
292 --fullheight, -fh make the first frame high as the screen\n\
293 --fullscreen, -fs make the first frame fullscreen\n\
294 --fullwidth, -fw make the first frame wide as the screen\n\
295 --maximized, -mm make the first frame maximized\n\
296 --geometry, -g GEOMETRY window geometry\n\
299 --no-bitmap-icon, -nbi do not use picture of gnu for Emacs icon\n\
300 --iconic start Emacs in iconified state\n\
301 --internal-border, -ib WIDTH width between text and main border\n\
302 --line-spacing, -lsp PIXELS additional space to put between lines\n\
303 --mouse-color, -ms COLOR mouse cursor color in Emacs window\n\
304 --name NAME title for initial Emacs frame\n\
307 --no-blinking-cursor, -nbc disable blinking cursor\n\
308 --reverse-video, -r, -rv switch foreground and background\n\
309 --title, -T TITLE title for initial Emacs frame\n\
310 --vertical-scroll-bars, -vb enable vertical scroll bars\n\
311 --xrm XRESOURCES set additional X resources\n\
312 --parent-id XID set parent window\n\
313 --help display this help and exit\n\
314 --version output version information and exit\n\
318 You can generally also specify long option names with a single -; for\n\
319 example, -batch as well as --batch. You can use any unambiguous\n\
320 abbreviation for a --option.\n\
322 Various environment variables and window system resources also affect\n\
323 the operation of Emacs. See the main documentation.\n\
325 Report bugs to " PACKAGE_BUGREPORT ". First, please see the Bugs\n\
326 section of the Emacs manual or the file BUGS.\n"
330 /* True if handling a fatal error already. */
331 bool fatal_error_in_progress;
333 #ifdef HAVE_NS
334 /* NS autrelease pool, for memory management. */
335 static void *ns_pool;
336 #endif
338 #if !HAVE_SETLOCALE
339 static char *
340 setlocale (int cat, char const *locale)
342 return 0;
344 #endif
346 /* True if the current system locale uses UTF-8 encoding. */
347 static bool
348 using_utf8 (void)
350 #ifdef HAVE_WCHAR_H
351 wchar_t wc;
352 mbstate_t mbs = { 0 };
353 return mbrtowc (&wc, "\xc4\x80", 2, &mbs) == 2 && wc == 0x100;
354 #else
355 return false;
356 #endif
360 /* Report a fatal error due to signal SIG, output a backtrace of at
361 most BACKTRACE_LIMIT lines, and exit. */
362 _Noreturn void
363 terminate_due_to_signal (int sig, int backtrace_limit)
365 signal (sig, SIG_DFL);
367 if (attempt_orderly_shutdown_on_fatal_signal)
369 /* If fatal error occurs in code below, avoid infinite recursion. */
370 if (! fatal_error_in_progress)
372 fatal_error_in_progress = 1;
374 totally_unblock_input ();
375 if (sig == SIGTERM || sig == SIGHUP || sig == SIGINT)
376 Fkill_emacs (make_number (sig));
378 shut_down_emacs (sig, Qnil);
379 emacs_backtrace (backtrace_limit);
383 /* Signal the same code; this time it will really be fatal.
384 Since we're in a signal handler, the signal is blocked, so we
385 have to unblock it if we want to really receive it. */
386 #ifndef MSDOS
388 sigset_t unblocked;
389 sigemptyset (&unblocked);
390 sigaddset (&unblocked, sig);
391 pthread_sigmask (SIG_UNBLOCK, &unblocked, 0);
393 #endif
395 emacs_raise (sig);
397 /* This shouldn't be executed, but it prevents a warning. */
398 exit (1);
401 /* Code for dealing with Lisp access to the Unix command line. */
403 static void
404 init_cmdargs (int argc, char **argv, int skip_args, char *original_pwd)
406 int i;
407 Lisp_Object name, dir, handler;
408 ptrdiff_t count = SPECPDL_INDEX ();
409 Lisp_Object raw_name;
410 AUTO_STRING (slash_colon, "/:");
412 initial_argv = argv;
413 initial_argc = argc;
415 #ifdef WINDOWSNT
416 /* Must use argv[0] converted to UTF-8, as it begets many standard
417 file and directory names. */
419 char argv0[MAX_UTF8_PATH];
421 if (filename_from_ansi (argv[0], argv0) == 0)
422 raw_name = build_unibyte_string (argv0);
423 else
424 raw_name = build_unibyte_string (argv[0]);
426 #else
427 raw_name = build_unibyte_string (argv[0]);
428 #endif
430 /* Add /: to the front of the name
431 if it would otherwise be treated as magic. */
432 handler = Ffind_file_name_handler (raw_name, Qt);
433 if (! NILP (handler))
434 raw_name = concat2 (slash_colon, raw_name);
436 Vinvocation_name = Ffile_name_nondirectory (raw_name);
437 Vinvocation_directory = Ffile_name_directory (raw_name);
439 /* If we got no directory in argv[0], search PATH to find where
440 Emacs actually came from. */
441 if (NILP (Vinvocation_directory))
443 Lisp_Object found;
444 int yes = openp (Vexec_path, Vinvocation_name,
445 Vexec_suffixes, &found, make_number (X_OK), false);
446 if (yes == 1)
448 /* Add /: to the front of the name
449 if it would otherwise be treated as magic. */
450 handler = Ffind_file_name_handler (found, Qt);
451 if (! NILP (handler))
452 found = concat2 (slash_colon, found);
453 Vinvocation_directory = Ffile_name_directory (found);
457 if (!NILP (Vinvocation_directory)
458 && NILP (Ffile_name_absolute_p (Vinvocation_directory)))
459 /* Emacs was started with relative path, like ./emacs.
460 Make it absolute. */
462 Lisp_Object odir =
463 original_pwd ? build_unibyte_string (original_pwd) : Qnil;
465 Vinvocation_directory = Fexpand_file_name (Vinvocation_directory, odir);
468 Vinstallation_directory = Qnil;
470 if (!NILP (Vinvocation_directory))
472 if (NILP (Vpurify_flag) && !NILP (Ffboundp (Qfile_truename)))
473 Vinvocation_directory = call1 (Qfile_truename, Vinvocation_directory);
475 dir = Vinvocation_directory;
476 #ifdef WINDOWSNT
477 /* If we are running from the build directory, set DIR to the
478 src subdirectory of the Emacs tree, like on Posix
479 platforms. */
480 if (SBYTES (dir) > sizeof ("/i386/") - 1
481 && 0 == strcmp (SSDATA (dir) + SBYTES (dir) - sizeof ("/i386/") + 1,
482 "/i386/"))
483 dir = Fexpand_file_name (build_string ("../.."), dir);
484 #else /* !WINDOWSNT */
485 #endif
486 name = Fexpand_file_name (Vinvocation_name, dir);
487 while (1)
489 Lisp_Object tem, lib_src_exists;
490 Lisp_Object etc_exists, info_exists;
492 /* See if dir contains subdirs for use by Emacs.
493 Check for the ones that would exist in a build directory,
494 not including lisp and info. */
495 tem = Fexpand_file_name (build_string ("lib-src"), dir);
496 lib_src_exists = Ffile_exists_p (tem);
498 #ifdef MSDOS
499 /* MSDOS installations frequently remove lib-src, but we still
500 must set installation-directory, or else info won't find
501 its files (it uses the value of installation-directory). */
502 tem = Fexpand_file_name (build_string ("info"), dir);
503 info_exists = Ffile_exists_p (tem);
504 #else
505 info_exists = Qnil;
506 #endif
508 if (!NILP (lib_src_exists) || !NILP (info_exists))
510 tem = Fexpand_file_name (build_string ("etc"), dir);
511 etc_exists = Ffile_exists_p (tem);
512 if (!NILP (etc_exists))
514 Vinstallation_directory
515 = Ffile_name_as_directory (dir);
516 break;
520 /* See if dir's parent contains those subdirs. */
521 tem = Fexpand_file_name (build_string ("../lib-src"), dir);
522 lib_src_exists = Ffile_exists_p (tem);
525 #ifdef MSDOS
526 /* See the MSDOS commentary above. */
527 tem = Fexpand_file_name (build_string ("../info"), dir);
528 info_exists = Ffile_exists_p (tem);
529 #else
530 info_exists = Qnil;
531 #endif
533 if (!NILP (lib_src_exists) || !NILP (info_exists))
535 tem = Fexpand_file_name (build_string ("../etc"), dir);
536 etc_exists = Ffile_exists_p (tem);
537 if (!NILP (etc_exists))
539 tem = Fexpand_file_name (build_string (".."), dir);
540 Vinstallation_directory
541 = Ffile_name_as_directory (tem);
542 break;
546 /* If the Emacs executable is actually a link,
547 next try the dir that the link points into. */
548 tem = Ffile_symlink_p (name);
549 if (!NILP (tem))
551 name = Fexpand_file_name (tem, dir);
552 dir = Ffile_name_directory (name);
554 else
555 break;
559 Vcommand_line_args = Qnil;
561 for (i = argc - 1; i >= 0; i--)
563 if (i == 0 || i > skip_args)
564 /* For the moment, we keep arguments as is in unibyte strings.
565 They are decoded in the function command-line after we know
566 locale-coding-system. */
567 Vcommand_line_args
568 = Fcons (build_unibyte_string (argv[i]), Vcommand_line_args);
571 unbind_to (count, Qnil);
574 DEFUN ("invocation-name", Finvocation_name, Sinvocation_name, 0, 0, 0,
575 doc: /* Return the program name that was used to run Emacs.
576 Any directory names are omitted. */)
577 (void)
579 return Fcopy_sequence (Vinvocation_name);
582 DEFUN ("invocation-directory", Finvocation_directory, Sinvocation_directory,
583 0, 0, 0,
584 doc: /* Return the directory name in which the Emacs executable was located. */)
585 (void)
587 return Fcopy_sequence (Vinvocation_directory);
591 /* Test whether the next argument in ARGV matches SSTR or a prefix of
592 LSTR (at least MINLEN characters). If so, then if VALPTR is non-null
593 (the argument is supposed to have a value) store in *VALPTR either
594 the next argument or the portion of this one after the equal sign.
595 ARGV is read starting at position *SKIPPTR; this index is advanced
596 by the number of arguments used.
598 Too bad we can't just use getopt for all of this, but we don't have
599 enough information to do it right. */
601 static bool
602 argmatch (char **argv, int argc, const char *sstr, const char *lstr,
603 int minlen, char **valptr, int *skipptr)
605 char *p = NULL;
606 ptrdiff_t arglen;
607 char *arg;
609 /* Don't access argv[argc]; give up in advance. */
610 if (argc <= *skipptr + 1)
611 return 0;
613 arg = argv[*skipptr+1];
614 if (arg == NULL)
615 return 0;
616 if (strcmp (arg, sstr) == 0)
618 if (valptr != NULL)
620 *valptr = argv[*skipptr+2];
621 *skipptr += 2;
623 else
624 *skipptr += 1;
625 return 1;
627 arglen = (valptr != NULL && (p = strchr (arg, '=')) != NULL
628 ? p - arg : strlen (arg));
629 if (lstr == 0 || arglen < minlen || strncmp (arg, lstr, arglen) != 0)
630 return 0;
631 else if (valptr == NULL)
633 *skipptr += 1;
634 return 1;
636 else if (p != NULL)
638 *valptr = p+1;
639 *skipptr += 1;
640 return 1;
642 else if (argv[*skipptr+2] != NULL)
644 *valptr = argv[*skipptr+2];
645 *skipptr += 2;
646 return 1;
648 else
650 return 0;
654 /* Close standard output and standard error, reporting any write
655 errors as best we can. This is intended for use with atexit. */
656 static void
657 close_output_streams (void)
659 if (close_stream (stdout) != 0)
661 emacs_perror ("Write error to standard output");
662 _exit (EXIT_FAILURE);
665 /* Do not close stderr if addresses are being sanitized, as the
666 sanitizer might report to stderr after this function is
667 invoked. */
668 if (!ADDRESS_SANITIZER && close_stream (stderr) != 0)
669 _exit (EXIT_FAILURE);
672 /* ARGSUSED */
674 main (int argc, char **argv)
676 /* Variable near the bottom of the stack, and aligned appropriately
677 for pointers. */
678 void *stack_bottom_variable;
680 bool do_initial_setlocale;
681 bool dumping;
682 int skip_args = 0;
683 bool no_loadup = false;
684 char *junk = 0;
685 char *dname_arg = 0;
686 #ifdef DAEMON_MUST_EXEC
687 char dname_arg2[80];
688 #endif
689 char *ch_to_dir = 0;
691 /* If we use --chdir, this records the original directory. */
692 char *original_pwd = 0;
694 /* Record (approximately) where the stack begins. */
695 stack_bottom = (char *) &stack_bottom_variable;
697 #ifndef CANNOT_DUMP
698 dumping = !initialized && (strcmp (argv[argc - 1], "dump") == 0
699 || strcmp (argv[argc - 1], "bootstrap") == 0);
700 #else
701 dumping = false;
702 #endif
704 /* True if address randomization interferes with memory allocation. */
705 # ifdef __PPC64__
706 bool disable_aslr = true;
707 # else
708 bool disable_aslr = dumping;
709 # endif
711 if (disable_aslr && disable_address_randomization ())
713 /* Set this so the personality will be reverted before execs
714 after this one. */
715 xputenv ("EMACS_HEAP_EXEC=true");
717 /* Address randomization was enabled, but is now disabled.
718 Re-execute Emacs to get a clean slate. */
719 execvp (argv[0], argv);
721 /* If the exec fails, warn and then try anyway. */
722 perror (argv[0]);
725 #ifndef CANNOT_DUMP
726 might_dump = !initialized;
728 # ifdef GNU_LINUX
729 if (!initialized)
731 char *heap_start = my_heap_start ();
732 heap_bss_diff = heap_start - max (my_endbss, my_endbss_static);
734 # endif
735 #endif
737 #if defined WINDOWSNT || defined HAVE_NTGUI
738 /* Set global variables used to detect Windows version. Do this as
739 early as possible. (unexw32.c calls this function as well, but
740 the additional call here is harmless.) */
741 cache_system_info ();
742 #ifdef WINDOWSNT
743 /* On Windows 9X, we have to load UNICOWS.DLL as early as possible,
744 to have non-stub implementations of APIs we need to convert file
745 names between UTF-8 and the system's ANSI codepage. */
746 maybe_load_unicows_dll ();
747 /* Initialize the codepage for file names, needed to decode
748 non-ASCII file names during startup. */
749 w32_init_file_name_codepage ();
750 #endif
751 w32_init_main_thread ();
752 #endif
754 #ifdef RUN_TIME_REMAP
755 if (initialized)
756 run_time_remap (argv[0]);
757 #endif
759 /* If using unexmacosx.c (set by s/darwin.h), we must do this. */
760 #if defined DARWIN_OS && !defined CANNOT_DUMP
761 if (!initialized)
762 unexec_init_emacs_zone ();
763 #endif
765 init_standard_fds ();
766 atexit (close_output_streams);
768 sort_args (argc, argv);
769 argc = 0;
770 while (argv[argc]) argc++;
772 if (argmatch (argv, argc, "-version", "--version", 3, NULL, &skip_args))
774 const char *version, *copyright;
775 if (initialized)
777 Lisp_Object tem, tem2;
778 tem = Fsymbol_value (intern_c_string ("emacs-version"));
779 tem2 = Fsymbol_value (intern_c_string ("emacs-copyright"));
780 if (!STRINGP (tem))
782 fprintf (stderr, "Invalid value of 'emacs-version'\n");
783 exit (1);
785 if (!STRINGP (tem2))
787 fprintf (stderr, "Invalid value of 'emacs-copyright'\n");
788 exit (1);
790 else
792 version = SSDATA (tem);
793 copyright = SSDATA (tem2);
796 else
798 version = emacs_version;
799 copyright = emacs_copyright;
801 printf ("%s %s\n", PACKAGE_NAME, version);
802 printf ("%s\n", copyright);
803 printf ("%s comes with ABSOLUTELY NO WARRANTY.\n", PACKAGE_NAME);
804 printf ("You may redistribute copies of %s\n", PACKAGE_NAME);
805 printf ("under the terms of the GNU General Public License.\n");
806 printf ("For more information about these matters, ");
807 printf ("see the file named COPYING.\n");
808 exit (0);
811 if (argmatch (argv, argc, "-chdir", "--chdir", 4, &ch_to_dir, &skip_args))
813 #ifdef WINDOWSNT
814 /* argv[] array is kept in its original ANSI codepage encoding,
815 we need to convert to UTF-8, for chdir to work. */
816 char newdir[MAX_UTF8_PATH];
818 filename_from_ansi (ch_to_dir, newdir);
819 ch_to_dir = newdir;
820 #endif
821 original_pwd = emacs_get_current_dir_name ();
822 if (chdir (ch_to_dir) != 0)
824 fprintf (stderr, "%s: Can't chdir to %s: %s\n",
825 argv[0], ch_to_dir, strerror (errno));
826 exit (1);
830 #if defined (HAVE_SETRLIMIT) && defined (RLIMIT_STACK) && !defined (CYGWIN)
831 /* Extend the stack space available. Don't do that if dumping,
832 since some systems (e.g. DJGPP) might define a smaller stack
833 limit at that time. And it's not needed on Cygwin, since emacs
834 is built with an 8MB stack. Moreover, the setrlimit call can
835 cause problems on Cygwin
836 (https://www.cygwin.com/ml/cygwin/2015-07/msg00096.html). */
837 struct rlimit rlim;
838 if (getrlimit (RLIMIT_STACK, &rlim) == 0
839 && 0 <= rlim.rlim_cur && rlim.rlim_cur <= LONG_MAX)
841 rlim_t lim = rlim.rlim_cur;
843 /* Approximate the amount regex.c needs per unit of
844 emacs_re_max_failures, then add 33% to cover the size of the
845 smaller stacks that regex.c successively allocates and
846 discards on its way to the maximum. */
847 int min_ratio = 20 * sizeof (char *);
848 int ratio = min_ratio + min_ratio / 3;
850 /* Extra space to cover what we're likely to use for other
851 reasons. For example, a typical GC might take 30K stack
852 frames. */
853 int extra = (30 * 1000) * 50;
855 bool try_to_grow_stack = true;
856 #ifndef CANNOT_DUMP
857 try_to_grow_stack = !noninteractive || initialized;
858 #endif
860 if (try_to_grow_stack)
862 rlim_t newlim = emacs_re_max_failures * ratio + extra;
864 /* Round the new limit to a page boundary; this is needed
865 for Darwin kernel 15.4.0 (see Bug#23622) and perhaps
866 other systems. Do not shrink the stack and do not exceed
867 rlim_max. Don't worry about exact values of
868 RLIM_INFINITY etc. since in practice when they are
869 nonnegative they are so large that the code does the
870 right thing anyway. */
871 long pagesize = getpagesize ();
872 newlim += pagesize - 1;
873 if (0 <= rlim.rlim_max && rlim.rlim_max < newlim)
874 newlim = rlim.rlim_max;
875 newlim -= newlim % pagesize;
877 if (pagesize <= newlim - lim)
879 rlim.rlim_cur = newlim;
880 if (setrlimit (RLIMIT_STACK, &rlim) == 0)
881 lim = newlim;
884 /* If the stack is big enough, let regex.c more of it before
885 falling back to heap allocation. */
886 emacs_re_safe_alloca = max
887 (min (lim - extra, SIZE_MAX) * (min_ratio / ratio),
888 MAX_ALLOCA);
890 #endif /* HAVE_SETRLIMIT and RLIMIT_STACK and not CYGWIN */
892 clearerr_unlocked (stdin);
894 emacs_backtrace (-1);
896 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
897 /* Arrange to get warning messages as memory fills up. */
898 memory_warnings (0, malloc_warning);
900 /* Call malloc at least once, to run malloc_initialize_hook.
901 Also call realloc and free for consistency. */
902 free (realloc (malloc (4), 4));
904 #endif /* not SYSTEM_MALLOC and not HYBRID_MALLOC */
906 #ifdef MSDOS
907 set_binary_mode (STDIN_FILENO, O_BINARY);
908 fflush (stdout);
909 set_binary_mode (STDOUT_FILENO, O_BINARY);
910 #endif /* MSDOS */
912 /* Skip initial setlocale if LC_ALL is "C", as it's not needed in that case.
913 The build procedure uses this while dumping, to ensure that the
914 dumped Emacs does not have its system locale tables initialized,
915 as that might cause screwups when the dumped Emacs starts up. */
917 char *lc_all = getenv ("LC_ALL");
918 do_initial_setlocale = ! lc_all || strcmp (lc_all, "C");
921 /* Set locale now, so that initial error messages are localized properly.
922 fixup_locale must wait until later, since it builds strings. */
923 if (do_initial_setlocale)
924 setlocale (LC_ALL, "");
925 text_quoting_flag = using_utf8 ();
927 inhibit_window_system = 0;
929 /* Handle the -t switch, which specifies filename to use as terminal. */
930 while (1)
932 char *term;
933 if (argmatch (argv, argc, "-t", "--terminal", 4, &term, &skip_args))
935 emacs_close (STDIN_FILENO);
936 emacs_close (STDOUT_FILENO);
937 int result = emacs_open (term, O_RDWR, 0);
938 if (result != STDIN_FILENO
939 || (fcntl (STDIN_FILENO, F_DUPFD_CLOEXEC, STDOUT_FILENO)
940 != STDOUT_FILENO))
942 char *errstring = strerror (errno);
943 fprintf (stderr, "%s: %s: %s\n", argv[0], term, errstring);
944 exit (EXIT_FAILURE);
946 if (! isatty (STDIN_FILENO))
948 fprintf (stderr, "%s: %s: not a tty\n", argv[0], term);
949 exit (EXIT_FAILURE);
951 fprintf (stderr, "Using %s\n", term);
952 #ifdef HAVE_WINDOW_SYSTEM
953 inhibit_window_system = true; /* -t => -nw */
954 #endif
956 else
957 break;
960 /* Command line option --no-windows is deprecated and thus not mentioned
961 in the manual and usage information. */
962 if (argmatch (argv, argc, "-nw", "--no-window-system", 6, NULL, &skip_args)
963 || argmatch (argv, argc, "-nw", "--no-windows", 6, NULL, &skip_args))
964 inhibit_window_system = 1;
966 /* Handle the -batch switch, which means don't do interactive display. */
967 noninteractive = 0;
968 if (argmatch (argv, argc, "-batch", "--batch", 5, NULL, &skip_args))
970 noninteractive = 1;
971 Vundo_outer_limit = Qnil;
973 if (argmatch (argv, argc, "-script", "--script", 3, &junk, &skip_args))
975 noninteractive = 1; /* Set batch mode. */
976 /* Convert --script to -scriptload, un-skip it, and sort again
977 so that it will be handled in proper sequence. */
978 /* FIXME broken for --script=FILE - is that supposed to work? */
979 argv[skip_args - 1] = (char *) "-scriptload";
980 skip_args -= 2;
981 sort_args (argc, argv);
984 /* Handle the --help option, which gives a usage message. */
985 if (argmatch (argv, argc, "-help", "--help", 3, NULL, &skip_args))
987 int i;
988 printf ("Usage: %s [OPTION-OR-FILENAME]...\n", argv[0]);
989 for (i = 0; i < ARRAYELTS (usage_message); i++)
990 fputs_unlocked (usage_message[i], stdout);
991 exit (0);
994 daemon_type = 0;
996 #ifndef WINDOWSNT
997 /* Make sure IS_DAEMON starts up as false. */
998 daemon_pipe[1] = 0;
999 #else
1000 w32_daemon_event = NULL;
1001 #endif
1004 int sockfd = -1;
1006 if (argmatch (argv, argc, "-fg-daemon", "--fg-daemon", 10, NULL, &skip_args)
1007 || argmatch (argv, argc, "-fg-daemon", "--fg-daemon", 10, &dname_arg, &skip_args))
1009 daemon_type = 1; /* foreground */
1011 else if (argmatch (argv, argc, "-daemon", "--daemon", 5, NULL, &skip_args)
1012 || argmatch (argv, argc, "-daemon", "--daemon", 5, &dname_arg, &skip_args)
1013 || argmatch (argv, argc, "-bg-daemon", "--bg-daemon", 10, NULL, &skip_args)
1014 || argmatch (argv, argc, "-bg-daemon", "--bg-daemon", 10, &dname_arg, &skip_args))
1016 daemon_type = 2; /* background */
1020 if (daemon_type > 0)
1022 #ifndef DOS_NT
1023 if (daemon_type == 2)
1025 /* Start as a background daemon: fork a new child process which
1026 will run the rest of the initialization code, then exit.
1028 Detaching a daemon requires the following steps:
1029 - fork
1030 - setsid
1031 - exit the parent
1032 - close the tty file-descriptors
1034 We only want to do the last 2 steps once the daemon is ready to
1035 serve requests, i.e. after loading .emacs (initialization).
1036 OTOH initialization may start subprocesses (e.g. ispell) and these
1037 should be run from the proper process (the one that will end up
1038 running as daemon) and with the proper "session id" in order for
1039 them to keep working after detaching, so fork and setsid need to be
1040 performed before initialization.
1042 We want to avoid exiting before the server socket is ready, so
1043 use a pipe for synchronization. The parent waits for the child
1044 to close its end of the pipe (using `daemon-initialized')
1045 before exiting. */
1046 if (emacs_pipe (daemon_pipe) != 0)
1048 fprintf (stderr, "Cannot pipe!\n");
1049 exit (1);
1051 } /* daemon_type == 2 */
1053 #ifdef HAVE_LIBSYSTEMD
1054 /* Read the number of sockets passed through by systemd. */
1055 int systemd_socket = sd_listen_fds (1);
1057 if (systemd_socket > 1)
1058 fprintf (stderr,
1059 ("\n"
1060 "Warning: systemd passed more than one socket to Emacs.\n"
1061 "Try 'Accept=false' in the Emacs socket unit file.\n"));
1062 else if (systemd_socket == 1
1063 && (0 < sd_is_socket (SD_LISTEN_FDS_START,
1064 AF_UNSPEC, SOCK_STREAM, 1)))
1065 sockfd = SD_LISTEN_FDS_START;
1066 #endif /* HAVE_LIBSYSTEMD */
1068 #ifdef USE_GTK
1069 fprintf (stderr, "\nWarning: due to a long standing Gtk+ bug\nhttp://bugzilla.gnome.org/show_bug.cgi?id=85715\n\
1070 Emacs might crash when run in daemon mode and the X11 connection is unexpectedly lost.\n\
1071 Using an Emacs configured with --with-x-toolkit=lucid does not have this problem.\n");
1072 #endif /* USE_GTK */
1074 if (daemon_type == 2)
1076 pid_t f;
1077 #ifndef DAEMON_MUST_EXEC
1079 f = fork ();
1080 #else /* DAEMON_MUST_EXEC */
1081 if (!dname_arg || !strchr (dname_arg, '\n'))
1082 f = fork (); /* in orig */
1083 else
1084 f = 0; /* in exec'd */
1085 #endif /* !DAEMON_MUST_EXEC */
1086 if (f > 0)
1088 int retval;
1089 char buf[1];
1091 /* Close unused writing end of the pipe. */
1092 emacs_close (daemon_pipe[1]);
1094 /* Just wait for the child to close its end of the pipe. */
1097 retval = read (daemon_pipe[0], &buf, 1);
1099 while (retval == -1 && errno == EINTR);
1101 if (retval < 0)
1103 fprintf (stderr, "Error reading status from child\n");
1104 exit (1);
1106 else if (retval == 0)
1108 fprintf (stderr, "Error: server did not start correctly\n");
1109 exit (1);
1112 emacs_close (daemon_pipe[0]);
1113 exit (0);
1115 if (f < 0)
1117 emacs_perror ("fork");
1118 exit (EXIT_CANCELED);
1121 #ifdef DAEMON_MUST_EXEC
1123 /* In orig process, forked as child, OR in exec'd. */
1124 if (!dname_arg || !strchr (dname_arg, '\n'))
1125 { /* In orig, child: now exec w/special daemon name. */
1126 char fdStr[80];
1127 int fdStrlen =
1128 snprintf (fdStr, sizeof fdStr,
1129 "--bg-daemon=\n%d,%d\n%s", daemon_pipe[0],
1130 daemon_pipe[1], dname_arg ? dname_arg : "");
1132 if (! (0 <= fdStrlen && fdStrlen < sizeof fdStr))
1134 fprintf (stderr, "daemon: child name too long\n");
1135 exit (EXIT_CANNOT_INVOKE);
1138 argv[skip_args] = fdStr;
1140 fcntl (daemon_pipe[0], F_SETFD, 0);
1141 fcntl (daemon_pipe[1], F_SETFD, 0);
1142 execvp (argv[0], argv);
1143 emacs_perror (argv[0]);
1144 exit (errno == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1147 /* In exec'd: parse special dname into pipe and name info. */
1148 if (!dname_arg || !strchr (dname_arg, '\n')
1149 || strlen (dname_arg) < 1 || strlen (dname_arg) > 70)
1151 fprintf (stderr, "emacs daemon: daemon name absent or too long\n");
1152 exit (EXIT_CANNOT_INVOKE);
1154 dname_arg2[0] = '\0';
1155 sscanf (dname_arg, "\n%d,%d\n%s", &(daemon_pipe[0]), &(daemon_pipe[1]),
1156 dname_arg2);
1157 dname_arg = *dname_arg2 ? dname_arg2 : NULL;
1158 fcntl (daemon_pipe[1], F_SETFD, FD_CLOEXEC);
1160 #endif /* DAEMON_MUST_EXEC */
1162 /* Close unused reading end of the pipe. */
1163 emacs_close (daemon_pipe[0]);
1165 setsid ();
1166 } /* daemon_type == 2 */
1167 #elif defined(WINDOWSNT)
1168 /* Indicate that we want daemon mode. */
1169 w32_daemon_event = CreateEvent (NULL, TRUE, FALSE, W32_DAEMON_EVENT);
1170 if (w32_daemon_event == NULL)
1172 fprintf (stderr, "Couldn't create MS-Windows event for daemon: %s\n",
1173 w32_strerror (0));
1174 exit (1);
1176 #else /* MSDOS */
1177 fprintf (stderr, "This platform does not support daemon mode.\n");
1178 exit (1);
1179 #endif /* MSDOS */
1180 if (dname_arg)
1181 daemon_name = xstrdup (dname_arg);
1184 #if defined HAVE_PTHREAD && !defined SYSTEM_MALLOC \
1185 && !defined DOUG_LEA_MALLOC && !defined HYBRID_MALLOC
1186 # ifndef CANNOT_DUMP
1187 /* Do not make gmalloc thread-safe when creating bootstrap-emacs, as
1188 that causes an infinite recursive loop with FreeBSD. See
1189 Bug#14569. The part of this bug involving Cygwin is no longer
1190 relevant, now that Cygwin defines HYBRID_MALLOC. */
1191 if (!noninteractive || initialized)
1192 # endif
1193 malloc_enable_thread ();
1194 #endif
1196 init_signals (dumping);
1198 noninteractive1 = noninteractive;
1200 /* Perform basic initializations (not merely interning symbols). */
1202 if (!initialized)
1204 init_alloc_once ();
1205 init_threads_once ();
1206 init_obarray ();
1207 init_eval_once ();
1208 init_charset_once ();
1209 init_coding_once ();
1210 init_syntax_once (); /* Create standard syntax table. */
1211 init_category_once (); /* Create standard category table. */
1212 init_casetab_once (); /* Must be done before init_buffer_once. */
1213 init_buffer_once (); /* Create buffer table and some buffers. */
1214 init_minibuf_once (); /* Create list of minibuffers. */
1215 /* Must precede init_window_once. */
1217 /* Call syms_of_xfaces before init_window_once because that
1218 function creates Vterminal_frame. Termcap frames now use
1219 faces, and the face implementation uses some symbols as
1220 face names. */
1221 syms_of_xfaces ();
1222 /* XXX syms_of_keyboard uses some symbols in keymap.c. It would
1223 be better to arrange things not to have this dependency. */
1224 syms_of_keymap ();
1225 /* Call syms_of_keyboard before init_window_once because
1226 keyboard sets up symbols that include some face names that
1227 the X support will want to use. This can happen when
1228 CANNOT_DUMP is defined. */
1229 syms_of_keyboard ();
1231 /* Called before syms_of_fileio, because it sets up Qerror_condition. */
1232 syms_of_data ();
1233 syms_of_fns (); /* Before syms_of_charset which uses hash tables. */
1234 syms_of_fileio ();
1235 /* Before syms_of_coding to initialize Vgc_cons_threshold. */
1236 syms_of_alloc ();
1237 /* May call Ffuncall and so GC, thus the latter should be initialized. */
1238 init_print_once ();
1239 /* Before syms_of_coding because it initializes Qcharsetp. */
1240 syms_of_charset ();
1241 /* Before init_window_once, because it sets up the
1242 Vcoding_system_hash_table. */
1243 syms_of_coding (); /* This should be after syms_of_fileio. */
1245 init_window_once (); /* Init the window system. */
1246 #ifdef HAVE_WINDOW_SYSTEM
1247 init_fringe_once (); /* Swap bitmaps if necessary. */
1248 #endif /* HAVE_WINDOW_SYSTEM */
1251 init_alloc ();
1252 init_threads ();
1254 if (do_initial_setlocale)
1256 fixup_locale ();
1257 Vsystem_messages_locale = Vprevious_system_messages_locale;
1258 Vsystem_time_locale = Vprevious_system_time_locale;
1261 init_eval ();
1262 init_atimer ();
1263 running_asynch_code = 0;
1264 init_random ();
1266 #if defined HAVE_JSON && !defined WINDOWSNT
1267 init_json ();
1268 #endif
1270 no_loadup
1271 = argmatch (argv, argc, "-nl", "--no-loadup", 6, NULL, &skip_args);
1273 no_site_lisp
1274 = argmatch (argv, argc, "-nsl", "--no-site-lisp", 11, NULL, &skip_args);
1276 build_details = ! argmatch (argv, argc, "-no-build-details",
1277 "--no-build-details", 7, NULL, &skip_args);
1279 #ifdef HAVE_MODULES
1280 bool module_assertions
1281 = argmatch (argv, argc, "-module-assertions", "--module-assertions", 15,
1282 NULL, &skip_args);
1283 if (dumping && module_assertions)
1285 fputs ("Module assertions are not supported during dumping\n", stderr);
1286 exit (1);
1288 init_module_assertions (module_assertions);
1289 #endif
1291 #ifdef HAVE_NS
1292 ns_pool = ns_alloc_autorelease_pool ();
1293 #ifdef NS_IMPL_GNUSTEP
1294 /* GNUstep stupidly resets our locale settings after we made them. */
1295 fixup_locale ();
1296 #endif
1298 if (!noninteractive)
1300 #ifdef NS_IMPL_COCOA
1301 /* Started from GUI? */
1302 /* FIXME: Do the right thing if getenv returns NULL, or if
1303 chdir fails. */
1304 if (! inhibit_window_system && ! isatty (STDIN_FILENO) && ! ch_to_dir)
1305 chdir (getenv ("HOME"));
1306 if (skip_args < argc)
1308 if (!strncmp (argv[skip_args], "-psn", 4))
1310 skip_args += 1;
1311 if (! ch_to_dir) chdir (getenv ("HOME"));
1313 else if (skip_args+1 < argc && !strncmp (argv[skip_args+1], "-psn", 4))
1315 skip_args += 2;
1316 if (! ch_to_dir) chdir (getenv ("HOME"));
1319 #endif /* COCOA */
1321 #endif /* HAVE_NS */
1323 #ifdef HAVE_X_WINDOWS
1324 /* Stupid kludge to catch command-line display spec. We can't
1325 handle this argument entirely in window system dependent code
1326 because we don't even know which window system dependent code
1327 to run until we've recognized this argument. */
1329 char *displayname = 0;
1330 int count_before = skip_args;
1332 /* Skip any number of -d options, but only use the last one. */
1333 while (1)
1335 int count_before_this = skip_args;
1337 if (argmatch (argv, argc, "-d", "--display", 3, &displayname, &skip_args))
1338 display_arg = 1;
1339 else if (argmatch (argv, argc, "-display", 0, 3, &displayname, &skip_args))
1340 display_arg = 1;
1341 else
1342 break;
1344 count_before = count_before_this;
1347 /* If we have the form --display=NAME,
1348 convert it into -d name.
1349 This requires inserting a new element into argv. */
1350 if (displayname && count_before < skip_args)
1352 if (skip_args == count_before + 1)
1354 memmove (argv + count_before + 3, argv + count_before + 2,
1355 (argc - (count_before + 2)) * sizeof *argv);
1356 argv[count_before + 2] = displayname;
1357 argc++;
1359 argv[count_before + 1] = (char *) "-d";
1362 if (! no_site_lisp)
1364 if (argmatch (argv, argc, "-Q", "--quick", 3, NULL, &skip_args)
1365 || argmatch (argv, argc, "-quick", 0, 2, NULL, &skip_args))
1366 no_site_lisp = 1;
1369 /* Don't actually discard this arg. */
1370 skip_args = count_before;
1372 #else /* !HAVE_X_WINDOWS */
1373 if (! no_site_lisp)
1375 int count_before = skip_args;
1377 if (argmatch (argv, argc, "-Q", "--quick", 3, NULL, &skip_args)
1378 || argmatch (argv, argc, "-quick", 0, 2, NULL, &skip_args))
1379 no_site_lisp = 1;
1381 skip_args = count_before;
1383 #endif
1385 /* argmatch must not be used after here,
1386 except when building temacs
1387 because the -d argument has not been skipped in skip_args. */
1389 #ifdef MSDOS
1390 /* Call early 'cause init_environment needs it. */
1391 init_dosfns ();
1392 /* Set defaults for several environment variables. */
1393 if (initialized)
1394 init_environment (argc, argv, skip_args);
1395 else
1396 tzset ();
1397 #endif /* MSDOS */
1399 #ifdef HAVE_KQUEUE
1400 globals_of_kqueue ();
1401 #endif
1403 #ifdef HAVE_GFILENOTIFY
1404 globals_of_gfilenotify ();
1405 #endif
1407 #ifdef HAVE_NS
1408 /* Initialize the locale from user defaults. */
1409 ns_init_locale ();
1410 #endif
1412 /* Initialize and GC-protect Vinitial_environment and
1413 Vprocess_environment before set_initial_environment fills them
1414 in. */
1415 if (!initialized)
1416 syms_of_callproc ();
1417 /* egetenv is a pretty low-level facility, which may get called in
1418 many circumstances; it seems flimsy to put off initializing it
1419 until calling init_callproc. Do not do it when dumping. */
1420 if (! dumping)
1421 set_initial_environment ();
1423 #ifdef WINDOWSNT
1424 globals_of_w32 ();
1425 #ifdef HAVE_W32NOTIFY
1426 globals_of_w32notify ();
1427 #endif
1428 /* Initialize environment from registry settings. Make sure to do
1429 this only after calling set_initial_environment so that
1430 Vinitial_environment and Vprocess_environment will contain only
1431 variables from the parent process without modifications from
1432 Emacs. */
1433 init_environment (argv);
1434 init_ntproc (dumping); /* must precede init_editfns. */
1435 #endif
1437 /* AIX crashes are reported in system versions 3.2.3 and 3.2.4
1438 if this is not done. Do it after set_global_environment so that we
1439 don't pollute Vglobal_environment. */
1440 /* Setting LANG here will defeat the startup locale processing... */
1441 #ifdef AIX
1442 xputenv ("LANG=C");
1443 #endif
1445 /* Init buffer storage and default directory of main buffer. */
1446 init_buffer (initialized);
1448 init_callproc_1 (); /* Must precede init_cmdargs and init_sys_modes. */
1450 /* Must precede init_lread. */
1451 init_cmdargs (argc, argv, skip_args, original_pwd);
1453 if (initialized)
1455 /* Erase any pre-dump messages in the message log, to avoid confusion. */
1456 Lisp_Object old_log_max;
1457 old_log_max = Vmessage_log_max;
1458 XSETFASTINT (Vmessage_log_max, 0);
1459 message_dolog ("", 0, 1, 0);
1460 Vmessage_log_max = old_log_max;
1463 init_callproc (); /* Must follow init_cmdargs but not init_sys_modes. */
1464 init_fileio ();
1465 init_lread ();
1466 #ifdef WINDOWSNT
1467 /* Check to see if Emacs has been installed correctly. */
1468 check_windows_init_file ();
1469 #endif
1471 /* Intern the names of all standard functions and variables;
1472 define standard keys. */
1474 if (!initialized)
1476 /* The basic levels of Lisp must come first. Note that
1477 syms_of_data and some others have already been called. */
1478 syms_of_chartab ();
1479 syms_of_lread ();
1480 syms_of_print ();
1481 syms_of_eval ();
1482 syms_of_floatfns ();
1484 syms_of_buffer ();
1485 syms_of_bytecode ();
1486 syms_of_callint ();
1487 syms_of_casefiddle ();
1488 syms_of_casetab ();
1489 syms_of_category ();
1490 syms_of_ccl ();
1491 syms_of_character ();
1492 syms_of_cmds ();
1493 syms_of_dired ();
1494 syms_of_display ();
1495 syms_of_doc ();
1496 syms_of_editfns ();
1497 syms_of_emacs ();
1498 syms_of_filelock ();
1499 syms_of_indent ();
1500 syms_of_insdel ();
1501 /* syms_of_keymap (); */
1502 syms_of_macros ();
1503 syms_of_marker ();
1504 syms_of_minibuf ();
1505 syms_of_process ();
1506 syms_of_search ();
1507 syms_of_frame ();
1508 syms_of_syntax ();
1509 syms_of_terminal ();
1510 syms_of_term ();
1511 syms_of_undo ();
1513 #ifdef HAVE_MODULES
1514 syms_of_module ();
1515 #endif
1517 #ifdef HAVE_SOUND
1518 syms_of_sound ();
1519 #endif
1520 syms_of_textprop ();
1521 syms_of_composite ();
1522 #ifdef WINDOWSNT
1523 syms_of_ntproc ();
1524 #endif /* WINDOWSNT */
1525 #if defined CYGWIN
1526 syms_of_cygw32 ();
1527 #endif
1528 syms_of_window ();
1529 syms_of_xdisp ();
1530 syms_of_font ();
1531 #ifdef HAVE_WINDOW_SYSTEM
1532 syms_of_fringe ();
1533 syms_of_image ();
1534 #endif /* HAVE_WINDOW_SYSTEM */
1535 #ifdef HAVE_X_WINDOWS
1536 syms_of_xterm ();
1537 syms_of_xfns ();
1538 syms_of_xmenu ();
1539 syms_of_fontset ();
1540 syms_of_xwidget ();
1541 syms_of_xsettings ();
1542 #ifdef HAVE_X_SM
1543 syms_of_xsmfns ();
1544 #endif
1545 #ifdef HAVE_X11
1546 syms_of_xselect ();
1547 #endif
1548 #endif /* HAVE_X_WINDOWS */
1550 syms_of_xml ();
1552 #ifdef HAVE_LCMS2
1553 syms_of_lcms2 ();
1554 #endif
1556 #ifdef HAVE_ZLIB
1557 syms_of_decompress ();
1558 #endif
1560 syms_of_menu ();
1562 #ifdef HAVE_NTGUI
1563 syms_of_w32term ();
1564 syms_of_w32fns ();
1565 syms_of_w32menu ();
1566 syms_of_fontset ();
1567 #endif /* HAVE_NTGUI */
1569 #if defined HAVE_NTGUI || defined CYGWIN
1570 syms_of_w32cygwinx ();
1571 #endif
1573 #if defined WINDOWSNT || defined HAVE_NTGUI
1574 syms_of_w32select ();
1575 #endif
1577 #ifdef MSDOS
1578 syms_of_xmenu ();
1579 syms_of_dosfns ();
1580 syms_of_msdos ();
1581 syms_of_win16select ();
1582 #endif /* MSDOS */
1584 #ifdef HAVE_NS
1585 syms_of_nsterm ();
1586 syms_of_nsfns ();
1587 syms_of_nsmenu ();
1588 syms_of_nsselect ();
1589 syms_of_fontset ();
1590 #endif /* HAVE_NS */
1592 syms_of_gnutls ();
1594 #ifdef HAVE_INOTIFY
1595 syms_of_inotify ();
1596 #endif /* HAVE_INOTIFY */
1598 #ifdef HAVE_KQUEUE
1599 syms_of_kqueue ();
1600 #endif /* HAVE_KQUEUE */
1602 #ifdef HAVE_GFILENOTIFY
1603 syms_of_gfilenotify ();
1604 #endif /* HAVE_GFILENOTIFY */
1606 #ifdef HAVE_DBUS
1607 syms_of_dbusbind ();
1608 #endif /* HAVE_DBUS */
1610 #ifdef WINDOWSNT
1611 syms_of_ntterm ();
1612 #ifdef HAVE_W32NOTIFY
1613 syms_of_w32notify ();
1614 #endif /* HAVE_W32NOTIFY */
1615 #endif /* WINDOWSNT */
1617 syms_of_threads ();
1618 syms_of_profiler ();
1620 #ifdef HAVE_JSON
1621 syms_of_json ();
1622 #endif
1624 keys_of_casefiddle ();
1625 keys_of_cmds ();
1626 keys_of_buffer ();
1627 keys_of_keyboard ();
1628 keys_of_keymap ();
1629 keys_of_window ();
1631 else
1633 /* Initialization that must be done even if the global variable
1634 initialized is non zero. */
1635 #ifdef HAVE_NTGUI
1636 globals_of_w32font ();
1637 globals_of_w32fns ();
1638 globals_of_w32menu ();
1639 #endif /* HAVE_NTGUI */
1641 #if defined WINDOWSNT || defined HAVE_NTGUI
1642 globals_of_w32select ();
1643 #endif
1646 init_charset ();
1648 /* This calls putenv and so must precede init_process_emacs. Also,
1649 it sets Voperating_system_release, which init_process_emacs uses. */
1650 init_editfns (dumping);
1652 /* These two call putenv. */
1653 #ifdef HAVE_DBUS
1654 init_dbusbind ();
1655 #endif
1656 #ifdef USE_GTK
1657 init_xterm ();
1658 #endif
1660 /* This can create a thread that may call getenv, so it must follow
1661 all calls to putenv and setenv. Also, this sets up
1662 add_keyboard_wait_descriptor, which init_display uses. */
1663 init_process_emacs (sockfd);
1665 init_keyboard (); /* This too must precede init_sys_modes. */
1666 if (!noninteractive)
1667 init_display (); /* Determine terminal type. Calls init_sys_modes. */
1668 #if HAVE_W32NOTIFY
1669 else
1670 init_crit (); /* w32notify.c needs this in batch mode. */
1671 #endif /* HAVE_W32NOTIFY */
1672 init_xdisp ();
1673 #ifdef HAVE_WINDOW_SYSTEM
1674 init_fringe ();
1675 #endif /* HAVE_WINDOW_SYSTEM */
1676 init_macros ();
1677 init_window ();
1678 init_font ();
1680 if (!initialized)
1682 char *file;
1683 /* Handle -l loadup, args passed by Makefile. */
1684 if (argmatch (argv, argc, "-l", "--load", 3, &file, &skip_args))
1686 #ifdef WINDOWSNT
1687 char file_utf8[MAX_UTF8_PATH];
1689 if (filename_from_ansi (file, file_utf8) == 0)
1690 file = file_utf8;
1691 #endif
1692 Vtop_level = list2 (Qload, build_unibyte_string (file));
1694 /* Unless next switch is -nl, load "loadup.el" first thing. */
1695 if (! no_loadup)
1696 Vtop_level = list2 (Qload, build_string ("loadup.el"));
1699 /* Set up for profiling. This is known to work on FreeBSD,
1700 GNU/Linux and MinGW. It might work on some other systems too.
1701 Give it a try and tell us if it works on your system. To compile
1702 for profiling, use the configure option --enable-profiling. */
1703 #if defined (__FreeBSD__) || defined (GNU_LINUX) || defined (__MINGW32__)
1704 #ifdef PROFILING
1705 if (initialized)
1707 #ifdef __MINGW32__
1708 extern unsigned char etext asm ("etext");
1709 #else
1710 extern char etext;
1711 #endif
1713 atexit (_mcleanup);
1714 monstartup ((uintptr_t) __executable_start, (uintptr_t) &etext);
1716 else
1717 moncontrol (0);
1718 #endif
1719 #endif
1721 initialized = 1;
1723 /* Enter editor command loop. This never returns. */
1724 Frecursive_edit ();
1725 /* NOTREACHED */
1726 return 0;
1729 /* Sort the args so we can find the most important ones
1730 at the beginning of argv. */
1732 /* First, here's a table of all the standard options. */
1734 struct standard_args
1736 const char *name;
1737 const char *longname;
1738 int priority;
1739 int nargs;
1742 static const struct standard_args standard_args[] =
1744 { "-version", "--version", 150, 0 },
1745 { "-chdir", "--chdir", 130, 1 },
1746 { "-t", "--terminal", 120, 1 },
1747 { "-nw", "--no-window-system", 110, 0 },
1748 { "-nw", "--no-windows", 110, 0 },
1749 { "-batch", "--batch", 100, 0 },
1750 { "-script", "--script", 100, 1 },
1751 { "-daemon", "--daemon", 99, 0 },
1752 { "-bg-daemon", "--bg-daemon", 99, 0 },
1753 { "-fg-daemon", "--fg-daemon", 99, 0 },
1754 { "-help", "--help", 90, 0 },
1755 { "-nl", "--no-loadup", 70, 0 },
1756 { "-nsl", "--no-site-lisp", 65, 0 },
1757 { "-no-build-details", "--no-build-details", 63, 0 },
1758 #ifdef HAVE_MODULES
1759 { "-module-assertions", "--module-assertions", 62, 0 },
1760 #endif
1761 /* -d must come last before the options handled in startup.el. */
1762 { "-d", "--display", 60, 1 },
1763 { "-display", 0, 60, 1 },
1764 /* Now for the options handled in `command-line' (startup.el). */
1765 /* (Note that to imply -nsl, -Q is partially handled here.) */
1766 { "-Q", "--quick", 55, 0 },
1767 { "-quick", 0, 55, 0 },
1768 { "-q", "--no-init-file", 50, 0 },
1769 { "-no-init-file", 0, 50, 0 },
1770 { "-no-x-resources", "--no-x-resources", 40, 0 },
1771 { "-no-site-file", "--no-site-file", 40, 0 },
1772 { "-u", "--user", 30, 1 },
1773 { "-user", 0, 30, 1 },
1774 { "-debug-init", "--debug-init", 20, 0 },
1775 { "-iconic", "--iconic", 15, 0 },
1776 { "-D", "--basic-display", 12, 0},
1777 { "-basic-display", 0, 12, 0},
1778 { "-nbc", "--no-blinking-cursor", 12, 0 },
1779 /* Now for the options handled in `command-line-1' (startup.el). */
1780 { "-nbi", "--no-bitmap-icon", 10, 0 },
1781 { "-bg", "--background-color", 10, 1 },
1782 { "-background", 0, 10, 1 },
1783 { "-fg", "--foreground-color", 10, 1 },
1784 { "-foreground", 0, 10, 1 },
1785 { "-bd", "--border-color", 10, 1 },
1786 { "-bw", "--border-width", 10, 1 },
1787 { "-ib", "--internal-border", 10, 1 },
1788 { "-ms", "--mouse-color", 10, 1 },
1789 { "-cr", "--cursor-color", 10, 1 },
1790 { "-fn", "--font", 10, 1 },
1791 { "-font", 0, 10, 1 },
1792 { "-fs", "--fullscreen", 10, 0 },
1793 { "-fw", "--fullwidth", 10, 0 },
1794 { "-fh", "--fullheight", 10, 0 },
1795 { "-mm", "--maximized", 10, 0 },
1796 { "-g", "--geometry", 10, 1 },
1797 { "-geometry", 0, 10, 1 },
1798 { "-T", "--title", 10, 1 },
1799 { "-title", 0, 10, 1 },
1800 { "-name", "--name", 10, 1 },
1801 { "-xrm", "--xrm", 10, 1 },
1802 { "-parent-id", "--parent-id", 10, 1 },
1803 { "-r", "--reverse-video", 5, 0 },
1804 { "-rv", 0, 5, 0 },
1805 { "-reverse", 0, 5, 0 },
1806 { "-hb", "--horizontal-scroll-bars", 5, 0 },
1807 { "-vb", "--vertical-scroll-bars", 5, 0 },
1808 { "-color", "--color", 5, 0},
1809 { "-no-splash", "--no-splash", 3, 0 },
1810 { "-no-desktop", "--no-desktop", 3, 0 },
1811 #ifdef HAVE_NS
1812 { "-NSAutoLaunch", 0, 5, 1 },
1813 { "-NXAutoLaunch", 0, 5, 1 },
1814 { "-_NSMachLaunch", 0, 85, 1 },
1815 { "-MachLaunch", 0, 85, 1 },
1816 { "-macosx", 0, 85, 0 },
1817 { "-NSHost", 0, 85, 1 },
1818 #endif
1819 /* These have the same priority as ordinary file name args,
1820 so they are not reordered with respect to those. */
1821 { "-L", "--directory", 0, 1 },
1822 { "-directory", 0, 0, 1 },
1823 { "-l", "--load", 0, 1 },
1824 { "-load", 0, 0, 1 },
1825 /* This has no longname, because using --scriptload confuses sort_args,
1826 because then the --script long option seems to match twice; ie
1827 you can't have a long option which is a prefix of another long
1828 option. In any case, this is entirely an internal option. */
1829 { "-scriptload", NULL, 0, 1 },
1830 { "-f", "--funcall", 0, 1 },
1831 { "-funcall", 0, 0, 1 },
1832 { "-eval", "--eval", 0, 1 },
1833 { "-execute", "--execute", 0, 1 },
1834 { "-find-file", "--find-file", 0, 1 },
1835 { "-visit", "--visit", 0, 1 },
1836 { "-file", "--file", 0, 1 },
1837 { "-insert", "--insert", 0, 1 },
1838 #ifdef HAVE_NS
1839 { "-NXOpen", 0, 0, 1 },
1840 { "-NXOpenTemp", 0, 0, 1 },
1841 { "-NSOpen", 0, 0, 1 },
1842 { "-NSOpenTemp", 0, 0, 1 },
1843 { "-GSFilePath", 0, 0, 1 },
1844 #endif
1845 /* This should be processed after ordinary file name args and the like. */
1846 { "-kill", "--kill", -10, 0 },
1849 /* Reorder the elements of ARGV (assumed to have ARGC elements)
1850 so that the highest priority ones come first.
1851 Do not change the order of elements of equal priority.
1852 If an option takes an argument, keep it and its argument together.
1854 If an option that takes no argument appears more
1855 than once, eliminate all but one copy of it. */
1857 static void
1858 sort_args (int argc, char **argv)
1860 char **new = xmalloc (argc * sizeof *new);
1861 /* For each element of argv,
1862 the corresponding element of options is:
1863 0 for an option that takes no arguments,
1864 1 for an option that takes one argument, etc.
1865 -1 for an ordinary non-option argument. */
1866 int *options = xnmalloc (argc, sizeof *options);
1867 int *priority = xnmalloc (argc, sizeof *priority);
1868 int to = 1;
1869 int incoming_used = 1;
1870 int from;
1871 int i;
1873 /* Categorize all the options,
1874 and figure out which argv elts are option arguments. */
1875 for (from = 1; from < argc; from++)
1877 options[from] = -1;
1878 priority[from] = 0;
1879 if (argv[from][0] == '-')
1881 int match;
1883 /* If we have found "--", don't consider
1884 any more arguments as options. */
1885 if (argv[from][1] == '-' && argv[from][2] == 0)
1887 /* Leave the "--", and everything following it, at the end. */
1888 for (; from < argc; from++)
1890 priority[from] = -100;
1891 options[from] = -1;
1893 break;
1896 /* Look for a match with a known old-fashioned option. */
1897 for (i = 0; i < ARRAYELTS (standard_args); i++)
1898 if (!strcmp (argv[from], standard_args[i].name))
1900 options[from] = standard_args[i].nargs;
1901 priority[from] = standard_args[i].priority;
1902 if (from + standard_args[i].nargs >= argc)
1903 fatal ("Option '%s' requires an argument\n", argv[from]);
1904 from += standard_args[i].nargs;
1905 goto done;
1908 /* Look for a match with a known long option.
1909 MATCH is -1 if no match so far, -2 if two or more matches so far,
1910 >= 0 (the table index of the match) if just one match so far. */
1911 if (argv[from][1] == '-')
1913 char const *equals = strchr (argv[from], '=');
1914 ptrdiff_t thislen =
1915 equals ? equals - argv[from] : strlen (argv[from]);
1917 match = -1;
1919 for (i = 0; i < ARRAYELTS (standard_args); i++)
1920 if (standard_args[i].longname
1921 && !strncmp (argv[from], standard_args[i].longname,
1922 thislen))
1924 if (match == -1)
1925 match = i;
1926 else
1927 match = -2;
1930 /* If we found exactly one match, use that. */
1931 if (match >= 0)
1933 options[from] = standard_args[match].nargs;
1934 priority[from] = standard_args[match].priority;
1935 /* If --OPTION=VALUE syntax is used,
1936 this option uses just one argv element. */
1937 if (equals != 0)
1938 options[from] = 0;
1939 if (from + options[from] >= argc)
1940 fatal ("Option '%s' requires an argument\n", argv[from]);
1941 from += options[from];
1943 else if (match == -2)
1945 /* This is an internal error.
1946 Eg if one long option is a prefix of another. */
1947 fprintf (stderr, "Option '%s' matched multiple standard arguments\n", argv[from]);
1949 /* Should we not also warn if there was no match? */
1951 done: ;
1955 /* Copy the arguments, in order of decreasing priority, to NEW. */
1956 new[0] = argv[0];
1957 while (incoming_used < argc)
1959 int best = -1;
1960 int best_priority = -9999;
1962 /* Find the highest priority remaining option.
1963 If several have equal priority, take the first of them. */
1964 for (from = 1; from < argc; from++)
1966 if (argv[from] != 0 && priority[from] > best_priority)
1968 best_priority = priority[from];
1969 best = from;
1971 /* Skip option arguments--they are tied to the options. */
1972 if (options[from] > 0)
1973 from += options[from];
1976 if (best < 0)
1977 emacs_abort ();
1979 /* Copy the highest priority remaining option, with its args, to NEW.
1980 Unless it is a duplicate of the previous one. */
1981 if (! (options[best] == 0
1982 && ! strcmp (new[to - 1], argv[best])))
1984 new[to++] = argv[best];
1985 for (i = 0; i < options[best]; i++)
1986 new[to++] = argv[best + i + 1];
1989 incoming_used += 1 + (options[best] > 0 ? options[best] : 0);
1991 /* Clear out this option in ARGV. */
1992 argv[best] = 0;
1993 for (i = 0; i < options[best]; i++)
1994 argv[best + i + 1] = 0;
1997 /* If duplicate options were deleted, fill up extra space with null ptrs. */
1998 while (to < argc)
1999 new[to++] = 0;
2001 memcpy (argv, new, sizeof (char *) * argc);
2003 xfree (options);
2004 xfree (new);
2005 xfree (priority);
2008 DEFUN ("kill-emacs", Fkill_emacs, Skill_emacs, 0, 1, "P",
2009 doc: /* Exit the Emacs job and kill it.
2010 If ARG is an integer, return ARG as the exit program code.
2011 If ARG is a string, stuff it as keyboard input.
2013 This function is called upon receipt of the signals SIGTERM
2014 or SIGHUP, and upon SIGINT in batch mode.
2016 The value of `kill-emacs-hook', if not void,
2017 is a list of functions (of no args),
2018 all of which are called before Emacs is actually killed. */
2019 attributes: noreturn)
2020 (Lisp_Object arg)
2022 int exit_code;
2024 /* Fsignal calls emacs_abort () if it sees that waiting_for_input is
2025 set. */
2026 waiting_for_input = 0;
2027 if (noninteractive)
2028 safe_run_hooks (Qkill_emacs_hook);
2029 else
2030 run_hook (Qkill_emacs_hook);
2032 #ifdef HAVE_X_WINDOWS
2033 /* Transfer any clipboards we own to the clipboard manager. */
2034 x_clipboard_manager_save_all ();
2035 #endif
2037 shut_down_emacs (0, (STRINGP (arg) && !feof (stdin)) ? arg : Qnil);
2039 #ifdef HAVE_NS
2040 ns_release_autorelease_pool (ns_pool);
2041 #endif
2043 /* If we have an auto-save list file,
2044 kill it because we are exiting Emacs deliberately (not crashing).
2045 Do it after shut_down_emacs, which does an auto-save. */
2046 if (STRINGP (Vauto_save_list_file_name))
2048 Lisp_Object listfile;
2049 listfile = Fexpand_file_name (Vauto_save_list_file_name, Qnil);
2050 unlink (SSDATA (listfile));
2053 if (INTEGERP (arg))
2054 exit_code = (XINT (arg) < 0
2055 ? XINT (arg) | INT_MIN
2056 : XINT (arg) & INT_MAX);
2057 else
2058 exit_code = EXIT_SUCCESS;
2059 exit (exit_code);
2063 /* Perform an orderly shutdown of Emacs. Autosave any modified
2064 buffers, kill any child processes, clean up the terminal modes (if
2065 we're in the foreground), and other stuff like that. Don't perform
2066 any redisplay; this may be called when Emacs is shutting down in
2067 the background, or after its X connection has died.
2069 If SIG is a signal number, print a message for it.
2071 This is called by fatal signal handlers, X protocol error handlers,
2072 and Fkill_emacs. */
2074 void
2075 shut_down_emacs (int sig, Lisp_Object stuff)
2077 /* Prevent running of hooks from now on. */
2078 Vrun_hooks = Qnil;
2080 /* Don't update display from now on. */
2081 Vinhibit_redisplay = Qt;
2083 /* If we are controlling the terminal, reset terminal modes. */
2084 #ifndef DOS_NT
2086 pid_t pgrp = getpgrp ();
2087 pid_t tpgrp = tcgetpgrp (0);
2088 if ((tpgrp != -1) && tpgrp == pgrp)
2090 reset_all_sys_modes ();
2091 if (sig && sig != SIGTERM)
2093 static char const format[] = "Fatal error %d: ";
2094 char buf[sizeof format - 2 + INT_STRLEN_BOUND (int)];
2095 int buflen = sprintf (buf, format, sig);
2096 char const *sig_desc = safe_strsignal (sig);
2097 emacs_write (STDERR_FILENO, buf, buflen);
2098 emacs_write (STDERR_FILENO, sig_desc, strlen (sig_desc));
2102 #else
2103 fflush (stdout);
2104 reset_all_sys_modes ();
2105 #endif
2107 stuff_buffered_input (stuff);
2109 inhibit_sentinels = 1;
2110 kill_buffer_processes (Qnil);
2111 Fdo_auto_save (Qt, Qnil);
2113 unlock_all_files ();
2115 /* There is a tendency for a SIGIO signal to arrive within exit,
2116 and cause a SIGHUP because the input descriptor is already closed. */
2117 unrequest_sigio ();
2119 /* Do this only if terminating normally, we want glyph matrices
2120 etc. in a core dump. */
2121 if (sig == 0 || sig == SIGTERM)
2123 check_glyph_memory ();
2124 check_message_stack ();
2127 #ifdef MSDOS
2128 dos_cleanup ();
2129 #endif
2131 #ifdef HAVE_NS
2132 ns_term_shutdown (sig);
2133 #endif
2135 #ifdef HAVE_LIBXML2
2136 xml_cleanup_parser ();
2137 #endif
2139 #ifdef WINDOWSNT
2140 term_ntproc (0);
2141 #endif
2146 #ifndef CANNOT_DUMP
2148 #include "unexec.h"
2150 DEFUN ("dump-emacs", Fdump_emacs, Sdump_emacs, 2, 2, 0,
2151 doc: /* Dump current state of Emacs into executable file FILENAME.
2152 Take symbols from SYMFILE (presumably the file you executed to run Emacs).
2153 This is used in the file `loadup.el' when building Emacs.
2155 You must run Emacs in batch mode in order to dump it. */)
2156 (Lisp_Object filename, Lisp_Object symfile)
2158 Lisp_Object tem;
2159 Lisp_Object symbol;
2160 ptrdiff_t count = SPECPDL_INDEX ();
2162 check_pure_size ();
2164 if (! noninteractive)
2165 error ("Dumping Emacs works only in batch mode");
2167 if (!might_dump)
2168 error ("Emacs can be dumped only once");
2170 #if defined GNU_LINUX && !defined CANNOT_DUMP
2172 /* Warn if the gap between BSS end and heap start is larger than this. */
2173 # define MAX_HEAP_BSS_DIFF (1024*1024)
2175 if (heap_bss_diff > MAX_HEAP_BSS_DIFF)
2177 fprintf (stderr, "**************************************************\n");
2178 fprintf (stderr, "Warning: Your system has a gap between BSS and the\n");
2179 fprintf (stderr, "heap (%"pMu" bytes). This usually means that exec-shield\n",
2180 heap_bss_diff);
2181 fprintf (stderr, "or something similar is in effect. The dump may\n");
2182 fprintf (stderr, "fail because of this. See the section about\n");
2183 fprintf (stderr, "exec-shield in etc/PROBLEMS for more information.\n");
2184 fprintf (stderr, "**************************************************\n");
2186 #endif /* GNU_LINUX */
2188 /* Bind `command-line-processed' to nil before dumping,
2189 so that the dumped Emacs will process its command line
2190 and set up to work with X windows if appropriate. */
2191 symbol = intern ("command-line-processed");
2192 specbind (symbol, Qnil);
2194 CHECK_STRING (filename);
2195 filename = Fexpand_file_name (filename, Qnil);
2196 filename = ENCODE_FILE (filename);
2197 if (!NILP (symfile))
2199 CHECK_STRING (symfile);
2200 if (SCHARS (symfile))
2202 symfile = Fexpand_file_name (symfile, Qnil);
2203 symfile = ENCODE_FILE (symfile);
2207 tem = Vpurify_flag;
2208 Vpurify_flag = Qnil;
2210 #ifdef HYBRID_MALLOC
2212 static char const fmt[] = "%d of %d static heap bytes used";
2213 char buf[sizeof fmt + 2 * (INT_STRLEN_BOUND (int) - 2)];
2214 int max_usage = max_bss_sbrk_ptr - bss_sbrk_buffer;
2215 sprintf (buf, fmt, max_usage, STATIC_HEAP_SIZE);
2216 /* Don't log messages, because at this point buffers cannot be created. */
2217 message1_nolog (buf);
2219 #endif
2221 fflush_unlocked (stdout);
2222 /* Tell malloc where start of impure now is. */
2223 /* Also arrange for warnings when nearly out of space. */
2224 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
2225 #ifndef WINDOWSNT
2226 /* On Windows, this was done before dumping, and that once suffices.
2227 Meanwhile, my_edata is not valid on Windows. */
2228 memory_warnings (my_edata, malloc_warning);
2229 #endif /* not WINDOWSNT */
2230 #endif /* not SYSTEM_MALLOC and not HYBRID_MALLOC */
2232 alloc_unexec_pre ();
2234 unexec (SSDATA (filename), !NILP (symfile) ? SSDATA (symfile) : 0);
2236 alloc_unexec_post ();
2238 #ifdef WINDOWSNT
2239 Vlibrary_cache = Qnil;
2240 #endif
2241 #ifdef HAVE_WINDOW_SYSTEM
2242 reset_image_types ();
2243 #endif
2245 Vpurify_flag = tem;
2247 return unbind_to (count, Qnil);
2250 #endif /* not CANNOT_DUMP */
2252 #if HAVE_SETLOCALE
2253 /* Recover from setlocale (LC_ALL, ""). */
2254 void
2255 fixup_locale (void)
2257 /* The Emacs Lisp reader needs LC_NUMERIC to be "C",
2258 so that numbers are read and printed properly for Emacs Lisp. */
2259 setlocale (LC_NUMERIC, "C");
2262 /* Set system locale CATEGORY, with previous locale *PLOCALE, to
2263 DESIRED_LOCALE. */
2264 static void
2265 synchronize_locale (int category, Lisp_Object *plocale, Lisp_Object desired_locale)
2267 if (! EQ (*plocale, desired_locale))
2269 *plocale = desired_locale;
2270 #ifdef WINDOWSNT
2271 /* Changing categories like LC_TIME usually requires specifying
2272 an encoding suitable for the new locale, but MS-Windows's
2273 'setlocale' will only switch the encoding when LC_ALL is
2274 specified. So we ignore CATEGORY, use LC_ALL instead, and
2275 then restore LC_NUMERIC to "C", so reading and printing
2276 numbers is unaffected. */
2277 setlocale (LC_ALL, (STRINGP (desired_locale)
2278 ? SSDATA (desired_locale)
2279 : ""));
2280 fixup_locale ();
2281 #else /* !WINDOWSNT */
2282 setlocale (category, (STRINGP (desired_locale)
2283 ? SSDATA (desired_locale)
2284 : ""));
2285 #endif /* !WINDOWSNT */
2289 /* Set system time locale to match Vsystem_time_locale, if possible. */
2290 void
2291 synchronize_system_time_locale (void)
2293 synchronize_locale (LC_TIME, &Vprevious_system_time_locale,
2294 Vsystem_time_locale);
2297 /* Set system messages locale to match Vsystem_messages_locale, if
2298 possible. */
2299 void
2300 synchronize_system_messages_locale (void)
2302 #ifdef LC_MESSAGES
2303 synchronize_locale (LC_MESSAGES, &Vprevious_system_messages_locale,
2304 Vsystem_messages_locale);
2305 #endif
2307 #endif /* HAVE_SETLOCALE */
2309 /* Return a diagnostic string for ERROR_NUMBER, in the wording
2310 and encoding appropriate for the current locale. */
2311 char *
2312 emacs_strerror (int error_number)
2314 synchronize_system_messages_locale ();
2315 return strerror (error_number);
2319 Lisp_Object
2320 decode_env_path (const char *evarname, const char *defalt, bool empty)
2322 const char *path, *p;
2323 Lisp_Object lpath, element, tem;
2324 /* Default is to use "." for empty path elements.
2325 But if argument EMPTY is true, use nil instead. */
2326 Lisp_Object empty_element = empty ? Qnil : build_string (".");
2327 #ifdef WINDOWSNT
2328 bool defaulted = 0;
2329 static const char *emacs_dir_env = "%emacs_dir%/";
2330 const size_t emacs_dir_len = strlen (emacs_dir_env);
2331 const char *edir = egetenv ("emacs_dir");
2332 char emacs_dir[MAX_UTF8_PATH];
2334 /* egetenv looks in process-environment, which holds the variables
2335 in their original system-locale encoding. We need emacs_dir to
2336 be in UTF-8. */
2337 if (edir)
2338 filename_from_ansi (edir, emacs_dir);
2339 #endif
2341 /* It's okay to use getenv here, because this function is only used
2342 to initialize variables when Emacs starts up, and isn't called
2343 after that. */
2344 if (evarname != 0)
2345 path = getenv (evarname);
2346 else
2347 path = 0;
2348 if (!path)
2350 path = defalt;
2351 #ifdef WINDOWSNT
2352 defaulted = 1;
2353 #endif
2355 #ifdef DOS_NT
2356 /* Ensure values from the environment use the proper directory separator. */
2357 if (path)
2359 char *path_copy;
2361 #ifdef WINDOWSNT
2362 char *path_utf8, *q, *d;
2363 int cnv_result;
2365 /* Convert each element of PATH to UTF-8. */
2366 p = path_copy = alloca (strlen (path) + 1);
2367 strcpy (path_copy, path);
2368 d = path_utf8 = alloca (4 * strlen (path) + 1);
2369 *d = '\0';
2370 do {
2371 q = _mbschr (p, SEPCHAR);
2372 if (q)
2373 *q = '\0';
2374 cnv_result = filename_from_ansi (p, d);
2375 if (q)
2377 *q++ = SEPCHAR;
2378 p = q;
2379 /* If conversion of this PATH elements fails, make sure
2380 destination pointer will stay put, thus effectively
2381 ignoring the offending element. */
2382 if (cnv_result == 0)
2384 d += strlen (d);
2385 *d++ = SEPCHAR;
2388 else if (cnv_result != 0 && d > path_utf8)
2389 d[-1] = '\0'; /* remove last semi-colon and null-terminate PATH */
2390 } while (q);
2391 path_copy = path_utf8;
2392 #else /* MSDOS */
2393 path_copy = alloca (strlen (path) + 1);
2394 strcpy (path_copy, path);
2395 #endif
2396 dostounix_filename (path_copy);
2397 path = path_copy;
2399 #endif
2400 lpath = Qnil;
2401 while (1)
2403 p = strchr (path, SEPCHAR);
2404 if (!p)
2405 p = path + strlen (path);
2406 element = ((p - path) ? make_unibyte_string (path, p - path)
2407 : empty_element);
2408 if (! NILP (element))
2410 #ifdef WINDOWSNT
2411 /* Relative file names in the default path are interpreted as
2412 being relative to $emacs_dir. */
2413 if (edir && defaulted
2414 && strncmp (path, emacs_dir_env, emacs_dir_len) == 0)
2415 element = Fexpand_file_name (Fsubstring
2416 (element,
2417 make_number (emacs_dir_len),
2418 Qnil),
2419 build_unibyte_string (emacs_dir));
2420 #endif
2422 /* Add /: to the front of the name
2423 if it would otherwise be treated as magic. */
2424 tem = Ffind_file_name_handler (element, Qt);
2426 /* However, if the handler says "I'm safe",
2427 don't bother adding /:. */
2428 if (SYMBOLP (tem))
2430 Lisp_Object prop;
2431 prop = Fget (tem, intern ("safe-magic"));
2432 if (! NILP (prop))
2433 tem = Qnil;
2436 if (! NILP (tem))
2438 AUTO_STRING (slash_colon, "/:");
2439 element = concat2 (slash_colon, element);
2441 } /* !NILP (element) */
2443 lpath = Fcons (element, lpath);
2444 if (*p)
2445 path = p + 1;
2446 else
2447 break;
2449 return Fnreverse (lpath);
2452 DEFUN ("daemonp", Fdaemonp, Sdaemonp, 0, 0, 0,
2453 doc: /* Return non-nil if the current emacs process is a daemon.
2454 If the daemon was given a name argument, return that name. */)
2455 (void)
2457 if (IS_DAEMON)
2458 if (daemon_name)
2459 return build_string (daemon_name);
2460 else
2461 return Qt;
2462 else
2463 return Qnil;
2466 DEFUN ("daemon-initialized", Fdaemon_initialized, Sdaemon_initialized, 0, 0, 0,
2467 doc: /* Mark the Emacs daemon as being initialized.
2468 This finishes the daemonization process by doing the other half of detaching
2469 from the parent process and its tty file descriptors. */)
2470 (void)
2472 bool err = 0;
2474 if (!IS_DAEMON)
2475 error ("This function can only be called if emacs is run as a daemon");
2477 if (!DAEMON_RUNNING)
2478 error ("The daemon has already been initialized");
2480 if (NILP (Vafter_init_time))
2481 error ("This function can only be called after loading the init files");
2482 #ifndef WINDOWSNT
2484 if (daemon_type == 2)
2486 int nfd;
2488 /* Get rid of stdin, stdout and stderr. */
2489 nfd = emacs_open ("/dev/null", O_RDWR, 0);
2490 err |= nfd < 0;
2491 err |= dup2 (nfd, STDIN_FILENO) < 0;
2492 err |= dup2 (nfd, STDOUT_FILENO) < 0;
2493 err |= dup2 (nfd, STDERR_FILENO) < 0;
2494 err |= emacs_close (nfd) != 0;
2496 /* Closing the pipe will notify the parent that it can exit.
2497 FIXME: In case some other process inherited the pipe, closing it here
2498 won't notify the parent because it's still open elsewhere, so we
2499 additionally send a byte, just to make sure the parent really exits.
2500 Instead, we should probably close the pipe in start-process and
2501 call-process to make sure the pipe is never inherited by
2502 subprocesses. */
2503 err |= write (daemon_pipe[1], "\n", 1) < 0;
2504 err |= emacs_close (daemon_pipe[1]) != 0;
2507 /* Set it to an invalid value so we know we've already run this function. */
2508 daemon_type = -1;
2510 #else /* WINDOWSNT */
2511 /* Signal the waiting emacsclient process. */
2512 err |= SetEvent (w32_daemon_event) == 0;
2513 err |= CloseHandle (w32_daemon_event) == 0;
2514 /* Set it to an invalid value so we know we've already run this function. */
2515 w32_daemon_event = INVALID_HANDLE_VALUE;
2516 #endif
2518 if (err)
2519 error ("I/O error during daemon initialization");
2520 return Qt;
2523 void
2524 syms_of_emacs (void)
2526 DEFSYM (Qfile_name_handler_alist, "file-name-handler-alist");
2527 DEFSYM (Qrisky_local_variable, "risky-local-variable");
2528 DEFSYM (Qkill_emacs, "kill-emacs");
2529 DEFSYM (Qkill_emacs_hook, "kill-emacs-hook");
2531 #ifndef CANNOT_DUMP
2532 defsubr (&Sdump_emacs);
2533 #endif
2535 defsubr (&Skill_emacs);
2537 defsubr (&Sinvocation_name);
2538 defsubr (&Sinvocation_directory);
2539 defsubr (&Sdaemonp);
2540 defsubr (&Sdaemon_initialized);
2542 DEFVAR_LISP ("command-line-args", Vcommand_line_args,
2543 doc: /* Args passed by shell to Emacs, as a list of strings.
2544 Many arguments are deleted from the list as they are processed. */);
2546 DEFVAR_LISP ("system-type", Vsystem_type,
2547 doc: /* The value is a symbol indicating the type of operating system you are using.
2548 Special values:
2549 `gnu' compiled for a GNU Hurd system.
2550 `gnu/linux' compiled for a GNU/Linux system.
2551 `gnu/kfreebsd' compiled for a GNU system with a FreeBSD kernel.
2552 `darwin' compiled for Darwin (GNU-Darwin, macOS, ...).
2553 `ms-dos' compiled as an MS-DOS application.
2554 `windows-nt' compiled as a native W32 application.
2555 `cygwin' compiled using the Cygwin library.
2556 Anything else (in Emacs 26, the possibilities are: aix, berkeley-unix,
2557 hpux, usg-unix-v) indicates some sort of Unix system. */);
2558 Vsystem_type = intern_c_string (SYSTEM_TYPE);
2559 /* See configure.ac for the possible SYSTEM_TYPEs. */
2561 DEFVAR_LISP ("system-configuration", Vsystem_configuration,
2562 doc: /* Value is string indicating configuration Emacs was built for. */);
2563 Vsystem_configuration = build_string (EMACS_CONFIGURATION);
2565 DEFVAR_LISP ("system-configuration-options", Vsystem_configuration_options,
2566 doc: /* String containing the configuration options Emacs was built with. */);
2567 Vsystem_configuration_options = build_string (EMACS_CONFIG_OPTIONS);
2569 DEFVAR_LISP ("system-configuration-features", Vsystem_configuration_features,
2570 doc: /* String listing some of the main features this Emacs was compiled with.
2571 An element of the form \"FOO\" generally means that HAVE_FOO was
2572 defined during the build.
2574 This is mainly intended for diagnostic purposes in bug reports.
2575 Don't rely on it for testing whether a feature you want to use is available. */);
2576 Vsystem_configuration_features = build_string (EMACS_CONFIG_FEATURES);
2578 DEFVAR_BOOL ("noninteractive", noninteractive1,
2579 doc: /* Non-nil means Emacs is running without interactive terminal. */);
2581 DEFVAR_LISP ("kill-emacs-hook", Vkill_emacs_hook,
2582 doc: /* Hook run when `kill-emacs' is called.
2583 Since `kill-emacs' may be invoked when the terminal is disconnected (or
2584 in other similar situations), functions placed on this hook should not
2585 expect to be able to interact with the user. To ask for confirmation,
2586 see `kill-emacs-query-functions' instead.
2588 Before Emacs 24.1, the hook was not run in batch mode, i.e., if
2589 `noninteractive' was non-nil. */);
2590 Vkill_emacs_hook = Qnil;
2592 DEFVAR_LISP ("path-separator", Vpath_separator,
2593 doc: /* String containing the character that separates directories in
2594 search paths, such as PATH and other similar environment variables. */);
2596 char c = SEPCHAR;
2597 Vpath_separator = make_string (&c, 1);
2600 DEFVAR_LISP ("invocation-name", Vinvocation_name,
2601 doc: /* The program name that was used to run Emacs.
2602 Any directory names are omitted. */);
2604 DEFVAR_LISP ("invocation-directory", Vinvocation_directory,
2605 doc: /* The directory in which the Emacs executable was found, to run it.
2606 The value is nil if that directory's name is not known. */);
2608 DEFVAR_LISP ("installation-directory", Vinstallation_directory,
2609 doc: /* A directory within which to look for the `lib-src' and `etc' directories.
2610 In an installed Emacs, this is normally nil. It is non-nil if
2611 both `lib-src' (on MS-DOS, `info') and `etc' directories are found
2612 within the variable `invocation-directory' or its parent. For example,
2613 this is the case when running an uninstalled Emacs executable from its
2614 build directory. */);
2615 Vinstallation_directory = Qnil;
2617 DEFVAR_LISP ("system-messages-locale", Vsystem_messages_locale,
2618 doc: /* System locale for messages. */);
2619 Vsystem_messages_locale = Qnil;
2621 DEFVAR_LISP ("previous-system-messages-locale",
2622 Vprevious_system_messages_locale,
2623 doc: /* Most recently used system locale for messages. */);
2624 Vprevious_system_messages_locale = Qnil;
2626 DEFVAR_LISP ("system-time-locale", Vsystem_time_locale,
2627 doc: /* System locale for time. */);
2628 Vsystem_time_locale = Qnil;
2630 DEFVAR_LISP ("previous-system-time-locale", Vprevious_system_time_locale,
2631 doc: /* Most recently used system locale for time. */);
2632 Vprevious_system_time_locale = Qnil;
2634 DEFVAR_LISP ("before-init-time", Vbefore_init_time,
2635 doc: /* Value of `current-time' before Emacs begins initialization. */);
2636 Vbefore_init_time = Qnil;
2638 DEFVAR_LISP ("after-init-time", Vafter_init_time,
2639 doc: /* Value of `current-time' after loading the init files.
2640 This is nil during initialization. */);
2641 Vafter_init_time = Qnil;
2643 DEFVAR_BOOL ("inhibit-x-resources", inhibit_x_resources,
2644 doc: /* If non-nil, X resources, Windows Registry settings, and NS defaults are not used. */);
2645 inhibit_x_resources = 0;
2647 DEFVAR_LISP ("emacs-copyright", Vemacs_copyright,
2648 doc: /* Short copyright string for this version of Emacs. */);
2649 Vemacs_copyright = build_string (emacs_copyright);
2651 DEFVAR_LISP ("emacs-version", Vemacs_version,
2652 doc: /* Version numbers of this version of Emacs.
2653 This has the form: MAJOR.MINOR[.MICRO], where MAJOR/MINOR/MICRO are integers.
2654 MICRO is only present in unreleased development versions,
2655 and is not especially meaningful. Prior to Emacs 26.1, an extra final
2656 component .BUILD is present. This is now stored separately in
2657 `emacs-build-number'. */);
2658 Vemacs_version = build_string (emacs_version);
2660 DEFVAR_LISP ("report-emacs-bug-address", Vreport_emacs_bug_address,
2661 doc: /* Address of mailing list for GNU Emacs bugs. */);
2662 Vreport_emacs_bug_address = build_string (emacs_bugreport);
2664 DEFVAR_LISP ("dynamic-library-alist", Vdynamic_library_alist,
2665 doc: /* Alist of dynamic libraries vs external files implementing them.
2666 Each element is a list (LIBRARY FILE...), where the car is a symbol
2667 representing a supported external library, and the rest are strings giving
2668 alternate filenames for that library.
2670 Emacs tries to load the library from the files in the order they appear on
2671 the list; if none is loaded, the running session of Emacs won't have access
2672 to that library.
2674 Note that image types `pbm' and `xbm' do not need entries in this variable
2675 because they do not depend on external libraries and are always available.
2677 Also note that this is not a generic facility for accessing external
2678 libraries; only those already known by Emacs will be loaded. */);
2679 Vdynamic_library_alist = Qnil;
2680 Fput (intern_c_string ("dynamic-library-alist"), Qrisky_local_variable, Qt);
2682 #ifdef WINDOWSNT
2683 Vlibrary_cache = Qnil;
2684 staticpro (&Vlibrary_cache);
2685 #endif