update.
[chise/xemacs-chise.git.1] / lisp / startup.el
index f2bc2d3..26cc299 100644 (file)
@@ -77,9 +77,9 @@ The frame system uses this to open frames to display messages while
 XEmacs loads the user's initialization file.")
 
 (defvar after-init-hook nil
-  "*Functions to call after loading the init file (`.emacs').
+  "*Functions to call after loading the init file.
 The call is not protected by a condition-case, so you can set `debug-on-error'
-in `.emacs', and put all the actual code on `after-init-hook'.")
+in the init file, and put all the actual code on `after-init-hook'.")
 
 (defvar term-setup-hook nil
   "*Functions to be called after loading terminal-specific Lisp code.
@@ -107,23 +107,36 @@ the user's init file.")
 (defvar user-init-directory-base ".xemacs"
   "Base of directory where user-installed init files may go.")
 
-(defvar user-init-file-base-list (append
-                                 '(".emacs.elc" ".emacs.el" ".emacs")
-                                 (and (eq system-type 'windows-nt)
-                                      '("_emacs.elc" "_emacs.el" "_emacs")))
-  "List of allowed init files.  The first one found takes precedence.")
-
 (defvar user-init-directory
   (file-name-as-directory
    (paths-construct-path (list "~" user-init-directory-base)))
   "Directory where user-installed init files may go.")
 
+(defvar user-init-file-base "init.el"
+  "Default name of the user init file if uncompiled.
+This should be used for migration purposes only.")
+
+(defvar user-init-file-base-list '("init.elc" "init.el")
+  "List of allowed init files in the user's init directory.
+The first one found takes precedence.")
+
+(defvar user-home-init-file-base-list
+  (append '(".emacs.elc" ".emacs.el" ".emacs")
+         (and (eq system-type 'windows-nt)
+              '("_emacs.elc" "_emacs.el" "_emacs")))
+  "List of allowed init files in the user's home directory.
+The first one found takes precedence.")
+
+(defvar load-home-init-file nil
+  "Non-nil if XEmacs should load the init file from the home directory.
+Otherwise, XEmacs will offer migration to the init directory.")
+
 (defvar load-user-init-file-p t
   "Non-nil if XEmacs should load the user's init file.")
 
 ;; #### called `site-run-file' in FSFmacs
 
-(defvar site-start-file (purecopy "site-start")
+(defvar site-start-file "site-start"
   "File containing site-wide run-time initializations.
 This file is loaded at run-time before `.emacs'.  It
 contains inits that need to be in place for the entire site, but
@@ -146,18 +159,17 @@ is less convenient.")
 ;;We do that if this regexp matches the locale name
 ;;specified by the LC_ALL, LC_CTYPE and LANG environment variables.")
 
-(defvar mail-host-address nil
-  "*Name of this machine, for purposes of naming users.")
+(defcustom mail-host-address nil
+  "*Name of this machine, for purposes of naming users."
+  :type 'string
+  :group 'mail)
 
-(defvar user-mail-address nil
+(defcustom user-mail-address nil
   "*Full mailing address of this user.
 This is initialized based on `mail-host-address',
-after your init file is read, in case it sets `mail-host-address'.")
-
-(defvar auto-save-list-file-prefix "~/.saves-"
-  "Prefix for generating auto-save-list-file-name.
-Emacs's pid and the system name will be appended to
-this prefix to create a unique file name.")
+after your init file is read, in case it sets `mail-host-address'."
+  :type 'string
+  :group 'mail)
 
 (defvar init-file-debug nil)
 
@@ -173,23 +185,22 @@ after, and will not be true at any time before.")
 \f
 
 (defvar command-switch-alist
-  (purecopy
-   '(("-help"  . command-line-do-help)
-     ("-version". command-line-do-version)
-     ("-V"     . command-line-do-version)
-     ("-funcall". command-line-do-funcall)
-     ("-f"     . command-line-do-funcall)
-     ("-e"     . command-line-do-funcall-1)
-     ("-eval"  . command-line-do-eval)
-     ("-load"  . command-line-do-load)
-     ("-l"     . command-line-do-load)
-     ("-insert"        . command-line-do-insert)
-     ("-i"     . command-line-do-insert)
-     ("-kill"  . command-line-do-kill)
-     ;; Options like +35 are handled specially.
-     ;; Window-system, site, or package-specific code might add to this.
-     ;; X11 handles its options by letting Xt remove args from this list.
-     ))
+  '(("-help"   . command-line-do-help)
+    ("-version". command-line-do-version)
+    ("-V"      . command-line-do-version)
+    ("-funcall". command-line-do-funcall)
+    ("-f"      . command-line-do-funcall)
+    ("-e"      . command-line-do-funcall-1)
+    ("-eval"   . command-line-do-eval)
+    ("-load"   . command-line-do-load)
+    ("-l"      . command-line-do-load)
+    ("-insert" . command-line-do-insert)
+    ("-i"      . command-line-do-insert)
+    ("-kill"   . command-line-do-kill)
+    ;; Options like +35 are handled specially.
+    ;; Window-system, site, or package-specific code might add to this.
+    ;; X11 handles its options by letting Xt remove args from this list.
+    )
   "Alist of command-line switches.
 Elements look like (SWITCH-STRING . HANDLER-FUNCTION).
 HANDLER-FUNCTION receives switch name as sole arg;
@@ -216,6 +227,9 @@ command line options plus the following:
 In addition, the")
        "The"))
     (princ " following options are accepted:
+  -sd                   Show dump ID.  Ignored when configured without --pdump.
+  -nd                   Don't load the dump file.  Roughly like old temacs.
+                        Ignored when configured without --pdump.
   -t <device>           Use TTY <device> instead of the terminal for input
                         and output.  This implies the -nw option.
   -nw                   Inhibit the use of any window-system-specific
@@ -224,17 +238,15 @@ In addition, the")
   -debug-init           Enter the debugger if an error in the init file occurs.
   -unmapped             Do not map the initial frame.
   -no-site-file         Do not load the site-specific init file (site-start.el).
-  -no-init-file         Do not load the user-specific init file (~/.emacs).
+  -no-init-file         Do not load the user-specific init file.
   -no-early-packages   Do not process early packages.
   -no-autoloads                Do not load global symbol files (auto-autoloads) at
                        startup.  Also implies `-vanilla'.
   -vanilla             Equivalent to -q -no-site-file -no-early-packages.
   -q                    Same as -no-init-file.
   -user-init-file <file> Use <file> as init file.
-  -user-init-directory <directory> use <directory> as init directory.
+  -user-init-directory <directory> Use <directory> as init directory.
   -user <user>          Load user's init file instead of your own.
-                        Equivalent to -user-init-file ~<user>/.emacs
-                                      -user-init-directory ~<user>/.xemacs/
   -u <user>             Same as -user.\n")
    (let ((l command-switch-alist)
          (insert (lambda (&rest x)
@@ -401,18 +413,23 @@ Type ^H^H^H (Control-h Control-h Control-h) to get more help options.\n")
                 'external-debugging-output))
 
       (if (null emacs-roots)
-         (startup-find-roots-warning)
-       (startup-setup-paths emacs-roots
-                            user-init-directory
-                            inhibit-early-packages
-                            inhibit-site-lisp
-                            debug-paths))
+         (startup-find-roots-warning))
+      (startup-setup-paths emacs-roots
+                          user-init-directory
+                          inhibit-early-packages
+                          inhibit-site-lisp
+                          debug-paths)
       (startup-setup-paths-warning))
 
-    (if (and (not inhibit-autoloads)
-            lisp-directory)
-       (load (expand-file-name (file-name-sans-extension autoload-file-name)
-                               lisp-directory) nil t))
+    (when (and (not inhibit-autoloads)
+              lisp-directory)
+      (load (expand-file-name (file-name-sans-extension autoload-file-name)
+                             lisp-directory) nil t)
+      (if (featurep 'utf-2000)
+         (load (expand-file-name
+                (file-name-sans-extension autoload-file-name)
+                (expand-file-name "utf-2000" lisp-directory))
+               nil t)))
 
     (if (not inhibit-autoloads)
        (progn
@@ -421,23 +438,27 @@ Type ^H^H^H (Control-h Control-h Control-h) to get more help options.\n")
          (packages-load-package-auto-autoloads late-package-load-path)
          (packages-load-package-auto-autoloads last-package-load-path)))
 
-    (unwind-protect
-       (command-line)
-      ;; Do this again, in case .emacs defined more abbreviations.
+    (let (error-data)
+      (condition-case data
+         (command-line)
+       ;; catch non-error signals, especially quit
+       (t (setq error-data data)))
+      ;; Do this again, in case the init file defined more abbreviations.
       (setq default-directory (abbreviate-file-name default-directory))
       ;; Specify the file for recording all the auto save files of
       ;; this session.  This is used by recover-session.
-      (setq auto-save-list-file-name
-           (expand-file-name
-            (format "%s%d-%s"
-                    auto-save-list-file-prefix
-                    (emacs-pid)
-                    (system-name))))
+      (if auto-save-list-file-prefix
+         (setq auto-save-list-file-name
+               (expand-file-name
+                (format "%s%d-%s"
+                        auto-save-list-file-prefix
+                        (emacs-pid)
+                        (system-name)))))
       (run-hooks 'emacs-startup-hook)
       (and term-setup-hook
           (run-hooks 'term-setup-hook))
       (setq term-setup-hook nil)
-      ;;      ;; Modify the initial frame based on what .emacs puts into
+      ;;      ;; Modify the initial frame based on what the init file puts into
       ;;      ;; ...-frame-alist.
       (frame-notice-user-settings)
       ;;      ;;####FSFmacs junk
@@ -446,25 +467,18 @@ Type ^H^H^H (Control-h Control-h Control-h) to get more help options.\n")
       ;;         (font-menu-add-default))
       (when window-setup-hook
        (run-hooks 'window-setup-hook))
-      (setq window-setup-hook nil))
-    ;;####FSFmacs junk
-    ;;      (or menubar-bindings-done
-    ;;   (precompute-menubar-bindings))
+      (setq window-setup-hook nil)
+      (if error-data
+         ;; re-signal, and don't allow continuation as that will probably
+          ;; wipe out the user's .emacs if she hasn't migrated yet!
+         (signal-error (car error-data) (cdr error-data))))
+
+    (if load-user-init-file-p
+       (maybe-migrate-user-init-file))
+    ;; FSF calls precompute-menubar-bindings.  We don't mix menubars
+    ;; and keymaps.
     ))
 
-;;####FSFmacs junk
-;;; Precompute the keyboard equivalents in the menu bar items.
-;;(defun precompute-menubar-bindings ()
-;;  (if (eq window-system 'x)
-;;      (let ((submap (lookup-key global-map [menu-bar])))
-;;     (while submap
-;;       (and (consp (car submap))
-;;            (symbolp (car (car submap)))
-;;            (stringp (car-safe (cdr (car submap))))
-;;            (keymapp (cdr (cdr (car submap))))
-;;            (x-popup-menu nil (cdr (cdr (car submap)))))
-;;       (setq submap (cdr submap))))))
-
 (defun command-line-early (args)
   ;; This processes those switches which need to be processed before
   ;; starting up the window system.
@@ -530,10 +544,13 @@ Type ^H^H^H (Control-h Control-h Control-h) to get more help options.\n")
            (string= arg "-user"))
        (let* ((user (pop args))
               (home-user (concat "~" user)))
-         (setq user-init-file (find-user-init-file home-user)
-               user-init-directory (file-name-as-directory
+         (setq user-init-directory (file-name-as-directory
                                     (paths-construct-path
-                                     (list home-user user-init-directory-base))))))
+                                     (list home-user user-init-directory-base))))
+         (setq user-init-file
+               (find-user-init-file user-init-directory home-user))
+         (setq custom-file
+               (make-custom-file-name user-init-file))))
        ((string= arg "-debug-init")
        (setq init-file-debug t))
        ((string= arg "-unmapped")
@@ -546,6 +563,7 @@ Type ^H^H^H (Control-h Control-h Control-h) to get more help options.\n")
          (push (pop args) new-args)))
        (t (push arg new-args))))
 
+    ;; obsolete, initialize for backward compatibility
     (setq init-file-user (and load-user-init-file-p ""))
 
     (nreverse new-args)))
@@ -572,6 +590,9 @@ If this is nil, no message will be displayed.")
       ;; handled here instead of down in C.
       (setq command-line-args-left (command-line-early command-line-args-left))
 
+      (when (eq system-type 'windows-nt)
+       (init-mswindows-at-startup))
+
       ;; Setup the toolbar icon directory
       (when (featurep 'toolbar)
        (init-toolbar-location))
@@ -637,20 +658,169 @@ If this is nil, no message will be displayed.")
            (setq term (substring term 0 hyphend))
          (setq term nil))))))
 
-(defun find-user-init-file (&optional directory)
+(defun find-user-init-directory-init-file (&optional init-directory)
+  "Determine the user's init file if in the init directory."
+  (let ((init-directory (or init-directory user-init-directory)))
+    (catch 'found
+      (dolist (file user-init-file-base-list)
+       (let ((expanded (expand-file-name file init-directory)))
+         (when (file-readable-p expanded)
+           (throw 'found expanded)))))))
+
+(defun find-user-home-directory-init-file (&optional home-directory)
+  "Determine the user's init file if in the home directory."
+  (let ((home-directory (or home-directory "~")))
+    (catch 'found
+      (dolist (file user-home-init-file-base-list)
+       (let ((expanded (expand-file-name file home-directory)))
+         (when (file-readable-p expanded)
+           (throw 'found expanded))))
+      nil)))
+
+(defun find-user-init-file (&optional init-directory home-directory)
   "Determine the user's init file."
-  (unless directory
-    (setq directory "~"))
-  (dolist (file user-init-file-base-list)
-    (let ((expanded (paths-construct-path (list directory file))))
-      (when (file-exists-p expanded)
-       (return expanded)))))
+  (if load-home-init-file
+      (find-user-home-directory-init-file home-directory)
+    (or (find-user-init-directory-init-file init-directory)
+       (find-user-home-directory-init-file home-directory))))
+
+(defun maybe-migrate-user-init-file ()
+  "Ask user if she wants to migrate the init file(s) to new location."
+  (if (and (not load-home-init-file)
+          (not (find-user-init-directory-init-file user-init-directory))
+          (stringp user-init-file)
+          (file-readable-p user-init-file))
+      (if (with-output-to-temp-buffer (help-buffer-name nil)
+           (progn
+             (princ "XEmacs recommends that the initialization code in
+")
+             (princ user-init-file)
+             (princ "
+be migrated to the ")
+             (princ user-init-directory)
+             (princ " directory.  XEmacs can
+perform the migration automatically.
+
+After the migration, init.el/init.elc holds user-written
+initialization code.  Moreover the customize settings will be in
+custom.el.
+
+You can undo the migration at any time with
+M-x maybe-unmigrate-user-init-file.
+
+If you choose not to do this now, XEmacs will not ask you this
+question in the future.  However, you can still make XEmacs
+perform the migration at any time with M-x migrate-user-init-file.")
+             (show-temp-buffer-in-current-frame standard-output)
+             (yes-or-no-p-minibuf (concat "Migrate init file to "
+                                          user-init-directory
+                                          "? "))))
+
+         (let ((backup (migrate-user-init-file)))
+           (with-output-to-temp-buffer (help-buffer-name nil)
+             (progn
+             (princ "The initialization code has now been migrated to the ")
+             (princ user-init-directory)
+             (princ "directory.
+
+For backwards compatibility with, for example, older versions of XEmacs,
+XEmacs can create a special old-style .emacs file in your home
+directory which will load the relocated initialization code.")
+             (if backup
+                 (progn
+                   (princ "\nMoreover, a backup of your old .emacs file was created as\n")
+                   (princ backup)
+                   (princ ".\n")))
+             (show-temp-buffer-in-current-frame standard-output)
+             (maybe-create-compatibility-dot-emacs))))
+       (customize-save-variable 'load-home-init-file t))))
+
+(defun maybe-create-compatibility-dot-emacs ()
+  "Ask user if she wants to create a .emacs compatibility file."
+  (if (yes-or-no-p-minibuf "Create compatibility .emacs? ")
+      (create-compatibility-dot-emacs)))
+
+(defun migrate-user-init-file ()
+  "Migrate the init file from the home directory.
+Return the name of backup file, if one was created."
+  (interactive)
+  (if (not (file-exists-p user-init-directory))
+      (progn
+       (message "Creating %s directory..." user-init-directory)
+       (make-directory user-init-directory)))
+  (message "Migrating custom file...")
+  (let* ((backup (concat user-init-file ".backup"))
+        (backup-p
+         (and (not (file-exists-p backup))
+              (progn
+                (copy-file user-init-file backup)
+                t))))
+    (customize-set-value 'load-home-init-file nil)
+    (custom-migrate-custom-file (make-custom-file-name user-init-file
+                                                      'force-new))
+    (message "Moving init file...")
+    (let ((new-user-init-file (expand-file-name user-init-file-base
+                                               user-init-directory)))
+      (rename-file user-init-file new-user-init-file)
+      (setq user-init-file new-user-init-file))
+    (message "Migration done.")
+    (and backup-p backup)))
+
+(defun create-compatibility-dot-emacs ()
+  "Create .emacs compatibility file for migrated setup."
+  (message "Creating .emacs compatibility file.")
+  (with-temp-file (expand-file-name ".emacs" "~")
+    (insert ";;; XEmacs backwards compatibility file\n")
+    (insert "(setq user-init-file\n")
+    (insert "      (expand-file-name \"init.el\"\n")
+    (insert "                  (expand-file-name \".xemacs\" \"~\")))\n")
+    (insert "(setq custom-file\n")
+    (insert "      (expand-file-name \"custom.el\"\n")
+    (insert "                  (expand-file-name \".xemacs\" \"~\")))\n")
+    (insert "\n")
+    (insert "(load-file user-init-file)\n")
+    (insert "(load-file custom-file)"))
+  (message "Created .emacs compatibility file."))
+
+(defun maybe-unmigrate-user-init-file ()
+  "Possibly unmigrate the user's init and custom files."
+  (interactive)
+  (let ((dot-emacs-file-name (expand-file-name ".emacs" "~")))
+    (if (and (not load-home-init-file)
+            (or (not (file-exists-p dot-emacs-file-name))
+                (yes-or-no-p-minibuf (concat "Overwrite " dot-emacs-file-name
+                                             "? "))))
+      (unmigrate-user-init-file dot-emacs-file-name))))
+
+(defun unmigrate-user-init-file (&optional target-file-name)
+  "Unmigrate the user's init and custom files."
+  (interactive)
+  (let ((target-file-name
+        (or target-file-name (expand-file-name ".emacs" "~"))))
+    (rename-file user-init-file target-file-name 'ok-if-already-exists)
+    (setq user-init-file target-file-name)
+    (let ((old-custom-file custom-file))
+      (custom-migrate-custom-file target-file-name)
+      (customize-save-variable 'load-home-init-file t)
+      (delete-file old-custom-file))))
 
 (defun load-user-init-file ()
-  "This function actually reads the init file, .emacs."
-  (if (or user-init-file
-          (setq user-init-file (find-user-init-file)))
+  "This function actually reads the init file."
+  (if (not user-init-file)
+      (setq user-init-file
+           (find-user-init-file user-init-directory)))
+  (if (not custom-file)
+      (setq custom-file (make-custom-file-name user-init-file)))
+  ;; #### should test load-user-init-file-p here, not in load-init-file
+  ;; see comment there
+  (if (and user-init-file
+          (file-readable-p user-init-file))
       (load user-init-file t t t))
+  (if (and custom-file
+          (or (not user-init-file)
+              (not (string= custom-file user-init-file)))
+          (file-readable-p custom-file))
+      (load custom-file t t t))
   (unless inhibit-default-init
     (let ((inhibit-startup-message nil))
       ;; Users are supposed to be told their rights.
@@ -677,11 +847,15 @@ If this is nil, no message will be displayed.")
        (debug-on-error-initial
         (if (eq init-file-debug t) 'startup init-file-debug)))
     (let ((debug-on-error debug-on-error-initial))
+      ;; #### I believe this test is incorrect, it leads to custom-file
+      ;; (at least) being undefined
       (if (and load-user-init-file-p init-file-debug)
-         ;; Do this without a condition-case if the user wants to debug.
-         (load-user-init-file)
+         (progn
+           ;; Do this without a condition-case if the user wants to debug.
+           (load-user-init-file))
        (condition-case error
            (progn
+             ;; #### probably incorrect, see comment above
              (if load-user-init-file-p
                  (load-user-init-file))
              (setq init-file-had-error nil))
@@ -970,11 +1144,13 @@ XEmacs, by either running the command `xemacs-mule', or by using the X resource
       ": how to get the latest version\n")
      "\n--\n"
      (face italic "\
-Copyright (C) 1985-1999 Free Software Foundation, Inc.
+Copyright (C) 1985-2001 Free Software Foundation, Inc.
 Copyright (C) 1990-1994 Lucid, Inc.
 Copyright (C) 1993-1997 Sun Microsystems, Inc. All Rights Reserved.
 Copyright (C) 1994-1996 Board of Trustees, University of Illinois
-Copyright (C) 1995-1996 Ben Wing\n"))
+Copyright (C) 1995-2001 Ben Wing
+Copyright (C) 1996-2002 MORIOKA Tomohiko
+"))
 
     ((face (blue bold underline) "\nInformation, on-line help:\n\n")
      "XEmacs comes with plenty of documentation...\n\n"
@@ -996,7 +1172,7 @@ Copyright (C) 1995-1996 Ben Wing\n"))
      ((key about-xemacs) ": see who's developing XEmacs\n"))
 
     ((face (blue bold underline) "\nUseful stuff:\n\n")
-     "Things that you should know rather quickly...\n\n"
+     "Things that you should learn rather quickly...\n\n"
      ((key find-file) ": visit a file\n")
      ((key save-buffer) ": save changes\n")
      ((key advertised-undo) ": undo changes\n")
@@ -1122,6 +1298,28 @@ It's idempotent, so call this as often as you like!"
       (princ (format "lisp-directory:\n%S\n" lisp-directory)
             'external-debugging-output))
 
+  (if (featurep 'mule)
+      (progn
+       (setq mule-lisp-directory
+             (paths-find-mule-lisp-directory roots
+                                             lisp-directory))
+       (if debug-paths
+           (princ (format "mule-lisp-directory:\n%S\n"
+                          mule-lisp-directory)
+                  'external-debugging-output)))
+    (setq mule-lisp-directory '()))
+
+  (if (featurep 'utf-2000)
+      (progn
+       (setq utf-2000-lisp-directory
+             (paths-find-utf-2000-lisp-directory roots
+                                                 lisp-directory))
+       (if debug-paths
+           (princ (format "utf-2000-lisp-directory:\n%S\n"
+                          utf-2000-lisp-directory)
+                  'external-debugging-output)))
+    (setq utf-2000-lisp-directory '()))
+
   (setq site-directory (and (null inhibit-site-lisp)
                            (paths-find-site-lisp-directory roots)))
 
@@ -1134,7 +1332,9 @@ It's idempotent, so call this as often as you like!"
                                             late-package-load-path
                                             last-package-load-path
                                             lisp-directory
-                                            site-directory))
+                                            site-directory
+                                            mule-lisp-directory
+                                            utf-2000-lisp-directory))
 
   (setq Info-directory-list
        (paths-construct-info-path roots
@@ -1201,6 +1401,12 @@ It's idempotent, so call this as often as you like!"
        (erase-buffer)
        (buffer-disable-undo (current-buffer))
        (if (null lisp-directory) (push "lisp-directory" warnings))
+       (if (and (featurep 'mule)
+                (null mule-lisp-directory))
+           (push "mule-lisp-directory" warnings))
+       (if (and (featurep 'utf-2000)
+                (null utf-2000-lisp-directory))
+           (push "utf-2000-lisp-directory" warnings))
        (if (null exec-directory) (push "exec-directory" warnings))
        (if (null data-directory) (push "data-directory" warnings))
        (if (null doc-directory)  (push "doc-directory"  warnings))