lisp/startup.el

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