sh-script.el 114 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1
;;; sh-script.el --- shell-script editing commands for Emacs
Erik Naggum's avatar
Erik Naggum committed
2

3
;; Copyright (C) 1993, 94, 95, 96, 97, 1999, 2001, 2003
4
;;  Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5

Karl Heuer's avatar
Karl Heuer committed
6
;; Author: Daniel Pfeiffer <occitan@esperanto.org>
7
;; Version: 2.0f
Richard M. Stallman's avatar
Richard M. Stallman committed
8
;; Maintainer: FSF
9
;; Keywords: languages, unix
Richard M. Stallman's avatar
Richard M. Stallman committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
24 25 26
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
27 28 29

;;; Commentary:

30 31 32 33 34
;; Major mode for editing shell scripts.  Bourne, C and rc shells as well
;; as various derivatives are supported and easily derived from.  Structured
;; statements can be inserted with one command or abbrev.  Completion is
;; available for filenames, variables known from the script, the shell and
;; the environment as well as commands.
Richard M. Stallman's avatar
Richard M. Stallman committed
35

36 37
;;; Known Bugs:

38
;; - In Bourne the keyword `in' is not anchored to case, for, select ...
39 40
;; - Variables in `"' strings aren't fontified because there's no way of
;;   syntactically distinguishing those from `'' strings.
41

42 43 44 45
;;		Indentation
;;	 	===========
;; Indentation for rc and es modes is very limited, but for Bourne shells
;; and its derivatives it is quite customizable.
46
;;
47 48
;; The following description applies to sh and derived shells (bash,
;; zsh, ...).
49
;;
50 51 52 53
;; There are various customization variables which allow tailoring to
;; a wide variety of styles.  Most of these variables are named
;; sh-indent-for-XXX and sh-indent-after-XXX.  For example.
;; sh-indent-after-if controls the indenting of a line following
Stefan Monnier's avatar
Stefan Monnier committed
54
;; an if statement, and sh-indent-for-fi controls the indentation
55
;; of the line containing the fi.
56
;;
57 58 59 60
;; You can set each to a numeric value, but it is often more convenient
;; to a symbol such as `+' which uses the value of variable `sh-basic-offset'.
;; By changing this one variable you can increase or decrease how much
;; indentation there is.  Valid symbols:
61
;;
62 63 64 65 66 67
;; 	+   Indent right by sh-basic-offset
;; 	-   Indent left  by sh-basic-offset
;; 	++  Indent right twice sh-basic-offset
;; 	--  Indent left  twice sh-basic-offset
;; 	*   Indent right half sh-basic-offset
;; 	/   Indent left  half sh-basic-offset.
68
;;
69
;; There are 4 commands to help set the indentation variables:
70
;;
71 72 73
;; `sh-show-indent'
;;    This shows what variable controls the indentation of the current
;;    line and its value.
74
;;
75 76 77 78 79 80 81
;; `sh-set-indent'
;;    This allows you to set the value of the variable controlling the
;;    current line's indentation.  You can enter a number or one of a
;;    number of special symbols to denote the value of sh-basic-offset,
;;    or its negative, or half it, or twice it, etc.  If you've used
;;    cc-mode this should be familiar.  If you forget which symbols are
;;    valid simply press C-h at the prompt.
82
;;
83 84 85 86 87
;; `sh-learn-line-indent'
;;    Simply make the line look the way you want it, then invoke this
;;    command.  It will set the variable to the value that makes the line
;;    indent like that.  If called with a prefix argument then it will set
;;    the value to one of the symbols if applicable.
88
;;
89 90 91 92 93 94 95 96 97 98 99 100
;; `sh-learn-buffer-indent'
;;    This is the deluxe function!  It "learns" the whole buffer (use
;;    narrowing if you want it to process only part).  It outputs to a
;;    buffer *indent* any conflicts it finds, and all the variables it has
;;    learned.  This buffer is a sort of Occur mode buffer, allowing you to
;;    easily find where something was set.  It is popped to automatically
;;    if there are any conflicts found or if `sh-popup-occur-buffer' is
;;    non-nil.
;;    `sh-indent-comment' will be set if all comments follow  the same
;;    pattern;  if they don't it will be set to nil.
;;    Whether `sh-basic-offset' is set is determined by variable
;;    `sh-learn-basic-offset'.
101
;;
102 103 104 105 106 107 108
;;    Unfortunately, `sh-learn-buffer-indent' can take a long time to run
;;    (e.g. if there are large case statements).  Perhaps it does not make
;;    sense to run it on large buffers: if lots of lines have different
;;    indentation styles it will produce a lot of diagnostics in the
;;    *indent* buffer; if there is a consistent style then running
;;    `sh-learn-buffer-indent' on a small region of the buffer should
;;    suffice.
109
;;
110 111 112 113 114 115 116
;; 	Saving indentation values
;; 	-------------------------
;; After you've learned the values in a buffer, how to you remember
;; them?   Originally I had hoped that `sh-learn-buffer-indent'
;; would make this unnecessary;  simply learn the values when you visit
;; the buffer.
;; You can do this automatically like this:
117
;;   (add-hook 'sh-set-shell-hook 'sh-learn-buffer-indent)
118
;;
119
;; However...  `sh-learn-buffer-indent' is extremely slow,
Stefan Monnier's avatar
Stefan Monnier committed
120
;; especially on large-ish buffer.  Also, if there are conflicts the
121
;; "last one wins" which may not produce the desired setting.
122
;;
123 124
;; So...There is a minimal way of being able to save indentation values and
;; to reload them in another buffer or at another point in time.
125
;;
126 127 128 129 130 131 132
;; Use `sh-name-style' to give a name to the indentation settings of
;; 	the current buffer.
;; Use `sh-load-style' to load indentation settings for the current
;; 	buffer from a specific style.
;; Use `sh-save-styles-to-buffer' to write all the styles to a buffer
;; 	in lisp code.  You can then store it in a file and later use
;; 	`load-file' to load it.
133
;;
134 135 136 137
;; 	Indentation variables - buffer local or global?
;; 	----------------------------------------------
;; I think that often having them buffer-local makes sense,
;; especially if one is using `sh-learn-buffer-indent'.  However, if
Stefan Monnier's avatar
Stefan Monnier committed
138
;; a user sets values using customization, these changes won't appear
139
;; to work if the variables are already local!
140
;;
Stefan Monnier's avatar
Stefan Monnier committed
141
;; To get round this, there is a variable `sh-make-vars-local' and 2
142
;; functions: `sh-make-vars-local' and `sh-reset-indent-vars-to-global-values'.
143
;;
Stefan Monnier's avatar
Stefan Monnier committed
144
;; If `sh-make-vars-local' is non-nil, then these variables become
145
;; buffer local when the mode is established.
Stefan Monnier's avatar
Stefan Monnier committed
146
;; If this is nil, then the variables are global.  At any time you
147
;; can make them local with the command `sh-make-vars-local'.
Stefan Monnier's avatar
Stefan Monnier committed
148
;; Conversely, to update with the global values you can use the
149
;; command `sh-reset-indent-vars-to-global-values'.
150
;;
Stefan Monnier's avatar
Stefan Monnier committed
151
;; This may be awkward, but the intent is to cover all cases.
152
;;
153 154 155
;; 	Awkward things, pitfalls
;; 	------------------------
;; Indentation for a sh script is complicated for a number of reasons:
156
;;
Stefan Monnier's avatar
Stefan Monnier committed
157
;; 1. You can't format by simply looking at symbols, you need to look
158 159 160 161
;;    at keywords.  [This is not the case for rc and es shells.]
;; 2. The character ")" is used both as a matched pair "(" ... ")" and
;;    as a stand-alone symbol (in a case alternative).  This makes
;;    things quite tricky!
Stefan Monnier's avatar
Stefan Monnier committed
162
;; 3. Here-documents in a script should be treated "as is", and when
163 164 165 166 167
;;    they terminate we want to revert to the indentation of the line
;;    containing the "<<" symbol.
;; 4. A line may be continued using the "\".
;; 5. The character "#" (outside a string) normally starts a comment,
;;    but it doesn't in the sequence "$#"!
168
;;
169
;; To try and address points 2 3 and 5 I used a feature that cperl mode
Stefan Monnier's avatar
Stefan Monnier committed
170
;; uses, that of a text's syntax property.  This, however, has 2
171 172 173 174 175 176 177
;; disadvantages:
;; 1. We need to scan the buffer to find which ")" symbols belong to a
;;    case alternative, to find any here documents, and handle "$#".
;; 2. Setting the text property makes the buffer modified.  If the
;;    buffer is read-only buffer we have to cheat and bypass the read-only
;;    status.  This is for cases where the buffer started read-only buffer
;;    but the user issued `toggle-read-only'.
178
;;
179 180 181 182
;; 	Bugs
;; 	----
;; - Indenting many lines is slow.  It currently does each line
;;   independently, rather than saving state information.
183
;;
184
;; - `sh-learn-buffer-indent' is extremely slow.
185
;;
186 187
;; Richard Sharman <rsharman@pobox.com>  June 1999.

Richard M. Stallman's avatar
Richard M. Stallman committed
188 189 190
;;; Code:

;; page 1:	variables and settings
191 192 193 194
;; page 2:	indentation stuff
;; page 3:	mode-command and utility functions
;; page 4:	statement syntax-commands for various shells
;; page 5:	various other commands
Richard M. Stallman's avatar
Richard M. Stallman committed
195

Dave Love's avatar
Dave Love committed
196 197
(eval-when-compile
  (require 'skeleton)
198
  (require 'cl)
Dave Love's avatar
Dave Love committed
199
  (require 'comint))
200 201
(require 'executable)

202 203


204 205 206 207 208 209 210 211 212 213 214 215
(defgroup sh nil
  "Shell programming utilities"
  :group 'unix
  :group 'languages)

(defgroup sh-script nil
  "Shell script mode"
  :group 'sh
  :prefix "sh-")


(defcustom sh-ancestor-alist
216 217
  '((ash . sh)
    (bash . jsh)
218
    (bash2 . jsh)
219 220 221 222 223 224 225 226 227 228 229 230 231
    (dtksh . ksh)
    (es . rc)
    (itcsh . tcsh)
    (jcsh . csh)
    (jsh . sh)
    (ksh . ksh88)
    (ksh88 . jsh)
    (oash . sh)
    (pdksh . ksh88)
    (posix . sh)
    (tcsh . csh)
    (wksh . ksh88)
    (wsh . sh)
232 233
    (zsh . ksh88)
    (rpm . sh))
234 235 236 237 238 239
  "*Alist showing the direct ancestor of various shells.
This is the basis for `sh-feature'.  See also `sh-alias-alist'.
By default we have the following three hierarchies:

