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-2017 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
	;; 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 79 80
			    (expand-file-name "emacs-lisp" dir)
			    (expand-file-name "language" dir)
			    (expand-file-name "international" dir)
81 82
			    (expand-file-name "textmodes" dir)
			    (expand-file-name "vc" dir)))))
83

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

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

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

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

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

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

113
(load "version")
114

115 116
(load "widget")
(load "custom")
117
(load "emacs-lisp/map-ynp")
118
(load "international/mule")
119
(load "international/mule-conf")
120
(load "env")
121
(load "format")
122
(load "bindings")
123
(load "window")  ; Needed here for `replace-buffer-in-windows'.
124 125 126 127
;; 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)
128
(setq load-source-file-function 'load-with-code-conversion)
Jim Blandy's avatar
Jim Blandy committed
129
(load "files")
130

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

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

147 148
(load "button")

149
;; We don't want to store loaddefs.el in the repository because it is
150 151 152 153 154
;; 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
155
;; work with ldefs-boot.el.  Therefore, whenever a new autoload cookie
156 157
;; 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
158 159
;; loaddefs.el that is not corrupted by local changes.
;; admin/update_autogen can be used to update ldefs-boot.el periodically.
160
(condition-case nil (load "loaddefs.el")
161
  ;; In case loaddefs hasn't been generated yet.
162
  (file-error (load "ldefs-boot.el")))
163

164 165 166 167 168 169
(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))

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

177
(load "help")
178

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

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

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

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

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

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

258 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
(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
286
        (load "ls-lisp")
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
        (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.
      (when (load-history-filename-element "charprop\\.el")
        (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"))
313 314
;; Preload some constants and floating point functions.
(load "emacs-lisp/float-sup")
315

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

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

;; 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.
334 335 336 337 338 339 340 341 342
(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
343

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

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

Jim Blandy's avatar
Jim Blandy committed
375 376

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

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

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

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

403
(set-buffer-modified-p nil)
404

405
(remove-hook 'after-load-functions (lambda (f) (garbage-collect)))
406

407 408 409 410 411 412
(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)))

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

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

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

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

441 442 443
(if (null (garbage-collect))
    (setq pure-space-overflow t))

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

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

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

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

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

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