f36d12c3ebe2fe918cf23eb9aaa5087a253326c2
[chise/xemacs-chise.git.1] / lisp / startup.el
1 ;;; startup.el --- process XEmacs shell arguments
2
3 ;; Copyright (C) 1985-1986, 1990, 1992-1997 Free Software Foundation, Inc.
4 ;; Copyright (c) 1993, 1994 Sun Microsystems, Inc.
5 ;; Copyright (C) 1995 Board of Trustees, University of Illinois
6
7 ;; Maintainer: XEmacs Development Team
8 ;; Keywords: internal, dumped
9
10 ;; This file is part of XEmacs.
11
12 ;; XEmacs is free software; you can redistribute it and/or modify it
13 ;; under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
16
17 ;; XEmacs is distributed in the hope that it will be useful, but
18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20 ;; General Public License for more details.
21
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with XEmacs; see the file COPYING.  If not, write to the 
24 ;; Free Software Foundation, 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
26
27 ;;; Synched up with: FSF 19.34.
28
29 ;;; Commentary:
30
31 ;; This file is dumped with XEmacs.
32
33 ;; -batch, -t, and -nw are processed by main() in emacs.c and are 
34 ;; never seen by lisp code.
35
36 ;; -version and -help are special-cased as well: they imply -batch,
37 ;; but are left on the list for lisp code to process.
38
39 ;;; Code:
40 \f
41 (setq top-level '(normal-top-level))
42
43 (defvar command-line-processed nil "t once command line has been processed")
44
45 (defconst startup-message-timeout 12000) ; More or less disable the timeout
46
47 (defconst inhibit-startup-message nil
48   "*Non-nil inhibits the initial startup message.
49 This is for use in your personal init file, once you are familiar
50 with the contents of the startup message.")
51
52 ;; #### FSFmacs randomness
53 ;;(defconst inhibit-startup-echo-area-message nil
54 ;;  "*Non-nil inhibits the initial startup echo area message.
55 ;;Inhibition takes effect only if your `.emacs' file contains
56 ;;a line of this form:
57 ;; (setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\")
58 ;;If your `.emacs' file is byte-compiled, use the following form instead:
59 ;; (eval '(setq inhibit-startup-echo-area-message \"YOUR-USER-NAME\"))
60 ;;Thus, someone else using a copy of your `.emacs' file will see
61 ;;the startup message unless he personally acts to inhibit it.")
62
63 (defconst inhibit-default-init nil
64   "*Non-nil inhibits loading the `default' library.")
65
66 (defvar command-line-args-left nil
67   "List of command-line args not yet processed.") ; bound by `command-line'
68
69 (defvar command-line-default-directory nil
70   "Default directory to use for command line arguments.
71 This is normally copied from `default-directory' when XEmacs starts.")
72
73 (defvar before-init-hook nil
74   "Functions to call after handling urgent options but before init files.
75 The frame system uses this to open frames to display messages while
76 XEmacs loads the user's initialization file.")
77
78 (defvar after-init-hook nil
79   "*Functions to call after loading the init file (`.emacs').
80 The call is not protected by a condition-case, so you can set `debug-on-error'
81 in `.emacs', and put all the actual code on `after-init-hook'.")
82
83 (defvar term-setup-hook nil
84   "*Functions to be called after loading terminal-specific Lisp code.
85 See `run-hooks'.  This variable exists for users to set, so as to
86 override the definitions made by the terminal-specific file.  XEmacs
87 never sets this variable itself.")
88
89 (defvar keyboard-type nil
90   "The brand of keyboard you are using.
91 This variable is used to define the proper function and keypad keys
92 for use under X.  It is used in a fashion analogous to the environment
93 value TERM.")
94
95 (defvar window-setup-hook nil
96   "Normal hook run to initialize window system display.
97 XEmacs runs this hook after processing the command line arguments and loading
98 the user's init file.")
99
100 (defconst initial-major-mode 'lisp-interaction-mode
101   "Major mode command symbol to use for the initial *scratch* buffer.")
102
103 (defvar emacs-roots nil
104   "List of plausible roots of the XEmacs hierarchy.")
105
106 (defvar init-file-user nil
107   "Identity of user whose `.emacs' file is or was read.
108 The value is nil if no init file is being used; otherwise, it may be either
109 the null string, meaning that the init file was taken from the user that
110 originally logged in, or it may be a string containing a user's name.
111
112 In either of the latter cases, `(concat \"~\" init-file-user \"/\")'
113 evaluates to the name of the directory in which the `.emacs' file was
114 searched for.
115
116 Setting `init-file-user' does not prevent Emacs from loading
117 `site-start.el'.  The only way to do that is to use `--no-site-file'.")
118
119 ;; #### called `site-run-file' in FSFmacs
120
121 (defvar site-start-file (purecopy "site-start")
122   "File containing site-wide run-time initializations.
123 This file is loaded at run-time before `.emacs'.  It
124 contains inits that need to be in place for the entire site, but
125 which, due to their higher incidence of change, don't make sense to
126 load into XEmacs' dumped image.  Thus, the run-time load order is:
127
128   1. file described in this variable, if non-nil;
129   2. `.emacs';
130   3. `/path/to/xemacs/lisp/default.el'.
131
132 Don't use the `site-start.el' file for things some users may not like.
133 Put them in `default.el' instead, so that users can more easily
134 override them.  Users can prevent loading `default.el' with the `-q'
135 option or by setting `inhibit-default-init' in their own init files,
136 but inhibiting `site-start.el' requires `--no-site-file', which
137 is less convenient.")
138
139 ;;(defconst iso-8859-1-locale-regexp "8859[-_]?1"
140 ;;  "Regexp that specifies when to enable the ISO 8859-1 character set.
141 ;;We do that if this regexp matches the locale name
142 ;;specified by the LC_ALL, LC_CTYPE and LANG environment variables.")
143
144 (defvar mail-host-address nil
145   "*Name of this machine, for purposes of naming users.")
146
147 (defvar user-mail-address nil
148   "*Full mailing address of this user.
149 This is initialized based on `mail-host-address',
150 after your init file is read, in case it sets `mail-host-address'.")
151
152 (defvar auto-save-list-file-prefix "~/.saves-"
153   "Prefix for generating auto-save-list-file-name.
154 Emacs's pid and the system name will be appended to
155 this prefix to create a unique file name.")
156
157 (defvar init-file-debug nil)
158
159 (defvar init-file-had-error nil)
160
161 (defvar init-file-loaded nil
162   "True after the user's init file has been loaded (or suppressed with -q).
163 This will be true when `after-init-hook' is run and at all times
164 after, and will not be true at any time before.")
165
166 (defvar initial-frame-unmapped-p nil)
167
168 \f
169
170 (defvar command-switch-alist
171   (purecopy
172    '(("-help"   . command-line-do-help)
173      ("-version". command-line-do-version)
174      ("-V"      . command-line-do-version)
175      ("-funcall". command-line-do-funcall)
176      ("-f"      . command-line-do-funcall)
177      ("-e"      . command-line-do-funcall-1)
178      ("-eval"   . command-line-do-eval)
179      ("-load"   . command-line-do-load)
180      ("-l"      . command-line-do-load)
181      ("-insert" . command-line-do-insert)
182      ("-i"      . command-line-do-insert)
183      ("-kill"   . command-line-do-kill)
184      ;; Options like +35 are handled specially.
185      ;; Window-system, site, or package-specific code might add to this.
186      ;; X11 handles its options by letting Xt remove args from this list.
187      ))
188   "Alist of command-line switches.
189 Elements look like (SWITCH-STRING . HANDLER-FUNCTION).
190 HANDLER-FUNCTION receives switch name as sole arg;
191 remaining command-line args are in the variable `command-line-args-left'.")
192
193 ;;; default switches
194 ;;; Note: these doc strings are semi-magical.
195
196 (defun command-line-do-help (arg)
197   "Print the XEmacs usage message and exit."
198   (let ((standard-output 'external-debugging-output))
199     (princ (concat "\n" (emacs-version) "\n\n"))
200     (princ
201      (if (featurep 'x)
202          (concat (emacs-name)
203                  " accepts all standard X Toolkit command line options.\n"
204                  "In addition, the")
205        "The"))
206     (princ " following options are accepted:
207
208   -t <device>           Use TTY <device> instead of the terminal for input
209                         and output.  This implies the -nw option.
210   -nw                   Inhibit the use of any window-system-specific
211                         display code: use the current tty.
212   -batch                Execute noninteractively (messages go to stderr).
213   -debug-init           Enter the debugger if an error in the init file occurs.
214   -unmapped             Do not map the initial frame.
215   -no-site-file         Do not load the site-specific init file (site-start.el).
216   -no-init-file         Do not load the user-specific init file (~/.emacs).
217   -no-early-packages    Do not process early packages.
218   -no-autoloads         Do not load global symbol files (auto-autoloads) at
219                         startup.  Also implies `-vanilla'.
220   -vanilla              Equivalent to -q -no-site-file -no-early-packages.
221   -q                    Same as -no-init-file.
222   -user <user>          Load user's init file instead of your own.
223   -u <user>             Same as -user.\n")
224    (let ((l command-switch-alist)
225           (insert (lambda (&rest x)
226                     (princ "  ")
227                     (let ((len 2))
228                       (while x
229                         (princ (car x))
230                         (incf len (length (car x)))
231                         (setq x (cdr x)))
232                       (when (>= len 24)
233                         (terpri) (setq len 0))
234                       (while (< len 24)
235                         (princ " ")
236                         (incf len))))))
237       (while l
238         (let ((name (car (car l)))
239               (fn (cdr (car l)))
240               doc arg cons)
241           (cond
242            ((and (symbolp fn) (get fn 'undocumented)) nil)
243            (t
244             (setq doc (documentation fn))
245             (if (member doc '(nil "")) (setq doc "(undocumented)"))
246             (cond ((string-match "\n\\(<.*>\\)\n?\\'" doc)
247                    ;; Doc of the form "The frobber switch\n<arg1> <arg2>"
248                    (setq arg (substring doc (match-beginning 1) (match-end 1))
249                          doc (substring doc 0 (match-beginning 0))))
250                   ((string-match "\n+\\'" doc)
251                    (setq doc (substring doc 0 (match-beginning 0)))))
252             (if (and (setq cons (rassq fn command-switch-alist))
253                      (not (eq cons (car l))))
254                 (setq doc (format "Same as %s." (car cons))))
255             (if arg
256                 (funcall insert name " " arg)
257               (funcall insert name))
258             (princ doc)
259             (terpri))))
260         (setq l (cdr l))))
261     (princ (concat "\
262   +N <file>             Start displaying <file> at line N.
263
264 Anything else is considered a file name, and is placed into a buffer for
265 editing.
266
267 " (emacs-name) " has an online tutorial and manuals.  Type ^Ht (Control-h t) after
268 starting XEmacs to run the tutorial.  Type ^Hi to enter the manual browser.
269 Type ^H^H^H (Control-h Control-h Control-h) to get more help options.\n")
270
271     (kill-emacs 0))))
272
273 (defun command-line-do-funcall (arg)
274   "Invoke the named lisp function with no arguments.
275 <function>"
276   (funcall (intern (pop command-line-args-left))))
277 (fset 'command-line-do-funcall-1 'command-line-do-funcall)
278 (put 'command-line-do-funcall-1 'undocumented t)
279
280 (defun command-line-do-eval (arg)
281   "Evaluate the lisp form.  Quote it carefully.
282 <form>"
283   (eval (read (pop command-line-args-left))))
284
285 (defun command-line-do-load (arg)
286   "Load the named file of Lisp code into XEmacs.
287 <file>"
288   (let ((file (pop command-line-args-left)))
289     ;; Take file from default dir if it exists there;
290     ;; otherwise let `load' search for it.
291     (if (file-exists-p (expand-file-name file))
292         (setq file (expand-file-name file)))
293     (load file nil t)))
294
295 (defun command-line-do-insert (arg)
296   "Insert file into the current buffer.
297 <file>"
298   (insert-file-contents (pop command-line-args-left)))
299
300 (defun command-line-do-kill (arg)
301   "Exit XEmacs."
302   (kill-emacs t))
303
304 (defun command-line-do-version (arg)
305   "Print version info and exit."
306   (princ (concat (emacs-version) "\n"))
307   (kill-emacs 0))
308
309 \f
310 ;;; Processing the command line and loading various init files
311
312 (defun early-error-handler (&rest debugger-args)
313   "You should probably not be using this."
314   ;; Used as the debugger during XEmacs initialization; if an error occurs,
315   ;; print some diagnostics, and kill XEmacs.
316
317   ;; output the contents of the warning buffer, since it won't be seen
318   ;; otherwise.
319   ;; #### kludge!  The call to Feval forces the pending warnings to
320   ;; get output.  There definitely needs to be a better way.
321   (let ((buffer (eval (get-buffer-create "*Warnings*"))))
322     (princ (buffer-substring (point-min buffer) (point-max buffer) buffer)
323            'external-debugging-output))
324
325   (let ((string "Initialization error")
326         (error (nth 1 debugger-args))
327         (debug-on-error nil)
328         (stream 'external-debugging-output))
329     (if (null error)
330         (princ string stream)
331       (princ (concat "\n" string ": ") stream)
332       (condition-case ()
333           (display-error error stream)
334         (error (princ "<<< error printing error message >>>" stream)))
335       (princ "\n" stream)
336       (if (memq (car-safe error) '(void-function void-variable))
337           (princ "
338         This probably means that XEmacs is picking up an old version of
339         the lisp library, or that some .elc files are not up-to-date.\n"
340                  stream)))
341     (when (not suppress-early-error-handler-backtrace)
342       (let ((print-length 1000)
343             (print-level 1000)
344             (print-escape-newlines t)
345             (print-readably nil))
346         (when (getenv "EMACSLOADPATH")
347           (princ (format "\n$EMACSLOADPATH is %s" (getenv "EMACSLOADPATH"))
348                  stream))
349         (princ (format "\nexec-directory is %S" exec-directory) stream)
350         (princ (format "\ndata-directory is %S" data-directory) stream)
351         (princ (format "\ndata-directory-list is %S" data-directory-list) stream)
352         (princ (format "\ndoc-directory is %S" doc-directory) stream)
353         (princ (format "\nload-path is %S" load-path) stream)
354         (princ "\n\n" stream)))
355     (when (not suppress-early-error-handler-backtrace)
356       (backtrace stream t)))
357   (kill-emacs -1))
358
359 (defvar lock-directory)
360 (defvar superlock-file)
361
362 (defun normal-top-level ()
363   (if command-line-processed
364       (message "Back to top level.")
365     (setq command-line-processed t)
366     ;; Canonicalize HOME (PWD is canonicalized by init_buffer in buffer.c)
367     (let ((value (user-home-directory)))
368       (if (and value
369                (< (length value) (length default-directory))
370                (equal (file-attributes default-directory)
371                       (file-attributes value)))
372           (setq default-directory (file-name-as-directory value))))
373     (setq default-directory (abbreviate-file-name default-directory))
374     (initialize-xemacs-paths)
375
376     (startup-set-invocation-environment)
377
378     (let ((debug-paths (or debug-paths
379                            (and (getenv "EMACSDEBUGPATHS")
380                                 t))))
381
382       (setq emacs-roots (paths-find-emacs-roots invocation-directory
383                                                 invocation-name))
384     
385       (if debug-paths
386           (princ (format "emacs-roots:\n%S\n" emacs-roots)
387                  'external-debugging-output))
388     
389       (if (null emacs-roots)
390           (startup-find-roots-warning)
391         (startup-setup-paths emacs-roots
392                              inhibit-early-packages
393                              inhibit-site-lisp
394                              debug-paths))
395       (startup-setup-paths-warning))
396
397     (if (and (not inhibit-autoloads)
398              lisp-directory)
399         (load (expand-file-name (file-name-sans-extension autoload-file-name)
400                                 lisp-directory) nil t))
401     
402     (if (not inhibit-autoloads)
403         (progn
404           (if (not inhibit-early-packages)
405               (packages-load-package-auto-autoloads early-package-load-path))
406           (packages-load-package-auto-autoloads late-package-load-path)
407           (packages-load-package-auto-autoloads last-package-load-path)))
408
409     (unwind-protect
410         (command-line)
411       ;; Do this again, in case .emacs defined more abbreviations.
412       (setq default-directory (abbreviate-file-name default-directory))
413       ;; Specify the file for recording all the auto save files of
414       ;; this session.  This is used by recover-session.
415       (setq auto-save-list-file-name
416             (expand-file-name
417              (format "%s%d-%s"
418                      auto-save-list-file-prefix
419                      (emacs-pid)
420                      (system-name))))
421       (run-hooks 'emacs-startup-hook)
422       (and term-setup-hook
423            (run-hooks 'term-setup-hook))
424       (setq term-setup-hook nil)
425       ;;      ;; Modify the initial frame based on what .emacs puts into
426       ;;      ;; ...-frame-alist.
427       (frame-notice-user-settings)
428       ;;      ;;####FSFmacs junk
429       ;;      ;; Now we know the user's default font, so add it to the menu.
430       ;;      (if (fboundp 'font-menu-add-default)
431       ;;          (font-menu-add-default))
432       (when window-setup-hook
433         (run-hooks 'window-setup-hook))
434       (setq window-setup-hook nil))
435     ;;####FSFmacs junk
436     ;;      (or menubar-bindings-done
437     ;;    (precompute-menubar-bindings))
438     ))
439
440 ;;####FSFmacs junk
441 ;;; Precompute the keyboard equivalents in the menu bar items.
442 ;;(defun precompute-menubar-bindings ()
443 ;;  (if (eq window-system 'x)
444 ;;      (let ((submap (lookup-key global-map [menu-bar])))
445 ;;      (while submap
446 ;;        (and (consp (car submap))
447 ;;             (symbolp (car (car submap)))
448 ;;             (stringp (car-safe (cdr (car submap))))
449 ;;             (keymapp (cdr (cdr (car submap))))
450 ;;             (x-popup-menu nil (cdr (cdr (car submap)))))
451 ;;        (setq submap (cdr submap))))))
452
453 (defun command-line-early (args)
454   ;; This processes those switches which need to be processed before
455   ;; starting up the window system.
456
457   (setq command-line-default-directory default-directory)
458
459   ;; See if we should import version-control from the environment variable.
460   (let ((vc (getenv "VERSION_CONTROL")))
461     (cond ((eq vc nil))                 ;don't do anything if not set
462           ((or (string= vc "t")
463                (string= vc "numbered"))
464            (setq version-control t))
465           ((or (string= vc "nil")
466                (string= vc "existing"))
467            (setq version-control nil))
468           ((or (string= vc "never")
469                (string= vc "simple"))
470            (setq version-control 'never))))
471
472   ;;####FSFmacs
473   ;;  (if (let ((ctype
474   ;;         ;; Use the first of these three envvars that has a nonempty value.
475   ;;         (or (let ((string (getenv "LC_ALL")))
476   ;;               (and (not (equal string "")) string))
477   ;;             (let ((string (getenv "LC_CTYPE")))
478   ;;               (and (not (equal string "")) string))
479   ;;             (let ((string (getenv "LANG")))
480   ;;               (and (not (equal string "")) string)))))
481   ;;    (and ctype
482   ;;         (string-match iso-8859-1-locale-regexp ctype)))
483   ;;      (progn 
484   ;;    (standard-display-european t)
485   ;;    (require 'iso-syntax)))
486
487   ;; Figure out which user's init file to load,
488   ;; either from the environment or from the options.
489   (setq init-file-user (if (noninteractive) nil (user-login-name)))
490   ;; If user has not done su, use current $HOME to find .emacs.
491   (and init-file-user (string= init-file-user (user-real-login-name))
492        (setq init-file-user ""))
493
494   ;; Allow (at least) these arguments anywhere in the command line
495   (let ((new-args nil)
496         (arg      nil))
497     (while args
498       (setq arg (pop args))
499       (cond
500        ((or (string= arg "-q")
501             (string= arg "-no-init-file"))
502         (setq init-file-user nil))
503        ((string= arg "-no-site-file")
504         (setq site-start-file nil))
505        ((or (string= arg "-no-early-packages")
506             (string= arg "--no-early-packages"))
507         (setq inhibit-early-packages t))
508        ((or (string= arg "-vanilla")
509             (string= arg "--vanilla")
510             ;; Some work on this one already done in emacs.c.
511             (string= arg "-no-autoloads")
512             (string= arg "--no-autoloads"))
513         (setq init-file-user nil
514               site-start-file nil))
515        ((or (string= arg "-u")
516             (string= arg "-user"))
517         (setq init-file-user (pop args)))
518        ((string= arg "-debug-init")
519         (setq init-file-debug t))
520        ((string= arg "-unmapped")
521         (setq initial-frame-unmapped-p t))
522        ((or (string= arg "-debug-paths")
523             (string= arg "--debug-paths"))
524         t)
525        ((or (string= arg "--") (string= arg "-"))
526         (while args
527           (push (pop args) new-args)))
528        (t (push arg new-args))))
529     
530     (nreverse new-args)))
531
532 (defconst initial-scratch-message "\
533 ;; This buffer is for notes you don't want to save, and for Lisp evaluation.
534 ;; If you want to create a file, first visit that file with C-x C-f,
535 ;; then enter the text in that file's own buffer.
536
537 "
538   "Initial message displayed in *scratch* buffer at startup.
539 If this is nil, no message will be displayed.")
540
541 (defun command-line ()
542   (let ((command-line-args-left (cdr command-line-args)))
543
544     (let ((debugger 'early-error-handler)
545           (debug-on-error t))
546
547       ;; Process magic command-line switches like -q and -u.  Do this
548       ;; before creating the first frame because some of these switches
549       ;; may affect that.  I think it's ok to do this before establishing
550       ;; the X connection, and maybe someday things like -nw can be
551       ;; handled here instead of down in C.
552       (setq command-line-args-left (command-line-early command-line-args-left))
553
554       ;; Setup the toolbar icon directory
555       (when (featurep 'toolbar)
556         (init-toolbar-location))
557
558       ;; Run the window system's init function.  tty is considered to be
559       ;; a type of window system for this purpose.  This creates the
560       ;; initial (non stdio) device.
561       (when (and initial-window-system (not noninteractive))
562         (funcall (intern (concat "init-"
563                                  (symbol-name initial-window-system)
564                                  "-win"))))
565
566       ;; When not in batch mode, this creates the first visible frame,
567       ;; and deletes the stdio device.
568       (frame-initialize))
569
570     ;;
571     ;; We have normality, I repeat, we have normality.  Anything you still
572     ;; can't cope with is therefore your own problem.  (And we don't need
573     ;; to kill XEmacs for it.)
574     ;;
575
576     ;;; Load init files.
577     (load-init-file)
578     
579     (with-current-buffer (get-buffer "*scratch*")
580       (erase-buffer)
581       ;; (insert initial-scratch-message)
582       (set-buffer-modified-p nil)
583       (when (eq major-mode 'fundamental-mode)
584         (funcall initial-major-mode)))
585
586     ;; Load library for our terminal type.
587     ;; User init file can set term-file-prefix to nil to prevent this.
588     ;; Note that for any TTY's opened subsequently, the TTY init
589     ;; code will run this.
590     (when (and (eq 'tty (console-type))
591                (not (noninteractive)))
592       (load-terminal-library))
593
594     ;; Process the remaining args.
595     (command-line-1)
596
597     ;; it was turned on by default so that the warnings don't get displayed
598     ;; until after the splash screen.
599     (setq inhibit-warning-display nil)
600     ;; If -batch, terminate after processing the command options.
601     (when (noninteractive) (kill-emacs t))))
602
603 (defun load-terminal-library ()       
604   (when term-file-prefix
605     (let ((term (getenv "TERM"))
606           hyphend)
607       (while (and term
608                   (not (load (concat term-file-prefix term) t t)))
609         ;; Strip off last hyphen and what follows, then try again
610         (if (setq hyphend (string-match "[-_][^-_]+\\'" term))
611             (setq term (substring term 0 hyphend))
612           (setq term nil))))))
613
614 (defconst user-init-directory "/.xemacs/"
615   "Directory where user-installed packages may go.")
616 (define-obsolete-variable-alias
617   'emacs-user-extension-dir
618   'user-init-directory)
619
620 (defun load-user-init-file (init-file-user)
621   "This function actually reads the init file, .emacs."
622   (when init-file-user
623 ;; purge references to init.el and options.el
624 ;; convert these to use paths-construct-path for eventual migration to init.el
625 ;; needs to be converted when idiom for constructing "~user" paths is created
626 ;    (setq user-init-file
627 ;         (paths-construct-path (list (concat "~" init-file-user)
628 ;                                     user-init-directory
629 ;                                     "init.el")))
630 ;    (unless (file-exists-p (expand-file-name user-init-file))
631     (setq user-init-file
632           (paths-construct-path (list (concat "~" init-file-user)
633                                       (cond
634                                        ((eq system-type 'ms-dos) "_emacs")
635                                        (t ".emacs")))))
636 ;    )
637     (load user-init-file t t t)
638 ;; This should not be loaded since custom stuff currently goes into .emacs
639 ;    (let ((default-custom-file
640 ;           (paths-construct-path (list (concat "~" init-file-user)
641 ;                                       user-init-directory
642 ;                                       "options.el")))
643 ;      (when (string= custom-file default-custom-file)
644 ;       (load default-custom-file t t)))
645     (unless inhibit-default-init
646       (let ((inhibit-startup-message nil))
647         ;; Users are supposed to be told their rights.
648         ;; (Plus how to get help and how to undo.)
649         ;; Don't you dare turn this off for anyone except yourself.
650         (load "default" t t)))))
651
652 ;;; Load user's init file and default ones.
653 (defun load-init-file ()
654   (run-hooks 'before-init-hook)
655
656   ;; Run the site-start library if it exists.  The point of this file is
657   ;; that it is run before .emacs.  There is no point in doing this after
658   ;; .emacs; that is useless.
659   (when site-start-file
660     (load site-start-file t t))
661
662   ;; Sites should not disable this.  Only individuals should disable
663   ;; the startup message.
664   (setq inhibit-startup-message nil)
665
666   (let (debug-on-error-from-init-file
667         debug-on-error-should-be-set
668         (debug-on-error-initial
669          (if (eq init-file-debug t) 'startup init-file-debug)))
670     (let ((debug-on-error debug-on-error-initial))
671       (if init-file-debug
672           ;; Do this without a condition-case if the user wants to debug.
673           (load-user-init-file init-file-user)
674         (condition-case error
675             (progn
676               (load-user-init-file init-file-user)
677               (setq init-file-had-error nil))
678           (error
679            (message "Error in init file: %s" (error-message-string error))
680            (display-warning 'initialization
681              (format "\
682 An error has occurred while loading %s:
683
684 %s
685
686 To ensure normal operation, you should investigate the cause of the error
687 in your initialization file and remove it.  Use the `-debug-init' option
688 to XEmacs to view a complete error backtrace."
689                      user-init-file (error-message-string error))
690              'error)
691            (setq init-file-had-error t))))
692       ;; If we can tell that the init file altered debug-on-error,
693       ;; arrange to preserve the value that it set up.
694       (or (eq debug-on-error debug-on-error-initial)
695           (setq debug-on-error-should-be-set t
696                 debug-on-error-from-init-file debug-on-error)))
697     (when debug-on-error-should-be-set
698       (setq debug-on-error debug-on-error-from-init-file)))
699
700   (setq init-file-loaded t)
701
702   ;; Do this here in case the init file sets mail-host-address.
703   ;; Don't do this here unless noninteractive, it is frequently wrong. -sb
704   ;; (or user-mail-address
705   (when noninteractive
706     (setq user-mail-address (concat (user-login-name) "@"
707                                     (or mail-host-address
708                                         (system-name)))))
709
710   (run-hooks 'after-init-hook)
711   nil)
712
713 (defun load-options-file (filename)
714   "Load the file of saved options (from the Options menu) called FILENAME.
715 Currently this does nothing but call `load', but it might be redefined
716 in the future to support automatically converting older options files to
717 a new format, when variables have changed, etc."
718   (load filename))
719
720 (defun command-line-1 ()
721   (cond
722    ((null command-line-args-left)
723     (unless noninteractive
724       ;; If there are no switches to process, run the term-setup-hook
725       ;; before displaying the copyright notice; there may be some need
726       ;; to do it before doing any output.  If we're not going to
727       ;; display a copyright notice (because other options are present)
728       ;; then this is run after those options are processed.
729       (run-hooks 'term-setup-hook)
730       ;; Don't let the hook be run twice.
731       (setq term-setup-hook nil)
732
733       ;; Don't clobber a non-scratch buffer if init file
734       ;; has selected it.
735       (when (string= (buffer-name) "*scratch*")
736         (unless (or inhibit-startup-message
737                     (input-pending-p))
738           (let ((timeout nil))
739             (unwind-protect
740                 ;; Guts of with-timeout
741                 (catch 'timeout
742                   (setq timeout (add-timeout startup-message-timeout
743                                              (lambda (ignore)
744                                                (condition-case nil
745                                                    (throw 'timeout t)
746                                                  (error nil)))
747                                              nil))
748                   (startup-splash-frame)
749                   (or nil;; (pos-visible-in-window-p (point-min))
750                       (goto-char (point-min)))
751                   (sit-for 0)
752                   (setq unread-command-event (next-command-event)))
753               (when timeout (disable-timeout timeout)))))
754         (with-current-buffer (get-buffer "*scratch*")
755           ;; In case the XEmacs server has already selected
756           ;; another buffer, erase the one our message is in.
757           (erase-buffer)
758           (when (stringp initial-scratch-message)
759             (insert initial-scratch-message))
760           (set-buffer-modified-p nil)))))
761
762    (t
763     ;; Command-line-options exist
764     (let ((dir command-line-default-directory)
765           (file-count 0)
766           (line nil)
767           (end-of-options nil)
768           first-file-buffer file-p arg tem)
769       (while command-line-args-left
770         (setq arg (pop command-line-args-left))
771         (cond
772          (end-of-options
773           (setq file-p t))
774          ((setq tem (when (eq (aref arg 0) ?-)
775                       (or (assoc arg command-switch-alist)
776                           (assoc (substring arg 1)
777                                  command-switch-alist))))
778           (funcall (cdr tem) arg))
779          ((string-match "\\`\\+[0-9]+\\'" arg)
780           (setq line (string-to-int arg)))
781          ;; "- file" means don't treat "file" as a switch
782          ;;  ("+0 file" has the same effect; "-" added
783          ;;   for unixoidiality).
784          ;; This is worthless; the `unixoid' way is "./file". -jwz
785          ((or (string= arg "-") (string= arg "--"))
786           (setq end-of-options t))
787          (t
788           (setq file-p t)))
789         
790         (when file-p
791           (setq file-p nil)
792           (incf file-count)
793           (setq arg (expand-file-name arg dir))
794           (cond
795            ((= file-count 1) (setq first-file-buffer
796                                    (progn (find-file arg) (current-buffer))))
797            (noninteractive (find-file arg))
798            (t (find-file-other-window arg)))
799           (when line
800             (goto-line line)
801             (setq line nil))))))))
802
803 (defvar startup-presentation-hack-keymap
804   (let ((map (make-sparse-keymap)))
805     (set-keymap-name map 'startup-presentation-hack-keymap)
806     (define-key map '[button1] 'startup-presentation-hack)
807     (define-key map '[button2] 'startup-presentation-hack)
808     map)
809   "Putting yesterday in the future tomorrow.")
810
811 (defun startup-presentation-hack ()
812   (interactive)
813   (let ((e last-command-event))
814     (and (button-press-event-p e)
815          (setq e (extent-at (event-point e)
816                             (event-buffer e)
817                             'startup-presentation-hack))
818          (setq e (extent-property e 'startup-presentation-hack))
819          (if (consp e)
820              (apply (car e) (cdr e))
821            (while (keymapp (indirect-function e))
822              (let ((map e)
823                    (overriding-local-map (indirect-function e)))
824                (setq e (read-key-sequence
825                         (let ((p (keymap-prompt map t)))
826                           (cond ((symbolp map)
827                                  (if p 
828                                      (format "%s %s " map p)
829                                    (format "%s " map)))
830                                 (p)
831                                 (t
832                                  (prin1-to-string map))))))
833                (if (and (button-release-event-p (elt e 0))
834                         (null (key-binding e)))
835                    (setq e map)         ; try again
836                  (setq e (key-binding e)))))
837            (call-interactively e)))))
838
839 (defun startup-presentation-hack-help (e)
840   (setq e (extent-property e 'startup-presentation-hack))
841   (if (consp e)
842       (format "Evaluate %S" e)
843     (symbol-name e)))
844
845 (defun splash-frame-present-hack (e v)
846   ;;  (set-extent-property e 'mouse-face 'highlight)
847   ;;  (set-extent-property e 'keymap
848   ;;                       startup-presentation-hack-keymap)
849   ;;  (set-extent-property e 'startup-presentation-hack v)
850   ;;  (set-extent-property e 'help-echo
851   ;;                       'startup-presentation-hack-help))
852   )
853
854 (defun splash-hack-version-string ()
855   (save-excursion
856     (save-restriction
857       (goto-char (point-min))
858       (re-search-forward "^XEmacs" nil t)
859       (narrow-to-region (point-at-bol) (point-at-eol))
860       (goto-char (point-min))
861       (when (re-search-forward " \\[Lucid\\]" nil t)
862         (delete-region (match-beginning 0) (match-end 0)))
863       (when (re-search-forward "[^(][^)]*-[^)]*-" nil t)
864         (delete-region (1+ (match-beginning 0)) (match-end 0))
865         (insert "("))
866       (goto-char (point-max))
867       (search-backward " " nil t)
868       (when (search-forward "." nil t)
869         (delete-region (1- (point)) (point-max))))))
870
871 (defun splash-frame-present (l)
872   (cond ((stringp l)
873          (insert l))
874         ((eq (car-safe l) 'face)
875          ;; (face name string)
876          (let ((p (point)))
877            (splash-frame-present (elt l 2))
878            (if (fboundp 'set-extent-face)
879                (set-extent-face (make-extent p (point))
880                                 (elt l 1)))))
881         ((eq (car-safe l) 'key)
882          (let* ((c (elt l 1))
883                 (p (point))
884                 (k (where-is-internal c nil t)))
885            (insert (if k (key-description k)
886                      (format "M-x %s" c)))
887            (if (fboundp 'set-extent-face)
888                (let ((e (make-extent p (point))))
889                  (set-extent-face e 'bold)
890                  (splash-frame-present-hack e c)))))
891         ((eq (car-safe l) 'funcall)
892          ;; (funcall (fun . args) string)
893          (let ((p (point)))
894            (splash-frame-present (elt l 2))
895            (if (fboundp 'set-extent-face)
896                (splash-frame-present-hack (make-extent p (point))
897                                           (elt l 1)))))
898         ((consp l)
899          (mapcar 'splash-frame-present l))
900         (t
901          (error "WTF!?"))))
902
903 (defun startup-center-spaces (glyph)
904   ;; Return the number of spaces to insert in order to center
905   ;; the given glyph (may be a string or a pixmap).
906   ;; Assume spaces are as wide as avg-pixwidth.  
907   ;; Won't be quite right for proportional fonts, but it's the best we can do.
908   ;; Maybe the new redisplay will export something a glyph-width function.
909   ;;; #### Yes, there is a glyph-width function but it isn't quite what
910   ;;; #### this was expecting.  Or is it?
911   ;; (An alternate way to get avg-pixwidth would be to use x-font-properties
912   ;; and calculate RESOLUTION_X * AVERAGE_WIDTH / 722.7, but it's no better.)
913
914   ;; This function is used in about.el too.
915   (let* ((avg-pixwidth     (round (/ (frame-pixel-width) (frame-width))))
916          (fill-area-width  (* avg-pixwidth (- fill-column left-margin)))
917          (glyph-pixwidth   (cond ((stringp glyph) 
918                                   (* avg-pixwidth (length glyph)))
919                                  ;; #### the pixmap option should be removed
920                                  ;;((pixmapp glyph)
921                                  ;; (pixmap-width glyph))
922                                  ((glyphp glyph)
923                                   (glyph-width glyph))
924                                  (t
925                                   (error "startup-center-spaces: bad arg")))))
926     (+ left-margin
927        (round (/ (/ (- fill-area-width glyph-pixwidth) 2) avg-pixwidth)))))
928
929 (defun startup-splash-frame-body ()
930   `("\n" ,(emacs-version) "\n"
931     ,@(if (string-match "beta" emacs-version)
932           `( (face (bold blue) ( "This is an Experimental version of XEmacs. "
933                                  " Type " (key describe-beta)
934                                  " to see what this means.\n")))
935         `( "\n"))
936     (face bold-italic "\
937 Copyright (C) 1985-1998 Free Software Foundation, Inc.
938 Copyright (C) 1990-1994 Lucid, Inc.
939 Copyright (C) 1993-1997 Sun Microsystems, Inc. All Rights Reserved.
940 Copyright (C) 1994-1996 Board of Trustees, University of Illinois
941 Copyright (C) 1995-1996 Ben Wing\n\n")
942     
943     ,@(if (featurep 'sparcworks)
944           `( "\
945 Sun provides support for the WorkShop/XEmacs integration package only.
946 All other XEmacs packages are provided to you \"AS IS\".
947 For full details, type " (key describe-no-warranty)
948 " to refer to the GPL Version 2, dated June 1991.\n\n"
949 ,@(let ((lang (or (getenv "LC_ALL") (getenv "LC_MESSAGES") (getenv "LANG"))))
950     (if (and
951          (not (featurep 'mule))         ; Already got mule?
952          (not (eq 'tty (console-type))) ; No Mule support on tty's yet
953          lang                           ; Non-English locale?
954          (not (string= lang "C"))
955          (not (string-match "^en" lang))
956          (locate-file "xemacs-mule" exec-path)) ; Comes with Sun WorkShop
957         '( "\
958 This version of XEmacs has been built with support for Latin-1 languages only.
959 To handle other languages you need to run a Multi-lingual (`Mule') version of
960 XEmacs, by either running the command `xemacs-mule', or by using the X resource
961 `ESERVE*defaultXEmacsPath: xemacs-mule' when starting XEmacs from Sun WorkShop.\n\n"))))
962
963         '("XEmacs comes with ABSOLUTELY NO WARRANTY; type "
964           (key describe-no-warranty) " for full details.\n"))
965     
966     "You may give out copies of XEmacs; type "
967     (key describe-copying) " to see the conditions.\n"
968     "Type " (key describe-distribution)
969     " for information on getting the latest version.\n\n"
970
971     "Type " (key help-command) " or use the " (face bold "Help") " menu to get help.\n"
972     "Type " (key advertised-undo) " to undo changes  (`C-' means use the Control key).\n"
973     "To get out of XEmacs, type " (key save-buffers-kill-emacs) ".\n"
974     "Type " (key help-with-tutorial) " for a tutorial on using XEmacs.\n"
975     "Type " (key info) " to enter Info, "
976     "which you can use to read online documentation.\n"
977     (face (bold red) ( "\
978 For tips and answers to frequently asked questions, see the XEmacs FAQ.
979 \(It's on the Help menu, or type " (key xemacs-local-faq) " [a capital F!].\)"))))
980
981 ;; I really hate global variables, oh well.
982 ;(defvar xemacs-startup-logo-function nil
983 ;  "If non-nil, function called to provide the startup logo.
984 ;This function should return an initialized glyph if it is used.")
985
986 (defun startup-splash-frame ()
987   (let ((p (point))
988 ;       (logo (cond (xemacs-startup-logo-function
989 ;                    (funcall xemacs-startup-logo-function))
990 ;                   (t xemacs-logo)))
991         (logo xemacs-logo)
992         (cramped-p (eq 'tty (console-type))))
993     (unless cramped-p (insert "\n"))
994     (indent-to (startup-center-spaces logo))
995     (set-extent-begin-glyph (make-extent (point) (point)) logo)
996     (insert (if cramped-p "\n" "\n\n"))
997     (splash-frame-present-hack (make-extent p (point)) 'about-xemacs))
998
999   (let ((after-change-functions nil))   ; no font-lock, thank you
1000     (dolist (l (startup-splash-frame-body))
1001       (splash-frame-present l)))
1002   (splash-hack-version-string)
1003   (set-buffer-modified-p nil))
1004
1005 ;;  (let ((present-file
1006 ;;         #'(lambda (f)
1007 ;;             (splash-frame-present
1008 ;;            (list 'funcall
1009 ;;                  (list 'find-file-other-window
1010 ;;                        (expand-file-name f data-directory))
1011 ;;                  f)))))
1012 ;;    (insert "For customization examples, see the files ")
1013 ;;    (funcall present-file "sample.emacs")
1014 ;;    (insert " and ")
1015 ;;    (funcall present-file "sample.Xdefaults")
1016 ;;    (insert (format "\nin the directory %s." data-directory)))
1017
1018 (defun startup-set-invocation-environment ()
1019   ;; XEmacs -- Steven Baur says invocation directory is nil if you
1020   ;; try to use XEmacs as a login shell.
1021   (or invocation-directory (setq invocation-directory default-directory))
1022   (setq invocation-directory
1023         ;; don't let /tmp_mnt/... get into the load-path or exec-path.
1024         (abbreviate-file-name invocation-directory)))
1025
1026 (defun startup-setup-paths (roots &optional
1027                                   inhibit-early-packages inhibit-site-lisp
1028                                   debug-paths)
1029   "Setup all the various paths.
1030 ROOTS is a list of plausible roots of the XEmacs directory hierarchy.
1031 If INHIBIT-PACKAGES is non-NIL, don't do packages.
1032 If INHIBIT-SITE-LISP is non-NIL, don't do site-lisp.
1033 If DEBUG-PATHS is non-NIL, print paths as they are detected.
1034 It's idempotent, so call this as often as you like!"
1035
1036   (apply #'(lambda (early late last)
1037              (setq early-packages (and (not inhibit-early-packages)
1038                                        early))
1039              (setq late-packages late)
1040              (setq last-packages last))
1041          (packages-find-packages roots))
1042
1043   (setq early-package-load-path (packages-find-package-load-path early-packages))
1044   (setq late-package-load-path (packages-find-package-load-path late-packages))
1045   (setq last-package-load-path (packages-find-package-load-path last-packages))
1046
1047   (if debug-paths
1048       (progn
1049         (princ (format "configure-package-path:\n%S\n" configure-package-path)
1050                'external-debugging-output)
1051         (princ (format "early-packages and early-package-load-path:\n%S\n%S\n"
1052                        early-packages early-package-load-path)
1053                'external-debugging-output)
1054         (princ (format "late-packages and late-package-load-path:\n%S\n%S\n"
1055                        late-packages late-package-load-path)
1056                'external-debugging-output)
1057         (princ (format "last-packages and last-package-load-path:\n%S\n%S\n"
1058                        last-packages last-package-load-path)
1059                'external-debugging-output)))
1060
1061   (setq lisp-directory (paths-find-lisp-directory roots))
1062
1063   (if debug-paths
1064       (princ (format "lisp-directory:\n%S\n" lisp-directory)
1065              'external-debugging-output))
1066
1067   (setq site-directory (and (null inhibit-site-lisp)
1068                             (paths-find-site-lisp-directory roots)))
1069
1070   (if (and debug-paths (null inhibit-site-lisp))
1071       (princ (format "site-directory:\n%S\n" site-directory)
1072              'external-debugging-output))
1073
1074   (setq load-path (paths-construct-load-path roots
1075                                              early-package-load-path
1076                                              late-package-load-path
1077                                              last-package-load-path
1078                                              lisp-directory
1079                                              site-directory))
1080
1081   (setq Info-directory-list
1082         (paths-construct-info-path roots
1083                                    early-packages late-packages last-packages))
1084
1085   
1086   (if debug-paths
1087       (princ (format "Info-directory-list:\n%S\n" Info-directory-list)
1088              'external-debugging-output))
1089
1090   (if (boundp 'lock-directory)
1091       (progn
1092         (setq lock-directory (paths-find-lock-directory roots))
1093         (setq superlock-file (paths-find-superlock-file lock-directory))
1094         
1095         (if debug-paths
1096             (progn
1097               (princ (format "lock-directory:\n%S\n" lock-directory)
1098                      'external-debugging-output)
1099               (princ (format "superlock-file:\n%S\n" superlock-file)
1100                      'external-debugging-output)))))
1101
1102   (setq exec-directory (paths-find-exec-directory roots))
1103
1104   (if debug-paths
1105       (princ (format "exec-directory:\n%s\n" exec-directory)
1106              'external-debugging-output))
1107
1108   (setq exec-path
1109         (paths-construct-exec-path roots exec-directory
1110                                    early-packages late-packages last-packages))
1111
1112   (if debug-paths
1113       (princ (format "exec-path:\n%S\n" exec-path)
1114              'external-debugging-output))
1115   
1116   (setq doc-directory (paths-find-doc-directory roots))
1117
1118   (if debug-paths
1119       (princ (format "doc-directory:\n%S\n" doc-directory)
1120              'external-debugging-output))
1121
1122   (setq data-directory (paths-find-data-directory roots))
1123
1124   (if debug-paths
1125       (princ (format "data-directory:\n%S\n" data-directory)
1126              'external-debugging-output))
1127
1128   (setq data-directory-list (paths-construct-data-directory-list data-directory
1129                                                                  early-packages
1130                                                                  late-packages
1131                                                                  last-packages))
1132   (if debug-paths
1133       (princ (format "data-directory-list:\n%S\n" data-directory-list)
1134              'external-debugging-output)))
1135
1136 (defun startup-find-roots-warning ()
1137   (save-excursion
1138     (set-buffer (get-buffer-create " *warning-tmp*"))
1139     (erase-buffer)
1140     (buffer-disable-undo (current-buffer))
1141
1142     (insert "Couldn't find an obvious default for the root of the\n"
1143             "XEmacs hierarchy.")
1144
1145     (princ "\nWARNING:\n" 'external-debugging-output)
1146     (princ (buffer-string) 'external-debugging-output)))
1147
1148 (defun startup-setup-paths-warning ()
1149   (let ((lock (if (boundp 'lock-directory) lock-directory 't))
1150         (warnings '()))
1151     (if (and (stringp lock) (null (file-directory-p lock)))
1152         (setq lock nil))
1153     (cond
1154      ((null (and lisp-directory exec-directory data-directory doc-directory
1155                  load-path
1156                  lock))
1157       (save-excursion
1158         (set-buffer (get-buffer-create " *warning-tmp*"))
1159         (erase-buffer)
1160         (buffer-disable-undo (current-buffer))
1161         (if (null lisp-directory) (push "lisp-directory" warnings))
1162         (if (null lock)           (push "lock-directory" warnings))
1163         (if (null exec-directory) (push "exec-directory" warnings))
1164         (if (null data-directory) (push "data-directory" warnings))
1165         (if (null doc-directory)  (push "doc-directory"  warnings))
1166         (if (null load-path)      (push "load-path"      warnings))
1167
1168         (insert "Couldn't find obvious defaults for:\n")
1169         (while warnings
1170           (insert (car warnings) "\n")
1171           (setq warnings (cdr warnings)))
1172         (insert "Perhaps some directories don't exist, "
1173                 "or the XEmacs executable,\n" (concat invocation-directory
1174                                                      invocation-name)
1175                 "\nis in a strange place?")
1176
1177         (princ "\nWARNING:\n" 'external-debugging-output)
1178         (princ (buffer-string) 'external-debugging-output)
1179         (erase-buffer)
1180         t)))))
1181
1182 ;;; startup.el ends here