1 ;;; tcl.el --- Tcl code editing commands for Emacs
3 ;; Copyright (C) 1994, 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
5 ;; Maintainer: Tom Tromey <tromey@busco.lanl.gov>
6 ;; Author: Tom Tromey <tromey@busco.lanl.gov>
7 ;; Chris Lindblad <cjl@lcs.mit.edu>
8 ;; Keywords: languages tcl modes
9 ;; Version: $Revision: 1.62 $
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
30 ;; If you plan to use the interface to the TclX help files, you must
31 ;; set the variable tcl-help-directory-list to point to the topmost
32 ;; directories containing the TclX help files. Eg:
34 ;; (setq tcl-help-directory-list '("/usr/local/lib/tclx/help"))
38 ;; CUSTOMIZATION NOTES:
39 ;; * tcl-proc-list can be used to customize a list of things that
40 ;; "define" other things. Eg in my project I put "defvar" in this
42 ;; * tcl-typeword-list is similar, but uses font-lock-type-face.
43 ;; * tcl-keyword-list is a list of keywords. I've generally used this
44 ;; for flow-control words. Eg I add "unwind_protect" to this list.
45 ;; * tcl-type-alist can be used to minimally customize indentation
46 ;; according to context.
48 ;; THANKS FOR CRITICISM AND SUGGESTIONS TO:
49 ;; Guido Bosch <Guido.Bosch@loria.fr>
50 ;; pgs1002@esc.cam.ac.uk (Dr P.G. Sjoerdsma)
51 ;; Mike Scheidler <c23mts@kocrsv01.delcoelect.com>
52 ;; Matt Newman <men@charney.colorado.edu>
53 ;; rwhitby@research.canon.oz.au (Rod Whitby)
54 ;; h9118101@hkuxa.hku.hk (Yip Chi Lap [Beta])
55 ;; Pertti Tapio Kasanen <ptk@delta.hut.fi>
56 ;; schmid@fb3-s7.math.TU-Berlin.DE (Gregor Schmid)
57 ;; warsaw@nlm.nih.gov (Barry A. Warsaw)
58 ;; Carl Witty <cwitty@ai.mit.edu>
59 ;; T. V. Raman <raman@crl.dec.com>
60 ;; Jesper Pedersen <blackie@imada.ou.dk>
61 ;; dfarmer@evolving.com (Doug Farmer)
62 ;; "Chris Alfeld" <calfeld@math.utah.edu>
63 ;; Ben Wing <wing@666.com>
66 ;; * In Tcl "#" is not always a comment character. This can confuse
67 ;; tcl.el in certain circumstances. For now the only workaround is
68 ;; to enclose offending hash characters in quotes or precede it with
69 ;; a backslash. Note that using braces won't work -- quotes change
70 ;; the syntax class of characters between them, while braces do not.
71 ;; The 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 preceeding 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.
111 ;; I sure wish Emacs had a package that made it easy to extract this
112 ;; sort of information. Strange definition works with XEmacs 20.0.
113 (defconst tcl-using-emacs-19 (not (string-match "18\\." emacs-version))
114 "Non-nil if using Emacs 19 or later.")
116 (defconst tcl-using-emacs-19-23
117 (or (string-match "19\\.\\(2[3-9]\\|[3-9][0-9]\\)" emacs-version)
118 (string-match "^[2-9][0-9]\\." emacs-version))
119 "Non-nil if using Emacs 19-23 or later.")
121 (defconst tcl-using-xemacs-19 (string-match "XEmacs" emacs-version)
122 "Non-nil if using XEmacs.")
126 ;; When compiling under Emacs, load imenu during compilation. If
127 ;; you have 19.22 or earlier, comment this out, or get imenu.
128 (and (fboundp 'eval-when-compile)
130 (if (and (not (string< emacs-version "19.23"))
131 (not (string-match "XEmacs" emacs-version)))
135 (defconst tcl-version "$Revision: 1.62 $")
136 (defconst tcl-maintainer "Tom Tromey <tromey@drip.colorado.edu>")
143 "Major mode for editing Tcl source in Emacs"
146 (defcustom tcl-indent-level 4
147 "*Indentation of Tcl statements with respect to containing block."
151 (defcustom tcl-continued-indent-level 4
152 "*Indentation of continuation line relative to first line of command."
156 (defcustom tcl-auto-newline nil
157 "*Non-nil means automatically newline before and after braces you insert."
161 (defcustom tcl-tab-always-indent t
162 "*Control effect of TAB key.
163 If t (the default), always indent current line.
164 If nil and point is not in the indentation area at the beginning of
165 the line, a TAB is inserted.
166 Other values cause the first possible action from the following list
169 1. Move from beginning of line to correct indentation.
170 2. Delete an empty comment.
171 3. Move forward to start of comment, indenting if necessary.
172 4. Move forward to end of line, indenting if necessary.
173 5. Create an empty comment.
174 6. Move backward to start of comment, indenting if necessary."
176 :type '(choice (const :tag "Always" t)
177 (const :tag "Beginning only" nil)
178 (const :tag "Maybe move or make or delete comment" 'tcl)))
181 (defcustom tcl-use-hairy-comment-detector t
182 "*If not nil, use the more sophisticated, but slower, comment-delete method.
183 This variable is not effective in Emacs 18;
184 the fast function is always used in that version."
188 (defcustom tcl-electric-hash-style 'smart
189 "*Style of electric hash insertion to use.
190 Possible values are `backslash', meaning that `\\' quoting should be
191 done; `quote', meaning that `\"' quoting should be done; `smart',
192 meaning that the choice between `backslash' and `quote' should be
193 made depending on the number of hashes inserted; or nil, meaning that
194 no quoting should be done. Any other value for this variable is
195 taken to mean `smart'. The default is `smart'."
197 :type '(choice (const backslash) (const quote) (const smart) (const nil)))
199 (defcustom tcl-help-directory-list nil
200 "*List of topmost directories containing TclX help files."
202 :type '(repeat directory))
204 (defcustom tcl-use-smart-word-finder t
205 "*If not nil, use smart way to find current word, for Tcl help feature."
209 (defcustom tcl-application "wish"
210 "*Name of Tcl program to run in inferior Tcl mode."
214 (defcustom tcl-command-switches nil
215 "*List of switches to supply to the `tcl-application' program."
217 :type '(repeat string))
219 (defcustom tcl-prompt-regexp "^\\(% \\|\\)"
220 "*If not nil, a regexp that will match the prompt in the inferior process.
221 If nil, the prompt is the name of the application with \">\" appended.
223 The default is \"^\\(% \\|\\)\", which will match the default primary
224 and secondary prompts for tclsh and wish."
228 (defcustom inferior-tcl-source-command "source %s\n"
229 "*Format-string for building a Tcl command to load a file.
230 This format string should use `%s' to substitute a file name
231 and should result in a Tcl expression that will command the
232 inferior Tcl to load that file. The filename will be appropriately
238 ;; Keymaps, abbrevs, syntax tables.
241 (defvar tcl-mode-abbrev-table nil
242 "Abbrev table in use in Tcl-mode buffers.")
243 (if tcl-mode-abbrev-table
245 (define-abbrev-table 'tcl-mode-abbrev-table ()))
247 (defvar tcl-mode-map ()
248 "Keymap used in Tcl mode.")
250 (defvar tcl-mode-syntax-table nil
251 "Syntax table in use in Tcl-mode buffers.")
252 (if tcl-mode-syntax-table
254 (setq tcl-mode-syntax-table (make-syntax-table))
255 (modify-syntax-entry ?% "_" tcl-mode-syntax-table)
256 (modify-syntax-entry ?@ "_" tcl-mode-syntax-table)
257 (modify-syntax-entry ?& "_" tcl-mode-syntax-table)
258 (modify-syntax-entry ?* "_" tcl-mode-syntax-table)
259 (modify-syntax-entry ?+ "_" tcl-mode-syntax-table)
260 (modify-syntax-entry ?- "_" tcl-mode-syntax-table)
261 (modify-syntax-entry ?. "_" tcl-mode-syntax-table)
262 (modify-syntax-entry ?: "_" tcl-mode-syntax-table)
263 (modify-syntax-entry ?! "_" tcl-mode-syntax-table)
264 (modify-syntax-entry ?$ "_" tcl-mode-syntax-table) ; FIXME use "'"?
265 (modify-syntax-entry ?/ "_" tcl-mode-syntax-table)
266 (modify-syntax-entry ?~ "_" tcl-mode-syntax-table)
267 (modify-syntax-entry ?< "_" tcl-mode-syntax-table)
268 (modify-syntax-entry ?= "_" tcl-mode-syntax-table)
269 (modify-syntax-entry ?> "_" tcl-mode-syntax-table)
270 (modify-syntax-entry ?| "_" tcl-mode-syntax-table)
271 (modify-syntax-entry ?\( "()" tcl-mode-syntax-table)
272 (modify-syntax-entry ?\) ")(" tcl-mode-syntax-table)
273 (modify-syntax-entry ?\; "." tcl-mode-syntax-table)
274 (modify-syntax-entry ?\n "> " tcl-mode-syntax-table)
275 (modify-syntax-entry ?\f "> " tcl-mode-syntax-table)
276 (modify-syntax-entry ?# "< " tcl-mode-syntax-table))
278 (defvar inferior-tcl-mode-map nil
279 "Keymap used in Inferior Tcl mode.")
282 (defvar tcl-xemacs-menu
283 '(["Beginning of function" tcl-beginning-of-defun t]
284 ["End of function" tcl-end-of-defun t]
285 ["Mark function" tcl-mark-defun t]
286 ["Indent region" indent-region (tcl-mark)]
287 ["Comment region" comment-region (tcl-mark)]
288 ["Uncomment region" tcl-uncomment-region (tcl-mark)]
290 ["Show Tcl process buffer" inferior-tcl t]
291 ["Send function to Tcl process" tcl-eval-defun
292 (and inferior-tcl-buffer (get-buffer inferior-tcl-buffer))]
293 ["Send region to Tcl process" tcl-eval-region
294 (and inferior-tcl-buffer (get-buffer inferior-tcl-buffer))]
295 ["Send file to Tcl process" tcl-load-file
296 (and inferior-tcl-buffer (get-buffer inferior-tcl-buffer))]
297 ["Restart Tcl process with file" tcl-restart-with-file t]
299 ["Tcl help" tcl-help-on-word tcl-help-directory-list]
300 ["Send bug report" tcl-submit-bug-report t])
301 "XEmacs menu for Tcl mode.")
303 ;; Emacs does menus via keymaps. Do it in a function in case we
304 ;; later decide to add it to inferior Tcl mode as well.
305 (defun tcl-add-emacs-menu (map)
306 (define-key map [menu-bar] (make-sparse-keymap "Tcl"))
307 ;; This fails in Emacs 19.22 and earlier.
309 (let ((menu (make-lucid-menu-keymap "Tcl" tcl-xemacs-menu)))
310 (define-key map [menu-bar tcl] (cons "Tcl" menu))
311 ;; The following is intended to compute the key sequence
312 ;; information for the menu. It doesn't work.
313 (x-popup-menu nil menu)))
315 (defun tcl-fill-mode-map ()
316 (define-key tcl-mode-map "{" 'tcl-electric-char)
317 (define-key tcl-mode-map "}" 'tcl-electric-brace)
318 (define-key tcl-mode-map "[" 'tcl-electric-char)
319 (define-key tcl-mode-map "]" 'tcl-electric-char)
320 (define-key tcl-mode-map ";" 'tcl-electric-char)
321 (define-key tcl-mode-map "#" 'tcl-electric-hash)
323 (define-key tcl-mode-map "\e\C-a" 'tcl-beginning-of-defun)
325 (define-key tcl-mode-map "\e\C-e" 'tcl-end-of-defun)
327 (define-key tcl-mode-map "\e\C-h" 'tcl-mark-defun)
328 (define-key tcl-mode-map "\e\C-q" 'indent-tcl-exp)
329 (define-key tcl-mode-map "\177" 'backward-delete-char-untabify)
330 (define-key tcl-mode-map "\t" 'tcl-indent-command)
331 (define-key tcl-mode-map "\M-;" 'tcl-indent-for-comment)
332 (define-key tcl-mode-map "\M-\C-x" 'tcl-eval-defun)
333 (define-key tcl-mode-map "\C-c\C-b" 'tcl-submit-bug-report)
334 (and (fboundp 'comment-region)
335 (define-key tcl-mode-map "\C-c\C-c" 'comment-region))
336 (define-key tcl-mode-map "\C-c\C-i" 'tcl-help-on-word)
337 (define-key tcl-mode-map "\C-c\C-v" 'tcl-eval-defun)
338 (define-key tcl-mode-map "\C-c\C-f" 'tcl-load-file)
339 (define-key tcl-mode-map "\C-c\C-t" 'inferior-tcl)
340 (define-key tcl-mode-map "\C-c\C-x" 'tcl-eval-region)
341 (define-key tcl-mode-map "\C-c\C-s" 'switch-to-tcl)
344 (if (and tcl-using-emacs-19 (not tcl-using-xemacs-19))
346 (tcl-add-emacs-menu tcl-mode-map))))
348 (defun tcl-fill-inferior-map ()
349 (define-key inferior-tcl-mode-map "\t" 'comint-dynamic-complete)
350 (define-key inferior-tcl-mode-map "\M-?"
351 'comint-dynamic-list-filename-completions)
352 (define-key inferior-tcl-mode-map "\e\C-a" 'tcl-beginning-of-defun)
353 (define-key inferior-tcl-mode-map "\e\C-e" 'tcl-end-of-defun)
354 (define-key inferior-tcl-mode-map "\177" 'backward-delete-char-untabify)
355 (define-key inferior-tcl-mode-map "\M-\C-x" 'tcl-eval-defun)
356 (define-key inferior-tcl-mode-map "\C-c\C-b" 'tcl-submit-bug-report)
357 (define-key inferior-tcl-mode-map "\C-c\C-i" 'tcl-help-on-word)
358 (define-key inferior-tcl-mode-map "\C-c\C-v" 'tcl-eval-defun)
359 (define-key inferior-tcl-mode-map "\C-c\C-f" 'tcl-load-file)
360 (define-key inferior-tcl-mode-map "\C-c\C-t" 'inferior-tcl)
361 (define-key inferior-tcl-mode-map "\C-c\C-x" 'tcl-eval-region)
362 (define-key inferior-tcl-mode-map "\C-c\C-s" 'switch-to-tcl))
366 (setq tcl-mode-map (make-sparse-keymap))
369 (if inferior-tcl-mode-map
371 ;; FIXME Use keymap inheritance here? FIXME we override comint
372 ;; keybindings here. Maybe someone has a better set?
373 (setq inferior-tcl-mode-map (copy-keymap comint-mode-map))
374 (tcl-fill-inferior-map))
377 (defvar inferior-tcl-buffer nil
378 "*The current inferior-tcl process buffer.
380 MULTIPLE PROCESS SUPPORT
381 ===========================================================================
382 To run multiple Tcl processes, you start the first up with
383 \\[inferior-tcl]. It will be in a buffer named `*inferior-tcl*'.
384 Rename this buffer with \\[rename-buffer]. You may now start up a new
385 process with another \\[inferior-tcl]. It will be in a new buffer,
386 named `*inferior-tcl*'. You can switch between the different process
387 buffers with \\[switch-to-buffer].
389 Commands that send text from source buffers to Tcl processes -- like
390 `tcl-eval-defun' or `tcl-load-file' -- have to choose a process to
391 send to, when you have more than one Tcl process around. This is
392 determined by the global variable `inferior-tcl-buffer'. Suppose you
393 have three inferior Lisps running:
397 *inferior-tcl* inferior-tcl<3>
398 If you do a \\[tcl-eval-defun] command on some Lisp source code, what
399 process do you send it to?
401 - If you're in a process buffer (foo, bar, or *inferior-tcl*),
402 you send it to that process.
403 - If you're in some other buffer (e.g., a source file), you
404 send it to the process attached to buffer `inferior-tcl-buffer'.
405 This process selection is performed by function `inferior-tcl-proc'.
407 Whenever \\[inferior-tcl] fires up a new process, it resets
408 `inferior-tcl-buffer' to be the new process's buffer. If you only run
409 one process, this does the right thing. If you run multiple
410 processes, you can change `inferior-tcl-buffer' to another process
411 buffer with \\[set-variable].")
414 ;; Hooks and other customization.
417 (defvar tcl-mode-hook nil
418 "Hook run on entry to Tcl mode.
420 Several functions exist which are useful to run from your
421 `tcl-mode-hook' (see each function's documentation for more
424 tcl-guess-application
425 Guesses a default setting for `tcl-application' based on any
426 \"#!\" line at the top of the file.
428 Quotes all \"#\" characters that don't correspond to actual
429 Tcl comments. (Useful when editing code not originally created
432 Auto-filling of Tcl comments.
434 Add functions to the hook with `add-hook':
436 (add-hook 'tcl-mode-hook 'tcl-guess-application)
438 Emacs 18 users must use `setq' instead:
440 (setq tcl-mode-hook (cons 'tcl-guess-application tcl-mode-hook))")
443 (defvar inferior-tcl-mode-hook nil
444 "Hook for customizing Inferior Tcl mode.")
446 (defvar tcl-proc-list
447 '("proc" "method" "itcl_class" "body" "configbody" "class")
448 "List of commands whose first argument defines something.
449 This exists because some people (eg, me) use `defvar' et al.
450 Call `tcl-set-proc-regexp' and `tcl-set-font-lock-keywords'
451 after changing this list.")
453 (defvar tcl-proc-regexp nil
454 "Regexp to use when matching proc headers.")
456 (defvar tcl-typeword-list
457 '("global" "upvar" "inherit" "public" "protected" "private"
458 "common" "itk_option" "variable")
459 "List of Tcl keywords denoting \"type\". Used only for highlighting.
460 Call `tcl-set-font-lock-keywords' after changing this list.")
462 ;; Generally I've picked control operators to be keywords.
463 (defvar tcl-keyword-list
464 '("if" "then" "else" "elseif" "for" "foreach" "break" "continue" "while"
465 "eval" "case" "in" "switch" "default" "exit" "error" "proc" "return"
466 "uplevel" "constructor" "destructor" "itcl_class" "loop" "for_array_keys"
467 "for_recursive_glob" "for_file" "method" "body" "configbody" "class")
468 "List of Tcl keywords. Used only for highlighting.
469 Default list includes some TclX keywords.
470 Call `tcl-set-font-lock-keywords' after changing this list.")
472 (defvar tcl-font-lock-keywords nil
473 "Keywords to highlight for Tcl. See variable `font-lock-keywords'.
474 This variable is generally set from `tcl-proc-regexp',
475 `tcl-typeword-list', and `tcl-keyword-list' by the function
476 `tcl-set-font-lock-keywords'.")
478 ;; FIXME need some way to recognize variables because array refs look
480 (defvar tcl-type-alist
482 ("proc" nil tcl-expr tcl-commands)
483 ("method" nil tcl-expr tcl-commands)
484 ("destructor" tcl-commands)
485 ("constructor" tcl-commands)
487 ("catch" tcl-commands)
488 ("if" tcl-expr "then" tcl-commands)
489 ("elseif" tcl-expr "then" tcl-commands)
490 ("elseif" tcl-expr tcl-commands)
491 ("if" tcl-expr tcl-commands)
492 ("while" tcl-expr tcl-commands)
493 ("for" tcl-commands tcl-expr tcl-commands tcl-commands)
494 ("foreach" nil nil tcl-commands)
495 ("for_file" nil nil tcl-commands)
496 ("for_array_keys" nil nil tcl-commands)
497 ("for_recursive_glob" nil nil nil tcl-commands)
498 ;; Loop handling is not perfect, because the third argument can be
499 ;; either a command or an expr, and there is no real way to look
501 ("loop" nil tcl-expr tcl-expr tcl-commands)
502 ("loop" nil tcl-expr tcl-commands)
504 "Alist that controls indentation.
505 \(Actually, this really only controls what happens on continuation lines).
506 Each entry looks like `(KEYWORD TYPE ...)'.
507 Each type entry describes a sexp after the keyword, and can be one of:
508 * nil, meaning that this sexp has no particular type.
509 * tcl-expr, meaning that this sexp is an arithmetic expression.
510 * tcl-commands, meaning that this sexp holds Tcl commands.
511 * a string, which must exactly match the string at the corresponding
512 position for a match to be made.
514 For example, the entry for the \"loop\" command is:
516 (\"loop\" nil tcl-expr tcl-commands)
518 This means that the \"loop\" command has three arguments. The first
519 argument is ignored (for indentation purposes). The second argument
520 is a Tcl expression, and the last argument is Tcl commands.")
522 (defvar tcl-explain-indentation nil
523 "If not `nil', debugging message will be printed during indentation.")
528 ;; Work around differences between various versions of Emacs.
531 (defconst tcl-pps-has-arg-6
532 (or tcl-using-emacs-19
533 (and tcl-using-xemacs-19
536 (parse-partial-sexp (point) (point) nil nil nil t)
539 "t if Emacs supports \"commentstop\" argument to `parse-partial-sexp'.")
541 ;; Its pretty bogus to have to do this, but there is no easier way to
542 ;; say "match not syntax-1 and not syntax-2". Too bad you can't put
543 ;; \s in [...]. This sickness is used in Emacs 19 to match a defun
544 ;; starter. (It is used for this in v18 as well).
545 ;;(defconst tcl-omit-ws-regexp
547 ;; (mapconcat 'char-to-string "w_.()\"\\$'/" "\\|\\s")
549 ;; "Regular expression that matches everything except space, comment
550 ;;starter, and comment ender syntax codes.")
552 ;; FIXME? Instead of using the hairy regexp above, we just use a
554 ;;(defconst tcl-omit-ws-regexp "^[^] \t\n#}]\\S(*"
555 ;; "Regular expression used in locating function definitions.")
557 ;; Here's another stab. I think this one actually works. Now the
558 ;; problem seems to be that there is a bug in Emacs 19.22 where
559 ;; end-of-defun doesn't really use the brace matching the one that
560 ;; trails defun-prompt-regexp.
561 ;; ?? Is there a bug now ??
562 (defconst tcl-omit-ws-regexp "^[^ \t\n#}][^\n}]+}*[ \t]+")
564 (defun tcl-internal-beginning-of-defun (&optional arg)
565 "Move backward to next beginning of defun.
566 With argument, do this that many times.
567 Returns t unless search stops due to end of buffer."
569 (if (or (null arg) (= arg 0))
576 (re-search-backward tcl-omit-ws-regexp nil 'move 1))))
577 (while (and (looking-at "[]#}]")
579 (re-search-backward tcl-omit-ws-regexp nil 'move 1)))))
581 (not (null success))))
583 (defun tcl-internal-end-of-defun (&optional arg)
584 "Move forward to next end of defun.
585 An end of a defun is found by moving forward from the beginning of one."
587 (if (or (null arg) (= arg 0)) (setq arg 1))
588 (let ((start (point)))
589 ;; Was forward-char. I think this works a little better.
591 (tcl-beginning-of-defun)
593 (while (and (re-search-forward tcl-omit-ws-regexp nil 'move 1)
594 (progn (beginning-of-line) t)
596 (progn (forward-line) t)))
597 (let ((next-line (save-excursion
600 (while (< (point) next-line)
603 (if (> (point) start) (setq arg (1- arg))))))
605 ;; We can now use begining-of-defun as long as we set up a
606 ;; certain regexp. In Emacs 18, we need our own function.
607 (defalias 'tcl-beginning-of-defun
608 (if tcl-using-emacs-19
610 'tcl-internal-beginning-of-defun))
612 ;; Ditto end-of-defun.
613 (defalias 'tcl-end-of-defun
614 (if (and tcl-using-emacs-19 (not tcl-using-xemacs-19))
616 'tcl-internal-end-of-defun))
618 ;; Internal mark-defun that is used for losing Emacsen.
619 (defun tcl-internal-mark-defun ()
620 "Put mark at end of Tcl function, point at beginning."
624 (if tcl-using-emacs-19
625 (push-mark (point) nil t)
627 (tcl-beginning-of-defun)
628 (backward-paragraph))
630 ;; In Emacs 19.23 and later, mark-defun works as advertised. I
631 ;; don't know about XEmacs, so for now it and Emacs 18 just lose.
632 (fset 'tcl-mark-defun
633 (if tcl-using-emacs-19-23
635 'tcl-internal-mark-defun))
637 ;; In Emacs 19, mark takes an additional "force" argument. I
638 ;; don't know about XEmacs, so I'm just assuming it is the same.
639 ;; Emacs 18 doesn't have this argument.
641 "Return mark, or nil if none."
642 (if tcl-using-emacs-19
649 ;; Some helper functions.
652 (defun tcl-set-proc-regexp ()
653 "Set `tcl-proc-regexp' from variable `tcl-proc-list'."
654 (setq tcl-proc-regexp (concat "^\\s-*\\("
655 (mapconcat 'identity tcl-proc-list "\\|")
658 (defun tcl-set-font-lock-keywords ()
659 "Set `tcl-font-lock-keywords'.
660 Uses variables `tcl-proc-regexp' and `tcl-keyword-list'."
661 (setq tcl-font-lock-keywords
663 ;; Names of functions (and other "defining things").
664 (list (concat tcl-proc-regexp "\\([^ \t\n]+\\)")
665 2 'font-lock-function-name-face)
667 ;; Names of type-defining things.
668 (list (concat "\\(\\s-\\|^\\)\\("
669 ;; FIXME Use 'regexp-quote?
670 (mapconcat 'identity tcl-typeword-list "\\|")
672 2 'font-lock-type-face)
674 ;; Keywords. Only recognized if surrounded by whitespace.
675 ;; FIXME consider using "not word or symbol", not
677 (cons (concat "\\(\\s-\\|^\\)\\("
678 ;; FIXME Use regexp-quote?
679 (mapconcat 'identity tcl-keyword-list "\\|")
686 (tcl-set-proc-regexp))
688 (if tcl-font-lock-keywords
690 (tcl-set-font-lock-keywords))
700 "Major mode for editing Tcl code.
701 Expression and list commands understand all Tcl brackets.
702 Tab indents for Tcl code.
703 Paragraphs are separated by blank lines only.
704 Delete converts tabs to spaces as it moves back.
706 Variables controlling indentation style:
708 Indentation of Tcl statements within surrounding block.
709 tcl-continued-indent-level
710 Indentation of continuation line relative to first line of command.
712 Variables controlling user interaction with mode (see variable
713 documentation for details):
714 tcl-tab-always-indent
715 Controls action of TAB key.
717 Non-nil means automatically newline before and after braces, brackets,
718 and semicolons inserted in Tcl code.
719 tcl-electric-hash-style
720 Controls action of `#' key.
721 tcl-use-hairy-comment-detector
722 If t, use more complicated, but slower, comment detector.
723 This variable is only used in Emacs 19.
724 tcl-use-smart-word-finder
725 If not nil, use a smarter, Tcl-specific way to find the current
726 word when looking up help on a Tcl command.
728 Turning on Tcl mode calls the value of the variable `tcl-mode-hook'
729 with no args, if that value is non-nil. Read the documentation for
730 `tcl-mode-hook' to see what kinds of interesting hook functions
736 (kill-all-local-variables)
737 (use-local-map tcl-mode-map)
738 (setq major-mode 'tcl-mode)
739 (setq mode-name "Tcl")
740 (setq local-abbrev-table tcl-mode-abbrev-table)
741 (set-syntax-table tcl-mode-syntax-table)
743 (make-local-variable 'paragraph-start)
744 (make-local-variable 'paragraph-separate)
745 (if (and tcl-using-emacs-19-23
746 (>= emacs-minor-version 29))
748 ;; In Emacs 19.29, you aren't supposed to start these with a ^.
749 (setq paragraph-start "$\\|
\f")
750 (setq paragraph-separate paragraph-start))
751 (setq paragraph-start (concat "^$\\|" page-delimiter))
752 (setq paragraph-separate paragraph-start))
753 (make-local-variable 'paragraph-ignore-fill-prefix)
754 (setq paragraph-ignore-fill-prefix t)
755 (make-local-variable 'fill-paragraph-function)
756 (setq fill-paragraph-function 'tcl-do-fill-paragraph)
758 (make-local-variable 'indent-line-function)
759 (setq indent-line-function 'tcl-indent-line)
760 ;; Tcl doesn't require a final newline.
761 ;; (make-local-variable 'require-final-newline)
762 ;; (setq require-final-newline t)
764 (make-local-variable 'comment-start)
765 (setq comment-start "# ")
766 (make-local-variable 'comment-start-skip)
767 (setq comment-start-skip "#+ *")
768 (make-local-variable 'comment-column)
769 (setq comment-column 40)
770 (make-local-variable 'comment-end)
771 (setq comment-end "")
773 (make-local-variable 'outline-regexp)
774 (setq outline-regexp "[^\n\^M]")
775 (make-local-variable 'outline-level)
776 (setq outline-level 'tcl-outline-level)
778 (make-local-variable 'font-lock-defaults)
779 (setq font-lock-defaults
780 '(tcl-font-lock-keywords))
782 (make-local-variable 'imenu-create-index-function)
783 (setq imenu-create-index-function 'tcl-imenu-create-index-function)
784 (make-local-variable 'parse-sexp-ignore-comments)
786 ;; Settings for new dabbrev code.
787 (make-local-variable 'dabbrev-case-fold-search)
788 (setq dabbrev-case-fold-search nil)
789 (make-local-variable 'dabbrev-case-replace)
790 (setq dabbrev-case-replace nil)
791 (make-local-variable 'dabbrev-abbrev-skip-leading-regexp)
792 (setq dabbrev-abbrev-skip-leading-regexp "[$!]")
793 (make-local-variable 'dabbrev-abbrev-char-regexp)
794 (setq dabbrev-abbrev-char-regexp "\\sw\\|\\s_")
796 (if tcl-using-emacs-19
798 ;; This can only be set to t in Emacs 19 and XEmacs.
799 ;; Emacs 18 and Epoch lose.
800 (setq parse-sexp-ignore-comments t)
801 ;; XEmacs has defun-prompt-regexp, but I don't believe
802 ;; that it works for end-of-defun -- only for
803 ;; beginning-of-defun.
804 (make-local-variable 'defun-prompt-regexp)
805 (setq defun-prompt-regexp tcl-omit-ws-regexp)
806 ;; The following doesn't work in Lucid Emacs 19.6, but maybe
807 ;; it will appear in later versions.
808 (make-local-variable 'add-log-current-defun-function)
809 (setq add-log-current-defun-function 'add-log-tcl-defun))
810 (setq parse-sexp-ignore-comments nil))
812 ;; Put Tcl menu into menubar for XEmacs. This happens
813 ;; automatically in Emacs.
814 (if (and tcl-using-xemacs-19
816 (not (assoc "Tcl" current-menubar)))
818 (set-buffer-menubar (copy-sequence current-menubar))
819 (add-menu nil "Tcl" tcl-xemacs-menu)))
820 ;; Append Tcl menu to popup menu for XEmacs.
821 (if (and tcl-using-xemacs-19 (boundp 'mode-popup-menu))
822 (setq mode-popup-menu
823 (cons (concat mode-name " Mode Commands") tcl-xemacs-menu)))
825 ;; If hilit19 is loaded, add our stuff.
826 (if (featurep 'hilit19)
829 (run-hooks 'tcl-mode-hook))
833 ;; This is used for braces, brackets, and semi (except for closing
834 ;; braces, which are handled specially).
835 (defun tcl-electric-char (arg)
836 "Insert character and correct line's indentation."
838 ;; Indent line first; this looks better if parens blink.
840 (self-insert-command arg)
841 (if (and tcl-auto-newline (= last-command-char ?\;))
846 ;; This is used for closing braces. If tcl-auto-newline is set, can
847 ;; insert a newline both before and after the brace, depending on
848 ;; context. FIXME should this be configurable? Does anyone use this?
849 (defun tcl-electric-brace (arg)
850 "Insert character and correct line's indentation."
852 ;; If auto-newlining and there is stuff on the same line, insert a
857 (skip-chars-backward " \t")
862 ;; In auto-newline case, must insert a newline after each
863 ;; brace. So an explicit loop is needed.
865 (insert last-command-char)
868 (setq arg (1- arg))))
869 (self-insert-command arg))
874 (defun tcl-indent-command (&optional arg)
875 "Indent current line as Tcl code, or in some cases insert a tab character.
876 If `tcl-tab-always-indent' is t (the default), always indent current line.
877 If `tcl-tab-always-indent' is nil and point is not in the indentation
878 area at the beginning of the line, a TAB is inserted.
879 Other values of `tcl-tab-always-indent' cause the first possible action
880 from the following list to take place:
882 1. Move from beginning of line to correct indentation.
883 2. Delete an empty comment.
884 3. Move forward to start of comment, indenting if necessary.
885 4. Move forward to end of line, indenting if necessary.
886 5. Create an empty comment.
887 6. Move backward to start of comment, indenting if necessary."
890 ((not tcl-tab-always-indent)
891 ;; Indent if in indentation area, otherwise insert TAB.
892 (if (<= (current-column) (current-indentation))
895 ((eq tcl-tab-always-indent t)
899 ;; "Perl-mode" style TAB command.
900 (let* ((ipoint (point))
904 (comment-p (tcl-in-comment)))
906 ((= ipoint (save-excursion
911 ;; If indenting didn't leave us in column 0, go to the
912 ;; indentation. Otherwise leave point at end of line. This
914 (if (= (point) (save-excursion
918 (back-to-indentation)))
919 ((and comment-p (looking-at "[ \t]*$"))
920 ;; Empty comment, so delete it. We also delete any ";"
921 ;; characters at the end of the line. I think this is
922 ;; friendlier, but I don't know how other people will feel.
924 (skip-chars-backward " \t;")
925 (delete-region (point) eolpoint))
926 ((and comment-p (< ipoint (point)))
927 ;; Before comment, so skip to it.
929 (indent-for-comment))
930 ((/= ipoint eolpoint)
931 ;; Go to end of line (since we're not there yet).
936 (tcl-indent-for-comment))
938 ;; Go to start of comment. We don't leave point where it is
939 ;; because we want to skip comment-start-skip.
941 (indent-for-comment)))))))
943 (defun tcl-indent-line ()
944 "Indent current line as Tcl code.
945 Return the amount the indentation changed by."
946 (let ((indent (calculate-tcl-indent nil))
948 (case-fold-search nil)
949 (pos (- (point-max) (point))))
952 (cond ((eq indent nil)
953 (setq indent (current-indentation)))
955 (skip-chars-forward " \t")
956 (if (listp indent) (setq indent (car indent)))
957 (cond ((= (following-char) ?})
958 (setq indent (- indent tcl-indent-level)))
959 ((= (following-char) ?\])
960 (setq indent (- indent 1))))))
961 (skip-chars-forward " \t")
962 (setq shift-amt (- indent (current-column)))
963 (if (zerop shift-amt)
964 (if (> (- (point-max) pos) (point))
965 (goto-char (- (point-max) pos)))
966 (delete-region beg (point))
968 ;; If initial point was within line's indentation,
969 ;; position after the indentation. Else stay at same point in text.
970 (if (> (- (point-max) pos) (point))
971 (goto-char (- (point-max) pos))))
974 (defun tcl-figure-type ()
975 "Determine type of sexp at point.
976 This is either `tcl-expr', `tcl-commands', or nil. Puts point at start
977 of sexp that indicates types.
979 See documentation for variable `tcl-type-alist' for more information."
983 (while (and (< count 5)
987 ;; FIXME should use "tcl-backward-sexp", which would skip
988 ;; over entire variables, etc.
990 (if (looking-at "[a-zA-Z_]+")
991 (let ((list tcl-type-alist)
993 (setq word-stack (cons (tcl-word-no-props) word-stack))
994 (while (and list (not result))
995 (setq entry (car list))
996 (setq list (cdr list))
998 (while (and entry (<= index count))
999 ;; Abort loop if string does not match word on
1001 (and (stringp (car entry))
1002 (not (string= (car entry)
1003 (nth index word-stack)))
1005 (setq entry (cdr entry))
1006 (setq index (1+ index)))
1007 (and (> index count)
1008 (not (stringp (car entry)))
1009 (setq result (car entry)))
1011 (setq word-stack (cons nil word-stack))))
1013 (setq count (1+ count)))
1014 (and tcl-explain-indentation
1015 (message "Indentation type %s" result))
1018 (defun calculate-tcl-indent (&optional parse-start)
1019 "Return appropriate indentation for current line as Tcl code.
1020 In usual case returns an integer: the column to indent to.
1021 Returns nil if line starts inside a string, t if in a comment."
1024 (let* ((indent-point (point))
1025 (case-fold-search nil)
1031 (= ?\\ (preceding-char)))))
1032 (continued-indent-value (if continued-line
1033 tcl-continued-indent-level
1039 (goto-char parse-start)
1040 (tcl-beginning-of-defun))
1041 (while (< (point) indent-point)
1042 (setq parse-start (point))
1043 (setq state (parse-partial-sexp (point) indent-point 0))
1044 (setq containing-sexp (car (cdr state))))
1045 (cond ((or (nth 3 state) (nth 4 state))
1046 ;; Inside comment or string. Return nil or t if should
1047 ;; not change this line
1049 ((null containing-sexp)
1050 ;; Line is at top level.
1051 continued-indent-value)
1053 ;; Set expr-p if we are looking at the expression part of
1054 ;; an "if", "expr", etc statement. Set commands-p if we
1055 ;; are looking at the body part of an if, while, etc
1056 ;; statement. FIXME Should check for "for" loops here.
1057 (goto-char containing-sexp)
1058 (let* ((sexpr-type (tcl-figure-type))
1059 (expr-p (eq sexpr-type 'tcl-expr))
1060 (commands-p (eq sexpr-type 'tcl-commands))
1061 (expr-start (point)))
1062 ;; Find the first statement in the block and indent
1063 ;; like it. The first statement in the block might be
1064 ;; on the same line, so what we do is skip all
1065 ;; "virtually blank" lines, looking for a non-blank
1066 ;; one. A line is virtually blank if it only contains
1067 ;; a comment and whitespace. FIXME continued comments
1068 ;; aren't supported. They are a wart on Tcl anyway.
1069 ;; We do it this funky way because we want to know if
1070 ;; we've found a statement on some line _after_ the
1071 ;; line holding the sexp opener.
1072 (goto-char containing-sexp)
1074 (if (and (< (point) indent-point)
1075 (looking-at "[ \t]*\\(#.*\\)?$"))
1078 (while (and (< (point) indent-point)
1079 (looking-at "[ \t]*\\(#.*\\)?$"))
1080 (setq found-next-line t)
1082 (if (or continued-line
1083 (/= (char-after containing-sexp) ?{)
1086 ;; Line is continuation line, or the sexp opener
1087 ;; is not a curly brace, or we are are looking at
1088 ;; an `expr' expression (which must be split
1089 ;; specially). So indentation is column of first
1090 ;; good spot after sexp opener (with some added
1091 ;; in the continued-line case). If there is no
1092 ;; nonempty line before the indentation point, we
1093 ;; use the column of the character after the sexp
1095 (if (>= (point) indent-point)
1097 (goto-char containing-sexp)
1099 (skip-chars-forward " \t"))
1100 (+ (current-column) continued-indent-value))
1101 ;; After a curly brace, and not a continuation line.
1102 ;; So take indentation from first good line after
1103 ;; start of block, unless that line is on the same
1104 ;; line as the opening brace. In this case use the
1105 ;; indentation of the opening brace's line, plus
1106 ;; another indent step. If we are in the body part
1107 ;; of an "if" or "while" then the indentation is
1108 ;; taken from the line holding the start of the
1110 (if (and (< (point) indent-point)
1112 (current-indentation)
1114 (goto-char expr-start)
1115 (goto-char containing-sexp))
1116 (+ (current-indentation) tcl-indent-level)))))))))
1120 (defun indent-tcl-exp ()
1121 "Indent each line of the Tcl grouping following point."
1123 (let ((indent-stack (list nil))
1124 (contain-stack (list (point)))
1125 (case-fold-search nil)
1126 outer-loop-done inner-loop-done state ostate
1127 this-indent last-sexp continued-line
1133 (setq outer-loop-done nil)
1134 (while (and (not (eobp)) (not outer-loop-done))
1135 (setq last-depth next-depth)
1136 ;; Compute how depth changes over this line
1137 ;; plus enough other lines to get to one that
1138 ;; does not end inside a comment or string.
1139 ;; Meanwhile, do appropriate indentation on comment lines.
1140 (setq inner-loop-done nil)
1141 (while (and (not inner-loop-done)
1142 (not (and (eobp) (setq outer-loop-done t))))
1144 (setq state (parse-partial-sexp (point) (progn (end-of-line) (point))
1146 (setq next-depth (car state))
1147 (if (and (car (cdr (cdr state)))
1148 (>= (car (cdr (cdr state))) 0))
1149 (setq last-sexp (car (cdr (cdr state)))))
1150 (if (or (nth 4 ostate))
1152 (if (or (nth 3 state))
1154 (setq inner-loop-done t)))
1155 (if (<= next-depth 0)
1156 (setq outer-loop-done t))
1159 ;; If this line had ..))) (((.. in it, pop out of the levels
1160 ;; that ended anywhere in this line, even if the final depth
1161 ;; doesn't indicate that they ended.
1162 (while (> last-depth (nth 6 state))
1163 (setq indent-stack (cdr indent-stack)
1164 contain-stack (cdr contain-stack)
1165 last-depth (1- last-depth)))
1166 (if (/= last-depth next-depth)
1167 (setq last-sexp nil))
1168 ;; Add levels for any parens that were started in this line.
1169 (while (< last-depth next-depth)
1170 (setq indent-stack (cons nil indent-stack)
1171 contain-stack (cons nil contain-stack)
1172 last-depth (1+ last-depth)))
1173 (if (null (car contain-stack))
1174 (setcar contain-stack
1175 (or (car (cdr state))
1180 (setq continued-line
1183 (= (preceding-char) ?\\)))
1184 (skip-chars-forward " \t")
1187 (if (and (car indent-stack)
1188 (>= (car indent-stack) 0))
1189 ;; Line is on an existing nesting level.
1190 (setq this-indent (car indent-stack))
1191 ;; Just started a new nesting level.
1192 ;; Compute the standard indent for this level.
1193 (let ((val (calculate-tcl-indent
1194 (if (car indent-stack)
1195 (- (car indent-stack))))))
1196 (setcar indent-stack
1197 (setq this-indent val))
1198 (setq continued-line nil)))
1199 (cond ((not (numberp this-indent)))
1200 ((= (following-char) ?})
1201 (setq this-indent (- this-indent tcl-indent-level)))
1202 ((= (following-char) ?\])
1203 (setq this-indent (- this-indent 1))))
1204 ;; Put chosen indentation into effect.
1205 (or (null this-indent)
1208 (+ this-indent tcl-indent-level)
1211 (delete-region (point) (progn (beginning-of-line) (point)))
1214 (+ this-indent tcl-indent-level)
1215 this-indent)))))))))
1221 ;; Interfaces to other packages.
1224 (defun tcl-imenu-create-index-function ()
1225 "Generate alist of indices for imenu."
1226 (let ((re (concat tcl-proc-regexp "\\([^ \t\n{]+\\)"))
1228 (goto-char (point-min))
1229 (imenu-progress-message prev-pos 0)
1231 (while (re-search-forward re nil t)
1232 (imenu-progress-message prev-pos)
1233 ;; Position on start of proc name, not beginning of line.
1235 (cons (buffer-substring (match-beginning 2) (match-end 2))
1236 (match-beginning 2))
1238 (imenu-progress-message prev-pos 100)
1241 ;; FIXME Definition of function is very ad-hoc. Should use
1242 ;; tcl-beginning-of-defun. Also has incestuous knowledge about the
1243 ;; format of tcl-proc-regexp.
1244 (defun add-log-tcl-defun ()
1245 "Return name of Tcl function point is in, or nil."
1248 (if (re-search-backward (concat tcl-proc-regexp "\\([^ \t\n{]+\\)") nil t)
1249 (buffer-substring (match-beginning 2)
1252 (defun tcl-outline-level ()
1254 (skip-chars-forward " \t")
1260 ;; Helper functions for inferior Tcl mode.
1263 ;; This exists to let us delete the prompt when commands are sent
1264 ;; directly to the inferior Tcl. See gud.el for an explanation of how
1265 ;; it all works (I took it from there). This stuff doesn't really
1266 ;; work as well as I'd like it to. But I don't believe there is
1267 ;; anything useful that can be done.
1268 (defvar inferior-tcl-delete-prompt-marker nil)
1270 (defun tcl-filter (proc string)
1271 (let ((inhibit-quit t))
1273 (set-buffer (process-buffer proc))
1274 (goto-char (process-mark proc))
1275 ;; Delete prompt if requested.
1276 (if (marker-buffer inferior-tcl-delete-prompt-marker)
1278 (delete-region (point) inferior-tcl-delete-prompt-marker)
1279 (set-marker inferior-tcl-delete-prompt-marker nil)))))
1280 (if tcl-using-emacs-19
1281 (comint-output-filter proc string)
1282 (funcall comint-output-filter string)))
1284 (defun tcl-send-string (proc string)
1286 (set-buffer (process-buffer proc))
1287 (goto-char (process-mark proc))
1289 (if (looking-at comint-prompt-regexp)
1290 (set-marker inferior-tcl-delete-prompt-marker (point))))
1291 (comint-send-string proc string))
1293 (defun tcl-send-region (proc start end)
1295 (set-buffer (process-buffer proc))
1296 (goto-char (process-mark proc))
1298 (if (looking-at comint-prompt-regexp)
1299 (set-marker inferior-tcl-delete-prompt-marker (point))))
1300 (comint-send-region proc start end))
1302 (defun switch-to-tcl (eob-p)
1303 "Switch to inferior Tcl process buffer.
1304 With argument, positions cursor at end of buffer."
1306 (if (get-buffer inferior-tcl-buffer)
1307 (pop-to-buffer inferior-tcl-buffer)
1308 (error "No current inferior Tcl buffer"))
1311 (goto-char (point-max)))))
1313 (defun inferior-tcl-proc ()
1314 "Return current inferior Tcl process.
1315 See variable `inferior-tcl-buffer'."
1316 (let ((proc (get-buffer-process (if (eq major-mode 'inferior-tcl-mode)
1318 inferior-tcl-buffer))))
1320 (error "No Tcl process; see variable `inferior-tcl-buffer'"))))
1322 (defun tcl-eval-region (start end &optional and-go)
1323 "Send the current region to the inferior Tcl process.
1324 Prefix argument means switch to the Tcl buffer afterwards."
1325 (interactive "r\nP")
1326 (let ((proc (inferior-tcl-proc)))
1327 (tcl-send-region proc start end)
1328 (tcl-send-string proc "\n")
1329 (if and-go (switch-to-tcl t))))
1331 (defun tcl-eval-defun (&optional and-go)
1332 "Send the current defun to the inferior Tcl process.
1333 Prefix argument means switch to the Tcl buffer afterwards."
1337 (let ((end (point)))
1338 (tcl-beginning-of-defun)
1339 (tcl-eval-region (point) end)))
1340 (if and-go (switch-to-tcl t)))
1345 ;; Inferior Tcl mode itself.
1348 (defun inferior-tcl-mode ()
1349 "Major mode for interacting with Tcl interpreter.
1351 A Tcl process can be started with M-x inferior-tcl.
1353 Entry to this mode runs the normal hooks `comint-mode-hook' and
1354 `inferior-tcl-mode-hook', in that order.
1356 You can send text to the inferior Tcl process from other buffers
1357 containing Tcl source.
1359 Variables controlling Inferior Tcl mode:
1361 Name of program to run.
1362 tcl-command-switches
1363 Command line arguments to `tcl-application'.
1366 inferior-tcl-source-command
1367 Command to use to read Tcl file in running application.
1369 The current inferior Tcl process buffer. See variable
1370 documentation for details on multiple-process support.
1372 The following commands are available:
1373 \\{inferior-tcl-mode-map}"
1376 (setq comint-prompt-regexp (or tcl-prompt-regexp
1378 (regexp-quote tcl-application)
1380 (setq major-mode 'inferior-tcl-mode)
1381 (setq mode-name "Inferior Tcl")
1382 (if (boundp 'modeline-process)
1383 (setq modeline-process '(": %s")) ; For XEmacs.
1384 (setq mode-line-process '(": %s")))
1385 (use-local-map inferior-tcl-mode-map)
1386 (setq local-abbrev-table tcl-mode-abbrev-table)
1387 (set-syntax-table tcl-mode-syntax-table)
1388 (if tcl-using-emacs-19
1390 (make-local-variable 'defun-prompt-regexp)
1391 (setq defun-prompt-regexp tcl-omit-ws-regexp)))
1392 (make-local-variable 'inferior-tcl-delete-prompt-marker)
1393 (setq inferior-tcl-delete-prompt-marker (make-marker))
1394 (set-process-filter (get-buffer-process (current-buffer)) 'tcl-filter)
1395 (run-hooks 'inferior-tcl-mode-hook))
1398 (defun inferior-tcl (cmd)
1399 "Run inferior Tcl process.
1400 Prefix arg means enter program name interactively.
1401 See documentation for function `inferior-tcl-mode' for more information."
1403 (list (if current-prefix-arg
1404 (read-string "Run Tcl: " tcl-application)
1406 (if (not (comint-check-proc "*inferior-tcl*"))
1408 (set-buffer (apply (function make-comint) "inferior-tcl" cmd nil
1409 tcl-command-switches))
1410 (inferior-tcl-mode)))
1411 (make-local-variable 'tcl-application)
1412 (setq tcl-application cmd)
1413 (setq inferior-tcl-buffer "*inferior-tcl*")
1414 (switch-to-buffer "*inferior-tcl*"))
1416 (and (fboundp 'defalias)
1417 (defalias 'run-tcl 'inferior-tcl))
1422 ;; Auto-fill support.
1425 (defun tcl-real-command-p ()
1426 "Return nil if point is not at the beginning of a command.
1427 A command is the first word on an otherwise empty line, or the
1428 first word following a semicolon, opening brace, or opening bracket."
1430 (skip-chars-backward " \t")
1435 ;; Note -- continued comments are not supported here. I
1436 ;; consider those to be a wart on the language.
1437 (not (eq ?\\ (preceding-char))))
1439 (memq (preceding-char) '(?\; ?{ ?\[))))))
1441 ;; FIXME doesn't actually return t. See last case.
1442 (defun tcl-real-comment-p ()
1443 "Return t if point is just after the `#' beginning a real comment.
1444 Does not check to see if previous char is actually `#'.
1445 A real comment is either at the beginning of the buffer,
1446 preceeded only by whitespace on the line, or has a preceeding
1447 semicolon, opening brace, or opening bracket on the same line."
1450 (tcl-real-command-p)))
1452 (defun tcl-hairy-scan-for-comment (state end always-stop)
1453 "Determine if point is in a comment.
1454 Returns a list of the form `(FLAG . STATE)'. STATE can be used
1455 as input to future invocations. FLAG is nil if not in comment,
1456 t otherwise. If in comment, leaves point at beginning of comment.
1458 This function does not work in Emacs 18.
1459 See also `tcl-simple-scan-for-comment', a
1460 simpler version that is often right, and works in Emacs 18."
1461 (let ((bol (save-excursion
1467 (while (and (not last-cstart) (< (point) end))
1468 (setq real-comment nil) ;In case we've looped around and it is
1470 (setq state (parse-partial-sexp (point) end nil nil state t))
1473 ;; If ALWAYS-STOP is set, stop even if we don't have a
1474 ;; real comment, or if the comment isn't on the same line
1476 (if always-stop (setq last-cstart (point)))
1477 ;; If we have a real comment, then set the comment
1478 ;; starting point if we are on the same line as the ending
1480 (setq real-comment (tcl-real-comment-p))
1483 (and (> (point) bol) (setq last-cstart (point)))
1484 ;; NOTE Emacs 19 has a misfeature whereby calling
1485 ;; parse-partial-sexp with COMMENTSTOP set and with
1486 ;; an initial list that says point is in a comment
1487 ;; will cause an immediate return. So we must skip
1488 ;; over the comment ourselves.
1489 (beginning-of-line 2)))
1490 ;; Frob the state to make it look like we aren't in a
1492 (setcar (nthcdr 4 state) nil))))
1494 (goto-char last-cstart))
1495 (cons real-comment state)))
1497 (defun tcl-hairy-in-comment ()
1498 "Return t if point is in a comment, and leave point at beginning of comment."
1499 (let ((save (point)))
1500 (tcl-beginning-of-defun)
1501 (car (tcl-hairy-scan-for-comment nil save nil))))
1503 (defun tcl-simple-in-comment ()
1504 "Return t if point is in comment, and leave point at beginning of comment.
1505 This is faster that `tcl-hairy-in-comment', but is correct less often."
1506 (let ((save (point))
1509 (while (and (< (point) save) (not comment))
1510 (search-forward "#" save 'move)
1511 (setq comment (tcl-real-comment-p)))
1514 (defun tcl-in-comment ()
1515 "Return t if point is in comment, and leave point at beginning of comment."
1516 (if (and tcl-pps-has-arg-6
1517 tcl-use-hairy-comment-detector)
1518 (tcl-hairy-in-comment)
1519 (tcl-simple-in-comment)))
1521 (defun tcl-do-fill-paragraph (ignore)
1522 "fill-paragraph function for Tcl mode. Only fills in a comment."
1523 (let (in-comment col where)
1526 (setq in-comment (tcl-in-comment))
1529 (setq where (1+ (point)))
1530 (setq col (1- (current-column))))))
1533 (back-to-indentation)
1534 (= col (current-column)))
1535 ;; In a comment. Set the fill prefix, and find the paragraph
1536 ;; boundaries by searching for lines that look like
1537 ;; comment-only lines.
1538 (let ((fill-prefix (buffer-substring (progn
1543 ;; Search backwards.
1545 (while (looking-at "^[ \t]*#")
1548 (setq p-start (point)))
1552 (while (looking-at "^[ \t]*#")
1554 (setq p-end (point)))
1556 ;; Narrow and do the fill.
1558 (narrow-to-region p-start p-end)
1559 (fill-paragraph ignore)))))
1562 (defun tcl-do-auto-fill ()
1563 "Auto-fill function for Tcl mode. Only auto-fills in a comment."
1564 (if (> (current-column) fill-column)
1565 (let ((fill-prefix "# ")
1568 (setq in-comment (tcl-in-comment))
1570 (setq col (1- (current-column)))))
1575 (back-to-indentation)
1576 (delete-region (point) (save-excursion
1579 (indent-to-column col)))))))
1584 ;; Help-related code.
1587 (defvar tcl-help-saved-dirs nil
1588 "Saved help directories.
1589 If `tcl-help-directory-list' changes, this allows `tcl-help-on-word'
1590 to update the alist.")
1592 (defvar tcl-help-alist nil
1593 "Alist with command names as keys and filenames as values.")
1595 (defun tcl-help-snarf-commands (dirlist)
1596 "Build alist of commands and filenames."
1598 (let ((files (directory-files (car dirlist) t)))
1600 (if (and (file-directory-p (car files))
1602 (let ((fpart (file-name-nondirectory (car files))))
1603 (or (equal fpart ".")
1604 (equal fpart "..")))))
1605 (let ((matches (directory-files (car files) t)))
1607 (or (file-directory-p (car matches))
1608 (setq tcl-help-alist
1610 (cons (file-name-nondirectory (car matches))
1613 (setq matches (cdr matches)))))
1614 (setq files (cdr files))))
1615 (setq dirlist (cdr dirlist))))
1617 (defun tcl-reread-help-files ()
1618 "Set up to re-read files, and then do it."
1620 (message "Building Tcl help file index...")
1621 (setq tcl-help-saved-dirs tcl-help-directory-list)
1622 (setq tcl-help-alist nil)
1623 (tcl-help-snarf-commands tcl-help-directory-list)
1624 (message "Building Tcl help file index...done"))
1626 (defun tcl-word-no-props ()
1627 "Like current-word, but strips properties."
1628 (let ((word (current-word)))
1629 (and (fboundp 'set-text-properties)
1630 (set-text-properties 0 (length word) nil word))
1633 (defun tcl-current-word (flag)
1634 "Return current command word, or nil.
1635 If FLAG is nil, just uses `current-word'.
1636 Otherwise scans backward for most likely Tcl command word."
1638 (memq major-mode '(tcl-mode inferior-tcl-mode)))
1641 ;; Look backward for first word actually in alist.
1644 (while (and (not (bobp))
1645 (not (tcl-real-command-p)))
1647 (if (assoc (tcl-word-no-props) tcl-help-alist)
1648 (tcl-word-no-props)))
1650 (tcl-word-no-props)))
1653 (defun tcl-help-on-word (command &optional arg)
1654 "Get help on Tcl command. Default is word at point.
1655 Prefix argument means invert sense of `tcl-use-smart-word-finder'."
1659 (if (not (equal tcl-help-directory-list tcl-help-saved-dirs))
1660 (tcl-reread-help-files))
1661 (let ((word (tcl-current-word
1662 (if current-prefix-arg
1663 (not tcl-use-smart-word-finder)
1664 tcl-use-smart-word-finder))))
1666 (if (or (null word) (string= word ""))
1667 "Help on Tcl command: "
1668 (format "Help on Tcl command (default %s): " word))
1669 tcl-help-alist nil t)))
1670 current-prefix-arg))
1671 (if (not (equal tcl-help-directory-list tcl-help-saved-dirs))
1672 (tcl-reread-help-files))
1673 (if (string= command "")
1674 (setq command (tcl-current-word
1676 (not tcl-use-smart-word-finder)
1677 tcl-use-smart-word-finder))))
1678 (let* ((help (get-buffer-create "*Tcl help*"))
1679 (cell (assoc command tcl-help-alist))
1680 (file (and cell (cdr cell))))
1682 (delete-region (point-min) (point-max))
1685 (insert "*** " command "\n\n")
1686 (insert-file-contents file))
1687 (if (string= command "")
1688 (insert "Magical Pig!")
1689 (insert "Tcl command " command " not in help\n")))
1690 (set-buffer-modified-p nil)
1691 (goto-char (point-min))
1692 (display-buffer help)))
1697 ;; Other interactive stuff.
1700 (defvar tcl-previous-dir/file nil
1701 "Record last directory and file used in loading.
1702 This holds a cons cell of the form `(DIRECTORY . FILE)'
1703 describing the last `tcl-load-file' command.")
1705 (defun tcl-load-file (file &optional and-go)
1706 "Load a Tcl file into the inferior Tcl process.
1707 Prefix argument means switch to the Tcl buffer afterwards."
1710 ;; car because comint-get-source returns a list holding the
1712 (car (comint-get-source "Load Tcl file: "
1714 (eq major-mode 'tcl-mode)
1716 tcl-previous-dir/file)
1718 current-prefix-arg))
1719 (comint-check-source file)
1720 (setq tcl-previous-dir/file (cons (file-name-directory file)
1721 (file-name-nondirectory file)))
1722 (tcl-send-string (inferior-tcl-proc)
1723 (format inferior-tcl-source-command (tcl-quote file)))
1724 (if and-go (switch-to-tcl t)))
1726 (defun tcl-restart-with-file (file &optional and-go)
1727 "Restart inferior Tcl with file.
1728 If an inferior Tcl process exists, it is killed first.
1729 Prefix argument means switch to the Tcl buffer afterwards."
1732 (car (comint-get-source "Restart with Tcl file: "
1734 (eq major-mode 'tcl-mode)
1736 tcl-previous-dir/file)
1738 current-prefix-arg))
1739 (let* ((buf (if (eq major-mode 'inferior-tcl-mode)
1741 inferior-tcl-buffer))
1742 (proc (and buf (get-process buf))))
1744 ((not (and buf (get-buffer buf)))
1745 ;; I think this will be ok.
1746 (inferior-tcl tcl-application)
1747 (tcl-load-file file and-go))
1749 (not (comint-check-proc buf))
1751 "A Tcl process is running, are you sure you want to reset it? "))
1753 (comint-check-source file)
1754 (setq tcl-previous-dir/file (cons (file-name-directory file)
1755 (file-name-nondirectory file)))
1756 (comint-exec (get-buffer-create buf)
1760 tcl-application file tcl-command-switches)
1761 (if and-go (switch-to-tcl t)))))))
1763 (defun tcl-auto-fill-mode (&optional arg)
1764 "Like `auto-fill-mode', but controls filling of Tcl comments."
1766 (and (not tcl-using-emacs-19)
1767 (error "This feature is not supported in Emacs 18"))
1768 ;; Following code taken from "auto-fill-mode" (simple.el).
1770 (setq auto-fill-function
1772 (not auto-fill-function)
1773 (> (prefix-numeric-value arg) 0))
1776 (force-mode-line-update)))
1778 ;; hilit19 support from "Chris Alfeld" <calfeld@math.utah.edu>
1780 (hilit-set-mode-patterns
1783 ("\\(^ *\\|\; *\\)#.*$" nil comment)
1784 ("[^\\]\\(\\$[A-Za-z0-9\\-\\_./\\(\\)]+\\)" 1 label)
1785 ("[^_]\\<\\(append\\|array\\|auto_execok\\|auto_load\\|auto_mkindex\\|auto_reset\\|break\\|case\\|catch\\|cd\\|close\\|concat\\|continue\\|eof\\|error\\|eval\\|exec\\|exit\\|expr\\|file\\|flush\\|for\\|foreach\\|format\\|gets\\|glob\\|global\\|history\\|if\\|incr\\|info\\|join\\|lappend\\|lindex\\|linsert\\|list\\|llength\\|lrange\\|lreplace\\|lsearch\\|lsort\\|open\\|pid\\|proc\\|puts\\|pwd\\|read\\|regexp\\|regsub\\|rename\\|return\\|scan\\|seek\\|set\\|source\\|split\\|string\\|switch\\|tell\\|time\\|trace\\|unknown\\|unset\\|uplevel\\|upvar\\|while\\)\\>[^_]" 1 keyword) ; tcl keywords
1786 ("[^_]\\<\\(after\\|bell\\|bind\\|bindtags\\|clipboard\\|destroy\\|fileevent\\|focus\\|grab\\|image\\|lower\\|option\\|pack\\|place\\|raise\\|scale\\|selection\\|send\\|subst\\|tk\\|tk_popup\\|tkwait\\|update\\|winfo\\|wm\\)\\>[^_]" 1 define) ; tk keywords
1787 ("[^_]\\<\\(button\\|canvas\\|checkbutton\\|entry\\|frame\\|label\\|listbox\\|menu\\|menubutton\\|message\\|radiobutton\\|scrollbar\\|text\\|toplevel\\)\\>[^_]" 1 decl) ; tk widgets
1788 ("[^_]\\<\\(tix\\((ButtonBox\\|Baloon\\|Control\\|DirList\\|ExFileSelectBox\\|ExFileSelectDialog\\|FileEntry\\|HList\\|LabelEntry\\|LabelFrame\\|NoteBook\\|OptionMenu\\|PanedWindow\\|PopupMenu\\|ScrolledHList\\|ScrolledText\\|ScrolledWindow\\|Select\\|StdButtonBox\\)\\)\\>[^_]" 1 defun) ; tix widgets
1789 ("[{}\\\"\\(\\)]" nil include) ; misc punctuation
1792 (defun tcl-electric-hash (&optional count)
1793 "Insert a `#' and quote if it does not start a real comment.
1794 Prefix arg is number of `#'s to insert.
1795 See variable `tcl-electric-hash-style' for description of quoting
1798 (or count (setq count 1))
1801 (if (eq tcl-electric-hash-style 'smart)
1802 (if (> count 3) ; FIXME what is "smart"?
1805 tcl-electric-hash-style))
1811 (setq comment (tcl-in-comment)))
1813 (and tcl-explain-indentation (message "comment: %s" comment))
1818 ((eq type 'backslash)
1819 ;; The following will set count to 0, so the
1820 ;; insert-char can still be run.
1824 (setq count (1- count)))))
1826 (insert-char ?# count))))
1828 (defun tcl-hashify-buffer ()
1829 "Quote all `#'s in current buffer that aren't Tcl comments."
1832 (goto-char (point-min))
1833 (if (and tcl-pps-has-arg-6 tcl-use-hairy-comment-detector)
1836 (while (< (point) (point-max))
1837 (setq result (tcl-hairy-scan-for-comment state (point-max) t))
1839 (beginning-of-line 2)
1841 (if (eq ?# (following-char))
1844 (setq state (cdr result))))
1845 (while (and (< (point) (point-max))
1846 (search-forward "#" nil 'move))
1847 (if (tcl-real-comment-p)
1848 (beginning-of-line 2)
1849 ;; There's really no good way for the simple converter to
1850 ;; work. So we just quote # if it isn't already quoted.
1851 ;; Bogus, but it works.
1853 (if (not (eq ?\\ (preceding-char)))
1857 (defun tcl-indent-for-comment ()
1858 "Indent this line's comment to comment column, or insert an empty comment.
1859 Is smart about syntax of Tcl comments.
1860 Parts of this were taken from `indent-for-comment'."
1863 (or (tcl-in-comment)
1865 ;; Not in a comment, so we have to insert one. Create an
1866 ;; empty comment (since there isn't one on this line). If
1867 ;; line is not blank, make sure we insert a ";" first.
1868 (skip-chars-backward " \t")
1869 (let ((eolpoint (point)))
1871 (if (/= (point) eolpoint)
1873 (goto-char eolpoint)
1875 (if (tcl-real-command-p) "" ";")
1877 (backward-char))))))
1878 ;; Point is just after the "#" starting a comment. Move it as
1880 (let* ((indent (funcall comment-indent-function))
1884 (if (/= begpos indent)
1886 (skip-chars-backward " \t" (save-excursion
1889 (delete-region (point) begpos)
1890 (indent-to indent)))
1891 (looking-at comment-start-skip) ; Always true.
1892 (goto-char (match-end 0))
1893 ;; I don't like the effect of the next two.
1894 ;;(skip-chars-backward " \t" (match-beginning 0))
1895 ;;(skip-chars-backward "^ \t" (match-beginning 0))
1898 ;; The following was inspired by the Tcl editing mode written by
1899 ;; Gregor Schmid <schmid@fb3-s7.math.TU-Berlin.DE>. His version also
1900 ;; attempts to snarf the command line options from the command line,
1901 ;; but I didn't think that would really be that helpful (doesn't seem
1902 ;; like it owould be right enough. His version also looks for the
1903 ;; "#!/bin/csh ... exec" hack, but that seemed even less useful.
1904 ;; FIXME should make sure that the application mentioned actually
1906 (defun tcl-guess-application ()
1907 "Attempt to guess Tcl application by looking at first line.
1908 The first line is assumed to look like \"#!.../program ...\"."
1910 (goto-char (point-min))
1911 (if (looking-at "#![^ \t]*/\\([^ \t\n/]+\\)\\([ \t]\\|$\\)")
1913 (make-local-variable 'tcl-application)
1914 (setq tcl-application (buffer-substring (match-beginning 1)
1917 ;; This only exists to put on the menubar. I couldn't figure out any
1918 ;; other way to do it. FIXME should take "number of #-marks"
1920 (defun tcl-uncomment-region (beg end)
1923 (comment-region beg end -1))
1928 ;; XEmacs menu support.
1929 ;; Taken from schmid@fb3-s7.math.TU-Berlin.DE (Gregor Schmid),
1930 ;; who wrote a different Tcl mode.
1931 ;; We also have support for menus in Emacs. We do this by
1932 ;; loading the XEmacs menu emulation code.
1935 (defun tcl-popup-menu (e)
1937 (and tcl-using-emacs-19
1938 (not tcl-using-xemacs-19)
1939 (if tcl-using-emacs-19-23
1942 ;; * lmenu.el provides 'menubar, which is bogus.
1943 ;; * lmenu.el causes menubars to be turned on everywhere.
1945 ;; Both of these problems are fixed in Emacs 19.23. People
1946 ;; using an Emacs before that just suffer.
1947 (require 'menubar "lmenu"))) ;; This is annoying
1948 ;; IMHO popup-menu should be autoloaded. Oh well.
1949 (popup-menu tcl-xemacs-menu))
1954 ;; Quoting and unquoting functions.
1957 ;; This quoting is sufficient to protect eg a filename from any sort
1958 ;; of expansion or splitting. Tcl quoting sure sucks.
1959 (defun tcl-quote (string)
1960 "Quote STRING according to Tcl rules."
1961 (mapconcat (function (lambda (char)
1962 (if (memq char '(?[ ?] ?{ ?} ?\\ ?\" ?$ ? ?\;))
1963 (concat "\\" (char-to-string char))
1964 (char-to-string char))))
1973 (and (fboundp 'eval-when-compile)
1975 (require 'reporter)))
1977 (defun tcl-submit-bug-report ()
1978 "Submit via mail a bug report on Tcl mode."
1982 (y-or-n-p "Do you really want to submit a bug report on Tcl mode? ")
1983 (reporter-submit-bug-report
1985 (concat "Tcl mode " tcl-version)
1987 tcl-continued-indent-level
1989 tcl-tab-always-indent
1990 tcl-use-hairy-comment-detector
1991 tcl-electric-hash-style
1992 tcl-help-directory-list
1993 tcl-use-smart-word-finder
1995 tcl-command-switches
1997 inferior-tcl-source-command
1999 tcl-using-emacs-19-23
2005 tcl-font-lock-keywords
2006 tcl-pps-has-arg-6))))
2012 ;;; tcl.el ends here