Add arch taglines
[bpt/emacs.git] / lisp / progmodes / sh-script.el
CommitLineData
ac59aed8 1;;; sh-script.el --- shell-script editing commands for Emacs
b578f267 2
5d1825c6 3;; Copyright (C) 1993, 94, 95, 96, 97, 1999, 2001, 2003
cf8b1bef 4;; Free Software Foundation, Inc.
ac59aed8 5
3e910376 6;; Author: Daniel Pfeiffer <occitan@esperanto.org>
f964dfcb 7;; Version: 2.0f
ac59aed8 8;; Maintainer: FSF
133693bc 9;; Keywords: languages, unix
ac59aed8
RS
10
11;; This file is part of GNU Emacs.
12
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)
16;; any later version.
17
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.
22
23;; You should have received a copy of the GNU General Public License
b578f267
EN
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.
ac59aed8
RS
27
28;;; Commentary:
29
133693bc
KH
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.
ac59aed8 35
133693bc
KH
36;;; Known Bugs:
37
bfc8e97b 38;; - In Bourne the keyword `in' is not anchored to case, for, select ...
133693bc
KH
39;; - Variables in `"' strings aren't fontified because there's no way of
40;; syntactically distinguishing those from `'' strings.
e932f2d2 41
f964dfcb
GM
42;; Indentation
43;; ===========
44;; Indentation for rc and es modes is very limited, but for Bourne shells
45;; and its derivatives it is quite customizable.
035107fa 46;;
f964dfcb
GM
47;; The following description applies to sh and derived shells (bash,
48;; zsh, ...).
035107fa 49;;
f964dfcb
GM
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
8db2b9fb 54;; an if statement, and sh-indent-for-fi controls the indentation
f964dfcb 55;; of the line containing the fi.
035107fa 56;;
f964dfcb
GM
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:
035107fa 61;;
f964dfcb
GM
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.
035107fa 68;;
f964dfcb 69;; There are 4 commands to help set the indentation variables:
035107fa 70;;
f964dfcb
GM
71;; `sh-show-indent'
72;; This shows what variable controls the indentation of the current
73;; line and its value.
035107fa 74;;
f964dfcb
GM
75;; `sh-set-indent'
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.
035107fa 82;;
f964dfcb
GM
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.
035107fa 88;;
f964dfcb
GM
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
96;; non-nil.
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'.
035107fa 101;;
f964dfcb
GM
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
108;; suffice.
035107fa 109;;
f964dfcb
GM
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
115;; the buffer.
116;; You can do this automatically like this:
6c5bcbc1 117;; (add-hook 'sh-set-shell-hook 'sh-learn-buffer-indent)
035107fa 118;;
4a9592f6 119;; However... `sh-learn-buffer-indent' is extremely slow,
8db2b9fb 120;; especially on large-ish buffer. Also, if there are conflicts the
f964dfcb 121;; "last one wins" which may not produce the desired setting.
035107fa 122;;
f964dfcb
GM
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.
035107fa 125;;
f964dfcb
GM
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.
035107fa 133;;
f964dfcb
GM
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
8db2b9fb 138;; a user sets values using customization, these changes won't appear
f964dfcb 139;; to work if the variables are already local!
035107fa 140;;
8db2b9fb 141;; To get round this, there is a variable `sh-make-vars-local' and 2
f964dfcb 142;; functions: `sh-make-vars-local' and `sh-reset-indent-vars-to-global-values'.
035107fa 143;;
8db2b9fb 144;; If `sh-make-vars-local' is non-nil, then these variables become
f964dfcb 145;; buffer local when the mode is established.
8db2b9fb 146;; If this is nil, then the variables are global. At any time you
f964dfcb 147;; can make them local with the command `sh-make-vars-local'.
8db2b9fb 148;; Conversely, to update with the global values you can use the
f964dfcb 149;; command `sh-reset-indent-vars-to-global-values'.
035107fa 150;;
8db2b9fb 151;; This may be awkward, but the intent is to cover all cases.
035107fa 152;;
f964dfcb
GM
153;; Awkward things, pitfalls
154;; ------------------------
155;; Indentation for a sh script is complicated for a number of reasons:
035107fa 156;;
8db2b9fb 157;; 1. You can't format by simply looking at symbols, you need to look
f964dfcb
GM
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!
8db2b9fb 162;; 3. Here-documents in a script should be treated "as is", and when
f964dfcb
GM
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 "$#"!
035107fa 168;;
f964dfcb 169;; To try and address points 2 3 and 5 I used a feature that cperl mode
8db2b9fb 170;; uses, that of a text's syntax property. This, however, has 2
f964dfcb
GM
171;; disadvantages:
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'.
035107fa 178;;
f964dfcb
GM
179;; Bugs
180;; ----
f964dfcb
GM
181;; - Indenting many lines is slow. It currently does each line
182;; independently, rather than saving state information.
035107fa 183;;
f964dfcb 184;; - `sh-learn-buffer-indent' is extremely slow.
035107fa 185;;
f964dfcb
GM
186;; Richard Sharman <rsharman@pobox.com> June 1999.
187
ac59aed8
RS
188;;; Code:
189
190;; page 1: variables and settings
f964dfcb
GM
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
ac59aed8 195
d2d00127
DL
196(eval-when-compile
197 (require 'skeleton)
017708e9 198 (require 'cl)
d2d00127 199 (require 'comint))
133693bc
KH
200(require 'executable)
201
2bffb7c4 202
2bffb7c4 203
cd482e05
RS
204(defgroup sh nil
205 "Shell programming utilities"
206 :group 'unix
207 :group 'languages)
208
209(defgroup sh-script nil
210 "Shell script mode"
211 :group 'sh
212 :prefix "sh-")
213
214
215(defcustom sh-ancestor-alist
133693bc
KH
216 '((ash . sh)
217 (bash . jsh)
457316e9 218 (bash2 . jsh)
133693bc
KH
219 (dtksh . ksh)
220 (es . rc)
221 (itcsh . tcsh)
222 (jcsh . csh)
223 (jsh . sh)
224 (ksh . ksh88)
225 (ksh88 . jsh)
226 (oash . sh)
227 (pdksh . ksh88)
228 (posix . sh)
229 (tcsh . csh)
230 (wksh . ksh88)
231 (wsh . sh)
547745f5
RS
232 (zsh . ksh88)
233 (rpm . sh))
133693bc
KH
234 "*Alist showing the direct ancestor of various shells.
235This is the basis for `sh-feature'. See also `sh-alias-alist'.
236By default we have the following three hierarchies:
237
238csh C Shell
239 jcsh C Shell with Job Control
3e2dd647
SM
240 tcsh Turbo C Shell
241 itcsh ? Turbo C Shell
133693bc
KH
242rc Plan 9 Shell
243 es Extensible Shell
244sh Bourne Shell
245 ash ? Shell
246 jsh Bourne Shell with Job Control
247 bash GNU Bourne Again Shell
248 ksh88 Korn Shell '88
249 ksh Korn Shell '93
250 dtksh CDE Desktop Korn Shell
251 pdksh Public Domain Korn Shell
252 wksh Window Korn Shell
253 zsh Z Shell
254 oash SCO OA (curses) Shell
255 posix IEEE 1003.2 Shell Standard
cd482e05
RS
256 wsh ? Shell"
257 :type '(repeat (cons symbol symbol))
258 :group 'sh-script)
133693bc
KH
259
260
cd482e05 261(defcustom sh-alias-alist
3ee5ce58 262 (append (if (eq system-type 'gnu/linux)
133693bc 263 '((csh . tcsh)
aafd074a 264 (ksh . pdksh)))
133693bc
KH
265 ;; for the time being
266 '((ksh . ksh88)
457316e9 267 (bash2 . bash)
133693bc
KH
268 (sh5 . sh)))
269 "*Alist for transforming shell names to what they really are.
270Use this where the name of the executable doesn't correspond to the type of
cd482e05
RS
271shell it really is."
272 :type '(repeat (cons symbol symbol))
273 :group 'sh-script)
133693bc
KH
274
275
cd482e05 276(defcustom sh-shell-file
d9de8c04 277 (or
5c449169
RS
278 ;; On MSDOS and Windows, collapse $SHELL to lower-case and remove
279 ;; the executable extension, so comparisons with the list of
d9de8c04 280 ;; known shells work.
5c449169 281 (and (memq system-type '(ms-dos windows-nt))
eee86eff
EZ
282 (let* ((shell (getenv "SHELL"))
283 (shell-base
284 (and shell (file-name-nondirectory shell))))
285 ;; shell-script mode doesn't support DOS/Windows shells,
286 ;; so use the default instead.
287 (if (or (null shell)
288 (member (downcase shell-base)
ced7b4a4
RS
289 '("command.com" "cmd.exe" "4dos.com" "ndos.com"
290 "cmdproxy.exe")))
eee86eff
EZ
291 "/bin/sh"
292 (file-name-sans-extension (downcase shell)))))
d9de8c04
RS
293 (getenv "SHELL")
294 "/bin/sh")
cd482e05
RS
295 "*The executable file name for the shell being programmed."
296 :type 'string
297 :group 'sh-script)
133693bc
KH
298
299
cd482e05 300(defcustom sh-shell-arg
8d31ff15 301 ;; bash does not need any options when run in a shell script,
8e46e267 302 '((bash)
133693bc 303 (csh . "-f")
133693bc 304 (pdksh)
8d31ff15 305 ;; Bill_Mann@praxisint.com says -p with ksh can do harm.
8e46e267 306 (ksh88)
8d31ff15 307 ;; -p means don't initialize functions from the environment.
133693bc 308 (rc . "-p")
8d31ff15
RS
309 ;; Someone proposed -motif, but we don't want to encourage
310 ;; use of a non-free widget set.
311 (wksh)
312 ;; -f means don't run .zshrc.
133693bc 313 (zsh . "-f"))
cd482e05
RS
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 (cons :format "Evaluate: %v"
319 (const :format "" eval)
320 sexp))))
321 :group 'sh-script)
133693bc 322
aa2c2426 323(defcustom sh-imenu-generic-expression
6c5bcbc1
SM
324 `((sh
325 . ((nil "^\\s-*\\(function\\s-+\\)?\\([A-Za-z_][A-Za-z_0-9]+\\)\\s-*()" 2))))
83c5d68f
DL
326 "*Alist of regular expressions for recognizing shell function definitions.
327See `sh-feature' and `imenu-generic-expression'."
328 :type '(alist :key-type (symbol :tag "Shell")
329 :value-type (alist :key-type (choice :tag "Title"
330 string
331 (const :tag "None" nil))
332 :value-type
333 (repeat :tag "Regexp, index..." sexp)))
cd32a7ba 334 :group 'sh-script
f964dfcb 335 :version "20.4")
aa2c2426 336
5a989d6e
RS
337(defvar sh-shell-variables nil
338 "Alist of shell variable names that should be included in completion.
339These are used for completion in addition to all the variables named
340in `process-environment'. Each element looks like (VAR . VAR), where
341the car and cdr are the same symbol.")
133693bc 342
5d73ac66
RS
343(defvar sh-shell-variables-initialized nil
344 "Non-nil if `sh-shell-variables' is initialized.")
345
aafd074a
KH
346(defun sh-canonicalize-shell (shell)
347 "Convert a shell name SHELL to the one we should handle it as."
842cc0e6 348 (if (string-match "\\.exe\\'" shell)
c8b88e9f 349 (setq shell (substring shell 0 (match-beginning 0))))
aafd074a
KH
350 (or (symbolp shell)
351 (setq shell (intern shell)))
352 (or (cdr (assq shell sh-alias-alist))
353 shell))
133693bc 354
aafd074a
KH
355(defvar sh-shell (sh-canonicalize-shell (file-name-nondirectory sh-shell-file))
356 "The shell being programmed. This is set by \\[sh-set-shell].")
133693bc 357
3e2dd647
SM
358;; I turned off this feature because it doesn't permit typing commands
359;; in the usual way without help.
360;;(defvar sh-abbrevs
361;; '((csh eval sh-abbrevs shell
362;; "switch" 'sh-case
363;; "getopts" 'sh-while-getopts)
364
365;; (es eval sh-abbrevs shell
366;; "function" 'sh-function)
367
368;; (ksh88 eval sh-abbrevs sh
369;; "select" 'sh-select)
370
371;; (rc eval sh-abbrevs shell
372;; "case" 'sh-case
373;; "function" 'sh-function)
374
375;; (sh eval sh-abbrevs shell
376;; "case" 'sh-case
377;; "function" 'sh-function
378;; "until" 'sh-until
379;; "getopts" 'sh-while-getopts)
380
381;; ;; The next entry is only used for defining the others
382;; (shell "for" sh-for
383;; "loop" sh-indexed-loop
384;; "if" sh-if
385;; "tmpfile" sh-tmp-file
386;; "while" sh-while)
387
388;; (zsh eval sh-abbrevs ksh88
389;; "repeat" 'sh-repeat))
390;; "Abbrev-table used in Shell-Script mode. See `sh-feature'.
aafd074a
KH
391;;;Due to the internal workings of abbrev tables, the shell name symbol is
392;;;actually defined as the table for the like of \\[edit-abbrevs].")
ac59aed8 393
ac59aed8
RS
394
395
b1e851bb
RS
396(defvar sh-mode-syntax-table
397 '((sh eval sh-mode-syntax-table ()
398 ?\# "<"
b1e851bb
RS
399 ?\n ">#"
400 ?\" "\"\""
401 ?\' "\"'"
402 ?\` "\"`"
403 ?! "_"
404 ?% "_"
405 ?: "_"
406 ?. "_"
407 ?^ "_"
408 ?~ "_"
29653ebc 409 ?, "_"
b1e851bb
RS
410 ?< "."
411 ?> ".")
412 (csh eval identity sh)
413 (rc eval identity sh))
414
415 "Syntax-table used in Shell-Script mode. See `sh-feature'.")
ac59aed8
RS
416
417(defvar sh-mode-map
bfc8e97b
KH
418 (let ((map (make-sparse-keymap))
419 (menu-map (make-sparse-keymap "Insert")))
ac59aed8
RS
420 (define-key map "\C-c(" 'sh-function)
421 (define-key map "\C-c\C-w" 'sh-while)
422 (define-key map "\C-c\C-u" 'sh-until)
133693bc 423 (define-key map "\C-c\C-t" 'sh-tmp-file)
ac59aed8 424 (define-key map "\C-c\C-s" 'sh-select)
133693bc
KH
425 (define-key map "\C-c\C-r" 'sh-repeat)
426 (define-key map "\C-c\C-o" 'sh-while-getopts)
ac59aed8
RS
427 (define-key map "\C-c\C-l" 'sh-indexed-loop)
428 (define-key map "\C-c\C-i" 'sh-if)
429 (define-key map "\C-c\C-f" 'sh-for)
430 (define-key map "\C-c\C-c" 'sh-case)
f964dfcb
GM
431 (define-key map "\C-c?" 'sh-show-indent)
432 (define-key map "\C-c=" 'sh-set-indent)
433 (define-key map "\C-c<" 'sh-learn-line-indent)
434 (define-key map "\C-c>" 'sh-learn-buffer-indent)
133693bc 435
ac59aed8
RS
436 (define-key map "=" 'sh-assignment)
437 (define-key map "\C-c+" 'sh-add)
fd4ea9a2
RS
438 (define-key map "\C-\M-x" 'sh-execute-region)
439 (define-key map "\C-c\C-x" 'executable-interpret)
133693bc 440 (define-key map "<" 'sh-maybe-here-document)
81ed2d75
KH
441 (define-key map "(" 'skeleton-pair-insert-maybe)
442 (define-key map "{" 'skeleton-pair-insert-maybe)
443 (define-key map "[" 'skeleton-pair-insert-maybe)
444 (define-key map "'" 'skeleton-pair-insert-maybe)
445 (define-key map "`" 'skeleton-pair-insert-maybe)
446 (define-key map "\"" 'skeleton-pair-insert-maybe)
ac59aed8 447
5d1825c6
AS
448 (define-key map [remap complete-tag] 'comint-dynamic-complete)
449 (define-key map [remap newline-and-indent] 'sh-newline-and-indent)
450 (define-key map [remap delete-backward-char]
451 'backward-delete-char-untabify)
ac59aed8 452 (define-key map "\C-c:" 'sh-set-shell)
5d1825c6
AS
453 (define-key map [remap backward-sentence] 'sh-beginning-of-command)
454 (define-key map [remap forward-sentence] 'sh-end-of-command)
bfc8e97b
KH
455 (define-key map [menu-bar insert] (cons "Insert" menu-map))
456 (define-key menu-map [sh-while] '("While Loop" . sh-while))
457 (define-key menu-map [sh-until] '("Until Loop" . sh-until))
458 (define-key menu-map [sh-tmp-file] '("Temporary File" . sh-tmp-file))
459 (define-key menu-map [sh-select] '("Select Statement" . sh-select))
460 (define-key menu-map [sh-repeat] '("Repeat Loop" . sh-repeat))
6c5bcbc1
SM
461 (define-key menu-map [sh-getopts] '("Options Loop" . sh-while-getopts))
462 (define-key menu-map [sh-indexed-loop] '("Indexed Loop" . sh-indexed-loop))
bfc8e97b
KH
463 (define-key menu-map [sh-if] '("If Statement" . sh-if))
464 (define-key menu-map [sh-for] '("For Loop" . sh-for))
465 (define-key menu-map [sh-case] '("Case Statement" . sh-case))
ac59aed8
RS
466 map)
467 "Keymap used in Shell-Script mode.")
468
469
470
cd482e05 471(defcustom sh-dynamic-complete-functions
133693bc
KH
472 '(shell-dynamic-complete-environment-variable
473 shell-dynamic-complete-command
474 comint-dynamic-complete-filename)
cd482e05
RS
475 "*Functions for doing TAB dynamic completion."
476 :type '(repeat function)
477 :group 'sh-script)
ac59aed8
RS
478
479
cd482e05 480(defcustom sh-require-final-newline
133693bc
KH
481 '((csh . t)
482 (pdksh . t)
483 (rc eval . require-final-newline)
484 (sh eval . require-final-newline))
485 "*Value of `require-final-newline' in Shell-Script mode buffers.
cd482e05
RS
486See `sh-feature'."
487 :type '(repeat (cons (symbol :tag "Shell")
488 (choice (const :tag "require" t)
489 (cons :format "Evaluate: %v"
490 (const :format "" eval)
491 sexp))))
492 :group 'sh-script)
ac59aed8
RS
493
494
c410bd65 495(defcustom sh-assignment-regexp
133693bc
KH
496 '((csh . "\\<\\([a-zA-Z0-9_]+\\)\\(\\[.+\\]\\)?[ \t]*[-+*/%^]?=")
497 ;; actually spaces are only supported in let/(( ... ))
498 (ksh88 . "\\<\\([a-zA-Z0-9_]+\\)\\(\\[.+\\]\\)?[ \t]*\\([-+*/%&|~^]\\|<<\\|>>\\)?=")
499 (rc . "\\<\\([a-zA-Z0-9_*]+\\)[ \t]*=")
500 (sh . "\\<\\([a-zA-Z0-9_]+\\)="))
501 "*Regexp for the variable name and what may follow in an assignment.
502First grouping matches the variable name. This is upto and including the `='
cd482e05
RS
503sign. See `sh-feature'."
504 :type '(repeat (cons (symbol :tag "Shell")
505 (choice regexp
506 (cons :format "Evaluate: %v"
507 (const :format "" eval)
508 sexp))))
509 :group 'sh-script)
ac59aed8 510
ac59aed8 511
cd482e05
RS
512(defcustom sh-indentation 4
513 "The width for further indentation in Shell-Script mode."
514 :type 'integer
515 :group 'sh-script)
ac59aed8 516
ac59aed8 517
cd482e05
RS
518(defcustom sh-remember-variable-min 3
519 "*Don't remember variables less than this length for completing reads."
520 :type 'integer
521 :group 'sh-script)
ac59aed8
RS
522
523
133693bc 524(defvar sh-header-marker nil
f964dfcb 525 "When non-nil is the end of header for prepending by \\[sh-execute-region].
133693bc
KH
526That command is also used for setting this variable.")
527
528
cd482e05 529(defcustom sh-beginning-of-command
84bfbb44 530 "\\([;({`|&]\\|\\`\\|[^\\]\n\\)[ \t]*\\([/~a-zA-Z0-9:]\\)"
ac59aed8 531 "*Regexp to determine the beginning of a shell command.
cd482e05
RS
532The actual command starts at the beginning of the second \\(grouping\\)."
533 :type 'regexp
534 :group 'sh-script)
ac59aed8 535
133693bc 536
cd482e05 537(defcustom sh-end-of-command
84bfbb44 538 "\\([/~a-zA-Z0-9:]\\)[ \t]*\\([;#)}`|&]\\|$\\)"
ac59aed8 539 "*Regexp to determine the end of a shell command.
cd482e05
RS
540The actual command ends at the end of the first \\(grouping\\)."
541 :type 'regexp
542 :group 'sh-script)
ac59aed8
RS
543
544
545
133693bc 546(defvar sh-here-document-word "EOF"
18368c4a
GM
547 "Word to delimit here documents.
548If the first character of this string is \"-\", this character will
549be removed from the string when it is used to close the here document.
550This convention is used by the Bash shell, for example, to indicate
551that leading tabs inside the here document should be ignored.
552Note that Emacs currently has no support for indenting inside here
553documents - you must insert literal tabs by hand.")
ac59aed8 554
225f6185
KH
555(defvar sh-test
556 '((sh "[ ]" . 3)
557 (ksh88 "[[ ]]" . 4))
558 "Initial input in Bourne if, while and until skeletons. See `sh-feature'.")
559
ac59aed8 560
cd482e05
RS
561;; customized this out of sheer bravado. not for the faint of heart.
562;; but it *did* have an asterisk in the docstring!
563(defcustom sh-builtins
84bfbb44 564 '((bash eval sh-append posix
fa1d74c5
GM
565 "." "alias" "bg" "bind" "builtin" "compgen" "complete"
566 "declare" "dirs" "disown" "enable" "fc" "fg" "help" "history"
567 "jobs" "kill" "let" "local" "popd" "printf" "pushd" "source"
84bfbb44 568 "suspend" "typeset" "unalias")
ac59aed8 569
133693bc
KH
570 ;; The next entry is only used for defining the others
571 (bourne eval sh-append shell
84bfbb44
KH
572 "eval" "export" "getopts" "newgrp" "pwd" "read" "readonly"
573 "times" "ulimit")
ac59aed8 574
133693bc 575 (csh eval sh-append shell
84bfbb44
KH
576 "alias" "chdir" "glob" "history" "limit" "nice" "nohup" "rehash"
577 "setenv" "source" "time" "unalias" "unhash")
578
579 (dtksh eval identity wksh)
ac59aed8 580
84bfbb44
KH
581 (es "access" "apids" "cd" "echo" "eval" "false" "let" "limit" "local"
582 "newpgrp" "result" "time" "umask" "var" "vars" "wait" "whatis")
ac59aed8 583
133693bc
KH
584 (jsh eval sh-append sh
585 "bg" "fg" "jobs" "kill" "stop" "suspend")
ac59aed8 586
133693bc 587 (jcsh eval sh-append csh
6c5bcbc1 588 "bg" "fg" "jobs" "kill" "notify" "stop" "suspend")
133693bc
KH
589
590 (ksh88 eval sh-append bourne
84bfbb44
KH
591 "alias" "bg" "false" "fc" "fg" "jobs" "kill" "let" "print" "time"
592 "typeset" "unalias" "whence")
133693bc
KH
593
594 (oash eval sh-append sh
595 "checkwin" "dateline" "error" "form" "menu" "newwin" "oadeinit"
596 "oaed" "oahelp" "oainit" "pp" "ppfile" "scan" "scrollok" "wattr"
597 "wclear" "werase" "win" "wmclose" "wmmessage" "wmopen" "wmove"
598 "wmtitle" "wrefresh")
599
600 (pdksh eval sh-append ksh88
601 "bind")
602
603 (posix eval sh-append sh
604 "command")
605
84bfbb44
KH
606 (rc "builtin" "cd" "echo" "eval" "limit" "newpgrp" "shift" "umask" "wait"
607 "whatis")
133693bc
KH
608
609 (sh eval sh-append bourne
610 "hash" "test" "type")
611
612 ;; The next entry is only used for defining the others
84bfbb44
KH
613 (shell "cd" "echo" "eval" "set" "shift" "umask" "unset" "wait")
614
615 (wksh eval sh-append ksh88
616 "Xt[A-Z][A-Za-z]*")
133693bc
KH
617
618 (zsh eval sh-append ksh88
84bfbb44
KH
619 "autoload" "bindkey" "builtin" "chdir" "compctl" "declare" "dirs"
620 "disable" "disown" "echotc" "enable" "functions" "getln" "hash"
621 "history" "integer" "limit" "local" "log" "popd" "pushd" "r"
622 "readonly" "rehash" "sched" "setopt" "source" "suspend" "true"
623 "ttyctl" "type" "unfunction" "unhash" "unlimit" "unsetopt" "vared"
624 "which"))
133693bc
KH
625 "*List of all shell builtins for completing read and fontification.
626Note that on some systems not all builtins are available or some are
cd482e05
RS
627implemented as aliases. See `sh-feature'."
628 :type '(repeat (cons (symbol :tag "Shell")
629 (choice (repeat string)
630 (cons :format "Evaluate: %v"
631 (const :format "" eval)
632 sexp))))
633 :group 'sh-script)
133693bc
KH
634
635
84bfbb44 636
cd482e05 637(defcustom sh-leading-keywords
fa1d74c5
GM
638 '((bash eval sh-append sh
639 "time")
640
641 (csh "else")
84bfbb44
KH
642
643 (es "true" "unwind-protect" "whatis")
644
645 (rc "else")
646
647 (sh "do" "elif" "else" "if" "then" "trap" "type" "until" "while"))
648 "*List of keywords that may be immediately followed by a builtin or keyword.
649Given some confusion between keywords and builtins depending on shell and
650system, the distinction here has been based on whether they influence the
cd482e05
RS
651flow of control or syntax. See `sh-feature'."
652 :type '(repeat (cons (symbol :tag "Shell")
653 (choice (repeat string)
654 (cons :format "Evaluate: %v"
655 (const :format "" eval)
656 sexp))))
657 :group 'sh-script)
84bfbb44
KH
658
659
cd482e05 660(defcustom sh-other-keywords
84bfbb44 661 '((bash eval sh-append bourne
bc387269 662 "bye" "logout" "select")
133693bc
KH
663
664 ;; The next entry is only used for defining the others
d9de8c04
RS
665 (bourne eval sh-append sh
666 "function")
133693bc 667
84bfbb44
KH
668 (csh eval sh-append shell
669 "breaksw" "default" "end" "endif" "endsw" "foreach" "goto"
670 "if" "logout" "onintr" "repeat" "switch" "then" "while")
133693bc 671
84bfbb44
KH
672 (es "break" "catch" "exec" "exit" "fn" "for" "forever" "fork" "if"
673 "return" "throw" "while")
133693bc
KH
674
675 (ksh88 eval sh-append bourne
84bfbb44 676 "select")
133693bc 677
84bfbb44
KH
678 (rc "break" "case" "exec" "exit" "fn" "for" "if" "in" "return" "switch"
679 "while")
133693bc 680
d9de8c04
RS
681 (sh eval sh-append shell
682 "done" "esac" "fi" "for" "in" "return")
683
84bfbb44
KH
684 ;; The next entry is only used for defining the others
685 (shell "break" "case" "continue" "exec" "exit")
133693bc 686
84bfbb44
KH
687 (zsh eval sh-append bash
688 "select"))
689 "*List of keywords not in `sh-leading-keywords'.
cd482e05
RS
690See `sh-feature'."
691 :type '(repeat (cons (symbol :tag "Shell")
692 (choice (repeat string)
693 (cons :format "Evaluate: %v"
694 (const :format "" eval)
695 sexp))))
696 :group 'sh-script)
133693bc
KH
697
698
699
700(defvar sh-variables
701 '((bash eval sh-append sh
fa1d74c5
GM
702 "allow_null_glob_expansion" "auto_resume" "BASH" "BASH_ENV"
703 "BASH_VERSINFO" "BASH_VERSION" "cdable_vars" "COMP_CWORD"
704 "COMP_LINE" "COMP_POINT" "COMP_WORDS" "COMPREPLY" "DIRSTACK"
705 "ENV" "EUID" "FCEDIT" "FIGNORE" "FUNCNAME"
706 "glob_dot_filenames" "GLOBIGNORE" "GROUPS" "histchars"
707 "HISTCMD" "HISTCONTROL" "HISTFILE" "HISTFILESIZE"
708 "HISTIGNORE" "history_control" "HISTSIZE"
709 "hostname_completion_file" "HOSTFILE" "HOSTTYPE" "IGNOREEOF"
710 "ignoreeof" "INPUTRC" "LINENO" "MACHTYPE" "MAIL_WARNING"
711 "noclobber" "nolinks" "notify" "no_exit_on_failed_exec"
712 "NO_PROMPT_VARS" "OLDPWD" "OPTERR" "OSTYPE" "PIPESTATUS"
713 "PPID" "POSIXLY_CORRECT" "PROMPT_COMMAND" "PS3" "PS4"
714 "pushd_silent" "PWD" "RANDOM" "REPLY" "SECONDS" "SHELLOPTS"
715 "SHLVL" "TIMEFORMAT" "TMOUT" "UID")
133693bc
KH
716
717 (csh eval sh-append shell
718 "argv" "cdpath" "child" "echo" "histchars" "history" "home"
719 "ignoreeof" "mail" "noclobber" "noglob" "nonomatch" "path" "prompt"
720 "shell" "status" "time" "verbose")
721
722 (es eval sh-append shell
723 "apid" "cdpath" "CDPATH" "history" "home" "ifs" "noexport" "path"
724 "pid" "prompt" "signals")
725
726 (jcsh eval sh-append csh
6c5bcbc1 727 "notify")
133693bc
KH
728
729 (ksh88 eval sh-append sh
730 "ENV" "ERRNO" "FCEDIT" "FPATH" "HISTFILE" "HISTSIZE" "LINENO"
731 "OLDPWD" "PPID" "PS3" "PS4" "PWD" "RANDOM" "REPLY" "SECONDS"
732 "TMOUT")
733
734 (oash eval sh-append sh
735 "FIELD" "FIELD_MAX" "LAST_KEY" "OALIB" "PP_ITEM" "PP_NUM")
736
737 (rc eval sh-append shell
738 "apid" "apids" "cdpath" "CDPATH" "history" "home" "ifs" "path" "pid"
739 "prompt" "status")
740
741 (sh eval sh-append shell
742 "CDPATH" "IFS" "OPTARG" "OPTIND" "PS1" "PS2")
743
744 ;; The next entry is only used for defining the others
745 (shell "COLUMNS" "EDITOR" "HOME" "HUSHLOGIN" "LANG" "LC_COLLATE"
746 "LC_CTYPE" "LC_MESSAGES" "LC_MONETARY" "LC_NUMERIC" "LC_TIME"
747 "LINES" "LOGNAME" "MAIL" "MAILCHECK" "MAILPATH" "PAGER" "PATH"
748 "SHELL" "TERM" "TERMCAP" "TERMINFO" "VISUAL")
749
750 (tcsh eval sh-append csh
751 "addsuffix" "ampm" "autocorrect" "autoexpand" "autolist"
752 "autologout" "chase_symlinks" "correct" "dextract" "edit" "el"
753 "fignore" "gid" "histlit" "HOST" "HOSTTYPE" "HPATH"
754 "ignore_symlinks" "listjobs" "listlinks" "listmax" "matchbeep"
755 "nobeep" "NOREBIND" "oid" "printexitvalue" "prompt2" "prompt3"
756 "pushdsilent" "pushdtohome" "recexact" "recognize_only_executables"
757 "rmstar" "savehist" "SHLVL" "showdots" "sl" "SYSTYPE" "tcsh" "term"
758 "tperiod" "tty" "uid" "version" "visiblebell" "watch" "who"
759 "wordchars")
760
761 (zsh eval sh-append ksh88
762 "BAUD" "bindcmds" "cdpath" "DIRSTACKSIZE" "fignore" "FIGNORE" "fpath"
763 "HISTCHARS" "hostcmds" "hosts" "HOSTS" "LISTMAX" "LITHISTSIZE"
764 "LOGCHECK" "mailpath" "manpath" "NULLCMD" "optcmds" "path" "POSTEDIT"
765 "prompt" "PROMPT" "PROMPT2" "PROMPT3" "PROMPT4" "psvar" "PSVAR"
766 "READNULLCMD" "REPORTTIME" "RPROMPT" "RPS1" "SAVEHIST" "SPROMPT"
767 "STTY" "TIMEFMT" "TMOUT" "TMPPREFIX" "varcmds" "watch" "WATCH"
768 "WATCHFMT" "WORDCHARS" "ZDOTDIR"))
769 "List of all shell variables available for completing read.
770See `sh-feature'.")
771
aace6150 772\f
3e2dd647 773;; Font-Lock support
aace6150
SM
774
775(defface sh-heredoc-face
776 '((((class color)
777 (background dark))
1fd714a4 778 (:foreground "yellow" :weight bold))
aace6150
SM
779 (((class color)
780 (background light))
781 (:foreground "tan" ))
782 (t
1fd714a4 783 (:weight bold)))
aace6150
SM
784 "Face to show a here-document"
785 :group 'sh-indentation)
786(defvar sh-heredoc-face 'sh-heredoc-face)
133693bc
KH
787
788
789(defvar sh-font-lock-keywords
790 '((csh eval sh-append shell
791 '("\\${?[#?]?\\([A-Za-z_][A-Za-z0-9_]*\\|0\\)" 1
225f6185 792 font-lock-variable-name-face))
133693bc 793
133693bc
KH
794 (es eval sh-append executable-font-lock-keywords
795 '("\\$#?\\([A-Za-z_][A-Za-z0-9_]*\\|[0-9]+\\)" 1
225f6185 796 font-lock-variable-name-face))
133693bc 797
84bfbb44 798 (rc eval identity es)
133693bc
KH
799
800 (sh eval sh-append shell
4d7ce99c 801 ;; Variable names.
133693bc 802 '("\\$\\({#?\\)?\\([A-Za-z_][A-Za-z0-9_]*\\|[-#?@!]\\)" 2
4d7ce99c
RS
803 font-lock-variable-name-face)
804 ;; Function names.
805 '("^\\(\\sw+\\)[ \t]*(" 1 font-lock-function-name-face)
806 '("\\<\\(function\\)\\>[ \t]*\\(\\sw+\\)?"
807 (1 font-lock-keyword-face) (2 font-lock-function-name-face nil t)))
133693bc
KH
808
809 ;; The next entry is only used for defining the others
810 (shell eval sh-append executable-font-lock-keywords
b48a16d2 811 '("\\\\[^A-Za-z0-9]" 0 font-lock-string-face)
133693bc 812 '("\\${?\\([A-Za-z_][A-Za-z0-9_]*\\|[0-9]+\\|[$*_]\\)" 1
547745f5
RS
813 font-lock-variable-name-face))
814 (rpm eval sh-append rpm2
815 '("%{?\\(\\sw+\\)" 1 font-lock-keyword-face))
816 (rpm2 eval sh-append shell
817 '("^\\(\\sw+\\):" 1 font-lock-variable-name-face)))
38c979d3 818 "Default expressions to highlight in Shell Script modes. See `sh-feature'.")
133693bc 819
84bfbb44 820(defvar sh-font-lock-keywords-1
bfc8e97b 821 '((sh "[ \t]in\\>"))
38c979d3 822 "Subdued level highlighting for Shell Script modes.")
84bfbb44
KH
823
824(defvar sh-font-lock-keywords-2 ()
38c979d3 825 "Gaudy level highlighting for Shell Script modes.")
84bfbb44 826
34939e2c
SM
827;; These are used for the syntax table stuff (derived from cperl-mode).
828;; Note: parse-sexp-lookup-properties must be set to t for it to work.
829(defconst sh-st-punc (string-to-syntax "."))
bffd712e 830(defconst sh-st-symbol (string-to-syntax "_"))
34939e2c
SM
831(defconst sh-here-doc-syntax (string-to-syntax "|")) ;; generic string
832
3e2dd647
SM
833(defconst sh-here-doc-open-re "<<-?\\s-*\\\\?\\(\\(?:['\"][^'\"]+['\"]\\|\\sw\\|\\s_\\)+\\).*\\(\n\\)")
834
835(defvar sh-here-doc-markers nil)
836(make-variable-buffer-local 'sh-here-doc-markers)
837(defvar sh-here-doc-re sh-here-doc-open-re)
838(make-variable-buffer-local 'sh-here-doc-re)
839
840(defun sh-font-lock-close-heredoc (bol eof indented)
841 "Determine the syntax of the \\n after an EOF.
842If non-nil INDENTED indicates that the EOF was indented."
187cd25b 843 (let* ((eof-re (if eof (regexp-quote eof) ""))
035107fa 844 ;; A rough regexp that should find the opening <<EOF back.
3e2dd647
SM
845 (sre (concat "<<\\(-?\\)\\s-*['\"\\]?"
846 ;; Use \s| to cheaply check it's an open-heredoc.
035107fa 847 eof-re "['\"]?\\([ \t|;&)<>].*\\)?\\s|"))
3e2dd647 848 ;; A regexp that will find other EOFs.
035107fa 849 (ere (concat "^" (if indented "[ \t]*") eof-re "\n"))
3e2dd647
SM
850 (start (save-excursion
851 (goto-char bol)
852 (re-search-backward (concat sre "\\|" ere) nil t))))
853 ;; If subgroup 1 matched, we found an open-heredoc, otherwise we first
854 ;; found a close-heredoc which makes the current close-heredoc inoperant.
855 (cond
856 ((when (and start (match-end 1)
857 (not (and indented (= (match-beginning 1) (match-end 1))))
858 (not (sh-in-comment-or-string (match-beginning 0))))
859 ;; Make sure our `<<' is not the EOF1 of a `cat <<EOF1 <<EOF2'.
860 (save-excursion
861 (goto-char start)
862 (setq start (line-beginning-position 2))
863 (while
864 (progn
865 (re-search-forward "<<") ; Skip ourselves.
866 (and (re-search-forward sh-here-doc-open-re start 'move)
867 (goto-char (match-beginning 0))
868 (sh-in-comment-or-string (point)))))
869 ;; No <<EOF2 found after our <<.
870 (= (point) start)))
871 sh-here-doc-syntax)
872 ((not (or start (save-excursion (re-search-forward sre nil t))))
873 ;; There's no <<EOF either before or after us,
874 ;; so we should remove ourselves from font-lock's keywords.
875 (setq sh-here-doc-markers (delete eof sh-here-doc-markers))
876 (setq sh-here-doc-re
877 (concat sh-here-doc-open-re "\\|^\\([ \t]*\\)"
878 (regexp-opt sh-here-doc-markers t) "\\(\n\\)"))
879 nil))))
880
881(defun sh-font-lock-open-heredoc (start string)
882 "Determine the syntax of the \\n after a <<EOF.
883START is the position of <<.
884STRING is the actual word used as delimiter (f.ex. \"EOF\").
885INDENTED is non-nil if the here document's content (and the EOF mark) can
886be indented (i.e. a <<- was used rather than just <<)."
887 (unless (or (memq (char-before start) '(?< ?>))
888 (sh-in-comment-or-string start))
34939e2c
SM
889 ;; We're looking at <<STRING, so we add "^STRING$" to the syntactic
890 ;; font-lock keywords to detect the end of this here document.
3e2dd647
SM
891 (let ((str (replace-regexp-in-string "['\"]" "" string)))
892 (unless (member str sh-here-doc-markers)
893 (push str sh-here-doc-markers)
894 (setq sh-here-doc-re
895 (concat sh-here-doc-open-re "\\|^\\([ \t]*\\)"
896 (regexp-opt sh-here-doc-markers t) "\\(\n\\)"))))
34939e2c
SM
897 sh-here-doc-syntax))
898
3e2dd647
SM
899(defun sh-font-lock-here-doc (limit)
900 "Search for a heredoc marker."
901 ;; This looks silly, but it's because `sh-here-doc-re' keeps changing.
902 (re-search-forward sh-here-doc-re limit t))
903
485219e0
SM
904(defun sh-is-quoted-p (pos)
905 (and (eq (char-before pos) ?\\)
906 (not (sh-is-quoted-p (1- pos)))))
907
34939e2c
SM
908(defun sh-font-lock-paren (start)
909 (save-excursion
910 (goto-char start)
911 ;; Skip through all patterns
912 (while
913 (progn
914 (forward-comment (- (point-max)))
915 ;; Skip through one pattern
916 (while
917 (or (/= 0 (skip-syntax-backward "w_"))
d96da6c4 918 (/= 0 (skip-chars-backward "?[]*/\\"))
485219e0
SM
919 (and (sh-is-quoted-p (1- (point)))
920 (goto-char (- (point) 2)))
34939e2c
SM
921 (when (memq (char-before) '(?\" ?\'))
922 (condition-case nil (progn (backward-sexp 1) t)
923 (error nil)))))
924 (forward-comment (- (point-max)))
925 (when (eq (char-before) ?|)
926 (backward-char 1) t)))
927 (when (save-excursion (backward-char 2) (looking-at ";;\\|in"))
928 sh-st-punc)))
929
38c979d3 930(defconst sh-font-lock-syntactic-keywords
bffd712e
SM
931 ;; A `#' begins a comment when it is unquoted and at the beginning of a
932 ;; word. In the shell, words are separated by metacharacters.
933 ;; The list of special chars is taken from the single-unix spec
934 ;; of the shell command language (under `quoting') but with `$' removed.
935 `(("[^|&;<>()`\\\"' \t\n]\\(#+\\)" 1 ,sh-st-symbol)
34939e2c 936 ;; Find HEREDOC starters and add a corresponding rule for the ender.
3e2dd647
SM
937 (sh-font-lock-here-doc
938 (2 (sh-font-lock-open-heredoc
939 (match-beginning 0) (match-string 1)) nil t)
940 (5 (sh-font-lock-close-heredoc
941 (match-beginning 0) (match-string 4)
187cd25b
SS
942 (and (match-beginning 3) (/= (match-beginning 3) (match-end 3))))
943 nil t))
34939e2c
SM
944 ;; Distinguish the special close-paren in `case'.
945 (")" 0 (sh-font-lock-paren (match-beginning 0)))))
f964dfcb 946
aace6150
SM
947(defun sh-font-lock-syntactic-face-function (state)
948 (if (nth 3 state)
949 (if (char-valid-p (nth 3 state))
950 font-lock-string-face
951 sh-heredoc-face)
952 font-lock-comment-face))
953
f964dfcb
GM
954(defgroup sh-indentation nil
955 "Variables controlling indentation in shell scripts.
956
957Note: customizing these variables will not affect existing buffers if
958`sh-make-vars-local' is no-nil. See the documentation for
959variable `sh-make-vars-local', command `sh-make-vars-local'
960and command `sh-reset-indent-vars-to-global-values'."
961 :group 'sh-script)
962
963
964(defcustom sh-set-shell-hook nil
965 "*Hook run by `sh-set-shell'."
6c5bcbc1 966 :type 'hook
f964dfcb
GM
967 :group 'sh-script)
968
969(defcustom sh-mode-hook nil
970 "*Hook run by `sh-mode'."
6c5bcbc1 971 :type 'hook
f964dfcb
GM
972 :group 'sh-script)
973
974(defcustom sh-learn-basic-offset nil
975 "*When `sh-guess-basic-offset' should learn `sh-basic-offset'.
976
977nil mean: never.
978t means: only if there seems to be an obvious value.
979Anything else means: whenever we have a \"good guess\" as to the value."
980 :type '(choice
981 (const :tag "Never" nil)
982 (const :tag "Only if sure" t)
8db2b9fb 983 (const :tag "If have a good guess" usually))
f964dfcb
GM
984 :group 'sh-indentation)
985
986(defcustom sh-popup-occur-buffer nil
8db2b9fb
SM
987 "*Controls when `sh-learn-buffer-indent' pops the *indent* buffer.
988If t it is always shown. If nil, it is shown only when there
f964dfcb
GM
989are conflicts."
990 :type '(choice
991 (const :tag "Only when there are conflicts." nil)
8db2b9fb 992 (const :tag "Always" t))
f964dfcb
GM
993 :group 'sh-indentation)
994
995(defcustom sh-blink t
8db2b9fb 996 "*If non-nil, `sh-show-indent' shows the line indentation is relative to.
f964dfcb
GM
997The position on the line is not necessarily meaningful.
998In some cases the line will be the matching keyword, but this is not
999always the case."
1000 :type 'boolean
1001 :group 'sh-indentation)
1002
1003(defcustom sh-first-lines-indent 0
1004 "*The indentation of the first non-blank non-comment line.
1005Usually 0 meaning first column.
8db2b9fb 1006Can be set to a number, or to nil which means leave it as is."
f964dfcb
GM
1007 :type '(choice
1008 (const :tag "Leave as is" nil)
1009 (integer :tag "Column number"
8db2b9fb 1010 :menu-tag "Indent to this col (0 means first col)" ))
f964dfcb
GM
1011 :group 'sh-indentation)
1012
1013
1014(defcustom sh-basic-offset 4
8db2b9fb 1015 "*The default indentation increment.
f964dfcb
GM
1016This value is used for the + and - symbols in an indentation variable."
1017 :type 'integer
1018 :group 'sh-indentation)
1019
1020(defcustom sh-indent-comment nil
1021 "*How a comment line is to be indented.
1022nil means leave it as it is;
8db2b9fb 1023t means indent it as a normal line, aligning it to previous non-blank
f964dfcb 1024 non-comment line;
8db2b9fb 1025a number means align to that column, e.g. 0 means fist column."
f964dfcb
GM
1026 :type '(choice
1027 (const :tag "Leave as is." nil)
1028 (const :tag "Indent as a normal line." t)
1029 (integer :menu-tag "Indent to this col (0 means first col)."
6c5bcbc1 1030 :tag "Indent to column number.") )
f964dfcb
GM
1031 :group 'sh-indentation)
1032
1033
1034(defvar sh-debug nil
1035 "Enable lots of debug messages - if function `sh-debug' is enabled.")
1036
1037
1038;; Uncomment this defun and comment the defmacro for debugging.
1039;; (defun sh-debug (&rest args)
1040;; "For debugging: display message ARGS if variable SH-DEBUG is non-nil."
1041;; (if sh-debug
1042;; (apply 'message args)))
1043(defmacro sh-debug (&rest args))
1044
d92474ed
SM
1045(defconst sh-symbol-list
1046 '((const :tag "+ " :value +
1047 :menu-tag "+ Indent right by sh-basic-offset")
1048 (const :tag "- " :value -
1049 :menu-tag "- Indent left by sh-basic-offset")
1050 (const :tag "++" :value ++
1051 :menu-tag "++ Indent right twice sh-basic-offset")
1052 (const :tag "--" :value --
1053 :menu-tag "-- Indent left twice sh-basic-offset")
1054 (const :tag "* " :value *
1055 :menu-tag "* Indent right half sh-basic-offset")
1056 (const :tag "/ " :value /
1057 :menu-tag "/ Indent left half sh-basic-offset")))
f964dfcb
GM
1058
1059(defcustom sh-indent-for-else 0
1060 "*How much to indent an else relative to an if. Usually 0."
1061 :type `(choice
1062 (integer :menu-tag "A number (positive=>indent right)"
1063 :tag "A number")
1064 (const :tag "--") ;; separator!
1065 ,@ sh-symbol-list
1066 )
1067 :group 'sh-indentation)
1068
d92474ed 1069(defconst sh-number-or-symbol-list
6c5bcbc1
SM
1070 (append '((integer :menu-tag "A number (positive=>indent right)"
1071 :tag "A number")
1072 (const :tag "--")) ; separator
d92474ed 1073 sh-symbol-list))
f964dfcb
GM
1074
1075(defcustom sh-indent-for-fi 0
4a9592f6 1076 "*How much to indent a fi relative to an if. Usually 0."
f964dfcb
GM
1077 :type `(choice ,@ sh-number-or-symbol-list )
1078 :group 'sh-indentation)
1079
1080(defcustom sh-indent-for-done '0
4a9592f6 1081 "*How much to indent a done relative to its matching stmt. Usually 0."
f964dfcb
GM
1082 :type `(choice ,@ sh-number-or-symbol-list )
1083 :group 'sh-indentation)
1084
1085(defcustom sh-indent-after-else '+
1086 "*How much to indent a statement after an else statement."
1087 :type `(choice ,@ sh-number-or-symbol-list )
1088 :group 'sh-indentation)
1089
1090(defcustom sh-indent-after-if '+
1091 "*How much to indent a statement after an if statement.
1092This includes lines after else and elif statements, too, but
1093does not affect then else elif or fi statements themselves."
1094 :type `(choice ,@ sh-number-or-symbol-list )
1095 :group 'sh-indentation)
1096
1097(defcustom sh-indent-for-then '+
b554bbff 1098 "*How much to indent a then relative to an if."
f964dfcb
GM
1099 :type `(choice ,@ sh-number-or-symbol-list )
1100 :group 'sh-indentation)
1101
1102(defcustom sh-indent-for-do '*
1103 "*How much to indent a do statement.
8db2b9fb 1104This is relative to the statement before the do, i.e. the
f964dfcb
GM
1105while until or for statement."
1106 :type `(choice ,@ sh-number-or-symbol-list)
1107 :group 'sh-indentation)
1108
1109(defcustom sh-indent-after-do '*
6c5bcbc1 1110 "*How much to indent a line after a do statement.
f964dfcb 1111This is used when the do is the first word of the line.
8db2b9fb 1112This is relative to the statement before the do, e.g. a
f964dfcb
GM
1113while for repeat or select statement."
1114 :type `(choice ,@ sh-number-or-symbol-list)
1115 :group 'sh-indentation)
1116
1117(defcustom sh-indent-after-loop-construct '+
1118 "*How much to indent a statement after a loop construct.
1119
1120This variable is used when the keyword \"do\" is on the same line as the
1121loop statement (e.g. \"until\", \"while\" or \"for\").
1122If the do is on a line by itself, then `sh-indent-after-do' is used instead."
1123 :type `(choice ,@ sh-number-or-symbol-list)
1124 :group 'sh-indentation)
1125
1126
1127(defcustom sh-indent-after-done 0
1128 "*How much to indent a statement after a \"done\" keyword.
1129Normally this is 0, which aligns the \"done\" to the matching
1130looping construct line.
1131Setting it non-zero allows you to have the \"do\" statement on a line
1132by itself and align the done under to do."
1133 :type `(choice ,@ sh-number-or-symbol-list)
1134 :group 'sh-indentation)
1135
1136(defcustom sh-indent-for-case-label '+
1137 "*How much to indent a case label statement.
1138This is relative to the line containing the case statement."
1139 :type `(choice ,@ sh-number-or-symbol-list)
1140 :group 'sh-indentation)
1141
1142(defcustom sh-indent-for-case-alt '++
1143 "*How much to indent statements after the case label.
1144This is relative to the line containing the case statement."
1145 :type `(choice ,@ sh-number-or-symbol-list)
1146 :group 'sh-indentation)
1147
1148
1149(defcustom sh-indent-for-continuation '+
1150 "*How much to indent for a continuation statement."
1151 :type `(choice ,@ sh-number-or-symbol-list)
1152 :group 'sh-indentation)
1153
1154(defcustom sh-indent-after-open '+
1155 "*How much to indent after a line with an opening parenthesis or brace.
1156For an open paren after a function `sh-indent-after-function' is used."
1157 :type `(choice ,@ sh-number-or-symbol-list)
1158 :group 'sh-indentation)
1159
1160(defcustom sh-indent-after-function '+
1161 "*How much to indent after a function line."
1162 :type `(choice ,@ sh-number-or-symbol-list)
1163 :group 'sh-indentation)
1164
1165;; These 2 are for the rc shell:
1166
1167(defcustom sh-indent-after-switch '+
1168 "*How much to indent a case statement relative to the switch statement.
1169This is for the rc shell."
1170 :type `(choice ,@ sh-number-or-symbol-list)
1171 :group 'sh-indentation)
1172
1173(defcustom sh-indent-after-case '+
1174 "*How much to indent a statement relative to the case statement.
1175This is for the rc shell."
1176 :type `(choice ,@ sh-number-or-symbol-list)
1177 :group 'sh-indentation)
1178
f964dfcb
GM
1179;; Internal use - not designed to be changed by the user:
1180
f964dfcb
GM
1181(defun sh-mkword-regexpr (word)
1182 "Make a regexp which matches WORD as a word.
8db2b9fb 1183This specifically excludes an occurrence of WORD followed by
f964dfcb
GM
1184punctuation characters like '-'."
1185 (concat word "\\([^-a-z0-9_]\\|$\\)"))
1186
d92474ed 1187(defconst sh-re-done (sh-mkword-regexpr "done"))
f964dfcb
GM
1188
1189
1190(defconst sh-kws-for-done
d92474ed 1191 '((sh . ( "while" "until" "for" ) )
f964dfcb
GM
1192 (bash . ( "while" "until" "for" "select" ) )
1193 (ksh88 . ( "while" "until" "for" "select" ) )
d92474ed
SM
1194 (zsh . ( "while" "until" "for" "repeat" "select" ) ) )
1195 "Which keywords can match the word `done' in this shell.")
f964dfcb
GM
1196
1197
1198(defconst sh-indent-supported
d92474ed 1199 '((sh . t)
f964dfcb 1200 (csh . nil)
d92474ed
SM
1201 (rc . t))
1202 "Shell types that shell indenting can do something with.")
1203
1204(defvar sh-indent-supported-here nil
1205 "Non-nil if we support indentation for the current buffer's shell type.")
f964dfcb 1206
f964dfcb
GM
1207(defconst sh-var-list
1208 '(
1209 sh-basic-offset sh-first-lines-indent sh-indent-after-case
1210 sh-indent-after-do sh-indent-after-done
1211 sh-indent-after-else
1212 sh-indent-after-if
1213 sh-indent-after-loop-construct
1214 sh-indent-after-open
1215 sh-indent-comment
1216 sh-indent-for-case-alt
1217 sh-indent-for-case-label
1218 sh-indent-for-continuation
1219 sh-indent-for-do
1220 sh-indent-for-done
1221 sh-indent-for-else
1222 sh-indent-for-fi
1223 sh-indent-for-then
1224 )
1225 "A list of variables used by script mode to control indentation.
1226This list is used when switching between buffer-local and global
8db2b9fb 1227values of variables, and for the commands using indentation styles.")
f964dfcb
GM
1228
1229(defvar sh-make-vars-local t
1230 "*Controls whether indentation variables are local to the buffer.
8db2b9fb
SM
1231If non-nil, indentation variables are made local initially.
1232If nil, you can later make the variables local by invoking
f964dfcb
GM
1233command `sh-make-vars-local'.
1234The default is t because I assume that in one Emacs session one is
1235frequently editing existing scripts with different styles.")
1236
133693bc
KH
1237\f
1238;; mode-command and utility functions
1239
fc8318f6 1240;;;###autoload
a7dba40b 1241(defun sh-mode ()
ac59aed8
RS
1242 "Major mode for editing shell scripts.
1243This mode works for many shells, since they all have roughly the same syntax,
1244as far as commands, arguments, variables, pipes, comments etc. are concerned.
1245Unless the file's magic number indicates the shell, your usual shell is
1246assumed. Since filenames rarely give a clue, they are not further analyzed.
1247
133693bc
KH
1248This mode adapts to the variations between shells (see `sh-set-shell') by
1249means of an inheritance based feature lookup (see `sh-feature'). This
1250mechanism applies to all variables (including skeletons) that pertain to
1251shell-specific features.
ac59aed8 1252
133693bc
KH
1253The default style of this mode is that of Rosenblatt's Korn shell book.
1254The syntax of the statements varies with the shell being used. The
1255following commands are available, based on the current shell's syntax:
ac59aed8
RS
1256
1257\\[sh-case] case statement
1258\\[sh-for] for loop
1259\\[sh-function] function definition
1260\\[sh-if] if statement
1261\\[sh-indexed-loop] indexed loop from 1 to n
133693bc
KH
1262\\[sh-while-getopts] while getopts loop
1263\\[sh-repeat] repeat loop
1264\\[sh-select] select loop
ac59aed8
RS
1265\\[sh-until] until loop
1266\\[sh-while] while loop
1267
f964dfcb
GM
1268For sh and rc shells indentation commands are:
1269\\[sh-show-indent] Show the variable controlling this line's indentation.
1270\\[sh-set-indent] Set then variable controlling this line's indentation.
1271\\[sh-learn-line-indent] Change the indentation variable so this line
1272would indent to the way it currently is.
1273\\[sh-learn-buffer-indent] Set the indentation variables so the
8db2b9fb 1274buffer indents as it currently is indented.
f964dfcb
GM
1275
1276
ac59aed8
RS
1277\\[backward-delete-char-untabify] Delete backward one position, even if it was a tab.
1278\\[sh-newline-and-indent] Delete unquoted space and indent new line same as this one.
1279\\[sh-end-of-command] Go to end of successive commands.
1280\\[sh-beginning-of-command] Go to beginning of successive commands.
1281\\[sh-set-shell] Set this buffer's shell, and maybe its magic number.
133693bc 1282\\[sh-execute-region] Have optional header and region be executed in a subshell.
ac59aed8 1283
ac59aed8 1284\\[sh-maybe-here-document] Without prefix, following an unquoted < inserts here document.
b52b132f 1285\{, (, [, ', \", `
133693bc
KH
1286 Unless quoted with \\, insert the pairs {}, (), [], or '', \"\", ``.
1287
1288If you generally program a shell different from your login shell you can
aafd074a 1289set `sh-shell-file' accordingly. If your shell's file name doesn't correctly
133693bc
KH
1290indicate what shell it is use `sh-alias-alist' to translate.
1291
1292If your shell gives error messages with line numbers, you can use \\[executable-interpret]
1293with your script for an edit-interpret-debug cycle."
a7dba40b
RS
1294 (interactive)
1295 (kill-all-local-variables)
1296 (setq major-mode 'sh-mode
1297 mode-name "Shell-script")
1298 (use-local-map sh-mode-map)
84bfbb44 1299 (make-local-variable 'skeleton-end-hook)
133693bc
KH
1300 (make-local-variable 'paragraph-start)
1301 (make-local-variable 'paragraph-separate)
ac59aed8
RS
1302 (make-local-variable 'comment-start)
1303 (make-local-variable 'comment-start-skip)
ac59aed8 1304 (make-local-variable 'require-final-newline)
133693bc 1305 (make-local-variable 'sh-header-marker)
aafd074a 1306 (make-local-variable 'sh-shell-file)
ac59aed8 1307 (make-local-variable 'sh-shell)
81ed2d75
KH
1308 (make-local-variable 'skeleton-pair-alist)
1309 (make-local-variable 'skeleton-pair-filter)
133693bc
KH
1310 (make-local-variable 'comint-dynamic-complete-functions)
1311 (make-local-variable 'comint-prompt-regexp)
84bfbb44 1312 (make-local-variable 'font-lock-defaults)
133693bc 1313 (make-local-variable 'skeleton-filter)
cd76025c 1314 (make-local-variable 'skeleton-newline-indent-rigidly)
5d73ac66
RS
1315 (make-local-variable 'sh-shell-variables)
1316 (make-local-variable 'sh-shell-variables-initialized)
aa2c2426 1317 (make-local-variable 'imenu-generic-expression)
f964dfcb 1318 (make-local-variable 'sh-indent-supported-here)
aace6150 1319 (setq skeleton-end-hook (lambda ()
84bfbb44 1320 (or (eolp) (newline) (indent-relative)))
bfc8e97b 1321 paragraph-start (concat page-delimiter "\\|$")
133693bc 1322 paragraph-separate paragraph-start
ac59aed8 1323 comment-start "# "
133693bc
KH
1324 comint-dynamic-complete-functions sh-dynamic-complete-functions
1325 ;; we can't look if previous line ended with `\'
1326 comint-prompt-regexp "^[ \t]*"
84bfbb44 1327 font-lock-defaults
34939e2c 1328 `((sh-font-lock-keywords
38c979d3
SM
1329 sh-font-lock-keywords-1 sh-font-lock-keywords-2)
1330 nil nil
1331 ((?/ . "w") (?~ . "w") (?. . "w") (?- . "w") (?_ . "w")) nil
3e2dd647 1332 (font-lock-syntactic-keywords . sh-font-lock-syntactic-keywords)
aace6150
SM
1333 (font-lock-syntactic-face-function
1334 . sh-font-lock-syntactic-face-function))
81ed2d75
KH
1335 skeleton-pair-alist '((?` _ ?`))
1336 skeleton-pair-filter 'sh-quoted-p
133693bc
KH
1337 skeleton-further-elements '((< '(- (min sh-indentation
1338 (current-column)))))
cd76025c 1339 skeleton-filter 'sh-feature
f964dfcb 1340 skeleton-newline-indent-rigidly t
f964dfcb 1341 sh-indent-supported-here nil)
6c5bcbc1 1342 (set (make-local-variable 'parse-sexp-ignore-comments) t)
e3dce9ba
RS
1343 ;; Parse or insert magic number for exec, and set all variables depending
1344 ;; on the shell thus determined.
1345 (let ((interpreter
1346 (save-excursion
1347 (goto-char (point-min))
547745f5 1348 (cond ((looking-at "#![ \t]?\\([^ \t\n]*/bin/env[ \t]\\)?\\([^ \t\n]+\\)")
1448f589
KH
1349 (match-string 2))
1350 ((and buffer-file-name
1351 (string-match "\\.m?spec$" buffer-file-name))
547745f5 1352 "rpm")))))
1c532f0d
RS
1353 (sh-set-shell (or interpreter sh-shell-file) nil nil))
1354 (run-hooks 'sh-mode-hook))
aace6150 1355
133693bc 1356;;;###autoload
ac59aed8
RS
1357(defalias 'shell-script-mode 'sh-mode)
1358
1359
84bfbb44
KH
1360(defun sh-font-lock-keywords (&optional keywords)
1361 "Function to get simple fontification based on `sh-font-lock-keywords'.
1362This adds rules for comments and assignments."
1363 (sh-feature sh-font-lock-keywords
b946fbad
RS
1364 (when (stringp (sh-feature sh-assignment-regexp))
1365 (lambda (list)
1366 `((,(sh-feature sh-assignment-regexp)
1367 1 font-lock-variable-name-face)
1368 ,@keywords
1369 ,@list)))))
84bfbb44
KH
1370
1371(defun sh-font-lock-keywords-1 (&optional builtins)
1372 "Function to get better fontification including keywords."
3e2dd647
SM
1373 (let ((keywords (concat "\\([;(){}`|&]\\|^\\)[ \t]*\\(\\("
1374 (regexp-opt (sh-feature sh-leading-keywords) t)
1375 "[ \t]+\\)?"
1376 (regexp-opt (append (sh-feature sh-leading-keywords)
1377 (sh-feature sh-other-keywords))
1378 t))))
84bfbb44
KH
1379 (sh-font-lock-keywords
1380 `(,@(if builtins
3e2dd647
SM
1381 `((,(concat keywords "[ \t]+\\)?"
1382 (regexp-opt (sh-feature sh-builtins) t)
1383 "\\>")
84bfbb44 1384 (2 font-lock-keyword-face nil t)
f802bd02 1385 (6 font-lock-builtin-face))
84bfbb44
KH
1386 ,@(sh-feature sh-font-lock-keywords-2)))
1387 (,(concat keywords "\\)\\>")
1388 2 font-lock-keyword-face)
1389 ,@(sh-feature sh-font-lock-keywords-1)))))
1390
1391(defun sh-font-lock-keywords-2 ()
1392 "Function to get better fontification including keywords and builtins."
1393 (sh-font-lock-keywords-1 t))
1394
ac59aed8 1395
d92474ed
SM
1396(defvar sh-regexp-for-done nil
1397 "A buffer-local regexp to match opening keyword for done.")
1398
1399(defvar sh-kw-alist nil
1400 "A buffer-local, since it is shell-type dependent, list of keywords.")
1401
1402;; ( key-word first-on-this on-prev-line )
1403;; This is used to set `sh-kw-alist' which is a list of sublists each
1404;; having 3 elements:
1405;; a keyword
8db2b9fb
SM
1406;; a rule to check when the keyword appears on "this" line
1407;; a rule to check when the keyword appears on "the previous" line
d92474ed 1408;; The keyword is usually a string and is the first word on a line.
8db2b9fb
SM
1409;; If this keyword appears on the line whose indentation is to be
1410;; calculated, the rule in element 2 is called. If this returns
1411;; non-zero, the resulting point (which may be changed by the rule)
d92474ed
SM
1412;; is used as the default indentation.
1413;; If it returned false or the keyword was not found in the table,
1414;; then the keyword from the previous line is looked up and the rule
1415;; in element 3 is called. In this case, however,
8db2b9fb 1416;; `sh-get-indent-info' does not stop but may keep going and test
d92474ed 1417;; other keywords against rules in element 3. This is because the
8db2b9fb 1418;; preceding line could have, for example, an opening "if" and an
d92474ed
SM
1419;; opening "while" keyword and we need to add the indentation offsets
1420;; for both.
1421;;
1422(defconst sh-kw
6c5bcbc1
SM
1423 '((sh
1424 ("if" nil sh-handle-prev-if)
1425 ("elif" sh-handle-this-else sh-handle-prev-else)
1426 ("else" sh-handle-this-else sh-handle-prev-else)
1427 ("fi" sh-handle-this-fi sh-handle-prev-fi)
1428 ("then" sh-handle-this-then sh-handle-prev-then)
1429 ("(" nil sh-handle-prev-open)
1430 ("{" nil sh-handle-prev-open)
1431 ("[" nil sh-handle-prev-open)
1432 ("}" sh-handle-this-close nil)
1433 (")" sh-handle-this-close nil)
1434 ("]" sh-handle-this-close nil)
1435 ("case" nil sh-handle-prev-case)
1436 ("esac" sh-handle-this-esac sh-handle-prev-esac)
1437 (case-label nil sh-handle-after-case-label) ;; ???
1438 (";;" nil sh-handle-prev-case-alt-end) ;; ???
1439 ("done" sh-handle-this-done sh-handle-prev-done)
1440 ("do" sh-handle-this-do sh-handle-prev-do))
d92474ed
SM
1441
1442 ;; Note: we don't need specific stuff for bash and zsh shells;
1443 ;; the regexp `sh-regexp-for-done' handles the extra keywords
1444 ;; these shells use.
1445 (rc
6c5bcbc1
SM
1446 ("{" nil sh-handle-prev-open)
1447 ("}" sh-handle-this-close nil)
1448 ("case" sh-handle-this-rc-case sh-handle-prev-rc-case))))
d92474ed
SM
1449
1450
616db04b 1451(defun sh-set-shell (shell &optional no-query-flag insert-flag)
133693bc 1452 "Set this buffer's shell to SHELL (a string).
57270c90
RS
1453When used interactively, insert the proper starting #!-line,
1454and make the visited file executable via `executable-set-magic',
1455perhaps querying depending on the value of `executable-query'.
1456
1457When this function is called noninteractively, INSERT-FLAG (the third
1458argument) controls whether to insert a #!-line and think about making
1459the visited file executable, and NO-QUERY-FLAG (the second argument)
1460controls whether to query about making the visited file executable.
1461
133693bc 1462Calls the value of `sh-set-shell-hook' if set."
54aaebc5
JB
1463 (interactive (list (completing-read (format "Shell \(default %s\): "
1464 sh-shell-file)
1465 interpreter-mode-alist
1466 (lambda (x) (eq (cdr x) 'sh-mode))
1467 nil nil nil sh-shell-file)
616db04b
RS
1468 (eq executable-query 'function)
1469 t))
842cc0e6 1470 (if (string-match "\\.exe\\'" shell)
c8b88e9f 1471 (setq shell (substring shell 0 (match-beginning 0))))
133693bc
KH
1472 (setq sh-shell (intern (file-name-nondirectory shell))
1473 sh-shell (or (cdr (assq sh-shell sh-alias-alist))
616db04b 1474 sh-shell))
e3dce9ba
RS
1475 (if insert-flag
1476 (setq sh-shell-file
1477 (executable-set-magic shell (sh-feature sh-shell-arg)
1478 no-query-flag insert-flag)))
616db04b 1479 (setq require-final-newline (sh-feature sh-require-final-newline)
aafd074a 1480;;; local-abbrev-table (sh-feature sh-abbrevs)
c8005e70 1481 comment-start-skip "#+[\t ]*"
133693bc 1482 mode-line-process (format "[%s]" sh-shell)
5a989d6e 1483 sh-shell-variables nil
5d73ac66 1484 sh-shell-variables-initialized nil
aa2c2426 1485 imenu-generic-expression (sh-feature sh-imenu-generic-expression)
c8b88e9f 1486 imenu-case-fold-search nil)
b1e851bb
RS
1487 (set-syntax-table (or (sh-feature sh-mode-syntax-table)
1488 (standard-syntax-table)))
6c5bcbc1
SM
1489 (dolist (var (sh-feature sh-variables))
1490 (sh-remember-variable var))
1491 (make-local-variable 'indent-line-function)
f964dfcb
GM
1492 (if (setq sh-indent-supported-here (sh-feature sh-indent-supported))
1493 (progn
1494 (message "Setting up indent for shell type %s" sh-shell)
6c5bcbc1 1495 (set (make-local-variable 'parse-sexp-lookup-properties) t)
6c5bcbc1 1496 (set (make-local-variable 'sh-kw-alist) (sh-feature sh-kw))
f964dfcb
GM
1497 (let ((regexp (sh-feature sh-kws-for-done)))
1498 (if regexp
6c5bcbc1
SM
1499 (set (make-local-variable 'sh-regexp-for-done)
1500 (sh-mkword-regexpr (regexp-opt regexp t)))))
f964dfcb
GM
1501 (message "setting up indent stuff")
1502 ;; sh-mode has already made indent-line-function local
1503 ;; but do it in case this is called before that.
f964dfcb 1504 (setq indent-line-function 'sh-indent-line)
f964dfcb
GM
1505 (if sh-make-vars-local
1506 (sh-make-vars-local))
1507 (message "Indentation setup for shell type %s" sh-shell))
1508 (message "No indentation for this shell type.")
1509 (setq indent-line-function 'sh-basic-indent-line))
133693bc
KH
1510 (run-hooks 'sh-set-shell-hook))
1511
1512
ac59aed8 1513
133693bc
KH
1514(defun sh-feature (list &optional function)
1515 "Index ALIST by the current shell.
1516If ALIST isn't a list where every element is a cons, it is returned as is.
1517Else indexing follows an inheritance logic which works in two ways:
1518
1519 - Fall back on successive ancestors (see `sh-ancestor-alist') as long as
1520 the alist contains no value for the current shell.
1c64011b 1521 The ultimate default is always `sh'.
133693bc
KH
1522
1523 - If the value thus looked up is a list starting with `eval' its `cdr' is
1524 first evaluated. If that is also a list and the first argument is a
1525 symbol in ALIST it is not evaluated, but rather recursively looked up in
1526 ALIST to allow the function called to define the value for one shell to be
1527 derived from another shell. While calling the function, is the car of the
1528 alist element is the current shell.
1529 The value thus determined is physically replaced into the alist.
1530
1531Optional FUNCTION is applied to the determined value and the result is cached
1532in ALIST."
1533 (or (if (consp list)
1534 (let ((l list))
1535 (while (and l (consp (car l)))
1536 (setq l (cdr l)))
1537 (if l list)))
1538 (if function
1539 (cdr (assoc (setq function (cons sh-shell function)) list)))
1540 (let ((sh-shell sh-shell)
1541 elt val)
1542 (while (and sh-shell
1543 (not (setq elt (assq sh-shell list))))
1544 (setq sh-shell (cdr (assq sh-shell sh-ancestor-alist))))
1c64011b
RS
1545 ;; If the shell is not known, treat it as sh.
1546 (unless elt
1547 (setq elt (assq 'sh list)))
133693bc
KH
1548 (if (and (consp (setq val (cdr elt)))
1549 (eq (car val) 'eval))
1550 (setcdr elt
1551 (setq val
1552 (eval (if (consp (setq val (cdr val)))
485219e0 1553 (let ((sh-shell (car (cdr val))))
133693bc
KH
1554 (if (assq sh-shell list)
1555 (setcar (cdr val)
1556 (list 'quote
1557 (sh-feature list))))
1558 val)
1559 val)))))
1560 (if function
1561 (nconc list
1562 (list (cons function
1563 (setq sh-shell (car function)
1564 val (funcall (cdr function) val))))))
1565 val)))
1566
1567
1568
3e2dd647
SM
1569;; I commented this out because nobody calls it -- rms.
1570;;(defun sh-abbrevs (ancestor &rest list)
1571;; "Iff it isn't, define the current shell as abbrev table and fill that.
1572;;Abbrev table will inherit all abbrevs from ANCESTOR, which is either an abbrev
1573;;table or a list of (NAME1 EXPANSION1 ...). In addition it will define abbrevs
1574;;according to the remaining arguments NAMEi EXPANSIONi ...
1575;;EXPANSION may be either a string or a skeleton command."
1576;; (or (if (boundp sh-shell)
1577;; (symbol-value sh-shell))
1578;; (progn
1579;; (if (listp ancestor)
1580;; (nconc list ancestor))
1581;; (define-abbrev-table sh-shell ())
1582;; (if (vectorp ancestor)
1583;; (mapatoms (lambda (atom)
1584;; (or (eq atom 0)
1585;; (define-abbrev (symbol-value sh-shell)
1586;; (symbol-name atom)
1587;; (symbol-value atom)
1588;; (symbol-function atom))))
1589;; ancestor))
1590;; (while list
1591;; (define-abbrev (symbol-value sh-shell)
1592;; (car list)
1593;; (if (stringp (car (cdr list)))
1594;; (car (cdr list))
1595;; "")
1596;; (if (symbolp (car (cdr list)))
1597;; (car (cdr list))))
1598;; (setq list (cdr (cdr list)))))
1599;; (symbol-value sh-shell)))
133693bc
KH
1600
1601
b1e851bb
RS
1602(defun sh-mode-syntax-table (table &rest list)
1603 "Copy TABLE and set syntax for successive CHARs according to strings S."
1604 (setq table (copy-syntax-table table))
1605 (while list
1606 (modify-syntax-entry (pop list) (pop list) table))
1607 table)
1608
133693bc
KH
1609(defun sh-append (ancestor &rest list)
1610 "Return list composed of first argument (a list) physically appended to rest."
1611 (nconc list ancestor))
1612
1613
1614(defun sh-modify (skeleton &rest list)
1615 "Modify a copy of SKELETON by replacing I1 with REPL1, I2 with REPL2 ..."
1616 (setq skeleton (copy-sequence skeleton))
1617 (while list
1618 (setcar (or (nthcdr (car list) skeleton)
1619 (error "Index %d out of bounds" (car list)))
1620 (car (cdr list)))
1621 (setq list (nthcdr 2 list)))
1622 skeleton)
ac59aed8
RS
1623
1624
f964dfcb 1625(defun sh-basic-indent-line ()
54c87e27
RS
1626 "Indent a line for Sh mode (shell script mode).
1627Indent as far as preceding non-empty line, then by steps of `sh-indentation'.
133693bc 1628Lines containing only comments are considered empty."
ac59aed8
RS
1629 (interactive)
1630 (let ((previous (save-excursion
54c87e27
RS
1631 (while (and (progn (beginning-of-line)
1632 (not (bobp)))
b46c06de
RS
1633 (progn
1634 (forward-line -1)
1635 (back-to-indentation)
1636 (or (eolp)
1637 (eq (following-char) ?#)))))
133693bc
KH
1638 (current-column)))
1639 current)
ac59aed8
RS
1640 (save-excursion
1641 (indent-to (if (eq this-command 'newline-and-indent)
1642 previous
1643 (if (< (current-column)
133693bc
KH
1644 (setq current (progn (back-to-indentation)
1645 (current-column))))
ac59aed8 1646 (if (eolp) previous 0)
133693bc
KH
1647 (delete-region (point)
1648 (progn (beginning-of-line) (point)))
ac59aed8 1649 (if (eolp)
133693bc
KH
1650 (max previous (* (1+ (/ current sh-indentation))
1651 sh-indentation))
1652 (* (1+ (/ current sh-indentation)) sh-indentation))))))
1653 (if (< (current-column) (current-indentation))
1654 (skip-chars-forward " \t"))))
1655
1656
1657(defun sh-execute-region (start end &optional flag)
1658 "Pass optional header and region to a subshell for noninteractive execution.
1659The working directory is that of the buffer, and only environment variables
1660are already set which is why you can mark a header within the script.
1661
1662With a positive prefix ARG, instead of sending region, define header from
1663beginning of buffer to point. With a negative prefix ARG, instead of sending
1664region, clear header."
1665 (interactive "r\nP")
1666 (if flag
1667 (setq sh-header-marker (if (> (prefix-numeric-value flag) 0)
1668 (point-marker)))
1669 (if sh-header-marker
1670 (save-excursion
1671 (let (buffer-undo-list)
1672 (goto-char sh-header-marker)
1673 (append-to-buffer (current-buffer) start end)
1674 (shell-command-on-region (point-min)
1675 (setq end (+ sh-header-marker
1676 (- end start)))
aafd074a 1677 sh-shell-file)
133693bc 1678 (delete-region sh-header-marker end)))
aafd074a 1679 (shell-command-on-region start end (concat sh-shell-file " -")))))
ac59aed8
RS
1680
1681
1682(defun sh-remember-variable (var)
1683 "Make VARIABLE available for future completing reads in this buffer."
1684 (or (< (length var) sh-remember-variable-min)
133693bc 1685 (getenv var)
5a989d6e 1686 (assoc var sh-shell-variables)
6c5bcbc1 1687 (push (cons var var) sh-shell-variables))
ac59aed8
RS
1688 var)
1689
1690
ac59aed8
RS
1691
1692(defun sh-quoted-p ()
1693 "Is point preceded by an odd number of backslashes?"
133693bc 1694 (eq -1 (% (save-excursion (skip-chars-backward "\\\\")) 2)))
ac59aed8 1695\f
f964dfcb 1696;; Indentation stuff.
f964dfcb
GM
1697(defun sh-must-support-indent ()
1698 "*Signal an error if the shell type for this buffer is not supported.
8db2b9fb 1699Also, the buffer must be in Shell-script mode."
f964dfcb 1700 (unless sh-indent-supported-here
4aa3ba0a 1701 (error "This buffer's shell does not support indentation through Emacs")))
f964dfcb
GM
1702
1703(defun sh-make-vars-local ()
1704 "Make the indentation variables local to this buffer.
1705Normally they already are local. This command is provided in case
1706variable `sh-make-vars-local' has been set to nil.
1707
8db2b9fb 1708To revert all these variables to the global values, use
f964dfcb
GM
1709command `sh-reset-indent-vars-to-global-values'."
1710 (interactive)
f964dfcb
GM
1711 (mapcar 'make-local-variable sh-var-list)
1712 (message "Indentation variable are now local."))
1713
1714(defun sh-reset-indent-vars-to-global-values ()
8db2b9fb
SM
1715 "Reset local indentation variables to the global values.
1716Then, if variable `sh-make-vars-local' is non-nil, make them local."
f964dfcb 1717 (interactive)
f964dfcb
GM
1718 (mapcar 'kill-local-variable sh-var-list)
1719 (if sh-make-vars-local
1720 (mapcar 'make-local-variable sh-var-list)))
1721
1722
f964dfcb
GM
1723;; Theoretically these are only needed in shell and derived modes.
1724;; However, the routines which use them are only called in those modes.
1725(defconst sh-special-keywords "then\\|do")
1726
f964dfcb
GM
1727(defun sh-help-string-for-variable (var)
1728 "Construct a string for `sh-read-variable' when changing variable VAR ."
1729 (let ((msg (documentation-property var 'variable-documentation))
1730 (msg2 ""))
6c5bcbc1 1731 (unless (memq var '(sh-first-lines-indent sh-indent-comment))
f964dfcb
GM
1732 (setq msg2
1733 (format "\n
8db2b9fb
SM
1734You can enter a number (positive to increase indentation,
1735negative to decrease indentation, zero for no change to indentation).
f964dfcb 1736
8db2b9fb 1737Or, you can enter one of the following symbols which are relative to
f964dfcb
GM
1738the value of variable `sh-basic-offset'
1739which in this buffer is currently %s.
1740
1741\t%s."
1742 sh-basic-offset
3e2dd647
SM
1743 (mapconcat (lambda (x)
1744 (nth (1- (length x)) x))
1745 sh-symbol-list "\n\t"))))
f964dfcb
GM
1746 (concat
1747 ;; The following shows the global not the local value!
1748 ;; (format "Current value of %s is %s\n\n" var (symbol-value var))
1749 msg msg2)))
1750
1751(defun sh-read-variable (var)
1752 "Read a new value for indentation variable VAR."
1753 (interactive "*variable? ") ;; to test
1754 (let ((minibuffer-help-form `(sh-help-string-for-variable
1755 (quote ,var)))
1756 val)
1757 (setq val (read-from-minibuffer
6c5bcbc1
SM
1758 (format "New value for %s (press %s for help): "
1759 var (single-key-description help-char))
1760 (format "%s" (symbol-value var))
1761 nil t))
f964dfcb
GM
1762 val))
1763
1764
1765
1766(defun sh-in-comment-or-string (start)
1767 "Return non-nil if START is in a comment or string."
1768 (save-excursion
3e2dd647
SM
1769 (let ((state (syntax-ppss start)))
1770 (or (nth 3 state) (nth 4 state)))))
f964dfcb
GM
1771
1772(defun sh-goto-matching-if ()
1773 "Go to the matching if for a fi.
1774This handles nested if..fi pairs."
1775 (let ((found (sh-find-prev-matching "\\bif\\b" "\\bfi\\b" 1)))
1776 (if found
1777 (goto-char found))))
1778
1779
1780;; Functions named sh-handle-this-XXX are called when the keyword on the
1781;; line whose indentation is being handled contain XXX;
8db2b9fb 1782;; those named sh-handle-prev-XXX are when XXX appears on the previous line.
f964dfcb
GM
1783
1784(defun sh-handle-prev-if ()
1785 (list '(+ sh-indent-after-if)))
1786
1787(defun sh-handle-this-else ()
1788 (if (sh-goto-matching-if)
1789 ;; (list "aligned to if")
1790 (list "aligned to if" '(+ sh-indent-for-else))
1791 nil
1792 ))
1793
1794(defun sh-handle-prev-else ()
1795 (if (sh-goto-matching-if)
1796 (list '(+ sh-indent-after-if))
1797 ))
1798
1799(defun sh-handle-this-fi ()
1800 (if (sh-goto-matching-if)
1801 (list "aligned to if" '(+ sh-indent-for-fi))
1802 nil
1803 ))
1804
1805(defun sh-handle-prev-fi ()
1806 ;; Why do we have this rule? Because we must go back to the if
1807 ;; to get its indent. We may continue back from there.
1808 ;; We return nil because we don't have anything to add to result,
1809 ;; the side affect of setting align-point is all that matters.
1810 ;; we could return a comment (a string) but I can't think of a good one...
1811 (sh-goto-matching-if)
1812 nil)
1813
1814(defun sh-handle-this-then ()
1815 (let ((p (sh-goto-matching-if)))
1816 (if p
1817 (list '(+ sh-indent-for-then))
1818 )))
1819
1820(defun sh-handle-prev-then ()
1821 (let ((p (sh-goto-matching-if)))
1822 (if p
1823 (list '(+ sh-indent-after-if))
1824 )))
1825
1826(defun sh-handle-prev-open ()
1827 (save-excursion
1828 (let ((x (sh-prev-stmt)))
1829 (if (and x
1830 (progn
1831 (goto-char x)
1832 (or
1833 (looking-at "function\\b")
1834 (looking-at "\\s-*\\S-+\\s-*()")
1835 )))
1836 (list '(+ sh-indent-after-function))
1837 (list '(+ sh-indent-after-open)))
1838 )))
1839
1840(defun sh-handle-this-close ()
1841 (forward-char 1) ;; move over ")"
6c5bcbc1
SM
1842 (if (sh-safe-forward-sexp -1)
1843 (list "aligned to opening paren")))
f964dfcb
GM
1844
1845(defun sh-goto-matching-case ()
1846 (let ((found (sh-find-prev-matching "\\bcase\\b" "\\besac\\b" 1)))
6c5bcbc1 1847 (if found (goto-char found))))
f964dfcb
GM
1848
1849(defun sh-handle-prev-case ()
1850 ;; This is typically called when point is on same line as a case
1851 ;; we shouldn't -- and can't find prev-case
6c5bcbc1 1852 (if (looking-at ".*\\<case\\>")
f964dfcb 1853 (list '(+ sh-indent-for-case-label))
6c5bcbc1 1854 (error "We don't seem to be on a line with a case"))) ;; debug
f964dfcb
GM
1855
1856(defun sh-handle-this-esac ()
6c5bcbc1
SM
1857 (if (sh-goto-matching-case)
1858 (list "aligned to matching case")))
f964dfcb
GM
1859
1860(defun sh-handle-prev-esac ()
6c5bcbc1
SM
1861 (if (sh-goto-matching-case)
1862 (list "matching case")))
f964dfcb
GM
1863
1864(defun sh-handle-after-case-label ()
6c5bcbc1
SM
1865 (if (sh-goto-matching-case)
1866 (list '(+ sh-indent-for-case-alt))))
f964dfcb
GM
1867
1868(defun sh-handle-prev-case-alt-end ()
6c5bcbc1
SM
1869 (if (sh-goto-matching-case)
1870 (list '(+ sh-indent-for-case-label))))
f964dfcb 1871
6c5bcbc1 1872(defun sh-safe-forward-sexp (&optional arg)
f964dfcb 1873 "Try and do a `forward-sexp', but do not error.
8db2b9fb 1874Return new point if successful, nil if an error occurred."
f964dfcb
GM
1875 (condition-case nil
1876 (progn
6c5bcbc1
SM
1877 (forward-sexp (or arg 1))
1878 (point)) ;; return point if successful
f964dfcb
GM
1879 (error
1880 (sh-debug "oops!(1) %d" (point))
6c5bcbc1 1881 nil))) ;; return nil if fail
f964dfcb
GM
1882
1883(defun sh-goto-match-for-done ()
1884 (let ((found (sh-find-prev-matching sh-regexp-for-done sh-re-done 1)))
1885 (if found
1886 (goto-char found))))
1887
1888(defun sh-handle-this-done ()
1889 (if (sh-goto-match-for-done)
6c5bcbc1 1890 (list "aligned to do stmt" '(+ sh-indent-for-done))))
f964dfcb
GM
1891
1892(defun sh-handle-prev-done ()
1893 (if (sh-goto-match-for-done)
6c5bcbc1 1894 (list "previous done")))
f964dfcb
GM
1895
1896(defun sh-handle-this-do ()
6c5bcbc1
SM
1897 (if (sh-goto-match-for-done)
1898 (list '(+ sh-indent-for-do))))
f964dfcb
GM
1899
1900(defun sh-handle-prev-do ()
6c5bcbc1
SM
1901 (cond
1902 ((save-restriction
1903 (narrow-to-region
1904 (point)
1905 (save-excursion
1906 (beginning-of-line)
1907 (point)))
1908 (sh-goto-match-for-done))
1909 (sh-debug "match for done found on THIS line")
1910 (list '(+ sh-indent-after-loop-construct)))
1911 ((sh-goto-match-for-done)
1912 (sh-debug "match for done found on PREV line")
1913 (list '(+ sh-indent-after-do)))
1914 (t
1915 (message "match for done NOT found")
1916 nil)))
f964dfcb
GM
1917
1918;; for rc:
1919(defun sh-find-prev-switch ()
1920 "Find the line for the switch keyword matching this line's case keyword."
8db2b9fb 1921 (re-search-backward "\\<switch\\>" nil t))
f964dfcb
GM
1922
1923(defun sh-handle-this-rc-case ()
1924 (if (sh-find-prev-switch)
1925 (list '(+ sh-indent-after-switch))
6c5bcbc1 1926 ;; (list '(+ sh-indent-for-case-label))
f964dfcb
GM
1927 nil))
1928
1929(defun sh-handle-prev-rc-case ()
1930 (list '(+ sh-indent-after-case)))
1931
1932(defun sh-check-rule (n thing)
1933 (let ((rule (nth n (assoc thing sh-kw-alist)))
1934 (val nil))
1935 (if rule
1936 (progn
1937 (setq val (funcall rule))
1938 (sh-debug "rule (%d) for %s at %d is %s\n-> returned %s"
1939 n thing (point) rule val)))
1940 val))
1941
1942
1943(defun sh-get-indent-info ()
1944 "Return indent-info for this line.
1945This is a list. nil means the line is to be left as is.
1946Otherwise it contains one or more of the following sublists:
8db2b9fb 1947\(t NUMBER\) NUMBER is the base location in the buffer that indentation is
f964dfcb
GM
1948 relative to. If present, this is always the first of the
1949 sublists. The indentation of the line in question is
8db2b9fb 1950 derived from the indentation of this point, possibly
f964dfcb
GM
1951 modified by subsequent sublists.
1952\(+ VAR\)
1953\(- VAR\) Get the value of variable VAR and add to or subtract from
1954 the indentation calculated so far.
1955\(= VAR\) Get the value of variable VAR and *replace* the
8db2b9fb 1956 indentation with its value. This only occurs for
f964dfcb
GM
1957 special variables such as `sh-indent-comment'.
1958STRING This is ignored for the purposes of calculating
8db2b9fb 1959 indentation, it is printed in certain cases to help show
f964dfcb
GM
1960 what the indentation is based on."
1961 ;; See comments before `sh-kw'.
1962 (save-excursion
485219e0 1963 (let ((have-result nil)
f964dfcb 1964 this-kw
f964dfcb 1965 start
485219e0 1966 val
f964dfcb 1967 (result nil)
f964dfcb
GM
1968 (align-point nil)
1969 prev-line-end x)
1970 (beginning-of-line)
1971 ;; Note: setting result to t means we are done and will return nil.
6c5bcbc1 1972 ;;(This function never returns just t.)
f964dfcb 1973 (cond
485219e0
SM
1974 ((or (and (boundp 'font-lock-string-face) (not (bobp))
1975 (eq (get-text-property (1- (point)) 'face)
1976 font-lock-string-face))
b36581fb 1977 (eq (get-text-property (point) 'face) sh-heredoc-face))
f964dfcb
GM
1978 (setq result t)
1979 (setq have-result t))
1980 ((looking-at "\\s-*#") ; was (equal this-kw "#")
1981 (if (bobp)
6c5bcbc1 1982 (setq result t) ;; return nil if 1st line!
f964dfcb
GM
1983 (setq result (list '(= sh-indent-comment)))
1984 ;; we still need to get previous line in case
8db2b9fb 1985 ;; sh-indent-comment is t (indent as normal)
f964dfcb
GM
1986 (setq align-point (sh-prev-line nil))
1987 (setq have-result nil)
1988 ))
6c5bcbc1 1989 ) ;; cond
035107fa 1990
f964dfcb
GM
1991 (unless have-result
1992 ;; Continuation lines are handled specially
1993 (if (sh-this-is-a-continuation)
1994 (progn
1995 ;; We assume the line being continued is already
1996 ;; properly indented...
1997 ;; (setq prev-line-end (sh-prev-line))
1998 (setq align-point (sh-prev-line nil))
1999 (setq result (list '(+ sh-indent-for-continuation)))
2000 (setq have-result t))
2001 (beginning-of-line)
2002 (skip-chars-forward " \t")
2003 (setq this-kw (sh-get-kw)))
2004
2005 ;; Handle "this" keyword: first word on the line we're
2006 ;; calculating indentation info for.
2007 (if this-kw
2008 (if (setq val (sh-check-rule 1 this-kw))
2009 (progn
2010 (setq align-point (point))
2011 (sh-debug
2012 "this - setting align-point to %d" align-point)
2013 (setq result (append result val))
2014 (setq have-result t)
2015 ;; set prev-line to continue processing remainder
8db2b9fb 2016 ;; of this line as a previous line
f964dfcb
GM
2017 (setq prev-line-end (point))
2018 ))))
2019
2020 (unless have-result
2021 (setq prev-line-end (sh-prev-line 'end)))
2022
2023 (if prev-line-end
2024 (save-excursion
2025 ;; We start off at beginning of this line.
2026 ;; Scan previous statements while this is <=
2027 ;; start of previous line.
6c5bcbc1 2028 (setq start (point)) ;; for debug only
f964dfcb
GM
2029 (goto-char prev-line-end)
2030 (setq x t)
2031 (while (and x (setq x (sh-prev-thing)))
2032 (sh-debug "at %d x is: %s result is: %s" (point) x result)
2033 (cond
2034 ((and (equal x ")")
2035 (equal (get-text-property (1- (point)) 'syntax-table)
34939e2c 2036 sh-st-punc))
f964dfcb
GM
2037 (sh-debug "Case label) here")
2038 (setq x 'case-label)
2039 (if (setq val (sh-check-rule 2 x))
2040 (progn
2041 (setq result (append result val))
2042 (setq align-point (point))))
2043 (forward-char -1)
2044 (skip-chars-forward "[a-z0-9]*?")
2045 )
2046 ((string-match "[])}]" x)
6c5bcbc1 2047 (setq x (sh-safe-forward-sexp -1))
f964dfcb
GM
2048 (if x
2049 (progn
2050 (setq align-point (point))
2051 (setq result (append result
2052 (list "aligned to opening paren")))
2053 )))
2054 ((string-match "[[({]" x)
2055 (sh-debug "Checking special thing: %s" x)
2056 (if (setq val (sh-check-rule 2 x))
2057 (setq result (append result val)))
2058 (forward-char -1)
2059 (setq align-point (point)))
2060 ((string-match "[\"'`]" x)
2061 (sh-debug "Skipping back for %s" x)
2062 ;; this was oops-2
6c5bcbc1 2063 (setq x (sh-safe-forward-sexp -1)))
f964dfcb
GM
2064 ((stringp x)
2065 (sh-debug "Checking string %s at %s" x (point))
2066 (if (setq val (sh-check-rule 2 x))
2067 ;; (or (eq t (car val))
2068 ;; (eq t (car (car val))))
2069 (setq result (append result val)))
2070 ;; not sure about this test Wed Jan 27 23:48:35 1999
2071 (setq align-point (point))
2072 (unless (bolp)
2073 (forward-char -1)))
2074 (t
2075 (error "Don't know what to do with %s" x))
2076 )
6c5bcbc1 2077 ) ;; while
f964dfcb
GM
2078 (sh-debug "result is %s" result)
2079 )
2080 (sh-debug "No prev line!")
2081 (sh-debug "result: %s align-point: %s" result align-point)
2082 )
035107fa 2083
f964dfcb
GM
2084 (if align-point
2085 ;; was: (setq result (append result (list (list t align-point))))
2086 (setq result (append (list (list t align-point)) result))
2087 )
2088 (sh-debug "result is now: %s" result)
035107fa 2089
f964dfcb
GM
2090 (or result
2091 (if prev-line-end
2092 (setq result (list (list t prev-line-end)))
2093 (setq result (list (list '= 'sh-first-lines-indent)))
2094 ))
035107fa 2095
f964dfcb
GM
2096 (if (eq result t)
2097 (setq result nil))
2098 (sh-debug "result is: %s" result)
2099 result
6c5bcbc1 2100 ) ;; let
f964dfcb
GM
2101 ))
2102
2103
2104(defun sh-get-indent-var-for-line (&optional info)
2105 "Return the variable controlling indentation for this line.
2106If there is not [just] one such variable, return a string
2107indicating the problem.
2108If INFO is supplied it is used, else it is calculated."
2109 (let ((var nil)
2110 (result nil)
2111 (reason nil)
2112 sym elt)
2113 (or info
2114 (setq info (sh-get-indent-info)))
2115 (if (null info)
2116 (setq result "this line to be left as is")
2117 (while (and info (null result))
2118 (setq elt (car info))
2119 (cond
2120 ((stringp elt)
2121 (setq reason elt)
2122 )
2123 ((not (listp elt))
2124 (error "sh-get-indent-var-for-line invalid elt: %s" elt))
2125 ;; so it is a list
2126 ((eq t (car elt))
6c5bcbc1 2127 ) ;; nothing
f964dfcb
GM
2128 ((symbolp (setq sym (nth 1 elt)))
2129 ;; A bit of a kludge - when we see the sh-indent-comment
2130 ;; ignore other variables. Otherwise it is tricky to
2131 ;; "learn" the comment indentation.
2132 (if (eq var 'sh-indent-comment)
2133 (setq result var)
2134 (if var
2135 (setq result
2136 "this line is controlled by more than 1 variable.")
2137 (setq var sym))))
2138 (t
2139 (error "sh-get-indent-var-for-line invalid list elt: %s" elt)))
2140 (setq info (cdr info))
2141 ))
2142 (or result
2143 (setq result var))
2144 (or result
2145 (setq result reason))
2146 (if (null result)
2147 ;; e.g. just had (t POS)
2148 (setq result "line has default indentation"))
2149 result))
2150
2151
2152
2153;; Finding the previous line isn't trivial.
2154;; We must *always* go back one more and see if that is a continuation
8db2b9fb 2155;; line -- it is the PREVIOUS line which is continued, not the one
f964dfcb
GM
2156;; we are going to!
2157;; Also, we want to treat a whole "here document" as one big line,
2158;; because we may want to a align to the beginning of it.
2159;;
2160;; What we do:
6c5bcbc1 2161;; - go back to previous non-empty line
8db2b9fb 2162;; - if this is in a here-document, go to the beginning of it
6c5bcbc1 2163;; - while previous line is continued, go back one line
f964dfcb
GM
2164(defun sh-prev-line (&optional end)
2165 "Back to end of previous non-comment non-empty line.
8db2b9fb 2166Go to beginning of logical line unless END is non-nil, in which case
f964dfcb 2167we go to the end of the previous line and do not check for continuations."
6c5bcbc1
SM
2168 (save-excursion
2169 (beginning-of-line)
2170 (forward-comment (- (point-max)))
2171 (unless end (beginning-of-line))
2172 (when (and (not (bobp))
34939e2c 2173 (equal (get-text-property (1- (point)) 'face)
b36581fb 2174 sh-heredoc-face))
34939e2c 2175 (let ((p1 (previous-single-property-change (1- (point)) 'face)))
6c5bcbc1
SM
2176 (when p1
2177 (goto-char p1)
34939e2c
SM
2178 (if end
2179 (end-of-line)
2180 (beginning-of-line)))))
6c5bcbc1
SM
2181 (unless end
2182 ;; we must check previous lines to see if they are continuation lines
2183 ;; if so, we must return position of first of them
2184 (while (and (sh-this-is-a-continuation)
2185 (>= 0 (forward-line -1))))
f964dfcb 2186 (beginning-of-line)
6c5bcbc1
SM
2187 (skip-chars-forward " \t"))
2188 (point)))
f964dfcb
GM
2189
2190
2191(defun sh-prev-stmt ()
2192 "Return the address of the previous stmt or nil."
2193 ;; This is used when we are trying to find a matching keyword.
8db2b9fb 2194 ;; Searching backward for the keyword would certainly be quicker, but
f964dfcb
GM
2195 ;; it is hard to remove "false matches" -- such as if the keyword
2196 ;; appears in a string or quote. This way is slower, but (I think) safer.
2197 (interactive)
2198 (save-excursion
2199 (let ((going t)
2200 (start (point))
2201 (found nil)
2202 (prev nil))
2203 (skip-chars-backward " \t;|&({[")
2204 (while (and (not found)
2205 (not (bobp))
2206 going)
8db2b9fb 2207 ;; Do a backward-sexp if possible, else backup bit by bit...
6c5bcbc1 2208 (if (sh-safe-forward-sexp -1)
f964dfcb
GM
2209 (progn
2210 (if (looking-at sh-special-keywords)
2211 (progn
2212 (setq found prev))
2213 (setq prev (point))
2214 ))
2215 ;; backward-sexp failed
2216 (if (zerop (skip-chars-backward " \t()[\]{};`'"))
2217 (forward-char -1))
2218 (if (bolp)
2219 (let ((back (sh-prev-line nil)))
2220 (if back
2221 (goto-char back)
2222 (setq going nil)))))
2223 (unless found
2224 (skip-chars-backward " \t")
2225 (if (or (and (bolp) (not (sh-this-is-a-continuation)))
2226 (eq (char-before) ?\;)
2227 (looking-at "\\s-*[|&]"))
2228 (setq found (point)))))
2229 (if found
2230 (goto-char found))
2231 (if found
2232 (progn
2233 (skip-chars-forward " \t|&({[")
2234 (setq found (point))))
2235 (if (>= (point) start)
2236 (progn
2237 (debug "We didn't move!")
2238 (setq found nil))
2239 (or found
2240 (sh-debug "Did not find prev stmt.")))
34939e2c 2241 found)))
f964dfcb
GM
2242
2243
2244(defun sh-get-word ()
2245 "Get a shell word skipping whitespace from point."
2246 (interactive)
2247 (skip-chars-forward "\t ")
2248 (let ((start (point)))
2249 (while
2250 (if (looking-at "[\"'`]")
2251 (sh-safe-forward-sexp)
2252 ;; (> (skip-chars-forward "^ \t\n\"'`") 0)
2253 (> (skip-chars-forward "-_a-zA-Z\$0-9") 0)
2254 ))
2255 (buffer-substring start (point))
2256 ))
2257
2258(defun sh-prev-thing ()
2259 "Return the previous thing this logical line."
2260 ;; This is called when `sh-get-indent-info' is working backwards on
2261 ;; the previous line(s) finding what keywords may be relevant for
8db2b9fb 2262 ;; indenting. It moves over sexps if possible, and will stop
f964dfcb
GM
2263 ;; on a ; and at the beginning of a line if it is not a continuation
2264 ;; line.
2265 ;;
2266 ;; Added a kludge for ";;"
2267 ;; Possible return values:
2268 ;; nil - nothing
2269 ;; a string - possibly a keyword
035107fa 2270 ;;
f964dfcb
GM
2271 (if (bolp)
2272 nil
485219e0
SM
2273 (let (c min-point
2274 (start (point)))
f964dfcb
GM
2275 (save-restriction
2276 (narrow-to-region
6c5bcbc1
SM
2277 (if (sh-this-is-a-continuation)
2278 (setq min-point (sh-prev-line nil))
2279 (save-excursion
2280 (beginning-of-line)
2281 (setq min-point (point))))
2282 (point))
f964dfcb
GM
2283 (skip-chars-backward " \t;")
2284 (unless (looking-at "\\s-*;;")
6c5bcbc1
SM
2285 (skip-chars-backward "^)}];\"'`({[")
2286 (setq c (char-before))))
f964dfcb 2287 (sh-debug "stopping at %d c is %s start=%d min-point=%d"
6c5bcbc1 2288 (point) c start min-point)
f964dfcb
GM
2289 (if (< (point) min-point)
2290 (error "point %d < min-point %d" (point) min-point))
2291 (cond
2292 ((looking-at "\\s-*;;")
2293 ;; (message "Found ;; !")
6c5bcbc1 2294 ";;")
f964dfcb
GM
2295 ((or (eq c ?\n)
2296 (eq c nil)
2297 (eq c ?\;))
6c5bcbc1
SM
2298 (save-excursion
2299 ;; skip forward over white space newline and \ at eol
2300 (skip-chars-forward " \t\n\\\\")
2301 (sh-debug "Now at %d start=%d" (point) start)
2302 (if (>= (point) start)
2303 (progn
2304 (sh-debug "point: %d >= start: %d" (point) start)
2305 nil)
2306 (sh-get-word))
2307 ))
f964dfcb
GM
2308 (t
2309 ;; c -- return a string
6c5bcbc1
SM
2310 (char-to-string c)
2311 ))
f964dfcb
GM
2312 )))
2313
2314
2315(defun sh-this-is-a-continuation ()
2316 "Return non-nil if current line is a continuation of previous line."
6c5bcbc1
SM
2317 (save-excursion
2318 (and (zerop (forward-line -1))
2319 (looking-at ".*\\\\$")
2320 (not (nth 4 (parse-partial-sexp (match-beginning 0) (match-end 0)
2321 nil nil nil t))))))
f964dfcb
GM
2322
2323(defun sh-get-kw (&optional where and-move)
2324 "Return first word of line from WHERE.
2325If AND-MOVE is non-nil then move to end of word."
2326 (let ((start (point)))
2327 (if where
2328 (goto-char where))
2329 (prog1
2330 (buffer-substring (point)
6c5bcbc1 2331 (progn (skip-chars-forward "^ \t\n;")(point)))
f964dfcb 2332 (unless and-move
34939e2c 2333 (goto-char start)))))
f964dfcb
GM
2334
2335(defun sh-find-prev-matching (open close &optional depth)
2336 "Find a matching token for a set of opening and closing keywords.
2337This takes into account that there may be nested open..close pairings.
2338OPEN and CLOSE are regexps denoting the tokens to be matched.
2339Optional parameter DEPTH (usually 1) says how many to look for."
2340 (let ((parse-sexp-ignore-comments t)
2341 prev)
2342 (setq depth (or depth 1))
2343 (save-excursion
2344 (condition-case nil
2345 (while (and
2346 (/= 0 depth)
2347 (not (bobp))
2348 (setq prev (sh-prev-stmt)))
2349 (goto-char prev)
2350 (save-excursion
2351 (if (looking-at "\\\\\n")
2352 (progn
2353 (forward-char 2)
2354 (skip-chars-forward " \t")))
2355 (cond
2356 ((looking-at open)
2357 (setq depth (1- depth))
2358 (sh-debug "found open at %d - depth = %d" (point) depth))
2359 ((looking-at close)
2360 (setq depth (1+ depth))
2361 (sh-debug "found close - depth = %d" depth))
2362 (t
2363 ))))
6c5bcbc1 2364 (error nil))
f964dfcb
GM
2365 (if (eq depth 0)
2366 prev ;; (point)
2367 nil)
2368 )))
2369
2370
2371(defun sh-var-value (var &optional ignore-error)
2372 "Return the value of variable VAR, interpreting symbols.
2373It can also return t or nil.
8db2b9fb 2374If an illegal value is found, throw an error unless Optional argument
f964dfcb
GM
2375IGNORE-ERROR is non-nil."
2376 (let ((val (symbol-value var)))
2377 (cond
2378 ((numberp val)
2379 val)
2380 ((eq val t)
2381 val)
2382 ((null val)
2383 val)
2384 ((eq val '+)
2385 sh-basic-offset)
2386 ((eq val '-)
2387 (- sh-basic-offset))
2388 ((eq val '++)
2389 (* 2 sh-basic-offset))
2390 ((eq val '--)
2391 (* 2 (- sh-basic-offset)))
2392 ((eq val '*)
2393 (/ sh-basic-offset 2))
2394 ((eq val '/)
2395 (/ (- sh-basic-offset) 2))
2396 (t
2397 (if ignore-error
6c5bcbc1
SM
2398 (progn
2399 (message "Don't know how to handle %s's value of %s" var val)
2400 0)
2401 (error "Don't know how to handle %s's value of %s" var val))
f964dfcb
GM
2402 ))))
2403
2404(defun sh-set-var-value (var value &optional no-symbol)
2405 "Set variable VAR to VALUE.
8db2b9fb 2406Unless optional argument NO-SYMBOL is non-nil, then if VALUE is
f964dfcb
GM
2407can be represented by a symbol then do so."
2408 (cond
2409 (no-symbol
2410 (set var value))
2411 ((= value sh-basic-offset)
2412 (set var '+))
2413 ((= value (- sh-basic-offset))
2414 (set var '-))
2415 ((eq value (* 2 sh-basic-offset))
2416 (set var '++))
2417 ((eq value (* 2 (- sh-basic-offset)))
2418 (set var '--))
2419 ((eq value (/ sh-basic-offset 2))
2420 (set var '*))
2421 ((eq value (/ (- sh-basic-offset) 2))
2422 (set var '/))
2423 (t
2424 (set var value)))
2425 )
2426
2427
2428(defun sh-calculate-indent (&optional info)
2429 "Return the indentation for the current line.
2430If INFO is supplied it is used, else it is calculated from current line."
6c5bcbc1 2431 (let ((ofs 0)
f964dfcb
GM
2432 (base-value 0)
2433 elt a b var val)
2434 (or info
2435 (setq info (sh-get-indent-info)))
6c5bcbc1 2436 (when info
f964dfcb
GM
2437 (while info
2438 (sh-debug "info: %s ofs=%s" info ofs)
2439 (setq elt (car info))
2440 (cond
6c5bcbc1 2441 ((stringp elt)) ;; do nothing?
f964dfcb
GM
2442 ((listp elt)
2443 (setq a (car (car info)))
2444 (setq b (nth 1 (car info)))
2445 (cond
2446 ((eq a t)
2447 (save-excursion
2448 (goto-char b)
2449 (setq val (current-indentation)))
2450 (setq base-value val))
2451 ((symbolp b)
2452 (setq val (sh-var-value b))
2453 (cond
2454 ((eq a '=)
2455 (cond
2456 ((null val)
2457 ;; no indentation
2458 ;; set info to nil so we stop immediately
2459 (setq base-value nil ofs nil info nil))
6c5bcbc1 2460 ((eq val t) (setq ofs 0)) ;; indent as normal line
f964dfcb
GM
2461 (t
2462 ;; The following assume the (t POS) come first!
2463 (setq ofs val base-value 0)
6c5bcbc1
SM
2464 (setq info nil)))) ;; ? stop now
2465 ((eq a '+) (setq ofs (+ ofs val)))
2466 ((eq a '-) (setq ofs (- ofs val)))
f964dfcb
GM
2467 (t
2468 (error "sh-calculate-indent invalid a a=%s b=%s" a b))))
2469 (t
6c5bcbc1 2470 (error "sh-calculate-indent invalid elt: a=%s b=%s" a b))))
f964dfcb 2471 (t
6c5bcbc1
SM
2472 (error "sh-calculate-indent invalid elt %s" elt)))
2473 (sh-debug "a=%s b=%s val=%s base-value=%s ofs=%s"
2474 a b val base-value ofs)
2475 (setq info (cdr info)))
f964dfcb
GM
2476 ;; return value:
2477 (sh-debug "at end: base-value: %s ofs: %s" base-value ofs)
2478
2479 (cond
2480 ((or (null base-value)(null ofs))
2481 nil)
2482 ((and (numberp base-value)(numberp ofs))
2483 (sh-debug "base (%d) + ofs (%d) = %d"
6c5bcbc1 2484 base-value ofs (+ base-value ofs))
f964dfcb
GM
2485 (+ base-value ofs)) ;; return value
2486 (t
2487 (error "sh-calculate-indent: Help. base-value=%s ofs=%s"
2488 base-value ofs)
6c5bcbc1 2489 nil)))))
f964dfcb
GM
2490
2491
3e2dd647 2492(defun sh-indent-line ()
f964dfcb
GM
2493 "Indent the current line."
2494 (interactive)
017708e9 2495 (let ((indent (sh-calculate-indent))
f964dfcb 2496 (pos (- (point-max) (point))))
6c5bcbc1
SM
2497 (when indent
2498 (beginning-of-line)
6c5bcbc1 2499 (skip-chars-forward " \t")
017708e9 2500 (indent-line-to indent)
6c5bcbc1
SM
2501 ;; If initial point was within line's indentation,
2502 ;; position after the indentation. Else stay at same point in text.
2503 (if (> (- (point-max) pos) (point))
2504 (goto-char (- (point-max) pos))))))
f964dfcb
GM
2505
2506
2507(defun sh-blink (blinkpos &optional msg)
2508 "Move cursor momentarily to BLINKPOS and display MSG."
2509 ;; We can get here without it being a number on first line
2510 (if (numberp blinkpos)
2511 (save-excursion
2512 (goto-char blinkpos)
2513 (message msg)
2514 (sit-for blink-matching-delay))
6c5bcbc1 2515 (message msg)))
f964dfcb
GM
2516
2517(defun sh-show-indent (arg)
2518 "Show the how the currently line would be indented.
2519This tells you which variable, if any, controls the indentation of
2520this line.
2521If optional arg ARG is non-null (called interactively with a prefix),
2522a pop up window describes this variable.
2523If variable `sh-blink' is non-nil then momentarily go to the line
2524we are indenting relative to, if applicable."
2525 (interactive "P")
2526 (sh-must-support-indent)
2527 (let* ((info (sh-get-indent-info))
2528 (var (sh-get-indent-var-for-line info))
6c5bcbc1
SM
2529 (curr-indent (current-indentation))
2530 val msg)
f964dfcb
GM
2531 (if (stringp var)
2532 (message (setq msg var))
2533 (setq val (sh-calculate-indent info))
2534
2535 (if (eq curr-indent val)
2536 (setq msg (format "%s is %s" var (symbol-value var)))
2537 (setq msg
2538 (if val
2539 (format "%s (%s) would change indent from %d to: %d"
2540 var (symbol-value var) curr-indent val)
2541 (format "%s (%s) would leave line as is"
2542 var (symbol-value var)))
2543 ))
2544 (if (and arg var)
2545 (describe-variable var)))
2546 (if sh-blink
2547 (let ((info (sh-get-indent-info)))
2548 (if (and info (listp (car info))
2549 (eq (car (car info)) t))
2550 (sh-blink (nth 1 (car info)) msg)
2551 (message msg)))
2552 (message msg))
2553 ))
2554
2555(defun sh-set-indent ()
2556 "Set the indentation for the current line.
2557If the current line is controlled by an indentation variable, prompt
2558for a new value for it."
2559 (interactive)
2560 (sh-must-support-indent)
2561 (let* ((info (sh-get-indent-info))
2562 (var (sh-get-indent-var-for-line info))
485219e0 2563 val old-val indent-val)
f964dfcb
GM
2564 (if (stringp var)
2565 (message (format "Cannot set indent - %s" var))
2566 (setq old-val (symbol-value var))
2567 (setq val (sh-read-variable var))
2568 (condition-case nil
2569 (progn
2570 (set var val)
2571 (setq indent-val (sh-calculate-indent info))
2572 (if indent-val
2573 (message "Variable: %s Value: %s would indent to: %d"
2574 var (symbol-value var) indent-val)
2575 (message "Variable: %s Value: %s would leave line as is."
2576 var (symbol-value var)))
8db2b9fb 2577 ;; I'm not sure about this, indenting it now?
f964dfcb 2578 ;; No. Because it would give the impression that an undo would
8db2b9fb 2579 ;; restore thing, but the value has been altered.
f964dfcb
GM
2580 ;; (sh-indent-line)
2581 )
2582 (error
2583 (set var old-val)
8db2b9fb 2584 (message "Bad value for %s, restoring to previous value %s"
f964dfcb
GM
2585 var old-val)
2586 (sit-for 1)
2587 nil))
2588 )))
2589
2590
2591(defun sh-learn-line-indent (arg)
2592 "Learn how to indent a line as it currently is indented.
2593
2594If there is an indentation variable which controls this line's indentation,
2595then set it to a value which would indent the line the way it
2596presently is.
2597
2598If the value can be represented by one of the symbols then do so
2599unless optional argument ARG (the prefix when interactive) is non-nil."
2600 (interactive "*P")
2601 (sh-must-support-indent)
2602 ;; I'm not sure if we show allow learning on an empty line.
2603 ;; Though it might occasionally be useful I think it usually
2604 ;; would just be confusing.
2605 (if (save-excursion
2606 (beginning-of-line)
2607 (looking-at "\\s-*$"))
2608 (message "sh-learn-line-indent ignores empty lines.")
2609 (let* ((info (sh-get-indent-info))
2610 (var (sh-get-indent-var-for-line info))
2611 ival sval diff new-val
2612 (no-symbol arg)
2613 (curr-indent (current-indentation)))
6c5bcbc1
SM
2614 (cond
2615 ((stringp var)
2616 (message (format "Cannot learn line - %s" var)))
2617 ((eq var 'sh-indent-comment)
2618 ;; This is arbitrary...
2619 ;; - if curr-indent is 0, set to curr-indent
2620 ;; - else if it has the indentation of a "normal" line,
2621 ;; then set to t
2622 ;; - else set to curr-indent.
2623 (setq sh-indent-comment
2624 (if (= curr-indent 0)
2625 0
2626 (let* ((sh-indent-comment t)
2627 (val2 (sh-calculate-indent info)))
2628 (if (= val2 curr-indent)
2629 t
2630 curr-indent))))
2631 (message "%s set to %s" var (symbol-value var))
2632 )
2633 ((numberp (setq sval (sh-var-value var)))
2634 (setq ival (sh-calculate-indent info))
2635 (setq diff (- curr-indent ival))
035107fa 2636
6c5bcbc1
SM
2637 (sh-debug "curr-indent: %d ival: %d diff: %d var:%s sval %s"
2638 curr-indent ival diff var sval)
2639 (setq new-val (+ sval diff))
f964dfcb
GM
2640;;; I commented out this because someone might want to replace
2641;;; a value of `+' with the current value of sh-basic-offset
2642;;; or vice-versa.
2643;;; (if (= 0 diff)
2644;;; (message "No change needed!")
6c5bcbc1
SM
2645 (sh-set-var-value var new-val no-symbol)
2646 (message "%s set to %s" var (symbol-value var))
2647 )
2648 (t
2649 (debug)
2650 (message "Cannot change %s" var))))))
f964dfcb
GM
2651
2652
2653
2654(defun sh-mark-init (buffer)
2655 "Initialize a BUFFER to be used by `sh-mark-line'."
348e1411
JB
2656 (save-excursion
2657 (set-buffer (get-buffer-create buffer))
2658 (erase-buffer)
2659 (occur-mode)
2660 ))
f964dfcb
GM
2661
2662
2663(defun sh-mark-line (message point buffer &optional add-linenum occur-point)
2664 "Insert MESSAGE referring to location POINT in current buffer into BUFFER.
2665Buffer BUFFER is in `occur-mode'.
2666If ADD-LINENUM is non-nil the message is preceded by the line number.
8db2b9fb 2667If OCCUR-POINT is non-nil then the line is marked as a new occurrence
f964dfcb
GM
2668so that `occur-next' and `occur-prev' will work."
2669 (let ((m1 (make-marker))
f964dfcb 2670 start
6c5bcbc1
SM
2671 (line ""))
2672 (when point
2673 (set-marker m1 point (current-buffer))
2674 (if add-linenum
2675 (setq line (format "%d: " (1+ (count-lines 1 point))))))
f964dfcb
GM
2676 (save-excursion
2677 (if (get-buffer buffer)
2678 (set-buffer (get-buffer buffer))
2679 (set-buffer (get-buffer-create buffer))
2680 (occur-mode)
f964dfcb
GM
2681 )
2682 (goto-char (point-max))
2683 (setq start (point))
2684 (insert line)
2685 (if occur-point
2686 (setq occur-point (point)))
2687 (insert message)
2688 (if point
06d74900
EZ
2689 (add-text-properties
2690 start (point)
2691 '(mouse-face highlight
2692 help-echo "mouse-2: go to the line where I learned this")))
f964dfcb
GM
2693 (insert "\n")
2694 (if point
2695 (progn
348e1411 2696 (put-text-property start (point) 'occur-target m1)
f964dfcb 2697 (if occur-point
348e1411
JB
2698 (put-text-property start occur-point
2699 'occur-match t))
f964dfcb
GM
2700 ))
2701 )))
2702
2703
2704
2705;; Is this really worth having?
2706(defvar sh-learned-buffer-hook nil
8db2b9fb 2707 "*An abnormal hook, called with an alist of learned variables.")
3e2dd647 2708;; Example of how to use sh-learned-buffer-hook
035107fa 2709;;
f964dfcb
GM
2710;; (defun what-i-learned (list)
2711;; (let ((p list))
2712;; (save-excursion
2713;; (set-buffer "*scratch*")
2714;; (goto-char (point-max))
2715;; (insert "(setq\n")
2716;; (while p
2717;; (insert (format " %s %s \n"
2718;; (nth 0 (car p)) (nth 1 (car p))))
2719;; (setq p (cdr p)))
2720;; (insert ")\n")
2721;; )))
035107fa 2722;;
f964dfcb
GM
2723;; (add-hook 'sh-learned-buffer-hook 'what-i-learned)
2724
2725
2726;; Originally this was sh-learn-region-indent (beg end)
8db2b9fb 2727;; However, in practice this was awkward so I changed it to
f964dfcb
GM
2728;; use the whole buffer. Use narrowing if needbe.
2729(defun sh-learn-buffer-indent (&optional arg)
2730 "Learn how to indent the buffer the way it currently is.
2731
2732Output in buffer \"*indent*\" shows any lines which have conflicting
8db2b9fb
SM
2733values of a variable, and the final value of all variables learned.
2734This buffer is popped to automatically if there are any discrepancies.
f964dfcb 2735
8db2b9fb
SM
2736If no prefix ARG is given, then variables are set to numbers.
2737If a prefix arg is given, then variables are set to symbols when
f964dfcb
GM
2738applicable -- e.g. to symbol `+' if the value is that of the
2739basic indent.
2740If a positive numerical prefix is given, then `sh-basic-offset'
2741is set to the prefix's numerical value.
8db2b9fb 2742Otherwise, sh-basic-offset may or may not be changed, according
f964dfcb
GM
2743to the value of variable `sh-learn-basic-offset'.
2744
2745Abnormal hook `sh-learned-buffer-hook' if non-nil is called when the
2746function completes. The function is abnormal because it is called
8db2b9fb 2747with an alist of variables learned. This feature may be changed or
f964dfcb
GM
2748removed in the future.
2749
2750This command can often take a long time to run."
2751 (interactive "P")
2752 (sh-must-support-indent)
2753 (save-excursion
2754 (goto-char (point-min))
2755 (let ((learned-var-list nil)
2756 (out-buffer "*indent*")
2757 (num-diffs 0)
f964dfcb
GM
2758 previous-set-info
2759 (max 17)
2760 vec
2761 msg
8db2b9fb 2762 (comment-col nil) ;; number if all same, t if seen diff values
f964dfcb
GM
2763 (comments-always-default t) ;; nil if we see one not default
2764 initial-msg
2765 (specified-basic-offset (and arg (numberp arg)
2766 (> arg 0)))
2767 (linenum 0)
2768 suggested)
2769 (setq vec (make-vector max 0))
2770 (sh-mark-init out-buffer)
2771
2772 (if specified-basic-offset
2773 (progn
2774 (setq sh-basic-offset arg)
2775 (setq initial-msg
2776 (format "Using specified sh-basic-offset of %d"
2777 sh-basic-offset)))
2778 (setq initial-msg
2779 (format "Initial value of sh-basic-offset: %s"
2780 sh-basic-offset)))
2781
2782 (while (< (point) (point-max))
2783 (setq linenum (1+ linenum))
6c5bcbc1
SM
2784 ;; (if (zerop (% linenum 10))
2785 (message "line %d" linenum)
2786 ;; )
f964dfcb
GM
2787 (unless (looking-at "\\s-*$") ;; ignore empty lines!
2788 (let* ((sh-indent-comment t) ;; info must return default indent
2789 (info (sh-get-indent-info))
2790 (var (sh-get-indent-var-for-line info))
2791 sval ival diff new-val
2792 (curr-indent (current-indentation)))
2793 (cond
2794 ((null var)
2795 nil)
2796 ((stringp var)
2797 nil)
2798 ((numberp (setq sval (sh-var-value var 'no-error)))
2799 ;; the numberp excludes comments since sval will be t.
2800 (setq ival (sh-calculate-indent))
2801 (setq diff (- curr-indent ival))
2802 (setq new-val (+ sval diff))
2803 (sh-set-var-value var new-val 'no-symbol)
6c5bcbc1 2804 (unless (looking-at "\\s-*#") ;; don't learn from comments
f964dfcb
GM
2805 (if (setq previous-set-info (assoc var learned-var-list))
2806 (progn
8db2b9fb 2807 ;; it was already there, is it same value ?
f964dfcb
GM
2808 (unless (eq (symbol-value var)
2809 (nth 1 previous-set-info))
2810 (sh-mark-line
2811 (format "Variable %s was set to %s"
2812 var (symbol-value var))
2813 (point) out-buffer t t)
2814 (sh-mark-line
2815 (format " but was previously set to %s"
2816 (nth 1 previous-set-info))
2817 (nth 2 previous-set-info) out-buffer t)
2818 (setq num-diffs (1+ num-diffs))
2819 ;; (delete previous-set-info learned-var-list)
2820 (setcdr previous-set-info
2821 (list (symbol-value var) (point)))
2822 )
2823 )
2824 (setq learned-var-list
2825 (append (list (list var (symbol-value var)
2826 (point)))
2827 learned-var-list)))
2828 (if (numberp new-val)
2829 (progn
2830 (sh-debug
2831 "This line's indent value: %d" new-val)
2832 (if (< new-val 0)
2833 (setq new-val (- new-val)))
2834 (if (< new-val max)
2835 (aset vec new-val (1+ (aref vec new-val))))))
2836 ))
2837 ((eq var 'sh-indent-comment)
2838 (unless (= curr-indent (sh-calculate-indent info))
2839 ;; this is not the default indentation
2840 (setq comments-always-default nil)
6c5bcbc1 2841 (if comment-col ;; then we have see one before
f964dfcb 2842 (or (eq comment-col curr-indent)
6c5bcbc1 2843 (setq comment-col t)) ;; seen a different one
f964dfcb 2844 (setq comment-col curr-indent))
6c5bcbc1
SM
2845 ))
2846 (t
f964dfcb
GM
2847 (sh-debug "Cannot learn this line!!!")
2848 ))
2849 (sh-debug
6c5bcbc1 2850 "at %s learned-var-list is %s" (point) learned-var-list)
f964dfcb
GM
2851 ))
2852 (forward-line 1)
2853 ) ;; while
2854 (if sh-debug
2855 (progn
2856 (setq msg (format
2857 "comment-col = %s comments-always-default = %s"
2858 comment-col comments-always-default))
2859 ;; (message msg)
2860 (sh-mark-line msg nil out-buffer)))
2861 (cond
2862 ((eq comment-col 0)
2863 (setq msg "\nComments are all in 1st column.\n"))
2864 (comments-always-default
2865 (setq msg "\nComments follow default indentation.\n")
2866 (setq comment-col t))
2867 ((numberp comment-col)
2868 (setq msg (format "\nComments are in col %d." comment-col)))
2869 (t
8db2b9fb 2870 (setq msg "\nComments seem to be mixed, leaving them as is.\n")
f964dfcb
GM
2871 (setq comment-col nil)
2872 ))
2873 (sh-debug msg)
2874 (sh-mark-line msg nil out-buffer)
2875
2876 (sh-mark-line initial-msg nil out-buffer t t)
2877
2878 (setq suggested (sh-guess-basic-offset vec))
2879
2880 (if (and suggested (not specified-basic-offset))
2881 (let ((new-value
2882 (cond
2883 ;; t => set it if we have a single value as a number
2884 ((and (eq sh-learn-basic-offset t) (numberp suggested))
2885 suggested)
2886 ;; other non-nil => set it if only one value was found
2887 (sh-learn-basic-offset
2888 (if (numberp suggested)
2889 suggested
2890 (if (= (length suggested) 1)
2891 (car suggested))))
2892 (t
2893 nil))))
2894 (if new-value
2895 (progn
2896 (setq learned-var-list
2897 (append (list (list 'sh-basic-offset
2898 (setq sh-basic-offset new-value)
2899 (point-max)))
2900 learned-var-list))
2901 ;; Not sure if we need to put this line in, since
2902 ;; it will appear in the "Learned variable settings".
2903 (sh-mark-line
2904 (format "Changed sh-basic-offset to: %d" sh-basic-offset)
2905 nil out-buffer))
2906 (sh-mark-line
2907 (if (listp suggested)
2908 (format "Possible value(s) for sh-basic-offset: %s"
2909 (mapconcat 'int-to-string suggested " "))
2910 (format "Suggested sh-basic-offset: %d" suggested))
2911 nil out-buffer))))
2912
035107fa 2913
f964dfcb
GM
2914 (setq learned-var-list
2915 (append (list (list 'sh-indent-comment comment-col (point-max)))
6c5bcbc1 2916 learned-var-list))
f964dfcb 2917 (setq sh-indent-comment comment-col)
485219e0 2918 (let ((name (buffer-name)))
f964dfcb
GM
2919 (sh-mark-line "\nLearned variable settings:" nil out-buffer)
2920 (if arg
2921 ;; Set learned variables to symbolic rather than numeric
2922 ;; values where possible.
6c5bcbc1
SM
2923 (dolist (learned-var (reverse learned-var-list))
2924 (let ((var (car learned-var))
2925 (val (nth 1 learned-var)))
2926 (when (and (not (eq var 'sh-basic-offset))
2927 (numberp val))
2928 (sh-set-var-value var val)))))
2929 (dolist (learned-var (reverse learned-var-list))
2930 (let ((var (car learned-var)))
f964dfcb 2931 (sh-mark-line (format " %s %s" var (symbol-value var))
6c5bcbc1 2932 (nth 2 learned-var) out-buffer)))
f964dfcb 2933 (save-excursion
6c5bcbc1
SM
2934 (set-buffer out-buffer)
2935 (goto-char (point-min))
2936 (insert
2937 (format "Indentation values for buffer %s.\n" name)
2938 (format "%d indentation variable%s different values%s\n\n"
2939 num-diffs
2940 (if (= num-diffs 1)
2941 " has" "s have")
2942 (if (zerop num-diffs)
2943 "." ":"))
2944 )))
f964dfcb
GM
2945 ;; Are abnormal hooks considered bad form?
2946 (run-hook-with-args 'sh-learned-buffer-hook learned-var-list)
2947 (if (or sh-popup-occur-buffer (> num-diffs 0))
2948 (pop-to-buffer out-buffer))
2949 )))
2950
2951(defun sh-guess-basic-offset (vec)
8db2b9fb 2952 "See if we can determine a reasonable value for `sh-basic-offset'.
f964dfcb
GM
2953This is experimental, heuristic and arbitrary!
2954Argument VEC is a vector of information collected by
2955`sh-learn-buffer-indent'.
2956Return values:
2957 number - there appears to be a good single value
8db2b9fb 2958 list of numbers - no obvious one, here is a list of one or more
f964dfcb
GM
2959 reasonable choices
2960 nil - we couldn't find a reasonable one."
2961 (let* ((max (1- (length vec)))
6c5bcbc1 2962 (i 1)
485219e0 2963 (totals (make-vector max 0)))
f964dfcb
GM
2964 (while (< i max)
2965 (aset totals i (+ (aref totals i) (* 4 (aref vec i))))
f964dfcb
GM
2966 (if (zerop (% i 2))
2967 (aset totals i (+ (aref totals i) (aref vec (/ i 2)))))
2968 (if (< (* i 2) max)
2969 (aset totals i (+ (aref totals i) (aref vec (* i 2)))))
6c5bcbc1
SM
2970 (setq i (1+ i)))
2971
f964dfcb
GM
2972 (let ((x nil)
2973 (result nil)
2974 tot sum p)
2975 (setq i 1)
2976 (while (< i max)
2977 (if (/= (aref totals i) 0)
2978 (setq x (append x (list (cons i (aref totals i))))))
2979 (setq i (1+ i)))
2980
6c5bcbc1 2981 (setq x (sort x (lambda (a b) (> (cdr a) (cdr b)))))
f964dfcb
GM
2982 (setq tot (apply '+ (append totals nil)))
2983 (sh-debug (format "vec: %s\ntotals: %s\ntot: %d"
6c5bcbc1 2984 vec totals tot))
f964dfcb
GM
2985 (cond
2986 ((zerop (length x))
2987 (message "no values!")) ;; we return nil
2988 ((= (length x) 1)
2989 (message "only value is %d" (car (car x)))
6c5bcbc1 2990 (setq result (car (car x)))) ;; return single value
f964dfcb
GM
2991 ((> (cdr (car x)) (/ tot 2))
2992 ;; 1st is > 50%
2993 (message "basic-offset is probably %d" (car (car x)))
2994 (setq result (car (car x)))) ;; again, return a single value
2995 ((>= (cdr (car x)) (* 2 (cdr (car (cdr x)))))
2996 ;; 1st is >= 2 * 2nd
2997 (message "basic-offset could be %d" (car (car x)))
2998 (setq result (car (car x))))
2999 ((>= (+ (cdr (car x))(cdr (car (cdr x)))) (/ tot 2))
3000 ;; 1st & 2nd together >= 50% - return a list
3001 (setq p x sum 0 result nil)
3002 (while (and p
3003 (<= (setq sum (+ sum (cdr (car p)))) (/ tot 2)))
3004 (setq result (append result (list (car (car p)))))
3005 (setq p (cdr p)))
3006 (message "Possible choices for sh-basic-offset: %s"
3007 (mapconcat 'int-to-string result " ")))
3008 (t
3009 (message "No obvious value for sh-basic-offset. Perhaps %d"
3010 (car (car x)))
3011 ;; result is nil here
3012 ))
34939e2c 3013 result)))
f964dfcb
GM
3014
3015;; ========================================================================
3016
8db2b9fb 3017;; Styles -- a quick and dirty way of saving the indentation settings.
f964dfcb
GM
3018
3019(defvar sh-styles-alist nil
3020 "A list of all known shell indentation styles.")
3021
3022(defun sh-name-style (name &optional confirm-overwrite)
3023 "Name the current indentation settings as a style called NAME.
8db2b9fb 3024If this name exists, the command will prompt whether it should be
f964dfcb 3025overwritten if
8db2b9fb 3026- - it was called interactively with a prefix argument, or
f964dfcb
GM
3027- - called non-interactively with optional CONFIRM-OVERWRITE non-nil."
3028 ;; (interactive "sName for this style: ")
3029 (interactive
3030 (list
3031 (read-from-minibuffer "Name for this style? " )
3032 (not current-prefix-arg)))
6c5bcbc1
SM
3033 (let ((slist (cons name
3034 (mapcar (lambda (var) (cons var (symbol-value var)))
3035 sh-var-list)))
3036 (style (assoc name sh-styles-alist)))
3037 (if style
3038 (if (and confirm-overwrite
3039 (not (y-or-n-p "This style exists. Overwrite it? ")))
3040 (message "Not changing style %s" name)
3041 (message "Updating style %s" name)
3042 (setcdr style (cdr slist)))
f964dfcb 3043 (message "Creating new style %s" name)
6c5bcbc1 3044 (push slist sh-styles-alist))))
f964dfcb
GM
3045
3046(defun sh-load-style (name)
3047 "Set shell indentation values for this buffer from those in style NAME."
3048 (interactive (list (completing-read
3049 "Which style to use for this buffer? "
3050 sh-styles-alist nil t)))
3051 (let ((sl (assoc name sh-styles-alist)))
3052 (if (null sl)
3053 (error "sh-load-style - style %s not known" name)
6c5bcbc1
SM
3054 (dolist (var (cdr sl))
3055 (set (car var) (cdr var))))))
f964dfcb
GM
3056
3057(defun sh-save-styles-to-buffer (buff)
3058 "Save all current styles in elisp to buffer BUFF.
3059This is always added to the end of the buffer."
3060 (interactive (list
6c5bcbc1
SM
3061 (read-from-minibuffer "Buffer to save styles in? " "*scratch*")))
3062 (with-current-buffer (get-buffer-create buff)
f964dfcb
GM
3063 (goto-char (point-max))
3064 (insert "\n")
6c5bcbc1 3065 (pp `(setq sh-styles-alist ',sh-styles-alist) (current-buffer))))
f964dfcb
GM
3066
3067
3068\f
ac59aed8
RS
3069;; statement syntax-commands for various shells
3070
3071;; You are welcome to add the syntax or even completely new statements as
3072;; appropriate for your favorite shell.
3073
017708e9
SM
3074(defconst sh-non-closing-paren
3075 ;; If we leave it rear-sticky, calling `newline' ends up inserting a \n
3076 ;; that inherits this property, which then confuses the indentation.
3077 (propertize ")" 'syntax-table sh-st-punc 'rear-nonsticky t))
3078
c410bd65
RS
3079(define-skeleton sh-case
3080 "Insert a case/switch statement. See `sh-feature'."
cef926f3
RS
3081 (csh "expression: "
3082 "switch( " str " )" \n
3083 > "case " (read-string "pattern: ") ?: \n
c410bd65 3084 > _ \n
cef926f3 3085 "breaksw" \n
c410bd65 3086 ( "other pattern, %s: "
cef926f3 3087 < "case " str ?: \n
c410bd65 3088 > _ \n
cef926f3
RS
3089 "breaksw" \n)
3090 < "default:" \n
c410bd65
RS
3091 > _ \n
3092 resume:
3e2dd647 3093 < < "endsw" \n)
cef926f3
RS
3094 (es)
3095 (rc "expression: "
f964dfcb 3096 > "switch( " str " ) {" \n
cef926f3
RS
3097 > "case " (read-string "pattern: ") \n
3098 > _ \n
3099 ( "other pattern, %s: "
f964dfcb 3100 "case " str > \n
cef926f3 3101 > _ \n)
f964dfcb 3102 "case *" > \n
cef926f3
RS
3103 > _ \n
3104 resume:
035107fa 3105 ?\} > \n)
cef926f3 3106 (sh "expression: "
f964dfcb 3107 > "case " str " in" \n
017708e9
SM
3108 ( "pattern, %s: "
3109 > str sh-non-closing-paren \n
cef926f3 3110 > _ \n
8f0b0ca5 3111 ";;" \n)
017708e9 3112 > "*" sh-non-closing-paren \n
cef926f3
RS
3113 > _ \n
3114 resume:
3e2dd647 3115 "esac" > \n))
133693bc
KH
3116
3117(define-skeleton sh-for
3118 "Insert a for loop. See `sh-feature'."
3119 (csh eval sh-modify sh
f964dfcb
GM
3120 1 ""
3121 2 "foreach "
3122 4 " ( "
3123 6 " )"
3124 15 '<
b36581fb 3125 16 "end")
133693bc 3126 (es eval sh-modify rc
f964dfcb 3127 4 " = ")
133693bc 3128 (rc eval sh-modify sh
f964dfcb
GM
3129 2 "for( "
3130 6 " ) {"
035107fa 3131 15 ?\} )
ac59aed8 3132 (sh "Index variable: "
f964dfcb 3133 > "for " str " in " _ "; do" \n
133693bc 3134 > _ | ?$ & (sh-remember-variable str) \n
3e2dd647 3135 "done" > \n))
ac59aed8
RS
3136
3137
3138
133693bc
KH
3139(define-skeleton sh-indexed-loop
3140 "Insert an indexed loop from 1 to n. See `sh-feature'."
3141 (bash eval identity posix)
ac59aed8
RS
3142 (csh "Index variable: "
3143 "@ " str " = 1" \n
133693bc
KH
3144 "while( $" str " <= " (read-string "upper limit: ") " )" \n
3145 > _ ?$ str \n
ac59aed8 3146 "@ " str "++" \n
3e2dd647 3147 < "end" \n)
133693bc 3148 (es eval sh-modify rc
f964dfcb 3149 4 " =")
133693bc 3150 (ksh88 "Index variable: "
f964dfcb
GM
3151 > "integer " str "=0" \n
3152 > "while (( ( " str " += 1 ) <= "
133693bc
KH
3153 (read-string "upper limit: ")
3154 " )); do" \n
f964dfcb 3155 > _ ?$ (sh-remember-variable str) > \n
3e2dd647 3156 "done" > \n)
133693bc 3157 (posix "Index variable: "
f964dfcb 3158 > str "=1" \n
133693bc
KH
3159 "while [ $" str " -le "
3160 (read-string "upper limit: ")
3161 " ]; do" \n
3162 > _ ?$ str \n
3163 str ?= (sh-add (sh-remember-variable str) 1) \n
3e2dd647 3164 "done" > \n)
133693bc 3165 (rc "Index variable: "
f964dfcb 3166 > "for( " str " in" " `{awk 'BEGIN { for( i=1; i<="
133693bc 3167 (read-string "upper limit: ")
f964dfcb 3168 "; i++ ) print i }'`}) {" \n
133693bc 3169 > _ ?$ (sh-remember-variable str) \n
035107fa 3170 ?\} > \n)
133693bc 3171 (sh "Index variable: "
f964dfcb 3172 > "for " str " in `awk 'BEGIN { for( i=1; i<="
133693bc
KH
3173 (read-string "upper limit: ")
3174 "; i++ ) print i }'`; do" \n
3175 > _ ?$ (sh-remember-variable str) \n
3e2dd647 3176 "done" > \n))
ac59aed8
RS
3177
3178
5d73ac66
RS
3179(defun sh-shell-initialize-variables ()
3180 "Scan the buffer for variable assignments.
3181Add these variables to `sh-shell-variables'."
3182 (message "Scanning buffer `%s' for variable assignments..." (buffer-name))
3183 (save-excursion
3184 (goto-char (point-min))
3185 (setq sh-shell-variables-initialized t)
3186 (while (search-forward "=" nil t)
3187 (sh-assignment 0)))
3188 (message "Scanning buffer `%s' for variable assignments...done"
3189 (buffer-name)))
3190
3191(defvar sh-add-buffer)
3192
3193(defun sh-add-completer (string predicate code)
3194 "Do completion using `sh-shell-variables', but initialize it first.
3195This function is designed for use as the \"completion table\",
3196so it takes three arguments:
3197 STRING, the current buffer contents;
3198 PREDICATE, the predicate for filtering possible matches;
3199 CODE, which says what kind of things to do.
3200CODE can be nil, t or `lambda'.
3201nil means to return the best completion of STRING, or nil if there is none.
3202t means to return a list of all possible completions of STRING.
3203`lambda' means to return t if STRING is a valid completion as it stands."
3204 (let ((sh-shell-variables
3205 (save-excursion
3206 (set-buffer sh-add-buffer)
3207 (or sh-shell-variables-initialized
3208 (sh-shell-initialize-variables))
3209 (nconc (mapcar (lambda (var)
3210 (let ((name
3211 (substring var 0 (string-match "=" var))))
3212 (cons name name)))
3213 process-environment)
3214 sh-shell-variables))))
017708e9 3215 (case code
fa1d74c5 3216 ((nil) (try-completion string sh-shell-variables predicate))
017708e9
SM
3217 (lambda (test-completion string sh-shell-variables predicate))
3218 (t (all-completions string sh-shell-variables predicate)))))
5d73ac66 3219
ac59aed8 3220(defun sh-add (var delta)
133693bc 3221 "Insert an addition of VAR and prefix DELTA for Bourne (type) shell."
ac59aed8 3222 (interactive
5d73ac66
RS
3223 (let ((sh-add-buffer (current-buffer)))
3224 (list (completing-read "Variable: " 'sh-add-completer)
3225 (prefix-numeric-value current-prefix-arg))))
133693bc
KH
3226 (insert (sh-feature '((bash . "$[ ")
3227 (ksh88 . "$(( ")
3228 (posix . "$(( ")
3229 (rc . "`{expr $")
3230 (sh . "`expr $")
3231 (zsh . "$[ ")))
3232 (sh-remember-variable var)
3233 (if (< delta 0) " - " " + ")
3234 (number-to-string (abs delta))
3235 (sh-feature '((bash . " ]")
3236 (ksh88 . " ))")
3237 (posix . " ))")
3238 (rc . "}")
3239 (sh . "`")
3240 (zsh . " ]")))))
3241
3242
3243
3244(define-skeleton sh-function
3245 "Insert a function definition. See `sh-feature'."
3246 (bash eval sh-modify ksh88
3247 3 "() {")
3248 (ksh88 "name: "
3249 "function " str " {" \n
3250 > _ \n
3e2dd647 3251 < "}" \n)
133693bc 3252 (rc eval sh-modify ksh88
6c5bcbc1 3253 1 "fn ")
ac59aed8
RS
3254 (sh ()
3255 "() {" \n
3256 > _ \n
3e2dd647 3257 < "}" \n))
ac59aed8
RS
3258
3259
3260
133693bc
KH
3261(define-skeleton sh-if
3262 "Insert an if statement. See `sh-feature'."
ac59aed8
RS
3263 (csh "condition: "
3264 "if( " str " ) then" \n
3265 > _ \n
3266 ( "other condition, %s: "
133693bc
KH
3267 < "else if( " str " ) then" \n
3268 > _ \n)
ac59aed8 3269 < "else" \n
133693bc 3270 > _ \n
ac59aed8 3271 resume:
3e2dd647 3272 < "endif" \n)
133693bc 3273 (es "condition: "
6c5bcbc1
SM
3274 > "if { " str " } {" \n
3275 > _ \n
3276 ( "other condition, %s: "
3277 "} { " str " } {" > \n
3278 > _ \n)
3279 "} {" > \n
3280 > _ \n
3281 resume:
035107fa 3282 ?\} > \n)
f964dfcb 3283 (rc "condition: "
6c5bcbc1
SM
3284 > "if( " str " ) {" \n
3285 > _ \n
3286 ( "other condition, %s: "
3287 "} else if( " str " ) {" > \n
3288 > _ \n)
3289 "} else {" > \n
3290 > _ \n
3291 resume:
035107fa 3292 ?\} > \n)
133693bc 3293 (sh "condition: "
225f6185 3294 '(setq input (sh-feature sh-test))
f964dfcb 3295 > "if " str "; then" \n
133693bc
KH
3296 > _ \n
3297 ( "other condition, %s: "
6c5bcbc1 3298 > "elif " str "; then" > \n
8f0b0ca5 3299 > \n)
6c5bcbc1 3300 "else" > \n
f964dfcb 3301 > \n
133693bc 3302 resume:
3e2dd647 3303 "fi" > \n))
ac59aed8
RS
3304
3305
3306
133693bc
KH
3307(define-skeleton sh-repeat
3308 "Insert a repeat loop definition. See `sh-feature'."
3309 (es nil
f964dfcb 3310 > "forever {" \n
133693bc 3311 > _ \n
035107fa 3312 ?\} > \n)
133693bc 3313 (zsh "factor: "
f964dfcb 3314 > "repeat " str "; do" > \n
6c5bcbc1 3315 > \n
3e2dd647 3316 "done" > \n))
f964dfcb 3317
ea39159e 3318;;;(put 'sh-repeat 'menu-enable '(sh-feature sh-repeat))
133693bc
KH
3319
3320
3321
3322(define-skeleton sh-select
3323 "Insert a select statement. See `sh-feature'."
3324 (ksh88 "Index variable: "
f964dfcb 3325 > "select " str " in " _ "; do" \n
133693bc 3326 > ?$ str \n
3e2dd647 3327 "done" > \n)
aace6150 3328 (bash eval sh-append ksh88))
ea39159e 3329;;;(put 'sh-select 'menu-enable '(sh-feature sh-select))
133693bc
KH
3330
3331
3332
3333(define-skeleton sh-tmp-file
3334 "Insert code to setup temporary file handling. See `sh-feature'."
3335 (bash eval identity ksh88)
3336 (csh (file-name-nondirectory (buffer-file-name))
3337 "set tmp = /tmp/" str ".$$" \n
3338 "onintr exit" \n _
3339 (and (goto-char (point-max))
3340 (not (bolp))
3341 ?\n)
3342 "exit:\n"
3e2dd647 3343 "rm $tmp* >&/dev/null" > \n)
133693bc 3344 (es (file-name-nondirectory (buffer-file-name))
f964dfcb
GM
3345 > "local( signals = $signals sighup sigint; tmp = /tmp/" str
3346 ".$pid ) {" \n
133693bc
KH
3347 > "catch @ e {" \n
3348 > "rm $tmp^* >[2]/dev/null" \n
3349 "throw $e" \n
f964dfcb 3350 "} {" > \n
6c5bcbc1 3351 _ \n
035107fa
SS
3352 ?\} > \n
3353 ?\} > \n)
133693bc 3354 (ksh88 eval sh-modify sh
f964dfcb 3355 7 "EXIT")
133693bc 3356 (rc (file-name-nondirectory (buffer-file-name))
f964dfcb 3357 > "tmp = /tmp/" str ".$pid" \n
3e2dd647 3358 "fn sigexit { rm $tmp^* >[2]/dev/null }" \n)
133693bc 3359 (sh (file-name-nondirectory (buffer-file-name))
f964dfcb 3360 > "TMP=${TMPDIR:-/tmp}/" str ".$$" \n
3e2dd647 3361 "trap \"rm $TMP* 2>/dev/null\" " ?0 \n))
ac59aed8
RS
3362
3363
3364
133693bc
KH
3365(define-skeleton sh-until
3366 "Insert an until loop. See `sh-feature'."
ac59aed8 3367 (sh "condition: "
225f6185 3368 '(setq input (sh-feature sh-test))
f964dfcb 3369 > "until " str "; do" \n
ac59aed8 3370 > _ \n
3e2dd647 3371 "done" > \n))
ea39159e 3372;;;(put 'sh-until 'menu-enable '(sh-feature sh-until))
133693bc
KH
3373
3374
3375
3376(define-skeleton sh-while
3377 "Insert a while loop. See `sh-feature'."
3378 (csh eval sh-modify sh
f964dfcb
GM
3379 2 ""
3380 3 "while( "
3381 5 " )"
3382 10 '<
b36581fb 3383 11 "end")
f964dfcb
GM
3384 (es eval sh-modify sh
3385 3 "while { "
3386 5 " } {"
035107fa 3387 10 ?\} )
f964dfcb
GM
3388 (rc eval sh-modify sh
3389 3 "while( "
3390 5 " ) {"
035107fa 3391 10 ?\} )
ac59aed8 3392 (sh "condition: "
225f6185 3393 '(setq input (sh-feature sh-test))
f964dfcb 3394 > "while " str "; do" \n
ac59aed8 3395 > _ \n
3e2dd647 3396 "done" > \n))
133693bc
KH
3397
3398
3399
3400(define-skeleton sh-while-getopts
3401 "Insert a while getopts loop. See `sh-feature'.
3402Prompts for an options string which consists of letters for each recognized
3403option followed by a colon `:' if the option accepts an argument."
3404 (bash eval sh-modify sh
3405 18 "${0##*/}")
225f6185
KH
3406 (csh nil
3407 "while( 1 )" \n
3408 > "switch( \"$1\" )" \n
3409 '(setq input '("- x" . 2))
3410 > >
3411 ( "option, %s: "
3412 < "case " '(eval str)
3413 '(if (string-match " +" str)
3414 (setq v1 (substring str (match-end 0))
3415 str (substring str 0 (match-beginning 0)))
3416 (setq v1 nil))
3417 str ?: \n
3418 > "set " v1 & " = $2" | -4 & _ \n
3419 (if v1 "shift") & \n
3420 "breaksw" \n)
3421 < "case --:" \n
3422 > "shift" \n
3423 < "default:" \n
3424 > "break" \n
3425 resume:
3426 < < "endsw" \n
3427 "shift" \n
3e2dd647 3428 < "end" \n)
133693bc
KH
3429 (ksh88 eval sh-modify sh
3430 16 "print"
3431 18 "${0##*/}"
bc387269 3432 37 "OPTIND-1")
133693bc
KH
3433 (posix eval sh-modify sh
3434 18 "$(basename $0)")
3435 (sh "optstring: "
f964dfcb 3436 > "while getopts :" str " OPT; do" \n
133693bc 3437 > "case $OPT in" \n
133693bc
KH
3438 '(setq v1 (append (vconcat str) nil))
3439 ( (prog1 (if v1 (char-to-string (car v1)))
3440 (if (eq (nth 1 v1) ?:)
3441 (setq v1 (nthcdr 2 v1)
3442 v2 "\"$OPTARG\"")
3443 (setq v1 (cdr v1)
3444 v2 nil)))
017708e9 3445 > str "|+" str sh-non-closing-paren \n
133693bc 3446 > _ v2 \n
8f0b0ca5 3447 > ";;" \n)
017708e9 3448 > "*" sh-non-closing-paren \n
133693bc 3449 > "echo" " \"usage: " "`basename $0`"
c898fb28 3450 " [+-" '(setq v1 (point)) str
133693bc
KH
3451 '(save-excursion
3452 (while (search-backward ":" v1 t)
c898fb28 3453 (replace-match " ARG] [+-" t t)))
133693bc 3454 (if (eq (preceding-char) ?-) -5)
16ed8416 3455 (if (and (sequencep v1) (length v1)) "] " "} ")
119b42eb 3456 "[--] ARGS...\"" \n
f964dfcb 3457 "exit 2" > \n
6c5bcbc1
SM
3458 "esac" >
3459 \n "done"
3460 > \n
3e2dd647 3461 "shift " (sh-add "OPTIND" -1) \n))
ac59aed8
RS
3462
3463
3464
3465(defun sh-assignment (arg)
133693bc 3466 "Remember preceding identifier for future completion and do self-insert."
ac59aed8 3467 (interactive "p")
133693bc
KH
3468 (self-insert-command arg)
3469 (if (<= arg 1)
ac59aed8
RS
3470 (sh-remember-variable
3471 (save-excursion
133693bc
KH
3472 (if (re-search-forward (sh-feature sh-assignment-regexp)
3473 (prog1 (point)
3474 (beginning-of-line 1))
3475 t)
84bfbb44 3476 (match-string 1))))))
ac59aed8
RS
3477
3478
3479
3480(defun sh-maybe-here-document (arg)
6c5bcbc1 3481 "Insert self. Without prefix, following unquoted `<' inserts here document.
ac59aed8
RS
3482The document is bounded by `sh-here-document-word'."
3483 (interactive "*P")
3484 (self-insert-command (prefix-numeric-value arg))
3485 (or arg
3486 (not (eq (char-after (- (point) 2)) last-command-char))
3487 (save-excursion
133693bc 3488 (backward-char 2)
ac59aed8
RS
3489 (sh-quoted-p))
3490 (progn
3491 (insert sh-here-document-word)
133693bc 3492 (or (eolp) (looking-at "[ \t]") (insert ? ))
ac59aed8 3493 (end-of-line 1)
133693bc
KH
3494 (while
3495 (sh-quoted-p)
3496 (end-of-line 2))
ac59aed8 3497 (newline)
18368c4a
GM
3498 (save-excursion
3499 (insert ?\n (substring
3500 sh-here-document-word
3501 (if (string-match "^-" sh-here-document-word) 1 0)))))))
ac59aed8
RS
3502
3503\f
3504;; various other commands
3505
133693bc
KH
3506(autoload 'comint-dynamic-complete "comint"
3507 "Dynamically perform completion at point." t)
3508
3509(autoload 'shell-dynamic-complete-command "shell"
3510 "Dynamically complete the command at point." t)
3511
ac59aed8
RS
3512(autoload 'comint-dynamic-complete-filename "comint"
3513 "Dynamically complete the filename at point." t)
3514
133693bc
KH
3515(autoload 'shell-dynamic-complete-environment-variable "shell"
3516 "Dynamically complete the environment variable at point." t)
3517
ac59aed8
RS
3518
3519
cd76025c
KH
3520(defun sh-newline-and-indent ()
3521 "Strip unquoted whitespace, insert newline, and indent like current line."
3522 (interactive "*")
3523 (indent-to (prog1 (current-indentation)
3524 (delete-region (point)
3525 (progn
3526 (or (zerop (skip-chars-backward " \t"))
3527 (if (sh-quoted-p)
3528 (forward-char)))
3529 (point)))
3530 (newline))))
ac59aed8 3531
ac59aed8
RS
3532(defun sh-beginning-of-command ()
3533 "Move point to successive beginnings of commands."
3534 (interactive)
3535 (if (re-search-backward sh-beginning-of-command nil t)
3536 (goto-char (match-beginning 2))))
3537
ac59aed8
RS
3538(defun sh-end-of-command ()
3539 "Move point to successive ends of commands."
3540 (interactive)
3541 (if (re-search-forward sh-end-of-command nil t)
3542 (goto-char (match-end 1))))
3543
f7c7053e 3544(provide 'sh-script)
43c89a96 3545
ab5796a9 3546;;; arch-tag: eccd8b72-f337-4fc2-ae86-18155a69d937
f964dfcb 3547;;; sh-script.el ends here