loadup.el 16.6 KB
Newer Older
1
;;; loadup.el --- load up standardly loaded Lisp files for Emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1985-1986, 1992, 1994, 2001-2016 Free Software
Paul Eggert's avatar
Paul Eggert committed
4
;; Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

6
;; Maintainer: emacs-devel@gnu.org
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Keywords: internal
8
;; Package: emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
9

Jim Blandy's avatar
Jim Blandy committed
10 11
;; This file is part of GNU Emacs.

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

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

Eric S. Raymond's avatar
Eric S. Raymond committed
25 26 27 28
;;; Commentary:

;; This is loaded into a bare Emacs to make a dumpable one.

29
;; If you add a file to be loaded here, keep the following points in mind:
Glenn Morris's avatar
Glenn Morris committed
30

31 32 33 34
;; i) If the file is no-byte-compile, explicitly load the .el version.
;; Such files should (where possible) obey the doc-string conventions
;; expected by make-docfile.  They should also be added to the
;; uncompiled[] list in make-docfile.c.
Glenn Morris's avatar
Glenn Morris committed
35

36 37 38 39 40 41 42
;; ii) If the file is dumped with Emacs (on any platform), put the
;; load statement at the start of a line (leading whitespace is ok).

;; iii) If the file is _not_ dumped with Emacs, make sure the load
;; statement is _not_ at the start of a line.  See pcase for an example.

;; These rules are so that src/Makefile can construct lisp.mk automatically.
43 44 45
;; This ensures both that the Lisp files are compiled (if necessary)
;; before the emacs executable is dumped, and that they are passed to
;; make-docfile.  (Any that are not processed for DOC will not have
46
;; doc strings in the dumped Emacs.)
Glenn Morris's avatar
Glenn Morris committed
47

Eric S. Raymond's avatar
Eric S. Raymond committed
48 49
;;; Code:

50 51 52 53 54 55 56
;; This is used in xdisp.c to determine when bidi reordering is safe.
;; (It starts non-nil in temacs, but we set it non-nil here anyway, in
;; case someone loads loadup one more time.)  We reset it after
;; successfully loading charprop.el, which defines the Unicode tables
;; bidi.c needs for its job.
(setq redisplay--inhibit-bidi t)

