lisp/startup.el

   1 ;;; startup.el --- process Emacs shell arguments
   2
   3 ;; Copyright (C) 1985, 1986, 1992 Free Software Foundation, Inc.
   4
   5 ;; Maintainer: FSF
   6 ;; Keywords: internal
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to
  22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  23
  24 ;;; Commentary:
  25
  26 ; These are processed only at the beginning of the argument list.
  27 ; -batch                execute noninteractively (messages go to stdout,
  28 ;                        variable noninteractive set to t)
  29 ;                        This option must be the first in the arglist.
  30 ;                        Processed by `main' in emacs.c -- never seen by lisp
  31 ; -t file               Specify to use file rather than stdin/stdout
  32 ;                        as the terminal.
  33 ;                        This option must be the first in the arglist.
  34 ;                        Processed by `main' in emacs.c -- never seen by lisp
  35 ; -nw                   Inhibit the use of any window-system-specific display
  36 ;                        code; use the current virtual terminal.
  37 ;                        This option must be the first in the arglist.
  38 ;                        Processed by `main' in emacs.c -- never seen by lisp
  39 ; -q                    load no init file
  40 ; -no-init-file         same
  41 ; -u user               load user's init file
  42 ; -user user            same
  43 ; -debug-init           Don't catch errors in init file; let debugger run.
  44
  45 ; These are processed in the order encountered.
  46 ; -f function           execute function
  47 ; -funcall function     same
  48 ; -l file               load file
  49 ; -load file            same
  50 ; -insert file          same
  51 ; file                  visit file
  52 ; -kill                 kill (exit) emacs
  53
  54 ;;; Code:
  55
  56 (setq top-level '(normal-top-level))
  57
  58 (defvar command-line-processed nil "t once command line has been processed")
  59
  60 (defconst inhibit-startup-message nil
  61   "*Non-nil inhibits the initial startup messages.
  62 This is for use in your personal init file, once you are familiar
  63 with the contents of the startup message.")
  64
  65 (defconst inhibit-default-init nil
  66   "*Non-nil inhibits loading the `default' library.")
  67
  68 (defconst command-switch-alist nil
  69   "Alist of command-line switches.
  70 Elements look like (SWITCH-STRING . HANDLER-FUNCTION).
  71 HANDLER-FUNCTION receives switch name as sole arg;
  72 remaining command-line args are in the variable `command-line-args-left'.")
  73
  74 (defvar command-line-functions nil    ;; lrs 7/31/89
  75   "List of functions to process unrecognized command-line arguments.
  76 Each function should access the dynamically bound variables
  77 argi (the current argument) and command-line-args-left (the remaining
  78 arguments).  The function should return non-nil only if it recognizes and
  79 processes argi.  If it does so, it may consume successive arguments by
  80 altering command-line-args-left to remove them.")
  81
  82 (defvar before-init-hook nil
  83   "Functions to call after handling urgent options but before loading init file.
  84 The frame system uses this to open frames to display messages while
  85 Emacs loads the user's initialization file.")
  86
  87 (defvar after-init-hook nil
  88   "Functions to call after loading the init file (`~/.emacs').
  89 The call is not protected by a condition-case, so you can set `debug-on-error'
  90 in `.emacs', and put all the actual code on `after-init-hook'.")
  91
  92 (defvar term-setup-hook nil
  93   "Functions to be called after loading terminal-specific lisp code.
  94 See `run-hooks'.  This variable exists for users to set,
  95 so as to override the definitions made by the terminal-specific file.
  96 Emacs never sets this variable itself.")
  97
  98 (defvar keyboard-type nil
  99   "The brand of keyboard you are using.  This variable is used to define
 100 the proper function and keypad keys for use under X.  It is used in a
 101 fashion analogous to the environment value TERM.")
 102
 103 (defvar window-setup-hook nil
 104   "Function called to initialize window system display.
 105 Emacs calls this after processing the command line arguments and loading
 106 the user's init file.
 107
 108 Users should not set this variable; use term-setup-hook instead.")
 109
 110 (defconst initial-major-mode 'lisp-interaction-mode
 111   "Major mode command symbol to use for the initial *scratch* buffer.")
 112
 113 (defvar init-file-user nil
 114   "Identity of user whose `.emacs' file is or was read.
 115 The value may be the null string or a string containing a user's name.
 116 If the value is a null string, it means that the init file was taken from
 117 the user that originally logged in.
 118
 119 In all cases, `(concat \"~\" init-file-user \"/\")' evaluates to the
 120 directory name of the directory where the `.emacs' file was looked for.")
 121
 122 (defvar site-run-file "site-start"
 123   "File containing site-wide run-time initializations.
 124 This file is loaded at run-time before `~/.emacs'.  It contains inits
 125 that need to be in place for the entire site, but which, due to their
 126 higher incidence of change, don't make sense to load into emacs'
 127 dumped image.  Thus, the run-time load order is: 1. file described in
 128 this variable, if non-nil; 2. `~/.emacs'; 3. `default.el'.")
 129
 130 (defvar init-file-debug nil)
 131
 132 (defvar init-file-had-error nil)
 133
 134 (defun normal-top-level ()
 135   (if command-line-processed
 136       (message "Back to top level.")
 137     (setq command-line-processed t)
 138     (if (not (eq system-type 'vax-vms))
 139         (progn
 140           ;; If the PWD environment variable isn't accurate, delete it.
 141           (let ((pwd (getenv "PWD")))
 142             (and (stringp pwd)
 143                  ;; Use FOO/., so that if FOO is a symlink, file-attributes
 144                  ;; describes the directory linked to, not FOO itself.
 145                  (or (equal (file-attributes
 146                              (concat (file-name-as-directory pwd) "."))
 147                             (file-attributes
 148                              (concat (file-name-as-directory default-directory)
 149                                      ".")))
 150                      (setq process-environment
 151                            (delete (concat "PWD=" pwd)
 152                                    process-environment)))))))
 153     (setq default-directory (abbreviate-file-name default-directory))
 154     (unwind-protect
 155         (command-line)
 156       ;; Do this again, in case .emacs defined more abbreviations.
 157       (setq default-directory (abbreviate-file-name default-directory))
 158       (run-hooks 'emacs-startup-hook)
 159       (and term-setup-hook
 160            (run-hooks 'term-setup-hook))
 161       ;; Modify the initial frame based on what .emacs puts into
 162       ;; ...-frame-alist.
 163       (if (fboundp 'frame-notice-user-settings)
 164           (frame-notice-user-settings))
 165       ;; Now we know the user's default font, so add it to the menu.
 166       (if (fboundp 'font-menu-add-default)
 167           (font-menu-add-default))
 168       (and window-setup-hook
 169            (run-hooks 'window-setup-hook)))))
 170
 171 (defun command-line ()
 172   ;; See if we should import version-control from the environment variable.
 173   (let ((vc (getenv "VERSION_CONTROL")))
 174     (cond ((eq vc nil))                 ;don't do anything if not set
 175           ((or (string= vc "t")
 176                (string= vc "numbered"))
 177            (setq version-control t))
 178           ((or (string= vc "nil")
 179                (string= vc "existing"))
 180            (setq version-control nil))
 181           ((or (string= vc "never")
 182                (string= vc "simple"))
 183            (setq version-control 'never))))
 184
 185   ;;! This has been commented out; I currently find the behavior when
 186   ;;! split-window-keep-point is nil disturbing, but if I can get used
 187   ;;! to it, then it would be better to eliminate the option.
 188   ;;! ;; Choose a good default value for split-window-keep-point.
 189   ;;! (setq split-window-keep-point (> baud-rate 2400))
 190
 191   ;; Read window system's init file if using a window system.
 192   (if (and window-system (not noninteractive))
 193       (load (concat term-file-prefix
 194                     (symbol-name window-system)
 195                     "-win")
 196             ;; Every window system should have a startup file;
 197             ;; barf if we can't find it.
 198             nil t))
 199
 200   (let ((done nil)
 201         (args (cdr command-line-args)))
 202
 203     ;; Figure out which user's init file to load,
 204     ;; either from the environment or from the options.
 205     (setq init-file-user (if noninteractive nil (user-login-name)))
 206     ;; If user has not done su, use current $HOME to find .emacs.
 207     (and init-file-user (string= init-file-user (user-real-login-name))
 208          (setq init-file-user ""))
 209
 210     ;; Process the command-line args, and delete the arguments
 211     ;; processed.  This is consistent with the way main in emacs.c
 212     ;; does things.
 213     (while (and (not done) args)
 214       (let ((argi (car args)))
 215         (cond
 216          ((or (string-equal argi "-q")
 217               (string-equal argi "-no-init-file"))
 218           (setq init-file-user nil
 219                 args (cdr args)))
 220          ((or (string-equal argi "-u")
 221               (string-equal argi "-user"))
 222           (setq args (cdr args)
 223                 init-file-user (car args)
 224                 args (cdr args)))
 225          ((string-equal argi "-no-site-file")
 226           (setq site-run-file nil
 227                 args (cdr args)))
 228          ((string-equal argi "-debug-init")
 229           (setq init-file-debug t
 230                 args (cdr args)))
 231          (t (setq done t)))))
 232
 233     ;; Re-attach the program name to the front of the arg list.
 234     (setcdr command-line-args args))
 235
 236   ;; Under X Windows, this creates the X frame and deletes the terminal frame.
 237   (if (fboundp 'frame-initialize)
 238       (frame-initialize))
 239   (if (fboundp 'face-initialize)
 240       (face-initialize))
 241
 242   (run-hooks 'before-init-hook)
 243
 244   ;; Run the site-start library if it exists.  The point of this file is
 245   ;; that it is run before .emacs.  There is no point in doing this after
 246   ;; .emacs; that is useless.
 247   (if site-run-file
 248       (load site-run-file t t))
 249
 250   ;; Sites should not disable this.  Only individuals should disable
 251   ;; the startup message.
 252   (setq inhibit-startup-message nil)
 253
 254   ;; Load that user's init file, or the default one, or none.
 255   (let (debug-on-error-from-init-file
 256         debug-on-error-should-be-set
 257         (debug-on-error-initial
 258          (if (eq init-file-debug t) 'startup init-file-debug)))
 259     (let ((debug-on-error debug-on-error-initial)
 260           ;; This function actually reads the init files.
 261           (inner
 262            (function
 263             (lambda ()
 264               (if init-file-user
 265                   (progn
 266                     (setq user-init-file
 267                           (cond
 268                            ((eq system-type 'ms-dos)
 269                             (concat "~" init-file-user "/_emacs"))
 270                            ((eq system-type 'vax-vms)
 271                             "sys$login:.emacs")
 272                            (t
 273                             (concat "~" init-file-user "/.emacs"))))
 274                     (load user-init-file t t t)
 275                     (or inhibit-default-init
 276                         (let ((inhibit-startup-message nil))
 277                           ;; Users are supposed to be told their rights.
 278                           ;; (Plus how to get help and how to undo.)
 279                           ;; Don't you dare turn this off for anyone
 280                           ;; except yourself.
 281                           (load "default" t t)))))))))
 282       (if init-file-debug
 283           ;; Do this without a condition-case if the user wants to debug.
 284           (funcall inner)
 285         (condition-case error
 286             (progn
 287               (funcall inner)
 288               (setq init-file-had-error nil))
 289           (error (message "Error in init file: %s%s%s"
 290                           (get (car error) 'error-message)
 291                           (if (cdr error) ": ")
 292                           (mapconcat 'prin1-to-string (cdr error) ", "))
 293                  (setq init-file-had-error t))))
 294       ;; If we can tell that the init file altered debug-on-error.,
 295       ;; arrange to preserve the value that it set up.
 296       (or (eq debug-on-error debug-on-error-initial)
 297           (setq debug-on-error-should-be-set t
 298                 debug-on-error-from-init-file debug-on-error)))
 299     (if debug-on-error-should-be-set
 300         (setq debug-on-error debug-on-error-from-init-file)))
 301
 302   (run-hooks 'after-init-hook)
 303
 304   ;; If *scratch* exists and init file didn't change its mode, initialize it.
 305   (if (get-buffer "*scratch*")
 306       (save-excursion
 307         (set-buffer "*scratch*")
 308         (if (eq major-mode 'fundamental-mode)
 309             (funcall initial-major-mode))))
 310   ;; Load library for our terminal type.
 311   ;; User init file can set term-file-prefix to nil to prevent this.
 312   (and term-file-prefix (not noninteractive) (not window-system)
 313        (let ((term (getenv "TERM"))
 314              hyphend)
 315          (while (and term
 316                      (not (load (concat term-file-prefix term) t t)))
 317            ;; Strip off last hyphen and what follows, then try again
 318            (if (setq hyphend (string-match "[-_][^-_]+$" term))
 319                (setq term (substring term 0 hyphend))
 320              (setq term nil)))))
 321
 322   ;; Process the remaining args.
 323   (command-line-1 (cdr command-line-args))
 324
 325   ;; If -batch, terminate after processing the command options.
 326   (if noninteractive (kill-emacs t)))
 327
 328 (defun command-line-1 (command-line-args-left)
 329   (or noninteractive (input-pending-p) init-file-had-error
 330       (if (eq (key-binding "\C-h\C-p") 'describe-project)
 331           (message "For more about the GNU Project, of which GNU Emacs is part, type C-h C-p.")))
 332   (if (null command-line-args-left)
 333       (cond ((and (not inhibit-startup-message) (not noninteractive)
 334                   ;; Don't clobber a non-scratch buffer if init file
 335                   ;; has selected it.
 336                   (string= (buffer-name) "*scratch*")
 337                   (not (input-pending-p)))
 338              ;; If there are no switches to process, we might as well
 339              ;; run this hook now, and there may be some need to do it
 340              ;; before doing any output.
 341              (and term-setup-hook
 342                   (run-hooks 'term-setup-hook))
 343              ;; Don't let the hook be run twice.
 344              (setq term-setup-hook nil)
 345
 346              ;; It's important to notice the user settings before we
 347              ;; display the startup message; otherwise, the settings
 348              ;; won't take effect until the user gives the first
 349              ;; keystroke, and that's distracting.
 350              (if (fboundp 'frame-notice-user-settings)
 351                  (frame-notice-user-settings))
 352
 353              (and window-setup-hook
 354                   (run-hooks 'window-setup-hook))
 355              (setq window-setup-hook nil)
 356              (unwind-protect
 357                  (progn
 358                    (insert (emacs-version)
 359                            "
 360 Copyright (C) 1993 Free Software Foundation, Inc.\n\n")
 361                    ;; If keys have their default meanings,
 362                    ;; use precomputed string to save lots of time.
 363                    (if (and (eq (key-binding "\C-h") 'help-command)
 364                             (eq (key-binding "\C-xu") 'advertised-undo)
 365                             (eq (key-binding "\C-x\C-c") 'save-buffers-kill-emacs)
 366                             (eq (key-binding "\C-h\C-c") 'describe-copying)
 367                             (eq (key-binding "\C-h\C-d") 'describe-distribution)
 368                             (eq (key-binding "\C-h\C-w") 'describe-no-warranty)
 369                             (eq (key-binding "\C-ht") 'help-with-tutorial))
 370                        (insert
 371        "Type C-h for help; C-x u to undo changes.  (`C-' means use CTRL key.)
 372 To kill the Emacs job, type C-x C-c.
 373 Type C-h t for a tutorial on using Emacs.
 374 Type C-h i to enter Info, which you can use to read GNU documentation.
 375
 376 GNU Emacs comes with ABSOLUTELY NO WARRANTY; type C-h C-w for full details.
 377 You may give out copies of Emacs; type C-h C-c to see the conditions.
 378 Type C-h C-d for information on getting the latest version.")
 379                      (insert (substitute-command-keys
 380        "Type \\[help-command] for help; \\[advertised-undo] to undo changes.  (`C-' means use CTRL key.)
 381 To kill the Emacs job, type \\[save-buffers-kill-emacs].
 382 Type \\[help-with-tutorial] for a tutorial on using Emacs.
 383 Type \\[info] to enter Info, which you can use to read GNU documentation.
 384
 385 GNU Emacs comes with ABSOLUTELY NO WARRANTY; type \\[describe-no-warranty] for full details.
 386 You may give out copies of Emacs; type \\[describe-copying] to see the conditions.
 387 Type \\[describe-distribution] for information on getting the latest version.")))
 388                    (set-buffer-modified-p nil)
 389                    (sit-for 120))
 390                (save-excursion
 391                  ;; In case the Emacs server has already selected
 392                  ;; another buffer, erase the one our message is in.
 393                  (set-buffer (get-buffer "*scratch*"))
 394                  (erase-buffer)
 395                  (set-buffer-modified-p nil)))))
 396     (let ((dir default-directory)
 397           (file-count 0)
 398           first-file-buffer
 399           (line 0))
 400       (while command-line-args-left
 401         (let ((argi (car command-line-args-left))
 402               tem)
 403           (setq command-line-args-left (cdr command-line-args-left))
 404           (cond ((setq tem (assoc argi command-switch-alist))
 405                  (funcall (cdr tem) argi))
 406                 ((or (string-equal argi "-f")  ;what the manual claims
 407                      (string-equal argi "-funcall")
 408                      (string-equal argi "-e")) ; what the source used to say
 409                  (setq tem (intern (car command-line-args-left)))
 410                  (setq command-line-args-left (cdr command-line-args-left))
 411                  (funcall tem))
 412                 ((or (string-equal argi "-l")
 413                      (string-equal argi "-load"))
 414                  (let ((file (car command-line-args-left)))
 415                    ;; Take file from default dir if it exists there;
 416                    ;; otherwise let `load' search for it.
 417                    (if (file-exists-p (expand-file-name file))
 418                        (setq file (expand-file-name file)))
 419                    (load file nil t))
 420                  (setq command-line-args-left (cdr command-line-args-left)))
 421                 ((string-equal argi "-insert")
 422                  (or (stringp (car command-line-args-left))
 423                      (error "filename omitted from `-insert' option"))
 424                  (insert-file-contents (car command-line-args-left))
 425                  (setq command-line-args-left (cdr command-line-args-left)))
 426                 ((string-equal argi "-kill")
 427                  (kill-emacs t))
 428                 ((string-match "^\\+[0-9]+\\'" argi)
 429                  (setq line (string-to-int argi)))
 430                 (t
 431                  ;; We have almost exhausted our options. See if the
 432                  ;; user has made any other command-line options available
 433                  (let ((hooks command-line-functions);; lrs 7/31/89
 434                        (did-hook nil))
 435                    (while (and hooks
 436                                (not (setq did-hook (funcall (car hooks)))))
 437                      (setq hooks (cdr hooks)))
 438                    (if (not did-hook)
 439                        ;; Ok, presume that the argument is a file name
 440                        (progn
 441                          (setq file-count (1+ file-count))
 442                          (cond ((= file-count 1)
 443                                 (setq first-file-buffer
 444                                       (find-file (expand-file-name argi dir))))
 445                                (t
 446                                 (find-file-other-window (expand-file-name argi dir))))
 447                          (or (zerop line)
 448                              (goto-line line))
 449                          (setq line 0))))))))
 450       ;; If 3 or more files visited, and not all visible,
 451       ;; show user what they all are.
 452       (if (> file-count 2)
 453           (or (get-buffer-window first-file-buffer)
 454               (progn (other-window 1)
 455                      (buffer-menu)))))))
 456
 457 ;;; startup.el ends here