sh-script.el 128 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, 1994, 1995, 1996, 1997, 1999, 2001, 2002, 2003,
4 5
;;  2004, 2005, 2006, 2007, 2008, 2009, 2010
;;  Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
6

Karl Heuer's avatar
Karl Heuer committed
7
;; Author: Daniel Pfeiffer <occitan@esperanto.org>
8
;; Version: 2.0f
Richard M. Stallman's avatar
Richard M. Stallman committed
9
;; Maintainer: FSF
10
;; Keywords: languages, unix
Richard M. Stallman's avatar
Richard M. Stallman committed
11 12 13

;; This file is part of GNU Emacs.

14
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
15
;; it under the terms of the GNU General Public License as published by
16 17
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
18 19 20 21 22 23 24

;; 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
25
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
26 27 28

;;; Commentary:

29 30 31 32 33
;; 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
34

35 36
;;; Known Bugs:

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

41 42 43 44
;;		Indentation
;;	 	===========
;; Indentation for rc and es modes is very limited, but for Bourne shells
;; and its derivatives it is quite customizable.
45
;;
46 47
;; The following description applies to sh and derived shells (bash,
;; zsh, ...).
48
;;
49 50 51 52
;; 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
53
;; an if statement, and sh-indent-for-fi controls the indentation
54
;; of the line containing the fi.
55
;;
56 57 58 59
;; 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:
60
;;
61 62 63 64 65 66
;; 	+   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.
67
;;
68
;; There are 4 commands to help set the indentation variables:
69
;;
70 71 72
;; `sh-show-indent'
;;    This shows what variable controls the indentation of the current
;;    line and its value.
73
;;
74 75 76 77 78 79 80
;; `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.
81
;;
82 83 84 85 86
;; `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.
87
;;
88 89 90 91 92 93 94 95 96 97 98 99
;; `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'.
100
;;
101 102 103 104 105 106 107
;;    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.
108
;;
109 110 111 112 113 114 115
;; 	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:
116
;;   (add-hook 'sh-set-shell-hook 'sh-learn-buffer-indent)
117
;;
118
;; However...  `sh-learn-buffer-indent' is extremely slow,
Stefan Monnier's avatar
Stefan Monnier committed
119
;; especially on large-ish buffer.  Also, if there are conflicts the
120
;; "last one wins" which may not produce the desired setting.
121
;;
122 123
;; 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.
124
;;
125 126 127 128 129 130 131
;; 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.
132
;;
133 134 135 136
;; 	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
137
;; a user sets values using customization, these changes won't appear
138
;; to work if the variables are already local!
139
;;
Stefan Monnier's avatar
Stefan Monnier committed
140
;; To get round this, there is a variable `sh-make-vars-local' and 2
141
;; functions: `sh-make-vars-local' and `sh-reset-indent-vars-to-global-values'.
142
;;
Stefan Monnier's avatar
Stefan Monnier committed
143
;; If `sh-make-vars-local' is non-nil, then these variables become
144
;; buffer local when the mode is established.
Stefan Monnier's avatar
Stefan Monnier committed
145
;; If this is nil, then the variables are global.  At any time you
146
;; can make them local with the command `sh-make-vars-local'.
Stefan Monnier's avatar
Stefan Monnier committed
147
;; Conversely, to update with the global values you can use the
148
;; command `sh-reset-indent-vars-to-global-values'.
149
;;
Stefan Monnier's avatar
Stefan Monnier committed
150
;; This may be awkward, but the intent is to cover all cases.
151
;;
152 153 154
;; 	Awkward things, pitfalls
;; 	------------------------
;; Indentation for a sh script is complicated for a number of reasons:
155
;;
Stefan Monnier's avatar
Stefan Monnier committed
156
;; 1. You can't format by simply looking at symbols, you need to look
157 158 159 160
;;    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
161
;; 3. Here-documents in a script should be treated "as is", and when
162 163 164 165 166
;;    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 "$#"!
167
;;
168
;; To try and address points 2 3 and 5 I used a feature that cperl mode
Stefan Monnier's avatar
Stefan Monnier committed
169
;; uses, that of a text's syntax property.  This, however, has 2
170 171 172
;; disadvantages:
;; 1. We need to scan the buffer to find which ")" symbols belong to a
;;    case alternative, to find any here documents, and handle "$#".
173
;;
174 175 176 177
;; 	Bugs
;; 	----
;; - Indenting many lines is slow.  It currently does each line
;;   independently, rather than saving state information.
178
;;
179
;; - `sh-learn-buffer-indent' is extremely slow.
180
;;
181 182 183 184 185 186 187 188 189 190
;; - "case $x in y) echo ;; esac)" the last ) is mis-identified as being
;;   part of a case-pattern.  You need to add a semi-colon after "esac" to
;;   coerce sh-script into doing the right thing.
;;
;; - "echo $z in ps | head)" the last ) is mis-identified as being part of
;;   a case-pattern.  You need to put the "in" between quotes to coerce
;;   sh-script into doing the right thing.
;;
;; - A line starting with "}>foo" is not indented like "} >foo".
;;
191 192
;; Richard Sharman <rsharman@pobox.com>  June 1999.

