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