loadup.el 17.8 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-2019 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 <https://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
	;; FIXME this is irritatingly fragile.
62 63 64 65 66
	(and (stringp (nth 4 command-line-args))
	     (string-match "^unidata-gen\\(\\.elc?\\)?$"
			   (nth 4 command-line-args)))
	(member (nth 7 command-line-args) '("unidata-gen-file"
					    "unidata-gen-charprop"))
67 68 69
	(if (fboundp 'dump-emacs)
	    (string-match "src/bootstrap-emacs" (nth 0 command-line-args))
	  t))
70
    (let ((dir (car load-path)))
71 72
      ;; We'll probably overflow the pure space.
      (setq purify-flag nil)
73 74 75 76
      ;; Value of max-lisp-eval-depth when compiling initially.
      ;; During bootstrapping the byte-compiler is run interpreted when
      ;; compiling itself, which uses a lot more stack than usual.
      (setq max-lisp-eval-depth 2200)
77
      (setq load-path (list (expand-file-name "." dir)
78
			    (expand-file-name "emacs-lisp" dir)
79
			    (expand-file-name "progmodes" dir)
80 81
			    (expand-file-name "language" dir)
			    (expand-file-name "international" dir)
82 83
			    (expand-file-name "textmodes" dir)
			    (expand-file-name "vc" dir)))))
84

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

89 90
(message "Using load-path %s" load-path)