Richard M. Stallman's avatar
Richard M. Stallman committed
193 194 195
;;; Code:

;; page 1:	variables and settings
196 197 198 199
;; 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
200

Dave Love's avatar
Dave Love committed
201 202
(eval-when-compile
  (require 'skeleton)
203
  (require 'cl)
Dave Love's avatar
Dave Love committed
204
  (require 'comint))
205 206
(require 'executable)

207 208 209
(defvar font-lock-comment-face)
(defvar font-lock-set-defaults)
(defvar font-lock-string-face)
210 211


212
(defgroup sh nil
213
  "Shell programming utilities."
214 215 216
  :group 'languages)

(defgroup sh-script nil
217
  "Shell script mode."
218
  :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
219 220 221 222 223
  :group 'sh
  :prefix "sh-")


(defcustom sh-ancestor-alist
224 225
  '((ash . sh)
    (bash . jsh)
226
    (bash2 . jsh)
227 228 229 230 231 232 233 234 235 236 237 238 239
    (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)
240 241
    (zsh . ksh88)
    (rpm . sh))
242
  "Alist showing the direct ancestor of various shells.
243 244 245 246 247
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
Chong Yidong's avatar
Chong Yidong committed
248 249
  tcsh		TENEX C Shell
    itcsh	Ian's TENEX C Shell
250 251 252
rc		Plan 9 Shell
  es		Extensible Shell
sh		Bourne Shell
Chong Yidong's avatar
Chong Yidong committed
253
  ash		Almquist Shell
254 255 256 257 258 259 260 261 262 263
  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
264 265 266
  wsh		? Shell"
  :type '(repeat (cons symbol symbol))
  :group 'sh-script)
267 268


269
(defcustom sh-alias-alist
270
  (append (if (eq system-type 'gnu/linux)
271
	     '((csh . tcsh)
272
	       (ksh . pdksh)))
273 274
	 ;; for the time being
	 '((ksh . ksh88)
275
           (bash2 . bash)
276
	   (sh5 . sh)))
277
  "Alist for transforming shell names to what they really are.
278
Use this where the name of the executable doesn't correspond to the type of
279 280 281
shell it really is."
  :type '(repeat (cons symbol symbol))
  :group 'sh-script)
282 283


284
(defcustom sh-shell-file
285
  (or
286 287
   ;; On MSDOS and Windows, collapse $SHELL to lower-case and remove
   ;; the executable extension, so comparisons with the list of
288
   ;; known shells work.
289
   (and (memq system-type '(ms-dos windows-nt))
290 291 292 293 294 295 296
	(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)
297 298
			  '("command.com" "cmd.exe" "4dos.com" "ndos.com"
			    "cmdproxy.exe")))
299 300
	      "/bin/sh"
	    (file-name-sans-extension (downcase shell)))))
301 302
   (getenv "SHELL")
   "/bin/sh")
303
  "The executable file name for the shell being programmed."
304 305
  :type 'string
  :group 'sh-script)
306 307


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

329
(defcustom sh-imenu-generic-expression
330
  `((sh
331 332
     . ((nil "^\\s-*\\(function\\s-+\\)?\\([[:alpha:]_][[:alnum:]_]+\\)\\s-*()" 2))))
  "Alist of regular expressions for recognizing shell function definitions.
333 334 335 336 337 338 339
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
340
  :group 'sh-script
341
  :version "20.4")
342

343 344 345 346 347
(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.")
348

349 350 351
(defvar sh-shell-variables-initialized nil
  "Non-nil if `sh-shell-variables' is initialized.")

352 353
(defun sh-canonicalize-shell (shell)
  "Convert a shell name SHELL to the one we should handle it as."
354
  (if (string-match "\\.exe\\'" shell)
355
      (setq shell (substring shell 0 (match-beginning 0))))
356 357 358 359
  (or (symbolp shell)
      (setq shell (intern shell)))
  (or (cdr (assq shell sh-alias-alist))
      shell))
360

361 362
(defvar sh-shell (sh-canonicalize-shell (file-name-nondirectory sh-shell-file))
  "The shell being programmed.  This is set by \\[sh-set-shell].")
Dan Nicolaescu's avatar
Dan Nicolaescu committed
363
;;;###autoload(put 'sh-shell 'safe-local-variable 'symbolp)
364

365 366 367
(define-abbrev-table 'sh-mode-abbrev-table ())


368 369 370
;; I turned off this feature because it doesn't permit typing commands
;; in the usual way without help.
;;(defvar sh-abbrevs
Kenichi Handa's avatar
Kenichi Handa committed
371
;;  '((csh sh-abbrevs shell
372 373 374
;;	 "switch" 'sh-case
;;	 "getopts" 'sh-while-getopts)

Kenichi Handa's avatar
Kenichi Handa committed
375
;;    (es sh-abbrevs shell
376 377
;;	"function" 'sh-function)

Kenichi Handa's avatar
Kenichi Handa committed
378
;;    (ksh88 sh-abbrevs sh
379 380
;;	   "select" 'sh-select)

Kenichi Handa's avatar
Kenichi Handa committed
381
;;    (rc sh-abbrevs shell
382 383 384
;;	"case" 'sh-case
;;	"function" 'sh-function)

Kenichi Handa's avatar
Kenichi Handa committed
385
;;    (sh sh-abbrevs shell
386 387 388 389 390 391 392 393 394 395 396 397
;;	"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)

Kenichi Handa's avatar
Kenichi Handa committed
398
;;    (zsh sh-abbrevs ksh88
399 400
;;	 "repeat" 'sh-repeat))
;;  "Abbrev-table used in Shell-Script mode.  See `sh-feature'.
401 402
;;;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
403 404 405



Kenichi Handa's avatar
Kenichi Handa committed
406 407 408 409 410 411 412
(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)

413
(defvar sh-mode-syntax-table
Kenichi Handa's avatar
Kenichi Handa committed
414
  (sh-mode-syntax-table ()
415 416 417 418 419
	?\# "<"
	?\n ">#"
	?\" "\"\""
	?\' "\"'"
	?\` "\"`"
420 421 422 423
	;; ?$ might also have a ". p" syntax. Both "'" and ". p" seem
	;; to work fine. This is needed so that dabbrev-expand
	;; $VARNAME works.
	?$ "'"
424 425 426 427 428 429
	?! "_"
	?% "_"
	?: "_"
	?. "_"
	?^ "_"
	?~ "_"
430
	?, "_"
431
	?= "."
432 433
	?< "."
	?> ".")
434 435
  "The syntax table to use for Shell-Script mode.
This is buffer-local in every such buffer.")
436

Kenichi Handa's avatar
Kenichi Handa committed
437 438
(defvar sh-mode-syntax-table-input
  '((sh . nil))
439
  "Syntax-table used in Shell-Script mode.  See `sh-feature'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
440 441

(defvar sh-mode-map
442
  (let ((map (make-sparse-keymap))
443
	(menu-map (make-sparse-keymap)))
Richard M. Stallman's avatar
Richard M. Stallman committed
444 445 446
    (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)
447
    (define-key map "\C-c\C-t" 'sh-tmp-file)
Richard M. Stallman's avatar
Richard M. Stallman committed
448
    (define-key map "\C-c\C-s" 'sh-select)
449 450
    (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
451 452 453 454
    (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)
455 456 457 458
    (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)
459
    (define-key map "\C-c\C-\\" 'sh-backslash-region)
460

Richard M. Stallman's avatar
Richard M. Stallman committed
461 462
    (define-key map "=" 'sh-assignment)
    (define-key map "\C-c+" 'sh-add)
463 464
    (define-key map "\C-\M-x" 'sh-execute-region)
    (define-key map "\C-c\C-x" 'executable-interpret)
465
    (define-key map "<" 'sh-maybe-here-document)
466 467 468 469 470 471
    (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
472

473 474 475
    (define-key map [remap complete-tag] 'comint-dynamic-complete)
    (define-key map [remap delete-backward-char]
      'backward-delete-char-untabify)
Richard M. Stallman's avatar
Richard M. Stallman committed
476
    (define-key map "\C-c:" 'sh-set-shell)
477 478
    (define-key map [remap backward-sentence] 'sh-beginning-of-command)
    (define-key map [remap forward-sentence] 'sh-end-of-command)
479 480 481 482 483 484 485 486 487
    (define-key map [menu-bar sh-script] (cons "Sh-Script" menu-map))
    (define-key menu-map [sh-learn-buffer-indent]
      '(menu-item "Learn buffer indentation" sh-learn-buffer-indent
		  :help "Learn how to indent the buffer the way it currently is."))
    (define-key menu-map [sh-learn-line-indent]
      '(menu-item "Learn line indentation" sh-learn-line-indent
		  :help "Learn how to indent a line as it currently is indented"))
    (define-key menu-map [sh-show-indent]
      '(menu-item "Show indentation" sh-show-indent
Dan Nicolaescu's avatar
Dan Nicolaescu committed
488
		  :help "Show the how the current line would be indented"))
489 490 491 492
    (define-key menu-map [sh-set-indent]
      '(menu-item "Set indentation" sh-set-indent
		  :help "Set the indentation for the current line"))

Dan Nicolaescu's avatar
Dan Nicolaescu committed
493
    (define-key menu-map [sh-pair]
494 495 496 497 498 499 500
      '(menu-item "Insert braces and quotes in pairs"
		  (lambda ()
		    (interactive)
		    (require 'skeleton)
		    (setq skeleton-pair (not skeleton-pair)))
		  :button (:toggle . (and (boundp 'skeleton-pair)
					  skeleton-pair))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
501 502
		  :help "Inserting a brace or quote automatically inserts the matching pair"))

503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
    (define-key menu-map [sh-s0] '("--"))
    ;; Insert
    (define-key menu-map [sh-function]
      '(menu-item "Function..." sh-function
		  :help "Insert a function definition"))
    (define-key menu-map [sh-add]
      '(menu-item "Addition..." sh-add
		  :help "Insert an addition of VAR and prefix DELTA for Bourne (type) shell"))
    (define-key menu-map [sh-until]
      '(menu-item "Until Loop" sh-until
		  :help "Insert an until loop"))
    (define-key menu-map [sh-repeat]
      '(menu-item "Repeat Loop" sh-repeat
		  :help "Insert a repeat loop definition"))
    (define-key menu-map [sh-while]
      '(menu-item "While Loop" sh-while
		  :help "Insert a while loop"))
    (define-key menu-map [sh-getopts]
      '(menu-item "Options Loop" sh-while-getopts
		  :help "Insert a while getopts loop."))
    (define-key menu-map [sh-indexed-loop]
      '(menu-item "Indexed Loop" sh-indexed-loop
		  :help "Insert an indexed loop from 1 to n."))
    (define-key menu-map [sh-select]
      '(menu-item "Select Statement" sh-select
		  :help "Insert a select statement "))
    (define-key menu-map [sh-if]
      '(menu-item "If Statement" sh-if
		  :help "Insert an if statement"))
    (define-key menu-map [sh-for]
      '(menu-item "For Loop" sh-for
		  :help "Insert a for loop"))
    (define-key menu-map [sh-case]
      '(menu-item "Case Statement" sh-case
		  :help "Insert a case/switch statement"))
    (define-key menu-map [sh-s1] '("--"))
    (define-key menu-map [sh-exec]
      '(menu-item "Execute region" sh-execute-region
		  :help "Pass optional header and region to a subshell for noninteractive execution"))
    (define-key menu-map [sh-exec-interpret]
      '(menu-item "Execute script..." executable-interpret
		  :help "Run script with user-specified args, and collect output in a buffer"))
    (define-key menu-map [sh-set-shell]
      '(menu-item "Set shell type..." sh-set-shell
		  :help "Set this buffer's shell to SHELL (a string)"))
    (define-key menu-map [sh-backslash-region]
      '(menu-item "Backslash region" sh-backslash-region
		  :help "Insert, align, or delete end-of-line backslashes on the lines in the region."))
Richard M. Stallman's avatar
Richard M. Stallman committed
551 552 553
    map)
  "Keymap used in Shell-Script mode.")

554 555 556 557
(defvar sh-skeleton-pair-default-alist '((?( _ ?)) (?\))
				      (?[ ?\s _ ?\s ?]) (?\])
				      (?{ _ ?}) (?\}))
  "Value to use for `skeleton-pair-default-alist' in Shell-Script mode.")
Richard M. Stallman's avatar
Richard M. Stallman committed
558

559
(defcustom sh-dynamic-complete-functions
560 561 562
  '(shell-dynamic-complete-environment-variable
    shell-dynamic-complete-command
    comint-dynamic-complete-filename)
563
  "Functions for doing TAB dynamic completion."
564 565
  :type '(repeat function)
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
566

567
(defcustom sh-assignment-regexp
568
  '((csh . "\\<\\([[:alnum:]_]+\\)\\(\\[.+\\]\\)?[ \t]*[-+*/%^]?=")
569
    ;; actually spaces are only supported in let/(( ... ))
570 571 572 573
    (ksh88 . "\\<\\([[:alnum:]_]+\\)\\(\\[.+\\]\\)?[ \t]*\\([-+*/%&|~^]\\|<<\\|>>\\)?=")
    (rc . "\\<\\([[:alnum:]_*]+\\)[ \t]*=")
    (sh . "\\<\\([[:alnum:]_]+\\)="))
  "Regexp for the variable name and what may follow in an assignment.
574
First grouping matches the variable name.  This is upto and including the `='
575 576 577
sign.  See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice regexp
Kenichi Handa's avatar
Kenichi Handa committed
578
			       (sexp :format "Evaluate: %v"))))
579
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
580 581


582 583 584 585
(defcustom sh-indentation 4
  "The width for further indentation in Shell-Script mode."
  :type 'integer
  :group 'sh-script)
586
(put 'sh-indentation 'safe-local-variable 'integerp)
Richard M. Stallman's avatar
Richard M. Stallman committed
587

588
(defcustom sh-remember-variable-min 3
589
  "Don't remember variables less than this length for completing reads."
590 591
  :type 'integer
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
592 593


594
(defvar sh-header-marker nil
595
  "When non-nil is the end of header for prepending by \\[sh-execute-region].
596
That command is also used for setting this variable.")
597
(make-variable-buffer-local 'sh-header-marker)
598

599
(defcustom sh-beginning-of-command
600 601
  "\\([;({`|&]\\|\\`\\|[^\\]\n\\)[ \t]*\\([/~[:alnum:]:]\\)"
  "Regexp to determine the beginning of a shell command.
602 603 604
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
605

606

607
(defcustom sh-end-of-command
608 609
  "\\([/~[:alnum:]:]\\)[ \t]*\\([;#)}`|&]\\|$\\)"
  "Regexp to determine the end of a shell command.
610 611 612
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
613 614 615



616
(defcustom sh-here-document-word "EOF"
617
  "Word to delimit here documents.
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
If the first character of this string is \"-\", this is taken as
part of the redirection operator, rather than part of the
word (that is, \"<<-\" instead of \"<<\").  This is a feature
used by some shells (for example Bash) to indicate that leading
tabs inside the here document should be ignored.  In this case,
Emacs indents the initial body and end of the here document with
tabs, to the same level as the start (note that apart from this
there is no support for indentation of here documents).  This
will only work correctly if `sh-basic-offset' is a multiple of
`tab-width'.

Any quote characters or leading whitespace in the word are
removed when closing the here document."
  :type 'string
  :group 'sh-script)

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

Karl Heuer's avatar
Karl Heuer committed
635 636 637 638 639
(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
640

641 642 643
;; customized this out of sheer bravado.  not for the faint of heart.
;; but it *did* have an asterisk in the docstring!
(defcustom sh-builtins
Kenichi Handa's avatar
Kenichi Handa committed
644
  '((bash sh-append posix
645
	  "." "alias" "bg" "bind" "builtin" "caller" "compgen" "complete"
Kenichi Handa's avatar
Kenichi Handa committed
646 647 648
          "declare" "dirs" "disown" "enable" "fc" "fg" "help" "history"
          "jobs" "kill" "let" "local" "popd" "printf" "pushd" "shopt"
          "source" "suspend" "typeset" "unalias")
Richard M. Stallman's avatar
Richard M. Stallman committed
649

650
    ;; The next entry is only used for defining the others
Kenichi Handa's avatar
Kenichi Handa committed
651
    (bourne sh-append shell
652 653
	    "eval" "export" "getopts" "newgrp" "pwd" "read" "readonly"
	    "times" "ulimit")
Richard M. Stallman's avatar
Richard M. Stallman committed
654

Kenichi Handa's avatar
Kenichi Handa committed
655
    (csh sh-append shell
656 657 658
	 "alias" "chdir" "glob" "history" "limit" "nice" "nohup" "rehash"
	 "setenv" "source" "time" "unalias" "unhash")

Kenichi Handa's avatar
Kenichi Handa committed
659
    (dtksh sh-append wksh)
Richard M. Stallman's avatar
Richard M. Stallman committed
660

661 662
    (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
663

Kenichi Handa's avatar
Kenichi Handa committed
664
    (jsh sh-append sh
665
	 "bg" "fg" "jobs" "kill" "stop" "suspend")
Richard M. Stallman's avatar
Richard M. Stallman committed
666

Kenichi Handa's avatar
Kenichi Handa committed
667
    (jcsh sh-append csh
668
	  "bg" "fg" "jobs" "kill" "notify" "stop" "suspend")
669

Kenichi Handa's avatar
Kenichi Handa committed
670
    (ksh88 sh-append bourne
671 672
	   "alias" "bg" "false" "fc" "fg" "jobs" "kill" "let" "print" "time"
	   "typeset" "unalias" "whence")
673

Kenichi Handa's avatar
Kenichi Handa committed
674
    (oash sh-append sh
675 676 677 678 679
	  "checkwin" "dateline" "error" "form" "menu" "newwin" "oadeinit"
	  "oaed" "oahelp" "oainit" "pp" "ppfile" "scan" "scrollok" "wattr"
	  "wclear" "werase" "win" "wmclose" "wmmessage" "wmopen" "wmove"
	  "wmtitle" "wrefresh")

Kenichi Handa's avatar
Kenichi Handa committed
680
    (pdksh sh-append ksh88
681 682
	   "bind")

Kenichi Handa's avatar
Kenichi Handa committed
683
    (posix sh-append sh
684 685
	   "command")

686 687
    (rc "builtin" "cd" "echo" "eval" "limit" "newpgrp" "shift" "umask" "wait"
	"whatis")
688

Kenichi Handa's avatar
Kenichi Handa committed
689
    (sh sh-append bourne
690 691 692
	"hash" "test" "type")

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

Kenichi Handa's avatar
Kenichi Handa committed
695
    (wksh sh-append ksh88
696
          ;; FIXME: This looks too much like a regexp.  --Stef
697
	  "Xt[A-Z][A-Za-z]*")
698

Kenichi Handa's avatar
Kenichi Handa committed
699
    (zsh sh-append ksh88
700 701 702 703 704 705
	 "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"))
706
  "List of all shell builtins for completing read and fontification.
707
Note that on some systems not all builtins are available or some are
708 709 710
implemented as aliases.  See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice (repeat string)
Kenichi Handa's avatar
Kenichi Handa committed
711
			       (sexp :format "Evaluate: %v"))))
712
  :group 'sh-script)
713 714


715

716
(defcustom sh-leading-keywords
Kenichi Handa's avatar
Kenichi Handa committed
717 718 719 720
  '((bash sh-append sh
          "time")

    (csh "else")
721 722 723 724 725

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

    (rc "else")

726
    (sh "!" "do" "elif" "else" "if" "then" "trap" "type" "until" "while"))
727
  "List of keywords that may be immediately followed by a builtin or keyword.
728 729
Given some confusion between keywords and builtins depending on shell and
system, the distinction here has been based on whether they influence the
730 731 732
flow of control or syntax.  See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice (repeat string)
Kenichi Handa's avatar
Kenichi Handa committed
733
			       (sexp :format "Evaluate: %v"))))
734
  :group 'sh-script)
735 736


737
(defcustom sh-other-keywords
Kenichi Handa's avatar
Kenichi Handa committed
738
  '((bash sh-append bourne
739
	  "bye" "logout" "select")
740 741

    ;; The next entry is only used for defining the others
Kenichi Handa's avatar
Kenichi Handa committed
742
    (bourne sh-append sh
743
	    "function")
744

Kenichi Handa's avatar
Kenichi Handa committed
745
    (csh sh-append shell
746 747
	 "breaksw" "default" "end" "endif" "endsw" "foreach" "goto"
	 "if" "logout" "onintr" "repeat" "switch" "then" "while")
748

749 750
    (es "break" "catch" "exec" "exit" "fn" "for" "forever" "fork" "if"
	"return" "throw" "while")
751

Kenichi Handa's avatar
Kenichi Handa committed
752
    (ksh88 sh-append bourne
753
	   "select")
754

755 756
    (rc "break" "case" "exec" "exit" "fn" "for" "if" "in" "return" "switch"
	"while")
757

Kenichi Handa's avatar
Kenichi Handa committed
758
    (sh sh-append shell
759 760
	"done" "esac" "fi" "for" "in" "return")

761 762
    ;; The next entry is only used for defining the others
    (shell "break" "case" "continue" "exec" "exit")
763

Kenichi Handa's avatar
Kenichi Handa committed
764
    (zsh sh-append bash
765
	 "select"))
766
  "List of keywords not in `sh-leading-keywords'.
767 768 769
See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice (repeat string)
Kenichi Handa's avatar
Kenichi Handa committed
770
			       (sexp :format "Evaluate: %v"))))
