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