Fix GPG bug introduced by Oct file-missing change
[emacs.git] / lisp / progmodes / sh-script.el
blob5d362e42c308c79b8d561db683eaa66beeb271ab
1 ;;; sh-script.el --- shell-script editing commands for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1993-1997, 1999, 2001-2016 Free Software Foundation,
4 ;; Inc.
6 ;; Author: Daniel Pfeiffer <occitan@esperanto.org>
7 ;; Version: 2.0f
8 ;; Maintainer: emacs-devel@gnu.org
9 ;; Keywords: languages, unix
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; Major mode for editing shell scripts. Bourne, C and rc shells as well
29 ;; as various derivatives are supported and easily derived from. Structured
30 ;; statements can be inserted with one command or abbrev. Completion is
31 ;; available for filenames, variables known from the script, the shell and
32 ;; the environment as well as commands.
34 ;;; Known Bugs:
36 ;; - In Bourne the keyword `in' is not anchored to case, for, select ...
37 ;; - Variables in `"' strings aren't fontified because there's no way of
38 ;; syntactically distinguishing those from `'' strings.
40 ;; Indentation
41 ;; ===========
42 ;; Indentation for rc and es modes is very limited, but for Bourne shells
43 ;; and its derivatives it is quite customizable.
45 ;; The following description applies to sh and derived shells (bash,
46 ;; zsh, ...).
48 ;; There are various customization variables which allow tailoring to
49 ;; a wide variety of styles. Most of these variables are named
50 ;; sh-indent-for-XXX and sh-indent-after-XXX. For example.
51 ;; sh-indent-after-if controls the indenting of a line following
52 ;; an if statement, and sh-indent-for-fi controls the indentation
53 ;; of the line containing the fi.
55 ;; You can set each to a numeric value, but it is often more convenient
56 ;; to a symbol such as `+' which uses the value of variable `sh-basic-offset'.
57 ;; By changing this one variable you can increase or decrease how much
58 ;; indentation there is. Valid symbols:
60 ;; + Indent right by sh-basic-offset
61 ;; - Indent left by sh-basic-offset
62 ;; ++ Indent right twice sh-basic-offset
63 ;; -- Indent left twice sh-basic-offset
64 ;; * Indent right half sh-basic-offset
65 ;; / Indent left half sh-basic-offset.
67 ;; There are 4 commands to help set the indentation variables:
69 ;; `sh-show-indent'
70 ;; This shows what variable controls the indentation of the current
71 ;; line and its value.
73 ;; `sh-set-indent'
74 ;; This allows you to set the value of the variable controlling the
75 ;; current line's indentation. You can enter a number or one of a
76 ;; number of special symbols to denote the value of sh-basic-offset,
77 ;; or its negative, or half it, or twice it, etc. If you've used
78 ;; cc-mode this should be familiar. If you forget which symbols are
79 ;; valid simply press C-h at the prompt.
81 ;; `sh-learn-line-indent'
82 ;; Simply make the line look the way you want it, then invoke this
83 ;; command. It will set the variable to the value that makes the line
84 ;; indent like that. If called with a prefix argument then it will set
85 ;; the value to one of the symbols if applicable.
87 ;; `sh-learn-buffer-indent'
88 ;; This is the deluxe function! It "learns" the whole buffer (use
89 ;; narrowing if you want it to process only part). It outputs to a
90 ;; buffer *indent* any conflicts it finds, and all the variables it has
91 ;; learned. This buffer is a sort of Occur mode buffer, allowing you to
92 ;; easily find where something was set. It is popped to automatically
93 ;; if there are any conflicts found or if `sh-popup-occur-buffer' is
94 ;; non-nil.
95 ;; `sh-indent-comment' will be set if all comments follow the same
96 ;; pattern; if they don't it will be set to nil.
97 ;; Whether `sh-basic-offset' is set is determined by variable
98 ;; `sh-learn-basic-offset'.
100 ;; Unfortunately, `sh-learn-buffer-indent' can take a long time to run
101 ;; (e.g. if there are large case statements). Perhaps it does not make
102 ;; sense to run it on large buffers: if lots of lines have different
103 ;; indentation styles it will produce a lot of diagnostics in the
104 ;; *indent* buffer; if there is a consistent style then running
105 ;; `sh-learn-buffer-indent' on a small region of the buffer should
106 ;; suffice.
108 ;; Saving indentation values
109 ;; -------------------------
110 ;; After you've learned the values in a buffer, how to you remember
111 ;; them? Originally I had hoped that `sh-learn-buffer-indent'
112 ;; would make this unnecessary; simply learn the values when you visit
113 ;; the buffer.
114 ;; You can do this automatically like this:
115 ;; (add-hook 'sh-set-shell-hook 'sh-learn-buffer-indent)
117 ;; However... `sh-learn-buffer-indent' is extremely slow,
118 ;; especially on large-ish buffer. Also, if there are conflicts the
119 ;; "last one wins" which may not produce the desired setting.
121 ;; So...There is a minimal way of being able to save indentation values and
122 ;; to reload them in another buffer or at another point in time.
124 ;; Use `sh-name-style' to give a name to the indentation settings of
125 ;; the current buffer.
126 ;; Use `sh-load-style' to load indentation settings for the current
127 ;; buffer from a specific style.
128 ;; Use `sh-save-styles-to-buffer' to write all the styles to a buffer
129 ;; in lisp code. You can then store it in a file and later use
130 ;; `load-file' to load it.
132 ;; Indentation variables - buffer local or global?
133 ;; ----------------------------------------------
134 ;; I think that often having them buffer-local makes sense,
135 ;; especially if one is using `sh-learn-buffer-indent'. However, if
136 ;; a user sets values using customization, these changes won't appear
137 ;; to work if the variables are already local!
139 ;; To get round this, there is a variable `sh-make-vars-local' and 2
140 ;; functions: `sh-make-vars-local' and `sh-reset-indent-vars-to-global-values'.
142 ;; If `sh-make-vars-local' is non-nil, then these variables become
143 ;; buffer local when the mode is established.
144 ;; If this is nil, then the variables are global. At any time you
145 ;; can make them local with the command `sh-make-vars-local'.
146 ;; Conversely, to update with the global values you can use the
147 ;; command `sh-reset-indent-vars-to-global-values'.
149 ;; This may be awkward, but the intent is to cover all cases.
151 ;; Awkward things, pitfalls
152 ;; ------------------------
153 ;; Indentation for a sh script is complicated for a number of reasons:
155 ;; 1. You can't format by simply looking at symbols, you need to look
156 ;; at keywords. [This is not the case for rc and es shells.]
157 ;; 2. The character ")" is used both as a matched pair "(" ... ")" and
158 ;; as a stand-alone symbol (in a case alternative). This makes
159 ;; things quite tricky!
160 ;; 3. Here-documents in a script should be treated "as is", and when
161 ;; they terminate we want to revert to the indentation of the line
162 ;; containing the "<<" symbol.
163 ;; 4. A line may be continued using the "\".
164 ;; 5. The character "#" (outside a string) normally starts a comment,
165 ;; but it doesn't in the sequence "$#"!
167 ;; To try and address points 2 3 and 5 I used a feature that cperl mode
168 ;; uses, that of a text's syntax property. This, however, has 2
169 ;; disadvantages:
170 ;; 1. We need to scan the buffer to find which ")" symbols belong to a
171 ;; case alternative, to find any here documents, and handle "$#".
173 ;; Bugs
174 ;; ----
175 ;; - Indenting many lines is slow. It currently does each line
176 ;; independently, rather than saving state information.
178 ;; - `sh-learn-buffer-indent' is extremely slow.
180 ;; - "case $x in y) echo ;; esac)" the last ) is mis-identified as being
181 ;; part of a case-pattern. You need to add a semi-colon after "esac" to
182 ;; coerce sh-script into doing the right thing.
184 ;; - "echo $z in ps | head)" the last ) is mis-identified as being part of
185 ;; a case-pattern. You need to put the "in" between quotes to coerce
186 ;; sh-script into doing the right thing.
188 ;; - A line starting with "}>foo" is not indented like "} >foo".
190 ;; Richard Sharman <rsharman@pobox.com> June 1999.
192 ;;; Code:
194 ;; page 1: variables and settings
195 ;; page 2: indentation stuff
196 ;; page 3: mode-command and utility functions
197 ;; page 4: statement syntax-commands for various shells
198 ;; page 5: various other commands
200 (eval-when-compile
201 (require 'skeleton)
202 (require 'cl-lib)
203 (require 'comint))
204 (require 'executable)
206 (autoload 'comint-completion-at-point "comint")
207 (autoload 'comint-filename-completion "comint")
208 (autoload 'comint-send-string "comint")
209 (autoload 'shell-command-completion "shell")
210 (autoload 'shell-environment-variable-completion "shell")
212 (defvar font-lock-comment-face)
213 (defvar font-lock-set-defaults)
214 (defvar font-lock-string-face)
217 (defgroup sh nil
218 "Shell programming utilities."
219 :group 'languages)
221 (defgroup sh-script nil
222 "Shell script mode."
223 :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
224 :group 'sh
225 :prefix "sh-")
228 (defcustom sh-ancestor-alist
229 '((ash . sh)
230 (bash . jsh)
231 (bash2 . jsh)
232 (dash . ash)
233 (dtksh . ksh)
234 (es . rc)
235 (itcsh . tcsh)
236 (jcsh . csh)
237 (jsh . sh)
238 (ksh . ksh88)
239 (ksh88 . jsh)
240 (oash . sh)
241 (pdksh . ksh88)
242 (mksh . pdksh)
243 (posix . sh)
244 (tcsh . csh)
245 (wksh . ksh88)
246 (wsh . sh)
247 (zsh . ksh88)
248 (rpm . sh))
249 "Alist showing the direct ancestor of various shells.
250 This is the basis for `sh-feature'. See also `sh-alias-alist'.
251 By default we have the following three hierarchies:
253 csh C Shell
254 jcsh C Shell with Job Control
255 tcsh TENEX C Shell
256 itcsh Ian's TENEX C Shell
257 rc Plan 9 Shell
258 es Extensible Shell
259 sh Bourne Shell
260 ash Almquist Shell
261 dash Debian Almquist Shell
262 jsh Bourne Shell with Job Control
263 bash GNU Bourne Again Shell
264 ksh88 Korn Shell '88
265 ksh Korn Shell '93
266 dtksh CDE Desktop Korn Shell
267 pdksh Public Domain Korn Shell
268 mksh MirOS BSD Korn Shell
269 wksh Window Korn Shell
270 zsh Z Shell
271 oash SCO OA (curses) Shell
272 posix IEEE 1003.2 Shell Standard
273 wsh ? Shell"
274 :type '(repeat (cons symbol symbol))
275 :version "24.4" ; added dash
276 :group 'sh-script)
278 (defcustom sh-alias-alist
279 (append (if (eq system-type 'gnu/linux)
280 '((csh . tcsh)
281 (ksh . pdksh)))
282 ;; for the time being
283 '((ksh . ksh88)
284 (bash2 . bash)
285 (sh5 . sh)
286 ;; Android's system shell
287 ("^/system/bin/sh$" . mksh)))
288 "Alist for transforming shell names to what they really are.
289 Use this where the name of the executable doesn't correspond to
290 the type of shell it really is. Keys are regular expressions
291 matched against the full path of the interpreter. (For backward
292 compatibility, keys may also be symbols, which are matched
293 against the interpreter's basename. The values are symbols
294 naming the shell."
295 :type '(repeat (cons (radio
296 (regexp :tag "Regular expression")
297 (symbol :tag "Basename"))
298 (symbol :tag "Shell")))
299 :group 'sh-script)
302 (defcustom sh-shell-file
304 ;; On MSDOS and Windows, collapse $SHELL to lower-case and remove
305 ;; the executable extension, so comparisons with the list of
306 ;; known shells work.
307 (and (memq system-type '(ms-dos windows-nt))
308 (let* ((shell (getenv "SHELL"))
309 (shell-base
310 (and shell (file-name-nondirectory shell))))
311 ;; shell-script mode doesn't support DOS/Windows shells,
312 ;; so use the default instead.
313 (if (or (null shell)
314 (member (downcase shell-base)
315 '("command.com" "cmd.exe" "4dos.com" "ndos.com"
316 "cmdproxy.exe")))
317 "/bin/sh"
318 (file-name-sans-extension (downcase shell)))))
319 (getenv "SHELL")
320 "/bin/sh")
321 "The executable file name for the shell being programmed."
322 :type 'string
323 :group 'sh-script)
326 (defcustom sh-shell-arg
327 ;; bash does not need any options when run in a shell script,
328 '((bash)
329 (csh . "-f")
330 (pdksh)
331 ;; Bill_Mann@praxisint.com says -p with ksh can do harm.
332 (ksh88)
333 ;; -p means don't initialize functions from the environment.
334 (rc . "-p")
335 ;; Someone proposed -motif, but we don't want to encourage
336 ;; use of a non-free widget set.
337 (wksh)
338 ;; -f means don't run .zshrc.
339 (zsh . "-f"))
340 "Single argument string for the magic number. See `sh-feature'."
341 :type '(repeat (cons (symbol :tag "Shell")
342 (choice (const :tag "No Arguments" nil)
343 (string :tag "Arguments")
344 (sexp :format "Evaluate: %v"))))
345 :group 'sh-script)
347 (defcustom sh-imenu-generic-expression
348 `((sh
349 . ((nil
350 ;; function FOO
351 ;; function FOO()
352 "^\\s-*function\\s-+\\([[:alpha:]_][[:alnum:]_]*\\)\\s-*\\(?:()\\)?"
354 ;; FOO()
355 (nil
356 "^\\s-*\\([[:alpha:]_][[:alnum:]_]*\\)\\s-*()"
359 "Alist of regular expressions for recognizing shell function definitions.
360 See `sh-feature' and `imenu-generic-expression'."
361 :type '(alist :key-type (symbol :tag "Shell")
362 :value-type (alist :key-type (choice :tag "Title"
363 string
364 (const :tag "None" nil))
365 :value-type
366 (repeat :tag "Regexp, index..." sexp)))
367 :group 'sh-script
368 :version "20.4")
370 (defun sh-current-defun-name ()
371 "Find the name of function or variable at point.
372 For use in `add-log-current-defun-function'."
373 (save-excursion
374 (end-of-line)
375 (when (re-search-backward
376 (concat "\\(?:"
377 ;; function FOO
378 ;; function FOO()
379 "^\\s-*function\\s-+\\([[:alpha:]_][[:alnum:]_]*\\)\\s-*\\(?:()\\)?"
380 "\\)\\|\\(?:"
381 ;; FOO()
382 "^\\s-*\\([[:alpha:]_][[:alnum:]_]*\\)\\s-*()"
383 "\\)\\|\\(?:"
384 ;; FOO=
385 "^\\([[:alpha:]_][[:alnum:]_]*\\)="
386 "\\)")
387 nil t)
388 (or (match-string-no-properties 1)
389 (match-string-no-properties 2)
390 (match-string-no-properties 3)))))
392 (defvar sh-shell-variables nil
393 "Alist of shell variable names that should be included in completion.
394 These are used for completion in addition to all the variables named
395 in `process-environment'. Each element looks like (VAR . VAR), where
396 the car and cdr are the same symbol.")
398 (defvar sh-shell-variables-initialized nil
399 "Non-nil if `sh-shell-variables' is initialized.")
401 (defun sh-canonicalize-shell (shell)
402 "Convert a shell name SHELL to the one we should handle it as.
403 SHELL is a full path to the shell interpreter; return a shell
404 name symbol."
405 (cl-loop
406 with shell = (cond ((string-match "\\.exe\\'" shell)
407 (substring shell 0 (match-beginning 0)))
408 (t shell))
409 with shell-base = (intern (file-name-nondirectory shell))
410 for (key . value) in sh-alias-alist
411 if (and (stringp key) (string-match key shell)) return value
412 if (eq key shell-base) return value
413 finally return shell-base))
415 (defvar sh-shell (sh-canonicalize-shell sh-shell-file)
416 "The shell being programmed. This is set by \\[sh-set-shell].")
417 ;;;###autoload(put 'sh-shell 'safe-local-variable 'symbolp)
419 (define-abbrev-table 'sh-mode-abbrev-table ())
422 ;; I turned off this feature because it doesn't permit typing commands
423 ;; in the usual way without help.
424 ;;(defvar sh-abbrevs
425 ;; '((csh sh-abbrevs shell
426 ;; "switch" 'sh-case
427 ;; "getopts" 'sh-while-getopts)
429 ;; (es sh-abbrevs shell
430 ;; "function" 'sh-function)
432 ;; (ksh88 sh-abbrevs sh
433 ;; "select" 'sh-select)
435 ;; (rc sh-abbrevs shell
436 ;; "case" 'sh-case
437 ;; "function" 'sh-function)
439 ;; (sh sh-abbrevs shell
440 ;; "case" 'sh-case
441 ;; "function" 'sh-function
442 ;; "until" 'sh-until
443 ;; "getopts" 'sh-while-getopts)
445 ;; ;; The next entry is only used for defining the others
446 ;; (shell "for" sh-for
447 ;; "loop" sh-indexed-loop
448 ;; "if" sh-if
449 ;; "tmpfile" sh-tmp-file
450 ;; "while" sh-while)
452 ;; (zsh sh-abbrevs ksh88
453 ;; "repeat" 'sh-repeat))
454 ;; "Abbrev-table used in Shell-Script mode. See `sh-feature'.
455 ;;;Due to the internal workings of abbrev tables, the shell name symbol is
456 ;;;actually defined as the table for the like of \\[edit-abbrevs].")
460 (defun sh-mode-syntax-table (table &rest list)
461 "Copy TABLE and set syntax for successive CHARs according to strings S."
462 (setq table (copy-syntax-table table))
463 (while list
464 (modify-syntax-entry (pop list) (pop list) table))
465 table)
467 (defvar sh-mode-syntax-table
468 (sh-mode-syntax-table ()
469 ?\# "<"
470 ?\n ">#"
471 ?\" "\"\""
472 ?\' "\"'"
473 ?\` "\"`"
474 ;; ?$ might also have a ". p" syntax. Both "'" and ". p" seem
475 ;; to work fine. This is needed so that dabbrev-expand
476 ;; $VARNAME works.
477 ?$ "'"
478 ?! "_"
479 ?% "_"
480 ?: "_"
481 ?. "_"
482 ?^ "_"
483 ?~ "_"
484 ?, "_"
485 ?= "."
486 ?\; "."
487 ?| "."
488 ?& "."
489 ?< "."
490 ?> ".")
491 "The syntax table to use for Shell-Script mode.
492 This is buffer-local in every such buffer.")
494 (defvar sh-mode-syntax-table-input
495 '((sh . nil))
496 "Syntax-table used in Shell-Script mode. See `sh-feature'.")
498 (defvar sh-mode-map
499 (let ((map (make-sparse-keymap))
500 (menu-map (make-sparse-keymap)))
501 (define-key map "\C-c(" 'sh-function)
502 (define-key map "\C-c\C-w" 'sh-while)
503 (define-key map "\C-c\C-u" 'sh-until)
504 (define-key map "\C-c\C-t" 'sh-tmp-file)
505 (define-key map "\C-c\C-s" 'sh-select)
506 (define-key map "\C-c\C-r" 'sh-repeat)
507 (define-key map "\C-c\C-o" 'sh-while-getopts)
508 (define-key map "\C-c\C-l" 'sh-indexed-loop)
509 (define-key map "\C-c\C-i" 'sh-if)
510 (define-key map "\C-c\C-f" 'sh-for)
511 (define-key map "\C-c\C-c" 'sh-case)
512 (define-key map "\C-c?" 'sh-show-indent)
513 (define-key map "\C-c=" 'sh-set-indent)
514 (define-key map "\C-c<" 'sh-learn-line-indent)
515 (define-key map "\C-c>" 'sh-learn-buffer-indent)
516 (define-key map "\C-c\C-\\" 'sh-backslash-region)
518 (define-key map "=" 'sh-assignment)
519 (define-key map "\C-c+" 'sh-add)
520 (define-key map "\C-\M-x" 'sh-execute-region)
521 (define-key map "\C-c\C-x" 'executable-interpret)
522 (define-key map "\C-c\C-n" 'sh-send-line-or-region-and-step)
523 (define-key map "\C-c\C-d" 'sh-cd-here)
524 (define-key map "\C-c\C-z" 'sh-show-shell)
526 (define-key map [remap delete-backward-char]
527 'backward-delete-char-untabify)
528 (define-key map "\C-c:" 'sh-set-shell)
529 (define-key map [remap backward-sentence] 'sh-beginning-of-command)
530 (define-key map [remap forward-sentence] 'sh-end-of-command)
531 (define-key map [menu-bar sh-script] (cons "Sh-Script" menu-map))
532 (define-key menu-map [sh-learn-buffer-indent]
533 '(menu-item "Learn buffer indentation" sh-learn-buffer-indent
534 :help "Learn how to indent the buffer the way it currently is."))
535 (define-key menu-map [sh-learn-line-indent]
536 '(menu-item "Learn line indentation" sh-learn-line-indent
537 :help "Learn how to indent a line as it currently is indented"))
538 (define-key menu-map [sh-show-indent]
539 '(menu-item "Show indentation" sh-show-indent
540 :help "Show the how the current line would be indented"))
541 (define-key menu-map [sh-set-indent]
542 '(menu-item "Set indentation" sh-set-indent
543 :help "Set the indentation for the current line"))
545 (define-key menu-map [sh-pair]
546 '(menu-item "Insert braces and quotes in pairs"
547 electric-pair-mode
548 :button (:toggle . (bound-and-true-p electric-pair-mode))
549 :help "Inserting a brace or quote automatically inserts the matching pair"))
551 (define-key menu-map [sh-s0] '("--"))
552 ;; Insert
553 (define-key menu-map [sh-function]
554 '(menu-item "Function..." sh-function
555 :help "Insert a function definition"))
556 (define-key menu-map [sh-add]
557 '(menu-item "Addition..." sh-add
558 :help "Insert an addition of VAR and prefix DELTA for Bourne (type) shell"))
559 (define-key menu-map [sh-until]
560 '(menu-item "Until Loop" sh-until
561 :help "Insert an until loop"))
562 (define-key menu-map [sh-repeat]
563 '(menu-item "Repeat Loop" sh-repeat
564 :help "Insert a repeat loop definition"))
565 (define-key menu-map [sh-while]
566 '(menu-item "While Loop" sh-while
567 :help "Insert a while loop"))
568 (define-key menu-map [sh-getopts]
569 '(menu-item "Options Loop" sh-while-getopts
570 :help "Insert a while getopts loop."))
571 (define-key menu-map [sh-indexed-loop]
572 '(menu-item "Indexed Loop" sh-indexed-loop
573 :help "Insert an indexed loop from 1 to n."))
574 (define-key menu-map [sh-select]
575 '(menu-item "Select Statement" sh-select
576 :help "Insert a select statement "))
577 (define-key menu-map [sh-if]
578 '(menu-item "If Statement" sh-if
579 :help "Insert an if statement"))
580 (define-key menu-map [sh-for]
581 '(menu-item "For Loop" sh-for
582 :help "Insert a for loop"))
583 (define-key menu-map [sh-case]
584 '(menu-item "Case Statement" sh-case
585 :help "Insert a case/switch statement"))
586 (define-key menu-map [sh-s1] '("--"))
587 (define-key menu-map [sh-exec]
588 '(menu-item "Execute region" sh-execute-region
589 :help "Pass optional header and region to a subshell for noninteractive execution"))
590 (define-key menu-map [sh-exec-interpret]
591 '(menu-item "Execute script..." executable-interpret
592 :help "Run script with user-specified args, and collect output in a buffer"))
593 (define-key menu-map [sh-set-shell]
594 '(menu-item "Set shell type..." sh-set-shell
595 :help "Set this buffer's shell to SHELL (a string)"))
596 (define-key menu-map [sh-backslash-region]
597 '(menu-item "Backslash region" sh-backslash-region
598 :help "Insert, align, or delete end-of-line backslashes on the lines in the region."))
599 map)
600 "Keymap used in Shell-Script mode.")
602 (defvar sh-skeleton-pair-default-alist '((?( _ ?)) (?\))
603 (?[ ?\s _ ?\s ?]) (?\])
604 (?{ _ ?}) (?\}))
605 "Value to use for `skeleton-pair-default-alist' in Shell-Script mode.")
607 (defcustom sh-dynamic-complete-functions
608 '(shell-environment-variable-completion
609 shell-command-completion
610 comint-filename-completion)
611 "Functions for doing TAB dynamic completion."
612 :type '(repeat function)
613 :group 'sh-script)
615 (defcustom sh-assignment-regexp
616 `((csh . "\\<\\([[:alnum:]_]+\\)\\(\\[.+\\]\\)?[ \t]*[-+*/%^]?=")
617 ;; actually spaces are only supported in let/(( ... ))
618 (ksh88 . ,(concat "\\<\\([[:alnum:]_]+\\)\\(\\[.+\\]\\)?"
619 "[ \t]*\\(?:[-+*/%&|~^]\\|<<\\|>>\\)?="))
620 (bash . "\\<\\([[:alnum:]_]+\\)\\(\\[.+\\]\\)?\\+?=")
621 (rc . "\\<\\([[:alnum:]_*]+\\)[ \t]*=")
622 (sh . "\\<\\([[:alnum:]_]+\\)="))
623 "Regexp for the variable name and what may follow in an assignment.
624 First grouping matches the variable name. This is upto and including the `='
625 sign. See `sh-feature'."
626 :type '(repeat (cons (symbol :tag "Shell")
627 (choice regexp
628 (sexp :format "Evaluate: %v"))))
629 :group 'sh-script)
632 (defcustom sh-indentation 4
633 "The width for further indentation in Shell-Script mode."
634 :type 'integer
635 :group 'sh-script)
636 (put 'sh-indentation 'safe-local-variable 'integerp)
638 (defcustom sh-remember-variable-min 3
639 "Don't remember variables less than this length for completing reads."
640 :type 'integer
641 :group 'sh-script)
644 (defvar sh-header-marker nil
645 "When non-nil is the end of header for prepending by \\[sh-execute-region].
646 That command is also used for setting this variable.")
647 (make-variable-buffer-local 'sh-header-marker)
649 (defcustom sh-beginning-of-command
650 "\\([;({`|&]\\|\\`\\|[^\\]\n\\)[ \t]*\\([/~[:alnum:]:]\\)"
651 "Regexp to determine the beginning of a shell command.
652 The actual command starts at the beginning of the second \\(grouping\\)."
653 :type 'regexp
654 :group 'sh-script)
657 (defcustom sh-end-of-command
658 "\\([/~[:alnum:]:]\\)[ \t]*\\([;#)}`|&]\\|$\\)"
659 "Regexp to determine the end of a shell command.
660 The actual command ends at the end of the first \\(grouping\\)."
661 :type 'regexp
662 :group 'sh-script)
666 (defcustom sh-here-document-word "EOF"
667 "Word to delimit here documents.
668 If the first character of this string is \"-\", this is taken as
669 part of the redirection operator, rather than part of the
670 word (that is, \"<<-\" instead of \"<<\"). This is a feature
671 used by some shells (for example Bash) to indicate that leading
672 tabs inside the here document should be ignored. In this case,
673 Emacs indents the initial body and end of the here document with
674 tabs, to the same level as the start (note that apart from this
675 there is no support for indentation of here documents). This
676 will only work correctly if `sh-basic-offset' is a multiple of
677 `tab-width'.
679 Any quote characters or leading whitespace in the word are
680 removed when closing the here document."
681 :type 'string
682 :group 'sh-script)
685 (defvar sh-test
686 '((sh "[ ]" . 3)
687 (ksh88 "[[ ]]" . 4))
688 "Initial input in Bourne if, while and until skeletons. See `sh-feature'.")
691 ;; customized this out of sheer bravado. not for the faint of heart.
692 ;; but it *did* have an asterisk in the docstring!
693 (defcustom sh-builtins
694 '((bash sh-append posix
695 "." "alias" "bg" "bind" "builtin" "caller" "compgen" "complete"
696 "declare" "dirs" "disown" "enable" "fc" "fg" "help" "history"
697 "jobs" "kill" "let" "local" "popd" "printf" "pushd" "shopt"
698 "source" "suspend" "typeset" "unalias"
699 ;; bash4
700 "mapfile" "readarray" "coproc")
702 ;; The next entry is only used for defining the others
703 (bourne sh-append shell
704 "eval" "export" "getopts" "newgrp" "pwd" "read" "readonly"
705 "times" "ulimit")
707 (csh sh-append shell
708 "alias" "chdir" "glob" "history" "limit" "nice" "nohup" "rehash"
709 "setenv" "source" "time" "unalias" "unhash")
711 (dtksh sh-append wksh)
713 (es "access" "apids" "cd" "echo" "eval" "false" "let" "limit" "local"
714 "newpgrp" "result" "time" "umask" "var" "vars" "wait" "whatis")
716 (jsh sh-append sh
717 "bg" "fg" "jobs" "kill" "stop" "suspend")
719 (jcsh sh-append csh
720 "bg" "fg" "jobs" "kill" "notify" "stop" "suspend")
722 (ksh88 sh-append bourne
723 "alias" "bg" "false" "fc" "fg" "jobs" "kill" "let" "print" "time"
724 "typeset" "unalias" "whence")
726 (oash sh-append sh
727 "checkwin" "dateline" "error" "form" "menu" "newwin" "oadeinit"
728 "oaed" "oahelp" "oainit" "pp" "ppfile" "scan" "scrollok" "wattr"
729 "wclear" "werase" "win" "wmclose" "wmmessage" "wmopen" "wmove"
730 "wmtitle" "wrefresh")
732 (pdksh sh-append ksh88
733 "bind")
735 (posix sh-append sh
736 "command")
738 (rc "builtin" "cd" "echo" "eval" "limit" "newpgrp" "shift" "umask" "wait"
739 "whatis")
741 (sh sh-append bourne
742 "hash" "test" "type")
744 ;; The next entry is only used for defining the others
745 (shell "cd" "echo" "eval" "set" "shift" "umask" "unset" "wait")
747 (wksh sh-append ksh88
748 ;; FIXME: This looks too much like a regexp. --Stef
749 "Xt[A-Z][A-Za-z]*")
751 (zsh sh-append ksh88
752 "autoload" "bindkey" "builtin" "chdir" "compctl" "declare" "dirs"
753 "disable" "disown" "echotc" "enable" "functions" "getln" "hash"
754 "history" "integer" "limit" "local" "log" "popd" "pushd" "r"
755 "readonly" "rehash" "sched" "setopt" "source" "suspend" "true"
756 "ttyctl" "type" "unfunction" "unhash" "unlimit" "unsetopt" "vared"
757 "which"))
758 "List of all shell builtins for completing read and fontification.
759 Note that on some systems not all builtins are available or some are
760 implemented as aliases. See `sh-feature'."
761 :type '(repeat (cons (symbol :tag "Shell")
762 (choice (repeat string)
763 (sexp :format "Evaluate: %v"))))
764 :version "24.4" ; bash4 additions
765 :group 'sh-script)
769 (defcustom sh-leading-keywords
770 '((bash sh-append sh
771 "time")
773 (csh "else")
775 (es "true" "unwind-protect" "whatis")
777 (rc "else")
779 (sh "!" "do" "elif" "else" "if" "then" "trap" "type" "until" "while"))
780 "List of keywords that may be immediately followed by a builtin or keyword.
781 Given some confusion between keywords and builtins depending on shell and
782 system, the distinction here has been based on whether they influence the
783 flow of control or syntax. See `sh-feature'."
784 :type '(repeat (cons (symbol :tag "Shell")
785 (choice (repeat string)
786 (sexp :format "Evaluate: %v"))))
787 :group 'sh-script)
790 (defcustom sh-other-keywords
791 '((bash sh-append bourne
792 "bye" "logout" "select")
794 ;; The next entry is only used for defining the others
795 (bourne sh-append sh
796 "function")
798 (csh sh-append shell
799 "breaksw" "default" "end" "endif" "endsw" "foreach" "goto"
800 "if" "logout" "onintr" "repeat" "switch" "then" "while")
802 (es "break" "catch" "exec" "exit" "fn" "for" "forever" "fork" "if"
803 "return" "throw" "while")
805 (ksh88 sh-append bourne
806 "select")
808 (rc "break" "case" "exec" "exit" "fn" "for" "if" "in" "return" "switch"
809 "while")
811 (sh sh-append shell
812 "done" "esac" "fi" "for" "in" "return")
814 ;; The next entry is only used for defining the others
815 (shell "break" "case" "continue" "exec" "exit")
817 (zsh sh-append bash
818 "select" "foreach"))
819 "List of keywords not in `sh-leading-keywords'.
820 See `sh-feature'."
821 :type '(repeat (cons (symbol :tag "Shell")
822 (choice (repeat string)
823 (sexp :format "Evaluate: %v"))))
824 :group 'sh-script)
828 (defvar sh-variables
829 '((bash sh-append sh
830 "allow_null_glob_expansion" "auto_resume" "BASH" "BASH_ENV"
831 "BASH_VERSINFO" "BASH_VERSION" "cdable_vars" "COMP_CWORD"
832 "COMP_LINE" "COMP_POINT" "COMP_WORDS" "COMPREPLY" "DIRSTACK"
833 "ENV" "EUID" "FCEDIT" "FIGNORE" "FUNCNAME"
834 "glob_dot_filenames" "GLOBIGNORE" "GROUPS" "histchars"
835 "HISTCMD" "HISTCONTROL" "HISTFILE" "HISTFILESIZE"
836 "HISTIGNORE" "history_control" "HISTSIZE"
837 "hostname_completion_file" "HOSTFILE" "HOSTTYPE" "IGNOREEOF"
838 "ignoreeof" "INPUTRC" "LINENO" "MACHTYPE" "MAIL_WARNING"
839 "noclobber" "nolinks" "notify" "no_exit_on_failed_exec"
840 "NO_PROMPT_VARS" "OLDPWD" "OPTERR" "OSTYPE" "PIPESTATUS"
841 "PPID" "POSIXLY_CORRECT" "PROMPT_COMMAND" "PS3" "PS4"
842 "pushd_silent" "PWD" "RANDOM" "REPLY" "SECONDS" "SHELLOPTS"
843 "SHLVL" "TIMEFORMAT" "TMOUT" "UID")
845 (csh sh-append shell
846 "argv" "cdpath" "child" "echo" "histchars" "history" "home"
847 "ignoreeof" "mail" "noclobber" "noglob" "nonomatch" "path" "prompt"
848 "shell" "status" "time" "verbose")
850 (es sh-append shell
851 "apid" "cdpath" "CDPATH" "history" "home" "ifs" "noexport" "path"
852 "pid" "prompt" "signals")
854 (jcsh sh-append csh
855 "notify")
857 (ksh88 sh-append sh
858 "ENV" "ERRNO" "FCEDIT" "FPATH" "HISTFILE" "HISTSIZE" "LINENO"
859 "OLDPWD" "PPID" "PS3" "PS4" "PWD" "RANDOM" "REPLY" "SECONDS"
860 "TMOUT")
862 (oash sh-append sh
863 "FIELD" "FIELD_MAX" "LAST_KEY" "OALIB" "PP_ITEM" "PP_NUM")
865 (rc sh-append shell
866 "apid" "apids" "cdpath" "CDPATH" "history" "home" "ifs" "path" "pid"
867 "prompt" "status")
869 (sh sh-append shell
870 "CDPATH" "IFS" "OPTARG" "OPTIND" "PS1" "PS2")
872 ;; The next entry is only used for defining the others
873 (shell "COLUMNS" "EDITOR" "HOME" "HUSHLOGIN" "LANG" "LC_COLLATE"
874 "LC_CTYPE" "LC_MESSAGES" "LC_MONETARY" "LC_NUMERIC" "LC_TIME"
875 "LINES" "LOGNAME" "MAIL" "MAILCHECK" "MAILPATH" "PAGER" "PATH"
876 "SHELL" "TERM" "TERMCAP" "TERMINFO" "VISUAL")
878 (tcsh sh-append csh
879 "addsuffix" "ampm" "autocorrect" "autoexpand" "autolist"
880 "autologout" "chase_symlinks" "correct" "dextract" "edit" "el"
881 "fignore" "gid" "histlit" "HOST" "HOSTTYPE" "HPATH"
882 "ignore_symlinks" "listjobs" "listlinks" "listmax" "matchbeep"
883 "nobeep" "NOREBIND" "oid" "printexitvalue" "prompt2" "prompt3"
884 "pushdsilent" "pushdtohome" "recexact" "recognize_only_executables"
885 "rmstar" "savehist" "SHLVL" "showdots" "sl" "SYSTYPE" "tcsh" "term"
886 "tperiod" "tty" "uid" "version" "visiblebell" "watch" "who"
887 "wordchars")
889 (zsh sh-append ksh88
890 "BAUD" "bindcmds" "cdpath" "DIRSTACKSIZE" "fignore" "FIGNORE" "fpath"
891 "HISTCHARS" "hostcmds" "hosts" "HOSTS" "LISTMAX" "LITHISTSIZE"
892 "LOGCHECK" "mailpath" "manpath" "NULLCMD" "optcmds" "path" "POSTEDIT"
893 "prompt" "PROMPT" "PROMPT2" "PROMPT3" "PROMPT4" "psvar" "PSVAR"
894 "READNULLCMD" "REPORTTIME" "RPROMPT" "RPS1" "SAVEHIST" "SPROMPT"
895 "STTY" "TIMEFMT" "TMOUT" "TMPPREFIX" "varcmds" "watch" "WATCH"
896 "WATCHFMT" "WORDCHARS" "ZDOTDIR"))
897 "List of all shell variables available for completing read.
898 See `sh-feature'.")
901 ;; Font-Lock support
903 (defface sh-heredoc
904 '((((min-colors 88) (class color)
905 (background dark))
906 (:foreground "yellow1" :weight bold))
907 (((class color)
908 (background dark))
909 (:foreground "yellow" :weight bold))
910 (((class color)
911 (background light))
912 (:foreground "tan1" ))
914 (:weight bold)))
915 "Face to show a here-document."
916 :group 'sh-indentation)
918 ;; These colors are probably icky. It's just a placeholder though.
919 (defface sh-quoted-exec
920 '((((class color) (background dark))
921 (:foreground "salmon"))
922 (((class color) (background light))
923 (:foreground "magenta"))
925 (:weight bold)))
926 "Face to show quoted execs like \\=`blabla\\=`."
927 :group 'sh-indentation)
929 (defface sh-escaped-newline '((t :inherit font-lock-string-face))
930 "Face used for (non-escaped) backslash at end of a line in Shell-script mode."
931 :group 'sh-script
932 :version "22.1")
934 (defvar sh-font-lock-keywords-var
935 '((csh sh-append shell
936 ("\\${?[#?]?\\([[:alpha:]_][[:alnum:]_]*\\|0\\)" 1
937 font-lock-variable-name-face))
939 (es sh-append executable-font-lock-keywords
940 ("\\$#?\\([[:alpha:]_][[:alnum:]_]*\\|[0-9]+\\)" 1
941 font-lock-variable-name-face))
943 (rc sh-append es)
944 (bash sh-append sh ("\\$(\\(\\sw+\\)" (1 'sh-quoted-exec t) ))
945 (sh sh-append shell
946 ;; Variable names.
947 ("\\$\\({#?\\)?\\([[:alpha:]_][[:alnum:]_]*\\|[-#?@!]\\)" 2
948 font-lock-variable-name-face)
949 ;; Function names.
950 ("^\\(\\sw+\\)[ \t]*(" 1 font-lock-function-name-face)
951 ("\\<\\(function\\)\\>[ \t]*\\(\\sw+\\)?"
952 (1 font-lock-keyword-face) (2 font-lock-function-name-face nil t))
953 ("\\(?:^\\s *\\|[[();&|]\\s *\\|\\(?:\\s +-[ao]\\|if\\|else\\|then\\|while\\|do\\)\\s +\\)\\(!\\)"
954 1 font-lock-negation-char-face))
956 ;; The next entry is only used for defining the others
957 (shell
958 ;; Using font-lock-string-face here confuses sh-get-indent-info.
959 ("\\(^\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\\\)$" 3 'sh-escaped-newline)
960 ("\\\\[^[:alnum:]]" 0 font-lock-string-face)
961 ("\\${?\\([[:alpha:]_][[:alnum:]_]*\\|[0-9]+\\|[$*_]\\)" 1
962 font-lock-variable-name-face))
963 (rpm sh-append rpm2
964 ("%{?\\(\\sw+\\)" 1 font-lock-keyword-face))
965 (rpm2 sh-append shell
966 ("^Summary:\\(.*\\)$" (1 font-lock-doc-face t))
967 ("^\\(\\sw+\\):" 1 font-lock-variable-name-face)))
968 "Default expressions to highlight in Shell Script modes. See `sh-feature'.")
970 (defvar sh-font-lock-keywords-var-1
971 '((sh "[ \t]in\\>"))
972 "Subdued level highlighting for Shell Script modes.")
974 (defvar sh-font-lock-keywords-var-2 ()
975 "Gaudy level highlighting for Shell Script modes.")
977 ;; These are used for the syntax table stuff (derived from cperl-mode).
978 ;; Note: parse-sexp-lookup-properties must be set to t for it to work.
979 (defconst sh-st-punc (string-to-syntax "."))
980 (defconst sh-here-doc-syntax (string-to-syntax "|")) ;; generic string
982 (eval-and-compile
983 (defconst sh-escaped-line-re
984 ;; Should match until the real end-of-continued-line, but if that is not
985 ;; possible (because we bump into EOB or the search bound), then we should
986 ;; match until the search bound.
987 "\\(?:\\(?:.*[^\\\n]\\)?\\(?:\\\\\\\\\\)*\\\\\n\\)*.*")
989 (defconst sh-here-doc-open-re
990 (concat "[^<]<<-?\\s-*\\\\?\\(\\(?:['\"][^'\"]+['\"]\\|\\sw\\|[-/~._]\\)+\\)"
991 sh-escaped-line-re "\\(\n\\)")))
993 (defun sh--inside-noncommand-expression (pos)
994 (save-excursion
995 (let ((ppss (syntax-ppss pos)))
996 (when (nth 1 ppss)
997 (goto-char (nth 1 ppss))
999 (pcase (char-after)
1000 ;; ((...)) or $((...)) or $[...] or ${...}. Nested
1001 ;; parenthesis can occur inside the first of these forms, so
1002 ;; parse backward recursively.
1003 (`?\( (eq ?\( (char-before)))
1004 ((or `?\{ `?\[) (eq ?\$ (char-before))))
1005 (sh--inside-noncommand-expression (1- (point))))))))
1007 (defun sh-font-lock-open-heredoc (start string eol)
1008 "Determine the syntax of the \\n after a <<EOF.
1009 START is the position of <<.
1010 STRING is the actual word used as delimiter (e.g. \"EOF\").
1011 INDENTED is non-nil if the here document's content (and the EOF mark) can
1012 be indented (i.e. a <<- was used rather than just <<).
1013 Point is at the beginning of the next line."
1014 (unless (or (memq (char-before start) '(?< ?>))
1015 (sh-in-comment-or-string start)
1016 (sh--inside-noncommand-expression start))
1017 ;; We're looking at <<STRING, so we add "^STRING$" to the syntactic
1018 ;; font-lock keywords to detect the end of this here document.
1019 (let ((str (replace-regexp-in-string "['\"]" "" string))
1020 (ppss (save-excursion (syntax-ppss eol))))
1021 (if (nth 4 ppss)
1022 ;; The \n not only starts the heredoc but also closes a comment.
1023 ;; Let's close the comment just before the \n.
1024 (put-text-property (1- eol) eol 'syntax-table '(12))) ;">"
1025 (if (or (nth 5 ppss) (> (count-lines start eol) 1))
1026 ;; If the sh-escaped-line-re part of sh-here-doc-open-re has matched
1027 ;; several lines, make sure we refontify them together.
1028 ;; Furthermore, if (nth 5 ppss) is non-nil (i.e. the \n is
1029 ;; escaped), it means the right \n is actually further down.
1030 ;; Don't bother fixing it now, but place a multiline property so
1031 ;; that when jit-lock-context-* refontifies the rest of the
1032 ;; buffer, it also refontifies the current line with it.
1033 (put-text-property start (1+ eol) 'syntax-multiline t))
1034 (put-text-property eol (1+ eol) 'sh-here-doc-marker str)
1035 (prog1 sh-here-doc-syntax
1036 (goto-char (+ 2 start))))))
1038 (defun sh-syntax-propertize-here-doc (end)
1039 (let ((ppss (syntax-ppss)))
1040 (when (eq t (nth 3 ppss))
1041 (let ((key (get-text-property (nth 8 ppss) 'sh-here-doc-marker))
1042 (case-fold-search nil))
1043 (when (re-search-forward
1044 (concat "^\\([ \t]*\\)" (regexp-quote key) "\\(\n\\)")
1045 end 'move)
1046 (let ((eol (match-beginning 2)))
1047 (put-text-property eol (1+ eol)
1048 'syntax-table sh-here-doc-syntax)))))))
1050 (defun sh-font-lock-quoted-subshell (limit)
1051 "Search for a subshell embedded in a string.
1052 Find all the unescaped \" characters within said subshell, remembering that
1053 subshells can nest."
1054 (when (eq ?\" (nth 3 (syntax-ppss))) ; Check we matched an opening quote.
1055 ;; bingo we have a $( or a ` inside a ""
1056 (let (;; `state' can be: double-quote, backquote, code.
1057 (state (if (eq (char-before) ?`) 'backquote 'code))
1058 (startpos (point))
1059 ;; Stacked states in the context.
1060 (states '(double-quote)))
1061 (while (and state (progn (skip-chars-forward "^'\\\\\"`$()" limit)
1062 (< (point) limit)))
1063 ;; unescape " inside a $( ... ) construct.
1064 (pcase (char-after)
1065 (?\' (pcase state
1066 (`double-quote nil)
1067 (_ (forward-char 1)
1068 ;; FIXME: mark skipped double quotes as punctuation syntax.
1069 (let ((spos (point)))
1070 (skip-chars-forward "^'" limit)
1071 (save-excursion
1072 (let ((epos (point)))
1073 (goto-char spos)
1074 (while (search-forward "\"" epos t)
1075 (put-text-property (point) (1- (point))
1076 'syntax-table '(1)))))))))
1077 (?\\ (forward-char 1))
1078 (?\" (pcase state
1079 (`double-quote (setq state (pop states)))
1080 (_ (push state states) (setq state 'double-quote)))
1081 (if state (put-text-property (point) (1+ (point))
1082 'syntax-table '(1))))
1083 (?\` (pcase state
1084 (`backquote (setq state (pop states)))
1085 (_ (push state states) (setq state 'backquote))))
1086 (?\$ (if (not (eq (char-after (1+ (point))) ?\())
1088 (forward-char 1)
1089 (pcase state
1090 (_ (push state states) (setq state 'code)))))
1091 (?\( (pcase state
1092 (`double-quote nil)
1093 (_ (push state states) (setq state 'code))))
1094 (?\) (pcase state
1095 (`double-quote nil)
1096 (_ (setq state (pop states)))))
1097 (_ (error "Internal error in sh-font-lock-quoted-subshell")))
1098 (forward-char 1))
1099 (when (< startpos (line-beginning-position))
1100 (put-text-property startpos (point) 'syntax-multiline t)
1101 (add-hook 'syntax-propertize-extend-region-functions
1102 'syntax-propertize-multiline nil t))
1106 (defun sh-is-quoted-p (pos)
1107 (and (eq (char-before pos) ?\\)
1108 (not (sh-is-quoted-p (1- pos)))))
1110 (defun sh-font-lock-paren (start)
1111 (unless (nth 8 (syntax-ppss))
1112 (save-excursion
1113 (let ((open nil))
1114 (goto-char start)
1115 ;; Skip through all patterns
1116 (while
1117 (progn
1118 (while
1119 (progn
1120 (forward-comment (- (point-max)))
1121 (when (and (eolp) (sh-is-quoted-p (point)))
1122 (forward-char -1)
1123 t)))
1124 ;; Skip through one pattern
1125 (while
1126 (or (/= 0 (skip-syntax-backward "w_"))
1127 (/= 0 (skip-chars-backward "-$=?[]*@/\\\\"))
1128 (and (sh-is-quoted-p (1- (point)))
1129 (goto-char (- (point) 2)))
1130 (when (memq (char-before) '(?\" ?\' ?\}))
1131 (condition-case nil (progn (backward-sexp 1) t)
1132 (error nil)))))
1133 ;; Patterns can be preceded by an open-paren (bug#1320).
1134 (when (eq (char-before (point)) ?\()
1135 (backward-char 1)
1136 (setq open (point)))
1137 (while (progn
1138 (forward-comment (- (point-max)))
1139 ;; Maybe we've bumped into an escaped newline.
1140 (sh-is-quoted-p (point)))
1141 (backward-char 1))
1142 (when (eq (char-before) ?|)
1143 (backward-char 1) t)))
1144 (and (> (point) (1+ (point-min)))
1145 (progn (backward-char 2)
1146 (if (> start (line-end-position))
1147 (put-text-property (point) (1+ start)
1148 'syntax-multiline t))
1149 ;; FIXME: The `in' may just be a random argument to
1150 ;; a normal command rather than the real `in' keyword.
1151 ;; I.e. we should look back to try and find the
1152 ;; corresponding `case'.
1153 (and (looking-at ";[;&]\\|\\_<in")
1154 ;; ";; esac )" is a case that looks
1155 ;; like a case-pattern but it's really just a close
1156 ;; paren after a case statement. I.e. if we skipped
1157 ;; over `esac' just now, we're not looking
1158 ;; at a case-pattern.
1159 (not (looking-at "..[ \t\n]+esac[^[:word:]_]"))))
1160 (progn
1161 (when open
1162 (put-text-property open (1+ open) 'syntax-table sh-st-punc))
1163 sh-st-punc))))))
1165 (defun sh-font-lock-backslash-quote ()
1166 (if (eq (save-excursion (nth 3 (syntax-ppss (match-beginning 0)))) ?\')
1167 ;; In a '...' the backslash is not escaping.
1168 sh-st-punc
1169 nil))
1171 (defun sh-syntax-propertize-function (start end)
1172 (goto-char start)
1173 (sh-syntax-propertize-here-doc end)
1174 (funcall
1175 (syntax-propertize-rules
1176 (sh-here-doc-open-re
1177 (2 (sh-font-lock-open-heredoc
1178 (match-beginning 0) (match-string 1) (match-beginning 2))))
1179 ("\\s|" (0 (prog1 nil (sh-syntax-propertize-here-doc end))))
1180 ;; A `#' begins a comment when it is unquoted and at the
1181 ;; beginning of a word. In the shell, words are separated by
1182 ;; metacharacters. The list of special chars is taken from
1183 ;; the single-unix spec of the shell command language (under
1184 ;; `quoting') but with `$' removed.
1185 ("\\(?:[^|&;<>()`\\\"' \t\n]\\|\\${\\)\\(#+\\)" (1 "_"))
1186 ;; In a '...' the backslash is not escaping.
1187 ("\\(\\\\\\)'" (1 (sh-font-lock-backslash-quote)))
1188 ;; Make sure $@ and $? are correctly recognized as sexps.
1189 ("\\$\\([?@]\\)" (1 "_"))
1190 ;; Distinguish the special close-paren in `case'.
1191 (")" (0 (sh-font-lock-paren (match-beginning 0))))
1192 ;; Highlight (possibly nested) subshells inside "" quoted
1193 ;; regions correctly.
1194 ("\"\\(?:\\(?:[^\\\"]\\|\\\\.\\)*?\\)??\\(\\$(\\|`\\)"
1195 (1 (ignore
1196 (if (nth 8 (save-excursion (syntax-ppss (match-beginning 0))))
1197 (goto-char (1+ (match-beginning 0)))
1198 ;; Save excursion because we want to also apply other
1199 ;; syntax-propertize rules within the affected region.
1200 (save-excursion
1201 (sh-font-lock-quoted-subshell end)))))))
1202 (point) end))
1203 (defun sh-font-lock-syntactic-face-function (state)
1204 (let ((q (nth 3 state)))
1205 (if q
1206 (if (characterp q)
1207 (if (eq q ?\`) 'sh-quoted-exec font-lock-string-face)
1208 'sh-heredoc)
1209 font-lock-comment-face)))
1211 (defgroup sh-indentation nil
1212 "Variables controlling indentation in shell scripts.
1214 Note: customizing these variables will not affect existing buffers if
1215 `sh-make-vars-local' is non-nil. See the documentation for
1216 variable `sh-make-vars-local', command `sh-make-vars-local'
1217 and command `sh-reset-indent-vars-to-global-values'."
1218 :group 'sh-script)
1221 (defcustom sh-set-shell-hook nil
1222 "Hook run by `sh-set-shell'."
1223 :type 'hook
1224 :group 'sh-script)
1226 (defcustom sh-mode-hook '(sh-electric-here-document-mode)
1227 "Hook run by `sh-mode'."
1228 :type 'hook
1229 :options '(sh-electric-here-document-mode)
1230 :group 'sh-script)
1232 (defcustom sh-learn-basic-offset nil
1233 "When `sh-guess-basic-offset' should learn `sh-basic-offset'.
1235 nil mean: never.
1236 t means: only if there seems to be an obvious value.
1237 Anything else means: whenever we have a \"good guess\" as to the value."
1238 :type '(choice
1239 (const :tag "Never" nil)
1240 (const :tag "Only if sure" t)
1241 (const :tag "If have a good guess" usually))
1242 :group 'sh-indentation)
1244 (defcustom sh-popup-occur-buffer nil
1245 "Controls when `sh-learn-buffer-indent' pops the `*indent*' buffer.
1246 If t it is always shown. If nil, it is shown only when there
1247 are conflicts."
1248 :type '(choice
1249 (const :tag "Only when there are conflicts." nil)
1250 (const :tag "Always" t))
1251 :group 'sh-indentation)
1253 (defcustom sh-blink t
1254 "If non-nil, `sh-show-indent' shows the line indentation is relative to.
1255 The position on the line is not necessarily meaningful.
1256 In some cases the line will be the matching keyword, but this is not
1257 always the case."
1258 :type 'boolean
1259 :group 'sh-indentation)
1261 (defcustom sh-first-lines-indent 0
1262 "The indentation of the first non-blank non-comment line.
1263 Usually 0 meaning first column.
1264 Can be set to a number, or to nil which means leave it as is."
1265 :type '(choice
1266 (const :tag "Leave as is" nil)
1267 (integer :tag "Column number"
1268 :menu-tag "Indent to this col (0 means first col)" ))
1269 :group 'sh-indentation)
1272 (defcustom sh-basic-offset 4
1273 "The default indentation increment.
1274 This value is used for the `+' and `-' symbols in an indentation variable."
1275 :type 'integer
1276 :group 'sh-indentation)
1277 (put 'sh-basic-offset 'safe-local-variable 'integerp)
1279 (defcustom sh-indent-comment t
1280 "How a comment line is to be indented.
1281 nil means leave it as it is;
1282 t means indent it as a normal line, aligning it to previous non-blank
1283 non-comment line;
1284 a number means align to that column, e.g. 0 means first column."
1285 :type '(choice
1286 (const :tag "Leave as is." nil)
1287 (const :tag "Indent as a normal line." t)
1288 (integer :menu-tag "Indent to this col (0 means first col)."
1289 :tag "Indent to column number.") )
1290 :version "24.3"
1291 :group 'sh-indentation)
1294 (defvar sh-debug nil
1295 "Enable lots of debug messages - if function `sh-debug' is enabled.")
1298 ;; Uncomment this defun and comment the defmacro for debugging.
1299 ;; (defun sh-debug (&rest args)
1300 ;; "For debugging: display message ARGS if variable SH-DEBUG is non-nil."
1301 ;; (if sh-debug
1302 ;; (apply 'message args)))
1303 (defmacro sh-debug (&rest _args))
1305 (defconst sh-symbol-list
1306 '((const :tag "+ " :value +
1307 :menu-tag "+ Indent right by sh-basic-offset")
1308 (const :tag "- " :value -
1309 :menu-tag "- Indent left by sh-basic-offset")
1310 (const :tag "++" :value ++
1311 :menu-tag "++ Indent right twice sh-basic-offset")
1312 (const :tag "--" :value --
1313 :menu-tag "-- Indent left twice sh-basic-offset")
1314 (const :tag "* " :value *
1315 :menu-tag "* Indent right half sh-basic-offset")
1316 (const :tag "/ " :value /
1317 :menu-tag "/ Indent left half sh-basic-offset")))
1319 (defcustom sh-indent-for-else 0
1320 "How much to indent an `else' relative to its `if'. Usually 0."
1321 :type `(choice
1322 (integer :menu-tag "A number (positive=>indent right)"
1323 :tag "A number")
1324 (const :tag "--") ;; separator!
1325 ,@ sh-symbol-list
1327 :group 'sh-indentation)
1329 (defconst sh-number-or-symbol-list
1330 (append '((integer :menu-tag "A number (positive=>indent right)"
1331 :tag "A number")
1332 (const :tag "--")) ; separator
1333 sh-symbol-list))
1335 (defcustom sh-indent-for-fi 0
1336 "How much to indent a `fi' relative to its `if'. Usually 0."
1337 :type `(choice ,@ sh-number-or-symbol-list )
1338 :group 'sh-indentation)
1340 (defcustom sh-indent-for-done 0
1341 "How much to indent a `done' relative to its matching stmt. Usually 0."
1342 :type `(choice ,@ sh-number-or-symbol-list )
1343 :group 'sh-indentation)
1345 (defcustom sh-indent-after-else '+
1346 "How much to indent a statement after an `else' statement."
1347 :type `(choice ,@ sh-number-or-symbol-list )
1348 :group 'sh-indentation)
1350 (defcustom sh-indent-after-if '+
1351 "How much to indent a statement after an `if' statement.
1352 This includes lines after `else' and `elif' statements, too, but
1353 does not affect the `else', `elif' or `fi' statements themselves."
1354 :type `(choice ,@ sh-number-or-symbol-list )
1355 :group 'sh-indentation)
1357 (defcustom sh-indent-for-then 0
1358 "How much to indent a `then' relative to its `if'."
1359 :type `(choice ,@ sh-number-or-symbol-list )
1360 :group 'sh-indentation)
1362 (defcustom sh-indent-for-do 0
1363 "How much to indent a `do' statement.
1364 This is relative to the statement before the `do', typically a
1365 `while', `until', `for', `repeat' or `select' statement."
1366 :type `(choice ,@ sh-number-or-symbol-list)
1367 :group 'sh-indentation)
1369 (defcustom sh-indent-after-do '+
1370 "How much to indent a line after a `do' statement.
1371 This is used when the `do' is the first word of the line.
1372 This is relative to the statement before the `do', typically a
1373 `while', `until', `for', `repeat' or `select' statement."
1374 :type `(choice ,@ sh-number-or-symbol-list)
1375 :group 'sh-indentation)
1377 (defcustom sh-indent-after-loop-construct '+
1378 "How much to indent a statement after a loop construct.
1380 This variable is used when the keyword `do' is on the same line as the
1381 loop statement (e.g., `until', `while' or `for').
1382 If the `do' is on a line by itself, then `sh-indent-after-do' is used instead."
1383 :type `(choice ,@ sh-number-or-symbol-list)
1384 :group 'sh-indentation)
1387 (defcustom sh-indent-after-done 0
1388 "How much to indent a statement after a `done' keyword.
1389 Normally this is 0, which aligns the `done' to the matching
1390 looping construct line.
1391 Setting it non-zero allows you to have the `do' statement on a line
1392 by itself and align the done under to do."
1393 :type `(choice ,@ sh-number-or-symbol-list)
1394 :group 'sh-indentation)
1396 (defcustom sh-indent-for-case-label '+
1397 "How much to indent a case label statement.
1398 This is relative to the line containing the `case' statement."
1399 :type `(choice ,@ sh-number-or-symbol-list)
1400 :group 'sh-indentation)
1402 (defcustom sh-indent-for-case-alt '++
1403 "How much to indent statements after the case label.
1404 This is relative to the line containing the `case' statement."
1405 :type `(choice ,@ sh-number-or-symbol-list)
1406 :group 'sh-indentation)
1409 (defcustom sh-indent-for-continuation '+
1410 "How much to indent for a continuation statement."
1411 :type `(choice ,@ sh-number-or-symbol-list)
1412 :group 'sh-indentation)
1414 (defcustom sh-indent-after-open '+
1415 "How much to indent after a line with an opening parenthesis or brace.
1416 For an open paren after a function, `sh-indent-after-function' is used."
1417 :type `(choice ,@ sh-number-or-symbol-list)
1418 :group 'sh-indentation)
1420 (defcustom sh-indent-after-function '+
1421 "How much to indent after a function line."
1422 :type `(choice ,@ sh-number-or-symbol-list)
1423 :group 'sh-indentation)
1425 ;; These 2 are for the rc shell:
1427 (defcustom sh-indent-after-switch '+
1428 "How much to indent a `case' statement relative to the `switch' statement.
1429 This is for the rc shell."
1430 :type `(choice ,@ sh-number-or-symbol-list)
1431 :group 'sh-indentation)
1433 (defcustom sh-indent-after-case '+
1434 "How much to indent a statement relative to the `case' statement.
1435 This is for the rc shell."
1436 :type `(choice ,@ sh-number-or-symbol-list)
1437 :group 'sh-indentation)
1439 (defcustom sh-backslash-column 48
1440 "Column in which `sh-backslash-region' inserts backslashes."
1441 :type 'integer
1442 :group 'sh)
1444 (defcustom sh-backslash-align t
1445 "If non-nil, `sh-backslash-region' will align backslashes."
1446 :type 'boolean
1447 :group 'sh)
1449 ;; Internal use - not designed to be changed by the user:
1451 (defun sh-mkword-regexpr (word)
1452 "Make a regexp which matches WORD as a word.
1453 This specifically excludes an occurrence of WORD followed by
1454 punctuation characters like `-'."
1455 (concat word "\\([^-[:alnum:]_]\\|$\\)"))
1457 (defconst sh-re-done (sh-mkword-regexpr "done"))
1460 (defconst sh-kws-for-done
1461 '((sh . ( "while" "until" "for" ) )
1462 (bash . ( "while" "until" "for" "select" ) )
1463 (ksh88 . ( "while" "until" "for" "select" ) )
1464 (zsh . ( "while" "until" "for" "repeat" "select" ) ) )
1465 "Which keywords can match the word `done' in this shell.")
1468 (defconst sh-indent-supported
1469 '((sh . sh)
1470 (csh . nil)
1471 (rc . rc))
1472 "Indentation rule set to use for each shell type.")
1474 (defvar sh-indent-supported-here nil
1475 "Non-nil if we support indentation for the current buffer's shell type.")
1477 (defconst sh-var-list
1479 sh-basic-offset sh-first-lines-indent sh-indent-after-case
1480 sh-indent-after-do sh-indent-after-done
1481 sh-indent-after-else
1482 sh-indent-after-if
1483 sh-indent-after-loop-construct
1484 sh-indent-after-open
1485 sh-indent-comment
1486 sh-indent-for-case-alt
1487 sh-indent-for-case-label
1488 sh-indent-for-continuation
1489 sh-indent-for-do
1490 sh-indent-for-done
1491 sh-indent-for-else
1492 sh-indent-for-fi
1493 sh-indent-for-then
1495 "A list of variables used by script mode to control indentation.
1496 This list is used when switching between buffer-local and global
1497 values of variables, and for the commands using indentation styles.")
1499 (defvar sh-make-vars-local t
1500 "Controls whether indentation variables are local to the buffer.
1501 If non-nil, indentation variables are made local initially.
1502 If nil, you can later make the variables local by invoking
1503 command `sh-make-vars-local'.
1504 The default is t because I assume that in one Emacs session one is
1505 frequently editing existing scripts with different styles.")
1508 ;; inferior shell interaction
1509 ;; TODO: support multiple interactive shells
1510 (defvar-local sh-shell-process nil
1511 "The inferior shell process for interaction.")
1513 (defvar explicit-shell-file-name)
1515 (defun sh-shell-process (force)
1516 "Get a shell process for interaction.
1517 If FORCE is non-nil and no process found, create one."
1518 (if (process-live-p sh-shell-process)
1519 sh-shell-process
1520 (setq sh-shell-process
1521 (let ((found nil) proc
1522 (procs (process-list)))
1523 (while (and (not found) procs
1524 (process-live-p (setq proc (pop procs)))
1525 (process-command proc))
1526 (when (string-equal sh-shell (file-name-nondirectory
1527 (car (process-command proc))))
1528 (setq found proc)))
1529 (or found
1530 (and force
1531 (get-buffer-process
1532 (let ((explicit-shell-file-name sh-shell-file))
1533 (shell)))))))))
1535 (defun sh-show-shell ()
1536 "Pop the shell interaction buffer."
1537 (interactive)
1538 (pop-to-buffer (process-buffer (sh-shell-process t))))
1540 (defun sh-send-text (text)
1541 "Send the text to the `sh-shell-process'."
1542 (comint-send-string (sh-shell-process t) (concat text "\n")))
1544 (defun sh-cd-here ()
1545 "Change directory in the current interaction shell to the current one."
1546 (interactive)
1547 (sh-send-text (concat "cd " default-directory)))
1549 (defun sh-send-line-or-region-and-step ()
1550 "Send the current line to the inferior shell and step to the next line.
1551 When the region is active, send the region instead."
1552 (interactive)
1553 (let (from to end)
1554 (if (use-region-p)
1555 (setq from (region-beginning)
1556 to (region-end)
1557 end to)
1558 (setq from (line-beginning-position)
1559 to (line-end-position)
1560 end (1+ to)))
1561 (sh-send-text (buffer-substring-no-properties from to))
1562 (goto-char end)))
1565 ;; mode-command and utility functions
1567 (defun sh-after-hack-local-variables ()
1568 (when (assq 'sh-shell file-local-variables-alist)
1569 (sh-set-shell (if (symbolp sh-shell)
1570 (symbol-name sh-shell)
1571 sh-shell))))
1573 ;;;###autoload
1574 (define-derived-mode sh-mode prog-mode "Shell-script"
1575 "Major mode for editing shell scripts.
1576 This mode works for many shells, since they all have roughly the same syntax,
1577 as far as commands, arguments, variables, pipes, comments etc. are concerned.
1578 Unless the file's magic number indicates the shell, your usual shell is
1579 assumed. Since filenames rarely give a clue, they are not further analyzed.
1581 This mode adapts to the variations between shells (see `sh-set-shell') by
1582 means of an inheritance based feature lookup (see `sh-feature'). This
1583 mechanism applies to all variables (including skeletons) that pertain to
1584 shell-specific features. Shell script files can use the `sh-shell' local
1585 variable to indicate the shell variant to be used for the file.
1587 The default style of this mode is that of Rosenblatt's Korn shell book.
1588 The syntax of the statements varies with the shell being used. The
1589 following commands are available, based on the current shell's syntax:
1590 \\<sh-mode-map>
1591 \\[sh-case] case statement
1592 \\[sh-for] for loop
1593 \\[sh-function] function definition
1594 \\[sh-if] if statement
1595 \\[sh-indexed-loop] indexed loop from 1 to n
1596 \\[sh-while-getopts] while getopts loop
1597 \\[sh-repeat] repeat loop
1598 \\[sh-select] select loop
1599 \\[sh-until] until loop
1600 \\[sh-while] while loop
1602 For sh and rc shells indentation commands are:
1603 \\[sh-show-indent] Show the variable controlling this line's indentation.
1604 \\[sh-set-indent] Set then variable controlling this line's indentation.
1605 \\[sh-learn-line-indent] Change the indentation variable so this line
1606 would indent to the way it currently is.
1607 \\[sh-learn-buffer-indent] Set the indentation variables so the
1608 buffer indents as it currently is indented.
1611 \\[backward-delete-char-untabify] Delete backward one position, even if it was a tab.
1612 \\[sh-end-of-command] Go to end of successive commands.
1613 \\[sh-beginning-of-command] Go to beginning of successive commands.
1614 \\[sh-set-shell] Set this buffer's shell, and maybe its magic number.
1615 \\[sh-execute-region] Have optional header and region be executed in a subshell.
1617 `sh-electric-here-document-mode' controls whether insertion of two
1618 unquoted < insert a here document. You can control this behavior by
1619 modifying `sh-mode-hook'.
1621 If you generally program a shell different from your login shell you can
1622 set `sh-shell-file' accordingly. If your shell's file name doesn't correctly
1623 indicate what shell it is use `sh-alias-alist' to translate.
1625 If your shell gives error messages with line numbers, you can use \\[executable-interpret]
1626 with your script for an edit-interpret-debug cycle."
1627 (make-local-variable 'sh-shell-file)
1628 (make-local-variable 'sh-shell)
1630 (setq-local skeleton-pair-default-alist
1631 sh-skeleton-pair-default-alist)
1632 (setq-local skeleton-end-hook
1633 (lambda () (or (eolp) (newline) (indent-relative))))
1635 (setq-local paragraph-start (concat page-delimiter "\\|$"))
1636 (setq-local paragraph-separate (concat paragraph-start "\\|#!/"))
1637 (setq-local comment-start "# ")
1638 (setq-local comment-start-skip "#+[\t ]*")
1639 (setq-local local-abbrev-table sh-mode-abbrev-table)
1640 (setq-local comint-dynamic-complete-functions
1641 sh-dynamic-complete-functions)
1642 (add-hook 'completion-at-point-functions 'comint-completion-at-point nil t)
1643 ;; we can't look if previous line ended with `\'
1644 (setq-local comint-prompt-regexp "^[ \t]*")
1645 (setq-local imenu-case-fold-search nil)
1646 (setq font-lock-defaults
1647 `((sh-font-lock-keywords
1648 sh-font-lock-keywords-1 sh-font-lock-keywords-2)
1649 nil nil
1650 ((?/ . "w") (?~ . "w") (?. . "w") (?- . "w") (?_ . "w")) nil
1651 (font-lock-syntactic-face-function
1652 . sh-font-lock-syntactic-face-function)))
1653 (setq-local syntax-propertize-function #'sh-syntax-propertize-function)
1654 (add-hook 'syntax-propertize-extend-region-functions
1655 #'syntax-propertize-multiline 'append 'local)
1656 (setq-local skeleton-pair-alist '((?` _ ?`)))
1657 (setq-local skeleton-pair-filter-function 'sh-quoted-p)
1658 (setq-local skeleton-further-elements
1659 '((< '(- (min sh-indentation (current-column))))))
1660 (setq-local skeleton-filter-function 'sh-feature)
1661 (setq-local skeleton-newline-indent-rigidly t)
1662 (setq-local defun-prompt-regexp
1663 (concat
1664 "^\\("
1665 "\\(function[ \t]\\)?[ \t]*[[:alnum:]]+[ \t]*([ \t]*)"
1666 "\\|"
1667 "function[ \t]+[[:alnum:]]+[ \t]*\\(([ \t]*)\\)?"
1668 "\\)[ \t]*"))
1669 (setq-local add-log-current-defun-function #'sh-current-defun-name)
1670 (add-hook 'completion-at-point-functions
1671 #'sh-completion-at-point-function nil t)
1672 ;; Parse or insert magic number for exec, and set all variables depending
1673 ;; on the shell thus determined.
1674 (sh-set-shell
1675 (cond ((save-excursion
1676 (goto-char (point-min))
1677 (looking-at "#![ \t]?\\([^ \t\n]*/bin/env[ \t]\\)?\\([^ \t\n]+\\)"))
1678 (match-string 2))
1679 ((not buffer-file-name) sh-shell-file)
1680 ;; Checks that use `buffer-file-name' follow.
1681 ((string-match "\\.m?spec\\'" buffer-file-name) "rpm")
1682 ((string-match "[.]sh\\>" buffer-file-name) "sh")
1683 ((string-match "[.]bash\\>" buffer-file-name) "bash")
1684 ((string-match "[.]ksh\\>" buffer-file-name) "ksh")
1685 ((string-match "[.]t?csh\\(rc\\)?\\>" buffer-file-name) "csh")
1686 ((equal (file-name-nondirectory buffer-file-name) ".profile") "sh")
1687 (t sh-shell-file))
1688 nil nil)
1689 (add-hook 'hack-local-variables-hook
1690 #'sh-after-hack-local-variables nil t))
1692 ;;;###autoload
1693 (defalias 'shell-script-mode 'sh-mode)
1696 (defun sh-font-lock-keywords (&optional keywords)
1697 "Function to get simple fontification based on `sh-font-lock-keywords'.
1698 This adds rules for comments and assignments."
1699 (sh-feature sh-font-lock-keywords-var
1700 (when (stringp (sh-feature sh-assignment-regexp))
1701 (lambda (list)
1702 `((,(sh-feature sh-assignment-regexp)
1703 1 font-lock-variable-name-face)
1704 ,@keywords
1705 ,@list
1706 ,@executable-font-lock-keywords)))))
1708 (defun sh-font-lock-keywords-1 (&optional builtins)
1709 "Function to get better fontification including keywords."
1710 (let ((keywords (concat "\\([;(){}`|&]\\|^\\)[ \t]*\\(\\("
1711 (regexp-opt (sh-feature sh-leading-keywords) t)
1712 "[ \t]+\\)?"
1713 (regexp-opt (append (sh-feature sh-leading-keywords)
1714 (sh-feature sh-other-keywords))
1715 t))))
1716 (sh-font-lock-keywords
1717 `(,@(if builtins
1718 `((,(concat keywords "[ \t]+\\)?"
1719 (regexp-opt (sh-feature sh-builtins) t)
1720 "\\>")
1721 (2 font-lock-keyword-face nil t)
1722 (6 font-lock-builtin-face))
1723 ,@(sh-feature sh-font-lock-keywords-var-2)))
1724 (,(concat keywords "\\)\\>")
1725 2 font-lock-keyword-face)
1726 ,@(sh-feature sh-font-lock-keywords-var-1)))))
1728 (defun sh-font-lock-keywords-2 ()
1729 "Function to get better fontification including keywords and builtins."
1730 (sh-font-lock-keywords-1 t))
1732 ;;; Completion
1734 (defun sh--vars-before-point ()
1735 (save-excursion
1736 (let ((vars ()))
1737 (while (re-search-backward "^[ \t]*\\([[:alnum:]_]+\\)=" nil t)
1738 (push (match-string 1) vars))
1739 vars)))
1741 ;; (defun sh--var-completion-table (string pred action)
1742 ;; (complete-with-action action (sh--vars-before-point) string pred))
1744 (defun sh--cmd-completion-table (string pred action)
1745 (let ((cmds
1746 (append (when (fboundp 'imenu--make-index-alist)
1747 (mapcar #'car
1748 (condition-case nil
1749 (imenu--make-index-alist)
1750 (imenu-unavailable nil))))
1751 (mapcar (lambda (v) (concat v "="))
1752 (sh--vars-before-point))
1753 (locate-file-completion-table
1754 exec-path exec-suffixes string pred t)
1755 '("if" "while" "until" "for"))))
1756 (complete-with-action action cmds string pred)))
1758 (defun sh-completion-at-point-function ()
1759 (save-excursion
1760 (skip-chars-forward "[:alnum:]_")
1761 (let ((end (point))
1762 (_ (skip-chars-backward "[:alnum:]_"))
1763 (start (point)))
1764 (cond
1765 ((eq (char-before) ?$)
1766 (list start end (sh--vars-before-point)))
1767 ((sh-smie--keyword-p)
1768 (list start end #'sh--cmd-completion-table))))))
1770 ;;; Indentation and navigation with SMIE.
1772 (require 'smie)
1774 ;; The SMIE code should generally be preferred, but it currently does not obey
1775 ;; the various indentation custom-vars, and it misses some important features
1776 ;; of the old code, mostly: sh-learn-line/buffer-indent, sh-show-indent,
1777 ;; sh-name/save/load-style.
1778 (defvar sh-use-smie t
1779 "Whether to use the SMIE code for navigation and indentation.")
1781 (defun sh-smie--keyword-p ()
1782 "Non-nil if we're at a keyword position.
1783 A keyword position is one where if we're looking at something that looks
1784 like a keyword, then it is a keyword."
1785 (let ((prev (funcall smie-backward-token-function)))
1786 (if (zerop (length prev))
1787 (looking-back "\\`\\|\\s(" (1- (point)))
1788 (assoc prev smie-grammar))))
1790 (defun sh-smie--newline-semi-p (&optional tok)
1791 "Return non-nil if a newline should be treated as a semi-colon.
1792 Here we assume that a newline should be treated as a semi-colon unless it
1793 comes right after a special keyword.
1794 This function does not pay attention to line-continuations.
1795 If TOK is nil, point should be before the newline; otherwise, TOK is the token
1796 before the newline and in that case point should be just before the token."
1797 (save-excursion
1798 (unless tok
1799 (setq tok (funcall smie-backward-token-function)))
1800 (if (and (zerop (length tok))
1801 (looking-back "\\s(" (1- (point))))
1803 (not (numberp (nth 2 (assoc tok smie-grammar)))))))
1805 ;;;; SMIE support for `sh'.
1807 (defconst sh-smie-sh-grammar
1808 (smie-prec2->grammar
1809 (smie-bnf->prec2
1810 '((exp) ;A constant, or a $var, or a sequence of them...
1811 (cmd ("case" exp "in" branches "esac")
1812 ("if" cmd "then" cmd "fi")
1813 ("if" cmd "then" cmd "else" cmd "fi")
1814 ("if" cmd "then" cmd "elif" cmd "then" cmd "fi")
1815 ("if" cmd "then" cmd "elif" cmd "then" cmd "else" cmd "fi")
1816 ("if" cmd "then" cmd "elif" cmd "then" cmd
1817 "elif" cmd "then" cmd "else" cmd "fi")
1818 ("while" cmd "do" cmd "done")
1819 ("until" cmd "do" cmd "done")
1820 ("for" exp "in" cmd "do" cmd "done")
1821 ("for" exp "do" cmd "done")
1822 ("select" exp "in" cmd "do" cmd "done") ;bash&zsh&ksh88.
1823 ("repeat" exp "do" cmd "done") ;zsh.
1824 (exp "always" exp) ;zsh.
1825 (cmd "|" cmd) (cmd "|&" cmd)
1826 (cmd "&&" cmd) (cmd "||" cmd)
1827 (cmd ";" cmd) (cmd "&" cmd))
1828 (rpattern (rpattern "|" rpattern))
1829 (pattern (rpattern) ("case-(" rpattern))
1830 (branches (branches ";;" branches)
1831 (branches ";&" branches) (branches ";;&" branches) ;bash.
1832 (pattern "case-)" cmd)))
1833 '((assoc ";;" ";&" ";;&"))
1834 '((assoc ";" "&") (assoc "&&" "||") (assoc "|" "|&")))))
1836 (defconst sh-smie--sh-operators
1837 (delq nil (mapcar (lambda (x)
1838 (setq x (car x))
1839 (and (stringp x)
1840 (not (string-match "\\`[a-z]" x))
1842 sh-smie-sh-grammar)))
1844 (defconst sh-smie--sh-operators-re (regexp-opt sh-smie--sh-operators))
1845 (defconst sh-smie--sh-operators-back-re
1846 (concat "\\(?:^\\|[^\\]\\)\\(?:\\\\\\\\\\)*"
1847 "\\(" sh-smie--sh-operators-re "\\)"))
1849 (defun sh-smie--sh-keyword-in-p ()
1850 "Assuming we're looking at \"in\", return non-nil if it's a keyword.
1851 Does not preserve point."
1852 (let ((forward-sexp-function nil)
1853 (words nil) ;We've seen words.
1854 (newline nil) ;We've seen newlines after the words.
1855 (res nil)
1856 prev)
1857 (while (not res)
1858 (setq prev (funcall smie-backward-token-function))
1859 (cond
1860 ((zerop (length prev))
1861 (cond
1862 (newline (cl-assert words) (setq res 'word))
1863 ((bobp) (setq res 'word))
1865 (setq words t)
1866 (condition-case nil
1867 (forward-sexp -1)
1868 (scan-error (setq res 'unknown))))))
1869 ((equal prev ";")
1870 (if words (setq newline t)
1871 (setq res 'keyword)))
1872 ((member prev '("case" "for" "select")) (setq res 'keyword))
1873 ((assoc prev smie-grammar) (setq res 'word))
1875 (if newline
1876 (progn (cl-assert words) (setq res 'word))
1877 (setq words t)))))
1878 (eq res 'keyword)))
1880 (defun sh-smie--sh-keyword-p (tok)
1881 "Non-nil if TOK (at which we're looking) really is a keyword."
1882 (cond
1883 ((looking-at "[[:alnum:]_]+=") nil)
1884 ((equal tok "in") (sh-smie--sh-keyword-in-p))
1885 (t (sh-smie--keyword-p))))
1887 (defun sh-smie--default-forward-token ()
1888 (forward-comment (point-max))
1889 (buffer-substring-no-properties
1890 (point)
1891 (progn (if (zerop (skip-syntax-forward "."))
1892 (while (progn (skip-syntax-forward "w_'")
1893 (looking-at "\\\\"))
1894 (forward-char 2)))
1895 (point))))
1897 (defun sh-smie--default-backward-token ()
1898 (forward-comment (- (point)))
1899 (let ((pos (point))
1900 (n (skip-syntax-backward ".")))
1901 (if (or (zerop n)
1902 (and (eq n -1)
1903 (let ((p (point)))
1904 (if (eq -1 (% (skip-syntax-backward "\\") 2))
1906 (goto-char p)
1907 nil))))
1908 (while
1909 (progn (skip-syntax-backward "w_'")
1910 (or (not (zerop (skip-syntax-backward "\\")))
1911 (when (eq ?\\ (char-before (1- (point))))
1912 (let ((p (point)))
1913 (forward-char -1)
1914 (if (eq -1 (% (skip-syntax-backward "\\") 2))
1916 (goto-char p)
1917 nil))))))
1918 (goto-char (- (point) (% (skip-syntax-backward "\\") 2))))
1919 (buffer-substring-no-properties (point) pos)))
1921 (defun sh-smie-sh-forward-token ()
1922 (if (and (looking-at "[ \t]*\\(?:#\\|\\(\\s|\\)\\|$\\)")
1923 (save-excursion
1924 (skip-chars-backward " \t")
1925 (not (bolp))))
1926 (if (and (match-end 1) (not (nth 3 (syntax-ppss))))
1927 ;; Right before a here-doc.
1928 (let ((forward-sexp-function nil))
1929 (forward-sexp 1)
1930 ;; Pretend the here-document is a "newline representing a
1931 ;; semi-colon", since the here-doc otherwise covers the newline(s).
1932 ";")
1933 (unless (eobp)
1934 (let ((semi (sh-smie--newline-semi-p)))
1935 (forward-line 1)
1936 (if (or semi (eobp)) ";"
1937 (sh-smie-sh-forward-token)))))
1938 (forward-comment (point-max))
1939 (cond
1940 ((looking-at "\\\\\n") (forward-line 1) (sh-smie-sh-forward-token))
1941 ((looking-at sh-smie--sh-operators-re)
1942 (goto-char (match-end 0))
1943 (let ((tok (match-string-no-properties 0)))
1944 (if (and (memq (aref tok (1- (length tok))) '(?\; ?\& ?\|))
1945 (looking-at "[ \t]*\\(?:#\\|$\\)"))
1946 (forward-line 1))
1947 tok))
1949 (let* ((pos (point))
1950 (tok (sh-smie--default-forward-token)))
1951 (cond
1952 ((equal tok ")") "case-)")
1953 ((equal tok "(") "case-(")
1954 ((and tok (string-match "\\`[a-z]" tok)
1955 (assoc tok smie-grammar)
1956 (not
1957 (save-excursion
1958 (goto-char pos)
1959 (sh-smie--sh-keyword-p tok))))
1960 " word ")
1961 (t tok)))))))
1963 (defun sh-smie--looking-back-at-continuation-p ()
1964 (save-excursion
1965 (and (if (eq (char-before) ?\n) (progn (forward-char -1) t) (eolp))
1966 (looking-back "\\(?:^\\|[^\\]\\)\\(?:\\\\\\\\\\)*\\\\"
1967 (line-beginning-position)))))
1969 (defun sh-smie-sh-backward-token ()
1970 (let ((bol (line-beginning-position)))
1971 (forward-comment (- (point)))
1972 (cond
1973 ((and (bolp) (not (bobp))
1974 (equal (syntax-after (1- (point))) (string-to-syntax "|"))
1975 (not (nth 3 (syntax-ppss))))
1976 ;; Right after a here-document.
1977 (let ((forward-sexp-function nil))
1978 (forward-sexp -1)
1979 ;; Pretend the here-document is a "newline representing a
1980 ;; semi-colon", since the here-doc otherwise covers the newline(s).
1981 ";"))
1982 ((< (point) bol)
1983 (cond
1984 ((sh-smie--looking-back-at-continuation-p)
1985 (forward-char -1)
1986 (funcall smie-backward-token-function))
1987 ((sh-smie--newline-semi-p) ";")
1988 (t (funcall smie-backward-token-function))))
1989 ((looking-back sh-smie--sh-operators-back-re
1990 (line-beginning-position) 'greedy)
1991 (goto-char (match-beginning 1))
1992 (match-string-no-properties 1))
1994 (let ((tok (sh-smie--default-backward-token)))
1995 (cond
1996 ((equal tok ")") "case-)")
1997 ((equal tok "(") "case-(")
1998 ((and tok (string-match "\\`[a-z]" tok)
1999 (assoc tok smie-grammar)
2000 (not (save-excursion (sh-smie--sh-keyword-p tok))))
2001 " word ")
2002 (t tok)))))))
2004 (defcustom sh-indent-after-continuation t
2005 "If non-nil, indent relative to the continued line's beginning.
2006 Continued lines can either be indented as \"one long wrapped line\" without
2007 paying attention to the actual syntactic structure, as in:
2009 for f \\
2010 in a; do \\
2011 toto; \\
2012 done
2014 or as lines that just don't have implicit semi-colons between them, as in:
2016 for f \\
2017 in a; do \\
2018 toto; \\
2019 done
2021 With `always' you get the former behavior whereas with nil you get the latter.
2022 With t, you get the latter as long as that would indent the continuation line
2023 deeper than the initial line."
2024 :version "25.1"
2025 :type '(choice
2026 (const nil :tag "Never")
2027 (const t :tag "Only if needed to make it deeper")
2028 (const always :tag "Always"))
2029 :group 'sh-indentation)
2031 (defun sh-smie--continuation-start-indent ()
2032 "Return the initial indentation of a continued line.
2033 May return nil if the line should not be treated as continued."
2034 (save-excursion
2035 (forward-line -1)
2036 (unless (sh-smie--looking-back-at-continuation-p)
2037 (current-indentation))))
2039 (defun sh-smie--indent-continuation ()
2040 (cond
2041 ((not (and sh-indent-after-continuation
2042 (save-excursion
2043 (ignore-errors
2044 (skip-chars-backward " \t")
2045 (sh-smie--looking-back-at-continuation-p)))))
2046 nil)
2047 ((eq sh-indent-after-continuation 'always)
2048 (save-excursion
2049 (forward-line -1)
2050 (if (sh-smie--looking-back-at-continuation-p)
2051 (current-indentation)
2052 (+ (current-indentation) sh-indentation))))
2054 ;; Just make sure a line-continuation is indented deeper.
2055 (save-excursion
2056 (let ((indent (let ((sh-indent-after-continuation nil))
2057 (smie-indent-calculate)))
2058 (max most-positive-fixnum))
2059 (if (not (numberp indent)) indent
2060 (while (progn
2061 (forward-line -1)
2062 (let ((ci (current-indentation)))
2063 (cond
2064 ;; Previous line is less indented, we're good.
2065 ((< ci indent) nil)
2066 ((sh-smie--looking-back-at-continuation-p)
2067 (setq max (min max ci))
2068 ;; Previous line is itself a continuation.
2069 ;; If it's indented like us, we're good, otherwise
2070 ;; check the line before that one.
2071 (> ci indent))
2072 (t ;Previous line is the beginning of the continued line.
2073 (setq indent (min (+ ci sh-indentation) max))
2074 nil)))))
2075 indent))))))
2077 (defun sh-smie-sh-rules (kind token)
2078 (pcase (cons kind token)
2079 (`(:elem . basic) sh-indentation)
2080 (`(:after . "case-)") (- (sh-var-value 'sh-indent-for-case-alt)
2081 (sh-var-value 'sh-indent-for-case-label)))
2082 (`(:before . ,(or `"(" `"{" `"[" "while" "if" "for" "case"))
2083 (if (not (smie-rule-prev-p "&&" "||" "|"))
2084 (when (smie-rule-hanging-p)
2085 (smie-rule-parent))
2086 (unless (smie-rule-bolp)
2087 (while (equal "|" (nth 2 (smie-backward-sexp 'halfexp))))
2088 `(column . ,(smie-indent-virtual)))))
2089 ;; FIXME: Maybe this handling of ;; should be made into
2090 ;; a smie-rule-terminator function that takes the substitute ";" as arg.
2091 (`(:before . ,(or `";;" `";&" `";;&"))
2092 (if (and (smie-rule-bolp) (looking-at ";;?&?[ \t]*\\(#\\|$\\)"))
2093 (cons 'column (smie-indent-keyword ";"))
2094 (smie-rule-separator kind)))
2095 (`(:after . ,(or `";;" `";&" `";;&"))
2096 (with-demoted-errors
2097 (smie-backward-sexp token)
2098 (cons 'column
2099 (if (or (smie-rule-bolp)
2100 (save-excursion
2101 (and (member (funcall smie-backward-token-function)
2102 '("in" ";;"))
2103 (smie-rule-bolp))))
2104 (current-column)
2105 (smie-indent-calculate)))))
2106 (`(:before . ,(or `"|" `"&&" `"||"))
2107 (unless (smie-rule-parent-p token)
2108 (smie-backward-sexp token)
2109 `(column . ,(+ (funcall smie-rules-function :elem 'basic)
2110 (smie-indent-virtual)))))
2112 ;; Attempt at backward compatibility with the old config variables.
2113 (`(:before . "fi") (sh-var-value 'sh-indent-for-fi))
2114 (`(:before . "done") (sh-var-value 'sh-indent-for-done))
2115 (`(:after . "else") (sh-var-value 'sh-indent-after-else))
2116 (`(:after . "if") (sh-var-value 'sh-indent-after-if))
2117 (`(:before . "then") (sh-var-value 'sh-indent-for-then))
2118 (`(:before . "do") (sh-var-value 'sh-indent-for-do))
2119 (`(:after . "do")
2120 (sh-var-value (if (smie-rule-hanging-p)
2121 'sh-indent-after-loop-construct 'sh-indent-after-do)))
2122 ;; sh-indent-after-done: aligned completely differently.
2123 (`(:after . "in") (sh-var-value 'sh-indent-for-case-label))
2124 ;; sh-indent-for-continuation: Line continuations are handled differently.
2125 (`(:after . ,(or `"(" `"{" `"["))
2126 (if (not (looking-at ".[ \t]*[^\n \t#]"))
2127 (sh-var-value 'sh-indent-after-open)
2128 (goto-char (1- (match-end 0)))
2129 `(column . ,(current-column))))
2130 ;; sh-indent-after-function: we don't handle it differently.
2133 ;; (defconst sh-smie-csh-grammar
2134 ;; (smie-prec2->grammar
2135 ;; (smie-bnf->prec2
2136 ;; '((exp) ;A constant, or a $var, or a sequence of them...
2137 ;; (elseifcmd (cmd)
2138 ;; (cmd "else" "else-if" exp "then" elseifcmd))
2139 ;; (cmd ("switch" branches "endsw")
2140 ;; ("if" exp)
2141 ;; ("if" exp "then" cmd "endif")
2142 ;; ("if" exp "then" cmd "else" cmd "endif")
2143 ;; ("if" exp "then" elseifcmd "endif")
2144 ;; ;; ("if" exp "then" cmd "else" cmd "endif")
2145 ;; ;; ("if" exp "then" cmd "else" "if" exp "then" cmd "endif")
2146 ;; ;; ("if" exp "then" cmd "else" "if" exp "then" cmd
2147 ;; ;; "else" cmd "endif")
2148 ;; ;; ("if" exp "then" cmd "else" "if" exp "then" cmd
2149 ;; ;; "else" "if" exp "then" cmd "endif")
2150 ;; ("while" cmd "end")
2151 ;; ("foreach" cmd "end")
2152 ;; (cmd "|" cmd) (cmd "|&" cmd)
2153 ;; (cmd "&&" cmd) (cmd "||" cmd)
2154 ;; (cmd ";" cmd) (cmd "&" cmd))
2155 ;; ;; This is a lie, but (combined with the corresponding disambiguation
2156 ;; ;; rule) it makes it more clear that `case' and `default' are the key
2157 ;; ;; separators and the `:' is a secondary tokens.
2158 ;; (branches (branches "case" branches)
2159 ;; (branches "default" branches)
2160 ;; (exp ":" branches)))
2161 ;; '((assoc "else" "then" "endif"))
2162 ;; '((assoc "case" "default") (nonassoc ":"))
2163 ;; '((assoc ";;" ";&" ";;&"))
2164 ;; '((assoc ";" "&") (assoc "&&" "||") (assoc "|" "|&")))))
2166 ;;;; SMIE support for `rc'.
2168 (defconst sh-smie-rc-grammar
2169 (smie-prec2->grammar
2170 (smie-bnf->prec2
2171 '((exp) ;A constant, or a $var, or a sequence of them...
2172 (cmd (cmd "case" cmd)
2173 ("if" exp)
2174 ("switch" exp)
2175 ("for" exp) ("while" exp)
2176 (cmd "|" cmd) (cmd "|&" cmd)
2177 (cmd "&&" cmd) (cmd "||" cmd)
2178 (cmd ";" cmd) (cmd "&" cmd))
2179 (pattern (pattern "|" pattern))
2180 (branches (branches ";;" branches)
2181 (branches ";&" branches) (branches ";;&" branches) ;bash.
2182 (pattern "case-)" cmd)))
2183 '((assoc ";;" ";&" ";;&"))
2184 '((assoc "case") (assoc ";" "&") (assoc "&&" "||") (assoc "|" "|&")))))
2186 (defun sh-smie--rc-after-special-arg-p ()
2187 "Check if we're after the first arg of an if/while/for/... construct.
2188 Returns the construct's token and moves point before it, if so."
2189 (forward-comment (- (point)))
2190 (when (looking-back ")\\|\\_<not" (- (point) 3))
2191 (ignore-errors
2192 (let ((forward-sexp-function nil))
2193 (forward-sexp -1)
2194 (car (member (funcall smie-backward-token-function)
2195 '("if" "for" "switch" "while")))))))
2197 (defun sh-smie--rc-newline-semi-p ()
2198 "Return non-nil if a newline should be treated as a semi-colon.
2199 Point should be before the newline."
2200 (save-excursion
2201 (let ((tok (funcall smie-backward-token-function)))
2202 (if (or (when (equal tok "not") (forward-word-strictly 1) t)
2203 (and (zerop (length tok)) (eq (char-before) ?\))))
2204 (not (sh-smie--rc-after-special-arg-p))
2205 (sh-smie--newline-semi-p tok)))))
2207 (defun sh-smie-rc-forward-token ()
2208 ;; FIXME: Code duplication with sh-smie-sh-forward-token.
2209 (if (and (looking-at "[ \t]*\\(?:#\\|\\(\\s|\\)\\|$\\)")
2210 (save-excursion
2211 (skip-chars-backward " \t")
2212 (not (bolp))))
2213 (if (and (match-end 1) (not (nth 3 (syntax-ppss))))
2214 ;; Right before a here-doc.
2215 (let ((forward-sexp-function nil))
2216 (forward-sexp 1)
2217 ;; Pretend the here-document is a "newline representing a
2218 ;; semi-colon", since the here-doc otherwise covers the newline(s).
2219 ";")
2220 (let ((semi (sh-smie--rc-newline-semi-p)))
2221 (forward-line 1)
2222 (if (or semi (eobp)) ";"
2223 (sh-smie-rc-forward-token))))
2224 (forward-comment (point-max))
2225 (cond
2226 ((looking-at "\\\\\n") (forward-line 1) (sh-smie-rc-forward-token))
2227 ;; ((looking-at sh-smie--rc-operators-re)
2228 ;; (goto-char (match-end 0))
2229 ;; (let ((tok (match-string-no-properties 0)))
2230 ;; (if (and (memq (aref tok (1- (length tok))) '(?\; ?\& ?\|))
2231 ;; (looking-at "[ \t]*\\(?:#\\|$\\)"))
2232 ;; (forward-line 1))
2233 ;; tok))
2235 (let* ((pos (point))
2236 (tok (sh-smie--default-forward-token)))
2237 (cond
2238 ;; ((equal tok ")") "case-)")
2239 ((and tok (string-match "\\`[a-z]" tok)
2240 (assoc tok smie-grammar)
2241 (not
2242 (save-excursion
2243 (goto-char pos)
2244 (sh-smie--keyword-p))))
2245 " word ")
2246 (t tok)))))))
2248 (defun sh-smie-rc-backward-token ()
2249 ;; FIXME: Code duplication with sh-smie-sh-backward-token.
2250 (let ((bol (line-beginning-position)))
2251 (forward-comment (- (point)))
2252 (cond
2253 ((and (bolp) (not (bobp))
2254 (equal (syntax-after (1- (point))) (string-to-syntax "|"))
2255 (not (nth 3 (syntax-ppss))))
2256 ;; Right after a here-document.
2257 (let ((forward-sexp-function nil))
2258 (forward-sexp -1)
2259 ;; Pretend the here-document is a "newline representing a
2260 ;; semi-colon", since the here-doc otherwise covers the newline(s).
2261 ";"))
2262 ((< (point) bol) ;We skipped over a newline.
2263 (cond
2264 ;; A continued line.
2265 ((and (eolp)
2266 (looking-back "\\(?:^\\|[^\\]\\)\\(?:\\\\\\\\\\)*\\\\"
2267 (line-beginning-position)))
2268 (forward-char -1)
2269 (funcall smie-backward-token-function))
2270 ((sh-smie--rc-newline-semi-p) ";")
2271 (t (funcall smie-backward-token-function))))
2272 ;; ((looking-back sh-smie--sh-operators-back-re
2273 ;; (line-beginning-position) 'greedy)
2274 ;; (goto-char (match-beginning 1))
2275 ;; (match-string-no-properties 1))
2277 (let ((tok (sh-smie--default-backward-token)))
2278 (cond
2279 ;; ((equal tok ")") "case-)")
2280 ((and tok (string-match "\\`[a-z]" tok)
2281 (assoc tok smie-grammar)
2282 (not (save-excursion (sh-smie--keyword-p))))
2283 " word ")
2284 (t tok)))))))
2286 (defun sh-smie-rc-rules (kind token)
2287 (pcase (cons kind token)
2288 (`(:elem . basic) sh-indentation)
2289 ;; (`(:after . "case") (or sh-indentation smie-indent-basic))
2290 (`(:after . ";")
2291 (if (smie-rule-parent-p "case")
2292 (smie-rule-parent (sh-var-value 'sh-indent-after-case))))
2293 (`(:before . "{")
2294 (save-excursion
2295 (when (sh-smie--rc-after-special-arg-p)
2296 `(column . ,(current-column)))))
2297 (`(:before . ,(or `"(" `"{" `"["))
2298 (if (smie-rule-hanging-p) (smie-rule-parent)))
2299 ;; FIXME: SMIE parses "if (exp) cmd" as "(if ((exp) cmd))" so "cmd" is
2300 ;; treated as an arg to (exp) by default, which indents it all wrong.
2301 ;; To handle it right, we should extend smie-indent-exps so that the
2302 ;; preceding keyword can give special rules. Currently the only special
2303 ;; rule we have is the :list-intro hack, which we use here to align "cmd"
2304 ;; with "(exp)", which is rarely the right thing to do, but is better
2305 ;; than nothing.
2306 (`(:list-intro . ,(or `"for" `"if" `"while")) t)
2307 ;; sh-indent-after-switch: handled implicitly by the default { rule.
2310 ;;; End of SMIE code.
2312 (defvar sh-regexp-for-done nil
2313 "A buffer-local regexp to match opening keyword for done.")
2315 (defvar sh-kw-alist nil
2316 "A buffer-local, since it is shell-type dependent, list of keywords.")
2318 ;; ( key-word first-on-this on-prev-line )
2319 ;; This is used to set `sh-kw-alist' which is a list of sublists each
2320 ;; having 3 elements:
2321 ;; a keyword
2322 ;; a rule to check when the keyword appears on "this" line
2323 ;; a rule to check when the keyword appears on "the previous" line
2324 ;; The keyword is usually a string and is the first word on a line.
2325 ;; If this keyword appears on the line whose indentation is to be
2326 ;; calculated, the rule in element 2 is called. If this returns
2327 ;; non-zero, the resulting point (which may be changed by the rule)
2328 ;; is used as the default indentation.
2329 ;; If it returned false or the keyword was not found in the table,
2330 ;; then the keyword from the previous line is looked up and the rule
2331 ;; in element 3 is called. In this case, however,
2332 ;; `sh-get-indent-info' does not stop but may keep going and test
2333 ;; other keywords against rules in element 3. This is because the
2334 ;; preceding line could have, for example, an opening "if" and an
2335 ;; opening "while" keyword and we need to add the indentation offsets
2336 ;; for both.
2338 (defconst sh-kw
2339 '((sh
2340 ("if" nil sh-handle-prev-if)
2341 ("elif" sh-handle-this-else sh-handle-prev-else)
2342 ("else" sh-handle-this-else sh-handle-prev-else)
2343 ("fi" sh-handle-this-fi sh-handle-prev-fi)
2344 ("then" sh-handle-this-then sh-handle-prev-then)
2345 ("(" nil sh-handle-prev-open)
2346 ("{" nil sh-handle-prev-open)
2347 ("[" nil sh-handle-prev-open)
2348 ("}" sh-handle-this-close nil)
2349 (")" sh-handle-this-close nil)
2350 ("]" sh-handle-this-close nil)
2351 ("case" nil sh-handle-prev-case)
2352 ("esac" sh-handle-this-esac sh-handle-prev-esac)
2353 (case-label nil sh-handle-after-case-label) ;; ???
2354 (";;" nil sh-handle-prev-case-alt-end) ;; ???
2355 (";;&" nil sh-handle-prev-case-alt-end) ;Like ";;" with diff semantics.
2356 (";&" nil sh-handle-prev-case-alt-end) ;Like ";;" with diff semantics.
2357 ("done" sh-handle-this-done sh-handle-prev-done)
2358 ("do" sh-handle-this-do sh-handle-prev-do))
2360 ;; Note: we don't need specific stuff for bash and zsh shells;
2361 ;; the regexp `sh-regexp-for-done' handles the extra keywords
2362 ;; these shells use.
2364 ("{" nil sh-handle-prev-open)
2365 ("}" sh-handle-this-close nil)
2366 ("case" sh-handle-this-rc-case sh-handle-prev-rc-case))))
2370 (defun sh-set-shell (shell &optional no-query-flag insert-flag)
2371 "Set this buffer's shell to SHELL (a string).
2372 When used interactively, insert the proper starting #!-line,
2373 and make the visited file executable via `executable-set-magic',
2374 perhaps querying depending on the value of `executable-query'.
2376 When this function is called noninteractively, INSERT-FLAG (the third
2377 argument) controls whether to insert a #!-line and think about making
2378 the visited file executable, and NO-QUERY-FLAG (the second argument)
2379 controls whether to query about making the visited file executable.
2381 Calls the value of `sh-set-shell-hook' if set.
2383 Shell script files can cause this function be called automatically
2384 when the file is visited by having a `sh-shell' file-local variable
2385 whose value is the shell name (don't quote it)."
2386 (interactive (list (completing-read
2387 (format "Shell (default %s): "
2388 sh-shell-file)
2389 ;; This used to use interpreter-mode-alist, but that is
2390 ;; no longer appropriate now that uses regexps.
2391 ;; Maybe there could be a separate variable that lists
2392 ;; the shells, used here and to construct i-mode-alist.
2393 ;; But the following is probably good enough:
2394 (append (mapcar (lambda (e) (symbol-name (car e)))
2395 sh-ancestor-alist)
2396 '("csh" "rc" "sh"))
2397 nil nil nil nil sh-shell-file)
2398 (eq executable-query 'function)
2400 (if (string-match "\\.exe\\'" shell)
2401 (setq shell (substring shell 0 (match-beginning 0))))
2402 (setq sh-shell (sh-canonicalize-shell shell))
2403 (if insert-flag
2404 (setq sh-shell-file
2405 (executable-set-magic shell (sh-feature sh-shell-arg)
2406 no-query-flag insert-flag)))
2407 (setq mode-line-process (format "[%s]" sh-shell))
2408 (setq-local sh-shell-variables nil)
2409 (setq-local sh-shell-variables-initialized nil)
2410 (setq-local imenu-generic-expression
2411 (sh-feature sh-imenu-generic-expression))
2412 (let ((tem (sh-feature sh-mode-syntax-table-input)))
2413 (when tem
2414 (setq-local sh-mode-syntax-table
2415 (apply 'sh-mode-syntax-table tem))
2416 (set-syntax-table sh-mode-syntax-table)))
2417 (dolist (var (sh-feature sh-variables))
2418 (sh-remember-variable var))
2419 (if (setq-local sh-indent-supported-here
2420 (sh-feature sh-indent-supported))
2421 (progn
2422 (message "Setting up indent for shell type %s" sh-shell)
2423 (let ((mksym (lambda (name)
2424 (intern (format "sh-smie-%s-%s"
2425 sh-indent-supported-here name)))))
2426 (add-function :around (local 'smie--hanging-eolp-function)
2427 (lambda (orig)
2428 (if (looking-at "[ \t]*\\\\\n")
2429 (goto-char (match-end 0))
2430 (funcall orig))))
2431 (add-hook 'smie-indent-functions #'sh-smie--indent-continuation nil t)
2432 (smie-setup (symbol-value (funcall mksym "grammar"))
2433 (funcall mksym "rules")
2434 :forward-token (funcall mksym "forward-token")
2435 :backward-token (funcall mksym "backward-token")))
2436 (setq-local parse-sexp-lookup-properties t)
2437 (unless sh-use-smie
2438 (setq-local sh-kw-alist (sh-feature sh-kw))
2439 (let ((regexp (sh-feature sh-kws-for-done)))
2440 (if regexp
2441 (setq-local sh-regexp-for-done
2442 (sh-mkword-regexpr (regexp-opt regexp t)))))
2443 (message "setting up indent stuff")
2444 ;; sh-mode has already made indent-line-function local
2445 ;; but do it in case this is called before that.
2446 (setq-local indent-line-function 'sh-indent-line))
2447 (if sh-make-vars-local
2448 (sh-make-vars-local))
2449 (message "Indentation setup for shell type %s" sh-shell))
2450 (message "No indentation for this shell type.")
2451 (setq-local indent-line-function 'sh-basic-indent-line))
2452 (when font-lock-mode
2453 (setq font-lock-set-defaults nil)
2454 (font-lock-set-defaults)
2455 (font-lock-flush))
2456 (setq sh-shell-process nil)
2457 (run-hooks 'sh-set-shell-hook))
2460 (defun sh-feature (alist &optional function)
2461 "Index ALIST by the current shell.
2462 If ALIST isn't a list where every element is a cons, it is returned as is.
2463 Else indexing follows an inheritance logic which works in two ways:
2465 - Fall back on successive ancestors (see `sh-ancestor-alist') as long as
2466 the alist contains no value for the current shell.
2467 The ultimate default is always `sh'.
2469 - If the value thus looked up is a list starting with `sh-append',
2470 we call the function `sh-append' with the rest of the list as
2471 arguments, and use the value. However, the next element of the
2472 list is not used as-is; instead, we look it up recursively
2473 in ALIST to allow the function called to define the value for
2474 one shell to be derived from another shell.
2475 The value thus determined is physically replaced into the alist.
2477 If FUNCTION is non-nil, it is called with one argument,
2478 the value thus obtained, and the result is used instead."
2479 (or (if (consp alist)
2480 ;; Check for something that isn't a valid alist.
2481 (let ((l alist))
2482 (while (and l (consp (car l)))
2483 (setq l (cdr l)))
2484 (if l alist)))
2486 (let ((orig-sh-shell sh-shell))
2487 (let ((sh-shell sh-shell)
2488 elt val)
2489 (while (and sh-shell
2490 (not (setq elt (assq sh-shell alist))))
2491 (setq sh-shell (cdr (assq sh-shell sh-ancestor-alist))))
2492 ;; If the shell is not known, treat it as sh.
2493 (unless elt
2494 (setq elt (assq 'sh alist)))
2495 (setq val (cdr elt))
2496 (if (and (consp val)
2497 (memq (car val) '(sh-append sh-modify)))
2498 (setq val
2499 (apply (car val)
2500 ;; Refer to the value for a different shell,
2501 ;; as a kind of inheritance.
2502 (let ((sh-shell (car (cdr val))))
2503 (sh-feature alist))
2504 (cddr val))))
2505 (if function
2506 (setq sh-shell orig-sh-shell
2507 val (funcall function val)))
2508 val))))
2512 ;; I commented this out because nobody calls it -- rms.
2513 ;;(defun sh-abbrevs (ancestor &rest list)
2514 ;; "If it isn't, define the current shell as abbrev table and fill that.
2515 ;;Abbrev table will inherit all abbrevs from ANCESTOR, which is either an abbrev
2516 ;;table or a list of (NAME1 EXPANSION1 ...). In addition it will define abbrevs
2517 ;;according to the remaining arguments NAMEi EXPANSIONi ...
2518 ;;EXPANSION may be either a string or a skeleton command."
2519 ;; (or (if (boundp sh-shell)
2520 ;; (symbol-value sh-shell))
2521 ;; (progn
2522 ;; (if (listp ancestor)
2523 ;; (nconc list ancestor))
2524 ;; (define-abbrev-table sh-shell ())
2525 ;; (if (vectorp ancestor)
2526 ;; (mapatoms (lambda (atom)
2527 ;; (or (eq atom 0)
2528 ;; (define-abbrev (symbol-value sh-shell)
2529 ;; (symbol-name atom)
2530 ;; (symbol-value atom)
2531 ;; (symbol-function atom))))
2532 ;; ancestor))
2533 ;; (while list
2534 ;; (define-abbrev (symbol-value sh-shell)
2535 ;; (car list)
2536 ;; (if (stringp (car (cdr list)))
2537 ;; (car (cdr list))
2538 ;; "")
2539 ;; (if (symbolp (car (cdr list)))
2540 ;; (car (cdr list))))
2541 ;; (setq list (cdr (cdr list)))))
2542 ;; (symbol-value sh-shell)))
2545 (defun sh-append (ancestor &rest list)
2546 "Return list composed of first argument (a list) physically appended to rest."
2547 (nconc list ancestor))
2550 (defun sh-modify (skeleton &rest list)
2551 "Modify a copy of SKELETON by replacing I1 with REPL1, I2 with REPL2 ..."
2552 (setq skeleton (copy-sequence skeleton))
2553 (while list
2554 (setcar (or (nthcdr (car list) skeleton)
2555 (error "Index %d out of bounds" (car list)))
2556 (car (cdr list)))
2557 (setq list (nthcdr 2 list)))
2558 skeleton)
2561 (defun sh-basic-indent-line ()
2562 "Indent a line for Sh mode (shell script mode).
2563 Indent as far as preceding non-empty line, then by steps of `sh-indentation'.
2564 Lines containing only comments are considered empty."
2565 (interactive)
2566 (let ((previous (save-excursion
2567 (while (and (progn (beginning-of-line)
2568 (not (bobp)))
2569 (progn
2570 (forward-line -1)
2571 (back-to-indentation)
2572 (or (eolp)
2573 (eq (following-char) ?#)))))
2574 (current-column)))
2575 current)
2576 (save-excursion
2577 (indent-to (if (or (eq this-command 'newline-and-indent)
2578 (and electric-indent-mode (eq this-command 'newline)))
2579 previous
2580 (if (< (current-column)
2581 (setq current (progn (back-to-indentation)
2582 (current-column))))
2583 (if (eolp) previous 0)
2584 (delete-region (point)
2585 (progn (beginning-of-line) (point)))
2586 (if (eolp)
2587 (max previous (* (1+ (/ current sh-indentation))
2588 sh-indentation))
2589 (* (1+ (/ current sh-indentation)) sh-indentation))))))
2590 (if (< (current-column) (current-indentation))
2591 (skip-chars-forward " \t"))))
2594 (defun sh-execute-region (start end &optional flag)
2595 "Pass optional header and region to a subshell for noninteractive execution.
2596 The working directory is that of the buffer, and only environment variables
2597 are already set which is why you can mark a header within the script.
2599 With a positive prefix ARG, instead of sending region, define header from
2600 beginning of buffer to point. With a negative prefix ARG, instead of sending
2601 region, clear header."
2602 (interactive "r\nP")
2603 (if flag
2604 (setq sh-header-marker (if (> (prefix-numeric-value flag) 0)
2605 (point-marker)))
2606 (if sh-header-marker
2607 (save-excursion
2608 (let (buffer-undo-list)
2609 (goto-char sh-header-marker)
2610 (append-to-buffer (current-buffer) start end)
2611 (shell-command-on-region (point-min)
2612 (setq end (+ sh-header-marker
2613 (- end start)))
2614 sh-shell-file)
2615 (delete-region sh-header-marker end)))
2616 (shell-command-on-region start end (concat sh-shell-file " -")))))
2619 (defun sh-remember-variable (var)
2620 "Make VARIABLE available for future completing reads in this buffer."
2621 (or (< (length var) sh-remember-variable-min)
2622 (getenv var)
2623 (assoc var sh-shell-variables)
2624 (push (cons var var) sh-shell-variables))
2625 var)
2629 (defun sh-quoted-p ()
2630 "Is point preceded by an odd number of backslashes?"
2631 (eq -1 (% (save-excursion (skip-chars-backward "\\\\")) 2)))
2633 ;; Indentation stuff.
2634 (defun sh-must-support-indent ()
2635 "Signal an error if the shell type for this buffer is not supported.
2636 Also, the buffer must be in Shell-script mode."
2637 (unless sh-indent-supported-here
2638 (error "This buffer's shell does not support indentation through Emacs")))
2640 (defun sh-make-vars-local ()
2641 "Make the indentation variables local to this buffer.
2642 Normally they already are local. This command is provided in case
2643 variable `sh-make-vars-local' has been set to nil.
2645 To revert all these variables to the global values, use
2646 command `sh-reset-indent-vars-to-global-values'."
2647 (interactive)
2648 (mapc 'make-local-variable sh-var-list)
2649 (message "Indentation variables are now local."))
2651 (defun sh-reset-indent-vars-to-global-values ()
2652 "Reset local indentation variables to the global values.
2653 Then, if variable `sh-make-vars-local' is non-nil, make them local."
2654 (interactive)
2655 (mapc 'kill-local-variable sh-var-list)
2656 (if sh-make-vars-local
2657 (mapcar 'make-local-variable sh-var-list)))
2660 ;; Theoretically these are only needed in shell and derived modes.
2661 ;; However, the routines which use them are only called in those modes.
2662 (defconst sh-special-keywords "then\\|do")
2664 (defun sh-help-string-for-variable (var)
2665 "Construct a string for `sh-read-variable' when changing variable VAR ."
2666 (let ((msg (documentation-property var 'variable-documentation))
2667 (msg2 ""))
2668 (unless (memq var '(sh-first-lines-indent sh-indent-comment))
2669 (setq msg2
2670 (format "\n
2671 You can enter a number (positive to increase indentation,
2672 negative to decrease indentation, zero for no change to indentation).
2674 Or, you can enter one of the following symbols which are relative to
2675 the value of variable `sh-basic-offset'
2676 which in this buffer is currently %s.
2678 \t%s."
2679 sh-basic-offset
2680 (mapconcat (lambda (x)
2681 (nth (1- (length x)) x))
2682 sh-symbol-list "\n\t"))))
2683 (concat
2684 ;; The following shows the global not the local value!
2685 ;; (format "Current value of %s is %s\n\n" var (symbol-value var))
2686 msg msg2)))
2688 (defun sh-read-variable (var)
2689 "Read a new value for indentation variable VAR."
2690 (let ((minibuffer-help-form `(sh-help-string-for-variable
2691 (quote ,var)))
2692 val)
2693 (setq val (read-from-minibuffer
2694 (format "New value for %s (press %s for help): "
2695 var (single-key-description help-char))
2696 (format "%s" (symbol-value var))
2697 nil t))
2698 val))
2702 (defun sh-in-comment-or-string (start)
2703 "Return non-nil if START is in a comment or string."
2704 (save-excursion
2705 (let ((state (syntax-ppss start)))
2706 (or (nth 3 state) (nth 4 state)))))
2708 (defun sh-goto-matching-if ()
2709 "Go to the matching if for a fi.
2710 This handles nested if..fi pairs."
2711 (let ((found (sh-find-prev-matching "\\bif\\b" "\\bfi\\b" 1)))
2712 (if found
2713 (goto-char found))))
2716 ;; Functions named sh-handle-this-XXX are called when the keyword on the
2717 ;; line whose indentation is being handled contain XXX;
2718 ;; those named sh-handle-prev-XXX are when XXX appears on the previous line.
2720 (defun sh-handle-prev-if ()
2721 (list '(+ sh-indent-after-if)))
2723 (defun sh-handle-this-else ()
2724 (if (sh-goto-matching-if)
2725 ;; (list "aligned to if")
2726 (list "aligned to if" '(+ sh-indent-for-else))
2730 (defun sh-handle-prev-else ()
2731 (if (sh-goto-matching-if)
2732 (list '(+ sh-indent-after-if))
2735 (defun sh-handle-this-fi ()
2736 (if (sh-goto-matching-if)
2737 (list "aligned to if" '(+ sh-indent-for-fi))
2741 (defun sh-handle-prev-fi ()
2742 ;; Why do we have this rule? Because we must go back to the if
2743 ;; to get its indent. We may continue back from there.
2744 ;; We return nil because we don't have anything to add to result,
2745 ;; the side affect of setting align-point is all that matters.
2746 ;; we could return a comment (a string) but I can't think of a good one...
2747 (sh-goto-matching-if)
2748 nil)
2750 (defun sh-handle-this-then ()
2751 (let ((p (sh-goto-matching-if)))
2752 (if p
2753 (list '(+ sh-indent-for-then))
2756 (defun sh-handle-prev-then ()
2757 (let ((p (sh-goto-matching-if)))
2758 (if p
2759 (list '(+ sh-indent-after-if))
2762 (defun sh-handle-prev-open ()
2763 (save-excursion
2764 (let ((x (sh-prev-stmt)))
2765 (if (and x
2766 (progn
2767 (goto-char x)
2769 (looking-at "function\\b")
2770 (looking-at "\\s-*\\S-+\\s-*()")
2772 (list '(+ sh-indent-after-function))
2773 (list '(+ sh-indent-after-open)))
2776 (defun sh-handle-this-close ()
2777 (forward-char 1) ;; move over ")"
2778 (if (sh-safe-forward-sexp -1)
2779 (list "aligned to opening paren")))
2781 (defun sh-goto-matching-case ()
2782 (let ((found (sh-find-prev-matching "\\bcase\\b" "\\besac\\b" 1)))
2783 (if found (goto-char found))))
2785 (defun sh-handle-prev-case ()
2786 ;; This is typically called when point is on same line as a case
2787 ;; we shouldn't -- and can't find prev-case
2788 (if (looking-at ".*\\<case\\>")
2789 (list '(+ sh-indent-for-case-label))
2790 (error "We don't seem to be on a line with a case"))) ;; debug
2792 (defun sh-handle-this-esac ()
2793 (if (sh-goto-matching-case)
2794 (list "aligned to matching case")))
2796 (defun sh-handle-prev-esac ()
2797 (if (sh-goto-matching-case)
2798 (list "matching case")))
2800 (defun sh-handle-after-case-label ()
2801 (if (sh-goto-matching-case)
2802 (list '(+ sh-indent-for-case-alt))))
2804 (defun sh-handle-prev-case-alt-end ()
2805 (if (sh-goto-matching-case)
2806 (list '(+ sh-indent-for-case-label))))
2808 (defun sh-safe-forward-sexp (&optional arg)
2809 "Try and do a `forward-sexp', but do not error.
2810 Return new point if successful, nil if an error occurred."
2811 (condition-case nil
2812 (progn
2813 (forward-sexp (or arg 1))
2814 (point)) ;; return point if successful
2815 (error
2816 (sh-debug "oops!(1) %d" (point))
2817 nil))) ;; return nil if fail
2819 (defun sh-goto-match-for-done ()
2820 (let ((found (sh-find-prev-matching sh-regexp-for-done sh-re-done 1)))
2821 (if found
2822 (goto-char found))))
2824 (defun sh-handle-this-done ()
2825 (if (sh-goto-match-for-done)
2826 (list "aligned to do stmt" '(+ sh-indent-for-done))))
2828 (defun sh-handle-prev-done ()
2829 (if (sh-goto-match-for-done)
2830 (list "previous done")))
2832 (defun sh-handle-this-do ()
2833 (if (sh-goto-match-for-done)
2834 (list '(+ sh-indent-for-do))))
2836 (defun sh-handle-prev-do ()
2837 (cond
2838 ((save-restriction
2839 (narrow-to-region (point) (line-beginning-position))
2840 (sh-goto-match-for-done))
2841 (sh-debug "match for done found on THIS line")
2842 (list '(+ sh-indent-after-loop-construct)))
2843 ((sh-goto-match-for-done)
2844 (sh-debug "match for done found on PREV line")
2845 (list '(+ sh-indent-after-do)))
2847 (message "match for done NOT found")
2848 nil)))
2850 ;; for rc:
2851 (defun sh-find-prev-switch ()
2852 "Find the line for the switch keyword matching this line's case keyword."
2853 (re-search-backward "\\<switch\\>" nil t))
2855 (defun sh-handle-this-rc-case ()
2856 (if (sh-find-prev-switch)
2857 (list '(+ sh-indent-after-switch))
2858 ;; (list '(+ sh-indent-for-case-label))
2859 nil))
2861 (defun sh-handle-prev-rc-case ()
2862 (list '(+ sh-indent-after-case)))
2864 (defun sh-check-rule (n thing)
2865 (let ((rule (nth n (assoc thing sh-kw-alist)))
2866 (val nil))
2867 (if rule
2868 (progn
2869 (setq val (funcall rule))
2870 (sh-debug "rule (%d) for %s at %d is %s\n-> returned %s"
2871 n thing (point) rule val)))
2872 val))
2875 (defun sh-get-indent-info ()
2876 "Return indent-info for this line.
2877 This is a list. nil means the line is to be left as is.
2878 Otherwise it contains one or more of the following sublists:
2879 \(t NUMBER) NUMBER is the base location in the buffer that indentation is
2880 relative to. If present, this is always the first of the
2881 sublists. The indentation of the line in question is
2882 derived from the indentation of this point, possibly
2883 modified by subsequent sublists.
2884 \(+ VAR)
2885 \(- VAR) Get the value of variable VAR and add to or subtract from
2886 the indentation calculated so far.
2887 \(= VAR) Get the value of variable VAR and *replace* the
2888 indentation with its value. This only occurs for
2889 special variables such as `sh-indent-comment'.
2890 STRING This is ignored for the purposes of calculating
2891 indentation, it is printed in certain cases to help show
2892 what the indentation is based on."
2893 ;; See comments before `sh-kw'.
2894 (save-excursion
2895 (let ((have-result nil)
2896 this-kw
2898 (result nil)
2899 (align-point nil)
2900 prev-line-end x)
2901 (beginning-of-line)
2902 ;; Note: setting result to t means we are done and will return nil.
2903 ;;(This function never returns just t.)
2904 (cond
2905 ((or (nth 3 (syntax-ppss (point)))
2906 (eq (get-text-property (point) 'face) 'sh-heredoc))
2907 ;; String continuation -- don't indent
2908 (setq result t)
2909 (setq have-result t))
2910 ((looking-at "\\s-*#") ; was (equal this-kw "#")
2911 (if (bobp)
2912 (setq result t) ;; return nil if 1st line!
2913 (setq result (list '(= sh-indent-comment)))
2914 ;; we still need to get previous line in case
2915 ;; sh-indent-comment is t (indent as normal)
2916 (setq align-point (sh-prev-line nil))
2917 (setq have-result nil)
2919 ) ;; cond
2921 (unless have-result
2922 ;; Continuation lines are handled specially
2923 (if (sh-this-is-a-continuation)
2924 (progn
2925 (setq result
2926 (if (save-excursion
2927 (beginning-of-line)
2928 (not (memq (char-before (- (point) 2)) '(?\s ?\t))))
2929 ;; By convention, if the continuation \ is not
2930 ;; preceded by a SPC or a TAB it means that the line
2931 ;; is cut at a place where spaces cannot be freely
2932 ;; added/removed. I.e. do not indent the line.
2933 (list '(= nil))
2934 ;; We assume the line being continued is already
2935 ;; properly indented...
2936 ;; (setq prev-line-end (sh-prev-line))
2937 (setq align-point (sh-prev-line nil))
2938 (list '(+ sh-indent-for-continuation))))
2939 (setq have-result t))
2940 (beginning-of-line)
2941 (skip-chars-forward " \t")
2942 (setq this-kw (sh-get-kw)))
2944 ;; Handle "this" keyword: first word on the line we're
2945 ;; calculating indentation info for.
2946 (if this-kw
2947 (if (setq val (sh-check-rule 1 this-kw))
2948 (progn
2949 (setq align-point (point))
2950 (sh-debug
2951 "this - setting align-point to %d" align-point)
2952 (setq result (append result val))
2953 (setq have-result t)
2954 ;; set prev-line to continue processing remainder
2955 ;; of this line as a previous line
2956 (setq prev-line-end (point))
2957 ))))
2959 (unless have-result
2960 (setq prev-line-end (sh-prev-line 'end)))
2962 (if prev-line-end
2963 (save-excursion
2964 ;; We start off at beginning of this line.
2965 ;; Scan previous statements while this is <=
2966 ;; start of previous line.
2967 (goto-char prev-line-end)
2968 (setq x t)
2969 (while (and x (setq x (sh-prev-thing)))
2970 (sh-debug "at %d x is: %s result is: %s" (point) x result)
2971 (cond
2972 ((and (equal x ")")
2973 (equal (get-text-property (1- (point)) 'syntax-table)
2974 sh-st-punc))
2975 (sh-debug "Case label) here")
2976 (setq x 'case-label)
2977 (if (setq val (sh-check-rule 2 x))
2978 (progn
2979 (setq result (append result val))
2980 (setq align-point (point))))
2981 (or (bobp)
2982 (forward-char -1))
2983 ;; FIXME: This charset looks too much like a regexp. --Stef
2984 (skip-chars-forward "[a-z0-9]*?")
2986 ((string-match "[])}]" x)
2987 (setq x (sh-safe-forward-sexp -1))
2988 (if x
2989 (progn
2990 (setq align-point (point))
2991 (setq result (append result
2992 (list "aligned to opening paren")))
2994 ((string-match "[[({]" x)
2995 (sh-debug "Checking special thing: %s" x)
2996 (if (setq val (sh-check-rule 2 x))
2997 (setq result (append result val)))
2998 (forward-char -1)
2999 (setq align-point (point)))
3000 ((string-match "[\"'`]" x)
3001 (sh-debug "Skipping back for %s" x)
3002 ;; this was oops-2
3003 (setq x (sh-safe-forward-sexp -1)))
3004 ((stringp x)
3005 (sh-debug "Checking string %s at %s" x (point))
3006 (if (setq val (sh-check-rule 2 x))
3007 ;; (or (eq t (car val))
3008 ;; (eq t (car (car val))))
3009 (setq result (append result val)))
3010 ;; not sure about this test Wed Jan 27 23:48:35 1999
3011 (setq align-point (point))
3012 (unless (bolp)
3013 (forward-char -1)))
3015 (error "Don't know what to do with %s" x))
3017 ) ;; while
3018 (sh-debug "result is %s" result)
3020 (sh-debug "No prev line!")
3021 (sh-debug "result: %s align-point: %s" result align-point)
3024 (if align-point
3025 ;; was: (setq result (append result (list (list t align-point))))
3026 (setq result (append (list (list t align-point)) result))
3028 (sh-debug "result is now: %s" result)
3030 (or result
3031 (setq result (list (if prev-line-end
3032 (list t prev-line-end)
3033 (list '= 'sh-first-lines-indent)))))
3035 (if (eq result t)
3036 (setq result nil))
3037 (sh-debug "result is: %s" result)
3038 result
3039 ) ;; let
3043 (defun sh-get-indent-var-for-line (&optional info)
3044 "Return the variable controlling indentation for this line.
3045 If there is not [just] one such variable, return a string
3046 indicating the problem.
3047 If INFO is supplied it is used, else it is calculated."
3048 (let ((var nil)
3049 (result nil)
3050 (reason nil)
3051 sym elt)
3052 (or info
3053 (setq info (sh-get-indent-info)))
3054 (if (null info)
3055 (setq result "this line to be left as is")
3056 (while (and info (null result))
3057 (setq elt (car info))
3058 (cond
3059 ((stringp elt)
3060 (setq reason elt)
3062 ((not (listp elt))
3063 (error "sh-get-indent-var-for-line invalid elt: %s" elt))
3064 ;; so it is a list
3065 ((eq t (car elt))
3066 ) ;; nothing
3067 ((symbolp (setq sym (nth 1 elt)))
3068 ;; A bit of a kludge - when we see the sh-indent-comment
3069 ;; ignore other variables. Otherwise it is tricky to
3070 ;; "learn" the comment indentation.
3071 (if (eq var 'sh-indent-comment)
3072 (setq result var)
3073 (if var
3074 (setq result
3075 "this line is controlled by more than 1 variable.")
3076 (setq var sym))))
3078 (error "sh-get-indent-var-for-line invalid list elt: %s" elt)))
3079 (setq info (cdr info))
3081 (or result
3082 (setq result var))
3083 (or result
3084 (setq result reason))
3085 (if (null result)
3086 ;; e.g. just had (t POS)
3087 (setq result "line has default indentation"))
3088 result))
3092 ;; Finding the previous line isn't trivial.
3093 ;; We must *always* go back one more and see if that is a continuation
3094 ;; line -- it is the PREVIOUS line which is continued, not the one
3095 ;; we are going to!
3096 ;; Also, we want to treat a whole "here document" as one big line,
3097 ;; because we may want to a align to the beginning of it.
3099 ;; What we do:
3100 ;; - go back to previous non-empty line
3101 ;; - if this is in a here-document, go to the beginning of it
3102 ;; - while previous line is continued, go back one line
3103 (defun sh-prev-line (&optional end)
3104 "Back to end of previous non-comment non-empty line.
3105 Go to beginning of logical line unless END is non-nil, in which case
3106 we go to the end of the previous line and do not check for continuations."
3107 (save-excursion
3108 (beginning-of-line)
3109 (forward-comment (- (point-max)))
3110 (unless end (beginning-of-line))
3111 (when (and (not (bobp))
3112 (eq (get-text-property (1- (point)) 'face) 'sh-heredoc))
3113 (let ((p1 (previous-single-property-change (1- (point)) 'face)))
3114 (when p1
3115 (goto-char p1)
3116 (if end
3117 (end-of-line)
3118 (beginning-of-line)))))
3119 (unless end
3120 ;; we must check previous lines to see if they are continuation lines
3121 ;; if so, we must return position of first of them
3122 (while (and (sh-this-is-a-continuation)
3123 (>= 0 (forward-line -1))))
3124 (beginning-of-line)
3125 (skip-chars-forward " \t"))
3126 (point)))
3129 (defun sh-prev-stmt ()
3130 "Return the address of the previous stmt or nil."
3131 ;; This is used when we are trying to find a matching keyword.
3132 ;; Searching backward for the keyword would certainly be quicker, but
3133 ;; it is hard to remove "false matches" -- such as if the keyword
3134 ;; appears in a string or quote. This way is slower, but (I think) safer.
3135 (interactive)
3136 (save-excursion
3137 (let ((going t)
3138 (start (point))
3139 (found nil)
3140 (prev nil))
3141 (skip-chars-backward " \t;|&({[")
3142 (while (and (not found)
3143 (not (bobp))
3144 going)
3145 ;; Do a backward-sexp if possible, else backup bit by bit...
3146 (if (sh-safe-forward-sexp -1)
3147 (progn
3148 (if (looking-at sh-special-keywords)
3149 (progn
3150 (setq found prev))
3151 (setq prev (point))
3153 ;; backward-sexp failed
3154 (if (zerop (skip-chars-backward " \t()[]{};`'"))
3155 (forward-char -1))
3156 (if (bolp)
3157 (let ((back (sh-prev-line nil)))
3158 (if back
3159 (goto-char back)
3160 (setq going nil)))))
3161 (unless found
3162 (skip-chars-backward " \t")
3163 (if (or (and (bolp) (not (sh-this-is-a-continuation)))
3164 (eq (char-before) ?\;)
3165 (looking-at "\\s-*[|&]"))
3166 (setq found (point)))))
3167 (if found
3168 (goto-char found))
3169 (if found
3170 (progn
3171 (skip-chars-forward " \t|&({[")
3172 (setq found (point))))
3173 (if (>= (point) start)
3174 (progn
3175 (debug "We didn't move!")
3176 (setq found nil))
3177 (or found
3178 (sh-debug "Did not find prev stmt.")))
3179 found)))
3182 (defun sh-get-word ()
3183 "Get a shell word skipping whitespace from point."
3184 (interactive)
3185 (skip-chars-forward "\t ")
3186 (let ((start (point)))
3187 (while
3188 (if (looking-at "[\"'`]")
3189 (sh-safe-forward-sexp)
3190 ;; (> (skip-chars-forward "^ \t\n\"'`") 0)
3191 (> (skip-chars-forward "-_$[:alnum:]") 0)
3193 (buffer-substring start (point))
3196 (defun sh-prev-thing ()
3197 "Return the previous thing this logical line."
3198 ;; This is called when `sh-get-indent-info' is working backwards on
3199 ;; the previous line(s) finding what keywords may be relevant for
3200 ;; indenting. It moves over sexps if possible, and will stop
3201 ;; on a ; and at the beginning of a line if it is not a continuation
3202 ;; line.
3204 ;; Added a kludge for ";;"
3205 ;; Possible return values:
3206 ;; nil - nothing
3207 ;; a string - possibly a keyword
3209 (if (bolp)
3211 (let ((start (point))
3212 (min-point (if (sh-this-is-a-continuation)
3213 (sh-prev-line nil)
3214 (line-beginning-position))))
3215 (skip-chars-backward " \t;" min-point)
3216 (if (looking-at "\\s-*;[;&]")
3217 ;; (message "Found ;; !")
3218 ";;"
3219 (skip-chars-backward "^)}];\"'`({[" min-point)
3220 (let ((c (if (> (point) min-point) (char-before))))
3221 (sh-debug "stopping at %d c is %s start=%d min-point=%d"
3222 (point) c start min-point)
3223 (if (not (memq c '(?\n nil ?\;)))
3224 ;; c -- return a string
3225 (char-to-string c)
3226 ;; Return the leading keyword of the "command" we supposedly
3227 ;; skipped over. Maybe we skipped too far (e.g. past a `do' or
3228 ;; `then' that precedes the actual command), so check whether
3229 ;; we're looking at such a keyword and if so, move back forward.
3230 (let ((boundary (point))
3231 kwd next)
3232 (while
3233 (progn
3234 ;; Skip forward over white space newline and \ at eol.
3235 (skip-chars-forward " \t\n\\\\" start)
3236 (if (>= (point) start)
3237 (progn
3238 (sh-debug "point: %d >= start: %d" (point) start)
3239 nil)
3240 (if next (setq boundary next))
3241 (sh-debug "Now at %d start=%d" (point) start)
3242 (setq kwd (sh-get-word))
3243 (if (member kwd (sh-feature sh-leading-keywords))
3244 (progn
3245 (setq next (point))
3247 nil))))
3248 (goto-char boundary)
3249 kwd)))))))
3252 (defun sh-this-is-a-continuation ()
3253 "Return non-nil if current line is a continuation of previous line."
3254 (save-excursion
3255 (and (zerop (forward-line -1))
3256 (looking-at ".*\\\\$")
3257 (not (nth 4 (parse-partial-sexp (match-beginning 0) (match-end 0)
3258 nil nil nil t))))))
3260 (defun sh-get-kw (&optional where and-move)
3261 "Return first word of line from WHERE.
3262 If AND-MOVE is non-nil then move to end of word."
3263 (let ((start (point)))
3264 (if where
3265 (goto-char where))
3266 (prog1
3267 (buffer-substring (point)
3268 (progn (skip-chars-forward "^ \t\n;&|")(point)))
3269 (unless and-move
3270 (goto-char start)))))
3272 (defun sh-find-prev-matching (open close &optional depth)
3273 "Find a matching token for a set of opening and closing keywords.
3274 This takes into account that there may be nested open..close pairings.
3275 OPEN and CLOSE are regexps denoting the tokens to be matched.
3276 Optional parameter DEPTH (usually 1) says how many to look for."
3277 (let ((parse-sexp-ignore-comments t)
3278 (forward-sexp-function nil)
3279 prev)
3280 (setq depth (or depth 1))
3281 (save-excursion
3282 (condition-case nil
3283 (while (and
3284 (/= 0 depth)
3285 (not (bobp))
3286 (setq prev (sh-prev-stmt)))
3287 (goto-char prev)
3288 (save-excursion
3289 (if (looking-at "\\\\\n")
3290 (progn
3291 (forward-char 2)
3292 (skip-chars-forward " \t")))
3293 (cond
3294 ((looking-at open)
3295 (setq depth (1- depth))
3296 (sh-debug "found open at %d - depth = %d" (point) depth))
3297 ((looking-at close)
3298 (setq depth (1+ depth))
3299 (sh-debug "found close - depth = %d" depth))
3301 ))))
3302 (error nil))
3303 (if (eq depth 0)
3304 prev ;; (point)
3305 nil)
3309 (defun sh-var-value (var &optional ignore-error)
3310 "Return the value of variable VAR, interpreting symbols.
3311 It can also return t or nil.
3312 If an invalid value is found, throw an error unless Optional argument
3313 IGNORE-ERROR is non-nil."
3314 (let ((val (symbol-value var)))
3315 (cond
3316 ((numberp val)
3317 val)
3318 ((eq val t)
3319 val)
3320 ((null val)
3321 val)
3322 ((eq val '+)
3323 sh-basic-offset)
3324 ((eq val '-)
3325 (- sh-basic-offset))
3326 ((eq val '++)
3327 (* 2 sh-basic-offset))
3328 ((eq val '--)
3329 (* 2 (- sh-basic-offset)))
3330 ((eq val '*)
3331 (/ sh-basic-offset 2))
3332 ((eq val '/)
3333 (/ (- sh-basic-offset) 2))
3335 (funcall (if ignore-error #'message #'error)
3336 "Don't know how to handle %s's value of %s" var val)
3337 0))))
3339 (defun sh-set-var-value (var value &optional no-symbol)
3340 "Set variable VAR to VALUE.
3341 Unless optional argument NO-SYMBOL is non-nil, then if VALUE is
3342 can be represented by a symbol then do so."
3343 (cond
3344 (no-symbol
3345 (set var value))
3346 ((= value sh-basic-offset)
3347 (set var '+))
3348 ((= value (- sh-basic-offset))
3349 (set var '-))
3350 ((eq value (* 2 sh-basic-offset))
3351 (set var '++))
3352 ((eq value (* 2 (- sh-basic-offset)))
3353 (set var '--))
3354 ((eq value (/ sh-basic-offset 2))
3355 (set var '*))
3356 ((eq value (/ (- sh-basic-offset) 2))
3357 (set var '/))
3359 (set var value)))
3363 (defun sh-calculate-indent (&optional info)
3364 "Return the indentation for the current line.
3365 If INFO is supplied it is used, else it is calculated from current line."
3366 (let ((ofs 0)
3367 (base-value 0)
3368 elt a b val)
3369 (or info
3370 (setq info (sh-get-indent-info)))
3371 (when info
3372 (while info
3373 (sh-debug "info: %s ofs=%s" info ofs)
3374 (setq elt (car info))
3375 (cond
3376 ((stringp elt)) ;; do nothing?
3377 ((listp elt)
3378 (setq a (car (car info)))
3379 (setq b (nth 1 (car info)))
3380 (cond
3381 ((eq a t)
3382 (save-excursion
3383 (goto-char b)
3384 (setq val (current-indentation)))
3385 (setq base-value val))
3386 ((symbolp b)
3387 (setq val (sh-var-value b))
3388 (cond
3389 ((eq a '=)
3390 (cond
3391 ((null val)
3392 ;; no indentation
3393 ;; set info to nil so we stop immediately
3394 (setq base-value nil ofs nil info nil))
3395 ((eq val t) (setq ofs 0)) ;; indent as normal line
3397 ;; The following assume the (t POS) come first!
3398 (setq ofs val base-value 0)
3399 (setq info nil)))) ;; ? stop now
3400 ((eq a '+) (setq ofs (+ ofs val)))
3401 ((eq a '-) (setq ofs (- ofs val)))
3403 (error "sh-calculate-indent invalid a a=%s b=%s" a b))))
3405 (error "sh-calculate-indent invalid elt: a=%s b=%s" a b))))
3407 (error "sh-calculate-indent invalid elt %s" elt)))
3408 (sh-debug "a=%s b=%s val=%s base-value=%s ofs=%s"
3409 a b val base-value ofs)
3410 (setq info (cdr info)))
3411 ;; return value:
3412 (sh-debug "at end: base-value: %s ofs: %s" base-value ofs)
3414 (cond
3415 ((or (null base-value)(null ofs))
3416 nil)
3417 ((and (numberp base-value)(numberp ofs))
3418 (sh-debug "base (%d) + ofs (%d) = %d"
3419 base-value ofs (+ base-value ofs))
3420 (+ base-value ofs)) ;; return value
3422 (error "sh-calculate-indent: Help. base-value=%s ofs=%s"
3423 base-value ofs)
3424 nil)))))
3427 (defun sh-indent-line ()
3428 "Indent the current line."
3429 (interactive)
3430 (let ((indent (sh-calculate-indent))
3431 (pos (- (point-max) (point))))
3432 (when indent
3433 (beginning-of-line)
3434 (skip-chars-forward " \t")
3435 (indent-line-to indent)
3436 ;; If initial point was within line's indentation,
3437 ;; position after the indentation. Else stay at same point in text.
3438 (if (> (- (point-max) pos) (point))
3439 (goto-char (- (point-max) pos))))))
3442 (defun sh-blink (blinkpos &optional msg)
3443 "Move cursor momentarily to BLINKPOS and display MSG."
3444 ;; We can get here without it being a number on first line
3445 (if (numberp blinkpos)
3446 (save-excursion
3447 (goto-char blinkpos)
3448 (if msg (message "%s" msg) (message nil))
3449 (sit-for blink-matching-delay))
3450 (if msg (message "%s" msg) (message nil))))
3452 (defun sh-show-indent (arg)
3453 "Show the how the current line would be indented.
3454 This tells you which variable, if any, controls the indentation of
3455 this line.
3456 If optional arg ARG is non-null (called interactively with a prefix),
3457 a pop up window describes this variable.
3458 If variable `sh-blink' is non-nil then momentarily go to the line
3459 we are indenting relative to, if applicable."
3460 (interactive "P")
3461 (sh-must-support-indent)
3462 (if sh-use-smie
3463 (smie-config-show-indent)
3464 (let* ((info (sh-get-indent-info))
3465 (var (sh-get-indent-var-for-line info))
3466 (curr-indent (current-indentation))
3467 val msg)
3468 (if (stringp var)
3469 (message "%s" (setq msg var))
3470 (setq val (sh-calculate-indent info))
3472 (if (eq curr-indent val)
3473 (setq msg (format "%s is %s" var (symbol-value var)))
3474 (setq msg
3475 (if val
3476 (format "%s (%s) would change indent from %d to: %d"
3477 var (symbol-value var) curr-indent val)
3478 (format "%s (%s) would leave line as is"
3479 var (symbol-value var)))
3481 (if (and arg var)
3482 (describe-variable var)))
3483 (if sh-blink
3484 (let ((info (sh-get-indent-info)))
3485 (if (and info (listp (car info))
3486 (eq (car (car info)) t))
3487 (sh-blink (nth 1 (car info)) msg)
3488 (message "%s" msg)))
3489 (message "%s" msg))
3492 (defun sh-set-indent ()
3493 "Set the indentation for the current line.
3494 If the current line is controlled by an indentation variable, prompt
3495 for a new value for it."
3496 (interactive)
3497 (sh-must-support-indent)
3498 (if sh-use-smie
3499 (smie-config-set-indent)
3500 (let* ((info (sh-get-indent-info))
3501 (var (sh-get-indent-var-for-line info))
3502 val old-val indent-val)
3503 (if (stringp var)
3504 (message "Cannot set indent - %s" var)
3505 (setq old-val (symbol-value var))
3506 (setq val (sh-read-variable var))
3507 (condition-case nil
3508 (progn
3509 (set var val)
3510 (setq indent-val (sh-calculate-indent info))
3511 (if indent-val
3512 (message "Variable: %s Value: %s would indent to: %d"
3513 var (symbol-value var) indent-val)
3514 (message "Variable: %s Value: %s would leave line as is."
3515 var (symbol-value var)))
3516 ;; I'm not sure about this, indenting it now?
3517 ;; No. Because it would give the impression that an undo would
3518 ;; restore thing, but the value has been altered.
3519 ;; (sh-indent-line)
3521 (error
3522 (set var old-val)
3523 (message "Bad value for %s, restoring to previous value %s"
3524 var old-val)
3525 (sit-for 1)
3526 nil))
3527 ))))
3530 (defun sh-learn-line-indent (arg)
3531 "Learn how to indent a line as it currently is indented.
3533 If there is an indentation variable which controls this line's indentation,
3534 then set it to a value which would indent the line the way it
3535 presently is.
3537 If the value can be represented by one of the symbols then do so
3538 unless optional argument ARG (the prefix when interactive) is non-nil."
3539 (interactive "*P")
3540 (sh-must-support-indent)
3541 (if sh-use-smie
3542 (smie-config-set-indent)
3543 ;; I'm not sure if we show allow learning on an empty line.
3544 ;; Though it might occasionally be useful I think it usually
3545 ;; would just be confusing.
3546 (if (save-excursion
3547 (beginning-of-line)
3548 (looking-at "\\s-*$"))
3549 (message "sh-learn-line-indent ignores empty lines.")
3550 (let* ((info (sh-get-indent-info))
3551 (var (sh-get-indent-var-for-line info))
3552 ival sval diff new-val
3553 (no-symbol arg)
3554 (curr-indent (current-indentation)))
3555 (cond
3556 ((stringp var)
3557 (message "Cannot learn line - %s" var))
3558 ((eq var 'sh-indent-comment)
3559 ;; This is arbitrary...
3560 ;; - if curr-indent is 0, set to curr-indent
3561 ;; - else if it has the indentation of a "normal" line,
3562 ;; then set to t
3563 ;; - else set to curr-indent.
3564 (setq sh-indent-comment
3565 (if (= curr-indent 0)
3567 (let* ((sh-indent-comment t)
3568 (val2 (sh-calculate-indent info)))
3569 (if (= val2 curr-indent)
3571 curr-indent))))
3572 (message "%s set to %s" var (symbol-value var))
3574 ((numberp (setq sval (sh-var-value var)))
3575 (setq ival (sh-calculate-indent info))
3576 (setq diff (- curr-indent ival))
3578 (sh-debug "curr-indent: %d ival: %d diff: %d var:%s sval %s"
3579 curr-indent ival diff var sval)
3580 (setq new-val (+ sval diff))
3581 ;; I commented out this because someone might want to replace
3582 ;; a value of `+' with the current value of sh-basic-offset
3583 ;; or vice-versa.
3584 ;;(if (= 0 diff)
3585 ;; (message "No change needed!")
3586 (sh-set-var-value var new-val no-symbol)
3587 (message "%s set to %s" var (symbol-value var))
3590 (debug)
3591 (message "Cannot change %s" var)))))))
3595 (defun sh-mark-init (buffer)
3596 "Initialize a BUFFER to be used by `sh-mark-line'."
3597 (with-current-buffer (get-buffer-create buffer)
3598 (erase-buffer)
3599 (occur-mode)))
3602 (defun sh-mark-line (message point buffer &optional add-linenum occur-point)
3603 "Insert MESSAGE referring to location POINT in current buffer into BUFFER.
3604 Buffer BUFFER is in `occur-mode'.
3605 If ADD-LINENUM is non-nil the message is preceded by the line number.
3606 If OCCUR-POINT is non-nil then the line is marked as a new occurrence
3607 so that `occur-next' and `occur-prev' will work."
3608 (let ((m1 (make-marker))
3609 start
3610 (line ""))
3611 (when point
3612 (set-marker m1 point (current-buffer))
3613 (if add-linenum
3614 (setq line (format "%d: " (1+ (count-lines 1 point))))))
3615 (save-excursion
3616 (if (get-buffer buffer)
3617 (set-buffer (get-buffer buffer))
3618 (set-buffer (get-buffer-create buffer))
3619 (occur-mode)
3621 (goto-char (point-max))
3622 (setq start (point))
3623 (let ((inhibit-read-only t))
3624 (insert line)
3625 (if occur-point
3626 (setq occur-point (point)))
3627 (insert message)
3628 (if point
3629 (add-text-properties
3630 start (point)
3631 '(mouse-face highlight
3632 help-echo "mouse-2: go to the line where I learned this")))
3633 (insert "\n")
3634 (when point
3635 (put-text-property start (point) 'occur-target m1)
3636 (if occur-point
3637 (put-text-property start occur-point
3638 'occur-match t))
3639 )))))
3641 ;; Is this really worth having?
3642 (defvar sh-learned-buffer-hook nil
3643 "An abnormal hook, called with an alist of learned variables.")
3644 ;; Example of how to use sh-learned-buffer-hook
3646 ;; (defun what-i-learned (list)
3647 ;; (let ((p list))
3648 ;; (with-current-buffer "*scratch*"
3649 ;; (goto-char (point-max))
3650 ;; (insert "(setq\n")
3651 ;; (while p
3652 ;; (insert (format " %s %s \n"
3653 ;; (nth 0 (car p)) (nth 1 (car p))))
3654 ;; (setq p (cdr p)))
3655 ;; (insert ")\n")
3656 ;; )))
3658 ;; (add-hook 'sh-learned-buffer-hook 'what-i-learned)
3661 ;; Originally this was sh-learn-region-indent (beg end)
3662 ;; However, in practice this was awkward so I changed it to
3663 ;; use the whole buffer. Use narrowing if need be.
3664 (defun sh-learn-buffer-indent (&optional arg)
3665 "Learn how to indent the buffer the way it currently is.
3667 Output in buffer \"*indent*\" shows any lines which have conflicting
3668 values of a variable, and the final value of all variables learned.
3669 When called interactively, pop to this buffer automatically if
3670 there are any discrepancies.
3672 If no prefix ARG is given, then variables are set to numbers.
3673 If a prefix arg is given, then variables are set to symbols when
3674 applicable -- e.g. to symbol `+' if the value is that of the
3675 basic indent.
3676 If a positive numerical prefix is given, then `sh-basic-offset'
3677 is set to the prefix's numerical value.
3678 Otherwise, sh-basic-offset may or may not be changed, according
3679 to the value of variable `sh-learn-basic-offset'.
3681 Abnormal hook `sh-learned-buffer-hook' if non-nil is called when the
3682 function completes. The function is abnormal because it is called
3683 with an alist of variables learned. This feature may be changed or
3684 removed in the future.
3686 This command can often take a long time to run."
3687 (interactive "P")
3688 (sh-must-support-indent)
3689 (if sh-use-smie
3690 (smie-config-guess)
3691 (save-excursion
3692 (goto-char (point-min))
3693 (let ((learned-var-list nil)
3694 (out-buffer "*indent*")
3695 (num-diffs 0)
3696 previous-set-info
3697 (max 17)
3700 (comment-col nil) ;; number if all same, t if seen diff values
3701 (comments-always-default t) ;; nil if we see one not default
3702 initial-msg
3703 (specified-basic-offset (and arg (numberp arg)
3704 (> arg 0)))
3705 (linenum 0)
3706 suggested)
3707 (setq vec (make-vector max 0))
3708 (sh-mark-init out-buffer)
3710 (if specified-basic-offset
3711 (progn
3712 (setq sh-basic-offset arg)
3713 (setq initial-msg
3714 (format "Using specified sh-basic-offset of %d"
3715 sh-basic-offset)))
3716 (setq initial-msg
3717 (format "Initial value of sh-basic-offset: %s"
3718 sh-basic-offset)))
3720 (while (< (point) (point-max))
3721 (setq linenum (1+ linenum))
3722 ;; (if (zerop (% linenum 10))
3723 (message "line %d" linenum)
3724 ;; )
3725 (unless (looking-at "\\s-*$") ;; ignore empty lines!
3726 (let* ((sh-indent-comment t) ;; info must return default indent
3727 (info (sh-get-indent-info))
3728 (var (sh-get-indent-var-for-line info))
3729 sval ival diff new-val
3730 (curr-indent (current-indentation)))
3731 (cond
3732 ((null var)
3733 nil)
3734 ((stringp var)
3735 nil)
3736 ((numberp (setq sval (sh-var-value var 'no-error)))
3737 ;; the numberp excludes comments since sval will be t.
3738 (setq ival (sh-calculate-indent))
3739 (setq diff (- curr-indent ival))
3740 (setq new-val (+ sval diff))
3741 (sh-set-var-value var new-val 'no-symbol)
3742 (unless (looking-at "\\s-*#") ;; don't learn from comments
3743 (if (setq previous-set-info (assoc var learned-var-list))
3744 (progn
3745 ;; it was already there, is it same value ?
3746 (unless (eq (symbol-value var)
3747 (nth 1 previous-set-info))
3748 (sh-mark-line
3749 (format "Variable %s was set to %s"
3750 var (symbol-value var))
3751 (point) out-buffer t t)
3752 (sh-mark-line
3753 (format " but was previously set to %s"
3754 (nth 1 previous-set-info))
3755 (nth 2 previous-set-info) out-buffer t)
3756 (setq num-diffs (1+ num-diffs))
3757 ;; (delete previous-set-info learned-var-list)
3758 (setcdr previous-set-info
3759 (list (symbol-value var) (point)))
3762 (setq learned-var-list
3763 (append (list (list var (symbol-value var)
3764 (point)))
3765 learned-var-list)))
3766 (if (numberp new-val)
3767 (progn
3768 (sh-debug
3769 "This line's indent value: %d" new-val)
3770 (if (< new-val 0)
3771 (setq new-val (- new-val)))
3772 (if (< new-val max)
3773 (aset vec new-val (1+ (aref vec new-val))))))
3775 ((eq var 'sh-indent-comment)
3776 (unless (= curr-indent (sh-calculate-indent info))
3777 ;; this is not the default indentation
3778 (setq comments-always-default nil)
3779 (if comment-col ;; then we have see one before
3780 (or (eq comment-col curr-indent)
3781 (setq comment-col t)) ;; seen a different one
3782 (setq comment-col curr-indent))
3785 (sh-debug "Cannot learn this line!!!")
3787 (sh-debug
3788 "at %s learned-var-list is %s" (point) learned-var-list)
3790 (forward-line 1)
3791 ) ;; while
3792 (if sh-debug
3793 (progn
3794 (setq msg (format
3795 "comment-col = %s comments-always-default = %s"
3796 comment-col comments-always-default))
3797 ;; (message msg)
3798 (sh-mark-line msg nil out-buffer)))
3799 (cond
3800 ((eq comment-col 0)
3801 (setq msg "\nComments are all in 1st column.\n"))
3802 (comments-always-default
3803 (setq msg "\nComments follow default indentation.\n")
3804 (setq comment-col t))
3805 ((numberp comment-col)
3806 (setq msg (format "\nComments are in col %d." comment-col)))
3808 (setq msg "\nComments seem to be mixed, leaving them as is.\n")
3809 (setq comment-col nil)
3811 (sh-debug msg)
3812 (sh-mark-line msg nil out-buffer)
3814 (sh-mark-line initial-msg nil out-buffer t t)
3816 (setq suggested (sh-guess-basic-offset vec))
3818 (if (and suggested (not specified-basic-offset))
3819 (let ((new-value
3820 (cond
3821 ;; t => set it if we have a single value as a number
3822 ((and (eq sh-learn-basic-offset t) (numberp suggested))
3823 suggested)
3824 ;; other non-nil => set it if only one value was found
3825 (sh-learn-basic-offset
3826 (if (numberp suggested)
3827 suggested
3828 (if (= (length suggested) 1)
3829 (car suggested))))
3831 nil))))
3832 (if new-value
3833 (progn
3834 (setq learned-var-list
3835 (append (list (list 'sh-basic-offset
3836 (setq sh-basic-offset new-value)
3837 (point-max)))
3838 learned-var-list))
3839 ;; Not sure if we need to put this line in, since
3840 ;; it will appear in the "Learned variable settings".
3841 (sh-mark-line
3842 (format "Changed sh-basic-offset to: %d" sh-basic-offset)
3843 nil out-buffer))
3844 (sh-mark-line
3845 (if (listp suggested)
3846 (format "Possible value(s) for sh-basic-offset: %s"
3847 (mapconcat 'int-to-string suggested " "))
3848 (format "Suggested sh-basic-offset: %d" suggested))
3849 nil out-buffer))))
3852 (setq learned-var-list
3853 (append (list (list 'sh-indent-comment comment-col (point-max)))
3854 learned-var-list))
3855 (setq sh-indent-comment comment-col)
3856 (let ((name (buffer-name)))
3857 (sh-mark-line "\nLearned variable settings:" nil out-buffer)
3858 (if arg
3859 ;; Set learned variables to symbolic rather than numeric
3860 ;; values where possible.
3861 (dolist (learned-var (reverse learned-var-list))
3862 (let ((var (car learned-var))
3863 (val (nth 1 learned-var)))
3864 (when (and (not (eq var 'sh-basic-offset))
3865 (numberp val))
3866 (sh-set-var-value var val)))))
3867 (dolist (learned-var (reverse learned-var-list))
3868 (let ((var (car learned-var)))
3869 (sh-mark-line (format " %s %s" var (symbol-value var))
3870 (nth 2 learned-var) out-buffer)))
3871 (with-current-buffer out-buffer
3872 (goto-char (point-min))
3873 (let ((inhibit-read-only t))
3874 (insert
3875 (format "Indentation values for buffer %s.\n" name)
3876 (format "%d indentation variable%s different values%s\n\n"
3877 num-diffs
3878 (if (= num-diffs 1)
3879 " has" "s have")
3880 (if (zerop num-diffs)
3881 "." ":"))))))
3882 ;; Are abnormal hooks considered bad form?
3883 (run-hook-with-args 'sh-learned-buffer-hook learned-var-list)
3884 (and (called-interactively-p 'any)
3885 (or sh-popup-occur-buffer (> num-diffs 0))
3886 (pop-to-buffer out-buffer))))))
3888 (defun sh-guess-basic-offset (vec)
3889 "See if we can determine a reasonable value for `sh-basic-offset'.
3890 This is experimental, heuristic and arbitrary!
3891 Argument VEC is a vector of information collected by
3892 `sh-learn-buffer-indent'.
3893 Return values:
3894 number - there appears to be a good single value
3895 list of numbers - no obvious one, here is a list of one or more
3896 reasonable choices
3897 nil - we couldn't find a reasonable one."
3898 (let* ((max (1- (length vec)))
3899 (i 1)
3900 (totals (make-vector max 0)))
3901 (while (< i max)
3902 (cl-incf (aref totals i) (* 4 (aref vec i)))
3903 (if (zerop (% i 2))
3904 (cl-incf (aref totals i) (aref vec (/ i 2))))
3905 (if (< (* i 2) max)
3906 (cl-incf (aref totals i) (aref vec (* i 2))))
3907 (setq i (1+ i)))
3909 (let ((x nil)
3910 (result nil)
3911 tot sum p)
3912 (setq i 1)
3913 (while (< i max)
3914 (if (/= (aref totals i) 0)
3915 (push (cons i (aref totals i)) x))
3916 (setq i (1+ i)))
3918 (setq x (sort (nreverse x) (lambda (a b) (> (cdr a) (cdr b)))))
3919 (setq tot (apply '+ (append totals nil)))
3920 (sh-debug (format "vec: %s\ntotals: %s\ntot: %d"
3921 vec totals tot))
3922 (cond
3923 ((zerop (length x))
3924 (message "no values!")) ;; we return nil
3925 ((= (length x) 1)
3926 (message "only value is %d" (car (car x)))
3927 (setq result (car (car x)))) ;; return single value
3928 ((> (cdr (car x)) (/ tot 2))
3929 ;; 1st is > 50%
3930 (message "basic-offset is probably %d" (car (car x)))
3931 (setq result (car (car x)))) ;; again, return a single value
3932 ((>= (cdr (car x)) (* 2 (cdr (car (cdr x)))))
3933 ;; 1st is >= 2 * 2nd
3934 (message "basic-offset could be %d" (car (car x)))
3935 (setq result (car (car x))))
3936 ((>= (+ (cdr (car x))(cdr (car (cdr x)))) (/ tot 2))
3937 ;; 1st & 2nd together >= 50% - return a list
3938 (setq p x sum 0 result nil)
3939 (while (and p
3940 (<= (setq sum (+ sum (cdr (car p)))) (/ tot 2)))
3941 (setq result (append result (list (car (car p)))))
3942 (setq p (cdr p)))
3943 (message "Possible choices for sh-basic-offset: %s"
3944 (mapconcat 'int-to-string result " ")))
3946 (message "No obvious value for sh-basic-offset. Perhaps %d"
3947 (car (car x)))
3948 ;; result is nil here
3950 result)))
3952 ;; ========================================================================
3954 ;; Styles -- a quick and dirty way of saving the indentation settings.
3956 (defvar sh-styles-alist nil
3957 "A list of all known shell indentation styles.")
3959 (defun sh-name-style (name &optional confirm-overwrite)
3960 "Name the current indentation settings as a style called NAME.
3961 If this name exists, the command will prompt whether it should be
3962 overwritten if
3963 - - it was called interactively with a prefix argument, or
3964 - - called non-interactively with optional CONFIRM-OVERWRITE non-nil."
3965 ;; (interactive "sName for this style: ")
3966 (interactive
3967 (list
3968 (read-from-minibuffer "Name for this style? " )
3969 (not current-prefix-arg)))
3970 (let ((slist (cons name
3971 (mapcar (lambda (var) (cons var (symbol-value var)))
3972 sh-var-list)))
3973 (style (assoc name sh-styles-alist)))
3974 (if style
3975 (if (and confirm-overwrite
3976 (not (y-or-n-p "This style exists. Overwrite it? ")))
3977 (message "Not changing style %s" name)
3978 (message "Updating style %s" name)
3979 (setcdr style (cdr slist)))
3980 (message "Creating new style %s" name)
3981 (push slist sh-styles-alist))))
3983 (defun sh-load-style (name)
3984 "Set shell indentation values for this buffer from those in style NAME."
3985 (interactive (list (completing-read
3986 "Which style to use for this buffer? "
3987 sh-styles-alist nil t)))
3988 (let ((sl (assoc name sh-styles-alist)))
3989 (if (null sl)
3990 (error "sh-load-style - style %s not known" name)
3991 (dolist (var (cdr sl))
3992 (set (car var) (cdr var))))))
3994 (defun sh-save-styles-to-buffer (buff)
3995 "Save all current styles in elisp to buffer BUFF.
3996 This is always added to the end of the buffer."
3997 (interactive
3998 (list
3999 (read-from-minibuffer "Buffer to save styles in? " "*scratch*")))
4000 (with-current-buffer (get-buffer-create buff)
4001 (goto-char (point-max))
4002 (insert "\n")
4003 (pp `(setq sh-styles-alist ',sh-styles-alist) (current-buffer))))
4007 ;; statement syntax-commands for various shells
4009 ;; You are welcome to add the syntax or even completely new statements as
4010 ;; appropriate for your favorite shell.
4012 (defconst sh-non-closing-paren
4013 ;; If we leave it rear-sticky, calling `newline' ends up inserting a \n
4014 ;; that inherits this property, which then confuses the indentation.
4015 (propertize ")" 'syntax-table sh-st-punc 'rear-nonsticky t))
4017 (define-skeleton sh-case
4018 "Insert a case/switch statement. See `sh-feature'."
4019 (csh "expression: "
4020 "switch( " str " )" \n
4021 > "case " (read-string "pattern: ") ?: \n
4022 > _ \n
4023 "breaksw" \n
4024 ( "other pattern, %s: "
4025 < "case " str ?: \n
4026 > _ \n
4027 "breaksw" \n)
4028 < "default:" \n
4029 > _ \n
4030 resume:
4031 < < "endsw" \n)
4032 (es)
4033 (rc "expression: "
4034 > "switch( " str " ) {" \n
4035 > "case " (read-string "pattern: ") \n
4036 > _ \n
4037 ( "other pattern, %s: "
4038 "case " str > \n
4039 > _ \n)
4040 "case *" > \n
4041 > _ \n
4042 resume:
4043 ?\} > \n)
4044 (sh "expression: "
4045 > "case " str " in" \n
4046 ( "pattern, %s: "
4047 > str sh-non-closing-paren \n
4048 > _ \n
4049 ";;" \n)
4050 > "*" sh-non-closing-paren \n
4051 > _ \n
4052 resume:
4053 "esac" > \n))
4055 (define-skeleton sh-for
4056 "Insert a for loop. See `sh-feature'."
4057 (csh sh-modify sh
4058 1 ""
4059 2 "foreach "
4060 4 " ( "
4061 6 " )"
4062 15 '<
4063 16 "end")
4064 (es sh-modify rc
4065 4 " = ")
4066 (rc sh-modify sh
4067 2 "for( "
4068 6 " ) {"
4069 15 ?\} )
4070 (sh "Index variable: "
4071 > "for " str " in " _ "; do" \n
4072 > _ | ?$ & (sh-remember-variable str) \n
4073 "done" > \n))
4077 (define-skeleton sh-indexed-loop
4078 "Insert an indexed loop from 1 to n. See `sh-feature'."
4079 (bash sh-modify posix)
4080 (csh "Index variable: "
4081 "@ " str " = 1" \n
4082 "while( $" str " <= " (read-string "upper limit: ") " )" \n
4083 > _ ?$ str \n
4084 "@ " str "++" \n
4085 < "end" \n)
4086 (es sh-modify rc
4087 4 " =")
4088 (ksh88 "Index variable: "
4089 > "integer " str "=0" \n
4090 > "while (( ( " str " += 1 ) <= "
4091 (read-string "upper limit: ")
4092 " )); do" \n
4093 > _ ?$ (sh-remember-variable str) > \n
4094 "done" > \n)
4095 (posix "Index variable: "
4096 > str "=1" \n
4097 "while [ $" str " -le "
4098 (read-string "upper limit: ")
4099 " ]; do" \n
4100 > _ ?$ str \n
4101 str ?= (sh-add (sh-remember-variable str) 1) \n
4102 "done" > \n)
4103 (rc "Index variable: "
4104 > "for( " str " in" " `{awk 'BEGIN { for( i=1; i<="
4105 (read-string "upper limit: ")
4106 "; i++ ) print i }'`}) {" \n
4107 > _ ?$ (sh-remember-variable str) \n
4108 ?\} > \n)
4109 (sh "Index variable: "
4110 > "for " str " in `awk 'BEGIN { for( i=1; i<="
4111 (read-string "upper limit: ")
4112 "; i++ ) print i }'`; do" \n
4113 > _ ?$ (sh-remember-variable str) \n
4114 "done" > \n))
4117 (defun sh-shell-initialize-variables ()
4118 "Scan the buffer for variable assignments.
4119 Add these variables to `sh-shell-variables'."
4120 (message "Scanning buffer `%s' for variable assignments..." (buffer-name))
4121 (save-excursion
4122 (goto-char (point-min))
4123 (setq sh-shell-variables-initialized t)
4124 (while (search-forward "=" nil t)
4125 (sh-assignment 0)))
4126 (message "Scanning buffer `%s' for variable assignments...done"
4127 (buffer-name)))
4129 (defvar sh-add-buffer)
4131 (defun sh-add-completer (string predicate code)
4132 "Do completion using `sh-shell-variables', but initialize it first.
4133 This function is designed for use as the \"completion table\",
4134 so it takes three arguments:
4135 STRING, the current buffer contents;
4136 PREDICATE, the predicate for filtering possible matches;
4137 CODE, which says what kind of things to do.