csh		C Shell
  jcsh		C Shell with Job Control
240 241
  tcsh		Turbo C Shell
    itcsh	? Turbo C Shell
242 243 244 245 246 247 248 249 250 251 252 253 254 255
rc		Plan 9 Shell
  es		Extensible Shell
sh		Bourne Shell
  ash		? Shell
  jsh		Bourne Shell with Job Control
    bash	GNU Bourne Again Shell
    ksh88	Korn Shell '88
      ksh	Korn Shell '93
	dtksh	CDE Desktop Korn Shell
      pdksh	Public Domain Korn Shell
      wksh	Window Korn Shell
      zsh	Z Shell
  oash		SCO OA (curses) Shell
  posix		IEEE 1003.2 Shell Standard
256 257 258
  wsh		? Shell"
  :type '(repeat (cons symbol symbol))
  :group 'sh-script)
259 260


261
(defcustom sh-alias-alist
262
  (append (if (eq system-type 'gnu/linux)
263
	     '((csh . tcsh)
264
	       (ksh . pdksh)))
265 266
	 ;; for the time being
	 '((ksh . ksh88)
267
           (bash2 . bash)
268 269 270
	   (sh5 . sh)))
  "*Alist for transforming shell names to what they really are.
Use this where the name of the executable doesn't correspond to the type of
271 272 273
shell it really is."
  :type '(repeat (cons symbol symbol))
  :group 'sh-script)