91
;; This is a poor man's `last', since we haven't loaded subr.el yet.
92 93 94
(if (and (fboundp 'dump-emacs)
         (or (equal (member "bootstrap" command-line-args) '("bootstrap"))
             (equal (member "dump" command-line-args) '("dump"))))
95 96 97 98 99 100
    (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)))
101

102
;; We don't want to have any undo records in the dumped Emacs.
103 104
(set-buffer "*scratch*")
(setq buffer-undo-list t)
Jim Blandy's avatar
Jim Blandy committed
105

106
(load "emacs-lisp/byte-run")
107
(load "emacs-lisp/backquote")
Jim Blandy's avatar
Jim Blandy committed
108
(load "subr")
109

110 111
;; Do it after subr, since both after-load-functions and add-hook are
;; implemented in subr.el.
112
(add-hook 'after-load-functions (lambda (f) (garbage-collect)))
113

114
(load "version")
115

116 117
(load "widget")
(load "custom")
118
(load "emacs-lisp/map-ynp")
119
(load "international/mule")
120
(load "international/mule-conf")
121
(load "env")
122
(load "format")
123
(load "bindings")
124
(load "window")  ; Needed here for `replace-buffer-in-windows'.
125 126 127 128
;; We are now capable of resizing the mini-windows, so give the
;; variable its advertised default value (it starts as nil, see
;; xdisp.c).
(setq resize-mini-windows 'grow-only)
129
(setq load-source-file-function 'load-with-code-conversion)
Jim Blandy's avatar
Jim Blandy committed
130
(load "files")
131

132 133 134 135 136 137 138 139
;; 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.
140
  (let ((macroexp--pending-eager-loads '(skip))) (load "emacs-lisp/pcase"))
141
  ;; Re-load macroexp so as to eagerly macro-expand its uses of pcase.
142 143
  (let ((max-lisp-eval-depth (* 2 max-lisp-eval-depth)))
    (load "emacs-lisp/macroexp")))
144

145
(load "cus-face")
146 147
(load "faces")  ; after here, `defface' may be used.

148 149
(load "button")

150
;; We don't want to store loaddefs.el in the repository because it is
151 152 153 154 155
;; 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
Paul Eggert's avatar
Paul Eggert committed
156
;; work with ldefs-boot.el.  Therefore, whenever a new autoload cookie
157 158
;; gets added that is necessary during bootstrapping, ldefs-boot.el
;; should be updated by overwriting it with an up-to-date copy of
Paul Eggert's avatar
Paul Eggert committed
159 160
;; loaddefs.el that is not corrupted by local changes.
;; admin/update_autogen can be used to update ldefs-boot.el periodically.
161
(condition-case nil (load "loaddefs.el")
162
  ;; In case loaddefs hasn't been generated yet.
163
  (file-error (load "ldefs-boot.el")))
164

165 166 167 168 169 170
(let ((new (make-hash-table :test 'equal)))
  ;; Now that loaddefs has populated definition-prefixes, purify its contents.
  (maphash (lambda (k v) (puthash (purecopy k) (purecopy v) new))
           definition-prefixes)
  (setq definition-prefixes new))

171
(load "emacs-lisp/nadvice")
172 173
(load "emacs-lisp/cl-preloaded")
(load "minibuffer")            ;After loaddefs, for define-minor-mode.
174
(load "obarray")        ;abbrev.el is implemented in terms of obarrays.
175
(load "abbrev")         ;lisp-mode.el and simple.el use define-abbrev-table.
176
(load "simple")
177

178
(load "help")
179

180
(load "jka-cmpr-hook")
181
(load "epa-hook")
182 183 184 185
;; 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
186 187
;; This file doesn't exist when building a development version of Emacs
;; from the repository.  It is generated just after temacs is built.
188 189
(load "international/charprop.el" t)
(if (featurep 'charprop)
190
    (setq redisplay--inhibit-bidi nil))
191 192
(load "international/characters")
(load "composite")
193

194
;; Load language-specific files.
Karl Heuer's avatar
Karl Heuer committed
195 196 197
(load "language/chinese")
(load "language/cyrillic")
(load "language/indian")
198
(load "language/sinhala")
199
(load "language/english")
Karl Heuer's avatar
Karl Heuer committed
200 201
(load "language/ethiopic")
(load "language/european")
202 203
(load "language/czech")
(load "language/slovak")
Dan Nicolaescu's avatar
Dan Nicolaescu committed
204
(load "language/romanian")
Karl Heuer's avatar
Karl Heuer committed
205 206
(load "language/greek")
(load "language/hebrew")
207 208
(load "international/cp51932")
(load "international/eucjp-ms")
Karl Heuer's avatar
Karl Heuer committed
209 210
(load "language/japanese")
(load "language/korean")
Kenichi Handa's avatar
Kenichi Handa committed
211
(load "language/lao")
Kenichi Handa's avatar
Kenichi Handa committed
212
(load "language/tai-viet")
Karl Heuer's avatar
Karl Heuer committed
213
(load "language/thai")
214
(load "language/tibetan")
Karl Heuer's avatar
Karl Heuer committed
215 216
(load "language/vietnamese")
(load "language/misc-lang")
217 218
(load "language/utf-8-lang")
(load "language/georgian")
219
(load "language/khmer")
220
(load "language/burmese")
Kenichi Handa's avatar
Kenichi Handa committed
221
(load "language/cham")
222

Jim Blandy's avatar
Jim Blandy committed
223
(load "indent")
224
(load "emacs-lisp/cl-generic")
225
(load "frame")
Stefan Monnier's avatar
Stefan Monnier committed
226
(load "startup")
227
(load "term/tty-colors")
Colin Walters's avatar
Colin Walters committed
228
(load "font-core")
229 230
;; facemenu must be loaded before font-lock, because `facemenu-keymap'
;; needs to be defined when font-lock is loaded.
231
(load "facemenu")
232 233 234
(load "emacs-lisp/syntax")
(load "font-lock")
(load "jit-lock")
235

236
(load "mouse")
237 238
(if (boundp 'x-toolkit-scroll-bars)
    (load "scroll-bar"))
239
(load "select")
240
(load "emacs-lisp/timer")
241
(load "isearch")
Luc Teirlinck's avatar
Luc Teirlinck committed
242
(load "rfn-eshadow")
243

Richard M. Stallman's avatar
Richard M. Stallman committed
244
(load "menu-bar")
245 246
(load "emacs-lisp/lisp")
(load "textmodes/page")
Jim Blandy's avatar
Jim Blandy committed
247
(load "register")
248
(load "textmodes/paragraphs")
249
(load "progmodes/prog-mode")
250
(load "emacs-lisp/lisp-mode")
251
(load "progmodes/elisp-mode")
252 253
(load "textmodes/text-mode")
(load "textmodes/fill")
254
(load "newcomment")
255

Jim Blandy's avatar
Jim Blandy committed
256
(load "replace")
257
(load "emacs-lisp/tabulated-list")
Jim Blandy's avatar
Jim Blandy committed
258
(load "buff-menu")
259

260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
(if (fboundp 'x-create-frame)
    (progn
      (load "fringe")
      ;; Needed by `imagemagick-register-types'
      (load "emacs-lisp/regexp-opt")
      (load "image")
      (load "international/fontset")
      (load "dnd")
      (load "tool-bar")))

(if (featurep 'dynamic-setting)
    (load "dynamic-setting"))

(if (featurep 'x)
    (progn
      (load "x-dnd")
      (load "term/common-win")
      (load "term/x-win")))

(if (or (eq system-type 'windows-nt)
        (featurep 'w32))
    (progn
      (load "term/common-win")
      (load "w32-vars")
      (load "term/w32-win")
      (load "disp-table")
      (when (eq system-type 'windows-nt)
        (load "w32-fns")
Daniel Colascione's avatar
Daniel Colascione committed
288
        (load "ls-lisp")
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
        (load "dos-w32"))))
(if (eq system-type 'ms-dos)
    (progn
      (load "dos-w32")
      (load "dos-fns")
      (load "dos-vars")
      ;; Don't load term/common-win: it isn't appropriate for the `pc'
      ;; ``window system'', which generally behaves like a terminal.
      (load "term/internal")
      (load "term/pc-win")
      (load "ls-lisp")
      (load "disp-table"))) ; needed to setup ibm-pc char set, see internal.el
(if (featurep 'ns)
    (progn
      (load "term/common-win")
      ;; 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.
307
      (when (featurep 'charprop)
308 309 310 311 312 313 314
        (load "international/mule-util")
        (load "international/ucs-normalize")
        (load "term/ns-win"))))
(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"))
315 316
;; Preload some constants and floating point functions.
(load "emacs-lisp/float-sup")
317

318 319
(load "vc/vc-hooks")
(load "vc/ediff-hook")
320
(load "uniquify")
321
(load "electric")
322
(load "emacs-lisp/eldoc")
323
(load "cus-start") ;Late to reduce customize-rogue (needs loaddefs.el anyway)
324 325
(if (not (eq system-type 'ms-dos))
    (load "tooltip"))
326

Glenn Morris's avatar
Glenn Morris committed
327 328
;; This file doesn't exist when building a development version of Emacs
;; from the repository.  It is generated just after temacs is built.
329
(load "leim/leim-list.el" t)
Glenn Morris's avatar
Glenn Morris committed
330 331 332 333 334 335

;; 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.
336 337 338 339 340
(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.
341
  ;; See https://debbugs.gnu.org/16107 for more details.
342 343 344
  (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
345

346 347 348 349 350 351 352
;; 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.
353
(if (and (member (car (last command-line-args)) '("dump" "bootstrap"))
354
         (fboundp 'dump-emacs)
355 356 357
	 (multibyte-string-p default-directory))
    (error "default-directory must be unibyte when dumping Emacs!"))

358
;; Determine which build number to use
359
;; based on the executables that now exist.
360
(if (and (equal (last command-line-args) '("dump"))
361
         (fboundp 'dump-emacs)
362
	 (not (eq system-type 'ms-dos)))
363
    (let* ((base (concat "emacs-" emacs-version "."))
364
	   (exelen (if (eq system-type 'windows-nt) -4))
365
	   (files (file-name-all-completions base default-directory))
366 367 368 369
	   (versions (mapcar (function
			      (lambda (name)
				(string-to-number
				 (substring name (length base) exelen))))
370
			     files)))
371 372
      (setq emacs-repository-version (ignore-errors (emacs-repository-get-version))
            emacs-repository-branch (ignore-errors (emacs-repository-get-branch)))
373 374 375
      ;; A constant, so we shouldn't change it with `setq'.
      (defconst emacs-build-number
	(if versions (1+ (apply 'max versions)) 1))))
376

Jim Blandy's avatar
Jim Blandy committed
377 378

(message "Finding pointers to doc strings...")
379 380
(if (and (fboundp 'dump-emacs)
         (equal (last command-line-args) '("dump")))
381 382 383 384
    (Snarf-documentation "DOC")
  (condition-case nil
      (Snarf-documentation "DOC")
    (error nil)))
Jim Blandy's avatar
Jim Blandy committed
385 386
(message "Finding pointers to doc strings...done")

387 388
;; Note: You can cause additional libraries to be preloaded
;; by writing a site-init.el that loads them.
389 390 391 392 393 394 395
;; 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")))

396
(setq current-load-list nil)
397 398
;; Avoid storing references to build directory in the binary.
(setq custom-current-group-alist nil)
399

400
;; We keep the load-history data in PURE space.
401 402 403 404
;; 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))

405
(set-buffer-modified-p nil)
406

407
(remove-hook 'after-load-functions (lambda (f) (garbage-collect)))
408

409 410 411 412 413 414
(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)))

415
(setq inhibit-load-charset-map nil)
416
(clear-charset-maps)
Jim Blandy's avatar
Jim Blandy committed
417 418
(garbage-collect)

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

422 423 424
(when (hash-table-p purify-flag)
  (let ((strings 0)
        (vectors 0)
425
        (bytecodes 0)
426 427 428 429 430 431 432
        (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)))
433
                ((byte-code-function-p v) (setq bytecodes (1+ bytecodes)))
434 435
                (t           (setq others  (1+ others)))))
             purify-flag)
436 437
    (message "Pure-hashed: %d strings, %d vectors, %d conses, %d bytecodes, %d others"
             strings vectors conses bytecodes others)))
438

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

443 444 445
(if (null (garbage-collect))
    (setq pure-space-overflow t))

446 447 448
;; Make sure we will attempt bidi reordering henceforth.
(setq redisplay--inhibit-bidi nil)

449 450
(if (and (fboundp 'dump-emacs)
         (member (car (last command-line-args)) '("dump" "bootstrap")))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
451
    (progn
452 453 454 455 456
      ;; Prevent build-time PATH getting stored in the binary.
      ;; Mainly cosmetic, but helpful for Guix.  (Bug#20330)
      ;; Do this here, rather than earlier, so that the above code
      ;; can invoke Git commands and the like.
      (setq exec-path nil)
457
      (message "Dumping under the name emacs")
Jim Blandy's avatar
Jim Blandy committed
458
      (condition-case ()
459
	  (delete-file "emacs")
Jim Blandy's avatar
Jim Blandy committed
460
	(file-error nil))
461 462 463
      ;; 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
464
      ;; other GNU program's build process.
465
      (dump-emacs "emacs" "temacs")
Richard M. Stallman's avatar
Richard M. Stallman committed
466
      (message "%d pure bytes used" pure-bytes-used)
Jim Blandy's avatar
Jim Blandy committed
467
      ;; Recompute NAME now, so that it isn't set when we dump.
468
      (if (not (or (eq system-type 'ms-dos)
469 470
                   ;; Don't bother adding another name if we're just
                   ;; building bootstrap-emacs.
471
                   (equal (last command-line-args) '("bootstrap"))))
472
	  (let ((name (format "emacs-%s.%d" emacs-version emacs-build-number))
473
		(exe (if (eq system-type 'windows-nt) ".exe" "")))
474 475 476 477
	    (while (string-match "[^-+_.a-zA-Z0-9]+" name)
	      (setq name (concat (downcase (substring name 0 (match-beginning 0)))
				 "-"
				 (substring name (match-end 0)))))
478
	    (setq name (concat name exe))
479
            (message "Adding name %s" name)
480 481 482 483 484 485
	    ;; 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
486 487 488 489
      (kill-emacs)))

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

492
(if (and (member (nth 1 command-line-args) '("-l" "--load"))
493 494 495 496
	 (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
497

498

Stefan Monnier's avatar
Stefan Monnier committed
499 500 501 502
;; Local Variables:
;; no-byte-compile: t
;; no-update-autoloads: t
;; End:
Kenichi Handa's avatar
Kenichi Handa committed
503

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