lisp/loadup.el

   1 ;;; loadup.el --- load up standardly loaded Lisp files for Emacs
   2
   3 ;; Copyright (C) 1985-1986, 1992, 1994, 2001-2014 Free Software
   4 ;; 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 (if (or (equal (nth 3 command-line-args) "bootstrap")
  50         (equal (nth 4 command-line-args) "bootstrap")
  51         ;; FIXME this is irritatingly fragile.
  52         (equal (nth 4 command-line-args) "unidata-gen.el")
  53         (equal (nth 7 command-line-args) "unidata-gen-files")
  54         (if (fboundp 'dump-emacs)
  55             (string-match "src/bootstrap-emacs" (nth 0 command-line-args))
  56           t))
  57     (let ((dir (car load-path)))
  58       ;; We'll probably overflow the pure space.
  59       (setq purify-flag nil)
  60       (setq load-path (list (expand-file-name "." dir)
  61                             (expand-file-name "emacs-lisp" dir)
  62                             (expand-file-name "language" dir)
  63                             (expand-file-name "international" dir)
  64                             (expand-file-name "textmodes" dir)
  65                             (expand-file-name "vc" dir)))))
  66
  67 (if (eq t purify-flag)
  68     ;; Hash consing saved around 11% of pure space in my tests.
  69     (setq purify-flag (make-hash-table :test 'equal :size 70000)))
  70
  71 (message "Using load-path %s" load-path)
  72
  73 (if (or (member (nth 3 command-line-args) '("dump" "bootstrap"))
  74         (member (nth 4 command-line-args) '("dump" "bootstrap")))
  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 (if (fboundp 'track-mouse)
 202     (progn
 203       (load "mouse")
 204       (and (boundp 'x-toolkit-scroll-bars)
 205            (load "scroll-bar"))
 206       (load "select")))
 207 (load "emacs-lisp/timer")
 208 (load "isearch")
 209 (load "rfn-eshadow")
 210
 211 (load "menu-bar")
 212 (load "emacs-lisp/lisp")
 213 (load "textmodes/page")
 214 (load "register")
 215 (load "textmodes/paragraphs")
 216 (load "progmodes/prog-mode")
 217 (load "emacs-lisp/lisp-mode")
 218 (load "textmodes/text-mode")
 219 (load "textmodes/fill")
 220 (load "newcomment")
 221
 222 (load "replace")
 223 (load "emacs-lisp/tabulated-list")
 224 (load "buff-menu")
 225
 226 (if (fboundp 'x-create-frame)
 227     (progn
 228       (load "fringe")
 229       ;; Needed by `imagemagick-register-types'
 230       (load "emacs-lisp/regexp-opt")
 231       (load "image")
 232       (load "international/fontset")
 233       (load "dnd")
 234       (load "tool-bar")))
 235
 236 (if (featurep 'dynamic-setting)
 237     (load "dynamic-setting"))
 238
 239 (if (featurep 'x)
 240     (progn
 241       (load "x-dnd")
 242       (load "term/common-win")
 243       (load "term/x-win")))
 244
 245 (if (or (eq system-type 'windows-nt)
 246         (featurep 'w32))
 247     (progn
 248       (load "term/common-win")
 249       (load "w32-vars")
 250       (load "term/w32-win")
 251       (load "disp-table")
 252       (load "w32-common-fns")
 253       (when (eq system-type 'windows-nt)
 254         (load "w32-fns")
 255         (load "ls-lisp")
 256         (load "dos-w32"))))
 257 (if (eq system-type 'ms-dos)
 258     (progn
 259       (load "dos-w32")
 260       (load "dos-fns")
 261       (load "dos-vars")
 262       ;; Don't load term/common-win: it isn't appropriate for the `pc'
 263       ;; ``window system'', which generally behaves like a terminal.
 264       (load "term/internal")
 265       (load "term/pc-win")
 266       (load "ls-lisp")
 267       (load "disp-table"))) ; needed to setup ibm-pc char set, see internal.el
 268 (if (featurep 'ns)
 269     (progn
 270       (load "term/common-win")
 271       (load "term/ns-win")))
 272 (if (fboundp 'x-create-frame)
 273     ;; Do it after loading term/foo-win.el since the value of the
 274     ;; mouse-wheel-*-event vars depends on those files being loaded or not.
 275     (load "mwheel"))
 276 ;; Preload some constants and floating point functions.
 277 (load "emacs-lisp/float-sup")
 278
 279 (load "vc/vc-hooks")
 280 (load "vc/ediff-hook")
 281 (load "uniquify")
 282 (load "electric")
 283 (if (not (eq system-type 'ms-dos)) (load "tooltip"))
 284
 285 ;; This file doesn't exist when building a development version of Emacs
 286 ;; from the repository.  It is generated just after temacs is built.
 287 (load "leim/leim-list.el" t)
 288
 289 ;; If you want additional libraries to be preloaded and their
 290 ;; doc strings kept in the DOC file rather than in core,
 291 ;; you may load them with a "site-load.el" file.
 292 ;; But you must also cause them to be scanned when the DOC file
 293 ;; is generated.
 294 (let ((lp load-path))
 295   (load "site-load" t)
 296   ;; We reset load-path after dumping.
 297   ;; For a permanent change in load-path, use configure's
 298   ;; --enable-locallisppath option.
 299   ;; See http://debbugs.gnu.org/16107 for more details.
 300   (or (equal lp load-path)
 301       (message "Warning: Change in load-path due to site-load will be \
 302 lost after dumping")))
 303
 304 ;; Make sure default-directory is unibyte when dumping.  This is
 305 ;; because we cannot decode and encode it correctly (since the locale
 306 ;; environment is not, and should not be, set up).  default-directory
 307 ;; is used every time we call expand-file-name, which we do in every
 308 ;; file primitive.  So the only workable solution to support building
 309 ;; in non-ASCII directories is to manipulate unibyte strings in the
 310 ;; current locale's encoding.
 311 (if (and (or (equal (nth 3 command-line-args) "dump")
 312              (equal (nth 4 command-line-args) "dump")
 313              (equal (nth 3 command-line-args) "bootstrap")
 314              (equal (nth 4 command-line-args) "bootstrap"))
 315          (multibyte-string-p default-directory))
 316     (error "default-directory must be unibyte when dumping Emacs!"))
 317
 318 ;; Determine which last version number to use
 319 ;; based on the executables that now exist.
 320 (if (and (or (equal (nth 3 command-line-args) "dump")
 321              (equal (nth 4 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-bzr-version (condition-case nil (emacs-bzr-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 (or (equal (nth 3 command-line-args) "dump")
 341         (equal (nth 4 command-line-args) "dump"))
 342     (Snarf-documentation "DOC")
 343   (condition-case nil
 344       (Snarf-documentation "DOC")
 345     (error nil)))
 346 (message "Finding pointers to doc strings...done")
 347
 348 ;; Note: You can cause additional libraries to be preloaded
 349 ;; by writing a site-init.el that loads them.
 350 ;; See also "site-load" above
 351 (let ((lp load-path))
 352   (load "site-init" t)
 353   (or (equal lp load-path)
 354       (message "Warning: Change in load-path due to site-init will be \
 355 lost after dumping")))
 356
 357 (setq current-load-list nil)
 358
 359 ;; We keep the load-history data in PURE space.
 360 ;; Make sure that the spine of the list is not in pure space because it can
 361 ;; be destructively mutated in lread.c:build_load_history.
 362 (setq load-history (mapcar 'purecopy load-history))
 363
 364 (set-buffer-modified-p nil)
 365
 366 (remove-hook 'after-load-functions (lambda (f) (garbage-collect)))
 367
 368 (setq inhibit-load-charset-map nil)
 369 (clear-charset-maps)
 370 (garbage-collect)
 371
 372 ;; At this point, we're ready to resume undo recording for scratch.
 373 (buffer-enable-undo "*scratch*")
 374
 375 (when (hash-table-p purify-flag)
 376   (let ((strings 0)
 377         (vectors 0)
 378         (bytecodes 0)
 379         (conses 0)
 380         (others 0))
 381     (maphash (lambda (k v)
 382                (cond
 383                 ((stringp k) (setq strings (1+ strings)))
 384                 ((vectorp k) (setq vectors (1+ vectors)))
 385                 ((consp k)   (setq conses  (1+ conses)))
 386                 ((byte-code-function-p v) (setq bytecodes (1+ bytecodes)))
 387                 (t           (setq others  (1+ others)))))
 388              purify-flag)
 389     (message "Pure-hashed: %d strings, %d vectors, %d conses, %d bytecodes, %d others"
 390              strings vectors conses bytecodes others)))
 391
 392 ;; Avoid error if user loads some more libraries now and make sure the
 393 ;; hash-consing hash table is GC'd.
 394 (setq purify-flag nil)
 395
 396 (if (null (garbage-collect))
 397     (setq pure-space-overflow t))
 398
 399 (if (or (member (nth 3 command-line-args) '("dump" "bootstrap"))
 400         (member (nth 4 command-line-args) '("dump" "bootstrap")))
 401     (progn
 402       (message "Dumping under the name emacs")
 403       (condition-case ()
 404           (delete-file "emacs")
 405         (file-error nil))
 406       ;; We used to dump under the name xemacs, but that occasionally
 407       ;; confused people installing Emacs (they'd install the file
 408       ;; under the name `xemacs'), and it's inconsistent with every
 409       ;; other GNU program's build process.
 410       (dump-emacs "emacs" "temacs")
 411       (message "%d pure bytes used" pure-bytes-used)
 412       ;; Recompute NAME now, so that it isn't set when we dump.
 413       (if (not (or (eq system-type 'ms-dos)
 414                    ;; Don't bother adding another name if we're just
 415                    ;; building bootstrap-emacs.
 416                    (equal (nth 3 command-line-args) "bootstrap")
 417                    (equal (nth 4 command-line-args) "bootstrap")))
 418           (let ((name (concat "emacs-" emacs-version))
 419                 (exe (if (eq system-type 'windows-nt) ".exe" "")))
 420             (while (string-match "[^-+_.a-zA-Z0-9]+" name)
 421               (setq name (concat (downcase (substring name 0 (match-beginning 0)))
 422                                  "-"
 423                                  (substring name (match-end 0)))))
 424             (setq name (concat name exe))
 425             (message "Adding name %s" name)
 426             ;; When this runs on Windows, invocation-directory is not
 427             ;; necessarily the current directory.
 428             (add-name-to-file (expand-file-name (concat "emacs" exe)
 429                                                 invocation-directory)
 430                               (expand-file-name name invocation-directory)
 431                               t)))
 432       (kill-emacs)))
 433
 434 ;; For machines with CANNOT_DUMP defined in config.h,
 435 ;; this file must be loaded each time Emacs is run.
 436 ;; So run the startup code now.  First, remove `-l loadup' from args.
 437
 438 (if (and (equal (nth 1 command-line-args) "-l")
 439          (equal (nth 2 command-line-args) "loadup"))
 440     (setcdr command-line-args (nthcdr 3 command-line-args)))
 441
 442 (eval top-level)
 443
 444 \f
 445 ;; Local Variables:
 446 ;; no-byte-compile: t
 447 ;; no-update-autoloads: t
 448 ;; End:
 449
 450 ;;; loadup.el ends here