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)

Leo Liu's avatar
Leo Liu committed
205 206 207 208 209
(autoload 'comint-completion-at-point "comint")
(autoload 'comint-filename-completion "comint")
(autoload 'shell-command-completion "shell")
(autoload 'shell-environment-variable-completion "shell")

210 211 212
(defvar font-lock-comment-face)
(defvar font-lock-set-defaults)
(defvar font-lock-string-face)
213 214


215
(defgroup sh nil
216
  "Shell programming utilities."
217 218 219
  :group 'languages)

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


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


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


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


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

332
(defcustom sh-imenu-generic-expression
333
  `((sh
334
     . ((nil
335 336 337 338 339 340 341 342 343
	 ;; function FOO
	 ;; function FOO()
         "^\\s-*function\\s-+\\\([[:alpha:]_][[:alnum:]_]+\\)\\s-*\\(?:()\\)?"
         1)
	;; FOO()
	(nil
	 "^\\s-*\\([[:alpha:]_][[:alnum:]_]+\\)\\s-*()"
	 1)
	)))
344
  "Alist of regular expressions for recognizing shell function definitions.
345 346 347 348 349 350 351
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
352
  :group 'sh-script
353
  :version "20.4")
354

355 356 357 358 359
(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.")
360

361 362 363
(defvar sh-shell-variables-initialized nil
  "Non-nil if `sh-shell-variables' is initialized.")

364 365
(defun sh-canonicalize-shell (shell)
  "Convert a shell name SHELL to the one we should handle it as."
366
  (if (string-match "\\.exe\\'" shell)
367
      (setq shell (substring shell 0 (match-beginning 0))))
368 369 370 371
  (or (symbolp shell)
      (setq shell (intern shell)))
  (or (cdr (assq shell sh-alias-alist))
      shell))
372

373 374
(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
375
;;;###autoload(put 'sh-shell 'safe-local-variable 'symbolp)
376

377 378 379
(define-abbrev-table 'sh-mode-abbrev-table ())


380 381 382
;; 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
383
;;  '((csh sh-abbrevs shell
384 385 386
;;	 "switch" 'sh-case
;;	 "getopts" 'sh-while-getopts)

Kenichi Handa's avatar
Kenichi Handa committed
387
;;    (es sh-abbrevs shell
388 389
;;	"function" 'sh-function)

Kenichi Handa's avatar
Kenichi Handa committed
390
;;    (ksh88 sh-abbrevs sh
391 392
;;	   "select" 'sh-select)

Kenichi Handa's avatar
Kenichi Handa committed
393
;;    (rc sh-abbrevs shell
394 395 396
;;	"case" 'sh-case
;;	"function" 'sh-function)

Kenichi Handa's avatar
Kenichi Handa committed
397
;;    (sh sh-abbrevs shell
398 399 400 401 402 403 404 405 406 407 408 409
;;	"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
410
;;    (zsh sh-abbrevs ksh88
411 412
;;	 "repeat" 'sh-repeat))
;;  "Abbrev-table used in Shell-Script mode.  See `sh-feature'.
413 414
;;;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
415 416 417



Kenichi Handa's avatar
Kenichi Handa committed
418 419 420 421 422 423 424
(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)

425
(defvar sh-mode-syntax-table
Kenichi Handa's avatar
Kenichi Handa committed
426
  (sh-mode-syntax-table ()
427 428 429 430 431
	?\# "<"
	?\n ">#"
	?\" "\"\""
	?\' "\"'"
	?\` "\"`"
432 433 434 435
	;; ?$ might also have a ". p" syntax. Both "'" and ". p" seem
	;; to work fine. This is needed so that dabbrev-expand
	;; $VARNAME works.
	?$ "'"
436 437 438 439 440 441
	?! "_"
	?% "_"
	?: "_"
	?. "_"
	?^ "_"
	?~ "_"
442
	?, "_"
443
	?= "."
444 445
	?< "."
	?> ".")
446 447
  "The syntax table to use for Shell-Script mode.
This is buffer-local in every such buffer.")
448

Kenichi Handa's avatar
Kenichi Handa committed
449 450
(defvar sh-mode-syntax-table-input
  '((sh . nil))
451
  "Syntax-table used in Shell-Script mode.  See `sh-feature'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
452 453

(defvar sh-mode-map
454
  (let ((map (make-sparse-keymap))
455
	(menu-map (make-sparse-keymap)))
Richard M. Stallman's avatar
Richard M. Stallman committed
456 457 458
    (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)
459
    (define-key map "\C-c\C-t" 'sh-tmp-file)
Richard M. Stallman's avatar
Richard M. Stallman committed
460
    (define-key map "\C-c\C-s" 'sh-select)
461 462
    (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
463 464 465 466
    (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)
467 468 469 470
    (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)
471
    (define-key map "\C-c\C-\\" 'sh-backslash-region)
472

Richard M. Stallman's avatar
Richard M. Stallman committed
473 474
    (define-key map "=" 'sh-assignment)
    (define-key map "\C-c+" 'sh-add)
475 476
    (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
477

478 479
    (define-key map [remap delete-backward-char]
      'backward-delete-char-untabify)
Richard M. Stallman's avatar
Richard M. Stallman committed
480
    (define-key map "\C-c:" 'sh-set-shell)
481 482
    (define-key map [remap backward-sentence] 'sh-beginning-of-command)
    (define-key map [remap forward-sentence] 'sh-end-of-command)
483 484 485
    (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
486
        :help "Learn how to indent the buffer the way it currently is."))
487 488
    (define-key menu-map [sh-learn-line-indent]
      '(menu-item "Learn line indentation" sh-learn-line-indent
489
        :help "Learn how to indent a line as it currently is indented"))
490 491
    (define-key menu-map [sh-show-indent]
      '(menu-item "Show indentation" sh-show-indent
Dan Nicolaescu's avatar
Dan Nicolaescu committed
492
		  :help "Show the how the current line would be indented"))
493 494 495 496
    (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
497
    (define-key menu-map [sh-pair]
498
      '(menu-item "Insert braces and quotes in pairs"
499 500 501
        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
502

503 504 505 506 507 508 509
    (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
510
        :help "Insert an addition of VAR and prefix DELTA for Bourne (type) shell"))
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
    (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
541
        :help "Pass optional header and region to a subshell for noninteractive execution"))
542 543
    (define-key menu-map [sh-exec-interpret]
      '(menu-item "Execute script..." executable-interpret
544
        :help "Run script with user-specified args, and collect output in a buffer"))
545 546 547 548 549
    (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
550
        :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
Leo Liu's avatar
Leo Liu committed
560 561 562
  '(shell-environment-variable-completion
    shell-command-completion
    comint-filename-completion)
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
    (ksh88 . ,(concat "\\<\\([[:alnum:]_]+\\)\\(\\[.+\\]\\)?"
                      "[ \t]*\\(?:[-+*/%&|~^]\\|<<\\|>>\\)?="))
572
    (bash . "\\<\\([[:alnum:]_]+\\)\\(\\[.+\\]\\)?\\+?=")
573 574 575
    (rc . "\\<\\([[:alnum:]_*]+\\)[ \t]*=")
    (sh . "\\<\\([[:alnum:]_]+\\)="))
  "Regexp for the variable name and what may follow in an assignment.
576
First grouping matches the variable name.  This is upto and including the `='
577 578 579
sign.  See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice regexp
Kenichi Handa's avatar
Kenichi Handa committed
580
			       (sexp :format "Evaluate: %v"))))
581
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
582 583


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

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


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

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

608

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



618
(defcustom sh-here-document-word "EOF"
619
  "Word to delimit here documents.
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
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
636

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

643 644 645
;; 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
646
  '((bash sh-append posix
647
	  "." "alias" "bg" "bind" "builtin" "caller" "compgen" "complete"
Kenichi Handa's avatar
Kenichi Handa committed
648 649 650
          "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
651

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

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

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

663 664
    (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
665

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
676
    (oash sh-append sh
677 678 679 680 681
	  "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
682
    (pdksh sh-append ksh88
683 684
	   "bind")

Kenichi Handa's avatar
Kenichi Handa committed
685
    (posix sh-append sh
686 687
	   "command")

688 689
    (rc "builtin" "cd" "echo" "eval" "limit" "newpgrp" "shift" "umask" "wait"
	"whatis")
690

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

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

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

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


717

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

    (csh "else")
723 724 725 726 727

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

    (rc "else")

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


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

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

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

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

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

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

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

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

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



(defvar sh-variables
Kenichi Handa's avatar
Kenichi Handa committed
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
  '((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
795 796 797 798
	 "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
799
    (es sh-append shell
800 801 802
	"apid" "cdpath" "CDPATH" "history" "home" "ifs" "noexport" "path"
	"pid" "prompt" "signals")

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

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
818
    (sh sh-append shell
819 820 821 822 823 824 825 826
	"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
827
    (tcsh sh-append csh
828 829 830 831 832 833 834 835 836 837
	  "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
838
    (zsh sh-append ksh88
839 840 841 842 843 844 845 846 847 848
	 "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'.")

849

850
;; Font-Lock support
851

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