1 ;;; sh-script.el --- shell-script editing commands for Emacs
3 ;; Copyright (C) 1993, 1994, 1995, 1996, 1997, 1999, 2001, 2003, 2004, 2005
4 ;; Free Software Foundation, Inc.
6 ;; Author: Daniel Pfeiffer <occitan@esperanto.org>
9 ;; Keywords: languages, unix
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
30 ;; Major mode for editing shell scripts. Bourne, C and rc shells as well
31 ;; as various derivatives are supported and easily derived from. Structured
32 ;; statements can be inserted with one command or abbrev. Completion is
33 ;; available for filenames, variables known from the script, the shell and
34 ;; the environment as well as commands.
38 ;; - In Bourne the keyword `in' is not anchored to case, for, select ...
39 ;; - Variables in `"' strings aren't fontified because there's no way of
40 ;; syntactically distinguishing those from `'' strings.
44 ;; Indentation for rc and es modes is very limited, but for Bourne shells
45 ;; and its derivatives it is quite customizable.
47 ;; The following description applies to sh and derived shells (bash,
50 ;; There are various customization variables which allow tailoring to
51 ;; a wide variety of styles. Most of these variables are named
52 ;; sh-indent-for-XXX and sh-indent-after-XXX. For example.
53 ;; sh-indent-after-if controls the indenting of a line following
54 ;; an if statement, and sh-indent-for-fi controls the indentation
55 ;; of the line containing the fi.
57 ;; You can set each to a numeric value, but it is often more convenient
58 ;; to a symbol such as `+' which uses the value of variable `sh-basic-offset'.
59 ;; By changing this one variable you can increase or decrease how much
60 ;; indentation there is. Valid symbols:
62 ;; + Indent right by sh-basic-offset
63 ;; - Indent left by sh-basic-offset
64 ;; ++ Indent right twice sh-basic-offset
65 ;; -- Indent left twice sh-basic-offset
66 ;; * Indent right half sh-basic-offset
67 ;; / Indent left half sh-basic-offset.
69 ;; There are 4 commands to help set the indentation variables:
72 ;; This shows what variable controls the indentation of the current
73 ;; line and its value.
76 ;; This allows you to set the value of the variable controlling the
77 ;; current line's indentation. You can enter a number or one of a
78 ;; number of special symbols to denote the value of sh-basic-offset,
79 ;; or its negative, or half it, or twice it, etc. If you've used
80 ;; cc-mode this should be familiar. If you forget which symbols are
81 ;; valid simply press C-h at the prompt.
83 ;; `sh-learn-line-indent'
84 ;; Simply make the line look the way you want it, then invoke this
85 ;; command. It will set the variable to the value that makes the line
86 ;; indent like that. If called with a prefix argument then it will set
87 ;; the value to one of the symbols if applicable.
89 ;; `sh-learn-buffer-indent'
90 ;; This is the deluxe function! It "learns" the whole buffer (use
91 ;; narrowing if you want it to process only part). It outputs to a
92 ;; buffer *indent* any conflicts it finds, and all the variables it has
93 ;; learned. This buffer is a sort of Occur mode buffer, allowing you to
94 ;; easily find where something was set. It is popped to automatically
95 ;; if there are any conflicts found or if `sh-popup-occur-buffer' is
97 ;; `sh-indent-comment' will be set if all comments follow the same
98 ;; pattern; if they don't it will be set to nil.
99 ;; Whether `sh-basic-offset' is set is determined by variable
100 ;; `sh-learn-basic-offset'.
102 ;; Unfortunately, `sh-learn-buffer-indent' can take a long time to run
103 ;; (e.g. if there are large case statements). Perhaps it does not make
104 ;; sense to run it on large buffers: if lots of lines have different
105 ;; indentation styles it will produce a lot of diagnostics in the
106 ;; *indent* buffer; if there is a consistent style then running
107 ;; `sh-learn-buffer-indent' on a small region of the buffer should
110 ;; Saving indentation values
111 ;; -------------------------
112 ;; After you've learned the values in a buffer, how to you remember
113 ;; them? Originally I had hoped that `sh-learn-buffer-indent'
114 ;; would make this unnecessary; simply learn the values when you visit
116 ;; You can do this automatically like this:
117 ;; (add-hook 'sh-set-shell-hook 'sh-learn-buffer-indent)
119 ;; However... `sh-learn-buffer-indent' is extremely slow,
120 ;; especially on large-ish buffer. Also, if there are conflicts the
121 ;; "last one wins" which may not produce the desired setting.
123 ;; So...There is a minimal way of being able to save indentation values and
124 ;; to reload them in another buffer or at another point in time.
126 ;; Use `sh-name-style' to give a name to the indentation settings of
127 ;; the current buffer.
128 ;; Use `sh-load-style' to load indentation settings for the current
129 ;; buffer from a specific style.
130 ;; Use `sh-save-styles-to-buffer' to write all the styles to a buffer
131 ;; in lisp code. You can then store it in a file and later use
132 ;; `load-file' to load it.
134 ;; Indentation variables - buffer local or global?
135 ;; ----------------------------------------------
136 ;; I think that often having them buffer-local makes sense,
137 ;; especially if one is using `sh-learn-buffer-indent'. However, if
138 ;; a user sets values using customization, these changes won't appear
139 ;; to work if the variables are already local!
141 ;; To get round this, there is a variable `sh-make-vars-local' and 2
142 ;; functions: `sh-make-vars-local' and `sh-reset-indent-vars-to-global-values'.
144 ;; If `sh-make-vars-local' is non-nil, then these variables become
145 ;; buffer local when the mode is established.
146 ;; If this is nil, then the variables are global. At any time you
147 ;; can make them local with the command `sh-make-vars-local'.
148 ;; Conversely, to update with the global values you can use the
149 ;; command `sh-reset-indent-vars-to-global-values'.
151 ;; This may be awkward, but the intent is to cover all cases.
153 ;; Awkward things, pitfalls
154 ;; ------------------------
155 ;; Indentation for a sh script is complicated for a number of reasons:
157 ;; 1. You can't format by simply looking at symbols, you need to look
158 ;; at keywords. [This is not the case for rc and es shells.]
159 ;; 2. The character ")" is used both as a matched pair "(" ... ")" and
160 ;; as a stand-alone symbol (in a case alternative). This makes
161 ;; things quite tricky!
162 ;; 3. Here-documents in a script should be treated "as is", and when
163 ;; they terminate we want to revert to the indentation of the line
164 ;; containing the "<<" symbol.
165 ;; 4. A line may be continued using the "\".
166 ;; 5. The character "#" (outside a string) normally starts a comment,
167 ;; but it doesn't in the sequence "$#"!
169 ;; To try and address points 2 3 and 5 I used a feature that cperl mode
170 ;; uses, that of a text's syntax property. This, however, has 2
172 ;; 1. We need to scan the buffer to find which ")" symbols belong to a
173 ;; case alternative, to find any here documents, and handle "$#".
174 ;; 2. Setting the text property makes the buffer modified. If the
175 ;; buffer is read-only buffer we have to cheat and bypass the read-only
176 ;; status. This is for cases where the buffer started read-only buffer
177 ;; but the user issued `toggle-read-only'.
181 ;; - Indenting many lines is slow. It currently does each line
182 ;; independently, rather than saving state information.
184 ;; - `sh-learn-buffer-indent' is extremely slow.
186 ;; Richard Sharman <rsharman@pobox.com> June 1999.
190 ;; page 1: variables and settings
191 ;; page 2: indentation stuff
192 ;; page 3: mode-command and utility functions
193 ;; page 4: statement syntax-commands for various shells
194 ;; page 5: various other commands
200 (require 'executable)
205 "Shell programming utilities"
209 (defgroup sh-script nil
215 (defcustom sh-ancestor-alist
234 "*Alist showing the direct ancestor of various shells.
235 This is the basis for `sh-feature'. See also `sh-alias-alist'.
236 By default we have the following three hierarchies:
239 jcsh C Shell with Job Control
241 itcsh ? Turbo C Shell
246 jsh Bourne Shell with Job Control
247 bash GNU Bourne Again Shell
250 dtksh CDE Desktop Korn Shell
251 pdksh Public Domain Korn Shell
252 wksh Window Korn Shell
254 oash SCO OA (curses) Shell
255 posix IEEE 1003.2 Shell Standard
257 :type '(repeat (cons symbol symbol))
261 (defcustom sh-alias-alist
262 (append (if (eq system-type 'gnu/linux)
265 ;; for the time being
269 "*Alist for transforming shell names to what they really are.
270 Use this where the name of the executable doesn't correspond to the type of
272 :type '(repeat (cons symbol symbol))
276 (defcustom sh-shell-file
278 ;; On MSDOS and Windows, collapse $SHELL to lower-case and remove
279 ;; the executable extension, so comparisons with the list of
280 ;; known shells work.
281 (and (memq system-type '(ms-dos windows-nt))
282 (let* ((shell (getenv "SHELL"))
284 (and shell (file-name-nondirectory shell))))
285 ;; shell-script mode doesn't support DOS/Windows shells,
286 ;; so use the default instead.
288 (member (downcase shell-base)
289 '("command.com" "cmd.exe" "4dos.com" "ndos.com"
292 (file-name-sans-extension (downcase shell)))))
295 "*The executable file name for the shell being programmed."
300 (defcustom sh-shell-arg
301 ;; bash does not need any options when run in a shell script,
305 ;; Bill_Mann@praxisint.com says -p with ksh can do harm.
307 ;; -p means don't initialize functions from the environment.
309 ;; Someone proposed -motif, but we don't want to encourage
310 ;; use of a non-free widget set.
312 ;; -f means don't run .zshrc.
314 "*Single argument string for the magic number. See `sh-feature'."
315 :type '(repeat (cons (symbol :tag "Shell")
316 (choice (const :tag "No Arguments" nil)
317 (string :tag "Arguments")
318 (sexp :format "Evaluate: %v"))))
321 (defcustom sh-imenu-generic-expression
323 . ((nil "^\\s-*\\(function\\s-+\\)?\\([A-Za-z_][A-Za-z_0-9]+\\)\\s-*()" 2))))
324 "*Alist of regular expressions for recognizing shell function definitions.
325 See `sh-feature' and `imenu-generic-expression'."
326 :type '(alist :key-type (symbol :tag "Shell")
327 :value-type (alist :key-type (choice :tag "Title"
329 (const :tag "None" nil))
331 (repeat :tag "Regexp, index..." sexp)))
335 (defvar sh-shell-variables nil
336 "Alist of shell variable names that should be included in completion.
337 These are used for completion in addition to all the variables named
338 in `process-environment'. Each element looks like (VAR . VAR), where
339 the car and cdr are the same symbol.")
341 (defvar sh-shell-variables-initialized nil
342 "Non-nil if `sh-shell-variables' is initialized.")
344 (defun sh-canonicalize-shell (shell)
345 "Convert a shell name SHELL to the one we should handle it as."
346 (if (string-match "\\.exe\\'" shell)
347 (setq shell (substring shell 0 (match-beginning 0))))
349 (setq shell (intern shell)))
350 (or (cdr (assq shell sh-alias-alist))
353 (defvar sh-shell (sh-canonicalize-shell (file-name-nondirectory sh-shell-file))
354 "The shell being programmed. This is set by \\[sh-set-shell].")
356 (defvar sh-mode-abbrev-table nil)
358 (define-abbrev-table 'sh-mode-abbrev-table ())
361 ;; I turned off this feature because it doesn't permit typing commands
362 ;; in the usual way without help.
364 ;; '((csh sh-abbrevs shell
366 ;; "getopts" 'sh-while-getopts)
368 ;; (es sh-abbrevs shell
369 ;; "function" 'sh-function)
371 ;; (ksh88 sh-abbrevs sh
372 ;; "select" 'sh-select)
374 ;; (rc sh-abbrevs shell
376 ;; "function" 'sh-function)
378 ;; (sh sh-abbrevs shell
380 ;; "function" 'sh-function
382 ;; "getopts" 'sh-while-getopts)
384 ;; ;; The next entry is only used for defining the others
385 ;; (shell "for" sh-for
386 ;; "loop" sh-indexed-loop
388 ;; "tmpfile" sh-tmp-file
391 ;; (zsh sh-abbrevs ksh88
392 ;; "repeat" 'sh-repeat))
393 ;; "Abbrev-table used in Shell-Script mode. See `sh-feature'.
394 ;;;Due to the internal workings of abbrev tables, the shell name symbol is
395 ;;;actually defined as the table for the like of \\[edit-abbrevs].")
399 (defun sh-mode-syntax-table (table &rest list)
400 "Copy TABLE and set syntax for successive CHARs according to strings S."
401 (setq table (copy-syntax-table table))
403 (modify-syntax-entry (pop list) (pop list) table))
406 (defvar sh-mode-syntax-table nil
407 "The syntax table to use for Shell-Script mode.
408 This is buffer-local in every such buffer.")
410 (defvar sh-mode-default-syntax-table
411 (sh-mode-syntax-table ()
427 "Default syntax table for shell mode.")
429 (defvar sh-mode-syntax-table-input
431 "Syntax-table used in Shell-Script mode. See `sh-feature'.")
434 (let ((map (make-sparse-keymap))
435 (menu-map (make-sparse-keymap "Insert")))
436 (define-key map "\C-c(" 'sh-function)
437 (define-key map "\C-c\C-w" 'sh-while)
438 (define-key map "\C-c\C-u" 'sh-until)
439 (define-key map "\C-c\C-t" 'sh-tmp-file)
440 (define-key map "\C-c\C-s" 'sh-select)
441 (define-key map "\C-c\C-r" 'sh-repeat)
442 (define-key map "\C-c\C-o" 'sh-while-getopts)
443 (define-key map "\C-c\C-l" 'sh-indexed-loop)
444 (define-key map "\C-c\C-i" 'sh-if)
445 (define-key map "\C-c\C-f" 'sh-for)
446 (define-key map "\C-c\C-c" 'sh-case)
447 (define-key map "\C-c?" 'sh-show-indent)
448 (define-key map "\C-c=" 'sh-set-indent)
449 (define-key map "\C-c<" 'sh-learn-line-indent)
450 (define-key map "\C-c>" 'sh-learn-buffer-indent)
451 (define-key map "\C-c\C-\\" 'sh-backslash-region)
453 (define-key map "=" 'sh-assignment)
454 (define-key map "\C-c+" 'sh-add)
455 (define-key map "\C-\M-x" 'sh-execute-region)
456 (define-key map "\C-c\C-x" 'executable-interpret)
457 (define-key map "<" 'sh-maybe-here-document)
458 (define-key map "(" 'skeleton-pair-insert-maybe)
459 (define-key map "{" 'skeleton-pair-insert-maybe)
460 (define-key map "[" 'skeleton-pair-insert-maybe)
461 (define-key map "'" 'skeleton-pair-insert-maybe)
462 (define-key map "`" 'skeleton-pair-insert-maybe)
463 (define-key map "\"" 'skeleton-pair-insert-maybe)
465 (define-key map [remap complete-tag] 'comint-dynamic-complete)
466 (define-key map [remap newline-and-indent] 'sh-newline-and-indent)
467 (define-key map [remap delete-backward-char]
468 'backward-delete-char-untabify)
469 (define-key map "\C-c:" 'sh-set-shell)
470 (define-key map [remap backward-sentence] 'sh-beginning-of-command)
471 (define-key map [remap forward-sentence] 'sh-end-of-command)
472 (define-key map [menu-bar insert] (cons "Insert" menu-map))
473 (define-key menu-map [sh-while] '("While Loop" . sh-while))
474 (define-key menu-map [sh-until] '("Until Loop" . sh-until))
475 (define-key menu-map [sh-tmp-file] '("Temporary File" . sh-tmp-file))
476 (define-key menu-map [sh-select] '("Select Statement" . sh-select))
477 (define-key menu-map [sh-repeat] '("Repeat Loop" . sh-repeat))
478 (define-key menu-map [sh-getopts] '("Options Loop" . sh-while-getopts))
479 (define-key menu-map [sh-indexed-loop] '("Indexed Loop" . sh-indexed-loop))
480 (define-key menu-map [sh-if] '("If Statement" . sh-if))
481 (define-key menu-map [sh-for] '("For Loop" . sh-for))
482 (define-key menu-map [sh-case] '("Case Statement" . sh-case))
484 "Keymap used in Shell-Script mode.")
488 (defcustom sh-dynamic-complete-functions
489 '(shell-dynamic-complete-environment-variable
490 shell-dynamic-complete-command
491 comint-dynamic-complete-filename)
492 "*Functions for doing TAB dynamic completion."
493 :type '(repeat function)
497 (defcustom sh-require-final-newline
500 "*Value of `require-final-newline' in Shell-Script mode buffers.
501 \(SHELL . t) means use the value of `mode-require-final-newline' for SHELL.
503 :type '(repeat (cons (symbol :tag "Shell")
504 (choice (const :tag "require" t)
505 (sexp :format "Evaluate: %v"))))
509 (defcustom sh-assignment-regexp
510 '((csh . "\\<\\([a-zA-Z0-9_]+\\)\\(\\[.+\\]\\)?[ \t]*[-+*/%^]?=")
511 ;; actually spaces are only supported in let/(( ... ))
512 (ksh88 . "\\<\\([a-zA-Z0-9_]+\\)\\(\\[.+\\]\\)?[ \t]*\\([-+*/%&|~^]\\|<<\\|>>\\)?=")
513 (rc . "\\<\\([a-zA-Z0-9_*]+\\)[ \t]*=")
514 (sh . "\\<\\([a-zA-Z0-9_]+\\)="))
515 "*Regexp for the variable name and what may follow in an assignment.
516 First grouping matches the variable name. This is upto and including the `='
517 sign. See `sh-feature'."
518 :type '(repeat (cons (symbol :tag "Shell")
520 (sexp :format "Evaluate: %v"))))
524 (defcustom sh-indentation 4
525 "The width for further indentation in Shell-Script mode."
530 (defcustom sh-remember-variable-min 3
531 "*Don't remember variables less than this length for completing reads."
536 (defvar sh-header-marker nil
537 "When non-nil is the end of header for prepending by \\[sh-execute-region].
538 That command is also used for setting this variable.")
541 (defcustom sh-beginning-of-command
542 "\\([;({`|&]\\|\\`\\|[^\\]\n\\)[ \t]*\\([/~a-zA-Z0-9:]\\)"
543 "*Regexp to determine the beginning of a shell command.
544 The actual command starts at the beginning of the second \\(grouping\\)."
549 (defcustom sh-end-of-command
550 "\\([/~a-zA-Z0-9:]\\)[ \t]*\\([;#)}`|&]\\|$\\)"
551 "*Regexp to determine the end of a shell command.
552 The actual command ends at the end of the first \\(grouping\\)."
558 (defcustom sh-here-document-word "EOF"
559 "Word to delimit here documents.
560 If the first character of this string is \"-\", this is taken as
561 part of the redirection operator, rather than part of the
562 word (that is, \"<<-\" instead of \"<<\"). This is a feature
563 used by some shells (for example Bash) to indicate that leading
564 tabs inside the here document should be ignored. In this case,
565 Emacs indents the initial body and end of the here document with
566 tabs, to the same level as the start (note that apart from this
567 there is no support for indentation of here documents). This
568 will only work correctly if `sh-basic-offset' is a multiple of
571 Any quote characters or leading whitespace in the word are
572 removed when closing the here document."
580 "Initial input in Bourne if, while and until skeletons. See `sh-feature'.")
583 ;; customized this out of sheer bravado. not for the faint of heart.
584 ;; but it *did* have an asterisk in the docstring!
585 (defcustom sh-builtins
586 '((bash sh-append posix
587 "." "alias" "bg" "bind" "builtin" "caller" "compgen" "complete"
588 "declare" "dirs" "disown" "enable" "fc" "fg" "help" "history"
589 "jobs" "kill" "let" "local" "popd" "printf" "pushd" "shopt"
590 "source" "suspend" "typeset" "unalias")
592 ;; The next entry is only used for defining the others
593 (bourne sh-append shell
594 "eval" "export" "getopts" "newgrp" "pwd" "read" "readonly"
598 "alias" "chdir" "glob" "history" "limit" "nice" "nohup" "rehash"
599 "setenv" "source" "time" "unalias" "unhash")
601 (dtksh sh-append wksh)
603 (es "access" "apids" "cd" "echo" "eval" "false" "let" "limit" "local"
604 "newpgrp" "result" "time" "umask" "var" "vars" "wait" "whatis")
607 "bg" "fg" "jobs" "kill" "stop" "suspend")
610 "bg" "fg" "jobs" "kill" "notify" "stop" "suspend")
612 (ksh88 sh-append bourne
613 "alias" "bg" "false" "fc" "fg" "jobs" "kill" "let" "print" "time"
614 "typeset" "unalias" "whence")
617 "checkwin" "dateline" "error" "form" "menu" "newwin" "oadeinit"
618 "oaed" "oahelp" "oainit" "pp" "ppfile" "scan" "scrollok" "wattr"
619 "wclear" "werase" "win" "wmclose" "wmmessage" "wmopen" "wmove"
620 "wmtitle" "wrefresh")
622 (pdksh sh-append ksh88
628 (rc "builtin" "cd" "echo" "eval" "limit" "newpgrp" "shift" "umask" "wait"
632 "hash" "test" "type")
634 ;; The next entry is only used for defining the others
635 (shell "cd" "echo" "eval" "set" "shift" "umask" "unset" "wait")
637 (wksh sh-append ksh88
641 "autoload" "bindkey" "builtin" "chdir" "compctl" "declare" "dirs"
642 "disable" "disown" "echotc" "enable" "functions" "getln" "hash"
643 "history" "integer" "limit" "local" "log" "popd" "pushd" "r"
644 "readonly" "rehash" "sched" "setopt" "source" "suspend" "true"
645 "ttyctl" "type" "unfunction" "unhash" "unlimit" "unsetopt" "vared"
647 "*List of all shell builtins for completing read and fontification.
648 Note that on some systems not all builtins are available or some are
649 implemented as aliases. See `sh-feature'."
650 :type '(repeat (cons (symbol :tag "Shell")
651 (choice (repeat string)
652 (sexp :format "Evaluate: %v"))))
657 (defcustom sh-leading-keywords
663 (es "true" "unwind-protect" "whatis")
667 (sh "!" "do" "elif" "else" "if" "then" "trap" "type" "until" "while"))
668 "*List of keywords that may be immediately followed by a builtin or keyword.
669 Given some confusion between keywords and builtins depending on shell and
670 system, the distinction here has been based on whether they influence the
671 flow of control or syntax. See `sh-feature'."
672 :type '(repeat (cons (symbol :tag "Shell")
673 (choice (repeat string)
674 (sexp :format "Evaluate: %v"))))
678 (defcustom sh-other-keywords
679 '((bash sh-append bourne
680 "bye" "logout" "select")
682 ;; The next entry is only used for defining the others
687 "breaksw" "default" "end" "endif" "endsw" "foreach" "goto"
688 "if" "logout" "onintr" "repeat" "switch" "then" "while")
690 (es "break" "catch" "exec" "exit" "fn" "for" "forever" "fork" "if"
691 "return" "throw" "while")
693 (ksh88 sh-append bourne
696 (rc "break" "case" "exec" "exit" "fn" "for" "if" "in" "return" "switch"
700 "done" "esac" "fi" "for" "in" "return")
702 ;; The next entry is only used for defining the others
703 (shell "break" "case" "continue" "exec" "exit")
707 "*List of keywords not in `sh-leading-keywords'.
709 :type '(repeat (cons (symbol :tag "Shell")
710 (choice (repeat string)
711 (sexp :format "Evaluate: %v"))))
718 "allow_null_glob_expansion" "auto_resume" "BASH" "BASH_ENV"
719 "BASH_VERSINFO" "BASH_VERSION" "cdable_vars" "COMP_CWORD"
720 "COMP_LINE" "COMP_POINT" "COMP_WORDS" "COMPREPLY" "DIRSTACK"
721 "ENV" "EUID" "FCEDIT" "FIGNORE" "FUNCNAME"
722 "glob_dot_filenames" "GLOBIGNORE" "GROUPS" "histchars"
723 "HISTCMD" "HISTCONTROL" "HISTFILE" "HISTFILESIZE"
724 "HISTIGNORE" "history_control" "HISTSIZE"
725 "hostname_completion_file" "HOSTFILE" "HOSTTYPE" "IGNOREEOF"
726 "ignoreeof" "INPUTRC" "LINENO" "MACHTYPE" "MAIL_WARNING"
727 "noclobber" "nolinks" "notify" "no_exit_on_failed_exec"
728 "NO_PROMPT_VARS" "OLDPWD" "OPTERR" "OSTYPE" "PIPESTATUS"
729 "PPID" "POSIXLY_CORRECT" "PROMPT_COMMAND" "PS3" "PS4"
730 "pushd_silent" "PWD" "RANDOM" "REPLY" "SECONDS" "SHELLOPTS"
731 "SHLVL" "TIMEFORMAT" "TMOUT" "UID")
734 "argv" "cdpath" "child" "echo" "histchars" "history" "home"
735 "ignoreeof" "mail" "noclobber" "noglob" "nonomatch" "path" "prompt"
736 "shell" "status" "time" "verbose")
739 "apid" "cdpath" "CDPATH" "history" "home" "ifs" "noexport" "path"
740 "pid" "prompt" "signals")
746 "ENV" "ERRNO" "FCEDIT" "FPATH" "HISTFILE" "HISTSIZE" "LINENO"
747 "OLDPWD" "PPID" "PS3" "PS4" "PWD" "RANDOM" "REPLY" "SECONDS"
751 "FIELD" "FIELD_MAX" "LAST_KEY" "OALIB" "PP_ITEM" "PP_NUM")
754 "apid" "apids" "cdpath" "CDPATH" "history" "home" "ifs" "path" "pid"
758 "CDPATH" "IFS" "OPTARG" "OPTIND" "PS1" "PS2")
760 ;; The next entry is only used for defining the others
761 (shell "COLUMNS" "EDITOR" "HOME" "HUSHLOGIN" "LANG" "LC_COLLATE"
762 "LC_CTYPE" "LC_MESSAGES" "LC_MONETARY" "LC_NUMERIC" "LC_TIME"
763 "LINES" "LOGNAME" "MAIL" "MAILCHECK" "MAILPATH" "PAGER" "PATH"
764 "SHELL" "TERM" "TERMCAP" "TERMINFO" "VISUAL")
767 "addsuffix" "ampm" "autocorrect" "autoexpand" "autolist"
768 "autologout" "chase_symlinks" "correct" "dextract" "edit" "el"
769 "fignore" "gid" "histlit" "HOST" "HOSTTYPE" "HPATH"
770 "ignore_symlinks" "listjobs" "listlinks" "listmax" "matchbeep"
771 "nobeep" "NOREBIND" "oid" "printexitvalue" "prompt2" "prompt3"
772 "pushdsilent" "pushdtohome" "recexact" "recognize_only_executables"
773 "rmstar" "savehist" "SHLVL" "showdots" "sl" "SYSTYPE" "tcsh" "term"
774 "tperiod" "tty" "uid" "version" "visiblebell" "watch" "who"
778 "BAUD" "bindcmds" "cdpath" "DIRSTACKSIZE" "fignore" "FIGNORE" "fpath"
779 "HISTCHARS" "hostcmds" "hosts" "HOSTS" "LISTMAX" "LITHISTSIZE"
780 "LOGCHECK" "mailpath" "manpath" "NULLCMD" "optcmds" "path" "POSTEDIT"
781 "prompt" "PROMPT" "PROMPT2" "PROMPT3" "PROMPT4" "psvar" "PSVAR"
782 "READNULLCMD" "REPORTTIME" "RPROMPT" "RPS1" "SAVEHIST" "SPROMPT"
783 "STTY" "TIMEFMT" "TMOUT" "TMPPREFIX" "varcmds" "watch" "WATCH"
784 "WATCHFMT" "WORDCHARS" "ZDOTDIR"))
785 "List of all shell variables available for completing read.
791 (defface sh-heredoc-face
792 '((((min-colors 88) (class color)
794 (:foreground "yellow1" :weight bold))
797 (:foreground "yellow" :weight bold))
800 (:foreground "tan" ))
803 "Face to show a here-document"
804 :group 'sh-indentation)
805 (defvar sh-heredoc-face 'sh-heredoc-face)
807 (defface sh-escaped-newline '((t :inherit font-lock-string-face))
808 "Face used for (non-escaped) backslash at end of a line in Shell-script mode."
812 (defvar sh-font-lock-keywords
813 '((csh sh-append shell
814 ("\\${?[#?]?\\([A-Za-z_][A-Za-z0-9_]*\\|0\\)" 1
815 font-lock-variable-name-face))
817 (es sh-append executable-font-lock-keywords
818 ("\\$#?\\([A-Za-z_][A-Za-z0-9_]*\\|[0-9]+\\)" 1
819 font-lock-variable-name-face))
825 ("\\$\\({#?\\)?\\([A-Za-z_][A-Za-z0-9_]*\\|[-#?@!]\\)" 2
826 font-lock-variable-name-face)
828 ("^\\(\\sw+\\)[ \t]*(" 1 font-lock-function-name-face)
829 ("\\<\\(function\\)\\>[ \t]*\\(\\sw+\\)?"
830 (1 font-lock-keyword-face) (2 font-lock-function-name-face nil t)))
832 ;; The next entry is only used for defining the others
833 (shell sh-append executable-font-lock-keywords
834 ;; Using font-lock-string-face here confuses sh-get-indent-info.
835 ("\\(^\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\\\)$" 3 'sh-escaped-newline)
836 ("\\\\[^A-Za-z0-9]" 0 font-lock-string-face)
837 ("\\${?\\([A-Za-z_][A-Za-z0-9_]*\\|[0-9]+\\|[$*_]\\)" 1
838 font-lock-variable-name-face))
840 ("%{?\\(\\sw+\\)" 1 font-lock-keyword-face))
841 (rpm2 sh-append shell
842 ("^\\(\\sw+\\):" 1 font-lock-variable-name-face)))
843 "Default expressions to highlight in Shell Script modes. See `sh-feature'.")
845 (defvar sh-font-lock-keywords-1
847 "Subdued level highlighting for Shell Script modes.")
849 (defvar sh-font-lock-keywords-2 ()
850 "Gaudy level highlighting for Shell Script modes.")
852 ;; These are used for the syntax table stuff (derived from cperl-mode).
853 ;; Note: parse-sexp-lookup-properties must be set to t for it to work.
854 (defconst sh-st-punc (string-to-syntax "."))
855 (defconst sh-st-symbol (string-to-syntax "_"))
856 (defconst sh-here-doc-syntax (string-to-syntax "|")) ;; generic string
858 (defconst sh-here-doc-open-re "<<-?\\s-*\\\\?\\(\\(?:['\"][^'\"]+['\"]\\|\\sw\\)+\\).*\\(\n\\)")
860 (defvar sh-here-doc-markers nil)
861 (make-variable-buffer-local 'sh-here-doc-markers)
862 (defvar sh-here-doc-re sh-here-doc-open-re)
863 (make-variable-buffer-local 'sh-here-doc-re)
865 (defun sh-font-lock-close-heredoc (bol eof indented)
866 "Determine the syntax of the \\n after an EOF.
867 If non-nil INDENTED indicates that the EOF was indented."
868 (let* ((eof-re (if eof (regexp-quote eof) ""))
869 ;; A rough regexp that should find the opening <<EOF back.
870 (sre (concat "<<\\(-?\\)\\s-*['\"\\]?"
871 ;; Use \s| to cheaply check it's an open-heredoc.
872 eof-re "['\"]?\\([ \t|;&)<>].*\\)?\\s|"))
873 ;; A regexp that will find other EOFs.
874 (ere (concat "^" (if indented "[ \t]*") eof-re "\n"))
875 (start (save-excursion
877 (re-search-backward (concat sre "\\|" ere) nil t))))
878 ;; If subgroup 1 matched, we found an open-heredoc, otherwise we first
879 ;; found a close-heredoc which makes the current close-heredoc inoperant.
881 ((when (and start (match-end 1)
882 (not (and indented (= (match-beginning 1) (match-end 1))))
883 (not (sh-in-comment-or-string (match-beginning 0))))
884 ;; Make sure our `<<' is not the EOF1 of a `cat <<EOF1 <<EOF2'.
887 (setq start (line-beginning-position 2))
890 (re-search-forward "<<") ; Skip ourselves.
891 (and (re-search-forward sh-here-doc-open-re start 'move)
892 (goto-char (match-beginning 0))
893 (sh-in-comment-or-string (point)))))
894 ;; No <<EOF2 found after our <<.
897 ((not (or start (save-excursion (re-search-forward sre nil t))))
898 ;; There's no <<EOF either before or after us,
899 ;; so we should remove ourselves from font-lock's keywords.
900 (setq sh-here-doc-markers (delete eof sh-here-doc-markers))
902 (concat sh-here-doc-open-re "\\|^\\([ \t]*\\)"
903 (regexp-opt sh-here-doc-markers t) "\\(\n\\)"))
906 (defun sh-font-lock-open-heredoc (start string)
907 "Determine the syntax of the \\n after a <<EOF.
908 START is the position of <<.
909 STRING is the actual word used as delimiter (f.ex. \"EOF\").
910 INDENTED is non-nil if the here document's content (and the EOF mark) can
911 be indented (i.e. a <<- was used rather than just <<)."
912 (unless (or (memq (char-before start) '(?< ?>))
913 (sh-in-comment-or-string start))
914 ;; We're looking at <<STRING, so we add "^STRING$" to the syntactic
915 ;; font-lock keywords to detect the end of this here document.
916 (let ((str (replace-regexp-in-string "['\"]" "" string)))
917 (unless (member str sh-here-doc-markers)
918 (push str sh-here-doc-markers)
920 (concat sh-here-doc-open-re "\\|^\\([ \t]*\\)"
921 (regexp-opt sh-here-doc-markers t) "\\(\n\\)"))))
924 (defun sh-font-lock-here-doc (limit)
925 "Search for a heredoc marker."
926 ;; This looks silly, but it's because `sh-here-doc-re' keeps changing.
927 (re-search-forward sh-here-doc-re limit t))
929 (defun sh-is-quoted-p (pos)
930 (and (eq (char-before pos) ?\\)
931 (not (sh-is-quoted-p (1- pos)))))
933 (defun sh-font-lock-paren (start)
936 ;; Skip through all patterns
939 (forward-comment (- (point-max)))
940 ;; Skip through one pattern
942 (or (/= 0 (skip-syntax-backward "w_"))
943 (/= 0 (skip-chars-backward "?[]*@/\\"))
944 (and (sh-is-quoted-p (1- (point)))
945 (goto-char (- (point) 2)))
946 (when (memq (char-before) '(?\" ?\'))
947 (condition-case nil (progn (backward-sexp 1) t)
949 (forward-comment (- (point-max)))
950 (when (eq (char-before) ?|)
951 (backward-char 1) t)))
952 (when (save-excursion (backward-char 2) (looking-at ";;\\|in"))
955 (defconst sh-font-lock-syntactic-keywords
956 ;; A `#' begins a comment when it is unquoted and at the beginning of a
957 ;; word. In the shell, words are separated by metacharacters.
958 ;; The list of special chars is taken from the single-unix spec
959 ;; of the shell command language (under `quoting') but with `$' removed.
960 `(("[^|&;<>()`\\\"' \t\n]\\(#+\\)" 1 ,sh-st-symbol)
961 ;; Find HEREDOC starters and add a corresponding rule for the ender.
962 (sh-font-lock-here-doc
963 (2 (sh-font-lock-open-heredoc
964 (match-beginning 0) (match-string 1)) nil t)
965 (5 (sh-font-lock-close-heredoc
966 (match-beginning 0) (match-string 4)
967 (and (match-beginning 3) (/= (match-beginning 3) (match-end 3))))
969 ;; Distinguish the special close-paren in `case'.
970 (")" 0 (sh-font-lock-paren (match-beginning 0)))))
972 (defun sh-font-lock-syntactic-face-function (state)
974 (if (char-valid-p (nth 3 state))
975 font-lock-string-face
977 font-lock-comment-face))
979 (defgroup sh-indentation nil
980 "Variables controlling indentation in shell scripts.
982 Note: customizing these variables will not affect existing buffers if
983 `sh-make-vars-local' is no-nil. See the documentation for
984 variable `sh-make-vars-local', command `sh-make-vars-local'
985 and command `sh-reset-indent-vars-to-global-values'."
989 (defcustom sh-set-shell-hook nil
990 "*Hook run by `sh-set-shell'."
994 (defcustom sh-mode-hook nil
995 "*Hook run by `sh-mode'."
999 (defcustom sh-learn-basic-offset nil
1000 "*When `sh-guess-basic-offset' should learn `sh-basic-offset'.
1003 t means: only if there seems to be an obvious value.
1004 Anything else means: whenever we have a \"good guess\" as to the value."
1006 (const :tag "Never" nil)
1007 (const :tag "Only if sure" t)
1008 (const :tag "If have a good guess" usually))
1009 :group 'sh-indentation)
1011 (defcustom sh-popup-occur-buffer nil
1012 "*Controls when `sh-learn-buffer-indent' pops the *indent* buffer.
1013 If t it is always shown. If nil, it is shown only when there
1016 (const :tag "Only when there are conflicts." nil)
1017 (const :tag "Always" t))
1018 :group 'sh-indentation)
1020 (defcustom sh-blink t
1021 "*If non-nil, `sh-show-indent' shows the line indentation is relative to.
1022 The position on the line is not necessarily meaningful.
1023 In some cases the line will be the matching keyword, but this is not
1026 :group 'sh-indentation)
1028 (defcustom sh-first-lines-indent 0
1029 "*The indentation of the first non-blank non-comment line.
1030 Usually 0 meaning first column.
1031 Can be set to a number, or to nil which means leave it as is."
1033 (const :tag "Leave as is" nil)
1034 (integer :tag "Column number"
1035 :menu-tag "Indent to this col (0 means first col)" ))
1036 :group 'sh-indentation)
1039 (defcustom sh-basic-offset 4
1040 "*The default indentation increment.
1041 This value is used for the + and - symbols in an indentation variable."
1043 :group 'sh-indentation)
1045 (defcustom sh-indent-comment nil
1046 "*How a comment line is to be indented.
1047 nil means leave it as it is;
1048 t means indent it as a normal line, aligning it to previous non-blank
1050 a number means align to that column, e.g. 0 means fist column."
1052 (const :tag "Leave as is." nil)
1053 (const :tag "Indent as a normal line." t)
1054 (integer :menu-tag "Indent to this col (0 means first col)."
1055 :tag "Indent to column number.") )
1056 :group 'sh-indentation)
1059 (defvar sh-debug nil
1060 "Enable lots of debug messages - if function `sh-debug' is enabled.")
1063 ;; Uncomment this defun and comment the defmacro for debugging.
1064 ;; (defun sh-debug (&rest args)
1065 ;; "For debugging: display message ARGS if variable SH-DEBUG is non-nil."
1067 ;; (apply 'message args)))
1068 (defmacro sh-debug (&rest args))
1070 (defconst sh-symbol-list
1071 '((const :tag "+ " :value +
1072 :menu-tag "+ Indent right by sh-basic-offset")
1073 (const :tag "- " :value -
1074 :menu-tag "- Indent left by sh-basic-offset")
1075 (const :tag "++" :value ++
1076 :menu-tag "++ Indent right twice sh-basic-offset")
1077 (const :tag "--" :value --
1078 :menu-tag "-- Indent left twice sh-basic-offset")
1079 (const :tag "* " :value *
1080 :menu-tag "* Indent right half sh-basic-offset")
1081 (const :tag "/ " :value /
1082 :menu-tag "/ Indent left half sh-basic-offset")))
1084 (defcustom sh-indent-for-else 0
1085 "*How much to indent an else relative to an if. Usually 0."
1087 (integer :menu-tag "A number (positive=>indent right)"
1089 (const :tag "--") ;; separator!
1092 :group 'sh-indentation)
1094 (defconst sh-number-or-symbol-list
1095 (append '((integer :menu-tag "A number (positive=>indent right)"
1097 (const :tag "--")) ; separator
1100 (defcustom sh-indent-for-fi 0
1101 "*How much to indent a fi relative to an if. Usually 0."
1102 :type `(choice ,@ sh-number-or-symbol-list )
1103 :group 'sh-indentation)
1105 (defcustom sh-indent-for-done '0
1106 "*How much to indent a done relative to its matching stmt. Usually 0."
1107 :type `(choice ,@ sh-number-or-symbol-list )
1108 :group 'sh-indentation)
1110 (defcustom sh-indent-after-else '+
1111 "*How much to indent a statement after an else statement."
1112 :type `(choice ,@ sh-number-or-symbol-list )
1113 :group 'sh-indentation)
1115 (defcustom sh-indent-after-if '+
1116 "*How much to indent a statement after an if statement.
1117 This includes lines after else and elif statements, too, but
1118 does not affect then else elif or fi statements themselves."
1119 :type `(choice ,@ sh-number-or-symbol-list )
1120 :group 'sh-indentation)
1122 (defcustom sh-indent-for-then 0
1123 "*How much to indent a then relative to an if."
1124 :type `(choice ,@ sh-number-or-symbol-list )
1125 :group 'sh-indentation)
1127 (defcustom sh-indent-for-do '*
1128 "*How much to indent a do statement.
1129 This is relative to the statement before the do, i.e. the
1130 while until or for statement."
1131 :type `(choice ,@ sh-number-or-symbol-list)
1132 :group 'sh-indentation)
1134 (defcustom sh-indent-after-do '*
1135 "*How much to indent a line after a do statement.
1136 This is used when the do is the first word of the line.
1137 This is relative to the statement before the do, e.g. a
1138 while for repeat or select statement."
1139 :type `(choice ,@ sh-number-or-symbol-list)
1140 :group 'sh-indentation)
1142 (defcustom sh-indent-after-loop-construct '+
1143 "*How much to indent a statement after a loop construct.
1145 This variable is used when the keyword \"do\" is on the same line as the
1146 loop statement (e.g. \"until\", \"while\" or \"for\").
1147 If the do is on a line by itself, then `sh-indent-after-do' is used instead."
1148 :type `(choice ,@ sh-number-or-symbol-list)
1149 :group 'sh-indentation)
1152 (defcustom sh-indent-after-done 0
1153 "*How much to indent a statement after a \"done\" keyword.
1154 Normally this is 0, which aligns the \"done\" to the matching
1155 looping construct line.
1156 Setting it non-zero allows you to have the \"do\" statement on a line
1157 by itself and align the done under to do."
1158 :type `(choice ,@ sh-number-or-symbol-list)
1159 :group 'sh-indentation)
1161 (defcustom sh-indent-for-case-label '+
1162 "*How much to indent a case label statement.
1163 This is relative to the line containing the case statement."
1164 :type `(choice ,@ sh-number-or-symbol-list)
1165 :group 'sh-indentation)
1167 (defcustom sh-indent-for-case-alt '++
1168 "*How much to indent statements after the case label.
1169 This is relative to the line containing the case statement."
1170 :type `(choice ,@ sh-number-or-symbol-list)
1171 :group 'sh-indentation)
1174 (defcustom sh-indent-for-continuation '+
1175 "*How much to indent for a continuation statement."
1176 :type `(choice ,@ sh-number-or-symbol-list)
1177 :group 'sh-indentation)
1179 (defcustom sh-indent-after-open '+
1180 "*How much to indent after a line with an opening parenthesis or brace.
1181 For an open paren after a function `sh-indent-after-function' is used."
1182 :type `(choice ,@ sh-number-or-symbol-list)
1183 :group 'sh-indentation)
1185 (defcustom sh-indent-after-function '+
1186 "*How much to indent after a function line."
1187 :type `(choice ,@ sh-number-or-symbol-list)
1188 :group 'sh-indentation)
1190 ;; These 2 are for the rc shell:
1192 (defcustom sh-indent-after-switch '+
1193 "*How much to indent a case statement relative to the switch statement.
1194 This is for the rc shell."
1195 :type `(choice ,@ sh-number-or-symbol-list)
1196 :group 'sh-indentation)
1198 (defcustom sh-indent-after-case '+
1199 "*How much to indent a statement relative to the case statement.
1200 This is for the rc shell."
1201 :type `(choice ,@ sh-number-or-symbol-list)
1202 :group 'sh-indentation)
1204 (defcustom sh-backslash-column 48
1205 "*Column in which `sh-backslash-region' inserts backslashes."
1209 (defcustom sh-backslash-align t
1210 "*If non-nil, `sh-backslash-region' will align backslashes."
1214 ;; Internal use - not designed to be changed by the user:
1216 (defun sh-mkword-regexpr (word)
1217 "Make a regexp which matches WORD as a word.
1218 This specifically excludes an occurrence of WORD followed by
1219 punctuation characters like '-'."
1220 (concat word "\\([^-a-z0-9_]\\|$\\)"))
1222 (defconst sh-re-done (sh-mkword-regexpr "done"))
1225 (defconst sh-kws-for-done
1226 '((sh . ( "while" "until" "for" ) )
1227 (bash . ( "while" "until" "for" "select" ) )
1228 (ksh88 . ( "while" "until" "for" "select" ) )
1229 (zsh . ( "while" "until" "for" "repeat" "select" ) ) )
1230 "Which keywords can match the word `done' in this shell.")
1233 (defconst sh-indent-supported
1237 "Shell types that shell indenting can do something with.")
1239 (defvar sh-indent-supported-here nil
1240 "Non-nil if we support indentation for the current buffer's shell type.")
1242 (defconst sh-var-list
1244 sh-basic-offset sh-first-lines-indent sh-indent-after-case
1245 sh-indent-after-do sh-indent-after-done
1246 sh-indent-after-else
1248 sh-indent-after-loop-construct
1249 sh-indent-after-open
1251 sh-indent-for-case-alt
1252 sh-indent-for-case-label
1253 sh-indent-for-continuation
1260 "A list of variables used by script mode to control indentation.
1261 This list is used when switching between buffer-local and global
1262 values of variables, and for the commands using indentation styles.")
1264 (defvar sh-make-vars-local t
1265 "*Controls whether indentation variables are local to the buffer.
1266 If non-nil, indentation variables are made local initially.
1267 If nil, you can later make the variables local by invoking
1268 command `sh-make-vars-local'.
1269 The default is t because I assume that in one Emacs session one is
1270 frequently editing existing scripts with different styles.")
1273 ;; mode-command and utility functions
1277 "Major mode for editing shell scripts.
1278 This mode works for many shells, since they all have roughly the same syntax,
1279 as far as commands, arguments, variables, pipes, comments etc. are concerned.
1280 Unless the file's magic number indicates the shell, your usual shell is
1281 assumed. Since filenames rarely give a clue, they are not further analyzed.
1283 This mode adapts to the variations between shells (see `sh-set-shell') by
1284 means of an inheritance based feature lookup (see `sh-feature'). This
1285 mechanism applies to all variables (including skeletons) that pertain to
1286 shell-specific features.
1288 The default style of this mode is that of Rosenblatt's Korn shell book.
1289 The syntax of the statements varies with the shell being used. The
1290 following commands are available, based on the current shell's syntax:
1292 \\[sh-case] case statement
1294 \\[sh-function] function definition
1295 \\[sh-if] if statement
1296 \\[sh-indexed-loop] indexed loop from 1 to n
1297 \\[sh-while-getopts] while getopts loop
1298 \\[sh-repeat] repeat loop
1299 \\[sh-select] select loop
1300 \\[sh-until] until loop
1301 \\[sh-while] while loop
1303 For sh and rc shells indentation commands are:
1304 \\[sh-show-indent] Show the variable controlling this line's indentation.
1305 \\[sh-set-indent] Set then variable controlling this line's indentation.
1306 \\[sh-learn-line-indent] Change the indentation variable so this line
1307 would indent to the way it currently is.
1308 \\[sh-learn-buffer-indent] Set the indentation variables so the
1309 buffer indents as it currently is indented.
1312 \\[backward-delete-char-untabify] Delete backward one position, even if it was a tab.
1313 \\[sh-newline-and-indent] Delete unquoted space and indent new line same as this one.
1314 \\[sh-end-of-command] Go to end of successive commands.
1315 \\[sh-beginning-of-command] Go to beginning of successive commands.
1316 \\[sh-set-shell] Set this buffer's shell, and maybe its magic number.
1317 \\[sh-execute-region] Have optional header and region be executed in a subshell.
1319 \\[sh-maybe-here-document] Without prefix, following an unquoted < inserts here document.
1321 Unless quoted with \\, insert the pairs {}, (), [], or '', \"\", ``.
1323 If you generally program a shell different from your login shell you can
1324 set `sh-shell-file' accordingly. If your shell's file name doesn't correctly
1325 indicate what shell it is use `sh-alias-alist' to translate.
1327 If your shell gives error messages with line numbers, you can use \\[executable-interpret]
1328 with your script for an edit-interpret-debug cycle."
1330 (kill-all-local-variables)
1331 (setq major-mode 'sh-mode
1332 mode-name "Shell-script")
1333 (use-local-map sh-mode-map)
1334 (make-local-variable 'skeleton-end-hook)
1335 (make-local-variable 'paragraph-start)
1336 (make-local-variable 'paragraph-separate)
1337 (make-local-variable 'comment-start)
1338 (make-local-variable 'comment-start-skip)
1339 (make-local-variable 'require-final-newline)
1340 (make-local-variable 'sh-header-marker)
1341 (make-local-variable 'sh-shell-file)
1342 (make-local-variable 'sh-shell)
1343 (make-local-variable 'skeleton-pair-alist)
1344 (make-local-variable 'skeleton-pair-filter)
1345 (make-local-variable 'comint-dynamic-complete-functions)
1346 (make-local-variable 'comint-prompt-regexp)
1347 (make-local-variable 'font-lock-defaults)
1348 (make-local-variable 'skeleton-filter)
1349 (make-local-variable 'skeleton-newline-indent-rigidly)
1350 (make-local-variable 'sh-shell-variables)
1351 (make-local-variable 'sh-shell-variables-initialized)
1352 (make-local-variable 'imenu-generic-expression)
1353 (make-local-variable 'sh-indent-supported-here)
1354 (setq skeleton-end-hook (lambda ()
1355 (or (eolp) (newline) (indent-relative)))
1356 paragraph-start (concat page-delimiter "\\|$")
1357 paragraph-separate paragraph-start
1359 comint-dynamic-complete-functions sh-dynamic-complete-functions
1360 ;; we can't look if previous line ended with `\'
1361 comint-prompt-regexp "^[ \t]*"
1363 `((sh-font-lock-keywords
1364 sh-font-lock-keywords-1 sh-font-lock-keywords-2)
1366 ((?/ . "w") (?~ . "w") (?. . "w") (?- . "w") (?_ . "w")) nil
1367 (font-lock-syntactic-keywords . sh-font-lock-syntactic-keywords)
1368 (font-lock-syntactic-face-function
1369 . sh-font-lock-syntactic-face-function))
1370 skeleton-pair-alist '((?` _ ?`))
1371 skeleton-pair-filter 'sh-quoted-p
1372 skeleton-further-elements '((< '(- (min sh-indentation
1373 (current-column)))))
1374 skeleton-filter 'sh-feature
1375 skeleton-newline-indent-rigidly t
1376 sh-indent-supported-here nil)
1377 (set (make-local-variable 'parse-sexp-ignore-comments) t)
1378 ;; Parse or insert magic number for exec, and set all variables depending
1379 ;; on the shell thus determined.
1382 (goto-char (point-min))
1383 (cond ((looking-at "#![ \t]?\\([^ \t\n]*/bin/env[ \t]\\)?\\([^ \t\n]+\\)")
1385 ((and buffer-file-name
1386 (string-match "\\.m?spec$" buffer-file-name))
1388 (sh-set-shell (or interpreter sh-shell-file) nil nil))
1389 (run-hooks 'sh-mode-hook))
1392 (defalias 'shell-script-mode 'sh-mode)
1395 (defun sh-font-lock-keywords (&optional keywords)
1396 "Function to get simple fontification based on `sh-font-lock-keywords'.
1397 This adds rules for comments and assignments."
1398 (sh-feature sh-font-lock-keywords
1399 (when (stringp (sh-feature sh-assignment-regexp))
1401 `((,(sh-feature sh-assignment-regexp)
1402 1 font-lock-variable-name-face)
1406 (defun sh-font-lock-keywords-1 (&optional builtins)
1407 "Function to get better fontification including keywords."
1408 (let ((keywords (concat "\\([;(){}`|&]\\|^\\)[ \t]*\\(\\("
1409 (regexp-opt (sh-feature sh-leading-keywords) t)
1411 (regexp-opt (append (sh-feature sh-leading-keywords)
1412 (sh-feature sh-other-keywords))
1414 (sh-font-lock-keywords
1416 `((,(concat keywords "[ \t]+\\)?"
1417 (regexp-opt (sh-feature sh-builtins) t)
1419 (2 font-lock-keyword-face nil t)
1420 (6 font-lock-builtin-face))
1421 ,@(sh-feature sh-font-lock-keywords-2)))
1422 (,(concat keywords "\\)\\>")
1423 2 font-lock-keyword-face)
1424 ,@(sh-feature sh-font-lock-keywords-1)))))
1426 (defun sh-font-lock-keywords-2 ()
1427 "Function to get better fontification including keywords and builtins."
1428 (sh-font-lock-keywords-1 t))
1431 (defvar sh-regexp-for-done nil
1432 "A buffer-local regexp to match opening keyword for done.")
1434 (defvar sh-kw-alist nil
1435 "A buffer-local, since it is shell-type dependent, list of keywords.")
1437 ;; ( key-word first-on-this on-prev-line )
1438 ;; This is used to set `sh-kw-alist' which is a list of sublists each
1439 ;; having 3 elements:
1441 ;; a rule to check when the keyword appears on "this" line
1442 ;; a rule to check when the keyword appears on "the previous" line
1443 ;; The keyword is usually a string and is the first word on a line.
1444 ;; If this keyword appears on the line whose indentation is to be
1445 ;; calculated, the rule in element 2 is called. If this returns
1446 ;; non-zero, the resulting point (which may be changed by the rule)
1447 ;; is used as the default indentation.
1448 ;; If it returned false or the keyword was not found in the table,
1449 ;; then the keyword from the previous line is looked up and the rule
1450 ;; in element 3 is called. In this case, however,
1451 ;; `sh-get-indent-info' does not stop but may keep going and test
1452 ;; other keywords against rules in element 3. This is because the
1453 ;; preceding line could have, for example, an opening "if" and an
1454 ;; opening "while" keyword and we need to add the indentation offsets
1459 ("if" nil sh-handle-prev-if)
1460 ("elif" sh-handle-this-else sh-handle-prev-else)
1461 ("else" sh-handle-this-else sh-handle-prev-else)
1462 ("fi" sh-handle-this-fi sh-handle-prev-fi)
1463 ("then" sh-handle-this-then sh-handle-prev-then)
1464 ("(" nil sh-handle-prev-open)
1465 ("{" nil sh-handle-prev-open)
1466 ("[" nil sh-handle-prev-open)
1467 ("}" sh-handle-this-close nil)
1468 (")" sh-handle-this-close nil)
1469 ("]" sh-handle-this-close nil)
1470 ("case" nil sh-handle-prev-case)
1471 ("esac" sh-handle-this-esac sh-handle-prev-esac)
1472 (case-label nil sh-handle-after-case-label) ;; ???
1473 (";;" nil sh-handle-prev-case-alt-end) ;; ???
1474 ("done" sh-handle-this-done sh-handle-prev-done)
1475 ("do" sh-handle-this-do sh-handle-prev-do))
1477 ;; Note: we don't need specific stuff for bash and zsh shells;
1478 ;; the regexp `sh-regexp-for-done' handles the extra keywords
1479 ;; these shells use.
1481 ("{" nil sh-handle-prev-open)
1482 ("}" sh-handle-this-close nil)
1483 ("case" sh-handle-this-rc-case sh-handle-prev-rc-case))))
1486 (defun sh-set-shell (shell &optional no-query-flag insert-flag)
1487 "Set this buffer's shell to SHELL (a string).
1488 When used interactively, insert the proper starting #!-line,
1489 and make the visited file executable via `executable-set-magic',
1490 perhaps querying depending on the value of `executable-query'.
1492 When this function is called noninteractively, INSERT-FLAG (the third
1493 argument) controls whether to insert a #!-line and think about making
1494 the visited file executable, and NO-QUERY-FLAG (the second argument)
1495 controls whether to query about making the visited file executable.
1497 Calls the value of `sh-set-shell-hook' if set."
1498 (interactive (list (completing-read (format "Shell \(default %s\): "
1500 interpreter-mode-alist
1501 (lambda (x) (eq (cdr x) 'sh-mode))
1502 nil nil nil sh-shell-file)
1503 (eq executable-query 'function)
1505 (if (string-match "\\.exe\\'" shell)
1506 (setq shell (substring shell 0 (match-beginning 0))))
1507 (setq sh-shell (intern (file-name-nondirectory shell))
1508 sh-shell (or (cdr (assq sh-shell sh-alias-alist))
1512 (executable-set-magic shell (sh-feature sh-shell-arg)
1513 no-query-flag insert-flag)))
1514 (let ((tem (sh-feature sh-require-final-newline)))
1516 (setq require-final-newline mode-require-final-newline)))
1518 comment-start-skip "#+[\t ]*"
1519 local-abbrev-table sh-mode-abbrev-table
1520 mode-line-process (format "[%s]" sh-shell)
1521 sh-shell-variables nil
1522 sh-shell-variables-initialized nil
1523 imenu-generic-expression (sh-feature sh-imenu-generic-expression)
1524 imenu-case-fold-search nil)
1525 (make-local-variable 'sh-mode-syntax-table)
1526 (let ((tem (sh-feature sh-mode-syntax-table-input)))
1527 (setq sh-mode-syntax-table
1528 (if tem (apply 'sh-mode-syntax-table tem)
1529 sh-mode-default-syntax-table)))
1530 (set-syntax-table sh-mode-syntax-table)
1531 (dolist (var (sh-feature sh-variables))
1532 (sh-remember-variable var))
1533 (make-local-variable 'indent-line-function)
1534 (if (setq sh-indent-supported-here (sh-feature sh-indent-supported))
1536 (message "Setting up indent for shell type %s" sh-shell)
1537 (set (make-local-variable 'parse-sexp-lookup-properties) t)
1538 (set (make-local-variable 'sh-kw-alist) (sh-feature sh-kw))
1539 (let ((regexp (sh-feature sh-kws-for-done)))
1541 (set (make-local-variable 'sh-regexp-for-done)
1542 (sh-mkword-regexpr (regexp-opt regexp t)))))
1543 (message "setting up indent stuff")
1544 ;; sh-mode has already made indent-line-function local
1545 ;; but do it in case this is called before that.
1546 (setq indent-line-function 'sh-indent-line)
1547 (if sh-make-vars-local
1548 (sh-make-vars-local))
1549 (message "Indentation setup for shell type %s" sh-shell))
1550 (message "No indentation for this shell type.")
1551 (setq indent-line-function 'sh-basic-indent-line))
1552 (run-hooks 'sh-set-shell-hook))
1556 (defun sh-feature (alist &optional function)
1557 "Index ALIST by the current shell.
1558 If ALIST isn't a list where every element is a cons, it is returned as is.
1559 Else indexing follows an inheritance logic which works in two ways:
1561 - Fall back on successive ancestors (see `sh-ancestor-alist') as long as
1562 the alist contains no value for the current shell.
1563 The ultimate default is always `sh'.
1565 - If the value thus looked up is a list starting with `sh-append',
1566 we call the function `sh-append' with the rest of the list as
1567 arguments, and use the value. However, the next element of the
1568 list is not used as-is; instead, we look it up recursively
1569 in ALIST to allow the function called to define the value for
1570 one shell to be derived from another shell.
1571 The value thus determined is physically replaced into the alist.
1573 Optional FUNCTION is applied to the determined value and the result is cached
1575 (or (if (consp alist)
1577 (while (and l (consp (car l)))
1581 (cdr (assoc (setq function (cons sh-shell function)) alist)))
1582 (let ((sh-shell sh-shell)
1584 (while (and sh-shell
1585 (not (setq elt (assq sh-shell alist))))
1586 (setq sh-shell (cdr (assq sh-shell sh-ancestor-alist))))
1587 ;; If the shell is not known, treat it as sh.
1589 (setq elt (assq 'sh alist)))
1590 (if (and (consp (setq val (cdr elt)))
1591 (memq (car val) '(sh-append sh-modify)))
1595 (let ((sh-shell (car (cdr val))))
1596 (if (assq sh-shell alist)
1602 (list (cons function
1603 (setq sh-shell (car function)
1604 val (funcall (cdr function) val))))))
1609 ;; I commented this out because nobody calls it -- rms.
1610 ;;(defun sh-abbrevs (ancestor &rest list)
1611 ;; "Iff it isn't, define the current shell as abbrev table and fill that.
1612 ;;Abbrev table will inherit all abbrevs from ANCESTOR, which is either an abbrev
1613 ;;table or a list of (NAME1 EXPANSION1 ...). In addition it will define abbrevs
1614 ;;according to the remaining arguments NAMEi EXPANSIONi ...
1615 ;;EXPANSION may be either a string or a skeleton command."
1616 ;; (or (if (boundp sh-shell)
1617 ;; (symbol-value sh-shell))
1619 ;; (if (listp ancestor)
1620 ;; (nconc list ancestor))
1621 ;; (define-abbrev-table sh-shell ())
1622 ;; (if (vectorp ancestor)
1623 ;; (mapatoms (lambda (atom)
1625 ;; (define-abbrev (symbol-value sh-shell)
1626 ;; (symbol-name atom)
1627 ;; (symbol-value atom)
1628 ;; (symbol-function atom))))
1631 ;; (define-abbrev (symbol-value sh-shell)
1633 ;; (if (stringp (car (cdr list)))
1636 ;; (if (symbolp (car (cdr list)))
1637 ;; (car (cdr list))))
1638 ;; (setq list (cdr (cdr list)))))
1639 ;; (symbol-value sh-shell)))
1642 (defun sh-append (ancestor &rest list)
1643 "Return list composed of first argument (a list) physically appended to rest."
1644 (nconc list ancestor))
1647 (defun sh-modify (skeleton &rest list)
1648 "Modify a copy of SKELETON by replacing I1 with REPL1, I2 with REPL2 ..."
1649 (setq skeleton (copy-sequence skeleton))
1651 (setcar (or (nthcdr (car list) skeleton)
1652 (error "Index %d out of bounds" (car list)))
1654 (setq list (nthcdr 2 list)))
1658 (defun sh-basic-indent-line ()
1659 "Indent a line for Sh mode (shell script mode).
1660 Indent as far as preceding non-empty line, then by steps of `sh-indentation'.
1661 Lines containing only comments are considered empty."
1663 (let ((previous (save-excursion
1664 (while (and (progn (beginning-of-line)
1668 (back-to-indentation)
1670 (eq (following-char) ?#)))))
1674 (indent-to (if (eq this-command 'newline-and-indent)
1676 (if (< (current-column)
1677 (setq current (progn (back-to-indentation)
1679 (if (eolp) previous 0)
1680 (delete-region (point)
1681 (progn (beginning-of-line) (point)))
1683 (max previous (* (1+ (/ current sh-indentation))
1685 (* (1+ (/ current sh-indentation)) sh-indentation))))))
1686 (if (< (current-column) (current-indentation))
1687 (skip-chars-forward " \t"))))
1690 (defun sh-execute-region (start end &optional flag)
1691 "Pass optional header and region to a subshell for noninteractive execution.
1692 The working directory is that of the buffer, and only environment variables
1693 are already set which is why you can mark a header within the script.
1695 With a positive prefix ARG, instead of sending region, define header from
1696 beginning of buffer to point. With a negative prefix ARG, instead of sending
1697 region, clear header."
1698 (interactive "r\nP")
1700 (setq sh-header-marker (if (> (prefix-numeric-value flag) 0)
1702 (if sh-header-marker
1704 (let (buffer-undo-list)
1705 (goto-char sh-header-marker)
1706 (append-to-buffer (current-buffer) start end)
1707 (shell-command-on-region (point-min)
1708 (setq end (+ sh-header-marker
1711 (delete-region sh-header-marker end)))
1712 (shell-command-on-region start end (concat sh-shell-file " -")))))
1715 (defun sh-remember-variable (var)
1716 "Make VARIABLE available for future completing reads in this buffer."
1717 (or (< (length var) sh-remember-variable-min)
1719 (assoc var sh-shell-variables)
1720 (push (cons var var) sh-shell-variables))
1725 (defun sh-quoted-p ()
1726 "Is point preceded by an odd number of backslashes?"
1727 (eq -1 (% (save-excursion (skip-chars-backward "\\\\")) 2)))
1729 ;; Indentation stuff.
1730 (defun sh-must-support-indent ()
1731 "*Signal an error if the shell type for this buffer is not supported.
1732 Also, the buffer must be in Shell-script mode."
1733 (unless sh-indent-supported-here
1734 (error "This buffer's shell does not support indentation through Emacs")))
1736 (defun sh-make-vars-local ()
1737 "Make the indentation variables local to this buffer.
1738 Normally they already are local. This command is provided in case
1739 variable `sh-make-vars-local' has been set to nil.
1741 To revert all these variables to the global values, use
1742 command `sh-reset-indent-vars-to-global-values'."
1744 (mapcar 'make-local-variable sh-var-list)
1745 (message "Indentation variable are now local."))
1747 (defun sh-reset-indent-vars-to-global-values ()
1748 "Reset local indentation variables to the global values.
1749 Then, if variable `sh-make-vars-local' is non-nil, make them local."
1751 (mapcar 'kill-local-variable sh-var-list)
1752 (if sh-make-vars-local
1753 (mapcar 'make-local-variable sh-var-list)))
1756 ;; Theoretically these are only needed in shell and derived modes.
1757 ;; However, the routines which use them are only called in those modes.
1758 (defconst sh-special-keywords "then\\|do")
1760 (defun sh-help-string-for-variable (var)
1761 "Construct a string for `sh-read-variable' when changing variable VAR ."
1762 (let ((msg (documentation-property var 'variable-documentation))
1764 (unless (memq var '(sh-first-lines-indent sh-indent-comment))
1767 You can enter a number (positive to increase indentation,
1768 negative to decrease indentation, zero for no change to indentation).
1770 Or, you can enter one of the following symbols which are relative to
1771 the value of variable `sh-basic-offset'
1772 which in this buffer is currently %s.
1776 (mapconcat (lambda (x)
1777 (nth (1- (length x)) x))
1778 sh-symbol-list "\n\t"))))
1780 ;; The following shows the global not the local value!
1781 ;; (format "Current value of %s is %s\n\n" var (symbol-value var))
1784 (defun sh-read-variable (var)
1785 "Read a new value for indentation variable VAR."
1786 (interactive "*variable? ") ;; to test
1787 (let ((minibuffer-help-form `(sh-help-string-for-variable
1790 (setq val (read-from-minibuffer
1791 (format "New value for %s (press %s for help): "
1792 var (single-key-description help-char))
1793 (format "%s" (symbol-value var))
1799 (defun sh-in-comment-or-string (start)
1800 "Return non-nil if START is in a comment or string."
1802 (let ((state (syntax-ppss start)))
1803 (or (nth 3 state) (nth 4 state)))))
1805 (defun sh-goto-matching-if ()
1806 "Go to the matching if for a fi.
1807 This handles nested if..fi pairs."
1808 (let ((found (sh-find-prev-matching "\\bif\\b" "\\bfi\\b" 1)))
1810 (goto-char found))))
1813 ;; Functions named sh-handle-this-XXX are called when the keyword on the
1814 ;; line whose indentation is being handled contain XXX;
1815 ;; those named sh-handle-prev-XXX are when XXX appears on the previous line.
1817 (defun sh-handle-prev-if ()
1818 (list '(+ sh-indent-after-if)))
1820 (defun sh-handle-this-else ()
1821 (if (sh-goto-matching-if)
1822 ;; (list "aligned to if")
1823 (list "aligned to if" '(+ sh-indent-for-else))
1827 (defun sh-handle-prev-else ()
1828 (if (sh-goto-matching-if)
1829 (list '(+ sh-indent-after-if))
1832 (defun sh-handle-this-fi ()
1833 (if (sh-goto-matching-if)
1834 (list "aligned to if" '(+ sh-indent-for-fi))
1838 (defun sh-handle-prev-fi ()
1839 ;; Why do we have this rule? Because we must go back to the if
1840 ;; to get its indent. We may continue back from there.
1841 ;; We return nil because we don't have anything to add to result,
1842 ;; the side affect of setting align-point is all that matters.
1843 ;; we could return a comment (a string) but I can't think of a good one...
1844 (sh-goto-matching-if)
1847 (defun sh-handle-this-then ()
1848 (let ((p (sh-goto-matching-if)))
1850 (list '(+ sh-indent-for-then))
1853 (defun sh-handle-prev-then ()
1854 (let ((p (sh-goto-matching-if)))
1856 (list '(+ sh-indent-after-if))
1859 (defun sh-handle-prev-open ()
1861 (let ((x (sh-prev-stmt)))
1866 (looking-at "function\\b")
1867 (looking-at "\\s-*\\S-+\\s-*()")
1869 (list '(+ sh-indent-after-function))
1870 (list '(+ sh-indent-after-open)))
1873 (defun sh-handle-this-close ()
1874 (forward-char 1) ;; move over ")"
1875 (if (sh-safe-forward-sexp -1)
1876 (list "aligned to opening paren")))
1878 (defun sh-goto-matching-case ()
1879 (let ((found (sh-find-prev-matching "\\bcase\\b" "\\besac\\b" 1)))
1880 (if found (goto-char found))))
1882 (defun sh-handle-prev-case ()
1883 ;; This is typically called when point is on same line as a case
1884 ;; we shouldn't -- and can't find prev-case
1885 (if (looking-at ".*\\<case\\>")
1886 (list '(+ sh-indent-for-case-label))
1887 (error "We don't seem to be on a line with a case"))) ;; debug
1889 (defun sh-handle-this-esac ()
1890 (if (sh-goto-matching-case)
1891 (list "aligned to matching case")))
1893 (defun sh-handle-prev-esac ()
1894 (if (sh-goto-matching-case)
1895 (list "matching case")))
1897 (defun sh-handle-after-case-label ()
1898 (if (sh-goto-matching-case)
1899 (list '(+ sh-indent-for-case-alt))))
1901 (defun sh-handle-prev-case-alt-end ()
1902 (if (sh-goto-matching-case)
1903 (list '(+ sh-indent-for-case-label))))
1905 (defun sh-safe-forward-sexp (&optional arg)
1906 "Try and do a `forward-sexp', but do not error.
1907 Return new point if successful, nil if an error occurred."
1910 (forward-sexp (or arg 1))
1911 (point)) ;; return point if successful
1913 (sh-debug "oops!(1) %d" (point))
1914 nil))) ;; return nil if fail
1916 (defun sh-goto-match-for-done ()
1917 (let ((found (sh-find-prev-matching sh-regexp-for-done sh-re-done 1)))
1919 (goto-char found))))
1921 (defun sh-handle-this-done ()
1922 (if (sh-goto-match-for-done)
1923 (list "aligned to do stmt" '(+ sh-indent-for-done))))
1925 (defun sh-handle-prev-done ()
1926 (if (sh-goto-match-for-done)
1927 (list "previous done")))
1929 (defun sh-handle-this-do ()
1930 (if (sh-goto-match-for-done)
1931 (list '(+ sh-indent-for-do))))
1933 (defun sh-handle-prev-do ()
1941 (sh-goto-match-for-done))
1942 (sh-debug "match for done found on THIS line")
1943 (list '(+ sh-indent-after-loop-construct)))
1944 ((sh-goto-match-for-done)
1945 (sh-debug "match for done found on PREV line")
1946 (list '(+ sh-indent-after-do)))
1948 (message "match for done NOT found")
1952 (defun sh-find-prev-switch ()
1953 "Find the line for the switch keyword matching this line's case keyword."
1954 (re-search-backward "\\<switch\\>" nil t))
1956 (defun sh-handle-this-rc-case ()
1957 (if (sh-find-prev-switch)
1958 (list '(+ sh-indent-after-switch))
1959 ;; (list '(+ sh-indent-for-case-label))
1962 (defun sh-handle-prev-rc-case ()
1963 (list '(+ sh-indent-after-case)))
1965 (defun sh-check-rule (n thing)
1966 (let ((rule (nth n (assoc thing sh-kw-alist)))
1970 (setq val (funcall rule))
1971 (sh-debug "rule (%d) for %s at %d is %s\n-> returned %s"
1972 n thing (point) rule val)))
1976 (defun sh-get-indent-info ()
1977 "Return indent-info for this line.
1978 This is a list. nil means the line is to be left as is.
1979 Otherwise it contains one or more of the following sublists:
1980 \(t NUMBER\) NUMBER is the base location in the buffer that indentation is
1981 relative to. If present, this is always the first of the
1982 sublists. The indentation of the line in question is
1983 derived from the indentation of this point, possibly
1984 modified by subsequent sublists.
1986 \(- VAR\) Get the value of variable VAR and add to or subtract from
1987 the indentation calculated so far.
1988 \(= VAR\) Get the value of variable VAR and *replace* the
1989 indentation with its value. This only occurs for
1990 special variables such as `sh-indent-comment'.
1991 STRING This is ignored for the purposes of calculating
1992 indentation, it is printed in certain cases to help show
1993 what the indentation is based on."
1994 ;; See comments before `sh-kw'.
1996 (let ((have-result nil)
2004 ;; Note: setting result to t means we are done and will return nil.
2005 ;;(This function never returns just t.)
2007 ((or (and (boundp 'font-lock-string-face) (not (bobp))
2008 (eq (get-text-property (1- (point)) 'face)
2009 font-lock-string-face))
2010 (eq (get-text-property (point) 'face) sh-heredoc-face))
2012 (setq have-result t))
2013 ((looking-at "\\s-*#") ; was (equal this-kw "#")
2015 (setq result t) ;; return nil if 1st line!
2016 (setq result (list '(= sh-indent-comment)))
2017 ;; we still need to get previous line in case
2018 ;; sh-indent-comment is t (indent as normal)
2019 (setq align-point (sh-prev-line nil))
2020 (setq have-result nil)
2025 ;; Continuation lines are handled specially
2026 (if (sh-this-is-a-continuation)
2028 ;; We assume the line being continued is already
2029 ;; properly indented...
2030 ;; (setq prev-line-end (sh-prev-line))
2031 (setq align-point (sh-prev-line nil))
2032 (setq result (list '(+ sh-indent-for-continuation)))
2033 (setq have-result t))
2035 (skip-chars-forward " \t")
2036 (setq this-kw (sh-get-kw)))
2038 ;; Handle "this" keyword: first word on the line we're
2039 ;; calculating indentation info for.
2041 (if (setq val (sh-check-rule 1 this-kw))
2043 (setq align-point (point))
2045 "this - setting align-point to %d" align-point)
2046 (setq result (append result val))
2047 (setq have-result t)
2048 ;; set prev-line to continue processing remainder
2049 ;; of this line as a previous line
2050 (setq prev-line-end (point))
2054 (setq prev-line-end (sh-prev-line 'end)))
2058 ;; We start off at beginning of this line.
2059 ;; Scan previous statements while this is <=
2060 ;; start of previous line.
2061 (setq start (point)) ;; for debug only
2062 (goto-char prev-line-end)
2064 (while (and x (setq x (sh-prev-thing)))
2065 (sh-debug "at %d x is: %s result is: %s" (point) x result)
2068 (equal (get-text-property (1- (point)) 'syntax-table)
2070 (sh-debug "Case label) here")
2071 (setq x 'case-label)
2072 (if (setq val (sh-check-rule 2 x))
2074 (setq result (append result val))
2075 (setq align-point (point))))
2078 (skip-chars-forward "[a-z0-9]*?")
2080 ((string-match "[])}]" x)
2081 (setq x (sh-safe-forward-sexp -1))
2084 (setq align-point (point))
2085 (setq result (append result
2086 (list "aligned to opening paren")))
2088 ((string-match "[[({]" x)
2089 (sh-debug "Checking special thing: %s" x)
2090 (if (setq val (sh-check-rule 2 x))
2091 (setq result (append result val)))
2093 (setq align-point (point)))
2094 ((string-match "[\"'`]" x)
2095 (sh-debug "Skipping back for %s" x)
2097 (setq x (sh-safe-forward-sexp -1)))
2099 (sh-debug "Checking string %s at %s" x (point))
2100 (if (setq val (sh-check-rule 2 x))
2101 ;; (or (eq t (car val))
2102 ;; (eq t (car (car val))))
2103 (setq result (append result val)))
2104 ;; not sure about this test Wed Jan 27 23:48:35 1999
2105 (setq align-point (point))
2109 (error "Don't know what to do with %s" x))
2112 (sh-debug "result is %s" result)
2114 (sh-debug "No prev line!")
2115 (sh-debug "result: %s align-point: %s" result align-point)
2119 ;; was: (setq result (append result (list (list t align-point))))
2120 (setq result (append (list (list t align-point)) result))
2122 (sh-debug "result is now: %s" result)
2126 (setq result (list (list t prev-line-end)))
2127 (setq result (list (list '= 'sh-first-lines-indent)))
2132 (sh-debug "result is: %s" result)
2138 (defun sh-get-indent-var-for-line (&optional info)
2139 "Return the variable controlling indentation for this line.
2140 If there is not [just] one such variable, return a string
2141 indicating the problem.
2142 If INFO is supplied it is used, else it is calculated."
2148 (setq info (sh-get-indent-info)))
2150 (setq result "this line to be left as is")
2151 (while (and info (null result))
2152 (setq elt (car info))
2158 (error "sh-get-indent-var-for-line invalid elt: %s" elt))
2162 ((symbolp (setq sym (nth 1 elt)))
2163 ;; A bit of a kludge - when we see the sh-indent-comment
2164 ;; ignore other variables. Otherwise it is tricky to
2165 ;; "learn" the comment indentation.
2166 (if (eq var 'sh-indent-comment)
2170 "this line is controlled by more than 1 variable.")
2173 (error "sh-get-indent-var-for-line invalid list elt: %s" elt)))
2174 (setq info (cdr info))
2179 (setq result reason))
2181 ;; e.g. just had (t POS)
2182 (setq result "line has default indentation"))
2187 ;; Finding the previous line isn't trivial.
2188 ;; We must *always* go back one more and see if that is a continuation
2189 ;; line -- it is the PREVIOUS line which is continued, not the one
2191 ;; Also, we want to treat a whole "here document" as one big line,
2192 ;; because we may want to a align to the beginning of it.
2195 ;; - go back to previous non-empty line
2196 ;; - if this is in a here-document, go to the beginning of it
2197 ;; - while previous line is continued, go back one line
2198 (defun sh-prev-line (&optional end)
2199 "Back to end of previous non-comment non-empty line.
2200 Go to beginning of logical line unless END is non-nil, in which case
2201 we go to the end of the previous line and do not check for continuations."
2204 (forward-comment (- (point-max)))
2205 (unless end (beginning-of-line))
2206 (when (and (not (bobp))
2207 (equal (get-text-property (1- (point)) 'face)
2209 (let ((p1 (previous-single-property-change (1- (point)) 'face)))
2214 (beginning-of-line)))))
2216 ;; we must check previous lines to see if they are continuation lines
2217 ;; if so, we must return position of first of them
2218 (while (and (sh-this-is-a-continuation)
2219 (>= 0 (forward-line -1))))
2221 (skip-chars-forward " \t"))
2225 (defun sh-prev-stmt ()
2226 "Return the address of the previous stmt or nil."
2227 ;; This is used when we are trying to find a matching keyword.
2228 ;; Searching backward for the keyword would certainly be quicker, but
2229 ;; it is hard to remove "false matches" -- such as if the keyword
2230 ;; appears in a string or quote. This way is slower, but (I think) safer.
2237 (skip-chars-backward " \t;|&({[")
2238 (while (and (not found)
2241 ;; Do a backward-sexp if possible, else backup bit by bit...
2242 (if (sh-safe-forward-sexp -1)
2244 (if (looking-at sh-special-keywords)
2249 ;; backward-sexp failed
2250 (if (zerop (skip-chars-backward " \t()[\]{};`'"))
2253 (let ((back (sh-prev-line nil)))
2256 (setq going nil)))))
2258 (skip-chars-backward " \t")
2259 (if (or (and (bolp) (not (sh-this-is-a-continuation)))
2260 (eq (char-before) ?\;)
2261 (looking-at "\\s-*[|&]"))
2262 (setq found (point)))))
2267 (skip-chars-forward " \t|&({[")
2268 (setq found (point))))
2269 (if (>= (point) start)
2271 (debug "We didn't move!")
2274 (sh-debug "Did not find prev stmt.")))
2278 (defun sh-get-word ()
2279 "Get a shell word skipping whitespace from point."
2281 (skip-chars-forward "\t ")
2282 (let ((start (point)))
2284 (if (looking-at "[\"'`]")
2285 (sh-safe-forward-sexp)
2286 ;; (> (skip-chars-forward "^ \t\n\"'`") 0)
2287 (> (skip-chars-forward "-_a-zA-Z\$0-9") 0)
2289 (buffer-substring start (point))
2292 (defun sh-prev-thing ()
2293 "Return the previous thing this logical line."
2294 ;; This is called when `sh-get-indent-info' is working backwards on
2295 ;; the previous line(s) finding what keywords may be relevant for
2296 ;; indenting. It moves over sexps if possible, and will stop
2297 ;; on a ; and at the beginning of a line if it is not a continuation
2300 ;; Added a kludge for ";;"
2301 ;; Possible return values:
2303 ;; a string - possibly a keyword
2311 (if (sh-this-is-a-continuation)
2312 (setq min-point (sh-prev-line nil))
2315 (setq min-point (point))))
2317 (skip-chars-backward " \t;")
2318 (unless (looking-at "\\s-*;;")
2319 (skip-chars-backward "^)}];\"'`({[")
2320 (setq c (char-before))))
2321 (sh-debug "stopping at %d c is %s start=%d min-point=%d"
2322 (point) c start min-point)
2323 (if (< (point) min-point)
2324 (error "point %d < min-point %d" (point) min-point))
2326 ((looking-at "\\s-*;;")
2327 ;; (message "Found ;; !")
2333 ;; skip forward over white space newline and \ at eol
2334 (skip-chars-forward " \t\n\\\\")
2335 (sh-debug "Now at %d start=%d" (point) start)
2336 (if (>= (point) start)
2338 (sh-debug "point: %d >= start: %d" (point) start)
2343 ;; c -- return a string
2349 (defun sh-this-is-a-continuation ()
2350 "Return non-nil if current line is a continuation of previous line."
2352 (and (zerop (forward-line -1))
2353 (looking-at ".*\\\\$")
2354 (not (nth 4 (parse-partial-sexp (match-beginning 0) (match-end 0)
2357 (defun sh-get-kw (&optional where and-move)
2358 "Return first word of line from WHERE.
2359 If AND-MOVE is non-nil then move to end of word."
2360 (let ((start (point)))
2364 (buffer-substring (point)
2365 (progn (skip-chars-forward "^ \t\n;")(point)))
2367 (goto-char start)))))
2369 (defun sh-find-prev-matching (open close &optional depth)
2370 "Find a matching token for a set of opening and closing keywords.
2371 This takes into account that there may be nested open..close pairings.
2372 OPEN and CLOSE are regexps denoting the tokens to be matched.
2373 Optional parameter DEPTH (usually 1) says how many to look for."
2374 (let ((parse-sexp-ignore-comments t)
2376 (setq depth (or depth 1))
2382 (setq prev (sh-prev-stmt)))
2385 (if (looking-at "\\\\\n")
2388 (skip-chars-forward " \t")))
2391 (setq depth (1- depth))
2392 (sh-debug "found open at %d - depth = %d" (point) depth))
2394 (setq depth (1+ depth))
2395 (sh-debug "found close - depth = %d" depth))
2405 (defun sh-var-value (var &optional ignore-error)
2406 "Return the value of variable VAR, interpreting symbols.
2407 It can also return t or nil.
2408 If an invalid value is found, throw an error unless Optional argument
2409 IGNORE-ERROR is non-nil."
2410 (let ((val (symbol-value var)))
2421 (- sh-basic-offset))
2423 (* 2 sh-basic-offset))
2425 (* 2 (- sh-basic-offset)))
2427 (/ sh-basic-offset 2))
2429 (/ (- sh-basic-offset) 2))
2433 (message "Don't know how to handle %s's value of %s" var val)
2435 (error "Don't know how to handle %s's value of %s" var val))
2438 (defun sh-set-var-value (var value &optional no-symbol)
2439 "Set variable VAR to VALUE.
2440 Unless optional argument NO-SYMBOL is non-nil, then if VALUE is
2441 can be represented by a symbol then do so."
2445 ((= value sh-basic-offset)
2447 ((= value (- sh-basic-offset))
2449 ((eq value (* 2 sh-basic-offset))
2451 ((eq value (* 2 (- sh-basic-offset)))
2453 ((eq value (/ sh-basic-offset 2))
2455 ((eq value (/ (- sh-basic-offset) 2))
2462 (defun sh-calculate-indent (&optional info)
2463 "Return the indentation for the current line.
2464 If INFO is supplied it is used, else it is calculated from current line."
2469 (setq info (sh-get-indent-info)))
2472 (sh-debug "info: %s ofs=%s" info ofs)
2473 (setq elt (car info))
2475 ((stringp elt)) ;; do nothing?
2477 (setq a (car (car info)))
2478 (setq b (nth 1 (car info)))
2483 (setq val (current-indentation)))
2484 (setq base-value val))
2486 (setq val (sh-var-value b))
2492 ;; set info to nil so we stop immediately
2493 (setq base-value nil ofs nil info nil))
2494 ((eq val t) (setq ofs 0)) ;; indent as normal line
2496 ;; The following assume the (t POS) come first!
2497 (setq ofs val base-value 0)
2498 (setq info nil)))) ;; ? stop now
2499 ((eq a '+) (setq ofs (+ ofs val)))
2500 ((eq a '-) (setq ofs (- ofs val)))
2502 (error "sh-calculate-indent invalid a a=%s b=%s" a b))))
2504 (error "sh-calculate-indent invalid elt: a=%s b=%s" a b))))
2506 (error "sh-calculate-indent invalid elt %s" elt)))
2507 (sh-debug "a=%s b=%s val=%s base-value=%s ofs=%s"
2508 a b val base-value ofs)
2509 (setq info (cdr info)))
2511 (sh-debug "at end: base-value: %s ofs: %s" base-value ofs)
2514 ((or (null base-value)(null ofs))
2516 ((and (numberp base-value)(numberp ofs))
2517 (sh-debug "base (%d) + ofs (%d) = %d"
2518 base-value ofs (+ base-value ofs))
2519 (+ base-value ofs)) ;; return value
2521 (error "sh-calculate-indent: Help. base-value=%s ofs=%s"
2526 (defun sh-indent-line ()
2527 "Indent the current line."
2529 (let ((indent (sh-calculate-indent))
2530 (pos (- (point-max) (point))))
2533 (skip-chars-forward " \t")
2534 (indent-line-to indent)
2535 ;; If initial point was within line's indentation,
2536 ;; position after the indentation. Else stay at same point in text.
2537 (if (> (- (point-max) pos) (point))
2538 (goto-char (- (point-max) pos))))))
2541 (defun sh-blink (blinkpos &optional msg)
2542 "Move cursor momentarily to BLINKPOS and display MSG."
2543 ;; We can get here without it being a number on first line
2544 (if (numberp blinkpos)
2546 (goto-char blinkpos)
2548 (sit-for blink-matching-delay))
2551 (defun sh-show-indent (arg)
2552 "Show the how the currently line would be indented.
2553 This tells you which variable, if any, controls the indentation of
2555 If optional arg ARG is non-null (called interactively with a prefix),
2556 a pop up window describes this variable.
2557 If variable `sh-blink' is non-nil then momentarily go to the line
2558 we are indenting relative to, if applicable."
2560 (sh-must-support-indent)
2561 (let* ((info (sh-get-indent-info))
2562 (var (sh-get-indent-var-for-line info))
2563 (curr-indent (current-indentation))
2566 (message (setq msg var))
2567 (setq val (sh-calculate-indent info))
2569 (if (eq curr-indent val)
2570 (setq msg (format "%s is %s" var (symbol-value var)))
2573 (format "%s (%s) would change indent from %d to: %d"
2574 var (symbol-value var) curr-indent val)
2575 (format "%s (%s) would leave line as is"
2576 var (symbol-value var)))
2579 (describe-variable var)))
2581 (let ((info (sh-get-indent-info)))
2582 (if (and info (listp (car info))
2583 (eq (car (car info)) t))
2584 (sh-blink (nth 1 (car info)) msg)
2589 (defun sh-set-indent ()
2590 "Set the indentation for the current line.
2591 If the current line is controlled by an indentation variable, prompt
2592 for a new value for it."
2594 (sh-must-support-indent)
2595 (let* ((info (sh-get-indent-info))
2596 (var (sh-get-indent-var-for-line info))
2597 val old-val indent-val)
2599 (message (format "Cannot set indent - %s" var))
2600 (setq old-val (symbol-value var))
2601 (setq val (sh-read-variable var))
2605 (setq indent-val (sh-calculate-indent info))
2607 (message "Variable: %s Value: %s would indent to: %d"
2608 var (symbol-value var) indent-val)
2609 (message "Variable: %s Value: %s would leave line as is."
2610 var (symbol-value var)))
2611 ;; I'm not sure about this, indenting it now?
2612 ;; No. Because it would give the impression that an undo would
2613 ;; restore thing, but the value has been altered.
2618 (message "Bad value for %s, restoring to previous value %s"
2625 (defun sh-learn-line-indent (arg)
2626 "Learn how to indent a line as it currently is indented.
2628 If there is an indentation variable which controls this line's indentation,
2629 then set it to a value which would indent the line the way it
2632 If the value can be represented by one of the symbols then do so
2633 unless optional argument ARG (the prefix when interactive) is non-nil."
2635 (sh-must-support-indent)
2636 ;; I'm not sure if we show allow learning on an empty line.
2637 ;; Though it might occasionally be useful I think it usually
2638 ;; would just be confusing.
2641 (looking-at "\\s-*$"))
2642 (message "sh-learn-line-indent ignores empty lines.")
2643 (let* ((info (sh-get-indent-info))
2644 (var (sh-get-indent-var-for-line info))
2645 ival sval diff new-val
2647 (curr-indent (current-indentation)))
2650 (message (format "Cannot learn line - %s" var)))
2651 ((eq var 'sh-indent-comment)
2652 ;; This is arbitrary...
2653 ;; - if curr-indent is 0, set to curr-indent
2654 ;; - else if it has the indentation of a "normal" line,
2656 ;; - else set to curr-indent.
2657 (setq sh-indent-comment
2658 (if (= curr-indent 0)
2660 (let* ((sh-indent-comment t)
2661 (val2 (sh-calculate-indent info)))
2662 (if (= val2 curr-indent)
2665 (message "%s set to %s" var (symbol-value var))
2667 ((numberp (setq sval (sh-var-value var)))
2668 (setq ival (sh-calculate-indent info))
2669 (setq diff (- curr-indent ival))
2671 (sh-debug "curr-indent: %d ival: %d diff: %d var:%s sval %s"
2672 curr-indent ival diff var sval)
2673 (setq new-val (+ sval diff))
2674 ;;; I commented out this because someone might want to replace
2675 ;;; a value of `+' with the current value of sh-basic-offset
2678 ;;; (message "No change needed!")
2679 (sh-set-var-value var new-val no-symbol)
2680 (message "%s set to %s" var (symbol-value var))
2684 (message "Cannot change %s" var))))))
2688 (defun sh-mark-init (buffer)
2689 "Initialize a BUFFER to be used by `sh-mark-line'."
2691 (set-buffer (get-buffer-create buffer))
2697 (defun sh-mark-line (message point buffer &optional add-linenum occur-point)
2698 "Insert MESSAGE referring to location POINT in current buffer into BUFFER.
2699 Buffer BUFFER is in `occur-mode'.
2700 If ADD-LINENUM is non-nil the message is preceded by the line number.
2701 If OCCUR-POINT is non-nil then the line is marked as a new occurrence
2702 so that `occur-next' and `occur-prev' will work."
2703 (let ((m1 (make-marker))
2707 (set-marker m1 point (current-buffer))
2709 (setq line (format "%d: " (1+ (count-lines 1 point))))))
2711 (if (get-buffer buffer)
2712 (set-buffer (get-buffer buffer))
2713 (set-buffer (get-buffer-create buffer))
2716 (goto-char (point-max))
2717 (setq start (point))
2720 (setq occur-point (point)))
2723 (add-text-properties
2725 '(mouse-face highlight
2726 help-echo "mouse-2: go to the line where I learned this")))
2730 (put-text-property start (point) 'occur-target m1)
2732 (put-text-property start occur-point
2739 ;; Is this really worth having?
2740 (defvar sh-learned-buffer-hook nil
2741 "*An abnormal hook, called with an alist of learned variables.")
2742 ;; Example of how to use sh-learned-buffer-hook
2744 ;; (defun what-i-learned (list)
2747 ;; (set-buffer "*scratch*")
2748 ;; (goto-char (point-max))
2749 ;; (insert "(setq\n")
2751 ;; (insert (format " %s %s \n"
2752 ;; (nth 0 (car p)) (nth 1 (car p))))
2753 ;; (setq p (cdr p)))
2757 ;; (add-hook 'sh-learned-buffer-hook 'what-i-learned)
2760 ;; Originally this was sh-learn-region-indent (beg end)
2761 ;; However, in practice this was awkward so I changed it to
2762 ;; use the whole buffer. Use narrowing if needbe.
2763 (defun sh-learn-buffer-indent (&optional arg)
2764 "Learn how to indent the buffer the way it currently is.
2766 Output in buffer \"*indent*\" shows any lines which have conflicting
2767 values of a variable, and the final value of all variables learned.
2768 This buffer is popped to automatically if there are any discrepancies.
2770 If no prefix ARG is given, then variables are set to numbers.
2771 If a prefix arg is given, then variables are set to symbols when
2772 applicable -- e.g. to symbol `+' if the value is that of the
2774 If a positive numerical prefix is given, then `sh-basic-offset'
2775 is set to the prefix's numerical value.
2776 Otherwise, sh-basic-offset may or may not be changed, according
2777 to the value of variable `sh-learn-basic-offset'.
2779 Abnormal hook `sh-learned-buffer-hook' if non-nil is called when the
2780 function completes. The function is abnormal because it is called
2781 with an alist of variables learned. This feature may be changed or
2782 removed in the future.
2784 This command can often take a long time to run."
2786 (sh-must-support-indent)
2788 (goto-char (point-min))
2789 (let ((learned-var-list nil)
2790 (out-buffer "*indent*")
2796 (comment-col nil) ;; number if all same, t if seen diff values
2797 (comments-always-default t) ;; nil if we see one not default
2799 (specified-basic-offset (and arg (numberp arg)
2803 (setq vec (make-vector max 0))
2804 (sh-mark-init out-buffer)
2806 (if specified-basic-offset
2808 (setq sh-basic-offset arg)
2810 (format "Using specified sh-basic-offset of %d"
2813 (format "Initial value of sh-basic-offset: %s"
2816 (while (< (point) (point-max))
2817 (setq linenum (1+ linenum))
2818 ;; (if (zerop (% linenum 10))
2819 (message "line %d" linenum)
2821 (unless (looking-at "\\s-*$") ;; ignore empty lines!
2822 (let* ((sh-indent-comment t) ;; info must return default indent
2823 (info (sh-get-indent-info))
2824 (var (sh-get-indent-var-for-line info))
2825 sval ival diff new-val
2826 (curr-indent (current-indentation)))
2832 ((numberp (setq sval (sh-var-value var 'no-error)))
2833 ;; the numberp excludes comments since sval will be t.
2834 (setq ival (sh-calculate-indent))
2835 (setq diff (- curr-indent ival))
2836 (setq new-val (+ sval diff))
2837 (sh-set-var-value var new-val 'no-symbol)
2838 (unless (looking-at "\\s-*#") ;; don't learn from comments
2839 (if (setq previous-set-info (assoc var learned-var-list))
2841 ;; it was already there, is it same value ?
2842 (unless (eq (symbol-value var)
2843 (nth 1 previous-set-info))
2845 (format "Variable %s was set to %s"
2846 var (symbol-value var))
2847 (point) out-buffer t t)
2849 (format " but was previously set to %s"
2850 (nth 1 previous-set-info))
2851 (nth 2 previous-set-info) out-buffer t)
2852 (setq num-diffs (1+ num-diffs))
2853 ;; (delete previous-set-info learned-var-list)
2854 (setcdr previous-set-info
2855 (list (symbol-value var) (point)))
2858 (setq learned-var-list
2859 (append (list (list var (symbol-value var)
2862 (if (numberp new-val)
2865 "This line's indent value: %d" new-val)
2867 (setq new-val (- new-val)))
2869 (aset vec new-val (1+ (aref vec new-val))))))
2871 ((eq var 'sh-indent-comment)
2872 (unless (= curr-indent (sh-calculate-indent info))
2873 ;; this is not the default indentation
2874 (setq comments-always-default nil)
2875 (if comment-col ;; then we have see one before
2876 (or (eq comment-col curr-indent)
2877 (setq comment-col t)) ;; seen a different one
2878 (setq comment-col curr-indent))
2881 (sh-debug "Cannot learn this line!!!")
2884 "at %s learned-var-list is %s" (point) learned-var-list)
2891 "comment-col = %s comments-always-default = %s"
2892 comment-col comments-always-default))
2894 (sh-mark-line msg nil out-buffer)))
2897 (setq msg "\nComments are all in 1st column.\n"))
2898 (comments-always-default
2899 (setq msg "\nComments follow default indentation.\n")
2900 (setq comment-col t))
2901 ((numberp comment-col)
2902 (setq msg (format "\nComments are in col %d." comment-col)))
2904 (setq msg "\nComments seem to be mixed, leaving them as is.\n")
2905 (setq comment-col nil)
2908 (sh-mark-line msg nil out-buffer)
2910 (sh-mark-line initial-msg nil out-buffer t t)
2912 (setq suggested (sh-guess-basic-offset vec))
2914 (if (and suggested (not specified-basic-offset))
2917 ;; t => set it if we have a single value as a number
2918 ((and (eq sh-learn-basic-offset t) (numberp suggested))
2920 ;; other non-nil => set it if only one value was found
2921 (sh-learn-basic-offset
2922 (if (numberp suggested)
2924 (if (= (length suggested) 1)
2930 (setq learned-var-list
2931 (append (list (list 'sh-basic-offset
2932 (setq sh-basic-offset new-value)
2935 ;; Not sure if we need to put this line in, since
2936 ;; it will appear in the "Learned variable settings".
2938 (format "Changed sh-basic-offset to: %d" sh-basic-offset)
2941 (if (listp suggested)
2942 (format "Possible value(s) for sh-basic-offset: %s"
2943 (mapconcat 'int-to-string suggested " "))
2944 (format "Suggested sh-basic-offset: %d" suggested))
2948 (setq learned-var-list
2949 (append (list (list 'sh-indent-comment comment-col (point-max)))
2951 (setq sh-indent-comment comment-col)
2952 (let ((name (buffer-name)))
2953 (sh-mark-line "\nLearned variable settings:" nil out-buffer)
2955 ;; Set learned variables to symbolic rather than numeric
2956 ;; values where possible.
2957 (dolist (learned-var (reverse learned-var-list))
2958 (let ((var (car learned-var))
2959 (val (nth 1 learned-var)))
2960 (when (and (not (eq var 'sh-basic-offset))
2962 (sh-set-var-value var val)))))
2963 (dolist (learned-var (reverse learned-var-list))
2964 (let ((var (car learned-var)))
2965 (sh-mark-line (format " %s %s" var (symbol-value var))
2966 (nth 2 learned-var) out-buffer)))
2968 (set-buffer out-buffer)
2969 (goto-char (point-min))
2971 (format "Indentation values for buffer %s.\n" name)
2972 (format "%d indentation variable%s different values%s\n\n"
2976 (if (zerop num-diffs)
2979 ;; Are abnormal hooks considered bad form?
2980 (run-hook-with-args 'sh-learned-buffer-hook learned-var-list)
2981 (if (or sh-popup-occur-buffer (> num-diffs 0))
2982 (pop-to-buffer out-buffer))
2985 (defun sh-guess-basic-offset (vec)
2986 "See if we can determine a reasonable value for `sh-basic-offset'.
2987 This is experimental, heuristic and arbitrary!
2988 Argument VEC is a vector of information collected by
2989 `sh-learn-buffer-indent'.
2991 number - there appears to be a good single value
2992 list of numbers - no obvious one, here is a list of one or more
2994 nil - we couldn't find a reasonable one."
2995 (let* ((max (1- (length vec)))
2997 (totals (make-vector max 0)))
2999 (aset totals i (+ (aref totals i) (* 4 (aref vec i))))
3001 (aset totals i (+ (aref totals i) (aref vec (/ i 2)))))
3003 (aset totals i (+ (aref totals i) (aref vec (* i 2)))))
3011 (if (/= (aref totals i) 0)
3012 (setq x (append x (list (cons i (aref totals i))))))
3015 (setq x (sort x (lambda (a b) (> (cdr a) (cdr b)))))
3016 (setq tot (apply '+ (append totals nil)))
3017 (sh-debug (format "vec: %s\ntotals: %s\ntot: %d"
3021 (message "no values!")) ;; we return nil
3023 (message "only value is %d" (car (car x)))
3024 (setq result (car (car x)))) ;; return single value
3025 ((> (cdr (car x)) (/ tot 2))
3027 (message "basic-offset is probably %d" (car (car x)))
3028 (setq result (car (car x)))) ;; again, return a single value
3029 ((>= (cdr (car x)) (* 2 (cdr (car (cdr x)))))
3030 ;; 1st is >= 2 * 2nd
3031 (message "basic-offset could be %d" (car (car x)))
3032 (setq result (car (car x))))
3033 ((>= (+ (cdr (car x))(cdr (car (cdr x)))) (/ tot 2))
3034 ;; 1st & 2nd together >= 50% - return a list
3035 (setq p x sum 0 result nil)
3037 (<= (setq sum (+ sum (cdr (car p)))) (/ tot 2)))
3038 (setq result (append result (list (car (car p)))))
3040 (message "Possible choices for sh-basic-offset: %s"
3041 (mapconcat 'int-to-string result " ")))
3043 (message "No obvious value for sh-basic-offset. Perhaps %d"
3045 ;; result is nil here
3049 ;; ========================================================================
3051 ;; Styles -- a quick and dirty way of saving the indentation settings.
3053 (defvar sh-styles-alist nil
3054 "A list of all known shell indentation styles.")
3056 (defun sh-name-style (name &optional confirm-overwrite)
3057 "Name the current indentation settings as a style called NAME.
3058 If this name exists, the command will prompt whether it should be
3060 - - it was called interactively with a prefix argument, or
3061 - - called non-interactively with optional CONFIRM-OVERWRITE non-nil."
3062 ;; (interactive "sName for this style: ")
3065 (read-from-minibuffer "Name for this style? " )
3066 (not current-prefix-arg)))
3067 (let ((slist (cons name
3068 (mapcar (lambda (var) (cons var (symbol-value var)))
3070 (style (assoc name sh-styles-alist)))
3072 (if (and confirm-overwrite
3073 (not (y-or-n-p "This style exists. Overwrite it? ")))
3074 (message "Not changing style %s" name)
3075 (message "Updating style %s" name)
3076 (setcdr style (cdr slist)))
3077 (message "Creating new style %s" name)
3078 (push slist sh-styles-alist))))
3080 (defun sh-load-style (name)
3081 "Set shell indentation values for this buffer from those in style NAME."
3082 (interactive (list (completing-read
3083 "Which style to use for this buffer? "
3084 sh-styles-alist nil t)))
3085 (let ((sl (assoc name sh-styles-alist)))
3087 (error "sh-load-style - style %s not known" name)
3088 (dolist (var (cdr sl))
3089 (set (car var) (cdr var))))))
3091 (defun sh-save-styles-to-buffer (buff)
3092 "Save all current styles in elisp to buffer BUFF.
3093 This is always added to the end of the buffer."
3095 (read-from-minibuffer "Buffer to save styles in? " "*scratch*")))
3096 (with-current-buffer (get-buffer-create buff)
3097 (goto-char (point-max))
3099 (pp `(setq sh-styles-alist ',sh-styles-alist) (current-buffer))))
3103 ;; statement syntax-commands for various shells
3105 ;; You are welcome to add the syntax or even completely new statements as
3106 ;; appropriate for your favorite shell.
3108 (defconst sh-non-closing-paren
3109 ;; If we leave it rear-sticky, calling `newline' ends up inserting a \n
3110 ;; that inherits this property, which then confuses the indentation.
3111 (propertize ")" 'syntax-table sh-st-punc 'rear-nonsticky t))
3113 (define-skeleton sh-case
3114 "Insert a case/switch statement. See `sh-feature'."
3116 "switch( " str " )" \n
3117 > "case " (read-string "pattern: ") ?: \n
3120 ( "other pattern, %s: "
3130 > "switch( " str " ) {" \n
3131 > "case " (read-string "pattern: ") \n
3133 ( "other pattern, %s: "
3141 > "case " str " in" \n
3143 > str sh-non-closing-paren \n
3146 > "*" sh-non-closing-paren \n
3151 (define-skeleton sh-for
3152 "Insert a for loop. See `sh-feature'."
3166 (sh "Index variable: "
3167 > "for " str " in " _ "; do" \n
3168 > _ | ?$ & (sh-remember-variable str) \n
3173 (define-skeleton sh-indexed-loop
3174 "Insert an indexed loop from 1 to n. See `sh-feature'."
3175 (bash sh-modify posix)
3176 (csh "Index variable: "
3178 "while( $" str " <= " (read-string "upper limit: ") " )" \n
3184 (ksh88 "Index variable: "
3185 > "integer " str "=0" \n
3186 > "while (( ( " str " += 1 ) <= "
3187 (read-string "upper limit: ")
3189 > _ ?$ (sh-remember-variable str) > \n
3191 (posix "Index variable: "
3193 "while [ $" str " -le "
3194 (read-string "upper limit: ")
3197 str ?= (sh-add (sh-remember-variable str) 1) \n
3199 (rc "Index variable: "
3200 > "for( " str " in" " `{awk 'BEGIN { for( i=1; i<="
3201 (read-string "upper limit: ")
3202 "; i++ ) print i }'`}) {" \n
3203 > _ ?$ (sh-remember-variable str) \n
3205 (sh "Index variable: "
3206 > "for " str " in `awk 'BEGIN { for( i=1; i<="
3207 (read-string "upper limit: ")
3208 "; i++ ) print i }'`; do" \n
3209 > _ ?$ (sh-remember-variable str) \n
3213 (defun sh-shell-initialize-variables ()
3214 "Scan the buffer for variable assignments.
3215 Add these variables to `sh-shell-variables'."
3216 (message "Scanning buffer `%s' for variable assignments..." (buffer-name))
3218 (goto-char (point-min))
3219 (setq sh-shell-variables-initialized t)
3220 (while (search-forward "=" nil t)
3222 (message "Scanning buffer `%s' for variable assignments...done"
3225 (defvar sh-add-buffer)
3227 (defun sh-add-completer (string predicate code)
3228 "Do completion using `sh-shell-variables', but initialize it first.
3229 This function is designed for use as the \"completion table\",
3230 so it takes three arguments:
3231 STRING, the current buffer contents;
3232 PREDICATE, the predicate for filtering possible matches;
3233 CODE, which says what kind of things to do.
3234 CODE can be nil, t or `lambda'.
3235 nil means to return the best completion of STRING, or nil if there is none.
3236 t means to return a list of all possible completions of STRING.
3237 `lambda' means to return t if STRING is a valid completion as it stands."
3238 (let ((sh-shell-variables
3240 (set-buffer sh-add-buffer)
3241 (or sh-shell-variables-initialized
3242 (sh-shell-initialize-variables))
3243 (nconc (mapcar (lambda (var)
3245 (substring var 0 (string-match "=" var))))
3247 process-environment)
3248 sh-shell-variables))))
3250 ((nil) (try-completion string sh-shell-variables predicate))
3251 (lambda (test-completion string sh-shell-variables predicate))
3252 (t (all-completions string sh-shell-variables predicate)))))
3254 (defun sh-add (var delta)
3255 "Insert an addition of VAR and prefix DELTA for Bourne (type) shell."
3257 (let ((sh-add-buffer (current-buffer)))
3258 (list (completing-read "Variable: " 'sh-add-completer)
3259 (prefix-numeric-value current-prefix-arg))))
3260 (insert (sh-feature '((bash . "$(( ")
3266 (sh-remember-variable var)
3267 (if (< delta 0) " - " " + ")
3268 (number-to-string (abs delta))
3269 (sh-feature '((bash . " ))")
3278 (define-skeleton sh-function
3279 "Insert a function definition. See `sh-feature'."
3280 (bash sh-modify ksh88
3283 "function " str " {" \n
3295 (define-skeleton sh-if
3296 "Insert an if statement. See `sh-feature'."
3298 "if( " str " ) then" \n
3300 ( "other condition, %s: "
3301 < "else if( " str " ) then" \n
3308 > "if { " str " } {" \n
3310 ( "other condition, %s: "
3311 "} { " str " } {" > \n
3318 > "if( " str " ) {" \n
3320 ( "other condition, %s: "
3321 "} else if( " str " ) {" > \n
3328 '(setq input (sh-feature sh-test))
3329 > "if " str "; then" \n
3331 ( "other condition, %s: "
3332 > "elif " str "; then" > \n
3341 (define-skeleton sh-repeat
3342 "Insert a repeat loop definition. See `sh-feature'."
3348 > "repeat " str "; do" > \n
3352 ;;;(put 'sh-repeat 'menu-enable '(sh-feature sh-repeat))
3356 (define-skeleton sh-select
3357 "Insert a select statement. See `sh-feature'."
3358 (ksh88 "Index variable: "
3359 > "select " str " in " _ "; do" \n
3362 (bash sh-append ksh88))
3363 ;;;(put 'sh-select 'menu-enable '(sh-feature sh-select))
3367 (define-skeleton sh-tmp-file
3368 "Insert code to setup temporary file handling. See `sh-feature'."
3369 (bash sh-append ksh88)
3370 (csh (file-name-nondirectory (buffer-file-name))
3371 "set tmp = /tmp/" str ".$$" \n
3373 (and (goto-char (point-max))
3377 "rm $tmp* >&/dev/null" > \n)
3378 (es (file-name-nondirectory (buffer-file-name))
3379 > "local( signals = $signals sighup sigint; tmp = /tmp/" str
3382 > "rm $tmp^* >[2]/dev/null" \n
3390 (rc (file-name-nondirectory (buffer-file-name))
3391 > "tmp = /tmp/" str ".$pid" \n
3392 "fn sigexit { rm $tmp^* >[2]/dev/null }" \n)
3393 (sh (file-name-nondirectory (buffer-file-name))
3394 > "TMP=${TMPDIR:-/tmp}/" str ".$$" \n
3395 "trap \"rm $TMP* 2>/dev/null\" " ?0 \n))
3399 (define-skeleton sh-until
3400 "Insert an until loop. See `sh-feature'."
3402 '(setq input (sh-feature sh-test))
3403 > "until " str "; do" \n
3406 ;;;(put 'sh-until 'menu-enable '(sh-feature sh-until))
3410 (define-skeleton sh-while
3411 "Insert a while loop. See `sh-feature'."
3427 '(setq input (sh-feature sh-test))
3428 > "while " str "; do" \n
3434 (define-skeleton sh-while-getopts
3435 "Insert a while getopts loop. See `sh-feature'.
3436 Prompts for an options string which consists of letters for each recognized
3437 option followed by a colon `:' if the option accepts an argument."
3442 > "switch( \"$1\" )" \n
3443 '(setq input '("- x" . 2))
3446 < "case " '(eval str)
3447 '(if (string-match " +" str)
3448 (setq v1 (substring str (match-end 0))
3449 str (substring str 0 (match-beginning 0)))
3452 > "set " v1 & " = $2" | -4 & _ \n
3453 (if v1 "shift") & \n
3468 18 "$(basename $0)")
3470 > "while getopts :" str " OPT; do" \n
3472 '(setq v1 (append (vconcat str) nil))
3473 ( (prog1 (if v1 (char-to-string (car v1)))
3474 (if (eq (nth 1 v1) ?:)
3475 (setq v1 (nthcdr 2 v1)
3479 > str "|+" str sh-non-closing-paren \n
3482 > "*" sh-non-closing-paren \n
3483 > "echo" " \"usage: " "`basename $0`"
3484 " [+-" '(setq v1 (point)) str
3486 (while (search-backward ":" v1 t)
3487 (replace-match " ARG] [+-" t t)))
3488 (if (eq (preceding-char) ?-) -5)
3489 (if (and (sequencep v1) (length v1)) "] " "} ")
3495 "shift " (sh-add "OPTIND" -1) \n
3500 (defun sh-assignment (arg)
3501 "Remember preceding identifier for future completion and do self-insert."
3503 (self-insert-command arg)
3505 (sh-remember-variable
3507 (if (re-search-forward (sh-feature sh-assignment-regexp)
3509 (beginning-of-line 1))
3511 (match-string 1))))))
3514 (defun sh-maybe-here-document (arg)
3515 "Insert self. Without prefix, following unquoted `<' inserts here document.
3516 The document is bounded by `sh-here-document-word'."
3518 (self-insert-command (prefix-numeric-value arg))
3520 (not (eq (char-after (- (point) 2)) last-command-char))
3524 (let ((tabs (if (string-match "\\`-" sh-here-document-word)
3525 (make-string (/ (current-indentation) tab-width) ?\t)
3527 (delim (replace-regexp-in-string "['\"]" ""
3528 sh-here-document-word)))
3529 (insert sh-here-document-word)
3530 (or (eolp) (looking-at "[ \t]") (insert ? ))
3537 (insert ?\n tabs (replace-regexp-in-string
3538 "\\`-?[ \t]*" "" delim))))))
3541 ;; various other commands
3543 (autoload 'comint-dynamic-complete "comint"
3544 "Dynamically perform completion at point." t)
3546 (autoload 'shell-dynamic-complete-command "shell"
3547 "Dynamically complete the command at point." t)
3549 (autoload 'comint-dynamic-complete-filename "comint"
3550 "Dynamically complete the filename at point." t)
3552 (autoload 'shell-dynamic-complete-environment-variable "shell"
3553 "Dynamically complete the environment variable at point." t)
3557 (defun sh-newline-and-indent ()
3558 "Strip unquoted whitespace, insert newline, and indent like current line."
3560 (indent-to (prog1 (current-indentation)
3561 (delete-region (point)
3563 (or (zerop (skip-chars-backward " \t"))
3569 (defun sh-beginning-of-command ()
3570 "Move point to successive beginnings of commands."
3572 (if (re-search-backward sh-beginning-of-command nil t)
3573 (goto-char (match-beginning 2))))
3575 (defun sh-end-of-command ()
3576 "Move point to successive ends of commands."
3578 (if (re-search-forward sh-end-of-command nil t)
3579 (goto-char (match-end 1))))
3581 ;; Backslashification. Stolen from make-mode.el.
3583 (defun sh-backslash-region (from to delete-flag)
3584 "Insert, align, or delete end-of-line backslashes on the lines in the region.
3585 With no argument, inserts backslashes and aligns existing backslashes.
3586 With an argument, deletes the backslashes.
3588 This function does not modify the last line of the region if the region ends
3589 right at the start of the following line; it does not modify blank lines
3590 at the start of the region. So you can put the region around an entire
3591 shell command and conveniently use this command."
3592 (interactive "r\nP")
3595 (let ((column sh-backslash-column)
3596 (endmark (make-marker)))
3597 (move-marker endmark to)
3598 ;; Compute the smallest column number past the ends of all the lines.
3599 (if sh-backslash-align
3601 (if (not delete-flag)
3602 (while (< (point) to)
3604 (if (= (preceding-char) ?\\)
3605 (progn (forward-char -1)
3606 (skip-chars-backward " \t")))
3607 (setq column (max column (1+ (current-column))))
3609 ;; Adjust upward to a tab column, if that doesn't push
3611 (if (> (% column tab-width) 0)
3612 (let ((adjusted (* (/ (+ column tab-width -1) tab-width)
3614 (if (< adjusted (window-width))
3615 (setq column adjusted))))))
3616 ;; Don't modify blank lines at start of region.
3618 (while (and (< (point) endmark) (eolp))
3620 ;; Add or remove backslashes on all the lines.
3621 (while (and (< (point) endmark)
3622 ;; Don't backslashify the last line
3623 ;; if the region ends right at the start of the next line.
3626 (< (point) endmark)))
3627 (if (not delete-flag)
3628 (sh-append-backslash column)
3629 (sh-delete-backslash))
3631 (move-marker endmark nil))))
3633 (defun sh-append-backslash (column)
3635 ;; Note that "\\\\" is needed to get one backslash.
3636 (if (= (preceding-char) ?\\)
3637 (progn (forward-char -1)
3638 (delete-horizontal-space)
3639 (indent-to column (if sh-backslash-align nil 1)))
3640 (indent-to column (if sh-backslash-align nil 1))
3643 (defun sh-delete-backslash ()
3648 (if (looking-at "\\\\")
3649 (delete-region (1+ (point))
3650 (progn (skip-chars-backward " \t") (point)))))))
3652 (provide 'sh-script)
3654 ;; arch-tag: eccd8b72-f337-4fc2-ae86-18155a69d937
3655 ;;; sh-script.el ends here