274 275


276
(defcustom sh-shell-file
277
  (or
278 279
   ;; On MSDOS and Windows, collapse $SHELL to lower-case and remove
   ;; the executable extension, so comparisons with the list of
280
   ;; known shells work.
281
   (and (memq system-type '(ms-dos windows-nt))
282 283 284 285 286 287 288
	(let* ((shell (getenv "SHELL"))
	       (shell-base
		(and shell (file-name-nondirectory shell))))
	  ;; shell-script mode doesn't support DOS/Windows shells,
	  ;; so use the default instead.
	  (if (or (null shell)
		  (member (downcase shell-base)
289 290
			  '("command.com" "cmd.exe" "4dos.com" "ndos.com"
			    "cmdproxy.exe")))
291 292
	      "/bin/sh"
	    (file-name-sans-extension (downcase shell)))))
293 294
   (getenv "SHELL")
   "/bin/sh")
295 296 297
  "*The executable file name for the shell being programmed."
  :type 'string
  :group 'sh-script)
298 299


300
(defcustom sh-shell-arg
301
  ;; bash does not need any options when run in a shell script,
302
  '((bash)
303 304
    (csh . "-f")
    (pdksh)
305
    ;; Bill_Mann@praxisint.com says -p with ksh can do harm.
306
    (ksh88)
307
    ;; -p means don't initialize functions from the environment.
308
    (rc . "-p")
309 310 311 312
    ;; Someone proposed -motif, but we don't want to encourage
    ;; use of a non-free widget set.
    (wksh)
    ;; -f means don't run .zshrc.
313
    (zsh . "-f"))
314 315 316 317 318 319 320 321
  "*Single argument string for the magic number.  See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice (const :tag "No Arguments" nil)
			       (string :tag "Arguments")
			       (cons :format "Evaluate: %v"
				     (const :format "" eval)
				     sexp))))
  :group 'sh-script)
322

