lisp/loadup.el

   1 ;;; loadup.el --- load up standardly loaded Lisp files for Emacs
   2
   3 ;; Copyright (C) 1985-1986, 1992, 1994, 2001-2015 Free Software
   4 ;; Foundation, Inc.
   5
   6 ;; Maintainer: emacs-devel@gnu.org
   7 ;; Keywords: internal
   8 ;; Package: emacs
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; 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/>.
  24
  25 ;;; Commentary:
  26
  27 ;; This is loaded into a bare Emacs to make a dumpable one.
  28
  29 ;; If you add/remove Lisp files to be loaded here, consider the
  30 ;; following issues:
  31
  32 ;; i) Any file loaded on any platform should appear in $lisp in src/lisp.mk.
  33 ;; Use the .el or .elc version as appropriate.
  34
  35 ;; This ensures both that the Lisp files are compiled (if necessary)
  36 ;; before the emacs executable is dumped, and that they are passed to
  37 ;; make-docfile.  (Any that are not processed for DOC will not have
  38 ;; doc strings in the dumped Emacs.)  Because of this:
  39
  40 ;; ii) If the file is loaded uncompiled, it should (where possible)
  41 ;; obey the doc-string conventions expected by make-docfile.  It
  42 ;; should also be added to the uncompiled[] list in make-docfile.c.
  43
  44 ;;; Code:
  45
  46 ;; Add subdirectories to the load-path for files that might get
  47 ;; autoloaded when bootstrapping.
  48 ;; This is because PATH_DUMPLOADSEARCH is just "../lisp".
  49 (if (or (equal (member "bootstrap" command-line-args) '("bootstrap"))
  50         ;; FIXME this is irritatingly fragile.
  51         (equal (nth 4 command-line-args) "unidata-gen.el")
  52         (equal (nth 7 command-line-args) "unidata-gen-files")
  53         (if (fboundp 'dump-emacs)
  54             (string-match "src/bootstrap-emacs" (nth 0 command-line-args))
  55           t))
  56     (let ((dir (car load-path)))
  57       ;; We'll probably overflow the pure space.
  58       (setq purify-flag nil)
  59       (setq load-path (list (expand-file-name "." dir)
  60                             (expand-file-name "emacs-lisp" dir)
  61                             (expand-file-name "language" dir)
  62                             (expand-file-name "international" dir)
  63                             (expand-file-name "textmodes" dir)
  64                             (expand-file-name "vc" dir)))))
  65
  66 (if (eq t purify-flag)
  67     ;; Hash consing saved around 11% of pure space in my tests.
  68     (setq purify-flag (make-hash-table :test 'equal :size 70000)))
  69
  70 (message "Using load-path %s" load-path)
  71
  72 ;; This is a poor man's `last', since we haven't loaded subr.el yet.
  73 (if (or (equal (member "bootstrap" command-line-args) '("bootstrap"))
  74         (equal (member "dump" command-line-args) '("dump")))
  75     (progn
  76       ;; To reduce the size of dumped Emacs, we avoid making huge char-tables.
  77       (setq inhibit-load-charset-map t)
  78       ;; --eval gets handled too late.
  79       (defvar load--prefer-newer load-prefer-newer)
  80       (setq load-prefer-newer t)))
  81
  82 ;; We don't want to have any undo records in the dumped Emacs.
  83 (set-buffer "*scratch*")
  84 (setq buffer-undo-list t)
  85
  86 (load "emacs-lisp/byte-run")
  87 (load "emacs-lisp/backquote")
  88 (load "subr")
  89
  90 ;; Do it after subr, since both after-load-functions and add-hook are
  91 ;; implemented in subr.el.
  92 (add-hook 'after-load-functions (lambda (f) (garbage-collect)))
  93
  94 (load "version")
  95
  96 (load "widget")
  97 (load "custom")
  98 (load "emacs-lisp/map-ynp")
  99 (load "international/mule")
 100 (load "international/mule-conf")
 101 (load "env")
 102 (load "format")
 103 (load "bindings")
 104 ;; This sets temporary-file-directory, used by eg
 105 ;; auto-save-file-name-transforms in files.el.
 106 (load "cus-start")
 107 (load "window")  ; Needed here for `replace-buffer-in-windows'.
 108 (setq load-source-file-function 'load-with-code-conversion)
 109 (load "files")
 110
 111 ;; Load-time macro-expansion can only take effect after setting
 112 ;; load-source-file-function because of where it is called in lread.c.
 113 (load "emacs-lisp/macroexp")
 114 (if (byte-code-function-p (symbol-function 'macroexpand-all))
 115     nil
 116   ;; Since loaddefs is not yet loaded, macroexp's uses of pcase will simply
 117   ;; fail until pcase is explicitly loaded.  This also means that we have to
 118   ;; disable eager macro-expansion while loading pcase.
 119   (let ((macroexp--pending-eager-loads '(skip)))
 120     (load "emacs-lisp/pcase"))
 121   ;; Re-load macroexp so as to eagerly macro-expand its uses of pcase.
 122   (let ((max-lisp-eval-depth (* 2 max-lisp-eval-depth)))
 123     (load "emacs-lisp/macroexp")))
 124
 125 (load "cus-face")
 126 (load "faces")  ; after here, `defface' may be used.
 127
 128 (load "button")
 129
 130 ;; We don't want to store loaddefs.el in the repository because it is
 131 ;; a generated file; but it is required in order to compile the lisp files.
 132 ;; When bootstrapping, we cannot generate loaddefs.el until an
 133 ;; emacs binary has been built.  We therefore compromise and keep
 134 ;; ldefs-boot.el in the repository.  This does not need to be updated
 135 ;; as often as the real loaddefs.el would.  Bootstrap should always
 136 ;; work with ldefs-boot.el.  Therefore, Whenever a new autoload cookie
 137 ;; gets added that is necessary during bootstrapping, ldefs-boot.el
 138 ;; should be updated by overwriting it with an up-to-date copy of
 139 ;; loaddefs.el that is uncorrupted by local changes.
 140 ;; autogen/update_autogen can be used to periodically update ldefs-boot.
 141 (condition-case nil
 142     ;; Don't get confused if someone compiled this by mistake.
 143     (load "loaddefs.el")
 144   ;; In case loaddefs hasn't been generated yet.
 145   (file-error (load "ldefs-boot.el")))
 146
 147 (load "emacs-lisp/nadvice")
 148 (load "emacs-lisp/cl-preloaded")
 149 (load "minibuffer")            ;After loaddefs, for define-minor-mode.
 150 (load "abbrev")         ;lisp-mode.el and simple.el use define-abbrev-table.
 151 (load "simple")
 152
 153 (load "help")
 154
 155 (load "jka-cmpr-hook")
 156 (load "epa-hook")
 157 ;; Any Emacs Lisp source file (*.el) loaded here after can contain
 158 ;; multilingual text.
 159 (load "international/mule-cmds")
 160 (load "case-table")
 161 ;; This file doesn't exist when building a development version of Emacs
 162 ;; from the repository.  It is generated just after temacs is built.
 163 (load "international/charprop.el" t)
 164 (load "international/characters")
 165 (load "composite")
 166
 167 ;; Load language-specific files.
 168 (load "language/chinese")
 169 (load "language/cyrillic")
 170 (load "language/indian")
 171 (load "language/sinhala")
 172 (load "language/english")
 173 (load "language/ethiopic")
 174 (load "language/european")
 175 (load "language/czech")
 176 (load "language/slovak")
 177 (load "language/romanian")
 178 (load "language/greek")
 179 (load "language/hebrew")
 180 (load "language/japanese")
 181 (load "language/korean")
 182 (load "language/lao")
 183 (load "language/tai-viet")
 184 (load "language/thai")
 185 (load "language/tibetan")
 186 (load "language/vietnamese")
 187 (load "language/misc-lang")
 188 (load "language/utf-8-lang")
 189 (load "language/georgian")
 190 (load "language/khmer")
 191 (load "language/burmese")
 192 (load "language/cham")
 193
 194 (load "indent")
 195 (load "frame")
 196 (load "startup")
 197 (load "term/tty-colors")
 198 (load "font-core")
 199 ;; facemenu must be loaded before font-lock, because `facemenu-keymap'
 200 ;; needs to be defined when font-lock is loaded.
 201 (load "facemenu")
 202 (load "emacs-lisp/syntax")
 203 (load "font-lock")
 204 (load "jit-lock")
 205
 206 (load "mouse")
 207 (if (boundp 'x-toolkit-scroll-bars)
 208     (load "scroll-bar"))
 209 (load "select")
 210 (load "emacs-lisp/timer")
 211 (load "isearch")
 212 (load "rfn-eshadow")
 213
 214 (load "menu-bar")
 215 (load "emacs-lisp/lisp")
 216 (load "textmodes/page")
 217 (load "register")
 218 (load "textmodes/paragraphs")
 219 (load "progmodes/prog-mode")
 220 (load "emacs-lisp/lisp-mode")
 221 (load "progmodes/elisp-mode")
 222 (load "textmodes/text-mode")
 223 (load "textmodes/fill")
 224 (load "newcomment")
 225
 226 (load "replace")
 227 (load "emacs-lisp/tabulated-list")
 228 (load "buff-menu")
 229
 230 (if (fboundp 'x-create-frame)
 231     (progn
 232       (load "fringe")
 233       ;; Needed by `imagemagick-register-types'
 234       (load "emacs-lisp/regexp-opt")
 235       (load "image")
 236       (load "international/fontset")
 237       (load "dnd")
 238       (load "tool-bar")))
 239
 240 (if (featurep 'dynamic-setting)
 241     (load "dynamic-setting"))
 242
 243 (if (featurep 'x)
 244     (progn
 245       (load "x-dnd")
 246       (load "term/common-win")
 247       (load "term/x-win")))
 248
 249 (if (or (eq system-type 'windows-nt)
 250         (featurep 'w32))
 251     (progn
 252       (load "term/common-win")
 253       (load "w32-vars")
 254       (load "term/w32-win")
 255       (load "disp-table")
 256       (when (eq system-type 'windows-nt)
 257         (load "w32-fns")
 258         (load "ls-lisp")
 259         (load "dos-w32"))))
 260 (if (eq system-type 'ms-dos)
 261     (progn
 262       (load "dos-w32")
 263       (load "dos-fns")
 264       (load "dos-vars")
 265       ;; Don't load term/common-win: it isn't appropriate for the `pc'
 266       ;; ``window system'', which generally behaves like a terminal.
 267       (load "term/internal")
 268       (load "term/pc-win")
 269       (load "ls-lisp")
 270       (load "disp-table"))) ; needed to setup ibm-pc char set, see internal.el
 271 (if (featurep 'ns)
 272     (progn
 273       (load "term/common-win")
 274       (load "term/ns-win")))
 275 (if (fboundp 'x-create-frame)
 276     ;; Do it after loading term/foo-win.el since the value of the
 277     ;; mouse-wheel-*-event vars depends on those files being loaded or not.
 278     (load "mwheel"))
 279 ;; Preload some constants and floating point functions.
 280 (load "emacs-lisp/float-sup")
 281
 282 (load "vc/vc-hooks")
 283 (load "vc/ediff-hook")
 284 (load "uniquify")
 285 (load "electric")
 286 (load "emacs-lisp/eldoc")
 287 (if (not (eq system-type 'ms-dos)) (load "tooltip"))
 288
 289 ;; This file doesn't exist when building a development version of Emacs
 290 ;; from the repository.  It is generated just after temacs is built.
 291 (load "leim/leim-list.el" t)
 292
 293 ;; If you want additional libraries to be preloaded and their
 294 ;; doc strings kept in the DOC file rather than in core,
 295 ;; you may load them with a "site-load.el" file.
 296 ;; But you must also cause them to be scanned when the DOC file
 297 ;; is generated.
 298 (let ((lp load-path))
 299   (load "site-load" t)
 300   ;; We reset load-path after dumping.
 301   ;; For a permanent change in load-path, use configure's
 302   ;; --enable-locallisppath option.
 303   ;; See http://debbugs.gnu.org/16107 for more details.
 304   (or (equal lp load-path)
 305       (message "Warning: Change in load-path due to site-load will be \
 306 lost after dumping")))
 307
 308 ;; Make sure default-directory is unibyte when dumping.  This is
 309 ;; because we cannot decode and encode it correctly (since the locale
 310 ;; environment is not, and should not be, set up).  default-directory
 311 ;; is used every time we call expand-file-name, which we do in every
 312 ;; file primitive.  So the only workable solution to support building
 313 ;; in non-ASCII directories is to manipulate unibyte strings in the
 314 ;; current locale's encoding.
 315 (if (and (member (car (last command-line-args)) '("dump" "bootstrap"))
 316          (multibyte-string-p default-directory))
 317     (error "default-directory must be unibyte when dumping Emacs!"))
 318
 319 ;; Determine which last version number to use
 320 ;; based on the executables that now exist.
 321 (if (and (equal (last command-line-args) '("dump"))
 322          (not (eq system-type 'ms-dos)))
 323     (let* ((base (concat "emacs-" emacs-version "."))
 324            (exelen (if (eq system-type 'windows-nt) -4))
 325            (files (file-name-all-completions base default-directory))
 326            (versions (mapcar (function
 327                               (lambda (name)
 328                                 (string-to-number
 329                                  (substring name (length base) exelen))))
 330                              files)))
 331       (setq emacs-repository-version (condition-case nil (emacs-repository-get-version)
 332                               (error nil)))
 333       ;; `emacs-version' is a constant, so we shouldn't change it with `setq'.
 334       (defconst emacs-version
 335         (format "%s.%d"
 336                 emacs-version (if versions (1+ (apply 'max versions)) 1)))))
 337
 338
 339 (message "Finding pointers to doc strings...")
 340 (if (equal (last command-line-args) '("dump"))
 341     (Snarf-documentation "DOC")
 342   (condition-case nil
 343       (Snarf-documentation "DOC")
 344     (error nil)))
 345 (message "Finding pointers to doc strings...done")
 346
 347 ;; Note: You can cause additional libraries to be preloaded
 348 ;; by writing a site-init.el that loads them.
 349 ;; See also "site-load" above
 350 (let ((lp load-path))
 351   (load "site-init" t)
 352   (or (equal lp load-path)
 353       (message "Warning: Change in load-path due to site-init will be \
 354 lost after dumping")))
 355
 356 (setq current-load-list nil)
 357
 358 ;; We keep the load-history data in PURE space.
 359 ;; Make sure that the spine of the list is not in pure space because it can
 360 ;; be destructively mutated in lread.c:build_load_history.
 361 (setq load-history (mapcar 'purecopy load-history))
 362
 363 (set-buffer-modified-p nil)
 364
 365 (remove-hook 'after-load-functions (lambda (f) (garbage-collect)))
 366
 367 (if (boundp 'load--prefer-newer)
 368     (progn
 369       (setq load-prefer-newer load--prefer-newer)
 370       (put 'load-prefer-newer 'standard-value load--prefer-newer)
 371       (makunbound 'load--prefer-newer)))
 372
 373 (setq inhibit-load-charset-map nil)
 374 (clear-charset-maps)
 375 (garbage-collect)
 376
 377 ;; At this point, we're ready to resume undo recording for scratch.
 378 (buffer-enable-undo "*scratch*")
 379
 380 (when (hash-table-p purify-flag)
 381   (let ((strings 0)
 382         (vectors 0)
 383         (bytecodes 0)
 384         (conses 0)
 385         (others 0))
 386     (maphash (lambda (k v)
 387                (cond
 388                 ((stringp k) (setq strings (1+ strings)))
 389                 ((vectorp k) (setq vectors (1+ vectors)))
 390                 ((consp k)   (setq conses  (1+ conses)))
 391                 ((byte-code-function-p v) (setq bytecodes (1+ bytecodes)))
 392                 (t           (setq others  (1+ others)))))
 393              purify-flag)
 394     (message "Pure-hashed: %d strings, %d vectors, %d conses, %d bytecodes, %d others"
 395              strings vectors conses bytecodes others)))
 396
 397 ;; Avoid error if user loads some more libraries now and make sure the
 398 ;; hash-consing hash table is GC'd.
 399 (setq purify-flag nil)
 400
 401 (if (null (garbage-collect))
 402     (setq pure-space-overflow t))
 403
 404 (if (member (car (last command-line-args)) '("dump" "bootstrap"))
 405     (progn
 406       (message "Dumping under the name emacs")
 407       (condition-case ()
 408           (delete-file "emacs")
 409         (file-error nil))
 410       ;; We used to dump under the name xemacs, but that occasionally
 411       ;; confused people installing Emacs (they'd install the file
 412       ;; under the name `xemacs'), and it's inconsistent with every
 413       ;; other GNU program's build process.
 414       (dump-emacs "emacs" "temacs")
 415       (message "%d pure bytes used" pure-bytes-used)
 416       ;; Recompute NAME now, so that it isn't set when we dump.
 417       (if (not (or (eq system-type 'ms-dos)
 418                    ;; Don't bother adding another name if we're just
 419                    ;; building bootstrap-emacs.
 420                    (equal (last command-line-args) '("bootstrap"))))
 421           (let ((name (concat "emacs-" emacs-version))
 422                 (exe (if (eq system-type 'windows-nt) ".exe" "")))
 423             (while (string-match "[^-+_.a-zA-Z0-9]+" name)
 424               (setq name (concat (downcase (substring name 0 (match-beginning 0)))
 425                                  "-"
 426                                  (substring name (match-end 0)))))
 427             (setq name (concat name exe))
 428             (message "Adding name %s" name)
 429             ;; When this runs on Windows, invocation-directory is not
 430             ;; necessarily the current directory.
 431             (add-name-to-file (expand-file-name (concat "emacs" exe)
 432                                                 invocation-directory)
 433                               (expand-file-name name invocation-directory)
 434                               t)))
 435       (kill-emacs)))
 436
 437 ;; For machines with CANNOT_DUMP defined in config.h,
 438 ;; this file must be loaded each time Emacs is run.
 439 ;; So run the startup code now.  First, remove `-l loadup' from args.
 440
 441 (if (and (member (nth 1 command-line-args) '("-l" "--load"))
 442          (equal (nth 2 command-line-args) "loadup"))
 443     (setcdr command-line-args (nthcdr 3 command-line-args)))
 444
 445 (eval top-level)
 446
 447 \f
 448 ;; Local Variables:
 449 ;; no-byte-compile: t
 450 ;; no-update-autoloads: t
 451 ;; End:
 452
 453 ;;; loadup.el ends here