771
  :group 'sh-script)
772 773 774 775



(defvar sh-variables
Kenichi Handa's avatar
Kenichi Handa committed
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
  '((bash sh-append sh
	  "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")

    (csh sh-append shell
793 794 795 796
	 "argv" "cdpath" "child" "echo" "histchars" "history" "home"
	 "ignoreeof" "mail" "noclobber" "noglob" "nonomatch" "path" "prompt"
	 "shell" "status" "time" "verbose")

Kenichi Handa's avatar
Kenichi Handa committed
797
    (es sh-append shell
798 799 800
	"apid" "cdpath" "CDPATH" "history" "home" "ifs" "noexport" "path"
	"pid" "prompt" "signals")

Kenichi Handa's avatar
Kenichi Handa committed
801
    (jcsh sh-append csh
802
	  "notify")
803

Kenichi Handa's avatar
Kenichi Handa committed
804
    (ksh88 sh-append sh
805 806 807 808
	   "ENV" "ERRNO" "FCEDIT" "FPATH" "HISTFILE" "HISTSIZE" "LINENO"
	   "OLDPWD" "PPID" "PS3" "PS4" "PWD" "RANDOM" "REPLY" "SECONDS"
	   "TMOUT")

Kenichi Handa's avatar
Kenichi Handa committed
809
    (oash sh-append sh
810 811
	  "FIELD" "FIELD_MAX" "LAST_KEY" "OALIB" "PP_ITEM" "PP_NUM")