323
(defcustom sh-imenu-generic-expression
324 325
  `((sh
     . ((nil "^\\s-*\\(function\\s-+\\)?\\([A-Za-z_][A-Za-z_0-9]+\\)\\s-*()" 2))))
326 327 328 329 330 331 332 333
  "*Alist of regular expressions for recognizing shell function definitions.
See `sh-feature' and `imenu-generic-expression'."
  :type '(alist :key-type (symbol :tag "Shell")
		:value-type (alist :key-type (choice :tag "Title"
						     string
						     (const :tag "None" nil))
				   :value-type
				   (repeat :tag "Regexp, index..." sexp)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
334
  :group 'sh-script
335
  :version "20.4")
336

337 338 339 340 341
(defvar sh-shell-variables nil
  "Alist of shell variable names that should be included in completion.
These are used for completion in addition to all the variables named
in `process-environment'.  Each element looks like (VAR . VAR), where
the car and cdr are the same symbol.")
342

343 344 345
(defvar sh-shell-variables-initialized nil
  "Non-nil if `sh-shell-variables' is initialized.")

346 347
(defun sh-canonicalize-shell (shell)
  "Convert a shell name SHELL to the one we should handle it as."
348
  (if (string-match "\\.exe\\'" shell)
349
      (setq shell (substring shell 0 (match-beginning 0))))
350 351 352 353
  (or (symbolp shell)
      (setq shell (intern shell)))
  (or (cdr (assq shell sh-alias-alist))
      shell))
354

355 356
(defvar sh-shell (sh-canonicalize-shell (file-name-nondirectory sh-shell-file))
  "The shell being programmed.  This is set by \\[sh-set-shell].")
357

358 359 360
;; I turned off this feature because it doesn't permit typing commands
;; in the usual way without help.
;;(defvar sh-abbrevs
361
;;  '((csh sh-abbrevs shell
362 363 364
;;	 "switch" 'sh-case
;;	 "getopts" 'sh-while-getopts)

365
;;    (es sh-abbrevs shell
366 367
;;	"function" 'sh-function)

368
;;    (ksh88 sh-abbrevs sh
369 370
;;	   "select" 'sh-select)

371
;;    (rc sh-abbrevs shell
372 373 374
;;	"case" 'sh-case
;;	"function" 'sh-function)

375
;;    (sh sh-abbrevs shell
376 377 378 379 380 381 382 383 384 385 386 387
;;	"case" 'sh-case
;;	"function" 'sh-function
;;	"until" 'sh-until
;;	"getopts" 'sh-while-getopts)

;;    ;; The next entry is only used for defining the others
;;    (shell "for" sh-for
;;	   "loop" sh-indexed-loop
;;	   "if" sh-if
;;	   "tmpfile" sh-tmp-file
;;	   "while" sh-while)

388
;;    (zsh sh-abbrevs ksh88
389 390
;;	 "repeat" 'sh-repeat))
;;  "Abbrev-table used in Shell-Script mode.  See `sh-feature'.
391 392
;;;Due to the internal workings of abbrev tables, the shell name symbol is
;;;actually defined as the table for the like of \\[edit-abbrevs].")
Richard M. Stallman's avatar
Richard M. Stallman committed
393 394 395



396 397 398 399 400 401 402
(defun sh-mode-syntax-table (table &rest list)
  "Copy TABLE and set syntax for successive CHARs according to strings S."
  (setq table (copy-syntax-table table))
  (while list
    (modify-syntax-entry (pop list) (pop list) table))
  table)

403 404 405 406
(defvar sh-mode-syntax-table nil
  "The syntax table to use for Shell-Script mode.
This is buffer-local in every such buffer.")

407 408
(defvar sh-mode-default-syntax-table
  (sh-mode-syntax-table ()
409 410 411 412 413 414 415 416 417 418 419
	?\# "<"
	?\n ">#"
	?\" "\"\""
	?\' "\"'"
	?\` "\"`"
	?! "_"
	?% "_"
	?: "_"
	?. "_"
	?^ "_"
	?~ "_"
420
	?, "_"
421 422
	?< "."
	?> ".")
423
  "Default syntax table for shell mode.")
424

425 426
(defvar sh-mode-syntax-table-input
  '((sh . nil))
427
  "Syntax-table used in Shell-Script mode.  See `sh-feature'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
428 429

(defvar sh-mode-map
430 431
  (let ((map (make-sparse-keymap))
	(menu-map (make-sparse-keymap "Insert")))
Richard M. Stallman's avatar
Richard M. Stallman committed
432 433 434
    (define-key map "\C-c(" 'sh-function)
    (define-key map "\C-c\C-w" 'sh-while)
    (define-key map "\C-c\C-u" 'sh-until)
435
    (define-key map "\C-c\C-t" 'sh-tmp-file)
Richard M. Stallman's avatar
Richard M. Stallman committed
436
    (define-key map "\C-c\C-s" 'sh-select)
437 438
    (define-key map "\C-c\C-r" 'sh-repeat)
    (define-key map "\C-c\C-o" 'sh-while-getopts)
Richard M. Stallman's avatar
Richard M. Stallman committed
439 440 441 442
    (define-key map "\C-c\C-l" 'sh-indexed-loop)
    (define-key map "\C-c\C-i" 'sh-if)
    (define-key map "\C-c\C-f" 'sh-for)
    (define-key map "\C-c\C-c" 'sh-case)
443 444 445 446
    (define-key map "\C-c?" 'sh-show-indent)
    (define-key map "\C-c=" 'sh-set-indent)
    (define-key map "\C-c<" 'sh-learn-line-indent)
    (define-key map "\C-c>" 'sh-learn-buffer-indent)
447

Richard M. Stallman's avatar
Richard M. Stallman committed
448 449
    (define-key map "=" 'sh-assignment)
    (define-key map "\C-c+" 'sh-add)
450 451
    (define-key map "\C-\M-x" 'sh-execute-region)
    (define-key map "\C-c\C-x" 'executable-interpret)
452
    (define-key map "<" 'sh-maybe-here-document)
453 454 455 456 457 458
    (define-key map "(" 'skeleton-pair-insert-maybe)
    (define-key map "{" 'skeleton-pair-insert-maybe)
    (define-key map "[" 'skeleton-pair-insert-maybe)
    (define-key map "'" 'skeleton-pair-insert-maybe)
    (define-key map "`" 'skeleton-pair-insert-maybe)
    (define-key map "\"" 'skeleton-pair-insert-maybe)
Richard M. Stallman's avatar
Richard M. Stallman committed
459

460 461 462 463
    (define-key map [remap complete-tag] 'comint-dynamic-complete)
    (define-key map [remap newline-and-indent] 'sh-newline-and-indent)
    (define-key map [remap delete-backward-char]
      'backward-delete-char-untabify)
Richard M. Stallman's avatar
Richard M. Stallman committed
464
    (define-key map "\C-c:" 'sh-set-shell)
465 466
    (define-key map [remap backward-sentence] 'sh-beginning-of-command)
    (define-key map [remap forward-sentence] 'sh-end-of-command)
467 468 469 470 471 472
    (define-key map [menu-bar insert] (cons "Insert" menu-map))
    (define-key menu-map [sh-while]	'("While Loop" . sh-while))
    (define-key menu-map [sh-until]	'("Until Loop" . sh-until))
    (define-key menu-map [sh-tmp-file]	'("Temporary File" . sh-tmp-file))
    (define-key menu-map [sh-select]	'("Select Statement" . sh-select))
    (define-key menu-map [sh-repeat]	'("Repeat Loop" . sh-repeat))
473 474
    (define-key menu-map [sh-getopts]	'("Options Loop" . sh-while-getopts))
    (define-key menu-map [sh-indexed-loop] '("Indexed Loop" . sh-indexed-loop))
475 476 477
    (define-key menu-map [sh-if]	'("If Statement" . sh-if))
    (define-key menu-map [sh-for]	'("For Loop" . sh-for))
    (define-key menu-map [sh-case]	'("Case Statement" . sh-case))
Richard M. Stallman's avatar
Richard M. Stallman committed
478 479 480 481 482
    map)
  "Keymap used in Shell-Script mode.")



483
(defcustom sh-dynamic-complete-functions
484 485 486
  '(shell-dynamic-complete-environment-variable
    shell-dynamic-complete-command
    comint-dynamic-complete-filename)
487 488 489
  "*Functions for doing TAB dynamic completion."
  :type '(repeat function)
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
490 491


492
(defcustom sh-require-final-newline
493 494
  '((csh . t)
    (pdksh . t)
495 496
    (rc . require-final-newline)
    (sh . require-final-newline))
497
  "*Value of `require-final-newline' in Shell-Script mode buffers.
498 499 500 501 502 503 504
See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice (const :tag "require" t)
			       (cons :format "Evaluate: %v"
				     (const :format "" eval)
				     sexp))))
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
505 506


507
(defcustom sh-assignment-regexp
508 509 510 511 512 513 514
  '((csh . "\\<\\([a-zA-Z0-9_]+\\)\\(\\[.+\\]\\)?[ \t]*[-+*/%^]?=")
    ;; actually spaces are only supported in let/(( ... ))
    (ksh88 . "\\<\\([a-zA-Z0-9_]+\\)\\(\\[.+\\]\\)?[ \t]*\\([-+*/%&|~^]\\|<<\\|>>\\)?=")
    (rc . "\\<\\([a-zA-Z0-9_*]+\\)[ \t]*=")
    (sh . "\\<\\([a-zA-Z0-9_]+\\)="))
  "*Regexp for the variable name and what may follow in an assignment.
First grouping matches the variable name.  This is upto and including the `='
515 516 517 518 519 520 521
sign.  See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice regexp
			       (cons :format "Evaluate: %v"
				     (const :format "" eval)
				     sexp))))
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
522 523


524 525 526 527
(defcustom sh-indentation 4
  "The width for further indentation in Shell-Script mode."
  :type 'integer
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
528 529


530 531 532 533
(defcustom sh-remember-variable-min 3
  "*Don't remember variables less than this length for completing reads."
  :type 'integer
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
534 535


536
(defvar sh-header-marker nil
537
  "When non-nil is the end of header for prepending by \\[sh-execute-region].
538 539 540
That command is also used for setting this variable.")


541
(defcustom sh-beginning-of-command
542
  "\\([;({`|&]\\|\\`\\|[^\\]\n\\)[ \t]*\\([/~a-zA-Z0-9:]\\)"
Richard M. Stallman's avatar
Richard M. Stallman committed
543
  "*Regexp to determine the beginning of a shell command.
544 545 546
The actual command starts at the beginning of the second \\(grouping\\)."
  :type 'regexp
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
547

548

549
(defcustom sh-end-of-command
550
  "\\([/~a-zA-Z0-9:]\\)[ \t]*\\([;#)}`|&]\\|$\\)"
Richard M. Stallman's avatar
Richard M. Stallman committed
551
  "*Regexp to determine the end of a shell command.
552 553 554
The actual command ends at the end of the first \\(grouping\\)."
  :type 'regexp
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
555 556 557



558
(defvar sh-here-document-word "EOF"
559 560 561 562 563 564 565
  "Word to delimit here documents.
If the first character of this string is \"-\", this character will
be removed from the string when it is used to close the here document.
This convention is used by the Bash shell, for example, to indicate
that leading tabs inside the here document should be ignored.
Note that Emacs currently has no support for indenting inside here
documents - you must insert literal tabs by hand.")
Richard M. Stallman's avatar
Richard M. Stallman committed
566

Karl Heuer's avatar
Karl Heuer committed
567 568 569 570 571
(defvar sh-test
  '((sh "[  ]" . 3)
    (ksh88 "[[  ]]" . 4))
  "Initial input in Bourne if, while and until skeletons.  See `sh-feature'.")

Richard M. Stallman's avatar
Richard M. Stallman committed
572

573 574 575
;; customized this out of sheer bravado.  not for the faint of heart.
;; but it *did* have an asterisk in the docstring!
(defcustom sh-builtins
576
  '((bash sh-append posix
577 578
	  "." "alias" "bg" "bind" "builtin" "compgen" "complete"
          "declare" "dirs" "disown" "enable" "fc" "fg" "help" "history"
579 580
          "jobs" "kill" "let" "local" "popd" "printf" "pushd" "shopt"
          "source" "suspend" "typeset" "unalias")
Richard M. Stallman's avatar
Richard M. Stallman committed
581

582
    ;; The next entry is only used for defining the others
583
    (bourne sh-append shell
584 585
	    "eval" "export" "getopts" "newgrp" "pwd" "read" "readonly"
	    "times" "ulimit")
Richard M. Stallman's avatar
Richard M. Stallman committed
586

587
    (csh sh-append shell
588 589 590
	 "alias" "chdir" "glob" "history" "limit" "nice" "nohup" "rehash"
	 "setenv" "source" "time" "unalias" "unhash")

591
    (dtksh sh-append wksh)
Richard M. Stallman's avatar
Richard M. Stallman committed
592

593 594
    (es "access" "apids" "cd" "echo" "eval" "false" "let" "limit" "local"
	"newpgrp" "result" "time" "umask" "var" "vars" "wait" "whatis")
Richard M. Stallman's avatar
Richard M. Stallman committed
595

596
    (jsh sh-append sh
597
	 "bg" "fg" "jobs" "kill" "stop" "suspend")
Richard M. Stallman's avatar
Richard M. Stallman committed
598

599
    (jcsh sh-append csh
600
	  "bg" "fg" "jobs" "kill" "notify" "stop" "suspend")
601

602
    (ksh88 sh-append bourne
603 604
	   "alias" "bg" "false" "fc" "fg" "jobs" "kill" "let" "print" "time"
	   "typeset" "unalias" "whence")
605

606
    (oash sh-append sh
607 608 609 610 611
	  "checkwin" "dateline" "error" "form" "menu" "newwin" "oadeinit"
	  "oaed" "oahelp" "oainit" "pp" "ppfile" "scan" "scrollok" "wattr"
	  "wclear" "werase" "win" "wmclose" "wmmessage" "wmopen" "wmove"
	  "wmtitle" "wrefresh")

612
    (pdksh sh-append ksh88
613 614
	   "bind")

615
    (posix sh-append sh
616 617
	   "command")

618 619
    (rc "builtin" "cd" "echo" "eval" "limit" "newpgrp" "shift" "umask" "wait"
	"whatis")
620

621
    (sh sh-append bourne
622 623 624
	"hash" "test" "type")

    ;; The next entry is only used for defining the others
625 626
    (shell "cd" "echo" "eval" "set" "shift" "umask" "unset" "wait")

627
    (wksh sh-append ksh88
628
	  "Xt[A-Z][A-Za-z]*")
629

630
    (zsh sh-append ksh88
631 632 633 634 635 636
	 "autoload" "bindkey" "builtin" "chdir" "compctl" "declare" "dirs"
	 "disable" "disown" "echotc" "enable" "functions" "getln" "hash"
	 "history" "integer" "limit" "local" "log" "popd" "pushd" "r"
	 "readonly" "rehash" "sched" "setopt" "source" "suspend" "true"
	 "ttyctl" "type" "unfunction" "unhash" "unlimit" "unsetopt" "vared"
	 "which"))
637 638
  "*List of all shell builtins for completing read and fontification.
Note that on some systems not all builtins are available or some are
639 640 641 642 643 644 645
implemented as aliases.  See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice (repeat string)
			       (cons :format "Evaluate: %v"
				     (const :format "" eval)
				     sexp))))
  :group 'sh-script)
646 647


648

649
(defcustom sh-leading-keywords
650
  '((bash sh-append sh
651 652 653
          "time")

    (csh "else")
654 655 656 657 658 659 660 661 662

    (es "true" "unwind-protect" "whatis")

    (rc "else")

    (sh "do" "elif" "else" "if" "then" "trap" "type" "until" "while"))
  "*List of keywords that may be immediately followed by a builtin or keyword.
Given some confusion between keywords and builtins depending on shell and
system, the distinction here has been based on whether they influence the
663 664 665 666 667 668 669
flow of control or syntax.  See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice (repeat string)
			       (cons :format "Evaluate: %v"
				     (const :format "" eval)
				     sexp))))
  :group 'sh-script)
670 671


672
(defcustom sh-other-keywords
673
  '((bash sh-append bourne
674
	  "bye" "logout" "select")
675 676

    ;; The next entry is only used for defining the others
677
    (bourne sh-append sh
678
	    "function")
679

680
    (csh sh-append shell
681 682
	 "breaksw" "default" "end" "endif" "endsw" "foreach" "goto"
	 "if" "logout" "onintr" "repeat" "switch" "then" "while")
683

684 685
    (es "break" "catch" "exec" "exit" "fn" "for" "forever" "fork" "if"
	"return" "throw" "while")
686

687
    (ksh88 sh-append bourne
688
	   "select")
689

690 691
    (rc "break" "case" "exec" "exit" "fn" "for" "if" "in" "return" "switch"
	"while")
692

693
    (sh sh-append shell
694 695
	"done" "esac" "fi" "for" "in" "return")

696 697
    ;; The next entry is only used for defining the others
    (shell "break" "case" "continue" "exec" "exit")
698

699
    (zsh sh-append bash
700 701
	 "select"))
  "*List of keywords not in `sh-leading-keywords'.
702 703 704 705 706 707 708
See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice (repeat string)
			       (cons :format "Evaluate: %v"
				     (const :format "" eval)
				     sexp))))
  :group 'sh-script)
709 710 711 712



(defvar sh-variables
713
  '((bash sh-append sh
714 715 716 717 718 719 720 721 722 723 724 725 726 727
	  "allow_null_glob_expansion" "auto_resume" "BASH" "BASH_ENV"
	  "BASH_VERSINFO" "BASH_VERSION" "cdable_vars" "COMP_CWORD"
	  "COMP_LINE" "COMP_POINT" "COMP_WORDS" "COMPREPLY" "DIRSTACK"
	  "ENV" "EUID" "FCEDIT" "FIGNORE" "FUNCNAME"
	  "glob_dot_filenames" "GLOBIGNORE" "GROUPS" "histchars"
	  "HISTCMD" "HISTCONTROL" "HISTFILE" "HISTFILESIZE"
	  "HISTIGNORE" "history_control" "HISTSIZE"
	  "hostname_completion_file" "HOSTFILE" "HOSTTYPE" "IGNOREEOF"
	  "ignoreeof" "INPUTRC" "LINENO" "MACHTYPE" "MAIL_WARNING"
	  "noclobber" "nolinks" "notify" "no_exit_on_failed_exec"
	  "NO_PROMPT_VARS" "OLDPWD" "OPTERR" "OSTYPE" "PIPESTATUS"
	  "PPID" "POSIXLY_CORRECT" "PROMPT_COMMAND" "PS3" "PS4"
	  "pushd_silent" "PWD" "RANDOM" "REPLY" "SECONDS" "SHELLOPTS"
	  "SHLVL" "TIMEFORMAT" "TMOUT" "UID")
728

729
    (csh sh-append shell
730 731 732 733
	 "argv" "cdpath" "child" "echo" "histchars" "history" "home"
	 "ignoreeof" "mail" "noclobber" "noglob" "nonomatch" "path" "prompt"
	 "shell" "status" "time" "verbose")

734
    (es sh-append shell
735 736 737
	"apid" "cdpath" "CDPATH" "history" "home" "ifs" "noexport" "path"
	"pid" "prompt" "signals")

738
    (jcsh sh-append csh
739
	  "notify")
740

741
    (ksh88 sh-append sh
742 743 744 745
	   "ENV" "ERRNO" "FCEDIT" "FPATH" "HISTFILE" "HISTSIZE" "LINENO"
	   "OLDPWD" "PPID" "PS3" "PS4" "PWD" "RANDOM" "REPLY" "SECONDS"
	   "TMOUT")

746
    (oash sh-append sh
747 748
	  "FIELD" "FIELD_MAX" "LAST_KEY" "OALIB" "PP_ITEM" "PP_NUM")

749
    (rc sh-append shell
750 751 752
	"apid" "apids" "cdpath" "CDPATH" "history" "home" "ifs" "path" "pid"
	"prompt" "status")

753
    (sh sh-append shell
754 755 756 757 758 759 760 761
	"CDPATH" "IFS" "OPTARG" "OPTIND" "PS1" "PS2")

    ;; The next entry is only used for defining the others
    (shell "COLUMNS" "EDITOR" "HOME" "HUSHLOGIN" "LANG" "LC_COLLATE"
	   "LC_CTYPE" "LC_MESSAGES" "LC_MONETARY" "LC_NUMERIC" "LC_TIME"
	   "LINES" "LOGNAME" "MAIL" "MAILCHECK" "MAILPATH" "PAGER" "PATH"
	   "SHELL" "TERM" "TERMCAP" "TERMINFO" "VISUAL")

762
    (tcsh sh-append csh
763 764 765 766 767 768 769 770 771 772
	  "addsuffix" "ampm" "autocorrect" "autoexpand" "autolist"
	  "autologout" "chase_symlinks" "correct" "dextract" "edit" "el"
	  "fignore" "gid" "histlit" "HOST" "HOSTTYPE" "HPATH"
	  "ignore_symlinks" "listjobs" "listlinks" "listmax" "matchbeep"
	  "nobeep" "NOREBIND" "oid" "printexitvalue" "prompt2" "prompt3"
	  "pushdsilent" "pushdtohome" "recexact" "recognize_only_executables"
	  "rmstar" "savehist" "SHLVL" "showdots" "sl" "SYSTYPE" "tcsh" "term"
	  "tperiod" "tty" "uid" "version" "visiblebell" "watch" "who"
	  "wordchars")

773
    (zsh sh-append ksh88
774 775 776 777 778 779 780 781 782 783
	 "BAUD" "bindcmds" "cdpath" "DIRSTACKSIZE" "fignore" "FIGNORE" "fpath"
	 "HISTCHARS" "hostcmds" "hosts" "HOSTS" "LISTMAX" "LITHISTSIZE"
	 "LOGCHECK" "mailpath" "manpath" "NULLCMD" "optcmds" "path" "POSTEDIT"
	 "prompt" "PROMPT" "PROMPT2" "PROMPT3" "PROMPT4" "psvar" "PSVAR"
	 "READNULLCMD" "REPORTTIME" "RPROMPT" "RPS1" "SAVEHIST" "SPROMPT"
	 "STTY" "TIMEFMT" "TMOUT" "TMPPREFIX" "varcmds" "watch" "WATCH"
	 "WATCHFMT" "WORDCHARS" "ZDOTDIR"))
  "List of all shell variables available for completing read.
See `sh-feature'.")

784

785
;; Font-Lock support
786 787 788 789

(defface sh-heredoc-face
  '((((class color)
      (background dark))
790
     (:foreground "yellow" :weight bold))
791 792 793 794
    (((class color)
      (background light))
     (:foreground "tan" ))
    (t
795
     (:weight bold)))
796 797 798
  "Face to show a here-document"
  :group 'sh-indentation)
(defvar sh-heredoc-face 'sh-heredoc-face)
799 800 801


(defvar sh-font-lock-keywords
802
  '((csh sh-append shell
803 804
	 ("\\${?[#?]?\\([A-Za-z_][A-Za-z0-9_]*\\|0\\)" 1
          font-lock-variable-name-face))
805

806
    (es sh-append executable-font-lock-keywords
807 808
	("\\$#?\\([A-Za-z_][A-Za-z0-9_]*\\|[0-9]+\\)" 1
         font-lock-variable-name-face))
809

810
    (rc sh-append es)
811

812
    (sh sh-append shell
813
	;; Variable names.
814
	("\\$\\({#?\\)?\\([A-Za-z_][A-Za-z0-9_]*\\|[-#?@!]\\)" 2
815 816
	  font-lock-variable-name-face)
	;; Function names.
817 818
	("^\\(\\sw+\\)[ \t]*(" 1 font-lock-function-name-face)
	("\\<\\(function\\)\\>[ \t]*\\(\\sw+\\)?"
819
	  (1 font-lock-keyword-face) (2 font-lock-function-name-face nil t)))
820 821

    ;; The next entry is only used for defining the others
822
    (shell sh-append executable-font-lock-keywords
823
           ;; Using font-lock-string-face here confuses sh-get-indent-info.
824 825 826
           ("\\\\$" 0 font-lock-warning-face)
	   ("\\\\[^A-Za-z0-9]" 0 font-lock-string-face)
	   ("\\${?\\([A-Za-z_][A-Za-z0-9_]*\\|[0-9]+\\|[$*_]\\)" 1
827
	     font-lock-variable-name-face))
828
    (rpm sh-append rpm2
829
	 ("%{?\\(\\sw+\\)"  1 font-lock-keyword-face))
830
    (rpm2 sh-append shell
831
	  ("^\\(\\sw+\\):"  1 font-lock-variable-name-face)))
832
  "Default expressions to highlight in Shell Script modes.  See `sh-feature'.")
833

834
(defvar sh-font-lock-keywords-1
835
  '((sh "[ \t]in\\>"))
836
  "Subdued level highlighting for Shell Script modes.")
837 838

(defvar sh-font-lock-keywords-2 ()
839
  "Gaudy level highlighting for Shell Script modes.")
840

841 842 843
;; These are used for the syntax table stuff (derived from cperl-mode).
;; Note: parse-sexp-lookup-properties must be set to t for it to work.
(defconst sh-st-punc (string-to-syntax "."))
Stefan Monnier's avatar
Stefan Monnier committed
844
(defconst sh-st-symbol (string-to-syntax "_"))
845 846
(defconst sh-here-doc-syntax (string-to-syntax "|")) ;; generic string

847 848 849 850 851 852 853 854 855 856
(defconst sh-here-doc-open-re "<<-?\\s-*\\\\?\\(\\(?:['\"][^'\"]+['\"]\\|\\sw\\|\\s_\\)+\\).*\\(\n\\)")

(defvar sh-here-doc-markers nil)
(make-variable-buffer-local 'sh-here-doc-markers)
(defvar sh-here-doc-re sh-here-doc-open-re)
(make-variable-buffer-local 'sh-here-doc-re)

(defun sh-font-lock-close-heredoc (bol eof indented)
  "Determine the syntax of the \\n after an EOF.
If non-nil INDENTED indicates that the EOF was indented."
857
  (let* ((eof-re (if eof (regexp-quote eof) ""))
858
         ;; A rough regexp that should find the opening <<EOF back.
859 860
	 (sre (concat "<<\\(-?\\)\\s-*['\"\\]?"
		      ;; Use \s| to cheaply check it's an open-heredoc.
861
		      eof-re "['\"]?\\([ \t|;&)<>].*\\)?\\s|"))
862
	 ;; A regexp that will find other EOFs.
863
	 (ere (concat "^" (if indented "[ \t]*") eof-re "\n"))
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
	 (start (save-excursion
		  (goto-char bol)
		  (re-search-backward (concat sre "\\|" ere) nil t))))
    ;; If subgroup 1 matched, we found an open-heredoc, otherwise we first
    ;; found a close-heredoc which makes the current close-heredoc inoperant.
    (cond
     ((when (and start (match-end 1)
		 (not (and indented (= (match-beginning 1) (match-end 1))))
		 (not (sh-in-comment-or-string (match-beginning 0))))
	;; Make sure our `<<' is not the EOF1 of a `cat <<EOF1 <<EOF2'.
	(save-excursion
	  (goto-char start)
	  (setq start (line-beginning-position 2))
	  (while
	      (progn
		(re-search-forward "<<") ; Skip ourselves.
		(and (re-search-forward sh-here-doc-open-re start 'move)
		     (goto-char (match-beginning 0))
		     (sh-in-comment-or-string (point)))))
	  ;; No <<EOF2 found after our <<.
	  (= (point) start)))
      sh-here-doc-syntax)
     ((not (or start (save-excursion (re-search-forward sre nil t))))
      ;; There's no <<EOF either before or after us,
      ;; so we should remove ourselves from font-lock's keywords.
      (setq sh-here-doc-markers (delete eof sh-here-doc-markers))
      (setq sh-here-doc-re
	    (concat sh-here-doc-open-re "\\|^\\([ \t]*\\)"
		    (regexp-opt sh-here-doc-markers t) "\\(\n\\)"))
      nil))))

(defun sh-font-lock-open-heredoc (start string)
  "Determine the syntax of the \\n after a <<EOF.
START is the position of <<.
STRING is the actual word used as delimiter (f.ex. \"EOF\").
INDENTED is non-nil if the here document's content (and the EOF mark) can
be indented (i.e. a <<- was used rather than just <<)."
  (unless (or (memq (char-before start) '(?< ?>))
	      (sh-in-comment-or-string start))
903 904
    ;; We're looking at <<STRING, so we add "^STRING$" to the syntactic
    ;; font-lock keywords to detect the end of this here document.
905 906 907 908 909 910
    (let ((str (replace-regexp-in-string "['\"]" "" string)))
      (unless (member str sh-here-doc-markers)
	(push str sh-here-doc-markers)
	(setq sh-here-doc-re
	      (concat sh-here-doc-open-re "\\|^\\([ \t]*\\)"
		      (regexp-opt sh-here-doc-markers t) "\\(\n\\)"))))
911 912
    sh-here-doc-syntax))

913 914 915 916 917
(defun sh-font-lock-here-doc (limit)
  "Search for a heredoc marker."
  ;; This looks silly, but it's because `sh-here-doc-re' keeps changing.
  (re-search-forward sh-here-doc-re limit t