sh-script.el 119 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, 2003, 2004, 2005
4
;;  Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5

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

;; This file is part of GNU Emacs.

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

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

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
25 26
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
27 28 29

;;; Commentary:

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

36 37
;;; Known Bugs:

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

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

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

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

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

202 203 204
(defvar font-lock-comment-face)
(defvar font-lock-set-defaults)
(defvar font-lock-string-face)
205 206


207
(defgroup sh nil
208
  "Shell programming utilities."
209 210 211 212
  :group 'unix
  :group 'languages)

(defgroup sh-script nil
213
  "Shell script mode."
214 215 216 217 218
  :group 'sh
  :prefix "sh-")


(defcustom sh-ancestor-alist
219 220
  '((ash . sh)
    (bash . jsh)
221
    (bash2 . jsh)
222 223 224 225 226 227 228 229 230 231 232 233 234
    (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)
235 236
    (zsh . ksh88)
    (rpm . sh))
237 238 239 240 241 242
  "*Alist showing the direct ancestor of various shells.
This is the basis for `sh-feature'.  See also `sh-alias-alist'.
By default we have the following three hierarchies:

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


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


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


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

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

338 339 340 341 342
(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.")
343

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

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

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

359 360 361 362 363
(defvar sh-mode-abbrev-table nil)

(define-abbrev-table 'sh-mode-abbrev-table ())


364 365 366
;; I turned off this feature because it doesn't permit typing commands
;; in the usual way without help.
;;(defvar sh-abbrevs
367
;;  '((csh sh-abbrevs shell
368 369 370
;;	 "switch" 'sh-case
;;	 "getopts" 'sh-while-getopts)

371
;;    (es sh-abbrevs shell
372 373
;;	"function" 'sh-function)

374
;;    (ksh88 sh-abbrevs sh
375 376
;;	   "select" 'sh-select)

377
;;    (rc sh-abbrevs shell
378 379 380
;;	"case" 'sh-case
;;	"function" 'sh-function)

381
;;    (sh sh-abbrevs shell
382 383 384 385 386 387 388 389 390 391 392 393
;;	"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)

394
;;    (zsh sh-abbrevs ksh88
395 396
;;	 "repeat" 'sh-repeat))
;;  "Abbrev-table used in Shell-Script mode.  See `sh-feature'.
397 398
;;;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
399 400 401



402 403 404 405 406 407 408
(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)

409 410 411 412
(defvar sh-mode-syntax-table nil
  "The syntax table to use for Shell-Script mode.
This is buffer-local in every such buffer.")

413 414
(defvar sh-mode-default-syntax-table
  (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
  "Default syntax table for shell mode.")
435

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

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

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

472 473 474 475
    (define-key map [remap complete-tag] 'comint-dynamic-complete)
    (define-key map [remap newline-and-indent] 'sh-newline-and-indent)
    (define-key map [remap delete-backward-char]
      'backward-delete-char-untabify)
Richard M. Stallman's avatar
Richard M. Stallman committed
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
    (define-key map [menu-bar insert] (cons "Insert" menu-map))
    (define-key menu-map [sh-while]	'("While Loop" . sh-while))
    (define-key menu-map [sh-until]	'("Until Loop" . sh-until))
    (define-key menu-map [sh-tmp-file]	'("Temporary File" . sh-tmp-file))
    (define-key menu-map [sh-select]	'("Select Statement" . sh-select))
    (define-key menu-map [sh-repeat]	'("Repeat Loop" . sh-repeat))
485 486
    (define-key menu-map [sh-getopts]	'("Options Loop" . sh-while-getopts))
    (define-key menu-map [sh-indexed-loop] '("Indexed Loop" . sh-indexed-loop))
487 488 489
    (define-key menu-map [sh-if]	'("If Statement" . sh-if))
    (define-key menu-map [sh-for]	'("For Loop" . sh-for))
    (define-key menu-map [sh-case]	'("Case Statement" . sh-case))
Richard M. Stallman's avatar
Richard M. Stallman committed
490 491 492
    map)
  "Keymap used in Shell-Script mode.")

493 494 495 496
(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
497

498
(defcustom sh-dynamic-complete-functions
499 500 501
  '(shell-dynamic-complete-environment-variable
    shell-dynamic-complete-command
    comint-dynamic-complete-filename)
502 503 504
  "*Functions for doing TAB dynamic completion."
  :type '(repeat function)
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
505 506


507
(defcustom sh-require-final-newline
508
  '((csh . t)
509
    (pdksh . t))
510
  "*Value of `require-final-newline' in Shell-Script mode buffers.
511
\(SHELL . t) means use the value of `mode-require-final-newline' for SHELL.
512 513 514
See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice (const :tag "require" t)
515
			       (sexp :format "Evaluate: %v"))))
516
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
517 518


519
(defcustom sh-assignment-regexp
520 521 522 523 524 525 526
  '((csh . "\\<\\([a-zA-Z0-9_]+\\)\\(\\[.+\\]\\)?[ \t]*[-+*/%^]?=")
    ;; actually spaces are only supported in let/(( ... ))
    (ksh88 . "\\<\\([a-zA-Z0-9_]+\\)\\(\\[.+\\]\\)?[ \t]*\\([-+*/%&|~^]\\|<<\\|>>\\)?=")
    (rc . "\\<\\([a-zA-Z0-9_*]+\\)[ \t]*=")
    (sh . "\\<\\([a-zA-Z0-9_]+\\)="))
  "*Regexp for the variable name and what may follow in an assignment.
First grouping matches the variable name.  This is upto and including the `='
527 528 529
sign.  See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice regexp
530
			       (sexp :format "Evaluate: %v"))))
531
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
532 533


534 535 536 537
(defcustom sh-indentation 4
  "The width for further indentation in Shell-Script mode."
  :type 'integer
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
538 539


540 541 542 543
(defcustom sh-remember-variable-min 3
  "*Don't remember variables less than this length for completing reads."
  :type 'integer
  :group 'sh-script)
Richard M. Stallman's avatar
Richard M. Stallman committed
544 545


546
(defvar sh-header-marker nil
547
  "When non-nil is the end of header for prepending by \\[sh-execute-region].
548 549 550
That command is also used for setting this variable.")


551
(defcustom sh-beginning-of-command
552
  "\\([;({`|&]\\|\\`\\|[^\\]\n\\)[ \t]*\\([/~a-zA-Z0-9:]\\)"
Richard M. Stallman's avatar
Richard M. Stallman committed
553
  "*Regexp to determine the beginning of a shell command.
554 555 556
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
557

558

559
(defcustom sh-end-of-command
560
  "\\([/~a-zA-Z0-9:]\\)[ \t]*\\([;#)}`|&]\\|$\\)"
Richard M. Stallman's avatar
Richard M. Stallman committed
561
  "*Regexp to determine the end of a shell command.
562 563 564
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
565 566 567



568
(defcustom sh-here-document-word "EOF"
569
  "Word to delimit here documents.
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
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
586

Karl Heuer's avatar
Karl Heuer committed
587 588 589 590 591
(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
592

593 594 595
;; customized this out of sheer bravado.  not for the faint of heart.
;; but it *did* have an asterisk in the docstring!
(defcustom sh-builtins
596
  '((bash sh-append posix
597
	  "." "alias" "bg" "bind" "builtin" "caller" "compgen" "complete"
598
          "declare" "dirs" "disown" "enable" "fc" "fg" "help" "history"
599 600
          "jobs" "kill" "let" "local" "popd" "printf" "pushd" "shopt"
          "source" "suspend" "typeset" "unalias")
Richard M. Stallman's avatar
Richard M. Stallman committed
601

602
    ;; The next entry is only used for defining the others
603
    (bourne sh-append shell
604 605
	    "eval" "export" "getopts" "newgrp" "pwd" "read" "readonly"
	    "times" "ulimit")
Richard M. Stallman's avatar
Richard M. Stallman committed
606

607
    (csh sh-append shell
608 609 610
	 "alias" "chdir" "glob" "history" "limit" "nice" "nohup" "rehash"
	 "setenv" "source" "time" "unalias" "unhash")

611
    (dtksh sh-append wksh)
Richard M. Stallman's avatar
Richard M. Stallman committed
612

613 614
    (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
615

616
    (jsh sh-append sh
617
	 "bg" "fg" "jobs" "kill" "stop" "suspend")
Richard M. Stallman's avatar
Richard M. Stallman committed
618

619
    (jcsh sh-append csh
620
	  "bg" "fg" "jobs" "kill" "notify" "stop" "suspend")
621

622
    (ksh88 sh-append bourne
623 624
	   "alias" "bg" "false" "fc" "fg" "jobs" "kill" "let" "print" "time"
	   "typeset" "unalias" "whence")
625

626
    (oash sh-append sh
627 628 629 630 631
	  "checkwin" "dateline" "error" "form" "menu" "newwin" "oadeinit"
	  "oaed" "oahelp" "oainit" "pp" "ppfile" "scan" "scrollok" "wattr"
	  "wclear" "werase" "win" "wmclose" "wmmessage" "wmopen" "wmove"
	  "wmtitle" "wrefresh")

632
    (pdksh sh-append ksh88
633 634
	   "bind")

635
    (posix sh-append sh
636 637
	   "command")

638 639
    (rc "builtin" "cd" "echo" "eval" "limit" "newpgrp" "shift" "umask" "wait"
	"whatis")
640

641
    (sh sh-append bourne
642 643 644
	"hash" "test" "type")

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

647
    (wksh sh-append ksh88
648
	  "Xt[A-Z][A-Za-z]*")
649

650
    (zsh sh-append ksh88
651 652 653 654 655 656
	 "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"))
657 658
  "*List of all shell builtins for completing read and fontification.
Note that on some systems not all builtins are available or some are
659 660 661
implemented as aliases.  See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice (repeat string)
662
			       (sexp :format "Evaluate: %v"))))
663
  :group 'sh-script)
664 665


666

667
(defcustom sh-leading-keywords
668
  '((bash sh-append sh
669 670 671
          "time")

    (csh "else")
672 673 674 675 676

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

    (rc "else")

677
    (sh "!" "do" "elif" "else" "if" "then" "trap" "type" "until" "while"))
678 679 680
  "*List of keywords that may be immediately followed by a builtin or keyword.
Given some confusion between keywords and builtins depending on shell and
system, the distinction here has been based on whether they influence the
681 682 683
flow of control or syntax.  See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice (repeat string)
684
			       (sexp :format "Evaluate: %v"))))
685
  :group 'sh-script)
686 687


688
(defcustom sh-other-keywords
689
  '((bash sh-append bourne
690
	  "bye" "logout" "select")
691 692

    ;; The next entry is only used for defining the others
693
    (bourne sh-append sh
694
	    "function")
695

696
    (csh sh-append shell
697 698
	 "breaksw" "default" "end" "endif" "endsw" "foreach" "goto"
	 "if" "logout" "onintr" "repeat" "switch" "then" "while")
699

700 701
    (es "break" "catch" "exec" "exit" "fn" "for" "forever" "fork" "if"
	"return" "throw" "while")
702

703
    (ksh88 sh-append bourne
704
	   "select")
705

706 707
    (rc "break" "case" "exec" "exit" "fn" "for" "if" "in" "return" "switch"
	"while")
708

709
    (sh sh-append shell
710 711
	"done" "esac" "fi" "for" "in" "return")

712 713
    ;; The next entry is only used for defining the others
    (shell "break" "case" "continue" "exec" "exit")
714

715
    (zsh sh-append bash
716 717
	 "select"))
  "*List of keywords not in `sh-leading-keywords'.
718 719 720
See `sh-feature'."
  :type '(repeat (cons (symbol :tag "Shell")
		       (choice (repeat string)
721
			       (sexp :format "Evaluate: %v"))))
722
  :group 'sh-script)
723 724 725 726



(defvar sh-variables
727
  '((bash sh-append sh
728 729 730 731 732 733 734 735 736 737 738 739 740 741
	  "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")
742

743
    (csh sh-append shell
744 745 746 747
	 "argv" "cdpath" "child" "echo" "histchars" "history" "home"
	 "ignoreeof" "mail" "noclobber" "noglob" "nonomatch" "path" "prompt"
	 "shell" "status" "time" "verbose")

748
    (es sh-append shell
749 750 751
	"apid" "cdpath" "CDPATH" "history" "home" "ifs" "noexport" "path"
	"pid" "prompt" "signals")

752
    (jcsh sh-append csh
753
	  "notify")
754

755
    (ksh88 sh-append sh
756 757 758 759
	   "ENV" "ERRNO" "FCEDIT" "FPATH" "HISTFILE" "HISTSIZE" "LINENO"
	   "OLDPWD" "PPID" "PS3" "PS4" "PWD" "RANDOM" "REPLY" "SECONDS"
	   "TMOUT")

760
    (oash sh-append sh
761 762
	  "FIELD" "FIELD_MAX" "LAST_KEY" "OALIB" "PP_ITEM" "PP_NUM")

763
    (rc sh-append shell
764 765 766
	"apid" "apids" "cdpath" "CDPATH" "history" "home" "ifs" "path" "pid"
	"prompt" "status")

767
    (sh sh-append shell
768 769 770 771 772 773 774 775
	"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")

776
    (tcsh sh-append csh
777 778 779 780 781 782 783 784 785 786
	  "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")

787
    (zsh sh-append ksh88
788 789 790 791 792 793 794 795 796 797
	 "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'.")

798

799
;; Font-Lock support
800

801
(defface sh-heredoc
802 803 804 805
  '((((min-colors 88) (class color)
      (background dark))
     (:foreground "yellow1" :weight bold))
    (((class color)
806
      (background dark))
807
     (:foreground "yellow" :weight bold))
808 809 810 811
    (((class color)
      (background light))
     (:foreground "tan" ))
    (t
812
     (:weight bold)))
813 814
  "Face to show a here-document"
  :group 'sh-indentation)
815 816 817
;; backward-compatibility alias
(put 'sh-heredoc-face 'face-alias 'sh-heredoc)
(defvar sh-heredoc-face 'sh-heredoc)
818

819 820 821 822
(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")
823

824
(defvar sh-font-lock-keywords-var
825
  '((csh sh-append shell
826 827
	 ("\\${?[#?]?\\([A-Za-z_][A-Za-z0-9_]*\\|0\\)" 1
          font-lock-variable-name-face))
828

829
    (es sh-append executable-font-lock-keywords
830 831
	("\\$#?\\([A-Za-z_][A-Za-z0-9_]*\\|[0-9]+\\)" 1
         font-lock-variable-name-face))
832

833
    (rc sh-append es)
834

835
    (sh sh-append shell
836
	;; Variable names.
837
	("\\$\\({#?\\)?\\([A-Za-z_][A-Za-z0-9_]*\\|[-#?@!]\\)" 2
838 839
	  font-lock-variable-name-face)
	;; Function names.
840 841
	("^\\(\\sw+\\)[ \t]*(" 1 font-lock-function-name-face)
	("\\<\\(function\\)\\>[ \t]*\\(\\sw+\\)?"
842 843 844
	  (1 font-lock-keyword-face) (2 font-lock-function-name-face nil t))
	("\\(?:^\\s *\\|[[();&|]\\s *\\|\\(?:\\s +-[ao]\\|if\\|else\\|then\\|while\\|do\\)\\s +\\)\\(!\\)"
	 1 font-lock-negation-char-face))
845 846

    ;; The next entry is only used for defining the others
847
    (shell
848
           ;; Using font-lock-string-face here confuses sh-get-indent-info.
849
           ("\\(^\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\\\)$" 3 'sh-escaped-newline)
850 851
	   ("\\\\[^A-Za-z0-9]" 0 font-lock-string-face)
	   ("\\${?\\([A-Za-z_][A-Za-z0-9_]*\\|[0-9]+\\|[$*_]\\)" 1
852
	     font-lock-variable-name-face))
853
    (rpm sh-append rpm2
854
	 ("%{?\\(\\sw+\\)"  1 font-lock-keyword-face))
855
    (rpm2 sh-append shell
856
	  ("^\\(\\sw+\\):"  1 font-lock-variable-name-face)))
857
  "Default expressions to highlight in Shell Script modes.  See `sh-feature'.")
858

859
(defvar sh-font-lock-keywords-var-1