Kenichi Handa's avatar
Kenichi Handa committed
812
    (rc sh-append shell
813 814 815
	"apid" "apids" "cdpath" "CDPATH" "history" "home" "ifs" "path" "pid"
	"prompt" "status")

Kenichi Handa's avatar
Kenichi Handa committed
816
    (sh sh-append shell
817 818 819 820 821 822 823 824
	"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")

Kenichi Handa's avatar
Kenichi Handa committed
825
    (tcsh sh-append csh
826 827 828 829 830 831 832 833 834 835
	  "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")

Kenichi Handa's avatar
Kenichi Handa committed
836
    (zsh sh-append ksh88
837 838 839 840 841 842 843 844 845 846
	 "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'.")

847

848
;; Font-Lock support
849

850
(defface sh-heredoc
851 852 853 854
  '((((min-colors 88) (class color)
      (background dark))
     (:foreground "yellow1" :weight bold))
    (((class color)
855
      (background dark))
856
     (:foreground "yellow" :weight bold))
857 858
    (((class color)
      (background light))
859
     (:foreground "tan1" ))
860
    (t
861
     (:weight bold)))
862 863
  "Face to show a here-document"
  :group 'sh-indentation)
864

Glenn Morris's avatar
Glenn Morris committed
865
;; These colors are probably icky.  It's just a placeholder though.
866 867 868 869 870 871 872 873 874
(defface sh-quoted-exec
  '((((class color) (background dark))
     (:foreground "salmon"))
    (((class color) (background light))
     (:foreground "magenta"))
    (t
     (:weight bold)))
  "Face to show quoted execs like ``"
  :group 'sh-indentation)
875
(define-obsolete-face-alias 'sh-heredoc-face 'sh-heredoc "22.1")
876
(defvar sh-heredoc-face 'sh-heredoc)
877

878 879 880 881
(defface sh-escaped-newline '((t :inherit font-lock-string-face))
  "Face used for (non-escaped) backslash at end of a line in Shell-script mode."
  :group 'sh-script
  :version "22.1")
882

883
(defvar sh-font-lock-keywords-var