* lisp/url/url-history.el: Use lexical-binding
[emacs.git] / lisp / progmodes / sh-script.el
blob35b555e687978646d2dd054f8444cb20272525e0
1 ;;; sh-script.el --- shell-script editing commands for Emacs -*- lexical-binding:t -*-
3 ;; Copyright (C) 1993-1997, 1999, 2001-2017 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 ;; Treat ' as punctuation rather than a string delimiter, as RPM
497 ;; files often contain prose with apostrophes.
498 (rpm . (,sh-mode-syntax-table ?\' ".")))
499 "Syntax-table used in Shell-Script mode. See `sh-feature'.")
501 (defvar sh-mode-map
502 (let ((map (make-sparse-keymap))
503 (menu-map (make-sparse-keymap)))
504 (define-key map "\C-c(" 'sh-function)
505 (define-key map "\C-c\C-w" 'sh-while)
506 (define-key map "\C-c\C-u" 'sh-until)
507 (define-key map "\C-c\C-t" 'sh-tmp-file)
508 (define-key map "\C-c\C-s" 'sh-select)
509 (define-key map "\C-c\C-r" 'sh-repeat)
510 (define-key map "\C-c\C-o" 'sh-while-getopts)
511 (define-key map "\C-c\C-l" 'sh-indexed-loop)
512 (define-key map "\C-c\C-i" 'sh-if)
513 (define-key map "\C-c\C-f" 'sh-for)
514 (define-key map "\C-c\C-c" 'sh-case)
515 (define-key map "\C-c?" 'sh-show-indent)
516 (define-key map "\C-c=" 'sh-set-indent)
517 (define-key map "\C-c<" 'sh-learn-line-indent)
518 (define-key map "\C-c>" 'sh-learn-buffer-indent)
519 (define-key map "\C-c\C-\\" 'sh-backslash-region)
521 (define-key map "=" 'sh-assignment)
522 (define-key map "\C-c+" 'sh-add)
523 (define-key map "\C-\M-x" 'sh-execute-region)
524 (define-key map "\C-c\C-x" 'executable-interpret)
525 (define-key map "\C-c\C-n" 'sh-send-line-or-region-and-step)
526 (define-key map "\C-c\C-d" 'sh-cd-here)
527 (define-key map "\C-c\C-z" 'sh-show-shell)
529 (define-key map [remap delete-backward-char]
530 'backward-delete-char-untabify)
531 (define-key map "\C-c:" 'sh-set-shell)
532 (define-key map [remap backward-sentence] 'sh-beginning-of-command)
533 (define-key map [remap forward-sentence] 'sh-end-of-command)
534 (define-key map [menu-bar sh-script] (cons "Sh-Script" menu-map))
535 (define-key menu-map [sh-learn-buffer-indent]
536 '(menu-item "Learn buffer indentation" sh-learn-buffer-indent
537 :help "Learn how to indent the buffer the way it currently is."))
538 (define-key menu-map [sh-learn-line-indent]
539 '(menu-item "Learn line indentation" sh-learn-line-indent
540 :help "Learn how to indent a line as it currently is indented"))
541 (define-key menu-map [sh-show-indent]
542 '(menu-item "Show indentation" sh-show-indent
543 :help "Show the how the current line would be indented"))
544 (define-key menu-map [sh-set-indent]
545 '(menu-item "Set indentation" sh-set-indent
546 :help "Set the indentation for the current line"))
548 (define-key menu-map [sh-pair]
549 '(menu-item "Insert braces and quotes in pairs"
550 electric-pair-mode
551 :button (:toggle . (bound-and-true-p electric-pair-mode))
552 :help "Inserting a brace or quote automatically inserts the matching pair"))
554 (define-key menu-map [sh-s0] '("--"))
555 ;; Insert
556 (define-key menu-map [sh-function]
557 '(menu-item "Function..." sh-function
558 :help "Insert a function definition"))
559 (define-key menu-map [sh-add]
560 '(menu-item "Addition..." sh-add
561 :help "Insert an addition of VAR and prefix DELTA for Bourne (type) shell"))
562 (define-key menu-map [sh-until]
563 '(menu-item "Until Loop" sh-until
564 :help "Insert an until loop"))
565 (define-key menu-map [sh-repeat]
566 '(menu-item "Repeat Loop" sh-repeat
567 :help "Insert a repeat loop definition"))
568 (define-key menu-map [sh-while]
569 '(menu-item "While Loop" sh-while
570 :help "Insert a while loop"))
571 (define-key menu-map [sh-getopts]
572 '(menu-item "Options Loop" sh-while-getopts
573 :help "Insert a while getopts loop."))
574 (define-key menu-map [sh-indexed-loop]
575 '(menu-item "Indexed Loop" sh-indexed-loop
576 :help "Insert an indexed loop from 1 to n."))
577 (define-key menu-map [sh-select]
578 '(menu-item "Select Statement" sh-select
579 :help "Insert a select statement "))
580 (define-key menu-map [sh-if]
581 '(menu-item "If Statement" sh-if
582 :help "Insert an if statement"))
583 (define-key menu-map [sh-for]
584 '(menu-item "For Loop" sh-for
585 :help "Insert a for loop"))
586 (define-key menu-map [sh-case]
587 '(menu-item "Case Statement" sh-case
588 :help "Insert a case/switch statement"))
589 (define-key menu-map [sh-s1] '("--"))
590 (define-key menu-map [sh-exec]
591 '(menu-item "Execute region" sh-execute-region
592 :help "Pass optional header and region to a subshell for noninteractive execution"))
593 (define-key menu-map [sh-exec-interpret]
594 '(menu-item "Execute script..." executable-interpret
595 :help "Run script with user-specified args, and collect output in a buffer"))
596 (define-key menu-map [sh-set-shell]
597 '(menu-item "Set shell type..." sh-set-shell
598 :help "Set this buffer's shell to SHELL (a string)"))
599 (define-key menu-map [sh-backslash-region]
600 '(menu-item "Backslash region" sh-backslash-region
601 :help "Insert, align, or delete end-of-line backslashes on the lines in the region."))
602 map)
603 "Keymap used in Shell-Script mode.")
605 (defvar sh-skeleton-pair-default-alist '((?\( _ ?\)) (?\))
606 (?\[ ?\s _ ?\s ?\]) (?\])
607 (?{ _ ?}) (?\}))
608 "Value to use for `skeleton-pair-default-alist' in Shell-Script mode.")
610 (defcustom sh-dynamic-complete-functions
611 '(shell-environment-variable-completion
612 shell-command-completion
613 comint-filename-completion)
614 "Functions for doing TAB dynamic completion."
615 :type '(repeat function)
616 :group 'sh-script)
618 (defcustom sh-assignment-regexp
619 `((csh . "\\<\\([[:alnum:]_]+\\)\\(\\[.+\\]\\)?[ \t]*[-+*/%^]?=")
620 ;; actually spaces are only supported in let/(( ... ))
621 (ksh88 . ,(concat "\\<\\([[:alnum:]_]+\\)\\(\\[.+\\]\\)?"
622 "[ \t]*\\(?:[-+*/%&|~^]\\|<<\\|>>\\)?="))
623 (bash . "\\<\\([[:alnum:]_]+\\)\\(\\[.+\\]\\)?\\+?=")
624 (rc . "\\<\\([[:alnum:]_*]+\\)[ \t]*=")
625 (sh . "\\<\\([[:alnum:]_]+\\)="))
626 "Regexp for the variable name and what may follow in an assignment.
627 First grouping matches the variable name. This is upto and including the `='
628 sign. See `sh-feature'."
629 :type '(repeat (cons (symbol :tag "Shell")
630 (choice regexp
631 (sexp :format "Evaluate: %v"))))
632 :group 'sh-script)
635 (defcustom sh-indentation 4
636 "The width for further indentation in Shell-Script mode."
637 :type 'integer
638 :group 'sh-script)
639 (put 'sh-indentation 'safe-local-variable 'integerp)
641 (defcustom sh-remember-variable-min 3
642 "Don't remember variables less than this length for completing reads."
643 :type 'integer
644 :group 'sh-script)
647 (defvar sh-header-marker nil
648 "When non-nil is the end of header for prepending by \\[sh-execute-region].
649 That command is also used for setting this variable.")
650 (make-variable-buffer-local 'sh-header-marker)
652 (defcustom sh-beginning-of-command
653 "\\([;({`|&]\\|\\`\\|[^\\]\n\\)[ \t]*\\([/~[:alnum:]:]\\)"
654 "Regexp to determine the beginning of a shell command.
655 The actual command starts at the beginning of the second \\(grouping\\)."
656 :type 'regexp
657 :group 'sh-script)
660 (defcustom sh-end-of-command
661 "\\([/~[:alnum:]:]\\)[ \t]*\\([;#)}`|&]\\|$\\)"
662 "Regexp to determine the end of a shell command.
663 The actual command ends at the end of the first \\(grouping\\)."
664 :type 'regexp
665 :group 'sh-script)
669 (defcustom sh-here-document-word "EOF"
670 "Word to delimit here documents.
671 If the first character of this string is \"-\", this is taken as
672 part of the redirection operator, rather than part of the
673 word (that is, \"<<-\" instead of \"<<\"). This is a feature
674 used by some shells (for example Bash) to indicate that leading
675 tabs inside the here document should be ignored. In this case,
676 Emacs indents the initial body and end of the here document with
677 tabs, to the same level as the start (note that apart from this
678 there is no support for indentation of here documents). This
679 will only work correctly if `sh-basic-offset' is a multiple of
680 `tab-width'.
682 Any quote characters or leading whitespace in the word are
683 removed when closing the here document."
684 :type 'string
685 :group 'sh-script)
688 (defvar sh-test
689 '((sh "[ ]" . 3)
690 (ksh88 "[[ ]]" . 4))
691 "Initial input in Bourne if, while and until skeletons. See `sh-feature'.")
694 ;; customized this out of sheer bravado. not for the faint of heart.
695 ;; but it *did* have an asterisk in the docstring!
696 (defcustom sh-builtins
697 '((bash sh-append posix
698 "." "alias" "bg" "bind" "builtin" "caller" "compgen" "complete"
699 "declare" "dirs" "disown" "enable" "fc" "fg" "help" "history"
700 "jobs" "kill" "let" "local" "popd" "printf" "pushd" "shopt"
701 "source" "suspend" "typeset" "unalias"
702 ;; bash4
703 "mapfile" "readarray" "coproc")
705 ;; The next entry is only used for defining the others
706 (bourne sh-append shell
707 "eval" "export" "getopts" "newgrp" "pwd" "read" "readonly"
708 "times" "ulimit")
710 (csh sh-append shell
711 "alias" "chdir" "glob" "history" "limit" "nice" "nohup" "rehash"
712 "setenv" "source" "time" "unalias" "unhash")
714 (dtksh sh-append wksh)
716 (es "access" "apids" "cd" "echo" "eval" "false" "let" "limit" "local"
717 "newpgrp" "result" "time" "umask" "var" "vars" "wait" "whatis")
719 (jsh sh-append sh
720 "bg" "fg" "jobs" "kill" "stop" "suspend")
722 (jcsh sh-append csh
723 "bg" "fg" "jobs" "kill" "notify" "stop" "suspend")
725 (ksh88 sh-append bourne
726 "alias" "bg" "false" "fc" "fg" "jobs" "kill" "let" "print" "time"
727 "typeset" "unalias" "whence")
729 (oash sh-append sh
730 "checkwin" "dateline" "error" "form" "menu" "newwin" "oadeinit"
731 "oaed" "oahelp" "oainit" "pp" "ppfile" "scan" "scrollok" "wattr"
732 "wclear" "werase" "win" "wmclose" "wmmessage" "wmopen" "wmove"
733 "wmtitle" "wrefresh")
735 (pdksh sh-append ksh88
736 "bind")
738 (posix sh-append sh
739 "command")
741 (rc "builtin" "cd" "echo" "eval" "limit" "newpgrp" "shift" "umask" "wait"
742 "whatis")
744 (sh sh-append bourne
745 "hash" "test" "type")
747 ;; The next entry is only used for defining the others
748 (shell "cd" "echo" "eval" "set" "shift" "umask" "unset" "wait")
750 (wksh sh-append ksh88
751 ;; FIXME: This looks too much like a regexp. --Stef
752 "Xt[A-Z][A-Za-z]*")
754 (zsh sh-append ksh88
755 "autoload" "bindkey" "builtin" "chdir" "compctl" "declare" "dirs"
756 "disable" "disown" "echotc" "enable" "functions" "getln" "hash"
757 "history" "integer" "limit" "local" "log" "popd" "pushd" "r"
758 "readonly" "rehash" "sched" "setopt" "source" "suspend" "true"
759 "ttyctl" "type" "unfunction" "unhash" "unlimit" "unsetopt" "vared"
760 "which"))
761 "List of all shell builtins for completing read and fontification.
762 Note that on some systems not all builtins are available or some are
763 implemented as aliases. See `sh-feature'."
764 :type '(repeat (cons (symbol :tag "Shell")
765 (choice (repeat string)
766 (sexp :format "Evaluate: %v"))))
767 :version "24.4" ; bash4 additions
768 :group 'sh-script)
772 (defcustom sh-leading-keywords
773 '((bash sh-append sh
774 "time")
776 (csh "else")
778 (es "true" "unwind-protect" "whatis")
780 (rc "else")
782 (sh "!" "do" "elif" "else" "if" "then" "trap" "type" "until" "while"))
783 "List of keywords that may be immediately followed by a builtin or keyword.
784 Given some confusion between keywords and builtins depending on shell and
785 system, the distinction here has been based on whether they influence the
786 flow of control or syntax. See `sh-feature'."
787 :type '(repeat (cons (symbol :tag "Shell")
788 (choice (repeat string)
789 (sexp :format "Evaluate: %v"))))
790 :group 'sh-script)
793 (defcustom sh-other-keywords
794 '((bash sh-append bourne
795 "bye" "logout" "select")
797 ;; The next entry is only used for defining the others
798 (bourne sh-append sh
799 "function")
801 (csh sh-append shell
802 "breaksw" "default" "end" "endif" "endsw" "foreach" "goto"
803 "if" "logout" "onintr" "repeat" "switch" "then" "while")
805 (es "break" "catch" "exec" "exit" "fn" "for" "forever" "fork" "if"
806 "return" "throw" "while")
808 (ksh88 sh-append bourne
809 "select")
811 (rc "break" "case" "exec" "exit" "fn" "for" "if" "in" "return" "switch"
812 "while")
814 (sh sh-append shell
815 "done" "esac" "fi" "for" "in" "return")
817 ;; The next entry is only used for defining the others
818 (shell "break" "case" "continue" "exec" "exit")
820 (zsh sh-append bash
821 "select" "foreach"))
822 "List of keywords not in `sh-leading-keywords'.
823 See `sh-feature'."
824 :type '(repeat (cons (symbol :tag "Shell")
825 (choice (repeat string)
826 (sexp :format "Evaluate: %v"))))
827 :group 'sh-script)
831 (defvar sh-variables
832 '((bash sh-append sh
833 "allow_null_glob_expansion" "auto_resume" "BASH" "BASH_ENV"
834 "BASH_VERSINFO" "BASH_VERSION" "cdable_vars" "COMP_CWORD"
835 "COMP_LINE" "COMP_POINT" "COMP_WORDS" "COMPREPLY" "DIRSTACK"
836 "ENV" "EUID" "FCEDIT" "FIGNORE" "FUNCNAME"
837 "glob_dot_filenames" "GLOBIGNORE" "GROUPS" "histchars"
838 "HISTCMD" "HISTCONTROL" "HISTFILE" "HISTFILESIZE"
839 "HISTIGNORE" "history_control" "HISTSIZE"
840 "hostname_completion_file" "HOSTFILE" "HOSTTYPE" "IGNOREEOF"
841 "ignoreeof" "INPUTRC" "LINENO" "MACHTYPE" "MAIL_WARNING"
842 "noclobber" "nolinks" "notify" "no_exit_on_failed_exec"
843 "NO_PROMPT_VARS" "OLDPWD" "OPTERR" "OSTYPE" "PIPESTATUS"
844 "PPID" "POSIXLY_CORRECT" "PROMPT_COMMAND" "PS3" "PS4"
845 "pushd_silent" "PWD" "RANDOM" "REPLY" "SECONDS" "SHELLOPTS"
846 "SHLVL" "TIMEFORMAT" "TMOUT" "UID")
848 (csh sh-append shell
849 "argv" "cdpath" "child" "echo" "histchars" "history" "home"
850 "ignoreeof" "mail" "noclobber" "noglob" "nonomatch" "path" "prompt"
851 "shell" "status" "time" "verbose")
853 (es sh-append shell
854 "apid" "cdpath" "CDPATH" "history" "home" "ifs" "noexport" "path"
855 "pid" "prompt" "signals")
857 (jcsh sh-append csh
858 "notify")
860 (ksh88 sh-append sh
861 "ENV" "ERRNO" "FCEDIT" "FPATH" "HISTFILE" "HISTSIZE" "LINENO"
862 "OLDPWD" "PPID" "PS3" "PS4" "PWD" "RANDOM" "REPLY" "SECONDS"
863 "TMOUT")
865 (oash sh-append sh
866 "FIELD" "FIELD_MAX" "LAST_KEY" "OALIB" "PP_ITEM" "PP_NUM")
868 (rc sh-append shell
869 "apid" "apids" "cdpath" "CDPATH" "history" "home" "ifs" "path" "pid"
870 "prompt" "status")
872 (sh sh-append shell
873 "CDPATH" "IFS" "OPTARG" "OPTIND" "PS1" "PS2")
875 ;; The next entry is only used for defining the others
876 (shell "COLUMNS" "EDITOR" "HOME" "HUSHLOGIN" "LANG" "LC_COLLATE"
877 "LC_CTYPE" "LC_MESSAGES" "LC_MONETARY" "LC_NUMERIC" "LC_TIME"
878 "LINES" "LOGNAME" "MAIL" "MAILCHECK" "MAILPATH" "PAGER" "PATH"
879 "SHELL" "TERM" "TERMCAP" "TERMINFO" "VISUAL")
881 (tcsh sh-append csh
882 "addsuffix" "ampm" "autocorrect" "autoexpand" "autolist"
883 "autologout" "chase_symlinks" "correct" "dextract" "edit" "el"
884 "fignore" "gid" "histlit" "HOST" "HOSTTYPE" "HPATH"
885 "ignore_symlinks" "listjobs" "listlinks" "listmax" "matchbeep"
886 "nobeep" "NOREBIND" "oid" "printexitvalue" "prompt2" "prompt3"
887 "pushdsilent" "pushdtohome" "recexact" "recognize_only_executables"
888 "rmstar" "savehist" "SHLVL" "showdots" "sl" "SYSTYPE" "tcsh" "term"
889 "tperiod" "tty" "uid" "version" "visiblebell" "watch" "who"
890 "wordchars")
892 (zsh sh-append ksh88
893 "BAUD" "bindcmds" "cdpath" "DIRSTACKSIZE" "fignore" "FIGNORE" "fpath"
894 "HISTCHARS" "hostcmds" "hosts" "HOSTS" "LISTMAX" "LITHISTSIZE"
895 "LOGCHECK" "mailpath" "manpath" "NULLCMD" "optcmds" "path" "POSTEDIT"
896 "prompt" "PROMPT" "PROMPT2" "PROMPT3" "PROMPT4" "psvar" "PSVAR"
897 "READNULLCMD" "REPORTTIME" "RPROMPT" "RPS1" "SAVEHIST" "SPROMPT"
898 "STTY" "TIMEFMT" "TMOUT" "TMPPREFIX" "varcmds" "watch" "WATCH"
899 "WATCHFMT" "WORDCHARS" "ZDOTDIR"))
900 "List of all shell variables available for completing read.
901 See `sh-feature'.")
904 ;; Font-Lock support
906 (defface sh-heredoc
907 '((((min-colors 88) (class color)
908 (background dark))
909 (:foreground "yellow1" :weight bold))
910 (((class color)
911 (background dark))
912 (:foreground "yellow" :weight bold))
913 (((class color)
914 (background light))
915 (:foreground "tan1" ))
917 (:weight bold)))
918 "Face to show a here-document."
919 :group 'sh-indentation)
921 ;; These colors are probably icky. It's just a placeholder though.
922 (defface sh-quoted-exec
923 '((((class color) (background dark))
924 (:foreground "salmon"))
925 (((class color) (background light))
926 (:foreground "magenta"))
928 (:weight bold)))
929 "Face to show quoted execs like \\=`blabla\\=`."
930 :group 'sh-indentation)
932 (defface sh-escaped-newline '((t :inherit font-lock-string-face))
933 "Face used for (non-escaped) backslash at end of a line in Shell-script mode."
934 :group 'sh-script
935 :version "22.1")
937 (defvar sh-font-lock-keywords-var
938 '((csh sh-append shell
939 ("\\${?[#?]?\\([[:alpha:]_][[:alnum:]_]*\\|0\\)" 1
940 font-lock-variable-name-face))
942 (es sh-append executable-font-lock-keywords
943 ("\\$#?\\([[:alpha:]_][[:alnum:]_]*\\|[0-9]+\\)" 1
944 font-lock-variable-name-face))
946 (rc sh-append es)
947 (bash sh-append sh ("\\$(\\(\\sw+\\)" (1 'sh-quoted-exec t) ))
948 (sh sh-append shell
949 ;; Variable names.
950 ("\\$\\({#?\\)?\\([[:alpha:]_][[:alnum:]_]*\\|[-#?@!]\\)" 2
951 font-lock-variable-name-face)
952 ;; Function names.
953 ("^\\(\\sw+\\)[ \t]*(" 1 font-lock-function-name-face)
954 ("\\<\\(function\\)\\>[ \t]*\\(\\sw+\\)?"
955 (1 font-lock-keyword-face) (2 font-lock-function-name-face nil t))
956 ("\\(?:^\\s *\\|[[();&|]\\s *\\|\\(?:\\s +-[ao]\\|if\\|else\\|then\\|while\\|do\\)\\s +\\)\\(!\\)"
957 1 font-lock-negation-char-face))
959 ;; The next entry is only used for defining the others
960 (shell
961 ;; Using font-lock-string-face here confuses sh-get-indent-info.
962 ("\\(^\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\\\)$" 3 'sh-escaped-newline)
963 ("\\\\[^[:alnum:]]" 0 font-lock-string-face)
964 ("\\${?\\([[:alpha:]_][[:alnum:]_]*\\|[0-9]+\\|[$*_]\\)" 1
965 font-lock-variable-name-face))
966 (rpm sh-append rpm2
967 ("%{?\\(\\sw+\\)" 1 font-lock-keyword-face))
968 (rpm2 sh-append shell
969 ("^Summary:\\(.*\\)$" (1 font-lock-doc-face t))
970 ("^\\(\\sw+\\):" 1 font-lock-variable-name-face)))
971 "Default expressions to highlight in Shell Script modes. See `sh-feature'.")
973 (defvar sh-font-lock-keywords-var-1
974 '((sh "[ \t]in\\>"))
975 "Subdued level highlighting for Shell Script modes.")
977 (defvar sh-font-lock-keywords-var-2 ()
978 "Gaudy level highlighting for Shell Script modes.")
980 ;; These are used for the syntax table stuff (derived from cperl-mode).
981 ;; Note: parse-sexp-lookup-properties must be set to t for it to work.
982 (defconst sh-st-punc (string-to-syntax "."))
983 (defconst sh-here-doc-syntax (string-to-syntax "|")) ;; generic string
985 (eval-and-compile
986 (defconst sh-escaped-line-re
987 ;; Should match until the real end-of-continued-line, but if that is not
988 ;; possible (because we bump into EOB or the search bound), then we should
989 ;; match until the search bound.
990 "\\(?:\\(?:.*[^\\\n]\\)?\\(?:\\\\\\\\\\)*\\\\\n\\)*.*")
992 (defconst sh-here-doc-open-re
993 (concat "[^<]<<-?\\s-*\\\\?\\(\\(?:['\"][^'\"]+['\"]\\|\\sw\\|[-/~._]\\)+\\)"
994 sh-escaped-line-re "\\(\n\\)")))
996 (defun sh--inside-noncommand-expression (pos)
997 (save-excursion
998 (let ((ppss (syntax-ppss pos)))
999 (when (nth 1 ppss)
1000 (goto-char (nth 1 ppss))
1002 (pcase (char-after)
1003 ;; ((...)) or $((...)) or $[...] or ${...}. Nested
1004 ;; parenthesis can occur inside the first of these forms, so
1005 ;; parse backward recursively.
1006 (`?\( (eq ?\( (char-before)))
1007 ((or `?\{ `?\[) (eq ?\$ (char-before))))
1008 (sh--inside-noncommand-expression (1- (point))))))))
1010 (defun sh-font-lock-open-heredoc (start string eol)
1011 "Determine the syntax of the \\n after a <<EOF.
1012 START is the position of <<.
1013 STRING is the actual word used as delimiter (e.g. \"EOF\").
1014 INDENTED is non-nil if the here document's content (and the EOF mark) can
1015 be indented (i.e. a <<- was used rather than just <<).
1016 Point is at the beginning of the next line."
1017 (unless (or (memq (char-before start) '(?< ?>))
1018 (sh-in-comment-or-string start)
1019 (sh--inside-noncommand-expression start))
1020 ;; We're looking at <<STRING, so we add "^STRING$" to the syntactic
1021 ;; font-lock keywords to detect the end of this here document.
1022 (let ((str (replace-regexp-in-string "['\"]" "" string))
1023 (ppss (save-excursion (syntax-ppss eol))))
1024 (if (nth 4 ppss)
1025 ;; The \n not only starts the heredoc but also closes a comment.
1026 ;; Let's close the comment just before the \n.
1027 (put-text-property (1- eol) eol 'syntax-table '(12))) ;">"
1028 (if (or (nth 5 ppss) (> (count-lines start eol) 1))
1029 ;; If the sh-escaped-line-re part of sh-here-doc-open-re has matched
1030 ;; several lines, make sure we refontify them together.
1031 ;; Furthermore, if (nth 5 ppss) is non-nil (i.e. the \n is
1032 ;; escaped), it means the right \n is actually further down.
1033 ;; Don't bother fixing it now, but place a multiline property so
1034 ;; that when jit-lock-context-* refontifies the rest of the
1035 ;; buffer, it also refontifies the current line with it.
1036 (put-text-property start (1+ eol) 'syntax-multiline t))
1037 (put-text-property eol (1+ eol) 'sh-here-doc-marker str)
1038 (prog1 sh-here-doc-syntax
1039 (goto-char (+ 2 start))))))
1041 (defun sh-syntax-propertize-here-doc (end)
1042 (let ((ppss (syntax-ppss)))
1043 (when (eq t (nth 3 ppss))
1044 (let ((key (get-text-property (nth 8 ppss) 'sh-here-doc-marker))
1045 (case-fold-search nil))
1046 (when (re-search-forward
1047 (concat "^\\([ \t]*\\)" (regexp-quote key) "\\(\n\\)")
1048 end 'move)
1049 (let ((eol (match-beginning 2)))
1050 (put-text-property eol (1+ eol)
1051 'syntax-table sh-here-doc-syntax)))))))
1053 (defun sh-font-lock-quoted-subshell (limit)
1054 "Search for a subshell embedded in a string.
1055 Find all the unescaped \" characters within said subshell, remembering that
1056 subshells can nest."
1057 (when (eq ?\" (nth 3 (syntax-ppss))) ; Check we matched an opening quote.
1058 ;; bingo we have a $( or a ` inside a ""
1059 (let (;; `state' can be: double-quote, backquote, code.
1060 (state (if (eq (char-before) ?`) 'backquote 'code))
1061 (startpos (point))
1062 ;; Stacked states in the context.
1063 (states '(double-quote)))
1064 (while (and state (progn (skip-chars-forward "^'\\\\\"`$()" limit)
1065 (< (point) limit)))
1066 ;; unescape " inside a $( ... ) construct.
1067 (pcase (char-after)
1068 (?\' (pcase state
1069 (`double-quote nil)
1070 (_ (forward-char 1)
1071 ;; FIXME: mark skipped double quotes as punctuation syntax.
1072 (let ((spos (point)))
1073 (skip-chars-forward "^'" limit)
1074 (save-excursion
1075 (let ((epos (point)))
1076 (goto-char spos)
1077 (while (search-forward "\"" epos t)
1078 (put-text-property (point) (1- (point))
1079 'syntax-table '(1)))))))))
1080 (?\\ (forward-char 1))
1081 (?\" (pcase state
1082 (`double-quote (setq state (pop states)))
1083 (_ (push state states) (setq state 'double-quote)))
1084 (if state (put-text-property (point) (1+ (point))
1085 'syntax-table '(1))))
1086 (?\` (pcase state
1087 (`backquote (setq state (pop states)))
1088 (_ (push state states) (setq state 'backquote))))
1089 (?\$ (if (not (eq (char-after (1+ (point))) ?\())
1091 (forward-char 1)
1092 (pcase state
1093 (_ (push state states) (setq state 'code)))))
1094 (?\( (pcase state
1095 (`double-quote nil)
1096 (_ (push state states) (setq state 'code))))
1097 (?\) (pcase state
1098 (`double-quote nil)
1099 (_ (setq state (pop states)))))
1100 (_ (error "Internal error in sh-font-lock-quoted-subshell")))
1101 (forward-char 1))
1102 (when (< startpos (line-beginning-position))
1103 (put-text-property startpos (point) 'syntax-multiline t)
1104 (add-hook 'syntax-propertize-extend-region-functions
1105 'syntax-propertize-multiline nil t))
1109 (defun sh-is-quoted-p (pos)
1110 (and (eq (char-before pos) ?\\)
1111 (not (sh-is-quoted-p (1- pos)))))
1113 (defun sh-font-lock-paren (start)
1114 (unless (nth 8 (syntax-ppss))
1115 (save-excursion
1116 (let ((open nil))
1117 (goto-char start)
1118 ;; Skip through all patterns
1119 (while
1120 (progn
1121 (while
1122 (progn
1123 (forward-comment (- (point-max)))
1124 (when (and (eolp) (sh-is-quoted-p (point)))
1125 (forward-char -1)
1126 t)))
1127 ;; Skip through one pattern
1128 (while
1129 (or (/= 0 (skip-syntax-backward "w_"))
1130 (/= 0 (skip-chars-backward "-$=?[]*@/\\\\"))
1131 (and (sh-is-quoted-p (1- (point)))
1132 (goto-char (- (point) 2)))
1133 (when (memq (char-before) '(?\" ?\' ?\}))
1134 (condition-case nil (progn (backward-sexp 1) t)
1135 (error nil)))))
1136 ;; Patterns can be preceded by an open-paren (bug#1320).
1137 (when (eq (char-before (point)) ?\()
1138 (backward-char 1)
1139 (setq open (point)))
1140 (while (progn
1141 (forward-comment (- (point-max)))
1142 ;; Maybe we've bumped into an escaped newline.
1143 (sh-is-quoted-p (point)))
1144 (backward-char 1))
1145 (when (eq (char-before) ?|)
1146 (backward-char 1) t)))
1147 (and (> (point) (1+ (point-min)))
1148 (progn (backward-char 2)
1149 (if (> start (line-end-position))
1150 (put-text-property (point) (1+ start)
1151 'syntax-multiline t))
1152 ;; FIXME: The `in' may just be a random argument to
1153 ;; a normal command rather than the real `in' keyword.
1154 ;; I.e. we should look back to try and find the
1155 ;; corresponding `case'.
1156 (and (looking-at ";[;&]\\|\\_<in")
1157 ;; ";; esac )" is a case that looks
1158 ;; like a case-pattern but it's really just a close
1159 ;; paren after a case statement. I.e. if we skipped
1160 ;; over `esac' just now, we're not looking
1161 ;; at a case-pattern.
1162 (not (looking-at "..[ \t\n]+esac[^[:word:]_]"))))
1163 (progn
1164 (when open
1165 (put-text-property open (1+ open) 'syntax-table sh-st-punc))
1166 sh-st-punc))))))
1168 (defun sh-font-lock-backslash-quote ()
1169 (if (eq (save-excursion (nth 3 (syntax-ppss (match-beginning 0)))) ?\')
1170 ;; In a '...' the backslash is not escaping.
1171 sh-st-punc
1172 nil))
1174 (defun sh-syntax-propertize-function (start end)
1175 (goto-char start)
1176 (sh-syntax-propertize-here-doc end)
1177 (funcall
1178 (syntax-propertize-rules
1179 (sh-here-doc-open-re
1180 (2 (sh-font-lock-open-heredoc
1181 (match-beginning 0) (match-string 1) (match-beginning 2))))
1182 ("\\s|" (0 (prog1 nil (sh-syntax-propertize-here-doc end))))
1183 ;; A `#' begins a comment when it is unquoted and at the
1184 ;; beginning of a word. In the shell, words are separated by
1185 ;; metacharacters. The list of special chars is taken from
1186 ;; the single-unix spec of the shell command language (under
1187 ;; `quoting') but with `$' removed.
1188 ("\\(?:[^|&;<>()`\\\"' \t\n]\\|\\${\\)\\(#+\\)" (1 "_"))
1189 ;; In a '...' the backslash is not escaping.
1190 ("\\(\\\\\\)'" (1 (sh-font-lock-backslash-quote)))
1191 ;; Make sure $@ and $? are correctly recognized as sexps.
1192 ("\\$\\([?@]\\)" (1 "_"))
1193 ;; Distinguish the special close-paren in `case'.
1194 (")" (0 (sh-font-lock-paren (match-beginning 0))))
1195 ;; Highlight (possibly nested) subshells inside "" quoted
1196 ;; regions correctly.
1197 ("\"\\(?:\\(?:[^\\\"]\\|\\\\.\\)*?\\)??\\(\\$(\\|`\\)"
1198 (1 (ignore
1199 (if (nth 8 (save-excursion (syntax-ppss (match-beginning 0))))
1200 (goto-char (1+ (match-beginning 0)))
1201 ;; Save excursion because we want to also apply other
1202 ;; syntax-propertize rules within the affected region.
1203 (save-excursion
1204 (sh-font-lock-quoted-subshell end)))))))
1205 (point) end))
1206 (defun sh-font-lock-syntactic-face-function (state)
1207 (let ((q (nth 3 state)))
1208 (if q
1209 (if (characterp q)
1210 (if (eq q ?\`) 'sh-quoted-exec font-lock-string-face)
1211 'sh-heredoc)
1212 font-lock-comment-face)))
1214 (defgroup sh-indentation nil
1215 "Variables controlling indentation in shell scripts.
1217 Note: customizing these variables will not affect existing buffers if
1218 `sh-make-vars-local' is non-nil. See the documentation for
1219 variable `sh-make-vars-local', command `sh-make-vars-local'
1220 and command `sh-reset-indent-vars-to-global-values'."
1221 :group 'sh-script)
1224 (defcustom sh-set-shell-hook nil
1225 "Hook run by `sh-set-shell'."
1226 :type 'hook
1227 :group 'sh-script)
1229 (defcustom sh-mode-hook '(sh-electric-here-document-mode)
1230 "Hook run by `sh-mode'."
1231 :type 'hook
1232 :options '(sh-electric-here-document-mode)
1233 :group 'sh-script)
1235 (defcustom sh-learn-basic-offset nil
1236 "When `sh-guess-basic-offset' should learn `sh-basic-offset'.
1238 nil mean: never.
1239 t means: only if there seems to be an obvious value.
1240 Anything else means: whenever we have a \"good guess\" as to the value."
1241 :type '(choice
1242 (const :tag "Never" nil)
1243 (const :tag "Only if sure" t)
1244 (const :tag "If have a good guess" usually))
1245 :group 'sh-indentation)
1247 (defcustom sh-popup-occur-buffer nil
1248 "Controls when `sh-learn-buffer-indent' pops the `*indent*' buffer.
1249 If t it is always shown. If nil, it is shown only when there
1250 are conflicts."
1251 :type '(choice
1252 (const :tag "Only when there are conflicts." nil)
1253 (const :tag "Always" t))
1254 :group 'sh-indentation)
1256 (defcustom sh-blink t
1257 "If non-nil, `sh-show-indent' shows the line indentation is relative to.
1258 The position on the line is not necessarily meaningful.
1259 In some cases the line will be the matching keyword, but this is not
1260 always the case."
1261 :type 'boolean
1262 :group 'sh-indentation)
1264 (defcustom sh-first-lines-indent 0
1265 "The indentation of the first non-blank non-comment line.
1266 Usually 0 meaning first column.
1267 Can be set to a number, or to nil which means leave it as is."
1268 :type '(choice
1269 (const :tag "Leave as is" nil)
1270 (integer :tag "Column number"
1271 :menu-tag "Indent to this col (0 means first col)" ))
1272 :group 'sh-indentation)
1275 (defcustom sh-basic-offset 4
1276 "The default indentation increment.
1277 This value is used for the `+' and `-' symbols in an indentation variable."
1278 :type 'integer
1279 :group 'sh-indentation)
1280 (put 'sh-basic-offset 'safe-local-variable 'integerp)
1282 (defcustom sh-indent-comment t
1283 "How a comment line is to be indented.
1284 nil means leave it as it is;
1285 t means indent it as a normal line, aligning it to previous non-blank
1286 non-comment line;
1287 a number means align to that column, e.g. 0 means first column."
1288 :type '(choice
1289 (const :tag "Leave as is." nil)
1290 (const :tag "Indent as a normal line." t)
1291 (integer :menu-tag "Indent to this col (0 means first col)."
1292 :tag "Indent to column number.") )
1293 :version "24.3"
1294 :group 'sh-indentation)
1297 (defvar sh-debug nil
1298 "Enable lots of debug messages - if function `sh-debug' is enabled.")
1301 ;; Uncomment this defun and comment the defmacro for debugging.
1302 ;; (defun sh-debug (&rest args)
1303 ;; "For debugging: display message ARGS if variable SH-DEBUG is non-nil."
1304 ;; (if sh-debug
1305 ;; (apply 'message args)))
1306 (defmacro sh-debug (&rest _args))
1308 (defconst sh-symbol-list
1309 '((const :tag "+ " :value +
1310 :menu-tag "+ Indent right by sh-basic-offset")
1311 (const :tag "- " :value -
1312 :menu-tag "- Indent left by sh-basic-offset")
1313 (const :tag "++" :value ++
1314 :menu-tag "++ Indent right twice sh-basic-offset")
1315 (const :tag "--" :value --
1316 :menu-tag "-- Indent left twice sh-basic-offset")
1317 (const :tag "* " :value *
1318 :menu-tag "* Indent right half sh-basic-offset")
1319 (const :tag "/ " :value /
1320 :menu-tag "/ Indent left half sh-basic-offset")))
1322 (defcustom sh-indent-for-else 0
1323 "How much to indent an `else' relative to its `if'. Usually 0."
1324 :type `(choice
1325 (integer :menu-tag "A number (positive=>indent right)"
1326 :tag "A number")
1327 (const :tag "--") ;; separator!
1328 ,@ sh-symbol-list
1330 :group 'sh-indentation)
1332 (defconst sh-number-or-symbol-list
1333 (append '((integer :menu-tag "A number (positive=>indent right)"
1334 :tag "A number")
1335 (const :tag "--")) ; separator
1336 sh-symbol-list))
1338 (defcustom sh-indent-for-fi 0
1339 "How much to indent a `fi' relative to its `if'. Usually 0."
1340 :type `(choice ,@ sh-number-or-symbol-list )
1341 :group 'sh-indentation)
1343 (defcustom sh-indent-for-done 0
1344 "How much to indent a `done' relative to its matching stmt. Usually 0."
1345 :type `(choice ,@ sh-number-or-symbol-list )
1346 :group 'sh-indentation)
1348 (defcustom sh-indent-after-else '+
1349 "How much to indent a statement after an `else' statement."
1350 :type `(choice ,@ sh-number-or-symbol-list )
1351 :group 'sh-indentation)
1353 (defcustom sh-indent-after-if '+
1354 "How much to indent a statement after an `if' statement.
1355 This includes lines after `else' and `elif' statements, too, but
1356 does not affect the `else', `elif' or `fi' statements themselves."
1357 :type `(choice ,@ sh-number-or-symbol-list )
1358 :group 'sh-indentation)
1360 (defcustom sh-indent-for-then 0
1361 "How much to indent a `then' relative to its `if'."
1362 :type `(choice ,@ sh-number-or-symbol-list )
1363 :group 'sh-indentation)
1365 (defcustom sh-indent-for-do 0
1366 "How much to indent a `do' statement.
1367 This is relative to the statement before the `do', typically a
1368 `while', `until', `for', `repeat' or `select' statement."
1369 :type `(choice ,@ sh-number-or-symbol-list)
1370 :group 'sh-indentation)
1372 (defcustom sh-indent-after-do '+
1373 "How much to indent a line after a `do' statement.
1374 This is used when the `do' is the first word of the line.
1375 This is relative to the statement before the `do', typically a
1376 `while', `until', `for', `repeat' or `select' statement."
1377 :type `(choice ,@ sh-number-or-symbol-list)
1378 :group 'sh-indentation)
1380 (defcustom sh-indent-after-loop-construct '+
1381 "How much to indent a statement after a loop construct.
1383 This variable is used when the keyword `do' is on the same line as the
1384 loop statement (e.g., `until', `while' or `for').
1385 If the `do' is on a line by itself, then `sh-indent-after-do' is used instead."
1386 :type `(choice ,@ sh-number-or-symbol-list)
1387 :group 'sh-indentation)
1390 (defcustom sh-indent-after-done 0
1391 "How much to indent a statement after a `done' keyword.
1392 Normally this is 0, which aligns the `done' to the matching
1393 looping construct line.
1394 Setting it non-zero allows you to have the `do' statement on a line
1395 by itself and align the done under to do."
1396 :type `(choice ,@ sh-number-or-symbol-list)
1397 :group 'sh-indentation)
1399 (defcustom sh-indent-for-case-label '+
1400 "How much to indent a case label statement.
1401 This is relative to the line containing the `case' statement."
1402 :type `(choice ,@ sh-number-or-symbol-list)
1403 :group 'sh-indentation)
1405 (defcustom sh-indent-for-case-alt '++
1406 "How much to indent statements after the case label.
1407 This is relative to the line containing the `case' statement."
1408 :type `(choice ,@ sh-number-or-symbol-list)
1409 :group 'sh-indentation)
1412 (defcustom sh-indent-for-continuation '+
1413 "How much to indent for a continuation statement."
1414 :type `(choice ,@ sh-number-or-symbol-list)
1415 :group 'sh-indentation)
1417 (defcustom sh-indent-after-open '+
1418 "How much to indent after a line with an opening parenthesis or brace.
1419 For an open paren after a function, `sh-indent-after-function' is used."
1420 :type `(choice ,@ sh-number-or-symbol-list)
1421 :group 'sh-indentation)
1423 (defcustom sh-indent-after-function '+
1424 "How much to indent after a function line."
1425 :type `(choice ,@ sh-number-or-symbol-list)
1426 :group 'sh-indentation)
1428 ;; These 2 are for the rc shell:
1430 (defcustom sh-indent-after-switch '+
1431 "How much to indent a `case' statement relative to the `switch' statement.
1432 This is for the rc shell."
1433 :type `(choice ,@ sh-number-or-symbol-list)
1434 :group 'sh-indentation)
1436 (defcustom sh-indent-after-case '+
1437 "How much to indent a statement relative to the `case' statement.
1438 This is for the rc shell."
1439 :type `(choice ,@ sh-number-or-symbol-list)
1440 :group 'sh-indentation)
1442 (defcustom sh-backslash-column 48
1443 "Column in which `sh-backslash-region' inserts backslashes."
1444 :type 'integer
1445 :group 'sh)
1447 (defcustom sh-backslash-align t
1448 "If non-nil, `sh-backslash-region' will align backslashes."
1449 :type 'boolean
1450 :group 'sh)
1452 ;; Internal use - not designed to be changed by the user:
1454 (defun sh-mkword-regexpr (word)
1455 "Make a regexp which matches WORD as a word.
1456 This specifically excludes an occurrence of WORD followed by
1457 punctuation characters like `-'."
1458 (concat word "\\([^-[:alnum:]_]\\|$\\)"))
1460 (defconst sh-re-done (sh-mkword-regexpr "done"))
1463 (defconst sh-kws-for-done
1464 '((sh . ( "while" "until" "for" ) )
1465 (bash . ( "while" "until" "for" "select" ) )
1466 (ksh88 . ( "while" "until" "for" "select" ) )
1467 (zsh . ( "while" "until" "for" "repeat" "select" ) ) )
1468 "Which keywords can match the word `done' in this shell.")
1471 (defconst sh-indent-supported
1472 '((sh . sh)
1473 (csh . nil)
1474 (rc . rc))
1475 "Indentation rule set to use for each shell type.")
1477 (defvar sh-indent-supported-here nil
1478 "Non-nil if we support indentation for the current buffer's shell type.")
1480 (defconst sh-var-list
1482 sh-basic-offset sh-first-lines-indent sh-indent-after-case
1483 sh-indent-after-do sh-indent-after-done
1484 sh-indent-after-else
1485 sh-indent-after-if
1486 sh-indent-after-loop-construct
1487 sh-indent-after-open
1488 sh-indent-comment
1489 sh-indent-for-case-alt
1490 sh-indent-for-case-label
1491 sh-indent-for-continuation
1492 sh-indent-for-do
1493 sh-indent-for-done
1494 sh-indent-for-else
1495 sh-indent-for-fi
1496 sh-indent-for-then
1498 "A list of variables used by script mode to control indentation.
1499 This list is used when switching between buffer-local and global
1500 values of variables, and for the commands using indentation styles.")
1502 (defvar sh-make-vars-local t
1503 "Controls whether indentation variables are local to the buffer.
1504 If non-nil, indentation variables are made local initially.
1505 If nil, you can later make the variables local by invoking
1506 command `sh-make-vars-local'.
1507 The default is t because I assume that in one Emacs session one is
1508 frequently editing existing scripts with different styles.")
1511 ;; inferior shell interaction
1512 ;; TODO: support multiple interactive shells
1513 (defvar-local sh-shell-process nil
1514 "The inferior shell process for interaction.")
1516 (defvar explicit-shell-file-name)
1518 (defun sh-shell-process (force)
1519 "Get a shell process for interaction.
1520 If FORCE is non-nil and no process found, create one."
1521 (if (process-live-p sh-shell-process)
1522 sh-shell-process
1523 (setq sh-shell-process
1524 (let ((found nil) proc
1525 (procs (process-list)))
1526 (while (and (not found) procs
1527 (process-live-p (setq proc (pop procs)))
1528 (process-command proc))
1529 (when (string-equal sh-shell (file-name-nondirectory
1530 (car (process-command proc))))
1531 (setq found proc)))
1532 (or found
1533 (and force
1534 (get-buffer-process
1535 (let ((explicit-shell-file-name sh-shell-file))
1536 (shell)))))))))
1538 (defun sh-show-shell ()
1539 "Pop the shell interaction buffer."
1540 (interactive)
1541 (pop-to-buffer (process-buffer (sh-shell-process t))))
1543 (defun sh-send-text (text)
1544 "Send the text to the `sh-shell-process'."
1545 (comint-send-string (sh-shell-process t) (concat text "\n")))
1547 (defun sh-cd-here ()
1548 "Change directory in the current interaction shell to the current one."
1549 (interactive)
1550 (sh-send-text (concat "cd " default-directory)))
1552 (defun sh-send-line-or-region-and-step ()
1553 "Send the current line to the inferior shell and step to the next line.
1554 When the region is active, send the region instead."
1555 (interactive)
1556 (let (from to end)
1557 (if (use-region-p)
1558 (setq from (region-beginning)
1559 to (region-end)
1560 end to)
1561 (setq from (line-beginning-position)
1562 to (line-end-position)
1563 end (1+ to)))
1564 (sh-send-text (buffer-substring-no-properties from to))
1565 (goto-char end)))
1568 ;; mode-command and utility functions
1570 (defun sh-after-hack-local-variables ()
1571 (when (assq 'sh-shell file-local-variables-alist)
1572 (sh-set-shell (if (symbolp sh-shell)
1573 (symbol-name sh-shell)
1574 sh-shell))))
1576 ;;;###autoload
1577 (define-derived-mode sh-mode prog-mode "Shell-script"
1578 "Major mode for editing shell scripts.
1579 This mode works for many shells, since they all have roughly the same syntax,
1580 as far as commands, arguments, variables, pipes, comments etc. are concerned.
1581 Unless the file's magic number indicates the shell, your usual shell is
1582 assumed. Since filenames rarely give a clue, they are not further analyzed.
1584 This mode adapts to the variations between shells (see `sh-set-shell') by
1585 means of an inheritance based feature lookup (see `sh-feature'). This
1586 mechanism applies to all variables (including skeletons) that pertain to
1587 shell-specific features. Shell script files can use the `sh-shell' local
1588 variable to indicate the shell variant to be used for the file.
1590 The default style of this mode is that of Rosenblatt's Korn shell book.
1591 The syntax of the statements varies with the shell being used. The
1592 following commands are available, based on the current shell's syntax:
1593 \\<sh-mode-map>
1594 \\[sh-case] case statement
1595 \\[sh-for] for loop
1596 \\[sh-function] function definition
1597 \\[sh-if] if statement
1598 \\[sh-indexed-loop] indexed loop from 1 to n
1599 \\[sh-while-getopts] while getopts loop
1600 \\[sh-repeat] repeat loop
1601 \\[sh-select] select loop
1602 \\[sh-until] until loop
1603 \\[sh-while] while loop
1605 For sh and rc shells indentation commands are:
1606 \\[sh-show-indent] Show the variable controlling this line's indentation.
1607 \\[sh-set-indent] Set then variable controlling this line's indentation.
1608 \\[sh-learn-line-indent] Change the indentation variable so this line
1609 would indent to the way it currently is.
1610 \\[sh-learn-buffer-indent] Set the indentation variables so the
1611 buffer indents as it currently is indented.
1614 \\[backward-delete-char-untabify] Delete backward one position, even if it was a tab.
1615 \\[sh-end-of-command] Go to end of successive commands.
1616 \\[sh-beginning-of-command] Go to beginning of successive commands.
1617 \\[sh-set-shell] Set this buffer's shell, and maybe its magic number.
1618 \\[sh-execute-region] Have optional header and region be executed in a subshell.
1620 `sh-electric-here-document-mode' controls whether insertion of two
1621 unquoted < insert a here document. You can control this behavior by
1622 modifying `sh-mode-hook'.
1624 If you generally program a shell different from your login shell you can
1625 set `sh-shell-file' accordingly. If your shell's file name doesn't correctly
1626 indicate what shell it is use `sh-alias-alist' to translate.
1628 If your shell gives error messages with line numbers, you can use \\[executable-interpret]
1629 with your script for an edit-interpret-debug cycle."
1630 (make-local-variable 'sh-shell-file)
1631 (make-local-variable 'sh-shell)
1633 (setq-local skeleton-pair-default-alist
1634 sh-skeleton-pair-default-alist)
1636 (setq-local paragraph-start (concat page-delimiter "\\|$"))
1637 (setq-local paragraph-separate (concat paragraph-start "\\|#!/"))
1638 (setq-local comment-start "# ")
1639 (setq-local comment-start-skip "#+[\t ]*")
1640 (setq-local local-abbrev-table sh-mode-abbrev-table)
1641 (setq-local comint-dynamic-complete-functions
1642 sh-dynamic-complete-functions)
1643 (add-hook 'completion-at-point-functions 'comint-completion-at-point nil t)
1644 ;; we can't look if previous line ended with `\'
1645 (setq-local comint-prompt-regexp "^[ \t]*")
1646 (setq-local imenu-case-fold-search nil)
1647 (setq font-lock-defaults
1648 `((sh-font-lock-keywords
1649 sh-font-lock-keywords-1 sh-font-lock-keywords-2)
1650 nil nil
1651 ((?/ . "w") (?~ . "w") (?. . "w") (?- . "w") (?_ . "w")) nil
1652 (font-lock-syntactic-face-function
1653 . sh-font-lock-syntactic-face-function)))
1654 (setq-local syntax-propertize-function #'sh-syntax-propertize-function)
1655 (add-hook 'syntax-propertize-extend-region-functions
1656 #'syntax-propertize-multiline 'append 'local)
1657 (setq-local skeleton-pair-alist '((?` _ ?`)))
1658 (setq-local skeleton-pair-filter-function 'sh-quoted-p)
1659 (setq-local skeleton-further-elements
1660 '((< '(- (min sh-indentation (current-column))))))
1661 (setq-local skeleton-filter-function 'sh-feature)
1662 (setq-local skeleton-newline-indent-rigidly t)
1663 (setq-local defun-prompt-regexp
1664 (concat
1665 "^\\("
1666 "\\(function[ \t]\\)?[ \t]*[[:alnum:]]+[ \t]*([ \t]*)"
1667 "\\|"
1668 "function[ \t]+[[:alnum:]]+[ \t]*\\(([ \t]*)\\)?"
1669 "\\)[ \t]*"))
1670 (setq-local add-log-current-defun-function #'sh-current-defun-name)
1671 (add-hook 'completion-at-point-functions
1672 #'sh-completion-at-point-function nil t)
1673 ;; Parse or insert magic number for exec, and set all variables depending
1674 ;; on the shell thus determined.
1675 (sh-set-shell
1676 (cond ((save-excursion
1677 (goto-char (point-min))
1678 (looking-at "#![ \t]?\\([^ \t\n]*/bin/env[ \t]\\)?\\([^ \t\n]+\\)"))
1679 (match-string 2))
1680 ((not buffer-file-name) sh-shell-file)
1681 ;; Checks that use `buffer-file-name' follow.
1682 ((string-match "\\.m?spec\\'" buffer-file-name) "rpm")
1683 ((string-match "[.]sh\\>" buffer-file-name) "sh")
1684 ((string-match "[.]bash\\>" buffer-file-name) "bash")
1685 ((string-match "[.]ksh\\>" buffer-file-name) "ksh")
1686 ((string-match "[.]t?csh\\(rc\\)?\\>" buffer-file-name) "csh")
1687 ((string-match "[.]zsh\\(rc\\|env\\)?\\>" buffer-file-name) "zsh")
1688 ((equal (file-name-nondirectory buffer-file-name) ".profile") "sh")
1689 (t sh-shell-file))
1690 nil nil)
1691 (add-hook 'hack-local-variables-hook
1692 #'sh-after-hack-local-variables nil t))
1694 ;;;###autoload
1695 (defalias 'shell-script-mode 'sh-mode)
1698 (defun sh-font-lock-keywords (&optional keywords)
1699 "Function to get simple fontification based on `sh-font-lock-keywords'.
1700 This adds rules for comments and assignments."
1701 (sh-feature sh-font-lock-keywords-var
1702 (when (stringp (sh-feature sh-assignment-regexp))
1703 (lambda (list)
1704 `((,(sh-feature sh-assignment-regexp)
1705 1 font-lock-variable-name-face)
1706 ,@keywords
1707 ,@list
1708 ,@executable-font-lock-keywords)))))
1710 (defun sh-font-lock-keywords-1 (&optional builtins)
1711 "Function to get better fontification including keywords."
1712 (let ((keywords (concat "\\([;(){}`|&]\\|^\\)[ \t]*\\(\\("
1713 (regexp-opt (sh-feature sh-leading-keywords) t)
1714 "[ \t]+\\)?"
1715 (regexp-opt (append (sh-feature sh-leading-keywords)
1716 (sh-feature sh-other-keywords))
1717 t))))
1718 (sh-font-lock-keywords
1719 `(,@(if builtins
1720 `((,(concat keywords "[ \t]+\\)?"
1721 (regexp-opt (sh-feature sh-builtins) t)
1722 "\\>")
1723 (2 font-lock-keyword-face nil t)
1724 (6 font-lock-builtin-face))
1725 ,@(sh-feature sh-font-lock-keywords-var-2)))
1726 (,(concat keywords "\\)\\>")
1727 2 font-lock-keyword-face)
1728 ,@(sh-feature sh-font-lock-keywords-var-1)))))
1730 (defun sh-font-lock-keywords-2 ()
1731 "Function to get better fontification including keywords and builtins."
1732 (sh-font-lock-keywords-1 t))
1734 ;;; Completion
1736 (defun sh--vars-before-point ()
1737 (save-excursion
1738 (let ((vars ()))
1739 (while (re-search-backward "^[ \t]*\\([[:alnum:]_]+\\)=" nil t)
1740 (push (match-string 1) vars))
1741 vars)))
1743 ;; (defun sh--var-completion-table (string pred action)
1744 ;; (complete-with-action action (sh--vars-before-point) string pred))
1746 (defun sh--cmd-completion-table (string pred action)
1747 (let ((cmds
1748 (append (when (fboundp 'imenu--make-index-alist)
1749 (mapcar #'car
1750 (condition-case nil
1751 (imenu--make-index-alist)
1752 (imenu-unavailable nil))))
1753 (mapcar (lambda (v) (concat v "="))
1754 (sh--vars-before-point))
1755 (locate-file-completion-table
1756 exec-path exec-suffixes string pred t)
1757 '("if" "while" "until" "for"))))
1758 (complete-with-action action cmds string pred)))
1760 (defun sh-completion-at-point-function ()
1761 (save-excursion
1762 (skip-chars-forward "[:alnum:]_")
1763 (let ((end (point))
1764 (_ (skip-chars-backward "[:alnum:]_"))
1765 (start (point)))
1766 (cond
1767 ((eq (char-before) ?$)
1768 (list start end (sh--vars-before-point)))
1769 ((sh-smie--keyword-p)
1770 (list start end #'sh--cmd-completion-table))))))
1772 ;;; Indentation and navigation with SMIE.
1774 (require 'smie)
1776 ;; The SMIE code should generally be preferred, but it currently does not obey
1777 ;; the various indentation custom-vars, and it misses some important features
1778 ;; of the old code, mostly: sh-learn-line/buffer-indent, sh-show-indent,
1779 ;; sh-name/save/load-style.
1780 (defvar sh-use-smie t
1781 "Whether to use the SMIE code for navigation and indentation.")
1783 (defun sh-smie--keyword-p ()
1784 "Non-nil if we're at a keyword position.
1785 A keyword position is one where if we're looking at something that looks
1786 like a keyword, then it is a keyword."
1787 (let ((prev (funcall smie-backward-token-function)))
1788 (if (zerop (length prev))
1789 (looking-back "\\`\\|\\s(" (1- (point)))
1790 (assoc prev smie-grammar))))
1792 (defun sh-smie--newline-semi-p (&optional tok)
1793 "Return non-nil if a newline should be treated as a semi-colon.
1794 Here we assume that a newline should be treated as a semi-colon unless it
1795 comes right after a special keyword.
1796 This function does not pay attention to line-continuations.
1797 If TOK is nil, point should be before the newline; otherwise, TOK is the token
1798 before the newline and in that case point should be just before the token."
1799 (save-excursion
1800 (unless tok
1801 (setq tok (funcall smie-backward-token-function)))
1802 (if (and (zerop (length tok))
1803 (looking-back "\\s(" (1- (point))))
1805 (not (numberp (nth 2 (assoc tok smie-grammar)))))))
1807 ;;;; SMIE support for `sh'.
1809 (defconst sh-smie-sh-grammar
1810 (smie-prec2->grammar
1811 (smie-bnf->prec2
1812 '((exp) ;A constant, or a $var, or a sequence of them...
1813 (cmd ("case" exp "in" branches "esac")
1814 ("if" cmd "then" cmd "fi")
1815 ("if" cmd "then" cmd "else" cmd "fi")
1816 ("if" cmd "then" cmd "elif" cmd "then" cmd "fi")
1817 ("if" cmd "then" cmd "elif" cmd "then" cmd "else" cmd "fi")
1818 ("if" cmd "then" cmd "elif" cmd "then" cmd
1819 "elif" cmd "then" cmd "else" cmd "fi")
1820 ("while" cmd "do" cmd "done")
1821 ("until" cmd "do" cmd "done")
1822 ("for" exp "in" cmd "do" cmd "done")
1823 ("for" exp "do" cmd "done")
1824 ("select" exp "in" cmd "do" cmd "done") ;bash&zsh&ksh88.
1825 ("repeat" exp "do" cmd "done") ;zsh.
1826 (exp "always" exp) ;zsh.
1827 (cmd "|" cmd) (cmd "|&" cmd)
1828 (cmd "&&" cmd) (cmd "||" cmd)
1829 (cmd ";" cmd) (cmd "&" cmd))
1830 (rpattern (rpattern "|" rpattern))
1831 (pattern (rpattern) ("case-(" rpattern))
1832 (branches (branches ";;" branches)
1833 (branches ";&" branches) (branches ";;&" branches) ;bash.
1834 (pattern "case-)" cmd)))
1835 '((assoc ";;" ";&" ";;&"))
1836 '((assoc ";" "&") (assoc "&&" "||") (assoc "|" "|&")))))
1838 (defconst sh-smie--sh-operators
1839 (delq nil (mapcar (lambda (x)
1840 (setq x (car x))
1841 (and (stringp x)
1842 (not (string-match "\\`[a-z]" x))
1844 sh-smie-sh-grammar)))
1846 (defconst sh-smie--sh-operators-re (regexp-opt sh-smie--sh-operators))
1847 (defconst sh-smie--sh-operators-back-re
1848 (concat "\\(?:^\\|[^\\]\\)\\(?:\\\\\\\\\\)*"
1849 "\\(" sh-smie--sh-operators-re "\\)"))
1851 (defun sh-smie--sh-keyword-in-p ()
1852 "Assuming we're looking at \"in\", return non-nil if it's a keyword.
1853 Does not preserve point."
1854 (let ((forward-sexp-function nil)
1855 (words nil) ;We've seen words.
1856 (newline nil) ;We've seen newlines after the words.
1857 (res nil)
1858 prev)
1859 (while (not res)
1860 (setq prev (funcall smie-backward-token-function))
1861 (cond
1862 ((zerop (length prev))
1863 (cond
1864 (newline (cl-assert words) (setq res 'word))
1865 ((bobp) (setq res 'word))
1867 (setq words t)
1868 (condition-case nil
1869 (forward-sexp -1)
1870 (scan-error (setq res 'unknown))))))
1871 ((equal prev ";")
1872 (if words (setq newline t)
1873 (setq res 'keyword)))
1874 ((member prev '("case" "for" "select")) (setq res 'keyword))
1875 ((assoc prev smie-grammar) (setq res 'word))
1877 (if newline
1878 (progn (cl-assert words) (setq res 'word))
1879 (setq words t)))))
1880 (eq res 'keyword)))
1882 (defun sh-smie--sh-keyword-p (tok)
1883 "Non-nil if TOK (at which we're looking) really is a keyword."
1884 (cond
1885 ((looking-at "[[:alnum:]_]+=") nil)
1886 ((equal tok "in") (sh-smie--sh-keyword-in-p))
1887 (t (sh-smie--keyword-p))))
1889 (defun sh-smie--default-forward-token ()
1890 (forward-comment (point-max))
1891 (buffer-substring-no-properties
1892 (point)
1893 (progn (if (zerop (skip-syntax-forward "."))
1894 (while (progn (skip-syntax-forward "w_'")
1895 (looking-at "\\\\"))
1896 (forward-char 2)))
1897 (point))))
1899 (defun sh-smie--default-backward-token ()
1900 (forward-comment (- (point)))
1901 (let ((pos (point))
1902 (n (skip-syntax-backward ".")))
1903 (if (or (zerop n)
1904 (and (eq n -1)
1905 (let ((p (point)))
1906 (if (eq -1 (% (skip-syntax-backward "\\") 2))
1908 (goto-char p)
1909 nil))))
1910 (while
1911 (progn (skip-syntax-backward "w_'")
1912 (or (not (zerop (skip-syntax-backward "\\")))
1913 (when (eq ?\\ (char-before (1- (point))))
1914 (let ((p (point)))
1915 (forward-char -1)
1916 (if (eq -1 (% (skip-syntax-backward "\\") 2))
1918 (goto-char p)
1919 nil))))))
1920 (goto-char (- (point) (% (skip-syntax-backward "\\") 2))))
1921 (buffer-substring-no-properties (point) pos)))
1923 (defun sh-smie-sh-forward-token ()
1924 (if (and (looking-at "[ \t]*\\(?:#\\|\\(\\s|\\)\\|$\\)")
1925 (save-excursion
1926 (skip-chars-backward " \t")
1927 (not (bolp))))
1928 (if (and (match-end 1) (not (nth 3 (syntax-ppss))))
1929 ;; Right before a here-doc.
1930 (let ((forward-sexp-function nil))
1931 (forward-sexp 1)
1932 ;; Pretend the here-document is a "newline representing a
1933 ;; semi-colon", since the here-doc otherwise covers the newline(s).
1934 ";")
1935 (unless (eobp)
1936 (let ((semi (sh-smie--newline-semi-p)))
1937 (forward-line 1)
1938 (if (or semi (eobp)) ";"
1939 (sh-smie-sh-forward-token)))))
1940 (forward-comment (point-max))
1941 (cond
1942 ((looking-at "\\\\\n") (forward-line 1) (sh-smie-sh-forward-token))
1943 ((looking-at sh-smie--sh-operators-re)
1944 (goto-char (match-end 0))
1945 (let ((tok (match-string-no-properties 0)))
1946 (if (and (memq (aref tok (1- (length tok))) '(?\; ?\& ?\|))
1947 (looking-at "[ \t]*\\(?:#\\|$\\)"))
1948 (forward-line 1))
1949 tok))
1951 (let* ((pos (point))
1952 (tok (sh-smie--default-forward-token)))
1953 (cond
1954 ((equal tok ")") "case-)")
1955 ((equal tok "(") "case-(")
1956 ((and tok (string-match "\\`[a-z]" tok)
1957 (assoc tok smie-grammar)
1958 (not
1959 (save-excursion
1960 (goto-char pos)
1961 (sh-smie--sh-keyword-p tok))))
1962 " word ")
1963 (t tok)))))))
1965 (defun sh-smie--looking-back-at-continuation-p ()
1966 (save-excursion
1967 (and (if (eq (char-before) ?\n) (progn (forward-char -1) t) (eolp))
1968 (looking-back "\\(?:^\\|[^\\]\\)\\(?:\\\\\\\\\\)*\\\\"
1969 (line-beginning-position)))))
1971 (defun sh-smie-sh-backward-token ()
1972 (let ((bol (line-beginning-position)))
1973 (forward-comment (- (point)))
1974 (cond
1975 ((and (bolp) (not (bobp))
1976 (equal (syntax-after (1- (point))) (string-to-syntax "|"))
1977 (not (nth 3 (syntax-ppss))))
1978 ;; Right after a here-document.
1979 (let ((forward-sexp-function nil))
1980 (forward-sexp -1)
1981 ;; Pretend the here-document is a "newline representing a
1982 ;; semi-colon", since the here-doc otherwise covers the newline(s).
1983 ";"))
1984 ((< (point) bol)
1985 (cond
1986 ((sh-smie--looking-back-at-continuation-p)
1987 (forward-char -1)
1988 (funcall smie-backward-token-function))
1989 ((sh-smie--newline-semi-p) ";")
1990 (t (funcall smie-backward-token-function))))
1991 ((looking-back sh-smie--sh-operators-back-re
1992 (line-beginning-position) 'greedy)
1993 (goto-char (match-beginning 1))
1994 (match-string-no-properties 1))
1996 (let ((tok (sh-smie--default-backward-token)))
1997 (cond
1998 ((equal tok ")") "case-)")
1999 ((equal tok "(") "case-(")
2000 ((and tok (string-match "\\`[a-z]" tok)
2001 (assoc tok smie-grammar)
2002 (not (save-excursion (sh-smie--sh-keyword-p tok))))
2003 " word ")
2004 (t tok)))))))
2006 (defcustom sh-indent-after-continuation t
2007 "If non-nil, indent relative to the continued line's beginning.
2008 Continued lines can either be indented as \"one long wrapped line\" without
2009 paying attention to the actual syntactic structure, as in:
2011 for f \\
2012 in a; do \\
2013 toto; \\
2014 done
2016 or as lines that just don't have implicit semi-colons between them, as in:
2018 for f \\
2019 in a; do \\
2020 toto; \\
2021 done
2023 With `always' you get the former behavior whereas with nil you get the latter.
2024 With t, you get the latter as long as that would indent the continuation line
2025 deeper than the initial line."
2026 :version "25.1"
2027 :type '(choice
2028 (const nil :tag "Never")
2029 (const t :tag "Only if needed to make it deeper")
2030 (const always :tag "Always"))
2031 :group 'sh-indentation)
2033 (defun sh-smie--continuation-start-indent ()
2034 "Return the initial indentation of a continued line.
2035 May return nil if the line should not be treated as continued."
2036 (save-excursion
2037 (forward-line -1)
2038 (unless (sh-smie--looking-back-at-continuation-p)
2039 (current-indentation))))
2041 (defun sh-smie--indent-continuation ()
2042 (cond
2043 ((not (and sh-indent-after-continuation
2044 (save-excursion
2045 (ignore-errors
2046 (skip-chars-backward " \t")
2047 (sh-smie--looking-back-at-continuation-p)))))
2048 nil)
2049 ((eq sh-indent-after-continuation 'always)
2050 (save-excursion
2051 (forward-line -1)
2052 (if (sh-smie--looking-back-at-continuation-p)
2053 (current-indentation)
2054 (+ (current-indentation) sh-indentation))))
2056 ;; Just make sure a line-continuation is indented deeper.
2057 (save-excursion
2058 (let ((indent (let ((sh-indent-after-continuation nil))
2059 (smie-indent-calculate)))
2060 (max most-positive-fixnum))
2061 (if (not (numberp indent)) indent
2062 (while (progn
2063 (forward-line -1)
2064 (let ((ci (current-indentation)))
2065 (cond
2066 ;; Previous line is less indented, we're good.
2067 ((< ci indent) nil)
2068 ((sh-smie--looking-back-at-continuation-p)
2069 (setq max (min max ci))
2070 ;; Previous line is itself a continuation.
2071 ;; If it's indented like us, we're good, otherwise
2072 ;; check the line before that one.
2073 (> ci indent))
2074 (t ;Previous line is the beginning of the continued line.
2075 (setq indent (min (+ ci sh-indentation) max))
2076 nil)))))
2077 indent))))))
2079 (defun sh-smie-sh-rules (kind token)
2080 (pcase (cons kind token)
2081 (`(:elem . basic) sh-indentation)
2082 (`(:after . "case-)") (- (sh-var-value 'sh-indent-for-case-alt)
2083 (sh-var-value 'sh-indent-for-case-label)))
2084 (`(:before . ,(or `"(" `"{" `"[" "while" "if" "for" "case"))
2085 (if (not (smie-rule-prev-p "&&" "||" "|"))
2086 (when (smie-rule-hanging-p)
2087 (smie-rule-parent))
2088 (unless (smie-rule-bolp)
2089 (while (equal "|" (nth 2 (smie-backward-sexp 'halfexp))))
2090 `(column . ,(smie-indent-virtual)))))
2091 ;; FIXME: Maybe this handling of ;; should be made into
2092 ;; a smie-rule-terminator function that takes the substitute ";" as arg.
2093 (`(:before . ,(or `";;" `";&" `";;&"))
2094 (if (and (smie-rule-bolp) (looking-at ";;?&?[ \t]*\\(#\\|$\\)"))
2095 (cons 'column (smie-indent-keyword ";"))
2096 (smie-rule-separator kind)))
2097 (`(:after . ,(or `";;" `";&" `";;&"))
2098 (with-demoted-errors
2099 (smie-backward-sexp token)
2100 (cons 'column
2101 (if (or (smie-rule-bolp)
2102 (save-excursion
2103 (and (member (funcall smie-backward-token-function)
2104 '("in" ";;"))
2105 (smie-rule-bolp))))
2106 (current-column)
2107 (smie-indent-calculate)))))
2108 (`(:before . ,(or `"|" `"&&" `"||"))
2109 (unless (smie-rule-parent-p token)
2110 (smie-backward-sexp token)
2111 `(column . ,(+ (funcall smie-rules-function :elem 'basic)
2112 (smie-indent-virtual)))))
2114 ;; Attempt at backward compatibility with the old config variables.
2115 (`(:before . "fi") (sh-var-value 'sh-indent-for-fi))
2116 (`(:before . "done") (sh-var-value 'sh-indent-for-done))
2117 (`(:after . "else") (sh-var-value 'sh-indent-after-else))
2118 (`(:after . "if") (sh-var-value 'sh-indent-after-if))
2119 (`(:before . "then") (sh-var-value 'sh-indent-for-then))
2120 (`(:before . "do") (sh-var-value 'sh-indent-for-do))
2121 (`(:after . "do")
2122 (sh-var-value (if (smie-rule-hanging-p)
2123 'sh-indent-after-loop-construct 'sh-indent-after-do)))
2124 ;; sh-indent-after-done: aligned completely differently.
2125 (`(:after . "in") (sh-var-value 'sh-indent-for-case-label))
2126 ;; sh-indent-for-continuation: Line continuations are handled differently.
2127 (`(:after . ,(or `"(" `"{" `"["))
2128 (if (not (looking-at ".[ \t]*[^\n \t#]"))
2129 (sh-var-value 'sh-indent-after-open)
2130 (goto-char (1- (match-end 0)))
2131 `(column . ,(current-column))))
2132 ;; sh-indent-after-function: we don't handle it differently.
2135 ;; (defconst sh-smie-csh-grammar
2136 ;; (smie-prec2->grammar
2137 ;; (smie-bnf->prec2
2138 ;; '((exp) ;A constant, or a $var, or a sequence of them...
2139 ;; (elseifcmd (cmd)
2140 ;; (cmd "else" "else-if" exp "then" elseifcmd))
2141 ;; (cmd ("switch" branches "endsw")
2142 ;; ("if" exp)
2143 ;; ("if" exp "then" cmd "endif")
2144 ;; ("if" exp "then" cmd "else" cmd "endif")
2145 ;; ("if" exp "then" elseifcmd "endif")
2146 ;; ;; ("if" exp "then" cmd "else" cmd "endif")
2147 ;; ;; ("if" exp "then" cmd "else" "if" exp "then" cmd "endif")
2148 ;; ;; ("if" exp "then" cmd "else" "if" exp "then" cmd
2149 ;; ;; "else" cmd "endif")
2150 ;; ;; ("if" exp "then" cmd "else" "if" exp "then" cmd
2151 ;; ;; "else" "if" exp "then" cmd "endif")
2152 ;; ("while" cmd "end")
2153 ;; ("foreach" cmd "end")
2154 ;; (cmd "|" cmd) (cmd "|&" cmd)
2155 ;; (cmd "&&" cmd) (cmd "||" cmd)
2156 ;; (cmd ";" cmd) (cmd "&" cmd))
2157 ;; ;; This is a lie, but (combined with the corresponding disambiguation
2158 ;; ;; rule) it makes it more clear that `case' and `default' are the key
2159 ;; ;; separators and the `:' is a secondary tokens.
2160 ;; (branches (branches "case" branches)
2161 ;; (branches "default" branches)
2162 ;; (exp ":" branches)))
2163 ;; '((assoc "else" "then" "endif"))
2164 ;; '((assoc "case" "default") (nonassoc ":"))
2165 ;; '((assoc ";;" ";&" ";;&"))
2166 ;; '((assoc ";" "&") (assoc "&&" "||") (assoc "|" "|&")))))
2168 ;;;; SMIE support for `rc'.
2170 (defconst sh-smie-rc-grammar
2171 (smie-prec2->grammar
2172 (smie-bnf->prec2
2173 '((exp) ;A constant, or a $var, or a sequence of them...
2174 (cmd (cmd "case" cmd)
2175 ("if" exp)
2176 ("switch" exp)
2177 ("for" exp) ("while" exp)
2178 (cmd "|" cmd) (cmd "|&" cmd)
2179 (cmd "&&" cmd) (cmd "||" cmd)
2180 (cmd ";" cmd) (cmd "&" cmd))
2181 (pattern (pattern "|" pattern))
2182 (branches (branches ";;" branches)
2183 (branches ";&" branches) (branches ";;&" branches) ;bash.
2184 (pattern "case-)" cmd)))
2185 '((assoc ";;" ";&" ";;&"))
2186 '((assoc "case") (assoc ";" "&") (assoc "&&" "||") (assoc "|" "|&")))))
2188 (defun sh-smie--rc-after-special-arg-p ()
2189 "Check if we're after the first arg of an if/while/for/... construct.
2190 Returns the construct's token and moves point before it, if so."
2191 (forward-comment (- (point)))
2192 (when (looking-back ")\\|\\_<not" (- (point) 3))
2193 (ignore-errors
2194 (let ((forward-sexp-function nil))
2195 (forward-sexp -1)
2196 (car (member (funcall smie-backward-token-function)
2197 '("if" "for" "switch" "while")))))))
2199 (defun sh-smie--rc-newline-semi-p ()
2200 "Return non-nil if a newline should be treated as a semi-colon.
2201 Point should be before the newline."
2202 (save-excursion
2203 (let ((tok (funcall smie-backward-token-function)))
2204 (if (or (when (equal tok "not") (forward-word-strictly 1) t)
2205 (and (zerop (length tok)) (eq (char-before) ?\))))
2206 (not (sh-smie--rc-after-special-arg-p))
2207 (sh-smie--newline-semi-p tok)))))
2209 (defun sh-smie-rc-forward-token ()
2210 ;; FIXME: Code duplication with sh-smie-sh-forward-token.
2211 (if (and (looking-at "[ \t]*\\(?:#\\|\\(\\s|\\)\\|$\\)")
2212 (save-excursion
2213 (skip-chars-backward " \t")
2214 (not (bolp))))
2215 (if (and (match-end 1) (not (nth 3 (syntax-ppss))))
2216 ;; Right before a here-doc.
2217 (let ((forward-sexp-function nil))
2218 (forward-sexp 1)
2219 ;; Pretend the here-document is a "newline representing a
2220 ;; semi-colon", since the here-doc otherwise covers the newline(s).
2221 ";")
2222 (let ((semi (sh-smie--rc-newline-semi-p)))
2223 (forward-line 1)
2224 (if (or semi (eobp)) ";"
2225 (sh-smie-rc-forward-token))))
2226 (forward-comment (point-max))
2227 (cond
2228 ((looking-at "\\\\\n") (forward-line 1) (sh-smie-rc-forward-token))
2229 ;; ((looking-at sh-smie--rc-operators-re)
2230 ;; (goto-char (match-end 0))
2231 ;; (let ((tok (match-string-no-properties 0)))
2232 ;; (if (and (memq (aref tok (1- (length tok))) '(?\; ?\& ?\|))
2233 ;; (looking-at "[ \t]*\\(?:#\\|$\\)"))
2234 ;; (forward-line 1))
2235 ;; tok))
2237 (let* ((pos (point))
2238 (tok (sh-smie--default-forward-token)))
2239 (cond
2240 ;; ((equal tok ")") "case-)")
2241 ((and tok (string-match "\\`[a-z]" tok)
2242 (assoc tok smie-grammar)
2243 (not
2244 (save-excursion
2245 (goto-char pos)
2246 (sh-smie--keyword-p))))
2247 " word ")
2248 (t tok)))))))
2250 (defun sh-smie-rc-backward-token ()
2251 ;; FIXME: Code duplication with sh-smie-sh-backward-token.
2252 (let ((bol (line-beginning-position)))
2253 (forward-comment (- (point)))
2254 (cond
2255 ((and (bolp) (not (bobp))
2256 (equal (syntax-after (1- (point))) (string-to-syntax "|"))
2257 (not (nth 3 (syntax-ppss))))
2258 ;; Right after a here-document.
2259 (let ((forward-sexp-function nil))
2260 (forward-sexp -1)
2261 ;; Pretend the here-document is a "newline representing a
2262 ;; semi-colon", since the here-doc otherwise covers the newline(s).
2263 ";"))
2264 ((< (point) bol) ;We skipped over a newline.
2265 (cond
2266 ;; A continued line.
2267 ((and (eolp)
2268 (looking-back "\\(?:^\\|[^\\]\\)\\(?:\\\\\\\\\\)*\\\\"
2269 (line-beginning-position)))
2270 (forward-char -1)
2271 (funcall smie-backward-token-function))
2272 ((sh-smie--rc-newline-semi-p) ";")
2273 (t (funcall smie-backward-token-function))))
2274 ;; ((looking-back sh-smie--sh-operators-back-re
2275 ;; (line-beginning-position) 'greedy)
2276 ;; (goto-char (match-beginning 1))
2277 ;; (match-string-no-properties 1))
2279 (let ((tok (sh-smie--default-backward-token)))
2280 (cond
2281 ;; ((equal tok ")") "case-)")
2282 ((and tok (string-match "\\`[a-z]" tok)
2283 (assoc tok smie-grammar)
2284 (not (save-excursion (sh-smie--keyword-p))))
2285 " word ")
2286 (t tok)))))))
2288 (defun sh-smie-rc-rules (kind token)
2289 (pcase (cons kind token)
2290 (`(:elem . basic) sh-indentation)
2291 ;; (`(:after . "case") (or sh-indentation smie-indent-basic))
2292 (`(:after . ";")
2293 (if (smie-rule-parent-p "case")
2294 (smie-rule-parent (sh-var-value 'sh-indent-after-case))))
2295 (`(:before . "{")
2296 (save-excursion
2297 (when (sh-smie--rc-after-special-arg-p)
2298 `(column . ,(current-column)))))
2299 (`(:before . ,(or `"(" `"{" `"["))
2300 (if (smie-rule-hanging-p) (smie-rule-parent)))
2301 ;; FIXME: SMIE parses "if (exp) cmd" as "(if ((exp) cmd))" so "cmd" is
2302 ;; treated as an arg to (exp) by default, which indents it all wrong.
2303 ;; To handle it right, we should extend smie-indent-exps so that the
2304 ;; preceding keyword can give special rules. Currently the only special
2305 ;; rule we have is the :list-intro hack, which we use here to align "cmd"
2306 ;; with "(exp)", which is rarely the right thing to do, but is better
2307 ;; than nothing.
2308 (`(:list-intro . ,(or `"for" `"if" `"while")) t)
2309 ;; sh-indent-after-switch: handled implicitly by the default { rule.
2312 ;;; End of SMIE code.
2314 (defvar sh-regexp-for-done nil
2315 "A buffer-local regexp to match opening keyword for done.")
2317 (defvar sh-kw-alist nil
2318 "A buffer-local, since it is shell-type dependent, list of keywords.")
2320 ;; ( key-word first-on-this on-prev-line )
2321 ;; This is used to set `sh-kw-alist' which is a list of sublists each
2322 ;; having 3 elements:
2323 ;; a keyword
2324 ;; a rule to check when the keyword appears on "this" line
2325 ;; a rule to check when the keyword appears on "the previous" line
2326 ;; The keyword is usually a string and is the first word on a line.
2327 ;; If this keyword appears on the line whose indentation is to be
2328 ;; calculated, the rule in element 2 is called. If this returns
2329 ;; non-zero, the resulting point (which may be changed by the rule)
2330 ;; is used as the default indentation.
2331 ;; If it returned false or the keyword was not found in the table,
2332 ;; then the keyword from the previous line is looked up and the rule
2333 ;; in element 3 is called. In this case, however,
2334 ;; `sh-get-indent-info' does not stop but may keep going and test
2335 ;; other keywords against rules in element 3. This is because the
2336 ;; preceding line could have, for example, an opening "if" and an
2337 ;; opening "while" keyword and we need to add the indentation offsets
2338 ;; for both.
2340 (defconst sh-kw
2341 '((sh
2342 ("if" nil sh-handle-prev-if)
2343 ("elif" sh-handle-this-else sh-handle-prev-else)
2344 ("else" sh-handle-this-else sh-handle-prev-else)
2345 ("fi" sh-handle-this-fi sh-handle-prev-fi)
2346 ("then" sh-handle-this-then sh-handle-prev-then)
2347 ("(" nil sh-handle-prev-open)
2348 ("{" nil sh-handle-prev-open)
2349 ("[" nil sh-handle-prev-open)
2350 ("}" sh-handle-this-close nil)
2351 (")" sh-handle-this-close nil)
2352 ("]" sh-handle-this-close nil)
2353 ("case" nil sh-handle-prev-case)
2354 ("esac" sh-handle-this-esac sh-handle-prev-esac)
2355 (case-label nil sh-handle-after-case-label) ;; ???
2356 (";;" nil sh-handle-prev-case-alt-end) ;; ???
2357 (";;&" nil sh-handle-prev-case-alt-end) ;Like ";;" with diff semantics.
2358 (";&" nil sh-handle-prev-case-alt-end) ;Like ";;" with diff semantics.
2359 ("done" sh-handle-this-done sh-handle-prev-done)
2360 ("do" sh-handle-this-do sh-handle-prev-do))
2362 ;; Note: we don't need specific stuff for bash and zsh shells;
2363 ;; the regexp `sh-regexp-for-done' handles the extra keywords
2364 ;; these shells use.
2366 ("{" nil sh-handle-prev-open)
2367 ("}" sh-handle-this-close nil)
2368 ("case" sh-handle-this-rc-case sh-handle-prev-rc-case))))
2372 (defun sh-set-shell (shell &optional no-query-flag insert-flag)
2373 "Set this buffer's shell to SHELL (a string).
2374 When used interactively, insert the proper starting #!-line,
2375 and make the visited file executable via `executable-set-magic',
2376 perhaps querying depending on the value of `executable-query'.
2378 When this function is called noninteractively, INSERT-FLAG (the third
2379 argument) controls whether to insert a #!-line and think about making
2380 the visited file executable, and NO-QUERY-FLAG (the second argument)
2381 controls whether to query about making the visited file executable.
2383 Calls the value of `sh-set-shell-hook' if set.
2385 Shell script files can cause this function be called automatically
2386 when the file is visited by having a `sh-shell' file-local variable
2387 whose value is the shell name (don't quote it)."
2388 (interactive (list (completing-read
2389 (format "Shell (default %s): "
2390 sh-shell-file)
2391 ;; This used to use interpreter-mode-alist, but that is
2392 ;; no longer appropriate now that uses regexps.
2393 ;; Maybe there could be a separate variable that lists
2394 ;; the shells, used here and to construct i-mode-alist.
2395 ;; But the following is probably good enough:
2396 (append (mapcar (lambda (e) (symbol-name (car e)))
2397 sh-ancestor-alist)
2398 '("csh" "rc" "sh"))
2399 nil nil nil nil sh-shell-file)
2400 (eq executable-query 'function)
2402 (if (string-match "\\.exe\\'" shell)
2403 (setq shell (substring shell 0 (match-beginning 0))))
2404 (setq sh-shell (sh-canonicalize-shell shell))
2405 (if insert-flag
2406 (setq sh-shell-file
2407 (executable-set-magic shell (sh-feature sh-shell-arg)
2408 no-query-flag insert-flag)))
2409 (setq mode-line-process (format "[%s]" sh-shell))
2410 (setq-local sh-shell-variables nil)
2411 (setq-local sh-shell-variables-initialized nil)
2412 (setq-local imenu-generic-expression
2413 (sh-feature sh-imenu-generic-expression))
2414 (let ((tem (sh-feature sh-mode-syntax-table-input)))
2415 (when tem
2416 (setq-local sh-mode-syntax-table
2417 (apply 'sh-mode-syntax-table tem))
2418 (set-syntax-table sh-mode-syntax-table)))
2419 (dolist (var (sh-feature sh-variables))
2420 (sh-remember-variable var))
2421 (if (setq-local sh-indent-supported-here
2422 (sh-feature sh-indent-supported))
2423 (progn
2424 (message "Setting up indent for shell type %s" sh-shell)
2425 (let ((mksym (lambda (name)
2426 (intern (format "sh-smie-%s-%s"
2427 sh-indent-supported-here name)))))
2428 (add-function :around (local 'smie--hanging-eolp-function)
2429 (lambda (orig)
2430 (if (looking-at "[ \t]*\\\\\n")
2431 (goto-char (match-end 0))
2432 (funcall orig))))
2433 (add-hook 'smie-indent-functions #'sh-smie--indent-continuation nil t)
2434 (smie-setup (symbol-value (funcall mksym "grammar"))
2435 (funcall mksym "rules")
2436 :forward-token (funcall mksym "forward-token")
2437 :backward-token (funcall mksym "backward-token")))
2438 (setq-local parse-sexp-lookup-properties t)
2439 (unless sh-use-smie
2440 (setq-local sh-kw-alist (sh-feature sh-kw))
2441 (let ((regexp (sh-feature sh-kws-for-done)))
2442 (if regexp
2443 (setq-local sh-regexp-for-done
2444 (sh-mkword-regexpr (regexp-opt regexp t)))))
2445 (message "setting up indent stuff")
2446 ;; sh-mode has already made indent-line-function local
2447 ;; but do it in case this is called before that.
2448 (setq-local indent-line-function 'sh-indent-line))
2449 (if sh-make-vars-local
2450 (sh-make-vars-local))
2451 (message "Indentation setup for shell type %s" sh-shell))
2452 (message "No indentation for this shell type.")
2453 (setq-local indent-line-function 'sh-basic-indent-line))
2454 (when font-lock-mode
2455 (setq font-lock-set-defaults nil)
2456 (font-lock-set-defaults)
2457 (font-lock-flush))
2458 (setq sh-shell-process nil)
2459 (run-hooks 'sh-set-shell-hook))
2462 (defun sh-feature (alist &optional function)
2463 "Index ALIST by the current shell.
2464 If ALIST isn't a list where every element is a cons, it is returned as is.
2465 Else indexing follows an inheritance logic which works in two ways:
2467 - Fall back on successive ancestors (see `sh-ancestor-alist') as long as
2468 the alist contains no value for the current shell.
2469 The ultimate default is always `sh'.
2471 - If the value thus looked up is a list starting with `sh-append',
2472 we call the function `sh-append' with the rest of the list as
2473 arguments, and use the value. However, the next element of the
2474 list is not used as-is; instead, we look it up recursively
2475 in ALIST to allow the function called to define the value for
2476 one shell to be derived from another shell.
2477 The value thus determined is physically replaced into the alist.
2479 If FUNCTION is non-nil, it is called with one argument,
2480 the value thus obtained, and the result is used instead."
2481 (or (if (consp alist)
2482 ;; Check for something that isn't a valid alist.
2483 (let ((l alist))
2484 (while (and l (consp (car l)))
2485 (setq l (cdr l)))
2486 (if l alist)))
2488 (let ((orig-sh-shell sh-shell))
2489 (let ((sh-shell sh-shell)
2490 elt val)
2491 (while (and sh-shell
2492 (not (setq elt (assq sh-shell alist))))
2493 (setq sh-shell (cdr (assq sh-shell sh-ancestor-alist))))
2494 ;; If the shell is not known, treat it as sh.
2495 (unless elt
2496 (setq elt (assq 'sh alist)))
2497 (setq val (cdr elt))
2498 (if (and (consp val)
2499 (memq (car val) '(sh-append sh-modify)))
2500 (setq val
2501 (apply (car val)
2502 ;; Refer to the value for a different shell,
2503 ;; as a kind of inheritance.
2504 (let ((sh-shell (car (cdr val))))
2505 (sh-feature alist))
2506 (cddr val))))
2507 (if function
2508 (setq sh-shell orig-sh-shell
2509 val (funcall function val)))
2510 val))))
2514 ;; I commented this out because nobody calls it -- rms.
2515 ;;(defun sh-abbrevs (ancestor &rest list)
2516 ;; "If it isn't, define the current shell as abbrev table and fill that.
2517 ;;Abbrev table will inherit all abbrevs from ANCESTOR, which is either an abbrev
2518 ;;table or a list of (NAME1 EXPANSION1 ...). In addition it will define abbrevs
2519 ;;according to the remaining arguments NAMEi EXPANSIONi ...
2520 ;;EXPANSION may be either a string or a skeleton command."
2521 ;; (or (if (boundp sh-shell)
2522 ;; (symbol-value sh-shell))
2523 ;; (progn
2524 ;; (if (listp ancestor)
2525 ;; (nconc list ancestor))
2526 ;; (define-abbrev-table sh-shell ())
2527 ;; (if (vectorp ancestor)
2528 ;; (mapatoms (lambda (atom)
2529 ;; (or (eq atom 0)
2530 ;; (define-abbrev (symbol-value sh-shell)
2531 ;; (symbol-name atom)
2532 ;; (symbol-value atom)
2533 ;; (symbol-function atom))))
2534 ;; ancestor))
2535 ;; (while list
2536 ;; (define-abbrev (symbol-value sh-shell)
2537 ;; (car list)
2538 ;; (if (stringp (car (cdr list)))
2539 ;; (car (cdr list))
2540 ;; "")
2541 ;; (if (symbolp (car (cdr list)))
2542 ;; (car (cdr list))))
2543 ;; (setq list (cdr (cdr list)))))
2544 ;; (symbol-value sh-shell)))
2547 (defun sh-append (ancestor &rest list)
2548 "Return list composed of first argument (a list) physically appended to rest."
2549 (nconc list ancestor))
2552 (defun sh-modify (skeleton &rest list)
2553 "Modify a copy of SKELETON by replacing I1 with REPL1, I2 with REPL2 ..."
2554 (setq skeleton (copy-sequence skeleton))
2555 (while list
2556 (setcar (or (nthcdr (car list) skeleton)
2557 (error "Index %d out of bounds" (car list)))
2558 (car (cdr list)))
2559 (setq list (nthcdr 2 list)))
2560 skeleton)
2563 (defun sh-basic-indent-line ()
2564 "Indent a line for Sh mode (shell script mode).
2565 Indent as far as preceding non-empty line, then by steps of `sh-indentation'.
2566 Lines containing only comments are considered empty."
2567 (interactive)
2568 (let ((previous (save-excursion
2569 (while (and (progn (beginning-of-line)
2570 (not (bobp)))
2571 (progn
2572 (forward-line -1)
2573 (back-to-indentation)
2574 (or (eolp)
2575 (eq (following-char) ?#)))))
2576 (current-column)))
2577 current)
2578 (save-excursion
2579 (indent-to (if (or (eq this-command 'newline-and-indent)
2580 (and electric-indent-mode (eq this-command 'newline)))
2581 previous
2582 (if (< (current-column)
2583 (setq current (progn (back-to-indentation)
2584 (current-column))))
2585 (if (eolp) previous 0)
2586 (delete-region (point)
2587 (progn (beginning-of-line) (point)))
2588 (if (eolp)
2589 (max previous (* (1+ (/ current sh-indentation))
2590 sh-indentation))
2591 (* (1+ (/ current sh-indentation)) sh-indentation))))))
2592 (if (< (current-column) (current-indentation))
2593 (skip-chars-forward " \t"))))
2596 (defun sh-execute-region (start end &optional flag)
2597 "Pass optional header and region to a subshell for noninteractive execution.
2598 The working directory is that of the buffer, and only environment variables
2599 are already set which is why you can mark a header within the script.
2601 With a positive prefix ARG, instead of sending region, define header from
2602 beginning of buffer to point. With a negative prefix ARG, instead of sending
2603 region, clear header."
2604 (interactive "r\nP")
2605 (if flag
2606 (setq sh-header-marker (if (> (prefix-numeric-value flag) 0)
2607 (point-marker)))
2608 (if sh-header-marker
2609 (save-excursion
2610 (let (buffer-undo-list)
2611 (goto-char sh-header-marker)
2612 (append-to-buffer (current-buffer) start end)
2613 (shell-command-on-region (point-min)
2614 (setq end (+ sh-header-marker
2615 (- end start)))
2616 sh-shell-file)
2617 (delete-region sh-header-marker end)))
2618 (shell-command-on-region start end (concat sh-shell-file " -")))))
2621 (defun sh-remember-variable (var)
2622 "Make VARIABLE available for future completing reads in this buffer."
2623 (or (< (length var) sh-remember-variable-min)
2624 (getenv var)
2625 (assoc var sh-shell-variables)
2626 (push (cons var var) sh-shell-variables))
2627 var)
2631 (defun sh-quoted-p ()
2632 "Is point preceded by an odd number of backslashes?"
2633 (eq -1 (% (save-excursion (skip-chars-backward "\\\\")) 2)))
2635 ;; Indentation stuff.
2636 (defun sh-must-support-indent ()
2637 "Signal an error if the shell type for this buffer is not supported.
2638 Also, the buffer must be in Shell-script mode."
2639 (unless sh-indent-supported-here
2640 (error "This buffer's shell does not support indentation through Emacs")))
2642 (defun sh-make-vars-local ()
2643 "Make the indentation variables local to this buffer.
2644 Normally they already are local. This command is provided in case
2645 variable `sh-make-vars-local' has been set to nil.
2647 To revert all these variables to the global values, use
2648 command `sh-reset-indent-vars-to-global-values'."
2649 (interactive)
2650 (mapc 'make-local-variable sh-var-list)
2651 (message "Indentation variables are now local."))
2653 (defun sh-reset-indent-vars-to-global-values ()
2654 "Reset local indentation variables to the global values.
2655 Then, if variable `sh-make-vars-local' is non-nil, make them local."
2656 (interactive)
2657 (mapc 'kill-local-variable sh-var-list)
2658 (if sh-make-vars-local
2659 (mapcar 'make-local-variable sh-var-list)))
2662 ;; Theoretically these are only needed in shell and derived modes.
2663 ;; However, the routines which use them are only called in those modes.
2664 (defconst sh-special-keywords "then\\|do")
2666 (defun sh-help-string-for-variable (var)
2667 "Construct a string for `sh-read-variable' when changing variable VAR ."
2668 (let ((msg (documentation-property var 'variable-documentation))
2669 (msg2 ""))
2670 (unless (memq var '(sh-first-lines-indent sh-indent-comment))
2671 (setq msg2
2672 (format "\n
2673 You can enter a number (positive to increase indentation,
2674 negative to decrease indentation, zero for no change to indentation).
2676 Or, you can enter one of the following symbols which are relative to
2677 the value of variable `sh-basic-offset'
2678 which in this buffer is currently %s.
2680 \t%s."
2681 sh-basic-offset
2682 (mapconcat (lambda (x)
2683 (nth (1- (length x)) x))
2684 sh-symbol-list "\n\t"))))
2685 (concat
2686 ;; The following shows the global not the local value!
2687 ;; (format "Current value of %s is %s\n\n" var (symbol-value var))
2688 msg msg2)))
2690 (defun sh-read-variable (var)
2691 "Read a new value for indentation variable VAR."
2692 (let ((minibuffer-help-form `(sh-help-string-for-variable
2693 (quote ,var)))
2694 val)
2695 (setq val (read-from-minibuffer
2696 (format "New value for %s (press %s for help): "
2697 var (single-key-description help-char))
2698 (format "%s" (symbol-value var))
2699 nil t))
2700 val))
2704 (defun sh-in-comment-or-string (start)
2705 "Return non-nil if START is in a comment or string."
2706 (save-excursion
2707 (let ((state (syntax-ppss start)))
2708 (or (nth 3 state) (nth 4 state)))))
2710 (defun sh-goto-matching-if ()
2711 "Go to the matching if for a fi.
2712 This handles nested if..fi pairs."
2713 (let ((found (sh-find-prev-matching "\\bif\\b" "\\bfi\\b" 1)))
2714 (if found
2715 (goto-char found))))
2718 ;; Functions named sh-handle-this-XXX are called when the keyword on the
2719 ;; line whose indentation is being handled contain XXX;
2720 ;; those named sh-handle-prev-XXX are when XXX appears on the previous line.
2722 (defun sh-handle-prev-if ()
2723 (list '(+ sh-indent-after-if)))
2725 (defun sh-handle-this-else ()
2726 (if (sh-goto-matching-if)
2727 ;; (list "aligned to if")
2728 (list "aligned to if" '(+ sh-indent-for-else))
2732 (defun sh-handle-prev-else ()
2733 (if (sh-goto-matching-if)
2734 (list '(+ sh-indent-after-if))
2737 (defun sh-handle-this-fi ()
2738 (if (sh-goto-matching-if)
2739 (list "aligned to if" '(+ sh-indent-for-fi))
2743 (defun sh-handle-prev-fi ()
2744 ;; Why do we have this rule? Because we must go back to the if
2745 ;; to get its indent. We may continue back from there.
2746 ;; We return nil because we don't have anything to add to result,
2747 ;; the side affect of setting align-point is all that matters.
2748 ;; we could return a comment (a string) but I can't think of a good one...
2749 (sh-goto-matching-if)
2750 nil)
2752 (defun sh-handle-this-then ()
2753 (let ((p (sh-goto-matching-if)))
2754 (if p
2755 (list '(+ sh-indent-for-then))
2758 (defun sh-handle-prev-then ()
2759 (let ((p (sh-goto-matching-if)))
2760 (if p
2761 (list '(+ sh-indent-after-if))
2764 (defun sh-handle-prev-open ()
2765 (save-excursion
2766 (let ((x (sh-prev-stmt)))
2767 (if (and x
2768 (progn
2769 (goto-char x)
2771 (looking-at "function\\b")
2772 (looking-at "\\s-*\\S-+\\s-*()")
2774 (list '(+ sh-indent-after-function))
2775 (list '(+ sh-indent-after-open)))
2778 (defun sh-handle-this-close ()
2779 (forward-char 1) ;; move over ")"
2780 (if (sh-safe-forward-sexp -1)
2781 (list "aligned to opening paren")))
2783 (defun sh-goto-matching-case ()
2784 (let ((found (sh-find-prev-matching "\\bcase\\b" "\\besac\\b" 1)))
2785 (if found (goto-char found))))
2787 (defun sh-handle-prev-case ()
2788 ;; This is typically called when point is on same line as a case
2789 ;; we shouldn't -- and can't find prev-case
2790 (if (looking-at ".*\\<case\\>")
2791 (list '(+ sh-indent-for-case-label))
2792 (error "We don't seem to be on a line with a case"))) ;; debug
2794 (defun sh-handle-this-esac ()
2795 (if (sh-goto-matching-case)
2796 (list "aligned to matching case")))
2798 (defun sh-handle-prev-esac ()
2799 (if (sh-goto-matching-case)
2800 (list "matching case")))
2802 (defun sh-handle-after-case-label ()
2803 (if (sh-goto-matching-case)
2804 (list '(+ sh-indent-for-case-alt))))
2806 (defun sh-handle-prev-case-alt-end ()
2807 (if (sh-goto-matching-case)
2808 (list '(+ sh-indent-for-case-label))))
2810 (defun sh-safe-forward-sexp (&optional arg)
2811 "Try and do a `forward-sexp', but do not error.
2812 Return new point if successful, nil if an error occurred."
2813 (condition-case nil
2814 (progn
2815 (forward-sexp (or arg 1))
2816 (point)) ;; return point if successful
2817 (error
2818 (sh-debug "oops!(1) %d" (point))
2819 nil))) ;; return nil if fail
2821 (defun sh-goto-match-for-done ()
2822 (let ((found (sh-find-prev-matching sh-regexp-for-done sh-re-done 1)))
2823 (if found
2824 (goto-char found))))
2826 (defun sh-handle-this-done ()
2827 (if (sh-goto-match-for-done)
2828 (list "aligned to do stmt" '(+ sh-indent-for-done))))
2830 (defun sh-handle-prev-done ()
2831 (if (sh-goto-match-for-done)
2832 (list "previous done")))
2834 (defun sh-handle-this-do ()
2835 (if (sh-goto-match-for-done)
2836 (list '(+ sh-indent-for-do))))
2838 (defun sh-handle-prev-do ()
2839 (cond
2840 ((save-restriction
2841 (narrow-to-region (point) (line-beginning-position))
2842 (sh-goto-match-for-done))
2843 (sh-debug "match for done found on THIS line")
2844 (list '(+ sh-indent-after-loop-construct)))
2845 ((sh-goto-match-for-done)
2846 (sh-debug "match for done found on PREV line")
2847 (list '(+ sh-indent-after-do)))
2849 (message "match for done NOT found")
2850 nil)))
2852 ;; for rc:
2853 (defun sh-find-prev-switch ()
2854 "Find the line for the switch keyword matching this line's case keyword."
2855 (re-search-backward "\\<switch\\>" nil t))
2857 (defun sh-handle-this-rc-case ()
2858 (if (sh-find-prev-switch)
2859 (list '(+ sh-indent-after-switch))
2860 ;; (list '(+ sh-indent-for-case-label))
2861 nil))
2863 (defun sh-handle-prev-rc-case ()
2864 (list '(+ sh-indent-after-case)))
2866 (defun sh-check-rule (n thing)
2867 (let ((rule (nth n (assoc thing sh-kw-alist)))
2868 (val nil))
2869 (if rule
2870 (progn
2871 (setq val (funcall rule))
2872 (sh-debug "rule (%d) for %s at %d is %s\n-> returned %s"
2873 n thing (point) rule val)))
2874 val))
2877 (defun sh-get-indent-info ()
2878 "Return indent-info for this line.
2879 This is a list. nil means the line is to be left as is.
2880 Otherwise it contains one or more of the following sublists:
2881 \(t NUMBER) NUMBER is the base location in the buffer that indentation is
2882 relative to. If present, this is always the first of the
2883 sublists. The indentation of the line in question is
2884 derived from the indentation of this point, possibly
2885 modified by subsequent sublists.
2886 \(+ VAR)
2887 \(- VAR) Get the value of variable VAR and add to or subtract from
2888 the indentation calculated so far.
2889 \(= VAR) Get the value of variable VAR and *replace* the
2890 indentation with its value. This only occurs for
2891 special variables such as `sh-indent-comment'.
2892 STRING This is ignored for the purposes of calculating
2893 indentation, it is printed in certain cases to help show
2894 what the indentation is based on."
2895 ;; See comments before `sh-kw'.
2896 (save-excursion
2897 (let ((have-result nil)
2898 this-kw
2900 (result nil)
2901 (align-point nil)
2902 prev-line-end x)
2903 (beginning-of-line)
2904 ;; Note: setting result to t means we are done and will return nil.
2905 ;;(This function never returns just t.)
2906 (cond
2907 ((or (nth 3 (syntax-ppss (point)))
2908 (eq (get-text-property (point) 'face) 'sh-heredoc))
2909 ;; String continuation -- don't indent
2910 (setq result t)
2911 (setq have-result t))
2912 ((looking-at "\\s-*#") ; was (equal this-kw "#")
2913 (if (bobp)
2914 (setq result t) ;; return nil if 1st line!
2915 (setq result (list '(= sh-indent-comment)))
2916 ;; we still need to get previous line in case
2917 ;; sh-indent-comment is t (indent as normal)
2918 (setq align-point (sh-prev-line nil))
2919 (setq have-result nil)
2921 ) ;; cond
2923 (unless have-result
2924 ;; Continuation lines are handled specially
2925 (if (sh-this-is-a-continuation)
2926 (progn
2927 (setq result
2928 (if (save-excursion
2929 (beginning-of-line)
2930 (not (memq (char-before (- (point) 2)) '(?\s ?\t))))
2931 ;; By convention, if the continuation \ is not
2932 ;; preceded by a SPC or a TAB it means that the line
2933 ;; is cut at a place where spaces cannot be freely
2934 ;; added/removed. I.e. do not indent the line.
2935 (list '(= nil))
2936 ;; We assume the line being continued is already
2937 ;; properly indented...
2938 ;; (setq prev-line-end (sh-prev-line))
2939 (setq align-point (sh-prev-line nil))
2940 (list '(+ sh-indent-for-continuation))))
2941 (setq have-result t))
2942 (beginning-of-line)
2943 (skip-chars-forward " \t")
2944 (setq this-kw (sh-get-kw)))
2946 ;; Handle "this" keyword: first word on the line we're
2947 ;; calculating indentation info for.
2948 (if this-kw
2949 (if (setq val (sh-check-rule 1 this-kw))
2950 (progn
2951 (setq align-point (point))
2952 (sh-debug
2953 "this - setting align-point to %d" align-point)
2954 (setq result (append result val))
2955 (setq have-result t)
2956 ;; set prev-line to continue processing remainder
2957 ;; of this line as a previous line
2958 (setq prev-line-end (point))
2959 ))))
2961 (unless have-result
2962 (setq prev-line-end (sh-prev-line 'end)))
2964 (if prev-line-end
2965 (save-excursion
2966 ;; We start off at beginning of this line.
2967 ;; Scan previous statements while this is <=
2968 ;; start of previous line.
2969 (goto-char prev-line-end)
2970 (setq x t)
2971 (while (and x (setq x (sh-prev-thing)))
2972 (sh-debug "at %d x is: %s result is: %s" (point) x result)
2973 (cond
2974 ((and (equal x ")")
2975 (equal (get-text-property (1- (point)) 'syntax-table)
2976 sh-st-punc))
2977 (sh-debug "Case label) here")
2978 (setq x 'case-label)
2979 (if (setq val (sh-check-rule 2 x))
2980 (progn
2981 (setq result (append result val))
2982 (setq align-point (point))))
2983 (or (bobp)
2984 (forward-char -1))
2985 ;; FIXME: This charset looks too much like a regexp. --Stef
2986 (skip-chars-forward "[a-z0-9]*?")
2988 ((string-match "[])}]" x)
2989 (setq x (sh-safe-forward-sexp -1))
2990 (if x
2991 (progn
2992 (setq align-point (point))
2993 (setq result (append result
2994 (list "aligned to opening paren")))
2996 ((string-match "[[({]" x)
2997 (sh-debug "Checking special thing: %s" x)
2998 (if (setq val (sh-check-rule 2 x))
2999 (setq result (append result val)))
3000 (forward-char -1)
3001 (setq align-point (point)))
3002 ((string-match "[\"'`]" x)
3003 (sh-debug "Skipping back for %s" x)
3004 ;; this was oops-2
3005 (setq x (sh-safe-forward-sexp -1)))
3006 ((stringp x)
3007 (sh-debug "Checking string %s at %s" x (point))
3008 (if (setq val (sh-check-rule 2 x))
3009 ;; (or (eq t (car val))
3010 ;; (eq t (car (car val))))
3011 (setq result (append result val)))
3012 ;; not sure about this test Wed Jan 27 23:48:35 1999
3013 (setq align-point (point))
3014 (unless (bolp)
3015 (forward-char -1)))
3017 (error "Don't know what to do with %s" x))
3019 ) ;; while
3020 (sh-debug "result is %s" result)
3022 (sh-debug "No prev line!")
3023 (sh-debug "result: %s align-point: %s" result align-point)
3026 (if align-point
3027 ;; was: (setq result (append result (list (list t align-point))))
3028 (setq result (append (list (list t align-point)) result))
3030 (sh-debug "result is now: %s" result)
3032 (or result
3033 (setq result (list (if prev-line-end
3034 (list t prev-line-end)
3035 (list '= 'sh-first-lines-indent)))))
3037 (if (eq result t)
3038 (setq result nil))
3039 (sh-debug "result is: %s" result)
3040 result
3041 ) ;; let
3045 (defun sh-get-indent-var-for-line (&optional info)
3046 "Return the variable controlling indentation for this line.
3047 If there is not [just] one such variable, return a string
3048 indicating the problem.
3049 If INFO is supplied it is used, else it is calculated."
3050 (let ((var nil)
3051 (result nil)
3052 (reason nil)
3053 sym elt)
3054 (or info
3055 (setq info (sh-get-indent-info)))
3056 (if (null info)
3057 (setq result "this line to be left as is")
3058 (while (and info (null result))
3059 (setq elt (car info))
3060 (cond
3061 ((stringp elt)
3062 (setq reason elt)
3064 ((not (listp elt))
3065 (error "sh-get-indent-var-for-line invalid elt: %s" elt))
3066 ;; so it is a list
3067 ((eq t (car elt))
3068 ) ;; nothing
3069 ((symbolp (setq sym (nth 1 elt)))
3070 ;; A bit of a kludge - when we see the sh-indent-comment
3071 ;; ignore other variables. Otherwise it is tricky to
3072 ;; "learn" the comment indentation.
3073 (if (eq var 'sh-indent-comment)
3074 (setq result var)
3075 (if var
3076 (setq result
3077 "this line is controlled by more than 1 variable.")
3078 (setq var sym))))
3080 (error "sh-get-indent-var-for-line invalid list elt: %s" elt)))
3081 (setq info (cdr info))
3083 (or result
3084 (setq result var))
3085 (or result
3086 (setq result reason))
3087 (if (null result)
3088 ;; e.g. just had (t POS)
3089 (setq result "line has default indentation"))
3090 result))
3094 ;; Finding the previous line isn't trivial.
3095 ;; We must *always* go back one more and see if that is a continuation
3096 ;; line -- it is the PREVIOUS line which is continued, not the one
3097 ;; we are going to!
3098 ;; Also, we want to treat a whole "here document" as one big line,
3099 ;; because we may want to a align to the beginning of it.
3101 ;; What we do:
3102 ;; - go back to previous non-empty line
3103 ;; - if this is in a here-document, go to the beginning of it
3104 ;; - while previous line is continued, go back one line
3105 (defun sh-prev-line (&optional end)
3106 "Back to end of previous non-comment non-empty line.
3107 Go to beginning of logical line unless END is non-nil, in which case
3108 we go to the end of the previous line and do not check for continuations."
3109 (save-excursion
3110 (beginning-of-line)
3111 (forward-comment (- (point-max)))
3112 (unless end (beginning-of-line))
3113 (when (and (not (bobp))
3114 (eq (get-text-property (1- (point)) 'face) 'sh-heredoc))
3115 (let ((p1 (previous-single-property-change (1- (point)) 'face)))
3116 (when p1
3117 (goto-char p1)
3118 (if end
3119 (end-of-line)
3120 (beginning-of-line)))))
3121 (unless end
3122 ;; we must check previous lines to see if they are continuation lines
3123 ;; if so, we must return position of first of them
3124 (while (and (sh-this-is-a-continuation)
3125 (>= 0 (forward-line -1))))
3126 (beginning-of-line)
3127 (skip-chars-forward " \t"))
3128 (point)))
3131 (defun sh-prev-stmt ()
3132 "Return the address of the previous stmt or nil."
3133 ;; This is used when we are trying to find a matching keyword.
3134 ;; Searching backward for the keyword would certainly be quicker, but
3135 ;; it is hard to remove "false matches" -- such as if the keyword
3136 ;; appears in a string or quote. This way is slower, but (I think) safer.
3137 (interactive)
3138 (save-excursion
3139 (let ((going t)
3140 (start (point))
3141 (found nil)
3142 (prev nil))
3143 (skip-chars-backward " \t;|&({[")
3144 (while (and (not found)
3145 (not (bobp))
3146 going)
3147 ;; Do a backward-sexp if possible, else backup bit by bit...
3148 (if (sh-safe-forward-sexp -1)
3149 (progn
3150 (if (looking-at sh-special-keywords)
3151 (progn
3152 (setq found prev))
3153 (setq prev (point))
3155 ;; backward-sexp failed
3156 (if (zerop (skip-chars-backward " \t()[]{};`'"))
3157 (forward-char -1))
3158 (if (bolp)
3159 (let ((back (sh-prev-line nil)))
3160 (if back
3161 (goto-char back)
3162 (setq going nil)))))
3163 (unless found
3164 (skip-chars-backward " \t")
3165 (if (or (and (bolp) (not (sh-this-is-a-continuation)))
3166 (eq (char-before) ?\;)
3167 (looking-at "\\s-*[|&]"))
3168 (setq found (point)))))
3169 (if found
3170 (goto-char found))
3171 (if found
3172 (progn
3173 (skip-chars-forward " \t|&({[")
3174 (setq found (point))))
3175 (if (>= (point) start)
3176 (progn
3177 (debug "We didn't move!")
3178 (setq found nil))
3179 (or found
3180 (sh-debug "Did not find prev stmt.")))
3181 found)))
3184 (defun sh-get-word ()
3185 "Get a shell word skipping whitespace from point."
3186 (interactive)
3187 (skip-chars-forward "\t ")
3188 (let ((start (point)))
3189 (while
3190 (if (looking-at "[\"'`]")
3191 (sh-safe-forward-sexp)
3192 ;; (> (skip-chars-forward "^ \t\n\"'`") 0)
3193 (> (skip-chars-forward "-_$[:alnum:]") 0)
3195 (buffer-substring start (point))
3198 (defun sh-prev-thing ()
3199 "Return the previous thing this logical line."
3200 ;; This is called when `sh-get-indent-info' is working backwards on
3201 ;; the previous line(s) finding what keywords may be relevant for
3202 ;; indenting. It moves over sexps if possible, and will stop
3203 ;; on a ; and at the beginning of a line if it is not a continuation
3204 ;; line.
3206 ;; Added a kludge for ";;"
3207 ;; Possible return values:
3208 ;; nil - nothing
3209 ;; a string - possibly a keyword
3211 (if (bolp)
3213 (let ((start (point))
3214 (min-point (if (sh-this-is-a-continuation)
3215 (sh-prev-line nil)
3216 (line-beginning-position))))
3217 (skip-chars-backward " \t;" min-point)
3218 (if (looking-at "\\s-*;[;&]")
3219 ;; (message "Found ;; !")
3220 ";;"
3221 (skip-chars-backward "^)}];\"'`({[" min-point)
3222 (let ((c (if (> (point) min-point) (char-before))))
3223 (sh-debug "stopping at %d c is %s start=%d min-point=%d"
3224 (point) c start min-point)
3225 (if (not (memq c '(?\n nil ?\;)))
3226 ;; c -- return a string
3227 (char-to-string c)
3228 ;; Return the leading keyword of the "command" we supposedly
3229 ;; skipped over. Maybe we skipped too far (e.g. past a `do' or
3230 ;; `then' that precedes the actual command), so check whether
3231 ;; we're looking at such a keyword and if so, move back forward.
3232 (let ((boundary (point))
3233 kwd next)
3234 (while
3235 (progn
3236 ;; Skip forward over white space newline and \ at eol.
3237 (skip-chars-forward " \t\n\\\\" start)
3238 (if (>= (point) start)
3239 (progn
3240 (sh-debug "point: %d >= start: %d" (point) start)
3241 nil)
3242 (if next (setq boundary next))
3243 (sh-debug "Now at %d start=%d" (point) start)
3244 (setq kwd (sh-get-word))
3245 (if (member kwd (sh-feature sh-leading-keywords))
3246 (progn
3247 (setq next (point))
3249 nil))))
3250 (goto-char boundary)
3251 kwd)))))))
3254 (defun sh-this-is-a-continuation ()
3255 "Return non-nil if current line is a continuation of previous line."
3256 (save-excursion
3257 (and (zerop (forward-line -1))
3258 (looking-at ".*\\\\$")
3259 (not (nth 4 (parse-partial-sexp (match-beginning 0) (match-end 0)
3260 nil nil nil t))))))
3262 (defun sh-get-kw (&optional where and-move)
3263 "Return first word of line from WHERE.
3264 If AND-MOVE is non-nil then move to end of word."
3265 (let ((start (point)))
3266 (if where
3267 (goto-char where))
3268 (prog1
3269 (buffer-substring (point)
3270 (progn (skip-chars-forward "^ \t\n;&|")(point)))
3271 (unless and-move
3272 (goto-char start)))))
3274 (defun sh-find-prev-matching (open close &optional depth)
3275 "Find a matching token for a set of opening and closing keywords.
3276 This takes into account that there may be nested open..close pairings.
3277 OPEN and CLOSE are regexps denoting the tokens to be matched.
3278 Optional parameter DEPTH (usually 1) says how many to look for."
3279 (let ((parse-sexp-ignore-comments t)
3280 (forward-sexp-function nil)
3281 prev)
3282 (setq depth (or depth 1))
3283 (save-excursion
3284 (condition-case nil
3285 (while (and
3286 (/= 0 depth)
3287 (not (bobp))
3288 (setq prev (sh-prev-stmt)))
3289 (goto-char prev)
3290 (save-excursion
3291 (if (looking-at "\\\\\n")
3292 (progn
3293 (forward-char 2)
3294 (skip-chars-forward " \t")))
3295 (cond
3296 ((looking-at open)
3297 (setq depth (1- depth))
3298 (sh-debug "found open at %d - depth = %d" (point) depth))
3299 ((looking-at close)
3300 (setq depth (1+ depth))
3301 (sh-debug "found close - depth = %d" depth))
3303 ))))
3304 (error nil))
3305 (if (eq depth 0)
3306 prev ;; (point)
3307 nil)
3311 (defun sh-var-value (var &optional ignore-error)
3312 "Return the value of variable VAR, interpreting symbols.
3313 It can also return t or nil.
3314 If an invalid value is found, throw an error unless Optional argument
3315 IGNORE-ERROR is non-nil."
3316 (let ((val (symbol-value var)))
3317 (cond
3318 ((numberp val)
3319 val)
3320 ((eq val t)
3321 val)
3322 ((null val)
3323 val)
3324 ((eq val '+)
3325 sh-basic-offset)
3326 ((eq val '-)
3327 (- sh-basic-offset))
3328 ((eq val '++)
3329 (* 2 sh-basic-offset))
3330 ((eq val '--)
3331 (* 2 (- sh-basic-offset)))
3332 ((eq val '*)
3333 (/ sh-basic-offset 2))
3334 ((eq val '/)
3335 (/ (- sh-basic-offset) 2))
3337 (funcall (if ignore-error #'message #'error)
3338 "Don't know how to handle %s's value of %s" var val)
3339 0))))
3341 (defun sh-set-var-value (var value &optional no-symbol)
3342 "Set variable VAR to VALUE.
3343 Unless optional argument NO-SYMBOL is non-nil, then if VALUE is
3344 can be represented by a symbol then do so."
3345 (cond
3346 (no-symbol
3347 (set var value))
3348 ((= value sh-basic-offset)
3349 (set var '+))
3350 ((= value (- sh-basic-offset))
3351 (set var '-))
3352 ((eq value (* 2 sh-basic-offset))
3353 (set var '++))
3354 ((eq value (* 2 (- sh-basic-offset)))
3355 (set var '--))
3356 ((eq value (/ sh-basic-offset 2))
3357 (set var '*))
3358 ((eq value (/ (- sh-basic-offset) 2))
3359 (set var '/))
3361 (set var value)))
3365 (defun sh-calculate-indent (&optional info)
3366 "Return the indentation for the current line.
3367 If INFO is supplied it is used, else it is calculated from current line."
3368 (let ((ofs 0)
3369 (base-value 0)
3370 elt a b val)
3371 (or info
3372 (setq info (sh-get-indent-info)))
3373 (when info
3374 (while info
3375 (sh-debug "info: %s ofs=%s" info ofs)
3376 (setq elt (car info))
3377 (cond
3378 ((stringp elt)) ;; do nothing?
3379 ((listp elt)
3380 (setq a (car (car info)))
3381 (setq b (nth 1 (car info)))
3382 (cond
3383 ((eq a t)
3384 (save-excursion
3385 (goto-char b)
3386 (setq val (current-indentation)))
3387 (setq base-value val))
3388 ((symbolp b)
3389 (setq val (sh-var-value b))
3390 (cond
3391 ((eq a '=)
3392 (cond
3393 ((null val)
3394 ;; no indentation
3395 ;; set info to nil so we stop immediately
3396 (setq base-value nil ofs nil info nil))
3397 ((eq val t) (setq ofs 0)) ;; indent as normal line
3399 ;; The following assume the (t POS) come first!
3400 (setq ofs val base-value 0)
3401 (setq info nil)))) ;; ? stop now
3402 ((eq a '+) (setq ofs (+ ofs val)))
3403 ((eq a '-) (setq ofs (- ofs val)))
3405 (error "sh-calculate-indent invalid a a=%s b=%s" a b))))
3407 (error "sh-calculate-indent invalid elt: a=%s b=%s" a b))))
3409 (error "sh-calculate-indent invalid elt %s" elt)))
3410 (sh-debug "a=%s b=%s val=%s base-value=%s ofs=%s"
3411 a b val base-value ofs)
3412 (setq info (cdr info)))
3413 ;; return value:
3414 (sh-debug "at end: base-value: %s ofs: %s" base-value ofs)
3416 (cond
3417 ((or (null base-value)(null ofs))
3418 nil)
3419 ((and (numberp base-value)(numberp ofs))
3420 (sh-debug "base (%d) + ofs (%d) = %d"
3421 base-value ofs (+ base-value ofs))
3422 (+ base-value ofs)) ;; return value
3424 (error "sh-calculate-indent: Help. base-value=%s ofs=%s"
3425 base-value ofs)
3426 nil)))))
3429 (defun sh-indent-line ()
3430 "Indent the current line."
3431 (interactive)
3432 (let ((indent (sh-calculate-indent))
3433 (pos (- (point-max) (point))))
3434 (when indent
3435 (beginning-of-line)
3436 (skip-chars-forward " \t")
3437 (indent-line-to indent)
3438 ;; If initial point was within line's indentation,
3439 ;; position after the indentation. Else stay at same point in text.
3440 (if (> (- (point-max) pos) (point))
3441 (goto-char (- (point-max) pos))))))
3444 (defun sh-blink (blinkpos &optional msg)
3445 "Move cursor momentarily to BLINKPOS and display MSG."
3446 ;; We can get here without it being a number on first line
3447 (if (numberp blinkpos)
3448 (save-excursion
3449 (goto-char blinkpos)
3450 (if msg (message "%s" msg) (message nil))
3451 (sit-for blink-matching-delay))
3452 (if msg (message "%s" msg) (message nil))))
3454 (defun sh-show-indent (arg)
3455 "Show the how the current line would be indented.
3456 This tells you which variable, if any, controls the indentation of
3457 this line.
3458 If optional arg ARG is non-null (called interactively with a prefix),
3459 a pop up window describes this variable.
3460 If variable `sh-blink' is non-nil then momentarily go to the line
3461 we are indenting relative to, if applicable."
3462 (interactive "P")
3463 (sh-must-support-indent)
3464 (if sh-use-smie
3465 (smie-config-show-indent)
3466 (let* ((info (sh-get-indent-info))
3467 (var (sh-get-indent-var-for-line info))
3468 (curr-indent (current-indentation))
3469 val msg)
3470 (if (stringp var)
3471 (message "%s" (setq msg var))
3472 (setq val (sh-calculate-indent info))
3474 (if (eq curr-indent val)
3475 (setq msg (format "%s is %s" var (symbol-value var)))
3476 (setq msg
3477 (if val
3478 (format "%s (%s) would change indent from %d to: %d"
3479 var (symbol-value var) curr-indent val)
3480 (format "%s (%s) would leave line as is"
3481 var (symbol-value var)))
3483 (if (and arg var)
3484 (describe-variable var)))
3485 (if sh-blink
3486 (let ((info (sh-get-indent-info)))
3487 (if (and info (listp (car info))
3488 (eq (car (car info)) t))
3489 (sh-blink (nth 1 (car info)) msg)
3490 (message "%s" msg)))
3491 (message "%s" msg))
3494 (defun sh-set-indent ()
3495 "Set the indentation for the current line.
3496 If the current line is controlled by an indentation variable, prompt
3497 for a new value for it."
3498 (interactive)
3499 (sh-must-support-indent)
3500 (if sh-use-smie
3501 (smie-config-set-indent)
3502 (let* ((info (sh-get-indent-info))
3503 (var (sh-get-indent-var-for-line info))
3504 val old-val indent-val)
3505 (if (stringp var)
3506 (message "Cannot set indent - %s" var)
3507 (setq old-val (symbol-value var))
3508 (setq val (sh-read-variable var))
3509 (condition-case nil
3510 (progn
3511 (set var val)
3512 (setq indent-val (sh-calculate-indent info))
3513 (if indent-val
3514 (message "Variable: %s Value: %s would indent to: %d"
3515 var (symbol-value var) indent-val)
3516 (message "Variable: %s Value: %s would leave line as is."
3517 var (symbol-value var)))
3518 ;; I'm not sure about this, indenting it now?
3519 ;; No. Because it would give the impression that an undo would
3520 ;; restore thing, but the value has been altered.
3521 ;; (sh-indent-line)
3523 (error
3524 (set var old-val)
3525 (message "Bad value for %s, restoring to previous value %s"
3526 var old-val)
3527 (sit-for 1)
3528 nil))
3529 ))))
3532 (defun sh-learn-line-indent (arg)
3533 "Learn how to indent a line as it currently is indented.
3535 If there is an indentation variable which controls this line's indentation,
3536 then set it to a value which would indent the line the way it
3537 presently is.
3539 If the value can be represented by one of the symbols then do so
3540 unless optional argument ARG (the prefix when interactive) is non-nil."
3541 (interactive "*P")
3542 (sh-must-support-indent)
3543 (if sh-use-smie
3544 (smie-config-set-indent)
3545 ;; I'm not sure if we show allow learning on an empty line.
3546 ;; Though it might occasionally be useful I think it usually
3547 ;; would just be confusing.
3548 (if (save-excursion
3549 (beginning-of-line)
3550 (looking-at "\\s-*$"))
3551 (message "sh-learn-line-indent ignores empty lines.")
3552 (let* ((info (sh-get-indent-info))
3553 (var (sh-get-indent-var-for-line info))
3554 ival sval diff new-val
3555 (no-symbol arg)
3556 (curr-indent (current-indentation)))
3557 (cond
3558 ((stringp var)
3559 (message "Cannot learn line - %s" var))
3560 ((eq var 'sh-indent-comment)
3561 ;; This is arbitrary...
3562 ;; - if curr-indent is 0, set to curr-indent
3563 ;; - else if it has the indentation of a "normal" line,
3564 ;; then set to t
3565 ;; - else set to curr-indent.
3566 (setq sh-indent-comment
3567 (if (= curr-indent 0)
3569 (let* ((sh-indent-comment t)
3570 (val2 (sh-calculate-indent info)))
3571 (if (= val2 curr-indent)
3573 curr-indent))))
3574 (message "%s set to %s" var (symbol-value var))
3576 ((numberp (setq sval (sh-var-value var)))
3577 (setq ival (sh-calculate-indent info))
3578 (setq diff (- curr-indent ival))
3580 (sh-debug "curr-indent: %d ival: %d diff: %d var:%s sval %s"
3581 curr-indent ival diff var sval)
3582 (setq new-val (+ sval diff))
3583 ;; I commented out this because someone might want to replace
3584 ;; a value of `+' with the current value of sh-basic-offset
3585 ;; or vice-versa.
3586 ;;(if (= 0 diff)
3587 ;; (message "No change needed!")
3588 (sh-set-var-value var new-val no-symbol)
3589 (message "%s set to %s" var (symbol-value var))
3592 (debug)
3593 (message "Cannot change %s" var)))))))
3597 (defun sh-mark-init (buffer)
3598 "Initialize a BUFFER to be used by `sh-mark-line'."
3599 (with-current-buffer (get-buffer-create buffer)
3600 (erase-buffer)
3601 (occur-mode)))
3604 (defun sh-mark-line (message point buffer &optional add-linenum occur-point)
3605 "Insert MESSAGE referring to location POINT in current buffer into BUFFER.
3606 Buffer BUFFER is in `occur-mode'.
3607 If ADD-LINENUM is non-nil the message is preceded by the line number.
3608 If OCCUR-POINT is non-nil then the line is marked as a new occurrence
3609 so that `occur-next' and `occur-prev' will work."
3610 (let ((m1 (make-marker))
3611 start
3612 (line ""))
3613 (when point
3614 (set-marker m1 point (current-buffer))
3615 (if add-linenum
3616 (setq line (format "%d: " (1+ (count-lines 1 point))))))
3617 (save-excursion
3618 (if (get-buffer buffer)
3619 (set-buffer (get-buffer buffer))
3620 (set-buffer (get-buffer-create buffer))
3621 (occur-mode)
3623 (goto-char (point-max))
3624 (setq start (point))
3625 (let ((inhibit-read-only t))
3626 (insert line)
3627 (if occur-point
3628 (setq occur-point (point)))
3629 (insert message)
3630 (if point
3631 (add-text-properties
3632 start (point)
3633 '(mouse-face highlight
3634 help-echo "mouse-2: go to the line where I learned this")))
3635 (insert "\n")
3636 (when point
3637 (put-text-property start (point) 'occur-target m1)
3638 (if occur-point
3639 (put-text-property start occur-point
3640 'occur-match t))
3641 )))))
3643 ;; Is this really worth having?
3644 (defvar sh-learned-buffer-hook nil
3645 "An abnormal hook, called with an alist of learned variables.")
3646 ;; Example of how to use sh-learned-buffer-hook
3648 ;; (defun what-i-learned (list)
3649 ;; (let ((p list))
3650 ;; (with-current-buffer "*scratch*"
3651 ;; (goto-char (point-max))
3652 ;; (insert "(setq\n")
3653 ;; (while p
3654 ;; (insert (format " %s %s \n"
3655 ;; (nth 0 (car p)) (nth 1 (car p))))
3656 ;; (setq p (cdr p)))
3657 ;; (insert ")\n")
3658 ;; )))
3660 ;; (add-hook 'sh-learned-buffer-hook 'what-i-learned)
3663 ;; Originally this was sh-learn-region-indent (beg end)
3664 ;; However, in practice this was awkward so I changed it to
3665 ;; use the whole buffer. Use narrowing if need be.
3666 (defun sh-learn-buffer-indent (&optional arg)
3667 "Learn how to indent the buffer the way it currently is.
3669 Output in buffer \"*indent*\" shows any lines which have conflicting
3670 values of a variable, and the final value of all variables learned.
3671 When called interactively, pop to this buffer automatically if
3672 there are any discrepancies.
3674 If no prefix ARG is given, then variables are set to numbers.
3675 If a prefix arg is given, then variables are set to symbols when
3676 applicable -- e.g. to symbol `+' if the value is that of the
3677 basic indent.
3678 If a positive numerical prefix is given, then `sh-basic-offset'
3679 is set to the prefix's numerical value.
3680 Otherwise, sh-basic-offset may or may not be changed, according
3681 to the value of variable `sh-learn-basic-offset'.
3683 Abnormal hook `sh-learned-buffer-hook' if non-nil is called when the
3684 function completes. The function is abnormal because it is called
3685 with an alist of variables learned. This feature may be changed or
3686 removed in the future.
3688 This command can often take a long time to run."
3689 (interactive "P")
3690 (sh-must-support-indent)
3691 (if sh-use-smie
3692 (smie-config-guess)
3693 (save-excursion
3694 (goto-char (point-min))
3695 (let ((learned-var-list nil)
3696 (out-buffer "*indent*")
3697 (num-diffs 0)
3698 previous-set-info
3699 (max 17)
3702 (comment-col nil) ;; number if all same, t if seen diff values
3703 (comments-always-default t) ;; nil if we see one not default
3704 initial-msg
3705 (specified-basic-offset (and arg (numberp arg)
3706 (> arg 0)))
3707 (linenum 0)
3708 suggested)
3709 (setq vec (make-vector max 0))
3710 (sh-mark-init out-buffer)
3712 (if specified-basic-offset
3713 (progn
3714 (setq sh-basic-offset arg)
3715 (setq initial-msg
3716 (format "Using specified sh-basic-offset of %d"
3717 sh-basic-offset)))
3718 (setq initial-msg
3719 (format "Initial value of sh-basic-offset: %s"
3720 sh-basic-offset)))
3722 (while (< (point) (point-max))
3723 (setq linenum (1+ linenum))
3724 ;; (if (zerop (% linenum 10))
3725 (message "line %d" linenum)
3726 ;; )
3727 (unless (looking-at "\\s-*$") ;; ignore empty lines!
3728 (let* ((sh-indent-comment t) ;; info must return default indent
3729 (info (sh-get-indent-info))
3730 (var (sh-get-indent-var-for-line info))
3731 sval ival diff new-val
3732 (curr-indent (current-indentation)))
3733 (cond
3734 ((null var)
3735 nil)
3736 ((stringp var)
3737 nil)
3738 ((numberp (setq sval (sh-var-value var 'no-error)))
3739 ;; the numberp excludes comments since sval will be t.
3740 (setq ival (sh-calculate-indent))
3741 (setq diff (- curr-indent ival))
3742 (setq new-val (+ sval diff))
3743 (sh-set-var-value var new-val 'no-symbol)
3744 (unless (looking-at "\\s-*#") ;; don't learn from comments
3745 (if (setq previous-set-info (assoc var learned-var-list))
3746 (progn
3747 ;; it was already there, is it same value ?
3748 (unless (eq (symbol-value var)
3749 (nth 1 previous-set-info))
3750 (sh-mark-line
3751 (format "Variable %s was set to %s"
3752 var (symbol-value var))
3753 (point) out-buffer t t)
3754 (sh-mark-line
3755 (format " but was previously set to %s"
3756 (nth 1 previous-set-info))
3757 (nth 2 previous-set-info) out-buffer t)
3758 (setq num-diffs (1+ num-diffs))
3759 ;; (delete previous-set-info learned-var-list)
3760 (setcdr previous-set-info
3761 (list (symbol-value var) (point)))
3764 (setq learned-var-list
3765 (append (list (list var (symbol-value var)
3766 (point)))
3767 learned-var-list)))
3768 (if (numberp new-val)
3769 (progn
3770 (sh-debug
3771 "This line's indent value: %d" new-val)
3772 (if (< new-val 0)
3773 (setq new-val (- new-val)))
3774 (if (< new-val max)
3775 (aset vec new-val (1+ (aref vec new-val))))))
3777 ((eq var 'sh-indent-comment)
3778 (unless (= curr-indent (sh-calculate-indent info))
3779 ;; this is not the default indentation
3780 (setq comments-always-default nil)
3781 (if comment-col ;; then we have see one before
3782 (or (eq comment-col curr-indent)
3783 (setq comment-col t)) ;; seen a different one
3784 (setq comment-col curr-indent))
3787 (sh-debug "Cannot learn this line!!!")
3789 (sh-debug
3790 "at %s learned-var-list is %s" (point) learned-var-list)
3792 (forward-line 1)
3793 ) ;; while
3794 (if sh-debug
3795 (progn
3796 (setq msg (format
3797 "comment-col = %s comments-always-default = %s"
3798 comment-col comments-always-default))
3799 ;; (message msg)
3800 (sh-mark-line msg nil out-buffer)))
3801 (cond
3802 ((eq comment-col 0)
3803 (setq msg "\nComments are all in 1st column.\n"))
3804 (comments-always-default
3805 (setq msg "\nComments follow default indentation.\n")
3806 (setq comment-col t))
3807 ((numberp comment-col)
3808 (setq msg (format "\nComments are in col %d." comment-col)))
3810 (setq msg "\nComments seem to be mixed, leaving them as is.\n")
3811 (setq comment-col nil)
3813 (sh-debug msg)
3814 (sh-mark-line msg nil out-buffer)
3816 (sh-mark-line initial-msg nil out-buffer t t)
3818 (setq suggested (sh-guess-basic-offset vec))
3820 (if (and suggested (not specified-basic-offset))
3821 (let ((new-value
3822 (cond
3823 ;; t => set it if we have a single value as a number
3824 ((and (eq sh-learn-basic-offset t) (numberp suggested))
3825 suggested)
3826 ;; other non-nil => set it if only one value was found
3827 (sh-learn-basic-offset
3828 (if (numberp suggested)
3829 suggested
3830 (if (= (length suggested) 1)
3831 (car suggested))))
3833 nil))))
3834 (if new-value
3835 (progn
3836 (setq learned-var-list
3837 (append (list (list 'sh-basic-offset
3838 (setq sh-basic-offset new-value)
3839 (point-max)))
3840 learned-var-list))
3841 ;; Not sure if we need to put this line in, since
3842 ;; it will appear in the "Learned variable settings".
3843 (sh-mark-line
3844 (format "Changed sh-basic-offset to: %d" sh-basic-offset)
3845 nil out-buffer))
3846 (sh-mark-line
3847 (if (listp suggested)
3848 (format "Possible value(s) for sh-basic-offset: %s"
3849 (mapconcat 'int-to-string suggested " "))
3850 (format "Suggested sh-basic-offset: %d" suggested))
3851 nil out-buffer))))
3854 (setq learned-var-list
3855 (append (list (list 'sh-indent-comment comment-col (point-max)))
3856 learned-var-list))
3857 (setq sh-indent-comment comment-col)
3858 (let ((name (buffer-name)))
3859 (sh-mark-line "\nLearned variable settings:" nil out-buffer)
3860 (if arg
3861 ;; Set learned variables to symbolic rather than numeric
3862 ;; values where possible.
3863 (dolist (learned-var (reverse learned-var-list))
3864 (let ((var (car learned-var))
3865 (val (nth 1 learned-var)))
3866 (when (and (not (eq var 'sh-basic-offset))
3867 (numberp val))
3868 (sh-set-var-value var val)))))
3869 (dolist (learned-var (reverse learned-var-list))
3870 (let ((var (car learned-var)))
3871 (sh-mark-line (format " %s %s" var (symbol-value var))
3872 (nth 2 learned-var) out-buffer)))
3873 (with-current-buffer out-buffer
3874 (goto-char (point-min))
3875 (let ((inhibit-read-only t))
3876 (insert
3877 (format "Indentation values for buffer %s.\n" name)
3878 (format "%d indentation variable%s different values%s\n\n"
3879 num-diffs
3880 (if (= num-diffs 1)
3881 " has" "s have")
3882 (if (zerop num-diffs)
3883 "." ":"))))))
3884 ;; Are abnormal hooks considered bad form?
3885 (run-hook-with-args 'sh-learned-buffer-hook learned-var-list)
3886 (and (called-interactively-p 'any)
3887 (or sh-popup-occur-buffer (> num-diffs 0))
3888 (pop-to-buffer out-buffer))))))
3890 (defun sh-guess-basic-offset (vec)
3891 "See if we can determine a reasonable value for `sh-basic-offset'.
3892 This is experimental, heuristic and arbitrary!
3893 Argument VEC is a vector of information collected by
3894 `sh-learn-buffer-indent'.
3895 Return values:
3896 number - there appears to be a good single value
3897 list of numbers - no obvious one, here is a list of one or more
3898 reasonable choices
3899 nil - we couldn't find a reasonable one."
3900 (let* ((max (1- (length vec)))
3901 (i 1)
3902 (totals (make-vector max 0)))
3903 (while (< i max)
3904 (cl-incf (aref totals i) (* 4 (aref vec i)))
3905 (if (zerop (% i 2))
3906 (cl-incf (aref totals i) (aref vec (/ i 2))))
3907 (if (< (* i 2) max)
3908 (cl-incf (aref totals i) (aref vec (* i 2))))
3909 (setq i (1+ i)))
3911 (let ((x nil)
3912 (result nil)
3913 tot sum p)
3914 (setq i 1)
3915 (while (< i max)
3916 (if (/= (aref totals i) 0)
3917 (push (cons i (aref totals i)) x))
3918 (setq i (1+ i)))
3920 (setq x (sort (nreverse x) (lambda (a b) (> (cdr a) (cdr b)))))
3921 (setq tot (apply '+ (append totals nil)))
3922 (sh-debug (format "vec: %s\ntotals: %s\ntot: %d"
3923 vec totals tot))
3924 (cond
3925 ((zerop (length x))
3926 (message "no values!")) ;; we return nil
3927 ((= (length x) 1)
3928 (message "only value is %d" (car (car x)))
3929 (setq result (car (car x)))) ;; return single value
3930 ((> (cdr (car x)) (/ tot 2))
3931 ;; 1st is > 50%
3932 (message "basic-offset is probably %d" (car (car x)))
3933 (setq result (car (car x)))) ;; again, return a single value
3934 ((>= (cdr (car x)) (* 2 (cdr (car (cdr x)))))
3935 ;; 1st is >= 2 * 2nd
3936 (message "basic-offset could be %d" (car (car x)))
3937 (setq result (car (car x))))
3938 ((>= (+ (cdr (car x))(cdr (car (cdr x)))) (/ tot 2))
3939 ;; 1st & 2nd together >= 50% - return a list
3940 (setq p x sum 0 result nil)
3941 (while (and p
3942 (<= (setq sum (+ sum (cdr (car p)))) (/ tot 2)))
3943 (setq result (append result (list (car (car p)))))
3944 (setq p (cdr p)))
3945 (message "Possible choices for sh-basic-offset: %s"
3946 (mapconcat 'int-to-string result " ")))
3948 (message "No obvious value for sh-basic-offset. Perhaps %d"
3949 (car (car x)))
3950 ;; result is nil here
3952 result)))
3954 ;; ========================================================================
3956 ;; Styles -- a quick and dirty way of saving the indentation settings.
3958 (defvar sh-styles-alist nil
3959 "A list of all known shell indentation styles.")
3961 (defun sh-name-style (name &optional confirm-overwrite)
3962 "Name the current indentation settings as a style called NAME.
3963 If this name exists, the command will prompt whether it should be
3964 overwritten if
3965 - - it was called interactively with a prefix argument, or
3966 - - called non-interactively with optional CONFIRM-OVERWRITE non-nil."
3967 ;; (interactive "sName for this style: ")
3968 (interactive
3969 (list
3970 (read-from-minibuffer "Name for this style? " )
3971 (not current-prefix-arg)))
3972 (let ((slist (cons name
3973 (mapcar (lambda (var) (cons var (symbol-value var)))
3974 sh-var-list)))
3975 (style (assoc name sh-styles-alist)))
3976 (if style
3977 (if (and confirm-overwrite
3978 (not (y-or-n-p "This style exists. Overwrite it? ")))
3979 (message "Not changing style %s" name)
3980 (message "Updating style %s" name)
3981 (setcdr style (cdr slist)))
3982 (message "Creating new style %s" name)
3983 (push slist sh-styles-alist))))
3985 (defun sh-load-style (name)
3986 "Set shell indentation values for this buffer from those in style NAME."
3987 (interactive (list (completing-read
3988 "Which style to use for this buffer? "
3989 sh-styles-alist nil t)))
3990 (let ((sl (assoc name sh-styles-alist)))
3991 (if (null sl)
3992 (error "sh-load-style - style %s not known" name)
3993 (dolist (var (cdr sl))
3994 (set (car var) (cdr var))))))
3996 (defun sh-save-styles-to-buffer (buff)
3997 "Save all current styles in elisp to buffer BUFF.
3998 This is always added to the end of the buffer."
3999 (interactive
4000 (list
4001 (read-from-minibuffer "Buffer to save styles in? " "*scratch*")))
4002 (with-current-buffer (get-buffer-create buff)
4003 (goto-char (point-max))
4004 (insert "\n")
4005 (pp `(setq sh-styles-alist ',sh-styles-alist) (current-buffer))))
4009 ;; statement syntax-commands for various shells
4011 ;; You are welcome to add the syntax or even completely new statements as
4012 ;; appropriate for your favorite shell.
4014 (defconst sh-non-closing-paren
4015 ;; If we leave it rear-sticky, calling `newline' ends up inserting a \n
4016 ;; that inherits this property, which then confuses the indentation.
4017 (propertize ")" 'syntax-table sh-st-punc 'rear-nonsticky t))
4019 (define-skeleton sh-case
4020 "Insert a case/switch statement. See `sh-feature'."
4021 (csh "expression: "
4022 "switch( " str " )" \n
4023 > "case " (read-string "pattern: ") ?: \n
4024 > _ \n
4025 "breaksw" \n
4026 ( "other pattern, %s: "
4027 < "case " str ?: \n
4028 > _ \n
4029 "breaksw" \n)
4030 < "default:" \n
4031 > _ \n
4032 resume:
4033 < < "endsw" \n)
4034 (es)
4035 (rc "expression: "
4036 > "switch( " str " ) {" \n
4037 > "case " (read-string "pattern: ") \n
4038 > _ \n
4039 ( "other pattern, %s: "
4040 "case " str > \n
4041 > _ \n)
4042 "case *" > \n
4043 > _ \n
4044 resume:
4045 ?\} > \n)
4046 (sh "expression: "
4047 > "case " str " in" \n
4048 ( "pattern, %s: "
4049 > str sh-non-closing-paren \n
4050 > _ \n
4051 ";;" \n)
4052 > "*" sh-non-closing-paren \n
4053 > _ \n
4054 resume:
4055 "esac" > \n))
4057 (define-skeleton sh-for
4058 "Insert a for loop. See `sh-feature'."
4059 (csh sh-modify sh
4060 1 ""
4061 2 "foreach "
4062 4 " ( "
4063 6 " )"
4064 15 '<
4065 16 "end")
4066 (es sh-modify rc
4067 4 " = ")
4068 (rc sh-modify sh
4069 2 "for( "
4070 6 " ) {"
4071 15 ?\} )
4072 (sh "Index variable: "
4073 > "for " str " in " _ "; do" \n
4074 > _ | ?$ & (sh-remember-variable str) \n
4075 "done" > \n))
4079 (define-skeleton sh-indexed-loop
4080 "Insert an indexed loop from 1 to n. See `sh-feature'."
4081 (bash sh-modify posix)
4082 (csh "Index variable: "
4083 "@ " str " = 1" \n
4084 "while( $" str " <= " (read-string "upper limit: ") " )" \n
4085 > _ ?$ str \n
4086 "@ " str "++" \n
4087 < "end" \n)
4088 (es sh-modify rc
4089 4 " =")
4090 (ksh88 "Index variable: "
4091 > "integer " str "=0" \n
4092 > "while (( ( " str " += 1 ) <= "
4093 (read-string "upper limit: ")
4094 " )); do" \n
4095 > _ ?$ (sh-remember-variable str) > \n
4096 "done" > \n)
4097 (posix "Index variable: "
4098 > str "=1" \n
4099 "while [ $" str " -le "
4100 (read-string "upper limit: ")
4101 " ]; do" \n
4102 > _ ?$ str \n
4103 str ?= (sh-add (sh-remember-variable str) 1) \n
4104 "done" > \n)
4105 (rc "Index variable: "
4106 > "for( " str " in" " `{awk 'BEGIN { for( i=1; i<="
4107 (read-string "upper limit: ")
4108 "; i++ ) print i }'`}) {" \n
4109 > _ ?$ (sh-remember-variable str) \n
4110 ?\} > \n)
4111 (sh "Index variable: "
4112 > "for " str " in `awk 'BEGIN { for( i=1; i<="
4113 (read-string "upper limit: ")
4114 "; i++ ) print i }'`; do" \n
4115 > _ ?$ (sh-remember-variable str) \n
4116 "done" > \n))
4119 (defun sh-shell-initialize-variables ()
4120 "Scan the buffer for variable assignments.
4121 Add these variables to `sh-shell-variables'."
4122 (message "Scanning buffer `%s' for variable assignments..." (buffer-name))
4123 (save-excursion
4124 (goto-char (point-min))
4125 (setq sh-shell-variables-initialized t)
4126 (while (search-forward "=" nil t)
4127 (sh-assignment 0)))
4128 (message "Scanning buffer `%s' for variable assignments...done"
4129 (buffer-name)))
4131 (defvar sh-add-buffer)
4133 (defun sh-add-completer (string predicate code)
4134 "Do completion using `sh-shell-variables', but initialize it first.
4135 This function is designed for use as the \"completion table\",
4136 so it takes three arguments: