lisp/loadup.el

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