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