1 ;;; tcl.el --- Tcl code editing commands for Emacs
3 ;; Copyright (C) 1994, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
4 ;; 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
7 ;; Author: Tom Tromey <tromey@redhat.com>
8 ;; Chris Lindblad <cjl@lcs.mit.edu>
9 ;; Keywords: languages tcl modes
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; If you plan to use the interface to the TclX help files, you must
29 ;; set the variable tcl-help-directory-list to point to the topmost
30 ;; directories containing the TclX help files. Eg:
32 ;; (setq tcl-help-directory-list '("/usr/local/lib/tclx/help"))
36 ;; CUSTOMIZATION NOTES:
37 ;; * tcl-proc-list can be used to customize a list of things that
38 ;; "define" other things. Eg in my project I put "defvar" in this
40 ;; * tcl-typeword-list is similar, but uses font-lock-type-face.
41 ;; * tcl-keyword-list is a list of keywords. I've generally used this
42 ;; for flow-control words. Eg I add "unwind_protect" to this list.
43 ;; * tcl-builtin-list lists commands to be given font-lock-builtin-face.
44 ;; * tcl-type-alist can be used to minimally customize indentation
45 ;; according to context.
47 ;; THANKS FOR CRITICISM AND SUGGESTIONS TO:
48 ;; Guido Bosch <Guido.Bosch@loria.fr>
49 ;; pgs1002@esc.cam.ac.uk (Dr P.G. Sjoerdsma)
50 ;; Mike Scheidler <c23mts@kocrsv01.delcoelect.com>
51 ;; Matt Newman <men@charney.colorado.edu>
52 ;; rwhitby@research.canon.oz.au (Rod Whitby)
53 ;; h9118101@hkuxa.hku.hk (Yip Chi Lap [Beta])
54 ;; Pertti Tapio Kasanen <ptk@delta.hut.fi>
55 ;; schmid@fb3-s7.math.TU-Berlin.DE (Gregor Schmid)
56 ;; warsaw@nlm.nih.gov (Barry A. Warsaw)
57 ;; Carl Witty <cwitty@ai.mit.edu>
58 ;; T. V. Raman <raman@crl.dec.com>
59 ;; Jesper Pedersen <blackie@imada.ou.dk>
60 ;; dfarmer@evolving.com (Doug Farmer)
61 ;; "Chris Alfeld" <calfeld@math.utah.edu>
62 ;; Ben Wing <ben@xemacs.org>
65 ;; * In Tcl "#" is not always a comment character. This can confuse tcl.el
66 ;; in certain circumstances. For now the only workaround is to use
67 ;; font-lock which will mark the # chars accordingly or enclose offending
68 ;; hash characters in quotes or precede them with a backslash. Note that
69 ;; using braces won't work -- quotes change the syntax class of characters
70 ;; between them, while braces do not. If you don't use font-lock, the
71 ;; electric-# mode helps alleviate this problem somewhat.
72 ;; * indent-tcl-exp is untested.
75 ;; * make add-log-tcl-defun smarter. should notice if we are in the
76 ;; middle of a defun, or between defuns. should notice if point is
77 ;; on first line of defun (or maybe even in comments before defun).
78 ;; * Allow continuation lines to be indented under the first argument
79 ;; of the preceding line, like this:
82 ;; * There is a request that indentation work like this:
83 ;; button .fred -label Fred \
84 ;; -command {puts fred}
85 ;; * Should have tcl-complete-symbol that queries the inferior process.
86 ;; * Should have describe-symbol that works by sending the magic
87 ;; command to a tclX process.
88 ;; * Need C-x C-e binding (tcl-eval-last-exp).
89 ;; * Write indent-region function that is faster than indenting each
91 ;; * tcl-figure-type should stop at "beginning of line" (only ws
92 ;; before point, and no "\" on previous line). (see tcl-real-command-p).
93 ;; * overrides some comint keybindings; fix.
94 ;; * Trailing \ will eat blank lines. Should deal with this.
95 ;; (this would help catch some potential bugs).
96 ;; * Inferior should display in half the screen, not the whole screen.
97 ;; * Indentation should deal with "switch".
98 ;; * Consider writing code to find help files automatically (for
100 ;; * `#' shouldn't insert `\#' when point is in string.
119 "Major mode for editing Tcl source in Emacs."
120 :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
123 (defcustom tcl-indent-level 4
124 "*Indentation of Tcl statements with respect to containing block."
127 (put 'tcl-indent-level 'safe-local-variable 'integerp)
129 (defcustom tcl-continued-indent-level 4
130 "*Indentation of continuation line relative to first line of command."
133 (put 'tcl-continued-indent-level 'safe-local-variable 'integerp)
135 (defcustom tcl-auto-newline nil
136 "*Non-nil means automatically newline before and after braces you insert."
140 (defcustom tcl-tab-always-indent tab-always-indent
141 "*Control effect of TAB key.
142 If t (the default), always indent current line.
143 If nil and point is not in the indentation area at the beginning of
144 the line, a TAB is inserted.
145 Other values cause the first possible action from the following list
148 1. Move from beginning of line to correct indentation.
149 2. Delete an empty comment.
150 3. Move forward to start of comment, indenting if necessary.
151 4. Move forward to end of line, indenting if necessary.
152 5. Create an empty comment.
153 6. Move backward to start of comment, indenting if necessary."
154 :type '(choice (const :tag "Always" t)
155 (const :tag "Beginning only" nil)
156 (const :tag "Maybe move or make or delete comment" 'tcl))
160 (defcustom tcl-electric-hash-style nil ;; 'smart
161 "*Style of electric hash insertion to use.
162 Possible values are `backslash', meaning that `\\' quoting should be
163 done; `quote', meaning that `\"' quoting should be done; `smart',
164 meaning that the choice between `backslash' and `quote' should be
165 made depending on the number of hashes inserted; or nil, meaning that
166 no quoting should be done. Any other value for this variable is
167 taken to mean `smart'. The default is nil."
168 :type '(choice (const backslash) (const quote) (const smart) (const nil))
171 (defcustom tcl-help-directory-list nil
172 "*List of topmost directories containing TclX help files."
173 :type '(repeat directory)
176 (defcustom tcl-use-smart-word-finder t
177 "*If not nil, use smart way to find current word, for Tcl help feature."
181 (defcustom tcl-application "wish"
182 "*Name of Tcl program to run in inferior Tcl mode."
186 (defcustom tcl-command-switches nil
187 "*List of switches to supply to the `tcl-application' program."
188 :type '(repeat string)
191 (defcustom tcl-prompt-regexp "^\\(% \\|\\)"
192 "*If not nil, a regexp that will match the prompt in the inferior process.
193 If nil, the prompt is the name of the application with \">\" appended.
195 The default is \"^\\(% \\|\\)\", which will match the default primary
196 and secondary prompts for tclsh and wish."
200 (defcustom inferior-tcl-source-command "source %s\n"
201 "*Format-string for building a Tcl command to load a file.
202 This format string should use `%s' to substitute a file name
203 and should result in a Tcl expression that will command the
204 inferior Tcl to load that file. The filename will be appropriately
209 (defface tcl-escaped-newline '((t :inherit font-lock-string-face))
210 "Face used for (non-escaped) backslash at end of a line in Tcl mode."
215 ;; Keymaps, abbrevs, syntax tables.
219 (let ((map (make-sparse-keymap)))
220 (define-key map "{" 'tcl-electric-char)
221 (define-key map "}" 'tcl-electric-brace)
222 (define-key map "[" 'tcl-electric-char)
223 (define-key map "]" 'tcl-electric-char)
224 (define-key map ";" 'tcl-electric-char)
225 (define-key map "#" 'tcl-electric-hash) ;Remove? -stef
226 (define-key map "\e\C-q" 'tcl-indent-exp)
227 (define-key map "\177" 'backward-delete-char-untabify)
228 (define-key map "\t" 'tcl-indent-command)
229 (define-key map "\M-\C-x" 'tcl-eval-defun)
230 (define-key map "\C-c\C-i" 'tcl-help-on-word)
231 (define-key map "\C-c\C-v" 'tcl-eval-defun)
232 (define-key map "\C-c\C-f" 'tcl-load-file)
233 (define-key map "\C-c\C-t" 'inferior-tcl)
234 (define-key map "\C-c\C-x" 'tcl-eval-region)
235 (define-key map "\C-c\C-s" 'switch-to-tcl)
237 "Keymap used in `tcl-mode'.")
239 (defvar tcl-mode-syntax-table
240 (let ((st (make-syntax-table)))
241 (modify-syntax-entry ?% "_" st)
242 (modify-syntax-entry ?@ "_" st)
243 (modify-syntax-entry ?& "_" st)
244 (modify-syntax-entry ?* "_" st)
245 (modify-syntax-entry ?+ "_" st)
246 (modify-syntax-entry ?- "_" st)
247 (modify-syntax-entry ?. "_" st)
248 (modify-syntax-entry ?: "_" st)
249 (modify-syntax-entry ?! "_" st)
250 (modify-syntax-entry ?$ "_" st) ; FIXME use "'"?
251 (modify-syntax-entry ?/ "_" st)
252 (modify-syntax-entry ?~ "_" st)
253 (modify-syntax-entry ?< "_" st)
254 (modify-syntax-entry ?= "_" st)
255 (modify-syntax-entry ?> "_" st)
256 (modify-syntax-entry ?| "_" st)
257 (modify-syntax-entry ?\( "()" st)
258 (modify-syntax-entry ?\) ")(" st)
259 (modify-syntax-entry ?\; "." st)
260 (modify-syntax-entry ?\n ">" st)
261 ;; (modify-syntax-entry ?\f ">" st)
262 (modify-syntax-entry ?# "<" st)
264 "Syntax table in use in `tcl-mode' buffers.")
266 (defvar inferior-tcl-mode-map
267 ;; FIXME we override comint keybindings here.
268 ;; Maybe someone has a better set?
269 (let ((map (make-sparse-keymap)))
270 ;; Will inherit from `comint-mode-map' thanks to define-derived-mode.
271 (define-key map "\t" 'comint-dynamic-complete)
272 (define-key map "\M-?" 'comint-dynamic-list-filename-completions)
273 (define-key map "\177" 'backward-delete-char-untabify)
274 (define-key map "\M-\C-x" 'tcl-eval-defun)
275 (define-key map "\C-c\C-i" 'tcl-help-on-word)
276 (define-key map "\C-c\C-v" 'tcl-eval-defun)
277 (define-key map "\C-c\C-f" 'tcl-load-file)
278 (define-key map "\C-c\C-t" 'inferior-tcl)
279 (define-key map "\C-c\C-x" 'tcl-eval-region)
280 (define-key map "\C-c\C-s" 'switch-to-tcl)
282 "Keymap used in `inferior-tcl-mode'.")
284 (easy-menu-define tcl-mode-menu tcl-mode-map "Menu used in `tcl-mode'."
286 ["Beginning of function" beginning-of-defun t]
287 ["End of function" end-of-defun t]
288 ["Mark function" mark-defun t]
289 ["Indent region" indent-region (mark t)]
290 ["Comment region" comment-region (mark t)]
291 ["Uncomment region" uncomment-region (mark t)]
293 ["Show Tcl process buffer" inferior-tcl t]
294 ["Send function to Tcl process" tcl-eval-defun
295 (and inferior-tcl-buffer (get-buffer inferior-tcl-buffer))]
296 ["Send region to Tcl process" tcl-eval-region
297 (and inferior-tcl-buffer (get-buffer inferior-tcl-buffer))]
298 ["Send file to Tcl process" tcl-load-file
299 (and inferior-tcl-buffer (get-buffer inferior-tcl-buffer))]
300 ["Restart Tcl process with file" tcl-restart-with-file t]
302 ["Tcl help" tcl-help-on-word tcl-help-directory-list]))
304 (defvar inferior-tcl-buffer nil
305 "*The current inferior-tcl process buffer.
307 MULTIPLE PROCESS SUPPORT
308 ===========================================================================
309 To run multiple Tcl processes, you start the first up with
310 \\[inferior-tcl]. It will be in a buffer named `*inferior-tcl*'.
311 Rename this buffer with \\[rename-buffer]. You may now start up a new
312 process with another \\[inferior-tcl]. It will be in a new buffer,
313 named `*inferior-tcl*'. You can switch between the different process
314 buffers with \\[switch-to-buffer].
316 Commands that send text from source buffers to Tcl processes -- like
317 `tcl-eval-defun' or `tcl-load-file' -- have to choose a process to
318 send to, when you have more than one Tcl process around. This is
319 determined by the global variable `inferior-tcl-buffer'. Suppose you
320 have three inferior Lisps running:
324 *inferior-tcl* inferior-tcl<3>
325 If you do a \\[tcl-eval-defun] command on some Lisp source code, what
326 process do you send it to?
328 - If you're in a process buffer (foo, bar, or *inferior-tcl*),
329 you send it to that process.
330 - If you're in some other buffer (e.g., a source file), you
331 send it to the process attached to buffer `inferior-tcl-buffer'.
332 This process selection is performed by function `inferior-tcl-proc'.
334 Whenever \\[inferior-tcl] fires up a new process, it resets
335 `inferior-tcl-buffer' to be the new process's buffer. If you only run
336 one process, this does the right thing. If you run multiple
337 processes, you can change `inferior-tcl-buffer' to another process
338 buffer with \\[set-variable].")
341 ;; Hooks and other customization.
344 (defvar tcl-mode-hook nil
345 "Hook run on entry to Tcl mode.
347 Several functions exist which are useful to run from your
348 `tcl-mode-hook' (see each function's documentation for more
351 `tcl-guess-application'
352 Guesses a default setting for `tcl-application' based on any
353 \"#!\" line at the top of the file.
355 Quotes all \"#\" characters that don't correspond to actual
356 Tcl comments. (Useful when editing code not originally created
359 Auto-filling of Tcl comments.
361 Add functions to the hook with `add-hook':
363 (add-hook 'tcl-mode-hook 'tcl-guess-application)")
366 (defvar tcl-proc-list
367 '("proc" "method" "itcl_class" "body" "configbody" "class")
368 "List of commands whose first argument defines something.
369 This exists because some people (eg, me) use `defvar' et al.
370 Call `tcl-set-proc-regexp' and `tcl-set-font-lock-keywords'
371 after changing this list.")
373 (defvar tcl-proc-regexp nil
374 "Regexp to use when matching proc headers.")
376 (defvar tcl-typeword-list
377 '("global" "upvar" "inherit" "public" "protected" "private"
378 "common" "itk_option" "variable")
379 "List of Tcl keywords denoting \"type\". Used only for highlighting.
380 Call `tcl-set-font-lock-keywords' after changing this list.")
382 ;; Generally I've picked control operators to be keywords.
383 (defvar tcl-keyword-list
384 '("if" "then" "else" "elseif" "for" "foreach" "break" "continue" "while"
385 "eval" "case" "in" "switch" "default" "exit" "error" "proc" "return"
386 "uplevel" "constructor" "destructor" "itcl_class" "loop" "for_array_keys"
387 "for_recursive_glob" "for_file" "method" "body" "configbody" "class"
389 "List of Tcl keywords. Used only for highlighting.
390 Default list includes some TclX keywords.
391 Call `tcl-set-font-lock-keywords' after changing this list.")
393 (defvar tcl-builtin-list
394 '("after" "append" "array" "bgerror" "binary" "catch" "cd" "clock"
395 "close" "concat" "console" "dde" "encoding" "eof" "exec" "expr"
396 "fblocked" "fconfigure" "fcopy" "file" "fileevent" "flush"
397 "format" "gets" "glob" "history" "incr" "info" "interp" "join"
398 "lappend" "lindex" "linsert" "list" "llength" "load" "lrange"
399 "lreplace" "lsort" "namespace" "open" "package" "pid" "puts" "pwd"
400 "read" "regexp" "registry" "regsub" "rename" "scan" "seek" "set"
401 "socket" "source" "split" "string" "subst" "tell" "time" "trace"
402 "unknown" "unset" "vwait")
403 "List of Tcl commands. Used only for highlighting.
404 Call `tcl-set-font-lock-keywords' after changing this list.
405 This list excludes those commands already found in `tcl-proc-list' and
406 `tcl-keyword-list'.")
408 (defvar tcl-font-lock-keywords nil
409 "Keywords to highlight for Tcl. See variable `font-lock-keywords'.
410 This variable is generally set from `tcl-proc-regexp',
411 `tcl-typeword-list', and `tcl-keyword-list' by the function
412 `tcl-set-font-lock-keywords'.")
414 (defconst tcl-syntax-propertize-function
415 (syntax-propertize-rules
416 ;; Mark the few `#' that are not comment-markers.
417 ("[^;[{ \t\n][ \t]*\\(#\\)" (1 ".")))
418 "Syntactic keywords for `tcl-mode'.")
420 ;; FIXME need some way to recognize variables because array refs look
422 (defvar tcl-type-alist
423 '(("proc" nil tcl-expr tcl-commands)
424 ("method" nil tcl-expr tcl-commands)
425 ("destructor" tcl-commands)
426 ("constructor" tcl-commands)
428 ("catch" tcl-commands)
429 ("if" tcl-expr "then" tcl-commands)
430 ("elseif" tcl-expr "then" tcl-commands)
431 ("elseif" tcl-expr tcl-commands)
432 ("if" tcl-expr tcl-commands)
433 ("while" tcl-expr tcl-commands)
434 ("for" tcl-commands tcl-expr tcl-commands tcl-commands)
435 ("foreach" nil nil tcl-commands)
436 ("for_file" nil nil tcl-commands)
437 ("for_array_keys" nil nil tcl-commands)
438 ("for_recursive_glob" nil nil nil tcl-commands)
439 ;; Loop handling is not perfect, because the third argument can be
440 ;; either a command or an expr, and there is no real way to look
442 ("loop" nil tcl-expr tcl-expr tcl-commands)
443 ("loop" nil tcl-expr tcl-commands))
444 "Alist that controls indentation.
445 \(Actually, this really only controls what happens on continuation lines).
446 Each entry looks like `(KEYWORD TYPE ...)'.
447 Each type entry describes a sexp after the keyword, and can be one of:
448 * nil, meaning that this sexp has no particular type.
449 * tcl-expr, meaning that this sexp is an arithmetic expression.
450 * tcl-commands, meaning that this sexp holds Tcl commands.
451 * a string, which must exactly match the string at the corresponding
452 position for a match to be made.
454 For example, the entry for the \"loop\" command is:
456 (\"loop\" nil tcl-expr tcl-commands)
458 This means that the \"loop\" command has three arguments. The first
459 argument is ignored (for indentation purposes). The second argument
460 is a Tcl expression, and the last argument is Tcl commands.")
462 (defvar tcl-explain-indentation nil
463 "If non-nil, debugging message will be printed during indentation.")
467 ;; Here's another stab. I think this one actually works.
468 ;; We have to be careful that the open-brace following this regexp
469 ;; is indeed the one corresponding to the function's body so
470 ;; that end-of-defun works correctly. Tricky cases are:
471 ;; proc foo { {arg1 def} arg2 } {
473 ;; proc foo { \n {arg1 def} \n arg2 } {
474 ;; The current setting handles the first case properly but not the second.
475 ;; It also fails if `proc' is not in column-0 (e.g. it's in a namespace).
476 (defconst tcl-omit-ws-regexp "^[^]\" \t\n#}][^\n\"#]+[ \t]+")
481 ;; Some helper functions.
484 (defun tcl-set-proc-regexp ()
485 "Set `tcl-proc-regexp' from variable `tcl-proc-list'."
486 (setq tcl-proc-regexp
487 (concat "^\\s-*" (regexp-opt tcl-proc-list t) "[ \t]+")))
489 (defun tcl-set-font-lock-keywords ()
490 "Set `tcl-font-lock-keywords'.
491 Uses variables `tcl-proc-regexp' and `tcl-keyword-list'."
492 (setq tcl-font-lock-keywords
494 ;; Names of functions (and other "defining things").
495 (list (concat tcl-proc-regexp "\\([^ \t\n]+\\)")
496 2 'font-lock-function-name-face)
498 ;; Names of type-defining things.
499 (list (concat "\\(\\s-\\|^\\)"
500 (regexp-opt tcl-typeword-list t)
502 2 'font-lock-type-face)
504 (list (concat "\\_<" (regexp-opt tcl-builtin-list t) "\\_>")
505 1 'font-lock-builtin-face)
507 ;; When variable names are enclosed in {} braces, any
508 ;; character can be used. Otherwise just letters, digits,
509 ;; underscores. Variable names can be prefixed with any
510 ;; number of "namespace::" qualifiers. A leading "::" refers
511 ;; to the global namespace.
512 '("\\${\\([^}]+\\)}" 1 font-lock-variable-name-face)
513 '("\\$\\(\\(?:::\\)?\\(?:[[:alnum:]_]+::\\)*[[:alnum:]_]+\\)"
514 1 font-lock-variable-name-face)
515 '("\\(?:\\s-\\|^\\|\\[\\)set\\s-+{\\([^}]+\\)}"
516 1 font-lock-variable-name-face keep)
517 '("\\(?:\\s-\\|^\\|\\[\\)set\\s-+\\(\\(?:::\\)?\
518 \\(?:[[:alnum:]_]+::\\)*[[:alnum:]_]+\\)"
519 1 font-lock-variable-name-face keep)
521 '("\\(^\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\\\)$" 3 'tcl-escaped-newline)
523 ;; Keywords. Only recognized if surrounded by whitespace.
524 ;; FIXME consider using "not word or symbol", not
526 (cons (concat "\\_<" (regexp-opt tcl-keyword-list t) "\\_>")
531 (tcl-set-proc-regexp))
533 (if tcl-font-lock-keywords
535 (tcl-set-font-lock-keywords))
538 (defvar tcl-imenu-generic-expression
539 `((nil ,(concat tcl-proc-regexp "\\([-A-Za-z0-9_:+*]+\\)") 2))
540 "Imenu generic expression for `tcl-mode'. See `imenu-generic-expression'.")
549 (define-derived-mode tcl-mode prog-mode "Tcl"
550 "Major mode for editing Tcl code.
551 Expression and list commands understand all Tcl brackets.
552 Tab indents for Tcl code.
553 Paragraphs are separated by blank lines only.
554 Delete converts tabs to spaces as it moves back.
556 Variables controlling indentation style:
558 Indentation of Tcl statements within surrounding block.
559 `tcl-continued-indent-level'
560 Indentation of continuation line relative to first line of command.
562 Variables controlling user interaction with mode (see variable
563 documentation for details):
564 `tcl-tab-always-indent'
565 Controls action of TAB key.
567 Non-nil means automatically newline before and after braces, brackets,
568 and semicolons inserted in Tcl code.
569 `tcl-use-smart-word-finder'
570 If not nil, use a smarter, Tcl-specific way to find the current
571 word when looking up help on a Tcl command.
573 Turning on Tcl mode runs `tcl-mode-hook'. Read the documentation for
574 `tcl-mode-hook' to see what kinds of interesting hook functions
579 (unless (and (boundp 'filladapt-mode) filladapt-mode)
580 (set (make-local-variable 'paragraph-ignore-fill-prefix) t))
582 (set (make-local-variable 'indent-line-function) 'tcl-indent-line)
583 (set (make-local-variable 'comment-indent-function) 'tcl-comment-indent)
584 ;; Tcl doesn't require a final newline.
585 ;; (make-local-variable 'require-final-newline)
586 ;; (setq require-final-newline t)
588 (set (make-local-variable 'comment-start) "# ")
589 (set (make-local-variable 'comment-start-skip)
590 "\\(\\(^\\|[;{[]\\)\\s-*\\)#+ *")
591 (set (make-local-variable 'comment-end) "")
593 (set (make-local-variable 'outline-regexp) ".")
594 (set (make-local-variable 'outline-level) 'tcl-outline-level)
596 (set (make-local-variable 'font-lock-defaults)
597 '(tcl-font-lock-keywords nil nil nil beginning-of-defun))
598 (set (make-local-variable 'syntax-propertize-function)
599 tcl-syntax-propertize-function)
601 (set (make-local-variable 'imenu-generic-expression)
602 tcl-imenu-generic-expression)
604 ;; Settings for new dabbrev code.
605 (set (make-local-variable 'dabbrev-case-fold-search) nil)
606 (set (make-local-variable 'dabbrev-case-replace) nil)
607 (set (make-local-variable 'dabbrev-abbrev-skip-leading-regexp) "[$!]")
608 (set (make-local-variable 'dabbrev-abbrev-char-regexp) "\\sw\\|\\s_")
610 ;; This can only be set to t in Emacs 19 and XEmacs.
611 ;; Emacs 18 and Epoch lose.
612 (set (make-local-variable 'parse-sexp-ignore-comments) t)
613 ;; XEmacs has defun-prompt-regexp, but I don't believe
614 ;; that it works for end-of-defun -- only for
615 ;; beginning-of-defun.
616 (set (make-local-variable 'defun-prompt-regexp) tcl-omit-ws-regexp)
617 ;; The following doesn't work in Lucid Emacs 19.6, but maybe
618 ;; it will appear in later versions.
619 (set (make-local-variable 'add-log-current-defun-function)
622 (easy-menu-add tcl-mode-menu)
623 ;; Append Tcl menu to popup menu for XEmacs.
624 (if (boundp 'mode-popup-menu)
625 (setq mode-popup-menu
626 (cons (concat mode-name " Mode Commands") tcl-mode-menu))))
630 ;; This is used for braces, brackets, and semi (except for closing
631 ;; braces, which are handled specially).
632 (defun tcl-electric-char (arg)
633 "Insert character and correct line's indentation."
635 ;; Indent line first; this looks better if parens blink.
637 (self-insert-command arg)
638 (if (and tcl-auto-newline (= last-command-event ?\;))
643 ;; This is used for closing braces. If tcl-auto-newline is set, can
644 ;; insert a newline both before and after the brace, depending on
645 ;; context. FIXME should this be configurable? Does anyone use this?
646 (defun tcl-electric-brace (arg)
647 "Insert character and correct line's indentation."
649 ;; If auto-newlining and there is stuff on the same line, insert a
654 (skip-chars-backward " \t")
659 ;; In auto-newline case, must insert a newline after each
660 ;; brace. So an explicit loop is needed.
662 (insert last-command-event)
665 (setq arg (1- arg))))
666 (self-insert-command arg))
671 (defun tcl-indent-command (&optional arg)
672 "Indent current line as Tcl code, or in some cases insert a tab character.
673 If `tcl-tab-always-indent' is t (the default), always indent current line.
674 If `tcl-tab-always-indent' is nil and point is not in the indentation
675 area at the beginning of the line, a TAB is inserted.
676 Other values of `tcl-tab-always-indent' cause the first possible action
677 from the following list to take place:
679 1. Move from beginning of line to correct indentation.
680 2. Delete an empty comment.
681 3. Move forward to start of comment, indenting if necessary.
682 4. Move forward to end of line, indenting if necessary.
683 5. Create an empty comment.
684 6. Move backward to start of comment, indenting if necessary."
686 (if (memq tcl-tab-always-indent '(nil t))
687 (let ((tab-always-indent tcl-tab-always-indent))
688 (call-interactively 'indent-for-tab-command))
689 ;; "Perl-mode" style TAB command.
690 (let* ((ipoint (point))
694 (comment-p (tcl-in-comment)))
696 ((= ipoint (line-beginning-position))
699 ;; If indenting didn't leave us in column 0, go to the
700 ;; indentation. Otherwise leave point at end of line. This
702 (if (= (point) (line-beginning-position))
704 (back-to-indentation)))
705 ((and comment-p (looking-at "[ \t]*$"))
706 ;; Empty comment, so delete it. We also delete any ";"
707 ;; characters at the end of the line. I think this is
708 ;; friendlier, but I don't know how other people will feel.
710 (skip-chars-backward " \t;")
711 (delete-region (point) eolpoint))
712 ((and comment-p (< ipoint (point)))
713 ;; Before comment, so skip to it.
715 (indent-for-comment))
716 ((/= ipoint eolpoint)
717 ;; Go to end of line (since we're not there yet).
724 ;; Go to start of comment. We don't leave point where it is
725 ;; because we want to skip comment-start-skip.
727 (indent-for-comment))))))
729 (defun tcl-indent-line ()
730 "Indent current line as Tcl code.
731 Return the amount the indentation changed by."
732 (let ((indent (tcl-calculate-indent nil))
734 (case-fold-search nil)
735 (pos (- (point-max) (point))))
740 (skip-chars-forward " \t")
741 (if (listp indent) (setq indent (car indent)))
742 (cond ((= (following-char) ?})
743 (setq indent (- indent tcl-indent-level)))
744 ((= (following-char) ?\])
745 (setq indent (- indent 1))))
746 (skip-chars-forward " \t")
747 (setq shift-amt (- indent (current-column)))
748 (if (zerop shift-amt)
749 (if (> (- (point-max) pos) (point))
750 (goto-char (- (point-max) pos)))
751 (delete-region beg (point))
753 ;; If initial point was within line's indentation,
754 ;; position after the indentation. Else stay at same point in text.
755 (if (> (- (point-max) pos) (point))
756 (goto-char (- (point-max) pos))))
759 (defun tcl-figure-type ()
760 "Determine type of sexp at point.
761 This is either `tcl-expr', `tcl-commands', or nil. Puts point at start
762 of sexp that indicates types.
764 See documentation for variable `tcl-type-alist' for more information."
768 (while (and (< count 5)
772 ;; FIXME should use "tcl-backward-sexp", which would skip
773 ;; over entire variables, etc.
775 (if (looking-at "[a-zA-Z_]+")
776 (let ((list tcl-type-alist)
778 (setq word-stack (cons (tcl-word-no-props) word-stack))
779 (while (and list (not result))
780 (setq entry (car list))
781 (setq list (cdr list))
783 (while (and entry (<= index count))
784 ;; Abort loop if string does not match word on
786 (and (stringp (car entry))
787 (not (string= (car entry)
788 (nth index word-stack)))
790 (setq entry (cdr entry))
791 (setq index (1+ index)))
793 (not (stringp (car entry)))
794 (setq result (car entry)))
796 (setq word-stack (cons nil word-stack))))
798 (setq count (1+ count)))
799 (and tcl-explain-indentation
800 (message "Indentation type %s" result))
803 (defun tcl-calculate-indent (&optional parse-start)
804 "Return appropriate indentation for current line as Tcl code.
805 In usual case returns an integer: the column to indent to.
806 Returns nil if line starts inside a string, t if in a comment."
809 (let* ((indent-point (point))
810 (case-fold-search nil)
816 (= ?\\ (preceding-char)))))
817 (continued-indent-value (if continued-line
818 tcl-continued-indent-level
824 (goto-char parse-start)
825 (beginning-of-defun))
826 (while (< (point) indent-point)
827 (setq parse-start (point))
828 (setq state (parse-partial-sexp (point) indent-point 0))
829 (setq containing-sexp (car (cdr state))))
830 (cond ((or (nth 3 state) (nth 4 state))
831 ;; Inside comment or string. Return nil or t if should
832 ;; not change this line
834 ((null containing-sexp)
835 ;; Line is at top level.
836 continued-indent-value)
838 ;; Set expr-p if we are looking at the expression part of
839 ;; an "if", "expr", etc statement. Set commands-p if we
840 ;; are looking at the body part of an if, while, etc
841 ;; statement. FIXME Should check for "for" loops here.
842 (goto-char containing-sexp)
843 (let* ((sexpr-type (tcl-figure-type))
844 (expr-p (eq sexpr-type 'tcl-expr))
845 (commands-p (eq sexpr-type 'tcl-commands))
846 (expr-start (point)))
847 ;; Find the first statement in the block and indent
848 ;; like it. The first statement in the block might be
849 ;; on the same line, so what we do is skip all
850 ;; "virtually blank" lines, looking for a non-blank
851 ;; one. A line is virtually blank if it only contains
852 ;; a comment and whitespace. FIXME continued comments
853 ;; aren't supported. They are a wart on Tcl anyway.
854 ;; We do it this funky way because we want to know if
855 ;; we've found a statement on some line _after_ the
856 ;; line holding the sexp opener.
857 (goto-char containing-sexp)
859 (if (and (< (point) indent-point)
860 (looking-at "[ \t]*\\(#.*\\)?$"))
863 (while (and (< (point) indent-point)
864 (looking-at "[ \t]*\\(#.*\\)?$"))
865 (setq found-next-line t)
867 (if (or continued-line
868 (/= (char-after containing-sexp) ?{)
871 ;; Line is continuation line, or the sexp opener
872 ;; is not a curly brace, or we are are looking at
873 ;; an `expr' expression (which must be split
874 ;; specially). So indentation is column of first
875 ;; good spot after sexp opener (with some added
876 ;; in the continued-line case). If there is no
877 ;; nonempty line before the indentation point, we
878 ;; use the column of the character after the sexp
880 (if (>= (point) indent-point)
882 (goto-char containing-sexp)
884 (skip-chars-forward " \t"))
885 (+ (current-column) continued-indent-value))
886 ;; After a curly brace, and not a continuation line.
887 ;; So take indentation from first good line after
888 ;; start of block, unless that line is on the same
889 ;; line as the opening brace. In this case use the
890 ;; indentation of the opening brace's line, plus
891 ;; another indent step. If we are in the body part
892 ;; of an "if" or "while" then the indentation is
893 ;; taken from the line holding the start of the
895 (if (and (< (point) indent-point)
897 (current-indentation)
899 (goto-char expr-start)
900 (goto-char containing-sexp))
901 (+ (current-indentation) tcl-indent-level)))))))))
905 (defun tcl-indent-exp ()
906 "Indent each line of the Tcl grouping following point."
908 (let ((indent-stack (list nil))
909 (contain-stack (list (point)))
910 (case-fold-search nil)
911 outer-loop-done inner-loop-done state ostate
912 this-indent continued-line
918 (setq outer-loop-done nil)
919 (while (and (not (eobp)) (not outer-loop-done))
920 (setq last-depth next-depth)
921 ;; Compute how depth changes over this line
922 ;; plus enough other lines to get to one that
923 ;; does not end inside a comment or string.
924 ;; Meanwhile, do appropriate indentation on comment lines.
925 (setq inner-loop-done nil)
926 (while (and (not inner-loop-done)
927 (not (and (eobp) (setq outer-loop-done t))))
929 (setq state (parse-partial-sexp (point) (progn (end-of-line) (point))
931 (setq next-depth (car state))
932 (if (or (nth 4 ostate))
934 (if (or (nth 3 state))
936 (setq inner-loop-done t)))
937 (if (<= next-depth 0)
938 (setq outer-loop-done t))
941 ;; If this line had ..))) (((.. in it, pop out of the levels
942 ;; that ended anywhere in this line, even if the final depth
943 ;; doesn't indicate that they ended.
944 (while (> last-depth (nth 6 state))
945 (setq indent-stack (cdr indent-stack)
946 contain-stack (cdr contain-stack)
947 last-depth (1- last-depth)))
948 ;; Add levels for any parens that were started in this line.
949 (while (< last-depth next-depth)
950 (setq indent-stack (cons nil indent-stack)
951 contain-stack (cons nil contain-stack)
952 last-depth (1+ last-depth)))
953 (if (null (car contain-stack))
954 (setcar contain-stack
955 (or (car (cdr state))
963 (= (preceding-char) ?\\)))
964 (skip-chars-forward " \t")
967 (if (and (car indent-stack)
968 (>= (car indent-stack) 0))
969 ;; Line is on an existing nesting level.
970 (setq this-indent (car indent-stack))
971 ;; Just started a new nesting level.
972 ;; Compute the standard indent for this level.
973 (let ((val (tcl-calculate-indent
974 (if (car indent-stack)
975 (- (car indent-stack))))))
977 (setq this-indent val))
978 (setq continued-line nil)))
979 (cond ((not (numberp this-indent)))
980 ((= (following-char) ?})
981 (setq this-indent (- this-indent tcl-indent-level)))
982 ((= (following-char) ?\])
983 (setq this-indent (- this-indent 1))))
984 ;; Put chosen indentation into effect.
985 (or (null this-indent)
988 (+ this-indent tcl-indent-level)
991 (delete-region (point) (progn (beginning-of-line) (point)))
994 (+ this-indent tcl-indent-level)
1001 ;; Interfaces to other packages.
1004 ;; FIXME Definition of function is very ad-hoc. Should use
1005 ;; beginning-of-defun. Also has incestuous knowledge about the
1006 ;; format of tcl-proc-regexp.
1007 (defun tcl-add-log-defun ()
1008 "Return name of Tcl function point is in, or nil."
1011 (if (re-search-backward (concat tcl-proc-regexp "\\([^ \t\n{]+\\)") nil t)
1014 (defun tcl-outline-level ()
1016 (skip-chars-forward " \t")
1022 ;; Helper functions for inferior Tcl mode.
1025 ;; This exists to let us delete the prompt when commands are sent
1026 ;; directly to the inferior Tcl. See gud.el for an explanation of how
1027 ;; it all works (I took it from there). This stuff doesn't really
1028 ;; work as well as I'd like it to. But I don't believe there is
1029 ;; anything useful that can be done.
1030 (defvar inferior-tcl-delete-prompt-marker nil)
1032 (defun tcl-filter (proc string)
1033 (let ((inhibit-quit t)) ;FIXME: Isn't that redundant?
1034 (with-current-buffer (process-buffer proc)
1035 ;; Delete prompt if requested.
1036 (when (marker-buffer inferior-tcl-delete-prompt-marker)
1037 (delete-region (process-mark proc) inferior-tcl-delete-prompt-marker)
1038 (set-marker inferior-tcl-delete-prompt-marker nil))))
1039 (comint-output-filter proc string))
1041 (defun tcl-send-string (proc string)
1042 (with-current-buffer (process-buffer proc)
1043 (goto-char (process-mark proc))
1044 (forward-line 0) ;Not (beginning-of-line) because of fields.
1045 (if (looking-at comint-prompt-regexp)
1046 (set-marker inferior-tcl-delete-prompt-marker (point))))
1047 (comint-send-string proc string))
1049 (defun tcl-send-region (proc start end)
1050 (with-current-buffer (process-buffer proc)
1051 (goto-char (process-mark proc))
1052 (forward-line 0) ;Not (beginning-of-line) because of fields.
1053 (if (looking-at comint-prompt-regexp)
1054 (set-marker inferior-tcl-delete-prompt-marker (point))))
1055 (comint-send-region proc start end))
1057 (defun switch-to-tcl (eob-p)
1058 "Switch to inferior Tcl process buffer.
1059 With argument, positions cursor at end of buffer."
1061 (if (get-buffer inferior-tcl-buffer)
1062 (pop-to-buffer inferior-tcl-buffer)
1063 (error "No current inferior Tcl buffer"))
1066 (goto-char (point-max)))))
1068 (defun inferior-tcl-proc ()
1069 "Return current inferior Tcl process.
1070 See variable `inferior-tcl-buffer'."
1071 (let ((proc (get-buffer-process (if (eq major-mode 'inferior-tcl-mode)
1073 inferior-tcl-buffer))))
1075 (error "No Tcl process; see variable `inferior-tcl-buffer'"))))
1077 (defun tcl-eval-region (start end &optional and-go)
1078 "Send the current region to the inferior Tcl process.
1079 Prefix argument means switch to the Tcl buffer afterwards."
1080 (interactive "r\nP")
1081 (let ((proc (inferior-tcl-proc)))
1084 ;; Strip leading and trailing whitespace.
1085 (save-excursion (goto-char start) (skip-chars-forward " \t\n") (point))
1086 (save-excursion (goto-char end) (skip-chars-backward " \t\n") (point)))
1087 (tcl-send-string proc "\n")
1088 (if and-go (switch-to-tcl t))))
1090 (defun tcl-eval-defun (&optional and-go)
1091 "Send the current defun to the inferior Tcl process.
1092 Prefix argument means switch to the Tcl buffer afterwards."
1096 (let ((end (point)))
1097 (beginning-of-defun)
1098 (tcl-eval-region (point) end)))
1099 (if and-go (switch-to-tcl t)))
1104 ;; Inferior Tcl mode itself.
1107 (define-derived-mode inferior-tcl-mode comint-mode "Inferior Tcl"
1108 "Major mode for interacting with Tcl interpreter.
1110 You can start a Tcl process with \\[inferior-tcl].
1112 Entry to this mode runs the normal hooks `comint-mode-hook' and
1113 `inferior-tcl-mode-hook', in that order.
1115 You can send text to the inferior Tcl process from other buffers
1116 containing Tcl source.
1118 Variables controlling Inferior Tcl mode:
1120 Name of program to run.
1121 `tcl-command-switches'
1122 Command line arguments to `tcl-application'.
1125 `inferior-tcl-source-command'
1126 Command to use to read Tcl file in running application.
1127 `inferior-tcl-buffer'
1128 The current inferior Tcl process buffer. See variable
1129 documentation for details on multiple-process support.
1131 The following commands are available:
1132 \\{inferior-tcl-mode-map}"
1133 (set (make-local-variable 'comint-prompt-regexp)
1134 (or tcl-prompt-regexp
1135 (concat "^" (regexp-quote tcl-application) ">")))
1136 (setq mode-line-process '(": %s"))
1137 (setq local-abbrev-table tcl-mode-abbrev-table)
1138 (set-syntax-table tcl-mode-syntax-table)
1139 (set (make-local-variable 'defun-prompt-regexp) tcl-omit-ws-regexp)
1140 (set (make-local-variable 'inferior-tcl-delete-prompt-marker) (make-marker))
1141 (set-process-filter (get-buffer-process (current-buffer)) 'tcl-filter))
1144 (defun inferior-tcl (cmd)
1145 "Run inferior Tcl process.
1146 Prefix arg means enter program name interactively.
1147 See documentation for function `inferior-tcl-mode' for more information."
1149 (list (if current-prefix-arg
1150 (read-string "Run Tcl: " tcl-application)
1152 (unless (comint-check-proc "*inferior-tcl*")
1153 (set-buffer (apply (function make-comint) "inferior-tcl" cmd nil
1154 tcl-command-switches))
1156 ;; Make tclsh display a prompt on ms-windows (or under Unix, when a tty
1157 ;; wasn't used). Doesn't affect wish, unfortunately.
1158 (unless (process-tty-name (inferior-tcl-proc))
1159 (tcl-send-string (inferior-tcl-proc)
1160 "set ::tcl_interactive 1; concat\n")))
1161 (set (make-local-variable 'tcl-application) cmd)
1162 (setq inferior-tcl-buffer "*inferior-tcl*")
1163 (pop-to-buffer "*inferior-tcl*"))
1165 (defalias 'run-tcl 'inferior-tcl)
1170 ;; Auto-fill support.
1173 (defun tcl-real-command-p ()
1174 "Return nil if point is not at the beginning of a command.
1175 A command is the first word on an otherwise empty line, or the
1176 first word following a semicolon, opening brace, or opening bracket."
1178 (skip-chars-backward " \t")
1183 ;; Note -- continued comments are not supported here. I
1184 ;; consider those to be a wart on the language.
1185 (not (eq ?\\ (preceding-char))))
1187 (memq (preceding-char) '(?\; ?{ ?\[))))))
1189 ;; FIXME doesn't actually return t. See last case.
1190 (defun tcl-real-comment-p ()
1191 "Return t if point is just after the `#' beginning a real comment.
1192 Does not check to see if previous char is actually `#'.
1193 A real comment is either at the beginning of the buffer,
1194 preceded only by whitespace on the line, or has a preceding
1195 semicolon, opening brace, or opening bracket on the same line."
1198 (tcl-real-command-p)))
1200 (defun tcl-hairy-scan-for-comment (state end always-stop)
1201 "Determine if point is in a comment.
1202 Returns a list of the form `(FLAG . STATE)'. STATE can be used
1203 as input to future invocations. FLAG is nil if not in comment,
1204 t otherwise. If in comment, leaves point at beginning of comment.
1206 This function does not work in Emacs 18.
1207 See also `tcl-simple-scan-for-comment', a
1208 simpler version that is often right, and works in Emacs 18."
1209 (let ((bol (save-excursion
1211 (line-beginning-position)))
1214 (while (and (not last-cstart) (< (point) end))
1215 (setq real-comment nil) ;In case we've looped around and it is set.
1216 (setq state (parse-partial-sexp (point) end nil nil state t))
1219 ;; If ALWAYS-STOP is set, stop even if we don't have a
1220 ;; real comment, or if the comment isn't on the same line
1222 (if always-stop (setq last-cstart (point)))
1223 ;; If we have a real comment, then set the comment
1224 ;; starting point if we are on the same line as the ending
1226 (setq real-comment (tcl-real-comment-p))
1229 (and (> (point) bol) (setq last-cstart (point)))
1230 ;; NOTE Emacs 19 has a misfeature whereby calling
1231 ;; parse-partial-sexp with COMMENTSTOP set and with
1232 ;; an initial list that says point is in a comment
1233 ;; will cause an immediate return. So we must skip
1234 ;; over the comment ourselves.
1235 (beginning-of-line 2)))
1236 ;; Frob the state to make it look like we aren't in a
1238 (setcar (nthcdr 4 state) nil))))
1240 (goto-char last-cstart))
1241 (cons real-comment state)))
1243 (defun tcl-in-comment ()
1244 "Return t if point is in a comment, and leave point at beginning of comment."
1245 (let ((save (point)))
1246 (beginning-of-defun)
1247 (car (tcl-hairy-scan-for-comment nil save nil))))
1252 ;; Help-related code.
1255 (defvar tcl-help-saved-dirs nil
1256 "Saved help directories.
1257 If `tcl-help-directory-list' changes, this allows `tcl-help-on-word'
1258 to update the alist.")
1260 (defvar tcl-help-alist nil
1261 "Alist with command names as keys and filenames as values.")
1263 (defun tcl-files-alist (dir &optional alist)
1264 "Recursively add all pairs (FILE . PATH) under DIR to ALIST."
1265 (dolist (file (directory-files dir t) alist)
1267 ((not (file-directory-p file))
1268 (push (cons (file-name-nondirectory file) file) alist))
1269 ((member (file-name-nondirectory file) '("." "..")))
1270 (t (setq alist (tcl-files-alist file alist))))))
1272 (defun tcl-help-snarf-commands (dirlist)
1273 "Return alist of commands and filenames."
1275 (dolist (dir dirlist alist)
1276 (when (file-directory-p dir)
1277 (setq alist (tcl-files-alist dir alist))))))
1279 (defun tcl-reread-help-files ()
1280 "Set up to re-read files, and then do it."
1282 (message "Building Tcl help file index...")
1283 (setq tcl-help-saved-dirs tcl-help-directory-list)
1284 (setq tcl-help-alist (tcl-help-snarf-commands tcl-help-directory-list))
1285 (message "Building Tcl help file index...done"))
1287 (defun tcl-word-no-props ()
1288 "Like `current-word', but strips properties."
1289 (let ((word (current-word)))
1290 (set-text-properties 0 (length word) nil word)
1293 (defun tcl-current-word (flag)
1294 "Return current command word, or nil.
1295 If FLAG is nil, just uses `current-word'.
1296 Otherwise scans backward for most likely Tcl command word."
1298 (memq major-mode '(tcl-mode inferior-tcl-mode)))
1301 ;; Look backward for first word actually in alist.
1304 (while (and (not (bobp))
1305 (not (tcl-real-command-p)))
1307 (if (assoc (tcl-word-no-props) tcl-help-alist)
1308 (tcl-word-no-props)))
1310 (tcl-word-no-props)))
1313 (defun tcl-help-on-word (command &optional arg)
1314 "Get help on Tcl command. Default is word at point.
1315 Prefix argument means invert sense of `tcl-use-smart-word-finder'."
1319 (if (not (equal tcl-help-directory-list tcl-help-saved-dirs))
1320 (tcl-reread-help-files))
1321 (let ((word (tcl-current-word
1322 (if current-prefix-arg
1323 (not tcl-use-smart-word-finder)
1324 tcl-use-smart-word-finder))))
1326 (if (or (null word) (string= word ""))
1327 "Help on Tcl command: "
1328 (format "Help on Tcl command (default %s): " word))
1329 tcl-help-alist nil t nil nil word)))
1330 current-prefix-arg))
1331 (if (not (equal tcl-help-directory-list tcl-help-saved-dirs))
1332 (tcl-reread-help-files))
1333 (if (string= command "")
1334 (setq command (tcl-current-word
1336 (not tcl-use-smart-word-finder)
1337 tcl-use-smart-word-finder))))
1338 (let* ((help (get-buffer-create "*Tcl help*"))
1339 (cell (assoc command tcl-help-alist))
1340 (file (and cell (cdr cell))))
1342 (delete-region (point-min) (point-max))
1345 (insert "*** " command "\n\n")
1346 (insert-file-contents file))
1347 (if (string= command "")
1348 (insert "Magical Pig!")
1349 (insert "Tcl command " command " not in help\n")))
1350 (set-buffer-modified-p nil)
1351 (goto-char (point-min))
1352 (display-buffer help)))
1357 ;; Other interactive stuff.
1360 (defvar tcl-previous-dir/file nil
1361 "Record last directory and file used in loading.
1362 This holds a cons cell of the form `(DIRECTORY . FILE)'
1363 describing the last `tcl-load-file' command.")
1365 (defun tcl-load-file (file &optional and-go)
1366 "Load a Tcl file into the inferior Tcl process.
1367 Prefix argument means switch to the Tcl buffer afterwards."
1370 ;; car because comint-get-source returns a list holding the
1372 (car (comint-get-source "Load Tcl file: "
1374 (eq major-mode 'tcl-mode)
1376 tcl-previous-dir/file)
1378 current-prefix-arg))
1379 (comint-check-source file)
1380 (setq tcl-previous-dir/file (cons (file-name-directory file)
1381 (file-name-nondirectory file)))
1382 (tcl-send-string (inferior-tcl-proc)
1383 (format inferior-tcl-source-command (tcl-quote file)))
1384 (if and-go (switch-to-tcl t)))
1386 (defun tcl-restart-with-file (file &optional and-go)
1387 "Restart inferior Tcl with file.
1388 If an inferior Tcl process exists, it is killed first.
1389 Prefix argument means switch to the Tcl buffer afterwards."
1392 (car (comint-get-source "Restart with Tcl file: "
1394 (eq major-mode 'tcl-mode)
1396 tcl-previous-dir/file)
1398 current-prefix-arg))
1399 (let* ((buf (if (eq major-mode 'inferior-tcl-mode)
1401 inferior-tcl-buffer))
1402 (proc (and buf (get-process buf))))
1404 ((not (and buf (get-buffer buf)))
1405 ;; I think this will be ok.
1406 (inferior-tcl tcl-application)
1407 (tcl-load-file file and-go))
1409 (not (comint-check-proc buf))
1411 "A Tcl process is running, are you sure you want to reset it? "))
1413 (comint-check-source file)
1414 (setq tcl-previous-dir/file (cons (file-name-directory file)
1415 (file-name-nondirectory file)))
1416 (comint-exec (get-buffer-create buf)
1420 tcl-application file tcl-command-switches)
1421 (if and-go (switch-to-tcl t)))))))
1423 (defun tcl-auto-fill-mode (&optional arg)
1424 "Like `auto-fill-mode', but sets `comment-auto-fill-only-comments'."
1426 (auto-fill-mode arg)
1427 (if auto-fill-function
1428 (set (make-local-variable 'comment-auto-fill-only-comments) t)
1429 (kill-local-variable 'comment-auto-fill-only-comments)))
1431 (defun tcl-electric-hash (&optional count)
1432 "Insert a `#' and quote if it does not start a real comment.
1433 Prefix arg is number of `#'s to insert.
1434 See variable `tcl-electric-hash-style' for description of quoting
1437 (or count (setq count 1))
1440 (if (eq tcl-electric-hash-style 'smart)
1441 (if (> count 3) ; FIXME what is "smart"?
1444 tcl-electric-hash-style))
1450 (setq comment (tcl-in-comment)))
1452 (and tcl-explain-indentation (message "comment: %s" comment))
1457 ((eq type 'backslash)
1458 ;; The following will set count to 0, so the
1459 ;; insert-char can still be run.
1463 (setq count (1- count)))))
1465 (insert-char ?# count))))
1467 (defun tcl-hashify-buffer ()
1468 "Quote all `#'s in current buffer that aren't Tcl comments."
1471 (goto-char (point-min))
1474 (while (< (point) (point-max))
1475 (setq result (tcl-hairy-scan-for-comment state (point-max) t))
1477 (beginning-of-line 2)
1479 (if (eq ?# (following-char))
1482 (setq state (cdr result))))))
1484 (defun tcl-comment-indent ()
1485 "Return the desired indentation, but be careful to add a `;' if needed."
1487 ;; If line is not blank, make sure we insert a ";" first.
1488 (skip-chars-backward " \t")
1489 (unless (or (bolp) (tcl-real-command-p))
1491 ;; Try and erase a non-significant char to keep charpos identical.
1492 (if (memq (char-after) '(?\t ?\s)) (delete-char 1))))
1493 (funcall (default-value 'comment-indent-function)))
1495 ;; The following was inspired by the Tcl editing mode written by
1496 ;; Gregor Schmid <schmid@fb3-s7.math.TU-Berlin.DE>. His version also
1497 ;; attempts to snarf the command line options from the command line,
1498 ;; but I didn't think that would really be that helpful (doesn't seem
1499 ;; like it would be right enough. His version also looks for the
1500 ;; "#!/bin/csh ... exec" hack, but that seemed even less useful.
1501 ;; FIXME should make sure that the application mentioned actually
1503 (defun tcl-guess-application ()
1504 "Attempt to guess Tcl application by looking at first line.
1505 The first line is assumed to look like \"#!.../program ...\"."
1507 (goto-char (point-min))
1508 (if (looking-at "#![^ \t]*/\\([^ \t\n/]+\\)\\([ \t]\\|$\\)")
1509 (set (make-local-variable 'tcl-application) (match-string 1)))))
1514 ;; XEmacs menu support.
1515 ;; Taken from schmid@fb3-s7.math.TU-Berlin.DE (Gregor Schmid),
1516 ;; who wrote a different Tcl mode.
1517 ;; We also have support for menus in Emacs. We do this by
1518 ;; loading the XEmacs menu emulation code.
1521 (defun tcl-popup-menu (e)
1523 (popup-menu tcl-mode-menu))
1528 ;; Quoting and unquoting functions.
1531 ;; This quoting is sufficient to protect eg a filename from any sort
1532 ;; of expansion or splitting. Tcl quoting sure sucks.
1533 (defun tcl-quote (string)
1534 "Quote STRING according to Tcl rules."
1535 (mapconcat (lambda (char)
1536 (if (memq char '(?[ ?] ?{ ?} ?\\ ?\" ?$ ?\s ?\;))
1537 (concat "\\" (char-to-string char))
1538 (char-to-string char)))
1546 ;; These are relics kept "just in case".
1547 (defalias 'tcl-uncomment-region 'uncomment-region)
1548 (defalias 'tcl-indent-for-comment 'comment-indent)
1549 (defalias 'add-log-tcl-defun 'tcl-add-log-defun)
1550 (defalias 'indent-tcl-exp 'tcl-indent-exp)
1551 (defalias 'calculate-tcl-indent 'tcl-calculate-indent)
1552 (defalias 'tcl-beginning-of-defun 'beginning-of-defun)
1553 (defalias 'tcl-end-of-defun 'end-of-defun)
1554 (defalias 'tcl-mark-defun 'mark-defun)
1555 (defun tcl-mark () (mark t))
1559 ;;; tcl.el ends here