Glenn Morris's avatar
Glenn Morris committed
57 58
;; Add subdirectories to the load-path for files that might get
;; autoloaded when bootstrapping.
59
;; This is because PATH_DUMPLOADSEARCH is just "../lisp".
60
(if (or (equal (member "bootstrap" command-line-args) '("bootstrap"))
61 62 63
	;; FIXME this is irritatingly fragile.
	(equal (nth 4 command-line-args) "unidata-gen.el")
	(equal (nth 7 command-line-args) "unidata-gen-files")
64 65 66
	(if (fboundp 'dump-emacs)
	    (string-match "src/bootstrap-emacs" (nth 0 command-line-args))
	  t))
67
    (let ((dir (car load-path)))
68 69
      ;; We'll probably overflow the pure space.
      (setq purify-flag nil)
70
      (setq load-path (list (expand-file-name "." dir)
71 72 73
			    (expand-file-name "emacs-lisp" dir)
			    (expand-file-name "language" dir)
			    (expand-file-name "international" dir)
74 75
			    (expand-file-name "textmodes" dir)
			    (expand-file-name "vc" dir)))))
76

Glenn Morris's avatar
Glenn Morris committed
77 78
;; Prevent build-time PATH getting stored in the binary.
;; Mainly cosmetic, but helpful for Guix.  (Bug#20330)
79 80
(setq exec-path nil)

Stefan Monnier's avatar
Stefan Monnier committed
81 82
(if (eq t purify-flag)
    ;; Hash consing saved around 11% of pure space in my tests.
83
    (setq purify-flag (make-hash-table :test 'equal :size 80000)))
Stefan Monnier's avatar
Stefan Monnier committed
84

85 86
(message "Using load-path %s" load-path)

87 88 89
;; This is a poor man's `last', since we haven't loaded subr.el yet.
(if (or (equal (member "bootstrap" command-line-args) '("bootstrap"))
	(equal (member "dump" command-line-args) '("dump")))
90 91 92 93 94 95
    (progn
      ;; To reduce the size of dumped Emacs, we avoid making huge char-tables.
      (setq inhibit-load-charset-map t)
      ;; --eval gets handled too late.
      (defvar load--prefer-newer load-prefer-newer)
      (setq load-prefer-newer t)))
96

97
;; We don't want to have any undo records in the dumped Emacs.
98 99
(set-buffer "*scratch*")
(setq buffer-undo-list t)
Jim Blandy's avatar
Jim Blandy committed
100

101
(load "emacs-lisp/byte-run")
102
(load "emacs-lisp/backquote")
Jim Blandy's avatar
Jim Blandy committed
103
(load "subr")
104

105 106
;; Do it after subr, since both after-load-functions and add-hook are
;; implemented in subr.el.
107
(add-hook 'after-load-functions (lambda (f) (garbage-collect)))
108

109
(load "version")
110

111 112
(load "widget")
(load "custom")
113
(load "emacs-lisp/map-ynp")
114
(load "international/mule")
115
(load "international/mule-conf")
116
(load "env")
117
(load "format")
118
(load "bindings")
119
(load "window")  ; Needed here for `replace-buffer-in-windows'.
120
(setq load-source-file-function 'load-with-code-conversion)
Jim Blandy's avatar
Jim Blandy committed
121
(load "files")
122

123 124 125 126 127 128 129 130
;; Load-time macro-expansion can only take effect after setting
;; load-source-file-function because of where it is called in lread.c.
(load "emacs-lisp/macroexp")
(if (byte-code-function-p (symbol-function 'macroexpand-all))
    nil
  ;; Since loaddefs is not yet loaded, macroexp's uses of pcase will simply
  ;; fail until pcase is explicitly loaded.  This also means that we have to
  ;; disable eager macro-expansion while loading pcase.
131
  (let ((macroexp--pending-eager-loads '(skip))) (load "emacs-lisp/pcase"))
132
  ;; Re-load macroexp so as to eagerly macro-expand its uses of pcase.
133 134
  (let ((max-lisp-eval-depth (* 2 max-lisp-eval-depth)))
    (load "emacs-lisp/macroexp")))
135

136
(load "cus-face")
137 138
(load "faces")  ; after here, `defface' may be used.

139 140
(load "button")

141 142 143 144 145 146 147 148 149 150 151
;; We don't want to store loaddefs.el in the repository because it is
;; a generated file; but it is required in order to compile the lisp files.
;; When bootstrapping, we cannot generate loaddefs.el until an
;; emacs binary has been built.  We therefore compromise and keep
;; ldefs-boot.el in the repository.  This does not need to be updated
;; as often as the real loaddefs.el would.  Bootstrap should always
;; work with ldefs-boot.el.  Therefore, Whenever a new autoload cookie
;; gets added that is necessary during bootstrapping, ldefs-boot.el
;; should be updated by overwriting it with an up-to-date copy of
;; loaddefs.el that is uncorrupted by local changes.
;; autogen/update_autogen can be used to periodically update ldefs-boot.
152
(condition-case nil (load "loaddefs.el")
153 154 155
  ;; In case loaddefs hasn't been generated yet.
  (file-error (load "ldefs-boot.el")))

156
(load "emacs-lisp/nadvice")
157 158
(load "emacs-lisp/cl-preloaded")
(load "minibuffer")            ;After loaddefs, for define-minor-mode.
159
(load "abbrev")         ;lisp-mode.el and simple.el use define-abbrev-table.
160
(load "simple")
161

162
(load "help")
163

164
(load "jka-cmpr-hook")
165
(load "epa-hook")
166 167 168 169
;; Any Emacs Lisp source file (*.el) loaded here after can contain
;; multilingual text.
(load "international/mule-cmds")
(load "case-table")
Glenn Morris's avatar
Glenn Morris committed
170 171
;; This file doesn't exist when building a development version of Emacs
;; from the repository.  It is generated just after temacs is built.
172 173
(if (load "international/charprop.el" t)
    (setq redisplay--inhibit-bidi nil))
174 175
(load "international/characters")
(load "composite")
176

177
;; Load language-specific files.
Karl Heuer's avatar
Karl Heuer committed
178 179 180
(load "language/chinese")
(load "language/cyrillic")
(load "language/indian")
181
(load "language/sinhala")
182
(load "language/english")
Karl Heuer's avatar
Karl Heuer committed
183 184
(load "language/ethiopic")
(load "language/european")
185 186
(load "language/czech")
(load "language/slovak")
Dan Nicolaescu's avatar
Dan Nicolaescu committed
187
(load "language/romanian")
Karl Heuer's avatar
Karl Heuer committed
188 189
(load "language/greek")
(load "language/hebrew")
190 191
(load "international/cp51932")
(load "international/eucjp-ms")
Karl Heuer's avatar
Karl Heuer committed
192 193
(load "language/japanese")
(load "language/korean")
Kenichi Handa's avatar
Kenichi Handa committed
194
(load "language/lao")
Kenichi Handa's avatar
Kenichi Handa committed
195
(load "language/tai-viet")
Karl Heuer's avatar
Karl Heuer committed
196
(load "language/thai")
197
(load "language/tibetan")
Karl Heuer's avatar
Karl Heuer committed
198 199
(load "language/vietnamese")
(load "language/misc-lang")
200 201
(load "language/utf-8-lang")
(load "language/georgian")
202
(load "language/khmer")
203
(load "language/burmese")
Kenichi Handa's avatar
Kenichi Handa committed
204
(load "language/cham")
205

Jim Blandy's avatar
Jim Blandy committed
206
(load "indent")
207
(load "emacs-lisp/cl-generic")
208
(load "frame")
Stefan Monnier's avatar
Stefan Monnier committed
209
(load "startup")
210
(load "term/tty-colors")
Colin Walters's avatar
Colin Walters committed
211
(load "font-core")
212 213
;; facemenu must be loaded before font-lock, because `facemenu-keymap'
;; needs to be defined when font-lock is loaded.
214
(load "facemenu")
215 216 217
(load "emacs-lisp/syntax")
(load "font-lock")
(load "jit-lock")
218

219 220 221 222
(load "mouse")
(if (boundp 'x-toolkit-scroll-bars)
    (load "scroll-bar"))
(load "select")
223
(load "emacs-lisp/timer")
224
(load "isearch")
Luc Teirlinck's avatar
Luc Teirlinck committed
225
(load "rfn-eshadow")
226

Richard M. Stallman's avatar
Richard M. Stallman committed
227
(load "menu-bar")
228 229
(load "emacs-lisp/lisp")
(load "textmodes/page")
Jim Blandy's avatar
Jim Blandy committed
230
(load "register")
231
(load "textmodes/paragraphs")
232
(load "progmodes/prog-mode")
233
(load "emacs-lisp/lisp-mode")
234
(load "progmodes/elisp-mode")
235 236
(load "textmodes/text-mode")
(load "textmodes/fill")
237
(load "newcomment")
238

Jim Blandy's avatar
Jim Blandy committed
239
(load "replace")
240
(load "emacs-lisp/tabulated-list")
Jim Blandy's avatar
Jim Blandy committed
241
(load "buff-menu")
242 243 244

(if (fboundp 'x-create-frame)
    (progn
245
      (load "fringe")
246 247
      ;; Needed by `imagemagick-register-types'
      (load "emacs-lisp/regexp-opt")
248 249 250 251
      (load "image")
      (load "international/fontset")
      (load "dnd")
      (load "tool-bar")))
252

253 254
(if (featurep 'dynamic-setting)
    (load "dynamic-setting"))
255

256
(if (featurep 'x)
257
    (progn
258
      (load "x-dnd")
259
      (load "term/common-win")
260
      (load "term/x-win")))
261

Daniel Colascione's avatar
Daniel Colascione committed
262 263
(if (or (eq system-type 'windows-nt)
        (featurep 'w32))
264
    (progn
265
      (load "term/common-win")
Daniel Colascione's avatar
Daniel Colascione committed
266
      (load "w32-vars")
267
      (load "term/w32-win")
Eli Zaretskii's avatar
Eli Zaretskii committed
268
      (load "disp-table")
Daniel Colascione's avatar
Daniel Colascione committed
269 270 271 272
      (when (eq system-type 'windows-nt)
        (load "w32-fns")
        (load "ls-lisp")
        (load "dos-w32"))))
273 274
(if (eq system-type 'ms-dos)
    (progn
Geoff Voelker's avatar
Geoff Voelker committed
275
      (load "dos-w32")
276
      (load "dos-fns")
277
      (load "dos-vars")
Eli Zaretskii's avatar
Eli Zaretskii committed
278 279
      ;; Don't load term/common-win: it isn't appropriate for the `pc'
      ;; ``window system'', which generally behaves like a terminal.
280
      (load "term/internal")
Eli Zaretskii's avatar
Eli Zaretskii committed
281 282
      (load "term/pc-win")
      (load "ls-lisp")
283
      (load "disp-table"))) ; needed to setup ibm-pc char set, see internal.el
Dan Nicolaescu's avatar
Dan Nicolaescu committed
284
(if (featurep 'ns)
Glenn Morris's avatar
Glenn Morris committed
285 286
    (progn
      (load "term/common-win")
287 288 289 290 291 292
      ;; Don't load ucs-normalize.el unless uni-*.el files were
      ;; already produced, because it needs uni-*.el files that might
      ;; not be built early enough during bootstrap.
      (when (load-history-filename-element "charprop\\.el")
        (load "international/ucs-normalize")
        (load "term/ns-win"))))
293 294 295 296
(if (fboundp 'x-create-frame)
    ;; Do it after loading term/foo-win.el since the value of the
    ;; mouse-wheel-*-event vars depends on those files being loaded or not.
    (load "mwheel"))
297 298
;; Preload some constants and floating point functions.
(load "emacs-lisp/float-sup")
299

300 301
(load "vc/vc-hooks")
(load "vc/ediff-hook")
302
(load "uniquify")
303
(load "electric")
304
(load "emacs-lisp/eldoc")
305
(load "cus-start") ;Late to reduce customize-rogue (needs loaddefs.el anyway)
306 307
(if (not (eq system-type 'ms-dos))
    (load "tooltip"))
308

Glenn Morris's avatar
Glenn Morris committed
309 310
;; This file doesn't exist when building a development version of Emacs
;; from the repository.  It is generated just after temacs is built.
311
(load "leim/leim-list.el" t)
Glenn Morris's avatar
Glenn Morris committed
312 313 314 315 316 317

;; If you want additional libraries to be preloaded and their
;; doc strings kept in the DOC file rather than in core,
;; you may load them with a "site-load.el" file.
;; But you must also cause them to be scanned when the DOC file
;; is generated.
318 319 320 321 322 323 324 325 326
(let ((lp load-path))
  (load "site-load" t)
  ;; We reset load-path after dumping.
  ;; For a permanent change in load-path, use configure's
  ;; --enable-locallisppath option.
  ;; See http://debbugs.gnu.org/16107 for more details.
  (or (equal lp load-path)
      (message "Warning: Change in load-path due to site-load will be \
lost after dumping")))
Jim Blandy's avatar
Jim Blandy committed
327

328 329 330 331 332 333 334
;; Make sure default-directory is unibyte when dumping.  This is
;; because we cannot decode and encode it correctly (since the locale
;; environment is not, and should not be, set up).  default-directory
;; is used every time we call expand-file-name, which we do in every
;; file primitive.  So the only workable solution to support building
;; in non-ASCII directories is to manipulate unibyte strings in the
;; current locale's encoding.
335
(if (and (member (car (last command-line-args)) '("dump" "bootstrap"))
336 337 338
	 (multibyte-string-p default-directory))
    (error "default-directory must be unibyte when dumping Emacs!"))

339 340
;; Determine which last version number to use
;; based on the executables that now exist.
341
(if (and (equal (last command-line-args) '("dump"))
342
	 (not (eq system-type 'ms-dos)))
343
    (let* ((base (concat "emacs-" emacs-version "."))
344
	   (exelen (if (eq system-type 'windows-nt) -4))
345
	   (files (file-name-all-completions base default-directory))
346 347 348 349
	   (versions (mapcar (function
			      (lambda (name)
				(string-to-number
				 (substring name (length base) exelen))))
350
			     files)))
351
      (setq emacs-repository-version (condition-case nil (emacs-repository-get-version)
Glenn Morris's avatar
Glenn Morris committed
352
                              (error nil)))
353 354 355 356
      ;; `emacs-version' is a constant, so we shouldn't change it with `setq'.
      (defconst emacs-version
	(format "%s.%d"
		emacs-version (if versions (1+ (apply 'max versions)) 1)))))
357

Jim Blandy's avatar
Jim Blandy committed
358 359

(message "Finding pointers to doc strings...")
360
(if (equal (last command-line-args) '("dump"))
361 362 363 364
    (Snarf-documentation "DOC")
  (condition-case nil
      (Snarf-documentation "DOC")
    (error nil)))
Jim Blandy's avatar
Jim Blandy committed
365 366
(message "Finding pointers to doc strings...done")

367 368
;; Note: You can cause additional libraries to be preloaded
;; by writing a site-init.el that loads them.
369 370 371 372 373 374 375
;; See also "site-load" above
(let ((lp load-path))
  (load "site-init" t)
  (or (equal lp load-path)
      (message "Warning: Change in load-path due to site-init will be \
lost after dumping")))

376
(setq current-load-list nil)
377 378
;; Avoid storing references to build directory in the binary.
(setq custom-current-group-alist nil)
379

380
;; We keep the load-history data in PURE space.
381 382 383 384
;; Make sure that the spine of the list is not in pure space because it can
;; be destructively mutated in lread.c:build_load_history.
(setq load-history (mapcar 'purecopy load-history))

385
(set-buffer-modified-p nil)
386

387
(remove-hook 'after-load-functions (lambda (f) (garbage-collect)))
388

389 390 391 392 393 394
(if (boundp 'load--prefer-newer)
    (progn
      (setq load-prefer-newer load--prefer-newer)
      (put 'load-prefer-newer 'standard-value load--prefer-newer)
      (makunbound 'load--prefer-newer)))

395
(setq inhibit-load-charset-map nil)
396
(clear-charset-maps)
Jim Blandy's avatar
Jim Blandy committed
397 398
(garbage-collect)

399
;; At this point, we're ready to resume undo recording for scratch.
Jim Blandy's avatar
Jim Blandy committed
400 401
(buffer-enable-undo "*scratch*")

402 403 404
(when (hash-table-p purify-flag)
  (let ((strings 0)
        (vectors 0)
405
        (bytecodes 0)
406 407 408 409 410 411 412
        (conses 0)
        (others 0))
    (maphash (lambda (k v)
               (cond
                ((stringp k) (setq strings (1+ strings)))
                ((vectorp k) (setq vectors (1+ vectors)))
                ((consp k)   (setq conses  (1+ conses)))
413
                ((byte-code-function-p v) (setq bytecodes (1+ bytecodes)))
414 415
                (t           (setq others  (1+ others)))))
             purify-flag)
416 417
    (message "Pure-hashed: %d strings, %d vectors, %d conses, %d bytecodes, %d others"
             strings vectors conses bytecodes others)))
418

Stefan Monnier's avatar
Stefan Monnier committed
419 420 421 422
;; Avoid error if user loads some more libraries now and make sure the
;; hash-consing hash table is GC'd.
(setq purify-flag nil)

423 424 425
(if (null (garbage-collect))
    (setq pure-space-overflow t))

426 427 428
;; Make sure we will attempt bidi reordering henceforth.
(setq redisplay--inhibit-bidi nil)

429
(if (member (car (last command-line-args)) '("dump" "bootstrap"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
430
    (progn
431
      (message "Dumping under the name emacs")
Jim Blandy's avatar
Jim Blandy committed
432
      (condition-case ()
433
	  (delete-file "emacs")
Jim Blandy's avatar
Jim Blandy committed
434
	(file-error nil))
435 436 437
      ;; We used to dump under the name xemacs, but that occasionally
      ;; confused people installing Emacs (they'd install the file
      ;; under the name `xemacs'), and it's inconsistent with every
Karl Heuer's avatar
Karl Heuer committed
438
      ;; other GNU program's build process.
439
      (dump-emacs "emacs" "temacs")
Richard M. Stallman's avatar
Richard M. Stallman committed
440
      (message "%d pure bytes used" pure-bytes-used)
Jim Blandy's avatar
Jim Blandy committed
441
      ;; Recompute NAME now, so that it isn't set when we dump.
442
      (if (not (or (eq system-type 'ms-dos)
443 444
                   ;; Don't bother adding another name if we're just
                   ;; building bootstrap-emacs.
445
                   (equal (last command-line-args) '("bootstrap"))))
446 447
	  (let ((name (concat "emacs-" emacs-version))
		(exe (if (eq system-type 'windows-nt) ".exe" "")))
448 449 450 451
	    (while (string-match "[^-+_.a-zA-Z0-9]+" name)
	      (setq name (concat (downcase (substring name 0 (match-beginning 0)))
				 "-"
				 (substring name (match-end 0)))))
452
	    (setq name (concat name exe))
453
            (message "Adding name %s" name)
454 455 456 457 458 459
	    ;; When this runs on Windows, invocation-directory is not
	    ;; necessarily the current directory.
	    (add-name-to-file (expand-file-name (concat "emacs" exe)
						invocation-directory)
			      (expand-file-name name invocation-directory)
			      t)))
Jim Blandy's avatar
Jim Blandy committed
460 461 462 463
      (kill-emacs)))

;; For machines with CANNOT_DUMP defined in config.h,
;; this file must be loaded each time Emacs is run.
464
;; So run the startup code now.  First, remove `-l loadup' from args.
Jim Blandy's avatar
Jim Blandy committed
465

466
(if (and (member (nth 1 command-line-args) '("-l" "--load"))
467 468 469 470
	 (equal (nth 2 command-line-args) "loadup"))
    (setcdr command-line-args (nthcdr 3 command-line-args)))

(eval top-level)
Eric S. Raymond's avatar
Eric S. Raymond committed
471

472

Stefan Monnier's avatar
Stefan Monnier committed
473 474 475 476
;; Local Variables:
;; no-byte-compile: t
;; no-update-autoloads: t
;; End:
Kenichi Handa's avatar
Kenichi Handa committed
477

Eric S. Raymond's avatar
Eric S. Raymond committed
478
;;; loadup.el ends here