lisp/loadup.el

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