code.delx.au - gnu-emacs/blob - lisp/progmodes/tcl.el

   1 ;; tcl.el --- Tcl code editing commands for Emacs
   2
   3 ;; Copyright (C) 1994, 1998, 1999 Free Software Foundation, Inc.
   4
   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.59 $
  10
  11 ;; This file is part of GNU Emacs.
  12
  13 ;; GNU Emacs is free software; you can redistribute it and/or modify
  14 ;; it under the terms of the GNU General Public License as published by
  15 ;; the Free Software Foundation; either version 2, or (at your option)
  16 ;; any later version.
  17
  18 ;; GNU Emacs is distributed in the hope that it will be useful,
  19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 ;; GNU General Public License for more details.
  22
  23 ;; You should have received a copy of the GNU General Public License
  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.
  27
  28 ;; BEFORE USE:
  29 ;;
  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:
  33 ;;
  34 ;;   (setq tcl-help-directory-list '("/usr/local/lib/tclx/help"))
  35 ;;
  36 ;;; Commentary:
  37
  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
  41 ;; list.
  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.
  47
  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>
  64
  65 ;; KNOWN BUGS:
  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.
  73
  74 ;; TODO:
  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:
  80 ;;      [list something \
  81 ;;            something-else]
  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
  90 ;;   line individually.
  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
  99 ;;   common cases).
 100 ;; * `#' shouldn't insert `\#' when point is in string.
 101
 102 \f
 103
 104 ;;; Code:
 105
 106 ;; I sure wish Emacs had a package that made it easy to extract this
 107 ;; sort of information.  Strange definition works with XEmacs 20.0.
 108 (defconst tcl-using-emacs-19 (not (string-match "18\\." emacs-version))
 109   "Non-nil if using Emacs 19.")
 110
 111 (defconst tcl-using-emacs-19-23
 112   (or (string-match "19\\.\\(2[3-9]\\|[3-9][0-9]\\)" emacs-version)
 113       (string-match "^20\\." emacs-version))
 114   "Non-nil if using Emacs 19-23 or later.")
 115
 116 (defconst tcl-using-xemacs-19 (string-match "XEmacs" emacs-version)
 117   "Non-nil if using XEmacs.")
 118
 119 (require 'comint)
 120
 121 ;; When compiling under Emacs, load imenu during compilation.  If
 122 ;; you have 19.22 or earlier, comment this out, or get imenu.
 123 (and (fboundp 'eval-when-compile)
 124      (eval-when-compile
 125        (if (and (string-match "19\\." emacs-version)
 126                 (not (string-match "XEmacs" emacs-version)))
 127            (require 'imenu))
 128        ()))
 129
 130 (defconst tcl-version "$Revision: 1.59 $")
 131 (defconst tcl-maintainer "Tom Tromey <tromey@drip.colorado.edu>")
 132
 133 ;;
 134 ;; User variables.
 135 ;;
 136
 137 (defgroup tcl nil
 138   "Major mode for editing Tcl source in Emacs"
 139   :group 'languages)
 140
 141 (defcustom tcl-indent-level 4
 142   "*Indentation of Tcl statements with respect to containing block."
 143   :group 'tcl
 144   :type 'integer)
 145
 146 (defcustom tcl-continued-indent-level 4
 147   "*Indentation of continuation line relative to first line of command."
 148   :group 'tcl
 149   :type 'integer)
 150
 151 (defcustom tcl-auto-newline nil
 152   "*Non-nil means automatically newline before and after braces you insert."
 153   :group 'tcl
 154   :type 'boolean)
 155
 156 (defcustom tcl-tab-always-indent t
 157   "*Control effect of TAB key.
 158 If t (the default), always indent current line.
 159 If nil and point is not in the indentation area at the beginning of
 160 the line, a TAB is inserted.
 161 Other values cause the first possible action from the following list
 162 to take place:
 163
 164   1. Move from beginning of line to correct indentation.
 165   2. Delete an empty comment.
 166   3. Move forward to start of comment, indenting if necessary.
 167   4. Move forward to end of line, indenting if necessary.
 168   5. Create an empty comment.
 169   6. Move backward to start of comment, indenting if necessary."
 170   :group 'tcl
 171   :type '(choice (const :tag "Always" t)
 172                  (const :tag "Beginning only" nil)
 173                  (const :tag "Maybe move or make or delete comment" 'tcl)))
 174
 175
 176 (defcustom tcl-use-hairy-comment-detector t
 177   "*If not nil, use the more sophisticated, but slower, comment-delete method.
 178 This variable is not effective in Emacs 18;
 179 the fast function is always used in that version."
 180   :group 'tcl
 181   :type 'boolean)
 182
 183 (defcustom tcl-electric-hash-style 'smart
 184   "*Style of electric hash insertion to use.
 185 Possible values are `backslash', meaning that `\\' quoting should be
 186 done; `quote', meaning that `\"' quoting should be done; `smart',
 187 meaning that the choice between `backslash' and `quote' should be
 188 made depending on the number of hashes inserted; or nil, meaning that
 189 no quoting should be done.  Any other value for this variable is
 190 taken to mean `smart'.  The default is `smart'."
 191   :group 'tcl
 192   :type '(choice (const backslash) (const quote) (const smart) (const nil)))
 193
 194 (defcustom tcl-help-directory-list nil
 195   "*List of topmost directories containing TclX help files."
 196   :group 'tcl
 197   :type '(list directory))
 198
 199 (defcustom tcl-use-smart-word-finder t
 200   "*If not nil, use smart way to find current word, for Tcl help feature."
 201   :group 'tcl
 202   :type 'boolean)
 203
 204 (defcustom tcl-application "wish"
 205   "*Name of Tcl program to run in inferior Tcl mode."
 206   :group 'tcl
 207   :type 'string)
 208
 209 (defcustom tcl-command-switches nil
 210   "*List of switches to supply to the `tcl-application' program."
 211   :group 'tcl
 212   :type '(list string))
 213
 214 (defcustom tcl-prompt-regexp "^\\(% \\|\\)"
 215   "*If not nil, a regexp that will match the prompt in the inferior process.
 216 If nil, the prompt is the name of the application with \">\" appended.
 217
 218 The default is \"^\\(% \\|\\)\", which will match the default primary
 219 and secondary prompts for tclsh and wish."
 220   :group 'tcl
 221   :type 'regexp)
 222
 223 (defcustom inferior-tcl-source-command "source %s\n"
 224   "*Format-string for building a Tcl command to load a file.
 225 This format string should use `%s' to substitute a file name
 226 and should result in a Tcl expression that will command the
 227 inferior Tcl to load that file.  The filename will be appropriately
 228 quoted for Tcl."
 229   :group 'tcl
 230   :type 'string)
 231
 232 ;;
 233 ;; Keymaps, abbrevs, syntax tables.
 234 ;;
 235
 236 (defvar tcl-mode-abbrev-table nil
 237   "Abbrev table in use in Tcl-mode buffers.")
 238 (if tcl-mode-abbrev-table
 239     ()
 240   (define-abbrev-table 'tcl-mode-abbrev-table ()))
 241
 242 (defvar tcl-mode-map ()
 243   "Keymap used in Tcl mode.")
 244
 245 (defvar tcl-mode-syntax-table nil
 246   "Syntax table in use in Tcl-mode buffers.")
 247 (if tcl-mode-syntax-table
 248     ()
 249   (setq tcl-mode-syntax-table (make-syntax-table))
 250   (modify-syntax-entry ?%  "_" tcl-mode-syntax-table)
 251   (modify-syntax-entry ?@  "_" tcl-mode-syntax-table)
 252   (modify-syntax-entry ?&  "_" tcl-mode-syntax-table)
 253   (modify-syntax-entry ?*  "_" tcl-mode-syntax-table)
 254   (modify-syntax-entry ?+  "_" tcl-mode-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) ; FIXME use "'"?
 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)
 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 ?\n ">   " tcl-mode-syntax-table)
 270   (modify-syntax-entry ?\f ">   " tcl-mode-syntax-table)
 271   (modify-syntax-entry ?# "<   " tcl-mode-syntax-table))
 272
 273 (defvar inferior-tcl-mode-map nil
 274   "Keymap used in Inferior Tcl mode.")
 275
 276 ;; XEmacs menu.
 277 (defvar tcl-xemacs-menu
 278   '(["Beginning of function" tcl-beginning-of-defun t]
 279     ["End of function" tcl-end-of-defun t]
 280     ["Mark function" tcl-mark-defun t]
 281     ["Indent region" indent-region (tcl-mark)]
 282     ["Comment region" comment-region (tcl-mark)]
 283     ["Uncomment region" tcl-uncomment-region (tcl-mark)]
 284     "----"
 285     ["Show Tcl process buffer" inferior-tcl t]
 286     ["Send function to Tcl process" tcl-eval-defun
 287      (and inferior-tcl-buffer (get-buffer inferior-tcl-buffer))]
 288     ["Send region to Tcl process" tcl-eval-region
 289      (and inferior-tcl-buffer (get-buffer inferior-tcl-buffer))]
 290     ["Send file to Tcl process" tcl-load-file
 291      (and inferior-tcl-buffer (get-buffer inferior-tcl-buffer))]
 292     ["Restart Tcl process with file" tcl-restart-with-file t]
 293     "----"
 294     ["Tcl help" tcl-help-on-word tcl-help-directory-list]
 295     ["Send bug report" tcl-submit-bug-report t])
 296   "XEmacs menu for Tcl mode.")
 297
 298 ;; Emacs does menus via keymaps.  Do it in a function in case we
 299 ;; later decide to add it to inferior Tcl mode as well.
 300 (defun tcl-add-emacs-menu (map)
 301   (define-key map [menu-bar] (make-sparse-keymap))
 302   ;; This fails in Emacs 19.22 and earlier.
 303   (require 'lmenu)
 304   (let ((menu (make-lucid-menu-keymap "Tcl" tcl-xemacs-menu)))
 305     (define-key map [menu-bar tcl] (cons "Tcl" menu))
 306     ;; The following is intended to compute the key sequence
 307     ;; information for the menu.  It doesn't work.
 308     (x-popup-menu nil menu)))
 309
 310 (defun tcl-fill-mode-map ()
 311   (define-key tcl-mode-map "{" 'tcl-electric-char)
 312   (define-key tcl-mode-map "}" 'tcl-electric-brace)
 313   (define-key tcl-mode-map "[" 'tcl-electric-char)
 314   (define-key tcl-mode-map "]" 'tcl-electric-char)
 315   (define-key tcl-mode-map ";" 'tcl-electric-char)
 316   (define-key tcl-mode-map "#" 'tcl-electric-hash)
 317   ;; FIXME.
 318   (define-key tcl-mode-map "\e\C-a" 'tcl-beginning-of-defun)
 319   ;; FIXME.
 320   (define-key tcl-mode-map "\e\C-e" 'tcl-end-of-defun)
 321   ;; FIXME.
 322   (define-key tcl-mode-map "\e\C-h" 'tcl-mark-defun)
 323   (define-key tcl-mode-map "\e\C-q" 'indent-tcl-exp)
 324   (define-key tcl-mode-map "\177" 'backward-delete-char-untabify)
 325   (define-key tcl-mode-map "\t" 'tcl-indent-command)
 326   (define-key tcl-mode-map "\M-;" 'tcl-indent-for-comment)
 327   (define-key tcl-mode-map "\M-\C-x" 'tcl-eval-defun)
 328   (define-key tcl-mode-map "\C-c\C-b" 'tcl-submit-bug-report)
 329   (and (fboundp 'comment-region)
 330        (define-key tcl-mode-map "\C-c\C-c" 'comment-region))
 331   (define-key tcl-mode-map "\C-c\C-i" 'tcl-help-on-word)
 332   (define-key tcl-mode-map "\C-c\C-v" 'tcl-eval-defun)
 333   (define-key tcl-mode-map "\C-c\C-f" 'tcl-load-file)
 334   (define-key tcl-mode-map "\C-c\C-t" 'inferior-tcl)
 335   (define-key tcl-mode-map "\C-c\C-x" 'tcl-eval-region)
 336   (define-key tcl-mode-map "\C-c\C-s" 'switch-to-tcl)
 337
 338   ;; Make menus.
 339   (if (and tcl-using-emacs-19 (not tcl-using-xemacs-19))
 340       (progn
 341         (tcl-add-emacs-menu tcl-mode-map))))
 342
 343 (defun tcl-fill-inferior-map ()
 344   (define-key inferior-tcl-mode-map "\t" 'comint-dynamic-complete)
 345   (define-key inferior-tcl-mode-map "\M-?"
 346     'comint-dynamic-list-filename-completions)
 347   (define-key inferior-tcl-mode-map "\e\C-a" 'tcl-beginning-of-defun)
 348   (define-key inferior-tcl-mode-map "\e\C-e" 'tcl-end-of-defun)
 349   (define-key inferior-tcl-mode-map "\177" 'backward-delete-char-untabify)
 350   (define-key inferior-tcl-mode-map "\M-\C-x" 'tcl-eval-defun)
 351   (define-key inferior-tcl-mode-map "\C-c\C-b" 'tcl-submit-bug-report)
 352   (define-key inferior-tcl-mode-map "\C-c\C-i" 'tcl-help-on-word)
 353   (define-key inferior-tcl-mode-map "\C-c\C-v" 'tcl-eval-defun)
 354   (define-key inferior-tcl-mode-map "\C-c\C-f" 'tcl-load-file)
 355   (define-key inferior-tcl-mode-map "\C-c\C-t" 'inferior-tcl)
 356   (define-key inferior-tcl-mode-map "\C-c\C-x" 'tcl-eval-region)
 357   (define-key inferior-tcl-mode-map "\C-c\C-s" 'switch-to-tcl))
 358
 359 (if tcl-mode-map
 360     ()
 361   (setq tcl-mode-map (make-sparse-keymap))
 362   (tcl-fill-mode-map))
 363
 364 (if inferior-tcl-mode-map
 365     ()
 366   ;; FIXME Use keymap inheritance here?  FIXME we override comint
 367   ;; keybindings here.  Maybe someone has a better set?
 368   (setq inferior-tcl-mode-map (copy-keymap comint-mode-map))
 369   (tcl-fill-inferior-map))
 370
 371
 372 (defvar inferior-tcl-buffer nil
 373   "*The current inferior-tcl process buffer.
 374
 375 MULTIPLE PROCESS SUPPORT
 376 ===========================================================================
 377 To run multiple Tcl processes, you start the first up with
 378 \\[inferior-tcl].  It will be in a buffer named `*inferior-tcl*'.
 379 Rename this buffer with \\[rename-buffer].  You may now start up a new
 380 process with another \\[inferior-tcl].  It will be in a new buffer,
 381 named `*inferior-tcl*'.  You can switch between the different process
 382 buffers with \\[switch-to-buffer].
 383
 384 Commands that send text from source buffers to Tcl processes -- like
 385 `tcl-eval-defun' or `tcl-load-file' -- have to choose a process to
 386 send to, when you have more than one Tcl process around.  This is
 387 determined by the global variable `inferior-tcl-buffer'.  Suppose you
 388 have three inferior Lisps running:
 389     Buffer              Process
 390     foo                 inferior-tcl
 391     bar                 inferior-tcl<2>
 392     *inferior-tcl*      inferior-tcl<3>
 393 If you do a \\[tcl-eval-defun] command on some Lisp source code, what
 394 process do you send it to?
 395
 396 - If you're in a process buffer (foo, bar, or *inferior-tcl*),
 397   you send it to that process.
 398 - If you're in some other buffer (e.g., a source file), you
 399   send it to the process attached to buffer `inferior-tcl-buffer'.
 400 This process selection is performed by function `inferior-tcl-proc'.
 401
 402 Whenever \\[inferior-tcl] fires up a new process, it resets
 403 `inferior-tcl-buffer' to be the new process's buffer.  If you only run
 404 one process, this does the right thing.  If you run multiple
 405 processes, you can change `inferior-tcl-buffer' to another process
 406 buffer with \\[set-variable].")
 407
 408 ;;
 409 ;; Hooks and other customization.
 410 ;;
 411
 412 (defvar tcl-mode-hook nil
 413   "Hook run on entry to Tcl mode.
 414
 415 Several functions exist which are useful to run from your
 416 `tcl-mode-hook' (see each function's documentation for more
 417 information):
 418
 419   tcl-guess-application
 420     Guesses a default setting for `tcl-application' based on any
 421     \"#!\" line at the top of the file.
 422   tcl-hashify-buffer
 423     Quotes all \"#\" characters that don't correspond to actual
 424     Tcl comments.  (Useful when editing code not originally created
 425     with this mode).
 426   tcl-auto-fill-mode
 427     Auto-filling of Tcl comments.
 428
 429 Add functions to the hook with `add-hook':
 430
 431    (add-hook 'tcl-mode-hook 'tcl-guess-application)
 432
 433 Emacs 18 users must use `setq' instead:
 434
 435    (setq tcl-mode-hook (cons 'tcl-guess-application tcl-mode-hook))")
 436
 437
 438 (defvar inferior-tcl-mode-hook nil
 439   "Hook for customizing Inferior Tcl mode.")
 440
 441 (defvar tcl-proc-list
 442   '("proc" "method" "itcl_class" "body" "configbody" "class")
 443   "List of commands whose first argument defines something.
 444 This exists because some people (eg, me) use `defvar' et al.
 445 Call `tcl-set-proc-regexp' and `tcl-set-font-lock-keywords'
 446 after changing this list.")
 447
 448 (defvar tcl-proc-regexp nil
 449   "Regexp to use when matching proc headers.")
 450
 451 (defvar tcl-typeword-list
 452   '("global" "upvar" "inherit" "public" "protected" "private"
 453     "common" "itk_option" "variable")
 454   "List of Tcl keywords denoting \"type\".  Used only for highlighting.
 455 Call `tcl-set-font-lock-keywords' after changing this list.")
 456
 457 ;; Generally I've picked control operators to be keywords.
 458 (defvar tcl-keyword-list
 459   '("if" "then" "else" "elseif" "for" "foreach" "break" "continue" "while"
 460     "eval" "case" "in" "switch" "default" "exit" "error" "proc" "return"
 461     "uplevel" "constructor" "destructor" "itcl_class" "loop" "for_array_keys"
 462     "for_recursive_glob" "for_file" "method" "body" "configbody" "class")
 463   "List of Tcl keywords.  Used only for highlighting.
 464 Default list includes some TclX keywords.
 465 Call `tcl-set-font-lock-keywords' after changing this list.")
 466
 467 (defvar tcl-font-lock-keywords nil
 468   "Keywords to highlight for Tcl.  See variable `font-lock-keywords'.
 469 This variable is generally set from `tcl-proc-regexp',
 470 `tcl-typeword-list', and `tcl-keyword-list' by the function
 471 `tcl-set-font-lock-keywords'.")
 472
 473 ;; FIXME need some way to recognize variables because array refs look
 474 ;; like 2 sexps.
 475 (defvar tcl-type-alist
 476   '(
 477     ("proc" nil tcl-expr tcl-commands)
 478     ("method" nil tcl-expr tcl-commands)
 479     ("destructor" tcl-commands)
 480     ("constructor" tcl-commands)
 481     ("expr" tcl-expr)
 482     ("catch" tcl-commands)
 483     ("if" tcl-expr "then" tcl-commands)
 484     ("elseif" tcl-expr "then" tcl-commands)
 485     ("elseif" tcl-expr tcl-commands)
 486     ("if" tcl-expr tcl-commands)
 487     ("while" tcl-expr tcl-commands)
 488     ("for" tcl-commands tcl-expr tcl-commands tcl-commands)
 489     ("foreach" nil nil tcl-commands)
 490     ("for_file" nil nil tcl-commands)
 491     ("for_array_keys" nil nil tcl-commands)
 492     ("for_recursive_glob" nil nil nil tcl-commands)
 493     ;; Loop handling is not perfect, because the third argument can be
 494     ;; either a command or an expr, and there is no real way to look
 495     ;; forward.
 496     ("loop" nil tcl-expr tcl-expr tcl-commands)
 497     ("loop" nil tcl-expr tcl-commands)
 498     )
 499   "Alist that controls indentation.
 500 \(Actually, this really only controls what happens on continuation lines).
 501 Each entry looks like `(KEYWORD TYPE ...)'.
 502 Each type entry describes a sexp after the keyword, and can be one of:
 503 * nil, meaning that this sexp has no particular type.
 504 * tcl-expr, meaning that this sexp is an arithmetic expression.
 505 * tcl-commands, meaning that this sexp holds Tcl commands.
 506 * a string, which must exactly match the string at the corresponding
 507   position for a match to be made.
 508
 509 For example, the entry for the \"loop\" command is:
 510
 511    (\"loop\" nil tcl-expr tcl-commands)
 512
 513 This means that the \"loop\" command has three arguments.  The first
 514 argument is ignored (for indentation purposes).  The second argument
 515 is a Tcl expression, and the last argument is Tcl commands.")
 516
 517 (defvar tcl-explain-indentation nil
 518   "If not `nil', debugging message will be printed during indentation.")
 519
 520 \f
 521
 522 ;;
 523 ;; Work around differences between various versions of Emacs.
 524 ;;
 525
 526 (defconst tcl-pps-has-arg-6
 527   (or tcl-using-emacs-19
 528       (and tcl-using-xemacs-19
 529            (condition-case nil
 530                (progn
 531                  (parse-partial-sexp (point) (point) nil nil nil t)
 532                  t)
 533              (error nil))))
 534   "t if Emacs supports \"commentstop\" argument to `parse-partial-sexp'.")
 535
 536 ;; Its pretty bogus to have to do this, but there is no easier way to
 537 ;; say "match not syntax-1 and not syntax-2".  Too bad you can't put
 538 ;; \s in [...].  This sickness is used in Emacs 19 to match a defun
 539 ;; starter.  (It is used for this in v18 as well).
 540 ;;(defconst tcl-omit-ws-regexp
 541 ;;  (concat "^\\(\\s"
 542 ;;        (mapconcat 'char-to-string "w_.()\"\\$'/" "\\|\\s")
 543 ;;        "\\)\\S(*")
 544 ;;  "Regular expression that matches everything except space, comment
 545 ;;starter, and comment ender syntax codes.")
 546
 547 ;; FIXME?  Instead of using the hairy regexp above, we just use a
 548 ;; simple one.
 549 ;;(defconst tcl-omit-ws-regexp "^[^] \t\n#}]\\S(*"
 550 ;;  "Regular expression used in locating function definitions.")
 551
 552 ;; Here's another stab.  I think this one actually works.  Now the
 553 ;; problem seems to be that there is a bug in Emacs 19.22 where
 554 ;; end-of-defun doesn't really use the brace matching the one that
 555 ;; trails defun-prompt-regexp.
 556 ;; ?? Is there a bug now ??
 557 (defconst tcl-omit-ws-regexp "^[^ \t\n#}][^\n}]+}*[ \t]+")
 558
 559 (defun tcl-internal-beginning-of-defun (&optional arg)
 560   "Move backward to next beginning of defun.
 561 With argument, do this that many times.
 562 Returns t unless search stops due to end of buffer."
 563   (interactive "p")
 564   (if (or (null arg) (= arg 0))
 565       (setq arg 1))
 566   (let (success)
 567     (while (progn
 568              (setq arg (1- arg))
 569              (and (>= arg 0)
 570                   (setq success
 571                         (re-search-backward tcl-omit-ws-regexp nil 'move 1))))
 572       (while (and (looking-at "[]#}]")
 573                   (setq success
 574                         (re-search-backward tcl-omit-ws-regexp nil 'move 1)))))
 575     (beginning-of-line)
 576     (not (null success))))
 577
 578 (defun tcl-internal-end-of-defun (&optional arg)
 579   "Move forward to next end of defun.
 580 An end of a defun is found by moving forward from the beginning of one."
 581   (interactive "p")
 582   (if (or (null arg) (= arg 0)) (setq arg 1))
 583   (let ((start (point)))
 584     ;; Was forward-char.  I think this works a little better.
 585     (forward-line)
 586     (tcl-beginning-of-defun)
 587     (while (> arg 0)
 588       (while (and (re-search-forward tcl-omit-ws-regexp nil 'move 1)
 589                   (progn (beginning-of-line) t)
 590                   (looking-at "[]#}]")
 591                   (progn (forward-line) t)))
 592       (let ((next-line (save-excursion
 593                          (forward-line)
 594                          (point))))
 595         (while (< (point) next-line)
 596           (forward-sexp)))
 597       (forward-line)
 598       (if (> (point) start) (setq arg (1- arg))))))
 599
 600 ;; We can now use begining-of-defun as long as we set up a
 601 ;; certain regexp.  In Emacs 18, we need our own function.
 602 (fset 'tcl-beginning-of-defun
 603       (if tcl-using-emacs-19
 604           'beginning-of-defun
 605         'tcl-internal-beginning-of-defun))
 606
 607 ;; Ditto end-of-defun.
 608 (fset 'tcl-end-of-defun
 609       (if (and tcl-using-emacs-19 (not tcl-using-xemacs-19))
 610           'end-of-defun
 611         'tcl-internal-end-of-defun))
 612
 613 ;; Internal mark-defun that is used for losing Emacsen.
 614 (defun tcl-internal-mark-defun ()
 615   "Put mark at end of Tcl function, point at beginning."
 616   (interactive)
 617   (push-mark (point))
 618   (tcl-end-of-defun)
 619   (if tcl-using-emacs-19
 620       (push-mark (point) nil t)
 621     (push-mark (point)))
 622   (tcl-beginning-of-defun)
 623   (backward-paragraph))
 624
 625 ;; In Emacs 19.23 and later, mark-defun works as advertised.  I
 626 ;; don't know about XEmacs, so for now it and Emacs 18 just lose.
 627 (fset 'tcl-mark-defun
 628       (if tcl-using-emacs-19-23
 629           'mark-defun
 630         'tcl-internal-mark-defun))
 631
 632 ;; In Emacs 19, mark takes an additional "force" argument.  I
 633 ;; don't know about XEmacs, so I'm just assuming it is the same.
 634 ;; Emacs 18 doesn't have this argument.
 635 (defun tcl-mark ()
 636   "Return mark, or nil if none."
 637   (if tcl-using-emacs-19
 638       (mark t)
 639     (mark)))
 640
 641 \f
 642
 643 ;;
 644 ;; Some helper functions.
 645 ;;
 646
 647 (defun tcl-set-proc-regexp ()
 648   "Set `tcl-proc-regexp' from variable `tcl-proc-list'."
 649   (setq tcl-proc-regexp (concat "^\\s-*\\("
 650                                 (mapconcat 'identity tcl-proc-list "\\|")
 651                                 "\\)[ \t]+")))
 652
 653 (defun tcl-set-font-lock-keywords ()
 654   "Set `tcl-font-lock-keywords'.
 655 Uses variables `tcl-proc-regexp' and `tcl-keyword-list'."
 656   (setq tcl-font-lock-keywords
 657         (list
 658          ;; Names of functions (and other "defining things").
 659          (list (concat tcl-proc-regexp "\\([^ \t\n]+\\)")
 660                2 'font-lock-function-name-face)
 661
 662          ;; Names of type-defining things.
 663          (list (concat "\\(\\s-\\|^\\)\\("
 664                        ;; FIXME Use 'regexp-quote?
 665                        (mapconcat 'identity tcl-typeword-list "\\|")
 666                        "\\)\\(\\s-\\|$\\)")
 667                2 'font-lock-type-face)
 668
 669          ;; Keywords.  Only recognized if surrounded by whitespace.
 670          ;; FIXME consider using "not word or symbol", not
 671          ;; "whitespace".
 672          (cons (concat "\\(\\s-\\|^\\)\\("
 673                        ;; FIXME Use regexp-quote?
 674                        (mapconcat 'identity tcl-keyword-list "\\|")
 675                        "\\)\\(\\s-\\|$\\)")
 676                2)
 677          )))
 678
 679 (if tcl-proc-regexp
 680     ()
 681   (tcl-set-proc-regexp))
 682
 683 (if tcl-font-lock-keywords
 684     ()
 685   (tcl-set-font-lock-keywords))
 686
 687 \f
 688
 689 ;;
 690 ;; The mode itself.
 691 ;;
 692
 693 ;;;###autoload
 694 (defun tcl-mode ()
 695   "Major mode for editing Tcl code.
 696 Expression and list commands understand all Tcl brackets.
 697 Tab indents for Tcl code.
 698 Paragraphs are separated by blank lines only.
 699 Delete converts tabs to spaces as it moves back.
 700
 701 Variables controlling indentation style:
 702   tcl-indent-level
 703     Indentation of Tcl statements within surrounding block.
 704   tcl-continued-indent-level
 705     Indentation of continuation line relative to first line of command.
 706
 707 Variables controlling user interaction with mode (see variable
 708 documentation for details):
 709   tcl-tab-always-indent
 710     Controls action of TAB key.
 711   tcl-auto-newline
 712     Non-nil means automatically newline before and after braces, brackets,
 713     and semicolons inserted in Tcl code.
 714   tcl-electric-hash-style
 715     Controls action of `#' key.
 716   tcl-use-hairy-comment-detector
 717     If t, use more complicated, but slower, comment detector.
 718     This variable is only used in Emacs 19.
 719   tcl-use-smart-word-finder
 720     If not nil, use a smarter, Tcl-specific way to find the current
 721     word when looking up help on a Tcl command.
 722
 723 Turning on Tcl mode calls the value of the variable `tcl-mode-hook'
 724 with no args, if that value is non-nil.  Read the documentation for
 725 `tcl-mode-hook' to see what kinds of interesting hook functions
 726 already exist.
 727
 728 Commands:
 729 \\{tcl-mode-map}"
 730   (interactive)
 731   (kill-all-local-variables)
 732   (use-local-map tcl-mode-map)
 733   (setq major-mode 'tcl-mode)
 734   (setq mode-name "Tcl")
 735   (setq local-abbrev-table tcl-mode-abbrev-table)
 736   (set-syntax-table tcl-mode-syntax-table)
 737
 738   (make-local-variable 'paragraph-start)
 739   (make-local-variable 'paragraph-separate)
 740   (if (and tcl-using-emacs-19-23
 741            (>= emacs-minor-version 29))
 742       (progn
 743         ;; In Emacs 19.29, you aren't supposed to start these with a ^.
 744         (setq paragraph-start "$\\|\f")
 745         (setq paragraph-separate paragraph-start))
 746     (setq paragraph-start (concat "^$\\|" page-delimiter))
 747     (setq paragraph-separate paragraph-start))
 748   (make-local-variable 'paragraph-ignore-fill-prefix)
 749   (setq paragraph-ignore-fill-prefix t)
 750   (make-local-variable 'fill-paragraph-function)
 751   (setq fill-paragraph-function 'tcl-do-fill-paragraph)
 752
 753   (make-local-variable 'indent-line-function)
 754   (setq indent-line-function 'tcl-indent-line)
 755   ;; Tcl doesn't require a final newline.
 756   ;; (make-local-variable 'require-final-newline)
 757   ;; (setq require-final-newline t)
 758
 759   (make-local-variable 'comment-start)
 760   (setq comment-start "# ")
 761   (make-local-variable 'comment-start-skip)
 762   (setq comment-start-skip "#+ *")
 763   (make-local-variable 'comment-column)
 764   (setq comment-column 40)
 765   (make-local-variable 'comment-end)
 766   (setq comment-end "")
 767
 768   (make-local-variable 'outline-regexp)
 769   (setq outline-regexp "[^\n\^M]")
 770   (make-local-variable 'outline-level)
 771   (setq outline-level 'tcl-outline-level)
 772
 773   (make-local-variable 'font-lock-defaults)
 774   (setq font-lock-defaults
 775         '(tcl-font-lock-keywords))
 776
 777   (make-local-variable 'imenu-create-index-function)
 778   (setq imenu-create-index-function 'tcl-imenu-create-index-function)
 779   (make-local-variable 'parse-sexp-ignore-comments)
 780
 781   ;; Settings for new dabbrev code.
 782   (make-local-variable 'dabbrev-case-fold-search)
 783   (setq dabbrev-case-fold-search nil)
 784   (make-local-variable 'dabbrev-case-replace)
 785   (setq dabbrev-case-replace nil)
 786   (make-local-variable 'dabbrev-abbrev-skip-leading-regexp)
 787   (setq dabbrev-abbrev-skip-leading-regexp "[$!]")
 788   (make-local-variable 'dabbrev-abbrev-char-regexp)
 789   (setq dabbrev-abbrev-char-regexp "\\sw\\|\\s_")
 790
 791   (if tcl-using-emacs-19
 792       (progn
 793         ;; This can only be set to t in Emacs 19 and XEmacs.
 794         ;; Emacs 18 and Epoch lose.
 795         (setq parse-sexp-ignore-comments t)
 796         ;; XEmacs has defun-prompt-regexp, but I don't believe
 797         ;; that it works for end-of-defun -- only for
 798         ;; beginning-of-defun.
 799         (make-local-variable 'defun-prompt-regexp)
 800         (setq defun-prompt-regexp tcl-omit-ws-regexp)
 801         ;; The following doesn't work in Lucid Emacs 19.6, but maybe
 802         ;; it will appear in later versions.
 803         (make-local-variable 'add-log-current-defun-function)
 804         (setq add-log-current-defun-function 'add-log-tcl-defun))
 805     (setq parse-sexp-ignore-comments nil))
 806
 807   ;; Put Tcl menu into menubar for XEmacs.  This happens
 808   ;; automatically in Emacs.
 809   (if (and tcl-using-xemacs-19
 810            current-menubar
 811            (not (assoc "Tcl" current-menubar)))
 812       (progn
 813         (set-buffer-menubar (copy-sequence current-menubar))
 814         (add-menu nil "Tcl" tcl-xemacs-menu)))
 815   ;; Append Tcl menu to popup menu for XEmacs.
 816   (if (and tcl-using-xemacs-19 (boundp 'mode-popup-menu))
 817       (setq mode-popup-menu
 818             (cons (concat mode-name " Mode Commands") tcl-xemacs-menu)))
 819
 820   ;; If hilit19 is loaded, add our stuff.
 821   (if (featurep 'hilit19)
 822       (tcl-hilit))
 823
 824   (run-hooks 'tcl-mode-hook))
 825
 826 \f
 827
 828 ;; This is used for braces, brackets, and semi (except for closing
 829 ;; braces, which are handled specially).
 830 (defun tcl-electric-char (arg)
 831   "Insert character and correct line's indentation."
 832   (interactive "p")
 833   ;; Indent line first; this looks better if parens blink.
 834   (tcl-indent-line)
 835   (self-insert-command arg)
 836   (if (and tcl-auto-newline (= last-command-char ?\;))
 837       (progn
 838         (newline)
 839         (tcl-indent-line))))
 840
 841 ;; This is used for closing braces.  If tcl-auto-newline is set, can
 842 ;; insert a newline both before and after the brace, depending on
 843 ;; context.  FIXME should this be configurable?  Does anyone use this?
 844 (defun tcl-electric-brace (arg)
 845   "Insert character and correct line's indentation."
 846   (interactive "p")
 847   ;; If auto-newlining and there is stuff on the same line, insert a
 848   ;; newline first.
 849   (if tcl-auto-newline
 850       (progn
 851         (if (save-excursion
 852               (skip-chars-backward " \t")
 853               (bolp))
 854             ()
 855           (tcl-indent-line)
 856           (newline))
 857         ;; In auto-newline case, must insert a newline after each
 858         ;; brace.  So an explicit loop is needed.
 859         (while (> arg 0)
 860           (insert last-command-char)
 861           (tcl-indent-line)
 862           (newline)
 863           (setq arg (1- arg))))
 864     (self-insert-command arg))
 865   (tcl-indent-line))
 866
 867 \f
 868
 869 (defun tcl-indent-command (&optional arg)
 870   "Indent current line as Tcl code, or in some cases insert a tab character.
 871 If `tcl-tab-always-indent' is t (the default), always indent current line.
 872 If `tcl-tab-always-indent' is nil and point is not in the indentation
 873 area at the beginning of the line, a TAB is inserted.
 874 Other values of `tcl-tab-always-indent' cause the first possible action
 875 from the following list to take place:
 876
 877   1. Move from beginning of line to correct indentation.
 878   2. Delete an empty comment.
 879   3. Move forward to start of comment, indenting if necessary.
 880   4. Move forward to end of line, indenting if necessary.
 881   5. Create an empty comment.
 882   6. Move backward to start of comment, indenting if necessary."
 883   (interactive "p")
 884   (cond
 885    ((not tcl-tab-always-indent)
 886     ;; Indent if in indentation area, otherwise insert TAB.
 887     (if (<= (current-column) (current-indentation))
 888         (tcl-indent-line)
 889       (insert-tab arg)))
 890    ((eq tcl-tab-always-indent t)
 891     ;; Always indent.
 892     (tcl-indent-line))
 893    (t
 894     ;; "Perl-mode" style TAB command.
 895     (let* ((ipoint (point))
 896            (eolpoint (progn
 897                        (end-of-line)
 898                        (point)))
 899            (comment-p (tcl-in-comment)))
 900       (cond
 901        ((= ipoint (save-excursion
 902                     (beginning-of-line)
 903                     (point)))
 904         (beginning-of-line)
 905         (tcl-indent-line)
 906         ;; If indenting didn't leave us in column 0, go to the
 907         ;; indentation.  Otherwise leave point at end of line.  This
 908         ;; is a hack.
 909         (if (= (point) (save-excursion
 910                          (beginning-of-line)
 911                          (point)))
 912             (end-of-line)
 913           (back-to-indentation)))
 914        ((and comment-p (looking-at "[ \t]*$"))
 915         ;; Empty comment, so delete it.  We also delete any ";"
 916         ;; characters at the end of the line.  I think this is
 917         ;; friendlier, but I don't know how other people will feel.
 918         (backward-char)
 919         (skip-chars-backward " \t;")
 920         (delete-region (point) eolpoint))
 921        ((and comment-p (< ipoint (point)))
 922         ;; Before comment, so skip to it.
 923         (tcl-indent-line)
 924         (indent-for-comment))
 925        ((/= ipoint eolpoint)
 926         ;; Go to end of line (since we're not there yet).
 927         (goto-char eolpoint)
 928         (tcl-indent-line))
 929        ((not comment-p)
 930         (tcl-indent-line)
 931         (tcl-indent-for-comment))
 932        (t
 933         ;; Go to start of comment.  We don't leave point where it is
 934         ;; because we want to skip comment-start-skip.
 935         (tcl-indent-line)
 936         (indent-for-comment)))))))
 937
 938 (defun tcl-indent-line ()
 939   "Indent current line as Tcl code.
 940 Return the amount the indentation changed by."
 941   (let ((indent (calculate-tcl-indent nil))
 942         beg shift-amt
 943         (case-fold-search nil)
 944         (pos (- (point-max) (point))))
 945     (beginning-of-line)
 946     (setq beg (point))
 947     (cond ((eq indent nil)
 948            (setq indent (current-indentation)))
 949           (t
 950            (skip-chars-forward " \t")
 951            (if (listp indent) (setq indent (car indent)))
 952            (cond ((= (following-char) ?})
 953                   (setq indent (- indent tcl-indent-level)))
 954                  ((= (following-char) ?\])
 955                   (setq indent (- indent 1))))))
 956     (skip-chars-forward " \t")
 957     (setq shift-amt (- indent (current-column)))
 958     (if (zerop shift-amt)
 959         (if (> (- (point-max) pos) (point))
 960             (goto-char (- (point-max) pos)))
 961       (delete-region beg (point))
 962       (indent-to indent)
 963       ;; If initial point was within line's indentation,
 964       ;; position after the indentation.  Else stay at same point in text.
 965       (if (> (- (point-max) pos) (point))
 966           (goto-char (- (point-max) pos))))
 967     shift-amt))
 968
 969 (defun tcl-figure-type ()
 970   "Determine type of sexp at point.
 971 This is either `tcl-expr', `tcl-commands', or nil.  Puts point at start
 972 of sexp that indicates types.
 973
 974 See documentation for variable `tcl-type-alist' for more information."
 975   (let ((count 0)
 976         result
 977         word-stack)
 978     (while (and (< count 5)
 979                 (not result))
 980       (condition-case nil
 981           (progn
 982             ;; FIXME should use "tcl-backward-sexp", which would skip
 983             ;; over entire variables, etc.
 984             (backward-sexp)
 985             (if (looking-at "[a-zA-Z_]+")
 986                 (let ((list tcl-type-alist)
 987                       entry)
 988                   (setq word-stack (cons (tcl-word-no-props) word-stack))
 989                   (while (and list (not result))
 990                     (setq entry (car list))
 991                     (setq list (cdr list))
 992                     (let ((index 0))
 993                       (while (and entry (<= index count))
 994                         ;; Abort loop if string does not match word on
 995                         ;; stack.
 996                         (and (stringp (car entry))
 997                              (not (string= (car entry)
 998                                            (nth index word-stack)))
 999                              (setq entry nil))
1000                         (setq entry (cdr entry))
1001                         (setq index (1+ index)))
1002                       (and (> index count)
1003                            (not (stringp (car entry)))
1004                            (setq result (car entry)))
1005                       )))
1006               (setq word-stack (cons nil word-stack))))
1007         (error nil))
1008       (setq count (1+ count)))
1009     (and tcl-explain-indentation
1010          (message "Indentation type %s" result))
1011     result))
1012
1013 (defun calculate-tcl-indent (&optional parse-start)
1014   "Return appropriate indentation for current line as Tcl code.
1015 In usual case returns an integer: the column to indent to.
1016 Returns nil if line starts inside a string, t if in a comment."
1017   (save-excursion
1018     (beginning-of-line)
1019     (let* ((indent-point (point))
1020            (case-fold-search nil)
1021            (continued-line
1022             (save-excursion
1023               (if (bobp)
1024                   nil
1025                 (backward-char)
1026                 (= ?\\ (preceding-char)))))
1027            (continued-indent-value (if continued-line
1028                                        tcl-continued-indent-level
1029                                      0))
1030            state
1031            containing-sexp
1032            found-next-line)
1033       (if parse-start
1034           (goto-char parse-start)
1035         (tcl-beginning-of-defun))
1036       (while (< (point) indent-point)
1037         (setq parse-start (point))
1038         (setq state (parse-partial-sexp (point) indent-point 0))
1039         (setq containing-sexp (car (cdr state))))
1040       (cond ((or (nth 3 state) (nth 4 state))
1041              ;; Inside comment or string.  Return nil or t if should
1042              ;; not change this line
1043              (nth 4 state))
1044             ((null containing-sexp)
1045              ;; Line is at top level.
1046              continued-indent-value)
1047             (t
1048              ;; Set expr-p if we are looking at the expression part of
1049              ;; an "if", "expr", etc statement.  Set commands-p if we
1050              ;; are looking at the body part of an if, while, etc
1051              ;; statement.  FIXME Should check for "for" loops here.
1052              (goto-char containing-sexp)
1053              (let* ((sexpr-type (tcl-figure-type))
1054                     (expr-p (eq sexpr-type 'tcl-expr))
1055                     (commands-p (eq sexpr-type 'tcl-commands))
1056                     (expr-start (point)))
1057                ;; Find the first statement in the block and indent
1058                ;; like it.  The first statement in the block might be
1059                ;; on the same line, so what we do is skip all
1060                ;; "virtually blank" lines, looking for a non-blank
1061                ;; one.  A line is virtually blank if it only contains
1062                ;; a comment and whitespace.  FIXME continued comments
1063                ;; aren't supported.  They are a wart on Tcl anyway.
1064                ;; We do it this funky way because we want to know if
1065                ;; we've found a statement on some line _after_ the
1066                ;; line holding the sexp opener.
1067                (goto-char containing-sexp)
1068                (forward-char)
1069                (if (and (< (point) indent-point)
1070                         (looking-at "[ \t]*\\(#.*\\)?$"))
1071                    (progn
1072                      (forward-line)
1073                      (while (and (< (point) indent-point)
1074                                  (looking-at "[ \t]*\\(#.*\\)?$"))
1075                        (setq found-next-line t)
1076                        (forward-line))))
1077                (if (or continued-line
1078                        (/= (char-after containing-sexp) ?{)
1079                        expr-p)
1080                    (progn
1081                      ;; Line is continuation line, or the sexp opener
1082                      ;; is not a curly brace, or we are are looking at
1083                      ;; an `expr' expression (which must be split
1084                      ;; specially).  So indentation is column of first
1085                      ;; good spot after sexp opener (with some added
1086                      ;; in the continued-line case).  If there is no
1087                      ;; nonempty line before the indentation point, we
1088                      ;; use the column of the character after the sexp
1089                      ;; opener.
1090                      (if (>= (point) indent-point)
1091                          (progn
1092                            (goto-char containing-sexp)
1093                            (forward-char))
1094                        (skip-chars-forward " \t"))
1095                      (+ (current-column) continued-indent-value))
1096                  ;; After a curly brace, and not a continuation line.
1097                  ;; So take indentation from first good line after
1098                  ;; start of block, unless that line is on the same
1099                  ;; line as the opening brace.  In this case use the
1100                  ;; indentation of the opening brace's line, plus
1101                  ;; another indent step.  If we are in the body part
1102                  ;; of an "if" or "while" then the indentation is
1103                  ;; taken from the line holding the start of the
1104                  ;; statement.
1105                  (if (and (< (point) indent-point)
1106                           found-next-line)
1107                      (current-indentation)
1108                    (if commands-p
1109                        (goto-char expr-start)
1110                      (goto-char containing-sexp))
1111                    (+ (current-indentation) tcl-indent-level)))))))))
1112
1113 \f
1114
1115 (defun indent-tcl-exp ()
1116   "Indent each line of the Tcl grouping following point."
1117   (interactive)
1118   (let ((indent-stack (list nil))
1119         (contain-stack (list (point)))
1120         (case-fold-search nil)
1121         outer-loop-done inner-loop-done state ostate
1122         this-indent last-sexp continued-line
1123         (next-depth 0)
1124         last-depth)
1125     (save-excursion
1126       (forward-sexp 1))
1127     (save-excursion
1128       (setq outer-loop-done nil)
1129       (while (and (not (eobp)) (not outer-loop-done))
1130         (setq last-depth next-depth)
1131         ;; Compute how depth changes over this line
1132         ;; plus enough other lines to get to one that
1133         ;; does not end inside a comment or string.
1134         ;; Meanwhile, do appropriate indentation on comment lines.
1135         (setq inner-loop-done nil)
1136         (while (and (not inner-loop-done)
1137                     (not (and (eobp) (setq outer-loop-done t))))
1138           (setq ostate state)
1139           (setq state (parse-partial-sexp (point) (progn (end-of-line) (point))
1140                                           nil nil state))
1141           (setq next-depth (car state))
1142           (if (and (car (cdr (cdr state)))
1143                    (>= (car (cdr (cdr state))) 0))
1144               (setq last-sexp (car (cdr (cdr state)))))
1145           (if (or (nth 4 ostate))
1146               (tcl-indent-line))
1147           (if (or (nth 3 state))
1148               (forward-line 1)
1149             (setq inner-loop-done t)))
1150         (if (<= next-depth 0)
1151             (setq outer-loop-done t))
1152         (if outer-loop-done
1153             nil
1154           ;; If this line had ..))) (((.. in it, pop out of the levels
1155           ;; that ended anywhere in this line, even if the final depth
1156           ;; doesn't indicate that they ended.
1157           (while (> last-depth (nth 6 state))
1158             (setq indent-stack (cdr indent-stack)
1159                   contain-stack (cdr contain-stack)
1160                   last-depth (1- last-depth)))
1161           (if (/= last-depth next-depth)
1162               (setq last-sexp nil))
1163           ;; Add levels for any parens that were started in this line.
1164           (while (< last-depth next-depth)
1165             (setq indent-stack (cons nil indent-stack)
1166                   contain-stack (cons nil contain-stack)
1167                   last-depth (1+ last-depth)))
1168           (if (null (car contain-stack))
1169               (setcar contain-stack
1170                       (or (car (cdr state))
1171                           (save-excursion
1172                             (forward-sexp -1)
1173                             (point)))))
1174           (forward-line 1)
1175           (setq continued-line
1176                 (save-excursion
1177                   (backward-char)
1178                   (= (preceding-char) ?\\)))
1179           (skip-chars-forward " \t")
1180           (if (eolp)
1181               nil
1182             (if (and (car indent-stack)
1183                      (>= (car indent-stack) 0))
1184                 ;; Line is on an existing nesting level.
1185                 (setq this-indent (car indent-stack))
1186               ;; Just started a new nesting level.
1187               ;; Compute the standard indent for this level.
1188               (let ((val (calculate-tcl-indent
1189                           (if (car indent-stack)
1190                               (- (car indent-stack))))))
1191                 (setcar indent-stack
1192                         (setq this-indent val))
1193                 (setq continued-line nil)))
1194             (cond ((not (numberp this-indent)))
1195                   ((= (following-char) ?})
1196                    (setq this-indent (- this-indent tcl-indent-level)))
1197                   ((= (following-char) ?\])
1198                    (setq this-indent (- this-indent 1))))
1199             ;; Put chosen indentation into effect.
1200             (or (null this-indent)
1201                 (= (current-column)
1202                    (if continued-line
1203                        (+ this-indent tcl-indent-level)
1204                      this-indent))
1205                 (progn
1206                   (delete-region (point) (progn (beginning-of-line) (point)))
1207                   (indent-to
1208                    (if continued-line
1209                        (+ this-indent tcl-indent-level)
1210                      this-indent)))))))))
1211   )
1212
1213 \f
1214
1215 ;;
1216 ;; Interfaces to other packages.
1217 ;;
1218
1219 (defun tcl-imenu-create-index-function ()
1220   "Generate alist of indices for imenu."
1221   (let ((re (concat tcl-proc-regexp "\\([^ \t\n{]+\\)"))
1222         alist prev-pos)
1223     (goto-char (point-min))
1224     (imenu-progress-message prev-pos 0)
1225     (save-match-data
1226       (while (re-search-forward re nil t)
1227         (imenu-progress-message prev-pos)
1228         ;; Position on start of proc name, not beginning of line.
1229         (setq alist (cons
1230                      (cons (buffer-substring (match-beginning 2) (match-end 2))
1231                            (match-beginning 2))
1232                      alist))))
1233     (imenu-progress-message prev-pos 100)
1234     (nreverse alist)))
1235
1236 ;; FIXME Definition of function is very ad-hoc.  Should use
1237 ;; tcl-beginning-of-defun.  Also has incestuous knowledge about the
1238 ;; format of tcl-proc-regexp.
1239 (defun add-log-tcl-defun ()
1240   "Return name of Tcl function point is in, or nil."
1241   (save-excursion
1242     (end-of-line)
1243     (if (re-search-backward (concat tcl-proc-regexp "\\([^ \t\n{]+\\)") nil t)
1244         (buffer-substring (match-beginning 2)
1245                           (match-end 2)))))
1246
1247 (defun tcl-outline-level ()
1248   (save-excursion
1249     (skip-chars-forward " \t")
1250     (current-column)))
1251
1252 \f
1253
1254 ;;
1255 ;; Helper functions for inferior Tcl mode.
1256 ;;
1257
1258 ;; This exists to let us delete the prompt when commands are sent
1259 ;; directly to the inferior Tcl.  See gud.el for an explanation of how
1260 ;; it all works (I took it from there).  This stuff doesn't really
1261 ;; work as well as I'd like it to.  But I don't believe there is
1262 ;; anything useful that can be done.
1263 (defvar inferior-tcl-delete-prompt-marker nil)
1264
1265 (defun tcl-filter (proc string)
1266   (let ((inhibit-quit t))
1267     (save-excursion
1268       (set-buffer (process-buffer proc))
1269       (goto-char (process-mark proc))
1270       ;; Delete prompt if requested.
1271       (if (marker-buffer inferior-tcl-delete-prompt-marker)
1272           (progn
1273             (delete-region (point) inferior-tcl-delete-prompt-marker)
1274             (set-marker inferior-tcl-delete-prompt-marker nil)))))
1275   (if tcl-using-emacs-19
1276       (comint-output-filter proc string)
1277     (funcall comint-output-filter string)))
1278
1279 (defun tcl-send-string (proc string)
1280   (save-excursion
1281     (set-buffer (process-buffer proc))
1282     (goto-char (process-mark proc))
1283     (beginning-of-line)
1284     (if (looking-at comint-prompt-regexp)
1285         (set-marker inferior-tcl-delete-prompt-marker (point))))
1286   (comint-send-string proc string))
1287
1288 (defun tcl-send-region (proc start end)
1289   (save-excursion
1290     (set-buffer (process-buffer proc))
1291     (goto-char (process-mark proc))
1292     (beginning-of-line)
1293     (if (looking-at comint-prompt-regexp)
1294         (set-marker inferior-tcl-delete-prompt-marker (point))))
1295   (comint-send-region proc start end))
1296
1297 (defun switch-to-tcl (eob-p)
1298   "Switch to inferior Tcl process buffer.
1299 With argument, positions cursor at end of buffer."
1300   (interactive "P")
1301   (if (get-buffer inferior-tcl-buffer)
1302       (pop-to-buffer inferior-tcl-buffer)
1303     (error "No current inferior Tcl buffer"))
1304   (cond (eob-p
1305          (push-mark)
1306          (goto-char (point-max)))))
1307
1308 (defun inferior-tcl-proc ()
1309   "Return current inferior Tcl process.
1310 See variable `inferior-tcl-buffer'."
1311   (let ((proc (get-buffer-process (if (eq major-mode 'inferior-tcl-mode)
1312                                       (current-buffer)
1313                                     inferior-tcl-buffer))))
1314     (or proc
1315         (error "No Tcl process; see variable `inferior-tcl-buffer'"))))
1316
1317 (defun tcl-eval-region (start end &optional and-go)
1318   "Send the current region to the inferior Tcl process.
1319 Prefix argument means switch to the Tcl buffer afterwards."
1320   (interactive "r\nP")
1321   (let ((proc (inferior-tcl-proc)))
1322     (tcl-send-region proc start end)
1323     (tcl-send-string proc "\n")
1324     (if and-go (switch-to-tcl t))))
1325
1326 (defun tcl-eval-defun (&optional and-go)
1327   "Send the current defun to the inferior Tcl process.
1328 Prefix argument means switch to the Tcl buffer afterwards."
1329   (interactive "P")
1330   (save-excursion
1331     (tcl-end-of-defun)
1332     (let ((end (point)))
1333       (tcl-beginning-of-defun)
1334       (tcl-eval-region (point) end)))
1335   (if and-go (switch-to-tcl t)))
1336
1337 \f
1338
1339 ;;
1340 ;; Inferior Tcl mode itself.
1341 ;;
1342
1343 (defun inferior-tcl-mode ()
1344   "Major mode for interacting with Tcl interpreter.
1345
1346 A Tcl process can be started with M-x inferior-tcl.
1347
1348 Entry to this mode runs the normal hooks `comint-mode-hook' and
1349 `inferior-tcl-mode-hook', in that order.
1350
1351 You can send text to the inferior Tcl process from other buffers
1352 containing Tcl source.
1353
1354 Variables controlling Inferior Tcl mode:
1355   tcl-application
1356     Name of program to run.
1357   tcl-command-switches
1358     Command line arguments to `tcl-application'.
1359   tcl-prompt-regexp
1360     Matches prompt.
1361   inferior-tcl-source-command
1362     Command to use to read Tcl file in running application.
1363   inferior-tcl-buffer
1364     The current inferior Tcl process buffer.  See variable
1365     documentation for details on multiple-process support.
1366
1367 The following commands are available:
1368 \\{inferior-tcl-mode-map}"
1369   (interactive)
1370   (comint-mode)
1371   (setq comint-prompt-regexp (or tcl-prompt-regexp
1372                                  (concat "^"
1373                                          (regexp-quote tcl-application)
1374                                          ">")))
1375   (setq major-mode 'inferior-tcl-mode)
1376   (setq mode-name "Inferior Tcl")
1377   (if (boundp 'modeline-process)
1378       (setq modeline-process '(": %s")) ; For XEmacs.
1379     (setq mode-line-process '(": %s")))
1380   (use-local-map inferior-tcl-mode-map)
1381   (setq local-abbrev-table tcl-mode-abbrev-table)
1382   (set-syntax-table tcl-mode-syntax-table)
1383   (if tcl-using-emacs-19
1384       (progn
1385         (make-local-variable 'defun-prompt-regexp)
1386         (setq defun-prompt-regexp tcl-omit-ws-regexp)))
1387   (make-local-variable 'inferior-tcl-delete-prompt-marker)
1388   (setq inferior-tcl-delete-prompt-marker (make-marker))
1389   (set-process-filter (get-buffer-process (current-buffer)) 'tcl-filter)
1390   (run-hooks 'inferior-tcl-mode-hook))
1391
1392 ;;;###autoload
1393 (defun inferior-tcl (cmd)
1394   "Run inferior Tcl process.
1395 Prefix arg means enter program name interactively.
1396 See documentation for function `inferior-tcl-mode' for more information."
1397   (interactive
1398    (list (if current-prefix-arg
1399              (read-string "Run Tcl: " tcl-application)
1400            tcl-application)))
1401   (if (not (comint-check-proc "*inferior-tcl*"))
1402       (progn
1403         (set-buffer (apply (function make-comint) "inferior-tcl" cmd nil
1404                            tcl-command-switches))
1405         (inferior-tcl-mode)))
1406   (make-local-variable 'tcl-application)
1407   (setq tcl-application cmd)
1408   (setq inferior-tcl-buffer "*inferior-tcl*")
1409   (switch-to-buffer "*inferior-tcl*"))
1410
1411 (and (fboundp 'defalias)
1412      (defalias 'run-tcl 'inferior-tcl))
1413
1414 \f
1415
1416 ;;
1417 ;; Auto-fill support.
1418 ;;
1419
1420 (defun tcl-real-command-p ()
1421   "Return nil if point is not at the beginning of a command.
1422 A command is the first word on an otherwise empty line, or the
1423 first word following a semicolon, opening brace, or opening bracket."
1424   (save-excursion
1425     (skip-chars-backward " \t")
1426     (cond
1427      ((bobp) t)
1428      ((bolp)
1429       (backward-char)
1430       ;; Note -- continued comments are not supported here.  I
1431       ;; consider those to be a wart on the language.
1432       (not (eq ?\\ (preceding-char))))
1433      (t
1434       (memq (preceding-char) '(?\; ?{ ?\[))))))
1435
1436 ;; FIXME doesn't actually return t.  See last case.
1437 (defun tcl-real-comment-p ()
1438   "Return t if point is just after the `#' beginning a real comment.
1439 Does not check to see if previous char is actually `#'.
1440 A real comment is either at the beginning of the buffer,
1441 preceeded only by whitespace on the line, or has a preceeding
1442 semicolon, opening brace, or opening bracket on the same line."
1443   (save-excursion
1444     (backward-char)
1445     (tcl-real-command-p)))
1446
1447 (defun tcl-hairy-scan-for-comment (state end always-stop)
1448   "Determine if point is in a comment.
1449 Returns a list of the form `(FLAG . STATE)'.  STATE can be used
1450 as input to future invocations.  FLAG is nil if not in comment,
1451 t otherwise.  If in comment, leaves point at beginning of comment.
1452
1453 This function does not work in Emacs 18.
1454 See also `tcl-simple-scan-for-comment', a
1455 simpler version that is often right, and works in Emacs 18."
1456   (let ((bol (save-excursion
1457                (goto-char end)
1458                (beginning-of-line)
1459                (point)))
1460         real-comment
1461         last-cstart)
1462     (while (and (not last-cstart) (< (point) end))
1463       (setq real-comment nil)           ;In case we've looped around and it is
1464                                         ;set.
1465       (setq state (parse-partial-sexp (point) end nil nil state t))
1466       (if (nth 4 state)
1467           (progn
1468             ;; If ALWAYS-STOP is set, stop even if we don't have a
1469             ;; real comment, or if the comment isn't on the same line
1470             ;; as the end.
1471             (if always-stop (setq last-cstart (point)))
1472             ;; If we have a real comment, then set the comment
1473             ;; starting point if we are on the same line as the ending
1474             ;; location.
1475             (setq real-comment (tcl-real-comment-p))
1476             (if real-comment
1477                 (progn
1478                   (and (> (point) bol) (setq last-cstart (point)))
1479                   ;; NOTE Emacs 19 has a misfeature whereby calling
1480                   ;; parse-partial-sexp with COMMENTSTOP set and with
1481                   ;; an initial list that says point is in a comment
1482                   ;; will cause an immediate return.  So we must skip
1483                   ;; over the comment ourselves.
1484                   (beginning-of-line 2)))
1485             ;; Frob the state to make it look like we aren't in a
1486             ;; comment.
1487             (setcar (nthcdr 4 state) nil))))
1488     (and last-cstart
1489          (goto-char last-cstart))
1490     (cons real-comment state)))
1491
1492 (defun tcl-hairy-in-comment ()
1493   "Return t if point is in a comment, and leave point at beginning of comment."
1494   (let ((save (point)))
1495     (tcl-beginning-of-defun)
1496     (car (tcl-hairy-scan-for-comment nil save nil))))
1497
1498 (defun tcl-simple-in-comment ()
1499   "Return t if point is in comment, and leave point at beginning of comment.
1500 This is faster that `tcl-hairy-in-comment', but is correct less often."
1501   (let ((save (point))
1502         comment)
1503     (beginning-of-line)
1504     (while (and (< (point) save) (not comment))
1505       (search-forward "#" save 'move)
1506       (setq comment (tcl-real-comment-p)))
1507     comment))
1508
1509 (defun tcl-in-comment ()
1510   "Return t if point is in comment, and leave point at beginning of comment."
1511   (if (and tcl-pps-has-arg-6
1512            tcl-use-hairy-comment-detector)
1513       (tcl-hairy-in-comment)
1514     (tcl-simple-in-comment)))
1515
1516 (defun tcl-do-fill-paragraph (ignore)
1517   "fill-paragraph function for Tcl mode.  Only fills in a comment."
1518   (let (in-comment col where)
1519     (save-excursion
1520       (end-of-line)
1521       (setq in-comment (tcl-in-comment))
1522       (if in-comment
1523           (progn
1524             (setq where (1+ (point)))
1525             (setq col (1- (current-column))))))
1526     (and in-comment
1527          (save-excursion
1528            (back-to-indentation)
1529            (= col (current-column)))
1530          ;; In a comment.  Set the fill prefix, and find the paragraph
1531          ;; boundaries by searching for lines that look like
1532          ;; comment-only lines.
1533          (let ((fill-prefix (buffer-substring (progn
1534                                                 (beginning-of-line)
1535                                                 (point))
1536                                               where))
1537                p-start p-end)
1538            ;; Search backwards.
1539            (save-excursion
1540              (while (looking-at "^[ \t]*#")
1541                (forward-line -1))
1542              (forward-line)
1543              (setq p-start (point)))
1544
1545            ;; Search forwards.
1546            (save-excursion
1547              (while (looking-at "^[ \t]*#")
1548                (forward-line))
1549              (setq p-end (point)))
1550
1551            ;; Narrow and do the fill.
1552            (save-restriction
1553              (narrow-to-region p-start p-end)
1554              (fill-paragraph ignore)))))
1555   t)
1556
1557 (defun tcl-do-auto-fill ()
1558   "Auto-fill function for Tcl mode.  Only auto-fills in a comment."
1559   (if (> (current-column) fill-column)
1560       (let ((fill-prefix "# ")
1561             in-comment col)
1562         (save-excursion
1563           (setq in-comment (tcl-in-comment))
1564           (if in-comment
1565               (setq col (1- (current-column)))))
1566         (if in-comment
1567             (progn
1568               (do-auto-fill)
1569               (save-excursion
1570                 (back-to-indentation)
1571                 (delete-region (point) (save-excursion
1572                                          (beginning-of-line)
1573                                          (point)))
1574                 (indent-to-column col)))))))
1575
1576 \f
1577
1578 ;;
1579 ;; Help-related code.
1580 ;;
1581
1582 (defvar tcl-help-saved-dirs nil
1583   "Saved help directories.
1584 If `tcl-help-directory-list' changes, this allows `tcl-help-on-word'
1585 to update the alist.")
1586
1587 (defvar tcl-help-alist nil
1588   "Alist with command names as keys and filenames as values.")
1589
1590 (defun tcl-help-snarf-commands (dirlist)
1591   "Build alist of commands and filenames."
1592   (while dirlist
1593     (let ((files (directory-files (car dirlist) t)))
1594       (while files
1595         (if (and (file-directory-p (car files))
1596                  (not
1597                   (let ((fpart (file-name-nondirectory (car files))))
1598                     (or (equal fpart ".")
1599                         (equal fpart "..")))))
1600             (let ((matches (directory-files (car files) t)))
1601               (while matches
1602                 (or (file-directory-p (car matches))
1603                     (setq tcl-help-alist
1604                           (cons
1605                            (cons (file-name-nondirectory (car matches))
1606                                  (car matches))
1607                            tcl-help-alist)))
1608                 (setq matches (cdr matches)))))
1609         (setq files (cdr files))))
1610     (setq dirlist (cdr dirlist))))
1611
1612 (defun tcl-reread-help-files ()
1613   "Set up to re-read files, and then do it."
1614   (interactive)
1615   (message "Building Tcl help file index...")
1616   (setq tcl-help-saved-dirs tcl-help-directory-list)
1617   (setq tcl-help-alist nil)
1618   (tcl-help-snarf-commands tcl-help-directory-list)
1619   (message "Building Tcl help file index...done"))
1620
1621 (defun tcl-word-no-props ()
1622   "Like current-word, but strips properties."
1623   (let ((word (current-word)))
1624     (and (fboundp 'set-text-properties)
1625          (set-text-properties 0 (length word) nil word))
1626     word))
1627
1628 (defun tcl-current-word (flag)
1629   "Return current command word, or nil.
1630 If FLAG is nil, just uses `current-word'.
1631 Otherwise scans backward for most likely Tcl command word."
1632   (if (and flag
1633            (memq major-mode '(tcl-mode inferior-tcl-mode)))
1634       (condition-case nil
1635           (save-excursion
1636             ;; Look backward for first word actually in alist.
1637             (if (bobp)
1638                 ()
1639               (while (and (not (bobp))
1640                           (not (tcl-real-command-p)))
1641                 (backward-sexp)))
1642             (if (assoc (tcl-word-no-props) tcl-help-alist)
1643                 (tcl-word-no-props)))
1644         (error nil))
1645     (tcl-word-no-props)))
1646
1647 ;;;###autoload
1648 (defun tcl-help-on-word (command &optional arg)
1649   "Get help on Tcl command.  Default is word at point.
1650 Prefix argument means invert sense of `tcl-use-smart-word-finder'."
1651   (interactive
1652    (list
1653     (progn
1654       (if (not (equal tcl-help-directory-list tcl-help-saved-dirs))
1655           (tcl-reread-help-files))
1656       (let ((word (tcl-current-word
1657                    (if current-prefix-arg
1658                        (not tcl-use-smart-word-finder)
1659                      tcl-use-smart-word-finder))))
1660         (completing-read
1661          (if (or (null word) (string= word ""))
1662              "Help on Tcl command: "
1663            (format "Help on Tcl command (default %s): " word))
1664          tcl-help-alist nil t)))
1665     current-prefix-arg))
1666   (if (not (equal tcl-help-directory-list tcl-help-saved-dirs))
1667       (tcl-reread-help-files))
1668   (if (string= command "")
1669       (setq command (tcl-current-word
1670                      (if arg
1671                          (not tcl-use-smart-word-finder)
1672                        tcl-use-smart-word-finder))))
1673   (let* ((help (get-buffer-create "*Tcl help*"))
1674          (cell (assoc command tcl-help-alist))
1675          (file (and cell (cdr cell))))
1676     (set-buffer help)
1677     (delete-region (point-min) (point-max))
1678     (if file
1679         (progn
1680           (insert "*** " command "\n\n")
1681           (insert-file-contents file))
1682       (if (string= command "")
1683           (insert "Magical Pig!")
1684         (insert "Tcl command " command " not in help\n")))
1685     (set-buffer-modified-p nil)
1686     (goto-char (point-min))
1687     (display-buffer help)))
1688
1689 \f
1690
1691 ;;
1692 ;; Other interactive stuff.
1693 ;;
1694
1695 (defvar tcl-previous-dir/file nil
1696   "Record last directory and file used in loading.
1697 This holds a cons cell of the form `(DIRECTORY . FILE)'
1698 describing the last `tcl-load-file' command.")
1699
1700 (defun tcl-load-file (file &optional and-go)
1701   "Load a Tcl file into the inferior Tcl process.
1702 Prefix argument means switch to the Tcl buffer afterwards."
1703   (interactive
1704    (list
1705     ;; car because comint-get-source returns a list holding the
1706     ;; filename.
1707     (car (comint-get-source "Load Tcl file: "
1708                             (or (and
1709                                  (eq major-mode 'tcl-mode)
1710                                  (buffer-file-name))
1711                                 tcl-previous-dir/file)
1712                             '(tcl-mode) t))
1713     current-prefix-arg))
1714   (comint-check-source file)
1715   (setq tcl-previous-dir/file (cons (file-name-directory file)
1716                                     (file-name-nondirectory file)))
1717   (tcl-send-string (inferior-tcl-proc)
1718                    (format inferior-tcl-source-command (tcl-quote file)))
1719   (if and-go (switch-to-tcl t)))
1720
1721 (defun tcl-restart-with-file (file &optional and-go)
1722   "Restart inferior Tcl with file.
1723 If an inferior Tcl process exists, it is killed first.
1724 Prefix argument means switch to the Tcl buffer afterwards."
1725   (interactive
1726    (list
1727     (car (comint-get-source "Restart with Tcl file: "
1728                             (or (and
1729                                  (eq major-mode 'tcl-mode)
1730                                  (buffer-file-name))
1731                                 tcl-previous-dir/file)
1732                             '(tcl-mode) t))
1733     current-prefix-arg))
1734   (let* ((buf (if (eq major-mode 'inferior-tcl-mode)
1735                   (current-buffer)
1736                 inferior-tcl-buffer))
1737          (proc (and buf (get-process buf))))
1738     (cond
1739      ((not (and buf (get-buffer buf)))
1740       ;; I think this will be ok.
1741       (inferior-tcl tcl-application)
1742       (tcl-load-file file and-go))
1743      ((or
1744        (not (comint-check-proc buf))
1745        (yes-or-no-p
1746         "A Tcl process is running, are you sure you want to reset it? "))
1747       (save-excursion
1748         (comint-check-source file)
1749         (setq tcl-previous-dir/file (cons (file-name-directory file)
1750                                           (file-name-nondirectory file)))
1751         (comint-exec (get-buffer-create buf)
1752                      (if proc
1753                          (process-name proc)
1754                        "inferior-tcl")
1755                      tcl-application file tcl-command-switches)
1756         (if and-go (switch-to-tcl t)))))))
1757
1758 (defun tcl-auto-fill-mode (&optional arg)
1759   "Like `auto-fill-mode', but controls filling of Tcl comments."
1760   (interactive "P")
1761   (and (not tcl-using-emacs-19)
1762        (error "This feature is not supported in Emacs 18"))
1763   ;; Following code taken from "auto-fill-mode" (simple.el).
1764   (prog1
1765       (setq auto-fill-function
1766             (if (if (null arg)
1767                     (not auto-fill-function)
1768                   (> (prefix-numeric-value arg) 0))
1769                 'tcl-do-auto-fill
1770               nil))
1771     (force-mode-line-update)))
1772
1773 ;; hilit19 support from "Chris Alfeld" <calfeld@math.utah.edu>
1774 (defun tcl-hilit ()
1775   (hilit-set-mode-patterns
1776    '(tcl-mode)
1777    '(
1778      ("\\(^ *\\|\; *\\)#.*$" nil comment)
1779      ("[^\\]\\(\\$[A-Za-z0-9\\-\\_./\\(\\)]+\\)" 1 label)
1780      ("[^_]\\<\\(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
1781      ("[^_]\\<\\(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
1782      ("[^_]\\<\\(button\\|canvas\\|checkbutton\\|entry\\|frame\\|label\\|listbox\\|menu\\|menubutton\\|message\\|radiobutton\\|scrollbar\\|text\\|toplevel\\)\\>[^_]" 1 decl) ; tk widgets
1783      ("[^_]\\<\\(tix\\((ButtonBox\\|Baloon\\|Control\\|DirList\\|ExFileSelectBox\\|ExFileSelectDialog\\|FileEntry\\|HList\\|LabelEntry\\|LabelFrame\\|NoteBook\\|OptionMenu\\|PanedWindow\\|PopupMenu\\|ScrolledHList\\|ScrolledText\\|ScrolledWindow\\|Select\\|StdButtonBox\\)\\)\\>[^_]" 1 defun) ; tix widgets
1784      ("[{}\\\"\\(\\)]" nil include) ; misc punctuation
1785      )))
1786
1787 (defun tcl-electric-hash (&optional count)
1788   "Insert a `#' and quote if it does not start a real comment.
1789 Prefix arg is number of `#'s to insert.
1790 See variable `tcl-electric-hash-style' for description of quoting
1791 styles."
1792   (interactive "p")
1793   (or count (setq count 1))
1794   (if (> count 0)
1795       (let ((type
1796              (if (eq tcl-electric-hash-style 'smart)
1797                  (if (> count 3)        ; FIXME what is "smart"?
1798                      'quote
1799                    'backslash)
1800                tcl-electric-hash-style))
1801             comment)
1802         (if type
1803             (progn
1804               (save-excursion
1805                 (insert "#")
1806                 (setq comment (tcl-in-comment)))
1807               (delete-char 1)
1808               (and tcl-explain-indentation (message "comment: %s" comment))
1809               (cond
1810                ((eq type 'quote)
1811                 (if (not comment)
1812                     (insert "\"")))
1813                ((eq type 'backslash)
1814                 ;; The following will set count to 0, so the
1815                 ;; insert-char can still be run.
1816                 (if (not comment)
1817                     (while (> count 0)
1818                       (insert "\\#")
1819                       (setq count (1- count)))))
1820                (t nil))))
1821         (insert-char ?# count))))
1822
1823 (defun tcl-hashify-buffer ()
1824   "Quote all `#'s in current buffer that aren't Tcl comments."
1825   (interactive)
1826   (save-excursion
1827     (goto-char (point-min))
1828     (if (and tcl-pps-has-arg-6 tcl-use-hairy-comment-detector)
1829         (let (state
1830               result)
1831           (while (< (point) (point-max))
1832             (setq result (tcl-hairy-scan-for-comment state (point-max) t))
1833             (if (car result)
1834                 (beginning-of-line 2)
1835               (backward-char)
1836               (if (eq ?# (following-char))
1837                   (insert "\\"))
1838               (forward-char))
1839             (setq state (cdr result))))
1840       (while (and (< (point) (point-max))
1841                   (search-forward "#" nil 'move))
1842         (if (tcl-real-comment-p)
1843             (beginning-of-line 2)
1844           ;; There's really no good way for the simple converter to
1845           ;; work.  So we just quote # if it isn't already quoted.
1846           ;; Bogus, but it works.
1847           (backward-char)
1848           (if (not (eq ?\\ (preceding-char)))
1849               (insert "\\"))
1850           (forward-char))))))
1851
1852 (defun tcl-indent-for-comment ()
1853   "Indent this line's comment to comment column, or insert an empty comment.
1854 Is smart about syntax of Tcl comments.
1855 Parts of this were taken from `indent-for-comment'."
1856   (interactive "*")
1857   (end-of-line)
1858   (or (tcl-in-comment)
1859       (progn
1860         ;; Not in a comment, so we have to insert one.  Create an
1861         ;; empty comment (since there isn't one on this line).  If
1862         ;; line is not blank, make sure we insert a ";" first.
1863         (skip-chars-backward " \t")
1864         (let ((eolpoint (point)))
1865           (beginning-of-line)
1866           (if (/= (point) eolpoint)
1867               (progn
1868                 (goto-char eolpoint)
1869                 (insert
1870                  (if (tcl-real-command-p) "" ";")
1871                  "# ")
1872                 (backward-char))))))
1873   ;; Point is just after the "#" starting a comment.  Move it as
1874   ;; appropriate.
1875   (let* ((indent (if comment-indent-hook
1876                      (funcall comment-indent-hook)
1877                    (funcall comment-indent-function)))
1878          (begpos (progn
1879                    (backward-char)
1880                    (point))))
1881     (if (/= begpos indent)
1882         (progn
1883           (skip-chars-backward " \t" (save-excursion
1884                                        (beginning-of-line)
1885                                        (point)))
1886           (delete-region (point) begpos)
1887           (indent-to indent)))
1888     (looking-at comment-start-skip)     ; Always true.
1889     (goto-char (match-end 0))
1890     ;; I don't like the effect of the next two.
1891     ;;(skip-chars-backward " \t" (match-beginning 0))
1892     ;;(skip-chars-backward "^ \t" (match-beginning 0))
1893     ))
1894
1895 ;; The following was inspired by the Tcl editing mode written by
1896 ;; Gregor Schmid <schmid@fb3-s7.math.TU-Berlin.DE>.  His version also
1897 ;; attempts to snarf the command line options from the command line,
1898 ;; but I didn't think that would really be that helpful (doesn't seem
1899 ;; like it owould be right enough.  His version also looks for the
1900 ;; "#!/bin/csh ... exec" hack, but that seemed even less useful.
1901 ;; FIXME should make sure that the application mentioned actually
1902 ;; exists.
1903 (defun tcl-guess-application ()
1904   "Attempt to guess Tcl application by looking at first line.
1905 The first line is assumed to look like \"#!.../program ...\"."
1906   (save-excursion
1907     (goto-char (point-min))
1908     (if (looking-at "#![^ \t]*/\\([^ \t\n/]+\\)\\([ \t]\\|$\\)")
1909         (progn
1910           (make-local-variable 'tcl-application)
1911           (setq tcl-application (buffer-substring (match-beginning 1)
1912                                                   (match-end 1)))))))
1913
1914 ;; This only exists to put on the menubar.  I couldn't figure out any
1915 ;; other way to do it.  FIXME should take "number of #-marks"
1916 ;; argument.
1917 (defun tcl-uncomment-region (beg end)
1918   "Uncomment region."
1919   (interactive "r")
1920   (comment-region beg end -1))
1921
1922 \f
1923
1924 ;;
1925 ;; XEmacs menu support.
1926 ;; Taken from schmid@fb3-s7.math.TU-Berlin.DE (Gregor Schmid),
1927 ;; who wrote a different Tcl mode.
1928 ;; We also have support for menus in Emacs.  We do this by
1929 ;; loading the XEmacs menu emulation code.
1930 ;;
1931
1932 (defun tcl-popup-menu (e)
1933   (interactive "@e")
1934   (and tcl-using-emacs-19
1935        (not tcl-using-xemacs-19)
1936        (if tcl-using-emacs-19-23
1937            (require 'lmenu)
1938          ;; CAVEATS:
1939          ;; * lmenu.el provides 'menubar, which is bogus.
1940          ;; * lmenu.el causes menubars to be turned on everywhere.
1941          ;;   Doubly bogus!
1942          ;; Both of these problems are fixed in Emacs 19.23.  People
1943          ;; using an Emacs before that just suffer.
1944          (require 'menubar "lmenu")))  ;; This is annoying
1945   ;; IMHO popup-menu should be autoloaded.  Oh well.
1946   (popup-menu tcl-xemacs-menu))
1947
1948 \f
1949
1950 ;;
1951 ;; Quoting and unquoting functions.
1952 ;;
1953
1954 ;; This quoting is sufficient to protect eg a filename from any sort
1955 ;; of expansion or splitting.  Tcl quoting sure sucks.
1956 (defun tcl-quote (string)
1957   "Quote STRING according to Tcl rules."
1958   (mapconcat (function (lambda (char)
1959                          (if (memq char '(?[ ?] ?{ ?} ?\\ ?\" ?$ ?  ?\;))
1960                              (concat "\\" (char-to-string char))
1961                            (char-to-string char))))
1962              string ""))
1963
1964 \f
1965
1966 ;;
1967 ;; Bug reporting.
1968 ;;
1969
1970 (and (fboundp 'eval-when-compile)
1971      (eval-when-compile
1972        (require 'reporter)))
1973
1974 (defun tcl-submit-bug-report ()
1975   "Submit via mail a bug report on Tcl mode."
1976   (interactive)
1977   (require 'reporter)
1978   (and
1979    (y-or-n-p "Do you really want to submit a bug report on Tcl mode? ")
1980    (reporter-submit-bug-report
1981     tcl-maintainer
1982     (concat "Tcl mode " tcl-version)
1983     '(tcl-indent-level
1984       tcl-continued-indent-level
1985       tcl-auto-newline
1986       tcl-tab-always-indent
1987       tcl-use-hairy-comment-detector
1988       tcl-electric-hash-style
1989       tcl-help-directory-list
1990       tcl-use-smart-word-finder
1991       tcl-application
1992       tcl-command-switches
1993       tcl-prompt-regexp
1994       inferior-tcl-source-command
1995       tcl-using-emacs-19
1996       tcl-using-emacs-19-23
1997       tcl-using-xemacs-19
1998       tcl-proc-list
1999       tcl-proc-regexp
2000       tcl-typeword-list
2001       tcl-keyword-list
2002       tcl-font-lock-keywords
2003       tcl-pps-has-arg-6))))
2004
2005 \f
2006
2007 (provide 'tcl)
2008
2009 ;;; tcl.el ends here