1 ;;; sh-script.el --- shell-script editing commands for Emacs
3 ;; Copyright (C) 1993-1997, 1999, 2001-2012 Free Software Foundation, Inc.
5 ;; Author: Daniel Pfeiffer <occitan@esperanto.org>
8 ;; Keywords: languages, unix
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; Major mode for editing shell scripts. Bourne, C and rc shells as well
28 ;; as various derivatives are supported and easily derived from. Structured
29 ;; statements can be inserted with one command or abbrev. Completion is
30 ;; available for filenames, variables known from the script, the shell and
31 ;; the environment as well as commands.
35 ;; - In Bourne the keyword `in' is not anchored to case, for, select ...
36 ;; - Variables in `"' strings aren't fontified because there's no way of
37 ;; syntactically distinguishing those from `'' strings.
41 ;; Indentation for rc and es modes is very limited, but for Bourne shells
42 ;; and its derivatives it is quite customizable.
44 ;; The following description applies to sh and derived shells (bash,
47 ;; There are various customization variables which allow tailoring to
48 ;; a wide variety of styles. Most of these variables are named
49 ;; sh-indent-for-XXX and sh-indent-after-XXX. For example.
50 ;; sh-indent-after-if controls the indenting of a line following
51 ;; an if statement, and sh-indent-for-fi controls the indentation
52 ;; of the line containing the fi.
54 ;; You can set each to a numeric value, but it is often more convenient
55 ;; to a symbol such as `+' which uses the value of variable `sh-basic-offset'.
56 ;; By changing this one variable you can increase or decrease how much
57 ;; indentation there is. Valid symbols:
59 ;; + Indent right by sh-basic-offset
60 ;; - Indent left by sh-basic-offset
61 ;; ++ Indent right twice sh-basic-offset
62 ;; -- Indent left twice sh-basic-offset
63 ;; * Indent right half sh-basic-offset
64 ;; / Indent left half sh-basic-offset.
66 ;; There are 4 commands to help set the indentation variables:
69 ;; This shows what variable controls the indentation of the current
70 ;; line and its value.
73 ;; This allows you to set the value of the variable controlling the
74 ;; current line's indentation. You can enter a number or one of a
75 ;; number of special symbols to denote the value of sh-basic-offset,
76 ;; or its negative, or half it, or twice it, etc. If you've used
77 ;; cc-mode this should be familiar. If you forget which symbols are
78 ;; valid simply press C-h at the prompt.
80 ;; `sh-learn-line-indent'
81 ;; Simply make the line look the way you want it, then invoke this
82 ;; command. It will set the variable to the value that makes the line
83 ;; indent like that. If called with a prefix argument then it will set
84 ;; the value to one of the symbols if applicable.
86 ;; `sh-learn-buffer-indent'
87 ;; This is the deluxe function! It "learns" the whole buffer (use
88 ;; narrowing if you want it to process only part). It outputs to a
89 ;; buffer *indent* any conflicts it finds, and all the variables it has
90 ;; learned. This buffer is a sort of Occur mode buffer, allowing you to
91 ;; easily find where something was set. It is popped to automatically
92 ;; if there are any conflicts found or if `sh-popup-occur-buffer' is
94 ;; `sh-indent-comment' will be set if all comments follow the same
95 ;; pattern; if they don't it will be set to nil.
96 ;; Whether `sh-basic-offset' is set is determined by variable
97 ;; `sh-learn-basic-offset'.
99 ;; Unfortunately, `sh-learn-buffer-indent' can take a long time to run
100 ;; (e.g. if there are large case statements). Perhaps it does not make
101 ;; sense to run it on large buffers: if lots of lines have different
102 ;; indentation styles it will produce a lot of diagnostics in the
103 ;; *indent* buffer; if there is a consistent style then running
104 ;; `sh-learn-buffer-indent' on a small region of the buffer should
107 ;; Saving indentation values
108 ;; -------------------------
109 ;; After you've learned the values in a buffer, how to you remember
110 ;; them? Originally I had hoped that `sh-learn-buffer-indent'
111 ;; would make this unnecessary; simply learn the values when you visit
113 ;; You can do this automatically like this:
114 ;; (add-hook 'sh-set-shell-hook 'sh-learn-buffer-indent)
116 ;; However... `sh-learn-buffer-indent' is extremely slow,
117 ;; especially on large-ish buffer. Also, if there are conflicts the
118 ;; "last one wins" which may not produce the desired setting.
120 ;; So...There is a minimal way of being able to save indentation values and
121 ;; to reload them in another buffer or at another point in time.
123 ;; Use `sh-name-style' to give a name to the indentation settings of
124 ;; the current buffer.
125 ;; Use `sh-load-style' to load indentation settings for the current
126 ;; buffer from a specific style.
127 ;; Use `sh-save-styles-to-buffer' to write all the styles to a buffer
128 ;; in lisp code. You can then store it in a file and later use
129 ;; `load-file' to load it.
131 ;; Indentation variables - buffer local or global?
132 ;; ----------------------------------------------
133 ;; I think that often having them buffer-local makes sense,
134 ;; especially if one is using `sh-learn-buffer-indent'. However, if
135 ;; a user sets values using customization, these changes won't appear
136 ;; to work if the variables are already local!
138 ;; To get round this, there is a variable `sh-make-vars-local' and 2
139 ;; functions: `sh-make-vars-local' and `sh-reset-indent-vars-to-global-values'.
141 ;; If `sh-make-vars-local' is non-nil, then these variables become
142 ;; buffer local when the mode is established.
143 ;; If this is nil, then the variables are global. At any time you
144 ;; can make them local with the command `sh-make-vars-local'.
145 ;; Conversely, to update with the global values you can use the
146 ;; command `sh-reset-indent-vars-to-global-values'.
148 ;; This may be awkward, but the intent is to cover all cases.
150 ;; Awkward things, pitfalls
151 ;; ------------------------
152 ;; Indentation for a sh script is complicated for a number of reasons:
154 ;; 1. You can't format by simply looking at symbols, you need to look
155 ;; at keywords. [This is not the case for rc and es shells.]
156 ;; 2. The character ")" is used both as a matched pair "(" ... ")" and
157 ;; as a stand-alone symbol (in a case alternative). This makes
158 ;; things quite tricky!
159 ;; 3. Here-documents in a script should be treated "as is", and when
160 ;; they terminate we want to revert to the indentation of the line
161 ;; containing the "<<" symbol.
162 ;; 4. A line may be continued using the "\".
163 ;; 5. The character "#" (outside a string) normally starts a comment,
164 ;; but it doesn't in the sequence "$#"!
166 ;; To try and address points 2 3 and 5 I used a feature that cperl mode
167 ;; uses, that of a text's syntax property. This, however, has 2
169 ;; 1. We need to scan the buffer to find which ")" symbols belong to a
170 ;; case alternative, to find any here documents, and handle "$#".
174 ;; - Indenting many lines is slow. It currently does each line
175 ;; independently, rather than saving state information.
177 ;; - `sh-learn-buffer-indent' is extremely slow.
179 ;; - "case $x in y) echo ;; esac)" the last ) is mis-identified as being
180 ;; part of a case-pattern. You need to add a semi-colon after "esac" to
181 ;; coerce sh-script into doing the right thing.
183 ;; - "echo $z in ps | head)" the last ) is mis-identified as being part of
184 ;; a case-pattern. You need to put the "in" between quotes to coerce
185 ;; sh-script into doing the right thing.
187 ;; - A line starting with "}>foo" is not indented like "} >foo".
189 ;; Richard Sharman <rsharman@pobox.com> June 1999.
193 ;; page 1: variables and settings
194 ;; page 2: indentation stuff
195 ;; page 3: mode-command and utility functions
196 ;; page 4: statement syntax-commands for various shells
197 ;; page 5: various other commands
203 (require 'executable
)
205 (autoload 'comint-completion-at-point
"comint")
206 (autoload 'comint-filename-completion
"comint")
207 (autoload 'shell-command-completion
"shell")
208 (autoload 'shell-environment-variable-completion
"shell")
210 (defvar font-lock-comment-face
)
211 (defvar font-lock-set-defaults
)
212 (defvar font-lock-string-face
)
216 "Shell programming utilities."
219 (defgroup sh-script nil
221 :link
'(custom-group-link :tag
"Font Lock Faces group" font-lock-faces
)
226 (defcustom sh-ancestor-alist
245 "Alist showing the direct ancestor of various shells.
246 This is the basis for `sh-feature'. See also `sh-alias-alist'.
247 By default we have the following three hierarchies:
250 jcsh C Shell with Job Control
252 itcsh Ian's TENEX C Shell
257 jsh Bourne Shell with Job Control
258 bash GNU Bourne Again Shell
261 dtksh CDE Desktop Korn Shell
262 pdksh Public Domain Korn Shell
263 wksh Window Korn Shell
265 oash SCO OA (curses) Shell
266 posix IEEE 1003.2 Shell Standard
268 :type
'(repeat (cons symbol symbol
))
272 (defcustom sh-alias-alist
273 (append (if (eq system-type
'gnu
/linux
)
276 ;; for the time being
280 "Alist for transforming shell names to what they really are.
281 Use this where the name of the executable doesn't correspond to the type of
283 :type
'(repeat (cons symbol symbol
))
287 (defcustom sh-shell-file
289 ;; On MSDOS and Windows, collapse $SHELL to lower-case and remove
290 ;; the executable extension, so comparisons with the list of
291 ;; known shells work.
292 (and (memq system-type
'(ms-dos windows-nt
))
293 (let* ((shell (getenv "SHELL"))
295 (and shell
(file-name-nondirectory shell
))))
296 ;; shell-script mode doesn't support DOS/Windows shells,
297 ;; so use the default instead.
299 (member (downcase shell-base
)
300 '("command.com" "cmd.exe" "4dos.com" "ndos.com"
303 (file-name-sans-extension (downcase shell
)))))
306 "The executable file name for the shell being programmed."
311 (defcustom sh-shell-arg
312 ;; bash does not need any options when run in a shell script,
316 ;; Bill_Mann@praxisint.com says -p with ksh can do harm.
318 ;; -p means don't initialize functions from the environment.
320 ;; Someone proposed -motif, but we don't want to encourage
321 ;; use of a non-free widget set.
323 ;; -f means don't run .zshrc.
325 "Single argument string for the magic number. See `sh-feature'."
326 :type
'(repeat (cons (symbol :tag
"Shell")
327 (choice (const :tag
"No Arguments" nil
)
328 (string :tag
"Arguments")
329 (sexp :format
"Evaluate: %v"))))
332 (defcustom sh-imenu-generic-expression
337 "^\\s-*function\\s-+\\\([[:alpha:]_][[:alnum:]_]+\\)\\s-*\\(?:()\\)?"
341 "^\\s-*\\([[:alpha:]_][[:alnum:]_]+\\)\\s-*()"
344 "Alist of regular expressions for recognizing shell function definitions.
345 See `sh-feature' and `imenu-generic-expression'."
346 :type
'(alist :key-type
(symbol :tag
"Shell")
347 :value-type
(alist :key-type
(choice :tag
"Title"
349 (const :tag
"None" nil
))
351 (repeat :tag
"Regexp, index..." sexp
)))
355 (defvar sh-shell-variables nil
356 "Alist of shell variable names that should be included in completion.
357 These are used for completion in addition to all the variables named
358 in `process-environment'. Each element looks like (VAR . VAR), where
359 the car and cdr are the same symbol.")
361 (defvar sh-shell-variables-initialized nil
362 "Non-nil if `sh-shell-variables' is initialized.")
364 (defun sh-canonicalize-shell (shell)
365 "Convert a shell name SHELL to the one we should handle it as."
366 (if (string-match "\\.exe\\'" shell
)
367 (setq shell
(substring shell
0 (match-beginning 0))))
369 (setq shell
(intern shell
)))
370 (or (cdr (assq shell sh-alias-alist
))
373 (defvar sh-shell
(sh-canonicalize-shell (file-name-nondirectory sh-shell-file
))
374 "The shell being programmed. This is set by \\[sh-set-shell].")
375 ;;;###autoload(put 'sh-shell 'safe-local-variable 'symbolp)
377 (define-abbrev-table 'sh-mode-abbrev-table
())
380 ;; I turned off this feature because it doesn't permit typing commands
381 ;; in the usual way without help.
383 ;; '((csh sh-abbrevs shell
385 ;; "getopts" 'sh-while-getopts)
387 ;; (es sh-abbrevs shell
388 ;; "function" 'sh-function)
390 ;; (ksh88 sh-abbrevs sh
391 ;; "select" 'sh-select)
393 ;; (rc sh-abbrevs shell
395 ;; "function" 'sh-function)
397 ;; (sh sh-abbrevs shell
399 ;; "function" 'sh-function
401 ;; "getopts" 'sh-while-getopts)
403 ;; ;; The next entry is only used for defining the others
404 ;; (shell "for" sh-for
405 ;; "loop" sh-indexed-loop
407 ;; "tmpfile" sh-tmp-file
410 ;; (zsh sh-abbrevs ksh88
411 ;; "repeat" 'sh-repeat))
412 ;; "Abbrev-table used in Shell-Script mode. See `sh-feature'.
413 ;;;Due to the internal workings of abbrev tables, the shell name symbol is
414 ;;;actually defined as the table for the like of \\[edit-abbrevs].")
418 (defun sh-mode-syntax-table (table &rest list
)
419 "Copy TABLE and set syntax for successive CHARs according to strings S."
420 (setq table
(copy-syntax-table table
))
422 (modify-syntax-entry (pop list
) (pop list
) table
))
425 (defvar sh-mode-syntax-table
426 (sh-mode-syntax-table ()
432 ;; ?$ might also have a ". p" syntax. Both "'" and ". p" seem
433 ;; to work fine. This is needed so that dabbrev-expand
446 "The syntax table to use for Shell-Script mode.
447 This is buffer-local in every such buffer.")
449 (defvar sh-mode-syntax-table-input
451 "Syntax-table used in Shell-Script mode. See `sh-feature'.")
454 (let ((map (make-sparse-keymap))
455 (menu-map (make-sparse-keymap)))
456 (define-key map
"\C-c(" 'sh-function
)
457 (define-key map
"\C-c\C-w" 'sh-while
)
458 (define-key map
"\C-c\C-u" 'sh-until
)
459 (define-key map
"\C-c\C-t" 'sh-tmp-file
)
460 (define-key map
"\C-c\C-s" 'sh-select
)
461 (define-key map
"\C-c\C-r" 'sh-repeat
)
462 (define-key map
"\C-c\C-o" 'sh-while-getopts
)
463 (define-key map
"\C-c\C-l" 'sh-indexed-loop
)
464 (define-key map
"\C-c\C-i" 'sh-if
)
465 (define-key map
"\C-c\C-f" 'sh-for
)
466 (define-key map
"\C-c\C-c" 'sh-case
)
467 (define-key map
"\C-c?" 'sh-show-indent
)
468 (define-key map
"\C-c=" 'sh-set-indent
)
469 (define-key map
"\C-c<" 'sh-learn-line-indent
)
470 (define-key map
"\C-c>" 'sh-learn-buffer-indent
)
471 (define-key map
"\C-c\C-\\" 'sh-backslash-region
)
473 (define-key map
"=" 'sh-assignment
)
474 (define-key map
"\C-c+" 'sh-add
)
475 (define-key map
"\C-\M-x" 'sh-execute-region
)
476 (define-key map
"\C-c\C-x" 'executable-interpret
)
478 (define-key map
[remap delete-backward-char
]
479 'backward-delete-char-untabify
)
480 (define-key map
"\C-c:" 'sh-set-shell
)
481 (define-key map
[remap backward-sentence
] 'sh-beginning-of-command
)
482 (define-key map
[remap forward-sentence
] 'sh-end-of-command
)
483 (define-key map
[menu-bar sh-script
] (cons "Sh-Script" menu-map
))
484 (define-key menu-map
[sh-learn-buffer-indent
]
485 '(menu-item "Learn buffer indentation" sh-learn-buffer-indent
486 :help
"Learn how to indent the buffer the way it currently is."))
487 (define-key menu-map
[sh-learn-line-indent
]
488 '(menu-item "Learn line indentation" sh-learn-line-indent
489 :help
"Learn how to indent a line as it currently is indented"))
490 (define-key menu-map
[sh-show-indent
]
491 '(menu-item "Show indentation" sh-show-indent
492 :help
"Show the how the current line would be indented"))
493 (define-key menu-map
[sh-set-indent
]
494 '(menu-item "Set indentation" sh-set-indent
495 :help
"Set the indentation for the current line"))
497 (define-key menu-map
[sh-pair
]
498 '(menu-item "Insert braces and quotes in pairs"
500 :button
(:toggle .
(bound-and-true-p electric-pair-mode
))
501 :help
"Inserting a brace or quote automatically inserts the matching pair"))
503 (define-key menu-map
[sh-s0
] '("--"))
505 (define-key menu-map
[sh-function
]
506 '(menu-item "Function..." sh-function
507 :help
"Insert a function definition"))
508 (define-key menu-map
[sh-add
]
509 '(menu-item "Addition..." sh-add
510 :help
"Insert an addition of VAR and prefix DELTA for Bourne (type) shell"))
511 (define-key menu-map
[sh-until
]
512 '(menu-item "Until Loop" sh-until
513 :help
"Insert an until loop"))
514 (define-key menu-map
[sh-repeat
]
515 '(menu-item "Repeat Loop" sh-repeat
516 :help
"Insert a repeat loop definition"))
517 (define-key menu-map
[sh-while
]
518 '(menu-item "While Loop" sh-while
519 :help
"Insert a while loop"))
520 (define-key menu-map
[sh-getopts
]
521 '(menu-item "Options Loop" sh-while-getopts
522 :help
"Insert a while getopts loop."))
523 (define-key menu-map
[sh-indexed-loop
]
524 '(menu-item "Indexed Loop" sh-indexed-loop
525 :help
"Insert an indexed loop from 1 to n."))
526 (define-key menu-map
[sh-select
]
527 '(menu-item "Select Statement" sh-select
528 :help
"Insert a select statement "))
529 (define-key menu-map
[sh-if
]
530 '(menu-item "If Statement" sh-if
531 :help
"Insert an if statement"))
532 (define-key menu-map
[sh-for
]
533 '(menu-item "For Loop" sh-for
534 :help
"Insert a for loop"))
535 (define-key menu-map
[sh-case
]
536 '(menu-item "Case Statement" sh-case
537 :help
"Insert a case/switch statement"))
538 (define-key menu-map
[sh-s1
] '("--"))
539 (define-key menu-map
[sh-exec
]
540 '(menu-item "Execute region" sh-execute-region
541 :help
"Pass optional header and region to a subshell for noninteractive execution"))
542 (define-key menu-map
[sh-exec-interpret
]
543 '(menu-item "Execute script..." executable-interpret
544 :help
"Run script with user-specified args, and collect output in a buffer"))
545 (define-key menu-map
[sh-set-shell
]
546 '(menu-item "Set shell type..." sh-set-shell
547 :help
"Set this buffer's shell to SHELL (a string)"))
548 (define-key menu-map
[sh-backslash-region
]
549 '(menu-item "Backslash region" sh-backslash-region
550 :help
"Insert, align, or delete end-of-line backslashes on the lines in the region."))
552 "Keymap used in Shell-Script mode.")
554 (defvar sh-skeleton-pair-default-alist
'((?
( _ ?
)) (?\
))
555 (?
[ ?\s _ ?\s ?
]) (?\
])
557 "Value to use for `skeleton-pair-default-alist' in Shell-Script mode.")
559 (defcustom sh-dynamic-complete-functions
560 '(shell-environment-variable-completion
561 shell-command-completion
562 comint-filename-completion
)
563 "Functions for doing TAB dynamic completion."
564 :type
'(repeat function
)
567 (defcustom sh-assignment-regexp
568 `((csh .
"\\<\\([[:alnum:]_]+\\)\\(\\[.+\\]\\)?[ \t]*[-+*/%^]?=")
569 ;; actually spaces are only supported in let/(( ... ))
570 (ksh88 .
,(concat "\\<\\([[:alnum:]_]+\\)\\(\\[.+\\]\\)?"
571 "[ \t]*\\(?:[-+*/%&|~^]\\|<<\\|>>\\)?="))
572 (bash .
"\\<\\([[:alnum:]_]+\\)\\(\\[.+\\]\\)?\\+?=")
573 (rc .
"\\<\\([[:alnum:]_*]+\\)[ \t]*=")
574 (sh .
"\\<\\([[:alnum:]_]+\\)="))
575 "Regexp for the variable name and what may follow in an assignment.
576 First grouping matches the variable name. This is upto and including the `='
577 sign. See `sh-feature'."
578 :type
'(repeat (cons (symbol :tag
"Shell")
580 (sexp :format
"Evaluate: %v"))))
584 (defcustom sh-indentation
4
585 "The width for further indentation in Shell-Script mode."
588 (put 'sh-indentation
'safe-local-variable
'integerp
)
590 (defcustom sh-remember-variable-min
3
591 "Don't remember variables less than this length for completing reads."
596 (defvar sh-header-marker nil
597 "When non-nil is the end of header for prepending by \\[sh-execute-region].
598 That command is also used for setting this variable.")
599 (make-variable-buffer-local 'sh-header-marker
)
601 (defcustom sh-beginning-of-command
602 "\\([;({`|&]\\|\\`\\|[^\\]\n\\)[ \t]*\\([/~[:alnum:]:]\\)"
603 "Regexp to determine the beginning of a shell command.
604 The actual command starts at the beginning of the second \\(grouping\\)."
609 (defcustom sh-end-of-command
610 "\\([/~[:alnum:]:]\\)[ \t]*\\([;#)}`|&]\\|$\\)"
611 "Regexp to determine the end of a shell command.
612 The actual command ends at the end of the first \\(grouping\\)."
618 (defcustom sh-here-document-word
"EOF"
619 "Word to delimit here documents.
620 If the first character of this string is \"-\", this is taken as
621 part of the redirection operator, rather than part of the
622 word (that is, \"<<-\" instead of \"<<\"). This is a feature
623 used by some shells (for example Bash) to indicate that leading
624 tabs inside the here document should be ignored. In this case,
625 Emacs indents the initial body and end of the here document with
626 tabs, to the same level as the start (note that apart from this
627 there is no support for indentation of here documents). This
628 will only work correctly if `sh-basic-offset' is a multiple of
631 Any quote characters or leading whitespace in the word are
632 removed when closing the here document."
640 "Initial input in Bourne if, while and until skeletons. See `sh-feature'.")
643 ;; customized this out of sheer bravado. not for the faint of heart.
644 ;; but it *did* have an asterisk in the docstring!
645 (defcustom sh-builtins
646 '((bash sh-append posix
647 "." "alias" "bg" "bind" "builtin" "caller" "compgen" "complete"
648 "declare" "dirs" "disown" "enable" "fc" "fg" "help" "history"
649 "jobs" "kill" "let" "local" "popd" "printf" "pushd" "shopt"
650 "source" "suspend" "typeset" "unalias")
652 ;; The next entry is only used for defining the others
653 (bourne sh-append shell
654 "eval" "export" "getopts" "newgrp" "pwd" "read" "readonly"
658 "alias" "chdir" "glob" "history" "limit" "nice" "nohup" "rehash"
659 "setenv" "source" "time" "unalias" "unhash")
661 (dtksh sh-append wksh
)
663 (es "access" "apids" "cd" "echo" "eval" "false" "let" "limit" "local"
664 "newpgrp" "result" "time" "umask" "var" "vars" "wait" "whatis")
667 "bg" "fg" "jobs" "kill" "stop" "suspend")
670 "bg" "fg" "jobs" "kill" "notify" "stop" "suspend")
672 (ksh88 sh-append bourne
673 "alias" "bg" "false" "fc" "fg" "jobs" "kill" "let" "print" "time"
674 "typeset" "unalias" "whence")
677 "checkwin" "dateline" "error" "form" "menu" "newwin" "oadeinit"
678 "oaed" "oahelp" "oainit" "pp" "ppfile" "scan" "scrollok" "wattr"
679 "wclear" "werase" "win" "wmclose" "wmmessage" "wmopen" "wmove"
680 "wmtitle" "wrefresh")
682 (pdksh sh-append ksh88
688 (rc "builtin" "cd" "echo" "eval" "limit" "newpgrp" "shift" "umask" "wait"
692 "hash" "test" "type")
694 ;; The next entry is only used for defining the others
695 (shell "cd" "echo" "eval" "set" "shift" "umask" "unset" "wait")
697 (wksh sh-append ksh88
698 ;; FIXME: This looks too much like a regexp. --Stef
702 "autoload" "bindkey" "builtin" "chdir" "compctl" "declare" "dirs"
703 "disable" "disown" "echotc" "enable" "functions" "getln" "hash"
704 "history" "integer" "limit" "local" "log" "popd" "pushd" "r"
705 "readonly" "rehash" "sched" "setopt" "source" "suspend" "true"
706 "ttyctl" "type" "unfunction" "unhash" "unlimit" "unsetopt" "vared"
708 "List of all shell builtins for completing read and fontification.
709 Note that on some systems not all builtins are available or some are
710 implemented as aliases. See `sh-feature'."
711 :type
'(repeat (cons (symbol :tag
"Shell")
712 (choice (repeat string
)
713 (sexp :format
"Evaluate: %v"))))
718 (defcustom sh-leading-keywords
724 (es "true" "unwind-protect" "whatis")
728 (sh "!" "do" "elif" "else" "if" "then" "trap" "type" "until" "while"))
729 "List of keywords that may be immediately followed by a builtin or keyword.
730 Given some confusion between keywords and builtins depending on shell and
731 system, the distinction here has been based on whether they influence the
732 flow of control or syntax. See `sh-feature'."
733 :type
'(repeat (cons (symbol :tag
"Shell")
734 (choice (repeat string
)
735 (sexp :format
"Evaluate: %v"))))
739 (defcustom sh-other-keywords
740 '((bash sh-append bourne
741 "bye" "logout" "select")
743 ;; The next entry is only used for defining the others
748 "breaksw" "default" "end" "endif" "endsw" "foreach" "goto"
749 "if" "logout" "onintr" "repeat" "switch" "then" "while")
751 (es "break" "catch" "exec" "exit" "fn" "for" "forever" "fork" "if"
752 "return" "throw" "while")
754 (ksh88 sh-append bourne
757 (rc "break" "case" "exec" "exit" "fn" "for" "if" "in" "return" "switch"
761 "done" "esac" "fi" "for" "in" "return")
763 ;; The next entry is only used for defining the others
764 (shell "break" "case" "continue" "exec" "exit")
768 "List of keywords not in `sh-leading-keywords'.
770 :type
'(repeat (cons (symbol :tag
"Shell")
771 (choice (repeat string
)
772 (sexp :format
"Evaluate: %v"))))
779 "allow_null_glob_expansion" "auto_resume" "BASH" "BASH_ENV"
780 "BASH_VERSINFO" "BASH_VERSION" "cdable_vars" "COMP_CWORD"
781 "COMP_LINE" "COMP_POINT" "COMP_WORDS" "COMPREPLY" "DIRSTACK"
782 "ENV" "EUID" "FCEDIT" "FIGNORE" "FUNCNAME"
783 "glob_dot_filenames" "GLOBIGNORE" "GROUPS" "histchars"
784 "HISTCMD" "HISTCONTROL" "HISTFILE" "HISTFILESIZE"
785 "HISTIGNORE" "history_control" "HISTSIZE"
786 "hostname_completion_file" "HOSTFILE" "HOSTTYPE" "IGNOREEOF"
787 "ignoreeof" "INPUTRC" "LINENO" "MACHTYPE" "MAIL_WARNING"
788 "noclobber" "nolinks" "notify" "no_exit_on_failed_exec"
789 "NO_PROMPT_VARS" "OLDPWD" "OPTERR" "OSTYPE" "PIPESTATUS"
790 "PPID" "POSIXLY_CORRECT" "PROMPT_COMMAND" "PS3" "PS4"
791 "pushd_silent" "PWD" "RANDOM" "REPLY" "SECONDS" "SHELLOPTS"
792 "SHLVL" "TIMEFORMAT" "TMOUT" "UID")
795 "argv" "cdpath" "child" "echo" "histchars" "history" "home"
796 "ignoreeof" "mail" "noclobber" "noglob" "nonomatch" "path" "prompt"
797 "shell" "status" "time" "verbose")
800 "apid" "cdpath" "CDPATH" "history" "home" "ifs" "noexport" "path"
801 "pid" "prompt" "signals")
807 "ENV" "ERRNO" "FCEDIT" "FPATH" "HISTFILE" "HISTSIZE" "LINENO"
808 "OLDPWD" "PPID" "PS3" "PS4" "PWD" "RANDOM" "REPLY" "SECONDS"
812 "FIELD" "FIELD_MAX" "LAST_KEY" "OALIB" "PP_ITEM" "PP_NUM")
815 "apid" "apids" "cdpath" "CDPATH" "history" "home" "ifs" "path" "pid"
819 "CDPATH" "IFS" "OPTARG" "OPTIND" "PS1" "PS2")
821 ;; The next entry is only used for defining the others
822 (shell "COLUMNS" "EDITOR" "HOME" "HUSHLOGIN" "LANG" "LC_COLLATE"
823 "LC_CTYPE" "LC_MESSAGES" "LC_MONETARY" "LC_NUMERIC" "LC_TIME"
824 "LINES" "LOGNAME" "MAIL" "MAILCHECK" "MAILPATH" "PAGER" "PATH"
825 "SHELL" "TERM" "TERMCAP" "TERMINFO" "VISUAL")
828 "addsuffix" "ampm" "autocorrect" "autoexpand" "autolist"
829 "autologout" "chase_symlinks" "correct" "dextract" "edit" "el"
830 "fignore" "gid" "histlit" "HOST" "HOSTTYPE" "HPATH"
831 "ignore_symlinks" "listjobs" "listlinks" "listmax" "matchbeep"
832 "nobeep" "NOREBIND" "oid" "printexitvalue" "prompt2" "prompt3"
833 "pushdsilent" "pushdtohome" "recexact" "recognize_only_executables"
834 "rmstar" "savehist" "SHLVL" "showdots" "sl" "SYSTYPE" "tcsh" "term"
835 "tperiod" "tty" "uid" "version" "visiblebell" "watch" "who"
839 "BAUD" "bindcmds" "cdpath" "DIRSTACKSIZE" "fignore" "FIGNORE" "fpath"
840 "HISTCHARS" "hostcmds" "hosts" "HOSTS" "LISTMAX" "LITHISTSIZE"
841 "LOGCHECK" "mailpath" "manpath" "NULLCMD" "optcmds" "path" "POSTEDIT"
842 "prompt" "PROMPT" "PROMPT2" "PROMPT3" "PROMPT4" "psvar" "PSVAR"
843 "READNULLCMD" "REPORTTIME" "RPROMPT" "RPS1" "SAVEHIST" "SPROMPT"
844 "STTY" "TIMEFMT" "TMOUT" "TMPPREFIX" "varcmds" "watch" "WATCH"
845 "WATCHFMT" "WORDCHARS" "ZDOTDIR"))
846 "List of all shell variables available for completing read.
853 '((((min-colors 88) (class color
)
855 (:foreground
"yellow1" :weight bold
))
858 (:foreground
"yellow" :weight bold
))
861 (:foreground
"tan1" ))
864 "Face to show a here-document"
865 :group
'sh-indentation
)
867 ;; These colors are probably icky. It's just a placeholder though.
868 (defface sh-quoted-exec
869 '((((class color
) (background dark
))
870 (:foreground
"salmon"))
871 (((class color
) (background light
))
872 (:foreground
"magenta"))
875 "Face to show quoted execs like ``"
876 :group
'sh-indentation
)
877 (define-obsolete-face-alias 'sh-heredoc-face
'sh-heredoc
"22.1")
878 (defvar sh-heredoc-face
'sh-heredoc
)
880 (defface sh-escaped-newline
'((t :inherit font-lock-string-face
))
881 "Face used for (non-escaped) backslash at end of a line in Shell-script mode."
885 (defvar sh-font-lock-keywords-var
886 '((csh sh-append shell
887 ("\\${?[#?]?\\([[:alpha:]_][[:alnum:]_]*\\|0\\)" 1
888 font-lock-variable-name-face
))
890 (es sh-append executable-font-lock-keywords
891 ("\\$#?\\([[:alpha:]_][[:alnum:]_]*\\|[0-9]+\\)" 1
892 font-lock-variable-name-face
))
895 (bash sh-append sh
("\\$(\\(\\sw+\\)" (1 'sh-quoted-exec t
) ))
898 ("\\$\\({#?\\)?\\([[:alpha:]_][[:alnum:]_]*\\|[-#?@!]\\)" 2
899 font-lock-variable-name-face
)
901 ("^\\(\\sw+\\)[ \t]*(" 1 font-lock-function-name-face
)
902 ("\\<\\(function\\)\\>[ \t]*\\(\\sw+\\)?"
903 (1 font-lock-keyword-face
) (2 font-lock-function-name-face nil t
))
904 ("\\(?:^\\s *\\|[[();&|]\\s *\\|\\(?:\\s +-[ao]\\|if\\|else\\|then\\|while\\|do\\)\\s +\\)\\(!\\)"
905 1 font-lock-negation-char-face
))
907 ;; The next entry is only used for defining the others
909 ;; Using font-lock-string-face here confuses sh-get-indent-info.
910 ("\\(^\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\\\)$" 3 'sh-escaped-newline
)
911 ("\\\\[^[:alnum:]]" 0 font-lock-string-face
)
912 ("\\${?\\([[:alpha:]_][[:alnum:]_]*\\|[0-9]+\\|[$*_]\\)" 1
913 font-lock-variable-name-face
))
915 ("%{?\\(\\sw+\\)" 1 font-lock-keyword-face
))
916 (rpm2 sh-append shell
917 ("^\\(\\sw+\\):" 1 font-lock-variable-name-face
)))
918 "Default expressions to highlight in Shell Script modes. See `sh-feature'.")
920 (defvar sh-font-lock-keywords-var-1
922 "Subdued level highlighting for Shell Script modes.")
924 (defvar sh-font-lock-keywords-var-2
()
925 "Gaudy level highlighting for Shell Script modes.")
927 ;; These are used for the syntax table stuff (derived from cperl-mode).
928 ;; Note: parse-sexp-lookup-properties must be set to t for it to work.
929 (defconst sh-st-punc
(string-to-syntax "."))
930 (defconst sh-here-doc-syntax
(string-to-syntax "|")) ;; generic string
933 (defconst sh-escaped-line-re
934 ;; Should match until the real end-of-continued-line, but if that is not
935 ;; possible (because we bump into EOB or the search bound), then we should
936 ;; match until the search bound.
937 "\\(?:\\(?:.*[^\\\n]\\)?\\(?:\\\\\\\\\\)*\\\\\n\\)*.*")
939 (defconst sh-here-doc-open-re
940 (concat "<<-?\\s-*\\\\?\\(\\(?:['\"][^'\"]+['\"]\\|\\sw\\|[-/~._]\\)+\\)"
941 sh-escaped-line-re
"\\(\n\\)")))
943 (defun sh--inside-noncommand-expression (pos)
945 (let ((ppss (syntax-ppss pos
)))
947 (goto-char (nth 1 ppss
))
949 ;; $((...)) or $[...] or ${...}.
950 (`?\
( (and (eq ?\
( (char-before))
951 (eq ?\$
(char-before (1- (point))))))
952 ((or `?\
{ `?\
[) (eq ?\$
(char-before))))))))
954 (defun sh-font-lock-open-heredoc (start string eol
)
955 "Determine the syntax of the \\n after a <<EOF.
956 START is the position of <<.
957 STRING is the actual word used as delimiter (e.g. \"EOF\").
958 INDENTED is non-nil if the here document's content (and the EOF mark) can
959 be indented (i.e. a <<- was used rather than just <<).
960 Point is at the beginning of the next line."
961 (unless (or (memq (char-before start
) '(?
< ?
>))
962 (sh-in-comment-or-string start
)
963 (sh--inside-noncommand-expression start
))
964 ;; We're looking at <<STRING, so we add "^STRING$" to the syntactic
965 ;; font-lock keywords to detect the end of this here document.
966 (let ((str (replace-regexp-in-string "['\"]" "" string
))
967 (ppss (save-excursion (syntax-ppss eol
))))
969 ;; The \n not only starts the heredoc but also closes a comment.
970 ;; Let's close the comment just before the \n.
971 (put-text-property (1- eol
) eol
'syntax-table
'(12))) ;">"
972 (if (or (nth 5 ppss
) (> (count-lines start eol
) 1))
973 ;; If the sh-escaped-line-re part of sh-here-doc-open-re has matched
974 ;; several lines, make sure we refontify them together.
975 ;; Furthermore, if (nth 5 ppss) is non-nil (i.e. the \n is
976 ;; escaped), it means the right \n is actually further down.
977 ;; Don't bother fixing it now, but place a multiline property so
978 ;; that when jit-lock-context-* refontifies the rest of the
979 ;; buffer, it also refontifies the current line with it.
980 (put-text-property start
(1+ eol
) 'syntax-multiline t
))
981 (put-text-property eol
(1+ eol
) 'sh-here-doc-marker str
)
982 (prog1 sh-here-doc-syntax
983 (goto-char (+ 2 start
))))))
985 (defun sh-syntax-propertize-here-doc (end)
986 (let ((ppss (syntax-ppss)))
987 (when (eq t
(nth 3 ppss
))
988 (let ((key (get-text-property (nth 8 ppss
) 'sh-here-doc-marker
))
989 (case-fold-search nil
))
990 (when (re-search-forward
991 (concat "^\\([ \t]*\\)" (regexp-quote key
) "\\(\n\\)")
993 (let ((eol (match-beginning 2)))
994 (put-text-property eol
(1+ eol
)
995 'syntax-table sh-here-doc-syntax
)))))))
997 (defun sh-font-lock-quoted-subshell (limit)
998 "Search for a subshell embedded in a string.
999 Find all the unescaped \" characters within said subshell, remembering that
1000 subshells can nest."
1001 ;; FIXME: This can (and often does) match multiple lines, yet it makes no
1002 ;; effort to handle multiline cases correctly, so it ends up being
1004 (when (eq ?
\" (nth 3 (syntax-ppss))) ; Check we matched an opening quote.
1005 ;; bingo we have a $( or a ` inside a ""
1006 (let (;; `state' can be: double-quote, backquote, code.
1007 (state (if (eq (char-before) ?
`) 'backquote
'code
))
1008 ;; Stacked states in the context.
1009 (states '(double-quote)))
1010 (while (and state
(progn (skip-chars-forward "^'\\\\\"`$()" limit
)
1012 ;; unescape " inside a $( ... ) construct.
1016 (_ (forward-char 1) (skip-chars-forward "^'" limit
))))
1017 (?
\\ (forward-char 1))
1019 (`double-quote
(setq state
(pop states
)))
1020 (_ (push state states
) (setq state
'double-quote
)))
1021 (if state
(put-text-property (point) (1+ (point))
1022 'syntax-table
'(1))))
1024 (`backquote
(setq state
(pop states
)))
1025 (_ (push state states
) (setq state
'backquote
))))
1026 (?\$
(if (not (eq (char-after (1+ (point))) ?\
())
1030 (_ (push state states
) (setq state
'code
)))))
1033 (_ (push state states
) (setq state
'code
))))
1036 (_ (setq state
(pop states
)))))
1037 (_ (error "Internal error in sh-font-lock-quoted-subshell")))
1038 (forward-char 1)))))
1041 (defun sh-is-quoted-p (pos)
1042 (and (eq (char-before pos
) ?
\\)
1043 (not (sh-is-quoted-p (1- pos
)))))
1045 (defun sh-font-lock-paren (start)
1046 (unless (nth 8 (syntax-ppss))
1050 ;; Skip through all patterns
1055 (forward-comment (- (point-max)))
1056 (when (and (eolp) (sh-is-quoted-p (point)))
1059 ;; Skip through one pattern
1061 (or (/= 0 (skip-syntax-backward "w_"))
1062 (/= 0 (skip-chars-backward "-$=?[]*@/\\\\"))
1063 (and (sh-is-quoted-p (1- (point)))
1064 (goto-char (- (point) 2)))
1065 (when (memq (char-before) '(?
\" ?
\' ?\
}))
1066 (condition-case nil
(progn (backward-sexp 1) t
)
1068 ;; Patterns can be preceded by an open-paren (bug#1320).
1069 (when (eq (char-before (point)) ?\
()
1071 (setq open
(point)))
1073 (forward-comment (- (point-max)))
1074 ;; Maybe we've bumped into an escaped newline.
1075 (sh-is-quoted-p (point)))
1077 (when (eq (char-before) ?|
)
1078 (backward-char 1) t
)))
1079 (and (> (point) (1+ (point-min)))
1080 (progn (backward-char 2)
1081 (if (> start
(line-end-position))
1082 (put-text-property (point) (1+ start
)
1083 'syntax-multiline t
))
1084 ;; FIXME: The `in' may just be a random argument to
1085 ;; a normal command rather than the real `in' keyword.
1086 ;; I.e. we should look back to try and find the
1087 ;; corresponding `case'.
1088 (and (looking-at ";[;&]\\|\\_<in")
1089 ;; ";; esac )" is a case that looks
1090 ;; like a case-pattern but it's really just a close
1091 ;; paren after a case statement. I.e. if we skipped
1092 ;; over `esac' just now, we're not looking
1093 ;; at a case-pattern.
1094 (not (looking-at "..[ \t\n]+esac[^[:word:]_]"))))
1097 (put-text-property open
(1+ open
) 'syntax-table sh-st-punc
))
1100 (defun sh-font-lock-backslash-quote ()
1101 (if (eq (save-excursion (nth 3 (syntax-ppss (match-beginning 0)))) ?
\')
1102 ;; In a '...' the backslash is not escaping.
1106 (defun sh-syntax-propertize-function (start end
)
1108 (sh-syntax-propertize-here-doc end
)
1110 (syntax-propertize-rules
1111 (sh-here-doc-open-re
1112 (2 (sh-font-lock-open-heredoc
1113 (match-beginning 0) (match-string 1) (match-beginning 2))))
1114 ("\\s|" (0 (prog1 nil
(sh-syntax-propertize-here-doc end
))))
1115 ;; A `#' begins a comment when it is unquoted and at the
1116 ;; beginning of a word. In the shell, words are separated by
1117 ;; metacharacters. The list of special chars is taken from
1118 ;; the single-unix spec of the shell command language (under
1119 ;; `quoting') but with `$' removed.
1120 ("\\(?:[^|&;<>()`\\\"' \t\n]\\|\\${\\)\\(#+\\)" (1 "_"))
1121 ;; In a '...' the backslash is not escaping.
1122 ("\\(\\\\\\)'" (1 (sh-font-lock-backslash-quote)))
1123 ;; Make sure $@ and $? are correctly recognized as sexps.
1124 ("\\$\\([?@]\\)" (1 "_"))
1125 ;; Distinguish the special close-paren in `case'.
1126 (")" (0 (sh-font-lock-paren (match-beginning 0))))
1127 ;; Highlight (possibly nested) subshells inside "" quoted
1128 ;; regions correctly.
1129 ("\"\\(?:\\(?:[^\\\"]\\|\\\\.\\)*?\\)??\\(\\$(\\|`\\)"
1131 (if (nth 8 (save-excursion (syntax-ppss (match-beginning 0))))
1132 (goto-char (1+ (match-beginning 0)))
1133 ;; Save excursion because we want to also apply other
1134 ;; syntax-propertize rules within the affected region.
1136 (sh-font-lock-quoted-subshell end
)))))))
1138 (defun sh-font-lock-syntactic-face-function (state)
1139 (let ((q (nth 3 state
)))
1142 (if (eq q ?\
`) 'sh-quoted-exec font-lock-string-face
)
1144 font-lock-comment-face
)))
1146 (defgroup sh-indentation nil
1147 "Variables controlling indentation in shell scripts.
1149 Note: customizing these variables will not affect existing buffers if
1150 `sh-make-vars-local' is non-nil. See the documentation for
1151 variable `sh-make-vars-local', command `sh-make-vars-local'
1152 and command `sh-reset-indent-vars-to-global-values'."
1156 (defcustom sh-set-shell-hook nil
1157 "Hook run by `sh-set-shell'."
1161 (defcustom sh-mode-hook nil
1162 "Hook run by `sh-mode'."
1166 (defcustom sh-learn-basic-offset nil
1167 "When `sh-guess-basic-offset' should learn `sh-basic-offset'.
1170 t means: only if there seems to be an obvious value.
1171 Anything else means: whenever we have a \"good guess\" as to the value."
1173 (const :tag
"Never" nil
)
1174 (const :tag
"Only if sure" t
)
1175 (const :tag
"If have a good guess" usually
))
1176 :group
'sh-indentation
)
1178 (defcustom sh-popup-occur-buffer nil
1179 "Controls when `sh-learn-buffer-indent' pops the `*indent*' buffer.
1180 If t it is always shown. If nil, it is shown only when there
1183 (const :tag
"Only when there are conflicts." nil
)
1184 (const :tag
"Always" t
))
1185 :group
'sh-indentation
)
1187 (defcustom sh-blink t
1188 "If non-nil, `sh-show-indent' shows the line indentation is relative to.
1189 The position on the line is not necessarily meaningful.
1190 In some cases the line will be the matching keyword, but this is not
1193 :group
'sh-indentation
)
1195 (defcustom sh-first-lines-indent
0
1196 "The indentation of the first non-blank non-comment line.
1197 Usually 0 meaning first column.
1198 Can be set to a number, or to nil which means leave it as is."
1200 (const :tag
"Leave as is" nil
)
1201 (integer :tag
"Column number"
1202 :menu-tag
"Indent to this col (0 means first col)" ))
1203 :group
'sh-indentation
)
1206 (defcustom sh-basic-offset
4
1207 "The default indentation increment.
1208 This value is used for the `+' and `-' symbols in an indentation variable."
1210 :group
'sh-indentation
)
1211 (put 'sh-basic-offset
'safe-local-variable
'integerp
)
1213 (defcustom sh-indent-comment t
1214 "How a comment line is to be indented.
1215 nil means leave it as it is;
1216 t means indent it as a normal line, aligning it to previous non-blank
1218 a number means align to that column, e.g. 0 means first column."
1220 (const :tag
"Leave as is." nil
)
1221 (const :tag
"Indent as a normal line." t
)
1222 (integer :menu-tag
"Indent to this col (0 means first col)."
1223 :tag
"Indent to column number.") )
1225 :group
'sh-indentation
)
1228 (defvar sh-debug nil
1229 "Enable lots of debug messages - if function `sh-debug' is enabled.")
1232 ;; Uncomment this defun and comment the defmacro for debugging.
1233 ;; (defun sh-debug (&rest args)
1234 ;; "For debugging: display message ARGS if variable SH-DEBUG is non-nil."
1236 ;; (apply 'message args)))
1237 (defmacro sh-debug
(&rest _args
))
1239 (defconst sh-symbol-list
1240 '((const :tag
"+ " :value
+
1241 :menu-tag
"+ Indent right by sh-basic-offset")
1242 (const :tag
"- " :value -
1243 :menu-tag
"- Indent left by sh-basic-offset")
1244 (const :tag
"++" :value
++
1245 :menu-tag
"++ Indent right twice sh-basic-offset")
1246 (const :tag
"--" :value --
1247 :menu-tag
"-- Indent left twice sh-basic-offset")
1248 (const :tag
"* " :value
*
1249 :menu-tag
"* Indent right half sh-basic-offset")
1250 (const :tag
"/ " :value
/
1251 :menu-tag
"/ Indent left half sh-basic-offset")))
1253 (defcustom sh-indent-for-else
0
1254 "How much to indent an `else' relative to its `if'. Usually 0."
1256 (integer :menu-tag
"A number (positive=>indent right)"
1258 (const :tag
"--") ;; separator!
1261 :group
'sh-indentation
)
1263 (defconst sh-number-or-symbol-list
1264 (append '((integer :menu-tag
"A number (positive=>indent right)"
1266 (const :tag
"--")) ; separator
1269 (defcustom sh-indent-for-fi
0
1270 "How much to indent a `fi' relative to its `if'. Usually 0."
1271 :type
`(choice ,@ sh-number-or-symbol-list
)
1272 :group
'sh-indentation
)
1274 (defcustom sh-indent-for-done
0
1275 "How much to indent a `done' relative to its matching stmt. Usually 0."
1276 :type
`(choice ,@ sh-number-or-symbol-list
)
1277 :group
'sh-indentation
)
1279 (defcustom sh-indent-after-else
'+
1280 "How much to indent a statement after an `else' statement."
1281 :type
`(choice ,@ sh-number-or-symbol-list
)
1282 :group
'sh-indentation
)
1284 (defcustom sh-indent-after-if
'+
1285 "How much to indent a statement after an `if' statement.
1286 This includes lines after `else' and `elif' statements, too, but
1287 does not affect the `else', `elif' or `fi' statements themselves."
1288 :type
`(choice ,@ sh-number-or-symbol-list
)
1289 :group
'sh-indentation
)
1291 (defcustom sh-indent-for-then
0
1292 "How much to indent a `then' relative to its `if'."
1293 :type
`(choice ,@ sh-number-or-symbol-list
)
1294 :group
'sh-indentation
)
1296 (defcustom sh-indent-for-do
0
1297 "How much to indent a `do' statement.
1298 This is relative to the statement before the `do', typically a
1299 `while', `until', `for', `repeat' or `select' statement."
1300 :type
`(choice ,@ sh-number-or-symbol-list
)
1301 :group
'sh-indentation
)
1303 (defcustom sh-indent-after-do
'+
1304 "How much to indent a line after a `do' statement.
1305 This is used when the `do' is the first word of the line.
1306 This is relative to the statement before the `do', typically a
1307 `while', `until', `for', `repeat' or `select' statement."
1308 :type
`(choice ,@ sh-number-or-symbol-list
)
1309 :group
'sh-indentation
)
1311 (defcustom sh-indent-after-loop-construct
'+
1312 "How much to indent a statement after a loop construct.
1314 This variable is used when the keyword `do' is on the same line as the
1315 loop statement (e.g., `until', `while' or `for').
1316 If the `do' is on a line by itself, then `sh-indent-after-do' is used instead."
1317 :type
`(choice ,@ sh-number-or-symbol-list
)
1318 :group
'sh-indentation
)
1321 (defcustom sh-indent-after-done
0
1322 "How much to indent a statement after a `done' keyword.
1323 Normally this is 0, which aligns the `done' to the matching
1324 looping construct line.
1325 Setting it non-zero allows you to have the `do' statement on a line
1326 by itself and align the done under to do."
1327 :type
`(choice ,@ sh-number-or-symbol-list
)
1328 :group
'sh-indentation
)
1330 (defcustom sh-indent-for-case-label
'+
1331 "How much to indent a case label statement.
1332 This is relative to the line containing the `case' statement."
1333 :type
`(choice ,@ sh-number-or-symbol-list
)
1334 :group
'sh-indentation
)
1336 (defcustom sh-indent-for-case-alt
'++
1337 "How much to indent statements after the case label.
1338 This is relative to the line containing the `case' statement."
1339 :type
`(choice ,@ sh-number-or-symbol-list
)
1340 :group
'sh-indentation
)
1343 (defcustom sh-indent-for-continuation
'+
1344 "How much to indent for a continuation statement."
1345 :type
`(choice ,@ sh-number-or-symbol-list
)
1346 :group
'sh-indentation
)
1348 (defcustom sh-indent-after-open
'+
1349 "How much to indent after a line with an opening parenthesis or brace.
1350 For an open paren after a function, `sh-indent-after-function' is used."
1351 :type
`(choice ,@ sh-number-or-symbol-list
)
1352 :group
'sh-indentation
)
1354 (defcustom sh-indent-after-function
'+
1355 "How much to indent after a function line."
1356 :type
`(choice ,@ sh-number-or-symbol-list
)
1357 :group
'sh-indentation
)
1359 ;; These 2 are for the rc shell:
1361 (defcustom sh-indent-after-switch
'+
1362 "How much to indent a `case' statement relative to the `switch' statement.
1363 This is for the rc shell."
1364 :type
`(choice ,@ sh-number-or-symbol-list
)
1365 :group
'sh-indentation
)
1367 (defcustom sh-indent-after-case
'+
1368 "How much to indent a statement relative to the `case' statement.
1369 This is for the rc shell."
1370 :type
`(choice ,@ sh-number-or-symbol-list
)
1371 :group
'sh-indentation
)
1373 (defcustom sh-backslash-column
48
1374 "Column in which `sh-backslash-region' inserts backslashes."
1378 (defcustom sh-backslash-align t
1379 "If non-nil, `sh-backslash-region' will align backslashes."
1383 ;; Internal use - not designed to be changed by the user:
1385 (defun sh-mkword-regexpr (word)
1386 "Make a regexp which matches WORD as a word.
1387 This specifically excludes an occurrence of WORD followed by
1388 punctuation characters like '-'."
1389 (concat word
"\\([^-[:alnum:]_]\\|$\\)"))
1391 (defconst sh-re-done
(sh-mkword-regexpr "done"))
1394 (defconst sh-kws-for-done
1395 '((sh .
( "while" "until" "for" ) )
1396 (bash .
( "while" "until" "for" "select" ) )
1397 (ksh88 .
( "while" "until" "for" "select" ) )
1398 (zsh .
( "while" "until" "for" "repeat" "select" ) ) )
1399 "Which keywords can match the word `done' in this shell.")
1402 (defconst sh-indent-supported
1406 "Indentation rule set to use for each shell type.")
1408 (defvar sh-indent-supported-here nil
1409 "Non-nil if we support indentation for the current buffer's shell type.")
1411 (defconst sh-var-list
1413 sh-basic-offset sh-first-lines-indent sh-indent-after-case
1414 sh-indent-after-do sh-indent-after-done
1415 sh-indent-after-else
1417 sh-indent-after-loop-construct
1418 sh-indent-after-open
1420 sh-indent-for-case-alt
1421 sh-indent-for-case-label
1422 sh-indent-for-continuation
1429 "A list of variables used by script mode to control indentation.
1430 This list is used when switching between buffer-local and global
1431 values of variables, and for the commands using indentation styles.")
1433 (defvar sh-make-vars-local t
1434 "Controls whether indentation variables are local to the buffer.
1435 If non-nil, indentation variables are made local initially.
1436 If nil, you can later make the variables local by invoking
1437 command `sh-make-vars-local'.
1438 The default is t because I assume that in one Emacs session one is
1439 frequently editing existing scripts with different styles.")
1442 ;; mode-command and utility functions
1445 (define-derived-mode sh-mode prog-mode
"Shell-script"
1446 "Major mode for editing shell scripts.
1447 This mode works for many shells, since they all have roughly the same syntax,
1448 as far as commands, arguments, variables, pipes, comments etc. are concerned.
1449 Unless the file's magic number indicates the shell, your usual shell is
1450 assumed. Since filenames rarely give a clue, they are not further analyzed.
1452 This mode adapts to the variations between shells (see `sh-set-shell') by
1453 means of an inheritance based feature lookup (see `sh-feature'). This
1454 mechanism applies to all variables (including skeletons) that pertain to
1455 shell-specific features.
1457 The default style of this mode is that of Rosenblatt's Korn shell book.
1458 The syntax of the statements varies with the shell being used. The
1459 following commands are available, based on the current shell's syntax:
1461 \\[sh-case] case statement
1463 \\[sh-function] function definition
1464 \\[sh-if] if statement
1465 \\[sh-indexed-loop] indexed loop from 1 to n
1466 \\[sh-while-getopts] while getopts loop
1467 \\[sh-repeat] repeat loop
1468 \\[sh-select] select loop
1469 \\[sh-until] until loop
1470 \\[sh-while] while loop
1472 For sh and rc shells indentation commands are:
1473 \\[sh-show-indent] Show the variable controlling this line's indentation.
1474 \\[sh-set-indent] Set then variable controlling this line's indentation.
1475 \\[sh-learn-line-indent] Change the indentation variable so this line
1476 would indent to the way it currently is.
1477 \\[sh-learn-buffer-indent] Set the indentation variables so the
1478 buffer indents as it currently is indented.
1481 \\[backward-delete-char-untabify] Delete backward one position, even if it was a tab.
1482 \\[newline-and-indent] Delete unquoted space and indent new line same as this one.
1483 \\[sh-end-of-command] Go to end of successive commands.
1484 \\[sh-beginning-of-command] Go to beginning of successive commands.
1485 \\[sh-set-shell] Set this buffer's shell, and maybe its magic number.
1486 \\[sh-execute-region] Have optional header and region be executed in a subshell.
1488 `sh-electric-here-document-mode' controls whether insertion of two
1489 unquoted < insert a here document.
1491 If you generally program a shell different from your login shell you can
1492 set `sh-shell-file' accordingly. If your shell's file name doesn't correctly
1493 indicate what shell it is use `sh-alias-alist' to translate.
1495 If your shell gives error messages with line numbers, you can use \\[executable-interpret]
1496 with your script for an edit-interpret-debug cycle."
1497 (make-local-variable 'sh-shell-file
)
1498 (make-local-variable 'sh-shell
)
1500 (set (make-local-variable 'skeleton-pair-default-alist
)
1501 sh-skeleton-pair-default-alist
)
1502 (set (make-local-variable 'skeleton-end-hook
)
1503 (lambda () (or (eolp) (newline) (indent-relative))))
1505 (set (make-local-variable 'paragraph-start
) (concat page-delimiter
"\\|$"))
1506 (set (make-local-variable 'paragraph-separate
) paragraph-start
)
1507 (set (make-local-variable 'comment-start
) "# ")
1508 (set (make-local-variable 'comment-start-skip
) "#+[\t ]*")
1509 (set (make-local-variable 'local-abbrev-table
) sh-mode-abbrev-table
)
1510 (set (make-local-variable 'comint-dynamic-complete-functions
)
1511 sh-dynamic-complete-functions
)
1512 (add-hook 'completion-at-point-functions
'comint-completion-at-point nil t
)
1513 ;; we can't look if previous line ended with `\'
1514 (set (make-local-variable 'comint-prompt-regexp
) "^[ \t]*")
1515 (set (make-local-variable 'imenu-case-fold-search
) nil
)
1516 (set (make-local-variable 'font-lock-defaults
)
1517 `((sh-font-lock-keywords
1518 sh-font-lock-keywords-1 sh-font-lock-keywords-2
)
1520 ((?
/ .
"w") (?~ .
"w") (?. .
"w") (?- .
"w") (?_ .
"w")) nil
1521 (font-lock-syntactic-face-function
1522 . sh-font-lock-syntactic-face-function
)))
1523 (set (make-local-variable 'syntax-propertize-function
)
1524 #'sh-syntax-propertize-function
)
1525 (add-hook 'syntax-propertize-extend-region-functions
1526 #'syntax-propertize-multiline
'append
'local
)
1527 (sh-electric-here-document-mode 1)
1528 (set (make-local-variable 'skeleton-pair-alist
) '((?
` _ ?
`)))
1529 (set (make-local-variable 'skeleton-pair-filter-function
) 'sh-quoted-p
)
1530 (set (make-local-variable 'skeleton-further-elements
)
1531 '((< '(- (min sh-indentation
(current-column))))))
1532 (set (make-local-variable 'skeleton-filter-function
) 'sh-feature
)
1533 (set (make-local-variable 'skeleton-newline-indent-rigidly
) t
)
1534 (set (make-local-variable 'defun-prompt-regexp
)
1535 (concat "^\\(function[ \t]\\|[[:alnum:]]+[ \t]+()[ \t]+\\)"))
1536 ;; Parse or insert magic number for exec, and set all variables depending
1537 ;; on the shell thus determined.
1539 (cond ((save-excursion
1540 (goto-char (point-min))
1541 (looking-at "#![ \t]?\\([^ \t\n]*/bin/env[ \t]\\)?\\([^ \t\n]+\\)"))
1543 ((not buffer-file-name
) sh-shell-file
)
1544 ;; Checks that use `buffer-file-name' follow.
1545 ((string-match "\\.m?spec\\'" buffer-file-name
) "rpm")
1546 ((string-match "[.]sh\\>" buffer-file-name
) "sh")
1547 ((string-match "[.]bash\\>" buffer-file-name
) "bash")
1548 ((string-match "[.]ksh\\>" buffer-file-name
) "ksh")
1549 ((string-match "[.]csh\\>" buffer-file-name
) "csh")
1550 ((equal (file-name-nondirectory buffer-file-name
) ".profile") "sh")
1555 (defalias 'shell-script-mode
'sh-mode
)
1558 (defun sh-font-lock-keywords (&optional keywords
)
1559 "Function to get simple fontification based on `sh-font-lock-keywords'.
1560 This adds rules for comments and assignments."
1561 (sh-feature sh-font-lock-keywords-var
1562 (when (stringp (sh-feature sh-assignment-regexp
))
1564 `((,(sh-feature sh-assignment-regexp
)
1565 1 font-lock-variable-name-face
)
1568 ,@executable-font-lock-keywords
)))))
1570 (defun sh-font-lock-keywords-1 (&optional builtins
)
1571 "Function to get better fontification including keywords."
1572 (let ((keywords (concat "\\([;(){}`|&]\\|^\\)[ \t]*\\(\\("
1573 (regexp-opt (sh-feature sh-leading-keywords
) t
)
1575 (regexp-opt (append (sh-feature sh-leading-keywords
)
1576 (sh-feature sh-other-keywords
))
1578 (sh-font-lock-keywords
1580 `((,(concat keywords
"[ \t]+\\)?"
1581 (regexp-opt (sh-feature sh-builtins
) t
)
1583 (2 font-lock-keyword-face nil t
)
1584 (6 font-lock-builtin-face
))
1585 ,@(sh-feature sh-font-lock-keywords-var-2
)))
1586 (,(concat keywords
"\\)\\>")
1587 2 font-lock-keyword-face
)
1588 ,@(sh-feature sh-font-lock-keywords-var-1
)))))
1590 (defun sh-font-lock-keywords-2 ()
1591 "Function to get better fontification including keywords and builtins."
1592 (sh-font-lock-keywords-1 t
))
1594 ;;; Indentation and navigation with SMIE.
1598 ;; The SMIE code should generally be preferred, but it currently does not obey
1599 ;; the various indentation custom-vars, and it misses some important features
1600 ;; of the old code, mostly: sh-learn-line/buffer-indent, sh-show-indent,
1601 ;; sh-name/save/load-style.
1602 (defvar sh-use-smie nil
1603 "Whether to use the SMIE code for navigation and indentation.")
1605 (defun sh-smie--keyword-p (tok)
1606 "Non-nil if TOK (at which we're looking) really is a keyword."
1607 (let ((prev (funcall smie-backward-token-function
)))
1608 (if (zerop (length prev
))
1609 (looking-back "\\s(" (1- (point)))
1610 (assoc prev smie-grammar
))))
1612 (defun sh-smie--newline-semi-p (&optional tok
)
1613 "Return non-nil if a newline should be treated as a semi-colon.
1614 Here we assume that a newline should be treated as a semi-colon unless it
1615 comes right after a special keyword.
1616 This function does not pay attention to line-continuations.
1617 If TOK is nil, point should be before the newline; otherwise, TOK is the token
1618 before the newline and in that case point should be just before the token."
1621 (setq tok
(funcall smie-backward-token-function
)))
1622 (if (and (zerop (length tok
))
1623 (looking-back "\\s(" (1- (point))))
1625 (not (numberp (nth 2 (assoc tok smie-grammar
)))))))
1627 ;;;; SMIE support for `sh'.
1629 (defconst sh-smie-sh-grammar
1630 (smie-prec2->grammar
1632 '((exp) ;A constant, or a $var, or a sequence of them...
1633 (cmd ("case" exp
"in" branches
"esac")
1634 ("if" cmd
"then" cmd
"fi")
1635 ("if" cmd
"then" cmd
"else" cmd
"fi")
1636 ("if" cmd
"then" cmd
"elif" cmd
"then" cmd
"fi")
1637 ("if" cmd
"then" cmd
"elif" cmd
"then" cmd
"else" cmd
"fi")
1638 ("if" cmd
"then" cmd
"elif" cmd
"then" cmd
1639 "elif" cmd
"then" cmd
"else" cmd
"fi")
1640 ("while" cmd
"do" cmd
"done")
1641 ("until" cmd
"do" cmd
"done")
1642 ("for" exp
"in" cmd
"do" cmd
"done")
1643 ("for" exp
"do" cmd
"done")
1644 ("select" exp
"in" cmd
"do" cmd
"done") ;bash&zsh&ksh88.
1645 ("repeat" exp
"do" cmd
"done") ;zsh.
1646 (exp "always" exp
) ;zsh.
1647 (cmd "|" cmd
) (cmd "|&" cmd
)
1648 (cmd "&&" cmd
) (cmd "||" cmd
)
1649 (cmd ";" cmd
) (cmd "&" cmd
))
1650 (rpattern (rpattern "|" rpattern
))
1651 (pattern (rpattern) ("case-(" rpattern
))
1652 (branches (branches ";;" branches
)
1653 (branches ";&" branches
) (branches ";;&" branches
) ;bash.
1654 (pattern "case-)" cmd
)))
1655 '((assoc ";;" ";&" ";;&"))
1656 '((assoc ";" "&") (assoc "&&" "||") (assoc "|" "|&")))))
1658 (defconst sh-smie--sh-operators
1659 (delq nil
(mapcar (lambda (x)
1662 (not (string-match "\\`[a-z]" x
))
1664 sh-smie-sh-grammar
)))
1666 (defconst sh-smie--sh-operators-re
(regexp-opt sh-smie--sh-operators
))
1667 (defconst sh-smie--sh-operators-back-re
1668 (concat "\\(?:^\\|[^\\]\\)\\(?:\\\\\\\\\\)*"
1669 "\\(" sh-smie--sh-operators-re
"\\)"))
1671 (defun sh-smie--sh-keyword-in-p ()
1672 "Assuming we're looking at \"in\", return non-nil if it's a keyword.
1673 Does not preserve point."
1674 (let ((forward-sexp-function nil
)
1675 (words nil
) ;We've seen words.
1676 (newline nil
) ;We've seen newlines after the words.
1680 (setq prev
(funcall smie-backward-token-function
))
1682 ((zerop (length prev
))
1684 (progn (cl-assert words
) (setq res
'word
))
1688 (scan-error (setq res
'unknown
)))))
1690 (if words
(setq newline t
)
1691 (setq res
'keyword
)))
1692 ((member prev
'("case" "for" "select")) (setq res
'keyword
))
1693 ((assoc prev smie-grammar
) (setq res
'word
))
1696 (progn (cl-assert words
) (setq res
'word
))
1700 (defun sh-smie--sh-keyword-p (tok)
1701 "Non-nil if TOK (at which we're looking) really is a keyword."
1702 (if (equal tok
"in")
1703 (sh-smie--sh-keyword-in-p)
1704 (sh-smie--keyword-p tok
)))
1706 (defun sh-smie-sh-forward-token ()
1707 (if (and (looking-at "[ \t]*\\(?:#\\|\\(\\s|\\)\\|$\\)")
1709 (skip-chars-backward " \t")
1711 (if (and (match-end 1) (not (nth 3 (syntax-ppss))))
1712 ;; Right before a here-doc.
1713 (let ((forward-sexp-function nil
))
1715 ;; Pretend the here-document is a "newline representing a
1716 ;; semi-colon", since the here-doc otherwise covers the newline(s).
1718 (let ((semi (sh-smie--newline-semi-p)))
1721 (sh-smie-sh-forward-token))))
1722 (forward-comment (point-max))
1724 ((looking-at "\\\\\n") (forward-line 1) (sh-smie-sh-forward-token))
1725 ((looking-at sh-smie--sh-operators-re
)
1726 (goto-char (match-end 0))
1727 (let ((tok (match-string-no-properties 0)))
1728 (if (and (memq (aref tok
(1- (length tok
))) '(?\
; ?\& ?\|))
1729 (looking-at "[ \t]*\\(?:#\\|$\\)"))
1733 (let* ((pos (point))
1734 (tok (smie-default-forward-token)))
1736 ((equal tok
")") "case-)")
1737 ((equal tok
"(") "case-(")
1738 ((and tok
(string-match "\\`[a-z]" tok
)
1739 (assoc tok smie-grammar
)
1743 (sh-smie--sh-keyword-p tok
))))
1747 (defun sh-smie--looking-back-at-continuation-p ()
1749 (and (if (eq (char-before) ?
\n) (progn (forward-char -
1) t
) (eolp))
1750 (looking-back "\\(?:^\\|[^\\]\\)\\(?:\\\\\\\\\\)*\\\\"
1751 (line-beginning-position)))))
1753 (defun sh-smie-sh-backward-token ()
1754 (let ((bol (line-beginning-position))
1756 (forward-comment (- (point)))
1758 ((and (bolp) (not (bobp))
1759 (equal (syntax-after (1- (point))) (string-to-syntax "|"))
1760 (not (nth 3 (syntax-ppss))))
1761 ;; Right after a here-document.
1762 (let ((forward-sexp-function nil
))
1764 ;; Pretend the here-document is a "newline representing a
1765 ;; semi-colon", since the here-doc otherwise covers the newline(s).
1769 ((sh-smie--looking-back-at-continuation-p)
1771 (funcall smie-backward-token-function
))
1772 ((sh-smie--newline-semi-p) ";")
1773 (t (funcall smie-backward-token-function
))))
1774 ((looking-back sh-smie--sh-operators-back-re
1775 (line-beginning-position) 'greedy
)
1776 (goto-char (match-beginning 1))
1777 (match-string-no-properties 1))
1779 (let ((tok (smie-default-backward-token)))
1781 ((equal tok
")") "case-)")
1782 ((equal tok
"(") "case-(")
1783 ((and tok
(string-match "\\`[a-z]" tok
)
1784 (assoc tok smie-grammar
)
1785 (not (save-excursion (sh-smie--sh-keyword-p tok
))))
1789 (defcustom sh-indent-after-continuation t
1790 "If non-nil, try to make sure text is indented after a line continuation."
1793 :group
'sh-indentation
)
1795 (defun sh-smie--continuation-start-indent ()
1796 "Return the initial indentation of a continued line.
1797 May return nil if the line should not be treated as continued."
1800 (unless (sh-smie--looking-back-at-continuation-p)
1801 (current-indentation))))
1803 (defun sh-smie-sh-rules (kind token
)
1804 (pcase (cons kind token
)
1805 (`(:elem . basic
) sh-indentation
)
1806 (`(:after .
"case-)") (or sh-indentation smie-indent-basic
))
1807 ((and `(:before .
,_
)
1808 (guard (when sh-indent-after-continuation
1811 (skip-chars-backward " \t")
1812 (sh-smie--looking-back-at-continuation-p))))))
1813 ;; After a line-continuation, make sure the rest is indented.
1814 (let* ((sh-indent-after-continuation nil
)
1815 (indent (smie-indent-calculate))
1816 (initial (sh-smie--continuation-start-indent)))
1817 (when (and (numberp indent
) (numberp initial
)
1818 (<= indent initial
))
1819 `(column .
,(+ initial sh-indentation
)))))
1820 (`(:before .
,(or `"(" `"{" `"["))
1821 (if (smie-rule-hanging-p) (smie-rule-parent)))
1822 ;; FIXME: Maybe this handling of ;; should be made into
1823 ;; a smie-rule-terminator function that takes the substitute ";" as arg.
1824 (`(:before .
,(or `";;" `";&" `";;&"))
1825 (if (and (smie-rule-bolp) (looking-at ";;?&?[ \t]*\\(#\\|$\\)"))
1826 (cons 'column
(smie-indent-keyword ";"))
1827 (smie-rule-separator kind
)))
1828 (`(:after .
,(or `";;" `";&" `";;&"))
1829 (with-demoted-errors
1830 (smie-backward-sexp token
)
1832 (if (or (smie-rule-bolp)
1834 (and (member (funcall smie-backward-token-function
)
1838 (smie-indent-calculate)))))
1839 (`(:after .
"|") (if (smie-rule-parent-p "|") nil
4))
1842 ;; (defconst sh-smie-csh-grammar
1843 ;; (smie-prec2->grammar
1845 ;; '((exp) ;A constant, or a $var, or a sequence of them…
1847 ;; (cmd "else" "else-if" exp "then" elseifcmd))
1848 ;; (cmd ("switch" branches "endsw")
1850 ;; ("if" exp "then" cmd "endif")
1851 ;; ("if" exp "then" cmd "else" cmd "endif")
1852 ;; ("if" exp "then" elseifcmd "endif")
1853 ;; ;; ("if" exp "then" cmd "else" cmd "endif")
1854 ;; ;; ("if" exp "then" cmd "else" "if" exp "then" cmd "endif")
1855 ;; ;; ("if" exp "then" cmd "else" "if" exp "then" cmd
1856 ;; ;; "else" cmd "endif")
1857 ;; ;; ("if" exp "then" cmd "else" "if" exp "then" cmd
1858 ;; ;; "else" "if" exp "then" cmd "endif")
1859 ;; ("while" cmd "end")
1860 ;; ("foreach" cmd "end")
1861 ;; (cmd "|" cmd) (cmd "|&" cmd)
1862 ;; (cmd "&&" cmd) (cmd "||" cmd)
1863 ;; (cmd ";" cmd) (cmd "&" cmd))
1864 ;; ;; This is a lie, but (combined with the corresponding disambiguation
1865 ;; ;; rule) it makes it more clear that `case' and `default' are the key
1866 ;; ;; separators and the `:' is a secondary tokens.
1867 ;; (branches (branches "case" branches)
1868 ;; (branches "default" branches)
1869 ;; (exp ":" branches)))
1870 ;; '((assoc "else" "then" "endif"))
1871 ;; '((assoc "case" "default") (nonassoc ":"))
1872 ;; '((assoc ";;" ";&" ";;&"))
1873 ;; '((assoc ";" "&") (assoc "&&" "||") (assoc "|" "|&")))))
1875 ;;;; SMIE support for `rc'.
1877 (defconst sh-smie-rc-grammar
1878 (smie-prec2->grammar
1880 '((exp) ;A constant, or a $var, or a sequence of them...
1881 (cmd (cmd "case" cmd
)
1884 ("for" exp
) ("while" exp
)
1885 (cmd "|" cmd
) (cmd "|&" cmd
)
1886 (cmd "&&" cmd
) (cmd "||" cmd
)
1887 (cmd ";" cmd
) (cmd "&" cmd
))
1888 (pattern (pattern "|" pattern
))
1889 (branches (branches ";;" branches
)
1890 (branches ";&" branches
) (branches ";;&" branches
) ;bash.
1891 (pattern "case-)" cmd
)))
1892 '((assoc ";;" ";&" ";;&"))
1893 '((assoc "case") (assoc ";" "&") (assoc "&&" "||") (assoc "|" "|&")))))
1895 (defun sh-smie--rc-after-special-arg-p ()
1896 "Check if we're after the first arg of an if/while/for/... construct.
1897 Returns the construct's token and moves point before it, if so."
1898 (forward-comment (- (point)))
1899 (when (looking-back ")\\|\\_<not" (- (point) 3))
1901 (let ((forward-sexp-function nil
))
1903 (car (member (funcall smie-backward-token-function
)
1904 '("if" "for" "switch" "while")))))))
1906 (defun sh-smie--rc-newline-semi-p ()
1907 "Return non-nil if a newline should be treated as a semi-colon.
1908 Point should be before the newline."
1910 (let ((tok (funcall smie-backward-token-function
)))
1911 (if (or (when (equal tok
"not") (forward-word 1) t
)
1912 (and (zerop (length tok
)) (eq (char-before) ?\
))))
1913 (not (sh-smie--rc-after-special-arg-p))
1914 (sh-smie--newline-semi-p tok
)))))
1916 (defun sh-smie-rc-forward-token ()
1917 ;; FIXME: Code duplication with sh-smie-sh-forward-token.
1918 (if (and (looking-at "[ \t]*\\(?:#\\|\\(\\s|\\)\\|$\\)")
1920 (skip-chars-backward " \t")
1922 (if (and (match-end 1) (not (nth 3 (syntax-ppss))))
1923 ;; Right before a here-doc.
1924 (let ((forward-sexp-function nil
))
1926 ;; Pretend the here-document is a "newline representing a
1927 ;; semi-colon", since the here-doc otherwise covers the newline(s).
1929 (let ((semi (sh-smie--rc-newline-semi-p)))
1932 (sh-smie-rc-forward-token))))
1933 (forward-comment (point-max))
1935 ((looking-at "\\\\\n") (forward-line 1) (sh-smie-rc-forward-token))
1936 ;; ((looking-at sh-smie--rc-operators-re)
1937 ;; (goto-char (match-end 0))
1938 ;; (let ((tok (match-string-no-properties 0)))
1939 ;; (if (and (memq (aref tok (1- (length tok))) '(?\; ?\& ?\|))
1940 ;; (looking-at "[ \t]*\\(?:#\\|$\\)"))
1941 ;; (forward-line 1))
1944 (let* ((pos (point))
1945 (tok (smie-default-forward-token)))
1947 ;; ((equal tok ")") "case-)")
1948 ((and tok
(string-match "\\`[a-z]" tok
)
1949 (assoc tok smie-grammar
)
1953 (sh-smie--keyword-p tok
))))
1957 (defun sh-smie-rc-backward-token ()
1958 ;; FIXME: Code duplication with sh-smie-sh-backward-token.
1959 (let ((bol (line-beginning-position))
1961 (forward-comment (- (point)))
1963 ((and (bolp) (not (bobp))
1964 (equal (syntax-after (1- (point))) (string-to-syntax "|"))
1965 (not (nth 3 (syntax-ppss))))
1966 ;; Right after a here-document.
1967 (let ((forward-sexp-function nil
))
1969 ;; Pretend the here-document is a "newline representing a
1970 ;; semi-colon", since the here-doc otherwise covers the newline(s).
1972 ((< (point) bol
) ;We skipped over a newline.
1974 ;; A continued line.
1976 (looking-back "\\(?:^\\|[^\\]\\)\\(?:\\\\\\\\\\)*\\\\"
1977 (line-beginning-position)))
1979 (funcall smie-backward-token-function
))
1980 ((sh-smie--rc-newline-semi-p) ";")
1981 (t (funcall smie-backward-token-function
))))
1982 ;; ((looking-back sh-smie--sh-operators-back-re
1983 ;; (line-beginning-position) 'greedy)
1984 ;; (goto-char (match-beginning 1))
1985 ;; (match-string-no-properties 1))
1987 (let ((tok (smie-default-backward-token)))
1989 ;; ((equal tok ")") "case-)")
1990 ((and tok
(string-match "\\`[a-z]" tok
)
1991 (assoc tok smie-grammar
)
1992 (not (save-excursion (sh-smie--keyword-p tok
))))
1996 (defun sh-smie-rc-rules (kind token
)
1997 (pcase (cons kind token
)
1998 (`(:elem . basic
) sh-indentation
)
1999 ;; (`(:after . "case") (or sh-indentation smie-indent-basic))
2000 (`(:after .
";") (if (smie-rule-parent-p "case")
2001 (smie-rule-parent sh-indentation
)))
2004 (when (sh-smie--rc-after-special-arg-p)
2005 `(column .
,(current-column)))))
2006 (`(:before .
,(or `"(" `"{" `"["))
2007 (if (smie-rule-hanging-p) (smie-rule-parent)))
2008 ;; FIXME: SMIE parses "if (exp) cmd" as "(if ((exp) cmd))" so "cmd" is
2009 ;; treated as an arg to (exp) by default, which indents it all wrong.
2010 ;; To handle it right, we should extend smie-indent-exps so that the
2011 ;; preceding keyword can give special rules. Currently the only special
2012 ;; rule we have is the :list-intro hack, which we use here to align "cmd"
2013 ;; with "(exp)", which is rarely the right thing to do, but is better
2015 (`(:list-intro .
,(or `"for" `"if" `"while")) t
)
2018 ;;; End of SMIE code.
2020 (defvar sh-regexp-for-done nil
2021 "A buffer-local regexp to match opening keyword for done.")
2023 (defvar sh-kw-alist nil
2024 "A buffer-local, since it is shell-type dependent, list of keywords.")
2026 ;; ( key-word first-on-this on-prev-line )
2027 ;; This is used to set `sh-kw-alist' which is a list of sublists each
2028 ;; having 3 elements:
2030 ;; a rule to check when the keyword appears on "this" line
2031 ;; a rule to check when the keyword appears on "the previous" line
2032 ;; The keyword is usually a string and is the first word on a line.
2033 ;; If this keyword appears on the line whose indentation is to be
2034 ;; calculated, the rule in element 2 is called. If this returns
2035 ;; non-zero, the resulting point (which may be changed by the rule)
2036 ;; is used as the default indentation.
2037 ;; If it returned false or the keyword was not found in the table,
2038 ;; then the keyword from the previous line is looked up and the rule
2039 ;; in element 3 is called. In this case, however,
2040 ;; `sh-get-indent-info' does not stop but may keep going and test
2041 ;; other keywords against rules in element 3. This is because the
2042 ;; preceding line could have, for example, an opening "if" and an
2043 ;; opening "while" keyword and we need to add the indentation offsets
2048 ("if" nil sh-handle-prev-if
)
2049 ("elif" sh-handle-this-else sh-handle-prev-else
)
2050 ("else" sh-handle-this-else sh-handle-prev-else
)
2051 ("fi" sh-handle-this-fi sh-handle-prev-fi
)
2052 ("then" sh-handle-this-then sh-handle-prev-then
)
2053 ("(" nil sh-handle-prev-open
)
2054 ("{" nil sh-handle-prev-open
)
2055 ("[" nil sh-handle-prev-open
)
2056 ("}" sh-handle-this-close nil
)
2057 (")" sh-handle-this-close nil
)
2058 ("]" sh-handle-this-close nil
)
2059 ("case" nil sh-handle-prev-case
)
2060 ("esac" sh-handle-this-esac sh-handle-prev-esac
)
2061 (case-label nil sh-handle-after-case-label
) ;; ???
2062 (";;" nil sh-handle-prev-case-alt-end
) ;; ???
2063 (";;&" nil sh-handle-prev-case-alt-end
) ;Like ";;" with diff semantics.
2064 (";&" nil sh-handle-prev-case-alt-end
) ;Like ";;" with diff semantics.
2065 ("done" sh-handle-this-done sh-handle-prev-done
)
2066 ("do" sh-handle-this-do sh-handle-prev-do
))
2068 ;; Note: we don't need specific stuff for bash and zsh shells;
2069 ;; the regexp `sh-regexp-for-done' handles the extra keywords
2070 ;; these shells use.
2072 ("{" nil sh-handle-prev-open
)
2073 ("}" sh-handle-this-close nil
)
2074 ("case" sh-handle-this-rc-case sh-handle-prev-rc-case
))))
2078 (defun sh-set-shell (shell &optional no-query-flag insert-flag
)
2079 "Set this buffer's shell to SHELL (a string).
2080 When used interactively, insert the proper starting #!-line,
2081 and make the visited file executable via `executable-set-magic',
2082 perhaps querying depending on the value of `executable-query'.
2084 When this function is called noninteractively, INSERT-FLAG (the third
2085 argument) controls whether to insert a #!-line and think about making
2086 the visited file executable, and NO-QUERY-FLAG (the second argument)
2087 controls whether to query about making the visited file executable.
2089 Calls the value of `sh-set-shell-hook' if set."
2090 (interactive (list (completing-read (format "Shell \(default %s\): "
2092 interpreter-mode-alist
2093 (lambda (x) (eq (cdr x
) 'sh-mode
))
2094 nil nil nil sh-shell-file
)
2095 (eq executable-query
'function
)
2097 (if (string-match "\\.exe\\'" shell
)
2098 (setq shell
(substring shell
0 (match-beginning 0))))
2099 (setq sh-shell
(intern (file-name-nondirectory shell
))
2100 sh-shell
(or (cdr (assq sh-shell sh-alias-alist
))
2104 (executable-set-magic shell
(sh-feature sh-shell-arg
)
2105 no-query-flag insert-flag
)))
2106 (setq mode-line-process
(format "[%s]" sh-shell
))
2107 (set (make-local-variable 'sh-shell-variables
) nil
)
2108 (set (make-local-variable 'sh-shell-variables-initialized
) nil
)
2109 (set (make-local-variable 'imenu-generic-expression
)
2110 (sh-feature sh-imenu-generic-expression
))
2111 (let ((tem (sh-feature sh-mode-syntax-table-input
)))
2113 (set (make-local-variable 'sh-mode-syntax-table
)
2114 (apply 'sh-mode-syntax-table tem
))
2115 (set-syntax-table sh-mode-syntax-table
)))
2116 (dolist (var (sh-feature sh-variables
))
2117 (sh-remember-variable var
))
2118 (if (set (make-local-variable 'sh-indent-supported-here
)
2119 (sh-feature sh-indent-supported
))
2121 (message "Setting up indent for shell type %s" sh-shell
)
2123 (let ((mksym (lambda (name)
2124 (intern (format "sh-smie-%s-%s"
2125 sh-indent-supported-here name
)))))
2126 (smie-setup (symbol-value (funcall mksym
"grammar"))
2127 (funcall mksym
"rules")
2128 :forward-token
(funcall mksym
"forward-token")
2129 :backward-token
(funcall mksym
"backward-token")))
2130 (set (make-local-variable 'parse-sexp-lookup-properties
) t
)
2131 (set (make-local-variable 'sh-kw-alist
) (sh-feature sh-kw
))
2132 (let ((regexp (sh-feature sh-kws-for-done
)))
2134 (set (make-local-variable 'sh-regexp-for-done
)
2135 (sh-mkword-regexpr (regexp-opt regexp t
)))))
2136 (message "setting up indent stuff")
2137 ;; sh-mode has already made indent-line-function local
2138 ;; but do it in case this is called before that.
2139 (set (make-local-variable 'indent-line-function
) 'sh-indent-line
))
2140 (if sh-make-vars-local
2141 (sh-make-vars-local))
2142 (message "Indentation setup for shell type %s" sh-shell
))
2143 (message "No indentation for this shell type.")
2144 (setq indent-line-function
'sh-basic-indent-line
))
2145 (when font-lock-mode
2146 (setq font-lock-set-defaults nil
)
2147 (font-lock-set-defaults)
2148 (font-lock-fontify-buffer))
2149 (run-hooks 'sh-set-shell-hook
))
2152 (defun sh-feature (alist &optional function
)
2153 "Index ALIST by the current shell.
2154 If ALIST isn't a list where every element is a cons, it is returned as is.
2155 Else indexing follows an inheritance logic which works in two ways:
2157 - Fall back on successive ancestors (see `sh-ancestor-alist') as long as
2158 the alist contains no value for the current shell.
2159 The ultimate default is always `sh'.
2161 - If the value thus looked up is a list starting with `sh-append',
2162 we call the function `sh-append' with the rest of the list as
2163 arguments, and use the value. However, the next element of the
2164 list is not used as-is; instead, we look it up recursively
2165 in ALIST to allow the function called to define the value for
2166 one shell to be derived from another shell.
2167 The value thus determined is physically replaced into the alist.
2169 If FUNCTION is non-nil, it is called with one argument,
2170 the value thus obtained, and the result is used instead."
2171 (or (if (consp alist
)
2172 ;; Check for something that isn't a valid alist.
2174 (while (and l
(consp (car l
)))
2178 (let ((orig-sh-shell sh-shell
))
2179 (let ((sh-shell sh-shell
)
2181 (while (and sh-shell
2182 (not (setq elt
(assq sh-shell alist
))))
2183 (setq sh-shell
(cdr (assq sh-shell sh-ancestor-alist
))))
2184 ;; If the shell is not known, treat it as sh.
2186 (setq elt
(assq 'sh alist
)))
2187 (setq val
(cdr elt
))
2188 (if (and (consp val
)
2189 (memq (car val
) '(sh-append sh-modify
)))
2192 ;; Refer to the value for a different shell,
2193 ;; as a kind of inheritance.
2194 (let ((sh-shell (car (cdr val
))))
2198 (setq sh-shell orig-sh-shell
2199 val
(funcall function val
)))
2204 ;; I commented this out because nobody calls it -- rms.
2205 ;;(defun sh-abbrevs (ancestor &rest list)
2206 ;; "Iff it isn't, define the current shell as abbrev table and fill that.
2207 ;;Abbrev table will inherit all abbrevs from ANCESTOR, which is either an abbrev
2208 ;;table or a list of (NAME1 EXPANSION1 ...). In addition it will define abbrevs
2209 ;;according to the remaining arguments NAMEi EXPANSIONi ...
2210 ;;EXPANSION may be either a string or a skeleton command."
2211 ;; (or (if (boundp sh-shell)
2212 ;; (symbol-value sh-shell))
2214 ;; (if (listp ancestor)
2215 ;; (nconc list ancestor))
2216 ;; (define-abbrev-table sh-shell ())
2217 ;; (if (vectorp ancestor)
2218 ;; (mapatoms (lambda (atom)
2220 ;; (define-abbrev (symbol-value sh-shell)
2221 ;; (symbol-name atom)
2222 ;; (symbol-value atom)
2223 ;; (symbol-function atom))))
2226 ;; (define-abbrev (symbol-value sh-shell)
2228 ;; (if (stringp (car (cdr list)))
2231 ;; (if (symbolp (car (cdr list)))
2232 ;; (car (cdr list))))
2233 ;; (setq list (cdr (cdr list)))))
2234 ;; (symbol-value sh-shell)))
2237 (defun sh-append (ancestor &rest list
)
2238 "Return list composed of first argument (a list) physically appended to rest."
2239 (nconc list ancestor
))
2242 (defun sh-modify (skeleton &rest list
)
2243 "Modify a copy of SKELETON by replacing I1 with REPL1, I2 with REPL2 ..."
2244 (setq skeleton
(copy-sequence skeleton
))
2246 (setcar (or (nthcdr (car list
) skeleton
)
2247 (error "Index %d out of bounds" (car list
)))
2249 (setq list
(nthcdr 2 list
)))
2253 (defun sh-basic-indent-line ()
2254 "Indent a line for Sh mode (shell script mode).
2255 Indent as far as preceding non-empty line, then by steps of `sh-indentation'.
2256 Lines containing only comments are considered empty."
2258 (let ((previous (save-excursion
2259 (while (and (progn (beginning-of-line)
2263 (back-to-indentation)
2265 (eq (following-char) ?
#)))))
2269 (indent-to (if (eq this-command
'newline-and-indent
)
2271 (if (< (current-column)
2272 (setq current
(progn (back-to-indentation)
2274 (if (eolp) previous
0)
2275 (delete-region (point)
2276 (progn (beginning-of-line) (point)))
2278 (max previous
(* (1+ (/ current sh-indentation
))
2280 (* (1+ (/ current sh-indentation
)) sh-indentation
))))))
2281 (if (< (current-column) (current-indentation))
2282 (skip-chars-forward " \t"))))
2285 (defun sh-execute-region (start end
&optional flag
)
2286 "Pass optional header and region to a subshell for noninteractive execution.
2287 The working directory is that of the buffer, and only environment variables
2288 are already set which is why you can mark a header within the script.
2290 With a positive prefix ARG, instead of sending region, define header from
2291 beginning of buffer to point. With a negative prefix ARG, instead of sending
2292 region, clear header."
2293 (interactive "r\nP")
2295 (setq sh-header-marker
(if (> (prefix-numeric-value flag
) 0)
2297 (if sh-header-marker
2299 (let (buffer-undo-list)
2300 (goto-char sh-header-marker
)
2301 (append-to-buffer (current-buffer) start end
)
2302 (shell-command-on-region (point-min)
2303 (setq end
(+ sh-header-marker
2306 (delete-region sh-header-marker end
)))
2307 (shell-command-on-region start end
(concat sh-shell-file
" -")))))
2310 (defun sh-remember-variable (var)
2311 "Make VARIABLE available for future completing reads in this buffer."
2312 (or (< (length var
) sh-remember-variable-min
)
2314 (assoc var sh-shell-variables
)
2315 (push (cons var var
) sh-shell-variables
))
2320 (defun sh-quoted-p ()
2321 "Is point preceded by an odd number of backslashes?"
2322 (eq -
1 (%
(save-excursion (skip-chars-backward "\\\\")) 2)))
2324 ;; Indentation stuff.
2325 (defun sh-must-support-indent ()
2326 "Signal an error if the shell type for this buffer is not supported.
2327 Also, the buffer must be in Shell-script mode."
2328 (unless sh-indent-supported-here
2329 (error "This buffer's shell does not support indentation through Emacs")))
2331 (defun sh-make-vars-local ()
2332 "Make the indentation variables local to this buffer.
2333 Normally they already are local. This command is provided in case
2334 variable `sh-make-vars-local' has been set to nil.
2336 To revert all these variables to the global values, use
2337 command `sh-reset-indent-vars-to-global-values'."
2339 (mapc 'make-local-variable sh-var-list
)
2340 (message "Indentation variables are now local."))
2342 (defun sh-reset-indent-vars-to-global-values ()
2343 "Reset local indentation variables to the global values.
2344 Then, if variable `sh-make-vars-local' is non-nil, make them local."
2346 (mapc 'kill-local-variable sh-var-list
)
2347 (if sh-make-vars-local
2348 (mapcar 'make-local-variable sh-var-list
)))
2351 ;; Theoretically these are only needed in shell and derived modes.
2352 ;; However, the routines which use them are only called in those modes.
2353 (defconst sh-special-keywords
"then\\|do")
2355 (defun sh-help-string-for-variable (var)
2356 "Construct a string for `sh-read-variable' when changing variable VAR ."
2357 (let ((msg (documentation-property var
'variable-documentation
))
2359 (unless (memq var
'(sh-first-lines-indent sh-indent-comment
))
2362 You can enter a number (positive to increase indentation,
2363 negative to decrease indentation, zero for no change to indentation).
2365 Or, you can enter one of the following symbols which are relative to
2366 the value of variable `sh-basic-offset'
2367 which in this buffer is currently %s.
2371 (mapconcat (lambda (x)
2372 (nth (1- (length x
)) x
))
2373 sh-symbol-list
"\n\t"))))
2375 ;; The following shows the global not the local value!
2376 ;; (format "Current value of %s is %s\n\n" var (symbol-value var))
2379 (defun sh-read-variable (var)
2380 "Read a new value for indentation variable VAR."
2381 (interactive "*variable? ") ;; to test
2382 (let ((minibuffer-help-form `(sh-help-string-for-variable
2385 (setq val
(read-from-minibuffer
2386 (format "New value for %s (press %s for help): "
2387 var
(single-key-description help-char
))
2388 (format "%s" (symbol-value var
))
2394 (defun sh-in-comment-or-string (start)
2395 "Return non-nil if START is in a comment or string."
2397 (let ((state (syntax-ppss start
)))
2398 (or (nth 3 state
) (nth 4 state
)))))
2400 (defun sh-goto-matching-if ()
2401 "Go to the matching if for a fi.
2402 This handles nested if..fi pairs."
2403 (let ((found (sh-find-prev-matching "\\bif\\b" "\\bfi\\b" 1)))
2405 (goto-char found
))))
2408 ;; Functions named sh-handle-this-XXX are called when the keyword on the
2409 ;; line whose indentation is being handled contain XXX;
2410 ;; those named sh-handle-prev-XXX are when XXX appears on the previous line.
2412 (defun sh-handle-prev-if ()
2413 (list '(+ sh-indent-after-if
)))
2415 (defun sh-handle-this-else ()
2416 (if (sh-goto-matching-if)
2417 ;; (list "aligned to if")
2418 (list "aligned to if" '(+ sh-indent-for-else
))
2422 (defun sh-handle-prev-else ()
2423 (if (sh-goto-matching-if)
2424 (list '(+ sh-indent-after-if
))
2427 (defun sh-handle-this-fi ()
2428 (if (sh-goto-matching-if)
2429 (list "aligned to if" '(+ sh-indent-for-fi
))
2433 (defun sh-handle-prev-fi ()
2434 ;; Why do we have this rule? Because we must go back to the if
2435 ;; to get its indent. We may continue back from there.
2436 ;; We return nil because we don't have anything to add to result,
2437 ;; the side affect of setting align-point is all that matters.
2438 ;; we could return a comment (a string) but I can't think of a good one...
2439 (sh-goto-matching-if)
2442 (defun sh-handle-this-then ()
2443 (let ((p (sh-goto-matching-if)))
2445 (list '(+ sh-indent-for-then
))
2448 (defun sh-handle-prev-then ()
2449 (let ((p (sh-goto-matching-if)))
2451 (list '(+ sh-indent-after-if
))
2454 (defun sh-handle-prev-open ()
2456 (let ((x (sh-prev-stmt)))
2461 (looking-at "function\\b")
2462 (looking-at "\\s-*\\S-+\\s-*()")
2464 (list '(+ sh-indent-after-function
))
2465 (list '(+ sh-indent-after-open
)))
2468 (defun sh-handle-this-close ()
2469 (forward-char 1) ;; move over ")"
2470 (if (sh-safe-forward-sexp -
1)
2471 (list "aligned to opening paren")))
2473 (defun sh-goto-matching-case ()
2474 (let ((found (sh-find-prev-matching "\\bcase\\b" "\\besac\\b" 1)))
2475 (if found
(goto-char found
))))
2477 (defun sh-handle-prev-case ()
2478 ;; This is typically called when point is on same line as a case
2479 ;; we shouldn't -- and can't find prev-case
2480 (if (looking-at ".*\\<case\\>")
2481 (list '(+ sh-indent-for-case-label
))
2482 (error "We don't seem to be on a line with a case"))) ;; debug
2484 (defun sh-handle-this-esac ()
2485 (if (sh-goto-matching-case)
2486 (list "aligned to matching case")))
2488 (defun sh-handle-prev-esac ()
2489 (if (sh-goto-matching-case)
2490 (list "matching case")))
2492 (defun sh-handle-after-case-label ()
2493 (if (sh-goto-matching-case)
2494 (list '(+ sh-indent-for-case-alt
))))
2496 (defun sh-handle-prev-case-alt-end ()
2497 (if (sh-goto-matching-case)
2498 (list '(+ sh-indent-for-case-label
))))
2500 (defun sh-safe-forward-sexp (&optional arg
)
2501 "Try and do a `forward-sexp', but do not error.
2502 Return new point if successful, nil if an error occurred."
2505 (forward-sexp (or arg
1))
2506 (point)) ;; return point if successful
2508 (sh-debug "oops!(1) %d" (point))
2509 nil
))) ;; return nil if fail
2511 (defun sh-goto-match-for-done ()
2512 (let ((found (sh-find-prev-matching sh-regexp-for-done sh-re-done
1)))
2514 (goto-char found
))))
2516 (defun sh-handle-this-done ()
2517 (if (sh-goto-match-for-done)
2518 (list "aligned to do stmt" '(+ sh-indent-for-done
))))
2520 (defun sh-handle-prev-done ()
2521 (if (sh-goto-match-for-done)
2522 (list "previous done")))
2524 (defun sh-handle-this-do ()
2525 (if (sh-goto-match-for-done)
2526 (list '(+ sh-indent-for-do
))))
2528 (defun sh-handle-prev-do ()
2531 (narrow-to-region (point) (line-beginning-position))
2532 (sh-goto-match-for-done))
2533 (sh-debug "match for done found on THIS line")
2534 (list '(+ sh-indent-after-loop-construct
)))
2535 ((sh-goto-match-for-done)
2536 (sh-debug "match for done found on PREV line")
2537 (list '(+ sh-indent-after-do
)))
2539 (message "match for done NOT found")
2543 (defun sh-find-prev-switch ()
2544 "Find the line for the switch keyword matching this line's case keyword."
2545 (re-search-backward "\\<switch\\>" nil t
))
2547 (defun sh-handle-this-rc-case ()
2548 (if (sh-find-prev-switch)
2549 (list '(+ sh-indent-after-switch
))
2550 ;; (list '(+ sh-indent-for-case-label))
2553 (defun sh-handle-prev-rc-case ()
2554 (list '(+ sh-indent-after-case
)))
2556 (defun sh-check-rule (n thing
)
2557 (let ((rule (nth n
(assoc thing sh-kw-alist
)))
2561 (setq val
(funcall rule
))
2562 (sh-debug "rule (%d) for %s at %d is %s\n-> returned %s"
2563 n thing
(point) rule val
)))
2567 (defun sh-get-indent-info ()
2568 "Return indent-info for this line.
2569 This is a list. nil means the line is to be left as is.
2570 Otherwise it contains one or more of the following sublists:
2571 \(t NUMBER\) NUMBER is the base location in the buffer that indentation is
2572 relative to. If present, this is always the first of the
2573 sublists. The indentation of the line in question is
2574 derived from the indentation of this point, possibly
2575 modified by subsequent sublists.
2577 \(- VAR\) Get the value of variable VAR and add to or subtract from
2578 the indentation calculated so far.
2579 \(= VAR\) Get the value of variable VAR and *replace* the
2580 indentation with its value. This only occurs for
2581 special variables such as `sh-indent-comment'.
2582 STRING This is ignored for the purposes of calculating
2583 indentation, it is printed in certain cases to help show
2584 what the indentation is based on."
2585 ;; See comments before `sh-kw'.
2587 (let ((have-result nil
)
2594 ;; Note: setting result to t means we are done and will return nil.
2595 ;;(This function never returns just t.)
2597 ((or (nth 3 (syntax-ppss (point)))
2598 (eq (get-text-property (point) 'face
) sh-heredoc-face
))
2599 ;; String continuation -- don't indent
2601 (setq have-result t
))
2602 ((looking-at "\\s-*#") ; was (equal this-kw "#")
2604 (setq result t
) ;; return nil if 1st line!
2605 (setq result
(list '(= sh-indent-comment
)))
2606 ;; we still need to get previous line in case
2607 ;; sh-indent-comment is t (indent as normal)
2608 (setq align-point
(sh-prev-line nil
))
2609 (setq have-result nil
)
2614 ;; Continuation lines are handled specially
2615 (if (sh-this-is-a-continuation)
2620 (not (memq (char-before (- (point) 2)) '(?\s ?
\t))))
2621 ;; By convention, if the continuation \ is not
2622 ;; preceded by a SPC or a TAB it means that the line
2623 ;; is cut at a place where spaces cannot be freely
2624 ;; added/removed. I.e. do not indent the line.
2626 ;; We assume the line being continued is already
2627 ;; properly indented...
2628 ;; (setq prev-line-end (sh-prev-line))
2629 (setq align-point
(sh-prev-line nil
))
2630 (list '(+ sh-indent-for-continuation
))))
2631 (setq have-result t
))
2633 (skip-chars-forward " \t")
2634 (setq this-kw
(sh-get-kw)))
2636 ;; Handle "this" keyword: first word on the line we're
2637 ;; calculating indentation info for.
2639 (if (setq val
(sh-check-rule 1 this-kw
))
2641 (setq align-point
(point))
2643 "this - setting align-point to %d" align-point
)
2644 (setq result
(append result val
))
2645 (setq have-result t
)
2646 ;; set prev-line to continue processing remainder
2647 ;; of this line as a previous line
2648 (setq prev-line-end
(point))
2652 (setq prev-line-end
(sh-prev-line 'end
)))
2656 ;; We start off at beginning of this line.
2657 ;; Scan previous statements while this is <=
2658 ;; start of previous line.
2659 (goto-char prev-line-end
)
2661 (while (and x
(setq x
(sh-prev-thing)))
2662 (sh-debug "at %d x is: %s result is: %s" (point) x result
)
2665 (equal (get-text-property (1- (point)) 'syntax-table
)
2667 (sh-debug "Case label) here")
2668 (setq x
'case-label
)
2669 (if (setq val
(sh-check-rule 2 x
))
2671 (setq result
(append result val
))
2672 (setq align-point
(point))))
2675 ;; FIXME: This charset looks too much like a regexp. --Stef
2676 (skip-chars-forward "[a-z0-9]*?")
2678 ((string-match "[])}]" x
)
2679 (setq x
(sh-safe-forward-sexp -
1))
2682 (setq align-point
(point))
2683 (setq result
(append result
2684 (list "aligned to opening paren")))
2686 ((string-match "[[({]" x
)
2687 (sh-debug "Checking special thing: %s" x
)
2688 (if (setq val
(sh-check-rule 2 x
))
2689 (setq result
(append result val
)))
2691 (setq align-point
(point)))
2692 ((string-match "[\"'`]" x
)
2693 (sh-debug "Skipping back for %s" x
)
2695 (setq x
(sh-safe-forward-sexp -
1)))
2697 (sh-debug "Checking string %s at %s" x
(point))
2698 (if (setq val
(sh-check-rule 2 x
))
2699 ;; (or (eq t (car val))
2700 ;; (eq t (car (car val))))
2701 (setq result
(append result val
)))
2702 ;; not sure about this test Wed Jan 27 23:48:35 1999
2703 (setq align-point
(point))
2707 (error "Don't know what to do with %s" x
))
2710 (sh-debug "result is %s" result
)
2712 (sh-debug "No prev line!")
2713 (sh-debug "result: %s align-point: %s" result align-point
)
2717 ;; was: (setq result (append result (list (list t align-point))))
2718 (setq result
(append (list (list t align-point
)) result
))
2720 (sh-debug "result is now: %s" result
)
2723 (setq result
(list (if prev-line-end
2724 (list t prev-line-end
)
2725 (list '= 'sh-first-lines-indent
)))))
2729 (sh-debug "result is: %s" result
)
2735 (defun sh-get-indent-var-for-line (&optional info
)
2736 "Return the variable controlling indentation for this line.
2737 If there is not [just] one such variable, return a string
2738 indicating the problem.
2739 If INFO is supplied it is used, else it is calculated."
2745 (setq info
(sh-get-indent-info)))
2747 (setq result
"this line to be left as is")
2748 (while (and info
(null result
))
2749 (setq elt
(car info
))
2755 (error "sh-get-indent-var-for-line invalid elt: %s" elt
))
2759 ((symbolp (setq sym
(nth 1 elt
)))
2760 ;; A bit of a kludge - when we see the sh-indent-comment
2761 ;; ignore other variables. Otherwise it is tricky to
2762 ;; "learn" the comment indentation.
2763 (if (eq var
'sh-indent-comment
)
2767 "this line is controlled by more than 1 variable.")
2770 (error "sh-get-indent-var-for-line invalid list elt: %s" elt
)))
2771 (setq info
(cdr info
))
2776 (setq result reason
))
2778 ;; e.g. just had (t POS)
2779 (setq result
"line has default indentation"))
2784 ;; Finding the previous line isn't trivial.
2785 ;; We must *always* go back one more and see if that is a continuation
2786 ;; line -- it is the PREVIOUS line which is continued, not the one
2788 ;; Also, we want to treat a whole "here document" as one big line,
2789 ;; because we may want to a align to the beginning of it.
2792 ;; - go back to previous non-empty line
2793 ;; - if this is in a here-document, go to the beginning of it
2794 ;; - while previous line is continued, go back one line
2795 (defun sh-prev-line (&optional end
)
2796 "Back to end of previous non-comment non-empty line.
2797 Go to beginning of logical line unless END is non-nil, in which case
2798 we go to the end of the previous line and do not check for continuations."
2801 (forward-comment (- (point-max)))
2802 (unless end
(beginning-of-line))
2803 (when (and (not (bobp))
2804 (equal (get-text-property (1- (point)) 'face
)
2806 (let ((p1 (previous-single-property-change (1- (point)) 'face
)))
2811 (beginning-of-line)))))
2813 ;; we must check previous lines to see if they are continuation lines
2814 ;; if so, we must return position of first of them
2815 (while (and (sh-this-is-a-continuation)
2816 (>= 0 (forward-line -
1))))
2818 (skip-chars-forward " \t"))
2822 (defun sh-prev-stmt ()
2823 "Return the address of the previous stmt or nil."
2824 ;; This is used when we are trying to find a matching keyword.
2825 ;; Searching backward for the keyword would certainly be quicker, but
2826 ;; it is hard to remove "false matches" -- such as if the keyword
2827 ;; appears in a string or quote. This way is slower, but (I think) safer.
2834 (skip-chars-backward " \t;|&({[")
2835 (while (and (not found
)
2838 ;; Do a backward-sexp if possible, else backup bit by bit...
2839 (if (sh-safe-forward-sexp -
1)
2841 (if (looking-at sh-special-keywords
)
2846 ;; backward-sexp failed
2847 (if (zerop (skip-chars-backward " \t()[\]{};`'"))
2850 (let ((back (sh-prev-line nil
)))
2853 (setq going nil
)))))
2855 (skip-chars-backward " \t")
2856 (if (or (and (bolp) (not (sh-this-is-a-continuation)))
2857 (eq (char-before) ?\
;)
2858 (looking-at "\\s-*[|&]"))
2859 (setq found
(point)))))
2864 (skip-chars-forward " \t|&({[")
2865 (setq found
(point))))
2866 (if (>= (point) start
)
2868 (debug "We didn't move!")
2871 (sh-debug "Did not find prev stmt.")))
2875 (defun sh-get-word ()
2876 "Get a shell word skipping whitespace from point."
2878 (skip-chars-forward "\t ")
2879 (let ((start (point)))
2881 (if (looking-at "[\"'`]")
2882 (sh-safe-forward-sexp)
2883 ;; (> (skip-chars-forward "^ \t\n\"'`") 0)
2884 (> (skip-chars-forward "-_$[:alnum:]") 0)
2886 (buffer-substring start
(point))
2889 (defun sh-prev-thing ()
2890 "Return the previous thing this logical line."
2891 ;; This is called when `sh-get-indent-info' is working backwards on
2892 ;; the previous line(s) finding what keywords may be relevant for
2893 ;; indenting. It moves over sexps if possible, and will stop
2894 ;; on a ; and at the beginning of a line if it is not a continuation
2897 ;; Added a kludge for ";;"
2898 ;; Possible return values:
2900 ;; a string - possibly a keyword
2904 (let ((start (point))
2905 (min-point (if (sh-this-is-a-continuation)
2907 (line-beginning-position))))
2908 (skip-chars-backward " \t;" min-point
)
2909 (if (looking-at "\\s-*;[;&]")
2910 ;; (message "Found ;; !")
2912 (skip-chars-backward "^)}];\"'`({[" min-point
)
2913 (let ((c (if (> (point) min-point
) (char-before))))
2914 (sh-debug "stopping at %d c is %s start=%d min-point=%d"
2915 (point) c start min-point
)
2916 (if (not (memq c
'(?
\n nil ?\
;)))
2917 ;; c -- return a string
2919 ;; Return the leading keyword of the "command" we supposedly
2920 ;; skipped over. Maybe we skipped too far (e.g. past a `do' or
2921 ;; `then' that precedes the actual command), so check whether
2922 ;; we're looking at such a keyword and if so, move back forward.
2923 (let ((boundary (point))
2927 ;; Skip forward over white space newline and \ at eol.
2928 (skip-chars-forward " \t\n\\\\" start
)
2929 (if (>= (point) start
)
2931 (sh-debug "point: %d >= start: %d" (point) start
)
2933 (if next
(setq boundary next
))
2934 (sh-debug "Now at %d start=%d" (point) start
)
2935 (setq kwd
(sh-get-word))
2936 (if (member kwd
(sh-feature sh-leading-keywords
))
2941 (goto-char boundary
)
2945 (defun sh-this-is-a-continuation ()
2946 "Return non-nil if current line is a continuation of previous line."
2948 (and (zerop (forward-line -
1))
2949 (looking-at ".*\\\\$")
2950 (not (nth 4 (parse-partial-sexp (match-beginning 0) (match-end 0)
2953 (defun sh-get-kw (&optional where and-move
)
2954 "Return first word of line from WHERE.
2955 If AND-MOVE is non-nil then move to end of word."
2956 (let ((start (point)))
2960 (buffer-substring (point)
2961 (progn (skip-chars-forward "^ \t\n;&|")(point)))
2963 (goto-char start
)))))
2965 (defun sh-find-prev-matching (open close
&optional depth
)
2966 "Find a matching token for a set of opening and closing keywords.
2967 This takes into account that there may be nested open..close pairings.
2968 OPEN and CLOSE are regexps denoting the tokens to be matched.
2969 Optional parameter DEPTH (usually 1) says how many to look for."
2970 (let ((parse-sexp-ignore-comments t
)
2972 (setq depth
(or depth
1))
2978 (setq prev
(sh-prev-stmt)))
2981 (if (looking-at "\\\\\n")
2984 (skip-chars-forward " \t")))
2987 (setq depth
(1- depth
))
2988 (sh-debug "found open at %d - depth = %d" (point) depth
))
2990 (setq depth
(1+ depth
))
2991 (sh-debug "found close - depth = %d" depth
))
3001 (defun sh-var-value (var &optional ignore-error
)
3002 "Return the value of variable VAR, interpreting symbols.
3003 It can also return t or nil.
3004 If an invalid value is found, throw an error unless Optional argument
3005 IGNORE-ERROR is non-nil."
3006 (let ((val (symbol-value var
)))
3017 (- sh-basic-offset
))
3019 (* 2 sh-basic-offset
))
3021 (* 2 (- sh-basic-offset
)))
3023 (/ sh-basic-offset
2))
3025 (/ (- sh-basic-offset
) 2))
3029 (message "Don't know how to handle %s's value of %s" var val
)
3031 (error "Don't know how to handle %s's value of %s" var val
))
3034 (defun sh-set-var-value (var value
&optional no-symbol
)
3035 "Set variable VAR to VALUE.
3036 Unless optional argument NO-SYMBOL is non-nil, then if VALUE is
3037 can be represented by a symbol then do so."
3041 ((= value sh-basic-offset
)
3043 ((= value
(- sh-basic-offset
))
3045 ((eq value
(* 2 sh-basic-offset
))
3047 ((eq value
(* 2 (- sh-basic-offset
)))
3049 ((eq value
(/ sh-basic-offset
2))
3051 ((eq value
(/ (- sh-basic-offset
) 2))
3058 (defun sh-calculate-indent (&optional info
)
3059 "Return the indentation for the current line.
3060 If INFO is supplied it is used, else it is calculated from current line."
3065 (setq info
(sh-get-indent-info)))
3068 (sh-debug "info: %s ofs=%s" info ofs
)
3069 (setq elt
(car info
))
3071 ((stringp elt
)) ;; do nothing?
3073 (setq a
(car (car info
)))
3074 (setq b
(nth 1 (car info
)))
3079 (setq val
(current-indentation)))
3080 (setq base-value val
))
3082 (setq val
(sh-var-value b
))
3088 ;; set info to nil so we stop immediately
3089 (setq base-value nil ofs nil info nil
))
3090 ((eq val t
) (setq ofs
0)) ;; indent as normal line
3092 ;; The following assume the (t POS) come first!
3093 (setq ofs val base-value
0)
3094 (setq info nil
)))) ;; ? stop now
3095 ((eq a
'+) (setq ofs
(+ ofs val
)))
3096 ((eq a
'-
) (setq ofs
(- ofs val
)))
3098 (error "sh-calculate-indent invalid a a=%s b=%s" a b
))))
3100 (error "sh-calculate-indent invalid elt: a=%s b=%s" a b
))))
3102 (error "sh-calculate-indent invalid elt %s" elt
)))
3103 (sh-debug "a=%s b=%s val=%s base-value=%s ofs=%s"
3104 a b val base-value ofs
)
3105 (setq info
(cdr info
)))
3107 (sh-debug "at end: base-value: %s ofs: %s" base-value ofs
)
3110 ((or (null base-value
)(null ofs
))
3112 ((and (numberp base-value
)(numberp ofs
))
3113 (sh-debug "base (%d) + ofs (%d) = %d"
3114 base-value ofs
(+ base-value ofs
))
3115 (+ base-value ofs
)) ;; return value
3117 (error "sh-calculate-indent: Help. base-value=%s ofs=%s"
3122 (defun sh-indent-line ()
3123 "Indent the current line."
3125 (let ((indent (sh-calculate-indent))
3126 (pos (- (point-max) (point))))
3129 (skip-chars-forward " \t")
3130 (indent-line-to indent
)
3131 ;; If initial point was within line's indentation,
3132 ;; position after the indentation. Else stay at same point in text.
3133 (if (> (- (point-max) pos
) (point))
3134 (goto-char (- (point-max) pos
))))))
3137 (defun sh-blink (blinkpos &optional msg
)
3138 "Move cursor momentarily to BLINKPOS and display MSG."
3139 ;; We can get here without it being a number on first line
3140 (if (numberp blinkpos
)
3142 (goto-char blinkpos
)
3143 (if msg
(message "%s" msg
) (message nil
))
3144 (sit-for blink-matching-delay
))
3145 (if msg
(message "%s" msg
) (message nil
))))
3147 (defun sh-show-indent (arg)
3148 "Show the how the current line would be indented.
3149 This tells you which variable, if any, controls the indentation of
3151 If optional arg ARG is non-null (called interactively with a prefix),
3152 a pop up window describes this variable.
3153 If variable `sh-blink' is non-nil then momentarily go to the line
3154 we are indenting relative to, if applicable."
3156 (sh-must-support-indent)
3157 (let* ((info (sh-get-indent-info))
3158 (var (sh-get-indent-var-for-line info
))
3159 (curr-indent (current-indentation))
3162 (message "%s" (setq msg var
))
3163 (setq val
(sh-calculate-indent info
))
3165 (if (eq curr-indent val
)
3166 (setq msg
(format "%s is %s" var
(symbol-value var
)))
3169 (format "%s (%s) would change indent from %d to: %d"
3170 var
(symbol-value var
) curr-indent val
)
3171 (format "%s (%s) would leave line as is"
3172 var
(symbol-value var
)))
3175 (describe-variable var
)))
3177 (let ((info (sh-get-indent-info)))
3178 (if (and info
(listp (car info
))
3179 (eq (car (car info
)) t
))
3180 (sh-blink (nth 1 (car info
)) msg
)
3181 (message "%s" msg
)))
3185 (defun sh-set-indent ()
3186 "Set the indentation for the current line.
3187 If the current line is controlled by an indentation variable, prompt
3188 for a new value for it."
3190 (sh-must-support-indent)
3191 (let* ((info (sh-get-indent-info))
3192 (var (sh-get-indent-var-for-line info
))
3193 val old-val indent-val
)
3195 (message "Cannot set indent - %s" var
)
3196 (setq old-val
(symbol-value var
))
3197 (setq val
(sh-read-variable var
))
3201 (setq indent-val
(sh-calculate-indent info
))
3203 (message "Variable: %s Value: %s would indent to: %d"
3204 var
(symbol-value var
) indent-val
)
3205 (message "Variable: %s Value: %s would leave line as is."
3206 var
(symbol-value var
)))
3207 ;; I'm not sure about this, indenting it now?
3208 ;; No. Because it would give the impression that an undo would
3209 ;; restore thing, but the value has been altered.
3214 (message "Bad value for %s, restoring to previous value %s"
3221 (defun sh-learn-line-indent (arg)
3222 "Learn how to indent a line as it currently is indented.
3224 If there is an indentation variable which controls this line's indentation,
3225 then set it to a value which would indent the line the way it
3228 If the value can be represented by one of the symbols then do so
3229 unless optional argument ARG (the prefix when interactive) is non-nil."
3231 (sh-must-support-indent)
3232 ;; I'm not sure if we show allow learning on an empty line.
3233 ;; Though it might occasionally be useful I think it usually
3234 ;; would just be confusing.
3237 (looking-at "\\s-*$"))
3238 (message "sh-learn-line-indent ignores empty lines.")
3239 (let* ((info (sh-get-indent-info))
3240 (var (sh-get-indent-var-for-line info
))
3241 ival sval diff new-val
3243 (curr-indent (current-indentation)))
3246 (message "Cannot learn line - %s" var
))
3247 ((eq var
'sh-indent-comment
)
3248 ;; This is arbitrary...
3249 ;; - if curr-indent is 0, set to curr-indent
3250 ;; - else if it has the indentation of a "normal" line,
3252 ;; - else set to curr-indent.
3253 (setq sh-indent-comment
3254 (if (= curr-indent
0)
3256 (let* ((sh-indent-comment t
)
3257 (val2 (sh-calculate-indent info
)))
3258 (if (= val2 curr-indent
)
3261 (message "%s set to %s" var
(symbol-value var
))
3263 ((numberp (setq sval
(sh-var-value var
)))
3264 (setq ival
(sh-calculate-indent info
))
3265 (setq diff
(- curr-indent ival
))
3267 (sh-debug "curr-indent: %d ival: %d diff: %d var:%s sval %s"
3268 curr-indent ival diff var sval
)
3269 (setq new-val
(+ sval diff
))
3270 ;;; I commented out this because someone might want to replace
3271 ;;; a value of `+' with the current value of sh-basic-offset
3274 ;;; (message "No change needed!")
3275 (sh-set-var-value var new-val no-symbol
)
3276 (message "%s set to %s" var
(symbol-value var
))
3280 (message "Cannot change %s" var
))))))
3284 (defun sh-mark-init (buffer)
3285 "Initialize a BUFFER to be used by `sh-mark-line'."
3286 (with-current-buffer (get-buffer-create buffer
)
3291 (defun sh-mark-line (message point buffer
&optional add-linenum occur-point
)
3292 "Insert MESSAGE referring to location POINT in current buffer into BUFFER.
3293 Buffer BUFFER is in `occur-mode'.
3294 If ADD-LINENUM is non-nil the message is preceded by the line number.
3295 If OCCUR-POINT is non-nil then the line is marked as a new occurrence
3296 so that `occur-next' and `occur-prev' will work."
3297 (let ((m1 (make-marker))
3301 (set-marker m1 point
(current-buffer))
3303 (setq line
(format "%d: " (1+ (count-lines 1 point
))))))
3305 (if (get-buffer buffer
)
3306 (set-buffer (get-buffer buffer
))
3307 (set-buffer (get-buffer-create buffer
))
3310 (goto-char (point-max))
3311 (setq start
(point))
3314 (setq occur-point
(point)))
3317 (add-text-properties
3319 '(mouse-face highlight
3320 help-echo
"mouse-2: go to the line where I learned this")))
3324 (put-text-property start
(point) 'occur-target m1
)
3326 (put-text-property start occur-point
3333 ;; Is this really worth having?
3334 (defvar sh-learned-buffer-hook nil
3335 "An abnormal hook, called with an alist of learned variables.")
3336 ;; Example of how to use sh-learned-buffer-hook
3338 ;; (defun what-i-learned (list)
3340 ;; (with-current-buffer "*scratch*"
3341 ;; (goto-char (point-max))
3342 ;; (insert "(setq\n")
3344 ;; (insert (format " %s %s \n"
3345 ;; (nth 0 (car p)) (nth 1 (car p))))
3346 ;; (setq p (cdr p)))
3350 ;; (add-hook 'sh-learned-buffer-hook 'what-i-learned)
3353 ;; Originally this was sh-learn-region-indent (beg end)
3354 ;; However, in practice this was awkward so I changed it to
3355 ;; use the whole buffer. Use narrowing if needbe.
3356 (defun sh-learn-buffer-indent (&optional arg
)
3357 "Learn how to indent the buffer the way it currently is.
3359 Output in buffer \"*indent*\" shows any lines which have conflicting
3360 values of a variable, and the final value of all variables learned.
3361 When called interactively, pop to this buffer automatically if
3362 there are any discrepancies.
3364 If no prefix ARG is given, then variables are set to numbers.
3365 If a prefix arg is given, then variables are set to symbols when
3366 applicable -- e.g. to symbol `+' if the value is that of the
3368 If a positive numerical prefix is given, then `sh-basic-offset'
3369 is set to the prefix's numerical value.
3370 Otherwise, sh-basic-offset may or may not be changed, according
3371 to the value of variable `sh-learn-basic-offset'.
3373 Abnormal hook `sh-learned-buffer-hook' if non-nil is called when the
3374 function completes. The function is abnormal because it is called
3375 with an alist of variables learned. This feature may be changed or
3376 removed in the future.
3378 This command can often take a long time to run."
3380 (sh-must-support-indent)
3382 (goto-char (point-min))
3383 (let ((learned-var-list nil
)
3384 (out-buffer "*indent*")
3390 (comment-col nil
) ;; number if all same, t if seen diff values
3391 (comments-always-default t
) ;; nil if we see one not default
3393 (specified-basic-offset (and arg
(numberp arg
)
3397 (setq vec
(make-vector max
0))
3398 (sh-mark-init out-buffer
)
3400 (if specified-basic-offset
3402 (setq sh-basic-offset arg
)
3404 (format "Using specified sh-basic-offset of %d"
3407 (format "Initial value of sh-basic-offset: %s"
3410 (while (< (point) (point-max))
3411 (setq linenum
(1+ linenum
))
3412 ;; (if (zerop (% linenum 10))
3413 (message "line %d" linenum
)
3415 (unless (looking-at "\\s-*$") ;; ignore empty lines!
3416 (let* ((sh-indent-comment t
) ;; info must return default indent
3417 (info (sh-get-indent-info))
3418 (var (sh-get-indent-var-for-line info
))
3419 sval ival diff new-val
3420 (curr-indent (current-indentation)))
3426 ((numberp (setq sval
(sh-var-value var
'no-error
)))
3427 ;; the numberp excludes comments since sval will be t.
3428 (setq ival
(sh-calculate-indent))
3429 (setq diff
(- curr-indent ival
))
3430 (setq new-val
(+ sval diff
))
3431 (sh-set-var-value var new-val
'no-symbol
)
3432 (unless (looking-at "\\s-*#") ;; don't learn from comments
3433 (if (setq previous-set-info
(assoc var learned-var-list
))
3435 ;; it was already there, is it same value ?
3436 (unless (eq (symbol-value var
)
3437 (nth 1 previous-set-info
))
3439 (format "Variable %s was set to %s"
3440 var
(symbol-value var
))
3441 (point) out-buffer t t
)
3443 (format " but was previously set to %s"
3444 (nth 1 previous-set-info
))
3445 (nth 2 previous-set-info
) out-buffer t
)
3446 (setq num-diffs
(1+ num-diffs
))
3447 ;; (delete previous-set-info learned-var-list)
3448 (setcdr previous-set-info
3449 (list (symbol-value var
) (point)))
3452 (setq learned-var-list
3453 (append (list (list var
(symbol-value var
)
3456 (if (numberp new-val
)
3459 "This line's indent value: %d" new-val
)
3461 (setq new-val
(- new-val
)))
3463 (aset vec new-val
(1+ (aref vec new-val
))))))
3465 ((eq var
'sh-indent-comment
)
3466 (unless (= curr-indent
(sh-calculate-indent info
))
3467 ;; this is not the default indentation
3468 (setq comments-always-default nil
)
3469 (if comment-col
;; then we have see one before
3470 (or (eq comment-col curr-indent
)
3471 (setq comment-col t
)) ;; seen a different one
3472 (setq comment-col curr-indent
))
3475 (sh-debug "Cannot learn this line!!!")
3478 "at %s learned-var-list is %s" (point) learned-var-list
)
3485 "comment-col = %s comments-always-default = %s"
3486 comment-col comments-always-default
))
3488 (sh-mark-line msg nil out-buffer
)))
3491 (setq msg
"\nComments are all in 1st column.\n"))
3492 (comments-always-default
3493 (setq msg
"\nComments follow default indentation.\n")
3494 (setq comment-col t
))
3495 ((numberp comment-col
)
3496 (setq msg
(format "\nComments are in col %d." comment-col
)))
3498 (setq msg
"\nComments seem to be mixed, leaving them as is.\n")
3499 (setq comment-col nil
)
3502 (sh-mark-line msg nil out-buffer
)
3504 (sh-mark-line initial-msg nil out-buffer t t
)
3506 (setq suggested
(sh-guess-basic-offset vec
))
3508 (if (and suggested
(not specified-basic-offset
))
3511 ;; t => set it if we have a single value as a number
3512 ((and (eq sh-learn-basic-offset t
) (numberp suggested
))
3514 ;; other non-nil => set it if only one value was found
3515 (sh-learn-basic-offset
3516 (if (numberp suggested
)
3518 (if (= (length suggested
) 1)
3524 (setq learned-var-list
3525 (append (list (list 'sh-basic-offset
3526 (setq sh-basic-offset new-value
)
3529 ;; Not sure if we need to put this line in, since
3530 ;; it will appear in the "Learned variable settings".
3532 (format "Changed sh-basic-offset to: %d" sh-basic-offset
)
3535 (if (listp suggested
)
3536 (format "Possible value(s) for sh-basic-offset: %s"
3537 (mapconcat 'int-to-string suggested
" "))
3538 (format "Suggested sh-basic-offset: %d" suggested
))
3542 (setq learned-var-list
3543 (append (list (list 'sh-indent-comment comment-col
(point-max)))
3545 (setq sh-indent-comment comment-col
)
3546 (let ((name (buffer-name)))
3547 (sh-mark-line "\nLearned variable settings:" nil out-buffer
)
3549 ;; Set learned variables to symbolic rather than numeric
3550 ;; values where possible.
3551 (dolist (learned-var (reverse learned-var-list
))
3552 (let ((var (car learned-var
))
3553 (val (nth 1 learned-var
)))
3554 (when (and (not (eq var
'sh-basic-offset
))
3556 (sh-set-var-value var val
)))))
3557 (dolist (learned-var (reverse learned-var-list
))
3558 (let ((var (car learned-var
)))
3559 (sh-mark-line (format " %s %s" var
(symbol-value var
))
3560 (nth 2 learned-var
) out-buffer
)))
3561 (with-current-buffer out-buffer
3562 (goto-char (point-min))
3564 (format "Indentation values for buffer %s.\n" name
)
3565 (format "%d indentation variable%s different values%s\n\n"
3569 (if (zerop num-diffs
)
3572 ;; Are abnormal hooks considered bad form?
3573 (run-hook-with-args 'sh-learned-buffer-hook learned-var-list
)
3574 (and (called-interactively-p 'any
)
3575 (or sh-popup-occur-buffer
(> num-diffs
0))
3576 (pop-to-buffer out-buffer
)))))
3578 (defun sh-guess-basic-offset (vec)
3579 "See if we can determine a reasonable value for `sh-basic-offset'.
3580 This is experimental, heuristic and arbitrary!
3581 Argument VEC is a vector of information collected by
3582 `sh-learn-buffer-indent'.
3584 number - there appears to be a good single value
3585 list of numbers - no obvious one, here is a list of one or more
3587 nil - we couldn't find a reasonable one."
3588 (let* ((max (1- (length vec
)))
3590 (totals (make-vector max
0)))
3592 (aset totals i
(+ (aref totals i
) (* 4 (aref vec i
))))
3594 (aset totals i
(+ (aref totals i
) (aref vec
(/ i
2)))))
3596 (aset totals i
(+ (aref totals i
) (aref vec
(* i
2)))))
3604 (if (/= (aref totals i
) 0)
3605 (setq x
(append x
(list (cons i
(aref totals i
))))))
3608 (setq x
(sort x
(lambda (a b
) (> (cdr a
) (cdr b
)))))
3609 (setq tot
(apply '+ (append totals nil
)))
3610 (sh-debug (format "vec: %s\ntotals: %s\ntot: %d"
3614 (message "no values!")) ;; we return nil
3616 (message "only value is %d" (car (car x
)))
3617 (setq result
(car (car x
)))) ;; return single value
3618 ((> (cdr (car x
)) (/ tot
2))
3620 (message "basic-offset is probably %d" (car (car x
)))
3621 (setq result
(car (car x
)))) ;; again, return a single value
3622 ((>= (cdr (car x
)) (* 2 (cdr (car (cdr x
)))))
3623 ;; 1st is >= 2 * 2nd
3624 (message "basic-offset could be %d" (car (car x
)))
3625 (setq result
(car (car x
))))
3626 ((>= (+ (cdr (car x
))(cdr (car (cdr x
)))) (/ tot
2))
3627 ;; 1st & 2nd together >= 50% - return a list
3628 (setq p x sum
0 result nil
)
3630 (<= (setq sum
(+ sum
(cdr (car p
)))) (/ tot
2)))
3631 (setq result
(append result
(list (car (car p
)))))
3633 (message "Possible choices for sh-basic-offset: %s"
3634 (mapconcat 'int-to-string result
" ")))
3636 (message "No obvious value for sh-basic-offset. Perhaps %d"
3638 ;; result is nil here
3642 ;; ========================================================================
3644 ;; Styles -- a quick and dirty way of saving the indentation settings.
3646 (defvar sh-styles-alist nil
3647 "A list of all known shell indentation styles.")
3649 (defun sh-name-style (name &optional confirm-overwrite
)
3650 "Name the current indentation settings as a style called NAME.
3651 If this name exists, the command will prompt whether it should be
3653 - - it was called interactively with a prefix argument, or
3654 - - called non-interactively with optional CONFIRM-OVERWRITE non-nil."
3655 ;; (interactive "sName for this style: ")
3658 (read-from-minibuffer "Name for this style? " )
3659 (not current-prefix-arg
)))
3660 (let ((slist (cons name
3661 (mapcar (lambda (var) (cons var
(symbol-value var
)))
3663 (style (assoc name sh-styles-alist
)))
3665 (if (and confirm-overwrite
3666 (not (y-or-n-p "This style exists. Overwrite it? ")))
3667 (message "Not changing style %s" name
)
3668 (message "Updating style %s" name
)
3669 (setcdr style
(cdr slist
)))
3670 (message "Creating new style %s" name
)
3671 (push slist sh-styles-alist
))))
3673 (defun sh-load-style (name)
3674 "Set shell indentation values for this buffer from those in style NAME."
3675 (interactive (list (completing-read
3676 "Which style to use for this buffer? "
3677 sh-styles-alist nil t
)))
3678 (let ((sl (assoc name sh-styles-alist
)))
3680 (error "sh-load-style - style %s not known" name
)
3681 (dolist (var (cdr sl
))
3682 (set (car var
) (cdr var
))))))
3684 (defun sh-save-styles-to-buffer (buff)
3685 "Save all current styles in elisp to buffer BUFF.
3686 This is always added to the end of the buffer."
3689 (read-from-minibuffer "Buffer to save styles in? " "*scratch*")))
3690 (with-current-buffer (get-buffer-create buff
)
3691 (goto-char (point-max))
3693 (pp `(setq sh-styles-alist
',sh-styles-alist
) (current-buffer))))
3697 ;; statement syntax-commands for various shells
3699 ;; You are welcome to add the syntax or even completely new statements as
3700 ;; appropriate for your favorite shell.
3702 (defconst sh-non-closing-paren
3703 ;; If we leave it rear-sticky, calling `newline' ends up inserting a \n
3704 ;; that inherits this property, which then confuses the indentation.
3705 (propertize ")" 'syntax-table sh-st-punc
'rear-nonsticky t
))
3707 (define-skeleton sh-case
3708 "Insert a case/switch statement. See `sh-feature'."
3710 "switch( " str
" )" \n
3711 > "case " (read-string "pattern: ") ?
: \n
3714 ( "other pattern, %s: "
3724 > "switch( " str
" ) {" \n
3725 > "case " (read-string "pattern: ") \n
3727 ( "other pattern, %s: "
3735 > "case " str
" in" \n
3737 > str sh-non-closing-paren
\n
3740 > "*" sh-non-closing-paren
\n
3745 (define-skeleton sh-for
3746 "Insert a for loop. See `sh-feature'."
3760 (sh "Index variable: "
3761 > "for " str
" in " _
"; do" \n
3762 > _ | ?$
& (sh-remember-variable str
) \n
3767 (define-skeleton sh-indexed-loop
3768 "Insert an indexed loop from 1 to n. See `sh-feature'."
3769 (bash sh-modify posix
)
3770 (csh "Index variable: "
3772 "while( $" str
" <= " (read-string "upper limit: ") " )" \n
3778 (ksh88 "Index variable: "
3779 > "integer " str
"=0" \n
3780 > "while (( ( " str
" += 1 ) <= "
3781 (read-string "upper limit: ")
3783 > _ ?$
(sh-remember-variable str
) > \n
3785 (posix "Index variable: "
3787 "while [ $" str
" -le "
3788 (read-string "upper limit: ")
3791 str ?
= (sh-add (sh-remember-variable str
) 1) \n
3793 (rc "Index variable: "
3794 > "for( " str
" in" " `{awk 'BEGIN { for( i=1; i<="
3795 (read-string "upper limit: ")
3796 "; i++ ) print i }'`}) {" \n
3797 > _ ?$
(sh-remember-variable str
) \n
3799 (sh "Index variable: "
3800 > "for " str
" in `awk 'BEGIN { for( i=1; i<="
3801 (read-string "upper limit: ")
3802 "; i++ ) print i }'`; do" \n
3803 > _ ?$
(sh-remember-variable str
) \n
3807 (defun sh-shell-initialize-variables ()
3808 "Scan the buffer for variable assignments.
3809 Add these variables to `sh-shell-variables'."
3810 (message "Scanning buffer `%s' for variable assignments..." (buffer-name))
3812 (goto-char (point-min))
3813 (setq sh-shell-variables-initialized t
)
3814 (while (search-forward "=" nil t
)
3816 (message "Scanning buffer `%s' for variable assignments...done"
3819 (defvar sh-add-buffer
)
3821 (defun sh-add-completer (string predicate code
)
3822 "Do completion using `sh-shell-variables', but initialize it first.
3823 This function is designed for use as the \"completion table\",
3824 so it takes three arguments:
3825 STRING, the current buffer contents;
3826 PREDICATE, the predicate for filtering possible matches;
3827 CODE, which says what kind of things to do.
3828 CODE can be nil, t or `lambda'.
3829 nil means to return the best completion of STRING, or nil if there is none.
3830 t means to return a list of all possible completions of STRING.
3831 `lambda' means to return t if STRING is a valid completion as it stands."
3833 (with-current-buffer sh-add-buffer
3834 (or sh-shell-variables-initialized
3835 (sh-shell-initialize-variables))
3836 (nconc (mapcar (lambda (var)
3837 (substring var
0 (string-match "=" var
)))
3838 process-environment
)
3839 sh-shell-variables
))))
3840 (complete-with-action code vars string predicate
)))
3842 (defun sh-add (var delta
)
3843 "Insert an addition of VAR and prefix DELTA for Bourne (type) shell."
3845 (let ((sh-add-buffer (current-buffer)))
3846 (list (completing-read "Variable: " 'sh-add-completer
)
3847 (prefix-numeric-value current-prefix-arg
))))
3848 (insert (sh-feature '((bash .
"$(( ")
3854 (sh-remember-variable var
)
3855 (if (< delta
0) " - " " + ")
3856 (number-to-string (abs delta
))
3857 (sh-feature '((bash .
" ))")
3866 (define-skeleton sh-function
3867 "Insert a function definition. See `sh-feature'."
3868 (bash sh-modify ksh88
3871 "function " str
" {" \n
3883 (define-skeleton sh-if
3884 "Insert an if statement. See `sh-feature'."
3886 "if( " str
" ) then" \n
3888 ( "other condition, %s: "
3889 < "else if( " str
" ) then" \n
3896 > "if { " str
" } {" \n
3898 ( "other condition, %s: "
3899 "} { " str
" } {" > \n
3906 > "if( " str
" ) {" \n
3908 ( "other condition, %s: "
3909 "} else if( " str
" ) {" > \n
3916 '(setq input
(sh-feature sh-test
))
3917 > "if " str
"; then" \n
3919 ( "other condition, %s: "
3920 > "elif " str
"; then" > \n
3929 (define-skeleton sh-repeat
3930 "Insert a repeat loop definition. See `sh-feature'."
3936 > "repeat " str
"; do" > \n
3940 ;;;(put 'sh-repeat 'menu-enable '(sh-feature sh-repeat))
3944 (define-skeleton sh-select
3945 "Insert a select statement. See `sh-feature'."
3946 (ksh88 "Index variable: "
3947 > "select " str
" in " _
"; do" \n
3950 (bash sh-append ksh88
))
3951 ;;;(put 'sh-select 'menu-enable '(sh-feature sh-select))
3955 (define-skeleton sh-tmp-file
3956 "Insert code to setup temporary file handling. See `sh-feature'."
3957 (bash sh-append ksh88
)
3958 (csh (file-name-nondirectory (buffer-file-name))
3959 "set tmp = `mktemp -t " str
".XXXXXX`" \n
3961 (and (goto-char (point-max))
3965 "rm $tmp* >&/dev/null" > \n)
3966 (es (file-name-nondirectory (buffer-file-name))
3967 > "local( signals = $signals sighup sigint;" \n
3968 > "tmp = `{ mktemp -t " str
".XXXXXX } ) {" \n
3970 > "rm $tmp^* >[2]/dev/null" \n
3978 (rc (file-name-nondirectory (buffer-file-name))
3979 > "tmp = `{ mktemp -t " str
".XXXXXX }" \n
3980 "fn sigexit { rm $tmp^* >[2]/dev/null }" \n)
3981 (sh (file-name-nondirectory (buffer-file-name))
3982 > "TMP=`mktemp -t " str
".XXXXXX`" \n
3983 "trap \"rm $TMP* 2>/dev/null\" " ?
0 \n))
3987 (define-skeleton sh-until
3988 "Insert an until loop. See `sh-feature'."
3990 '(setq input
(sh-feature sh-test
))
3991 > "until " str
"; do" \n
3994 ;;;(put 'sh-until 'menu-enable '(sh-feature sh-until))
3998 (define-skeleton sh-while
3999 "Insert a while loop. See `sh-feature'."
4015 '(setq input
(sh-feature sh-test
))
4016 > "while " str
"; do" \n
4022 (define-skeleton sh-while-getopts
4023 "Insert a while getopts loop. See `sh-feature'.
4024 Prompts for an options string which consists of letters for each recognized
4025 option followed by a colon `:' if the option accepts an argument."
4030 > "switch( \"$1\" )" \n
4031 '(setq input
'("- x" .
2))
4034 < "case " '(eval str
)
4035 '(if (string-match " +" str
)
4036 (setq v1
(substring str
(match-end 0))
4037 str
(substring str
0 (match-beginning 0)))
4040 > "set " v1
& " = $2" | -
4 & _
\n
4041 (if v1
"shift") & \n
4056 18 "$(basename $0)")
4058 > "while getopts :" str
" OPT; do" \n
4060 '(setq v1
(append (vconcat str
) nil
))
4061 ( (prog1 (if v1
(char-to-string (car v1
)))
4062 (if (eq (nth 1 v1
) ?
:)
4063 (setq v1
(nthcdr 2 v1
)
4067 > str
"|+" str sh-non-closing-paren
\n
4070 > "*" sh-non-closing-paren
\n
4071 > "echo" " \"usage: " "`basename $0`"
4072 " [+-" '(setq v1
(point)) str
4074 (while (search-backward ":" v1 t
)
4075 (replace-match " ARG] [+-" t t
)))
4076 (if (eq (preceding-char) ?-
) -
5)
4077 (if (and (sequencep v1
) (length v1
)) "] " "} ")
4083 "shift " (sh-add "OPTIND" -
1) \n
4088 (defun sh-assignment (arg)
4089 "Remember preceding identifier for future completion and do self-insert."
4091 (self-insert-command arg
)
4093 (sh-remember-variable
4095 (if (re-search-forward (sh-feature sh-assignment-regexp
)
4097 (beginning-of-line 1))
4099 (match-string 1))))))
4102 (defun sh-maybe-here-document (arg)
4103 "Insert self. Without prefix, following unquoted `<' inserts here document.
4104 The document is bounded by `sh-here-document-word'."
4105 (declare (obsolete sh-electric-here-document-mode
"24.3"))
4107 (self-insert-command (prefix-numeric-value arg
))
4108 (or arg
(sh--maybe-here-document)))
4110 (defun sh--maybe-here-document ()
4111 (or (not (looking-back "[^<]<<"))
4115 (nth 8 (syntax-ppss))
4116 (let ((tabs (if (string-match "\\`-" sh-here-document-word
)
4117 (make-string (/ (current-indentation) tab-width
) ?
\t)
4119 (delim (replace-regexp-in-string "['\"]" ""
4120 sh-here-document-word
)))
4121 (insert sh-here-document-word
)
4122 (or (eolp) (looking-at "[ \t]") (insert ?\s
))
4129 (insert ?
\n tabs
(replace-regexp-in-string
4130 "\\`-?[ \t]*" "" delim
))))))
4132 (define-minor-mode sh-electric-here-document-mode
4133 "Make << insert a here document skeleton."
4135 (if sh-electric-here-document-mode
4136 (add-hook 'post-self-insert-hook
#'sh--maybe-here-document nil t
)
4137 (remove-hook 'post-self-insert-hook
#'sh--maybe-here-document t
)))
4139 ;; various other commands
4141 (defun sh-beginning-of-command ()
4142 ;; FIXME: Redefine using SMIE.
4143 "Move point to successive beginnings of commands."
4145 (if (re-search-backward sh-beginning-of-command nil t
)
4146 (goto-char (match-beginning 2))))
4148 (defun sh-end-of-command ()
4149 ;; FIXME: Redefine using SMIE.
4150 "Move point to successive ends of commands."
4152 (if (re-search-forward sh-end-of-command nil t
)
4153 (goto-char (match-end 1))))
4155 ;; Backslashification. Stolen from make-mode.el.
4157 (defun sh-backslash-region (from to delete-flag
)
4158 "Insert, align, or delete end-of-line backslashes on the lines in the region.
4159 With no argument, inserts backslashes and aligns existing backslashes.
4160 With an argument, deletes the backslashes.
4162 This function does not modify the last line of the region if the region ends
4163 right at the start of the following line; it does not modify blank lines
4164 at the start of the region. So you can put the region around an entire
4165 shell command and conveniently use this command."
4166 (interactive "r\nP")
4169 (let ((column sh-backslash-column
)
4170 (endmark (make-marker)))
4171 (move-marker endmark to
)
4172 ;; Compute the smallest column number past the ends of all the lines.
4173 (if sh-backslash-align
4175 (if (not delete-flag
)
4176 (while (< (point) to
)
4178 (if (= (preceding-char) ?
\\)
4179 (progn (forward-char -
1)
4180 (skip-chars-backward " \t")))
4181 (setq column
(max column
(1+ (current-column))))
4183 ;; Adjust upward to a tab column, if that doesn't push
4185 (if (> (% column tab-width
) 0)
4186 (let ((adjusted (* (/ (+ column tab-width -
1) tab-width
)
4188 (if (< adjusted
(window-width))
4189 (setq column adjusted
))))))
4190 ;; Don't modify blank lines at start of region.
4192 (while (and (< (point) endmark
) (eolp))
4194 ;; Add or remove backslashes on all the lines.
4195 (while (and (< (point) endmark
)
4196 ;; Don't backslashify the last line
4197 ;; if the region ends right at the start of the next line.
4200 (< (point) endmark
)))
4201 (if (not delete-flag
)
4202 (sh-append-backslash column
)
4203 (sh-delete-backslash))
4205 (move-marker endmark nil
))))
4207 (defun sh-append-backslash (column)
4209 ;; Note that "\\\\" is needed to get one backslash.
4210 (if (= (preceding-char) ?
\\)
4211 (progn (forward-char -
1)
4212 (delete-horizontal-space)
4213 (indent-to column
(if sh-backslash-align nil
1)))
4214 (indent-to column
(if sh-backslash-align nil
1))
4217 (defun sh-delete-backslash ()
4222 (if (looking-at "\\\\")
4223 (delete-region (1+ (point))
4224 (progn (skip-chars-backward " \t") (point)))))))
4226 (provide 'sh-script
)
4228 ;;; sh-script.el ends here