sh-script.el 143 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-1997, 1999, 2001-2012  Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4

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

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; 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
16 17 18 19 20 21 22

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

;;; Commentary:

27 28 29 30 31
;; 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
32

33 34
;;; Known Bugs:

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
191 192 193
;;; Code:

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

Dave Love's avatar
Dave Love committed
199 200
(eval-when-compile
  (require 'skeleton)
Stefan Monnier's avatar
Stefan Monnier committed
201
  (require 'cl-lib)
Dave Love's avatar
Dave Love committed
202
  (require 'comint))
203 204
(require 'executable)

205 206 207
(defvar font-lock-comment-face)
(defvar font-lock-set-defaults)
(defvar font-lock-string-face)
208 209


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

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


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


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


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


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

327
(defcustom sh-imenu-generic-expression
328
  `((sh
329 330 331
     . ((nil
         "^\\s-*\\(function\\s-+\\)?\\([[:alpha:]_][[:alnum:]_]+\\)\\s-*()"
         2))))
332
  "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)
Richard M. Stallman's avatar
Richard M. Stallman committed
465

466 467 468
    (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
469
    (define-key map "\C-c:" 'sh-set-shell)
470 471
    (define-key map [remap backward-sentence] 'sh-beginning-of-command)
    (define-key map [remap forward-sentence] 'sh-end-of-command)
472 473 474
    (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
475
        :help "Learn how to indent the buffer the way it currently is."))
476 477
    (define-key menu-map [sh-learn-line-indent]
      '(menu-item "Learn line indentation" sh-learn-line-indent
478
        :help "Learn how to indent a line as it currently is indented"))
479 480
    (define-key menu-map [sh-show-indent]
      '(menu-item "Show indentation" sh-show-indent
Dan Nicolaescu's avatar
Dan Nicolaescu committed
481
		  :help "Show the how the current line would be indented"))
482 483 484 485
    (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
486
    (define-key menu-map [sh-pair]
487
      '(menu-item "Insert braces and quotes in pairs"
488 489 490
        electric-pair-mode
        :button (:toggle . (bound-and-true-p electric-pair-mode))
        :help "Inserting a brace or quote automatically inserts the matching pair"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
491

492 493 494 495 496 497 498
    (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
499
        :help "Insert an addition of VAR and prefix DELTA for Bourne (type) shell"))
500 501 502 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
    (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
530
        :help "Pass optional header and region to a subshell for noninteractive execution"))
531 532
    (define-key menu-map [sh-exec-interpret]
      '(menu-item "Execute script..." executable-interpret
533
        :help "Run script with user-specified args, and collect output in a buffer"))
534 535 536 537 538
    (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
539
        :help "Insert, align, or delete end-of-line backslashes on the lines in the region."))
Richard M. Stallman's avatar
Richard M. Stallman committed
540 541 542
    map)
  "Keymap used in Shell-Script mode.")

543 544 545 546
(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
547

548
(defcustom sh-dynamic-complete-functions
549 550 551
  '(shell-dynamic-complete-environment-variable
    shell-dynamic-complete-command
    comint-dynamic-complete-filename)
552
  "Functions for doing TAB dynamic completion."
553 554
  :type '(repeat function)
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
555

556
(defcustom sh-assignment-regexp
557
  `((csh . "\\<\\([[:alnum:]_]+\\)\\(\\[.+\\]\\)?[ \t]*[-+*/%^]?=")
558
    ;; actually spaces are only supported in let/(( ... ))
559 560
    (ksh88 . ,(concat "\\<\\([[:alnum:]_]+\\)\\(\\[.+\\]\\)?"
                      "[ \t]*\\(?:[-+*/%&|~^]\\|<<\\|>>\\)?="))
561
    (bash . "\\<\\([[:alnum:]_]+\\)\\(\\[.+\\]\\)?\\+?=")
562 563 564
    (rc . "\\<\\([[:alnum:]_*]+\\)[ \t]*=")
    (sh . "\\<\\([[:alnum:]_]+\\)="))
  "Regexp for the variable name and what may follow in an assignment.
565
First grouping matches the variable name.  This is upto and including the `='
566 567 568
sign.  See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice regexp
Kenichi Handa's avatar
Kenichi Handa committed
569
			       (sexp :format "Evaluate: %v"))))
570
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
571 572


573 574 575 576
(defcustom sh-indentation 4
  "The width for further indentation in Shell-Script mode."
  :type 'integer
  :group 'sh-script)
577
(put 'sh-indentation 'safe-local-variable 'integerp)
Richard M. Stallman's avatar
Richard M. Stallman committed
578

579
(defcustom sh-remember-variable-min 3
580
  "Don't remember variables less than this length for completing reads."
581 582
  :type 'integer
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
583 584


585
(defvar sh-header-marker nil
586
  "When non-nil is the end of header for prepending by \\[sh-execute-region].
587
That command is also used for setting this variable.")
588
(make-variable-buffer-local 'sh-header-marker)
589

590
(defcustom sh-beginning-of-command
591 592
  "\\([;({`|&]\\|\\`\\|[^\\]\n\\)[ \t]*\\([/~[:alnum:]:]\\)"
  "Regexp to determine the beginning of a shell command.
593 594 595
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
596

597

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



607
(defcustom sh-here-document-word "EOF"
608
  "Word to delimit here documents.
609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
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
625

Karl Heuer's avatar
Karl Heuer committed
626 627 628 629 630
(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
631

632 633 634
;; 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
635
  '((bash sh-append posix
636
	  "." "alias" "bg" "bind" "builtin" "caller" "compgen" "complete"
Kenichi Handa's avatar
Kenichi Handa committed
637 638 639
          "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
640

641
    ;; The next entry is only used for defining the others
Kenichi Handa's avatar
Kenichi Handa committed
642
    (bourne sh-append shell
643 644
	    "eval" "export" "getopts" "newgrp" "pwd" "read" "readonly"
	    "times" "ulimit")
Richard M. Stallman's avatar
Richard M. Stallman committed
645

Kenichi Handa's avatar
Kenichi Handa committed
646
    (csh sh-append shell
647 648 649
	 "alias" "chdir" "glob" "history" "limit" "nice" "nohup" "rehash"
	 "setenv" "source" "time" "unalias" "unhash")

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

652 653
    (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
654

Kenichi Handa's avatar
Kenichi Handa committed
655
    (jsh sh-append sh
656
	 "bg" "fg" "jobs" "kill" "stop" "suspend")
Richard M. Stallman's avatar
Richard M. Stallman committed
657

Kenichi Handa's avatar
Kenichi Handa committed
658
    (jcsh sh-append csh
659
	  "bg" "fg" "jobs" "kill" "notify" "stop" "suspend")
660

Kenichi Handa's avatar
Kenichi Handa committed
661
    (ksh88 sh-append bourne
662 663
	   "alias" "bg" "false" "fc" "fg" "jobs" "kill" "let" "print" "time"
	   "typeset" "unalias" "whence")
664

Kenichi Handa's avatar
Kenichi Handa committed
665
    (oash sh-append sh
666 667 668 669 670
	  "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
671
    (pdksh sh-append ksh88
672 673
	   "bind")

Kenichi Handa's avatar
Kenichi Handa committed
674
    (posix sh-append sh
675 676
	   "command")

677 678
    (rc "builtin" "cd" "echo" "eval" "limit" "newpgrp" "shift" "umask" "wait"
	"whatis")
679

Kenichi Handa's avatar
Kenichi Handa committed
680
    (sh sh-append bourne
681 682 683
	"hash" "test" "type")

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

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

Kenichi Handa's avatar
Kenichi Handa committed
690
    (zsh sh-append ksh88
691 692 693 694 695 696
	 "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"))
697
  "List of all shell builtins for completing read and fontification.
698
Note that on some systems not all builtins are available or some are
699 700 701
implemented as aliases.  See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice (repeat string)
Kenichi Handa's avatar
Kenichi Handa committed
702
			       (sexp :format "Evaluate: %v"))))
703
  :group 'sh-script)
704 705


706

707
(defcustom sh-leading-keywords
Kenichi Handa's avatar
Kenichi Handa committed
708 709 710 711
  '((bash sh-append sh
          "time")

    (csh "else")
712 713 714 715 716

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

    (rc "else")

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


728
(defcustom sh-other-keywords
Kenichi Handa's avatar
Kenichi Handa committed
729
  '((bash sh-append bourne
730
	  "bye" "logout" "select")
731 732

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

Kenichi Handa's avatar
Kenichi Handa committed
736
    (csh sh-append shell
737 738
	 "breaksw" "default" "end" "endif" "endsw" "foreach" "goto"
	 "if" "logout" "onintr" "repeat" "switch" "then" "while")
739

740 741
    (es "break" "catch" "exec" "exit" "fn" "for" "forever" "fork" "if"
	"return" "throw" "while")
742

Kenichi Handa's avatar
Kenichi Handa committed
743
    (ksh88 sh-append bourne
744
	   "select")
745

746 747
    (rc "break" "case" "exec" "exit" "fn" "for" "if" "in" "return" "switch"
	"while")
748

Kenichi Handa's avatar
Kenichi Handa committed
749
    (sh sh-append shell
750 751
	"done" "esac" "fi" "for" "in" "return")

752 753
    ;; The next entry is only used for defining the others
    (shell "break" "case" "continue" "exec" "exit")
754

Kenichi Handa's avatar
Kenichi Handa committed
755
    (zsh sh-append bash
756
	 "select" "foreach"))
757
  "List of keywords not in `sh-leading-keywords'.
758 759 760
See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice (repeat string)
Kenichi Handa's avatar
Kenichi Handa committed
761
			       (sexp :format "Evaluate: %v"))))
762
  :group 'sh-script)
763 764 765 766



(defvar sh-variables
Kenichi Handa's avatar
Kenichi Handa committed
767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
  '((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
784 785 786 787
	 "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
788
    (es sh-append shell
789 790 791
	"apid" "cdpath" "CDPATH" "history" "home" "ifs" "noexport" "path"
	"pid" "prompt" "signals")

Kenichi Handa's avatar
Kenichi Handa committed
792
    (jcsh sh-append csh
793
	  "notify")
794

Kenichi Handa's avatar
Kenichi Handa committed
795
    (ksh88 sh-append sh
796 797 798 799
	   "ENV" "ERRNO" "FCEDIT" "FPATH" "HISTFILE" "HISTSIZE" "LINENO"
	   "OLDPWD" "PPID" "PS3" "PS4" "PWD" "RANDOM" "REPLY" "SECONDS"
	   "TMOUT")

Kenichi Handa's avatar
Kenichi Handa committed
800
    (oash sh-append sh
801 802
	  "FIELD" "FIELD_MAX" "LAST_KEY" "OALIB" "PP_ITEM" "PP_NUM")

Kenichi Handa's avatar
Kenichi Handa committed
803
    (rc sh-append shell
804 805 806
	"apid" "apids" "cdpath" "CDPATH" "history" "home" "ifs" "path" "pid"
	"prompt" "status")

Kenichi Handa's avatar
Kenichi Handa committed
807
    (sh sh-append shell
808 809 810 811 812 813 814 815
	"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
816
    (tcsh sh-append csh
817 818 819 820 821 822 823 824 825 826
	  "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
827
    (zsh sh-append ksh88
828 829 830 831 832 833 834 835 836 837
	 "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'.")

838

839
;; Font-Lock support
840

841
(defface sh-heredoc
842 843 844 845
  '((((min-colors 88) (class color)
      (background dark))
     (:foreground "yellow1" :weight bold))
    (((class color)
846
      (background dark))
847
     (:foreground "yellow" :weight bold))
848 849
    (((class color)
      (background light))
850
     (:foreground "tan1" ))
851
    (t
852
     (:weight bold)))
853 854
  "Face to show a here-document"
  :group 'sh-indentation)
855

Glenn Morris's avatar
Glenn Morris committed
856
;; These colors are probably icky.  It's just a placeholder though.
857 858 859 860 861 862 863 864 865
(defface sh-quoted-exec
  '((((class color) (background dark))
     (:foreground "salmon"))
    (((class color) (background light))
     (:foreground "magenta"))
    (t
     (:weight bold)))